开放平台-检索

本章节将讲解：如何使用“开放平台-检索”渠道对文档库进行检索。

渠道配置

点击机器人菜单“部署-渠道”，点击“配置”即可查看渠道ID。渠道ID将用来进行检索API的调用。

使用开放平台渠道

调用前准备

1. 手册顶部工具栏中“开放平台”包含全部的服务端接口和引擎层接口详情。其中服务端接口页面支持快速调用，操作指南请见调用开放平台接口。

2. 开放平台的所有接口调用均需增加鉴权，鉴权详情请见服务账号。

通过开放平台创建用户并发起检索

1. 平台提供机器人的创建用户接口，调用这个接口需要提供如下两个固定参数：

参数名	参数说明	查找方式
agentId	机器人ID，创建机器人后生成	前端URL或机器人设置中
channelId	渠道ID，创建渠道后生成	渠道配置中

2. 平台提供机器人的文档检索接口，调用这个接口需要提供如下四个固定参数：

参数名	参数说明	查找方式
agentId	机器人ID，创建机器人后生成	前端URL或机器人设置中
documentBaseId	文档库ID，创建文档库后生成	前端URL中
channelId	渠道ID，创建渠道后生成	渠道配置中
environment	指定环境，SKETCH即测试环境，PRODUCT即生产环境	根据对接的渠道类型，自行选择

• 接口可以传入未创建用户，未创建用户可以正常检索，但是不会出现在数据统计与检索记录中
• 接口channelId支持传-，用户可以正常检索，但不会出现在数据统计与检索记录中

通过开放平台为文档打标签

平台提供机器人的文档打标签接口，调用这个接口需要提供如下两个固定参数：

参数名	参数说明	查找方式
agentId	机器人ID，创建机器人后生成	前端URL或机器人设置中
documentBaseId	文档库ID，创建文档库后生成	前端URL中

通过开放平台导入导出文档

平台提供机器人的文档导入接口、文档导出接口，调用这个接口需要提供如下两个固定参数：

参数名	参数说明	查找方式
agentId	机器人ID，创建机器人后生成	前端URL或机器人设置中
documentBaseId	文档库ID，创建文档库后生成	前端URL中