View a markdown version of this page

連結至知識庫的 Confluence - Amazon Bedrock
支援的功能先決條件連線組態

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

連結至知識庫的 Confluence

重要

為了最佳化擷取準確性和受管體驗，我們建議使用 Amazon Bedrock 受管知識庫。

Atlassian Confluence 是一款協作型工作管理工具，專為共用、儲存和進行專案規劃、軟體開發和產品管理而設計。您可以使用 Amazon Bedrock AWS的 管理主控台或 CreateDataSource API 來連線至 Amazon Bedrock 知識庫的 Confluence 執行個體 （請參閱 Amazon Bedrock 支援的 SDKs和AWS CLI)。 CreateDataSource

注意

Confluence 資料來源連接器目前為預覽版本，並可能會有所變更。

Confluence 資料來源不支援多模態資料，例如資料表、圖表或其他影像。

Amazon Bedrock 支援連結至 Confluence Cloud 執行個體。目前，只有 Amazon OpenSearch Serverless 向量存放區可搭配此資料來源使用。

可網路爬取的檔案數量及每個檔案大小 (MB) 都有限制。請參閱知識庫的配額。

支援的功能

  • 自動偵測主要文件欄位

  • 包含/排除內容篩選條件

  • 新增、更新、刪除內容的增量內容同步

  • OAuth 2.0 身分驗證，使用 Confluence API 字符進行身分驗證

先決條件

在 Confluence 中，請確定您：

  • 記下 Confluence 執行個體的 URL。例如，若是 Confluence Cloud，則為 https://example.atlassian.net。Confluence Cloud 的 URL 必須是基底 URL，結尾為 .atlassian.net。

  • 設定內含使用者名稱 (管理員帳戶的電子郵件) 和密碼 (Confluence API 字符) 的基本身分驗證憑證，以允許 Amazon Bedrock 連結至 Confluence Cloud 執行個體。如需如何建立 Confluence API 字符的相關資訊，請參閱 Atlassian 網站上的管理 Atlassian 帳戶的 API 字符。

  • (選用) 使用應用程式金鑰、應用程式秘密、存取字符和重新整理字符的憑證，來設定 OAuth 2.0 應用程式。如需詳細資訊，請參閱 Atlassian 網站上的 OAuth 2.0 應用程式。

  • 必須啟用特定讀取許可或範圍，OAuth 2.0 應用程式才能連結至 Confluence。

    Confluence API：

    • offline_access

    • read:content:confluence：檢視詳細內容

    • read:content-details:confluence：檢視內容詳細資訊

    • read:space-details:confluence：檢視空間詳細資訊

    • read:audit-log:confluence：檢視稽核記錄

    • read:page:confluence：檢視頁面

    • read:attachment:confluence：檢視和下載內容附件

    • read:blogpost:confluence：檢視部落格文章

    • read:custom-content:confluence：檢視自訂內容

    • read:comment:confluence：檢視註解

    • read:template:confluence：檢視內容範本

    • read:label:confluence：檢視標籤

    • read:watcher:confluence：檢視內容監看器

    • read:relation:confluence：檢視實體關係

    • read:user:confluence：檢視使用者詳細資訊

    • read:configuration:confluence：檢視 Confluence 設定

    • read:space:confluence：檢視空間詳細資訊

    • read:space.property:confluence：檢視空間屬性

    • read:user.property:confluence：檢視使用者屬性

    • read:space.setting:confluence：檢視空間設定

    • read:analytics.content:confluence：檢視內容的分析

    • read:content.property:confluence：檢視內容屬性

    • read:content.metadata:confluence：檢視內容摘要

    • read:inlinetask:confluence：檢視任務

    • read:task:confluence：檢視任務

    • read:whiteboard:confluence：檢視白板

    • read:app-data:confluence：讀取應用程式資料

    • read:folder:confluence：檢視資料夾

    • read:embed:confluence：檢視 Smart Link 資料

在您的帳戶中AWS，請確定您：

  • 將身分驗證憑證存放在 AWS Secrets Manager 機密中，並記下機密的 Amazon Resource Name (ARN)。遵循此頁面上的連線組態指示，以包含必須在機密中包含的鍵/值對。

  • 在知識庫的 AWS Identity and Access Management (IAM) 角色/許可政策中包含要連接至資料來源的必要許可。如需此資料來源新增至知識庫IAM角色的必要許可資訊，請參閱存取資料來源的許可。

注意

