本产品(
智能对话机器人/2022-04-08
)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。
类目管理
API | 标题 | API概述 |
---|---|---|
CreateCategory | 类目-新建 | 新建类目。 |
DeleteCategory | 类目-删除 | 删除类目, 已发布的类目变成已删除未发布状态,未发布的类目则直接删除。 |
UpdateCategory | 类目-更新 | 编辑类目。 |
DescribeCategory | 类目-详情 | 查看单个类目信息。 |
ListCategory | 获取类目列表 | 获取类目列表。 |
会话管理
API | 标题 | API概述 |
---|---|---|
Feedback | 问答点赞、点踩 | 保存用户对于问答结果的评价。 |
Chat | 会话 | 根据机器人唯一标识(机器人ID)与其进行会话,仅适用于智能对话机器人(旧版)。 |
Associate | 会话-联想API | 根据用户query联想知识库中的FAQ。 |
BeginSession | 获取欢迎语 | 获取欢迎语接口。 |
Nlu | 统一NLU接口 | 针对用户query,返回机器人有关这个query的语言理解(nlu)结果。当前只支持对话工厂、中控的NLU信息透出,其他引擎后续按需支持。 |
全局服务
API | 标题 | API概述 |
---|---|---|
GetAsyncResult | 获取异步函数执行结果 | 获取异步服务执行结果,配合Chat接口使用。 |
机器人管理
API | 标题 | API概述 |
---|---|---|
机器人管理 | 机器人管理 | |
CreateInstance | 机器人-创建 | 创建沙箱环境机器人。 |
DeleteInstance | 机器人-删除 | 删除沙箱和线上的机器人。 |
UpdateInstance | 机器人-更新 | 更新机器人名称,描述。 |
LinkInstanceCategory | 机器人-绑定类目 | 机器人绑定知识类目。 |
DescribeInstance | 获取机器人详情 | 查询机器人详情。 |
ListInstance | 机器人-列表 | 查询机器人列表。 |
机器人发布 | 机器人发布 | |
CreateInstancePublishTask | 创建机器人发布任务 | 将沙箱机器人发布到线上。 |
CancelInstancePublishTask | 取消机器人发布 | 在发布机器人的过程中,取消机器人发布任务。 |
ContinueInstancePublishTask | 继续机器人发布 | 机器人发布告警时,忽略告警并继续发布。 |
GetInstancePublishTaskState | 查询机器人发布进度 | 查询机器人发布进度。 |
FAQ管理
API | 标题 | API概述 |
---|---|---|
FAQ答案 | FAQ答案 | |
CreateSolution | 创建FAQ答案 | 创建知识答案。 |
DeleteSolution | 删除FAQ答案 | 删除答案。 |
UpdateSolution | 更新FAQ答案 | 更新答案。 |
ListSolution | 获取FAQ答案列表 | 查询知识的答案列表。 |
FAQ关联问 | FAQ关联问 | |
CreateConnQuestion | 创建关联问 | 为知识添加关联知识。 |
DeleteConnQuestion | 删除FAQ关联问 | 删除知识的关联知识。 |
UpdateConnQuestion | 更新FAQ关联问 | 更新关联关系。 |
ListConnQuestion | 获取关联问列表 | 查询知识的关联问题列表。 |
FAQ相似问 | FAQ相似问 | |
CreateSimQuestion | 创建相似问 | 创建相似问题。 |
DeleteSimQuestion | 删除FAQ相似问 | 删除相似问题。 |
UpdateSimQuestion | 更新FAQ相似问 | 更新相似问题。 |
ListSimQuestion | 获取FAQ相似问列表 | 查询知识的相似问题列表。 |
FAQ | FAQ | |
CreateFaq | 创建FAQ | 创建一条知识。 |
DeleteFaq | 删除FAQ | 删除一条知识。 |
UpdateFaq | 修改FAQ | 编辑一条知识。 |
DescribeFaq | 获取FAQ详情 | 查询知识详情。 |
SearchFaq | FAQ搜索 | 搜索知识。 |
对话工厂
API | 标题 | API概述 |
---|---|---|
实体管理 | 实体管理 | |
实体 | 实体 | |
CreateDSEntity | 实体-创建 | 创建实体,特指实体的Meta信息,如:实体名称、实体类型。 |
DeleteDSEntity | 实体-删除 | 删除一个实体,会级联删除该实体下所有的实体成员及同义词、正则表达式。 |
UpdateDSEntity | 实体-修改 | 实体meta信息修改,仅支持修改实体名称;实体类型不支持修改。 |
DescribeDSEntity | 实体-详情 | 查询指定机器人下指定实体的meta信息,如:实体类型、实体名称、创建时间、修改时间等。 |
ListDSEntity | 实体-列表 | 查询指定机器人下的实体列表数据,仅返回每个实体的meta信息,如:实体类型、实体名称、创建时间、修改时间等。 |
实体成员 | 实体成员 | |
CreateDSEntityValue | 实体成员-创建 | 为指定的某个实体,添加实体成员信息,包含:实体值、对应的同义词列表,同一实体内部的实体值、同义词唯一。 |
DeleteDSEntityValue | 实体-实体成员-删除 | 删除某个实体的某个成员;若为标准实体,会同步删除其同义词(若有)。 |
UpdateDSEntityValue | 实体成员-修改 | 修改某个实体的某个实体成员,有实体值&同义词、正则表达式两类数据修改。注意:往一个标准实体中添加正则表达式是不被允许的,反之亦然。 |
ListDSEntityValue | 实体成员-列表 | 查询指定实体的实体成员列表及详情数据,同时支持关键词筛选(contains),筛选范围:实体值、同义词。 |
意图管理 | 意图管理 | |
意图 | 意图 | |
CreateIntent | 意图-创建 | 新建意图,主要包含意图的meta信息,如:意图名称、意图别名、意图关联词槽信息;不包含意图话术、LGF。 |
DeleteIntent | 意图-删除 | 删除一个意图,会级联删除该意图下所有的意图话术和高级语义配置(LGF)。 |
UpdateIntent | 意图-修改 | 修改意图,主要包含意图的meta信息,如:意图名称、意图别名、意图关联词槽信息;不包含意图话术、LGF。 |
DescribeIntent | 意图-详情 | 返回指定意图的 meta 信息,如:意图类型、意图名称、创建时间、修改时间等。 |
ListIntent | 意图-列表 | 查询指定机器人下的意图列表数据,仅返回每个意图的 meta 信息,如:意图类型、意图名称、创建时间、修改时间等。 |
意图话术 | 意图话术 | |
CreateUserSay | 意图-话术创建 | 为指定意图添加话术的信息。 |
DeleteUserSay | 意图-话术-删除 | 修改意图话术信息。 |
UpdateUserSay | 意图-话术-修改 | 修改意图话术信息。 |
ListUserSay | 意图-话术-列表 | 查询指定意图的话术内容及关联槽位信息,支持关键话术筛选(contains)。 |
高级语义配置(LGF) | 高级语义配置(LGF) | |
CreateLgf | 意图-LGF-创建 | 为指定意图创建高级语义配置(LGF)。 |
DeleteLgf | 意图-LGF-删除 | 删除指定高级语义配置。 |
UpdateLgf | LGF-修改 | 为指定意图创建高级语义配置(LGF)。 |
ListLgf | 意图-LGF-列表 | 查询指定意图的高级语义配置(LGF)。 |
视角管理
API | 标题 | API概述 |
---|---|---|
CreatePerspective | 视角-创建 | 创建视角。 |
DeletePerspective | 视角-删除 | 删除视角。 |
UpdatePerspective | 视角-更新 | 更新视角名称和描述。 |
DescribePerspective | 视角-详情 | 查询视角详情。 |
QueryPerspectives | 视角-列表 | 查询视角列表。 |
发布管理
API | 标题 | API概述 |
---|---|---|
CreatePublishTask | 创建发布任务 | 创建发布中心的发布任务。 |
CancelPublishTask | 取消发布任务 | 取消正在发布中的任务。 |
GetPublishTaskState | 查询发布进度 | 查询发布进度。 |
业务空间
API | 标题 | API概述 |
---|---|---|
GetAgentInfo | 根据实例ID获取业务空间信息 | 获取业务空间ID。 |
ListAgent | 获取业务空间列表 | 获取当前阿里云账号的业务空间列表。 |
渠道聊天窗
API | 标题 | API概述 |
---|---|---|
GenerateUserAccessToken | 获取用户免登Token | 用于聊天窗用户免登时,获取Token,通过该Token可将用户的企业身份带入。 |
数据看板
API | 标题 | API概述 |
---|---|---|
ListTongyiConversationLogs | 查询单个会话的对话记录 | 查询对话机器人通义版的单个会话对话记录 |
GetBotSessionData | 机器人接待概况 | 查询机器⼈问答概览指标。 |
其他
API | 标题 | API概述 |
---|---|---|
InitIMConnect | 初始化im连接 | 通过渠道后台配置生成的from值,自定义初始化im连接信息,初始化时支持传递用户鉴权token。 |
ListSaasInfo | 获取SaaS被集成信息列表 | 获取SaaS被集成信息列表。 |
ListSaasPermissionGroupInfos | 获取权限被集成信息列表 | 获取权限被集成信息列表,可通过该列表返回的权限组,给用户授权。 |