智能对话机器人_API文档

智能对话机器人 - OpenAPI 概览2022-04-08
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
文档管理
OpenAPI 名称描述操作
CreateDochot文档新建查看文档去调试
SearchDoc搜索文档查看文档去调试
DescribeDoc文档详情查看文档去调试
UpdateDoc更新文档查看文档去调试
RetryDoc文档重试查看文档去调试
DeleteDoc删除文档查看文档去调试
类目管理
OpenAPI 名称描述操作
CreateCategory新建类目查看文档去调试
DescribeCategory查看单个类目信息查看文档去调试
ListCategoryhot获取类目列表查看文档去调试
UpdateCategory编辑类目查看文档去调试
DeleteCategory删除类目, 已发布的类目变成已删除未发布状态,未发布的类目则直接删除查看文档去调试
会话管理
OpenAPI 名称描述操作
Feedbackhot保存用户对于问答结果的评价查看文档去调试
Chathot根据机器人唯一标识(机器人ID)与其进行会话,仅适用于智能对话机器人(旧版)查看文档去调试
Associatehot根据用户query联想知识库中的FAQ查看文档去调试
BeginSessionhot获取欢迎语接口查看文档去调试
Nlu针对用户query,返回机器人有关这个query的语言理解(nlu)结果。当前只支持对话工厂、中控的NLU信息透出,其他引擎后续按需支持查看文档去调试
TongyiChatDebugInfo大模型问答调试信息查看文档去调试
ApplyForStreamAccessTokenhot获取流式调用的连接信息查看文档去调试
全局服务
OpenAPI 名称描述操作
GetAsyncResult获取异步服务执行结果,配合Chat接口使用查看文档去调试
机器人管理
OpenAPI 名称描述操作
机器人管理
CreateInstance创建沙箱环境机器人查看文档去调试
DescribeInstance查询机器人详情查看文档去调试
ListInstance查询机器人列表查看文档去调试
UpdateInstance更新机器人名称,描述查看文档去调试
LinkInstanceCategory机器人绑定知识类目查看文档去调试
DeleteInstance删除沙箱和线上的机器人查看文档去调试
机器人发布
CreateInstancePublishTask将沙箱机器人发布到线上查看文档去调试
GetInstancePublishTaskState查询机器人发布进度查看文档去调试
ContinueInstancePublishTask机器人发布告警时,忽略告警并继续发布查看文档去调试
CancelInstancePublishTask在发布机器人的过程中,取消机器人发布任务查看文档去调试
FAQ管理
OpenAPI 名称描述操作
FAQ答案
CreateSolutionhot创建知识答案查看文档去调试
ListSolution查询知识的答案列表查看文档去调试
UpdateSolution更新答案查看文档去调试
DeleteSolution删除答案查看文档去调试
FAQ关联问
CreateConnQuestion为知识添加关联知识查看文档去调试
ListConnQuestion查询知识的关联问题列表查看文档去调试
UpdateConnQuestion更新关联关系查看文档去调试
DeleteConnQuestion删除知识的关联知识查看文档去调试
FAQ相似问
CreateSimQuestion创建相似问题查看文档去调试
ListSimQuestion查询知识的相似问题列表查看文档去调试
UpdateSimQuestion更新相似问题查看文档去调试
DeleteSimQuestion删除相似问题查看文档去调试
FAQ
CreateFaq创建一条知识查看文档去调试
DescribeFaq查询知识详情查看文档去调试
SearchFaqhot搜索知识查看文档去调试
UpdateFaq编辑一条知识查看文档去调试
DeleteFaq删除一条知识查看文档去调试
对话工厂
OpenAPI 名称描述操作
实体管理
实体
CreateDSEntity创建实体,特指实体的Meta信息,如:实体名称、实体类型查看文档去调试
DescribeDSEntity查询指定机器人下指定实体的meta信息,如:实体类型、实体名称、创建时间、修改时间等查看文档去调试
ListDSEntity查询指定机器人下的实体列表数据,仅返回每个实体的meta信息,如:实体类型、实体名称、创建时间、修改时间等查看文档去调试
UpdateDSEntity实体meta信息修改,仅支持修改实体名称;实体类型不支持修改查看文档去调试
DeleteDSEntity删除一个实体,会级联删除该实体下所有的实体成员及同义词、正则表达式查看文档去调试
实体成员
CreateDSEntityValue为指定的某个实体,添加实体成员信息,包含:实体值、对应的同义词列表,同一实体内部的实体值、同义词唯一查看文档去调试
ListDSEntityValue查询指定实体的实体成员列表及详情数据,同时支持关键词筛选(contains),筛选范围:实体值、同义词查看文档去调试
UpdateDSEntityValue修改某个实体的某个实体成员,有实体值&同义词、正则表达式两类数据修改。注意:往一个标准实体中添加正则表达式是不被允许的,反之亦然查看文档去调试
DeleteDSEntityValue删除某个实体的某个成员;若为标准实体,会同步删除其同义词(若有)查看文档去调试
意图管理
意图
CreateIntent新建意图,主要包含意图的meta信息,如:意图名称、意图别名、意图关联词槽信息;不包含意图话术、LGF查看文档去调试
DescribeIntent返回指定意图的 meta 信息,如:意图类型、意图名称、创建时间、修改时间等查看文档去调试
ListIntent查询指定机器人下的意图列表数据,仅返回每个意图的 meta 信息,如:意图类型、意图名称、创建时间、修改时间等查看文档去调试
UpdateIntent修改意图,主要包含意图的meta信息,如:意图名称、意图别名、意图关联词槽信息;不包含意图话术、LGF查看文档去调试
DeleteIntent删除一个意图,会级联删除该意图下所有的意图话术和高级语义配置(LGF)查看文档去调试
意图话术
CreateUserSay为指定意图添加话术的信息查看文档去调试
ListUserSay查询指定意图的话术内容及关联槽位信息,支持关键话术筛选(contains)查看文档去调试
UpdateUserSay修改意图话术信息查看文档去调试
DeleteUserSay修改意图话术信息查看文档去调试
高级语义配置(LGF)
CreateLgf为指定意图创建高级语义配置(LGF)查看文档去调试
ListLgf查询指定意图的高级语义配置(LGF)查看文档去调试
UpdateLgf为指定意图创建高级语义配置(LGF)查看文档去调试
DeleteLgf删除指定高级语义配置查看文档去调试
视角管理
OpenAPI 名称描述操作
CreatePerspective创建视角查看文档去调试
DescribePerspective查询视角详情查看文档去调试
QueryPerspectives查询视角列表查看文档去调试
UpdatePerspective更新视角名称和描述查看文档去调试
DeletePerspective删除视角查看文档去调试
发布管理
OpenAPI 名称描述操作
CreatePublishTask创建发布中心的发布任务查看文档去调试
GetPublishTaskState查询发布进度查看文档去调试
CancelPublishTask取消正在发布中的任务查看文档去调试
业务空间
OpenAPI 名称描述操作
GetAgentInfo获取业务空间ID查看文档去调试
ListAgent获取当前阿里云账号的业务空间列表查看文档去调试
渠道聊天窗
OpenAPI 名称描述操作
GenerateUserAccessTokenhot用于聊天窗用户免登时,获取Token,通过该Token可将用户的企业身份带入查看文档去调试
数据看板
OpenAPI 名称描述操作
ListTongyiConversationLogs查询对话机器人通义版的单个会话对话记录查看文档去调试
ListTongyiChatHistorys获取会话历史明细查看文档去调试
GetBotSessionData查询机器⼈问答概览指标查看文档去调试
其他
OpenAPI 名称描述操作
InitIMConnect通过渠道后台配置生成的from值,自定义初始化im连接信息,初始化时支持传递用户鉴权token查看文档去调试
ListSaasInfo获取SaaS被集成信息列表查看文档去调试
ListSaasPermissionGroupInfos获取权限被集成信息列表,可通过该列表返回的权限组,给用户授权查看文档去调试