搜索数据集
功能介绍
搜索数据集。
URI
POST /v1/{project_id}/search/query
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 最小长度:1 最大长度:255 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Content-Type |
是 |
String |
请求体参数类型,该字段必须设置为:application/json。 最小长度:0 最大长度:20 |
Application_ID |
是 |
String |
应用ID。 最小长度:1 最大长度:255 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
query |
是 |
String |
搜索关键词,必输字段,收索查询匹配字段。 最小长度:1 最大长度:255 |
filters |
否 |
Array of filter objects |
过滤条件,条件之间为与关系。 |
sort |
否 |
Array of sort objects |
按指定字段排序。 |
requestTags |
否 |
requestTags object |
请求标识,用于个性化匹配和排序。 |
pagination |
否 |
pagination object |
分页信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
attribute |
否 |
String |
筛选的属性。 最小长度:0 最大长度:255 |
opt |
否 |
String |
筛选条件,opt字段取值为“=、>、>=、<、<=”,除“=”以外的只适用于数值类型,values字段需为数字,含小数如1.00。 枚举值:
|
values |
否 |
Array of strings |
筛选值,当为多值时,表示与关系。 例如:["red", "blue"],表示筛选属性同时满足红色和蓝色的结果。 |
响应参数
状态码: 200
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
totalHits |
是 |
Integer |
结果总数。 |
hits |
否 |
Array of hit objects |
匹配结果集。 |
请求示例
搜索商品
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 |
服务器请求失败。 |
错误码
请参见错误码。