View a markdown version of this page

Connecter une source de données Confluence - Amazon Bedrock
Création de la source de donnéesParamètres du connecteurModifier la méthode d'authentificationÉtapes suivantes

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Connecter une source de données Confluence

Après avoir configuré l'authentification et enregistré vos informations d'identification de manière AWS Secrets Manager secrète, créez la source de données Confluence dans votre base de connaissances. Cette page explique comment créer la source de données à l'aide de l'API Console de gestion AWS ou, suivie d'une référence pour les paramètres de connecteur que vous pouvez configurer.

Note

Terminez d'abord la configuration de l'authentification. Voir User-managed configuration (3LO) (le plus simple)Configurer l'authentification de base pour Confluence, ouConfigurer l'authentification OAuth 2.0 pour Confluence. Pour une configuration gérée par l'utilisateur (3LO), vous vous connectez via la console et Amazon Bedrock crée le secret pour vous (à l'aide d'un ARN généré par le système) ; vous fournissez l'URL de l'hôte Confluence mais pas de secret. Pour les autres méthodes, vous avez besoin de l'ARN secret et de l'URL de l'hôte Confluence.

Création de la source de données

Console
Pour connecter Confluence à votre base de connaissances gérée

  1. Sous Source de données, donnez un nom à votre source de données.

  2. Sélectionnez Confluence dans la liste déroulante des sources de données.

  3. Dans Source, entrez votre URL Confluence (par exemple,https://example.atlassian.net).

  4. Sous Authentification, sélectionnez User-managed Configuration (3LO), Authentification de base ou Authentification OAuth 2.0. Pour une configuration gérée par l'utilisateur (3LO), entrez éventuellement un préfixe de nom secret, puis choisissez Se connecter pour vous connecter à Confluence Cloud. Vous ne divulguez aucun secret. Amazon Bedrock crée un secret à l'aide d'un ARN généré par le système pour stocker le jeton. Pour en savoir plus, consultez User-managed configuration (3LO).

  5. Sélectionnez ou créez un AWS Secrets Manager secret pour stocker vos informations d'identification.

  6. (Facultatif, authentification de base uniquement) Pour activer le contrôle d'accès au niveau du document, sélectionnez Contrôler l'accès aux documents avec des ACL. Le secret que vous sélectionnez doit inclure adminApiKeyorganizationId, etdirectoryId. Cette option ne peut pas être modifiée après sa création. Pour en savoir plus, consultez Document-level contrôles d'accès.

  7. (Facultatif) Élargissez le champ de synchronisation pour choisir les types d'entités à analyser (pages, blogs, pièces jointes de pages, pièces jointes de blog, espaces archivés, pages archivées, espaces personnels).

  8. (Facultatif) Développez les URL des entités pour utiliser le URL-based filtrage afin de synchroniser des espaces, des pages et des blogs Confluence spécifiques.

  9. (Facultatif) Développez le modèle regex des types MIME pour inclure ou exclure des types MIME spécifiques.

API

Pour créer une source de données Confluence, envoyez une CreateDataSource demande avec un point de terminaison Agents for Amazon Bedrock build-time. L' AWS Command Line Interface exemple suivant crée une source de données qui utilise l'authentification de base. Pour utiliser OAuth 2.0 à la place, passez authType à. OAUTH2 Pour une configuration gérée par l'utilisateur (3LO), réglez surauthType. MANAGED_OAUTH2 Vous ne pouvez pas créer de secret 3LO via l'API : connectez-vous d'abord via la console pour créer le secret, puis configurez secretArn l'ARN de ce secret (voirUser-managed configuration (3LO)). Pour activer le contrôle d'accès au niveau du document, définissez suraclEnabled. true Pour une description de chaque champ, reportez-vous à la référence des paramètres du connecteur qui suit.

aws bedrock-agent create-data-source \
 --name "Confluence-connector" \
 --knowledge-base-id "your-knowledge-base-id" \
 --data-source-configuration file://confluence-managed-connector.json

Le confluence-managed-connector.json fichier contient les éléments suivants :

{
    "type": "MANAGED_KNOWLEDGE_BASE_CONNECTOR",
    "managedKnowledgeBaseConnectorConfiguration": {
        "connectorParameters": {
            "type": "CONFLUENCE",
            "version": "1",
            "aclEnabled": false,
            "connectionConfiguration": {
                "secretArn": "arn:aws:secretsmanager:us-west-2:123456789012:secret:bedrock-confluence-basic-creds",
                "type": "SAAS",
                "authType": "BASIC",
                "hostUrl": "https://example.atlassian.net"
            },
            "dataEntityConfiguration": {
                "crawlPage": true,
                "crawlBlog": true,
                "crawlPageAttachment": true,
                "crawlBlogAttachment": true
            },
            "filterConfiguration": {
                "inclusionSpaceKeys": ["ENG", "DOCS"]
            }
        }
    }
}

Pour les bases de connaissances gérées, CreateDataSource est asynchrone : l'état de la source de données passe du statut de la source de données CREATING à la AVAILABLE fin de l'opération.

Paramètres du connecteur

La configuration de la source de données utilise les paramètres de connecteur suivants. Pour vous connecter à Confluence, spécifiez CONFLUENCE le type de connecteur dansconnectorParameters. Pour les champs encapsulés connectorParameters (tels que deletionProtectionConfiguration etmediaExtractionConfiguration), consultezConnexion d’une sources de données.

Définissez AclEnabled de manière explicite

Si vous omettezaclEnabled, la valeur par défaut dépend de authType : la valeur par BASIC défaut est et OAUTH2 la true valeur par défaut est. false Étant donné que la configuration ACL est permanente après la création de la source de données, définissez-la aclEnabled explicitement pour que la source de données présente le comportement de contrôle d'accès que vous souhaitez. Pour en savoir plus, consultez Document-level contrôles d'accès.

connectionConfiguration
Champ Obligatoire Description
secretArn Oui L'ARN du AWS Secrets Manager secret contenant vos informations d'identification Confluence.
type Oui Type de déploiement Confluence. Définie sur SAAS. Confluence Server et Data Center ne sont pas pris en charge.
authType Oui Type d’authentification. Réglez sur MANAGED_OAUTH2 (configuration gérée par l'utilisateur, 3LO)BASIC, ou. OAUTH2 Consultez Méthodes d’authentification.
hostUrl Oui URL de base de votre instance Confluence Cloud (par exemple,https://example.atlassian.net).
données EntityConfiguration (facultatif)
Champ Obligatoire Description
crawlPage Non S'il faut explorer les pages.
crawlBlog Non S'il faut explorer les articles de blog.
crawlPageAttachment Non S'il faut explorer les pièces jointes des pages. J'ai rampé uniquement quand crawlPage c'est aussi true le cas.
crawlBlogAttachment Non S'il faut explorer les pièces jointes des articles de blog. J'ai rampé uniquement quand crawlBlog c'est aussi true le cas.
crawlArchivedSpace Non S'il faut explorer les espaces archivés.
crawlArchivedPage Non S'il faut explorer les pages archivées.
crawlPersonalSpace Non Que ce soit pour parcourir les espaces personnels.
Configuration du filtre (facultatif)
Champ Obligatoire Description
inclusionSpaceKeys Non Touches d'espace à inclure.
inclusionSpaceUrls Non Espacez les URL à inclure.
inclusionMimeTypes Non Types MIME à inclure.
exclusionMimeTypes Non Types MIME à exclure.
maxFileSizeInMegaBytes Non Taille maximale, en mégaoctets, de tout fichier ingéré par le connecteur. Fournissez-la sous forme de chaîne numérique (par exemple,"500"). La valeur par défaut est "500" .
ACL activé (facultatif)
Champ Obligatoire Description
aclEnabled Non Si le contrôle d'accès au niveau du document est activé. Réglez true sur pour activer ou false pour désactiver. Si vous omettez ce champ, la valeur par défaut dépend de authType : la valeur par défaut est true ; OAUTH2 la BASIC valeur par défaut est. false L'ACL activé BASIC nécessite un secret qui inclut les informations d'identification d'administrateur de l'organisation Atlassian. Vous ne pouvez pas modifier ce paramètre après avoir créé la source de données. Pour en savoir plus, consultez Document-level contrôles d'accès.

Modifier la méthode d'authentification

Vous pouvez modifier la méthode d'authentification d'une source de données (par exemple, de OAuth 2.0 à Basic) en mettant à jour la source de données avec la nouvelle méthode authType et un secret contenant les informations d'identification correspondantes, à l'aide de l'UpdateDataSourceopération ou du. Console de gestion AWS Le paramètre de contrôle d'accès au niveau du document est fixe lorsque vous créez une source de données. Par conséquent, pour ajouter ou supprimer des ACL, vous devez créer une nouvelle source de données.

Étapes suivantes

Après avoir créé la source de données, synchronisez-la pour intégrer le contenu dans votre base de connaissances. Pour en savoir plus, consultez Synchronisation d’une source de données. Pour filtrer les résultats des requêtes en fonction des autorisations des utilisateurs, consultezDocument-level contrôles d'accès.