文档介绍：智能检索接入规范
文件状态：
[] 草稿
[√] 正式发布
[ ]正在修改
文件标识：
当前版本：
作 者：
季振宇
完成日期：
2017-9-30
文件修订记录
版本号
发布时间
作者
备注
2017-6-30
季振宇
初稿
2017-8-30
季振宇
第二版
2017-9-30
季振宇
第三版
2017-12-22
季振宇
2018-09-07
季振宇/王雅
2019-01-15
季振宇/王雅
目录
1. 概述 3
2. 规范&约定 4
. 技术规范 4
. 项目接入流程 4
. 接口规范 5
. 索引权限 6
3. sdk方法列表 7
. getFullTextDataNew（推荐） 7
功能 7
请求参数含义与示例 7
返回结果 11
. heatStatistics 12
功能 12
请求参数含义与示例 13
返回结果 13
. getFullTextData（不再推荐使用） 13
功能 13
请求参数含义与示例 13
返回结果 16
. getFullTextDataForBusiness（不再推荐使用） 18
功能 18
请求参数含义与示例 18
返回结果 21
. getFullTextDataWithTimeOut 21
功能 22
请求参数含义与示例 22
返回结果 25
. addOrUpdateIndex 25
功能 25
请求参数含义与示例 25
返回结果 26
. deleteIndexByIds 26
功能 26
请求参数含义与示例 27
返回结果 27
. deleteALL 27
功能 27
请求参数含义与示例 27
返回结果 28
. deleteByCondition 28
功能 28
请求参数含义与示例 28
返回结果 28
. getHotWords 29
功能 29
请求参数含义与示例 29
返回结果 29
. cleanAllHot 30
功能 30
请求参数含义与示例 30
返回结果 30
. semantic 31
功能 31
请求参数含义与示例 31
返回结果 31
. prompt 31
功能 31
请求参数含义与示例 32
返回结果 32
4. 纯前端调用方式 32
1、全文检索 32
2、智能问答机器人 34
5. 整合场景 34
概述
全文检索本质上是文本检索，即查询硬盘的索引文件，得到想要的数据。它包括索引创建(Indexing)和搜索索引(Search)。
索引创建：按照一定的规则从数据库中将需要检索的数据查询出来，建立索引文件。
搜索索引：利用搜索引擎对索引文件进行检索，返回匹配结果。
规范&约定
技术规范
全文检索搜索引擎提供索引的建立与搜索功能。
索引的建立由项目实施或开发人员按照部署指南中配置要求，配置引擎连接目标数据库采集完成。搜索引擎提供通用化的REST API供开发人员使用，不提供任何搜索界面。
全文检索遵循前后端分离的架构模式，提供标准化的REST API，公司各产品组根据需要开发标准搜索页面，项目组可根据已有前端界面向产品组寻求技术支持。
项目接入流程
项目组需求分析
结合公司产品组已有全文检索标准版方案，分析是否满足项目需求，如果满足就直接部署标准版全文检索引擎使用标准产品页面。
产品组标准方案不满足需求时，如果仅仅是页面的个性化开发，由项目开发或产品组负责处理。需个性化全文检索搜索引擎API的执行步骤4。
产品组没有标准全文检索页面时，由项目组基于标准全文检索引擎API自行开发。
标准搜索引擎API不满足产品或项目组需求时，请一律登记知识库或邮件给网站研发部全文检索负责人员，由网站研发部评审项目需求并给予反馈。
技术支持与维护约定
全文检索不提供任何搜索页面的维护支持，仅在项目组或产品组能够确定是全文检索搜索引擎API、后台配置中心存在异常时，统一登记知识库或邮件反馈给网站研发部处理。
注：全文检索部署参考《》。
接口规范
智能检索搜索引擎为开发者提供了sdk工具包，开发者只需要在项