文档

API概览

本产品(智能对话机器人/2022-04-08)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用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相似问列表查询知识的相似问题列表。
FAQFAQ
CreateFaq创建FAQ创建一条知识。
DeleteFaq删除FAQ删除一条知识。
UpdateFaq修改FAQ编辑一条知识。
DescribeFaq获取FAQ详情查询知识详情。
SearchFaqFAQ搜索搜索知识。

对话工厂

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-删除删除指定高级语义配置。
UpdateLgfLGF-修改为指定意图创建高级语义配置(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概述
GetBotSessionData机器人接待概况查询机器⼈问答概览指标

其他

API标题API概述
InitIMConnect初始化im连接通过渠道后台配置生成的from值,自定义初始化im连接信息,初始化时支持传递用户鉴权token。
ListSaasInfo获取SaaS被集成信息列表获取SaaS被集成信息列表。
ListSaasPermissionGroupInfos获取权限被集成信息列表获取权限被集成信息列表,可通过该列表返回的权限组,给用户授权。
  • 本页导读 (0)