Document 对象。身份验证方法
支持以下身份验证方法用户名/api_keyOAuth2 登录cookies- 本地部署安装:
token身份验证
页面选择
您可以使用以下方式指定要加载的页面-
page_ids (list):要加载相应页面的
page_id值列表。 -
space_key (string):一个
space_key字符串值,用于加载指定 confluence 空间内的所有页面。
page_ids 和 space_key,加载器将返回两个列表中页面的并集。 提示:space_key 和 page_id 都可以在 Confluence 页面的 URL 中找到:https://yoursite.atlassian.com/wiki/spaces/{space_key}/pages/{page_id}附件
您可以通过将布尔参数 include_attachments 设置为True(默认为 False),将附件包含在加载的 Document 对象中。启用后,所有附件都将被下载,其文本内容将被提取并添加到文档中。 当前支持的附件类型:- PDF (
.pdf) - PNG (
.png) - JPEG/JPG (
.jpeg,.jpg) - SVG (
.svg) - Word (
.doc,.docx) - Excel (
.xls,.xlsx)
在使用 ConfluenceLoader 之前,请确保您已安装最新版本的 atlassian-python-api 包
示例
用户名和密码 或 用户名和 API 令牌 (仅限 Atlassian Cloud)
此示例使用用户名和密码进行身份验证,或者,如果您连接到 Atlassian Cloud 托管的 Confluence 版本,则使用用户名和 API 令牌。您可以在以下网址生成 API 令牌:id.atlassian.com/manage-profile/security/api-tokens。limit 参数指定单次调用将检索多少个文档,而不是总共检索多少个文档。默认情况下,代码将以 50 个文档为一批,最多返回 1000 个文档。要控制文档总数,请使用 max_pages 参数。请注意,atlassian-python-api 包中 limit 参数的最大值当前为 100。个人访问令牌 (仅限服务器/本地部署)
此方法仅适用于数据中心/服务器本地部署版本。有关如何生成个人访问令牌 (PAT) 的更多信息,请查阅官方 Confluence 文档:confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html。使用 PAT 时,您只提供令牌值,不能提供用户名。请注意,ConfluenceLoader 将在生成 PAT 的用户的权限下运行,并且只能加载该用户有权访问的文档。以编程方式连接这些文档到 Claude、VSCode 等,通过 MCP 获取实时答案。