连接 Confluence 数据源

设置身份验证并将凭据存储在 AWS Secrets Manager 密钥中后，请在知识库中创建 Confluence 数据源。本页介绍如何使用 AWS 管理控制台或 API 创建数据源，然后是您可以配置的连接器参数的参考。

注意

首先完成身份验证设置。请参阅为 Confluence 设置基本身份验证或为 Confluence 设置 OAuth 2.0 身份验证。你需要秘密 ARN 和 Confluence 主机网址。

创建数据源

Console

将 Confluence 连接到您的托管知识库

在 “数据源” 下，为您的数据源提供一个名称。
从数据源下拉列表中选择 Confluence。
在 “来源” 下，输入您的 Confluence 网址（例如）。https://example.atlassian.net
在 “身份验证” 下，选择基本身份验证或 OAuth 2.0 身份验证。
选择或创建用于存储您的凭据的 AWS Secrets Manager 密钥。
（可选，仅限基本身份验证）要启用文档级访问控制，请选择使用 ACL 控制文档访问权限。您选择的密钥必须包含adminApiKeyorganizationId、和directoryId。此选项在创建后无法更改。有关更多信息，请参阅 Document-level 访问控制。
（可选）展开同步范围以选择要抓取的实体类型（页面、博客、页面附件、博客附件、存档空间、存档页面、个人空间）。
（可选）展开实体网址以使用 URL-based 筛选功能同步特定的 Confluence 空间、页面和博客。
（可选）扩展 Mime 类型正则表达式模式以包含或排除特定的 MIME 类型。

API

要创建 Confluence 数据源，请向 Amazon Bedrock 构建时终端节点的代理发送CreateDataSource请求。以下 AWS Command Line Interface 示例创建了一个使用基本身份验证的数据源。要改用 OAuth 2.0，请更改为authType。OAUTH2要启用文档级访问控制，请将设置为aclEnabled。true有关每个字段的描述，请参阅下面的连接器参数参考。


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

该confluence-managed-connector.json文件包含以下内容：


{
    "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"]
            }
        }
    }
}

对于托管知识库，CreateDataSource这是异步的：操作完成后，数据源状态AVAILABLE会从CREATING变为。

连接器参数

数据源配置使用以下连接器参数。要连接到 Confluence，请在中指定CONFLUENCE为连接器类型。connectorParameters有关换行字段connectorParameters（例如deletionProtectionConfiguration和mediaExtractionConfiguration），请参阅连接数据来源。

明确设置启用 ACL

如果省略aclEnabled，则默认值取决于authType：BASIC默认为true，OAUTH2默认为。false由于 ACL 配置在数据源创建后是永久性的，因此请aclEnabled明确设置以使数据源具有您想要的访问控制行为。有关更多信息，请参阅 Document-level 访问控制。

connectionConfiguration
字段	必填	描述
`secretArn`	是	包含您的 Confluence AWS Secrets Manager 凭据的密钥的 ARN。
`type`	是	Confluence 部署类型。设置为 `SAAS`。不支持 Confluence 服务器和数据中心。
`authType`	是	身份验证类型。设置为`BASIC`或`OAUTH2`。请参阅身份验证方法。
`hostUrl`	是	您的 Confluence 云实例的基本网址（例如，`https://example.atlassian.net`）。

数据EntityConfiguration （可选）
字段	必填	说明
`crawlPage`	否	是否抓取页面。
`crawlBlog`	否	是否抓取博客文章。
`crawlPageAttachment`	否	是否抓取页面附件。只有在同样`true`的时候`crawlPage`才会爬行。
`crawlBlogAttachment`	否	是否抓取博客文章附件。只有在同样`true`的时候`crawlBlog`才会爬行。
`crawlArchivedSpace`	否	是否抓取已存档的空间。
`crawlArchivedPage`	否	是否抓取存档页面。
`crawlPersonalSpace`	否	是否搜寻个人空间。

过滤器配置（可选）
字段	必填	说明
`inclusionSpaceKeys`	否	要包含的空格键。
`inclusionSpaceUrls`	否	要包含的空格 URL。
`inclusionMimeTypes`	否	要包括的 MIME 类型。
`exclusionMimeTypes`	否	要排除的 MIME 类型。
`maxFileSizeInMegaBytes`	否	连接器接收的任何单个文件的最大大小（以兆字节为单位）。以数字字符串形式提供（例如，`"500"`）。默认值为 `"500"`。

已启用 ACL（可选）
字段	必填	说明
`aclEnabled`	否	是否启用文档级访问控制。设置`true`为可启用，或设置`false`为禁用。如果省略此字段，则默认值取决于`authType`：`BASIC`默认为`true`；`OAUTH2`默认为。`false`开启 ACL `BASIC` 需要一个包含 Atlassian 组织管理员凭据的密钥。创建数据源后，您无法更改此设置。有关更多信息，请参阅 Document-level 访问控制。

更改身份验证方法

您可以更改数据源的身份验证方法（例如，从 OAuth 2.0 到 Basic），方法是使用新的authType和包含匹配凭据的密钥更新数据源，使用UpdateDataSource操作或。 AWS 管理控制台创建数据源时，文档级访问控制设置是固定的，因此要添加或删除 ACL，必须创建一个新的数据源。

后续步骤

创建数据源后，将其同步，将内容摄取到知识库中。有关更多信息，请参阅同步数据来源。要按用户权限筛选查询结果，请参阅Document-level 访问控制。

Javascript 在您的浏览器中被禁用或不可用。

要使用 Amazon Web Services 文档，必须启用 Javascript。请参阅浏览器的帮助页面以了解相关说明。

文档惯例

设置 OAuth 2.0 身份验证

Document-level 访问控制