Skip to main content
Open In Colab在 GitHub 上打开

合流

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

用于Confluence页面。

这目前支持username/api_key,Oauth2 login,cookies.此外,本地安装还支持token认证。

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

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

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

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

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

例子

用户名和密码或用户名和 API 令牌(仅限 Atlassian Cloud)

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

limitparameter 指定在一次调用中将检索多少个文档,而不是总共检索多少个文档。 默认情况下,该代码将以 50 个文档批次返回最多 1000 个文档。要控制文档总数,请使用max_pages参数。 请注意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 本地版本有效。 有关如何生成 Personal Access Token (PAT) 的更多信息,请查看 Confluence 官方文档:https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html。 使用 PAT 时,您只能提供 token 值,而不能提供用户名。 请注意,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