更新时间:2022-09-30 GMT+08:00
分享

搜索数据集

功能介绍

搜索数据集。

URI

POST /v1/{project_id}/search/query

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

最小长度:1

最大长度:255

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

String

请求体参数类型,该字段必须设置为:application/json。

最小长度:0

最大长度:20

Application_ID

String

应用ID。

最小长度:1

最大长度:255

表3 请求Body参数

参数

是否必选

参数类型

描述

query

String

搜索关键词,必输字段,收索查询匹配字段。

最小长度:1

最大长度:255

filters

Array of filter objects

过滤条件,条件之间为与关系。

sort

Array of sort objects

按指定字段排序。

requestTags

requestTags object

请求标识,用于个性化匹配和排序。

pagination

pagination object

分页信息。

表4 filter

参数

是否必选

参数类型

描述

attribute

String

筛选的属性。

最小长度:0

最大长度:255

opt

String

筛选条件,opt字段取值为“=、>、>=、<、<=”,除“=”以外的只适用于数值类型,values字段需为数字,含小数如1.00。

枚举值:

  • =
  • <
  • <=
  • >
  • >=

values

Array of strings

筛选值,当为多值时,表示与关系。 例如:["red", "blue"],表示筛选属性同时满足红色和蓝色的结果。

表5 sort

参数

是否必选

参数类型

描述

attribute

String

排序字段。

最小长度:0

最大长度:255

order

String

排序策略,desc正序返回,asc倒序返回,默认desc。

缺省值:desc

枚举值:

  • desc
  • asc
表6 requestTags

参数

是否必选

参数类型

描述

requestId

String

请求唯一标识,可以为设备ID/用户ID等唯一标识。

最小长度:0

最大长度:255

表7 pagination

参数

是否必选

参数类型

描述

page

Integer

查询起始页面。

缺省值:1

hitsPerPage

Integer

每页数量。

缺省值:50

响应参数

状态码: 200

表8 响应Body参数

参数

是否必选

参数类型

描述

totalHits

Integer

结果总数。

hits

Array of hit objects

匹配结果集。

表9 hit

参数

是否必选

参数类型

描述

objectId

String

数据ID。

sources

object

匹配的搜索结果,结果字段与数据上传管理接口对应的数据模型字段一致。

请求示例

搜索商品

https://koosearch.myhuaweicloud.com/v1/{project_id}/search/query

{
  "query" : "电动剃须",
  "filters" : [ {
    "attribute" : "onlineFlag",
    "opt" : "=",
    "values" : [ "true" ]
  } ],
  "sort" : [ {
    "attribute" : "goodsPrice",
    "order" : "desc"
  } ],
  "requestTags" : {
    "requestId" : null
  },
  "pagination" : {
    "page" : 1,
    "hitsPerPage" : 10
  }
}

响应示例

状态码: 200

返回信息。

{
  "status": "200",
  "message": "success",
  "data": {
    "totalHits": 1,  
    "hits": [    
      {
        "objectId": "1715166_poa7260552_en",    
        "sources": {      
          "image": "https://www.xxxx/ru/unknow-0/p-1615588.html",    
          "score": 206,          
          "salePrice": 1280,     
          "price": 1900,         
          "webLink": "https://www.xxxx/ru/unknow-0/p-1615588.html",    
          "description": "[\"科技创造美好生活,专注男性洁面护理\"]",   
          "rankScore": null,                 
          "currency": null,                  
          "spuId": null,                     
          "reviewNum": null,                 
          "title": "飞利浦电动剃须刀s1008",  
          "extraInfo": {                     
            "secondClass": "secondclass",   
            "goodsDcn": "0.0",              
            "skuIdStr": "poa6228532",      
            "gender": "female",              
            "spuName": "price_type",        
            "color": "[\"blue\"]",                 
            "minClass": "minclass",         
            "minClassId": "35800101",      
            "secondClassId": "358001",     
            "thirdClassId": "35800101",    
            "size": "[\"16px\"]",                  
            "spuIdStr": "1615411",         
            "activityType": "1",            
            "firstClassId": "3580",        
            "priceType": "1",               
            "shippingWeight": "1.0",        
            "skuName": "poa6228533",        
            "productBrand": "飞利浦",        
            "onlineFlag": "true",             
            "goodsStock": "1000",            
            "firstClass": "first_class",    
            "thirdClass": "thirdclass"      
          }
        }
      }
    ]
  }
}

状态码: 400

详见错误码分类。

{
  "status" : "3014",
  "message" : "请求参数校验不通过",
  "data" : null
}

状态码: 500

服务器请求失败。

{
  "status" : "1000",
  "message" : "服务异常",
  "data" : null
}

状态码

状态码

描述

200

返回信息。

400

详见错误码分类。

500

服务器请求失败。

错误码

请参见错误码

分享:

    相关文档

    相关产品