Skip to main content

Confluence

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

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

目前支持username/api_key，Oauth2登录。此外，本地安装还支持token身份验证。

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

您还可以指定一个布尔值include_attachments来包含附件，默认设置为False，如果设置为True，则会下载所有附件，并且ConfluenceReader将从附件中提取文本并将其添加到文档对象中。当前支持的附件类型有：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 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.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)

个人访问令牌（仅适用于服务器/本地）​

此方法仅适用于数据中心/服务器本地版。 有关如何生成个人访问令牌（PAT）的更多信息，请查看官方Confluence文档：https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html。 使用PAT时，只提供令牌值，无法提供用户名。 请注意，ConfluenceLoader将在生成PAT的用户的权限下运行，并且只能加载该用户具有访问权限的文档。

from langchain.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
)