You need to enable JavaScript to run this app.
导航
图像技术
  • 文档首页
    • /
  • 图像技术

调用方式

最近更新时间：2023.11.03 11:10:36

首次发布时间：2022.07.21 16:20:22

我的收藏

接口简介

识别图片中的商品分类及属性，包含服饰鞋靴、箱包、玩具、3C家电、家居日用等品类。

限制条件

名称内容

图片要求

1. 图片格式：JPG、JPEG、PNG、BMP等常见格式，建议使用JPG格式。
2. 图片文件大小：最大 5 MB。

请求说明

名称内容
接口地址https://visual.volcengineapi.com
请求方式POST
Content-Typeapplication/x-www-form-urlencoded

请求参数

（1）header请求参数

公共请求参数

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

名称类型是否必填描述
X-DateString是使用UTC时间，精确到秒。请使用格式：YYYYMMDD'T'HHMMSS'Z' ，例如：20201103T104027Z

Authorization

String

是

HMAC-SHA256：签名方法
-Credential为签名凭证，其中:
-AccessKeyId为访问密钥ID，可在 访问密钥（Access Key） 获取；
-ShortDate为请求的短时间，使用UTC时间，精确到日。请使用格式：YYYYMMDD，例如：20180201；
-Region为请求地区，国内一般为为cn-north-1；
-Service为请求的服务，一般为cv；
-SignedHeaders为参与签名计算的头部信息，content-type 和 host 为必选头部；
-Signature为签名，可在 签名方法 获取。
注：我们提供了SDK及签名示例供您实现服务快速接入，具体可参考 快速接入
例如：HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}

X-Security-TokenString否指安全令牌服务（Security Token Service，STS） 颁发的临时安全凭证中的SessionToken，使用长期密钥时无需填写该参数。

（2）Query参数：
业务请求参数

参数可选/必选类型说明
Action必选String接口名，取值：GoodsDetect
Version必选String版本号，取值：2020-08-26

（3）Body参数：
业务请求参数

参数可选/必选类型说明
image_base64必选（二选一，优先生效）String图片Base64编码
image_url必选（二选一）String图片文件URL

输出说明

（1）通用输出参数
请参考通用返回字段及错误码

（2）业务输出参数

data字段说明

字段类型说明
FrameFrame商品识别结果

Frame字段说明

字段类型说明
widthint图片宽度
heightint图片高度
objects[Object]图片中的检测框

Object字段说明

字段类型说明备注
boundingboxBoundingBox检测框信息包含以下字段：
  • Prob: 置信度
  • Xmin,Xmax,Ymin,Ymax: 检测框坐标
categoryint商品类别详情见商品类别

商品类别

Person         = 0
Cloth          = 1
Shoe           = 2
Bag            = 3
Hat            = 4
Scarf          = 5
Sock           = 6
3c             = 7
Makeup         = 8
FoodDrink      = 9
Furniture      = 10
Jewelry        = 11
Toy            = 12
DailyUse       = 13
Book           = 14
KitchenWare    = 15
OfficeSupplies = 16
Others         = 255

（3）输出示例

{
    "status": 10000,
    "code": 10000,
    "time_elapsed": "185.087819ms",
    "request_id": "68919181477633085521604649738",
    "message": "Success",
    "data": {
        "Frame": {
            "Width": 800,
            "Objects": [
                {
                    "BoundingBox": {
                        "Xmin": 608,
                        "Ymin": 119,
                        "Ymax": 340,
                        "Xmax": 783,
                        "Prob": 0.857064425945282
                    },
                    "Category": 1,
                    "Thumbnail": {
                        "Url": "http://sf1-ttcdn-tos.pstatp.com/obj/lab-vc-merchandise/frame_crop/bde10175789459862f2a7175fe245052"
                    }
                },
                ......
                {
                    "BoundingBox": {
                        "Xmin": 287,
                        "Ymin": 203,
                        "Ymax": 572,
                        "Xmax": 563,
                        "Prob": 0.5342626571655273
                    },
                    "Category": 1,
                    "Thumbnail": {
                        "Url": "http://sf1-ttcdn-tos.pstatp.com/obj/lab-vc-merchandise/frame_crop/61a3ca026f601520342bab5d3ed58a14"
                    }
                }
            ],
            "Height": 800
        }
    }
}

错误码

（1）通用错误码

见通用返回字段及错误码）

（2）业务错误码

HttpCode错误码错误消息描述
20010000无请求成功