Skip to main content
Open In ColabOpen on GitHub

Confluence

Confluence is a wiki collaboration platform that saves and organizes all of the project-related material. Confluence is a knowledge base that primarily handles content management activities.

一个用于 Confluence 页面的加载器。

目前支持 username/api_key、Oauth2 login、cookies。此外，本地部署还支持 token 认证。

指定一个 page_id 和/或 space_key 的列表，以便将对应页面加载到 Document 对象中；如果两者都指定，则返回两者的并集。

您还可以指定一个布尔值 include_attachments 以包含附件，默认情况下该值为 False；如果设置为 True，所有附件将被下载，ConfluenceReader 将从附件中提取文本并将其添加到 Document 对象中。当前支持的附件类型包括：PDF、PNG、JPEG/JPG、SVG、Word 和 Excel。

提示：space_key 和 page_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

个人访问令牌（仅限服务器/本地部署）​

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