搜索处理

/v3/openapi/apps/$app_name/search?fetch_fields=name&query=config=format:fulljson&&query=name:'zhangsan'&&sort=id

• $app_name：表示应用名（高级版/标准版是多应用版本类型，需要指定应用名访问，主要针对服务中的应用版本，如填写线下应用ID可访问线下应用搜索服务）。

• 以上 URL 省略了请求Header参数及编码等因素。

• 以上 URL 中省略了访问应用的 host 地址。

• 以上URL 中拼接的所有查询参数，请查看下方“查询参数”的参数定义、使用方式及样例。

HTTP

GET

JSON

查询参数具体拼接规则，详情请参见V3版API签名机制文档。

查询参数用法

• query：可以通过若干子句的组合来实现多样的搜索需求，query参数中各子句之间通过&&进行连接。

• fetch_fields：返回文本数据大小对查询性能影响较大，建议只获取需要的字段。如果SDK/API中有配置该参数会覆盖控制台中对应功能配置。

• qp：如果SDK/API中有配置该参数会覆盖控制台中对应功能配置。

注意事项：qp的生效过程以及结果可以在控制台搜索测试页面查看，API/SDK暂不支持透出。

• disable：目前支持禁用qp、summary、first_rank、second_rank、re_search等参数功能。

  功能说明

  • 控制查询过程中关闭某些功能

  • 目前支持禁用查询分析、飘红、粗精排, 重查等参数功能

  参数格式：

  disable=function[;function]
  function=function_name[:function_param]

  • 例如：

    • 关闭查询分析， disable=qp

    • 关闭查询分析中的spell_check功能，disable=qp:spell_check，格式：disable=qp:$qp_processor_name，参考：QueryProcessor

    • 关闭重查, disable=re_search

• first_rank_name：如果SDK/API中有配置该参数会覆盖控制台中对应功能配置。

• second_rank_name：如果SDK/API中有配置该参数会覆盖控制台中对应功能配置。

• user_id：

  • 在搜索请求中设置时候，user_id的值需要做urlencode。

  • 数据统计功能在统计UV信息时依赖该参数做统计。

  • 如果有对接数据采集，尽量让上报行为数据时候的user_id和查询请求中的user_id保持设置规则一致。

• abtest参数格式：abtest=urlencode(scene_tag:urlencode(\$scene),flow_divider:urlencode(\$value))，其中urlencode为URL编码函数。

  • flow_divider推荐为最终用户的ID，如果没有的话可以用最终用户的设备ID或者IP地址，该参数必须指定。

  • scene_tag：场景标识，如果用户在控制台上没有设置表示对所有场景下的流量都会做实验，查询中就不用设置scene_tag。

• raw_query：

  功能说明

  • 用于类目预测查询；只有查询词和raw_query的内容一致时，查询时，才会去查查询分析中配置的类目预测；

  • 用于类目预测等算法训练使用，因此，建议所有查询都设置该参数；

  • 一般建议设置为终端用户输入的原始查询词。

  参数格式：

  raw_query=content

  • content: 原始查询词