如果您使用 主控台，您可以前往 AWS Secrets Manager新增秘密，或使用現有的秘密做為資料來源組態步驟的一部分。您可以在建立知識庫的主控台步驟中，為您建立具有所有必要許可IAM的角色。在您設定資料來源和其他組態之後，具有所有必要許可IAM的角色會套用至您的特定知識庫。

建議定期更新或輪換憑證與機密。僅授予作業所需的最低存取層級，以確保自身安全。不建議您在資料來源之間重複使用憑證和機密。

連線組態

若要連結至 Confluence 執行個體，您必須提供必要的組態資訊，Amazon Bedrock 才能存取和網路爬取資料。您也必須遵循 先決條件。

本節包含此資料來源的組態範例。

如需文件欄位的自動偵測、包含/排除篩選條件、增量同步、私密身分驗證憑證，以及這些運作方式的詳細資訊，請選取下列各項：

資料來源連接器會自動偵測和網路爬取文件或內容的所有主要中繼資料欄位。例如，資料來源連接器可以網路爬取與您文件同等的文件內文、文件標題、文件建立或修改日期，或其他可能適用於文件的核心欄位。

重要

如果您的內容包含敏感資訊，則 Amazon Bedrock可能會使用敏感資訊來回應 。

您可以將篩選運算子套用至中繼資料欄位，以協助您進一步改善回應的相關性。例如，文件「epoch_modification_time」或文件上次更新時間的 1970 年 1 月 1 日經過的秒數。您可以篩選最近的資料，其中「epoch_modification_time」大於特定數字。如需可套用至中繼資料欄位之篩選運算子的詳細資訊，請參閱中繼資料和篩選。

您可以包含或排除網路爬取特定內容。例如，您可以指定排除字首/規則表達式模式，略過對檔案名稱中包含「私有」的任何檔案的網路爬取。您也可以指定包含字首/規則表達式模式，以包含特定內容實體或內容類型。如果您指定包含篩選條件和排除篩選條件，且兩者皆與文件相符，則排除篩選條件會優先，且不會網路爬取文件。

規則表達式模式的範例，用於排除或篩選檔案名稱中包含「私有」的 PDF 檔案：".*private.*\\.pdf"

您可以在下列內容類型上套用包含/排除篩選條件：

  • Space：唯一空格鍵

  • Page：主頁面標題

  • Blog：主要部落格標題

  • Comment：屬於特定頁面或部落格的註解。指定回覆：頁面/部落格標題

  • Attachment：附件檔案名稱及其副檔名

每次資料來源與您的知識庫同步時，資料來源連接器都會編目新的、修改過的和刪除的內容。 Amazon Bedrock可以使用資料來源的機制來追蹤自上次同步以來變更的內容和編目內容。當您第一次將資料來源與知識庫同步時，依預設會網路爬取所有內容。

若要將資料來源與知識庫同步，請使用 StartIngestionJob API，或在主控台中選取知識庫，然後在資料來源概觀區段中選取同步。

重要

您從資料來源同步的所有資料可供具有 bedrock:Retrieve 許可能擷取資料的任何人使用。這也可以包含具有受控資料來源許可的任何資料。如需詳細資訊，請參閱知識庫許可。

(如果使用基本身分驗證) 您在 AWS Secrets Manager 中的私密身分驗證憑證應包含這些鍵/值對：

  • username：Atlassian 帳戶的管理員使用者電子郵件地址

  • password：Confluence API 字符

(如果使用 OAuth 2.0 身分驗證) 您在 AWS Secrets Manager 中的私密身分驗證憑證應包含這些鍵/值對：

  • confluenceAppKey：應用程式金鑰

  • confluenceAppSecret：應用程式秘密

  • confluenceAccessToken：應用程式存取字符

  • confluenceRefreshToken：應用程式重新整理字符

注意

Confluence OAuth2.0 存取字符的預設到期時間為 60 分鐘。如果此字符在資料來源同步 (同步任務) 時過期，Amazon Bedrock 將使用提供的重新整理字符來重新產生此字符。此重新產生會同時重新整理存取和重新整理字符。為了讓字符從目前同步任務更新到下一個同步任務，Amazon Bedrock 需要秘密憑證的寫入/放置許可，作為知識庫 IAM 角色的一部分。

注意

您在 中的秘密AWS Secrets Manager必須使用與知識庫相同的區域。

