代理
API 鉴权
NOTE
- 获取 AUTH_TOKEN 的途径，可以查看 授权 - 获取 AUTH_TOKEN 部分信息。
- 请确保所有的 API 请求都在请求头中包含 AUTH_TOKEN，如下所示：
SDK 鉴权
NOTE
- 在进行SDK集成之前，请确保已经获得 APP_ID 和 APP_KEY。
- 获取 APP_ID 和 APP_KEY 的途径，可以查看 授权 - 获取 APP_ID & APP_KEY 部分信息。
代理
API 请求示例
- 示例
- 字段描述
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| page | Integer | N | 页码（起始值为0） |
| size | Integer | N | 单页返回记录数 |
| keyword | String | N | 关键词 |
API 响应示例
- 示例
- 字段描述
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| pageNum | Integer | Y | 页码（起始值为0） |
| pageSize | Integer | Y | 单页返回记录数 |
| total | Integer | Y | 总记录数 |
| pages | Integer | Y | 总页面数 |
| currentPageTotal | Integer | Y | 当前页记录数量 |
| content | Array<Object> | Y | 知识库列表内容 |
| content.id | Integer | Y | 代理唯一标识 |
| content.name | String | Y | 代理 - 名称 |
| content.description | String | Y | 代理 - 描述 |
| content.status | String | Y | 代理 - 状态 ENABLED/DISABLED |
| content.createDatetime | Timestamp | Y | 代理 - 创建时间 |
| content.updateDatetime | Timestamp | Y | 代理 - 更新时间 |
代理 执行
执行触发
API 请求示例
- 示例
- 字段描述
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| agentId | Integer | Y | 代理唯一标识 |
| query | String | Y | 代理对话输入 |
API 响应示例
- 示例
- 字段描述
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| taskId | Integer | Y | 代理执行任务ID |
| status | String | Y | 代理执行状态 CREATED/IN_PROCESS/FAILED/FINISHED |
执行进度
API 请求示例
- 示例
- 字段描述
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| id | Integer | Y | 代理执行任务ID |
API 响应示例
- 示例
- 字段描述
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| taskId | Integer | Y | 代理执行任务ID |
| status | String | Y | 代理执行任务状态 CREATED/IN_PROCESS/FAILED/FINISHED |
| nodes | Array<Object> | Y | 节点列表 |
| nodes.number | Integer | Y | 节点序号 |
| nodes.id | Integer | Y | 节点ID |
| nodes.status | String | Y | 节点状态 CREATED/IN_PROCESS/FAILED/FINISHED |
| nodes.result | String | Y | 节点处理结果 |
| nodes.costTime | Integer | Y | 节点处理耗时 |
| nodes.nodeInputs | Array<Object> | Y | 节点输入字段列表 |
| nodes.nodeInputs.name | String | Y | 节点字段名称 |
| nodes.nodeInputs.value | String | Y | 节点字段值 |
| nodes.nodeInputs.type | String | Y | 节点字段类型 REFERENCE/INPUT |
| nodes.nodeOutputs | Array<Object> | Y | 节点输出字段列表 |
| nodes.nodeOutputs.name | String | Y | 节点字段名称 |
| nodes.nodeOutputs.value | String | Y | 节点字段值 |
| nodes.nodeOutputs.type | String | Y | 节点字段类型 STRING,INTEGER,BOOLEAN,NUMBER,OBJECT, ARRAY_STRING,ARRAY_INTEGER, ARRAY_BOOLEAN,ARRAY_NUMBER, ARRAY_OBJECT |