跳至主要內容

Confluence

Confluence 是一個 Wiki 協作平台,可儲存和整理所有專案相關資料。 Confluence 是一個主要處理內容管理活動的知識庫。

用於 Confluence 頁面的載入器。

目前支援 username/api_keyOauth2 登入。此外,內部部署的安裝也支援 token 驗證。

指定 page_id 和/或 space_key 的列表,以將對應的頁面載入到 Document 物件中。如果兩者都指定,則會傳回兩者的聯集。

您還可以指定布林值 include_attachments 來包含附件。預設情況下,此設定為 False。如果設定為 True,則將下載所有附件,並且 ConfluenceReader 將從附件中提取文字,並將其添加到 Document 物件。目前支援的附件類型有:PDFPNGJPEG/JPGSVGWordExcel

提示:space_keypage_id 都可以在 Confluence 頁面的 URL 中找到 - https://yoursite.atlassian.com/wiki/spaces/<space_key>/pages/<page_id>

在使用 ConfluenceLoader 之前,請確保已安裝最新版本的 atlassian-python-api 套件。

%pip install --upgrade --quiet  atlassian-python-api

範例

使用者名稱和密碼或使用者名稱和 API 權杖(僅限 Atlassian Cloud)

此範例使用使用者名稱和密碼進行驗證,或者,如果您連線到 Atlassian Cloud 託管的 Confluence 版本,則使用使用者名稱和 API 權杖。您可以在以下位置產生 API 權杖:https://id.atlassian.com/manage-profile/security/api-tokens

limit 參數指定單次呼叫將檢索多少個文檔,而不是總共將檢索多少個文檔。 預設情況下,該程式碼將以 50 個文檔為一批返回最多 1000 個文檔。 要控制文檔總數,請使用 max_pages 參數。 請注意,atlassian-python-api 套件中 limit 參數的最大值目前為 100。

from langchain_community.document_loaders import ConfluenceLoader

loader = ConfluenceLoader(
url="https://yoursite.atlassian.com/wiki", username="me", api_key="12345"
)
documents = loader.load(space_key="SPACE", include_attachments=True, limit=50)
API 參考:ConfluenceLoader

個人存取權杖(僅限伺服器/內部部署)

此方法僅適用於 Data Center/Server 內部部署版本。 有關如何產生個人存取權杖 (PAT) 的更多資訊,請查看官方 Confluence 文件:https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html。 使用 PAT 時,您只需提供權杖值,而不能提供使用者名稱。 請注意,ConfluenceLoader 將以產生 PAT 的使用者的權限執行,並且只能載入該使用者有權存取的文檔。

from langchain_community.document_loaders import ConfluenceLoader

loader = ConfluenceLoader(url="https://yoursite.atlassian.com/wiki", token="12345")
documents = loader.load(
space_key="SPACE", include_attachments=True, limit=50, max_pages=50
)
API 參考:ConfluenceLoader

此頁面是否有幫助?