搜索
系统提供了丰富的搜索语法以满足用户各种场景下的搜索需求。
URL
/search
支持格式
JSON
HTTP请求方式
GET
请求参数
- query参数:查询的主体。可以通过若干子句的组合来实现多样的搜索需求,其中query子句为必选,子句与子句之前通过“&&”进行连接;
- disable参数:目前仅支持”qp”。
- index_name参数:多应用联合查询说明请见本节的“多应用联合查询”介绍;
- fetch_fields参数:返回文本数据大小对查询性能影响较大,建议只获取需要的字段。
- summary参数:格式如下表,summary_element_prefix与summary_element_postfix必须同时设定;同时summary_element与(summary_element_prefix、summary_element_postfix)是相互影响的,出现在后面的配置会覆盖前面。另外,目前不支持摘要和飘红单独设置。
返回结果
- searchtime指引擎耗时,单位为秒。
- items包含两个节点fields及variableValue,其中fields为搜索返回字段内容,variableValue为自定义参数返回结果,如获取distance距离值。
- variableValue节点只有在config子句的format为“xml”或者“fulljson”时才能展现出来,“json”格式默认不展示。
- total、viewtotal、num区别:total为一次查询(不考虑config子句)引擎中符合条件的结果数(在结果数较多情况下,该值会做优化),但考虑到性能及相关性,引擎最多会返回viewtotal个结果,如果需要翻页的话,要求start+hit一定要小于viewtotal,total一般用来做展示。num为本次查询请求(受config子句的start及hit)实际返回的条目,不会超过hit值。
示例
请求:(此处省略了公共参数及编码等因素)
多应用联合查询
- 查询:查询语句必须一致(应用结构可以不一致),该查询会往指定的多个应用分别发送,所以必须保证该查询条件(包含first_formula_name、formula_name及summary等参数)在每个应用上都可以使用。一旦个别应用出现问题,则会报错,并返回其他应用结果。
- 排序:如果用户查询语句中包含sort子句,则获取各个应用结果后按照指定的sort子句再进行一次二次排序;如果没有包含sort子句,则会将各个应用结果交叉展示;如果需要按照相关性(排序表达式)分数进行排序的话,可以显式的在查询语句中指定sort=-RANK。
- 费用计算:对每个应用分别计算一次访问请求。
- 最多支持6个应用查询,超过6个则直接报错无结果。
扫描
传统搜索场景的主要目的是为了尽量短的时间内召回最符合的结果,所以对搜索结果进行了限制。在某些场景下需要提供更多的结果来进行分析工作,可以使用scroll接口来获取更多的结果,[backcolor=transparent]目前scorll只支持query与filter子句,sort子句无法支持。
URL
第一次查询:/search?scroll=1m&search_type=scan
后续查询:/search?scroll=1m&scroll_id=$scroll_id
支持格式
JSON
HTTP请求方式
GET
请求参数
返回结果
示例
第一次请求:(此处省略了公共参数及编码等因素)