系统为开发者提供了一套Java SDK服务API。本手册将简单地介绍API列表,及API对应的功能概览。
请注意:
开发者通过API接口传输的数据,请务必进行必要脱敏处理,并确保传输的数据中不包含任何个人信息。
机器人管理
API | 描述 |
用于创建一个Robot实例。每新增1个客户,都须调用本接口创建一个Robot、获取RobotCode。 | |
用于更新机器人配置信息 | |
用于删除指定机器人。删除后该机器人相关的所有数据(包括机器人配置、知识等)也都将被删除,且删除后不可再恢复。 | |
Robot核心问答接口,用于输入用户问题、调用指定机器人获取机器人应答结果。 | |
Robot问答测试接口,用于模拟用户问题,进行应答测试。 |
行业包管理
API | 描述 |
用于查询系统为开发者提供的全部知识包,包括retailbot提供的通用包、行业包、ISV自定义的行业包 | |
用于查询单个指定的行业包有效版本列表 | |
用于批量查询多个行业包的有效版本列表 | |
用于查询指定包的指定版本下,所包含的知识列表 | |
根据指定的行业包查询订阅了指定行业包、指定版本的机器人订阅关系列表 | |
根据机器人Code查询指定机器人与行业包订阅关系列表 | |
为指定机器人订阅指定行业包 | |
为指定机器人取消订阅指定行业包,取消订阅后,该Robot下将无法再查询到该行业包相关的知识(含答案),且重新订阅该行业包后原有答案不会再恢复。 | |
用于将指定Robot的指定行业包,从a版本升级到b版本。版本升级后,相同场景的答案会自动保留,新版本不再包含的场景的答案会自动删除。 |
知识管理
API | 描述 |
查询商家已订阅知识包知识列表 | |
用于查询指定知识的详细信息 | |
将指定Robot的指定场景的启用状态设置为“开启”。场景开启后,在实时问答服务中可被定位到。 | |
将指定Robot的指定场景的启用状态设置为“关闭”。场景关闭后,在实时问答服务中不可被定位到。 |
答案管理
API | 描述 |
用于在指定知识下新建一个答案 | |
用于更新一个已有的答案内容 | |
用于查询一个指定答案的详情 | |
用于删除一个指定的答案。删除后不可再恢复,且无法再查询到已被删除的答案的信息。 |
知识类目树管理
API | 描述 |
获取完整的知识类目树,用于知识库场景展示等功能 |
对话数据管理
API | 描述 |
用于向retailbot回流完整的人机对话日志 | |
用于向retailbot回流完整的人人对话日志 | |
训练师上传语料打标数据训练AI问答模型 |