mirror of
https://github.com/simstudioai/sim.git
synced 2026-02-15 00:44:56 -05:00
356 lines
12 KiB
Plaintext
356 lines
12 KiB
Plaintext
---
|
||
title: Confluence
|
||
description: 与 Confluence 互动
|
||
---
|
||
|
||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||
|
||
<BlockInfoCard
|
||
type="confluence"
|
||
color="#E0E0E0"
|
||
/>
|
||
|
||
{/* MANUAL-CONTENT-START:intro */}
|
||
[Confluence](https://www.atlassian.com/software/confluence) 是 Atlassian 强大的团队协作和知识管理平台。它是一个集中式工作空间,团队可以在其中创建、组织和共享跨部门和组织的信息。
|
||
|
||
使用 Confluence,您可以:
|
||
|
||
- **创建结构化文档**:使用丰富的格式构建全面的维基、项目计划和知识库
|
||
- **实时协作**:与团队成员一起在文档上协作,支持评论、提及和编辑功能
|
||
- **分层组织信息**:通过空间、页面和嵌套层次结构组织内容,实现直观导航
|
||
- **与其他工具集成**:与 Jira、Trello 和其他 Atlassian 产品连接,实现无缝工作流集成
|
||
- **控制访问权限**:管理谁可以查看、编辑或评论特定内容
|
||
|
||
在 Sim 中,Confluence 集成使您的代理能够访问和利用组织的知识库。代理可以从 Confluence 页面检索信息,搜索特定内容,甚至在需要时更新文档。这使您的工作流能够整合存储在 Confluence 实例中的集体知识,从而构建能够参考内部文档、遵循既定程序并维护最新信息资源的代理。
|
||
|
||
## 使用说明
|
||
|
||
将 Confluence 集成到工作流程中。可以读取、创建、更新、删除页面,管理评论、附件、标签,并搜索内容。
|
||
|
||
## 工具
|
||
|
||
### `confluence_retrieve`
|
||
|
||
使用 Confluence API 从 Confluence 页面检索内容。
|
||
|
||
#### 输入
|
||
|
||
| 参数 | 类型 | 必需 | 描述 |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `domain` | string | 是 | 您的 Confluence 域名 \(例如:yourcompany.atlassian.net\) |
|
||
| `pageId` | string | 是 | 要检索的 Confluence 页面 ID |
|
||
| `cloudId` | string | 否 | 实例的 Confluence Cloud ID。如果未提供,将使用域名进行获取。 |
|
||
|
||
#### 输出
|
||
|
||
| 参数 | 类型 | 描述 |
|
||
| --------- | ---- | ----------- |
|
||
| `ts` | string | 检索的时间戳 |
|
||
| `pageId` | string | Confluence 页面 ID |
|
||
| `content` | string | 去除 HTML 标签的页面内容 |
|
||
| `title` | string | 页面标题 |
|
||
|
||
### `confluence_update`
|
||
|
||
使用 Confluence API 更新 Confluence 页面。
|
||
|
||
#### 输入
|
||
|
||
| 参数 | 类型 | 必需 | 描述 |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `domain` | string | 是 | 您的 Confluence 域名 \(例如:yourcompany.atlassian.net\) |
|
||
| `pageId` | string | 是 | 要更新的 Confluence 页面 ID |
|
||
| `title` | string | 否 | 页面的新标题 |
|
||
| `content` | string | 否 | 页面的新内容(以 Confluence 存储格式) |
|
||
| `version` | number | 否 | 页面的版本号 \(用于防止冲突\) |
|
||
| `cloudId` | string | 否 | 实例的 Confluence Cloud ID。如果未提供,将使用域名进行获取。 |
|
||
|
||
#### 输出
|
||
|
||
| 参数 | 类型 | 描述 |
|
||
| --------- | ---- | ----------- |
|
||
| `ts` | string | 更新的时间戳 |
|
||
| `pageId` | string | Confluence 页面 ID |
|
||
| `title` | string | 更新的页面标题 |
|
||
| `success` | boolean | 更新操作的成功状态 |
|
||
|
||
### `confluence_create_page`
|
||
|
||
在 Confluence 空间中创建新页面。
|
||
|
||
#### 输入
|
||
|
||
| 参数 | 类型 | 必需 | 描述 |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `domain` | string | 是 | 您的 Confluence 域名 \(例如:yourcompany.atlassian.net\) |
|
||
| `spaceId` | string | 是 | 创建页面的 Confluence 空间 ID |
|
||
| `title` | string | 是 | 新页面的标题 |
|
||
| `content` | string | 是 | 页面内容(以 Confluence 存储格式 \(HTML\)) |
|
||
| `parentId` | string | 否 | 如果创建子页面,则为父页面 ID |
|
||
| `cloudId` | string | 否 | 实例的 Confluence Cloud ID。如果未提供,将使用域名进行获取。 |
|
||
|
||
#### 输出
|
||
|
||
| 参数 | 类型 | 描述 |
|
||
| --------- | ---- | ----------- |
|
||
| `ts` | string | 创建的时间戳 |
|
||
| `pageId` | string | 创建的页面 ID |
|
||
| `title` | string | 页面标题 |
|
||
| `url` | string | 页面 URL |
|
||
|
||
### `confluence_delete_page`
|
||
|
||
删除 Confluence 页面(将其移至回收站,可从回收站恢复)。
|
||
|
||
#### 输入
|
||
|
||
| 参数 | 类型 | 必需 | 描述 |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `domain` | string | 是 | 您的 Confluence 域名 \(例如:yourcompany.atlassian.net\) |
|
||
| `pageId` | string | 是 | 要删除的 Confluence 页面 ID |
|
||
| `cloudId` | string | 否 | 实例的 Confluence Cloud ID。如果未提供,将使用域名进行获取。 |
|
||
|
||
#### 输出
|
||
|
||
| 参数 | 类型 | 描述 |
|
||
| --------- | ---- | ----------- |
|
||
| `ts` | string | 删除的时间戳 |
|
||
| `pageId` | string | 已删除的页面 ID |
|
||
| `deleted` | boolean | 删除状态 |
|
||
|
||
### `confluence_search`
|
||
|
||
在 Confluence 页面、博客文章和其他内容中搜索内容。
|
||
|
||
#### 输入
|
||
|
||
| 参数 | 类型 | 必需 | 描述 |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `domain` | string | 是 | 您的 Confluence 域名 \(例如:yourcompany.atlassian.net\) |
|
||
| `query` | string | 是 | 搜索查询字符串 |
|
||
| `limit` | number | 否 | 返回的最大结果数 \(默认值:25\) |
|
||
| `cloudId` | string | 否 | 实例的 Confluence Cloud ID。如果未提供,将使用域名进行获取。 |
|
||
|
||
#### 输出
|
||
|
||
| 参数 | 类型 | 描述 |
|
||
| --------- | ---- | ----------- |
|
||
| `ts` | string | 搜索的时间戳 |
|
||
| `results` | array | 搜索结果 |
|
||
|
||
### `confluence_create_comment`
|
||
|
||
向 Confluence 页面添加评论。
|
||
|
||
#### 输入
|
||
|
||
| 参数 | 类型 | 必需 | 描述 |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `domain` | string | 是 | 您的 Confluence 域名 \(例如:yourcompany.atlassian.net\) |
|
||
| `pageId` | string | 是 | 要评论的 Confluence 页面 ID |
|
||
| `comment` | string | 是 | 以 Confluence 存储格式编写的评论文本 |
|
||
| `cloudId` | string | 否 | 实例的 Confluence Cloud ID。如果未提供,将使用域名进行获取。 |
|
||
|
||
#### 输出
|
||
|
||
| 参数 | 类型 | 描述 |
|
||
| --------- | ---- | ----------- |
|
||
| `ts` | string | 创建的时间戳 |
|
||
| `commentId` | string | 创建的评论 ID |
|
||
| `pageId` | string | 页面 ID |
|
||
|
||
### `confluence_list_comments`
|
||
|
||
列出 Confluence 页面上的所有评论。
|
||
|
||
#### 输入
|
||
|
||
| 参数 | 类型 | 必需 | 描述 |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `domain` | string | 是 | 您的 Confluence 域名 \(例如:yourcompany.atlassian.net\) |
|
||
| `pageId` | string | 是 | 要列出评论的 Confluence 页面 ID |
|
||
| `limit` | number | 否 | 返回的最大评论数 \(默认值:25\) |
|
||
| `cloudId` | string | 否 | 实例的 Confluence Cloud ID。如果未提供,将使用域名进行获取。 |
|
||
|
||
#### 输出
|
||
|
||
| 参数 | 类型 | 描述 |
|
||
| --------- | ---- | ----------- |
|
||
| `ts` | string | 检索的时间戳 |
|
||
| `comments` | array | 评论列表 |
|
||
|
||
### `confluence_update_comment`
|
||
|
||
更新 Confluence 页面上的现有评论。
|
||
|
||
#### 输入
|
||
|
||
| 参数 | 类型 | 必需 | 描述 |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `domain` | string | 是 | 您的 Confluence 域名 \(例如:yourcompany.atlassian.net\) |
|
||
| `commentId` | string | 是 | 要更新的 Confluence 评论 ID |
|
||
| `comment` | string | 是 | 更新后的评论文本(以 Confluence 存储格式) |
|
||
| `cloudId` | string | 否 | 实例的 Confluence Cloud ID。如果未提供,将使用域名进行获取。 |
|
||
|
||
#### 输出
|
||
|
||
| 参数 | 类型 | 描述 |
|
||
| --------- | ---- | ----------- |
|
||
| `ts` | string | 更新的时间戳 |
|
||
| `commentId` | string | 更新的评论 ID |
|
||
| `updated` | boolean | 更新状态 |
|
||
|
||
### `confluence_delete_comment`
|
||
|
||
从 Confluence 页面删除评论。
|
||
|
||
#### 输入
|
||
|
||
| 参数 | 类型 | 必需 | 描述 |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `domain` | string | 是 | 您的 Confluence 域名 \(例如:yourcompany.atlassian.net\) |
|
||
| `commentId` | string | 是 | 要删除的 Confluence 评论 ID |
|
||
| `cloudId` | string | 否 | 实例的 Confluence Cloud ID。如果未提供,将使用域名进行获取。 |
|
||
|
||
#### 输出
|
||
|
||
| 参数 | 类型 | 描述 |
|
||
| --------- | ---- | ----------- |
|
||
| `ts` | string | 删除的时间戳 |
|
||
| `commentId` | string | 删除的评论 ID |
|
||
| `deleted` | boolean | 删除状态 |
|
||
|
||
### `confluence_upload_attachment`
|
||
|
||
将文件作为附件上传到 Confluence 页面。
|
||
|
||
#### 输入
|
||
|
||
| 参数 | 类型 | 必需 | 描述 |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `domain` | string | 是 | 您的 Confluence 域名 \(例如:yourcompany.atlassian.net\) |
|
||
| `pageId` | string | 是 | 要附加文件的 Confluence 页面 ID |
|
||
| `file` | file | 是 | 要作为附件上传的文件 |
|
||
| `fileName` | string | 否 | 附件的可选自定义文件名 |
|
||
| `comment` | string | 否 | 附件的可选评论 |
|
||
| `cloudId` | string | 否 | 实例的 Confluence Cloud ID。如果未提供,将使用域名进行获取。 |
|
||
|
||
#### 输出
|
||
|
||
| 参数 | 类型 | 描述 |
|
||
| --------- | ---- | ----------- |
|
||
| `ts` | string | 上传的时间戳 |
|
||
| `attachmentId` | string | 上传的附件 ID |
|
||
| `title` | string | 附件文件名 |
|
||
| `fileSize` | number | 文件大小(以字节为单位) |
|
||
| `mediaType` | string | 附件的 MIME 类型 |
|
||
| `downloadUrl` | string | 附件的下载 URL |
|
||
| `pageId` | string | 添加附件的页面 ID |
|
||
|
||
### `confluence_list_attachments`
|
||
|
||
列出 Confluence 页面上的所有附件。
|
||
|
||
#### 输入
|
||
|
||
| 参数 | 类型 | 必需 | 描述 |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `domain` | string | 是 | 您的 Confluence 域名 \(例如:yourcompany.atlassian.net\) |
|
||
| `pageId` | string | 是 | 要列出附件的 Confluence 页面 ID |
|
||
| `limit` | number | 否 | 返回的最大附件数量 \(默认值:25\) |
|
||
| `cloudId` | string | 否 | 实例的 Confluence Cloud ID。如果未提供,将使用域名进行获取。 |
|
||
|
||
#### 输出
|
||
|
||
| 参数 | 类型 | 描述 |
|
||
| --------- | ---- | ----------- |
|
||
| `ts` | string | 检索的时间戳 |
|
||
| `attachments` | array | 附件列表 |
|
||
|
||
### `confluence_delete_attachment`
|
||
|
||
从 Confluence 页面删除附件(移至回收站)。
|
||
|
||
#### 输入
|
||
|
||
| 参数 | 类型 | 必需 | 描述 |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `domain` | string | 是 | 您的 Confluence 域名 \(例如:yourcompany.atlassian.net\) |
|
||
| `attachmentId` | string | 是 | 要删除的 Confluence 附件 ID |
|
||
| `cloudId` | string | 否 | 实例的 Confluence Cloud ID。如果未提供,将使用域名进行获取。 |
|
||
|
||
#### 输出
|
||
|
||
| 参数 | 类型 | 描述 |
|
||
| --------- | ---- | ----------- |
|
||
| `ts` | string | 删除的时间戳 |
|
||
| `attachmentId` | string | 删除的附件 ID |
|
||
| `deleted` | boolean | 删除状态 |
|
||
|
||
### `confluence_list_labels`
|
||
|
||
列出 Confluence 页面上的所有标签。
|
||
|
||
#### 输入
|
||
|
||
| 参数 | 类型 | 必需 | 描述 |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `domain` | string | 是 | 您的 Confluence 域名 \(例如:yourcompany.atlassian.net\) |
|
||
| `pageId` | string | 是 | 要列出标签的 Confluence 页面 ID |
|
||
| `cloudId` | string | 否 | 实例的 Confluence Cloud ID。如果未提供,将使用域名进行获取。 |
|
||
|
||
#### 输出
|
||
|
||
| 参数 | 类型 | 描述 |
|
||
| --------- | ---- | ----------- |
|
||
| `ts` | string | 检索的时间戳 |
|
||
| `labels` | array | 标签列表 |
|
||
|
||
### `confluence_get_space`
|
||
|
||
获取有关特定 Confluence 空间的详细信息。
|
||
|
||
#### 输入
|
||
|
||
| 参数 | 类型 | 必需 | 描述 |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `domain` | string | 是 | 您的 Confluence 域名 \(例如:yourcompany.atlassian.net\) |
|
||
| `spaceId` | string | 是 | 要检索的 Confluence 空间 ID |
|
||
| `cloudId` | string | 否 | 实例的 Confluence Cloud ID。如果未提供,将使用域名进行获取。 |
|
||
|
||
#### 输出
|
||
|
||
| 参数 | 类型 | 描述 |
|
||
| --------- | ---- | ----------- |
|
||
| `ts` | string | 检索的时间戳 |
|
||
| `spaceId` | string | 空间 ID |
|
||
| `name` | string | 空间名称 |
|
||
| `key` | string | 空间键值 |
|
||
| `type` | string | 空间类型 |
|
||
| `status` | string | 空间状态 |
|
||
| `url` | string | 空间 URL |
|
||
|
||
### `confluence_list_spaces`
|
||
|
||
列出用户可访问的所有 Confluence 空间。
|
||
|
||
#### 输入
|
||
|
||
| 参数 | 类型 | 必需 | 描述 |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `domain` | string | 是 | 您的 Confluence 域名 \(例如:yourcompany.atlassian.net\) |
|
||
| `limit` | number | 否 | 返回的最大空间数量 \(默认值:25\) |
|
||
| `cloudId` | string | 否 | 实例的 Confluence Cloud ID。如果未提供,将使用域名进行获取。 |
|
||
|
||
#### 输出
|
||
|
||
| 参数 | 类型 | 描述 |
|
||
| --------- | ---- | ----------- |
|
||
| `ts` | string | 检索的时间戳 |
|
||
| `spaces` | array | 空间列表 |
|
||
|
||
## 注意事项
|
||
|
||
- 类别:`tools`
|
||
- 类型:`confluence`
|