View a markdown version of this page

連接 Confluence 資料來源 - Amazon Bedrock

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

連接 Confluence 資料來源

設定身分驗證並將登入資料存放在 AWS Secrets Manager 秘密之後,請在知識庫中建立 Confluence 資料來源。此頁面說明如何使用 AWS 管理主控台 或 API 建立資料來源,後面接著您可以設定的連接器參數參考。

注意

請先完成身分驗證設定。請參閱 設定 Confluence 的基本身分驗證設定 Confluence 的 OAuth 2.0 身分驗證。您需要秘密 ARN 和 Confluence 主機 URL。

建立資料來源

Console
將 Confluence 連接到您的受管知識庫
  1. 資料來源下,提供資料來源的名稱。

  2. 從資料來源下拉式清單中選取 Confluence

  3. 來源下,輸入您的 Confluence URL (例如,https://example.atlassian.net)。

  4. 身分驗證下,選取基本身分驗證OAuth 2.0 身分驗證。

  5. 選取或建立 AWS Secrets Manager 秘密以存放您的登入資料。

  6. (選用,僅限基本身分驗證) 若要啟用文件層級存取控制,請選取使用 ACLs 控制文件存取。您選取的秘密必須包含 adminApiKeyorganizationIddirectoryId。此選項無法在建立後變更。如需詳細資訊,請參閱文件層級存取控制

  7. (選用) 展開同步範圍以選擇要爬取的實體類型 (頁面、部落格、頁面附件、部落格附件、封存空間、封存頁面、個人空間)。

  8. (選用) 展開實體 URLs以使用 URL 型篩選來同步特定的 Confluence 空間、頁面和部落格。

  9. (選用) 展開 Mime 類型 regex 模式,以包含或排除特定 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是非同步的:當操作完成CREATINGAVAILABLE時,資料來源狀態會從 轉換為 。

連接器參數

資料來源組態使用下列連接器參數。若要連線至 Confluence,請在 中指定 CONFLUENCE做為連接器類型connectorParameters。如需包裝的欄位 connectorParameters(例如 deletionProtectionConfigurationmediaExtractionConfiguration),請參閱 連接資料來源

aclEnabled 明確設定

如果您省略 aclEnabled,預設值取決於 authTypeBASIC預設值為 trueOAUTH2預設值為 false。由於 ACL 組態在資料來源建立後是永久的,因此aclEnabled請明確設定 ,讓資料來源具有您想要的存取控制行為。如需詳細資訊,請參閱文件層級存取控制

connectionConfiguration
欄位 必要 描述
secretArn 包含 Confluence 登入資料的 AWS Secrets Manager 秘密 ARN。
type Confluence 部署類型。設定為 SAAS。不支援 Confluence Server 和資料中心。
authType 驗證類型。將 設定為 BASICOAUTH2。請參閱 身分驗證方法
hostUrl Confluence Cloud 執行個體的基本 URL (例如 https://example.atlassian.net)。
dataEntityConfiguration (選用)
欄位 必要 說明
crawlPage 是否要編目頁面。
crawlBlog 是否要編目部落格文章。
crawlPageAttachment 是否要編目頁面附件。只有在 crawlPage也是 時才會爬取true
crawlBlogAttachment 是否要編目部落格文章附件。只有在 crawlBlog也是 時才會爬取true
crawlArchivedSpace 是否要編目封存空間。
crawlArchivedPage 是否要編目封存的頁面。
crawlPersonalSpace 是否要編目個人空間。
filterConfiguration (選用)
欄位 必要 說明
inclusionSpaceKeys 要包含的空間索引鍵。
inclusionSpaceUrls 要包含的空間 URLs。
inclusionMimeTypes 要包含的 MIME 類型。
exclusionMimeTypes 要排除的 MIME 類型。
maxFileSizeInMegaBytes 連接器擷取之任何單一檔案的大小上限,以 MB 為單位。提供 做為數值字串 (例如,"500")。預設為 "500"
aclEnabled (選用)
欄位 必要 說明
aclEnabled 文件層級存取控制是否已啟用。設定為 true 以啟用,或false設定為停用。如果您省略此欄位,預設值取決於 authTypeBASIC預設值為 trueOAUTH2預設值為 false。上的 ACL BASIC需要包含 Atlassian 組織管理員憑證的秘密。您無法在建立資料來源後變更此設定。如需詳細資訊,請參閱文件層級存取控制

變更身分驗證方法

您可以使用 UpdateDataSource 操作或 ,使用新的 authType和包含相符憑證的秘密更新資料來源,以變更資料來源的身分驗證方法 (例如,從 OAuth 2 AWS 管理主控台.0 變更為基本)。文件層級存取控制設定會在您建立資料來源時修正,因此若要新增或移除 ACLs,您必須建立新的資料來源。

後續步驟

建立資料來源之後,請同步資料來源,以將內容擷取到您的知識庫。如需詳細資訊,請參閱同步資料來源。若要依使用者許可篩選查詢結果,請參閱 文件層級存取控制