文档

API概览

更新时间:
本产品(智能对话机器人/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相似问列表查询知识的相似问题列表。
FAQFAQ
CreateFaq创建FAQ创建一条知识。
DeleteFaq删除FAQ删除一条知识。
UpdateFaq修改FAQ编辑一条知识。
DescribeFaq获取FAQ详情查询知识详情。
SearchFaqFAQ搜索搜索知识。

发布管理

API标题API概述
CreatePublishTask创建发布任务创建发布中心的发布任务。
CancelPublishTask取消发布任务取消正在发布中的任务。
GetPublishTaskState查询发布进度查询发布进度。

业务空间

API标题API概述
GetAgentInfo根据实例ID获取业务空间信息获取业务空间ID。
ListAgent获取业务空间列表获取当前阿里云账号的业务空间列表。

渠道聊天窗

API标题API概述
GenerateUserAccessToken获取用户登录Token用于聊天窗用户免登时,获取Token。通过Token可将用户的企业身份带入机器人。同时支持访客名片的自定义信息的带入。

数据看板

API标题API概述
ListTongyiChatHistorys会话历史明细调用ListTongyiChatHistorys接口获取会话历史明细。
  • 本页导读 (0)