連接至 Confluence 以使用 Amazon Bedrock 知識庫

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

注意

Confluence 資料來源連接器處於預覽版本中，可能會有所變更。

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

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

每個檔案可以爬取的檔案和 MB 數量有限制。如需知識庫，請參閱配額。

支援的功能

自動偵測主要文件欄位
包含/排除內容篩選條件
新增、更新、刪除內容的增量內容同步
OAuth 2.0 身分驗證，使用 Confluence API字符進行身分驗證

必要條件

在 Confluence 中，請確定您：

請記下您的 Confluence 執行個體 URL。例如，針對 Confluence Cloud， https://example.atlassian.net。URL 適用於 Confluence Cloud 的必須是基本 URL，以結尾.atlassian.net。
設定包含使用者名稱（管理帳戶的電子郵件）和密碼 (Confluence API字符）的基本身分驗證憑證，以允許 Amazon Bedrock 連線至 Confluence Cloud 執行個體。如需有關如何建立 Confluence API權杖的資訊，請參閱 Atlassian 網站上的管理 Atlassian 帳戶的權API杖。
（選用） OAuth 使用應用程式金鑰、應用程式秘密、存取字符和重新整理字符的登入資料來設定 2.0 應用程式。如需詳細資訊，請參閱 Atlassian 網站上的 OAuth2.0 應用程式。
必須啟用特定讀取許可或範圍，您的 OAuth 2.0 應用程式才能連線至 Confluence。

ConfluenceAPI：
- 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" 大於特定數字。如需可套用至中繼資料欄位之篩選運算子的詳細資訊，請參閱中繼資料和篩選。

您可以包含或排除爬取特定內容。例如，您可以指定排除prefix/regular expression pattern to skip crawling any file that contains “private” in the file name. You could also specify an inclusion prefix/regular表達式模式，以包含特定內容實體或內容類型。如果您指定包含和排除篩選條件，且兩者都符合文件，則排除篩選條件優先，且文件不會編目。

一般表達式模式的範例，以排除或篩選檔案名稱中PDF包含「私有」的檔案：「.*private.*\\.pdf」

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

Space：唯一空格鍵
Page：主頁面標題
Blog：主要部落格標題
Comment：屬於特定頁面或部落格的評論。指定 Re: Page/Blog Title
Attachment：附件檔案名稱及其副檔名

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

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

重要

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

（如果使用基本身分驗證）中的秘密身分驗證憑證 AWS Secrets Manager 應包含這些鍵/值對：

username: admin user email address of Atlassian account
password: Confluence API token

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

confluenceAppKey: app key
confluenceAppSecret: app secret
confluenceAccessToken: app access token
confluenceRefreshToken: app refresh token

注意

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

注意

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

Console

將 Confluence 執行個體連接至您的知識庫

遵循中的步驟在 Amazon Bedrock 知識庫中建立知識庫，然後選擇 Confluence 作為資料來源。
提供資料來源的名稱和選用描述。
提供您的 Confluence 執行個體 URL。例如，對於 Confluence Cloud，https://example.atlassian.net。URL 適用於 Confluence Cloud 的必須是基本 URL，以結尾.atlassian.net。
在進階設定區段中，您可以選擇設定下列項目：
- KMS 暫時性資料儲存的金鑰。– 您可以在使用預設 AWS 受管金鑰或您自己的KMS金鑰將資料轉換為內嵌時加密暫時性資料。如需詳細資訊，請參閱資料擷取期間的暫時性資料儲存加密。
- 資料刪除政策 – 預設情況下，您可以刪除存放於向量存放區之資料來源的向量內嵌，或選擇保留向量存放區資料。
提供身分驗證資訊以連線至 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 網站上的 OAuth2.0 應用程式。
（選用）在內容剖析和區塊化區段中，您可以自訂如何剖析和區塊化資料。請參閱下列資源，進一步了解這些自訂項目：
- 如需剖析選項的詳細資訊，請參閱資料來源的剖析選項。
- 如需區塊化策略的詳細資訊，請參閱內容區塊如何適用於知識庫。
  
  警告
  您無法在連線至資料來源後變更區塊化策略。
- 如需如何使用 Lambda 函數自訂資料區塊和處理中繼資料的詳細資訊，請參閱使用自訂轉換 Lambda 函數來定義如何擷取您的資料。
選擇使用篩選條件/規則表達式模式來包含或排除特定內容。否則會爬取所有標準內容。
繼續選擇內嵌模型和向量存放區。若要查看剩餘的步驟，請返回，在 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"
}

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

Amazon S3

Microsoft SharePoint

連接至 Confluence 以使用 Amazon Bedrock 知識庫

注意

主題

支援的功能

必要條件

注意

連線組態

重要

重要

注意

注意

將 Confluence 執行個體連接至您的知識庫

警告