From 7347bac4ab7e136157fc94777e6cf87ef9e08599 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Fri, 13 Feb 2026 10:54:11 +0800 Subject: first commit --- data/en_us/imagesearch/2019-03-25/api-docs.php | 1185 +++++++ data/en_us/imagesearch/2020-12-14/api-docs.php | 4329 ++++++++++++++++++++++++ data/en_us/imagesearch/2021-05-01/api-docs.php | 1553 +++++++++ 3 files changed, 7067 insertions(+) create mode 100644 data/en_us/imagesearch/2019-03-25/api-docs.php create mode 100644 data/en_us/imagesearch/2020-12-14/api-docs.php create mode 100644 data/en_us/imagesearch/2021-05-01/api-docs.php (limited to 'data/en_us/imagesearch') diff --git a/data/en_us/imagesearch/2019-03-25/api-docs.php b/data/en_us/imagesearch/2019-03-25/api-docs.php new file mode 100644 index 0000000..f3dba48 --- /dev/null +++ b/data/en_us/imagesearch/2019-03-25/api-docs.php @@ -0,0 +1,1185 @@ + '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'ImageSearch', + 'version' => '2019-03-25', + ], + 'directories' => [ + [ + 'id' => 64375, + 'title' => 'Search', + 'type' => 'directory', + 'children' => [ + 'SearchImage', + ], + ], + [ + 'id' => 64377, + 'title' => 'Management', + 'type' => 'directory', + 'children' => [ + 'AddImage', + 'DeleteImage', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'SearchImage' => [ + 'summary' => '检索图片', + 'path' => '/v2/image/search', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREimagesearchF4L5JA', + ], + ], + 'parameters' => [ + [ + 'name' => 'CategoryId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '88888888', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'phimagesearch', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pro-goods-25376', + ], + ], + [ + 'name' => 'PicName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'goods-23312-1', + ], + ], + [ + 'name' => 'PicContent', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'iVBORw0KGgoAAAANSUhEUgAAAV8AAADwAQMAAACdRvVNAAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAK7OHOkAAAADUExURQAAAKd6PdoAAAABdFJOUyR85Ty3AAAAIUlEQVRo3u3BAQ0AAADCoPdPbQ8HFAAAAAAAAAAAAADPBiowAAGR02EbAAAAAElFTkSuQmCC', + 'maxLength' => 6000000, + ], + ], + [ + 'name' => 'Crop', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Region', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '32,282,43,256', + ], + ], + [ + 'name' => 'Num', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Start', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'SearchByPic', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '(int_attr >= 100000000 AND int_attr < 200000000 AND int_attr=100000252 AND str_attr=\\"87\\")', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Msg' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + 'required' => false, + 'default' => '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' => '', + 'type' => 'string', + 'example' => '3033A0A7-36DA-5AC9-9973-953C38EBDFA9', + ], + 'Auctions' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PicName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2092061_1.jpg', + ], + 'IntAttr' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'CategoryId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8888888', + ], + 'ProductId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2092061_1', + ], + 'StrAttr' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ss', + ], + 'SortExprValues' => [ + 'description' => '', + 'type' => 'string', + 'example' => '5.37633353624177e+24;0', + ], + 'CustomContent' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'zidingyi', + ], + 'Score' => [ + 'type' => 'number', + 'format' => 'float', + ], + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PicInfo' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '', + 'type' => 'string', + 'example' => '94,691,206,650', + ], + 'CategoryId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '88888888', + ], + 'MultiRegion' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'type' => 'string', + ], + ], + ], + ], + 'AllCategories' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'other', + ], + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '88888888', + ], + ], + ], + ], + ], + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'BadRequest', + 'errorMessage' => 'The request has invalid parameters.', + ], + [ + '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.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation.', + ], + [ + 'errorCode' => 'DeniedRequest', + 'errorMessage' => 'Your request was denied due to instance flow control.', + ], + ], + 409 => [ + [ + 'errorCode' => 'InstanceStatusError', + 'errorMessage' => 'Your instance is unavailable.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownException', + 'errorMessage' => 'An internal server error occurred.', + ], + [ + 'errorCode' => 'NetworkException', + 'errorMessage' => 'A network error occurred.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => '​The request is timeout.', + ], + [ + 'errorCode' => 'UnsupportedInstanceType', + 'errorMessage' => 'The instance type is not supported.', + ], + [ + 'errorCode' => 'UnsupportedOperationType', + 'errorMessage' => 'The specified action is not supported.', + ], + [ + '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' => '[{"errorExample":"","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"Head\\": {\\n \\"DocsFound\\": 10,\\n \\"DocsReturn\\": 10000,\\n \\"SearchTime\\": 95\\n },\\n \\"RequestId\\": \\"3033A0A7-36DA-5AC9-9973-953C38EBDFA9\\",\\n \\"Auctions\\": [\\n {\\n \\"PicName\\": \\"2092061_1.jpg\\",\\n \\"IntAttr\\": 2,\\n \\"CategoryId\\": 8888888,\\n \\"ProductId\\": \\"2092061_1\\",\\n \\"StrAttr\\": \\"ss\\",\\n \\"SortExprValues\\": \\"5.37633353624177e+24;0\\",\\n \\"CustomContent\\": \\"zidingyi\\",\\n \\"Score\\": 0\\n }\\n ],\\n \\"Code\\": 0,\\n \\"PicInfo\\": {\\n \\"Region\\": \\"94,691,206,650\\",\\n \\"CategoryId\\": 88888888,\\n \\"MultiRegion\\": [\\n {\\n \\"Region\\": \\"\\"\\n }\\n ],\\n \\"AllCategories\\": [\\n {\\n \\"Name\\": \\"other\\",\\n \\"Id\\": 88888888\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'AddImage' => [ + 'summary' => '添加图片', + 'path' => '/v2/image/add', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREimagesearchAOOGRD', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'demoinstance1', + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '88888888', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2092061_1', + ], + ], + [ + 'name' => 'PicName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2092061_1.jpg', + ], + ], + [ + 'name' => 'PicContent', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=', + 'maxLength' => 6000000, + ], + ], + [ + 'name' => 'Crop', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Region', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '280,486,232,351', + ], + ], + [ + 'name' => 'CustomContent', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"merchant_id\\":\\"46-718f-da04-4099b2f144ae\\",\\"category_ids\\":[\\"1234\\"],\\"image_index\\":0,\\"updated\\":5678}', + ], + ], + [ + 'name' => 'IntAttr', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '22', + ], + ], + [ + 'name' => 'StrAttr', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ss', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'E0845DE6-52AF-4B50-9F15-51ED4044E6AB', + ], + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PicInfo' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '', + 'type' => 'string', + 'example' => '94,691,206,650', + ], + 'CategoryId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '88888888', + ], + ], + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'BadRequest', + 'errorMessage' => 'The request has invalid parameters.', + ], + [ + '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.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation.', + ], + [ + 'errorCode' => 'DeniedRequest', + 'errorMessage' => 'Your request was denied due to instance flow control.', + ], + ], + 409 => [ + [ + 'errorCode' => 'InstanceStatusError', + 'errorMessage' => 'Your instance is unavailable.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownException', + 'errorMessage' => 'An internal server error occurred.', + ], + [ + 'errorCode' => 'NetworkException', + 'errorMessage' => 'A network error occurred.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => '​The request is timeout.', + ], + [ + 'errorCode' => 'UnsupportedInstanceType', + 'errorMessage' => 'The instance type is not supported.', + ], + [ + 'errorCode' => 'UnsupportedOperationType', + 'errorMessage' => 'The specified action is not supported.', + ], + [ + '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' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DeleteImage' => [ + 'path' => '/v2/image/delete', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'demoinstance1', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '179443', + ], + ], + [ + 'name' => 'PicName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2092061_1.jpg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0703956F-9BCC-48FA-99F7-96C0BF449C69', + ], + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'BadRequest', + 'errorMessage' => 'The request has invalid parameters.', + ], + [ + '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.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation.', + ], + [ + 'errorCode' => 'DeniedRequest', + 'errorMessage' => 'Your request was denied due to instance flow control.', + ], + ], + 409 => [ + [ + 'errorCode' => 'InstanceStatusError', + 'errorMessage' => 'Your instance is unavailable.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'An internal server error occurred.', + ], + [ + 'errorCode' => 'NetworkException', + 'errorMessage' => 'A network error occurred.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => '​The request is timeout.', + ], + [ + 'errorCode' => 'UnsupportedInstanceType', + 'errorMessage' => 'The instance type is not supported.', + ], + [ + 'errorCode' => 'UnsupportedOperationType', + 'errorMessage' => 'The specified action is not supported.', + ], + [ + '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' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0703956F-9BCC-48FA-99F7-96C0BF449C69\\",\\n \\"Code\\": 0,\\n \\"Success\\": true\\n}","type":"json"}]', + ], + ], + '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-south-1', + 'endpoint' => 'imagesearch.ap-south-1.aliyuncs.com', + ], + ], +]; diff --git a/data/en_us/imagesearch/2020-12-14/api-docs.php b/data/en_us/imagesearch/2020-12-14/api-docs.php new file mode 100644 index 0000000..66342a0 --- /dev/null +++ b/data/en_us/imagesearch/2020-12-14/api-docs.php @@ -0,0 +1,4329 @@ + '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'ImageSearch', + 'version' => '2020-12-14', + ], + 'directories' => [ + [ + 'id' => 64363, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'AddImage', + 'DeleteImage', + ], + ], + [ + 'id' => 64366, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'SearchImageByName', + 'SearchImageByPic', + ], + ], + [ + 'id' => 208341, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CompareSimilarByImage', + 'Detail', + 'DumpMeta', + 'DumpMetaList', + 'IncreaseInstance', + 'IncreaseList', + 'SearchImageByText', + 'UpdateImage', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'AddImage' => [ + 'summary' => 'Adds an image to an Image Search instance.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREimagesearchAOOGRD', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the Image Search instance. The name can be up to 20 characters in length. If an Image Search instance is purchased, you can log on to the [Image Search console](https://imagesearch.console.aliyun.com/) to view the instance. If no Image Search instance is purchased, you must purchase an instance. For more information, see [Activate Image Search](~~179178~~) and [Create an instance](~~66569~~).'."\n" + ."\n" + .'> The instance name is not the instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'demoinstance1', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the product. The ID can be up to 512 characters in length.'."\n" + ."\n" + .'> A product may have multiple images.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2092061_1', + ], + ], + [ + 'name' => 'PicName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the image. The name can be up to 512 characters in length.'."\n" + ."\n" + .'> * An image is uniquely identified by the values of ProductId and PicName.'."\n" + .'>* If you add an image whose product ID (ProductId) and image name (PicName) are the same as those of an existing image, the newly added image overwrites the existing image.', + 'type' => 'string', + 'required' => true, + 'example' => '2092061_1.jpg', + ], + ], + [ + 'name' => 'PicContent', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The image file. The image file is encoded in Base64.'."\n" + ."\n" + .'* The file size of the image cannot exceed 4 MB.'."\n" + .'* The following image formats are supported: PNG, JPG, JPEG, BMP, GIF, WebP, TIFF, and PPM.'."\n" + .'* The transmission timeout period cannot exceed 5 seconds.'."\n" + .'* For product and generic image searches, the length and width of the image must range from 100 pixels to 4,096 pixels.'."\n" + .'* The image cannot contain rotation settings.'."\n" + ."\n" + .'> * If you use SDKs to call this operation, you do not need to specify **PicContent**. The SDKs encapsulate this parameter and automatically encode its value in Base64. For more information about how to use Image Search SDK for Java, see [Java SDK](~~179188~~).'."\n" + .'>* If you use OpenAPI Explorer to call this operation, you can select only the **2019-03-25** version. If you call this operation of other versions, the value of **PicContent** cannot be encoded in Base64.', + 'type' => 'string', + 'required' => true, + 'example' => 'AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=', + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The category of the image. For more information, see [Category reference](~~179184~~).'."\n" + ."\n" + .'> * For product image search, if you specify a category for an image, the specified category prevails. If you do not specify a category for an image, the system predicts the category, and returns the prediction result in the response.'."\n" + .'>* For generic image search, only 88888888 may be returned for this parameter in the response regardless of whether a category is specified.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '88888888', + ], + ], + [ + 'name' => 'Crop', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Specifies whether to identify the subject in the image and search for images based on the subject identification result. Default value: true. Valid values:'."\n" + ."\n" + .'* true: The system identifies the subject in the image, and searches for images based on the subject identification result. The subject identification result is included in the response.'."\n" + .'* false: The system does not identify the subject in the image, and searches for images based on the entire image.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Region', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The subject area of the image, in the format of `x1,x2,y1,y2`. `x1 and y1` represent the position in the upper-left corner, in pixels. `x2 and y2` represent the position in the lower-right corner, in pixels.'."\n" + ."\n" + .'> * If you specify Region, the system searches for images based on the value of Region regardless of the value of Crop.'."\n" + .'>* The value of Region does not have a unit. The value is generated based on the length and width of the image. If the length and width of the image are scaled, the value of Region must be proportionally adjusted.', + 'type' => 'string', + 'required' => false, + 'example' => '280,486,232,351', + ], + ], + [ + 'name' => 'CustomContent', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The user-defined content. The value can be up to 4,096 characters in length.'."\n" + ."\n" + .'> If you specify this parameter, the response includes this parameter and its value. You can add text such as an image description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zidingyi', + ], + ], + [ + 'name' => 'IntAttr', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The attribute, which is an integer. The attribute can be used to filter images when you search for images. If you specify this parameter, the response includes this parameter and its value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '22', + ], + ], + [ + 'name' => 'StrAttr', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The attribute, which is a string. The value can be up to 128 characters in length. The attribute can be used to filter images when you search for images. If you specify this parameter, the response includes this parameter and its value.'."\n" + ."\n" + .'> The value cannot contain the following special characters: \\ ¥ $ & %'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ss', + ], + ], + [ + 'name' => 'IntAttr2', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The attribute, which is an integer. The attribute can be used to filter images when you search for images. If you specify this parameter, the response includes this parameter and its value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '22', + ], + ], + [ + 'name' => 'StrAttr2', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The attribute, which is a string. The value can be up to 128 characters in length. The attribute can be used to filter images when you search for images. If you specify this parameter, the response includes this parameter and its value.'."\n" + ."\n" + .'> The value cannot contain the following special characters: \\ ¥ $ & %'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ss', + ], + ], + [ + 'name' => 'IntAttr3', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'StrAttr3', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'IntAttr4', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'StrAttr4', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The error message returned if the request failed.'."\n" + ."\n" + .'> No value is returned if the request was successful, and an error message is returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E0845DE6-52AF-4B50-9F15-51ED4044E6AB', + ], + 'Code' => [ + 'description' => 'The code returned.'."\n" + ."\n" + .'* A value of 0 indicates that the request was successful.'."\n" + .'* Values other than 0 indicate that the request failed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PicInfo' => [ + 'description' => 'The results of category prediction and subject identification.'."\n", + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => 'The result of subject identification. The subject area of the image is in the format of `x1,x2,y1,y2`. `x1 and y1` represent the position in the upper-left corner, in pixels. `x2 and y2` represent the position in the lower-right corner, in pixels. If a subject area is specified in the request, the specified subject area prevails.'."\n", + 'type' => 'string', + 'example' => '94,691,206,650', + ], + 'CategoryId' => [ + 'description' => 'The result of category prediction. If a category is specified in the request, the specified category prevails.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '88888888', + ], + ], + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + '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.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation.', + ], + [ + 'errorCode' => 'DeniedRequest', + 'errorMessage' => 'Your request was denied due to instance flow control.', + ], + ], + 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":""}]', + 'title' => 'AddImage', + 'description' => 'You can call this operation to add an image to an Image Search instance.'."\n" + ."\n" + .'> If you want to obtain more information about the service and technical support, click [Online Consulting](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) or join the DingTalk group (ID 35035130).'."\n" + ."\n" + .'## QPS limits'."\n" + ."\n" + .'By default, the concurrency limit for adding an image to instances whose image capacity specifications are 0.1 million images is 1. This means that the system can process up to one request of adding an image every second. By default, the concurrency limit for adding an image to instances of other image capacity specifications is 5. This means that the system can process up to five requests of adding an image every second.', + ], + 'DeleteImage' => [ + 'summary' => 'This topic describes the syntax of the DeleteImage operation and provides examples of this operation. You can call this operation to delete images from an Image Search instance.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREimagesearchIT4SIC', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the Image Search instance. The name can be up to 20 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'demoinstance1', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the commodity.'."\n" + ."\n" + .'> A commodity may have multiple images.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2092061_1', + ], + ], + [ + 'name' => 'PicName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the image.'."\n" + ."\n" + .'* If this parameter is not set, the system deletes all the images that correspond to the specified ProductId parameter.'."\n" + .'* If this parameter is set, the system deletes only the image that is specified by the ProductId and PicName parameters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2092061_1.jpg', + ], + ], + [ + 'name' => 'IsDeleteByFilter', + 'in' => 'formData', + 'schema' => [ + 'type' => 'boolean', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '0703956F-9BCC-48FA-99F7-96C0BF449C69', + ], + 'Code' => [ + 'description' => 'The error code returned.'."\n" + ."\n" + .'* A value of 0 indicates that the operation is successful.'."\n" + .'* Values other than 0 indicate errors.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The information about the deleted images.'."\n", + 'type' => 'object', + 'properties' => [ + 'PicNames' => [ + 'description' => 'The name (PicName) of the deleted image.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx.jpg', + ], + 'example' => '5555.jpg', + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation.', + ], + [ + 'errorCode' => 'DeniedRequest', + 'errorMessage' => 'Your request was denied due to instance flow control.', + ], + ], + 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":""}]', + 'description' => 'This operation deletes images from an Image Search instance.'."\n" + ."\n" + .'> A success response is returned even if the specified image does not exist on the instance. Therefore, you cannot determine whether the image exists on the instance based on the response.'."\n" + ."\n" + .'## QPS limits'."\n" + ."\n" + .'By default, the maximum number of queries supported by this operation is 20. In this case, the system can process at most 20 requests every second.', + ], + 'SearchImageByName' => [ + 'summary' => 'This topic describes the syntax of the SearchByName operation and provides examples of this operation. You can call this operation to search for images by image name on an Image Search instance.', + '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' => 'The name of the Image Search instance. The name can be up to 20 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'demoinstance1', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the product.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2092061_1', + 'isFileTransferUrl' => false, + ], + ], + [ + 'name' => 'PicName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the image.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2092061_1.jpg', + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The category of the product. For more information, see [Category references](~~179184~~).'."\n" + ."\n" + .'* For product search: If a category is specified, the specified category prevails. If no category is specified, the system estimates and selects a category. The category selected by the system is included in the response.'."\n" + .'* For generic search: The parameter value is set to 88888888 regardless of whether a category is specified.'."\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' => 'The number of images to return on each page. Valid values: 1 to 100. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Start', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The number of the image to return. Valid values: 0 to 499. Default value: 0.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '499', + 'exclusiveMaximum' => false, + 'minimum' => '0', + 'exclusiveMinimum' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The filter conditions. int_attr supports the following operators: >, >=, <, <=, and =. str_attr supports the following operators: = and !=. You can set the logical operator between conditions to AND or OR.'."\n" + ."\n" + .'Examples:'."\n" + ."\n" + .'* int_attr>=100'."\n" + .'* str_attr!="value1"'."\n" + .'* int_attr=1000 AND str_attr="value1"'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'int_attr>=100', + ], + ], + [ + 'name' => 'DistinctProductId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'boolean', + ], + ], + [ + 'name' => 'ScoreThreshold', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Msg' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Head' => [ + 'description' => 'The summary of the search result.'."\n", + 'type' => 'object', + 'properties' => [ + 'DocsFound' => [ + 'description' => 'The number of images returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'DocsReturn' => [ + 'description' => 'The number of images that match the search conditions on the Image Search instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'SearchTime' => [ + 'description' => 'The time it takes to complete the search process. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '95', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1', + ], + 'Auctions' => [ + 'description' => 'The product descriptions returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ProductId' => [ + 'description' => 'The ID of the product.'."\n", + 'type' => 'string', + 'example' => '2092061_1', + ], + 'PicName' => [ + 'description' => 'The name of the image.'."\n", + 'type' => 'string', + 'example' => '2092061_1.jpg', + ], + 'CategoryId' => [ + 'description' => 'The category of the image.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'SortExprValues' => [ + 'description' => 'The score information about the image.'."\n" + ."\n" + .'> * This parameter is not supported. We recommend that you use the Score parameter.'."\n" + .'>* The SortExprValues parameter indicates a 2-tuple in which values are separated by a semicolon (;). The first value indicates the correlation score of the returned image. A greater value indicates a higher correlation with the sample image. Different algorithms are used.'."\n" + .'>* If the value of CategoryId is within the value range from 0 to 2, the value range of SortExprValues is from 0 to 7.33136443711219e+24.'."\n" + .'>* If the value of CategoryId is not within the value range from 0 to 2, the value range of SortExprValues is from 0 to 5.37633353624177e+24. If the returned image is identical with the sample image, the highest correlation score is generated.', + 'type' => 'string', + 'example' => '5.37633353624177e+24;0', + ], + 'CustomContent' => [ + 'description' => 'The user-defined content.'."\n", + 'type' => 'string', + 'example' => 'zidingyi', + ], + 'Score' => [ + 'description' => 'The similarity score of the returned image. Valid values: 0 to 1.'."\n" + ."\n" + .'> To use this feature, you must upgrade the SDK to version 3.1.1.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'IntAttr' => [ + 'description' => 'The attribute, which is an integer.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'IntAttr2' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'StrAttr' => [ + 'description' => 'The attribute, which is a string.'."\n", + 'type' => 'string', + 'example' => 'ss', + ], + 'StrAttr2' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'StrAttr3' => [ + 'type' => 'string', + ], + 'StrAttr4' => [ + 'type' => 'string', + ], + 'IntAttr3' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'IntAttr4' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + 'Code' => [ + 'description' => 'The error code returned.'."\n" + ."\n" + .'* A value of 0 indicates that the operation is successful.'."\n" + .'* Values other than 0 indicate errors.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PicInfo' => [ + 'description' => 'The information such as the system-selected category and result of subject recognition.'."\n", + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => 'The result of subject recognition.'."\n" + ."\n" + .'The subject area of the image, in the format of x1,x2,y1,y2. Specifically, x1 and y1 specify the upper-left pixel, and x2 and y2 specify the lower-right pixel. If a subject area is specified in the request, the specified subject area prevails.'."\n", + 'type' => 'string', + 'example' => '280,486,232,351', + ], + 'CategoryId' => [ + 'description' => 'The category selected by the system.'."\n" + ."\n" + .'If a category is specified in the request, the specified category prevails.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'MultiRegion' => [ + 'description' => 'The recognized subjects.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => 'The result of subject recognition.'."\n" + ."\n" + .'The subject area of the image, in the format of x1,x2,y1,y2. Specifically, x1 and y1 specify the upper-left pixel, and x2 and y2 specify the lower-right pixel. If a subject area is specified in the request, the specified subject area prevails.'."\n", + 'type' => 'string', + 'example' => '280,486,232,351', + ], + ], + ], + ], + 'AllCategories' => [ + 'description' => 'The categories that are supported by the system.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the category.'."\n", + 'type' => 'string', + 'example' => '88888888', + ], + 'Id' => [ + 'description' => 'The ID of the category.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'other', + ], + ], + ], + ], + ], + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.', + '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 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.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation.', + ], + [ + 'errorCode' => 'DeniedRequest', + 'errorMessage' => 'Your request was denied due to instance flow control.', + ], + ], + 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.', + ], + ], + ], + '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":""}]', + 'description' => 'This operation searches for images by image name on an Image Search instance.'."\n" + ."\n" + .'## QPS limits'."\n" + ."\n" + .'The maximum number of queries per second is displayed in the Image Search console. The upper limit is specified when you purchase the instance. You can set the upper limit to 5 QPS or 10 QPS.', + ], + 'SearchImageByPic' => [ + 'summary' => 'This topic describes the syntax of the SearchByPic operation and provides examples of this operation. You can call this operation to search for images by image on an Image Search Instance.', + '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' => 'The name of the Image Search instance. The name can be up to 20 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'demoinstance1', + ], + ], + [ + 'name' => 'PicContent', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The image file. The image file is encoded in Base64.'."\n" + ."\n" + .'* The file size of the image cannot exceed 4 MB.'."\n" + .'* The following image formats are supported: PNG, JPG, JPEG, BMP, GIF, WebP, TIFF, and PPM.'."\n" + .'* The transmission timeout period cannot exceed 5 seconds.'."\n" + .'* For brand image searches, the length and the width of the image must range from 200 pixels to 4,096 pixels.'."\n" + .'* For cloth image searches, the length and the width of the image must range from 448 pixels to 4,096 pixels.'."\n" + .'* For product and generic image searches, the length and the width of the image must range from 100 pixels to 4,096 pixels.'."\n" + .'* The image cannot contain rotation settings.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=', + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The category of the product. For more information, see [Category references](~~179184~~).'."\n" + ."\n" + .'* For product search: If a category is specified, the specified category prevails. If no category is specified, the system estimates and selects a category. The category selected by the system is included in the response.'."\n" + .'* For generic search: The parameter value is set to 88888888 regardless of whether a category is specified.'."\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' => 'Specifies whether to recognize the subject in the image and search for images based on the recognized subject. Valid values: true and false. Default value: true.'."\n" + ."\n" + .'* true: The system recognizes the subject in the image, and searches for images based on the recognized subject. The recognition result is included in the response.'."\n" + .'* false: The system does not recognize the subject of the image, and searches for images based on the entire image.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Region', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The subject area of the image. Specify the subject area in the following format: `x1,x2,y1,y2`. `x1 and y1` represent the upper-left corner pixel. `x2 and y2` represent the lower-right corner pixel.'."\n" + ."\n" + .'>* If you set the Region parameter, the system searches for images based on the value of Region regardless of the value of the Crop parameter.', + 'type' => 'string', + 'required' => false, + 'example' => '280,486,232,351', + ], + ], + [ + 'name' => 'Num', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The number of images to return on each page. Valid values: 1 to 100. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Start', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The number of the image to return. Valid values: 0 to 499. Default value: 0.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '499', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The filter conditions. int_attr supports the following operators: >, >=, <, <=, and =. str_attr supports the following operators: = and !=. You can set the logical operator between conditions to AND or OR.'."\n" + ."\n" + .'Examples:'."\n" + ."\n" + .'* int_attr>=100'."\n" + .'* str_attr!="value1"'."\n" + .'* Example: int_attr=1000 AND str_attr="value1"'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'int_attr=1000 AND str_attr="value1"', + ], + ], + [ + 'name' => 'DistinctProductId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'boolean', + ], + ], + [ + 'name' => 'ScoreThreshold', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Msg' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Head' => [ + 'description' => 'The summary of the search result.'."\n", + 'type' => 'object', + 'properties' => [ + 'DocsFound' => [ + 'description' => 'The number of images returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'DocsReturn' => [ + 'description' => 'The number of images that match the search conditions on the Image Search instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'SearchTime' => [ + 'description' => 'The time it takes to complete the search process. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '95', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', + ], + 'Auctions' => [ + 'description' => 'The product descriptions returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ProductId' => [ + 'description' => 'The ID of the product.'."\n", + 'type' => 'string', + 'example' => '2092061_1', + ], + 'PicName' => [ + 'description' => 'The name of the image.'."\n", + 'type' => 'string', + 'example' => '2092061_1.jpg', + ], + 'CategoryId' => [ + 'description' => 'The category of the image.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8888888', + ], + 'SortExprValues' => [ + 'description' => 'The score information about the image.'."\n" + ."\n" + .'> * This parameter is not supported. We recommend that you use the Score parameter.'."\n" + .'>* The SortExprValues parameter indicates a 2-tuple in which values are separated by a semicolon (;). The first value indicates the correlation score of the returned image. A greater value indicates a higher correlation with the sample image. Different algorithms are used.'."\n" + .'>* If the value of CategoryId is within the value range from 0 to 2, the value range of SortExprValues is from 0 to 7.33136443711219e+24.'."\n" + .'>* If the value of CategoryId is not within the value range from 0 to 2, the value range of SortExprValues is from 0 to 5.37633353624177e+24. If the returned image is identical with the sample image, the highest correlation score is generated.', + 'type' => 'string', + 'example' => '5.37633353624177e+24;0', + ], + 'CustomContent' => [ + 'description' => 'The user-defined content.'."\n", + 'type' => 'string', + 'example' => 'zidingyi', + ], + 'Score' => [ + 'description' => 'The similarity score of the searched image. Valid values: 0 to 1.'."\n" + ."\n" + .'> To use this feature, you must upgrade the SDK to version 3.1.1.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'IntAttr' => [ + 'description' => 'The attribute, which is an integer.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'IntAttr2' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'StrAttr2' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'StrAttr' => [ + 'description' => 'The attribute, which is a string.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'StrAttr3' => [ + 'type' => 'string', + ], + 'StrAttr4' => [ + 'type' => 'string', + ], + 'IntAttr3' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'IntAttr4' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + 'Code' => [ + 'description' => 'The error code returned.'."\n" + ."\n" + .'* A value of 0 indicates that the operation is successful.'."\n" + .'* Values other than 0 indicate errors.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PicInfo' => [ + 'description' => 'The information such as the system-selected category and result of subject recognition.'."\n", + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => 'The result of subject recognition. The subject area of the image, in the format of x1,x2,y1,y2. Specifically, x1 and y1 specify the upper-left pixel, and x2 and y2 specify the lower-right pixel. If a subject area is specified in the request, the specified subject area prevails.'."\n", + 'type' => 'string', + 'example' => '280,486,232,351', + ], + 'CategoryId' => [ + 'description' => 'The category selected by the system. If a category is specified in the request, the specified category prevails.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '88888888', + ], + 'MultiRegion' => [ + 'description' => 'The recognized subjects.'."\n" + ."\n" + .'> To use this feature, you must upgrade the SDK to version 3.1.1.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => 'The result of subject recognition. The subject area of the image, in the format of x1,x2,y1,y2. Specifically, x1 and y1 specify the upper-left pixel, and x2 and y2 specify the lower-right pixel. If a subject area is specified in the request, the specified subject area prevails.'."\n", + 'type' => 'string', + 'example' => '280,486,232,351', + ], + ], + ], + ], + 'AllCategories' => [ + 'description' => 'The categories that are supported by the system.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the category.'."\n", + 'type' => 'string', + 'example' => 'other', + ], + 'Id' => [ + 'description' => 'The ID of the category.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '88888888', + ], + ], + ], + ], + ], + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.', + '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.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation.', + ], + [ + 'errorCode' => 'DeniedRequest', + 'errorMessage' => 'Your request was denied due to instance flow control.', + ], + ], + 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 \\"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":""}]', + 'description' => 'This operation searches for images by image name on an Image Search instance.'."\n" + ."\n" + .'## QPS limits'."\n" + ."\n" + .'The maximum number of queries per second is displayed in the Image Search console. The upper limit is specified when you purchase the instance. You can set the upper limit to 5 QPS or 10 QPS. '."\n" + ."\n\n" + .'## SDK release notes'."\n" + ."\n" + .'The Image Search SDK has been upgraded to version 3.1.1, which supports multi-subject recognition and similarity scores. For more information, see [Image Search SDK for Java](/help/en/image-search/latest/version-v3-java-sdk).', + ], + 'CompareSimilarByImage' => [ + 'summary' => '对比图片相似值', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREimagesearchAOOGRD', + ], + ], + 'parameters' => [ + [ + 'name' => 'PrimaryPicContent', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=', + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'SecondaryPicContent', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=', + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'demoinstance1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Score' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.85', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', + ], + 'Msg' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'AccessDeniedDetail' => [ + 'type' => 'object', + 'properties' => [ + 'AuthAction' => [ + 'type' => 'string', + ], + 'AuthPrincipalDisplayName' => [ + 'type' => 'string', + ], + 'AuthPrincipalOwnerId' => [ + 'type' => 'string', + ], + 'AuthPrincipalType' => [ + 'type' => 'string', + ], + 'EncodedDiagnosticMessage' => [ + 'type' => 'string', + ], + 'NoPermissionType' => [ + 'type' => 'string', + ], + 'PolicyType' => [ + 'type' => 'string', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'example' => '0', + 'format' => 'int32', + ], + ], + ], + ], + ], + '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":"\\n 0.85\\n true\\n B3137727-7D6E-488C-BA21-0E034C38A879\\n success\\n \\n xxx\\n 111\\n 222\\n SubUser\\n xxxxxx\\n ImplicitDeny\\n AccountLevelIdentityBasedPolicy\\n \\n 0\\n","errorExample":""}]', + ], + 'Detail' => [ + 'summary' => 'This topic describes the syntax of the Detail operation and provides examples of this operation. You can call this operation to query instance details.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'imagesearchName', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Instance' => [ + 'description' => 'The details about the instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'Capacity' => [ + 'description' => 'The capacity of the plan. Unit: × 10,000 images.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'UtcExpireTime' => [ + 'description' => 'The time when the instance expires. Unit: milliseconds.'."\n", + 'type' => 'string', + 'example' => '1623081600000', + ], + 'UtcCreate' => [ + 'description' => 'The time when the instance was created. Unit: milliseconds.'."\n", + 'type' => 'string', + 'example' => '1620382716000', + ], + 'ServiceType' => [ + 'description' => 'The Image Search model.'."\n" + ."\n" + .'0: commodity search. 1: generic image search.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Region' => [ + 'description' => 'The information about the region.'."\n", + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'Name' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => 'imagesearchName', + ], + 'TotalCount' => [ + 'description' => 'The number of images.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10063', + ], + 'Qps' => [ + 'description' => 'The number of queries per second supported by the plan.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + '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' => 'Console.LoginError', + 'errorMessage' => 'Check login failed.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Console.NoPermission', + 'errorMessage' => 'You are not authorized to this operation.', + ], + ], + 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.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Console.InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'errorCode' => 'Console.CallServiceError', + 'errorMessage' => 'Fail to call service.', + ], + ], + ], + '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":"\\n 36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1\\n true\\n \\n imagesearchName\\n 1623081600000\\n 10063\\n 1620382716000\\n 10\\n 1\\n 0\\n cn-shanghai\\n \\n","errorExample":""}]', + 'description' => 'This operation queries instance details.'."\n" + ."\n" + .'## QPS limits'."\n" + ."\n" + .'By default, the maximum number of queries supported by this operation is 1. In this case, the system can process only 1 request every second.', + ], + 'DumpMeta' => [ + 'summary' => 'This topic describes the syntax of the DumpMeta operation and provides examples of this operation. You can call this operation to create a task for exporting metadata from an Image Search instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'maximum' => '10000000', + 'minimum' => '1', + 'example' => 'imagesearchName', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The information about the export task.'."\n", + 'type' => 'object', + 'properties' => [ + 'DumpMetaStatus' => [ + 'description' => 'The status of the export task.'."\n" + ."\n" + .'* PROCESSING: in progress'."\n" + .'* FAIL: failed'."\n" + .'* SUCCESS: successful'."\n", + 'type' => 'string', + 'example' => 'PROCESSING', + ], + 'Id' => [ + 'description' => 'The ID of the export task.'."\n", + 'type' => 'string', + 'example' => '500', + ], + ], + ], + ], + ], + ], + ], + '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' => 'Console.LoginError', + 'errorMessage' => 'Check login failed.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Console.NoPermission', + 'errorMessage' => 'You are not authorized to this operation.', + ], + ], + 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.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Console.InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'errorCode' => 'Console.CallServiceError', + 'errorMessage' => 'An internal service error occurred.', + ], + ], + ], + '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":""}]', + 'description' => 'This operation creates a task for exporting metadata from an Image Search instance.'."\n" + ."\n" + .'## QPS limits'."\n" + ."\n" + .'By default, the maximum number of queries supported by this operation is 1. In this case, the system can process at most 1 request every second.', + ], + 'DumpMetaList' => [ + 'summary' => 'This topic describes the syntax of the DumpMetaList operation and provides examples of this operation. You can call this operation to query tasks that are used for exporting metadata from an Image Search instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Image Search instance. The name can be up to 20 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'maximum' => '10000000', + 'minimum' => '1', + 'example' => 'demoinstance1', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the export task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '500', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of images to return on each page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '500', + 'exclusiveMaximum' => true, + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '500', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', + ], + 'Data' => [ + 'description' => 'The information about the task that is used to export metadata.'."\n", + 'type' => 'object', + 'properties' => [ + 'DumpMetaList' => [ + 'description' => 'A list of tasks that are used to export metadata.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the export task.'."\n" + ."\n" + .'* PROCESSING: in progress'."\n" + .'* FAIL: failed'."\n" + .'* SUCCESS: successful'."\n", + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Msg' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'UtcModified' => [ + 'description' => 'The time when the task was updated. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1629095760000', + ], + 'MetaUrl' => [ + 'description' => 'The address where you can download the metadata. The address is valid for 2 hours.'."\n", + 'type' => 'string', + 'example' => 'https://imagesearchname.oss-cn-shanghai.aliyuncs.com/xxx', + ], + 'UtcCreate' => [ + 'description' => 'The time when the task was created. Unit: milliseconds.'."\n", + 'type' => 'string', + 'example' => '1629095713000', + ], + 'Code' => [ + 'description' => 'The error code returned.'."\n" + ."\n" + .'* A value of 0 indicates that the operation is successful.'."\n" + .'* Values other than 0 indicate errors.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Id' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '500', + ], + ], + ], + ], + 'PageSize' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of tasks.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + ], + ], + ], + ], + ], + ], + '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' => 'Console.LoginError', + 'errorMessage' => 'Check login failed.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Console.NoPermission', + 'errorMessage' => 'You are not authorized to this operation.', + ], + ], + 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.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Console.InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'errorCode' => 'Console.CallServiceError', + 'errorMessage' => 'An internal service error occurred.', + ], + ], + ], + '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":""}]', + 'description' => 'This operation queries tasks that are used for exporting metadata from an Image Search instance.'."\n" + ."\n" + .'## QPS limits'."\n" + ."\n" + .'By default, the maximum number of queries supported by this operation is 1. In this case, the system can process at most 1 request every second.', + ], + 'IncreaseInstance' => [ + 'summary' => 'This topic describes the syntax of the IncreaseInstance operation and provides examples of this operation. You can call this operation to create a batch task on an Image Search instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'imagesearchName', + ], + ], + [ + 'name' => 'BucketName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Object Storage Service (OSS) bucket.'."\n" + ."\n" + .'> The bucket must be in the same region as the Image Search instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'bucketName', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => 'The absolute path to the increment.meta file in the bucket. The path must start with a forward slash (/) and cannot end with a forward slash (/).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '/xxx/xxx', + ], + ], + [ + 'name' => 'CallbackAddress', + 'in' => 'query', + 'schema' => [ + 'description' => 'The callback address.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'http://xxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The information about the task.'."\n", + 'type' => 'object', + 'properties' => [ + 'IncrementStatus' => [ + 'description' => 'The status of the task.'."\n" + ."\n" + .'* PROCESSING: in progress'."\n" + .'* FAIL: failed'."\n" + .'* SUCCESS: successful'."\n", + 'type' => 'string', + 'example' => 'PROCESSING', + ], + 'Id' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'string', + 'example' => '500', + ], + ], + ], + ], + ], + ], + ], + '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' => 'Console.LoginError', + 'errorMessage' => 'Check login failed.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Console.NoPermission', + 'errorMessage' => 'You are not authorized to this operation.', + ], + ], + 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.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Console.InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'errorCode' => 'Console.CallServiceError', + 'errorMessage' => 'Fail to call service.', + ], + ], + ], + '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":""}]', + 'description' => 'This operation creates a batch task on an Image Search instance.'."\n" + ."\n" + .'## QPS limits'."\n" + ."\n" + .'By default, the maximum number of queries supported by this operation is 1. In this case, the system can process at most 1 request every second.', + ], + 'IncreaseList' => [ + 'summary' => 'This topic describes the syntax of the IncreaseList operation and provides examples of this operation. You can call this operation to query batch tasks on an Image Search instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Image Search instance. The name can be up to 20 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'demoinstance1', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the batch task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '500', + ], + ], + [ + 'name' => 'BucketName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Object Storage Service (OSS) bucket.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'bucketName', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => 'The absolute path to the increment.meta file in the bucket. The path must start with a forward slash (/) and cannot end with a forward slash (/).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/xxx/xxx', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of images to return on each page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '500', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '500', + 'exclusiveMaximum' => true, + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', + ], + 'Data' => [ + 'description' => 'The information about the batch task.'."\n", + 'type' => 'object', + 'properties' => [ + 'Increments' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Instance' => [ + 'description' => 'A list of batch tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Msg' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'sucess', + ], + 'Status' => [ + 'description' => 'The status of the batch task.'."\n" + ."\n" + .'* PROCESSING: in progress'."\n" + .'* FAIL: failed'."\n" + .'* SUCCESS: successful'."\n", + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'UtcModified' => [ + 'description' => 'The time when the task was updated. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1629095760000', + ], + 'BucketName' => [ + 'description' => 'The name of the Object Storage Service (OSS) bucket.'."\n", + 'type' => 'string', + 'example' => 'bucketName', + ], + 'UtcCreate' => [ + 'description' => 'The time when the task was created. Unit: milliseconds.'."\n", + 'type' => 'string', + 'example' => '1629095713000', + ], + 'Code' => [ + 'description' => 'The error code returned.'."\n" + ."\n" + .'* A value of 0 indicates that the operation is successful.'."\n" + .'* Values other than 0 indicate errors.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Path' => [ + 'description' => 'The absolute path to the increment.meta file in the bucket. The path must start with a forward slash (/) and cannot end with a forward slash (/).'."\n", + 'type' => 'string', + 'example' => '/xx/xx', + ], + 'ErrorUrl' => [ + 'description' => 'The address where you can download the result. The address is valid for 2 hours.'."\n", + 'type' => 'string', + 'example' => 'https://imagesearchname.oss-cn-shanghai.aliyuncs.com/xxx', + ], + 'Id' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '500', + ], + 'CallbackAddress' => [ + 'description' => 'The callback address.'."\n", + 'type' => 'string', + 'example' => 'http://xxxxx', + ], + ], + ], + ], + ], + ], + 'PageSize' => [ + 'description' => 'The number of entries to return on each page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of tasks.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + ], + ], + ], + ], + ], + ], + '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' => 'Console.LoginError', + 'errorMessage' => 'Check login failed.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Console.NoPermission', + 'errorMessage' => 'You are not authorized to this operation.', + ], + ], + 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.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Console.InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'errorCode' => 'Console.CallServiceError', + 'errorMessage' => 'Fail to call service.', + ], + ], + ], + '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":""}]', + 'description' => 'This operation queries batch tasks on an Image Search instance.'."\n" + ."\n" + .'## QPS limits'."\n" + ."\n" + .'By default, the maximum number of queries supported by this operation is 1. In this case, the system can process at most 1 request every second.', + ], + 'SearchImageByText' => [ + 'summary' => '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' => '', + 'example' => 'demoinstance1', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'Num', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'example' => '10', + 'format' => 'int32', + 'maximum' => '100', + 'minimum' => '1', + 'required' => false, + 'type' => 'integer', + 'default' => '10', + ], + ], + [ + 'name' => 'Start', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'example' => '0', + 'format' => 'int32', + 'maximum' => '499', + 'minimum' => '0', + 'required' => false, + 'type' => 'integer', + 'default' => '0', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'example' => 'int_attr=1000 AND str_attr="value1"', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'DistinctProductId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'example' => 'false', + 'required' => false, + 'type' => 'boolean', + ], + ], + [ + 'name' => 'Text', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'example' => 'xxxx', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'ScoreThreshold', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'properties' => [ + 'Msg' => [ + 'description' => '', + 'example' => 'success', + 'type' => 'string', + ], + 'Head' => [ + 'description' => '', + 'properties' => [ + 'DocsFound' => [ + 'description' => '', + 'example' => '10', + 'format' => 'int32', + 'type' => 'integer', + ], + 'DocsReturn' => [ + 'description' => '', + 'example' => '10000', + 'format' => 'int32', + 'type' => 'integer', + ], + 'SearchTime' => [ + 'description' => '', + 'example' => '95', + 'format' => 'int32', + 'type' => 'integer', + ], + ], + 'type' => 'object', + ], + 'RequestId' => [ + 'description' => '', + 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', + 'type' => 'string', + ], + 'Auctions' => [ + 'description' => '', + 'items' => [ + 'description' => '', + 'properties' => [ + 'ProductId' => [ + 'description' => '', + 'example' => '2092061_1', + 'type' => 'string', + ], + 'PicName' => [ + 'description' => '', + 'example' => '2092061_1.jpg', + 'type' => 'string', + ], + 'CategoryId' => [ + 'description' => '', + 'example' => '8888888', + 'format' => 'int32', + 'type' => 'integer', + ], + 'CustomContent' => [ + 'description' => '', + 'example' => 'zidingyi', + 'type' => 'string', + ], + 'Score' => [ + 'description' => '', + 'example' => '1', + 'format' => 'float', + 'type' => 'number', + ], + 'IntAttr' => [ + 'description' => '', + 'example' => '2', + 'format' => 'int32', + 'type' => 'integer', + ], + 'IntAttr2' => [ + 'description' => '', + 'example' => '2', + 'format' => 'int32', + 'type' => 'integer', + ], + 'StrAttr2' => [ + 'description' => '', + 'example' => 'xxxx', + 'type' => 'string', + ], + 'StrAttr' => [ + 'description' => '', + 'example' => 'xxxx', + 'type' => 'string', + ], + 'StrAttr3' => [ + 'description' => '', + 'example' => 'xxxx', + 'type' => 'string', + ], + 'StrAttr4' => [ + 'description' => '', + 'example' => 'xxxx', + 'type' => 'string', + ], + 'IntAttr3' => [ + 'description' => '', + 'example' => '2', + 'format' => 'int32', + 'type' => 'integer', + ], + 'IntAttr4' => [ + 'description' => '', + 'example' => '2', + 'format' => 'int32', + 'type' => 'integer', + ], + ], + 'type' => 'object', + ], + 'type' => 'array', + ], + 'Code' => [ + 'description' => '', + 'example' => '0', + 'format' => 'int32', + 'type' => 'integer', + ], + 'PicInfo' => [ + 'description' => '', + 'properties' => [ + 'AllCategories' => [ + 'description' => '', + 'items' => [ + 'description' => '', + 'properties' => [ + 'Name' => [ + 'description' => '', + 'example' => 'other', + 'type' => 'string', + ], + 'Id' => [ + 'description' => '', + 'example' => '88888888', + 'format' => 'int32', + 'type' => 'integer', + ], + ], + 'type' => 'object', + ], + 'type' => 'array', + ], + ], + 'type' => 'object', + ], + 'Success' => [ + 'description' => '', + 'example' => 'true', + 'type' => 'boolean', + ], + 'AccessDeniedDetail' => [ + 'description' => '', + 'properties' => [ + 'AuthAction' => [ + 'description' => '', + 'example' => 'xxx', + 'type' => 'string', + ], + 'AuthPrincipalDisplayName' => [ + 'description' => '', + 'example' => '111', + 'type' => 'string', + ], + 'AuthPrincipalOwnerId' => [ + 'description' => '', + 'example' => '222', + 'type' => 'string', + ], + 'AuthPrincipalType' => [ + 'description' => '', + 'example' => 'SubUser', + 'type' => 'string', + ], + 'EncodedDiagnosticMessage' => [ + 'description' => '', + 'example' => 'xxxxxx', + 'type' => 'string', + ], + 'NoPermissionType' => [ + 'description' => '', + 'example' => 'ImplicitDeny', + 'type' => 'string', + ], + 'PolicyType' => [ + 'description' => '', + 'example' => 'PauseNotify', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + 'type' => 'object', + ], + ], + ], + '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.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation.', + ], + [ + 'errorCode' => 'DeniedRequest', + 'errorMessage' => 'Your request was denied due to instance flow control.', + ], + ], + 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":"\\n success\\n \\n 10\\n 10000\\n 95\\n \\n B3137727-7D6E-488C-BA21-0E034C38A879\\n \\n 2092061_1\\n 2092061_1.jpg\\n 8888888\\n zidingyi\\n 1\\n 2\\n 2\\n xxxx\\n xxxx\\n xxxx\\n xxxx\\n 2\\n 2\\n \\n 0\\n \\n \\n other\\n 88888888\\n \\n \\n true\\n","errorExample":""}]', + ], + 'UpdateImage' => [ + 'summary' => 'This topic describes the syntax of the UpdateImage operation and provides examples of this operation. You can call this operation to update image information on an Image Search instance.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREimagesearchAA7PKJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the Image Search instance. The name can be up to 20 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'demoinstance1', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the product. The ID can be up to 512 characters in length.'."\n" + ."\n" + .'> A product may have multiple images.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2092061_1', + ], + ], + [ + 'name' => 'PicName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the image. The name can be up to 512 characters in length.'."\n" + ."\n" + .'> * An image is uniquely identified by the values of the ProductId and PicName parameters.'."\n" + .'>* If you add an image whose product ID (ProductId) and image name (PicName) are the same as those of an existing image, the newly added image overwrites the existing image.', + 'type' => 'string', + 'required' => true, + 'example' => 'namexxx.jpg', + ], + ], + [ + 'name' => 'CustomContent', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The user-defined content. The value can be up to 4,096 characters in length.'."\n" + ."\n" + .'> If you set this parameter, the response includes this parameter and its value. You can add text such as an image description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zidingyi', + ], + ], + [ + 'name' => 'IntAttr', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The attribute, which is an integer. The attribute can be used to filter images when you search for images. If you set this parameter, the response includes this parameter and its value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'StrAttr', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The attribute, which is a string. The value can be up to 128 characters in length. The attribute can be used to filter images. If you set this parameter, the response includes this parameter and its value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ss', + ], + ], + [ + 'name' => 'IntAttr2', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'StrAttr2', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'IntAttr3', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'StrAttr3', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'IntAttr4', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'StrAttr4', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E0845DE6-52AF-4B50-9F15-51ED4044E6AB', + ], + 'Code' => [ + 'description' => 'The error code returned.'."\n" + ."\n" + .'* A value of 0 indicates that the operation is successful.'."\n" + .'* Values other than 0 indicate errors.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + '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.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation.', + ], + [ + 'errorCode' => 'DeniedRequest', + 'errorMessage' => 'Your request was denied due to instance flow control.', + ], + ], + 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.', + ], + ], + ], + '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":""}]', + 'description' => 'This operation updates image information on an Image Search instance.'."\n" + ."\n" + .'> * Limits are imposed on the instance creation time.'."\n" + .'>* This operation is supported by instances that are created in the Singapore (Singapore) region after December 2021. This operation is not supported in other regions.'."\n" + ."\n" + .'## QPS limits'."\n" + ."\n" + .'By default, the maximum number of queries supported by this operation is 20. In this case, the system can process at most 20 requests every second.', + ], + ], + '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-south-1', + 'endpoint' => 'imagesearch.ap-south-1.aliyuncs.com', + ], + ], +]; diff --git a/data/en_us/imagesearch/2021-05-01/api-docs.php b/data/en_us/imagesearch/2021-05-01/api-docs.php new file mode 100644 index 0000000..2375671 --- /dev/null +++ b/data/en_us/imagesearch/2021-05-01/api-docs.php @@ -0,0 +1,1553 @@ + '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'ImageSearch', + 'version' => '2021-05-01', + ], + 'directories' => [ + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'SearchByUrl', + 'SearchByPic', + 'GetProductInfoByIds', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'SearchByUrl' => [ + 'summary' => '使用Url进行搜索', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PicUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'https://oss-test.oss-cn-shanghai.aliyuncs.com/xxxx.jpg', + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + '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' => 'Pid', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mm_xxx_xxx_xxx', + ], + ], + [ + 'name' => 'UserType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + [ + 'name' => 'Crop', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Region', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '280,486,232,351', + ], + ], + [ + 'name' => 'Start', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '499', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'Num', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '20', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Fields', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Url,UserType', + ], + ], + [ + 'name' => 'RelationId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1125526', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Auctions' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ItemId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'Title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ShortTitle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'SubTitle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'PicUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '//img.alicdn.com/i1/FXXXXXXXXXX.jpg', + ], + 'ReservePrice' => [ + 'description' => '', + 'type' => 'string', + 'example' => '158', + ], + 'ZkFinalPrice' => [ + 'description' => '', + 'type' => 'string', + 'example' => '98', + ], + 'PriceAfterCoupon' => [ + 'description' => '', + 'type' => 'string', + 'example' => '90', + ], + 'UserType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Provcity' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Nick' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'SellerId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '32590610', + ], + 'Volume' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'LevelOneCategoryName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CategoryName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CouponTotalCount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '100000', + ], + 'CouponRemainCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CouponStartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-05-01', + ], + 'CouponEndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-06-01', + ], + 'CouponStartFee' => [ + 'description' => '', + 'type' => 'string', + 'example' => '98.000000', + ], + 'CouponAmount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'CouponInfo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CommissionRate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '180', + ], + 'CouponShareUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '//uland.taobao.com/cxxxxxx', + ], + 'DeeplinkCouponShareUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tbopen://m.taobao.com/tbopen/index.html?', + ], + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'example' => '//s.click.taobao.com/t?xxxxxx', + ], + 'DeeplinkUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tbopen://m.taobao.com/tbopen/index.html?', + ], + 'ShopTitle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'MaxCommission' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MaxCommissionRate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '20.4', + ], + 'MaxCommissionClickUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://s.click.taobao.com/t?e=xxxx', + ], + 'MaxCommissionCouponShareUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://s.click.taobao.com/t?e=xxxx', + ], + ], + ], + ], + ], + 'RankScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.337', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', + ], + 'PicInfo' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MainRegion' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '', + 'type' => 'string', + 'example' => '280,486,232,351', + ], + 'MultiCategoryId' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CategoryId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '88888888', + ], + 'Score' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.34', + ], + ], + ], + ], + ], + ], + 'MultiRegion' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '', + 'type' => 'string', + 'example' => '280,486,232,351', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'PidNotExist', + 'errorMessage' => 'The parameter specified Pid not exist', + ], + [ + 'errorCode' => 'InvalidPid', + 'errorMessage' => 'The parameter Pid no specified', + ], + [ + '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' => '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' => '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' => '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' => 'NoSpecifiedPicContent', + 'errorMessage' => 'The parameter PicContent no specified.', + ], + [ + '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 specified parameter PicUrl is not valid.', + ], + [ + 'errorCode' => 'NotRegisterBeforeInvoke', + 'errorMessage' => 'Need register token: pid before invoke.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation.', + ], + [ + 'errorCode' => 'DeniedRequest', + 'errorMessage' => 'Your request was denied due to instance flow control.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownException', + 'errorMessage' => 'An internal server error occurred.', + ], + [ + 'errorCode' => 'NetworkException', + 'errorMessage' => 'A network error occurred.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => '​The request is timeout.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Auctions\\": [\\n {\\n \\"Result\\": {\\n \\"ItemId\\": \\"0gkRpWudf8Qk6G0AqU6NZH2t6-4asdasdaszxczxpz\\",\\n \\"Title\\": \\"xxx套装\\",\\n \\"ShortTitle\\": \\"yyy套装\\",\\n \\"SubTitle\\": \\"xxx套装\\",\\n \\"PicUrl\\": \\"//img.alicdn.com/i1/FXXXXXXXXXX.jpg\\",\\n \\"ReservePrice\\": \\"158\\",\\n \\"ZkFinalPrice\\": \\"98\\",\\n \\"PriceAfterCoupon\\": \\"90\\",\\n \\"UserType\\": 0,\\n \\"Provcity\\": \\"广东 深圳\\",\\n \\"Nick\\": \\"衣服专卖店\\",\\n \\"SellerId\\": \\"32590610\\",\\n \\"Volume\\": 500,\\n \\"LevelOneCategoryName\\": \\"童装/婴儿装/亲子装\\",\\n \\"CategoryName\\": \\"连衣裙\\",\\n \\"CouponTotalCount\\": \\"100000\\",\\n \\"CouponRemainCount\\": 0,\\n \\"CouponStartTime\\": \\"2021-05-01\\",\\n \\"CouponEndTime\\": \\"2021-06-01\\",\\n \\"CouponStartFee\\": \\"98.000000\\",\\n \\"CouponAmount\\": 5,\\n \\"CouponInfo\\": \\"满98.0元减5.0元\\",\\n \\"CommissionRate\\": \\"180\\",\\n \\"CouponShareUrl\\": \\"//uland.taobao.com/cxxxxxx\\",\\n \\"DeeplinkCouponShareUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"Url\\": \\"//s.click.taobao.com/t?xxxxxx\\",\\n \\"DeeplinkUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"ShopTitle\\": \\"xx旗舰店\\",\\n \\"MaxCommission\\": {\\n \\"MaxCommissionRate\\": \\"20.4\\",\\n \\"MaxCommissionClickUrl\\": \\"https://s.click.taobao.com/t?e=xxxx\\",\\n \\"MaxCommissionCouponShareUrl\\": \\"https://s.click.taobao.com/t?e=xxxx\\"\\n }\\n },\\n \\"RankScore\\": 0.337\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"PicInfo\\": {\\n \\"MainRegion\\": {\\n \\"Region\\": \\"280,486,232,351\\",\\n \\"MultiCategoryId\\": [\\n {\\n \\"CategoryId\\": 88888888,\\n \\"Score\\": 0.34\\n }\\n ]\\n },\\n \\"MultiRegion\\": [\\n {\\n \\"Region\\": \\"280,486,232,351\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'SearchByPic' => [ + 'summary' => '使用图片进行搜索', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PicContent', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'xxx', + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + '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' => 'Pid', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mm_xxx_xxx_xxx', + ], + ], + [ + 'name' => 'UserType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + [ + 'name' => 'Crop', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Region', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '280,486,232,351', + ], + ], + [ + 'name' => 'Start', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '499', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'Num', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '20', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Fields', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Url,UserType', + ], + ], + [ + 'name' => 'RelationId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1125526', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'sucess', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Auctions' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ItemId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'Title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ShortTitle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'SubTitle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'PicUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '//img.alicdn.com/i1/FXXXXXXXXXX.jpg', + ], + 'ReservePrice' => [ + 'description' => '', + 'type' => 'string', + 'example' => '158', + ], + 'ZkFinalPrice' => [ + 'description' => '', + 'type' => 'string', + 'example' => '98', + ], + 'PriceAfterCoupon' => [ + 'description' => '', + 'type' => 'string', + 'example' => '90', + ], + 'UserType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Provcity' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Nick' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'SellerId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '32590610', + ], + 'Volume' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'LevelOneCategoryName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CategoryName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CouponTotalCount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '100000', + ], + 'CouponRemainCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CouponStartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-05-01', + ], + 'CouponEndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-06-01', + ], + 'CouponStartFee' => [ + 'description' => '', + 'type' => 'string', + 'example' => '98.000000', + ], + 'CouponAmount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'CouponInfo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CommissionRate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '180', + ], + 'CouponShareUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '//uland.taobao.com/xxxxxxx', + ], + 'DeeplinkCouponShareUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tbopen://m.taobao.com/tbopen/index.html?', + ], + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'example' => '//s.click.taobao.com/t?xxxxxx', + ], + 'DeeplinkUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tbopen://m.taobao.com/tbopen/index.html?', + ], + 'ShopTitle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'MaxCommission' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MaxCommissionRate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '20.4', + ], + 'MaxCommissionClickUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://s.click.taobao.com/t?e=xxxx', + ], + 'MaxCommissionCouponShareUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://uland.taobao.com/coupon/xxxx', + ], + ], + ], + ], + ], + 'RankScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.337', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', + ], + 'PicInfo' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MainRegion' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '', + 'type' => 'string', + 'example' => '280,486,232,351', + ], + 'MultiCategoryId' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CategoryId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '88888888', + ], + 'Score' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.34', + ], + ], + ], + ], + ], + ], + 'MultiRegion' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '', + 'type' => 'string', + 'example' => '280,486,232,351', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPicContent', + 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', + ], + [ + 'errorCode' => 'InvalidPid', + 'errorMessage' => 'The parameter Pid no specified', + ], + [ + 'errorCode' => 'BadRequest', + 'errorMessage' => 'The request has invalid parameters.', + ], + [ + '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' => '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' => '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' => 'NoSpecifiedPicContent', + 'errorMessage' => 'The parameter PicContent no specified.', + ], + [ + 'errorCode' => 'InvalidCustomContent', + 'errorMessage' => 'The specified parameter CustomContent is not valid.', + ], + [ + 'errorCode' => 'NotRegisterBeforeInvoke', + 'errorMessage' => 'Need register token: pid before invoke.', + ], + ], + 403 => [ + [ + 'errorCode' => 'DeniedRequest', + 'errorMessage' => 'Your request was denied due to instance flow control.', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownException', + 'errorMessage' => 'An internal server error occurred.', + ], + [ + 'errorCode' => 'NetworkException', + 'errorMessage' => 'A network error occurred.', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'An internal server error occurred.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => '​The request is timeout.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"Code\\": 0,\\n \\"Message\\": \\"sucess\\",\\n \\"Data\\": {\\n \\"Auctions\\": [\\n {\\n \\"Result\\": {\\n \\"ItemId\\": \\"casdcascascasc-dsasdasdasdasdas\\",\\n \\"Title\\": \\"xxx套装\\",\\n \\"ShortTitle\\": \\"yyy套装\\",\\n \\"SubTitle\\": \\"xxx套装\\",\\n \\"PicUrl\\": \\"//img.alicdn.com/i1/FXXXXXXXXXX.jpg\\",\\n \\"ReservePrice\\": \\"158\\",\\n \\"ZkFinalPrice\\": \\"98\\",\\n \\"PriceAfterCoupon\\": \\"90\\",\\n \\"UserType\\": 0,\\n \\"Provcity\\": \\"广东 深圳\\",\\n \\"Nick\\": \\"衣服专卖店\\",\\n \\"SellerId\\": \\"32590610\\",\\n \\"Volume\\": 500,\\n \\"LevelOneCategoryName\\": \\"童装/婴儿装/亲子装\\",\\n \\"CategoryName\\": \\"连衣裙\\",\\n \\"CouponTotalCount\\": \\"100000\\",\\n \\"CouponRemainCount\\": 0,\\n \\"CouponStartTime\\": \\"2021-05-01\\",\\n \\"CouponEndTime\\": \\"2021-06-01\\",\\n \\"CouponStartFee\\": \\"98.000000\\",\\n \\"CouponAmount\\": 5,\\n \\"CouponInfo\\": \\"满98.0元减5.0元\\",\\n \\"CommissionRate\\": \\"180\\",\\n \\"CouponShareUrl\\": \\"//uland.taobao.com/xxxxxxx\\",\\n \\"DeeplinkCouponShareUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"Url\\": \\"//s.click.taobao.com/t?xxxxxx\\",\\n \\"DeeplinkUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"ShopTitle\\": \\"xx旗舰店\\",\\n \\"MaxCommission\\": {\\n \\"MaxCommissionRate\\": \\"20.4\\",\\n \\"MaxCommissionClickUrl\\": \\"https://s.click.taobao.com/t?e=xxxx\\",\\n \\"MaxCommissionCouponShareUrl\\": \\"https://uland.taobao.com/coupon/xxxx\\"\\n }\\n },\\n \\"RankScore\\": 0.337\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"PicInfo\\": {\\n \\"MainRegion\\": {\\n \\"Region\\": \\"280,486,232,351\\",\\n \\"MultiCategoryId\\": [\\n {\\n \\"CategoryId\\": 88888888,\\n \\"Score\\": 0.34\\n }\\n ]\\n },\\n \\"MultiRegion\\": [\\n {\\n \\"Region\\": \\"280,486,232,351\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'GetProductInfoByIds' => [ + 'summary' => '获取商品信息', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ItemIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '111,22,33', + ], + ], + [ + 'name' => 'Pid', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mm_xxx_xxx_xxx', + ], + ], + [ + 'name' => 'Fields', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Url,UserType', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Auctions' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'InputItemId' => [ + 'type' => 'string', + ], + 'ItemId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'Title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ShortTitle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'SubTitle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'PicUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '//img.alicdn.com/i1/FXXXXXXXXXX.jpg', + ], + 'ReservePrice' => [ + 'description' => '', + 'type' => 'string', + 'example' => '150', + ], + 'ZkFinalPrice' => [ + 'description' => '', + 'type' => 'string', + 'example' => '98', + ], + 'PriceAfterCoupon' => [ + 'description' => '', + 'type' => 'string', + 'example' => '90', + ], + 'UserType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Provcity' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Nick' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'SellerId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '32590610', + ], + 'CategoryName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Volume' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'LevelOneCategoryName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CouponTotalCount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10000', + ], + 'CouponRemainCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CouponStartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-05-01', + ], + 'CouponEndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-06-01', + ], + 'CouponStartFee' => [ + 'description' => '', + 'type' => 'string', + 'example' => '98.000000', + ], + 'CouponAmount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'CouponInfo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CommissionRate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '180', + ], + 'CouponShareUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tbopen://m.taobao.com/tbopen/index.html?', + ], + 'DeeplinkCouponShareUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tbopen://m.taobao.com/tbopen/index.html?', + ], + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tbopen://m.taobao.com/tbopen/index.html?', + ], + 'DeeplinkUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tbopen://m.taobao.com/tbopen/index.html?', + ], + 'ShopTitle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'MaxCommission' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MaxCommissionRate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '20.4', + ], + 'MaxCommissionClickUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://s.click.taobao.com/t?e=xxxx', + ], + 'MaxCommissionCouponShareUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://s.click.taobao.com/t?e=xxxx', + ], + ], + ], + ], + ], + 'RankScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.34', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'PidNotExist', + 'errorMessage' => 'The parameter specified Pid not exist', + ], + [ + 'errorCode' => 'InvalidPid', + 'errorMessage' => 'The parameter Pid no specified', + ], + [ + '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' => 'InvalidItemIds', + 'errorMessage' => 'ItemIds parameter overflow number max 40.', + ], + [ + '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' => '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' => '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' => 'NoSpecifiedPicContent', + 'errorMessage' => 'The parameter PicContent no specified.', + ], + [ + '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 specified parameter PicUrl is not valid.', + ], + [ + 'errorCode' => 'NotRegisterBeforeInvoke', + 'errorMessage' => 'Need register token: pid before invoke.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation.', + ], + [ + 'errorCode' => 'DeniedRequest', + 'errorMessage' => 'Your request was denied due to instance flow control.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal server error occurred.', + ], + [ + 'errorCode' => 'NetworkException', + 'errorMessage' => 'A network error occurred.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => '​The request is timeout.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Auctions\\": [\\n {\\n \\"Result\\": {\\n \\"InputItemId\\": \\"123000123\\",\\n \\"ItemId\\": \\"Oqz93kougf9bkN7f4ACMtJ\\",\\n \\"Title\\": \\"xxx套装\\",\\n \\"ShortTitle\\": \\"xxx套装\\",\\n \\"SubTitle\\": \\"xxx套装\\",\\n \\"PicUrl\\": \\"//img.alicdn.com/i1/FXXXXXXXXXX.jpg\\",\\n \\"ReservePrice\\": \\"150\\",\\n \\"ZkFinalPrice\\": \\"98\\",\\n \\"PriceAfterCoupon\\": \\"90\\",\\n \\"UserType\\": 0,\\n \\"Provcity\\": \\"广东 深圳\\",\\n \\"Nick\\": \\"衣服专卖店\\",\\n \\"SellerId\\": \\"32590610\\",\\n \\"CategoryName\\": \\"连衣裙\\",\\n \\"Volume\\": 500,\\n \\"LevelOneCategoryName\\": \\"童装/婴儿装/亲子装\\",\\n \\"CouponTotalCount\\": \\"10000\\",\\n \\"CouponRemainCount\\": 0,\\n \\"CouponStartTime\\": \\"2021-05-01\\",\\n \\"CouponEndTime\\": \\"2021-06-01\\",\\n \\"CouponStartFee\\": \\"98.000000\\",\\n \\"CouponAmount\\": 8,\\n \\"CouponInfo\\": \\"满98.0元减5.0元\\",\\n \\"CommissionRate\\": \\"180\\",\\n \\"CouponShareUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"DeeplinkCouponShareUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"Url\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"DeeplinkUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"ShopTitle\\": \\"xx旗舰店\\",\\n \\"MaxCommission\\": {\\n \\"MaxCommissionRate\\": \\"20.4\\",\\n \\"MaxCommissionClickUrl\\": \\"https://s.click.taobao.com/t?e=xxxx\\",\\n \\"MaxCommissionCouponShareUrl\\": \\"https://s.click.taobao.com/t?e=xxxx\\"\\n }\\n },\\n \\"RankScore\\": 0.34\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + ], + '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-south-1', + 'endpoint' => 'imagesearch.ap-south-1.aliyuncs.com', + ], + ], +]; -- cgit v1.2.3