Skip to main content
Open In ColabOpen on GitHub

Confluence

Confluence 是一个维基协作平台,用于保存和组织所有项目相关材料。Confluence 是一个主要处理内容管理活动的知识库。

Confluence页面的加载器。

这目前支持username/api_keyOauth2 logincookies。此外,本地安装还支持token认证。

指定一个由page_id-s和/或space_key组成的列表,以加载相应的页面到Document对象中,如果同时指定了两者,则返回两者的并集。

您还可以指定一个布尔值 include_attachments 以包含附件,此设置默认为 False。如果将其设置为 True,则将下载所有附件并从这些附件中提取文本并添加到 Document 对象中。目前支持的附件类型包括:PDFPNGJPEG/JPGSVGWordExcel

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

在使用ConfluenceLoader之前,请确保已经安装了atlassian-python-api的最新版本:

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

示例

用户名和密码或用户名和API令牌(仅适用于Atlassian云)

此示例使用用户名和密码进行身份验证,或者如果您正在连接到 Atlassian Cloud 托管的 Confluence 版本,则可以使用用户名和 API 令牌进行身份验证。 您可以在以下链接生成 API 令牌:https://id.atlassian.com/manage-profile/security/api-tokens

The limit参数指定了单次调用将检索多少文档,而不是总共将检索多少文档。 默认情况下,代码将在50份文档批次中返回最多1000份文档。要控制总文档数,请使用max_pages参数。 Plese note the maximum value for the limit parameter in the atlassian-python-api包目前是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)

Personal Access Token (Server/On-Prem 只读)

此方法仅适用于本地版的数据中心/服务器。 如需了解如何生成个人访问令牌 (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
)