diff options
Diffstat (limited to 'data/zh_cn/imagesearch/2020-12-14/api-docs.php')
| -rw-r--r-- | data/zh_cn/imagesearch/2020-12-14/api-docs.php | 5798 |
1 files changed, 2075 insertions, 3723 deletions
diff --git a/data/zh_cn/imagesearch/2020-12-14/api-docs.php b/data/zh_cn/imagesearch/2020-12-14/api-docs.php index 6978e87..7c545f9 100644 --- a/data/zh_cn/imagesearch/2020-12-14/api-docs.php +++ b/data/zh_cn/imagesearch/2020-12-14/api-docs.php @@ -1,43 +1,24 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'ImageSearch', - 'version' => '2020-12-14', - ], + 'info' => ['style' => 'RPC', 'product' => 'ImageSearch', 'version' => '2020-12-14'], 'directories' => [ [ - 'id' => 64363, - 'title' => '管理', + 'children' => ['AddImage', 'DeleteImage'], 'type' => 'directory', - 'children' => [ - 'AddImage', - 'DeleteImage', - ], + 'title' => '管理', + 'id' => 35413, ], [ - 'id' => 64366, - 'title' => '搜索', + 'children' => ['SearchImageByName', 'SearchImageByPic'], 'type' => 'directory', - 'children' => [ - 'SearchImageByName', - 'SearchImageByPic', - ], + 'title' => '搜索', + 'id' => 35416, ], [ - 'id' => 208341, - 'title' => '其他', + 'children' => ['CompareSimilarByImage', 'Detail', 'DumpMeta', 'DumpMetaList', 'IncreaseInstance', 'IncreaseList', 'SearchImageByText', 'UpdateImage', 'CheckImageExists', 'SearchImageByFilter'], 'type' => 'directory', - 'children' => [ - 'CompareSimilarByImage', - 'Detail', - 'DumpMeta', - 'DumpMetaList', - 'IncreaseInstance', - 'IncreaseList', - 'SearchImageByText', - 'UpdateImage', - ], + 'title' => '其他', + 'id' => 35419, ], ], 'components' => [ @@ -46,13 +27,8 @@ 'apis' => [ 'AddImage' => [ 'summary' => '本文为您介绍AddImage接口的语法及示例，用于向图像搜索实例中添加图片信息。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -64,223 +40,135 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREimagesearchAOOGRD', - ], + 'abilityTreeNodes' => ['FEATUREimagesearchAOOGRD'], ], 'parameters' => [ [ 'name' => 'InstanceName', 'in' => 'formData', - 'schema' => [ - 'description' => '图搜实例名称。最多支持20个字符。'."\n" - .'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n" - .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" - .'>这里的实例名称并非实例ID，使用时请区分。', - 'type' => 'string', - 'required' => true, - 'example' => 'demoinstance1', - ], + 'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n" + .'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n" + .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" + .'>这里的实例名称并非实例ID，使用时请区分。', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1'], ], [ 'name' => 'ProductId', 'in' => 'formData', - 'schema' => [ - 'description' => '商品ID，最多支持256个字符。'."\n" - ."\n" - .'>一个商品可以有多张图片。', - 'type' => 'string', - 'required' => true, - 'example' => '2092061_1', - ], + 'schema' => ['description' => '商品ID，最多支持256个字符。'."\n" + ."\n" + .'>一个商品可以有多张图片。', 'type' => 'string', 'required' => true, 'example' => '2092061_1'], ], [ 'name' => 'PicName', 'in' => 'formData', - 'schema' => [ - 'description' => ' 图片名称，最多支持256个字符。'."\n" - .'> - ProductId和PicName唯一确定一张图片。'."\n" - .'- 如果多次添加图片具有相同的ProductId和PicName，以最后一次添加为准，前面添加的图片将被覆盖。'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2092061_1.jpg', - ], + 'schema' => ['description' => ' 图片名称，最多支持256个字符。'."\n" + .'> - ProductId和PicName唯一确定一张图片。'."\n" + .'- 如果多次添加图片具有相同的ProductId和PicName，以最后一次添加为准，前面添加的图片将被覆盖。'."\n", 'type' => 'string', 'required' => true, 'example' => '2092061_1.jpg'], ], [ 'name' => 'PicContent', 'in' => 'formData', - 'schema' => [ - 'description' => '图片内容。'."\n" - .' - 图片大小要求不超过4 MB。'."\n" - .' - 图片格式：PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM。'."\n" - .' - 传输等待时间不超过5秒。'."\n" - .'<props="china">'."\n" - .' - 服务类型为商品图片搜索、通用图片搜索、家具家居图片搜索和工业五金图片搜索时，图片长和宽像素要求大于等于100PX且小于等于4096PX。'."\n" - .' 服务类型为商标图片搜索时，图片长和宽像素要求大于等于200PX且小于4096PX。'."\n" - .' 服务类型为布料图片搜索时，图片长和宽像素要求大于等于448PX且小于等于4096PX。'."\n" - .'</props>'."\n" - .'<props="intl">'."\n" - .' - 服务类型为商品图片搜索和通用图片搜索时，图片长和宽像素要求大于等于100PX且小于等于4096PX。'."\n" - .'</props>'."\n" - .'- 图片中不能包含旋转信息。'."\n" - ."\n" - .'> - **使用SDK方式调用：**'."\n" - .' - 如使用V3版本SDK，则无需填写PicContent字段，SDK已将本字段封装为PicContentObject字段并自动转化为Base64编码。具体示例参考[JAVA SDK](~~179188~~)。'."\n" - .' - SDK不支持客户直接传递图片URL，V3版本SDK提供了一种变相实现URL上传的方式。具体示例参考[JAVA SDK](~~179188~~)。'."\n" - .'- **使用阿里云OpenAPI平台调用：**'."\n" - .' - 如使用**2019-03-25**版本，**PicContent**字段请填写图片的**Base64**编码。'."\n" - .' - 如使用**2020-12-14**版本，在**PicContent**字段直接点击上传图片即可。', - 'type' => 'string', - 'required' => true, - 'example' => 'AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=', - 'isFileTransferUrl' => true, - ], + 'schema' => ['description' => '图片内容。'."\n" + .' - 图片大小要求不超过4 MB。'."\n" + .' - 图片格式：PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM。'."\n" + .' - 传输等待时间不超过5秒。'."\n" + .'<props="china">'."\n" + .' - 服务类型为商品图片搜索、通用图片搜索、家具家居图片搜索和工业五金图片搜索时，图片长和宽像素要求大于等于100PX且小于等于4096PX。'."\n" + .' 服务类型为商标图片搜索时，图片长和宽像素要求大于等于200PX且小于4096PX。'."\n" + .' 服务类型为布料图片搜索时，图片长和宽像素要求大于等于448PX且小于等于4096PX。'."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + .' - 服务类型为商品图片搜索和通用图片搜索时，图片长和宽像素要求大于等于100PX且小于等于4096PX。'."\n" + .'</props>'."\n" + .'- 图片中不能包含旋转信息。'."\n" + ."\n" + .'> - **使用SDK方式调用：**'."\n" + .' - 如使用V3版本SDK，则无需填写PicContent字段，SDK已将本字段封装为PicContentObject字段并自动转化为Base64编码。具体示例参考[JAVA SDK](~~179188~~)。'."\n" + .' - SDK不支持客户直接传递图片URL，V3版本SDK提供了一种变相实现URL上传的方式。具体示例参考[JAVA SDK](~~179188~~)。'."\n" + .'- **使用阿里云OpenAPI平台调用：**'."\n" + .' - 如使用**2019-03-25**版本，**PicContent**字段请填写图片的**Base64**编码。'."\n" + .' - 如使用**2020-12-14**版本，在**PicContent**字段直接点击上传图片即可。', 'type' => 'string', 'required' => true, 'example' => 'AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=', 'isFileTransferUrl' => true], ], [ 'name' => 'CategoryId', 'in' => 'formData', - 'schema' => [ - 'description' => '图片类目。具体请参考[类目参考](~~179184~~)。'."\n" - .'> - 对于商品搜索，若设置类目，则以设置的为准；若不设置类目，将由系统进行类目预测，预测的类目结果可在Response中获取 。'."\n" - .'<props="china">'."\n" - .'- 对于布料、商标、通用、家具家居和工业五金搜索，不论是否设置类目，系统会将类目设置为88888888。'."\n" - .'</props>'."\n" - .'- 对于通用搜索，不论是否设置类目，系统会将类目设置为88888888。'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '88888888', - ], + 'schema' => ['description' => '图片类目。具体请参考[类目参考](~~179184~~)。'."\n" + .'> - 对于商品搜索，若设置类目，则以设置的为准；若不设置类目，将由系统进行类目预测，预测的类目结果可在Response中获取 。'."\n" + .'<props="china">'."\n" + .'- 对于布料、商标、通用、家具家居和工业五金搜索，不论是否设置类目，系统会将类目设置为88888888。'."\n" + .'</props>'."\n" + .'- 对于通用搜索，不论是否设置类目，系统会将类目设置为88888888。'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '88888888'], ], [ 'name' => 'Crop', 'in' => 'formData', - 'schema' => [ - 'description' => '是否需要进行主体识别。默认true。'."\n" - .' - 为true：由系统进行主体识别，以识别的主体进行搜索，主体识别结果可在Response中获取。'."\n" - .'- 为false：则不进行主体识别，以整张图进行搜索。'."\n" - ."\n" - .'<props="china">对于布料图片搜索，此参数会被忽略，系统会以整张图进行搜索。</props>'."\n" - ."\n\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '是否需要进行主体识别。默认true。'."\n" + .' - 为true：由系统进行主体识别，以识别的主体进行搜索，主体识别结果可在Response中获取。'."\n" + .'- 为false：则不进行主体识别，以整张图进行搜索。'."\n" + ."\n" + .'<props="china">对于布料图片搜索，此参数会被忽略，系统会以整张图进行搜索。</props>'."\n" + ."\n\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'Region', 'in' => 'formData', - 'schema' => [ - 'description' => '图片的主体区域，格式为`x1,x2,y1,y2`, 其中`x1,y1 `是左上角的点，`x2,y2`是右下角的点。'."\n" - .'> - 若用户设置了Region，则不论Crop参数为何值，都将以用户输入Region进行搜索。'."\n" - .'<props="china">'."\n" - .'- 对于布料图片搜索，此参数会被忽略，系统会以整张图进行搜索。'."\n" - .'</props>'."\n" - .'- Region参数没有单位，是参考使用图片的长宽PX像素尺寸标记的结果，如果图片缩放对应Region参数值也要等比例缩放。', - 'type' => 'string', - 'required' => false, - 'example' => '280,486,232,351', - ], + 'schema' => ['description' => '图片的主体区域，格式为`x1,x2,y1,y2`, 其中`x1,y1 `是左上角的点，`x2,y2`是右下角的点。'."\n" + .'> - 若用户设置了Region，则不论Crop参数为何值，都将以用户输入Region进行搜索。'."\n" + .'<props="china">'."\n" + .'- 对于布料图片搜索，此参数会被忽略，系统会以整张图进行搜索。'."\n" + .'</props>'."\n" + .'- Region参数没有单位，是参考使用图片的长宽PX像素尺寸标记的结果，如果图片缩放对应Region参数值也要等比例缩放。', 'type' => 'string', 'required' => false, 'example' => '280,486,232,351'], ], [ 'name' => 'CustomContent', 'in' => 'formData', - 'schema' => [ - 'description' => '用户自定义的内容，最多支持4096个字符。'."\n" - .'>查询时会返回该字段。例如可添加图片的描述等文本。', - 'type' => 'string', - 'required' => false, - 'example' => 'zidingyi', - ], + 'schema' => ['description' => '用户自定义的内容，最多支持4096个字符。'."\n" + .'>查询时会返回该字段。例如可添加图片的描述等文本。', 'type' => 'string', 'required' => false, 'example' => 'zidingyi'], ], [ 'name' => 'IntAttr', 'in' => 'formData', - 'schema' => [ - 'description' => '整数类型属性，可用于查询时过滤，查询时会返回该字段。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '22', - ], + 'schema' => ['description' => '整数类型属性，可用于查询时过滤，查询时会返回该字段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '22'], ], [ 'name' => 'StrAttr', 'in' => 'formData', - 'schema' => [ - 'description' => '字符串类型属性，最多支持128个字符。可用于查询时过滤，查询时会返回该字段。'."\n" - .'> 不支持特殊字符比如：\\¥$&%', - 'type' => 'string', - 'required' => false, - 'example' => 'ss', - ], + 'schema' => ['description' => '字符串类型属性，最多支持128个字符。可用于查询时过滤，查询时会返回该字段。'."\n" + .'> 不支持特殊字符比如：\\¥$&%', 'type' => 'string', 'required' => false, 'example' => 'ss'], ], [ 'name' => 'IntAttr2', 'in' => 'formData', - 'schema' => [ - 'description' => '整数类型属性，可用于查询时过滤，查询时会返回该字段。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '22', - ], + 'schema' => ['description' => '整数类型属性，可用于查询时过滤，查询时会返回该字段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '22'], ], [ 'name' => 'StrAttr2', 'in' => 'formData', - 'schema' => [ - 'description' => '字符串类型属性，最多支持128个字符。可用于查询时过滤，查询时会返回该字段。'."\n" - .'> 不支持特殊字符比如：\\¥$&%', - 'type' => 'string', - 'required' => false, - 'example' => 'ss', - ], + 'schema' => ['description' => '字符串类型属性，最多支持128个字符。可用于查询时过滤，查询时会返回该字段。'."\n" + .'> 不支持特殊字符比如：\\¥$&%', 'type' => 'string', 'required' => false, 'example' => 'ss'], ], [ 'name' => 'IntAttr3', 'in' => 'formData', - 'schema' => [ - 'description' => '整数类型属性，可用于查询时过滤，查询时会返回该字段。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '33', - ], + 'schema' => ['description' => '整数类型属性，可用于查询时过滤，查询时会返回该字段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '33'], ], [ 'name' => 'StrAttr3', 'in' => 'formData', - 'schema' => [ - 'description' => '字符串类型属性，最多支持128个字符。可用于查询时过滤，查询时会返回该字段。'."\n" - .'> 不支持特殊字符比如：\\¥$&%', - 'type' => 'string', - 'required' => false, - 'example' => 'ss', - ], + 'schema' => ['description' => '字符串类型属性，最多支持128个字符。可用于查询时过滤，查询时会返回该字段。'."\n" + .'> 不支持特殊字符比如：\\¥$&%', 'type' => 'string', 'required' => false, 'example' => 'ss'], ], [ 'name' => 'IntAttr4', 'in' => 'formData', - 'schema' => [ - 'description' => '整数类型属性，可用于查询时过滤，查询时会返回该字段。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '44', - ], + 'schema' => ['description' => '整数类型属性，可用于查询时过滤，查询时会返回该字段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '44'], ], [ 'name' => 'StrAttr4', 'in' => 'formData', - 'schema' => [ - 'description' => '字符串类型属性，最多支持128个字符。可用于查询时过滤，查询时会返回该字段。'."\n" - .'> 不支持特殊字符比如：\\¥$&%', - 'type' => 'string', - 'required' => false, - 'example' => 'ss', - ], + 'schema' => ['description' => '字符串类型属性，最多支持128个字符。可用于查询时过滤，查询时会返回该字段。'."\n" + .'> 不支持特殊字符比如：\\¥$&%', 'type' => 'string', 'required' => false, 'example' => 'ss'], ], ], 'responses' => [ @@ -290,297 +178,118 @@ 'description' => '参数返回结果。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '错误信息。'."\n" - .'> 成功请求不返回数据，失败请求返回错误信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E0845DE6-52AF-4B50-9F15-51ED4044E6AB', - ], - 'Code' => [ - 'description' => '错误码。'."\n" - ."\n" - .'- 0：成功。'."\n" - .'- 非0：失败。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'Message' => ['description' => '错误信息。'."\n" + .'> 成功请求不返回数据，失败请求返回错误信息。', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E0845DE6-52AF-4B50-9F15-51ED4044E6AB'], + 'Code' => ['description' => '错误码。'."\n" + ."\n" + .'- 0：成功。'."\n" + .'- 非0：失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'PicInfo' => [ 'description' => '类目预测、主体识别结果。', 'type' => 'object', 'properties' => [ - 'Region' => [ - 'description' => '主体识别结果。图片的主体区域，格式为`x1,x2,y1,y2`，其中`x1,y1`是左上角的点，`x2,y2`是右下角的点。若用户请求中指定了主体区域，则以请求中为准。', - 'type' => 'string', - 'example' => '94,691,206,650', + 'Region' => ['description' => '主体识别结果。图片的主体区域，格式为`x1,x2,y1,y2`，其中`x1,y1`是左上角的点，`x2,y2`是右下角的点。若用户请求中指定了主体区域，则以请求中为准。', 'type' => 'string', 'example' => '94,691,206,650'], + 'CategoryId' => ['description' => '类目预测结果。若用户请求中指定了类目，则以请求中为准。', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888'], + 'MultiRegion' => [ + 'description' => '主体识别结果集合。'."\n" + .'> 需要版本升级至V3.1.1方可使用。', + 'type' => 'array', + 'items' => [ + 'description' => '主体识别结果。', + 'type' => 'object', + 'properties' => [ + 'Region' => ['description' => '主体识别结果。图片的主体区域，格式为x1,x2,y1,y2，其中 x1,y1 是左上角的点，x2，y2是右下角的点。若用户请求中指定了主体区域，则以请求中为准。', 'type' => 'string', 'example' => '94,691,206,650'], + ], + ], ], - 'CategoryId' => [ - 'description' => '类目预测结果。若用户请求中指定了类目，则以请求中为准。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '88888888', + 'AllCategories' => [ + 'description' => '系统支持的所有类目信息。', + 'type' => 'array', + 'items' => [ + 'description' => '系统支持的所有类目信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '类目名称。', 'type' => 'string', 'example' => 'Other'], + 'Id' => ['description' => '类目ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888'], + ], + ], ], ], ], - 'Success' => [ - 'description' => '请求是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'BadRequest', - 'errorMessage' => 'The request has invalid parameters.', - ], - [ - 'errorCode' => 'InstanceStatusError', - 'errorMessage' => 'Your instance is unavailable.', - ], - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'NoCaretSeperator', - 'errorMessage' => 'The body content is missing the ^ separator.', - ], - [ - 'errorCode' => 'EmptyMeta', - 'errorMessage' => 'The body content has an empty meta field.', - ], - [ - 'errorCode' => 'InvalidMetaItem', - 'errorMessage' => 'The meta field is invalid.', - ], - [ - 'errorCode' => 'NoPicList', - 'errorMessage' => 'The body content is missing the pic_list parameter.', - ], - [ - 'errorCode' => 'NoSpecifiedPic', - 'errorMessage' => 'The content of an image is not specified in the HTTP POST body.', - ], - [ - 'errorCode' => 'NoSpecifiedSearchPic', - 'errorMessage' => 'The search image is not specified.', - ], - [ - 'errorCode' => 'InvalidCategory', - 'errorMessage' => 'The specified category is invalid.', - ], - [ - 'errorCode' => 'OverflowMaxResultNum', - 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', - ], - [ - 'errorCode' => 'OverflowMaxReturnNum', - 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', - ], - [ - 'errorCode' => 'InvalidStartParameter', - 'errorMessage' => 'The specified parameter s is inavlid.', - ], - [ - 'errorCode' => 'InvalidNumParameter', - 'errorMessage' => 'The specified parameter n is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedAddPic', - 'errorMessage' => 'The image to insert is not specified.', - ], - [ - 'errorCode' => 'NoSpecifiedItemId', - 'errorMessage' => 'The item_id parameter is not specified.', - ], - [ - 'errorCode' => 'InvalidIntAttr', - 'errorMessage' => 'The specified int_attr field is invalid.', - ], - [ - 'errorCode' => 'UnsupportedPicFormat', - 'errorMessage' => 'The specified image format is invalid.', - ], - [ - 'errorCode' => 'InvalidFilterClause', - 'errorMessage' => 'The specified filtering condition is invalid.', - ], - [ - 'errorCode' => 'InstanceOverQuota', - 'errorMessage' => 'The number of items exceeds the limit.', - ], - [ - 'errorCode' => 'IncorrectOrientation', - 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', - ], - [ - 'errorCode' => 'UnsupportedPicPixels', - 'errorMessage' => 'The specified pixels is not supported.', - ], - [ - 'errorCode' => 'SearchTimeout', - 'errorMessage' => 'The request is timed out.', - ], - [ - 'errorCode' => 'PicNotExist', - 'errorMessage' => 'The search picture does not exist.', - ], - [ - 'errorCode' => 'NoSpecifiedProductId', - 'errorMessage' => 'The parameter ProductId no specified.', - ], - [ - 'errorCode' => 'NoSpecifiedPicName', - 'errorMessage' => 'The parameter PicName no specified.', - ], - [ - 'errorCode' => 'NoSpecifiedPicContent', - 'errorMessage' => 'The parameter PicContent no specified.', - ], - [ - 'errorCode' => 'InvalidType', - 'errorMessage' => 'The specified parameter Type is not valid.', - ], - [ - 'errorCode' => 'InvalidProductId', - 'errorMessage' => 'The specified parameter ProductId is not valid.', - ], - [ - 'errorCode' => 'InvalidPicName', - 'errorMessage' => 'The specified parameter PicName is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr', - 'errorMessage' => 'The specified parameter StrAttr is not valid.', - ], - [ - 'errorCode' => 'InvalidCustomContent', - 'errorMessage' => 'The specified parameter CustomContent is not valid.', - ], - [ - 'errorCode' => 'InvalidPicContent', - 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', - ], - [ - 'errorCode' => 'TimeoutForTransferImage', - 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', - ], - [ - 'errorCode' => 'InvalidPicUrl', - 'errorMessage' => 'The search picture does not exist at the specific url.', - ], - [ - 'errorCode' => 'InvalidInstanceName', - 'errorMessage' => 'The parameter instanceName is not specified.', - ], - [ - 'errorCode' => 'InvalidRequestId', - 'errorMessage' => 'The parameter requestId is not specified.', - ], - [ - 'errorCode' => 'InvalidRequestIdTooLarge', - 'errorMessage' => 'The parameter requestId is too large.', - ], - [ - 'errorCode' => 'InvalidRegion', - 'errorMessage' => 'The specific region is illegal.', - ], - [ - 'errorCode' => 'RegionError', - 'errorMessage' => 'region.', - ], - [ - 'errorCode' => 'InvalidStrAttr2', - 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr3', - 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr4', - 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr2', - 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr3', - 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr4', - 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', - ], - [ - 'errorCode' => 'PictureError', - 'errorMessage' => '[download] Img Download Failed.', - ], - [ - 'errorCode' => 'UnsupportedOperationType', - 'errorMessage' => 'The specified action is not supported.', - ], + ['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''], + ['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'], + ['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => '请求body缺少特定符号'], + ['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => '请求body含有空的字段'], + ['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => '无效的元信息字段'], + ['errorCode' => 'NoPicList', 'errorMessage' => 'The body content is missing the pic_list parameter.', 'description' => '未指定pic_list字段'], + ['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'The content of an image is not specified in the HTTP POST body.', 'description' => '图片未指定'], + ['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''], + ['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => '无效的类目id'], + ['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => '超过了最大的返回结果限制数500'], + ['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => '单次返回数超过限制值100'], + ['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter s is inavlid.', 'description' => ''], + ['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter n is invalid.', 'description' => ''], + ['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''], + ['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => '无效的int过滤字段'], + ['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => '无效的图片格式'], + ['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => '无效的过滤条件'], + ['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => '实例的图片数量超过限制值'], + ['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => '图片包含不支持的旋转参数'], + ['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => '图片像素值不支持'], + ['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''], + ['errorCode' => 'PicNotExist', 'errorMessage' => 'The search picture does not exist.', 'description' => ''], + ['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'The parameter ProductId no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicName', 'errorMessage' => 'The parameter PicName no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''], + ['errorCode' => 'InvalidType', 'errorMessage' => 'The specified parameter Type is not valid.', 'description' => ''], + ['errorCode' => 'InvalidProductId', 'errorMessage' => 'The specified parameter ProductId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicName', 'errorMessage' => 'The specified parameter PicName is not valid.', 'description' => ''], + ['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => '无效StrAttr'], + ['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', 'description' => ''], + ['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''], + ['errorCode' => 'InvalidPicUrl', 'errorMessage' => 'The search picture does not exist at the specific url.', 'description' => ''], + ['errorCode' => 'InvalidInstanceName', 'errorMessage' => 'The parameter instanceName is not specified.', 'description' => ''], + ['errorCode' => 'InvalidRequestId', 'errorMessage' => 'The parameter requestId is not specified.', 'description' => ''], + ['errorCode' => 'InvalidRequestIdTooLarge', 'errorMessage' => 'The parameter requestId is too large.', 'description' => ''], + ['errorCode' => 'InvalidRegion', 'errorMessage' => 'The specific region is illegal.', 'description' => ''], + ['errorCode' => 'RegionError', 'errorMessage' => 'region.', 'description' => ''], + ['errorCode' => 'InvalidStrAttr2', 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', 'description' => '无效StrAttr2'], + ['errorCode' => 'InvalidStrAttr3', 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', 'description' => '无效StrAttr3'], + ['errorCode' => 'InvalidStrAttr4', 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', 'description' => '无效StrAttr4'], + ['errorCode' => 'InvalidIntAttr2', 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', 'description' => '无效IntAttr2'], + ['errorCode' => 'InvalidIntAttr3', 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', 'description' => '无效IntAttr3'], + ['errorCode' => 'InvalidIntAttr4', 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', 'description' => '无效IntAttr4'], + ['errorCode' => 'PictureError', 'errorMessage' => '[download] Img Download Failed.', 'description' => '图片下载失败，请检查图片'], + ['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => '内部错误：不支持的action'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation.', - ], - [ - 'errorCode' => 'DeniedRequest', - 'errorMessage' => 'Your request was denied due to instance flow control.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => '未授权的行为'], + ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => '请求被限流'], ], 500 => [ - [ - 'errorCode' => 'UnknownException', - 'errorMessage' => 'An internal server error occurred.', - ], - [ - 'errorCode' => 'NetworkException', - 'errorMessage' => 'A network error occurred.', - ], - [ - 'errorCode' => 'RequestTimeout', - 'errorMessage' => 'The request is timeout.', - ], - [ - 'errorCode' => 'ExtractFeatureTimeout', - 'errorMessage' => 'The request was timed out while extracting features.', - ], - [ - 'errorCode' => 'AccessEngineFailed', - 'errorMessage' => 'An error occurred while accessing the search engine.', - ], - [ - 'errorCode' => 'InternalOssError', - 'errorMessage' => 'An internal OAS error occurred.', - ], - [ - 'errorCode' => 'InternalSwiftError', - 'errorMessage' => 'An internal SWIFT error occurred.', - ], - [ - 'errorCode' => 'InternalTableStoreError', - 'errorMessage' => 'An internal Table Store error occurred.', - ], - [ - 'errorCode' => 'ConnectionDVException', - 'errorMessage' => 'Failed to obtain collection.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"E0845DE6-52AF-4B50-9F15-51ED4044E6AB\\",\\n \\"Code\\": 0,\\n \\"PicInfo\\": {\\n \\"Region\\": \\"94,691,206,650\\",\\n \\"CategoryId\\": 88888888\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ['errorCode' => 'UnknownException', 'errorMessage' => 'An internal server error occurred.', 'description' => '未知异常'], + ['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => '内部错误：请求网络异常'], + ['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''], + ['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''], + ['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''], + ['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => '内部错误：请求内部算法错误'], + ['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => '内部错误：请求内部消息队列错误'], + ['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => '内部错误：请求特征存储错误'], + ['errorCode' => 'ConnectionDVException', 'errorMessage' => 'Failed to obtain collection.', 'description' => 'internalError'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"E0845DE6-52AF-4B50-9F15-51ED4044E6AB\\",\\n \\"Code\\": 0,\\n \\"PicInfo\\": {\\n \\"Region\\": \\"94,691,206,650\\",\\n \\"CategoryId\\": 88888888,\\n \\"MultiRegion\\": [\\n {\\n \\"Region\\": \\"94,691,206,650\\"\\n }\\n ],\\n \\"AllCategories\\": [\\n {\\n \\"Name\\": \\"Other\\",\\n \\"Id\\": 88888888\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AddImageResponse>\\n <Message>success</Message>\\n <RequestId>E0845DE6-52AF-4B50-9F15-51ED4044E6AB</RequestId>\\n <Code>0</Code>\\n <PicInfo>\\n <Region>94,691,206,650</Region>\\n <CategoryId>88888888</CategoryId>\\n <MultiRegion>\\n <Region>94,691,206,650</Region>\\n </MultiRegion>\\n <AllCategories>\\n <Name>Other</Name>\\n <Id>88888888</Id>\\n </AllCategories>\\n </PicInfo>\\n <Success>true</Success>\\n</AddImageResponse>","errorExample":""}]', 'title' => '新增图片', 'description' => '## 使用说明'."\n" .'本接口用于向图像搜索实例中添加图片信息。'."\n" @@ -590,350 +299,193 @@ .'其他图片容量的实例默认的并发量为5，也就是每秒钟最多处理5个图片新增请求。', 'extraInfo' => '## 错误码'."\n" .'请参见[错误码](~~66619~~)。', - ], - 'DeleteImage' => [ - 'summary' => '本文为您介绍DeleteImage接口的语法及示例，用于向图像搜索实例中删除图片信息。', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddImage'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imagesearch:AddImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'CheckImageExists' => [ + 'summary' => 'CheckImageExists', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREimagesearchIT4SIC', - ], + 'abilityTreeNodes' => ['FEATUREimagesearchF4L5JA'], ], 'parameters' => [ [ 'name' => 'InstanceName', 'in' => 'formData', - 'schema' => [ - 'description' => '图搜实例名称。最多支持20个字符。'."\n" - .'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n" - .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" - .'>这里的实例名称并非实例ID，且实例名称同区域内唯一不可重复，使用时请区分。', - 'type' => 'string', - 'required' => true, - 'example' => 'demoinstance1', - ], + 'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n" + .'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n" + .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" + .'>这里的实例名称并非实例ID，使用时请区分。', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1'], ], [ 'name' => 'ProductId', 'in' => 'formData', - 'schema' => [ - 'description' => '商品ID。'."\n" - ."\n" - .'> 1.一个商品可以有多张图片 2.若IsDeleteByFilter字段为false 则此字段必填', - 'type' => 'string', - 'required' => false, - 'example' => '2092061_1', - ], + 'schema' => ['description' => '商品ID。'."\n", 'type' => 'string', 'required' => true, 'example' => '2092061_1', 'isFileTransferUrl' => false], ], [ 'name' => 'PicName', 'in' => 'formData', - 'schema' => [ - 'description' => '图片名称。'."\n" - .' - 如果不指定本参数，则删除ProductId下所有图片。'."\n" - .' - 如果指定本参数，则删除ProductId+PicName指定的图片。', - 'type' => 'string', - 'required' => false, - 'example' => '2092061_1.jpg', - ], - ], - [ - 'name' => 'IsDeleteByFilter', - 'in' => 'formData', - 'schema' => [ - 'description' => '根据Filter字段去重'."\n" - .'> 1.若为true 则根据Filter删除 且Filter必填 '."\n" - .' 2.若为false 则根据ProductId或者ProductId+PicName进行删除 ProductId必填', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'Filter', - 'in' => 'formData', - 'schema' => [ - 'description' => '过滤条件。int_attr支持的操作符有大于号(>)、大于等于号(>=)、小于号(<)、小于等于号(<=)、等于号(=)。str_attr支持的操作符有等于号(=)和不等号(!=)，多个条件之支持AND和OR进行连接。'."\n" - .'例如：'."\n" - .'- int_attr >= 100。'."\n" - .'- str_attr != "value1"。'."\n" - .'- int_attr = 1000 AND str_attr = "value1"。'."\n" - .'>最多支持4096个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'int_attr=1000 AND str_attr="value1"', - ], + 'schema' => ['description' => '图片名称。', 'type' => 'string', 'required' => true, 'example' => '2092061_1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回对象。', + 'description' => '结果返回。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '0703956F-9BCC-48FA-99F7-96C0BF449C69', - ], - 'Code' => [ - 'description' => '错误码。'."\n" - .'- 0：成功。'."\n" - .'- 非0：失败。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Success' => [ - 'description' => '请求是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '删除结果返回。', + 'Msg' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879'], + 'Auctions' => [ + 'description' => '所有返回的商品描述信息。', 'type' => 'object', 'properties' => [ - 'PicNames' => [ - 'description' => '删除的PicName。', - 'type' => 'array', - 'items' => [ - 'description' => '删除的PicName。', - 'type' => 'string', - 'example' => 'xxx.jpg', - ], - 'example' => '5555.jpg', - ], + 'ProductId' => ['description' => '商品ID。', 'type' => 'string', 'example' => '2092061_1'], + 'PicName' => ['description' => '图片名称。', 'type' => 'string', 'example' => '2092061_1.jpg'], + 'CategoryId' => ['description' => '图片类目。', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888'], + 'CustomContent' => ['description' => '用户自定义的内容。', 'type' => 'string', 'example' => 'zidingyi'], + 'IntAttr' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'IntAttr2' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'StrAttr' => ['description' => '字符串类型属性。'."\n", 'type' => 'string', 'example' => 'test'], + 'StrAttr2' => ['description' => '字符串类型属性。'."\n", 'type' => 'string', 'example' => 'test'], + 'StrAttr3' => ['description' => '字符串类型属性。'."\n", 'type' => 'string', 'example' => 'test'], + 'StrAttr4' => ['description' => '字符串类型属性。'."\n", 'type' => 'string', 'example' => 'test'], + 'IntAttr3' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'IntAttr4' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], ], ], + 'Code' => ['description' => '错误码。'."\n" + .'- 0：成功。'."\n" + .'- 非0：失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'Exists' => ['description' => '图片是否存在。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'BadRequest', - 'errorMessage' => 'The request has invalid parameters.', - ], - [ - 'errorCode' => 'InstanceStatusError', - 'errorMessage' => 'Your instance is unavailable.', - ], - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'NoCaretSeperator', - 'errorMessage' => 'The body content is missing the ^ separator.', - ], - [ - 'errorCode' => 'EmptyMeta', - 'errorMessage' => 'The body content has an empty meta field.', - ], - [ - 'errorCode' => 'InvalidMetaItem', - 'errorMessage' => 'The meta field is invalid.', - ], - [ - 'errorCode' => 'InvalidPicList', - 'errorMessage' => 'The specified pic_list parameter is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedPic', - 'errorMessage' => 'The content of an image is not specified in the HTTP POST body.', - ], - [ - 'errorCode' => 'NoSpecifiedSearchPic', - 'errorMessage' => 'The search image is not specified.', - ], - [ - 'errorCode' => 'InvalidCategory', - 'errorMessage' => 'The specified category is invalid.', - ], - [ - 'errorCode' => 'OverflowMaxResultNum', - 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', - ], - [ - 'errorCode' => 'OverflowMaxReturnNum', - 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', - ], - [ - 'errorCode' => 'InvalidStartParameter', - 'errorMessage' => 'The specified parameter s is inavlid.', - ], - [ - 'errorCode' => 'InvalidNumParameter', - 'errorMessage' => 'The specified parameter n is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedAddPic', - 'errorMessage' => 'The image to insert is not specified.', - ], - [ - 'errorCode' => 'NoSpecifiedItemId', - 'errorMessage' => 'The item_id parameter is not specified.', - ], - [ - 'errorCode' => 'InvalidIntAttr', - 'errorMessage' => 'The specified int_attr field is invalid.', - ], - [ - 'errorCode' => 'UnsupportedPicFormat', - 'errorMessage' => 'The specified image format is invalid.', - ], - [ - 'errorCode' => 'InvalidFilterClause', - 'errorMessage' => 'The specified filtering condition is invalid.', - ], - [ - 'errorCode' => 'InstanceOverQuota', - 'errorMessage' => 'The number of items exceeds the limit.', - ], - [ - 'errorCode' => 'IncorrectOrientation', - 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', - ], - [ - 'errorCode' => 'UnsupportedPicPixels', - 'errorMessage' => 'The specified pixels is not supported.', - ], - [ - 'errorCode' => 'SearchTimeout', - 'errorMessage' => 'The request is timed out.', - ], - [ - 'errorCode' => 'NoSpecifiedProductId', - 'errorMessage' => 'You must specify ProductId.', - ], - [ - 'errorCode' => 'InvalidIntAttr4', - 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr3', - 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr2', - 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr4', - 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr3', - 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr2', - 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr', - 'errorMessage' => 'The specified parameter StrAttr is not valid.', - ], - [ - 'errorCode' => 'UnsupportedOperationType', - 'errorMessage' => 'The specified action is not supported.', - ], - [ - 'errorCode' => 'UnsupportedInstanceType', - 'errorMessage' => 'The instance type is not supported.', - ], + ['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''], + ['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''], + ['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'], + ['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => '请求body缺少特定符号'], + ['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => '请求body含有空的字段'], + ['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => '无效的元信息字段'], + ['errorCode' => 'NoPicList', 'errorMessage' => 'The body content is missing the pic_list parameter.', 'description' => '未指定pic_list字段'], + ['errorCode' => 'InvalidPicList', 'errorMessage' => 'The specified pic_list parameter is invalid.', 'description' => '无效的pic_list字段'], + ['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'he content of an image is not specified in the HTTP POST body.', 'description' => ''], + ['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''], + ['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => '无效的类目id'], + ['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => '超过了最大的返回结果限制数500'], + ['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => '单次返回数超过限制值100'], + ['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter start is inavlid.', 'description' => ''], + ['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter num is invalid.', 'description' => '无效的字段num'], + ['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''], + ['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => '无效的int过滤字段'], + ['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => '无效的图片格式'], + ['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => '无效的过滤条件'], + ['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => '实例的图片数量超过限制值'], + ['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => '图片包含不支持的旋转参数'], + ['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => '图片像素值不支持'], + ['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''], + ['errorCode' => 'PicNotExist', 'errorMessage' => 'The search picture does not exist.', 'description' => ''], + ['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'The parameter ProductId no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicName', 'errorMessage' => 'The parameter PicName no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''], + ['errorCode' => 'InvalidType', 'errorMessage' => 'The specified parameter Type is not valid.', 'description' => ''], + ['errorCode' => 'InvalidProductId', 'errorMessage' => 'The specified parameter ProductId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicName', 'errorMessage' => 'The specified parameter PicName is not valid.', 'description' => ''], + ['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => '无效StrAttr'], + ['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 2 * 1024 * 1024.', 'description' => ''], + ['errorCode' => 'InvalidStrAttr4', 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', 'description' => '无效StrAttr4'], + ['errorCode' => 'InvalidStrAttr3', 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', 'description' => '无效StrAttr3'], + ['errorCode' => 'InvalidStrAttr2', 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', 'description' => '无效StrAttr2'], + ['errorCode' => 'InvalidIntAttr4', 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', 'description' => '无效IntAttr4'], + ['errorCode' => 'InvalidIntAttr3', 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', 'description' => '无效IntAttr3'], + ['errorCode' => 'InvalidIntAttr2', 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', 'description' => '无效IntAttr2'], + ['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => '内部错误：不支持的action'], + ['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => '内部错误：不支持的实例类型'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation.', - ], - [ - 'errorCode' => 'DeniedRequest', - 'errorMessage' => 'Your request was denied due to instance flow control.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => '未授权的行为'], + ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => '请求被限流'], ], 500 => [ - [ - 'errorCode' => 'UnknownlException', - 'errorMessage' => 'An internal server error occurred.', - ], - [ - 'errorCode' => 'UnknownException', - 'errorMessage' => 'An internal server error occurred.', - ], - [ - 'errorCode' => 'NetworkException', - 'errorMessage' => 'A network error occurred.', - ], - [ - 'errorCode' => 'RequestTimeout', - 'errorMessage' => 'The request is timeout.', - ], - [ - 'errorCode' => 'ExtractFeatureTimeout', - 'errorMessage' => 'The request was timed out while extracting features.', - ], - [ - 'errorCode' => 'AccessEngineFailed', - 'errorMessage' => 'An error occurred while accessing the search engine.', - ], - [ - 'errorCode' => 'InternalOssError', - 'errorMessage' => 'An internal OAS error occurred.', - ], - [ - 'errorCode' => 'InternalSwiftError', - 'errorMessage' => 'An internal SWIFT error occurred.', - ], - [ - 'errorCode' => 'InternalTableStoreError', - 'errorMessage' => 'An internal Table Store error occurred.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0703956F-9BCC-48FA-99F7-96C0BF449C69\\",\\n \\"Code\\": 0,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PicNames\\": [\\n \\"xxx.jpg\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '删除图片', + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal server error occurred.', 'description' => ''], + ['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => '内部错误：请求网络异常'], + ['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''], + ['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''], + ['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''], + ['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => '内部错误：请求内部算法错误'], + ['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => '内部错误：请求内部消息队列错误'], + ['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => '内部错误：请求特征存储错误'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '检查图片', 'description' => '## 使用说明'."\n" - .'本接口用于向图像搜索实例中删除图片信息。'."\n" - .'>- 如果指定图片在图像搜索实例中不存在，该接口依然会返回成功。不能用返回结果来判断图片是否存在。'."\n" + .'本接口用于根据图片查询图像搜索实例中的图片信息。'."\n" ."\n" .'## QPS限制'."\n" - .'删除操作默认的并发量为20，也就是每秒钟最多处理20个删除请求。', - 'extraInfo' => '## 错误码'."\n" - .'请参见[错误码](~~66619~~)。', - ], - 'SearchImageByName' => [ - 'summary' => '本文为您介绍SearchByName接口的语法及示例，用于根据名称查询图像搜索实例中的图片信息。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + .'查询操作默认的最大访问频率可在控制台中查看，为您购买时所选择的访问频次（QPS），当前支持1QPS、5QPS、10QPS。'."\n" + ."\n\n" + .'### SDK版本说明'."\n" + .'图像SDK版本升级到V3.1.1，可使用“多主体识别”、“相似性分数”功能。请参见[Java SDK](~~179188~~)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imagesearch:CheckImageExists', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Auctions\\": {\\n \\"ProductId\\": \\"2092061_1\\",\\n \\"PicName\\": \\"2092061_1.jpg\\",\\n \\"CategoryId\\": 88888888,\\n \\"CustomContent\\": \\"zidingyi\\",\\n \\"IntAttr\\": 2,\\n \\"IntAttr2\\": 2,\\n \\"StrAttr\\": \\"test\\",\\n \\"StrAttr2\\": \\"test\\",\\n \\"StrAttr3\\": \\"test\\",\\n \\"StrAttr4\\": \\"test\\",\\n \\"IntAttr3\\": 2,\\n \\"IntAttr4\\": 2\\n },\\n \\"Code\\": 0,\\n \\"Success\\": true,\\n \\"Exists\\": true\\n}","errorExample":""},{"type":"xml","example":"<CheckImageExistsResponse>\\n <Msg>success</Msg>\\n <RequestId>B3137727-7D6E-488C-BA21-0E034C38A879</RequestId>\\n <Auctions>\\n <ProductId>2092061_1</ProductId>\\n <PicName>2092061_1.jpg</PicName>\\n <CategoryId>88888888</CategoryId>\\n <CustomContent>zidingyi</CustomContent>\\n <IntAttr>2</IntAttr>\\n <IntAttr2>2</IntAttr2>\\n <StrAttr>test</StrAttr>\\n <StrAttr2>test</StrAttr2>\\n <StrAttr3>test</StrAttr3>\\n <StrAttr4>test</StrAttr4>\\n <IntAttr3>2</IntAttr3>\\n <IntAttr4>2</IntAttr4>\\n </Auctions>\\n <Code>0</Code>\\n <Success>true</Success>\\n <Exists>true</Exists>\\n</CheckImageExistsResponse>","errorExample":""}]', + ], + 'CompareSimilarByImage' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -942,1614 +494,343 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREimagesearchF4L5JA', - ], + 'abilityTreeNodes' => ['FEATUREimagesearchAOOGRD'], ], 'parameters' => [ [ - 'name' => 'InstanceName', - 'in' => 'formData', - 'schema' => [ - 'description' => '图搜实例名称。最多支持20个字符。'."\n" - .'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n" - .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" - .'>这里的实例名称并非实例ID，使用时请区分。', - 'type' => 'string', - 'required' => true, - 'example' => 'demoinstance1', - ], - ], - [ - 'name' => 'ProductId', - 'in' => 'formData', - 'schema' => [ - 'description' => '商品ID。'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2092061_1', - 'isFileTransferUrl' => false, - ], - ], - [ - 'name' => 'PicName', - 'in' => 'formData', - 'schema' => [ - 'description' => '图片名称。', - 'type' => 'string', - 'required' => true, - 'example' => '2092061_1.jpg', - ], - ], - [ - 'name' => 'CategoryId', - 'in' => 'formData', - 'schema' => [ - 'description' => '商品类目。具体请参见[类目参考](~~179184~~)。'."\n" - .' - 对于商品搜索，如果设置类目，则以设置的为准；如果不设置类目，则由系统进行类目预测，预测的类目结果可以在Response中获取 。'."\n" - .'<props="china">'."\n" - .' - 对于布料、商标、通用、家具家居和工业五金搜索，不论是否设置类目，系统会将类目设置为88888888。'."\n" - .'</props>'."\n" - .'<props="intl">'."\n" - .'- 对于通用搜索，不论是否设置类目，系统会将类目设置为88888888。</props>'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '88888888', - 'minimum' => '0', - 'example' => '88888888', - 'enum' => [ - '0', - '1', - '2', - '3', - '4', - '5', - '6', - '7', - '8', - '9', - '20', - '21', - '22', - '88888888', - ], - ], - ], - [ - 'name' => 'Num', - 'in' => 'formData', - 'schema' => [ - 'description' => '返回结果的数目。取值范围：1~100。默认值为10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], - ], - [ - 'name' => 'Start', + 'name' => 'PrimaryPicContent', 'in' => 'formData', - 'schema' => [ - 'description' => '返回结果的起始位置。取值范围：0~499。默认值为0。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '499', - 'exclusiveMaximum' => false, - 'minimum' => '0', - 'exclusiveMinimum' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => '图片内容。'."\n" + ."\n" + .'- 图片大小要求不超过4 MB。'."\n" + .'- 图片格式：PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM。'."\n" + .'- 传输等待时间不超过5秒。'."\n" + .'<props="china">'."\n" + .'- 服务类型为商品图片搜索、通用图片搜索、家具家居图片搜索和工业五金图片搜索时，图片长和宽像素要求大于等于100PX且小于等于4096PX。'."\n" + .'</props>'."\n" + .'<props="china">'."\n" + .'- 服务类型为商标图片搜索时，图片长和宽像素要求大于等于200PX且小于4096PX。'."\n" + .'</props>'."\n" + .'<props="china">'."\n" + .'- 服务类型为布料图片搜索时，图片长和宽像素要求大于等于448PX且小于等于4096PX。'."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + .'- 服务类型为商品图片搜索、通用图片搜索时，图片长和宽像素要求大于等于100PX且小于等于4096PX。'."\n" + .'</props>'."\n" + .'- 图片中不能包含旋转信息。'."\n" + ."\n" + .'> **使用SDK方式调用：**- 仅支持V3版本SDK，无需填写PrimaryPicContent字段，SDK已将本字段封装为PrimaryPicContentObject字段并自动转化为Base64编码。具体示例参考 [JAVA SDK](~~179188~~)。- SDK不支持客户直接传递图片URL，V3版本SDK提供了一种变相实现URL上传的方式。具体示例参考 [JAVA SDK](~~179188~~)。', 'type' => 'string', 'required' => true, 'example' => 'AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=', 'isFileTransferUrl' => true], ], [ - 'name' => 'Filter', + 'name' => 'SecondaryPicContent', 'in' => 'formData', - 'schema' => [ - 'description' => '过滤条件。int_attr支持的操作符有in、not in、大于号(>)、大于等于号(>=)、小于号(<)、小于等于号(<=)、等于号(=)。str_attr支持的操作符有in、not in、等于号(=)和不等号(!=)，多个条件之支持AND和OR进行连接。'."\n" - .'例如：'."\n" - .'- int_attr>=100。'."\n" - .'- str_attr!="value1"。'."\n" - .'- int_attr=1000 AND str_attr="value1"。'."\n" - ."\n" - .'>最多支持4096个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'int_attr>=100', - ], + 'schema' => ['description' => '图片内容。'."\n" + ."\n" + .'- 图片大小要求不超过4 MB。'."\n" + .'- 图片格式：PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM。'."\n" + .'- 传输等待时间不超过5秒。'."\n" + .'<props="china">'."\n" + .'- 服务类型为商品图片搜索、通用图片搜索、家具家居图片搜索和工业五金图片搜索时，图片长和宽像素要求大于等于100PX且小于等于4096PX。'."\n" + .'</props>'."\n" + .'<props="china">'."\n" + .'- 服务类型为商标图片搜索时，图片长和宽像素要求大于等于200PX且小于4096PX。'."\n" + .'</props>'."\n" + .'<props="china">'."\n" + .'- 服务类型为布料图片搜索时，图片长和宽像素要求大于等于448PX且小于等于4096PX。'."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + .'- 服务类型为商品图片搜索、通用图片搜索时，图片长和宽像素要求大于等于100PX且小于等于4096PX。'."\n" + .'</props>'."\n" + .'- 图片中不能包含旋转信息。'."\n" + ."\n" + .'> **使用SDK方式调用：**- 仅支持V3版本SDK，无需填写PrimaryPicContent字段，SDK已将本字段封装为PrimaryPicContentObject字段并自动转化为Base64编码。具体示例参考[JAVA SDK](~~179188~~)。- SDK不支持客户直接传递图片URL，V3版本SDK提供了一种变相实现URL上传的方式。具体示例参考[JAVA SDK](~~179188~~)。', 'type' => 'string', 'required' => true, 'example' => 'AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=', 'isFileTransferUrl' => true], ], [ - 'name' => 'DistinctProductId', + 'name' => 'InstanceName', 'in' => 'formData', - 'schema' => [ - 'description' => '根据ProductId进行去重复数据。'."\n" - .'> 设置为true则有效。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'ScoreThreshold', - 'in' => 'query', - 'schema' => [ - 'description' => '填写相似度分数阈值后，只返回图片相似度分数大于等于阈值的图片信息。阈值范围0.00-1.00，最大支持2位小数，默认为0.00 。', - 'type' => 'string', - 'required' => false, - 'example' => '0.50', - ], + 'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n" + .'如果已经购买图搜实例可登录<props="intl">[图像搜索管控台](https://imagesearch.console.alibabacloud.com)</props><props="china">[图像搜索管控台](https://imagesearch.console.aliyun.com)</props>查看。'."\n" + .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" + .'>这里的实例名称并非实例ID，使用时请区分。', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '结果返回。', + 'title' => 'Schema of Response', + 'description' => '相似度计算结果。', 'type' => 'object', 'properties' => [ - 'Msg' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Head' => [ - 'description' => '搜索结果概述信息。', - 'type' => 'object', - 'properties' => [ - 'DocsFound' => [ - 'description' => '返回结果数目。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'DocsReturn' => [ - 'description' => '实例中命中结果数目。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', - ], - 'SearchTime' => [ - 'description' => '搜索耗时，单位毫秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '95', - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1', - ], - 'Auctions' => [ - 'description' => '所有返回的商品描述信息。', - 'type' => 'array', - 'items' => [ - 'description' => '图片参数。', - 'type' => 'object', - 'properties' => [ - 'ProductId' => [ - 'description' => '商品ID。', - 'type' => 'string', - 'example' => '2092061_1', - ], - 'PicName' => [ - 'description' => '图片名称。', - 'type' => 'string', - 'example' => '2092061_1.jpg', - ], - 'CategoryId' => [ - 'description' => '图片类目。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'SortExprValues' => [ - 'description' => '系统打分信息。'."\n" - .'> - 当前字段已弃用，建议使用Score。'."\n" - .'- SortExprValues是一个分号分隔的二元组，第一个值表示图片的相关性分数，值越大表示和查询的图片相关性越高。由于算法模型不同。'."\n" - .'- 当类目为0~2时，SortExprValues值域范围：0～7.33136443711219e+24。'."\n" - .'- 类目为其他值时，SortExprValues值域范围：0～5.37633353624177e+24。当两个图片完全一样时，这个分值最大。', - 'type' => 'string', - 'example' => '5.37633353624177e+24;0', - ], - 'CustomContent' => [ - 'description' => '用户自定义的内容。', - 'type' => 'string', - 'example' => 'zidingyi', - ], - 'Score' => [ - 'description' => '图片相似打分。取值范围：0~1。'."\n" - .'> 需要版本升级至V3.1.1方可使用。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'IntAttr' => [ - 'description' => '整数类型属性。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'IntAttr2' => [ - 'description' => '整数类型属性。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'StrAttr' => [ - 'description' => '字符串类型属性。'."\n", - 'type' => 'string', - 'example' => 'ss', - ], - 'StrAttr2' => [ - 'description' => '字符串类型属性。'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'StrAttr3' => [ - 'description' => '字符串类型属性，最多支持128个字符。可用于查询时过滤，查询时会返回该字段。', - 'type' => 'string', - 'example' => 'test', - ], - 'StrAttr4' => [ - 'description' => '字符串类型属性，最多支持128个字符。可用于查询时过滤，查询时会返回该字段。', - 'type' => 'string', - 'example' => 'test', - ], - 'IntAttr3' => [ - 'description' => '整数类型属性，可用于查询时过滤，查询时会返回该字段。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'IntAttr4' => [ - 'description' => '整数类型属性，可用于查询时过滤，查询时会返回该字段。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], - 'Code' => [ - 'description' => '错误码。'."\n" - .'- 0：成功。'."\n" - .'- 非0：失败。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'PicInfo' => [ - 'description' => '类目预测、主体识别结果等信息。', + 'Score' => ['description' => '图片相似打分。取值范围：0~1。', 'type' => 'number', 'format' => 'double', 'example' => '0.85'], + 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879'], + 'Msg' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success'], + 'AccessDeniedDetail' => [ + 'description' => '鉴权返回集合。', 'type' => 'object', 'properties' => [ - 'Region' => [ - 'description' => ' 主体识别结果。'."\n" - .'图片的主体区域，格式为x1,x2,y1,y2，其中 x1,y1 是左上角的点，x2，y2是右下角的点。若用户请求中指定了主体区域，则以请求中为准。', - 'type' => 'string', - 'example' => '280,486,232,351', - ], - 'CategoryId' => [ - 'description' => ' 类目预测结果。'."\n" - .'若用户请求中指定了类目，则以请求中为准。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'MultiRegion' => [ - 'description' => '主体识别集合。', - 'type' => 'array', - 'items' => [ - 'description' => '主体集合。', - 'type' => 'object', - 'properties' => [ - 'Region' => [ - 'description' => ' 主体识别结果。'."\n" - .'图片的主体区域，格式为x1,x2,y1,y2，其中 x1,y1 是左上角的点，x2，y2是右下角的点。若用户请求中指定了主体区域，则以请求中为准。', - 'type' => 'string', - 'example' => '280,486,232,351', - ], - ], - ], - ], - 'AllCategories' => [ - 'description' => '系统支持的所有类目信息。', - 'type' => 'array', - 'items' => [ - 'description' => '类目信息。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => ' 类目名称。', - 'type' => 'string', - 'example' => 'other', - ], - 'Id' => [ - 'description' => '类目ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '88888888', - ], - ], - ], - ], + 'AuthAction' => ['description' => '鉴权请求Action。', 'type' => 'string', 'example' => 'xxx'], + 'AuthPrincipalDisplayName' => ['description' => '鉴权主体信息。', 'type' => 'string', 'example' => '111'], + 'AuthPrincipalOwnerId' => ['description' => '鉴权主体的主账号ID。', 'type' => 'string', 'example' => '222'], + 'AuthPrincipalType' => ['description' => '鉴权主体类型。', 'type' => 'string', 'example' => 'SubUser'], + 'EncodedDiagnosticMessage' => ['description' => '加密后的完整诊断信息。', 'type' => 'string', 'example' => 'xxxxxx'], + 'NoPermissionType' => ['description' => 'ImplicitDeny：未命中任何策略。'."\n" + .'ExplicitDeny：明确命中Deny策略。', 'type' => 'string', 'example' => 'ImplicitDeny'], + 'PolicyType' => ['description' => '引起无权限的策略类型。', 'type' => 'string', 'example' => 'AccountLevelIdentityBasedPolicy'], ], ], - 'Success' => [ - 'description' => '请求是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => '错误码。'."\n" + .'- 0：成功。'."\n" + .'- 非0：失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'BadRequest', - 'errorMessage' => 'The request has invalid parameters.', - ], - [ - 'errorCode' => 'InstanceStatusError', - 'errorMessage' => 'Your instance is unavailable.', - ], - [ - 'errorCode' => 'TimeoutForTransferImage', - 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', - ], - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'NoCaretSeperator', - 'errorMessage' => 'The body content is missing the ^ separator.', - ], - [ - 'errorCode' => 'EmptyMeta', - 'errorMessage' => 'The body content has an empty meta field.', - ], - [ - 'errorCode' => 'InvalidMetaItem', - 'errorMessage' => 'The meta field is invalid.', - ], - [ - 'errorCode' => 'NoPicList', - 'errorMessage' => 'The body content is missing the pic_list parameter.', - ], - [ - 'errorCode' => 'InvalidPicList', - 'errorMessage' => 'The specified pic_list parameter is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedPic', - 'errorMessage' => 'he content of an image is not specified in the HTTP POST body.', - ], - [ - 'errorCode' => 'NoSpecifiedSearchPic', - 'errorMessage' => 'The search image is not specified.', - ], - [ - 'errorCode' => 'InvalidCategory', - 'errorMessage' => 'The specified category is invalid.', - ], - [ - 'errorCode' => 'OverflowMaxResultNum', - 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', - ], - [ - 'errorCode' => 'OverflowMaxReturnNum', - 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', - ], - [ - 'errorCode' => 'InvalidStartParameter', - 'errorMessage' => 'The specified parameter start is inavlid.', - ], - [ - 'errorCode' => 'InvalidNumParameter', - 'errorMessage' => 'The specified parameter num is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedAddPic', - 'errorMessage' => 'The image to insert is not specified.', - ], - [ - 'errorCode' => 'NoSpecifiedItemId', - 'errorMessage' => 'The item_id parameter is not specified.', - ], - [ - 'errorCode' => 'InvalidIntAttr', - 'errorMessage' => 'The specified int_attr field is invalid.', - ], - [ - 'errorCode' => 'UnsupportedPicFormat', - 'errorMessage' => 'The specified image format is invalid.', - ], - [ - 'errorCode' => 'InvalidFilterClause', - 'errorMessage' => 'The specified filtering condition is invalid.', - ], - [ - 'errorCode' => 'InstanceOverQuota', - 'errorMessage' => 'The number of items exceeds the limit.', - ], - [ - 'errorCode' => 'IncorrectOrientation', - 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', - ], - [ - 'errorCode' => 'UnsupportedPicPixels', - 'errorMessage' => 'The specified pixels is not supported.', - ], - [ - 'errorCode' => 'SearchTimeout', - 'errorMessage' => 'The request is timed out.', - ], - [ - 'errorCode' => 'PicNotExist', - 'errorMessage' => 'The search picture does not exist.', - ], - [ - 'errorCode' => 'NoSpecifiedProductId', - 'errorMessage' => 'The parameter ProductId no specified.', - ], - [ - 'errorCode' => 'NoSpecifiedPicName', - 'errorMessage' => 'The parameter PicName no specified.', - ], - [ - 'errorCode' => 'NoSpecifiedPicContent', - 'errorMessage' => 'The parameter PicContent no specified.', - ], - [ - 'errorCode' => 'InvalidType', - 'errorMessage' => 'The specified parameter Type is not valid.', - ], - [ - 'errorCode' => 'InvalidProductId', - 'errorMessage' => 'The specified parameter ProductId is not valid.', - ], - [ - 'errorCode' => 'InvalidPicName', - 'errorMessage' => 'The specified parameter PicName is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr', - 'errorMessage' => 'The specified parameter StrAttr is not valid.', - ], - [ - 'errorCode' => 'InvalidCustomContent', - 'errorMessage' => 'The specified parameter CustomContent is not valid.', - ], - [ - 'errorCode' => 'InvalidPicContent', - 'errorMessage' => 'The specified parameter PicContent length greater than 2 * 1024 * 1024.', - ], - [ - 'errorCode' => 'InvalidStrAttr4', - 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr3', - 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr2', - 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr4', - 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr3', - 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr2', - 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', - ], - [ - 'errorCode' => 'UnsupportedOperationType', - 'errorMessage' => 'The specified action is not supported.', - ], - [ - 'errorCode' => 'UnsupportedInstanceType', - 'errorMessage' => 'The instance type is not supported.', - ], + ['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request timed out.', 'description' => '请求超时'], + ['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Image transfer timed out.', 'description' => '客户端图片传输超时'], + ['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => '无效的图片格式'], + ['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => '图片像素值不支持'], + ['errorCode' => 'UnsupportedPictureFormat', 'errorMessage' => 'The format of the specified picture is not supported.', 'description' => '用户图片格式不支持'], + ['errorCode' => 'Console.InstanceNotFound', 'errorMessage' => 'The specified ImageSearch instance is not found.', 'description' => '查找不到实例，检查购买的实例ID是否正确。'], + ['errorCode' => 'Console.PidError', 'errorMessage' => 'The number of PID bindings of the current instance exceeds 50.', 'description' => '当前实例PID绑定数量超过50'], + ['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => '请求body含有空的字段'], + ['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => '图片包含不支持的旋转参数'], + ['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => '实例的图片数量超过限制值'], + ['errorCode' => 'InstanceStatusError', 'errorMessage' => 'The current instance status does not support this operation.', 'description' => '实例状态不可用'], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'], + ['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The image size exceeds 4 MB.', 'description' => '图片大小超过4M'], + ['errorCode' => 'InvalidPicUrl', 'errorMessage' => 'The specified parameter PicUrl is not valid.', 'description' => '无效的PicUrl参数'], + ['errorCode' => 'NeedRegisterBeforeInvoke', 'errorMessage' => 'Register for PID before invoking the service.', 'description' => '调用前需要先注册pid'], + ['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => '请求body缺少特定符号'], + ['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'The content of an image is not specified in the HTTP POST body.', 'description' => '图片未指定'], + ['errorCode' => 'PicNotExist', 'errorMessage' => 'The specified image does not exist.', 'description' => '图片未指定'], + ['errorCode' => 'InvalidSecondaryPicContent', 'errorMessage' => 'The specified parameter SecondaryPicContent is not valid.', 'description' => '无效的SecondaryPicContent参数'], + ['errorCode' => 'InvalidPrimaryPicContent', 'errorMessage' => 'The specified parameter PrimaryPicContent is not valid.', 'description' => '无效的PrimaryPicContent参数'], + ['errorCode' => 'PictureError', 'errorMessage' => '[download] Img Download Failed.', 'description' => '图片下载失败，请检查图片'], + ['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => '内部错误：不支持的action'], + ['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => '内部错误：不支持的实例类型'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation.', - ], - [ - 'errorCode' => 'DeniedRequest', - 'errorMessage' => 'Your request was denied due to instance flow control.', - ], + ['errorCode' => 'Console.NoPermissionError', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => '你没有权限进行该操作'], + ['errorCode' => 'Console.NotAllowedModifyToken', 'errorMessage' => 'You are not allowed to modify token today.', 'description' => '今天不允许用户修改该token值'], + ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => '请求被限流'], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => '未授权的行为'], + ], + 409 => [ + ['errorCode' => 'Console.TaskAlreadyExist', 'errorMessage' => 'A task that is in progress already exists.', 'description' => '已经存在正在运行的任务。'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal server error occurred.', - ], - [ - 'errorCode' => 'NetworkException', - 'errorMessage' => 'A network error occurred.', - ], - [ - 'errorCode' => 'RequestTimeout', - 'errorMessage' => 'The request is timeout.', - ], - [ - 'errorCode' => 'ExtractFeatureTimeout', - 'errorMessage' => 'The request was timed out while extracting features.', - ], - [ - 'errorCode' => 'AccessEngineFailed', - 'errorMessage' => 'An error occurred while accessing the search engine.', - ], - [ - 'errorCode' => 'InternalOssError', - 'errorMessage' => 'An internal OAS error occurred.', - ], - [ - 'errorCode' => 'InternalSwiftError', - 'errorMessage' => 'An internal SWIFT error occurred.', - ], - [ - 'errorCode' => 'InternalTableStoreError', - 'errorMessage' => 'An internal Table Store error occurred.', + ['errorCode' => 'ServerInternalError', 'errorMessage' => 'An internal error occurred.', 'description' => '系统内部错误'], + ['errorCode' => 'UnknownException', 'errorMessage' => 'An internal server error occurred.', 'description' => '未知异常'], + ['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''], + ['errorCode' => 'ConnectionDVException', 'errorMessage' => 'Failed to obtain collection.', 'description' => 'internalError'], + ['errorCode' => 'Console.CallServiceError', 'errorMessage' => 'An internal service error occurred.', 'description' => '访问内部服务错误'], + ['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request timed out while extracting features.', 'description' => '内部错误：提取特征超时'], + ['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => '内部错误：请求内部算法错误'], + ['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => '内部错误：请求内部消息队列错误'], + ['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => '内部错误：请求特征存储错误'], + ['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => '内部错误：请求网络异常'], + ['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request timed out.', 'description' => '内部错误：请求超时'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '相似度比较', + 'summary' => '本接口用于对比两张图片相似值。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imagesearch:CompareSimilarByImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"Head\\": {\\n \\"DocsFound\\": 10,\\n \\"DocsReturn\\": 10000,\\n \\"SearchTime\\": 95\\n },\\n \\"RequestId\\": \\"36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1\\",\\n \\"Auctions\\": [\\n {\\n \\"ProductId\\": \\"2092061_1\\",\\n \\"PicName\\": \\"2092061_1.jpg\\",\\n \\"CategoryId\\": 20,\\n \\"SortExprValues\\": \\"5.37633353624177e+24;0\\",\\n \\"CustomContent\\": \\"zidingyi\\",\\n \\"Score\\": 1,\\n \\"IntAttr\\": 2,\\n \\"IntAttr2\\": 20,\\n \\"StrAttr\\": \\"ss\\",\\n \\"StrAttr2\\": \\"test\\",\\n \\"StrAttr3\\": \\"test\\",\\n \\"StrAttr4\\": \\"test\\",\\n \\"IntAttr3\\": 1,\\n \\"IntAttr4\\": 1\\n }\\n ],\\n \\"Code\\": 0,\\n \\"PicInfo\\": {\\n \\"Region\\": \\"280,486,232,351\\",\\n \\"CategoryId\\": 20,\\n \\"MultiRegion\\": [\\n {\\n \\"Region\\": \\"280,486,232,351\\"\\n }\\n ],\\n \\"AllCategories\\": [\\n {\\n \\"Name\\": \\"other\\",\\n \\"Id\\": 88888888\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '通过名称搜索图像', - 'description' => '### 使用说明'."\n" - .'本接口用于根据名称（即ProductId和PicName）查询图像搜索实例中的图片信息。'."\n" - ."\n" - .'> 如需了解更多产品详情和获取技术支持，请单击[在线咨询](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2)或通过钉钉群（35035130）联系我们。'."\n" - ."\n\n" - .'### QPS限制'."\n" - .'查询操作默认的最大访问频率可在控制台中查看，为您购买时所选择的访问频次（QPS），当前支持1QPS、5QPS、10QPS。'."\n" - ."\n", - 'extraInfo' => '### 错误码'."\n" - .'请参见[错误码](~~66619~~)。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Score\\": 0.85,\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Msg\\": \\"success\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalDisplayName\\": \\"111\\",\\n \\"AuthPrincipalOwnerId\\": \\"222\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"xxxxxx\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"AccountLevelIdentityBasedPolicy\\"\\n },\\n \\"Code\\": 0\\n}","errorExample":""},{"type":"xml","example":"<CompareSimilarByImageResponse>\\n <Score>0.85</Score>\\n <Success>true</Success>\\n <RequestId>B3137727-7D6E-488C-BA21-0E034C38A879</RequestId>\\n <Msg>success</Msg>\\n <AccessDeniedDetail>\\n <AuthAction>xxx</AuthAction>\\n <AuthPrincipalDisplayName>111</AuthPrincipalDisplayName>\\n <AuthPrincipalOwnerId>222</AuthPrincipalOwnerId>\\n <AuthPrincipalType>SubUser</AuthPrincipalType>\\n <EncodedDiagnosticMessage>xxxxxx</EncodedDiagnosticMessage>\\n <NoPermissionType>ImplicitDeny</NoPermissionType>\\n <PolicyType>AccountLevelIdentityBasedPolicy</PolicyType>\\n </AccessDeniedDetail>\\n <Code>0</Code>\\n</CompareSimilarByImageResponse>","errorExample":""}]', ], - 'SearchImageByPic' => [ - 'summary' => '本文为您介绍SearchByPic的语法及示例，用于根据图片查询图像搜索实例中的图片信息。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteImage' => [ + 'summary' => '本文为您介绍DeleteImage接口的语法及示例，用于向图像搜索实例中删除图片信息。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREimagesearchF4L5JA', - ], + 'abilityTreeNodes' => ['FEATUREimagesearchIT4SIC'], ], 'parameters' => [ [ 'name' => 'InstanceName', 'in' => 'formData', - 'schema' => [ - 'description' => '图搜实例名称。最多支持20个字符。'."\n" - .'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n" - .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" - .'>这里的实例名称并非实例ID，使用时请区分。', - 'type' => 'string', - 'required' => true, - 'example' => 'demoinstance1', - ], - ], - [ - 'name' => 'PicContent', - 'in' => 'formData', - 'schema' => [ - 'description' => '图片内容。'."\n" - .' - 图片大小要求不超过4 MB。'."\n" - .' - 图片格式：PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM。'."\n" - .' - 传输等待时间不超过5秒。'."\n" - .'<props="china">'."\n" - .' - 服务类型为商品图片搜索、通用图片搜索、家具家居图片搜索和工业五金图片搜索时，图片长和宽像素要求大于等于100PX且小于等于4096PX。'."\n" - .'服务类型为商标图片搜索时，图片长和宽像素要求大于等于200PX且小于4096PX。'."\n" - .'服务类型为布料图片搜索时，图片长和宽像素要求大于等于448PX且小于等于4096PX。'."\n" - .'</props>'."\n" - .'<props="intl">'."\n" - .' - 服务类型为商品图片搜索和通用图片搜索时，图片长和宽像素要求大于等于100PX且小于等于4096PX。'."\n" - .'</props>'."\n" - .'- 图片中不能包含旋转信息。'."\n" - ."\n" - .'> - **使用SDK方式调用：**'."\n" - .' - 如使用V3版本SDK，则无需填写PicContent字段，SDK已将本字段封装为PicContentObject字段并自动转化为Base64编码。具体示例参考[JAVA SDK](~~179188~~)。'."\n" - .' - SDK不支持客户直接传递图片URL，V3版本SDK提供了一种变相实现URL上传的方式。具体示例参考[JAVA SDK](~~179188~~)。'."\n" - .'- **使用阿里云OpenAPI平台调用：**'."\n" - .' - 如使用**2019-03-25**版本，**PicContent**字段请填写图片的**Base64**编码。'."\n" - .' - 如使用**2020-12-14**版本，在**PicContent**字段直接点击上传图片即可。', - 'type' => 'string', - 'required' => true, - 'example' => 'AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=', - 'isFileTransferUrl' => true, - ], + 'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n" + .'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n" + .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" + .'>这里的实例名称并非实例ID，且实例名称同区域内唯一不可重复，使用时请区分。', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1'], ], [ - 'name' => 'CategoryId', - 'in' => 'formData', - 'schema' => [ - 'description' => '商品类目。具体请参见[类目参考](~~179184~~)。'."\n" - .' - 对于商品搜索，如果设置类目，则以设置的为准；如果不设置类目，则由系统进行类目预测，预测的类目结果可以在Response中获取 。'."\n" - .'<props="china">'."\n" - .' - 对于布料、商标、通用家具家居和工业五金搜索，不论是否设置类目，系统会将类目设置为88888888。'."\n" - .'</props>'."\n" - .'<props="intl">'."\n" - .' - 对于通用搜索，不论是否设置类目，系统会将类目设置为88888888。'."\n" - .'</props>'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '88888888', - 'minimum' => '0', - 'example' => '88888888', - 'enum' => [ - '0', - '1', - '2', - '3', - '4', - '5', - '6', - '7', - '8', - '9', - '20', - '21', - '22', - '88888888', - ], - ], - ], - [ - 'name' => 'Crop', + 'name' => 'ProductId', 'in' => 'formData', - 'schema' => [ - 'description' => '是否需要进行主体识别。默认true。'."\n" - .' - 为true时，由系统进行主体识别，以识别的主体进行搜索，主体识别结果可在Response中获取。'."\n" - .' - 为false时，则不进行主体识别，以整张图进行搜索。'."\n" - .'<props="china">'."\n" - .'- 对于布料图片搜索，此参数会被忽略，系统会以整张图进行搜索。'."\n" - .'</props>'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '商品ID。'."\n" + ."\n" + .'> 1.一个商品可以有多张图片 2.若IsDeleteByFilter字段为false 则此字段必填', 'type' => 'string', 'required' => false, 'example' => '2092061_1'], ], [ - 'name' => 'Region', - 'in' => 'formData', - 'schema' => [ - 'description' => '图片的主体区域，格式为`x1,x2,y1,y2,` 其中`x1,y1` 是左上角的点，`x2,y2`是右下角的点。'."\n" - .'> - 若用户设置了Region，则不论Crop参数为何值，都将以用户输入Region进行搜索。'."\n" - .'<props="china">'."\n" - .'- 对于布料图片搜索，此参数会被忽略，系统会以整张图进行搜索。'."\n" - .'</props>'."\n" - ."\n\n", - 'type' => 'string', - 'required' => false, - 'example' => '280,486,232,351', - ], - ], - [ - 'name' => 'Num', + 'name' => 'PicName', 'in' => 'formData', - 'schema' => [ - 'description' => '返回结果的数目。取值范围：1~100。默认值为10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => '图片名称。'."\n" + .' - 如果不指定本参数，则删除ProductId下所有图片。'."\n" + .' - 如果指定本参数，则删除ProductId+PicName指定的图片。', 'type' => 'string', 'required' => false, 'example' => '2092061_1.jpg'], ], [ - 'name' => 'Start', + 'name' => 'IsDeleteByFilter', 'in' => 'formData', - 'schema' => [ - 'description' => '返回结果的起始位置。取值范围：0~499。默认值为0。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '499', - 'minimum' => '0', - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => '根据Filter字段去重'."\n" + .'> 1.若为true 则根据Filter或Filter+ProductId删除 且Filter必填。2.若为false 则根据ProductId或者ProductId+PicName进行删除 ProductId必填', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'Filter', 'in' => 'formData', - 'schema' => [ - 'description' => '过滤条件。int_attr支持的操作符有in、not in、大于号(>)、大于等于号(>=)、小于号(<)、小于等于号(<=)、等于号(=)。str_attr支持的操作符有in、not in、等于号(=)和不等号(!=)，多个条件之间支持AND和OR进行连接。'."\n" - .'例如：'."\n" - .'- int_attr >= 100。'."\n" - .'- str_attr != "value1"。'."\n" - .'- int_attr = 1000 AND str_attr = "value1"。'."\n" - ."\n" - .'>最多支持4096个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'int_attr=1000 AND str_attr="value1"', - ], - ], - [ - 'name' => 'DistinctProductId', - 'in' => 'formData', - 'schema' => [ - 'description' => '如果为true则检索时根据ProductId字段进行去重复数据。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'ScoreThreshold', - 'in' => 'query', - 'schema' => [ - 'description' => '填写相似度分数阈值后，只返回图片相似度分数大于等于阈值的图片信息。阈值范围0.00-1.00，最大支持2位小数，默认为0.00 。', - 'type' => 'string', - 'required' => false, - 'example' => '0.50', - ], + 'schema' => ['description' => '过滤条件。int_attr支持的操作符有大于号(>)、大于等于号(>=)、小于号(<)、小于等于号(<=)、等于号(=)。str_attr支持的操作符有等于号(=)和不等号(!=)，多个条件之支持AND和OR进行连接。'."\n" + .'例如：'."\n" + .'- int_attr >= 100。'."\n" + .'- str_attr != "value1"。'."\n" + .'- int_attr = 1000 AND str_attr = "value1"。'."\n" + .'>最多支持4096个字符。', 'type' => 'string', 'required' => false, 'example' => 'int_attr=1000 AND str_attr="value1"'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回结果。', + 'description' => '返回对象。', 'type' => 'object', 'properties' => [ - 'Msg' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Head' => [ - 'description' => '搜索结果概述信息。', - 'type' => 'object', - 'properties' => [ - 'DocsFound' => [ - 'description' => '返回结果数目。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'DocsReturn' => [ - 'description' => '实例中命中结果数目。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', - ], - 'SearchTime' => [ - 'description' => '搜索耗时，单位毫秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '95', - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', - ], - 'Auctions' => [ - 'description' => '所有返回的商品描述信息。', - 'type' => 'array', - 'items' => [ - 'description' => '所有返回的商品描述信息。', - 'type' => 'object', - 'properties' => [ - 'ProductId' => [ - 'description' => '商品ID。', - 'type' => 'string', - 'example' => '2092061_1', - ], - 'PicName' => [ - 'description' => '图片名称。', - 'type' => 'string', - 'example' => '2092061_1.jpg', - ], - 'CategoryId' => [ - 'description' => '图片类目。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8888888', - ], - 'SortExprValues' => [ - 'description' => '系统打分信息。'."\n" - .'> - 当前字段已弃用，建议使用Score。 '."\n" - .'- SortExprValues是一个分号分隔的二元组，第一个值表示图片的相关性分数，值越大表示和查询的图片相关性越高。由于算法模型不同。'."\n" - .'- 当类目为0~2时，SortExprValues值域范围：0～7.33136443711219e+24。'."\n" - .'- 类目为其他值时，SortExprValues值域范围：0～5.37633353624177e+24。当两个图片完全一样时，这个分值最大。', - 'type' => 'string', - 'example' => '5.37633353624177e+24;0', - ], - 'CustomContent' => [ - 'description' => '用户自定义的内容。', - 'type' => 'string', - 'example' => 'zidingyi', - ], - 'Score' => [ - 'description' => '图片相似打分。取值范围：0~1。'."\n" - .'> 需要版本升级至V3.1.1方可使用。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'IntAttr' => [ - 'description' => '整数类型属性。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'IntAttr2' => [ - 'description' => '整数类型属性。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'StrAttr2' => [ - 'description' => '字符串类型属性。', - 'type' => 'string', - 'example' => 'test', - ], - 'StrAttr' => [ - 'description' => '字符串类型属性。', - 'type' => 'string', - 'example' => 'test', - ], - 'StrAttr3' => [ - 'description' => '字符串类型属性。', - 'type' => 'string', - 'example' => 'test', - ], - 'StrAttr4' => [ - 'description' => '字符串类型属性。', - 'type' => 'string', - 'example' => 'test', - ], - 'IntAttr3' => [ - 'description' => '整数类型属性。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'IntAttr4' => [ - 'description' => '整数类型属性。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - ], - ], - ], - 'Code' => [ - 'description' => ' 错误码。'."\n" - .'- 0：成功。'."\n" - .'- 非0：失败。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'PicInfo' => [ - 'description' => '类目预测、主体识别结果等信息。', + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0703956F-9BCC-48FA-99F7-96C0BF449C69'], + 'Code' => ['description' => '错误码。'."\n" + .'- 0：成功。'."\n" + .'- 非0：失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => [ + 'description' => '删除结果返回。', 'type' => 'object', 'properties' => [ - 'Region' => [ - 'description' => '主体识别结果。图片的主体区域，格式为x1,x2,y1,y2，其中 x1,y1 是左上角的点，x2，y2是右下角的点。若用户请求中指定了主体区域，则以请求中为准。', - 'type' => 'string', - 'example' => '280,486,232,351', - ], - 'CategoryId' => [ - 'description' => '类目预测结果。若用户请求中指定了类目，则以请求中为准。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '88888888', - ], - 'MultiRegion' => [ - 'description' => '主体识别结果集合。'."\n" - .'> 需要版本升级至V3.1.1方可使用。', - 'type' => 'array', - 'items' => [ - 'description' => '主体识别结果。', - 'type' => 'object', - 'properties' => [ - 'Region' => [ - 'description' => '主体识别结果。图片的主体区域，格式为x1,x2,y1,y2，其中 x1,y1 是左上角的点，x2，y2是右下角的点。若用户请求中指定了主体区域，则以请求中为准。', - 'type' => 'string', - 'example' => '280,486,232,351', - ], - ], - ], - ], - 'AllCategories' => [ - 'description' => '系统支持的所有类目信息。', + 'PicNames' => [ + 'description' => '删除的PicName。', 'type' => 'array', - 'items' => [ - 'description' => '系统支持的所有类目信息。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '类目名称。', - 'type' => 'string', - 'example' => 'other', - ], - 'Id' => [ - 'description' => '类目ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '88888888', - ], - ], - ], + 'items' => ['description' => '删除的PicName。', 'type' => 'string', 'example' => 'xxx.jpg'], + 'example' => '5555.jpg', ], ], ], - 'Success' => [ - 'description' => '请求是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'BadRequest', - 'errorMessage' => 'The request has invalid parameters.', - ], - [ - 'errorCode' => 'InstanceStatusError', - 'errorMessage' => 'Your instance is unavailable.', - ], - [ - 'errorCode' => 'TimeoutForTransferImage', - 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', - ], - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'NoCaretSeperator', - 'errorMessage' => 'The body content is missing the ^ separator.', - ], - [ - 'errorCode' => 'EmptyMeta', - 'errorMessage' => 'The body content has an empty meta field.', - ], - [ - 'errorCode' => 'InvalidMetaItem', - 'errorMessage' => 'The meta field is invalid.', - ], - [ - 'errorCode' => 'NoPicList', - 'errorMessage' => 'The body content is missing the pic_list parameter.', - ], - [ - 'errorCode' => 'InvalidPicList', - 'errorMessage' => 'The specified pic_list parameter is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedPic', - 'errorMessage' => 'he content of an image is not specified in the HTTP POST body.', - ], - [ - 'errorCode' => 'NoSpecifiedSearchPic', - 'errorMessage' => 'The search image is not specified.', - ], - [ - 'errorCode' => 'InvalidCategory', - 'errorMessage' => 'The specified category is invalid.', - ], - [ - 'errorCode' => 'OverflowMaxResultNum', - 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', - ], - [ - 'errorCode' => 'OverflowMaxReturnNum', - 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', - ], - [ - 'errorCode' => 'InvalidStartParameter', - 'errorMessage' => 'The specified parameter start is inavlid.', - ], - [ - 'errorCode' => 'InvalidNumParameter', - 'errorMessage' => 'The specified parameter num is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedAddPic', - 'errorMessage' => 'The image to insert is not specified.', - ], - [ - 'errorCode' => 'NoSpecifiedItemId', - 'errorMessage' => 'The item_id parameter is not specified.', - ], - [ - 'errorCode' => 'InvalidIntAttr', - 'errorMessage' => 'The specified int_attr field is invalid.', - ], - [ - 'errorCode' => 'UnsupportedPicFormat', - 'errorMessage' => 'The specified image format is invalid.', - ], - [ - 'errorCode' => 'InvalidFilterClause', - 'errorMessage' => 'The specified filtering condition is invalid.', - ], - [ - 'errorCode' => 'InstanceOverQuota', - 'errorMessage' => 'The number of items exceeds the limit.', - ], - [ - 'errorCode' => 'IncorrectOrientation', - 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', - ], - [ - 'errorCode' => 'UnsupportedPicPixels', - 'errorMessage' => 'The specified pixels is not supported.', - ], - [ - 'errorCode' => 'SearchTimeout', - 'errorMessage' => 'The request is timed out.', - ], - [ - 'errorCode' => 'PicNotExist', - 'errorMessage' => 'The search picture does not exist.', - ], - [ - 'errorCode' => 'NoSpecifiedProductId', - 'errorMessage' => 'The parameter ProductId no specified.', - ], - [ - 'errorCode' => 'NoSpecifiedPicName', - 'errorMessage' => 'The parameter PicName no specified.', - ], - [ - 'errorCode' => 'NoSpecifiedPicContent', - 'errorMessage' => 'The parameter PicContent no specified.', - ], - [ - 'errorCode' => 'InvalidType', - 'errorMessage' => 'The specified parameter Type is not valid.', - ], - [ - 'errorCode' => 'InvalidProductId', - 'errorMessage' => 'The specified parameter ProductId is not valid.', - ], - [ - 'errorCode' => 'InvalidPicName', - 'errorMessage' => 'The specified parameter PicName is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr', - 'errorMessage' => 'The specified parameter StrAttr is not valid.', - ], - [ - 'errorCode' => 'InvalidCustomContent', - 'errorMessage' => 'The specified parameter CustomContent is not valid.', - ], - [ - 'errorCode' => 'InvalidPicContent', - 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', - ], - [ - 'errorCode' => 'InvalidPicUrl', - 'errorMessage' => 'The search picture does not exist at the specific url.', - ], - [ - 'errorCode' => 'InvalidInstanceName', - 'errorMessage' => 'The parameter instanceName is not specified.', - ], - [ - 'errorCode' => 'InvalidRequestId', - 'errorMessage' => 'The parameter requestId is not specified.', - ], - [ - 'errorCode' => 'InvalidRequestIdTooLarge', - 'errorMessage' => 'The parameter requestId is too large.', - ], - [ - 'errorCode' => 'InvalidRegion', - 'errorMessage' => 'The specific region is illegal', - ], - [ - 'errorCode' => 'InvalidIntAttr4', - 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr3', - 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr2', - 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr4', - 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr3', - 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr2', - 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', - ], - [ - 'errorCode' => 'PictureError', - 'errorMessage' => '[download] Img Download Failed.', - ], - [ - 'errorCode' => 'UnsupportedOperationType', - 'errorMessage' => 'The specified action is not supported.', - ], - [ - 'errorCode' => 'UnsupportedInstanceType', - 'errorMessage' => 'The instance type is not supported.', - ], + ['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''], + ['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'], + ['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => '请求body缺少特定符号'], + ['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => '请求body含有空的字段'], + ['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => '无效的元信息字段'], + ['errorCode' => 'InvalidPicList', 'errorMessage' => 'The specified pic_list parameter is invalid.', 'description' => '无效的pic_list字段'], + ['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'The content of an image is not specified in the HTTP POST body.', 'description' => '图片未指定'], + ['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''], + ['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => '无效的类目id'], + ['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => '超过了最大的返回结果限制数500'], + ['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => '单次返回数超过限制值100'], + ['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter s is inavlid.', 'description' => ''], + ['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter n is invalid.', 'description' => ''], + ['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''], + ['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => '无效的int过滤字段'], + ['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => '无效的图片格式'], + ['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => '无效的过滤条件'], + ['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => '实例的图片数量超过限制值'], + ['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => '图片包含不支持的旋转参数'], + ['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => '图片像素值不支持'], + ['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''], + ['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'You must specify ProductId.', 'description' => '未指定商品id'], + ['errorCode' => 'InvalidIntAttr4', 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', 'description' => '无效IntAttr4'], + ['errorCode' => 'InvalidIntAttr3', 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', 'description' => '无效IntAttr3'], + ['errorCode' => 'InvalidIntAttr2', 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', 'description' => '无效IntAttr2'], + ['errorCode' => 'InvalidStrAttr4', 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', 'description' => '无效StrAttr4'], + ['errorCode' => 'InvalidStrAttr3', 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', 'description' => '无效StrAttr3'], + ['errorCode' => 'InvalidStrAttr2', 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', 'description' => '无效StrAttr2'], + ['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => '无效StrAttr'], + ['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => '内部错误：不支持的action'], + ['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => '内部错误：不支持的实例类型'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation.', - ], - [ - 'errorCode' => 'DeniedRequest', - 'errorMessage' => 'Your request was denied due to instance flow control.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => '未授权的行为'], + ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => '请求被限流'], ], 500 => [ - [ - 'errorCode' => 'UnknownException', - 'errorMessage' => 'An internal server error occurred.', - ], - [ - 'errorCode' => 'NetworkException', - 'errorMessage' => 'A network error occurred.', - ], - [ - 'errorCode' => 'RequestTimeout', - 'errorMessage' => 'The request is timeout.', - ], - [ - 'errorCode' => 'ExtractFeatureTimeout', - 'errorMessage' => 'The request was timed out while extracting features.', - ], - [ - 'errorCode' => 'AccessEngineFailed', - 'errorMessage' => 'An error occurred while accessing the search engine.', - ], - [ - 'errorCode' => 'InternalOssError', - 'errorMessage' => 'An internal OAS error occurred.', - ], - [ - 'errorCode' => 'InternalSwiftError', - 'errorMessage' => 'An internal SWIFT error occurred.', - ], - [ - 'errorCode' => 'InternalTableStoreError', - 'errorMessage' => 'An internal Table Store error occurred.', - ], - [ - 'errorCode' => 'ConnectionDVException', - 'errorMessage' => 'Failed to obtain collection.', - ], + ['errorCode' => 'UnknownlException', 'errorMessage' => 'An internal server error occurred.', 'description' => ''], + ['errorCode' => 'UnknownException', 'errorMessage' => 'An internal server error occurred.', 'description' => '未知异常'], + ['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => '内部错误：请求网络异常'], + ['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''], + ['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''], + ['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''], + ['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => '内部错误：请求内部算法错误'], + ['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => '内部错误：请求内部消息队列错误'], + ['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => '内部错误：请求特征存储错误'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"Head\\": {\\n \\"DocsFound\\": 10,\\n \\"DocsReturn\\": 10000,\\n \\"SearchTime\\": 95\\n },\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Auctions\\": [\\n {\\n \\"ProductId\\": \\"2092061_1\\",\\n \\"PicName\\": \\"2092061_1.jpg\\",\\n \\"CategoryId\\": 8888888,\\n \\"SortExprValues\\": \\"5.37633353624177e+24;0\\",\\n \\"CustomContent\\": \\"zidingyi\\",\\n \\"Score\\": 1,\\n \\"IntAttr\\": 2,\\n \\"IntAttr2\\": 20,\\n \\"StrAttr2\\": \\"test\\",\\n \\"StrAttr\\": \\"test\\",\\n \\"StrAttr3\\": \\"test\\",\\n \\"StrAttr4\\": \\"test\\",\\n \\"IntAttr3\\": 2,\\n \\"IntAttr4\\": 2\\n }\\n ],\\n \\"Code\\": 0,\\n \\"PicInfo\\": {\\n \\"Region\\": \\"280,486,232,351\\",\\n \\"CategoryId\\": 88888888,\\n \\"MultiRegion\\": [\\n {\\n \\"Region\\": \\"280,486,232,351\\"\\n }\\n ],\\n \\"AllCategories\\": [\\n {\\n \\"Name\\": \\"other\\",\\n \\"Id\\": 88888888\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '根据图片查询图片', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0703956F-9BCC-48FA-99F7-96C0BF449C69\\",\\n \\"Code\\": 0,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PicNames\\": [\\n \\"xxx.jpg\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '删除图片', 'description' => '## 使用说明'."\n" - .'本接口用于根据图片查询图像搜索实例中的图片信息。'."\n" - .'> <props="china">如需了解更多产品详情和获取技术支持，请单击[在线咨询](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2)或通过钉钉群（35035130）联系我们。</props>'."\n" + .'本接口用于向图像搜索实例中删除图片信息。'."\n" + .'>- 如果指定图片在图像搜索实例中不存在，该接口依然会返回成功。不能用返回结果来判断图片是否存在。'."\n" ."\n" .'## QPS限制'."\n" - .'查询操作默认的最大访问频率可在控制台中查看，为您购买时所选择的访问频次（QPS），当前支持1QPS、5QPS、10QPS。'."\n" - ."\n\n" - .'### SDK版本说明'."\n" - .'图像SDK版本升级到V3.1.1，可使用“多主体识别”、“相似性分数”功能。请参见[Java SDK](~~179188~~)。', + .'删除操作默认的并发量为20，也就是每秒钟最多处理20个删除请求。', 'extraInfo' => '## 错误码'."\n" .'请参见[错误码](~~66619~~)。', - ], - 'CompareSimilarByImage' => [ - 'summary' => '本接口用于对比两张图片相似值。', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREimagesearchAOOGRD', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteImage'], ], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'PrimaryPicContent', - 'in' => 'formData', - 'schema' => [ - 'description' => '图片内容。'."\n" - ."\n" - .'- 图片大小要求不超过4 MB。'."\n" - .'- 图片格式：PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM。'."\n" - .'- 传输等待时间不超过5秒。'."\n" - .'<props="china">'."\n" - .'- 服务类型为商品图片搜索、通用图片搜索、家具家居图片搜索和工业五金图片搜索时，图片长和宽像素要求大于等于100PX且小于等于4096PX。'."\n" - .'</props>'."\n" - .'<props="china">'."\n" - .'- 服务类型为商标图片搜索时，图片长和宽像素要求大于等于200PX且小于4096PX。'."\n" - .'</props>'."\n" - .'<props="china">'."\n" - .'- 服务类型为布料图片搜索时，图片长和宽像素要求大于等于448PX且小于等于4096PX。'."\n" - .'</props>'."\n" - .'<props="intl">'."\n" - .'- 服务类型为商品图片搜索、通用图片搜索时，图片长和宽像素要求大于等于100PX且小于等于4096PX。'."\n" - .'</props>'."\n" - .'- 图片中不能包含旋转信息。'."\n" - ."\n" - .'> **使用SDK方式调用：**- 仅支持V3版本SDK，无需填写PrimaryPicContent字段，SDK已将本字段封装为PrimaryPicContentObject字段并自动转化为Base64编码。具体示例参考 [JAVA SDK](~~179188~~)。- SDK不支持客户直接传递图片URL，V3版本SDK提供了一种变相实现URL上传的方式。具体示例参考 [JAVA SDK](~~179188~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=', - 'isFileTransferUrl' => true, - ], - ], - [ - 'name' => 'SecondaryPicContent', - 'in' => 'formData', - 'schema' => [ - 'description' => '图片内容。'."\n" - ."\n" - .'- 图片大小要求不超过4 MB。'."\n" - .'- 图片格式：PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM。'."\n" - .'- 传输等待时间不超过5秒。'."\n" - .'<props="china">'."\n" - .'- 服务类型为商品图片搜索、通用图片搜索、家具家居图片搜索和工业五金图片搜索时，图片长和宽像素要求大于等于100PX且小于等于4096PX。'."\n" - .'</props>'."\n" - .'<props="china">'."\n" - .'- 服务类型为商标图片搜索时，图片长和宽像素要求大于等于200PX且小于4096PX。'."\n" - .'</props>'."\n" - .'<props="china">'."\n" - .'- 服务类型为布料图片搜索时，图片长和宽像素要求大于等于448PX且小于等于4096PX。'."\n" - .'</props>'."\n" - .'<props="intl">'."\n" - .'- 服务类型为商品图片搜索、通用图片搜索时，图片长和宽像素要求大于等于100PX且小于等于4096PX。'."\n" - .'</props>'."\n" - .'- 图片中不能包含旋转信息。'."\n" - ."\n" - .'> **使用SDK方式调用：**- 仅支持V3版本SDK，无需填写PrimaryPicContent字段，SDK已将本字段封装为PrimaryPicContentObject字段并自动转化为Base64编码。具体示例参考[JAVA SDK](~~179188~~)。- SDK不支持客户直接传递图片URL，V3版本SDK提供了一种变相实现URL上传的方式。具体示例参考[JAVA SDK](~~179188~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=', - 'isFileTransferUrl' => true, - ], - ], - [ - 'name' => 'InstanceName', - 'in' => 'formData', - 'schema' => [ - 'description' => '图搜实例名称。最多支持20个字符。'."\n" - .'如果已经购买图搜实例可登录<props="intl">[图像搜索管控台](https://imagesearch.console.alibabacloud.com)</props><props="china">[图像搜索管控台](https://imagesearch.console.aliyun.com)</props>查看。'."\n" - .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" - .'>这里的实例名称并非实例ID，使用时请区分。', - 'type' => 'string', - 'required' => true, - 'example' => 'demoinstance1', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '相似度计算结果。', - 'type' => 'object', - 'properties' => [ - 'Score' => [ - 'description' => '图片相似打分。取值范围：0~1。', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.85', - ], - 'Success' => [ - 'description' => '请求是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', - ], - 'Msg' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'AccessDeniedDetail' => [ - 'description' => '鉴权返回集合。', - 'type' => 'object', - 'properties' => [ - 'AuthAction' => [ - 'description' => '鉴权请求Action。', - 'type' => 'string', - 'example' => 'xxx', - ], - 'AuthPrincipalDisplayName' => [ - 'description' => '鉴权主体信息。', - 'type' => 'string', - 'example' => '111', - ], - 'AuthPrincipalOwnerId' => [ - 'description' => '鉴权主体的主账号ID。', - 'type' => 'string', - 'example' => '222', - ], - 'AuthPrincipalType' => [ - 'description' => '鉴权主体类型。', - 'type' => 'string', - 'example' => 'SubUser', - ], - 'EncodedDiagnosticMessage' => [ - 'description' => '加密后的完整诊断信息。', - 'type' => 'string', - 'example' => 'xxxxxx', - ], - 'NoPermissionType' => [ - 'description' => 'ImplicitDeny：未命中任何策略。'."\n" - .'ExplicitDeny：明确命中Deny策略。', - 'type' => 'string', - 'example' => 'ImplicitDeny', - ], - 'PolicyType' => [ - 'description' => '引起无权限的策略类型。', - 'type' => 'string', - 'example' => 'AccountLevelIdentityBasedPolicy', - ], - ], - ], - 'Code' => [ - 'description' => '错误码。'."\n" - .'- 0：成功。'."\n" - .'- 非0：失败。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imagesearch:DeleteImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'SearchTimeout', - 'errorMessage' => 'The request timed out.', - ], - [ - 'errorCode' => 'TimeoutForTransferImage', - 'errorMessage' => 'Image transfer timed out.', - ], - [ - 'errorCode' => 'UnsupportedPicFormat', - 'errorMessage' => 'The specified image format is invalid.', - ], - [ - 'errorCode' => 'UnsupportedPicPixels', - 'errorMessage' => 'The specified pixels is not supported.', - ], - [ - 'errorCode' => 'UnsupportedPictureFormat', - 'errorMessage' => 'The format of the specified picture is not supported.', - ], - [ - 'errorCode' => 'Console.InstanceNotFound', - 'errorMessage' => 'The specified ImageSearch instance is not found.', - ], - [ - 'errorCode' => 'Console.PidError', - 'errorMessage' => 'The number of PID bindings of the current instance exceeds 50.', - ], - [ - 'errorCode' => 'EmptyMeta', - 'errorMessage' => 'The body content has an empty meta field.', - ], - [ - 'errorCode' => 'IncorrectOrientation', - 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', - ], - [ - 'errorCode' => 'InstanceOverQuota', - 'errorMessage' => 'The number of items exceeds the limit.', - ], - [ - 'errorCode' => 'InstanceStatusError', - 'errorMessage' => 'The current instance status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'InvalidPicContent', - 'errorMessage' => 'The image size exceeds 4 MB.', - ], - [ - 'errorCode' => 'InvalidPicUrl', - 'errorMessage' => 'The specified parameter PicUrl is not valid.', - ], - [ - 'errorCode' => 'NeedRegisterBeforeInvoke', - 'errorMessage' => 'Register for PID before invoking the service.', - ], - [ - 'errorCode' => 'NoCaretSeperator', - 'errorMessage' => 'The body content is missing the ^ separator.', - ], - [ - 'errorCode' => 'NoSpecifiedPic', - 'errorMessage' => 'The content of an image is not specified in the HTTP POST body.', - ], - [ - 'errorCode' => 'PicNotExist', - 'errorMessage' => 'The specified image does not exist.', - ], - [ - 'errorCode' => 'InvalidSecondaryPicContent', - 'errorMessage' => 'The specified parameter SecondaryPicContent is not valid.', - ], - [ - 'errorCode' => 'InvalidPrimaryPicContent', - 'errorMessage' => 'The specified parameter PrimaryPicContent is not valid.', - ], - [ - 'errorCode' => 'PictureError', - 'errorMessage' => '[download] Img Download Failed.', - ], - [ - 'errorCode' => 'UnsupportedOperationType', - 'errorMessage' => 'The specified action is not supported.', - ], - [ - 'errorCode' => 'UnsupportedInstanceType', - 'errorMessage' => 'The instance type is not supported.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Console.NoPermissionError', - 'errorMessage' => 'You are not authorized to perform this operation.', - ], - [ - 'errorCode' => 'Console.NotAllowedModifyToken', - 'errorMessage' => 'You are not allowed to modify token today.', - ], - [ - 'errorCode' => 'DeniedRequest', - 'errorMessage' => 'Your request was denied due to instance flow control.', - ], - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation.', - ], - ], - 409 => [ - [ - 'errorCode' => 'Console.TaskAlreadyExist', - 'errorMessage' => 'A task that is in progress already exists.', - ], - ], - 500 => [ - [ - 'errorCode' => 'ServerInternalError', - 'errorMessage' => 'An internal error occurred.', - ], - [ - 'errorCode' => 'UnknownException', - 'errorMessage' => 'An internal server error occurred.', - ], - [ - 'errorCode' => 'AccessEngineFailed', - 'errorMessage' => 'An error occurred while accessing the search engine.', - ], - [ - 'errorCode' => 'ConnectionDVException', - 'errorMessage' => 'Failed to obtain collection.', - ], - [ - 'errorCode' => 'Console.CallServiceError', - 'errorMessage' => 'An internal service error occurred.', - ], - [ - 'errorCode' => 'ExtractFeatureTimeout', - 'errorMessage' => 'The request timed out while extracting features.', - ], - [ - 'errorCode' => 'InternalOssError', - 'errorMessage' => 'An internal OAS error occurred.', - ], - [ - 'errorCode' => 'InternalSwiftError', - 'errorMessage' => 'An internal SWIFT error occurred.', - ], - [ - 'errorCode' => 'InternalTableStoreError', - 'errorMessage' => 'An internal Table Store error occurred.', - ], - [ - 'errorCode' => 'NetworkException', - 'errorMessage' => 'A network error occurred.', - ], - [ - 'errorCode' => 'RequestTimeout', - 'errorMessage' => 'The request timed out.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Score\\": 0.85,\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Msg\\": \\"success\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalDisplayName\\": \\"111\\",\\n \\"AuthPrincipalOwnerId\\": \\"222\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"xxxxxx\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"AccountLevelIdentityBasedPolicy\\"\\n },\\n \\"Code\\": 0\\n}","errorExample":""},{"type":"xml","example":"<CompareSimilarByImageResponse>\\n <Score>0.85</Score>\\n <Success>true</Success>\\n <RequestId>B3137727-7D6E-488C-BA21-0E034C38A879</RequestId>\\n <Msg>success</Msg>\\n <AccessDeniedDetail>\\n <AuthAction>xxx</AuthAction>\\n <AuthPrincipalDisplayName>111</AuthPrincipalDisplayName>\\n <AuthPrincipalOwnerId>222</AuthPrincipalOwnerId>\\n <AuthPrincipalType>SubUser</AuthPrincipalType>\\n <EncodedDiagnosticMessage>xxxxxx</EncodedDiagnosticMessage>\\n <NoPermissionType>ImplicitDeny</NoPermissionType>\\n <PolicyType>AccountLevelIdentityBasedPolicy</PolicyType>\\n </AccessDeniedDetail>\\n <Code>0</Code>\\n</CompareSimilarByImageResponse>","errorExample":""}]', - 'title' => '相似度比较', ], 'Detail' => [ 'summary' => '本文为您介绍Detail接口的语法及示例，用于根据名称查询图像搜索实例的相关信息。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2561,15 +842,10 @@ [ 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '图搜实例名称。最多支持20个字符。'."\n" - .'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n" - .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" - .'>这里的实例名称并非实例ID，且实例名称同区域内唯一不可重复，使用时请区分。', - 'type' => 'string', - 'required' => true, - 'example' => 'imagesearchName', - ], + 'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n" + .'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n" + .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" + .'>这里的实例名称并非实例ID，且实例名称同区域内唯一不可重复，使用时请区分。', 'type' => 'string', 'required' => true, 'example' => 'imagesearchName'], ], ], 'responses' => [ @@ -2578,67 +854,23 @@ 'description' => '结果返回。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1', - ], - 'Success' => [ - 'description' => '请求是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1'], + 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Instance' => [ 'description' => '实例信息。', 'type' => 'object', 'properties' => [ - 'Capacity' => [ - 'description' => '套餐容量。单位万。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'UtcExpireTime' => [ - 'description' => '实例到期时间。单位毫秒。', - 'type' => 'string', - 'example' => '1623081600000', - ], - 'UtcCreate' => [ - 'description' => '实例创建时间。单位毫秒。', - 'type' => 'string', - 'example' => '1620382716000', - ], - 'ServiceType' => [ - 'description' => '图搜模型。'."\n" - ."\n" - .'<props="intl">0：商品搜索；1：通用图片搜索。</props>'."\n" - .'<props="china">0：商品搜索；1：通用图片搜索；2：布料搜索；3、7：商标搜索；4：版权搜索；5：家具搜索；6：五金搜索。</props>'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Region' => [ - 'description' => '地域信息。', - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'Name' => [ - 'description' => '实例名称。', - 'type' => 'string', - 'example' => 'imagesearchName', - ], - 'TotalCount' => [ - 'description' => '图片数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10063', - ], - 'Qps' => [ - 'description' => '套餐QPS。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'Capacity' => ['description' => '套餐容量。单位万。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'UtcExpireTime' => ['description' => '实例到期时间。单位毫秒。', 'type' => 'string', 'example' => '1623081600000'], + 'UtcCreate' => ['description' => '实例创建时间。单位毫秒。', 'type' => 'string', 'example' => '1620382716000'], + 'ServiceType' => ['description' => '图搜模型。'."\n" + ."\n" + .'<props="intl">0：商品搜索；1：通用图片搜索。</props>'."\n" + .'<props="china">0：商品搜索；1：通用图片搜索；2：布料搜索；3、7：商标搜索；4：版权搜索；5：家具搜索；6：五金搜索。</props>'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Region' => ['description' => '地域信息。', 'type' => 'string', 'example' => 'cn-shanghai'], + 'Name' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'imagesearchName'], + 'TotalCount' => ['description' => '图片数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10063'], + 'Qps' => ['description' => '套餐QPS。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], ], ], @@ -2647,61 +879,27 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'DeniedRequest', - 'errorMessage' => 'Your request was denied due to instance flow control.', - ], - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'Console.BadRequest', - 'errorMessage' => 'The request has invalid parameters.', - ], - [ - 'errorCode' => 'Console.InstanceNotFound', - 'errorMessage' => 'The specified ImageSearch instance is not found.', - ], + ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => ''], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'], + ['errorCode' => 'Console.BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => '非法请求，请检查请求参数。'], + ['errorCode' => 'Console.InstanceNotFound', 'errorMessage' => 'The specified ImageSearch instance is not found.', 'description' => '查找不到实例，检查购买的实例ID是否正确。'], ], [ - [ - 'errorCode' => 'Console.LoginError', - 'errorMessage' => 'Check login failed.', - ], + ['errorCode' => 'Console.LoginError', 'errorMessage' => 'Check login failed.', 'description' => '登录失败，请检查用户名、密码、邮箱是否输入有误。'], ], 403 => [ - [ - 'errorCode' => 'Console.NoPermission', - 'errorMessage' => 'You are not authorized to this operation.', - ], + ['errorCode' => 'Console.NoPermission', 'errorMessage' => 'You are not authorized to this operation.', 'description' => ''], ], 409 => [ - [ - 'errorCode' => 'Console.InstanceStatusError', - 'errorMessage' => 'Current Instance status not supported this opreate.', - ], - [ - 'errorCode' => 'Console.OrderStatusError', - 'errorMessage' => 'Current Order status not supported this opreate.', - ], - [ - 'errorCode' => 'Console.IncrementStatusError', - 'errorMessage' => 'Current Increment status not supported this opreate.', - ], + ['errorCode' => 'Console.InstanceStatusError', 'errorMessage' => 'Current Instance status not supported this opreate.', 'description' => ''], + ['errorCode' => 'Console.OrderStatusError', 'errorMessage' => 'Current Order status not supported this opreate.', 'description' => '用户订单错误，请确认订单处于有效状态'], + ['errorCode' => 'Console.IncrementStatusError', 'errorMessage' => 'Current Increment status not supported this opreate.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'Console.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - [ - 'errorCode' => 'Console.CallServiceError', - 'errorMessage' => 'Fail to call service.', - ], + ['errorCode' => 'Console.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => '服务器内部错误，请登录阿里云控制台提交工单。'], + ['errorCode' => 'Console.CallServiceError', 'errorMessage' => 'Fail to call service.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1\\",\\n \\"Success\\": true,\\n \\"Instance\\": {\\n \\"Capacity\\": 10,\\n \\"UtcExpireTime\\": \\"1623081600000\\",\\n \\"UtcCreate\\": \\"1620382716000\\",\\n \\"ServiceType\\": 0,\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"Name\\": \\"imagesearchName\\",\\n \\"TotalCount\\": 10063,\\n \\"Qps\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<DetailResponse>\\n <RequestId>36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1</RequestId>\\n <Success>true</Success>\\n <Instance>\\n <Name>imagesearchName</Name>\\n <UtcExpireTime>1623081600000</UtcExpireTime>\\n <TotalCount>10063</TotalCount>\\n <UtcCreate>1620382716000</UtcCreate>\\n <Capacity>10</Capacity>\\n <Qps>1</Qps>\\n <ServiceType>0</ServiceType>\\n <Region>cn-shanghai</Region>\\n </Instance>\\n</DetailResponse>","errorExample":""}]', 'title' => '查询实例状态', 'description' => '## 使用说明'."\n" .'本接口用于向图像搜索实例中查询实例信息。'."\n" @@ -2711,17 +909,28 @@ .'查询操作默认的并发量为1，也就是每秒钟最多处理1个请求。', 'extraInfo' => '## 错误码'."\n" .'请参见[错误码](~~66619~~)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'imagesearch:Detail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1\\",\\n \\"Success\\": true,\\n \\"Instance\\": {\\n \\"Capacity\\": 10,\\n \\"UtcExpireTime\\": \\"1623081600000\\",\\n \\"UtcCreate\\": \\"1620382716000\\",\\n \\"ServiceType\\": 0,\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"Name\\": \\"imagesearchName\\",\\n \\"TotalCount\\": 10063,\\n \\"Qps\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<DetailResponse>\\n <RequestId>36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1</RequestId>\\n <Success>true</Success>\\n <Instance>\\n <Name>imagesearchName</Name>\\n <UtcExpireTime>1623081600000</UtcExpireTime>\\n <TotalCount>10063</TotalCount>\\n <UtcCreate>1620382716000</UtcCreate>\\n <Capacity>10</Capacity>\\n <Qps>1</Qps>\\n <ServiceType>0</ServiceType>\\n <Region>cn-shanghai</Region>\\n </Instance>\\n</DetailResponse>","errorExample":""}]', ], 'DumpMeta' => [ - 'summary' => '本文为您介绍DumpMeta接口的语法及示例，用于根据名称新建图像搜索元数据导出任务。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2734,17 +943,10 @@ [ 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '图搜实例名称。最多支持20个字符。'."\n" - .'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n" - .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" - .'>这里的实例名称并非实例ID，使用时请区分。', - 'type' => 'string', - 'required' => true, - 'maximum' => '10000000', - 'minimum' => '1', - 'example' => 'imagesearchName', - ], + 'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n" + .'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n" + .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" + .'>这里的实例名称并非实例ID，使用时请区分。', 'type' => 'string', 'required' => true, 'maximum' => '10000000', 'minimum' => '1', 'example' => 'imagesearchName'], ], ], 'responses' => [ @@ -2753,33 +955,17 @@ 'description' => '返回信息。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1', - ], - 'Success' => [ - 'description' => '请求是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1'], + 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '任务执行返回。', 'type' => 'object', 'properties' => [ - 'DumpMetaStatus' => [ - 'description' => '元数据导出任务状态。'."\n" - .'- PROCESSING：任务处理中。'."\n" - .'- FAIL：任务执行失败。'."\n" - .'- SUCCESS：任务已完成。', - 'type' => 'string', - 'example' => 'PROCESSING', - ], - 'Id' => [ - 'description' => '任务ID。', - 'type' => 'string', - 'example' => '500', - ], + 'DumpMetaStatus' => ['description' => '元数据导出任务状态。'."\n" + .'- PROCESSING：任务处理中。'."\n" + .'- FAIL：任务执行失败。'."\n" + .'- SUCCESS：任务已完成。', 'type' => 'string', 'example' => 'PROCESSING'], + 'Id' => ['description' => '任务ID。', 'type' => 'string', 'example' => '500'], ], ], ], @@ -2788,62 +974,29 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'Console.BadRequest', - 'errorMessage' => 'The request has invalid parameters.', - ], - [ - 'errorCode' => 'Console.InstanceNotFound', - 'errorMessage' => 'The specified ImageSearch instance is not found.', - ], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'], + ['errorCode' => 'Console.BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => '非法请求，请检查请求参数。'], + ['errorCode' => 'Console.InstanceNotFound', 'errorMessage' => 'The specified ImageSearch instance is not found.', 'description' => '查找不到实例，检查购买的实例ID是否正确。'], ], [ - [ - 'errorCode' => 'Console.LoginError', - 'errorMessage' => 'Check login failed.', - ], + ['errorCode' => 'Console.LoginError', 'errorMessage' => 'Check login failed.', 'description' => '登录失败，请检查用户名、密码、邮箱是否输入有误。'], ], 403 => [ - [ - 'errorCode' => 'Console.NoPermission', - 'errorMessage' => 'You are not authorized to this operation.', - ], + ['errorCode' => 'Console.NoPermission', 'errorMessage' => 'You are not authorized to this operation.', 'description' => ''], ], 409 => [ - [ - 'errorCode' => 'Console.InstanceStatusError', - 'errorMessage' => 'Current Instance status not supported this opreate.', - ], - [ - 'errorCode' => 'Console.OrderStatusError', - 'errorMessage' => 'Current Order status not supported this opreate.', - ], - [ - 'errorCode' => 'Console.IncrementStatusError', - 'errorMessage' => 'Current Increment status not supported this opreate.', - ], - [ - 'errorCode' => 'Console.TaskAlreadyExist', - 'errorMessage' => 'A task that is in progress already exists.', - ], + ['errorCode' => 'Console.InstanceStatusError', 'errorMessage' => 'Current Instance status not supported this opreate.', 'description' => ''], + ['errorCode' => 'Console.OrderStatusError', 'errorMessage' => 'Current Order status not supported this opreate.', 'description' => '用户订单错误，请确认订单处于有效状态'], + ['errorCode' => 'Console.IncrementStatusError', 'errorMessage' => 'Current Increment status not supported this opreate.', 'description' => ''], + ['errorCode' => 'Console.TaskAlreadyExist', 'errorMessage' => 'A task that is in progress already exists.', 'description' => '已经存在正在运行的任务。'], ], 500 => [ - [ - 'errorCode' => 'Console.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - [ - 'errorCode' => 'Console.CallServiceError', - 'errorMessage' => 'An internal service error occurred.', - ], + ['errorCode' => 'Console.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => '服务器内部错误，请登录阿里云控制台提交工单。'], + ['errorCode' => 'Console.CallServiceError', 'errorMessage' => 'An internal service error occurred.', 'description' => '访问内部服务错误'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DumpMetaStatus\\": \\"PROCESSING\\",\\n \\"Id\\": \\"500\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '元数据导出', + 'summary' => '本文为您介绍DumpMeta接口的语法及示例，用于根据名称新建图像搜索元数据导出任务。', 'description' => '## 使用说明'."\n" .'本接口用于向图像搜索实例中提交元信息导出任务。'."\n" .'> 如需了解更多产品详情和获取技术支持，请单击[在线咨询](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2)或通过钉钉群（35035130）联系我们。'."\n" @@ -2853,17 +1006,28 @@ .'> 当上一个元信息导出任务没有完成时，无法提交新的元信息导出任务。', 'extraInfo' => '## 错误码'."\n" .'请参见[错误码](~~66619~~)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'imagesearch:DumpMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DumpMetaStatus\\": \\"PROCESSING\\",\\n \\"Id\\": \\"500\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', ], 'DumpMetaList' => [ - 'summary' => '本文为您介绍DumpMetaList接口的语法及示例，用于向图像搜索实例中查看元信息导出任务列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2876,56 +1040,26 @@ [ 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '图搜实例名称。最多支持20个字符。'."\n" - .'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n" - .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" - .'>这里的实例名称并非实例ID，且实例名称同区域内唯一不可重复，使用时请区分。', - 'type' => 'string', - 'required' => true, - 'maximum' => '10000000', - 'minimum' => '1', - 'example' => 'demoinstance1', - ], + 'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n" + .'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n" + .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" + .'>这里的实例名称并非实例ID，且实例名称同区域内唯一不可重复，使用时请区分。', 'type' => 'string', 'required' => true, 'maximum' => '10000000', 'minimum' => '1', 'example' => 'demoinstance1'], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '元信息导出任务ID。'."\n" - .'>导出任务ID，需要先执行[元数据导出](~~377466~~)从返回值得到。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '500', - ], + 'schema' => ['description' => '元信息导出任务ID。'."\n" + .'>导出任务ID，需要先执行[元数据导出](~~377466~~)从返回值得到。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '500'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '返回结果的数目。默认值为10，最大值30。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '500', - 'exclusiveMaximum' => true, - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => '返回结果的数目。默认值为10，最大值30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'exclusiveMaximum' => true, 'minimum' => '1', 'example' => '10'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '返回结果的起始位置。默认值为1，最大值30。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '500', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => '返回结果的起始位置。默认值为1，最大值30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '1', 'example' => '1'], ], ], 'responses' => [ @@ -2934,11 +1068,7 @@ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879'], 'Data' => [ 'description' => '元数据导出信息返回。', 'type' => 'object', @@ -2950,70 +1080,25 @@ 'description' => '元信息导出任务详情。', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '任务状态。'."\n" - .'- PROCESSING：任务处理中。'."\n" - .'- FAIL：任务执行失败。'."\n" - .'- SUCCESS：任务已完成。', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'Msg' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'UtcModified' => [ - 'description' => '任务更新时间。单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1629095760000', - ], - 'MetaUrl' => [ - 'description' => '结果下载地址。有效期两个小时。', - 'type' => 'string', - 'example' => 'https://imagesearchname.oss-cn-shanghai.aliyuncs.com/xxx', - ], - 'UtcCreate' => [ - 'description' => '任务创建时间。单位毫秒。', - 'type' => 'string', - 'example' => '1629095713000', - ], - 'Code' => [ - 'description' => '错误码。'."\n" - ."\n" - .'- 0：成功。'."\n" - .'- 非0：失败。', - 'type' => 'string', - 'example' => '0', - ], - 'Id' => [ - 'description' => '任务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '500', - ], + 'Status' => ['description' => '任务状态。'."\n" + .'- PROCESSING：任务处理中。'."\n" + .'- FAIL：任务执行失败。'."\n" + .'- SUCCESS：任务已完成。', 'type' => 'string', 'example' => 'SUCCESS'], + 'Msg' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success'], + 'UtcModified' => ['description' => '任务更新时间。单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1629095760000'], + 'MetaUrl' => ['description' => '结果下载地址。有效期两个小时。', 'type' => 'string', 'example' => 'https://imagesearchname.oss-cn-shanghai.aliyuncs.com/xxx'], + 'UtcCreate' => ['description' => '任务创建时间。单位毫秒。', 'type' => 'string', 'example' => '1629095713000'], + 'Code' => ['description' => '错误码。'."\n" + ."\n" + .'- 0：成功。'."\n" + .'- 非0：失败。', 'type' => 'string', 'example' => '0'], + 'Id' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '500'], ], ], ], - 'PageSize' => [ - 'description' => '查询结果数目。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '结果当前页数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => '任务总数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], + 'PageSize' => ['description' => '查询结果数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'PageNumber' => ['description' => '结果当前页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'TotalCount' => ['description' => '任务总数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '15'], ], ], ], @@ -3022,58 +1107,28 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'Console.BadRequest', - 'errorMessage' => 'The request has invalid parameters.', - ], - [ - 'errorCode' => 'Console.InstanceNotFound', - 'errorMessage' => 'The specified ImageSearch instance is not found.', - ], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'], + ['errorCode' => 'Console.BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => '非法请求，请检查请求参数。'], + ['errorCode' => 'Console.InstanceNotFound', 'errorMessage' => 'The specified ImageSearch instance is not found.', 'description' => '查找不到实例，检查购买的实例ID是否正确。'], ], [ - [ - 'errorCode' => 'Console.LoginError', - 'errorMessage' => 'Check login failed.', - ], + ['errorCode' => 'Console.LoginError', 'errorMessage' => 'Check login failed.', 'description' => '登录失败，请检查用户名、密码、邮箱是否输入有误。'], ], 403 => [ - [ - 'errorCode' => 'Console.NoPermission', - 'errorMessage' => 'You are not authorized to this operation.', - ], + ['errorCode' => 'Console.NoPermission', 'errorMessage' => 'You are not authorized to this operation.', 'description' => ''], ], 409 => [ - [ - 'errorCode' => 'Console.InstanceStatusError', - 'errorMessage' => 'Current Instance status not supported this opreate.', - ], - [ - 'errorCode' => 'Console.OrderStatusError', - 'errorMessage' => 'Current Order status not supported this opreate.', - ], - [ - 'errorCode' => 'Console.IncrementStatusError', - 'errorMessage' => 'Current Increment status not supported this opreate.', - ], + ['errorCode' => 'Console.InstanceStatusError', 'errorMessage' => 'Current Instance status not supported this opreate.', 'description' => ''], + ['errorCode' => 'Console.OrderStatusError', 'errorMessage' => 'Current Order status not supported this opreate.', 'description' => '用户订单错误，请确认订单处于有效状态'], + ['errorCode' => 'Console.IncrementStatusError', 'errorMessage' => 'Current Increment status not supported this opreate.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'Console.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - [ - 'errorCode' => 'Console.CallServiceError', - 'errorMessage' => 'An internal service error occurred.', - ], + ['errorCode' => 'Console.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => '服务器内部错误，请登录阿里云控制台提交工单。'], + ['errorCode' => 'Console.CallServiceError', 'errorMessage' => 'An internal service error occurred.', 'description' => '访问内部服务错误'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Data\\": {\\n \\"DumpMetaList\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Msg\\": \\"success\\",\\n \\"UtcModified\\": 1629095760000,\\n \\"MetaUrl\\": \\"https://imagesearchname.oss-cn-shanghai.aliyuncs.com/xxx\\",\\n \\"UtcCreate\\": \\"1629095713000\\",\\n \\"Code\\": \\"0\\",\\n \\"Id\\": 500\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 15\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '查询元信息导出任务', + 'summary' => '本文为您介绍DumpMetaList接口的语法及示例，用于向图像搜索实例中查看元信息导出任务列表。', 'description' => '## 使用说明'."\n" .'本接口用于向图像搜索实例中查询元信息导出任务。'."\n" .'> 如需了解更多产品详情和获取技术支持，请单击[在线咨询](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2)或通过钉钉群（35035130）联系我们。'."\n" @@ -3082,17 +1137,29 @@ .'查询操作默认的并发量为1，也就是每秒钟最多处理1个请求。', 'extraInfo' => '## 错误码'."\n" .'请参见[错误码](~~66619~~)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'imagesearch:DumpMetaList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Data\\": {\\n \\"DumpMetaList\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Msg\\": \\"success\\",\\n \\"UtcModified\\": 1629095760000,\\n \\"MetaUrl\\": \\"https://imagesearchname.oss-cn-shanghai.aliyuncs.com/xxx\\",\\n \\"UtcCreate\\": \\"1629095713000\\",\\n \\"Code\\": \\"0\\",\\n \\"Id\\": 500\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 15\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', ], 'IncreaseInstance' => [ 'summary' => '本文为您介绍IncreaseInstance接口的语法及示例，用于根据名称新建图像搜索实例批量任务。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3104,47 +1171,27 @@ [ 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '图搜实例名称。最多支持20个字符。'."\n" - .'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n" - .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" - .'>这里的实例名称并非实例ID，使用时请区分。', - 'type' => 'string', - 'required' => true, - 'example' => 'imagesearchName', - ], + 'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n" + .'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n" + .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" + .'>这里的实例名称并非实例ID，使用时请区分。', 'type' => 'string', 'required' => true, 'example' => 'imagesearchName'], ], [ 'name' => 'BucketName', 'in' => 'query', - 'schema' => [ - 'description' => 'Bucket名称。'."\n" - .'> 仅支持实例同区域的BucketName。', - 'type' => 'string', - 'required' => true, - 'example' => 'bucketName', - ], + 'schema' => ['description' => 'Bucket名称。'."\n" + .'> 仅支持实例同区域的BucketName。', 'type' => 'string', 'required' => true, 'example' => 'bucketName'], ], [ 'name' => 'Path', 'in' => 'query', - 'schema' => [ - 'description' => 'OSS中increment.meta文件的绝对路径。必须"/"开头，非"/"结尾。'."\n" - .'> 需要您提前准备increment.meta文件。具体请参见[批量操作](~~66580~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '/xxx/xxx', - ], + 'schema' => ['description' => 'OSS中increment.meta文件的绝对路径。必须"/"开头，非"/"结尾。'."\n" + .'> 需要您提前准备increment.meta文件。具体请参见[批量操作](~~66580~~)。', 'type' => 'string', 'required' => true, 'example' => '/xxx/xxx'], ], [ 'name' => 'CallbackAddress', 'in' => 'query', - 'schema' => [ - 'description' => '任务回调地址。', - 'type' => 'string', - 'required' => false, - 'example' => 'http://xxxxx', - ], + 'schema' => ['description' => '任务回调地址。', 'type' => 'string', 'required' => false, 'example' => 'http://xxxxx'], ], ], 'responses' => [ @@ -3153,33 +1200,17 @@ 'description' => '返回信息。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1', - ], - 'Success' => [ - 'description' => '请求是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1'], + 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '任务执行返回。', 'type' => 'object', 'properties' => [ - 'IncrementStatus' => [ - 'description' => '批量任务状态。'."\n" - .'- PROCESSING：任务处理中。'."\n" - .'- FAIL：任务执行失败。'."\n" - .'- SUCCESS：任务已完成。', - 'type' => 'string', - 'example' => 'PROCESSING', - ], - 'Id' => [ - 'description' => '任务ID。', - 'type' => 'string', - 'example' => '500', - ], + 'IncrementStatus' => ['description' => '批量任务状态。'."\n" + .'- PROCESSING：任务处理中。'."\n" + .'- FAIL：任务执行失败。'."\n" + .'- SUCCESS：任务已完成。', 'type' => 'string', 'example' => 'PROCESSING'], + 'Id' => ['description' => '任务ID。', 'type' => 'string', 'example' => '500'], ], ], ], @@ -3188,57 +1219,26 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'Console.BadRequest', - 'errorMessage' => 'The request has invalid parameters.', - ], - [ - 'errorCode' => 'Console.InstanceNotFound', - 'errorMessage' => 'The specified ImageSearch instance is not found.', - ], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'], + ['errorCode' => 'Console.BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => '非法请求，请检查请求参数。'], + ['errorCode' => 'Console.InstanceNotFound', 'errorMessage' => 'The specified ImageSearch instance is not found.', 'description' => '查找不到实例，检查购买的实例ID是否正确。'], ], [ - [ - 'errorCode' => 'Console.LoginError', - 'errorMessage' => 'Check login failed.', - ], + ['errorCode' => 'Console.LoginError', 'errorMessage' => 'Check login failed.', 'description' => '登录失败，请检查用户名、密码、邮箱是否输入有误。'], ], 403 => [ - [ - 'errorCode' => 'Console.NoPermission', - 'errorMessage' => 'You are not authorized to this operation.', - ], + ['errorCode' => 'Console.NoPermission', 'errorMessage' => 'You are not authorized to this operation.', 'description' => ''], ], 409 => [ - [ - 'errorCode' => 'Console.InstanceStatusError', - 'errorMessage' => 'Current Instance status not supported this opreate.', - ], - [ - 'errorCode' => 'Console.OrderStatusError', - 'errorMessage' => 'Current Order status not supported this opreate.', - ], - [ - 'errorCode' => 'Console.IncrementStatusError', - 'errorMessage' => 'Current Increment status not supported this opreate.', - ], + ['errorCode' => 'Console.InstanceStatusError', 'errorMessage' => 'Current Instance status not supported this opreate.', 'description' => ''], + ['errorCode' => 'Console.OrderStatusError', 'errorMessage' => 'Current Order status not supported this opreate.', 'description' => '用户订单错误，请确认订单处于有效状态'], + ['errorCode' => 'Console.IncrementStatusError', 'errorMessage' => 'Current Increment status not supported this opreate.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'Console.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - [ - 'errorCode' => 'Console.CallServiceError', - 'errorMessage' => 'Fail to call service.', - ], + ['errorCode' => 'Console.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => '服务器内部错误，请登录阿里云控制台提交工单。'], + ['errorCode' => 'Console.CallServiceError', 'errorMessage' => 'Fail to call service.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"IncrementStatus\\": \\"PROCESSING\\",\\n \\"Id\\": \\"500\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '批量操作', 'description' => '## 使用说明'."\n" .'本接口用于向图像搜索实例中提交批量任务。'."\n" @@ -3249,17 +1249,28 @@ .'> 当上一个批量任务没有完成时，无法提交新的批量任务。'."\n", 'extraInfo' => '## 错误码'."\n" .'请参见[错误码](~~66619~~)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'imagesearch:IncreaseInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"IncrementStatus\\": \\"PROCESSING\\",\\n \\"Id\\": \\"500\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', ], 'IncreaseList' => [ - 'summary' => '本文为您介绍IncreaseList接口的语法及示例，用于向图像搜索实例中查看批量任务列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3271,74 +1282,36 @@ [ 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '图搜实例名称。最多支持20个字符。'."\n" - .'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n" - .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" - .'>这里的实例名称并非实例ID，且实例名称同区域内唯一不可重复，使用时请区分。', - 'type' => 'string', - 'required' => true, - 'example' => 'demoinstance1', - ], + 'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n" + .'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n" + .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" + .'>这里的实例名称并非实例ID，且实例名称同区域内唯一不可重复，使用时请区分。', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1'], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '批量任务ID。'."\n" - .'>批量任务ID，需要先执行[批量操作](~~377468~~)从返回值得到。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '500', - ], + 'schema' => ['description' => '批量任务ID。'."\n" + .'>批量任务ID，需要先执行[批量操作](~~377468~~)从返回值得到。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '500'], ], [ 'name' => 'BucketName', 'in' => 'query', - 'schema' => [ - 'description' => 'Bucket名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'bucketName', - ], + 'schema' => ['description' => 'Bucket名称。', 'type' => 'string', 'required' => false, 'example' => 'bucketName'], ], [ 'name' => 'Path', 'in' => 'query', - 'schema' => [ - 'description' => 'OSS中increment.meta文件的绝对路径。必须"/"开头，非"/"结尾。', - 'type' => 'string', - 'required' => false, - 'example' => '/xxx/xxx', - ], + 'schema' => ['description' => 'OSS中increment.meta文件的绝对路径。必须"/"开头，非"/"结尾。', 'type' => 'string', 'required' => false, 'example' => '/xxx/xxx'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '返回结果的数目。默认值为10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '500', - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => '返回结果的数目。默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '1', 'example' => '10'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '返回结果的起始位置。默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '500', - 'exclusiveMaximum' => true, - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => '返回结果的起始位置。默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'exclusiveMaximum' => true, 'minimum' => '1', 'example' => '1'], ], ], 'responses' => [ @@ -3347,11 +1320,7 @@ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879'], 'Data' => [ 'description' => '批量任务信息返回。', 'type' => 'object', @@ -3367,87 +1336,31 @@ 'description' => '批量任务详情。', 'type' => 'object', 'properties' => [ - 'Msg' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'sucess', - ], - 'Status' => [ - 'description' => '任务状态。'."\n" - .'- PROCESSING：任务处理中。'."\n" - .'- FAIL：任务执行失败。'."\n" - .'- SUCCESS：任务已完成。', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'UtcModified' => [ - 'description' => '任务更新时间。单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1629095760000', - ], - 'BucketName' => [ - 'description' => 'Bucket名称。', - 'type' => 'string', - 'example' => 'bucketName', - ], - 'UtcCreate' => [ - 'description' => '任务创建时间。单位毫秒。', - 'type' => 'string', - 'example' => '1629095713000', - ], - 'Code' => [ - 'description' => '错误码。'."\n" - ."\n" - .'- 0：成功。'."\n" - .'- 非0：失败。', - 'type' => 'string', - 'example' => '0', - ], - 'Path' => [ - 'description' => 'OSS中increment.meta文件的绝对路径。必须"/"开头，非"/"结尾。', - 'type' => 'string', - 'example' => '/xx/xx', - ], - 'ErrorUrl' => [ - 'description' => '结果下载地址。有效期两个小时。', - 'type' => 'string', - 'example' => 'https://imagesearchname.oss-cn-shanghai.aliyuncs.com/xxx', - ], - 'Id' => [ - 'description' => '任务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '500', - ], - 'CallbackAddress' => [ - 'description' => '任务回调地址。', - 'type' => 'string', - 'example' => 'http://xxxxx', - ], + 'Msg' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'sucess'], + 'Status' => ['description' => '任务状态。'."\n" + .'- PROCESSING：任务处理中。'."\n" + .'- FAIL：任务执行失败。'."\n" + .'- SUCCESS：任务已完成。', 'type' => 'string', 'example' => 'SUCCESS'], + 'UtcModified' => ['description' => '任务更新时间。单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1629095760000'], + 'BucketName' => ['description' => 'Bucket名称。', 'type' => 'string', 'example' => 'bucketName'], + 'UtcCreate' => ['description' => '任务创建时间。单位毫秒。', 'type' => 'string', 'example' => '1629095713000'], + 'Code' => ['description' => '错误码。'."\n" + ."\n" + .'- 0：成功。'."\n" + .'- 非0：失败。', 'type' => 'string', 'example' => '0'], + 'Path' => ['description' => 'OSS中increment.meta文件的绝对路径。必须"/"开头，非"/"结尾。', 'type' => 'string', 'example' => '/xx/xx'], + 'ErrorUrl' => ['description' => '结果下载地址。有效期两个小时。', 'type' => 'string', 'example' => 'https://imagesearchname.oss-cn-shanghai.aliyuncs.com/xxx'], + 'Id' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '500'], + 'CallbackAddress' => ['description' => '任务回调地址。', 'type' => 'string', 'example' => 'http://xxxxx'], ], ], ], ], + 'description' => '', ], - 'PageSize' => [ - 'description' => '查询结果数目。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '结果当前页数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => '任务总数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], + 'PageSize' => ['description' => '查询结果数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'PageNumber' => ['description' => '结果当前页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'TotalCount' => ['description' => '任务总数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '15'], ], ], ], @@ -3456,58 +1369,28 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'Console.BadRequest', - 'errorMessage' => 'The request has invalid parameters.', - ], - [ - 'errorCode' => 'Console.InstanceNotFound', - 'errorMessage' => 'The specified ImageSearch instance is not found.', - ], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'], + ['errorCode' => 'Console.BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => '非法请求，请检查请求参数。'], + ['errorCode' => 'Console.InstanceNotFound', 'errorMessage' => 'The specified ImageSearch instance is not found.', 'description' => '查找不到实例，检查购买的实例ID是否正确。'], ], [ - [ - 'errorCode' => 'Console.LoginError', - 'errorMessage' => 'Check login failed.', - ], + ['errorCode' => 'Console.LoginError', 'errorMessage' => 'Check login failed.', 'description' => '登录失败，请检查用户名、密码、邮箱是否输入有误。'], ], 403 => [ - [ - 'errorCode' => 'Console.NoPermission', - 'errorMessage' => 'You are not authorized to this operation.', - ], + ['errorCode' => 'Console.NoPermission', 'errorMessage' => 'You are not authorized to this operation.', 'description' => ''], ], 409 => [ - [ - 'errorCode' => 'Console.InstanceStatusError', - 'errorMessage' => 'Current Instance status not supported this opreate.', - ], - [ - 'errorCode' => 'Console.OrderStatusError', - 'errorMessage' => 'Current Order status not supported this opreate.', - ], - [ - 'errorCode' => 'Console.IncrementStatusError', - 'errorMessage' => 'Current Increment status not supported this opreate.', - ], + ['errorCode' => 'Console.InstanceStatusError', 'errorMessage' => 'Current Instance status not supported this opreate.', 'description' => ''], + ['errorCode' => 'Console.OrderStatusError', 'errorMessage' => 'Current Order status not supported this opreate.', 'description' => '用户订单错误，请确认订单处于有效状态'], + ['errorCode' => 'Console.IncrementStatusError', 'errorMessage' => 'Current Increment status not supported this opreate.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'Console.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - [ - 'errorCode' => 'Console.CallServiceError', - 'errorMessage' => 'Fail to call service.', - ], + ['errorCode' => 'Console.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => '服务器内部错误，请登录阿里云控制台提交工单。'], + ['errorCode' => 'Console.CallServiceError', 'errorMessage' => 'Fail to call service.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Data\\": {\\n \\"Increments\\": {\\n \\"Instance\\": [\\n {\\n \\"Msg\\": \\"sucess\\",\\n \\"Status\\": \\"SUCCESS\\",\\n \\"UtcModified\\": 1629095760000,\\n \\"BucketName\\": \\"bucketName\\",\\n \\"UtcCreate\\": \\"1629095713000\\",\\n \\"Code\\": \\"0\\",\\n \\"Path\\": \\"/xx/xx\\",\\n \\"ErrorUrl\\": \\"https://imagesearchname.oss-cn-shanghai.aliyuncs.com/xxx\\",\\n \\"Id\\": 500,\\n \\"CallbackAddress\\": \\"http://xxxxx\\"\\n }\\n ]\\n },\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 15\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '查询批量任务', + 'summary' => '本文为您介绍IncreaseList接口的语法及示例，用于向图像搜索实例中查看批量任务列表。', 'description' => '## 使用说明'."\n" .'本接口用于向图像搜索实例中查询批量任务。'."\n" .'> 如需了解更多产品详情和获取技术支持，请单击[在线咨询](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2)或通过钉钉群（35035130）联系我们。'."\n" @@ -3516,15 +1399,29 @@ .'查询操作默认的并发量为1，也就是每秒钟最多处理1个请求。', 'extraInfo' => '## 错误码'."\n" .'请参见[错误码](~~66619~~)。', - ], - 'SearchImageByText' => [ - 'summary' => '本文为您介绍SearchImageByText的语法及示例，用于根据文字查询图像搜索实例中的图片信息。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'imagesearch:IncreaseList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Data\\": {\\n \\"Increments\\": {\\n \\"Instance\\": [\\n {\\n \\"Msg\\": \\"sucess\\",\\n \\"Status\\": \\"SUCCESS\\",\\n \\"UtcModified\\": 1629095760000,\\n \\"BucketName\\": \\"bucketName\\",\\n \\"UtcCreate\\": \\"1629095713000\\",\\n \\"Code\\": \\"0\\",\\n \\"Path\\": \\"/xx/xx\\",\\n \\"ErrorUrl\\": \\"https://imagesearchname.oss-cn-shanghai.aliyuncs.com/xxx\\",\\n \\"Id\\": 500,\\n \\"CallbackAddress\\": \\"http://xxxxx\\"\\n }\\n ]\\n },\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 15\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'SearchImageByFilter' => [ + 'summary' => '本文为您介绍SearchImageByFilter的语法及示例，用于根据过滤条件查询图像搜索实例中的图片信息。', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3536,99 +1433,545 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREimagesearchF4L5JA', - ], + 'abilityTreeNodes' => ['FEATUREimagesearchF4L5JA'], ], 'parameters' => [ [ 'name' => 'InstanceName', 'in' => 'formData', - 'schema' => [ - 'description' => '图搜实例名称。最多支持20个字符。'."\n" - .'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n" - .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" - .'>这里的实例名称并非实例ID，使用时请区分。', - 'type' => 'string', - 'required' => true, - 'example' => 'demoinstance1', - ], + 'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n" + .'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n" + .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" + .'>这里的实例名称并非实例ID，使用时请区分。', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1'], ], [ 'name' => 'Num', 'in' => 'formData', + 'schema' => ['description' => '返回结果的数目。取值范围：1~100。默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'], + ], + [ + 'name' => 'Start', + 'in' => 'formData', + 'schema' => ['description' => '返回结果的起始位置。取值范围：0~499。默认值为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '499', 'minimum' => '0', 'example' => '0', 'default' => '0'], + ], + [ + 'name' => 'Filter', + 'in' => 'formData', + 'schema' => ['description' => '过滤条件。int_attr支持的操作符有in、not in、大于号(>)、大于等于号(>=)、小于号(<)、小于等于号(<=)、等于号(=)。str_attr支持的操作符有in、not in、等于号(=)和不等号(!=)，多个条件之间支持AND和OR进行连接。'."\n" + .'例如：'."\n" + .'- int_attr >= 100。'."\n" + .'- str_attr != "value1"。'."\n" + .'- int_attr = 1000 AND str_attr = "value1"。'."\n" + ."\n" + .'>最多支持4096个字符。', 'type' => 'string', 'required' => true, 'example' => 'int_attr=1000 AND str_attr="value1"'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '返回结果的数目。取值范围：1~100。默认值为10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', + 'description' => '结果返回。', + 'type' => 'object', + 'properties' => [ + 'Msg' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879'], + 'Auctions' => [ + 'description' => '所有返回的商品描述信息。', + 'type' => 'array', + 'items' => [ + 'description' => '图片参数。', + 'type' => 'object', + 'properties' => [ + 'ProductId' => ['description' => '商品ID。', 'type' => 'string', 'example' => '2092061_1'], + 'PicName' => ['description' => '图片名称。', 'type' => 'string', 'example' => '2092061_1.jpg'], + 'CategoryId' => ['description' => '图片类目。', 'type' => 'integer', 'format' => 'int32', 'example' => '8888888'], + 'CustomContent' => ['description' => '用户自定义的内容。', 'type' => 'string', 'example' => 'zidingyi'], + 'IntAttr' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'IntAttr2' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'StrAttr2' => ['description' => '字符串类型属性。', 'type' => 'string', 'example' => 'test'], + 'StrAttr' => ['description' => '字符串类型属性。', 'type' => 'string', 'example' => 'test'], + 'StrAttr3' => ['description' => '字符串类型属性。', 'type' => 'string', 'example' => 'test'], + 'StrAttr4' => ['description' => '字符串类型属性。', 'type' => 'string', 'example' => 'test'], + 'IntAttr3' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'IntAttr4' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + ], + ], + ], + 'Code' => ['description' => '错误码。'."\n" + .'- 0：成功。'."\n" + .'- 非0：失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''], + ['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''], + ['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'], + ['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => '请求body缺少特定符号'], + ['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => '请求body含有空的字段'], + ['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => '无效的元信息字段'], + ['errorCode' => 'NoPicList', 'errorMessage' => 'The body content is missing the pic_list parameter.', 'description' => '未指定pic_list字段'], + ['errorCode' => 'InvalidPicList', 'errorMessage' => 'The specified pic_list parameter is invalid.', 'description' => '无效的pic_list字段'], + ['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'he content of an image is not specified in the HTTP POST body.', 'description' => ''], + ['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''], + ['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => '无效的类目id'], + ['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => '超过了最大的返回结果限制数500'], + ['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => '单次返回数超过限制值100'], + ['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter start is inavlid.', 'description' => ''], + ['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter num is invalid.', 'description' => '无效的字段num'], + ['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''], + ['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => '无效的int过滤字段'], + ['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => '无效的图片格式'], + ['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => '无效的过滤条件'], + ['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => '实例的图片数量超过限制值'], + ['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => '图片包含不支持的旋转参数'], + ['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => '图片像素值不支持'], + ['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''], + ['errorCode' => 'PicNotExist', 'errorMessage' => 'The search picture does not exist.', 'description' => ''], + ['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'The parameter ProductId no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicName', 'errorMessage' => 'The parameter PicName no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''], + ['errorCode' => 'InvalidType', 'errorMessage' => 'The specified parameter Type is not valid.', 'description' => ''], + ['errorCode' => 'InvalidProductId', 'errorMessage' => 'The specified parameter ProductId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicName', 'errorMessage' => 'The specified parameter PicName is not valid.', 'description' => ''], + ['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => '无效StrAttr'], + ['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', 'description' => ''], + ['errorCode' => 'InvalidPicUrl', 'errorMessage' => 'The search picture does not exist at the specific url.', 'description' => ''], + ['errorCode' => 'InvalidInstanceName', 'errorMessage' => 'The parameter instanceName is not specified.', 'description' => ''], + ['errorCode' => 'InvalidRequestId', 'errorMessage' => 'The parameter requestId is not specified.', 'description' => ''], + ['errorCode' => 'InvalidRequestIdTooLarge', 'errorMessage' => 'The parameter requestId is too large.', 'description' => ''], + ['errorCode' => 'InvalidRegion', 'errorMessage' => 'The specific region is illegal', 'description' => ''], + ['errorCode' => 'InvalidIntAttr4', 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', 'description' => '无效IntAttr4'], + ['errorCode' => 'InvalidIntAttr3', 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', 'description' => '无效IntAttr3'], + ['errorCode' => 'InvalidIntAttr2', 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', 'description' => '无效IntAttr2'], + ['errorCode' => 'InvalidStrAttr4', 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', 'description' => '无效StrAttr4'], + ['errorCode' => 'InvalidStrAttr3', 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', 'description' => '无效StrAttr3'], + ['errorCode' => 'InvalidStrAttr2', 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', 'description' => '无效StrAttr2'], + ['errorCode' => 'PictureError', 'errorMessage' => '[download] Img Download Failed.', 'description' => '图片下载失败，请检查图片'], + ['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => '内部错误：不支持的action'], + ['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => '内部错误：不支持的实例类型'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => '未授权的行为'], + ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => '请求被限流'], + ], + 500 => [ + ['errorCode' => 'UnknownException', 'errorMessage' => 'An internal server error occurred.', 'description' => '未知异常'], + ['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => '内部错误：请求网络异常'], + ['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''], + ['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''], + ['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''], + ['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => '内部错误：请求内部算法错误'], + ['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => '内部错误：请求内部消息队列错误'], + ['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => '内部错误：请求特征存储错误'], + ['errorCode' => 'ConnectionDVException', 'errorMessage' => 'Failed to obtain collection.', 'description' => 'internalError'], + ], + ], + 'title' => '根据过滤条件查询图片', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Auctions\\": [\\n {\\n \\"ProductId\\": \\"2092061_1\\",\\n \\"PicName\\": \\"2092061_1.jpg\\",\\n \\"CategoryId\\": 8888888,\\n \\"CustomContent\\": \\"zidingyi\\",\\n \\"IntAttr\\": 2,\\n \\"IntAttr2\\": 2,\\n \\"StrAttr2\\": \\"test\\",\\n \\"StrAttr\\": \\"test\\",\\n \\"StrAttr3\\": \\"test\\",\\n \\"StrAttr4\\": \\"test\\",\\n \\"IntAttr3\\": 2,\\n \\"IntAttr4\\": 2\\n }\\n ],\\n \\"Code\\": 0,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SearchImageByFilterResponse>\\n <Msg>success</Msg>\\n <RequestId>B3137727-7D6E-488C-BA21-0E034C38A879</RequestId>\\n <Auctions>\\n <ProductId>2092061_1</ProductId>\\n <PicName>2092061_1.jpg</PicName>\\n <CategoryId>8888888</CategoryId>\\n <CustomContent>zidingyi</CustomContent>\\n <IntAttr>2</IntAttr>\\n <IntAttr2>2</IntAttr2>\\n <StrAttr2>test</StrAttr2>\\n <StrAttr>test</StrAttr>\\n <StrAttr3>test</StrAttr3>\\n <StrAttr4>test</StrAttr4>\\n <IntAttr3>2</IntAttr3>\\n <IntAttr4>2</IntAttr4>\\n </Auctions>\\n <Code>0</Code>\\n <Success>true</Success>\\n</SearchImageByFilterResponse>","errorExample":""}]', + ], + 'SearchImageByName' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Start', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREimagesearchF4L5JA'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'formData', + 'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n" + .'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n" + .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" + .'>这里的实例名称并非实例ID，使用时请区分。', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1'], + ], + [ + 'name' => 'ProductId', + 'in' => 'formData', + 'schema' => ['description' => '商品ID。'."\n", 'type' => 'string', 'required' => true, 'example' => '2092061_1', 'isFileTransferUrl' => false], + ], + [ + 'name' => 'PicName', + 'in' => 'formData', + 'schema' => ['description' => '图片名称。', 'type' => 'string', 'required' => true, 'example' => '2092061_1.jpg'], + ], + [ + 'name' => 'CategoryId', 'in' => 'formData', 'schema' => [ - 'description' => '返回结果的起始位置。取值范围：0~499。默认值为0。', + 'description' => '商品类目。具体请参见[类目参考](~~179184~~)。'."\n" + .' - 对于商品搜索，如果设置类目，则以设置的为准；如果不设置类目，则由系统进行类目预测，预测的类目结果可以在Response中获取 。'."\n" + .'<props="china">'."\n" + .' - 对于布料、商标、通用、家具家居和工业五金搜索，不论是否设置类目，系统会将类目设置为88888888。'."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + .'- 对于通用搜索，不论是否设置类目，系统会将类目设置为88888888。</props>'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, - 'maximum' => '499', + 'maximum' => '88888888', 'minimum' => '0', - 'example' => '0', - 'default' => '0', + 'example' => '88888888', + 'enum' => ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '20', '21', '22', '88888888'], ], ], [ + 'name' => 'Num', + 'in' => 'formData', + 'schema' => ['description' => '返回结果的数目。取值范围：1~100。默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'], + ], + [ + 'name' => 'Start', + 'in' => 'formData', + 'schema' => ['description' => '返回结果的起始位置。取值范围：0~499。默认值为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '499', 'exclusiveMaximum' => false, 'minimum' => '0', 'exclusiveMinimum' => false, 'example' => '0', 'default' => '0'], + ], + [ 'name' => 'Filter', 'in' => 'formData', - 'schema' => [ - 'description' => '过滤条件。int_attr支持的操作符有in、not in、大于号(>)、大于等于号(>=)、小于号(<)、小于等于号(<=)、等于号(=)。str_attr支持的操作符有in、not in、等于号(=)和不等号(!=)，多个条件之间支持AND和OR进行连接。'."\n" - .'例如：'."\n" - .'- int_attr >= 100。'."\n" - .'- str_attr != "value1"。'."\n" - .'- int_attr = 1000 AND str_attr = "value1"。'."\n" - ."\n" - .'>最多支持4096个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'int_attr=1000 AND str_attr="value1"', - ], + 'schema' => ['description' => '过滤条件。int_attr支持的操作符有in、not in、大于号(>)、大于等于号(>=)、小于号(<)、小于等于号(<=)、等于号(=)。str_attr支持的操作符有in、not in、等于号(=)和不等号(!=)，多个条件之支持AND和OR进行连接。'."\n" + .'例如：'."\n" + .'- int_attr>=100。'."\n" + .'- str_attr!="value1"。'."\n" + .'- int_attr=1000 AND str_attr="value1"。'."\n" + ."\n" + .'>最多支持4096个字符。', 'type' => 'string', 'required' => false, 'example' => 'int_attr>=100'], ], [ 'name' => 'DistinctProductId', 'in' => 'formData', + 'schema' => ['description' => '根据ProductId进行去重复数据。'."\n" + .'> 设置为true则有效。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'ScoreThreshold', + 'in' => 'query', + 'schema' => ['description' => '填写相似度分数阈值后，只返回图片相似度分数大于等于阈值的图片信息。阈值范围0.00-1.00，最大支持2位小数，默认为0.00 。', 'type' => 'string', 'required' => false, 'example' => '0.50'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '如果为true则检索时根据ProductId字段进行去重复数据。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'description' => '结果返回。', + 'type' => 'object', + 'properties' => [ + 'Msg' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success'], + 'Head' => [ + 'description' => '搜索结果概述信息。', + 'type' => 'object', + 'properties' => [ + 'DocsFound' => ['description' => '返回结果数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'DocsReturn' => ['description' => '实例中命中结果数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '10000'], + 'SearchTime' => ['description' => '搜索耗时，单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '95'], + ], + ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1'], + 'Auctions' => [ + 'description' => '所有返回的商品描述信息。', + 'type' => 'array', + 'items' => [ + 'description' => '图片参数。', + 'type' => 'object', + 'properties' => [ + 'ProductId' => ['description' => '商品ID。', 'type' => 'string', 'example' => '2092061_1'], + 'PicName' => ['description' => '图片名称。', 'type' => 'string', 'example' => '2092061_1.jpg'], + 'CategoryId' => ['description' => '图片类目。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'SortExprValues' => ['description' => '系统打分信息。'."\n" + .'> - 当前字段已弃用，建议使用Score。'."\n" + .'- SortExprValues是一个分号分隔的二元组，第一个值表示图片的相关性分数，值越大表示和查询的图片相关性越高。由于算法模型不同。'."\n" + .'- 当类目为0~2时，SortExprValues值域范围：0～7.33136443711219e+24。'."\n" + .'- 类目为其他值时，SortExprValues值域范围：0～5.37633353624177e+24。当两个图片完全一样时，这个分值最大。', 'type' => 'string', 'example' => '5.37633353624177e+24;0'], + 'CustomContent' => ['description' => '用户自定义的内容。', 'type' => 'string', 'example' => 'zidingyi'], + 'Score' => ['description' => '图片相似打分。取值范围：0~1。'."\n" + .'> 需要版本升级至V3.1.1方可使用。', 'type' => 'number', 'format' => 'float', 'example' => '1'], + 'IntAttr' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'IntAttr2' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'StrAttr' => ['description' => '字符串类型属性。'."\n", 'type' => 'string', 'example' => 'ss'], + 'StrAttr2' => ['description' => '字符串类型属性。'."\n", 'type' => 'string', 'example' => 'test'], + 'StrAttr3' => ['description' => '字符串类型属性，最多支持128个字符。可用于查询时过滤，查询时会返回该字段。', 'type' => 'string', 'example' => 'test'], + 'StrAttr4' => ['description' => '字符串类型属性，最多支持128个字符。可用于查询时过滤，查询时会返回该字段。', 'type' => 'string', 'example' => 'test'], + 'IntAttr3' => ['description' => '整数类型属性，可用于查询时过滤，查询时会返回该字段。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'IntAttr4' => ['description' => '整数类型属性，可用于查询时过滤，查询时会返回该字段。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + ], + ], + 'Code' => ['description' => '错误码。'."\n" + .'- 0：成功。'."\n" + .'- 非0：失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'PicInfo' => [ + 'description' => '类目预测、主体识别结果等信息。', + 'type' => 'object', + 'properties' => [ + 'Region' => ['description' => ' 主体识别结果。'."\n" + .'图片的主体区域，格式为x1,x2,y1,y2，其中 x1,y1 是左上角的点，x2，y2是右下角的点。若用户请求中指定了主体区域，则以请求中为准。', 'type' => 'string', 'example' => '280,486,232,351'], + 'CategoryId' => ['description' => ' 类目预测结果。'."\n" + .'若用户请求中指定了类目，则以请求中为准。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'MultiRegion' => [ + 'description' => '主体识别集合。', + 'type' => 'array', + 'items' => [ + 'description' => '主体集合。', + 'type' => 'object', + 'properties' => [ + 'Region' => ['description' => ' 主体识别结果。'."\n" + .'图片的主体区域，格式为x1,x2,y1,y2，其中 x1,y1 是左上角的点，x2，y2是右下角的点。若用户请求中指定了主体区域，则以请求中为准。', 'type' => 'string', 'example' => '280,486,232,351'], + ], + ], + ], + 'AllCategories' => [ + 'description' => '系统支持的所有类目信息。', + 'type' => 'array', + 'items' => [ + 'description' => '类目信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => ' 类目名称。', 'type' => 'string', 'example' => 'other'], + 'Id' => ['description' => '类目ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888'], + ], + ], + ], + ], + ], + 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''], + ['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''], + ['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'], + ['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => '请求body缺少特定符号'], + ['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => '请求body含有空的字段'], + ['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => '无效的元信息字段'], + ['errorCode' => 'NoPicList', 'errorMessage' => 'The body content is missing the pic_list parameter.', 'description' => '未指定pic_list字段'], + ['errorCode' => 'InvalidPicList', 'errorMessage' => 'The specified pic_list parameter is invalid.', 'description' => '无效的pic_list字段'], + ['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'he content of an image is not specified in the HTTP POST body.', 'description' => ''], + ['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''], + ['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => '无效的类目id'], + ['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => '超过了最大的返回结果限制数500'], + ['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => '单次返回数超过限制值100'], + ['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter start is inavlid.', 'description' => ''], + ['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter num is invalid.', 'description' => '无效的字段num'], + ['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''], + ['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => '无效的int过滤字段'], + ['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => '无效的图片格式'], + ['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => '无效的过滤条件'], + ['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => '实例的图片数量超过限制值'], + ['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => '图片包含不支持的旋转参数'], + ['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => '图片像素值不支持'], + ['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''], + ['errorCode' => 'PicNotExist', 'errorMessage' => 'The search picture does not exist.', 'description' => ''], + ['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'The parameter ProductId no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicName', 'errorMessage' => 'The parameter PicName no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''], + ['errorCode' => 'InvalidType', 'errorMessage' => 'The specified parameter Type is not valid.', 'description' => ''], + ['errorCode' => 'InvalidProductId', 'errorMessage' => 'The specified parameter ProductId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicName', 'errorMessage' => 'The specified parameter PicName is not valid.', 'description' => ''], + ['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => '无效StrAttr'], + ['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 2 * 1024 * 1024.', 'description' => ''], + ['errorCode' => 'InvalidStrAttr4', 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', 'description' => '无效StrAttr4'], + ['errorCode' => 'InvalidStrAttr3', 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', 'description' => '无效StrAttr3'], + ['errorCode' => 'InvalidStrAttr2', 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', 'description' => '无效StrAttr2'], + ['errorCode' => 'InvalidIntAttr4', 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', 'description' => '无效IntAttr4'], + ['errorCode' => 'InvalidIntAttr3', 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', 'description' => '无效IntAttr3'], + ['errorCode' => 'InvalidIntAttr2', 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', 'description' => '无效IntAttr2'], + ['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => '内部错误：不支持的action'], + ['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => '内部错误：不支持的实例类型'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => '未授权的行为'], + ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => '请求被限流'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal server error occurred.', 'description' => ''], + ['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => '内部错误：请求网络异常'], + ['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''], + ['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''], + ['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''], + ['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => '内部错误：请求内部算法错误'], + ['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => '内部错误：请求内部消息队列错误'], + ['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => '内部错误：请求特征存储错误'], + ], + ], + 'title' => '通过名称搜索图像', + 'summary' => '本文为您介绍SearchByName接口的语法及示例，用于根据名称查询图像搜索实例中的图片信息。', + 'description' => '### 使用说明'."\n" + .'本接口用于根据名称（即ProductId和PicName）查询图像搜索实例中的图片信息。'."\n" + ."\n" + .'> 如需了解更多产品详情和获取技术支持，请单击[在线咨询](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2)或通过钉钉群（35035130）联系我们。'."\n" + ."\n\n" + .'### QPS限制'."\n" + .'查询操作默认的最大访问频率可在控制台中查看，为您购买时所选择的访问频次（QPS），当前支持1QPS、5QPS、10QPS。'."\n" + ."\n", + 'extraInfo' => '### 错误码'."\n" + .'请参见[错误码](~~66619~~)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchImageByName'], + ], + ], + 'ramActions' => [ [ - 'name' => 'Text', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imagesearch:SearchImageByName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"Head\\": {\\n \\"DocsFound\\": 10,\\n \\"DocsReturn\\": 10000,\\n \\"SearchTime\\": 95\\n },\\n \\"RequestId\\": \\"36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1\\",\\n \\"Auctions\\": [\\n {\\n \\"ProductId\\": \\"2092061_1\\",\\n \\"PicName\\": \\"2092061_1.jpg\\",\\n \\"CategoryId\\": 20,\\n \\"SortExprValues\\": \\"5.37633353624177e+24;0\\",\\n \\"CustomContent\\": \\"zidingyi\\",\\n \\"Score\\": 1,\\n \\"IntAttr\\": 2,\\n \\"IntAttr2\\": 20,\\n \\"StrAttr\\": \\"ss\\",\\n \\"StrAttr2\\": \\"test\\",\\n \\"StrAttr3\\": \\"test\\",\\n \\"StrAttr4\\": \\"test\\",\\n \\"IntAttr3\\": 1,\\n \\"IntAttr4\\": 1\\n }\\n ],\\n \\"Code\\": 0,\\n \\"PicInfo\\": {\\n \\"Region\\": \\"280,486,232,351\\",\\n \\"CategoryId\\": 20,\\n \\"MultiRegion\\": [\\n {\\n \\"Region\\": \\"280,486,232,351\\"\\n }\\n ],\\n \\"AllCategories\\": [\\n {\\n \\"Name\\": \\"other\\",\\n \\"Id\\": 88888888\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'SearchImageByPic' => [ + 'summary' => '本文为您介绍SearchByPic的语法及示例，用于根据图片查询图像搜索实例中的图片信息。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREimagesearchF4L5JA'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'formData', + 'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n" + .'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n" + .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" + .'>这里的实例名称并非实例ID，使用时请区分。', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1'], + ], + [ + 'name' => 'PicContent', + 'in' => 'formData', + 'schema' => ['description' => '图片内容。'."\n" + .' - 图片大小要求不超过4 MB。'."\n" + .' - 图片格式：PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM。'."\n" + .' - 传输等待时间不超过5秒。'."\n" + .'<props="china">'."\n" + .' - 服务类型为商品图片搜索、通用图片搜索、家具家居图片搜索和工业五金图片搜索时，图片长和宽像素要求大于等于100PX且小于等于4096PX。'."\n" + .'服务类型为商标图片搜索时，图片长和宽像素要求大于等于200PX且小于4096PX。'."\n" + .'服务类型为布料图片搜索时，图片长和宽像素要求大于等于448PX且小于等于4096PX。'."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + .' - 服务类型为商品图片搜索和通用图片搜索时，图片长和宽像素要求大于等于100PX且小于等于4096PX。'."\n" + .'</props>'."\n" + .'- 图片中不能包含旋转信息。'."\n" + ."\n" + .'> - **使用SDK方式调用：**'."\n" + .' - 如使用V3版本SDK，则无需填写PicContent字段，SDK已将本字段封装为PicContentObject字段并自动转化为Base64编码。具体示例参考[JAVA SDK](~~179188~~)。'."\n" + .' - SDK不支持客户直接传递图片URL，V3版本SDK提供了一种变相实现URL上传的方式。具体示例参考[JAVA SDK](~~179188~~)。'."\n" + .'- **使用阿里云OpenAPI平台调用：**'."\n" + .' - 如使用**2019-03-25**版本，**PicContent**字段请填写图片的**Base64**编码。'."\n" + .' - 如使用**2020-12-14**版本，在**PicContent**字段直接点击上传图片即可。', 'type' => 'string', 'required' => true, 'example' => 'AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=', 'isFileTransferUrl' => true], + ], + [ + 'name' => 'CategoryId', 'in' => 'formData', 'schema' => [ - 'description' => '搜索图片的描述文本，支持中英文。'."\n" - ."\n" - .'>最多支持512个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'xxxx', + 'description' => '商品类目。具体请参见[类目参考](~~179184~~)。'."\n" + .' - 对于商品搜索，如果设置类目，则以设置的为准；如果不设置类目，则由系统进行类目预测，预测的类目结果可以在Response中获取 。'."\n" + .'<props="china">'."\n" + .' - 对于布料、商标、通用家具家居和工业五金搜索，不论是否设置类目，系统会将类目设置为88888888。'."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + .' - 对于通用搜索，不论是否设置类目，系统会将类目设置为88888888。'."\n" + .'</props>'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '88888888', + 'minimum' => '0', + 'example' => '88888888', + 'enum' => ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '20', '21', '22', '88888888'], ], ], [ + 'name' => 'Crop', + 'in' => 'formData', + 'schema' => ['description' => '是否需要进行主体识别。默认true。'."\n" + .' - 为true时，由系统进行主体识别，以识别的主体进行搜索，主体识别结果可在Response中获取。'."\n" + .' - 为false时，则不进行主体识别，以整张图进行搜索。'."\n" + .'<props="china">'."\n" + .'- 对于布料图片搜索，此参数会被忽略，系统会以整张图进行搜索。'."\n" + .'</props>'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'Region', + 'in' => 'formData', + 'schema' => ['description' => '图片的主体区域，格式为`x1,x2,y1,y2,` 其中`x1,y1` 是左上角的点，`x2,y2`是右下角的点。'."\n" + .'> - 若用户设置了Region，则不论Crop参数为何值，都将以用户输入Region进行搜索。'."\n" + .'<props="china">'."\n" + .'- 对于布料图片搜索，此参数会被忽略，系统会以整张图进行搜索。'."\n" + .'</props>'."\n" + ."\n\n", 'type' => 'string', 'required' => false, 'example' => '280,486,232,351'], + ], + [ + 'name' => 'Num', + 'in' => 'formData', + 'schema' => ['description' => '返回结果的数目。取值范围：1~100。默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'], + ], + [ + 'name' => 'Start', + 'in' => 'formData', + 'schema' => ['description' => '返回结果的起始位置。取值范围：0~499。默认值为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '499', 'minimum' => '0', 'example' => '0', 'default' => '0'], + ], + [ + 'name' => 'Filter', + 'in' => 'formData', + 'schema' => ['description' => '过滤条件。int_attr支持的操作符有in、not in、大于号(>)、大于等于号(>=)、小于号(<)、小于等于号(<=)、等于号(=)。str_attr支持的操作符有in、not in、等于号(=)和不等号(!=)，多个条件之间支持AND和OR进行连接。'."\n" + .'例如：'."\n" + .'- int_attr >= 100。'."\n" + .'- str_attr != "value1"。'."\n" + .'- int_attr = 1000 AND str_attr = "value1"。'."\n" + ."\n" + .'>最多支持4096个字符。', 'type' => 'string', 'required' => false, 'example' => 'int_attr=1000 AND str_attr="value1"'], + ], + [ + 'name' => 'DistinctProductId', + 'in' => 'formData', + 'schema' => ['description' => '如果为true则检索时根据ProductId字段进行去重复数据。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ 'name' => 'ScoreThreshold', 'in' => 'query', - 'schema' => [ - 'description' => '填写相似度分数阈值后，只返回图片相似度分数大于等于阈值的图片信息。阈值范围0.00-1.00，最大支持2位小数，默认为0.00 。', - 'type' => 'string', - 'required' => false, - 'example' => '0.50', - ], + 'schema' => ['description' => '填写相似度分数阈值后，只返回图片相似度分数大于等于阈值的图片信息。阈值范围0.00-1.00，最大支持2位小数，默认为0.00 。', 'type' => 'string', 'required' => false, 'example' => '0.50'], ], ], 'responses' => [ @@ -3637,40 +1980,268 @@ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'Msg' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'success', - ], + 'Msg' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success'], 'Head' => [ 'description' => '搜索结果概述信息。', 'type' => 'object', 'properties' => [ - 'DocsFound' => [ - 'description' => '返回结果数目。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', + 'DocsFound' => ['description' => '返回结果数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'DocsReturn' => ['description' => '实例中命中结果数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '10000'], + 'SearchTime' => ['description' => '搜索耗时，单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '95'], + ], + ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879'], + 'Auctions' => [ + 'description' => '所有返回的商品描述信息。', + 'type' => 'array', + 'items' => [ + 'description' => '所有返回的商品描述信息。', + 'type' => 'object', + 'properties' => [ + 'ProductId' => ['description' => '商品ID。', 'type' => 'string', 'example' => '2092061_1'], + 'PicName' => ['description' => '图片名称。', 'type' => 'string', 'example' => '2092061_1.jpg'], + 'CategoryId' => ['description' => '图片类目。', 'type' => 'integer', 'format' => 'int32', 'example' => '8888888'], + 'SortExprValues' => ['description' => '系统打分信息。'."\n" + .'> - 当前字段已弃用，建议使用Score。 '."\n" + .'- SortExprValues是一个分号分隔的二元组，第一个值表示图片的相关性分数，值越大表示和查询的图片相关性越高。由于算法模型不同。'."\n" + .'- 当类目为0~2时，SortExprValues值域范围：0～7.33136443711219e+24。'."\n" + .'- 类目为其他值时，SortExprValues值域范围：0～5.37633353624177e+24。当两个图片完全一样时，这个分值最大。', 'type' => 'string', 'example' => '5.37633353624177e+24;0'], + 'CustomContent' => ['description' => '用户自定义的内容。', 'type' => 'string', 'example' => 'zidingyi'], + 'Score' => ['description' => '图片相似打分。取值范围：0~1。'."\n" + .'> 需要版本升级至V3.1.1方可使用。', 'type' => 'number', 'format' => 'float', 'example' => '1'], + 'IntAttr' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'IntAttr2' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'StrAttr2' => ['description' => '字符串类型属性。', 'type' => 'string', 'example' => 'test'], + 'StrAttr' => ['description' => '字符串类型属性。', 'type' => 'string', 'example' => 'test'], + 'StrAttr3' => ['description' => '字符串类型属性。', 'type' => 'string', 'example' => 'test'], + 'StrAttr4' => ['description' => '字符串类型属性。', 'type' => 'string', 'example' => 'test'], + 'IntAttr3' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'IntAttr4' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], ], - 'DocsReturn' => [ - 'description' => '实例中命中结果数目。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', + ], + ], + 'Code' => ['description' => ' 错误码。'."\n" + .'- 0：成功。'."\n" + .'- 非0：失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'PicInfo' => [ + 'description' => '类目预测、主体识别结果等信息。', + 'type' => 'object', + 'properties' => [ + 'Region' => ['description' => '主体识别结果。图片的主体区域，格式为x1,x2,y1,y2，其中 x1,y1 是左上角的点，x2，y2是右下角的点。若用户请求中指定了主体区域，则以请求中为准。', 'type' => 'string', 'example' => '280,486,232,351'], + 'CategoryId' => ['description' => '类目预测结果。若用户请求中指定了类目，则以请求中为准。', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888'], + 'MultiRegion' => [ + 'description' => '主体识别结果集合。'."\n" + .'> 需要版本升级至V3.1.1方可使用。', + 'type' => 'array', + 'items' => [ + 'description' => '主体识别结果。', + 'type' => 'object', + 'properties' => [ + 'Region' => ['description' => '主体识别结果。图片的主体区域，格式为x1,x2,y1,y2，其中 x1,y1 是左上角的点，x2，y2是右下角的点。若用户请求中指定了主体区域，则以请求中为准。', 'type' => 'string', 'example' => '280,486,232,351'], + ], + ], ], - 'SearchTime' => [ - 'description' => '搜索耗时，单位毫秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '95', + 'AllCategories' => [ + 'description' => '系统支持的所有类目信息。', + 'type' => 'array', + 'items' => [ + 'description' => '系统支持的所有类目信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '类目名称。', 'type' => 'string', 'example' => 'other'], + 'Id' => ['description' => '类目ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888'], + ], + ], ], ], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', + 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''], + ['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''], + ['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'], + ['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => '请求body缺少特定符号'], + ['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => '请求body含有空的字段'], + ['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => '无效的元信息字段'], + ['errorCode' => 'NoPicList', 'errorMessage' => 'The body content is missing the pic_list parameter.', 'description' => '未指定pic_list字段'], + ['errorCode' => 'InvalidPicList', 'errorMessage' => 'The specified pic_list parameter is invalid.', 'description' => '无效的pic_list字段'], + ['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'he content of an image is not specified in the HTTP POST body.', 'description' => ''], + ['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''], + ['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => '无效的类目id'], + ['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => '超过了最大的返回结果限制数500'], + ['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => '单次返回数超过限制值100'], + ['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter start is inavlid.', 'description' => ''], + ['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter num is invalid.', 'description' => '无效的字段num'], + ['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''], + ['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => '无效的int过滤字段'], + ['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => '无效的图片格式'], + ['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => '无效的过滤条件'], + ['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => '实例的图片数量超过限制值'], + ['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => '图片包含不支持的旋转参数'], + ['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => '图片像素值不支持'], + ['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''], + ['errorCode' => 'PicNotExist', 'errorMessage' => 'The search picture does not exist.', 'description' => ''], + ['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'The parameter ProductId no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicName', 'errorMessage' => 'The parameter PicName no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''], + ['errorCode' => 'InvalidType', 'errorMessage' => 'The specified parameter Type is not valid.', 'description' => ''], + ['errorCode' => 'InvalidProductId', 'errorMessage' => 'The specified parameter ProductId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicName', 'errorMessage' => 'The specified parameter PicName is not valid.', 'description' => ''], + ['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => '无效StrAttr'], + ['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', 'description' => ''], + ['errorCode' => 'InvalidPicUrl', 'errorMessage' => 'The search picture does not exist at the specific url.', 'description' => ''], + ['errorCode' => 'InvalidInstanceName', 'errorMessage' => 'The parameter instanceName is not specified.', 'description' => ''], + ['errorCode' => 'InvalidRequestId', 'errorMessage' => 'The parameter requestId is not specified.', 'description' => ''], + ['errorCode' => 'InvalidRequestIdTooLarge', 'errorMessage' => 'The parameter requestId is too large.', 'description' => ''], + ['errorCode' => 'InvalidRegion', 'errorMessage' => 'The specific region is illegal', 'description' => ''], + ['errorCode' => 'InvalidIntAttr4', 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', 'description' => '无效IntAttr4'], + ['errorCode' => 'InvalidIntAttr3', 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', 'description' => '无效IntAttr3'], + ['errorCode' => 'InvalidIntAttr2', 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', 'description' => '无效IntAttr2'], + ['errorCode' => 'InvalidStrAttr4', 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', 'description' => '无效StrAttr4'], + ['errorCode' => 'InvalidStrAttr3', 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', 'description' => '无效StrAttr3'], + ['errorCode' => 'InvalidStrAttr2', 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', 'description' => '无效StrAttr2'], + ['errorCode' => 'PictureError', 'errorMessage' => '[download] Img Download Failed.', 'description' => '图片下载失败，请检查图片'], + ['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => '内部错误：不支持的action'], + ['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => '内部错误：不支持的实例类型'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => '未授权的行为'], + ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => '请求被限流'], + ], + 500 => [ + ['errorCode' => 'UnknownException', 'errorMessage' => 'An internal server error occurred.', 'description' => '未知异常'], + ['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => '内部错误：请求网络异常'], + ['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''], + ['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''], + ['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''], + ['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => '内部错误：请求内部算法错误'], + ['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => '内部错误：请求内部消息队列错误'], + ['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => '内部错误：请求特征存储错误'], + ['errorCode' => 'ConnectionDVException', 'errorMessage' => 'Failed to obtain collection.', 'description' => 'internalError'], + ], + ], + 'title' => '根据图片查询图片', + 'description' => '## 使用说明'."\n" + .'本接口用于根据图片查询图像搜索实例中的图片信息。'."\n" + .'> <props="china">如需了解更多产品详情和获取技术支持，请单击[在线咨询](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2)或通过钉钉群（35035130）联系我们。</props>'."\n" + ."\n" + .'## QPS限制'."\n" + .'查询操作默认的最大访问频率可在控制台中查看，为您购买时所选择的访问频次（QPS），当前支持1QPS、5QPS、10QPS。'."\n" + ."\n\n" + .'### SDK版本说明'."\n" + .'图像SDK版本升级到V3.1.1，可使用“多主体识别”、“相似性分数”功能。请参见[Java SDK](~~179188~~)。', + 'extraInfo' => '## 错误码'."\n" + .'请参见[错误码](~~66619~~)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchImageByPic'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imagesearch:SearchImageByPic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"Head\\": {\\n \\"DocsFound\\": 10,\\n \\"DocsReturn\\": 10000,\\n \\"SearchTime\\": 95\\n },\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Auctions\\": [\\n {\\n \\"ProductId\\": \\"2092061_1\\",\\n \\"PicName\\": \\"2092061_1.jpg\\",\\n \\"CategoryId\\": 8888888,\\n \\"SortExprValues\\": \\"5.37633353624177e+24;0\\",\\n \\"CustomContent\\": \\"zidingyi\\",\\n \\"Score\\": 1,\\n \\"IntAttr\\": 2,\\n \\"IntAttr2\\": 20,\\n \\"StrAttr2\\": \\"test\\",\\n \\"StrAttr\\": \\"test\\",\\n \\"StrAttr3\\": \\"test\\",\\n \\"StrAttr4\\": \\"test\\",\\n \\"IntAttr3\\": 2,\\n \\"IntAttr4\\": 2\\n }\\n ],\\n \\"Code\\": 0,\\n \\"PicInfo\\": {\\n \\"Region\\": \\"280,486,232,351\\",\\n \\"CategoryId\\": 88888888,\\n \\"MultiRegion\\": [\\n {\\n \\"Region\\": \\"280,486,232,351\\"\\n }\\n ],\\n \\"AllCategories\\": [\\n {\\n \\"Name\\": \\"other\\",\\n \\"Id\\": 88888888\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'SearchImageByText' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREimagesearchF4L5JA'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'formData', + 'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n" + .'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n" + .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" + .'>这里的实例名称并非实例ID，使用时请区分。', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1'], + ], + [ + 'name' => 'Num', + 'in' => 'formData', + 'schema' => ['description' => '返回结果的数目。取值范围：1~100。默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'], + ], + [ + 'name' => 'Start', + 'in' => 'formData', + 'schema' => ['description' => '返回结果的起始位置。取值范围：0~499。默认值为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '499', 'minimum' => '0', 'example' => '0', 'default' => '0'], + ], + [ + 'name' => 'Filter', + 'in' => 'formData', + 'schema' => ['description' => '过滤条件。int_attr支持的操作符有in、not in、大于号(>)、大于等于号(>=)、小于号(<)、小于等于号(<=)、等于号(=)。str_attr支持的操作符有in、not in、等于号(=)和不等号(!=)，多个条件之间支持AND和OR进行连接。'."\n" + .'例如：'."\n" + .'- int_attr >= 100。'."\n" + .'- str_attr != "value1"。'."\n" + .'- int_attr = 1000 AND str_attr = "value1"。'."\n" + ."\n" + .'>最多支持4096个字符。', 'type' => 'string', 'required' => false, 'example' => 'int_attr=1000 AND str_attr="value1"'], + ], + [ + 'name' => 'DistinctProductId', + 'in' => 'formData', + 'schema' => ['description' => '如果为true则检索时根据ProductId字段进行去重复数据。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'Text', + 'in' => 'formData', + 'schema' => ['description' => '搜索图片的描述文本，支持中英文。'."\n" + ."\n" + .'>最多支持512个字符。', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], + ], + [ + 'name' => 'ScoreThreshold', + 'in' => 'query', + 'schema' => ['description' => '填写相似度分数阈值后，只返回图片相似度分数大于等于阈值的图片信息。阈值范围0.00-1.00，最大支持2位小数，默认为0.00 。', 'type' => 'string', 'required' => false, 'example' => '0.50'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Msg' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success'], + 'Head' => [ + 'description' => '搜索结果概述信息。', + 'type' => 'object', + 'properties' => [ + 'DocsFound' => ['description' => '返回结果数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'DocsReturn' => ['description' => '实例中命中结果数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '10000'], + 'SearchTime' => ['description' => '搜索耗时，单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '95'], + ], ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879'], 'Auctions' => [ 'description' => '所有返回的商品描述信息。', 'type' => 'array', @@ -3678,89 +2249,26 @@ 'description' => '所有返回的商品描述信息。', 'type' => 'object', 'properties' => [ - 'ProductId' => [ - 'description' => '商品ID。', - 'type' => 'string', - 'example' => '2092061_1', - ], - 'PicName' => [ - 'description' => '图片名称。', - 'type' => 'string', - 'example' => '2092061_1.jpg', - ], - 'CategoryId' => [ - 'description' => '图片类目。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8888888', - ], - 'CustomContent' => [ - 'description' => '用户自定义的内容。', - 'type' => 'string', - 'example' => 'zidingyi', - ], - 'Score' => [ - 'description' => '图片相似打分。取值范围：0~1。'."\n" - .'> 需要版本升级至V3.1.1方可使用。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'IntAttr' => [ - 'description' => '整数类型属性。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'IntAttr2' => [ - 'description' => '整数类型属性。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'StrAttr2' => [ - 'description' => '字符串类型属性。', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'StrAttr' => [ - 'description' => '字符串类型属性。', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'StrAttr3' => [ - 'description' => '字符串类型属性。', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'StrAttr4' => [ - 'description' => '字符串类型属性。', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'IntAttr3' => [ - 'description' => '整数类型属性。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'IntAttr4' => [ - 'description' => '整数类型属性。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'ProductId' => ['description' => '商品ID。', 'type' => 'string', 'example' => '2092061_1'], + 'PicName' => ['description' => '图片名称。', 'type' => 'string', 'example' => '2092061_1.jpg'], + 'CategoryId' => ['description' => '图片类目。', 'type' => 'integer', 'format' => 'int32', 'example' => '8888888'], + 'CustomContent' => ['description' => '用户自定义的内容。', 'type' => 'string', 'example' => 'zidingyi'], + 'Score' => ['description' => '图片相似打分。取值范围：0~1。'."\n" + .'> 需要版本升级至V3.1.1方可使用。', 'type' => 'number', 'format' => 'float', 'example' => '1'], + 'IntAttr' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'IntAttr2' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'StrAttr2' => ['description' => '字符串类型属性。', 'type' => 'string', 'example' => 'xxxx'], + 'StrAttr' => ['description' => '字符串类型属性。', 'type' => 'string', 'example' => 'xxxx'], + 'StrAttr3' => ['description' => '字符串类型属性。', 'type' => 'string', 'example' => 'xxxx'], + 'StrAttr4' => ['description' => '字符串类型属性。', 'type' => 'string', 'example' => 'xxxx'], + 'IntAttr3' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'IntAttr4' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], ], ], ], - 'Code' => [ - 'description' => '错误码。'."\n" - .'- 0：成功。'."\n" - .'- 非0：失败。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'Code' => ['description' => '错误码。'."\n" + .'- 0：成功。'."\n" + .'- 非0：失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'PicInfo' => [ 'description' => '所有的类目信息', 'type' => 'object', @@ -3772,67 +2280,26 @@ 'description' => '系统支持的所有类目信息。', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '类目名称。', - 'type' => 'string', - 'example' => 'other', - ], - 'Id' => [ - 'description' => '类目ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '88888888', - ], + 'Name' => ['description' => '类目名称。', 'type' => 'string', 'example' => 'other'], + 'Id' => ['description' => '类目ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888'], ], ], ], ], ], - 'Success' => [ - 'description' => '请求是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'AccessDeniedDetail' => [ 'description' => '鉴权返回集合。', 'type' => 'object', 'properties' => [ - 'AuthAction' => [ - 'description' => '鉴权请求Action。', - 'type' => 'string', - 'example' => 'xxx', - ], - 'AuthPrincipalDisplayName' => [ - 'description' => '鉴权主体信息。', - 'type' => 'string', - 'example' => '111', - ], - 'AuthPrincipalOwnerId' => [ - 'description' => '鉴权主体的主账号ID。', - 'type' => 'string', - 'example' => '222', - ], - 'AuthPrincipalType' => [ - 'description' => '鉴权主体类型。', - 'type' => 'string', - 'example' => 'SubUser', - ], - 'EncodedDiagnosticMessage' => [ - 'description' => '加密后的完整诊断信息。', - 'type' => 'string', - 'example' => 'xxxxxx', - ], - 'NoPermissionType' => [ - 'description' => 'ImplicitDeny：未命中任何策略。'."\n" - .'ExplicitDeny：明确命中Deny策略。', - 'type' => 'string', - 'example' => 'ImplicitDeny', - ], - 'PolicyType' => [ - 'description' => '引起无权限的策略类型。', - 'type' => 'string', - 'example' => 'PauseNotify', - ], + 'AuthAction' => ['description' => '鉴权请求Action。', 'type' => 'string', 'example' => 'xxx'], + 'AuthPrincipalDisplayName' => ['description' => '鉴权主体信息。', 'type' => 'string', 'example' => '111'], + 'AuthPrincipalOwnerId' => ['description' => '鉴权主体的主账号ID。', 'type' => 'string', 'example' => '222'], + 'AuthPrincipalType' => ['description' => '鉴权主体类型。', 'type' => 'string', 'example' => 'SubUser'], + 'EncodedDiagnosticMessage' => ['description' => '加密后的完整诊断信息。', 'type' => 'string', 'example' => 'xxxxxx'], + 'NoPermissionType' => ['description' => 'ImplicitDeny：未命中任何策略。'."\n" + .'ExplicitDeny：明确命中Deny策略。', 'type' => 'string', 'example' => 'ImplicitDeny'], + 'PolicyType' => ['description' => '引起无权限的策略类型。', 'type' => 'string', 'example' => 'PauseNotify'], ], ], ], @@ -3841,253 +2308,74 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'BadRequest', - 'errorMessage' => 'The request has invalid parameters.', - ], - [ - 'errorCode' => 'InstanceStatusError', - 'errorMessage' => 'Your instance is unavailable.', - ], - [ - 'errorCode' => 'TimeoutForTransferImage', - 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', - ], - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'NoCaretSeperator', - 'errorMessage' => 'The body content is missing the ^ separator.', - ], - [ - 'errorCode' => 'EmptyMeta', - 'errorMessage' => 'The body content has an empty meta field.', - ], - [ - 'errorCode' => 'InvalidMetaItem', - 'errorMessage' => 'The meta field is invalid.', - ], - [ - 'errorCode' => 'NoPicList', - 'errorMessage' => 'The body content is missing the pic_list parameter.', - ], - [ - 'errorCode' => 'InvalidPicList', - 'errorMessage' => 'The specified pic_list parameter is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedPic', - 'errorMessage' => 'he content of an image is not specified in the HTTP POST body.', - ], - [ - 'errorCode' => 'NoSpecifiedSearchPic', - 'errorMessage' => 'The search image is not specified.', - ], - [ - 'errorCode' => 'OverflowMaxResultNum', - 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', - ], - [ - 'errorCode' => 'OverflowMaxReturnNum', - 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', - ], - [ - 'errorCode' => 'InvalidStartParameter', - 'errorMessage' => 'The specified parameter start is inavlid.', - ], - [ - 'errorCode' => 'InvalidNumParameter', - 'errorMessage' => 'The specified parameter num is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedAddPic', - 'errorMessage' => 'The image to insert is not specified.', - ], - [ - 'errorCode' => 'NoSpecifiedItemId', - 'errorMessage' => 'The item_id parameter is not specified.', - ], - [ - 'errorCode' => 'InvalidIntAttr', - 'errorMessage' => 'The specified int_attr field is invalid.', - ], - [ - 'errorCode' => 'InvalidFilterClause', - 'errorMessage' => 'The specified filtering condition is invalid.', - ], - [ - 'errorCode' => 'InstanceOverQuota', - 'errorMessage' => 'The number of items exceeds the limit.', - ], - [ - 'errorCode' => 'IncorrectOrientation', - 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', - ], - [ - 'errorCode' => 'UnsupportedPicPixels', - 'errorMessage' => 'The specified pixels is not supported.', - ], - [ - 'errorCode' => 'SearchTimeout', - 'errorMessage' => 'The request is timed out.', - ], - [ - 'errorCode' => 'PicNotExist', - 'errorMessage' => 'The search picture does not exist.', - ], - [ - 'errorCode' => 'NoSpecifiedProductId', - 'errorMessage' => 'The parameter ProductId no specified.', - ], - [ - 'errorCode' => 'NoSpecifiedPicName', - 'errorMessage' => 'The parameter PicName no specified.', - ], - [ - 'errorCode' => 'NoSpecifiedPicContent', - 'errorMessage' => 'The parameter PicContent no specified.', - ], - [ - 'errorCode' => 'InvalidType', - 'errorMessage' => 'The specified parameter Type is not valid.', - ], - [ - 'errorCode' => 'InvalidProductId', - 'errorMessage' => 'The specified parameter ProductId is not valid.', - ], - [ - 'errorCode' => 'InvalidPicName', - 'errorMessage' => 'The specified parameter PicName is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr', - 'errorMessage' => 'The specified parameter StrAttr is not valid.', - ], - [ - 'errorCode' => 'InvalidCustomContent', - 'errorMessage' => 'The specified parameter CustomContent is not valid.', - ], - [ - 'errorCode' => 'InvalidPicContent', - 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', - ], - [ - 'errorCode' => 'InvalidPicUrl', - 'errorMessage' => 'The search picture does not exist at the specific url.', - ], - [ - 'errorCode' => 'InvalidInstanceName', - 'errorMessage' => 'The parameter instanceName is not specified.', - ], - [ - 'errorCode' => 'InvalidRequestId', - 'errorMessage' => 'The parameter requestId is not specified.', - ], - [ - 'errorCode' => 'InvalidRequestIdTooLarge', - 'errorMessage' => 'The parameter requestId is too large.', - ], - [ - 'errorCode' => 'InvalidRegion', - 'errorMessage' => 'The specific region is illegal', - ], - [ - 'errorCode' => 'InvalidIntAttr4', - 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr3', - 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr2', - 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr4', - 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr3', - 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr2', - 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', - ], - [ - 'errorCode' => 'InvalidText', - 'errorMessage' => 'The specified parameter Text is not valid.', - ], - [ - 'errorCode' => 'InvalidTextLength', - 'errorMessage' => 'Invalid text clause.', - ], - [ - 'errorCode' => 'UnsupportedOperationType', - 'errorMessage' => 'The specified action is not supported.', - ], - [ - 'errorCode' => 'UnsupportedInstanceType', - 'errorMessage' => 'The instance type is not supported.', - ], + ['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''], + ['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''], + ['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'], + ['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => '请求body缺少特定符号'], + ['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => '请求body含有空的字段'], + ['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => '无效的元信息字段'], + ['errorCode' => 'NoPicList', 'errorMessage' => 'The body content is missing the pic_list parameter.', 'description' => '未指定pic_list字段'], + ['errorCode' => 'InvalidPicList', 'errorMessage' => 'The specified pic_list parameter is invalid.', 'description' => '无效的pic_list字段'], + ['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'he content of an image is not specified in the HTTP POST body.', 'description' => ''], + ['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''], + ['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => '超过了最大的返回结果限制数500'], + ['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => '单次返回数超过限制值100'], + ['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter start is inavlid.', 'description' => ''], + ['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter num is invalid.', 'description' => '无效的字段num'], + ['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''], + ['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => '无效的int过滤字段'], + ['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => '无效的过滤条件'], + ['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => '实例的图片数量超过限制值'], + ['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => '图片包含不支持的旋转参数'], + ['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => '图片像素值不支持'], + ['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''], + ['errorCode' => 'PicNotExist', 'errorMessage' => 'The search picture does not exist.', 'description' => ''], + ['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'The parameter ProductId no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicName', 'errorMessage' => 'The parameter PicName no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''], + ['errorCode' => 'InvalidType', 'errorMessage' => 'The specified parameter Type is not valid.', 'description' => ''], + ['errorCode' => 'InvalidProductId', 'errorMessage' => 'The specified parameter ProductId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicName', 'errorMessage' => 'The specified parameter PicName is not valid.', 'description' => ''], + ['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => '无效StrAttr'], + ['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', 'description' => ''], + ['errorCode' => 'InvalidPicUrl', 'errorMessage' => 'The search picture does not exist at the specific url.', 'description' => ''], + ['errorCode' => 'InvalidInstanceName', 'errorMessage' => 'The parameter instanceName is not specified.', 'description' => ''], + ['errorCode' => 'InvalidRequestId', 'errorMessage' => 'The parameter requestId is not specified.', 'description' => ''], + ['errorCode' => 'InvalidRequestIdTooLarge', 'errorMessage' => 'The parameter requestId is too large.', 'description' => ''], + ['errorCode' => 'InvalidRegion', 'errorMessage' => 'The specific region is illegal', 'description' => ''], + ['errorCode' => 'InvalidIntAttr4', 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', 'description' => '无效IntAttr4'], + ['errorCode' => 'InvalidIntAttr3', 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', 'description' => '无效IntAttr3'], + ['errorCode' => 'InvalidIntAttr2', 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', 'description' => '无效IntAttr2'], + ['errorCode' => 'InvalidStrAttr4', 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', 'description' => '无效StrAttr4'], + ['errorCode' => 'InvalidStrAttr3', 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', 'description' => '无效StrAttr3'], + ['errorCode' => 'InvalidStrAttr2', 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', 'description' => '无效StrAttr2'], + ['errorCode' => 'InvalidText', 'errorMessage' => 'The specified parameter Text is not valid.', 'description' => '描述信息Text不能为null'], + ['errorCode' => 'InvalidTextLength', 'errorMessage' => 'Invalid text clause.', 'description' => 'text字段长度必须在512内。'], + ['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => '内部错误：不支持的action'], + ['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => '内部错误：不支持的实例类型'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation.', - ], - [ - 'errorCode' => 'DeniedRequest', - 'errorMessage' => 'Your request was denied due to instance flow control.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => '未授权的行为'], + ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => '请求被限流'], ], 500 => [ - [ - 'errorCode' => 'UnknownException', - 'errorMessage' => 'An internal server error occurred.', - ], - [ - 'errorCode' => 'NetworkException', - 'errorMessage' => 'A network error occurred.', - ], - [ - 'errorCode' => 'RequestTimeout', - 'errorMessage' => 'The request is timeout.', - ], - [ - 'errorCode' => 'ExtractFeatureTimeout', - 'errorMessage' => 'The request was timed out while extracting features.', - ], - [ - 'errorCode' => 'AccessEngineFailed', - 'errorMessage' => 'An error occurred while accessing the search engine.', - ], - [ - 'errorCode' => 'InternalOssError', - 'errorMessage' => 'An internal OAS error occurred.', - ], - [ - 'errorCode' => 'InternalSwiftError', - 'errorMessage' => 'An internal SWIFT error occurred.', - ], - [ - 'errorCode' => 'InternalTableStoreError', - 'errorMessage' => 'An internal Table Store error occurred.', - ], - [ - 'errorCode' => 'ConnectionDVException', - 'errorMessage' => 'Failed to obtain collection.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"Head\\": {\\n \\"DocsFound\\": 10,\\n \\"DocsReturn\\": 10000,\\n \\"SearchTime\\": 95\\n },\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Auctions\\": [\\n {\\n \\"ProductId\\": \\"2092061_1\\",\\n \\"PicName\\": \\"2092061_1.jpg\\",\\n \\"CategoryId\\": 8888888,\\n \\"CustomContent\\": \\"zidingyi\\",\\n \\"Score\\": 1,\\n \\"IntAttr\\": 2,\\n \\"IntAttr2\\": 2,\\n \\"StrAttr2\\": \\"xxxx\\",\\n \\"StrAttr\\": \\"xxxx\\",\\n \\"StrAttr3\\": \\"xxxx\\",\\n \\"StrAttr4\\": \\"xxxx\\",\\n \\"IntAttr3\\": 2,\\n \\"IntAttr4\\": 2\\n }\\n ],\\n \\"Code\\": 0,\\n \\"PicInfo\\": {\\n \\"AllCategories\\": [\\n {\\n \\"Name\\": \\"other\\",\\n \\"Id\\": 88888888\\n }\\n ]\\n },\\n \\"Success\\": true,\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalDisplayName\\": \\"111\\",\\n \\"AuthPrincipalOwnerId\\": \\"222\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"xxxxxx\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"PauseNotify\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<SearchImageByTextResponse>\\n <Msg>success</Msg>\\n <Head>\\n <DocsFound>10</DocsFound>\\n <DocsReturn>10000</DocsReturn>\\n <SearchTime>95</SearchTime>\\n </Head>\\n <RequestId>B3137727-7D6E-488C-BA21-0E034C38A879</RequestId>\\n <Auctions>\\n <ProductId>2092061_1</ProductId>\\n <PicName>2092061_1.jpg</PicName>\\n <CategoryId>8888888</CategoryId>\\n <CustomContent>zidingyi</CustomContent>\\n <Score>1</Score>\\n <IntAttr>2</IntAttr>\\n <IntAttr2>2</IntAttr2>\\n <StrAttr2>xxxx</StrAttr2>\\n <StrAttr>xxxx</StrAttr>\\n <StrAttr3>xxxx</StrAttr3>\\n <StrAttr4>xxxx</StrAttr4>\\n <IntAttr3>2</IntAttr3>\\n <IntAttr4>2</IntAttr4>\\n </Auctions>\\n <Code>0</Code>\\n <PicInfo>\\n <AllCategories>\\n <Name>other</Name>\\n <Id>88888888</Id>\\n </AllCategories>\\n </PicInfo>\\n <Success>true</Success>\\n</SearchImageByTextResponse>","errorExample":""}]', + ['errorCode' => 'UnknownException', 'errorMessage' => 'An internal server error occurred.', 'description' => '未知异常'], + ['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => '内部错误：请求网络异常'], + ['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''], + ['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''], + ['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''], + ['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => '内部错误：请求内部算法错误'], + ['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => '内部错误：请求内部消息队列错误'], + ['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => '内部错误：请求特征存储错误'], + ['errorCode' => 'ConnectionDVException', 'errorMessage' => 'Failed to obtain collection.', 'description' => 'internalError'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '根据文本查询图片', + 'summary' => '本文为您介绍SearchImageByText的语法及示例，用于根据文字查询图像搜索实例中的图片信息。', 'description' => '## 使用说明'."\n" .'本接口用于根据文字查询图像搜索实例中的图片信息。只有服务类型为商品多模态搜索才能使用。'."\n" .'> <props="china">如需了解更多产品详情和获取技术支持，请单击[在线咨询](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2)或通过钉钉群（35035130）联系我们。</props>'."\n" @@ -4097,16 +2385,29 @@ ."\n\n" .'### SDK版本说明'."\n" .'图像SDK版本升级到V3.1.1，可使用“多主体识别”、“相似性分数”功能。请参见[Java SDK](~~179188~~)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imagesearch:SearchImageByText', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"Head\\": {\\n \\"DocsFound\\": 10,\\n \\"DocsReturn\\": 10000,\\n \\"SearchTime\\": 95\\n },\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Auctions\\": [\\n {\\n \\"ProductId\\": \\"2092061_1\\",\\n \\"PicName\\": \\"2092061_1.jpg\\",\\n \\"CategoryId\\": 8888888,\\n \\"CustomContent\\": \\"zidingyi\\",\\n \\"Score\\": 1,\\n \\"IntAttr\\": 2,\\n \\"IntAttr2\\": 2,\\n \\"StrAttr2\\": \\"xxxx\\",\\n \\"StrAttr\\": \\"xxxx\\",\\n \\"StrAttr3\\": \\"xxxx\\",\\n \\"StrAttr4\\": \\"xxxx\\",\\n \\"IntAttr3\\": 2,\\n \\"IntAttr4\\": 2\\n }\\n ],\\n \\"Code\\": 0,\\n \\"PicInfo\\": {\\n \\"AllCategories\\": [\\n {\\n \\"Name\\": \\"other\\",\\n \\"Id\\": 88888888\\n }\\n ]\\n },\\n \\"Success\\": true,\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalDisplayName\\": \\"111\\",\\n \\"AuthPrincipalOwnerId\\": \\"222\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"xxxxxx\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"PauseNotify\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<SearchImageByTextResponse>\\n <Msg>success</Msg>\\n <Head>\\n <DocsFound>10</DocsFound>\\n <DocsReturn>10000</DocsReturn>\\n <SearchTime>95</SearchTime>\\n </Head>\\n <RequestId>B3137727-7D6E-488C-BA21-0E034C38A879</RequestId>\\n <Auctions>\\n <ProductId>2092061_1</ProductId>\\n <PicName>2092061_1.jpg</PicName>\\n <CategoryId>8888888</CategoryId>\\n <CustomContent>zidingyi</CustomContent>\\n <Score>1</Score>\\n <IntAttr>2</IntAttr>\\n <IntAttr2>2</IntAttr2>\\n <StrAttr2>xxxx</StrAttr2>\\n <StrAttr>xxxx</StrAttr>\\n <StrAttr3>xxxx</StrAttr3>\\n <StrAttr4>xxxx</StrAttr4>\\n <IntAttr3>2</IntAttr3>\\n <IntAttr4>2</IntAttr4>\\n </Auctions>\\n <Code>0</Code>\\n <PicInfo>\\n <AllCategories>\\n <Name>other</Name>\\n <Id>88888888</Id>\\n </AllCategories>\\n </PicInfo>\\n <Success>true</Success>\\n</SearchImageByTextResponse>","errorExample":""}]', ], 'UpdateImage' => [ 'summary' => '本文为您介绍UpdateImage接口的语法及示例，用于向图像搜索实例中修改图片信息。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4118,143 +2419,80 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREimagesearchAA7PKJ', - ], + 'abilityTreeNodes' => ['FEATUREimagesearchAA7PKJ'], ], 'parameters' => [ [ 'name' => 'InstanceName', 'in' => 'formData', - 'schema' => [ - 'description' => '图搜实例名称。最多支持20个字符。'."\n" - .'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n" - .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" - .'>这里的实例名称并非实例ID，使用时请区分。', - 'type' => 'string', - 'required' => true, - 'example' => 'demoinstance1', - ], + 'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n" + .'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n" + .'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n" + .'>这里的实例名称并非实例ID，使用时请区分。', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1'], ], [ 'name' => 'ProductId', 'in' => 'formData', - 'schema' => [ - 'description' => '商品ID，最多支持256个字符。'."\n" - ."\n" - .'>一个商品可以有多张图片。根据实际情况自定义参数值。比如：上衣001号、裤子002号等。', - 'type' => 'string', - 'required' => true, - 'example' => '2092061_1', - ], + 'schema' => ['description' => '商品ID，最多支持256个字符。'."\n" + ."\n" + .'>一个商品可以有多张图片。根据实际情况自定义参数值。比如：上衣001号、裤子002号等。', 'type' => 'string', 'required' => true, 'example' => '2092061_1'], ], [ 'name' => 'PicName', 'in' => 'formData', - 'schema' => [ - 'description' => ' 图片名称，最多支持256个字符。'."\n" - .'> - ProductId和PicName唯一确定一张图片。'."\n" - .'- 如果多次添加图片具有相同的ProductId和PicName，以最后一次添加为准，前面添加的图片将被覆盖。'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'namexxx.jpg', - ], + 'schema' => ['description' => ' 图片名称，最多支持256个字符。'."\n" + .'> - ProductId和PicName唯一确定一张图片，且ProductId和PicName无法被修改。'."\n" + .'- 如果多次添加图片具有相同的ProductId和PicName，以最后一次添加为准，前面添加的图片将被覆盖。'."\n" + .'- 如果不填写PicName，则根据ProductId进行修改图片信息。'."\n" + .'- 如果填写PicName，则根据ProductId+PicName进行修改图片信息。'."\n" + ."\n\n", 'type' => 'string', 'required' => false, 'example' => 'namexxx.jpg'], ], [ 'name' => 'CustomContent', 'in' => 'formData', - 'schema' => [ - 'description' => '用户自定义的内容，最多支持4096个字符。'."\n" - .'>调用"<props="china">[根据图片查询图片](https://help.aliyun.com/document_detail/202282.html)</props><props="intl">[根据图片查询图片](https://www.alibabacloud.com/help/zh/image-search/latest/updateimage)</props>"接口时会返回该字段。例如可添加图片的描述等文本。'."\n" - ."\n\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zidingyi', - ], + 'schema' => ['description' => '用户自定义的内容，最多支持4096个字符。'."\n" + .'>调用"<props="china">[根据图片查询图片](https://help.aliyun.com/document_detail/202282.html)</props><props="intl">[根据图片查询图片](https://www.alibabacloud.com/help/zh/image-search/latest/updateimage)</props>"接口时会返回该字段。例如可添加图片的描述等文本。'."\n" + ."\n\n", 'type' => 'string', 'required' => false, 'example' => 'zidingyi'], ], [ 'name' => 'IntAttr', 'in' => 'formData', - 'schema' => [ - 'description' => '整数类型属性，可用于查询时过滤，查询时会返回该字段。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => '整数类型属性，可用于查询时过滤，查询时会返回该字段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], ], [ 'name' => 'StrAttr', 'in' => 'formData', - 'schema' => [ - 'description' => '字符串类型属性，最多支持128个字符。可用于查询时过滤，查询时会返回该字段。', - 'type' => 'string', - 'required' => false, - 'example' => 'ss', - ], + 'schema' => ['description' => '字符串类型属性，最多支持128个字符。可用于查询时过滤，查询时会返回该字段。', 'type' => 'string', 'required' => false, 'example' => 'ss'], ], [ 'name' => 'IntAttr2', 'in' => 'formData', - 'schema' => [ - 'description' => '整数类型属性，可用于查询时过滤，查询时会返回该字段。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '整数类型属性，可用于查询时过滤，查询时会返回该字段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ 'name' => 'StrAttr2', 'in' => 'formData', - 'schema' => [ - 'description' => '字符串类型属性，最多支持128个字符。可用于查询时过滤，查询时会返回该字段。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '字符串类型属性，最多支持128个字符。可用于查询时过滤，查询时会返回该字段。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ 'name' => 'IntAttr3', 'in' => 'query', - 'schema' => [ - 'description' => '整数类型属性，可用于查询时过滤，查询时会返回该字段。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '33', - ], + 'schema' => ['description' => '整数类型属性，可用于查询时过滤，查询时会返回该字段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '33'], ], [ 'name' => 'StrAttr3', 'in' => 'query', - 'schema' => [ - 'description' => '字符串类型属性，最多支持128个字符。可用于查询时过滤，查询时会返回该字段。', - 'type' => 'string', - 'required' => false, - 'example' => 'ss', - ], + 'schema' => ['description' => '字符串类型属性，最多支持128个字符。可用于查询时过滤，查询时会返回该字段。', 'type' => 'string', 'required' => false, 'example' => 'ss'], ], [ 'name' => 'IntAttr4', 'in' => 'query', - 'schema' => [ - 'description' => '整数类型属性，可用于查询时过滤，查询时会返回该字段。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '33', - ], + 'schema' => ['description' => '整数类型属性，可用于查询时过滤，查询时会返回该字段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '33'], ], [ 'name' => 'StrAttr4', 'in' => 'query', - 'schema' => [ - 'description' => '字符串类型属性，最多支持128个字符。可用于查询时过滤，查询时会返回该字段。', - 'type' => 'string', - 'required' => false, - 'example' => 'ss', - ], + 'schema' => ['description' => '字符串类型属性，最多支持128个字符。可用于查询时过滤，查询时会返回该字段。', 'type' => 'string', 'required' => false, 'example' => 'ss'], ], ], 'responses' => [ @@ -4264,253 +2502,76 @@ 'description' => '返回对象。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => 'Id of the request', - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E0845DE6-52AF-4B50-9F15-51ED4044E6AB', - ], - 'Code' => [ - 'description' => '错误码。'."\n" - ."\n" - .'- 0：成功。'."\n" - .'- 非0：失败。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Success' => [ - 'description' => '请求是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['title' => 'Id of the request', 'description' => '错误信息。', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E0845DE6-52AF-4B50-9F15-51ED4044E6AB'], + 'Code' => ['description' => '错误码。'."\n" + ."\n" + .'- 0：成功。'."\n" + .'- 非0：失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'BadRequest', - 'errorMessage' => 'The request has invalid parameters.', - ], - [ - 'errorCode' => 'InstanceStatusError', - 'errorMessage' => 'Your instance is unavailable.', - ], - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'NoCaretSeperator', - 'errorMessage' => 'The body content is missing the ^ separator.', - ], - [ - 'errorCode' => 'EmptyMeta', - 'errorMessage' => 'The body content has an empty meta field.', - ], - [ - 'errorCode' => 'InvalidMetaItem', - 'errorMessage' => 'The meta field is invalid.', - ], - [ - 'errorCode' => 'NoPicList', - 'errorMessage' => 'The body content is missing the pic_list parameter.', - ], - [ - 'errorCode' => 'InvalidPicList', - 'errorMessage' => 'The specified pic_list parameter is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedPic', - 'errorMessage' => 'The content of an image is not specified in the HTTP POST body.', - ], - [ - 'errorCode' => 'NoSpecifiedSearchPic', - 'errorMessage' => 'The search image is not specified.', - ], - [ - 'errorCode' => 'InvalidCategory', - 'errorMessage' => 'The specified category is invalid.', - ], - [ - 'errorCode' => 'OverflowMaxResultNum', - 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', - ], - [ - 'errorCode' => 'OverflowMaxReturnNum', - 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', - ], - [ - 'errorCode' => 'InvalidStartParameter', - 'errorMessage' => 'The specified parameter s is inavlid.', - ], - [ - 'errorCode' => 'InvalidNumParameter', - 'errorMessage' => 'The specified parameter n is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedAddPic', - 'errorMessage' => 'The image to insert is not specified.', - ], - [ - 'errorCode' => 'NoSpecifiedItemId', - 'errorMessage' => 'The item_id parameter is not specified.', - ], - [ - 'errorCode' => 'InvalidIntAttr', - 'errorMessage' => 'The specified int_attr field is invalid.', - ], - [ - 'errorCode' => 'UnsupportedPicFormat', - 'errorMessage' => 'The specified image format is invalid.', - ], - [ - 'errorCode' => 'InvalidFilterClause', - 'errorMessage' => 'The specified filtering condition is invalid.', - ], - [ - 'errorCode' => 'InstanceOverQuota', - 'errorMessage' => 'The number of items exceeds the limit.', - ], - [ - 'errorCode' => 'IncorrectOrientation', - 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', - ], - [ - 'errorCode' => 'UnsupportedPicPixels', - 'errorMessage' => 'The specified pixels is not supported.', - ], - [ - 'errorCode' => 'SearchTimeout', - 'errorMessage' => 'The request is timed out.', - ], - [ - 'errorCode' => 'PicNotExist', - 'errorMessage' => 'The search picture does not exist.', - ], - [ - 'errorCode' => 'NoSpecifiedProductId', - 'errorMessage' => 'The parameter ProductId no specified.', - ], - [ - 'errorCode' => 'NoSpecifiedPicName', - 'errorMessage' => 'The parameter PicName no specified.', - ], - [ - 'errorCode' => 'NoSpecifiedPicContent', - 'errorMessage' => 'The parameter PicContent no specified.', - ], - [ - 'errorCode' => 'InvalidType', - 'errorMessage' => 'The specified parameter Type is not valid.', - ], - [ - 'errorCode' => 'InvalidProductId', - 'errorMessage' => 'The specified parameter ProductId is not valid.', - ], - [ - 'errorCode' => 'InvalidPicName', - 'errorMessage' => 'The specified parameter PicName is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr', - 'errorMessage' => 'The specified parameter StrAttr is not valid.', - ], - [ - 'errorCode' => 'InvalidCustomContent', - 'errorMessage' => 'The specified parameter CustomContent is not valid.', - ], - [ - 'errorCode' => 'InvalidPicContent', - 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', - ], - [ - 'errorCode' => 'TimeoutForTransferImage', - 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', - ], - [ - 'errorCode' => 'InvalidIntAttr4', - 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr3', - 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr2', - 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr4', - 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr3', - 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr2', - 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', - ], - [ - 'errorCode' => 'UnsupportedInstanceType', - 'errorMessage' => 'The instance type is not supported.', - ], - [ - 'errorCode' => 'UnsupportedOperationType', - 'errorMessage' => 'The specified action is not supported.', - ], + ['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''], + ['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'], + ['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => '请求body缺少特定符号'], + ['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => '请求body含有空的字段'], + ['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => '无效的元信息字段'], + ['errorCode' => 'NoPicList', 'errorMessage' => 'The body content is missing the pic_list parameter.', 'description' => '未指定pic_list字段'], + ['errorCode' => 'InvalidPicList', 'errorMessage' => 'The specified pic_list parameter is invalid.', 'description' => '无效的pic_list字段'], + ['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'The content of an image is not specified in the HTTP POST body.', 'description' => '图片未指定'], + ['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''], + ['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => '无效的类目id'], + ['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => '超过了最大的返回结果限制数500'], + ['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => '单次返回数超过限制值100'], + ['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter s is inavlid.', 'description' => ''], + ['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter n is invalid.', 'description' => ''], + ['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''], + ['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => '无效的int过滤字段'], + ['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => '无效的图片格式'], + ['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => '无效的过滤条件'], + ['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => '实例的图片数量超过限制值'], + ['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => '图片包含不支持的旋转参数'], + ['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => '图片像素值不支持'], + ['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''], + ['errorCode' => 'PicNotExist', 'errorMessage' => 'The search picture does not exist.', 'description' => ''], + ['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'The parameter ProductId no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicName', 'errorMessage' => 'The parameter PicName no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''], + ['errorCode' => 'InvalidType', 'errorMessage' => 'The specified parameter Type is not valid.', 'description' => ''], + ['errorCode' => 'InvalidProductId', 'errorMessage' => 'The specified parameter ProductId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicName', 'errorMessage' => 'The specified parameter PicName is not valid.', 'description' => ''], + ['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => '无效StrAttr'], + ['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', 'description' => ''], + ['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''], + ['errorCode' => 'InvalidIntAttr4', 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', 'description' => '无效IntAttr4'], + ['errorCode' => 'InvalidIntAttr3', 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', 'description' => '无效IntAttr3'], + ['errorCode' => 'InvalidIntAttr2', 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', 'description' => '无效IntAttr2'], + ['errorCode' => 'InvalidStrAttr4', 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', 'description' => '无效StrAttr4'], + ['errorCode' => 'InvalidStrAttr3', 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', 'description' => '无效StrAttr3'], + ['errorCode' => 'InvalidStrAttr2', 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', 'description' => '无效StrAttr2'], + ['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => '内部错误：不支持的实例类型'], + ['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => '内部错误：不支持的action'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation.', - ], - [ - 'errorCode' => 'DeniedRequest', - 'errorMessage' => 'Your request was denied due to instance flow control.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => '未授权的行为'], + ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => '请求被限流'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal server error occurred.', - ], - [ - 'errorCode' => 'NetworkException', - 'errorMessage' => 'A network error occurred.', - ], - [ - 'errorCode' => 'RequestTimeout', - 'errorMessage' => 'The request is timeout.', - ], - [ - 'errorCode' => 'ExtractFeatureTimeout', - 'errorMessage' => 'The request was timed out while extracting features.', - ], - [ - 'errorCode' => 'AccessEngineFailed', - 'errorMessage' => 'An error occurred while accessing the search engine.', - ], - [ - 'errorCode' => 'InternalOssError', - 'errorMessage' => 'An internal OAS error occurred.', - ], - [ - 'errorCode' => 'InternalSwiftError', - 'errorMessage' => 'An internal SWIFT error occurred.', - ], - [ - 'errorCode' => 'InternalTableStoreError', - 'errorMessage' => 'An internal Table Store error occurred.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal server error occurred.', 'description' => ''], + ['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => '内部错误：请求网络异常'], + ['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''], + ['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''], + ['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''], + ['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => '内部错误：请求内部算法错误'], + ['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => '内部错误：请求内部消息队列错误'], + ['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => '内部错误：请求特征存储错误'], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"E0845DE6-52AF-4B50-9F15-51ED4044E6AB\\",\\n \\"Code\\": 0,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', @@ -4531,48 +2592,339 @@ ."\n\n", 'extraInfo' => '## 错误码'."\n" .'请参见[错误码](~~66619~~)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateImage'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imagesearch:UpdateImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], ], 'endpoints' => [ - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'imagesearch.cn-beijing.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'imagesearch.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'imagesearch.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'imagesearch.cn-shenzhen.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'imagesearch.cn-hongkong.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'imagesearch.ap-northeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'imagesearch.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-2', - 'endpoint' => 'imagesearch.ap-southeast-2.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'imagesearch.eu-central-1.aliyuncs.com', + ['regionId' => 'ap-northeast-1', 'regionName' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'imagesearch.ap-northeast-1.aliyuncs.com', 'endpoint' => 'imagesearch.ap-northeast-1.aliyuncs.com', 'vpc' => 'imagesearch-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'imagesearch.ap-southeast-1.aliyuncs.com', 'endpoint' => 'imagesearch.ap-southeast-1.aliyuncs.com', 'vpc' => 'imagesearch-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-2', 'regionName' => '澳大利亚（悉尼）已关停', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'imagesearch.ap-southeast-2.aliyuncs.com', 'endpoint' => 'imagesearch.ap-southeast-2.aliyuncs.com', 'vpc' => 'imagesearch-vpc.ap-southeast-2.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'imagesearch.cn-beijing.aliyuncs.com', 'endpoint' => 'imagesearch.cn-beijing.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'imagesearch.cn-hangzhou.aliyuncs.com', 'endpoint' => 'imagesearch.cn-hangzhou.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'imagesearch.cn-hongkong.aliyuncs.com', 'endpoint' => 'imagesearch.cn-hongkong.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'imagesearch.cn-shanghai.aliyuncs.com', 'endpoint' => 'imagesearch.cn-shanghai.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'imagesearch.cn-shenzhen.aliyuncs.com', 'endpoint' => 'imagesearch.cn-shenzhen.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'imagesearch.eu-central-1.aliyuncs.com', 'endpoint' => 'imagesearch.eu-central-1.aliyuncs.com', 'vpc' => 'imagesearch-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'ap-south-1', 'regionName' => '印度（孟买）已关停', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'imagesearch.ap-south-1.aliyuncs.com', 'endpoint' => 'imagesearch.ap-south-1.aliyuncs.com', 'vpc' => 'imagesearch-vpc.ap-south-1.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'AccessEngineFailed', 'message' => 'An error occurred while accessing the search engine.', 'http_code' => 400, 'description' => '内部错误：请求引擎失败'], + ['code' => 'ConnectionDVException', 'message' => 'Failed to obtain collection.', 'http_code' => 500, 'description' => 'internalError'], + ['code' => 'Console.BadRequest', 'message' => 'The request has invalid parameters.', 'http_code' => 400, 'description' => '非法请求，请检查请求参数。'], + ['code' => 'Console.CallServiceError', 'message' => 'An internal service error occurred.', 'http_code' => 500, 'description' => '访问内部服务错误'], + ['code' => 'Console.InstanceNotFound', 'message' => 'The specified ImageSearch instance is not found.', 'http_code' => 400, 'description' => '查找不到实例，检查购买的实例ID是否正确。'], + ['code' => 'Console.InstanceStatusError', 'message' => 'The current instance status does not support this operation.', 'http_code' => 409, 'description' => '实例状态错误，请检查实例状态'], + ['code' => 'Console.InternalError', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 500, 'description' => '服务器内部错误，请登录阿里云控制台提交工单。'], + ['code' => 'Console.LoginError', 'message' => 'Check login failed.', 'http_code' => 401, 'description' => '登录失败，请检查用户名、密码、邮箱是否输入有误。'], + ['code' => 'Console.MigrateCapacityError', 'message' => 'Migration instance specification error.', 'http_code' => 400, 'description' => '迁移的目标实例规格错误，目标实例规格必须大于等于源实例规格'], + ['code' => 'Console.MigrateDocNumError', 'message' => 'Migration target instance doc quantity error.', 'http_code' => 400, 'description' => '目标实例的doc数量必须为0'], + ['code' => 'Console.MigrateError', 'message' => 'An instance can only have one migration task.', 'http_code' => 400, 'description' => '实例只能存在一个迁移任务'], + ['code' => 'Console.MigrateExistError', 'message' => 'Only one migration task can exist in an instance.', 'http_code' => 400, 'description' => '当前实例下只能存在一个迁移任务。'], + ['code' => 'Console.MigrateTypeError', 'message' => 'Migration instance type error.', 'http_code' => 400, 'description' => '迁移的两个实例类型必须相同'], + ['code' => 'Console.ModifyTokenTimesExceed', 'message' => 'You can only modify the token once every day.', 'http_code' => 400, 'description' => '用户当天的修改次数不能超过1次'], + ['code' => 'Console.NoPermissionError', 'message' => 'You are not authorized to perform this operation.', 'http_code' => 403, 'description' => '你没有权限进行该操作'], + ['code' => 'Console.NotAllowedModifyToken', 'message' => 'You are not allowed to modify token today.', 'http_code' => 403, 'description' => '今天不允许用户修改该token值'], + ['code' => 'Console.OrderStatusError', 'message' => 'Current Order status not supported this opreate.', 'http_code' => 409, 'description' => '用户订单错误，请确认订单处于有效状态'], + ['code' => 'Console.PidDescError', 'message' => 'The maximum character length of this PidDesc parameter is 32.', 'http_code' => 400, 'description' => 'PidDesc 这个字符串长度最长32位'], + ['code' => 'Console.PidError', 'message' => 'The number of PID bindings of the current instance exceeds 50.', 'http_code' => 400, 'description' => '当前实例PID绑定数量超过50'], + ['code' => 'Console.TaskAlreadyExist', 'message' => 'A task that is in progress already exists.', 'http_code' => 409, 'description' => '已经存在正在运行的任务。'], + ['code' => 'DeniedRequest', 'message' => 'Your request was denied due to instance flow control.', 'http_code' => 403, 'description' => '请求被限流'], + ['code' => 'EmptyMeta', 'message' => 'The body content has an empty meta field.', 'http_code' => 400, 'description' => '请求body含有空的字段'], + ['code' => 'ExtractFeatureTimeout', 'message' => 'The request timed out while extracting features.', 'http_code' => 500, 'description' => '内部错误：提取特征超时'], + ['code' => 'IncorrectOrientation', 'message' => 'The image contains incorrect rotation flags in the meta data.', 'http_code' => 400, 'description' => '图片包含不支持的旋转参数'], + ['code' => 'InstanceOverQuota', 'message' => 'The number of items exceeds the limit.', 'http_code' => 400, 'description' => '实例的图片数量超过限制值'], + ['code' => 'InstanceStatusError', 'message' => 'The current instance status does not support this operation.', 'http_code' => 400, 'description' => '实例状态不可用'], + ['code' => 'InternalOssError', 'message' => 'An internal OAS error occurred.', 'http_code' => 500, 'description' => '内部错误：请求内部算法错误'], + ['code' => 'InternalSwiftError', 'message' => 'An internal SWIFT error occurred.', 'http_code' => 500, 'description' => '内部错误：请求内部消息队列错误'], + ['code' => 'InternalTableStoreError', 'message' => 'An internal Table Store error occurred.', 'http_code' => 500, 'description' => '内部错误：请求特征存储错误'], + ['code' => 'InvalidCategory', 'message' => 'The specified category is invalid.', 'http_code' => 400, 'description' => '无效的类目id'], + ['code' => 'InvalidCategoryId', 'message' => 'The specified CategoryId parameter is invalid.', 'http_code' => 400, 'description' => '无效CategoryId'], + ['code' => 'InvalidCrop', 'message' => 'The specified Crop parameter is invalid.', 'http_code' => 400, 'description' => '无效Crop'], + ['code' => 'InvalidCustomContent', 'message' => 'The specified CustomContent is invalid.', 'http_code' => 400, 'description' => '无效的自定义内容'], + ['code' => 'InvalidFilterClause', 'message' => 'The specified filtering condition is invalid.', 'http_code' => 400, 'description' => '无效的过滤条件'], + ['code' => 'InvalidInstance', 'message' => 'The specified instance name is invalid.', 'http_code' => 400, 'description' => '实例名错误'], + ['code' => 'InvalidIntAttr', 'message' => 'The specified int_attr field is invalid.', 'http_code' => 400, 'description' => '无效的int过滤字段'], + ['code' => 'InvalidIntAttr', 'message' => 'The specified parameter IntAttr is not valid.', 'http_code' => 400, 'description' => '无效IntAttr'], + ['code' => 'InvalidIntAttr2', 'message' => 'The specified parameter IntAttr2 is not valid.', 'http_code' => 400, 'description' => '无效IntAttr2'], + ['code' => 'InvalidIntAttr3', 'message' => 'The specified parameter IntAttr3 is not valid.', 'http_code' => 400, 'description' => '无效IntAttr3'], + ['code' => 'InvalidIntAttr4', 'message' => 'The specified parameter IntAttr4 is not valid.', 'http_code' => 400, 'description' => '无效IntAttr4'], + ['code' => 'InvalidMetaItem', 'message' => 'The meta field is invalid.', 'http_code' => 400, 'description' => '无效的元信息字段'], + ['code' => 'InvalidNum', 'message' => 'The specified Num parameter is invalid.', 'http_code' => 400, 'description' => '无效num'], + ['code' => 'InvalidNumParameter', 'message' => 'The specified parameter num is invalid.', 'http_code' => 400, 'description' => '无效的字段num'], + ['code' => 'InvalidParameterReturnPicFormat', 'message' => 'The specified parameter returnPicFormat is invalid', 'http_code' => 400, 'description' => '入参ReturnPicFormat错误，仅支持png或jpg'], + ['code' => 'InvalidParameterReturnPicType', 'message' => 'The specified parameter returnPicType is invalid', 'http_code' => 400, 'description' => '入参ReturnPicType错误，仅支持score_image或white_bk'], + ['code' => 'InvalidParameterTitleIndex', 'message' => 'The specified parameter titleIndex is invalid.', 'http_code' => 400, 'description' => '无效的titleIndex参数，仅支持1,2,3.'], + ['code' => 'InvalidPicContent', 'message' => 'The image size exceeds 4 MB.', 'http_code' => 400, 'description' => '图片大小超过4M'], + ['code' => 'InvalidPicList', 'message' => 'The specified pic_list parameter is invalid.', 'http_code' => 400, 'description' => '无效的pic_list字段'], + ['code' => 'InvalidPicName', 'message' => 'The specified PicName is invalid.', 'http_code' => 400, 'description' => '无效的图片名称'], + ['code' => 'InvalidPicUrl', 'message' => 'The specified parameter PicUrl is not valid.', 'http_code' => 400, 'description' => '无效的PicUrl参数'], + ['code' => 'InvalidPrimaryPicContent', 'message' => 'The specified parameter PrimaryPicContent is not valid.', 'http_code' => 400, 'description' => '无效的PrimaryPicContent参数'], + ['code' => 'InvalidProductId', 'message' => 'The specified ProductId is invalid.', 'http_code' => 400, 'description' => '无效的商品id'], + ['code' => 'InvalidProductId', 'message' => 'The parameter ProductId no specified.', 'http_code' => 400, 'description' => 'ProductId无效'], + ['code' => 'InvalidSecondaryPicContent', 'message' => 'The specified parameter SecondaryPicContent is not valid.', 'http_code' => 400, 'description' => '无效的SecondaryPicContent参数'], + ['code' => 'InvalidStart', 'message' => 'The specified Start parameter is invalid.', 'http_code' => 400, 'description' => '无效Start'], + ['code' => 'InvalidStartParameter', 'message' => 'The specified parameter start is invalid.', 'http_code' => 400, 'description' => '无效的字段start'], + ['code' => 'InvalidStrAttr', 'message' => 'The specified StrAttr is invalid.', 'http_code' => 400, 'description' => '无效的过滤值'], + ['code' => 'InvalidStrAttr', 'message' => 'The specified parameter StrAttr is not valid.', 'http_code' => 400, 'description' => '无效StrAttr'], + ['code' => 'InvalidStrAttr2', 'message' => 'The specified parameter StrAttr2 is not valid.', 'http_code' => 400, 'description' => '无效StrAttr2'], + ['code' => 'InvalidStrAttr3', 'message' => 'The specified parameter StrAttr3 is not valid.', 'http_code' => 400, 'description' => '无效StrAttr3'], + ['code' => 'InvalidStrAttr4', 'message' => 'The specified parameter StrAttr4 is not valid.', 'http_code' => 400, 'description' => '无效StrAttr4'], + ['code' => 'InvalidText', 'message' => 'The specified parameter Text is not valid.', 'http_code' => 400, 'description' => '描述信息Text不能为null'], + ['code' => 'InvalidTextLength', 'message' => 'Invalid text clause.', 'http_code' => 400, 'description' => 'text字段长度必须在512内。'], + ['code' => 'InvalidType', 'message' => 'The specified Type is invalid.', 'http_code' => 400, 'description' => '不支持的参数类型'], + ['code' => 'InvalidUserType', 'message' => 'The specified UserType parameter is invalid.', 'http_code' => 400, 'description' => '无效UserType'], + ['code' => 'NeedRegisterBeforeInvoke', 'message' => 'Register for PID before invoking the service.', 'http_code' => 400, 'description' => '调用前需要先注册pid'], + ['code' => 'NetworkException', 'message' => 'A network error occurred.', 'http_code' => 500, 'description' => '内部错误：请求网络异常'], + ['code' => 'NoCaretSeperator', 'message' => 'The body content is missing the ^ separator.', 'http_code' => 400, 'description' => '请求body缺少特定符号'], + ['code' => 'NoPermission', 'message' => 'You are not authorized to perform this operation.', 'http_code' => 403, 'description' => '未授权的行为'], + ['code' => 'NoPicList', 'message' => 'The body content is missing the pic_list parameter.', 'http_code' => 400, 'description' => '未指定pic_list字段'], + ['code' => 'NoSpecifiedAddPic', 'message' => 'You must specify an image.', 'http_code' => 400, 'description' => '未指定图片'], + ['code' => 'NoSpecifiedItemId', 'message' => 'You must specify item_id.', 'http_code' => 400, 'description' => '未指定商品id'], + ['code' => 'NoSpecifiedPic', 'message' => 'The content of an image is not specified in the HTTP POST body.', 'http_code' => 400, 'description' => '图片未指定'], + ['code' => 'NoSpecifiedPicContent', 'message' => 'You must specify PicContent.', 'http_code' => 400, 'description' => '未指定图片内容'], + ['code' => 'NoSpecifiedPicName', 'message' => 'You must specify PicName.', 'http_code' => 400, 'description' => '未指定图片名称'], + ['code' => 'NoSpecifiedProductId', 'message' => 'You must specify ProductId.', 'http_code' => 400, 'description' => '未指定商品id'], + ['code' => 'NoSpecifiedSearchPic', 'message' => 'You must specify a search image.', 'http_code' => 400, 'description' => '图片未指定'], + ['code' => 'OverflowMaxResultNum', 'message' => 'The specified number of total results exceeds the maximum of 500.', 'http_code' => 400, 'description' => '超过了最大的返回结果限制数500'], + ['code' => 'OverflowMaxReturnNum', 'message' => 'The specified number of results for each request exceeds the maximum of 100.', 'http_code' => 400, 'description' => '单次返回数超过限制值100'], + ['code' => 'PicNotExist', 'message' => 'The specified image does not exist.', 'http_code' => 400, 'description' => '图片未指定'], + ['code' => 'PictureError', 'message' => '[download] Img Download Failed.', 'http_code' => 500, 'description' => '图片下载失败，请检查图片'], + ['code' => 'PidNotExist', 'message' => 'The specified Pid parameter does not exist.', 'http_code' => 400, 'description' => 'Pid不存在'], + ['code' => 'RequestTimeout', 'message' => 'The request timed out.', 'http_code' => 500, 'description' => '内部错误：请求超时'], + ['code' => 'SearchTimeout', 'message' => 'The request timed out.', 'http_code' => 400, 'description' => '请求超时'], + ['code' => 'ServerInternalError', 'message' => 'An internal error occurred.', 'http_code' => 500, 'description' => '系统内部错误'], + ['code' => 'TimeoutForTransferImage', 'message' => 'Image transfer timed out.', 'http_code' => 400, 'description' => '客户端图片传输超时'], + ['code' => 'UnknownException', 'message' => 'An internal server error occurred.', 'http_code' => 500, 'description' => '未知异常'], + ['code' => 'UnsupportedInstanceType', 'message' => 'The instance type is not supported.', 'http_code' => 500, 'description' => '内部错误：不支持的实例类型'], + ['code' => 'UnsupportedOperationType', 'message' => 'The specified action is not supported.', 'http_code' => 500, 'description' => '内部错误：不支持的action'], + ['code' => 'UnsupportedPicCategory', 'message' => 'The picture category is not supported.', 'http_code' => 400, 'description' => '图片对应的类目不支持，目前仅支持鞋子和衣服'], + ['code' => 'UnsupportedPicFormat', 'message' => 'The specified image format is invalid.', 'http_code' => 400, 'description' => '无效的图片格式'], + ['code' => 'UnsupportedPicPixels', 'message' => 'The specified pixels is not supported.', 'http_code' => 400, 'description' => '图片像素值不支持'], + ['code' => 'UnsupportedPictureFormat', 'message' => 'The format of the specified picture is not supported.', 'http_code' => 400, 'description' => '用户图片格式不支持'], + ['code' => 'UnsupportedInstanceType', 'message' => 'The instance type is not supported.', 'http_code' => 400, 'description' => '内部错误：不支持的实例类型'], + ['code' => 'UnsupportedOperationType', 'message' => 'The specified action is not supported.', 'http_code' => 400, 'description' => '内部错误：不支持的action'], + ['code' => 'PictureError', 'message' => '[download] Img Download Failed.', 'http_code' => 400, 'description' => '图片下载失败，请检查图片'], + ['code' => 'Console.OssError', 'message' => 'OSS information error.', 'http_code' => 400, 'description' => 'oss 信息错误'], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateImage'], + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteImage'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchImageByPic'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchImageByName'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddImage'], ], - [ - 'regionId' => 'ap-south-1', - 'endpoint' => 'imagesearch.ap-south-1.aliyuncs.com', + ], + 'ram' => [ + 'productCode' => 'ImageSearch', + 'productName' => '图像搜索', + 'ramCodes' => ['imagesearch'], + 'ramLevel' => '资源级', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'SearchImageByPic', + 'description' => '根据图片查询图片', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imagesearch:SearchImageByPic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DumpMetaList', + 'description' => '查询元信息导出任务', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'imagesearch:DumpMetaList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SearchImageByText', + 'description' => '根据文本查询图片', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imagesearch:SearchImageByText', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddImage', + 'description' => '新增图片', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imagesearch:AddImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SearchImageByName', + 'description' => '根据名称查询图片', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imagesearch:SearchImageByName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SearchImageByFilter', + 'description' => '根据过滤条件查询图片', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imagesearch:SearchImageByFilter', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DumpMeta', + 'description' => '元数据导出', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'imagesearch:DumpMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateImage', + 'description' => '修改图片', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imagesearch:UpdateImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteImage', + 'description' => '删除图片', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imagesearch:DeleteImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CheckImageExists', + 'description' => '检查图片', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imagesearch:CheckImageExists', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'IncreaseInstance', + 'description' => '批量操作', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'imagesearch:IncreaseInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'Detail', + 'description' => '查询实例状态', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'imagesearch:Detail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'IncreaseList', + 'description' => '查询批量任务', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'imagesearch:IncreaseList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CompareSimilarByImage', + 'description' => '相似度比较', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imagesearch:CompareSimilarByImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'resourceTypes' => [], ], ]; |