本产品（
智能对话机器人/2022-04-08）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
文档管理
| API | 标题 | API概述 |
|---|---|---|
| CreateDoc | 文档新建 | 文档新建 |
| DeleteDoc | 删除文档 | 删除文档 |
| UpdateDoc | 更新文档 | 更新文档 |
| RetryDoc | 文档重试 | 文档重试 |
| SearchDoc | 搜索文档 | 搜索文档 |
| DescribeDoc | 文档详情 | 文档详情 |
类目管理
| API | 标题 | API概述 |
|---|---|---|
| CreateCategory | 类目-新建 | 新建类目。 |
| DeleteCategory | 类目-删除 | 删除类目， 已发布的类目变成已删除未发布状态，未发布的类目则直接删除。 |
| UpdateCategory | 类目-更新 | 编辑类目。 |
| DescribeCategory | 类目-详情 | 查看单个类目信息。 |
| ListCategory | 获取类目列表 | 获取类目列表。 |
会话管理
| API | 标题 | API概述 |
|---|---|---|
| ApplyForStreamAccessToken | 获取流式调用的连接信息 | 获取流式调用的连接信息。 |
| Feedback | 问答点赞、点踩 | 保存用户对于问答结果的评价。 |
| BeginSession | 获取欢迎语 | 获取欢迎语接口。 |
全局服务
| API | 标题 | API概述 |
|---|---|---|
| GetAsyncResult | 获取异步函数执行结果 | 获取异步服务执行结果，配合Chat接口使用。 |
机器人管理
| API | 标题 | API概述 |
|---|---|---|
| 机器人管理 | 机器人管理 | |
| CreateInstance | 机器人-创建 | 创建沙箱环境机器人。 |
| DeleteInstance | 机器人-删除 | 删除沙箱和线上的机器人。 |
| UpdateInstance | 机器人-更新 | 更新机器人名称，描述。 |
| ListInstance | 机器人-列表 | 查询机器人列表。 |
FAQ管理
| API | 标题 | API概述 |
|---|---|---|
| FAQ相似问 | FAQ相似问 | |
| CreateSimQuestion | 创建相似问 | 创建相似问题。 |
| DeleteSimQuestion | 删除FAQ相似问 | 删除相似问题。 |
| UpdateSimQuestion | 更新FAQ相似问 | 更新相似问题。 |
| ListSimQuestion | 获取FAQ相似问列表 | 查询知识的相似问题列表。 |
| FAQ | FAQ | |
| CreateFaq | 创建FAQ | 创建一条知识。 |
| DeleteFaq | 删除FAQ | 删除一条知识。 |
| UpdateFaq | 修改FAQ | 编辑一条知识。 |
| DescribeFaq | 获取FAQ详情 | 查询知识详情。 |
| SearchFaq | FAQ搜索 | 搜索知识。 |
发布管理
| API | 标题 | API概述 |
|---|---|---|
| CreatePublishTask | 创建发布任务 | 创建发布中心的发布任务。 |
| CancelPublishTask | 取消发布任务 | 取消正在发布中的任务。 |
| GetPublishTaskState | 查询发布进度 | 查询发布进度。 |
业务空间
| API | 标题 | API概述 |
|---|---|---|
| GetAgentInfo | 根据实例ID获取业务空间信息 | 获取业务空间ID。 |
| ListAgent | 获取业务空间列表 | 获取当前阿里云账号的业务空间列表。 |
渠道聊天窗
| API | 标题 | API概述 |
|---|---|---|
| GenerateUserAccessToken | 获取用户登录Token | 用于聊天窗用户免登时，获取Token。通过Token可将用户的企业身份带入机器人。同时支持访客名片的自定义信息的带入。 |