Console
將 Confluence 執行個體連結至知識庫

  1. 遵循 透過連線至 Amazon Bedrock 知識庫中的資料來源來建立知識庫 中的步驟，然後選擇 Confluence 作為資料來源。

  2. 提供資料來源的名稱和選用的描述。

  3. 提供 Confluence 執行個體 URL。例如，若是 Confluence Cloud，則為 https://example.atlassian.net。Confluence Cloud 的 URL 必須是基底 URL，結尾為 .atlassian.net。

  4. 在進階設定區段中，您可以選擇設定下列項目：

    • 用於暫時性資料儲存的 KMS 金鑰。– 您可以使用預設AWS 受管金鑰或您自己的 KMS 金鑰，在將資料轉換為內嵌時加密暫時性資料。如需詳細資訊，請參閱資料擷取期間的暫時性資料儲存加密。

    • 資料刪除政策 – 您可以刪除預設存放在向量存放區中資料來源的向量嵌入，或選擇保留向量存放區資料。

  5. 提供驗證資訊以連結到 Confluence 執行個體：

    • 如需基本身分驗證，請前往 AWS Secrets Manager新增秘密身分驗證憑證，或為您建立的秘密使用現有的 Amazon Resource Name (ARN)。您的密碼必須包含 Atlassian 帳戶的管理員使用者電子郵件地址作為使用者名稱，以及 Confluence API 字符來取代密碼。如需如何建立 Confluence API 字符的相關資訊，請參閱 Atlassian 網站上的管理 Atlassian 帳戶的 API 字符。

    • 對於 OAuth 2.0 身分驗證，請前往 AWS Secrets Manager新增秘密身分驗證憑證，或為您建立的秘密使用現有的 Amazon Resource Name (ARN)。您的密碼必須包含 Confluence 應用程式金鑰、應用程式私密、存取字符和重新整理字符。如需詳細資訊，請參閱 Atlassian 網站上的 OAuth 2.0 應用程式。

  6. (選用) 在內容剖析和分塊區段中，您可以自訂如何將資料剖析和分塊。請參閱下列資源進一步了解這些自訂項目：

  7. 選擇以使用篩選條件/規則表達式模式來包含或排除特定內容。否則將會網路爬取所有標準內容。

  8. 繼續選擇嵌入模型和向量存放區。若要查看剩餘的步驟，請返回透過連線至 Amazon Bedrock 知識庫中的資料來源來建立知識庫，並在連接資料來源後繼續進行該步驟。

API

以下是 Amazon Bedrock 知識庫連結至 Confluence Cloud 的組態範例。您可以使用 API 搭配 AWS CLI或支援的 SDK 來設定資料來源，例如 Python。呼叫 CreateKnowledgeBase 之後，您可以呼叫 CreateDataSource，在 dataSourceConfiguration 中使用連線資訊建立資料來源。

若要了解您可以透過包含選用 vectorIngestionConfiguration 欄位套用至擷取的自訂項目，請參閱自訂資料來源的擷取。

AWS Command Line Interface

aws bedrock create-data-source \
 --name "Confluence Cloud/SaaS connector" \
 --description "Confluence Cloud/SaaS data source connector for Amazon Bedrock to use content in Confluence" \
 --knowledge-base-id "your-knowledge-base-id" \
 --data-source-configuration file://confluence-bedrock-connector-configuration.json \
 --data-deletion-policy "DELETE" \
 --vector-ingestion-configuration '{"chunkingConfiguration":[{"chunkingStrategy":"FIXED_SIZE","fixedSizeChunkingConfiguration":[{"maxTokens":"100","overlapPercentage":"10"}]}]}'

confluence-bedrock-connector-configuration.json
{
    "confluenceConfiguration": {
        "sourceConfiguration": {
            "hostUrl": "https://example.atlassian.net",
            "hostType": "SAAS",
            "authType": "OAUTH2_CLIENT_CREDENTIALS",
            "credentialsSecretArn": "arn:aws::secretsmanager:your-region:secret:AmazonBedrock-Confluence"
        },
        "crawlerConfiguration": {
            "filterConfiguration": {
                "type": "PATTERN",
                "patternObjectFilter": {
                    "filters": [
                        {
                            "objectType": "Attachment",
                            "inclusionFilters": [
                                ".*\\.pdf"
                            ],
                            "exclusionFilters": [
                                ".*private.*\\.pdf"
                            ]
                        }
                    ]
                }
            }
        }
    },
    "type": "CONFLUENCE"
}