Skip to main content
Open In ColabOpen on GitHub

Confluence

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

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

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

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

您还可以指定一个布尔值 include_attachments 来包含附件,默认情况下设置为 False,如果设置为 True,所有附件将被下载,并且 ConfluenceReader 将从附件中提取文本并将其添加到 Document 对象中。目前支持的附件类型有:PDF, PNG, JPEG/JPG, SVG, WordExcel

提示: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 Reference: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 Reference:ConfluenceLoader

这个页面有帮助吗?