• re_search：

  功能说明

  • 用来设置重查策略，当前只支持按照total hits的阈值来设置。

  • 需配置查询分析功能。

  • 若query中的查询词分词后的term实体识别权重都一样，则不会触发重查，需干预实体识别类别权重。

  参数格式：

  re_search=strategy:threshold,params:total_hits#${COUNT}

  • COUNT: 触发重查时的total_hits上限。即当total hits少于COUNT时，会进行重查

  • 样例：

    • re_search=url_encode(strategy:threshold,params:total_hits#6)

• biz：

  功能说明

  • 用来描述本次请求的相关业务信息。比如本次请求来源的业务类型。

    参数格式：

    biz=type:$TYPE

  • type: 用户用来设置流量的类型，取值用户自己确定，后续可以在报表中区分不同的来源统计

  • 样例：

    • biz=type:home_page

• vector_threshold：

• summary：

  • summary_element_prefix 与 summary_element_postfix 必须同时设定。

  • summary_element 与 （summary_element_prefix、summary_element_postfix）是相互影响的，出现在后面的配置会覆盖前面。

  • 目前不支持摘要和飘红单独设置。

  • 如果SDK/API中有配置该参数会覆盖控制台中对应功能配置。

返回结果

• searchtime：指引擎耗时，单位为秒。

• total、viewtotal、num区别：total为一次查询（不考虑config子句）引擎中符合条件的结果数（在结果数较多情况下，该值会做优化），但考虑到性能及相关性，引擎最多会返回viewtotal个结果。如果需要翻页的话，要求start+hit必须要小于viewtotal，total一般用来做展示。num为本次查询请求（受限于config子句的start及hit）实际返回的条目，不会超过hit值。

• compute_cost：是一个只有一个map元素的数组，其中index_name表示应用ID，value表示本次查询消耗的LCU。

• items：包含查询召回数据信息，其中fields为搜索召回内容。

• variableValue：表示自定义参数返回结果，如获取distance距离值，variableValue 节点只有在config子句的format为xml或者fulljson时才能展现出来，json格式默认不展示。

• sortExprValues： 表示对应文档排序分。

• facet：用于存放Aggregate子句返回的信息。

• array字段类型：通过JSON和fulljson格式返回，数据之间通过\t分割，如果通过xml格式返回，通过空格分割

Search示例

返回结果JSON

{
 "result": {
  "searchtime": 0.009554,
  "total": 1,
  "compute_cost": [
   {
    "index_name": "110247758",
    "value": 0.304
   }
  ],
  "num": 1,
  "viewtotal": 1,
  "items": [
   {
    "variableValue": {

    },
    "sortExprValues": [
     "10000"
    ],
    "property": {

    },
    "attribute": {

    },
    "fields": {
     "size": "XL",
     "discount_price": "9.9",
     "pid": "950",
     "range_age": "18\t25",
     "detail": "男士夹克翻领2021春秋新款青年薄款上衣休闲拉链外套",
     "index_name": "110247758"
    }
   }
  ],
  "facet": []
 },
 "ops_request_misc": "%7B%22request%5Fid%22%3A%22162642700916781929257960%22%2C%22scm%22%3A%2220140713.110229359..%22%7D",
 "tracer": "",
 "request_id": "162642700916781929257960",
 "errors": [],
 "status": "OK"
}

错误返回

{
 "result": {
  "searchtime": 0.003999,
  "total": 0,
  "compute_cost": [
   {
    "index_name": "110247758",
    "value": 0.232
   }
  ],
  "num": 0,
  "viewtotal": 0,
  "items": [],
  "facet": []
 },
 "ops_request_misc": "%7B%22request%5Fid%22%3A%22162642716516781913069826%22%2C%22scm%22%3A%2220140713.110229359..%22%7D",
 "tracer": "",
 "request_id": "162642716516781913069826",
 "errors": [
  {
   "code": 6127,
   "message": "Attribute not exist."
  }
 ],
 "status": "FAIL"
}

• 说明：status为FAIL表示既有error又无结果返回；但可能会出现既有error，又会有结果返回，此时status就为OK. 如出现1000 server error（搜索超时）；或者2112（未指定精排中设置的索引）等报错时，仍可能有结果返回。

传统搜索场景的主要目的是为了尽量短的时间内召回最符合的结果，所以对搜索结果进行了限制，例如 search方法最多只能召回5000条文档。在某些场景下需要提供更多的结果来进行分析工作，可以使用scroll接口来获取更多的结果。

支持子句

• query子句。

• config子句（start参数无效）。

• filter子句。

• sort子句（只支持单字段INT类型，仅限v3版API及SDK）。

URL

首次查询

/v3/openapi/apps/$app_name/search?search_type=scan&scroll=1m&查询参数

后续查询

/v3/openapi/apps/$app_name/search?scroll_id=$scroll_id&scroll=1m&查询参数

• $app_name：表示应用名。

• 以上 URL 中省略了访问应用的 host 地址。

• 以上2次 scroll请求 URL 省略了请求Header参数，查询参数对应内容，及编码等因素，完整scroll 请求 URL 参考下面示例描述。

• scroll 方法支持的功能较少，大部分功能都不支持，具体功能限制参考底部注意事项。

HTTP

GET

JSON

第一次请求

http://$host/v3/openapi/apps/app_schema_demo/search?query=config=start:0,hit:1,format:fulljson,rerank_size:200&&query=name:'搜索'&&sort=+id&&filter=id>0&search_type=scan&scroll=1m&fetch_fields=id;name;phone;int_arr;literal_arr;float_arr;cate_id

成功返回

{
  "status": "OK",
  "request_id": "150150574119953661605242",
  "result": {
    "searchtime": 0.005029,
    "total": 1,
    "num": 0,
    "viewtotal": 1,
    "scroll_id": "eJxtUMtuhDAM/BrvOYQC5cABdulvRFFIirsm2TpBavv1Ndut1EMlS36NZ0Y2ZHMxbueceAjIuWCMnrPjRITLyfzZm83y9V QVGT8x80U3PxQNUqieVZV1/an4ItbTUBPSx5wgXqKdvOSbmuKR8ZYjGWWirB4tvToAiX7u3G2eCNK77vnz8GlGPAV6suKBeqxAn0OiTd7NGEnesspyoyFLF6hecn4JUKjVgp0K3FnkfMfIyPoDuYWegX9GeYOpicY9TG8gwOSuBL04X1 MMg3ROwCesLlG6X7a2o=",
    "items": [],
    "facet": []
  },
  "errors": [],
  "tracer": ""
}

后续请求

http://$host/v3/openapi/apps/app_schema_demo/search?fetch_fields=id;name;phone;int_arr;literal_arr;float_arr;cate_id&query=config=start:0,hit:1,format:fulljson,rerank_size:200&&query=name:'搜索'&&sort=+id&&filter=id>0&scroll=1m&scroll_id=eJxtUMtuhDAM/BrvOYQC5cABdulvRFFIirsm2TpBavv1Ndut1EMlS36NZ0Y2ZHMxbueceAjIuWCMnrPjRITLyfzZm83y9V+QVGT8x80U3PxQNUqieVZV1/an4ItbTUBPSx5wgXqKdvOSbmuKR8ZYjGWWirB4tvToAiX7u3G2eCNK77vnz8GlGPAV6suKBeqxAn0OiTd7NGEnesspyoyFLF6hecn4JUKjVgp0K3FnkfMfIyPoDuYWegX9GeYOpicY9TG8gwOSuBL04X1+MMg3ROwCesLlG6X7a2o=

返回结果

{
  "status": "OK",
  "request_id": "150150574119952551519970",
  "result": {
    "searchtime": 0.006293,
    "total": 1,
    "num": 1,
    "viewtotal": 1,
    "scroll_id": "eJxNT9tugzAM/RrznIRC4YEHaNlvRFFIhteQtE6Qtn39TNdJk2z5dnx8rIPJRdudcqKhl60Uir2Vp06ISv8b6s3QbZCVzpaCdp93XXBzg2wEW9MJ2dWq8q7YVXt0YckDLlBP0WyOw31N8YgYizZEnAUsjkx4VT4k8zexpjiNS/XYHX0NNkWP71BfVyxQjxLUxSfazFH4PYSPnCL3iMniDZq3jN98aFRCgGrZniy8/itkBHWGuYVeQH+B+QzTCUZ1NJ9gj4FVMfrQPr8Y+Hk+dgU14fIDVhtfTw==",
    "items": [
      {
        "fields": {
          "cate_id": "0",
          "float_arr": "0",
          "id": "1",
          "int_arr": "0",
          "literal_arr": "搜索",
          "name": "搜索",
          "phone": "123****5678",
          "index_name": "app_schema_demo"
        },
        "property": {},
        "attribute": {},
        "variableValue": {},
        "sortExprValues": [
          "1"
        ]
      }
    ],
    "facet": []
  },
  "errors": [],
  "tracer": ""
}