接口文档

请先查看接入指引了解具体接入方式，再参考此文档完成接入。

请求header

以下请求参数列表仅列出了接口请求参数和必要公共参数，完整公共参数列表见 公共参数

向图库中添加一张图片。

输入参数

（1）Query参数：

（2）Body参数：

PS: ${product_id}_${image_id} 即为图片唯一pid

请求示例

{
        "product_id": "test",
        "image_id": "test1",
        "category_id": 1,
        "url": "https://img.tvc-mall.com/uploads/IPHONE-610.jpg",
        "custom_content": "custom",
        "int_attr": 1,
        "str_attr": "str",
        "crop": true,
        "region": {
            "x1": 1,
            "x2": 2,
            "y1": 3,
            "y2": 4,
        }
    }
}

API返回

data字段

注：data字段包含在通用返回字段中，具体见通用返回字段及错误码

msg可能出现以下几种情况：

错误码

注：其余请参考通用返回字段及错误码

返回值示例

{
    "status": 10000,
    "code": 10000,
    "time_elapsed": "3.193254432s",
    "request_id": "20220830200429010212140137023A7EF2",
    "message": "Success",
    "data":
    {
        "image_info":
        {
            "regions":
            [
                {
                    "x2": 300,
                    "y1": 0,
                    "x1": 0,
                    "y2": 300
                }
            ],
            "category_id": 1
        }
    }
}

从图库删除一张图片

输入参数

Query参数：

Body参数：

API返回

data字段说明

无

注：data字段包含在通用返回字段中，具体见通用返回字段及错误码

错误码

注：其余请参考通用返回字段及错误码

返回值示例

{
    'code': 10000, 
    'data': null, 
    'message': 'Success', 
    'request_id': '69554530352795504791619442607', 
    'status': 10000, 
    'time_elapsed': '9.825631ms'
}

输入参数

Query参数：

Body参数：

过滤表达式

查询语句遵循基本的 JSON 格式，包含下列基本查询算子及其组合：

must, must_not, range, range_out, and, or

• must 算子，针对指定字段名生效，语义为必须在 [...] 之中，即 "must in"。
  示例：

{
	"op":	"must",	//	算子名，表示	region	必须为	cn	或	sg
	"field":	"region",	//	v，必须填写
	"conds":	\["cn",	"sg"\]	//	检索条件列表，一个或多个匹配项，元素类型为字符串或数字
}

• must_not 算子，针对指定字段名生效，语义为必须不在 [...] 之中，即 "must not in"。

{
  "op": "must_not",        // type 不能是 1,2,3 中的任意一个
  "field": "type",
  "conds": [1,2,3]
}

• range/range_out 算子，针对指定字段名生效，语义为连续区间范围筛选，其中 range_out 用于筛选指定范围外扩的场景，形式化描述如下。算子支持能力如下

• 支持用 gte（大于等于）, gt（大于）, lte（小于等于）, lt（小于） 表示一维范围

{
  "op": "range",      // 筛选价格在 [100, 500) 左闭右开区间内的商品
  "field": "price",
  "gte": 100.0,       // 浮点存在误差，更安全的方式是 "gt":99.9999
  "lt": 500.0
}

{
  "op": "range",      // 筛选价格高于或等于 100 的商品
  "field": "price",
  "gte": 100.0        // 浮点存在误差，更安全的方式是 "gt":99.9999
}

{
  "op": "range_out",  // 筛选价格低于 100 或高于 500 的商品
  "field": "price",
  "gt": 500.0,
  "lt": 100.0
}

{
  "op": "range",                // 支持两个维度用于距离筛选
  "field": ["pos_x", "pos_y"],  // 两个维度组成的直角坐标系
  "center": [100.0, 123.4],     // 中心点
  "radius": 50.0                 // 半径，注意自己对齐坐标单位
}

• and 逻辑算子，针对逻辑查询需求，对多个条件取交集

{
  "op": "and",         // 算子名
  "conds": [           // 条件列表，支持嵌套逻辑算子和 must/must_not 算子
    {
      "op": "must",
      "field": "type",
      "conds": [1]
    },
    {
        ...            // 支持>=1的任意数量的条件进行组合
    }
  ]
}

• or 逻辑算子，针对逻辑查询需求，对多个条件取并集

类似 and 算子，不再冗述，"op": "or"

API返回

data字段

注：data字段包含在通用返回字段中，具体见通用返回字段及错误码

错误码（通用错误码见【通用返回字段及错误码】文档）

注：其余请参考通用返回字段及错误码

返回值示例

{
    "status": 10000,
    "code": 10000,
    "time_elapsed": "3.862298319s",
    "request_id": "202208302027000102040531390242DC45",
    "message": "Success",
    "data":
    {
        "image_info":
        {
            "regions":
            [
                {
                    "x2": 287,
                    "y1": 69,
                    "x1": 9,
                    "y2": 236
                }
            ],
            "category_id": 1
        },
        "auctions":
        [
            {
                "image_id": "test1",
                "meta":
                {
                    "int_attr": 1,
                    "str_attr": "str",
                    "category_id": 1,
                    "custom_content": "custom"
                },
                "product_id": "test1",
                "score": 0.9970066547393799
            }
        ]
    }
}