Appearance
组件服务
什么是组件
组件(Component)是平台中可被应用复用的能力单元。应用(App)在编排时挂载组件,运行期由组件提供具体能力——工作流负责固定流程编排、知识库负责检索增强、三方服务负责对接外部工具。
组件既可挂载到 Agent / AgentLite 应用内由 Agent 自行调度,也可通过 OpenAPI 独立调用。
组件类型
| 组件 | 标识前缀 | 说明 |
|---|---|---|
| 工作流 | /workflow | 将多步骤逻辑编排为可视化节点流,按节点顺序执行并返回结果 |
| 知识库 | /knowledge | 以「知识库 + 数据集 + 分段」三级组织的检索能力,支持文档集、表格集、图片集 |
| 三方服务 | /third-party-service | 已接入的外部服务(如 Tavily 搜索、豆包语音),以「服务 + 工具」两级组织 |
工作流
工作流(Workflow)将对话或任务逻辑编排为可视化节点流,按节点顺序执行。发布后可通过 OpenAPI 独立调用,支持阻塞与 SSE 流式两种返回方式。
适用场景:固定流程的多步骤任务,如分步问诊、信息采集、固定审批流程等。
详见 工作流 API。
知识库
知识库(Knowledge)以「知识库(knowledge) + 数据集(dataset) + 分段(segment)」三级组织,第三方调用方通常只关心知识检索。当前一期开放发现(列表 / 详情)与检索共三个只读接口。
知识库分为三种类型:
type | 类型 | 说明 |
|---|---|---|
1 | 文档集 | 文本类知识库(PDF、Word、Markdown 等切分后入库) |
2 | 表格集 | 结构化数据知识库,分段内容为行级数据拼接 |
3 | 图片集 | 图片标注知识库,分段对应图片描述/标注,命中结果额外返回 image 字段 |
适用场景:医疗百科问答、结构化数据查询、图片标注检索等检索增强场景。
详见 知识库调用说明。
三方服务
三方服务(Third-party Service)以「服务(service) + 工具(tool)」两级组织,URL 中的 :service 与 :tool 均为 slug 字符串(如 tavily_search、doubao_speech),不是 UUID。
提供服务列表、工具列表、工具调用三个通用接口;具体某类服务的工具清单与入参结构请查阅对应子页面。
适用场景:联网搜索、语音合成/识别等需要对接外部能力的场景。
详见 三方服务调用说明。
公共约定
基地址
各组件模块前缀拼接在统一基地址之后,基地址请参考 快速开始。
请求头(公共)
| 参数名 | 必填 | 说明 |
|---|---|---|
| Authorization | 是 | 鉴权凭证,格式 Bearer sk_xxx |
统一响应格式
json
{
"code": 200,
"data": {},
"message": "",
"trace_id": "xxx"
}TIP
鉴权类错误(401/403)由网关直接返回,不会进入业务错误清单。详见 错误处理。
接口入口
| 组件 | 入口 |
|---|---|
| 工作流 | 工作流 API |
| 知识库 | 调用说明 · 知识库列表 · 知识库详情 · 知识检索 |
| 三方服务 | 调用说明 · 服务列表 · 工具列表 · 工具调用 |
