[P075]检索式检索专利嵌套版

post
https://connect.zhihuiya.com/search/patent/nested-search-patent
在体验中心中试用

可以通过标准的PatSnap检索式查询搜索我们的全球专利资料库, 需要了解关于PatSnap搜索语法的信息，请参阅https://analytics.zhihuiya.com/search_helper。返回信息包含：专利数量、专利公开号、专利ID。

field 类型一维分析 limit 不超过 500

field 类型二维分析 limit 不超过 100

最多支持二维分析

aggregate 不支持嵌套

同一层级 facet 不超过 5 个

请求参数

此 API 接口支持的参数列表

名称类型示例描述
facet
arrayPlease check the form: Facet

嵌套统计配置

支持四种类型：

field - 字段统计

range - 范围统计

query - 查询统计

aggregate - 聚合统计

1. field (字段统计)

{ "type": "field", "tag": "patent_type", "field": "PATENT_TYPE", "limit": 10, "mincount": 1, "offset": 0, "num_buckets": true}

2. range (范围统计)

{ "type": "range", "tag": "apd_year", "field": "APD_YEAR", "start": 2000, "end": 2018, "gap": 1}

3. query (查询统计)

{ "type": "query", "tag": "patent_type", "query": "PV:[0 TO 100000]"}

4. aggregate (聚合统计)

{ "type": "aggregate", "tag": "avg_pv", "expr": "avg(PV)"}

end
integer<int32>2018
范围结束值（不包含）（type为range时）
expr
stringavg(PV)
aggregate 表达式，支持嵌套。aggregate function 目前支持 avg/min/max/sum/unique 五种（type为aggregate时）
facet
array[ { "end": 2018, "gap": 1, "tag": "apd_year", "type": "range", "field": "APD_YEAR", "start": 2000 } ]
嵌套统计配置
field
stringANCS
待统计的字段名称（type为field，range时）参考 ： https://analytics.zhihuiya.com/search_helper
gap
integer<int32>1
范围步进值，默认为 1（type为range时）
limit
integer<int32>10
需要返回多少个统计结果（type为field时）
mincount
integer<int32>1
统计可返回的最小值，默认为 1（type为field时）
num_buckets
boolean-
统计number of buckets for the facet ，默认为false。返回格式为tag_num_buckets（type为field时）
offset
integer<int32>10
统计的偏移量，用来做分页，默认为 0（type为field时）
query
stringPV:[0 TO 100000]
需要统计的 query（type为query时）
start
integer<int32>2000
范围起始值（type为range时）
tag
必填
stringancs
当前统计的自定义别名（别名名称不能为 name 和 count）
type
必填
stringfield

检索统计类型：

field - 对字段值的统计，等价于传统的 facet field

range - 对数值字段的范围统计，会自动补全，等价于传统的 range facet

query - 对 query 的统计，等价于传统的 facet query

aggregate - 对字段做 min / max / sum 等 statistic 统计

limit
integer<int32>10
返回文档个数
offset
integer<int32>-
偏移量
query_text
必填
stringTTL:car
检索式, 参考 ： https://analytics.zhihuiya.com/search_helper
sort
array[ { "field": "SCORE", "order": "DESC" } ]
排序
field
stringSCORE
排序字段
order
stringDESC
排序方式
stemming
boolean-
是否开启截词, 开启后支持同一词干查询(例:通过查询car可搜索出cars). 默认不开启. 目前只支持 TTL/ABST/CLMS/DESC相关字段

响应结构

API 响应数据的结构说明

字段名类型示例描述
data
object-
响应数据
facets
object{ "PUM_PROP_ID_CN": [ { "name": "af1d2b97-6078-514c-a2f1-9d930de64767", "count": 158 }, { "name": "6979882c-f05c-516e-9bab-723396999f87", "count": 80 } ], "PUM_PROP_ID_CN_num_buckets": 131 }
统计结果（动态key,根据入参中的tag定义）
num_found
integer<int32>1000
检索到的结果数
id_mapping
objectAnsEntity
ANS时会返回ANS信息, 以ans_id为key
status
必填
booleanfalse
状态
error_msg
stringThe request parameter format is incorrect！
错误信息
error_code
必填
integer0
错误代码

成功响应示例

成功调用 API 的响应示例

JSON 
{
  "data": {
    "facets": {
      "PUM_PROP_ID_CN": [
        {
          "name": "af1d2b97-6078-514c-a2f1-9d930de64767",
          "count": 158
        },
        {
          "name": "6979882c-f05c-516e-9bab-723396999f87",
          "count": 80
        }
      ],
      "PUM_PROP_ID_CN_num_buckets": 131
    },
    "num_found": 1000,
    "id_mapping": "AnsEntity"
  },
  "status": true,
  "error_code": 0
}

错误码

此接口可能返回的错误码列表

业务错误码

错误码描述
68300004请求参数异常!
68300005查询Api失败!
68300006解析基本存取错误!
68300007存在错误的请求!
68300008服务中断异常，请稍后再试!
68300010文件不符合上传规范!

平台错误码

错误码描述
67200000API整体限流错误!
67200001API整体限流错误！
67200002当前调用速率过快,超过当前配置限制QPS！
67200003申请token的key和secret传参不正确或者客户端已被禁用！
67200004请求的接口无权限请联系我们的支持人员！
67200005账户余额/调用次数不足！
67200006客户端超过开通有效期！
67200007当前调用超过当天配置使用额度！
67200008请检查query参数中必填的apikey是否传输！
67200009apikey与所传的bearerToken不匹配,请检查是否使用在有效期内的token！
67200012请求不合法！
67200100当前服务器状态正忙,请求响应超时！
67200101当前请求的Api不存在请检查请求Path！

HTTP 状态码

状态码描述
0请求成功
201Created
401Unauthorized
403Forbidden
404Not Found

性能指标

此接口的预期性能特征

正常响应时间

5000 ms

最大响应时间

10000 ms