diff options
Diffstat (limited to 'data/en_us/imagesearch/2020-12-14/api-docs.php')
| -rw-r--r-- | data/en_us/imagesearch/2020-12-14/api-docs.php | 5883 |
1 files changed, 2296 insertions, 3587 deletions
diff --git a/data/en_us/imagesearch/2020-12-14/api-docs.php b/data/en_us/imagesearch/2020-12-14/api-docs.php index 66342a0..213b8c3 100644 --- a/data/en_us/imagesearch/2020-12-14/api-docs.php +++ b/data/en_us/imagesearch/2020-12-14/api-docs.php @@ -1,43 +1,21 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'ImageSearch', - 'version' => '2020-12-14', - ], + 'info' => ['style' => 'RPC', 'product' => 'ImageSearch', 'version' => '2020-12-14'], 'directories' => [ [ - 'id' => 64363, - 'title' => null, + 'children' => ['AddImage', 'DeleteImage'], 'type' => 'directory', - 'children' => [ - 'AddImage', - 'DeleteImage', - ], + 'title' => 'Management', ], [ - 'id' => 64366, - 'title' => null, + 'children' => ['SearchImageByName', 'SearchImageByPic'], 'type' => 'directory', - 'children' => [ - 'SearchImageByName', - 'SearchImageByPic', - ], + 'title' => 'Search', ], [ - 'id' => 208341, - 'title' => null, + 'children' => ['CompareSimilarByImage', 'Detail', 'DumpMeta', 'DumpMetaList', 'IncreaseInstance', 'IncreaseList', 'SearchImageByText', 'UpdateImage', 'CheckImageExists', 'SearchImageByFilter'], 'type' => 'directory', - 'children' => [ - 'CompareSimilarByImage', - 'Detail', - 'DumpMeta', - 'DumpMetaList', - 'IncreaseInstance', - 'IncreaseList', - 'SearchImageByText', - 'UpdateImage', - ], + 'title' => 'Others', ], ], 'components' => [ @@ -45,14 +23,9 @@ ], 'apis' => [ 'AddImage' => [ - 'summary' => 'Adds an image to an Image Search instance.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Describes the syntax and provides examples of the AddImage operation, which adds image information to an Image Search instance.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -64,832 +37,465 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREimagesearchAOOGRD', - ], + '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', - ], + 'schema' => ['description' => 'The name of the Image Search instance. The name can be up to 20 characters in length.'."\n" + .'If you have purchased an Image Search instance, log on to the [Image Search console](https://imagesearch.console.aliyun.com/) to view the instance name.'."\n" + .'If you have not purchased an Image Search instance, refer to [Activate the service](~~179178~~) and [Create an instance](~~66569~~).'."\n" + .'>The instance name is not the instance ID. Do not confuse the two.', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The product ID. The ID can be up to 256 characters in length.'."\n" + ."\n" + .'>A product can have multiple images.', 'type' => 'string', 'required' => true, 'example' => '2092061_1', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The image name. The name can be up to 256 characters in length.'."\n" + .'> - ProductId and PicName uniquely identify an image.'."\n" + .'- If you add multiple images with the same ProductId and PicName, only the last added image is retained. Previously added images are overwritten.', 'type' => 'string', 'required' => true, 'example' => '2092061_1.jpg', 'title' => ''], ], [ '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, - ], + 'schema' => ['description' => 'The image content.'."\n" + .' - The image size cannot exceed 4 MB.'."\n" + .' - Image formats: PNG, JPG, JPEG, BMP, GIF, WEBP, TIFF, and PPM.'."\n" + .' - The transmission wait time cannot exceed 5 seconds.'."\n" + .'<props="china">'."\n" + .' - For product image search, generic image search, furniture image search, and industrial hardware image search, the image width and height must be at least 100 pixels and at most 4,096 pixels.'."\n" + .' For trademark image search, the image width and height must be at least 200 pixels and less than 4,096 pixels.'."\n" + .' For fabric image search, the image width and height must be at least 448 pixels and at most 4,096 pixels.'."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + .' - For product image search and generic image search, the image width and height must be at least 100 pixels and at most 4,096 pixels.'."\n" + .'</props>'."\n" + .'- The image must not contain rotation information.'."\n" + ."\n" + .'> - **When calling by using an SDK:**'."\n" + .' - If you use a V3 SDK, you do not need to set the PicContent field. The SDK encapsulates this field as PicContentObject and automatically converts it to Base64 encoding. For specific examples, refer to [Java SDK](~~179188~~).'."\n" + .' - The SDK does not support passing image URLs directly. The V3 SDK provides an alternative method to upload images by URL. For specific examples, refer to [Java SDK](~~179188~~).'."\n" + .'- **When calling by using the Alibaba Cloud OpenAPI platform:**'."\n" + .' - If you use the **2019-03-25** version, set the **PicContent** field to the **Base64** encoding of the image.'."\n" + .' - If you use the **2020-12-14** version, click to upload the image directly in the **PicContent** field.', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The image category. For more information, refer to [Category reference](~~179184~~).'."\n" + .'> - For product image search, if you specify a category, the specified category is used. If you do not specify a category, the system predicts the category. The predicted category result can be obtained from the response.'."\n" + .'<props="china">'."\n" + .'- For fabric, trademark, generic, furniture, and industrial hardware image search, the system sets the category to 88888888 regardless of whether you specify a category.'."\n" + .'</props>'."\n" + .'- For generic image search, the system sets the category to 88888888 regardless of whether you specify a category.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '88888888', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'Specifies whether to perform subject identification. Default value: true.'."\n" + .' - true: The system performs subject identification and searches based on the identified subject. The subject identification result can be obtained from the response.'."\n" + .'- false: The system does not perform subject identification and searches based on the entire image.'."\n" + ."\n" + .'<props="china">For fabric image search, this parameter is ignored. The system searches based on the entire image.</props>.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The subject region of the image, in the format of `x1,x2,y1,y2`, where `x1,y1` is the upper-left point and `x2,y2` is the lower-right point.'."\n" + .'> - If you specify Region, the system searches based on the specified Region regardless of the Crop parameter value.'."\n" + .'<props="china">'."\n" + .'- For fabric image search, this parameter is ignored. The system searches based on the entire image.'."\n" + .'</props>'."\n" + .'- The Region parameter has no unit. The values are based on the pixel dimensions of the image. If the image is scaled, the Region parameter values must be scaled proportionally.', 'type' => 'string', 'required' => false, 'example' => '280,486,232,351', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The custom content defined by the user. The content can be up to 4,096 characters in length.'."\n" + .'>This field is returned in query results. For example, you can add a text description of the image.', 'type' => 'string', 'required' => false, 'example' => 'zidingyi', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The integer attribute. This attribute can be used to filter query results and is returned in query results.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '22', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The string attribute. The attribute can be up to 128 characters in length. This attribute can be used to filter query results and is returned in query results.'."\n" + .'> Special characters such as \\¥$&% are not supported.', 'type' => 'string', 'required' => false, 'example' => 'ss', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The integer attribute. This attribute can be used to filter query results and is returned in query results.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '22', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The string attribute. The attribute can be up to 128 characters in length. This attribute can be used to filter query results and is returned in query results.'."\n" + .'> Special characters such as \\¥$&% are not supported.', 'type' => 'string', 'required' => false, 'example' => 'ss', 'title' => ''], ], [ 'name' => 'IntAttr3', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['description' => 'The integer attribute. This attribute can be used to filter query results and is returned in query results.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '33', 'title' => ''], ], [ 'name' => 'StrAttr3', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The string attribute. The attribute can be up to 128 characters in length. This attribute can be used to filter query results and is returned in query results.'."\n" + .'> Special characters such as \\¥$&% are not supported.', 'type' => 'string', 'required' => false, 'example' => 'ss', 'title' => ''], ], [ 'name' => 'IntAttr4', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['description' => 'The integer attribute. This attribute can be used to filter query results and is returned in query results.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '44', 'title' => ''], ], [ 'name' => 'StrAttr4', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The string attribute. The attribute can be up to 128 characters in length. This attribute can be used to filter query results and is returned in query results.'."\n" + .'> Special characters such as \\¥$&% are not supported.', 'type' => 'string', 'required' => false, 'example' => 'ss', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data returned.'."\n", + 'title' => '', + 'description' => 'The response parameters.', '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', - ], + 'Message' => ['description' => 'The error message.'."\n" + .'> No data is returned for successful requests. Error messages are returned for failed requests.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E0845DE6-52AF-4B50-9F15-51ED4044E6AB', 'title' => ''], + 'Code' => ['description' => 'The error code.'."\n" + ."\n" + .'- 0: success.'."\n" + .'- Non-zero: failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'PicInfo' => [ - 'description' => 'The results of category prediction and subject identification.'."\n", + 'description' => 'The category prediction and subject identification results.', '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', + 'Region' => ['description' => 'The subject identification result. The subject region of the image, in the format of `x1,x2,y1,y2`, where `x1,y1` is the upper-left point and `x2,y2` is the lower-right point. If the user specifies a subject region in the request, the specified region is used.', 'type' => 'string', 'example' => '94,691,206,650', 'title' => ''], + 'CategoryId' => ['description' => 'The category prediction result. If the user specifies a category in the request, the specified category is used.', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888', 'title' => ''], + 'MultiRegion' => [ + 'description' => 'The collection of subject identification results.'."\n" + .'> Upgrade to V3.1.1 or later to use this feature.', + 'type' => 'array', + 'items' => [ + 'description' => 'The subject identification result.', + 'type' => 'object', + 'properties' => [ + 'Region' => ['description' => 'The subject identification result. The subject region of the image, in the format of x1,x2,y1,y2, where x1,y1 is the upper-left point and x2,y2 is the lower-right point. If the user specifies a subject region in the request, the specified region is used.', 'type' => 'string', 'example' => '94,691,206,650', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - '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', + 'AllCategories' => [ + 'description' => 'The information about all categories supported by the system.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about all categories supported by the system.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The category name.', 'type' => 'string', 'example' => 'Other', 'title' => ''], + 'Id' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'BadRequest', - 'errorMessage' => 'The request has invalid parameters.', - ], - [ - 'errorCode' => 'InstanceStatusError', - 'errorMessage' => 'Your instance is unavailable.', - ], - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'NoCaretSeperator', - 'errorMessage' => 'The body content is missing the ^ separator.', - ], - [ - 'errorCode' => 'EmptyMeta', - 'errorMessage' => 'The body content has an empty meta field.', - ], - [ - 'errorCode' => 'InvalidMetaItem', - 'errorMessage' => 'The meta field is invalid.', - ], - [ - 'errorCode' => 'NoPicList', - 'errorMessage' => 'The body content is missing the pic_list parameter.', - ], - [ - 'errorCode' => 'NoSpecifiedPic', - 'errorMessage' => 'The content of an image is not specified in the HTTP POST body.', - ], - [ - 'errorCode' => 'NoSpecifiedSearchPic', - 'errorMessage' => 'The search image is not specified.', - ], - [ - 'errorCode' => 'InvalidCategory', - 'errorMessage' => 'The specified category is invalid.', - ], - [ - 'errorCode' => 'OverflowMaxResultNum', - 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', - ], - [ - 'errorCode' => 'OverflowMaxReturnNum', - 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', - ], - [ - 'errorCode' => 'InvalidStartParameter', - 'errorMessage' => 'The specified parameter s is inavlid.', - ], - [ - 'errorCode' => 'InvalidNumParameter', - 'errorMessage' => 'The specified parameter n is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedAddPic', - 'errorMessage' => 'The image to insert is not specified.', - ], - [ - 'errorCode' => 'NoSpecifiedItemId', - 'errorMessage' => 'The item_id parameter is not specified.', - ], - [ - 'errorCode' => 'InvalidIntAttr', - 'errorMessage' => 'The specified int_attr field is invalid.', - ], - [ - 'errorCode' => 'UnsupportedPicFormat', - 'errorMessage' => 'The specified image format is invalid.', - ], - [ - 'errorCode' => 'InvalidFilterClause', - 'errorMessage' => 'The specified filtering condition is invalid.', - ], - [ - 'errorCode' => 'InstanceOverQuota', - 'errorMessage' => 'The number of items exceeds the limit.', - ], - [ - 'errorCode' => 'IncorrectOrientation', - 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', - ], - [ - 'errorCode' => 'UnsupportedPicPixels', - 'errorMessage' => 'The specified pixels is not supported.', - ], - [ - 'errorCode' => 'SearchTimeout', - 'errorMessage' => 'The request is timed out.', - ], - [ - 'errorCode' => 'PicNotExist', - 'errorMessage' => 'The search picture does not exist.', - ], - [ - 'errorCode' => 'NoSpecifiedProductId', - 'errorMessage' => 'The parameter ProductId no specified.', - ], - [ - 'errorCode' => 'NoSpecifiedPicName', - 'errorMessage' => 'The parameter PicName no specified.', - ], - [ - 'errorCode' => 'NoSpecifiedPicContent', - 'errorMessage' => 'The parameter PicContent no specified.', - ], - [ - 'errorCode' => 'InvalidType', - 'errorMessage' => 'The specified parameter Type is not valid.', - ], - [ - 'errorCode' => 'InvalidProductId', - 'errorMessage' => 'The specified parameter ProductId is not valid.', - ], - [ - 'errorCode' => 'InvalidPicName', - 'errorMessage' => 'The specified parameter PicName is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr', - 'errorMessage' => 'The specified parameter StrAttr is not valid.', - ], - [ - 'errorCode' => 'InvalidCustomContent', - 'errorMessage' => 'The specified parameter CustomContent is not valid.', - ], - [ - 'errorCode' => 'InvalidPicContent', - 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', - ], - [ - 'errorCode' => 'TimeoutForTransferImage', - 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', - ], - [ - 'errorCode' => 'InvalidPicUrl', - 'errorMessage' => 'The search picture does not exist at the specific url.', - ], - [ - 'errorCode' => 'InvalidInstanceName', - 'errorMessage' => 'The parameter instanceName is not specified.', - ], - [ - 'errorCode' => 'InvalidRequestId', - 'errorMessage' => 'The parameter requestId is not specified.', - ], - [ - 'errorCode' => 'InvalidRequestIdTooLarge', - 'errorMessage' => 'The parameter requestId is too large.', - ], - [ - 'errorCode' => 'InvalidRegion', - 'errorMessage' => 'The specific region is illegal.', - ], - [ - 'errorCode' => 'RegionError', - 'errorMessage' => 'region.', - ], - [ - 'errorCode' => 'InvalidStrAttr2', - 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr3', - 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr4', - 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr2', - 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr3', - 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr4', - 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', - ], - [ - 'errorCode' => 'PictureError', - 'errorMessage' => '[download] Img Download Failed.', - ], - [ - 'errorCode' => 'UnsupportedOperationType', - 'errorMessage' => 'The specified action is not supported.', - ], + ['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''], + ['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => ''], + ['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => ''], + ['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => ''], + ['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => ''], + ['errorCode' => 'NoPicList', 'errorMessage' => 'The body content is missing the pic_list parameter.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'The content of an image is not specified in the HTTP POST body.', 'description' => ''], + ['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''], + ['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => ''], + ['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => ''], + ['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => ''], + ['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter s is inavlid.', 'description' => ''], + ['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter n is invalid.', 'description' => ''], + ['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''], + ['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => ''], + ['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => ''], + ['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => ''], + ['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => ''], + ['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => ''], + ['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => ''], + ['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''], + ['errorCode' => 'PicNotExist', 'errorMessage' => 'The search picture does not exist.', 'description' => ''], + ['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'The parameter ProductId no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicName', 'errorMessage' => 'The parameter PicName no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''], + ['errorCode' => 'InvalidType', 'errorMessage' => 'The specified parameter Type is not valid.', 'description' => ''], + ['errorCode' => 'InvalidProductId', 'errorMessage' => 'The specified parameter ProductId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicName', 'errorMessage' => 'The specified parameter PicName is not valid.', 'description' => ''], + ['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => 'Invalid StrAttr'], + ['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', 'description' => ''], + ['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''], + ['errorCode' => 'InvalidPicUrl', 'errorMessage' => 'The search picture does not exist at the specific url.', 'description' => ''], + ['errorCode' => 'InvalidInstanceName', 'errorMessage' => 'The parameter instanceName is not specified.', 'description' => ''], + ['errorCode' => 'InvalidRequestId', 'errorMessage' => 'The parameter requestId is not specified.', 'description' => ''], + ['errorCode' => 'InvalidRequestIdTooLarge', 'errorMessage' => 'The parameter requestId is too large.', 'description' => ''], + ['errorCode' => 'InvalidRegion', 'errorMessage' => 'The specific region is illegal.', 'description' => ''], + ['errorCode' => 'RegionError', 'errorMessage' => 'region.', 'description' => ''], + ['errorCode' => 'InvalidStrAttr2', 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', 'description' => 'Invalid'], + ['errorCode' => 'InvalidStrAttr3', 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', 'description' => 'Invalid StrAttr3'], + ['errorCode' => 'InvalidStrAttr4', 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', 'description' => 'Invalid StrAttr4'], + ['errorCode' => 'InvalidIntAttr2', 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', 'description' => 'Invalid IntAttr2'], + ['errorCode' => 'InvalidIntAttr3', 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', 'description' => 'Invalid IntAttr3'], + ['errorCode' => 'InvalidIntAttr4', 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', 'description' => 'Invalid'], + ['errorCode' => 'PictureError', 'errorMessage' => '[download] Img Download Failed.', 'description' => 'Picture download failed, please check the picture'], + ['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation.', - ], - [ - 'errorCode' => 'DeniedRequest', - 'errorMessage' => 'Your request was denied due to instance flow control.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => ''], + ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'UnknownException', - 'errorMessage' => 'An internal server error occurred.', - ], - [ - 'errorCode' => 'NetworkException', - 'errorMessage' => 'A network error occurred.', - ], - [ - 'errorCode' => 'RequestTimeout', - 'errorMessage' => 'The request is timeout.', - ], - [ - 'errorCode' => 'ExtractFeatureTimeout', - 'errorMessage' => 'The request was timed out while extracting features.', - ], - [ - 'errorCode' => 'AccessEngineFailed', - 'errorMessage' => 'An error occurred while accessing the search engine.', - ], - [ - 'errorCode' => 'InternalOssError', - 'errorMessage' => 'An internal OAS error occurred.', - ], - [ - 'errorCode' => 'InternalSwiftError', - 'errorMessage' => 'An internal SWIFT error occurred.', - ], - [ - 'errorCode' => 'InternalTableStoreError', - 'errorMessage' => 'An internal Table Store error occurred.', - ], - [ - 'errorCode' => 'ConnectionDVException', - 'errorMessage' => 'Failed to obtain collection.', + ['errorCode' => 'UnknownException', 'errorMessage' => 'An internal server error occurred.', 'description' => ''], + ['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => ''], + ['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''], + ['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''], + ['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''], + ['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => ''], + ['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => ''], + ['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => ''], + ['errorCode' => 'ConnectionDVException', 'errorMessage' => 'Failed to obtain collection.', 'description' => 'internalError'], + ], + ], + 'responseDemo' => '[{"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 \\"MultiRegion\\": [\\n {\\n \\"Region\\": \\"94,691,206,650\\"\\n }\\n ],\\n \\"AllCategories\\": [\\n {\\n \\"Name\\": \\"Other\\",\\n \\"Id\\": 88888888\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Add an image', + 'description' => '## Description'."\n" + .'This operation adds image information to an Image Search instance.'."\n" + ."\n" + .'## QPS limit'."\n" + .'An instance with a maximum image capacity of 100,000 has a default concurrency of 1, which means that a maximum of 1 image addition request can be processed per second.'."\n" + .'Instances with other image capacities have a default concurrency of 5, which means that a maximum of 5 image addition requests can be processed per second.', + 'extraInfo' => '## Error codes'."\n" + .'For more information, refer to [Error codes](~~66619~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddImage'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imagesearch:AddImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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', - ], + 'CheckImageExists' => [ + 'summary' => 'CheckImageExists', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREimagesearchIT4SIC', - ], + 'abilityTreeNodes' => ['FEATUREimagesearchF4L5JA'], ], 'parameters' => [ [ 'name' => 'InstanceName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the Image Search instance. The name can be up to 20 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'demoinstance1', - ], + 'schema' => ['description' => 'Image Search instance name. Supports up to 20 characters. '."\n" + .'If you have already purchased an Image Search instance, you can logon to the [Image Search console](https://imagesearch.console.aliyun.com/) to view it. '."\n" + .'If you have not purchased an Image Search instance, see [Activate the service](~~179178~~) and [Create an instance](~~66569~~). '."\n" + .'> The instance name here is not the instance ID. Please distinguish between them when using.', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'Product ID.', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => false, 'example' => '2092061_1', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'Image name.', 'type' => 'string', 'required' => true, 'example' => '2092061_1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'Result returned.', '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", + 'Msg' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', 'title' => ''], + 'Auctions' => [ + 'description' => 'Description information of all returned products.', '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', - ], + 'ProductId' => ['description' => 'Product ID.', 'type' => 'string', 'example' => '2092061_1', 'title' => ''], + 'PicName' => ['description' => 'Image name.', 'type' => 'string', 'example' => '2092061_1.jpg', 'title' => ''], + 'CategoryId' => ['description' => 'Image category.', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888', 'title' => ''], + 'CustomContent' => ['description' => 'User-defined content.', 'type' => 'string', 'example' => 'zidingyi', 'title' => ''], + 'IntAttr' => ['description' => 'Integer-type property.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'IntAttr2' => ['description' => 'Integer-type property.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'StrAttr' => ['description' => 'String-type property.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'StrAttr2' => ['description' => 'String-type property.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'StrAttr3' => ['description' => 'String-type property.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'StrAttr4' => ['description' => 'String-type property.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'IntAttr3' => ['description' => 'Integer-type property.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'IntAttr4' => ['description' => 'Integer-type property.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'Error code. '."\n" + .'- 0: Succeeded. '."\n" + .'- Non-zero: Failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Exists' => ['description' => 'Indicates whether the image exists.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'BadRequest', - 'errorMessage' => 'The request has invalid parameters.', - ], - [ - 'errorCode' => 'InstanceStatusError', - 'errorMessage' => 'Your instance is unavailable.', - ], - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'NoCaretSeperator', - 'errorMessage' => 'The body content is missing the ^ separator.', - ], - [ - 'errorCode' => 'EmptyMeta', - 'errorMessage' => 'The body content has an empty meta field.', - ], - [ - 'errorCode' => 'InvalidMetaItem', - 'errorMessage' => 'The meta field is invalid.', - ], - [ - 'errorCode' => 'InvalidPicList', - 'errorMessage' => 'The specified pic_list parameter is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedPic', - 'errorMessage' => 'The content of an image is not specified in the HTTP POST body.', - ], - [ - 'errorCode' => 'NoSpecifiedSearchPic', - 'errorMessage' => 'The search image is not specified.', - ], - [ - 'errorCode' => 'InvalidCategory', - 'errorMessage' => 'The specified category is invalid.', - ], - [ - 'errorCode' => 'OverflowMaxResultNum', - 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', - ], - [ - 'errorCode' => 'OverflowMaxReturnNum', - 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', - ], - [ - 'errorCode' => 'InvalidStartParameter', - 'errorMessage' => 'The specified parameter s is inavlid.', - ], - [ - 'errorCode' => 'InvalidNumParameter', - 'errorMessage' => 'The specified parameter n is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedAddPic', - 'errorMessage' => 'The image to insert is not specified.', - ], - [ - 'errorCode' => 'NoSpecifiedItemId', - 'errorMessage' => 'The item_id parameter is not specified.', - ], - [ - 'errorCode' => 'InvalidIntAttr', - 'errorMessage' => 'The specified int_attr field is invalid.', - ], - [ - 'errorCode' => 'UnsupportedPicFormat', - 'errorMessage' => 'The specified image format is invalid.', - ], - [ - 'errorCode' => 'InvalidFilterClause', - 'errorMessage' => 'The specified filtering condition is invalid.', - ], - [ - 'errorCode' => 'InstanceOverQuota', - 'errorMessage' => 'The number of items exceeds the limit.', - ], - [ - 'errorCode' => 'IncorrectOrientation', - 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', - ], - [ - 'errorCode' => 'UnsupportedPicPixels', - 'errorMessage' => 'The specified pixels is not supported.', - ], - [ - 'errorCode' => 'SearchTimeout', - 'errorMessage' => 'The request is timed out.', - ], - [ - 'errorCode' => 'NoSpecifiedProductId', - 'errorMessage' => 'You must specify ProductId.', - ], - [ - 'errorCode' => 'InvalidIntAttr4', - 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr3', - 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr2', - 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr4', - 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr3', - 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr2', - 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr', - 'errorMessage' => 'The specified parameter StrAttr is not valid.', - ], - [ - 'errorCode' => 'UnsupportedOperationType', - 'errorMessage' => 'The specified action is not supported.', - ], - [ - 'errorCode' => 'UnsupportedInstanceType', - 'errorMessage' => 'The instance type is not supported.', - ], + ['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''], + ['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''], + ['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => ''], + ['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => ''], + ['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => ''], + ['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => ''], + ['errorCode' => 'NoPicList', 'errorMessage' => 'The body content is missing the pic_list parameter.', 'description' => ''], + ['errorCode' => 'InvalidPicList', 'errorMessage' => 'The specified pic_list parameter is invalid.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'he content of an image is not specified in the HTTP POST body.', 'description' => ''], + ['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''], + ['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => ''], + ['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => ''], + ['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => ''], + ['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter start is inavlid.', 'description' => ''], + ['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter num is invalid.', 'description' => ''], + ['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''], + ['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => ''], + ['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => ''], + ['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => ''], + ['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => ''], + ['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => ''], + ['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => ''], + ['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''], + ['errorCode' => 'PicNotExist', 'errorMessage' => 'The search picture does not exist.', 'description' => ''], + ['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'The parameter ProductId no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicName', 'errorMessage' => 'The parameter PicName no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''], + ['errorCode' => 'InvalidType', 'errorMessage' => 'The specified parameter Type is not valid.', 'description' => ''], + ['errorCode' => 'InvalidProductId', 'errorMessage' => 'The specified parameter ProductId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicName', 'errorMessage' => 'The specified parameter PicName is not valid.', 'description' => ''], + ['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => 'Invalid StrAttr'], + ['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 2 * 1024 * 1024.', 'description' => ''], + ['errorCode' => 'InvalidStrAttr4', 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', 'description' => 'Invalid StrAttr4'], + ['errorCode' => 'InvalidStrAttr3', 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', 'description' => 'Invalid StrAttr3'], + ['errorCode' => 'InvalidStrAttr2', 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', 'description' => 'Invalid'], + ['errorCode' => 'InvalidIntAttr4', 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', 'description' => 'Invalid'], + ['errorCode' => 'InvalidIntAttr3', 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', 'description' => 'Invalid IntAttr3'], + ['errorCode' => 'InvalidIntAttr2', 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', 'description' => 'Invalid IntAttr2'], + ['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => ''], + ['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation.', - ], - [ - 'errorCode' => 'DeniedRequest', - 'errorMessage' => 'Your request was denied due to instance flow control.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => ''], + ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'UnknownlException', - 'errorMessage' => 'An internal server error occurred.', - ], - [ - 'errorCode' => 'UnknownException', - 'errorMessage' => 'An internal server error occurred.', - ], - [ - 'errorCode' => 'NetworkException', - 'errorMessage' => 'A network error occurred.', - ], - [ - 'errorCode' => 'RequestTimeout', - 'errorMessage' => 'The request is timeout.', - ], - [ - 'errorCode' => 'ExtractFeatureTimeout', - 'errorMessage' => 'The request was timed out while extracting features.', - ], - [ - 'errorCode' => 'AccessEngineFailed', - 'errorMessage' => 'An error occurred while accessing the search engine.', - ], - [ - 'errorCode' => 'InternalOssError', - 'errorMessage' => 'An internal OAS error occurred.', - ], - [ - 'errorCode' => 'InternalSwiftError', - 'errorMessage' => 'An internal SWIFT error occurred.', - ], - [ - 'errorCode' => 'InternalTableStoreError', - 'errorMessage' => 'An internal Table Store error occurred.', + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal server error occurred.', 'description' => ''], + ['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => ''], + ['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''], + ['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''], + ['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''], + ['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => ''], + ['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => ''], + ['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Check Image', + 'description' => '## How-To '."\n" + .'This API is used to query image information in an Image Search instance based on an image.'."\n" + ."\n" + .'## QPS Limit '."\n" + .'The default maximum queries per second (QPS) for query operations can be viewed in the console. It corresponds to the Visit Frequency (QPS) you selected when purchasing the instance. Supported QPS values are 1, 5, and 10.'."\n" + ."\n" + .'### SDK Version Guide '."\n" + .'Upgrade the Image SDK to version V3.1.1 to use the "subject identification" and "similarity score" features. For more information, see [Java SDK](~~179188~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imagesearch:CheckImageExists', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Auctions\\": {\\n \\"ProductId\\": \\"2092061_1\\",\\n \\"PicName\\": \\"2092061_1.jpg\\",\\n \\"CategoryId\\": 88888888,\\n \\"CustomContent\\": \\"zidingyi\\",\\n \\"IntAttr\\": 2,\\n \\"IntAttr2\\": 2,\\n \\"StrAttr\\": \\"test\\",\\n \\"StrAttr2\\": \\"test\\",\\n \\"StrAttr3\\": \\"test\\",\\n \\"StrAttr4\\": \\"test\\",\\n \\"IntAttr3\\": 2,\\n \\"IntAttr4\\": 2\\n },\\n \\"Code\\": 0,\\n \\"Success\\": true,\\n \\"Exists\\": true\\n}","type":"json"}]', ], - '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', - ], + 'CompareSimilarByImage' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -898,1496 +504,352 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREimagesearchF4L5JA', - ], + '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.'."\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', + 'name' => 'PrimaryPicContent', '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', - ], + 'schema' => ['description' => 'The image content.'."\n" + ."\n" + .'- The image size must not exceed 4 MB.'."\n" + .'- Image formats: PNG, JPG, JPEG, BMP, GIF, WEBP, TIFF, and PPM.'."\n" + .'- The transmission wait time must not exceed 5 seconds.'."\n" + .'<props="china">'."\n" + .'- If the service type is product image search, generic image search, furniture image search, or industrial hardware image search, the image width and height must be at least 100 px and at most 4096 px.'."\n" + .'</props>'."\n" + .'<props="china">'."\n" + .'- If the service type is trademark image search, the image width and height must be at least 200 px and less than 4096 px.'."\n" + .'</props>'."\n" + .'<props="china">'."\n" + .'- If the service type is fabric image search, the image width and height must be at least 448 px and at most 4096 px.'."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + .'- If the service type is product image search or generic image search, the image width and height must be at least 100 px and at most 4096 px.'."\n" + .'</props>'."\n" + .'- The image must not contain rotation information.'."\n" + ."\n" + .'> **When calling by using an SDK:**- Only V3 SDKs are supported. You do not need to set the PrimaryPicContent field. The SDK encapsulates this field as PrimaryPicContentObject and automatically converts it to Base64 encoding. For examples, refer to [JAVA SDK](~~179188~~).- The SDK does not support passing image URLs directly. V3 SDKs provide an alternative way to upload images by URL. For examples, refer to [JAVA SDK](~~179188~~).', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=', 'title' => ''], ], [ - 'name' => 'Filter', + 'name' => 'SecondaryPicContent', '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', - ], + 'schema' => ['description' => 'The image content.'."\n" + ."\n" + .'- The image size must not exceed 4 MB.'."\n" + .'- Image formats: PNG, JPG, JPEG, BMP, GIF, WEBP, TIFF, and PPM.'."\n" + .'- The transmission wait time must not exceed 5 seconds.'."\n" + .'<props="china">'."\n" + .'- If the service type is product image search, generic image search, furniture image search, or industrial hardware image search, the image width and height must be at least 100 px and at most 4096 px.'."\n" + .'</props>'."\n" + .'<props="china">'."\n" + .'- If the service type is trademark image search, the image width and height must be at least 200 px and less than 4096 px.'."\n" + .'</props>'."\n" + .'<props="china">'."\n" + .'- If the service type is fabric image search, the image width and height must be at least 448 px and at most 4096 px.'."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + .'- If the service type is product image search or generic image search, the image width and height must be at least 100 px and at most 4096 px.'."\n" + .'</props>'."\n" + .'- The image must not contain rotation information.'."\n" + ."\n" + .'> **When calling by using an SDK:**- Only V3 SDKs are supported. You do not need to set the PrimaryPicContent field. The SDK encapsulates this field as PrimaryPicContentObject and automatically converts it to Base64 encoding. For examples, refer to [JAVA SDK](~~179188~~).- The SDK does not support passing image URLs directly. V3 SDKs provide an alternative way to upload images by URL. For examples, refer to [JAVA SDK](~~179188~~).', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=', 'title' => ''], ], [ - 'name' => 'DistinctProductId', + 'name' => 'InstanceName', 'in' => 'formData', - 'schema' => [ - 'type' => 'boolean', - ], - ], - [ - 'name' => 'ScoreThreshold', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The name of the Image Search instance. The name can be up to 20 characters in length.'."\n" + .'If you have purchased an Image Search instance, log on to the <props="intl">[Image Search console](https://imagesearch.console.alibabacloud.com)</props><props="china">[Image Search console](https://imagesearch.console.aliyun.com)</props> to view the instance name.'."\n" + .'If you have not purchased an Image Search instance, refer to [Activate the service](~~179178~~) and [Create an instance](~~66569~~).'."\n" + .'>The instance name is not the instance ID. Make sure you distinguish between them.', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'The similarity calculation result.', '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", + 'Score' => ['description' => 'The image similarity score. Valid values: 0 to 1.', 'type' => 'number', 'format' => 'double', 'example' => '0.85', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', 'title' => ''], + 'Msg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'AccessDeniedDetail' => [ + 'description' => 'The authentication response details.', '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', - ], - ], - ], - ], + 'AuthAction' => ['description' => 'The action for the authentication request.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The authentication principal information.', 'type' => 'string', 'example' => '111', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'The Alibaba Cloud account ID of the authentication principal.', 'type' => 'string', 'example' => '222', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'The type of the authentication principal.', 'type' => 'string', 'example' => 'SubUser', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The encrypted diagnostic message.', 'type' => 'string', 'example' => 'xxxxxx', 'title' => ''], + 'NoPermissionType' => ['description' => 'Valid values:'."\n" + .'- ImplicitDeny: no policy is matched.'."\n" + .'- ExplicitDeny: an explicit Deny policy is matched.', 'type' => 'string', 'example' => 'ImplicitDeny', 'title' => ''], + 'PolicyType' => ['description' => 'The type of the policy that caused the access denial.', 'type' => 'string', 'example' => 'AccountLevelIdentityBasedPolicy', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code. Valid values:'."\n" + .'- 0: success.'."\n" + .'- Non-zero: failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'BadRequest', - 'errorMessage' => 'The request has invalid parameters.', - ], - [ - 'errorCode' => 'InstanceStatusError', - 'errorMessage' => 'Your instance is unavailable.', - ], - [ - 'errorCode' => 'TimeoutForTransferImage', - 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', - ], - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'NoCaretSeperator', - 'errorMessage' => 'The body content is missing the ^ separator.', - ], - [ - 'errorCode' => 'EmptyMeta', - 'errorMessage' => 'The body content has an empty meta field.', - ], - [ - 'errorCode' => 'InvalidMetaItem', - 'errorMessage' => 'The meta field is invalid.', - ], - [ - 'errorCode' => 'NoPicList', - 'errorMessage' => 'The body content is missing the pic_list parameter.', - ], - [ - 'errorCode' => 'InvalidPicList', - 'errorMessage' => 'The specified pic_list parameter is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedPic', - 'errorMessage' => 'he content of an image is not specified in the HTTP POST body.', - ], - [ - 'errorCode' => 'NoSpecifiedSearchPic', - 'errorMessage' => 'The search image is not specified.', - ], - [ - 'errorCode' => 'InvalidCategory', - 'errorMessage' => 'The specified category is invalid.', - ], - [ - 'errorCode' => 'OverflowMaxResultNum', - 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', - ], - [ - 'errorCode' => 'OverflowMaxReturnNum', - 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', - ], - [ - 'errorCode' => 'InvalidStartParameter', - 'errorMessage' => 'The specified parameter start is inavlid.', - ], - [ - 'errorCode' => 'InvalidNumParameter', - 'errorMessage' => 'The specified parameter num is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedAddPic', - 'errorMessage' => 'The image to insert is not specified.', - ], - [ - 'errorCode' => 'NoSpecifiedItemId', - 'errorMessage' => 'The item_id parameter is not specified.', - ], - [ - 'errorCode' => 'InvalidIntAttr', - 'errorMessage' => 'The specified int_attr field is invalid.', - ], - [ - 'errorCode' => 'UnsupportedPicFormat', - 'errorMessage' => 'The specified image format is invalid.', - ], - [ - 'errorCode' => 'InvalidFilterClause', - 'errorMessage' => 'The specified filtering condition is invalid.', - ], - [ - 'errorCode' => 'InstanceOverQuota', - 'errorMessage' => 'The number of items exceeds the limit.', - ], - [ - 'errorCode' => 'IncorrectOrientation', - 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', - ], - [ - 'errorCode' => 'UnsupportedPicPixels', - 'errorMessage' => 'The specified pixels is not supported.', - ], - [ - 'errorCode' => 'SearchTimeout', - 'errorMessage' => 'The request is timed out.', - ], - [ - 'errorCode' => 'PicNotExist', - 'errorMessage' => 'The search picture does not exist.', - ], - [ - 'errorCode' => 'NoSpecifiedProductId', - 'errorMessage' => 'The parameter ProductId no specified.', - ], - [ - 'errorCode' => 'NoSpecifiedPicName', - 'errorMessage' => 'The parameter PicName no specified.', - ], - [ - 'errorCode' => 'NoSpecifiedPicContent', - 'errorMessage' => 'The parameter PicContent no specified.', - ], - [ - 'errorCode' => 'InvalidType', - 'errorMessage' => 'The specified parameter Type is not valid.', - ], - [ - 'errorCode' => 'InvalidProductId', - 'errorMessage' => 'The specified parameter ProductId is not valid.', - ], - [ - 'errorCode' => 'InvalidPicName', - 'errorMessage' => 'The specified parameter PicName is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr', - 'errorMessage' => 'The specified parameter StrAttr is not valid.', - ], - [ - 'errorCode' => 'InvalidCustomContent', - 'errorMessage' => 'The specified parameter CustomContent is not valid.', - ], - [ - 'errorCode' => 'InvalidPicContent', - 'errorMessage' => 'The specified parameter PicContent length greater than 2 * 1024 * 1024.', - ], - [ - 'errorCode' => 'InvalidStrAttr4', - 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr3', - 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr2', - 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr4', - 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr3', - 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr2', - 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', - ], - [ - 'errorCode' => 'UnsupportedOperationType', - 'errorMessage' => 'The specified action is not supported.', - ], - [ - 'errorCode' => 'UnsupportedInstanceType', - 'errorMessage' => 'The instance type is not supported.', - ], + ['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request timed out.', 'description' => ''], + ['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Image transfer timed out.', 'description' => ''], + ['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => ''], + ['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => ''], + ['errorCode' => 'UnsupportedPictureFormat', 'errorMessage' => 'The format of the specified picture is not supported.', 'description' => ''], + ['errorCode' => 'Console.InstanceNotFound', 'errorMessage' => 'The specified ImageSearch instance is not found.', 'description' => 'The specified instance ID does not exist. Check the instance ID and try again.'], + ['errorCode' => 'Console.PidError', 'errorMessage' => 'The number of PID bindings of the current instance exceeds 50.', 'description' => ''], + ['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => ''], + ['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => ''], + ['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => ''], + ['errorCode' => 'InstanceStatusError', 'errorMessage' => 'The current instance status does not support this operation.', 'description' => ''], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => ''], + ['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The image size exceeds 4 MB.', 'description' => ''], + ['errorCode' => 'InvalidPicUrl', 'errorMessage' => 'The specified parameter PicUrl is not valid.', 'description' => ''], + ['errorCode' => 'NeedRegisterBeforeInvoke', 'errorMessage' => 'Register for PID before invoking the service.', 'description' => ''], + ['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'The content of an image is not specified in the HTTP POST body.', 'description' => ''], + ['errorCode' => 'PicNotExist', 'errorMessage' => 'The specified image does not exist.', 'description' => ''], + ['errorCode' => 'InvalidSecondaryPicContent', 'errorMessage' => 'The specified parameter SecondaryPicContent is not valid.', 'description' => 'Invalid SecondaryPicContent parameter'], + ['errorCode' => 'InvalidPrimaryPicContent', 'errorMessage' => 'The specified parameter PrimaryPicContent is not valid.', 'description' => 'Invalid PrimaryPicContent parameter'], + ['errorCode' => 'PictureError', 'errorMessage' => '[download] Img Download Failed.', 'description' => 'Picture download failed, please check the picture'], + ['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => ''], + ['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation.', - ], - [ - 'errorCode' => 'DeniedRequest', - 'errorMessage' => 'Your request was denied due to instance flow control.', - ], + ['errorCode' => 'Console.NoPermissionError', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => ''], + ['errorCode' => 'Console.NotAllowedModifyToken', 'errorMessage' => 'You are not allowed to modify token today.', 'description' => ''], + ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => ''], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => ''], + ], + 409 => [ + ['errorCode' => 'Console.TaskAlreadyExist', 'errorMessage' => 'A task that is in progress already exists.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal server error occurred.', - ], - [ - 'errorCode' => 'NetworkException', - 'errorMessage' => 'A network error occurred.', - ], - [ - 'errorCode' => 'RequestTimeout', - 'errorMessage' => 'The request is timeout.', - ], - [ - 'errorCode' => 'ExtractFeatureTimeout', - 'errorMessage' => 'The request was timed out while extracting features.', - ], - [ - 'errorCode' => 'AccessEngineFailed', - 'errorMessage' => 'An error occurred while accessing the search engine.', - ], - [ - 'errorCode' => 'InternalOssError', - 'errorMessage' => 'An internal OAS error occurred.', - ], - [ - 'errorCode' => 'InternalSwiftError', - 'errorMessage' => 'An internal SWIFT error occurred.', - ], - [ - 'errorCode' => 'InternalTableStoreError', - 'errorMessage' => 'An internal Table Store error occurred.', + ['errorCode' => 'ServerInternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], + ['errorCode' => 'UnknownException', 'errorMessage' => 'An internal server error occurred.', 'description' => ''], + ['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''], + ['errorCode' => 'ConnectionDVException', 'errorMessage' => 'Failed to obtain collection.', 'description' => 'internalError'], + ['errorCode' => 'Console.CallServiceError', 'errorMessage' => 'An internal service error occurred.', 'description' => ''], + ['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request timed out while extracting features.', 'description' => ''], + ['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => ''], + ['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => ''], + ['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => ''], + ['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => ''], + ['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request timed out.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Compare image similarity', + 'summary' => 'Compares two images and returns a similarity score.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imagesearch:CompareSimilarByImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"Head\\": {\\n \\"DocsFound\\": 10,\\n \\"DocsReturn\\": 10000,\\n \\"SearchTime\\": 95\\n },\\n \\"RequestId\\": \\"36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1\\",\\n \\"Auctions\\": [\\n {\\n \\"ProductId\\": \\"2092061_1\\",\\n \\"PicName\\": \\"2092061_1.jpg\\",\\n \\"CategoryId\\": 20,\\n \\"SortExprValues\\": \\"5.37633353624177e+24;0\\",\\n \\"CustomContent\\": \\"zidingyi\\",\\n \\"Score\\": 1,\\n \\"IntAttr\\": 2,\\n \\"IntAttr2\\": 20,\\n \\"StrAttr\\": \\"ss\\",\\n \\"StrAttr2\\": \\"test\\",\\n \\"StrAttr3\\": \\"test\\",\\n \\"StrAttr4\\": \\"test\\",\\n \\"IntAttr3\\": 1,\\n \\"IntAttr4\\": 1\\n }\\n ],\\n \\"Code\\": 0,\\n \\"PicInfo\\": {\\n \\"Region\\": \\"280,486,232,351\\",\\n \\"CategoryId\\": 20,\\n \\"MultiRegion\\": [\\n {\\n \\"Region\\": \\"280,486,232,351\\"\\n }\\n ],\\n \\"AllCategories\\": [\\n {\\n \\"Name\\": \\"other\\",\\n \\"Id\\": 88888888\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - '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.', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], - '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', - ], + 'DeleteImage' => [ + 'summary' => 'This topic describes the syntax and examples of the DeleteImage operation, which is used to delete image information from an Image Search instance.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREimagesearchF4L5JA', - ], + 'abilityTreeNodes' => ['FEATUREimagesearchIT4SIC'], ], 'parameters' => [ [ 'name' => 'InstanceName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the Image Search instance. The name can be up to 20 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'demoinstance1', - ], + 'schema' => ['description' => 'The name of the Image Search instance. The name can be up to 20 characters in length.'."\n" + .'If you have purchased an Image Search instance, log on to the [Image Search console](https://imagesearch.console.aliyun.com/) to view the instance name.'."\n" + .'If you have not purchased an Image Search instance, refer to [Activate the service](~~179178~~) and [Create an instance](~~66569~~).'."\n" + .'>The instance name is not the instance ID. The instance name must be unique within the same region. Make sure you distinguish between the two.', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1', 'title' => ''], ], [ - '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', + 'name' => 'ProductId', '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', - ], + 'schema' => ['description' => 'The product ID.'."\n" + ."\n" + .'> 1. A product can have multiple images. 2. If IsDeleteByFilter is set to false, this parameter is required.', 'type' => 'string', 'required' => false, 'example' => '2092061_1', 'title' => ''], ], [ - 'name' => 'Num', + 'name' => 'PicName', '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', - ], + 'schema' => ['description' => 'The image name.'."\n" + .' - If you do not specify this parameter, all images under the specified ProductId are deleted.'."\n" + .' - If you specify this parameter, the image specified by ProductId and PicName is deleted.', 'type' => 'string', 'required' => false, 'example' => '2092061_1.jpg', 'title' => ''], ], [ - 'name' => 'Start', + 'name' => 'IsDeleteByFilter', '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', - ], + 'schema' => ['description' => 'Specifies whether to delete images based on the Filter field.'."\n" + .'> 1. If this parameter is set to true, images are deleted based on Filter or Filter+ProductId, and Filter is required. 2. If this parameter is set to false, images are deleted based on ProductId or ProductId+PicName, and ProductId is required.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The filter condition. The int_attr field supports the following operators: greater than (>), greater than or equal to (>=), less than (<), less than or equal to (<=), and equal to (=). The str_attr field supports the following operators: equal to (=) and not equal to (!=). Multiple conditions can be connected by using AND and OR.'."\n" + .'Examples:'."\n" + .'- int_attr >= 100.'."\n" + .'- str_attr != "value1".'."\n" + .'- int_attr = 1000 AND str_attr = "value1".'."\n" + .'>A maximum of 4096 characters are supported.', 'type' => 'string', 'required' => false, 'example' => 'int_attr=1000 AND str_attr="value1"', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'The response object.', '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", + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0703956F-9BCC-48FA-99F7-96C0BF449C69', 'title' => ''], + 'Code' => ['description' => 'The error code. Valid values:'."\n" + .'- 0: success.'."\n" + .'- Non-zero value: failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The deletion result.', '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", + 'PicNames' => [ + 'description' => 'The deleted PicName values.', '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', - ], - ], - ], + 'items' => ['description' => 'The deleted PicName values.', 'type' => 'string', 'example' => 'xxx.jpg', 'title' => ''], + 'example' => '5555.jpg', + 'title' => '', ], ], - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'BadRequest', - 'errorMessage' => 'The request has invalid parameters.', - ], - [ - 'errorCode' => 'InstanceStatusError', - 'errorMessage' => 'Your instance is unavailable.', - ], - [ - 'errorCode' => 'TimeoutForTransferImage', - 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', - ], - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'NoCaretSeperator', - 'errorMessage' => 'The body content is missing the ^ separator.', - ], - [ - 'errorCode' => 'EmptyMeta', - 'errorMessage' => 'The body content has an empty meta field.', - ], - [ - 'errorCode' => 'InvalidMetaItem', - 'errorMessage' => 'The meta field is invalid.', - ], - [ - 'errorCode' => 'NoPicList', - 'errorMessage' => 'The body content is missing the pic_list parameter.', - ], - [ - 'errorCode' => 'InvalidPicList', - 'errorMessage' => 'The specified pic_list parameter is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedPic', - 'errorMessage' => 'he content of an image is not specified in the HTTP POST body.', - ], - [ - 'errorCode' => 'NoSpecifiedSearchPic', - 'errorMessage' => 'The search image is not specified.', - ], - [ - 'errorCode' => 'InvalidCategory', - 'errorMessage' => 'The specified category is invalid.', - ], - [ - 'errorCode' => 'OverflowMaxResultNum', - 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', - ], - [ - 'errorCode' => 'OverflowMaxReturnNum', - 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', - ], - [ - 'errorCode' => 'InvalidStartParameter', - 'errorMessage' => 'The specified parameter start is inavlid.', - ], - [ - 'errorCode' => 'InvalidNumParameter', - 'errorMessage' => 'The specified parameter num is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedAddPic', - 'errorMessage' => 'The image to insert is not specified.', - ], - [ - 'errorCode' => 'NoSpecifiedItemId', - 'errorMessage' => 'The item_id parameter is not specified.', - ], - [ - 'errorCode' => 'InvalidIntAttr', - 'errorMessage' => 'The specified int_attr field is invalid.', - ], - [ - 'errorCode' => 'UnsupportedPicFormat', - 'errorMessage' => 'The specified image format is invalid.', - ], - [ - 'errorCode' => 'InvalidFilterClause', - 'errorMessage' => 'The specified filtering condition is invalid.', - ], - [ - 'errorCode' => 'InstanceOverQuota', - 'errorMessage' => 'The number of items exceeds the limit.', - ], - [ - 'errorCode' => 'IncorrectOrientation', - 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', - ], - [ - 'errorCode' => 'UnsupportedPicPixels', - 'errorMessage' => 'The specified pixels is not supported.', - ], - [ - 'errorCode' => 'SearchTimeout', - 'errorMessage' => 'The request is timed out.', - ], - [ - 'errorCode' => 'PicNotExist', - 'errorMessage' => 'The search picture does not exist.', - ], - [ - 'errorCode' => 'NoSpecifiedProductId', - 'errorMessage' => 'The parameter ProductId no specified.', - ], - [ - 'errorCode' => 'NoSpecifiedPicName', - 'errorMessage' => 'The parameter PicName no specified.', - ], - [ - 'errorCode' => 'NoSpecifiedPicContent', - 'errorMessage' => 'The parameter PicContent no specified.', - ], - [ - 'errorCode' => 'InvalidType', - 'errorMessage' => 'The specified parameter Type is not valid.', - ], - [ - 'errorCode' => 'InvalidProductId', - 'errorMessage' => 'The specified parameter ProductId is not valid.', - ], - [ - 'errorCode' => 'InvalidPicName', - 'errorMessage' => 'The specified parameter PicName is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr', - 'errorMessage' => 'The specified parameter StrAttr is not valid.', - ], - [ - 'errorCode' => 'InvalidCustomContent', - 'errorMessage' => 'The specified parameter CustomContent is not valid.', - ], - [ - 'errorCode' => 'InvalidPicContent', - 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', - ], - [ - 'errorCode' => 'InvalidPicUrl', - 'errorMessage' => 'The search picture does not exist at the specific url.', - ], - [ - 'errorCode' => 'InvalidInstanceName', - 'errorMessage' => 'The parameter instanceName is not specified.', - ], - [ - 'errorCode' => 'InvalidRequestId', - 'errorMessage' => 'The parameter requestId is not specified.', - ], - [ - 'errorCode' => 'InvalidRequestIdTooLarge', - 'errorMessage' => 'The parameter requestId is too large.', - ], - [ - 'errorCode' => 'InvalidRegion', - 'errorMessage' => 'The specific region is illegal', - ], - [ - 'errorCode' => 'InvalidIntAttr4', - 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr3', - 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr2', - 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr4', - 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr3', - 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr2', - 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', - ], - [ - 'errorCode' => 'PictureError', - 'errorMessage' => '[download] Img Download Failed.', - ], - [ - 'errorCode' => 'UnsupportedOperationType', - 'errorMessage' => 'The specified action is not supported.', - ], - [ - 'errorCode' => 'UnsupportedInstanceType', - 'errorMessage' => 'The instance type is not supported.', - ], + ['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''], + ['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => ''], + ['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => ''], + ['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => ''], + ['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => ''], + ['errorCode' => 'InvalidPicList', 'errorMessage' => 'The specified pic_list parameter is invalid.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'The content of an image is not specified in the HTTP POST body.', 'description' => ''], + ['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''], + ['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => ''], + ['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => ''], + ['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => ''], + ['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter s is inavlid.', 'description' => ''], + ['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter n is invalid.', 'description' => ''], + ['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''], + ['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => ''], + ['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => ''], + ['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => ''], + ['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => ''], + ['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => ''], + ['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => ''], + ['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''], + ['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'You must specify ProductId.', 'description' => ''], + ['errorCode' => 'InvalidIntAttr4', 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', 'description' => 'Invalid'], + ['errorCode' => 'InvalidIntAttr3', 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', 'description' => 'Invalid IntAttr3'], + ['errorCode' => 'InvalidIntAttr2', 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', 'description' => 'Invalid IntAttr2'], + ['errorCode' => 'InvalidStrAttr4', 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', 'description' => 'Invalid StrAttr4'], + ['errorCode' => 'InvalidStrAttr3', 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', 'description' => 'Invalid StrAttr3'], + ['errorCode' => 'InvalidStrAttr2', 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', 'description' => 'Invalid'], + ['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => 'Invalid StrAttr'], + ['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => ''], + ['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation.', - ], - [ - 'errorCode' => 'DeniedRequest', - 'errorMessage' => 'Your request was denied due to instance flow control.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => ''], + ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'UnknownException', - 'errorMessage' => 'An internal server error occurred.', - ], - [ - 'errorCode' => 'NetworkException', - 'errorMessage' => 'A network error occurred.', - ], - [ - 'errorCode' => 'RequestTimeout', - 'errorMessage' => 'The request is timeout.', - ], - [ - 'errorCode' => 'ExtractFeatureTimeout', - 'errorMessage' => 'The request was timed out while extracting features.', - ], - [ - 'errorCode' => 'AccessEngineFailed', - 'errorMessage' => 'An error occurred while accessing the search engine.', - ], - [ - 'errorCode' => 'InternalOssError', - 'errorMessage' => 'An internal OAS error occurred.', - ], - [ - 'errorCode' => 'InternalSwiftError', - 'errorMessage' => 'An internal SWIFT error occurred.', - ], - [ - 'errorCode' => 'InternalTableStoreError', - 'errorMessage' => 'An internal Table Store error occurred.', - ], - [ - 'errorCode' => 'ConnectionDVException', - 'errorMessage' => 'Failed to obtain collection.', - ], - ], - ], - '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" + ['errorCode' => 'UnknownlException', 'errorMessage' => 'An internal server error occurred.', 'description' => ''], + ['errorCode' => 'UnknownException', 'errorMessage' => 'An internal server error occurred.', 'description' => ''], + ['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => ''], + ['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''], + ['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''], + ['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''], + ['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => ''], + ['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => ''], + ['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Delete an image', + 'description' => '## Usage notes'."\n" + .'This operation is used to delete image information from an Image Search instance.'."\n" + .'>- If the specified image does not exist in the Image Search instance, this operation still returns a success response. Do not use the response to determine whether the image exists.'."\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', - ], + .'## QPS limit'."\n" + .'The default concurrency for delete operations is 20, which means a maximum of 20 delete requests can be processed per second.', + 'extraInfo' => '## Error codes'."\n" + .'For more information, see [Error codes](~~66619~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteImage'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imagesearch:DeleteImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'SearchTimeout', - 'errorMessage' => 'The request timed out.', - ], - [ - 'errorCode' => 'TimeoutForTransferImage', - 'errorMessage' => 'Image transfer timed out.', - ], - [ - 'errorCode' => 'UnsupportedPicFormat', - 'errorMessage' => 'The specified image format is invalid.', - ], - [ - 'errorCode' => 'UnsupportedPicPixels', - 'errorMessage' => 'The specified pixels is not supported.', - ], - [ - 'errorCode' => 'UnsupportedPictureFormat', - 'errorMessage' => 'The format of the specified picture is not supported.', - ], - [ - 'errorCode' => 'Console.InstanceNotFound', - 'errorMessage' => 'The specified ImageSearch instance is not found.', - ], - [ - 'errorCode' => 'Console.PidError', - 'errorMessage' => 'The number of PID bindings of the current instance exceeds 50.', - ], - [ - 'errorCode' => 'EmptyMeta', - 'errorMessage' => 'The body content has an empty meta field.', - ], - [ - 'errorCode' => 'IncorrectOrientation', - 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', - ], - [ - 'errorCode' => 'InstanceOverQuota', - 'errorMessage' => 'The number of items exceeds the limit.', - ], - [ - 'errorCode' => 'InstanceStatusError', - 'errorMessage' => 'The current instance status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'InvalidPicContent', - 'errorMessage' => 'The image size exceeds 4 MB.', - ], - [ - 'errorCode' => 'InvalidPicUrl', - 'errorMessage' => 'The specified parameter PicUrl is not valid.', - ], - [ - 'errorCode' => 'NeedRegisterBeforeInvoke', - 'errorMessage' => 'Register for PID before invoking the service.', - ], - [ - 'errorCode' => 'NoCaretSeperator', - 'errorMessage' => 'The body content is missing the ^ separator.', - ], - [ - 'errorCode' => 'NoSpecifiedPic', - 'errorMessage' => 'The content of an image is not specified in the HTTP POST body.', - ], - [ - 'errorCode' => 'PicNotExist', - 'errorMessage' => 'The specified image does not exist.', - ], - [ - 'errorCode' => 'InvalidSecondaryPicContent', - 'errorMessage' => 'The specified parameter SecondaryPicContent is not valid.', - ], - [ - 'errorCode' => 'InvalidPrimaryPicContent', - 'errorMessage' => 'The specified parameter PrimaryPicContent is not valid.', - ], - [ - 'errorCode' => 'PictureError', - 'errorMessage' => '[download] Img Download Failed.', - ], - [ - 'errorCode' => 'UnsupportedOperationType', - 'errorMessage' => 'The specified action is not supported.', - ], - [ - 'errorCode' => 'UnsupportedInstanceType', - 'errorMessage' => 'The instance type is not supported.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Console.NoPermissionError', - 'errorMessage' => 'You are not authorized to perform this operation.', - ], - [ - 'errorCode' => 'Console.NotAllowedModifyToken', - 'errorMessage' => 'You are not allowed to modify token today.', - ], - [ - 'errorCode' => 'DeniedRequest', - 'errorMessage' => 'Your request was denied due to instance flow control.', - ], - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation.', - ], - ], - 409 => [ - [ - 'errorCode' => 'Console.TaskAlreadyExist', - 'errorMessage' => 'A task that is in progress already exists.', - ], - ], - 500 => [ - [ - 'errorCode' => 'ServerInternalError', - 'errorMessage' => 'An internal error occurred.', - ], - [ - 'errorCode' => 'UnknownException', - 'errorMessage' => 'An internal server error occurred.', - ], - [ - 'errorCode' => 'AccessEngineFailed', - 'errorMessage' => 'An error occurred while accessing the search engine.', - ], - [ - 'errorCode' => 'ConnectionDVException', - 'errorMessage' => 'Failed to obtain collection.', - ], - [ - 'errorCode' => 'Console.CallServiceError', - 'errorMessage' => 'An internal service error occurred.', - ], - [ - 'errorCode' => 'ExtractFeatureTimeout', - 'errorMessage' => 'The request timed out while extracting features.', - ], - [ - 'errorCode' => 'InternalOssError', - 'errorMessage' => 'An internal OAS error occurred.', - ], - [ - 'errorCode' => 'InternalSwiftError', - 'errorMessage' => 'An internal SWIFT error occurred.', - ], - [ - 'errorCode' => 'InternalTableStoreError', - 'errorMessage' => 'An internal Table Store error occurred.', - ], - [ - 'errorCode' => 'NetworkException', - 'errorMessage' => 'A network error occurred.', - ], - [ - 'errorCode' => 'RequestTimeout', - 'errorMessage' => 'The request timed out.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Score\\": 0.85,\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Msg\\": \\"success\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalDisplayName\\": \\"111\\",\\n \\"AuthPrincipalOwnerId\\": \\"222\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"xxxxxx\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"AccountLevelIdentityBasedPolicy\\"\\n },\\n \\"Code\\": 0\\n}","errorExample":""},{"type":"xml","example":"<CompareSimilarByImageResponse>\\n <Score>0.85</Score>\\n <Success>true</Success>\\n <RequestId>B3137727-7D6E-488C-BA21-0E034C38A879</RequestId>\\n <Msg>success</Msg>\\n <AccessDeniedDetail>\\n <AuthAction>xxx</AuthAction>\\n <AuthPrincipalDisplayName>111</AuthPrincipalDisplayName>\\n <AuthPrincipalOwnerId>222</AuthPrincipalOwnerId>\\n <AuthPrincipalType>SubUser</AuthPrincipalType>\\n <EncodedDiagnosticMessage>xxxxxx</EncodedDiagnosticMessage>\\n <NoPermissionType>ImplicitDeny</NoPermissionType>\\n <PolicyType>AccountLevelIdentityBasedPolicy</PolicyType>\\n </AccessDeniedDetail>\\n <Code>0</Code>\\n</CompareSimilarByImageResponse>","errorExample":""}]', ], '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', - ], + 'summary' => 'This topic describes the syntax and examples of the Detail operation, which queries information about an Image Search instance by name.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2399,159 +861,99 @@ [ 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'imagesearchName', - ], + 'schema' => ['description' => 'The name of the Image Search instance. The name can be up to 20 characters in length.'."\n" + .'If you have purchased an Image Search instance, log on to the [Image Search console](https://imagesearch.console.aliyun.com/) to view the instance name.'."\n" + .'If you have not purchased an Image Search instance, refer to [Activate the service](~~179178~~) and [Create an instance](~~66569~~).'."\n" + .'>The instance name is not the instance ID. Instance names must be unique within the same region. Make sure you distinguish between the two.', 'type' => 'string', 'required' => true, 'example' => 'imagesearchName', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'The response parameters.', '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', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Instance' => [ - 'description' => 'The details about the instance.'."\n", + 'description' => 'The instance information.', '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', - ], + 'Capacity' => ['description' => 'The maximum image capacity of the plan. Unit: 10,000.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'UtcExpireTime' => ['description' => 'The time when the instance expires. Unit: milliseconds.', 'type' => 'string', 'example' => '1623081600000', 'title' => ''], + 'UtcCreate' => ['description' => 'The creation time of the instance. Unit: milliseconds.', 'type' => 'string', 'example' => '1620382716000', 'title' => ''], + 'ServiceType' => ['description' => 'The Image Search model.'."\n" + ."\n" + .'<props="intl">Valid values: 0: product image search. 1: generic image search.</props>'."\n" + .'<props="china">Valid values: 0: product image search. 1: generic image search. 2: fabric search. 3 and 7: trademark search. 4: copyright search. 5: furniture search. 6: hardware search.</props>.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Region' => ['description' => 'The region information.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], + 'Name' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'imagesearchName', 'title' => ''], + 'TotalCount' => ['description' => 'The number of images.', 'type' => 'integer', 'format' => 'int64', 'example' => '10063', 'title' => ''], + 'Qps' => ['description' => 'The QPS of the plan.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'DeniedRequest', - 'errorMessage' => 'Your request was denied due to instance flow control.', - ], - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'Console.BadRequest', - 'errorMessage' => 'The request has invalid parameters.', - ], - [ - 'errorCode' => 'Console.InstanceNotFound', - 'errorMessage' => 'The specified ImageSearch instance is not found.', - ], + ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => ''], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => ''], + ['errorCode' => 'Console.BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => 'Invalid request. Check the request parameters.'], + ['errorCode' => 'Console.InstanceNotFound', 'errorMessage' => 'The specified ImageSearch instance is not found.', 'description' => 'The specified instance ID does not exist. Check the instance ID and try again.'], ], [ - [ - 'errorCode' => 'Console.LoginError', - 'errorMessage' => 'Check login failed.', - ], + ['errorCode' => 'Console.LoginError', 'errorMessage' => 'Check login failed.', 'description' => 'Login failed, please check whether the user name, password and email address are entered incorrectly.'], ], 403 => [ - [ - 'errorCode' => 'Console.NoPermission', - 'errorMessage' => 'You are not authorized to this operation.', - ], + ['errorCode' => 'Console.NoPermission', 'errorMessage' => 'You are not authorized to this operation.', 'description' => ''], ], 409 => [ - [ - 'errorCode' => 'Console.InstanceStatusError', - 'errorMessage' => 'Current Instance status not supported this opreate.', - ], - [ - 'errorCode' => 'Console.OrderStatusError', - 'errorMessage' => 'Current Order status not supported this opreate.', - ], - [ - 'errorCode' => 'Console.IncrementStatusError', - 'errorMessage' => 'Current Increment status not supported this opreate.', - ], + ['errorCode' => 'Console.InstanceStatusError', 'errorMessage' => 'Current Instance status not supported this opreate.', 'description' => ''], + ['errorCode' => 'Console.OrderStatusError', 'errorMessage' => 'Current Order status not supported this opreate.', 'description' => 'User order error, please confirm that the order is valid'], + ['errorCode' => 'Console.IncrementStatusError', 'errorMessage' => 'Current Increment status not supported this opreate.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'Console.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - [ - 'errorCode' => 'Console.CallServiceError', - 'errorMessage' => 'Fail to call service.', - ], + ['errorCode' => 'Console.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'The server has an internal error. Log on to the Alibaba Cloud console to submit a ticket.'], + ['errorCode' => 'Console.CallServiceError', 'errorMessage' => 'Fail to call service.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1\\",\\n \\"Success\\": true,\\n \\"Instance\\": {\\n \\"Capacity\\": 10,\\n \\"UtcExpireTime\\": \\"1623081600000\\",\\n \\"UtcCreate\\": \\"1620382716000\\",\\n \\"ServiceType\\": 0,\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"Name\\": \\"imagesearchName\\",\\n \\"TotalCount\\": 10063,\\n \\"Qps\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<DetailResponse>\\n <RequestId>36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1</RequestId>\\n <Success>true</Success>\\n <Instance>\\n <Name>imagesearchName</Name>\\n <UtcExpireTime>1623081600000</UtcExpireTime>\\n <TotalCount>10063</TotalCount>\\n <UtcCreate>1620382716000</UtcCreate>\\n <Capacity>10</Capacity>\\n <Qps>1</Qps>\\n <ServiceType>0</ServiceType>\\n <Region>cn-shanghai</Region>\\n </Instance>\\n</DetailResponse>","errorExample":""}]', - 'description' => 'This operation queries instance details.'."\n" + 'title' => 'Query instance status', + 'description' => '## Operation description'."\n" + .'This operation queries instance information from an Image Search instance.'."\n" + .'> For more product details or technical support, click [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) or contact us through DingTalk group (35035130).'."\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.', + .'## QPS limit'."\n" + .'The default concurrency for query operations is 1, which means a maximum of 1 request is processed per second.', + 'extraInfo' => '## Error codes'."\n" + .'For more information, see [Error codes](~~66619~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'imagesearch:Detail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], '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', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2564,129 +966,95 @@ [ 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'maximum' => '10000000', - 'minimum' => '1', - 'example' => 'imagesearchName', - ], + 'schema' => ['description' => 'The name of the Image Search instance. The name can be up to 20 characters in length.'."\n" + .'If you have purchased an Image Search instance, log on to the [Image Search console](https://imagesearch.console.aliyun.com/) to view the instance name.'."\n" + .'If you have not purchased an Image Search instance, refer to [Activate the service](~~179178~~) and [Create an instance](~~66569~~).'."\n" + .'>The instance name is not the instance ID. Make sure you distinguish between them.', 'type' => 'string', 'required' => true, 'maximum' => '10000000', 'minimum' => '1', 'example' => 'imagesearchName', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'The response parameters.', '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', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The information about the export task.'."\n", + 'description' => 'The returned result of the task execution.', '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', - ], + 'DumpMetaStatus' => ['description' => 'The status of the metadata export task. Valid values:'."\n" + .'- PROCESSING: The task is being processed.'."\n" + .'- FAIL: The task failed.'."\n" + .'- SUCCESS: The task is completed.', 'type' => 'string', 'example' => 'PROCESSING', 'title' => ''], + 'Id' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '500', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'Console.BadRequest', - 'errorMessage' => 'The request has invalid parameters.', - ], - [ - 'errorCode' => 'Console.InstanceNotFound', - 'errorMessage' => 'The specified ImageSearch instance is not found.', - ], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => ''], + ['errorCode' => 'Console.BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => 'Invalid request. Check the request parameters.'], + ['errorCode' => 'Console.InstanceNotFound', 'errorMessage' => 'The specified ImageSearch instance is not found.', 'description' => 'The specified instance ID does not exist. Check the instance ID and try again.'], ], [ - [ - 'errorCode' => 'Console.LoginError', - 'errorMessage' => 'Check login failed.', - ], + ['errorCode' => 'Console.LoginError', 'errorMessage' => 'Check login failed.', 'description' => 'Login failed, please check whether the user name, password and email address are entered incorrectly.'], ], 403 => [ - [ - 'errorCode' => 'Console.NoPermission', - 'errorMessage' => 'You are not authorized to this operation.', - ], + ['errorCode' => 'Console.NoPermission', 'errorMessage' => 'You are not authorized to this operation.', 'description' => ''], ], 409 => [ - [ - 'errorCode' => 'Console.InstanceStatusError', - 'errorMessage' => 'Current Instance status not supported this opreate.', - ], - [ - 'errorCode' => 'Console.OrderStatusError', - 'errorMessage' => 'Current Order status not supported this opreate.', - ], - [ - 'errorCode' => 'Console.IncrementStatusError', - 'errorMessage' => 'Current Increment status not supported this opreate.', - ], - [ - 'errorCode' => 'Console.TaskAlreadyExist', - 'errorMessage' => 'A task that is in progress already exists.', - ], + ['errorCode' => 'Console.InstanceStatusError', 'errorMessage' => 'Current Instance status not supported this opreate.', 'description' => ''], + ['errorCode' => 'Console.OrderStatusError', 'errorMessage' => 'Current Order status not supported this opreate.', 'description' => 'User order error, please confirm that the order is valid'], + ['errorCode' => 'Console.IncrementStatusError', 'errorMessage' => 'Current Increment status not supported this opreate.', 'description' => ''], + ['errorCode' => 'Console.TaskAlreadyExist', 'errorMessage' => 'A task that is in progress already exists.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'Console.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - [ - 'errorCode' => 'Console.CallServiceError', - 'errorMessage' => 'An internal service error occurred.', - ], + ['errorCode' => 'Console.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'The server has an internal error. Log on to the Alibaba Cloud console to submit a ticket.'], + ['errorCode' => 'Console.CallServiceError', 'errorMessage' => 'An internal service error occurred.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DumpMetaStatus\\": \\"PROCESSING\\",\\n \\"Id\\": \\"500\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'description' => 'This operation creates a task for exporting metadata from an Image Search instance.'."\n" - ."\n" - .'## QPS limits'."\n" + 'title' => 'Export metadata', + 'summary' => 'This topic describes the syntax and examples of the DumpMeta operation, which creates a metadata export task for Image Search by name.', + 'description' => '## Operation description'."\n" + .'This operation submits a metadata export task to an Image Search instance.'."\n" + .'> For more product details and technical support, click [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) or contact us through DingTalk group (35035130).'."\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.', + .'## QPS limit'."\n" + .'The default concurrency for submit operations is 1, which means a maximum of 1 request is processed per second.'."\n" + .'> You cannot submit a new metadata export task while the previous metadata export task is still in progress.', + 'extraInfo' => '## Error codes'."\n" + .'For more information, see [Error codes](~~66619~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'imagesearch:DumpMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DumpMetaStatus\\": \\"PROCESSING\\",\\n \\"Id\\": \\"500\\"\\n }\\n}","type":"json"}]', ], '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', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2699,216 +1067,134 @@ [ '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', - ], + 'schema' => ['description' => 'The name of the Image Search instance. The name can be up to 20 characters in length.'."\n" + .'If you have purchased an Image Search instance, log on to the [Image Search console](https://imagesearch.console.aliyun.com/) to view the instance name.'."\n" + .'If you have not purchased an Image Search instance, refer to [Activate the service](~~179178~~) and [Create an instance](~~66569~~).'."\n" + .'>The instance name is not the instance ID. The instance name must be unique within the same region. Make sure you distinguish between the two.', 'type' => 'string', 'required' => true, 'maximum' => '10000000', 'minimum' => '1', 'example' => 'demoinstance1', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the export task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '500', - ], + 'schema' => ['description' => 'The ID of the metadata export task.'."\n" + .'>To obtain the export task ID, call the [metadata export](~~377466~~) operation first and retrieve the ID from the response.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '500', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The number of entries to return. Default value: 10. Maximum value: 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'exclusiveMaximum' => true, 'minimum' => '1', 'example' => '10', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The page number of the returned results. Default value: 1. Maximum value: 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', 'title' => ''], 'Data' => [ - 'description' => 'The information about the task that is used to export metadata.'."\n", + 'description' => 'The metadata export information.', 'type' => 'object', 'properties' => [ 'DumpMetaList' => [ - 'description' => 'A list of tasks that are used to export metadata.'."\n", + 'description' => 'The collection of metadata export tasks.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The details of a metadata export task.', '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', - ], + 'Status' => ['description' => 'The task status. Valid values:'."\n" + .'- PROCESSING: The task is being processed.'."\n" + .'- FAIL: The task failed.'."\n" + .'- SUCCESS: The task is completed.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Msg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'UtcModified' => ['description' => 'The time when the task was last updated. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1629095760000', 'title' => ''], + 'MetaUrl' => ['description' => 'The URL for downloading the result. The URL is valid for two hours.', 'type' => 'string', 'example' => 'https://imagesearchname.oss-cn-shanghai.aliyuncs.com/xxx', 'title' => ''], + 'UtcCreate' => ['description' => 'The time when the task was created. Unit: milliseconds.', 'type' => 'string', 'example' => '1629095713000', 'title' => ''], + 'Code' => ['description' => 'The error code. Valid values:'."\n" + ."\n" + .'- 0: Succeeded.'."\n" + .'- Non-zero: Failed.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Id' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '500', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - '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', - ], + 'PageSize' => ['description' => 'The number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'Console.BadRequest', - 'errorMessage' => 'The request has invalid parameters.', - ], - [ - 'errorCode' => 'Console.InstanceNotFound', - 'errorMessage' => 'The specified ImageSearch instance is not found.', - ], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => ''], + ['errorCode' => 'Console.BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => 'Invalid request. Check the request parameters.'], + ['errorCode' => 'Console.InstanceNotFound', 'errorMessage' => 'The specified ImageSearch instance is not found.', 'description' => 'The specified instance ID does not exist. Check the instance ID and try again.'], ], [ - [ - 'errorCode' => 'Console.LoginError', - 'errorMessage' => 'Check login failed.', - ], + ['errorCode' => 'Console.LoginError', 'errorMessage' => 'Check login failed.', 'description' => 'Login failed, please check whether the user name, password and email address are entered incorrectly.'], ], 403 => [ - [ - 'errorCode' => 'Console.NoPermission', - 'errorMessage' => 'You are not authorized to this operation.', - ], + ['errorCode' => 'Console.NoPermission', 'errorMessage' => 'You are not authorized to this operation.', 'description' => ''], ], 409 => [ - [ - 'errorCode' => 'Console.InstanceStatusError', - 'errorMessage' => 'Current Instance status not supported this opreate.', - ], - [ - 'errorCode' => 'Console.OrderStatusError', - 'errorMessage' => 'Current Order status not supported this opreate.', - ], - [ - 'errorCode' => 'Console.IncrementStatusError', - 'errorMessage' => 'Current Increment status not supported this opreate.', - ], + ['errorCode' => 'Console.InstanceStatusError', 'errorMessage' => 'Current Instance status not supported this opreate.', 'description' => ''], + ['errorCode' => 'Console.OrderStatusError', 'errorMessage' => 'Current Order status not supported this opreate.', 'description' => 'User order error, please confirm that the order is valid'], + ['errorCode' => 'Console.IncrementStatusError', 'errorMessage' => 'Current Increment status not supported this opreate.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'Console.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - [ - 'errorCode' => 'Console.CallServiceError', - 'errorMessage' => 'An internal service error occurred.', - ], + ['errorCode' => 'Console.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'The server has an internal error. Log on to the Alibaba Cloud console to submit a ticket.'], + ['errorCode' => 'Console.CallServiceError', 'errorMessage' => 'An internal service error occurred.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Data\\": {\\n \\"DumpMetaList\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Msg\\": \\"success\\",\\n \\"UtcModified\\": 1629095760000,\\n \\"MetaUrl\\": \\"https://imagesearchname.oss-cn-shanghai.aliyuncs.com/xxx\\",\\n \\"UtcCreate\\": \\"1629095713000\\",\\n \\"Code\\": \\"0\\",\\n \\"Id\\": 500\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 15\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'description' => 'This operation queries tasks that are used for exporting metadata from an Image Search instance.'."\n" + 'title' => 'Query metadata export tasks', + 'summary' => 'Describes the syntax and provides examples of the DumpMetaList operation, which queries the list of metadata export tasks in an Image Search instance.', + 'description' => '## Operation description'."\n" + .'This operation queries metadata export tasks in an Image Search instance.'."\n" + .'> For more product details and technical support, click [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) or contact us through DingTalk group (35035130).'."\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.', + .'## QPS limit'."\n" + .'The default concurrency for query operations is 1, which means a maximum of 1 request is processed per second.', + 'extraInfo' => '## Error codes'."\n" + .'For more information, refer to [Error codes](~~66619~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'imagesearch:DumpMetaList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], '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', - ], + 'summary' => 'Describes the syntax and provides examples of the IncreaseInstance operation, which is used to create a batch task for an Image Search instance by name.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2920,155 +1206,110 @@ [ 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'imagesearchName', - ], + 'schema' => ['description' => 'The name of the Image Search instance. The name can be up to 20 characters in length.'."\n" + .'If you have purchased an Image Search instance, log on to the [Image Search console](https://imagesearch.console.aliyun.com/) to view the instance name.'."\n" + .'If you have not purchased an Image Search instance, refer to [Activate the service](~~179178~~) and [Create an instance](~~66569~~).'."\n" + .'>The instance name is not the instance ID. Make sure that you distinguish between the two.', 'type' => 'string', 'required' => true, 'example' => 'imagesearchName', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The name of the bucket.'."\n" + .'> Only a bucket in the same region as the instance is supported.', 'type' => 'string', 'required' => true, 'example' => 'bucketName', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The absolute path of the increment.meta file in OSS. The path must start with a forward slash (/) and must not end with a forward slash (/).'."\n" + .'> Prepare the increment.meta file in advance. For more information, see [Batch operations](~~66580~~).', 'type' => 'string', 'required' => true, 'example' => '/xxx/xxx', 'title' => ''], ], [ 'name' => 'CallbackAddress', 'in' => 'query', - 'schema' => [ - 'description' => 'The callback address.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://xxxxx', - ], + 'schema' => ['description' => 'The callback URL of the task.', 'type' => 'string', 'required' => false, 'example' => 'http://xxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'The response parameters.', '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', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The information about the task.'."\n", + 'description' => 'The returned result of the task.', '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', - ], + 'IncrementStatus' => ['description' => 'The status of the batch task. Valid values:'."\n" + .'- PROCESSING: The task is being processed.'."\n" + .'- FAIL: The task failed.'."\n" + .'- SUCCESS: The task is complete.', 'type' => 'string', 'example' => 'PROCESSING', 'title' => ''], + 'Id' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '500', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'Console.BadRequest', - 'errorMessage' => 'The request has invalid parameters.', - ], - [ - 'errorCode' => 'Console.InstanceNotFound', - 'errorMessage' => 'The specified ImageSearch instance is not found.', - ], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => ''], + ['errorCode' => 'Console.BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => 'Invalid request. Check the request parameters.'], + ['errorCode' => 'Console.InstanceNotFound', 'errorMessage' => 'The specified ImageSearch instance is not found.', 'description' => 'The specified instance ID does not exist. Check the instance ID and try again.'], ], [ - [ - 'errorCode' => 'Console.LoginError', - 'errorMessage' => 'Check login failed.', - ], + ['errorCode' => 'Console.LoginError', 'errorMessage' => 'Check login failed.', 'description' => 'Login failed, please check whether the user name, password and email address are entered incorrectly.'], ], 403 => [ - [ - 'errorCode' => 'Console.NoPermission', - 'errorMessage' => 'You are not authorized to this operation.', - ], + ['errorCode' => 'Console.NoPermission', 'errorMessage' => 'You are not authorized to this operation.', 'description' => ''], ], 409 => [ - [ - 'errorCode' => 'Console.InstanceStatusError', - 'errorMessage' => 'Current Instance status not supported this opreate.', - ], - [ - 'errorCode' => 'Console.OrderStatusError', - 'errorMessage' => 'Current Order status not supported this opreate.', - ], - [ - 'errorCode' => 'Console.IncrementStatusError', - 'errorMessage' => 'Current Increment status not supported this opreate.', - ], + ['errorCode' => 'Console.InstanceStatusError', 'errorMessage' => 'Current Instance status not supported this opreate.', 'description' => ''], + ['errorCode' => 'Console.OrderStatusError', 'errorMessage' => 'Current Order status not supported this opreate.', 'description' => 'User order error, please confirm that the order is valid'], + ['errorCode' => 'Console.IncrementStatusError', 'errorMessage' => 'Current Increment status not supported this opreate.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'Console.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - [ - 'errorCode' => 'Console.CallServiceError', - 'errorMessage' => 'Fail to call service.', - ], + ['errorCode' => 'Console.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'The server has an internal error. Log on to the Alibaba Cloud console to submit a ticket.'], + ['errorCode' => 'Console.CallServiceError', 'errorMessage' => 'Fail to call service.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"IncrementStatus\\": \\"PROCESSING\\",\\n \\"Id\\": \\"500\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'description' => 'This operation creates a batch task on an Image Search instance.'."\n" - ."\n" - .'## QPS limits'."\n" + 'title' => 'Batch operations', + 'description' => '## Operation description'."\n" + .'This operation is used to submit a batch task to an Image Search instance.'."\n" + .'> <props="china">For more information about the product or technical support, click [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) or contact us by using DingTalk group 35035130.</props>'."\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.', + .'## QPS limit'."\n" + .'Only one batch task can run at a time.'."\n" + .'> You cannot submit a new batch task until the previous batch task is complete.', + 'extraInfo' => '## Error codes'."\n" + .'For more information, see [Error codes](~~66619~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'imagesearch:IncreaseInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"IncrementStatus\\": \\"PROCESSING\\",\\n \\"Id\\": \\"500\\"\\n }\\n}","type":"json"}]', ], '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', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3080,85 +1321,47 @@ [ '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', - ], + 'schema' => ['description' => 'The name of the Image Search instance. The name can be up to 20 characters in length.'."\n" + .'If you have purchased an Image Search instance, log on to the [Image Search console](https://imagesearch.console.aliyun.com/) to view the instance name.'."\n" + .'If you have not purchased an Image Search instance, refer to [Activate the service](~~179178~~) and [Create an instance](~~66569~~).'."\n" + .'>The instance name is not the instance ID. The instance name must be unique within the same region. Make sure you use the correct value.', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the batch task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '500', - ], + 'schema' => ['description' => 'The batch task ID.'."\n" + .'>To obtain the batch task ID, call the [batch operation](~~377468~~) first and retrieve the ID from the response.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '500', 'title' => ''], ], [ 'name' => 'BucketName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Object Storage Service (OSS) bucket.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bucketName', - ], + 'schema' => ['description' => 'The name of the bucket.', 'type' => 'string', 'required' => false, 'example' => 'bucketName', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The absolute path of the increment.meta file in OSS. The path must start with a forward slash (/) and must not end with a forward slash (/).', 'type' => 'string', 'required' => false, 'example' => '/xxx/xxx', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The number of entries to return. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '1', 'example' => '10', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The page number of the first page to return. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'exclusiveMaximum' => true, 'minimum' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', 'title' => ''], 'Data' => [ - 'description' => 'The information about the batch task.'."\n", + 'description' => 'The batch task information.', 'type' => 'object', 'properties' => [ 'Increments' => [ @@ -3166,167 +1369,108 @@ 'itemNode' => true, 'properties' => [ 'Instance' => [ - 'description' => 'A list of batch tasks.'."\n", + 'description' => 'The collection of batch tasks.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The details of the batch task.', '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', - ], + 'Msg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'sucess', 'title' => ''], + 'Status' => ['description' => 'The task status. Valid values:'."\n" + .'- PROCESSING: The task is being processed.'."\n" + .'- FAIL: The task failed.'."\n" + .'- SUCCESS: The task is completed.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'UtcModified' => ['description' => 'The time when the task was last updated. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1629095760000', 'title' => ''], + 'BucketName' => ['description' => 'The name of the bucket.', 'type' => 'string', 'example' => 'bucketName', 'title' => ''], + 'UtcCreate' => ['description' => 'The time when the task was created. Unit: milliseconds.', 'type' => 'string', 'example' => '1629095713000', 'title' => ''], + 'Code' => ['description' => 'The error code. Valid values:'."\n" + ."\n" + .'- 0: successful.'."\n" + .'- Non-zero: failed.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Path' => ['description' => 'The absolute path of the increment.meta file in OSS. The path must start with a forward slash (/) and must not end with a forward slash (/).', 'type' => 'string', 'example' => '/xx/xx', 'title' => ''], + 'ErrorUrl' => ['description' => 'The URL for downloading the result. The URL is valid for two hours.', 'type' => 'string', 'example' => 'https://imagesearchname.oss-cn-shanghai.aliyuncs.com/xxx', 'title' => ''], + 'Id' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '500', 'title' => ''], + 'CallbackAddress' => ['description' => 'The callback URL of the task.', 'type' => 'string', 'example' => 'http://xxxxx', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - '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', - ], + 'PageSize' => ['description' => 'The number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'Console.BadRequest', - 'errorMessage' => 'The request has invalid parameters.', - ], - [ - 'errorCode' => 'Console.InstanceNotFound', - 'errorMessage' => 'The specified ImageSearch instance is not found.', - ], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => ''], + ['errorCode' => 'Console.BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => 'Invalid request. Check the request parameters.'], + ['errorCode' => 'Console.InstanceNotFound', 'errorMessage' => 'The specified ImageSearch instance is not found.', 'description' => 'The specified instance ID does not exist. Check the instance ID and try again.'], ], [ - [ - 'errorCode' => 'Console.LoginError', - 'errorMessage' => 'Check login failed.', - ], + ['errorCode' => 'Console.LoginError', 'errorMessage' => 'Check login failed.', 'description' => 'Login failed, please check whether the user name, password and email address are entered incorrectly.'], ], 403 => [ - [ - 'errorCode' => 'Console.NoPermission', - 'errorMessage' => 'You are not authorized to this operation.', - ], + ['errorCode' => 'Console.NoPermission', 'errorMessage' => 'You are not authorized to this operation.', 'description' => ''], ], 409 => [ - [ - 'errorCode' => 'Console.InstanceStatusError', - 'errorMessage' => 'Current Instance status not supported this opreate.', - ], - [ - 'errorCode' => 'Console.OrderStatusError', - 'errorMessage' => 'Current Order status not supported this opreate.', - ], - [ - 'errorCode' => 'Console.IncrementStatusError', - 'errorMessage' => 'Current Increment status not supported this opreate.', - ], + ['errorCode' => 'Console.InstanceStatusError', 'errorMessage' => 'Current Instance status not supported this opreate.', 'description' => ''], + ['errorCode' => 'Console.OrderStatusError', 'errorMessage' => 'Current Order status not supported this opreate.', 'description' => 'User order error, please confirm that the order is valid'], + ['errorCode' => 'Console.IncrementStatusError', 'errorMessage' => 'Current Increment status not supported this opreate.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'Console.InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - [ - 'errorCode' => 'Console.CallServiceError', - 'errorMessage' => 'Fail to call service.', - ], + ['errorCode' => 'Console.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'The server has an internal error. Log on to the Alibaba Cloud console to submit a ticket.'], + ['errorCode' => 'Console.CallServiceError', 'errorMessage' => 'Fail to call service.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Data\\": {\\n \\"Increments\\": {\\n \\"Instance\\": [\\n {\\n \\"Msg\\": \\"sucess\\",\\n \\"Status\\": \\"SUCCESS\\",\\n \\"UtcModified\\": 1629095760000,\\n \\"BucketName\\": \\"bucketName\\",\\n \\"UtcCreate\\": \\"1629095713000\\",\\n \\"Code\\": \\"0\\",\\n \\"Path\\": \\"/xx/xx\\",\\n \\"ErrorUrl\\": \\"https://imagesearchname.oss-cn-shanghai.aliyuncs.com/xxx\\",\\n \\"Id\\": 500,\\n \\"CallbackAddress\\": \\"http://xxxxx\\"\\n }\\n ]\\n },\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 15\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'description' => 'This operation queries batch tasks on an Image Search instance.'."\n" - ."\n" - .'## QPS limits'."\n" + 'title' => 'List batch tasks', + 'summary' => 'Queries the list of batch tasks in an Image Search instance by calling the IncreaseList operation. This topic describes the syntax and provides examples.', + 'description' => '## Operation description'."\n" + .'This operation is used to query batch tasks in an Image Search instance.'."\n" + .'> For more product details or technical support, click [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) or contact us through DingTalk group (35035130).'."\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', + .'## QPS limit'."\n" + .'The default concurrency for query operations is 1, which means a maximum of 1 request is processed per second.', + 'extraInfo' => '## Error codes'."\n" + .'For more information, see [Error codes](~~66619~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'imagesearch:IncreaseList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'SearchImageByFilter' => [ + 'summary' => 'This topic describes the syntax and examples of SearchImageByFilter, which is used to query image information in an Image Search instance based on filter conditions.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3338,549 +1482,1042 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREimagesearchF4L5JA', - ], + '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" + .'If you have purchased an Image Search instance, you can log on to the [Image Search console](https://imagesearch.console.aliyun.com/) to view the instance name.'."\n" + .'If you have not purchased an Image Search instance, see [Activate the service](~~179178~~) and [Create an instance](~~66569~~).'."\n" + .'>The instance name is not the instance ID. Make sure that you can distinguish between them.', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1', 'title' => ''], + ], + [ + 'name' => 'Num', + 'in' => 'formData', + 'schema' => ['description' => 'The number of results to return. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Start', + 'in' => 'formData', + 'schema' => ['description' => 'The start position of the results to return. Valid values: 0 to 499. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '499', 'minimum' => '0', 'default' => '0', 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Filter', + 'in' => 'formData', + 'schema' => ['description' => 'The filter conditions. The operators supported by int_attr include in, not in, greater-than sign (>), greater-than-or-equal-to sign (>=), less-than sign (<), less-than-or-equal-to sign (<=), and equal sign (=). The operators supported by str_attr include in, not in, equal sign (=), and not-equal sign (!=). Multiple conditions can be connected by using AND and OR.'."\n" + .'Examples:'."\n" + .'- int_attr >= 100.'."\n" + .'- str_attr != "value1".'."\n" + .'- int_attr = 1000 AND str_attr = "value1".'."\n" + ."\n" + .'>A maximum of 4,096 characters are supported.', 'type' => 'string', 'required' => true, 'example' => 'int_attr=1000 AND str_attr="value1"', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'example' => 'demoinstance1', - 'required' => true, - 'type' => 'string', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'Msg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', 'title' => ''], + 'Auctions' => [ + 'description' => 'The description of all returned items.', + 'type' => 'array', + 'items' => [ + 'description' => 'The image parameters.', + 'type' => 'object', + 'properties' => [ + 'ProductId' => ['description' => 'The product ID.', 'type' => 'string', 'example' => '2092061_1', 'title' => ''], + 'PicName' => ['description' => 'The image name.', 'type' => 'string', 'example' => '2092061_1.jpg', 'title' => ''], + 'CategoryId' => ['description' => 'The image category.', 'type' => 'integer', 'format' => 'int32', 'example' => '8888888', 'title' => ''], + 'CustomContent' => ['description' => 'The user-defined content.', 'type' => 'string', 'example' => 'zidingyi', 'title' => ''], + 'IntAttr' => ['description' => 'The integer type attribute.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'IntAttr2' => ['description' => 'The integer type attribute.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'StrAttr2' => ['description' => 'The string type attribute.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'StrAttr' => ['description' => 'The string type attribute.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'StrAttr3' => ['description' => 'The string type attribute.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'StrAttr4' => ['description' => 'The string type attribute.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'IntAttr3' => ['description' => 'The integer type attribute.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'IntAttr4' => ['description' => 'The integer type attribute.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The error code.'."\n" + .'- 0: successful.'."\n" + .'- Non-zero: failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''], + ['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''], + ['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => ''], + ['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => ''], + ['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => ''], + ['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => ''], + ['errorCode' => 'NoPicList', 'errorMessage' => 'The body content is missing the pic_list parameter.', 'description' => ''], + ['errorCode' => 'InvalidPicList', 'errorMessage' => 'The specified pic_list parameter is invalid.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'he content of an image is not specified in the HTTP POST body.', 'description' => ''], + ['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''], + ['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => ''], + ['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => ''], + ['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => ''], + ['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter start is inavlid.', 'description' => ''], + ['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter num is invalid.', 'description' => ''], + ['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''], + ['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => ''], + ['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => ''], + ['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => ''], + ['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => ''], + ['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => ''], + ['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => ''], + ['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''], + ['errorCode' => 'PicNotExist', 'errorMessage' => 'The search picture does not exist.', 'description' => ''], + ['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'The parameter ProductId no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicName', 'errorMessage' => 'The parameter PicName no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''], + ['errorCode' => 'InvalidType', 'errorMessage' => 'The specified parameter Type is not valid.', 'description' => ''], + ['errorCode' => 'InvalidProductId', 'errorMessage' => 'The specified parameter ProductId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicName', 'errorMessage' => 'The specified parameter PicName is not valid.', 'description' => ''], + ['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => 'Invalid StrAttr'], + ['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', 'description' => ''], + ['errorCode' => 'InvalidPicUrl', 'errorMessage' => 'The search picture does not exist at the specific url.', 'description' => ''], + ['errorCode' => 'InvalidInstanceName', 'errorMessage' => 'The parameter instanceName is not specified.', 'description' => ''], + ['errorCode' => 'InvalidRequestId', 'errorMessage' => 'The parameter requestId is not specified.', 'description' => ''], + ['errorCode' => 'InvalidRequestIdTooLarge', 'errorMessage' => 'The parameter requestId is too large.', 'description' => ''], + ['errorCode' => 'InvalidRegion', 'errorMessage' => 'The specific region is illegal', 'description' => ''], + ['errorCode' => 'InvalidIntAttr4', 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', 'description' => 'Invalid'], + ['errorCode' => 'InvalidIntAttr3', 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', 'description' => 'Invalid IntAttr3'], + ['errorCode' => 'InvalidIntAttr2', 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', 'description' => 'Invalid IntAttr2'], + ['errorCode' => 'InvalidStrAttr4', 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', 'description' => 'Invalid StrAttr4'], + ['errorCode' => 'InvalidStrAttr3', 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', 'description' => 'Invalid StrAttr3'], + ['errorCode' => 'InvalidStrAttr2', 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', 'description' => 'Invalid'], + ['errorCode' => 'PictureError', 'errorMessage' => '[download] Img Download Failed.', 'description' => 'Picture download failed, please check the picture'], + ['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => ''], + ['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => ''], + ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'UnknownException', 'errorMessage' => 'An internal server error occurred.', 'description' => ''], + ['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => ''], + ['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''], + ['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''], + ['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''], + ['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => ''], + ['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => ''], + ['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => ''], + ['errorCode' => 'ConnectionDVException', 'errorMessage' => 'Failed to obtain collection.', 'description' => 'internalError'], + ], + ], + 'title' => 'Query images by filter conditions', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Auctions\\": [\\n {\\n \\"ProductId\\": \\"2092061_1\\",\\n \\"PicName\\": \\"2092061_1.jpg\\",\\n \\"CategoryId\\": 8888888,\\n \\"CustomContent\\": \\"zidingyi\\",\\n \\"IntAttr\\": 2,\\n \\"IntAttr2\\": 2,\\n \\"StrAttr2\\": \\"test\\",\\n \\"StrAttr\\": \\"test\\",\\n \\"StrAttr3\\": \\"test\\",\\n \\"StrAttr4\\": \\"test\\",\\n \\"IntAttr3\\": 2,\\n \\"IntAttr4\\": 2\\n }\\n ],\\n \\"Code\\": 0,\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'SearchImageByName' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Num', + '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" + .'If you have purchased an Image Search instance, log on to the [Image Search console](https://imagesearch.console.aliyun.com/) to view the instance name.'."\n" + .'If you have not purchased an Image Search instance, refer to [Activate the service](~~179178~~) and [Create an instance](~~66569~~).'."\n" + .'>The instance name is not the instance ID. Make sure you distinguish between them.', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1', 'title' => ''], + ], + [ + 'name' => 'ProductId', + 'in' => 'formData', + 'schema' => ['description' => 'The product ID.', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => false, 'example' => '2092061_1', 'title' => ''], + ], + [ + 'name' => 'PicName', + 'in' => 'formData', + 'schema' => ['description' => 'The image name.', 'type' => 'string', 'required' => true, 'example' => '2092061_1.jpg', 'title' => ''], + ], + [ + 'name' => 'CategoryId', 'in' => 'formData', 'schema' => [ - 'description' => '', - 'example' => '10', + 'description' => 'The product category. For more information, see [Category reference](~~179184~~).'."\n" + .' - For product image search, if you specify a category, the specified category is used. If you do not specify a category, the system predicts the category. You can obtain the predicted category from the response.'."\n" + .'<props="china">'."\n" + .' - For fabric, trademark, generic, home furnishing, and industrial hardware searches, the system sets the category to 88888888 regardless of whether you specify a category.'."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + .'- For generic image search, the system sets the category to 88888888 regardless of whether you specify a category.</props>.', + 'type' => 'integer', 'format' => 'int32', - 'maximum' => '100', - 'minimum' => '1', 'required' => false, - 'type' => 'integer', - 'default' => '10', + 'maximum' => '88888888', + 'minimum' => '0', + 'enum' => ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '20', '21', '22', '88888888'], + 'example' => '88888888', + 'title' => '', ], ], [ + 'name' => 'Num', + 'in' => 'formData', + 'schema' => ['description' => 'The number of results to return. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], + ], + [ 'name' => 'Start', 'in' => 'formData', 'schema' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int32', - 'maximum' => '499', - 'minimum' => '0', - 'required' => false, - 'type' => 'integer', - 'default' => '0', + 'description' => 'The start position of the results to return. Valid values: 0 to 499. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '499', 'exclusiveMaximum' => false, 'minimum' => '0', 'exclusiveMinimum' => false, 'default' => '0', 'example' => '0', + 'title' => '', ], ], [ 'name' => 'Filter', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'int_attr=1000 AND str_attr="value1"', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The filter condition. The int_attr field supports the following operators: in, not in, greater than (>), greater than or equal to (>=), less than (<), less than or equal to (<=), and equal to (=). The str_attr field supports the following operators: in, not in, equal to (=), and not equal to (!=). Multiple conditions can be connected by using AND and OR.'."\n" + .'Examples:'."\n" + .'- int_attr>=100.'."\n" + .'- str_attr!="value1".'."\n" + .'- int_attr=1000 AND str_attr="value1".'."\n" + ."\n" + .'>The maximum length is 4,096 characters.', 'type' => 'string', 'required' => false, 'example' => 'int_attr>=100', 'title' => ''], ], [ 'name' => 'DistinctProductId', 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to deduplicate results based on ProductId.'."\n" + .'> Set this parameter to true to enable deduplication.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'ScoreThreshold', + 'in' => 'query', + 'schema' => ['description' => 'The similarity score threshold. If you specify this parameter, only images with a similarity score greater than or equal to the threshold are returned. Valid values: 0.00 to 1.00. Up to two decimal places are supported. Default value: 0.00.', 'type' => 'string', 'required' => false, 'example' => '0.50', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'example' => 'false', - 'required' => false, - 'type' => 'boolean', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'Msg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Head' => [ + 'description' => 'The overview of the search results.', + 'type' => 'object', + 'properties' => [ + 'DocsFound' => ['description' => 'The number of results returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'DocsReturn' => ['description' => 'The number of matched results in the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '10000', 'title' => ''], + 'SearchTime' => ['description' => 'The search duration, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '95', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1', 'title' => ''], + 'Auctions' => [ + 'description' => 'The descriptions of all returned products.', + 'type' => 'array', + 'items' => [ + 'description' => 'The image parameters.', + 'type' => 'object', + 'properties' => [ + 'ProductId' => ['description' => 'The product ID.', 'type' => 'string', 'example' => '2092061_1', 'title' => ''], + 'PicName' => ['description' => 'The image name.', 'type' => 'string', 'example' => '2092061_1.jpg', 'title' => ''], + 'CategoryId' => ['description' => 'The image category.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'SortExprValues' => ['description' => 'The system scoring information.'."\n" + .'> - This field is deprecated. Use Score instead.'."\n" + .'- SortExprValues is a semicolon-separated pair. The first value indicates the relevance score of the image. A higher value indicates higher relevance to the query image. The scoring varies depending on the algorithm model.'."\n" + .'- When the category is 0 to 2, the value range of SortExprValues is 0 to 7.33136443711219e+24.'."\n" + .'- For other category values, the value range of SortExprValues is 0 to 5.37633353624177e+24. This score reaches its maximum when two images are identical.', 'type' => 'string', 'example' => '5.37633353624177e+24;0', 'title' => ''], + 'CustomContent' => ['description' => 'The custom content defined by the user.', 'type' => 'string', 'example' => 'zidingyi', 'title' => ''], + 'Score' => ['description' => 'The image similarity score. Valid values: 0 to 1.'."\n" + .'> You must upgrade to V3.1.1 or later to use this field.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'IntAttr' => ['description' => 'The integer attribute.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'IntAttr2' => ['description' => 'The integer attribute.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'StrAttr' => ['description' => 'The string attribute.', 'type' => 'string', 'example' => 'ss', 'title' => ''], + 'StrAttr2' => ['description' => 'The string attribute.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'StrAttr3' => ['description' => 'The string attribute. The maximum length is 128 characters. This field can be used for filtering during queries and is returned in query results.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'StrAttr4' => ['description' => 'The string attribute. The maximum length is 128 characters. This field can be used for filtering during queries and is returned in query results.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'IntAttr3' => ['description' => 'The integer attribute. This field can be used for filtering during queries and is returned in query results.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'IntAttr4' => ['description' => 'The integer attribute. This field can be used for filtering during queries and is returned in query results.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The error code. Valid values:'."\n" + .'- 0: success.'."\n" + .'- Non-zero: failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'PicInfo' => [ + 'description' => 'The information such as category prediction and subject identification results.', + 'type' => 'object', + 'properties' => [ + 'Region' => ['description' => 'The subject identification result.'."\n" + .'The subject region of the image, in the format of x1,x2,y1,y2, where x1,y1 is the upper-left point and x2,y2 is the lower-right point. If the user specifies a subject region in the request, the specified region is used.', 'type' => 'string', 'example' => '280,486,232,351', 'title' => ''], + 'CategoryId' => ['description' => 'The category prediction result.'."\n" + .'If the user specifies a category in the request, the specified category is used.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'MultiRegion' => [ + 'description' => 'The subject identification collection.', + 'type' => 'array', + 'items' => [ + 'description' => 'The subject collection.', + 'type' => 'object', + 'properties' => [ + 'Region' => ['description' => 'The subject identification result.'."\n" + .'The subject region of the image, in the format of x1,x2,y1,y2, where x1,y1 is the upper-left point and x2,y2 is the lower-right point. If the user specifies a subject region in the request, the specified region is used.', 'type' => 'string', 'example' => '280,486,232,351', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'AllCategories' => [ + 'description' => 'The information about all categories supported by the system.', + 'type' => 'array', + 'items' => [ + 'description' => 'The category information.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The category name.', 'type' => 'string', 'example' => 'other', 'title' => ''], + 'Id' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''], + ['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''], + ['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => ''], + ['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => ''], + ['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => ''], + ['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => ''], + ['errorCode' => 'NoPicList', 'errorMessage' => 'The body content is missing the pic_list parameter.', 'description' => ''], + ['errorCode' => 'InvalidPicList', 'errorMessage' => 'The specified pic_list parameter is invalid.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'he content of an image is not specified in the HTTP POST body.', 'description' => ''], + ['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''], + ['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => ''], + ['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => ''], + ['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => ''], + ['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter start is inavlid.', 'description' => ''], + ['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter num is invalid.', 'description' => ''], + ['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''], + ['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => ''], + ['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => ''], + ['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => ''], + ['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => ''], + ['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => ''], + ['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => ''], + ['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''], + ['errorCode' => 'PicNotExist', 'errorMessage' => 'The search picture does not exist.', 'description' => ''], + ['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'The parameter ProductId no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicName', 'errorMessage' => 'The parameter PicName no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''], + ['errorCode' => 'InvalidType', 'errorMessage' => 'The specified parameter Type is not valid.', 'description' => ''], + ['errorCode' => 'InvalidProductId', 'errorMessage' => 'The specified parameter ProductId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicName', 'errorMessage' => 'The specified parameter PicName is not valid.', 'description' => ''], + ['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => 'Invalid StrAttr'], + ['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 2 * 1024 * 1024.', 'description' => ''], + ['errorCode' => 'InvalidStrAttr4', 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', 'description' => 'Invalid StrAttr4'], + ['errorCode' => 'InvalidStrAttr3', 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', 'description' => 'Invalid StrAttr3'], + ['errorCode' => 'InvalidStrAttr2', 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', 'description' => 'Invalid'], + ['errorCode' => 'InvalidIntAttr4', 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', 'description' => 'Invalid'], + ['errorCode' => 'InvalidIntAttr3', 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', 'description' => 'Invalid IntAttr3'], + ['errorCode' => 'InvalidIntAttr2', 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', 'description' => 'Invalid IntAttr2'], + ['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => ''], + ['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => ''], + ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal server error occurred.', 'description' => ''], + ['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => ''], + ['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''], + ['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''], + ['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''], + ['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => ''], + ['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => ''], + ['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => ''], + ], + ], + 'title' => 'Search images by name', + 'summary' => 'This topic describes the syntax and examples of the SearchByName operation, which is used to query image information in an Image Search instance by name.', + 'description' => '### Operation description'."\n" + .'This operation queries image information in an Image Search instance by name (ProductId and PicName).'."\n" + ."\n" + .'> For more product details and technical support, click [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) or contact us through DingTalk group (35035130).'."\n" + ."\n\n" + .'### QPS limit'."\n" + .'The default maximum query rate can be viewed in the console. It is the QPS value you selected at the time of purchase. Currently supported values are 1 QPS, 5 QPS, and 10 QPS.', + 'extraInfo' => '### Error codes'."\n" + .'For more information, see [Error codes](~~66619~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchImageByName'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imagesearch:SearchImageByName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'SearchImageByPic' => [ + 'summary' => 'This topic describes the syntax and examples of SearchByPic, which is used to search for image information in an Image Search instance by image.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Text', + '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" + .'If you have purchased an Image Search instance, log on to the [Image Search console](https://imagesearch.console.aliyun.com/) to view the instance name.'."\n" + .'If you have not purchased an Image Search instance, see [Activate the service](~~179178~~) and [Create an instance](~~66569~~).'."\n" + .'>The instance name is not the instance ID. Make sure that you distinguish between them.', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1', 'title' => ''], + ], + [ + 'name' => 'PicContent', + 'in' => 'formData', + 'schema' => ['description' => 'The image content.'."\n" + .' - The image size cannot exceed 4 MB.'."\n" + .' - Image formats: PNG, JPG, JPEG, BMP, GIF, WEBP, TIFF, and PPM.'."\n" + .' - The transmission wait time cannot exceed 5 seconds.'."\n" + .'<props="china">'."\n" + .' - For product image search, generic image search, furniture image search, and industrial hardware image search, the image width and height must be greater than or equal to 100 px and less than or equal to 4096 px.'."\n" + .'For trademark image search, the image width and height must be greater than or equal to 200 px and less than 4096 px.'."\n" + .'For fabric image search, the image width and height must be greater than or equal to 448 px and less than or equal to 4096 px.'."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + .' - For product image search and generic image search, the image width and height must be greater than or equal to 100 px and less than or equal to 4096 px.'."\n" + .'</props>'."\n" + .'- The image cannot contain rotation information.'."\n" + ."\n" + .'> - **Call by using the SDK:**'."\n" + .' - If you use the V3 SDK, you do not need to specify the PicContent field. The SDK encapsulates this field as PicContentObject and automatically converts it to Base64 encoding. For specific examples, see [Java SDK](~~179188~~).'."\n" + .' - The SDK does not support directly passing an image URL. The V3 SDK provides an alternative method to upload images by URL. For specific examples, see [Java SDK](~~179188~~).'."\n" + .'- **Call by using the Alibaba Cloud OpenAPI platform:**'."\n" + .' - If you use the **2019-03-25** version, set the **PicContent** field to the **Base64**-encoded string of the image.'."\n" + .' - If you use the **2020-12-14** version, click the upload button in the **PicContent** field to upload the image.', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=', 'title' => ''], + ], + [ + 'name' => 'CategoryId', 'in' => 'formData', 'schema' => [ - 'description' => '', - 'example' => 'xxxx', - 'required' => true, - 'type' => 'string', + 'description' => 'The product category. For more information, see [Category reference](~~179184~~).'."\n" + .' - For product image search, if you specify a category, the specified category is used. If you do not specify a category, the system predicts the category. You can obtain the predicted category from the response.'."\n" + .'<props="china">'."\n" + .' - For fabric, trademark, generic furniture, and industrial hardware image search, the system sets the category to 88888888 regardless of whether you specify a category.'."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + .' - For generic image search, the system sets the category to 88888888 regardless of whether you specify a category.'."\n" + .'</props>.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '88888888', + 'minimum' => '0', + 'enum' => ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '20', '21', '22', '88888888'], + 'example' => '88888888', + 'title' => '', ], ], [ + 'name' => 'Crop', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to perform subject identification. Default value: true.'."\n" + .' - If this parameter is set to true, the system performs subject identification and searches based on the identified subject. You can obtain the subject identification result from the response.'."\n" + .' - If this parameter is set to false, the system does not perform subject identification and searches based on the entire image.'."\n" + .'<props="china">'."\n" + .'- For fabric image search, this parameter is ignored and the system searches based on the entire image.'."\n" + .'</props>.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Region', + 'in' => 'formData', + 'schema' => ['description' => 'The subject region of the image, in the format of `x1,x2,y1,y2`, where `x1,y1` is the upper-left point and `x2,y2` is the lower-right point.'."\n" + .'> - If you specify Region, the system searches based on the specified Region regardless of the value of the Crop parameter.'."\n" + .'<props="china">'."\n" + .'- For fabric image search, this parameter is ignored and the system searches based on the entire image.'."\n" + .'</props>.', 'type' => 'string', 'required' => false, 'example' => '280,486,232,351', 'title' => ''], + ], + [ + 'name' => 'Num', + 'in' => 'formData', + 'schema' => ['description' => 'The number of results to return. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Start', + 'in' => 'formData', + 'schema' => ['description' => 'The start position of the results to return. Valid values: 0 to 499. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '499', 'minimum' => '0', 'default' => '0', 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Filter', + 'in' => 'formData', + 'schema' => ['description' => 'The filter condition. The int_attr field supports the following operators: in, not in, greater than (>), greater than or equal to (>=), less than (<), less than or equal to (<=), and equal to (=). The str_attr field supports the following operators: in, not in, equal to (=), and not equal to (!=). Multiple conditions can be connected by using AND and OR.'."\n" + .'Examples:'."\n" + .'- int_attr >= 100.'."\n" + .'- str_attr != "value1".'."\n" + .'- int_attr = 1000 AND str_attr = "value1".'."\n" + ."\n" + .'>A maximum of 4096 characters are supported.', 'type' => 'string', 'required' => false, 'example' => 'int_attr=1000 AND str_attr="value1"', 'title' => ''], + ], + [ + 'name' => 'DistinctProductId', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to deduplicate results based on the ProductId field during the search. If this parameter is set to true, deduplication is performed.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ 'name' => 'ScoreThreshold', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The similarity score threshold. After you specify this threshold, only images with a similarity score greater than or equal to the threshold are returned. Valid values: 0.00 to 1.00. Up to two decimal places are supported. Default value: 0.00.', 'type' => 'string', 'required' => false, 'example' => '0.50', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'The response parameters.', + 'type' => 'object', 'properties' => [ - 'Msg' => [ - 'description' => '', - 'example' => 'success', - 'type' => 'string', - ], + 'Msg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Head' => [ - 'description' => '', + 'description' => 'The overview of the search results.', + 'type' => 'object', 'properties' => [ - 'DocsFound' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'type' => 'integer', + 'DocsFound' => ['description' => 'The number of results returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'DocsReturn' => ['description' => 'The number of results matched in the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '10000', 'title' => ''], + 'SearchTime' => ['description' => 'The search duration, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '95', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', 'title' => ''], + 'Auctions' => [ + 'description' => 'The descriptions of all returned products.', + 'type' => 'array', + 'items' => [ + 'description' => 'The descriptions of all returned products.', + 'type' => 'object', + 'properties' => [ + 'ProductId' => ['description' => 'The product ID.', 'type' => 'string', 'example' => '2092061_1', 'title' => ''], + 'PicName' => ['description' => 'The image name.', 'type' => 'string', 'example' => '2092061_1.jpg', 'title' => ''], + 'CategoryId' => ['description' => 'The image category.', 'type' => 'integer', 'format' => 'int32', 'example' => '8888888', 'title' => ''], + 'SortExprValues' => ['description' => 'The system scoring information.'."\n" + .'> - This field is deprecated. Use Score instead. '."\n" + .'- SortExprValues is a semicolon-separated tuple. The first value indicates the relevance score of the image. A higher value indicates higher relevance to the query image. The scoring varies depending on the algorithm model.'."\n" + .'- When the category is 0 to 2, the value range of SortExprValues is 0 to 7.33136443711219e+24.'."\n" + .'- For other category values, the value range of SortExprValues is 0 to 5.37633353624177e+24. This score reaches its maximum when two images are identical.', 'type' => 'string', 'example' => '5.37633353624177e+24;0', 'title' => ''], + 'CustomContent' => ['description' => 'The user-defined content.', 'type' => 'string', 'example' => 'zidingyi', 'title' => ''], + 'Score' => ['description' => 'The image similarity score. Valid values: 0 to 1.'."\n" + .'> You must upgrade to V3.1.1 to use this feature.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'IntAttr' => ['description' => 'The integer type attribute.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'IntAttr2' => ['description' => 'The integer type attribute.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'StrAttr2' => ['description' => 'The string type attribute.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'StrAttr' => ['description' => 'The string type attribute.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'StrAttr3' => ['description' => 'The string type attribute.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'StrAttr4' => ['description' => 'The string type attribute.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'IntAttr3' => ['description' => 'The integer type attribute.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'IntAttr4' => ['description' => 'The integer type attribute.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], - 'DocsReturn' => [ - 'description' => '', - 'example' => '10000', - 'format' => 'int32', - 'type' => 'integer', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The error code.'."\n" + .'- 0: successful.'."\n" + .'- Non-zero: failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'PicInfo' => [ + 'description' => 'The information such as category prediction and subject identification results.', + 'type' => 'object', + 'properties' => [ + 'Region' => ['description' => 'The subject identification result. The subject region of the image, in the format of x1,x2,y1,y2, where x1,y1 is the upper-left point and x2,y2 is the lower-right point. If the subject region is specified in the request, the value specified in the request is used.', 'type' => 'string', 'example' => '280,486,232,351', 'title' => ''], + 'CategoryId' => ['description' => 'The category prediction result. If the category is specified in the request, the value specified in the request is used.', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888', 'title' => ''], + 'MultiRegion' => [ + 'description' => 'The collection of subject identification results.'."\n" + .'> You must upgrade to V3.1.1 to use this feature.', + 'type' => 'array', + 'items' => [ + 'description' => 'The subject identification result.', + 'type' => 'object', + 'properties' => [ + 'Region' => ['description' => 'The subject identification result. The subject region of the image, in the format of x1,x2,y1,y2, where x1,y1 is the upper-left point and x2,y2 is the lower-right point. If the subject region is specified in the request, the value specified in the request is used.', 'type' => 'string', 'example' => '280,486,232,351', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'SearchTime' => [ - 'description' => '', - 'example' => '95', - 'format' => 'int32', - 'type' => 'integer', + 'AllCategories' => [ + 'description' => 'The information about all categories supported by the system.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about all categories supported by the system.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The category name.', 'type' => 'string', 'example' => 'other', 'title' => ''], + 'Id' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => '', - 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', - 'type' => 'string', + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''], + ['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''], + ['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => ''], + ['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => ''], + ['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => ''], + ['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => ''], + ['errorCode' => 'NoPicList', 'errorMessage' => 'The body content is missing the pic_list parameter.', 'description' => ''], + ['errorCode' => 'InvalidPicList', 'errorMessage' => 'The specified pic_list parameter is invalid.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'he content of an image is not specified in the HTTP POST body.', 'description' => ''], + ['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''], + ['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => ''], + ['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => ''], + ['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => ''], + ['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter start is inavlid.', 'description' => ''], + ['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter num is invalid.', 'description' => ''], + ['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''], + ['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => ''], + ['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => ''], + ['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => ''], + ['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => ''], + ['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => ''], + ['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => ''], + ['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''], + ['errorCode' => 'PicNotExist', 'errorMessage' => 'The search picture does not exist.', 'description' => ''], + ['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'The parameter ProductId no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicName', 'errorMessage' => 'The parameter PicName no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''], + ['errorCode' => 'InvalidType', 'errorMessage' => 'The specified parameter Type is not valid.', 'description' => ''], + ['errorCode' => 'InvalidProductId', 'errorMessage' => 'The specified parameter ProductId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicName', 'errorMessage' => 'The specified parameter PicName is not valid.', 'description' => ''], + ['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => 'Invalid StrAttr'], + ['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', 'description' => ''], + ['errorCode' => 'InvalidPicUrl', 'errorMessage' => 'The search picture does not exist at the specific url.', 'description' => ''], + ['errorCode' => 'InvalidInstanceName', 'errorMessage' => 'The parameter instanceName is not specified.', 'description' => ''], + ['errorCode' => 'InvalidRequestId', 'errorMessage' => 'The parameter requestId is not specified.', 'description' => ''], + ['errorCode' => 'InvalidRequestIdTooLarge', 'errorMessage' => 'The parameter requestId is too large.', 'description' => ''], + ['errorCode' => 'InvalidRegion', 'errorMessage' => 'The specific region is illegal', 'description' => ''], + ['errorCode' => 'InvalidIntAttr4', 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', 'description' => 'Invalid'], + ['errorCode' => 'InvalidIntAttr3', 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', 'description' => 'Invalid IntAttr3'], + ['errorCode' => 'InvalidIntAttr2', 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', 'description' => 'Invalid IntAttr2'], + ['errorCode' => 'InvalidStrAttr4', 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', 'description' => 'Invalid StrAttr4'], + ['errorCode' => 'InvalidStrAttr3', 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', 'description' => 'Invalid StrAttr3'], + ['errorCode' => 'InvalidStrAttr2', 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', 'description' => 'Invalid'], + ['errorCode' => 'PictureError', 'errorMessage' => '[download] Img Download Failed.', 'description' => 'Picture download failed, please check the picture'], + ['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => ''], + ['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => ''], + ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'UnknownException', 'errorMessage' => 'An internal server error occurred.', 'description' => ''], + ['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => ''], + ['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''], + ['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''], + ['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''], + ['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => ''], + ['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => ''], + ['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => ''], + ['errorCode' => 'ConnectionDVException', 'errorMessage' => 'Failed to obtain collection.', 'description' => 'internalError'], + ], + ], + 'title' => 'Search by image', + 'description' => '## Operation description'."\n" + .'This operation is used to search for image information in an Image Search instance by image.'."\n" + .'> <props="china">For more product details and technical support, click [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) or contact us through DingTalk group (35035130).</props>'."\n" + ."\n" + .'## QPS limit'."\n" + .'You can view the default maximum access frequency for query operations in the console. The frequency is the QPS value that you selected when you made the purchase. The supported values are 1 QPS, 5 QPS, and 10 QPS.'."\n" + ."\n\n" + .'### SDK version description'."\n" + .'Upgrade the Image Search SDK to V3.1.1 to use the multi-subject identification and similarity score features. For more information, see [Java SDK](~~179188~~).', + 'extraInfo' => '## Error codes'."\n" + .'For more information, see [Error codes](~~66619~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchImageByPic'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imagesearch:SearchImageByPic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + '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' => 'The name of the Image Search instance. The name can be up to 20 characters in length.'."\n" + .'If you have purchased an Image Search instance, log on to the [Image Search console](https://imagesearch.console.aliyun.com/) to view the instance name.'."\n" + .'If you have not purchased an Image Search instance, see [Activate the service](~~179178~~) and [Create an instance](~~66569~~).'."\n" + .'>The instance name is not the instance ID. Make sure you distinguish between them.', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1', 'title' => ''], + ], + [ + 'name' => 'Num', + 'in' => 'formData', + 'schema' => ['description' => 'The number of results to return. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Start', + 'in' => 'formData', + 'schema' => ['description' => 'The start position of the results to return. Valid values: 0 to 499. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '499', 'minimum' => '0', 'default' => '0', 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Filter', + 'in' => 'formData', + 'schema' => ['description' => 'The filter condition. The int_attr field supports the following operators: in, not in, greater than (>), greater than or equal to (>=), less than (<), less than or equal to (<=), and equal to (=). The str_attr field supports the following operators: in, not in, equal to (=), and not equal to (!=). You can use AND and OR to connect multiple conditions.'."\n" + .'Examples:'."\n" + .'- int_attr >= 100.'."\n" + .'- str_attr != "value1".'."\n" + .'- int_attr = 1000 AND str_attr = "value1".'."\n" + ."\n" + .'>The filter condition can be up to 4,096 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'int_attr=1000 AND str_attr="value1"', 'title' => ''], + ], + [ + 'name' => 'DistinctProductId', + 'in' => 'formData', + 'schema' => ['description' => 'If this parameter is set to true, duplicate data is removed based on the ProductId field during the search.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'Text', + 'in' => 'formData', + 'schema' => ['description' => 'The description text for searching images. Chinese and English are supported.'."\n" + ."\n" + .'>The text can be up to 512 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'xxxx', 'title' => ''], + ], + [ + 'name' => 'ScoreThreshold', + 'in' => 'query', + 'schema' => ['description' => 'The similarity score threshold. After you specify this parameter, only images whose similarity scores are greater than or equal to the threshold are returned. Valid values: 0.00 to 1.00. The value supports up to two decimal places. Default value: 0.00.', 'type' => 'string', 'required' => false, 'example' => '0.50', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'Msg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Head' => [ + 'description' => 'The overview of the search results.', + 'type' => 'object', + 'properties' => [ + 'DocsFound' => ['description' => 'The number of results returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'DocsReturn' => ['description' => 'The number of matched results in the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '10000', 'title' => ''], + 'SearchTime' => ['description' => 'The time consumed by the search, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '95', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', 'title' => ''], 'Auctions' => [ - 'description' => '', + 'description' => 'The description information of all returned products.', + 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The description information of all returned products.', + 'type' => 'object', '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', - ], + 'ProductId' => ['description' => 'The product ID.', 'type' => 'string', 'example' => '2092061_1', 'title' => ''], + 'PicName' => ['description' => 'The image name.', 'type' => 'string', 'example' => '2092061_1.jpg', 'title' => ''], + 'CategoryId' => ['description' => 'The image category.', 'type' => 'integer', 'format' => 'int32', 'example' => '8888888', 'title' => ''], + 'CustomContent' => ['description' => 'The custom content defined by the user.', 'type' => 'string', 'example' => 'zidingyi', 'title' => ''], + 'Score' => ['description' => 'The image similarity score. Valid values: 0 to 1.'."\n" + .'> You must upgrade the SDK to V3.1.1 to use this feature.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'IntAttr' => ['description' => 'The integer type attribute.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'IntAttr2' => ['description' => 'The integer type attribute.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'StrAttr2' => ['description' => 'The string type attribute.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'StrAttr' => ['description' => 'The string type attribute.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'StrAttr3' => ['description' => 'The string type attribute.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'StrAttr4' => ['description' => 'The string type attribute.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'IntAttr3' => ['description' => 'The integer type attribute.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'IntAttr4' => ['description' => 'The integer type attribute.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], - 'type' => 'array', - ], - 'Code' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int32', - 'type' => 'integer', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The error code. Valid values:'."\n" + .'- 0: successful.'."\n" + .'- Non-zero value: failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'PicInfo' => [ - 'description' => '', + 'description' => 'The category information.', + 'type' => 'object', 'properties' => [ 'AllCategories' => [ - 'description' => '', + 'description' => 'All categories supported by the system.', + 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'All categories supported by the system.', + 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '', - 'example' => 'other', - 'type' => 'string', - ], - 'Id' => [ - 'description' => '', - 'example' => '88888888', - 'format' => 'int32', - 'type' => 'integer', - ], + 'Name' => ['description' => 'The category name.', 'type' => 'string', 'example' => 'other', 'title' => ''], + 'Id' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888', 'title' => ''], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], - 'type' => 'array', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'title' => '', + 'example' => '', ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'AccessDeniedDetail' => [ - 'description' => '', + 'description' => 'The authentication details.', + 'type' => 'object', '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', - ], + 'AuthAction' => ['description' => 'The action for the authentication request.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The authentication principal information.', 'type' => 'string', 'example' => '111', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'The Alibaba Cloud account ID of the authentication principal.', 'type' => 'string', 'example' => '222', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'The type of the authentication principal.', 'type' => 'string', 'example' => 'SubUser', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The encrypted complete diagnostic message.', 'type' => 'string', 'example' => 'xxxxxx', 'title' => ''], + 'NoPermissionType' => ['description' => 'Valid values:'."\n" + .'- ImplicitDeny: no policy is matched.'."\n" + .'- ExplicitDeny: an explicit Deny policy is matched.', 'type' => 'string', 'example' => 'ImplicitDeny', 'title' => ''], + 'PolicyType' => ['description' => 'The type of the policy that caused the access denial.', 'type' => 'string', 'example' => 'PauseNotify', 'title' => ''], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'BadRequest', - 'errorMessage' => 'The request has invalid parameters.', - ], - [ - 'errorCode' => 'InstanceStatusError', - 'errorMessage' => 'Your instance is unavailable.', - ], - [ - 'errorCode' => 'TimeoutForTransferImage', - 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', - ], - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'NoCaretSeperator', - 'errorMessage' => 'The body content is missing the ^ separator.', - ], - [ - 'errorCode' => 'EmptyMeta', - 'errorMessage' => 'The body content has an empty meta field.', - ], - [ - 'errorCode' => 'InvalidMetaItem', - 'errorMessage' => 'The meta field is invalid.', - ], - [ - 'errorCode' => 'NoPicList', - 'errorMessage' => 'The body content is missing the pic_list parameter.', - ], - [ - 'errorCode' => 'InvalidPicList', - 'errorMessage' => 'The specified pic_list parameter is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedPic', - 'errorMessage' => 'he content of an image is not specified in the HTTP POST body.', - ], - [ - 'errorCode' => 'NoSpecifiedSearchPic', - 'errorMessage' => 'The search image is not specified.', - ], - [ - 'errorCode' => 'OverflowMaxResultNum', - 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', - ], - [ - 'errorCode' => 'OverflowMaxReturnNum', - 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', - ], - [ - 'errorCode' => 'InvalidStartParameter', - 'errorMessage' => 'The specified parameter start is inavlid.', - ], - [ - 'errorCode' => 'InvalidNumParameter', - 'errorMessage' => 'The specified parameter num is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedAddPic', - 'errorMessage' => 'The image to insert is not specified.', - ], - [ - 'errorCode' => 'NoSpecifiedItemId', - 'errorMessage' => 'The item_id parameter is not specified.', - ], - [ - 'errorCode' => 'InvalidIntAttr', - 'errorMessage' => 'The specified int_attr field is invalid.', - ], - [ - 'errorCode' => 'InvalidFilterClause', - 'errorMessage' => 'The specified filtering condition is invalid.', - ], - [ - 'errorCode' => 'InstanceOverQuota', - 'errorMessage' => 'The number of items exceeds the limit.', - ], - [ - 'errorCode' => 'IncorrectOrientation', - 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', - ], - [ - 'errorCode' => 'UnsupportedPicPixels', - 'errorMessage' => 'The specified pixels is not supported.', - ], - [ - 'errorCode' => 'SearchTimeout', - 'errorMessage' => 'The request is timed out.', - ], - [ - 'errorCode' => 'PicNotExist', - 'errorMessage' => 'The search picture does not exist.', - ], - [ - 'errorCode' => 'NoSpecifiedProductId', - 'errorMessage' => 'The parameter ProductId no specified.', - ], - [ - 'errorCode' => 'NoSpecifiedPicName', - 'errorMessage' => 'The parameter PicName no specified.', - ], - [ - 'errorCode' => 'NoSpecifiedPicContent', - 'errorMessage' => 'The parameter PicContent no specified.', - ], - [ - 'errorCode' => 'InvalidType', - 'errorMessage' => 'The specified parameter Type is not valid.', - ], - [ - 'errorCode' => 'InvalidProductId', - 'errorMessage' => 'The specified parameter ProductId is not valid.', - ], - [ - 'errorCode' => 'InvalidPicName', - 'errorMessage' => 'The specified parameter PicName is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr', - 'errorMessage' => 'The specified parameter StrAttr is not valid.', - ], - [ - 'errorCode' => 'InvalidCustomContent', - 'errorMessage' => 'The specified parameter CustomContent is not valid.', - ], - [ - 'errorCode' => 'InvalidPicContent', - 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', - ], - [ - 'errorCode' => 'InvalidPicUrl', - 'errorMessage' => 'The search picture does not exist at the specific url.', - ], - [ - 'errorCode' => 'InvalidInstanceName', - 'errorMessage' => 'The parameter instanceName is not specified.', - ], - [ - 'errorCode' => 'InvalidRequestId', - 'errorMessage' => 'The parameter requestId is not specified.', - ], - [ - 'errorCode' => 'InvalidRequestIdTooLarge', - 'errorMessage' => 'The parameter requestId is too large.', - ], - [ - 'errorCode' => 'InvalidRegion', - 'errorMessage' => 'The specific region is illegal', - ], - [ - 'errorCode' => 'InvalidIntAttr4', - 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr3', - 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', - ], - [ - 'errorCode' => 'InvalidIntAttr2', - 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr4', - 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr3', - 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr2', - 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', - ], - [ - 'errorCode' => 'InvalidText', - 'errorMessage' => 'The specified parameter Text is not valid.', - ], - [ - 'errorCode' => 'InvalidTextLength', - 'errorMessage' => 'Invalid text clause.', - ], - [ - 'errorCode' => 'UnsupportedOperationType', - 'errorMessage' => 'The specified action is not supported.', - ], - [ - 'errorCode' => 'UnsupportedInstanceType', - 'errorMessage' => 'The instance type is not supported.', - ], + ['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''], + ['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''], + ['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => ''], + ['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => ''], + ['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => ''], + ['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => ''], + ['errorCode' => 'NoPicList', 'errorMessage' => 'The body content is missing the pic_list parameter.', 'description' => ''], + ['errorCode' => 'InvalidPicList', 'errorMessage' => 'The specified pic_list parameter is invalid.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'he content of an image is not specified in the HTTP POST body.', 'description' => ''], + ['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''], + ['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => ''], + ['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => ''], + ['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter start is inavlid.', 'description' => ''], + ['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter num is invalid.', 'description' => ''], + ['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''], + ['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => ''], + ['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => ''], + ['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => ''], + ['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => ''], + ['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => ''], + ['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''], + ['errorCode' => 'PicNotExist', 'errorMessage' => 'The search picture does not exist.', 'description' => ''], + ['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'The parameter ProductId no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicName', 'errorMessage' => 'The parameter PicName no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''], + ['errorCode' => 'InvalidType', 'errorMessage' => 'The specified parameter Type is not valid.', 'description' => ''], + ['errorCode' => 'InvalidProductId', 'errorMessage' => 'The specified parameter ProductId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicName', 'errorMessage' => 'The specified parameter PicName is not valid.', 'description' => ''], + ['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => 'Invalid StrAttr'], + ['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', 'description' => ''], + ['errorCode' => 'InvalidPicUrl', 'errorMessage' => 'The search picture does not exist at the specific url.', 'description' => ''], + ['errorCode' => 'InvalidInstanceName', 'errorMessage' => 'The parameter instanceName is not specified.', 'description' => ''], + ['errorCode' => 'InvalidRequestId', 'errorMessage' => 'The parameter requestId is not specified.', 'description' => ''], + ['errorCode' => 'InvalidRequestIdTooLarge', 'errorMessage' => 'The parameter requestId is too large.', 'description' => ''], + ['errorCode' => 'InvalidRegion', 'errorMessage' => 'The specific region is illegal', 'description' => ''], + ['errorCode' => 'InvalidIntAttr4', 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', 'description' => 'Invalid'], + ['errorCode' => 'InvalidIntAttr3', 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', 'description' => 'Invalid IntAttr3'], + ['errorCode' => 'InvalidIntAttr2', 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', 'description' => 'Invalid IntAttr2'], + ['errorCode' => 'InvalidStrAttr4', 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', 'description' => 'Invalid StrAttr4'], + ['errorCode' => 'InvalidStrAttr3', 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', 'description' => 'Invalid StrAttr3'], + ['errorCode' => 'InvalidStrAttr2', 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', 'description' => 'Invalid'], + ['errorCode' => 'InvalidText', 'errorMessage' => 'The specified parameter Text is not valid.', 'description' => 'Description Text cannot be null'], + ['errorCode' => 'InvalidTextLength', 'errorMessage' => 'Invalid text clause.', 'description' => 'The text field length must be within 512.'], + ['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => ''], + ['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation.', - ], - [ - 'errorCode' => 'DeniedRequest', - 'errorMessage' => 'Your request was denied due to instance flow control.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => ''], + ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'UnknownException', - 'errorMessage' => 'An internal server error occurred.', - ], - [ - 'errorCode' => 'NetworkException', - 'errorMessage' => 'A network error occurred.', - ], - [ - 'errorCode' => 'RequestTimeout', - 'errorMessage' => 'The request is timeout.', - ], - [ - 'errorCode' => 'ExtractFeatureTimeout', - 'errorMessage' => 'The request was timed out while extracting features.', - ], - [ - 'errorCode' => 'AccessEngineFailed', - 'errorMessage' => 'An error occurred while accessing the search engine.', - ], - [ - 'errorCode' => 'InternalOssError', - 'errorMessage' => 'An internal OAS error occurred.', - ], - [ - 'errorCode' => 'InternalSwiftError', - 'errorMessage' => 'An internal SWIFT error occurred.', - ], - [ - 'errorCode' => 'InternalTableStoreError', - 'errorMessage' => 'An internal Table Store error occurred.', - ], - [ - 'errorCode' => 'ConnectionDVException', - 'errorMessage' => 'Failed to obtain collection.', + ['errorCode' => 'UnknownException', 'errorMessage' => 'An internal server error occurred.', 'description' => ''], + ['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => ''], + ['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''], + ['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''], + ['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''], + ['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => ''], + ['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => ''], + ['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => ''], + ['errorCode' => 'ConnectionDVException', 'errorMessage' => 'Failed to obtain collection.', 'description' => 'internalError'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Search for images by text', + 'summary' => 'This topic describes the syntax and examples of SearchImageByText, which is used to search for image information in an Image Search instance based on text.', + 'description' => '## Operation description'."\n" + .'This operation is used to search for image information in an Image Search instance based on text. This operation is available only for instances whose service type is product multimodal search.'."\n" + .'> <props="china">For more product details and technical support, click [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) or contact us through the DingTalk group (35035130).</props>'."\n" + ."\n" + .'## QPS limit'."\n" + .'You can view the default maximum access frequency for query operations in the console. The frequency is the QPS value you selected at the time of purchase. Currently supported values are 1 QPS, 5 QPS, and 10 QPS.'."\n" + ."\n\n" + .'### SDK version description'."\n" + .'Upgrade the Image Search SDK to V3.1.1 to use the multi-subject identification and similarity score features. For more information, see [Java SDK](~~179188~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imagesearch:SearchImageByText', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"Head\\": {\\n \\"DocsFound\\": 10,\\n \\"DocsReturn\\": 10000,\\n \\"SearchTime\\": 95\\n },\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Auctions\\": [\\n {\\n \\"ProductId\\": \\"2092061_1\\",\\n \\"PicName\\": \\"2092061_1.jpg\\",\\n \\"CategoryId\\": 8888888,\\n \\"CustomContent\\": \\"zidingyi\\",\\n \\"Score\\": 1,\\n \\"IntAttr\\": 2,\\n \\"IntAttr2\\": 2,\\n \\"StrAttr2\\": \\"xxxx\\",\\n \\"StrAttr\\": \\"xxxx\\",\\n \\"StrAttr3\\": \\"xxxx\\",\\n \\"StrAttr4\\": \\"xxxx\\",\\n \\"IntAttr3\\": 2,\\n \\"IntAttr4\\": 2\\n }\\n ],\\n \\"Code\\": 0,\\n \\"PicInfo\\": {\\n \\"AllCategories\\": [\\n {\\n \\"Name\\": \\"other\\",\\n \\"Id\\": 88888888\\n }\\n ]\\n },\\n \\"Success\\": true,\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalDisplayName\\": \\"111\\",\\n \\"AuthPrincipalOwnerId\\": \\"222\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"xxxxxx\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"PauseNotify\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<SearchImageByTextResponse>\\n <Msg>success</Msg>\\n <Head>\\n <DocsFound>10</DocsFound>\\n <DocsReturn>10000</DocsReturn>\\n <SearchTime>95</SearchTime>\\n </Head>\\n <RequestId>B3137727-7D6E-488C-BA21-0E034C38A879</RequestId>\\n <Auctions>\\n <ProductId>2092061_1</ProductId>\\n <PicName>2092061_1.jpg</PicName>\\n <CategoryId>8888888</CategoryId>\\n <CustomContent>zidingyi</CustomContent>\\n <Score>1</Score>\\n <IntAttr>2</IntAttr>\\n <IntAttr2>2</IntAttr2>\\n <StrAttr2>xxxx</StrAttr2>\\n <StrAttr>xxxx</StrAttr>\\n <StrAttr3>xxxx</StrAttr3>\\n <StrAttr4>xxxx</StrAttr4>\\n <IntAttr3>2</IntAttr3>\\n <IntAttr4>2</IntAttr4>\\n </Auctions>\\n <Code>0</Code>\\n <PicInfo>\\n <AllCategories>\\n <Name>other</Name>\\n <Id>88888888</Id>\\n </AllCategories>\\n </PicInfo>\\n <Success>true</Success>\\n</SearchImageByTextResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], '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', - ], + 'summary' => 'This topic describes the syntax and examples of the UpdateImage operation, which modifies image information in an Image Search instance.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3892,438 +2529,510 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREimagesearchAA7PKJ', - ], + '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', - ], + 'schema' => ['description' => 'The name of the Image Search instance. The name can be up to 20 characters in length.'."\n" + .'If you have purchased an Image Search instance, log on to the [Image Search console](https://imagesearch.console.aliyun.com/) to view the instance name.'."\n" + .'If you have not purchased an Image Search instance, refer to [Activate the service](~~179178~~) and [Create an instance](~~66569~~).'."\n" + .'>The instance name is not the instance ID. Do not confuse the two.', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The product ID. The ID can be up to 256 characters in length.'."\n" + ."\n" + .'>A product can have multiple images. Set this parameter based on your business requirements. For example: top001, pants002.', 'type' => 'string', 'required' => true, 'example' => '2092061_1', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The image name. The name can be up to 256 characters in length.'."\n" + .'> - ProductId and PicName uniquely identify an image. ProductId and PicName cannot be modified.'."\n" + .'- If you add multiple images with the same ProductId and PicName, only the last added image is retained. Previously added images are overwritten.'."\n" + .'- If you do not specify PicName, image information is modified based on ProductId.'."\n" + .'- If you specify PicName, image information is modified based on ProductId and PicName.', 'type' => 'string', 'required' => false, 'example' => 'namexxx.jpg', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The custom content. The content can be up to 4,096 characters in length.'."\n" + .'>This field is returned when you call the "<props="china">[SearchImageByPic](https://help.aliyun.com/document_detail/202282.html)</props><props="intl">[SearchImageByPic](https://www.alibabacloud.com/help/zh/image-search/latest/updateimage)</props>" operation. For example, you can add a text description of the image.', 'type' => 'string', 'required' => false, 'example' => 'zidingyi', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The integer attribute. This attribute can be used to filter results during queries and is returned in query results.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The string attribute. The value can be up to 128 characters in length. This attribute can be used to filter results during queries and is returned in query results.', 'type' => 'string', 'required' => false, 'example' => 'ss', 'title' => ''], ], [ 'name' => 'IntAttr2', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The integer attribute. This attribute can be used to filter results during queries and is returned in query results.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'StrAttr2', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The string attribute. The value can be up to 128 characters in length. This attribute can be used to filter results during queries and is returned in query results.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'IntAttr3', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['description' => 'The integer attribute. This attribute can be used to filter results during queries and is returned in query results.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '33', 'title' => ''], ], [ 'name' => 'StrAttr3', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The string attribute. The value can be up to 128 characters in length. This attribute can be used to filter results during queries and is returned in query results.', 'type' => 'string', 'required' => false, 'example' => 'ss', 'title' => ''], ], [ 'name' => 'IntAttr4', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['description' => 'The integer attribute. This attribute can be used to filter results during queries and is returned in query results.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '33', 'title' => ''], ], [ 'name' => 'StrAttr4', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The string attribute. The value can be up to 128 characters in length. This attribute can be used to filter results during queries and is returned in query results.', 'type' => 'string', 'required' => false, 'example' => 'ss', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The response object.', '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', - ], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E0845DE6-52AF-4B50-9F15-51ED4044E6AB', 'title' => ''], + 'Code' => ['description' => 'The error code. Valid values:'."\n" + ."\n" + .'- 0: success.'."\n" + .'- Non-zero value: failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], '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' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''], + ['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => ''], + ['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => ''], + ['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => ''], + ['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => ''], + ['errorCode' => 'NoPicList', 'errorMessage' => 'The body content is missing the pic_list parameter.', 'description' => ''], + ['errorCode' => 'InvalidPicList', 'errorMessage' => 'The specified pic_list parameter is invalid.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'The content of an image is not specified in the HTTP POST body.', 'description' => ''], + ['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''], + ['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => ''], + ['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => ''], + ['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => ''], + ['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter s is inavlid.', 'description' => ''], + ['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter n is invalid.', 'description' => ''], + ['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''], + ['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => ''], + ['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => ''], + ['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => ''], + ['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => ''], + ['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => ''], + ['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => ''], + ['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''], + ['errorCode' => 'PicNotExist', 'errorMessage' => 'The search picture does not exist.', 'description' => ''], + ['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'The parameter ProductId no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicName', 'errorMessage' => 'The parameter PicName no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''], + ['errorCode' => 'InvalidType', 'errorMessage' => 'The specified parameter Type is not valid.', 'description' => ''], + ['errorCode' => 'InvalidProductId', 'errorMessage' => 'The specified parameter ProductId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicName', 'errorMessage' => 'The specified parameter PicName is not valid.', 'description' => ''], + ['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => 'Invalid StrAttr'], + ['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', 'description' => ''], + ['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''], + ['errorCode' => 'InvalidIntAttr4', 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', 'description' => 'Invalid'], + ['errorCode' => 'InvalidIntAttr3', 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', 'description' => 'Invalid IntAttr3'], + ['errorCode' => 'InvalidIntAttr2', 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', 'description' => 'Invalid IntAttr2'], + ['errorCode' => 'InvalidStrAttr4', 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', 'description' => 'Invalid StrAttr4'], + ['errorCode' => 'InvalidStrAttr3', 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', 'description' => 'Invalid StrAttr3'], + ['errorCode' => 'InvalidStrAttr2', 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', 'description' => 'Invalid'], + ['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => ''], + ['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => ''], + ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal server error occurred.', 'description' => ''], + ['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => ''], + ['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''], + ['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''], + ['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''], + ['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => ''], + ['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => ''], + ['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"E0845DE6-52AF-4B50-9F15-51ED4044E6AB\\",\\n \\"Code\\": 0,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Modify image information', + 'description' => '## Operation description'."\n" + .'This operation modifies image information in an Image Search instance based on the product ID and image name.'."\n" + .'> - Instance creation time requirements apply.'."\n" + .'<props="china">'."\n" + .'- Instances created after June 2021 in the Shanghai and Hangzhou regions are supported. Instances in other regions can be used normally.'."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + .'- Instances created after December 2021 in the Singapore region are supported. Instances in other regions are currently not supported.'."\n" + .'</props>'."\n" + .'- For more information about the product or to obtain technical support, click [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) or contact us through DingTalk group (35035130).'."\n" + ."\n\n" + .'## QPS limit'."\n" + .'The default concurrency for update operations is 20, which means a maximum of 20 requests can be processed per second.', + 'extraInfo' => '## Error codes'."\n" + .'For a list of error codes, see [Error codes](~~66619~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateImage'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imagesearch:UpdateImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - [ - 'errorCode' => 'InvalidStrAttr3', - 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', + ], + ], + ], + ], + 'endpoints' => [ + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imagesearch.ap-northeast-1.aliyuncs.com', 'endpoint' => 'imagesearch.ap-northeast-1.aliyuncs.com', 'vpc' => 'imagesearch-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imagesearch.ap-southeast-1.aliyuncs.com', 'endpoint' => 'imagesearch.ap-southeast-1.aliyuncs.com', 'vpc' => 'imagesearch-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imagesearch.ap-southeast-2.aliyuncs.com', 'endpoint' => 'imagesearch.ap-southeast-2.aliyuncs.com', 'vpc' => 'imagesearch-vpc.ap-southeast-2.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imagesearch.cn-beijing.aliyuncs.com', 'endpoint' => 'imagesearch.cn-beijing.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imagesearch.cn-hangzhou.aliyuncs.com', 'endpoint' => 'imagesearch.cn-hangzhou.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imagesearch.cn-hongkong.aliyuncs.com', 'endpoint' => 'imagesearch.cn-hongkong.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imagesearch.cn-shanghai.aliyuncs.com', 'endpoint' => 'imagesearch.cn-shanghai.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imagesearch.cn-shenzhen.aliyuncs.com', 'endpoint' => 'imagesearch.cn-shenzhen.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'imagesearch.eu-central-1.aliyuncs.com', 'endpoint' => 'imagesearch.eu-central-1.aliyuncs.com', 'vpc' => 'imagesearch-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'imagesearch.ap-south-1.aliyuncs.com', 'endpoint' => 'imagesearch.ap-south-1.aliyuncs.com', 'vpc' => 'imagesearch-vpc.ap-south-1.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'AccessEngineFailed', 'message' => 'An error occurred while accessing the search engine.', 'http_code' => 400, 'description' => ''], + ['code' => 'ConnectionDVException', 'message' => 'Failed to obtain collection.', 'http_code' => 500, 'description' => 'internalError'], + ['code' => 'Console.BadRequest', 'message' => 'The request has invalid parameters.', 'http_code' => 400, 'description' => 'Invalid request. Check the request parameters.'], + ['code' => 'Console.CallServiceError', 'message' => 'An internal service error occurred.', 'http_code' => 500, 'description' => ''], + ['code' => 'Console.InstanceNotFound', 'message' => 'The specified ImageSearch instance is not found.', 'http_code' => 400, 'description' => 'The specified instance ID does not exist. Check the instance ID and try again.'], + ['code' => 'Console.InstanceStatusError', 'message' => 'The current instance status does not support this operation.', 'http_code' => 409, 'description' => 'Instance status error, please check the instance status'], + ['code' => 'Console.InternalError', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 500, 'description' => 'The server has an internal error. Log on to the Alibaba Cloud console to submit a ticket.'], + ['code' => 'Console.LoginError', 'message' => 'Check login failed.', 'http_code' => 401, 'description' => 'Login failed, please check whether the user name, password and email address are entered incorrectly.'], + ['code' => 'Console.MigrateCapacityError', 'message' => 'Migration instance specification error.', 'http_code' => 400, 'description' => 'The specification of the target instance to be migrated is incorrect. The specification of the target instance must be greater than or equal to the specification of the source instance.'], + ['code' => 'Console.MigrateDocNumError', 'message' => 'Migration target instance doc quantity error.', 'http_code' => 400, 'description' => 'The number of docs for the target instance must be 0.'], + ['code' => 'Console.MigrateError', 'message' => 'An instance can only have one migration task.', 'http_code' => 400, 'description' => 'An instance can only have one migration task.'], + ['code' => 'Console.MigrateExistError', 'message' => 'Only one migration task can exist in an instance.', 'http_code' => 400, 'description' => 'Only one migration task can exist in the current instance.'], + ['code' => 'Console.MigrateTypeError', 'message' => 'Migration instance type error.', 'http_code' => 400, 'description' => 'Both instances must be of the same type.'], + ['code' => 'Console.ModifyTokenTimesExceed', 'message' => 'You can only modify the token once every day.', 'http_code' => 400, 'description' => ''], + ['code' => 'Console.NoPermissionError', 'message' => 'You are not authorized to perform this operation.', 'http_code' => 403, 'description' => ''], + ['code' => 'Console.NotAllowedModifyToken', 'message' => 'You are not allowed to modify token today.', 'http_code' => 403, 'description' => ''], + ['code' => 'Console.OrderStatusError', 'message' => 'Current Order status not supported this opreate.', 'http_code' => 409, 'description' => 'User order error, please confirm that the order is valid'], + ['code' => 'Console.PidDescError', 'message' => 'The maximum character length of this PidDesc parameter is 32.', 'http_code' => 400, 'description' => ''], + ['code' => 'Console.PidError', 'message' => 'The number of PID bindings of the current instance exceeds 50.', 'http_code' => 400, 'description' => ''], + ['code' => 'Console.TaskAlreadyExist', 'message' => 'A task that is in progress already exists.', 'http_code' => 409, 'description' => ''], + ['code' => 'DeniedRequest', 'message' => 'Your request was denied due to instance flow control.', 'http_code' => 403, 'description' => ''], + ['code' => 'EmptyMeta', 'message' => 'The body content has an empty meta field.', 'http_code' => 400, 'description' => ''], + ['code' => 'ExtractFeatureTimeout', 'message' => 'The request timed out while extracting features.', 'http_code' => 500, 'description' => ''], + ['code' => 'IncorrectOrientation', 'message' => 'The image contains incorrect rotation flags in the meta data.', 'http_code' => 400, 'description' => ''], + ['code' => 'InstanceOverQuota', 'message' => 'The number of items exceeds the limit.', 'http_code' => 400, 'description' => ''], + ['code' => 'InstanceStatusError', 'message' => 'The current instance status does not support this operation.', 'http_code' => 400, 'description' => ''], + ['code' => 'InternalOssError', 'message' => 'An internal OAS error occurred.', 'http_code' => 500, 'description' => ''], + ['code' => 'InternalSwiftError', 'message' => 'An internal SWIFT error occurred.', 'http_code' => 500, 'description' => ''], + ['code' => 'InternalTableStoreError', 'message' => 'An internal Table Store error occurred.', 'http_code' => 500, 'description' => ''], + ['code' => 'InvalidCategory', 'message' => 'The specified category is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidCategoryId', 'message' => 'The specified CategoryId parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidCrop', 'message' => 'The specified Crop parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidCustomContent', 'message' => 'The specified CustomContent is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFilterClause', 'message' => 'The specified filtering condition is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidInstance', 'message' => 'The specified instance name is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidIntAttr', 'message' => 'The specified int_attr field is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidIntAttr', 'message' => 'The specified parameter IntAttr is not valid.', 'http_code' => 400, 'description' => 'Invalid IntAttr'], + ['code' => 'InvalidIntAttr2', 'message' => 'The specified parameter IntAttr2 is not valid.', 'http_code' => 400, 'description' => 'Invalid IntAttr2'], + ['code' => 'InvalidIntAttr3', 'message' => 'The specified parameter IntAttr3 is not valid.', 'http_code' => 400, 'description' => 'Invalid IntAttr3'], + ['code' => 'InvalidIntAttr4', 'message' => 'The specified parameter IntAttr4 is not valid.', 'http_code' => 400, 'description' => 'Invalid'], + ['code' => 'InvalidMetaItem', 'message' => 'The meta field is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidNum', 'message' => 'The specified Num parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidNumParameter', 'message' => 'The specified parameter num is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidParameterReturnPicFormat', 'message' => 'The specified parameter returnPicFormat is invalid', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidParameterReturnPicType', 'message' => 'The specified parameter returnPicType is invalid', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidParameterTitleIndex', 'message' => 'The specified parameter titleIndex is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidPicContent', 'message' => 'The image size exceeds 4 MB.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidPicList', 'message' => 'The specified pic_list parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidPicName', 'message' => 'The specified PicName is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidPicUrl', 'message' => 'The specified parameter PicUrl is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidPrimaryPicContent', 'message' => 'The specified parameter PrimaryPicContent is not valid.', 'http_code' => 400, 'description' => 'Invalid PrimaryPicContent parameter'], + ['code' => 'InvalidProductId', 'message' => 'The specified ProductId is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidProductId', 'message' => 'The parameter ProductId no specified.', 'http_code' => 400, 'description' => 'Invalid ProductId'], + ['code' => 'InvalidSecondaryPicContent', 'message' => 'The specified parameter SecondaryPicContent is not valid.', 'http_code' => 400, 'description' => 'Invalid SecondaryPicContent parameter'], + ['code' => 'InvalidStart', 'message' => 'The specified Start parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidStartParameter', 'message' => 'The specified parameter start is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidStrAttr', 'message' => 'The specified StrAttr is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidStrAttr', 'message' => 'The specified parameter StrAttr is not valid.', 'http_code' => 400, 'description' => 'Invalid StrAttr'], + ['code' => 'InvalidStrAttr2', 'message' => 'The specified parameter StrAttr2 is not valid.', 'http_code' => 400, 'description' => 'Invalid'], + ['code' => 'InvalidStrAttr3', 'message' => 'The specified parameter StrAttr3 is not valid.', 'http_code' => 400, 'description' => 'Invalid StrAttr3'], + ['code' => 'InvalidStrAttr4', 'message' => 'The specified parameter StrAttr4 is not valid.', 'http_code' => 400, 'description' => 'Invalid StrAttr4'], + ['code' => 'InvalidText', 'message' => 'The specified parameter Text is not valid.', 'http_code' => 400, 'description' => 'Description Text cannot be null'], + ['code' => 'InvalidTextLength', 'message' => 'Invalid text clause.', 'http_code' => 400, 'description' => 'The text field length must be within 512.'], + ['code' => 'InvalidType', 'message' => 'The specified Type is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidUserType', 'message' => 'The specified UserType parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'NeedRegisterBeforeInvoke', 'message' => 'Register for PID before invoking the service.', 'http_code' => 400, 'description' => ''], + ['code' => 'NetworkException', 'message' => 'A network error occurred.', 'http_code' => 500, 'description' => ''], + ['code' => 'NoCaretSeperator', 'message' => 'The body content is missing the ^ separator.', 'http_code' => 400, 'description' => ''], + ['code' => 'NoPermission', 'message' => 'You are not authorized to perform this operation.', 'http_code' => 403, 'description' => ''], + ['code' => 'NoPicList', 'message' => 'The body content is missing the pic_list parameter.', 'http_code' => 400, 'description' => ''], + ['code' => 'NoSpecifiedAddPic', 'message' => 'You must specify an image.', 'http_code' => 400, 'description' => ''], + ['code' => 'NoSpecifiedItemId', 'message' => 'You must specify item_id.', 'http_code' => 400, 'description' => ''], + ['code' => 'NoSpecifiedPic', 'message' => 'The content of an image is not specified in the HTTP POST body.', 'http_code' => 400, 'description' => ''], + ['code' => 'NoSpecifiedPicContent', 'message' => 'You must specify PicContent.', 'http_code' => 400, 'description' => ''], + ['code' => 'NoSpecifiedPicName', 'message' => 'You must specify PicName.', 'http_code' => 400, 'description' => ''], + ['code' => 'NoSpecifiedProductId', 'message' => 'You must specify ProductId.', 'http_code' => 400, 'description' => ''], + ['code' => 'NoSpecifiedSearchPic', 'message' => 'You must specify a search image.', 'http_code' => 400, 'description' => ''], + ['code' => 'OverflowMaxResultNum', 'message' => 'The specified number of total results exceeds the maximum of 500.', 'http_code' => 400, 'description' => ''], + ['code' => 'OverflowMaxReturnNum', 'message' => 'The specified number of results for each request exceeds the maximum of 100.', 'http_code' => 400, 'description' => ''], + ['code' => 'PicNotExist', 'message' => 'The specified image does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'PictureError', 'message' => '[download] Img Download Failed.', 'http_code' => 500, 'description' => 'Picture download failed, please check the picture'], + ['code' => 'PidNotExist', 'message' => 'The specified Pid parameter does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'RequestTimeout', 'message' => 'The request timed out.', 'http_code' => 500, 'description' => ''], + ['code' => 'SearchTimeout', 'message' => 'The request timed out.', 'http_code' => 400, 'description' => ''], + ['code' => 'ServerInternalError', 'message' => 'An internal error occurred.', 'http_code' => 500, 'description' => ''], + ['code' => 'TimeoutForTransferImage', 'message' => 'Image transfer timed out.', 'http_code' => 400, 'description' => ''], + ['code' => 'UnknownException', 'message' => 'An internal server error occurred.', 'http_code' => 500, 'description' => ''], + ['code' => 'UnsupportedInstanceType', 'message' => 'The instance type is not supported.', 'http_code' => 500, 'description' => ''], + ['code' => 'UnsupportedOperationType', 'message' => 'The specified action is not supported.', 'http_code' => 500, 'description' => ''], + ['code' => 'UnsupportedPicCategory', 'message' => 'The picture category is not supported.', 'http_code' => 400, 'description' => ''], + ['code' => 'UnsupportedPicFormat', 'message' => 'The specified image format is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'UnsupportedPicPixels', 'message' => 'The specified pixels is not supported.', 'http_code' => 400, 'description' => ''], + ['code' => 'UnsupportedPictureFormat', 'message' => 'The format of the specified picture is not supported.', 'http_code' => 400, 'description' => ''], + ['code' => 'UnsupportedInstanceType', 'message' => 'The instance type is not supported.', 'http_code' => 400, 'description' => ''], + ['code' => 'UnsupportedOperationType', 'message' => 'The specified action is not supported.', 'http_code' => 400, 'description' => ''], + ['code' => 'PictureError', 'message' => '[download] Img Download Failed.', 'http_code' => 400, 'description' => 'Picture download failed, please check the picture'], + ['code' => 'Console.OssError', 'message' => 'OSS information error.', 'http_code' => 400, 'description' => 'oss information error'], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateImage'], + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteImage'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchImageByPic'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchImageByName'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddImage'], + ], + ], + 'ram' => [ + 'productCode' => 'ImageSearch', + 'productName' => 'Image Search', + 'ramCodes' => ['imagesearch'], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'SearchImageByPic', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imagesearch:SearchImageByPic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidStrAttr2', - 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', + ], + ], + [ + 'apiName' => 'DumpMetaList', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'imagesearch:DumpMetaList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'UnsupportedInstanceType', - 'errorMessage' => 'The instance type is not supported.', + ], + ], + [ + 'apiName' => 'SearchImageByText', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imagesearch:SearchImageByText', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'UnsupportedOperationType', - 'errorMessage' => 'The specified action is not supported.', + ], + ], + [ + 'apiName' => 'AddImage', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imagesearch:AddImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation.', + ], + [ + 'apiName' => 'SearchImageByName', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imagesearch:SearchImageByName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'DeniedRequest', - 'errorMessage' => 'Your request was denied due to instance flow control.', + ], + ], + [ + 'apiName' => 'SearchImageByFilter', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imagesearch:SearchImageByFilter', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal server error occurred.', + ], + [ + 'apiName' => 'DumpMeta', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'imagesearch:DumpMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'NetworkException', - 'errorMessage' => 'A network error occurred.', + ], + ], + [ + 'apiName' => 'UpdateImage', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imagesearch:UpdateImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'RequestTimeout', - 'errorMessage' => 'The request is timeout.', + ], + ], + [ + 'apiName' => 'DeleteImage', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imagesearch:DeleteImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'ExtractFeatureTimeout', - 'errorMessage' => 'The request was timed out while extracting features.', + ], + ], + [ + 'apiName' => 'CheckImageExists', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imagesearch:CheckImageExists', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'AccessEngineFailed', - 'errorMessage' => 'An error occurred while accessing the search engine.', + ], + ], + [ + 'apiName' => 'IncreaseInstance', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'imagesearch:IncreaseInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InternalOssError', - 'errorMessage' => 'An internal OAS error occurred.', + ], + ], + [ + 'apiName' => 'Detail', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'imagesearch:Detail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InternalSwiftError', - 'errorMessage' => 'An internal SWIFT error occurred.', + ], + ], + [ + 'apiName' => 'IncreaseList', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'imagesearch:IncreaseList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InternalTableStoreError', - 'errorMessage' => 'An internal Table Store error occurred.', + ], + ], + [ + 'apiName' => 'CompareSimilarByImage', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imagesearch:CompareSimilarByImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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', ], + 'resourceTypes' => [], ], ]; |