diff options
Diffstat (limited to 'data/en_us/imgsearch')
| -rw-r--r-- | data/en_us/imgsearch/2020-03-20/api-docs.php | 1055 |
1 files changed, 664 insertions, 391 deletions
diff --git a/data/en_us/imgsearch/2020-03-20/api-docs.php b/data/en_us/imgsearch/2020-03-20/api-docs.php index 64149ec..552f0fc 100644 --- a/data/en_us/imgsearch/2020-03-20/api-docs.php +++ b/data/en_us/imgsearch/2020-03-20/api-docs.php @@ -1,39 +1,25 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'imgsearch', - 'version' => '2020-03-20', - ], + 'info' => ['style' => 'RPC', 'product' => 'imgsearch', 'version' => '2020-03-20'], 'directories' => [ [ - 'id' => 64439, - 'title' => null, + 'children' => ['CreateImageDb', 'ListImageDbs', 'SearchImage', 'DeleteImageDb'], + 'type' => 'directory', + 'title' => 'Duplicate image detection', + ], + [ + 'children' => ['AddImage', 'DeleteImage', 'ListImages'], + 'title' => 'Others', 'type' => 'directory', - 'children' => [ - 'CreateImageDb', - 'ListImageDbs', - 'AddImage', - 'ListImages', - 'SearchImage', - 'DeleteImageDb', - 'DeleteImage', - ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'CreateImageDb' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddImage' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -41,48 +27,105 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'DbName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'default', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The name of the database. The name can contain lowercase letters, digits, and underscores (_), and must be 2 to 64 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'default', 'title' => ''], + ], + [ + 'name' => 'ImageUrl', + 'in' => 'formData', + 'schema' => ['description' => 'The URL of the image. We recommend that you use an Object Storage Service (OSS) URL in the Shanghai region. If the file is stored locally or the OSS URL is in a region other than Shanghai, see [File URL processing](~~155645~~).', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'https://viapi-test.oss-cn-shanghai.aliyuncs.com/test/imgsearch/xxxx.png', 'title' => ''], + ], + [ + 'name' => 'ExtraData', + 'in' => 'formData', + 'schema' => ['description' => 'The custom data. The value can contain letters, digits, punctuation marks, and Chinese characters, and must be 0 to 512 characters in length.', 'type' => 'string', 'required' => false, 'example' => '风景', 'title' => ''], + ], + [ + 'name' => 'EntityId', + 'in' => 'formData', + 'schema' => ['description' => 'The entity ID, which can be used as a data group ID. The ID can contain lowercase letters, digits, and underscores (_), and must be 1 to 64 characters in length.', 'type' => 'string', 'required' => true, 'example' => '001', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'DD106AE3-838A-41D7-8CD0-B902DC2BC109', - 'type' => 'string', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4DC6BB62-06D1-4242-939A-4AC500662E33', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'DataId' => ['description' => 'The data ID.', 'type' => 'string', 'example' => '1585903814940000', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DD106AE3-838A-41D7-8CD0-B902DC2BC109\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>DD106AE3-838A-41D7-8CD0-B902DC2BC109</RequestId>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DC6BB62-06D1-4242-939A-4AC500662E33\\",\\n \\"Data\\": {\\n \\"DataId\\": \\"1585903814940000\\"\\n }\\n}","type":"json"}]', + 'title' => 'Add image data', + 'summary' => 'This topic describes the syntax and examples of the AddImage operation.', + 'description' => '## Feature description'."\n" + .'The AddImage operation adds image data to a specified database.'."\n" + ."\n\n" + .'> - Each database can contain up to 50,000 images.'."\n" + .'- To learn more about Alibaba Cloud Vision AI capabilities, API integration, usage, or consultation, join the DingTalk group (23109592) to contact us.'."\n" + ."\n" + .'## Service notice'."\n" + .'The Visual Search service stopped receiving updates on February 15, 2023. New users can no longer activate this service. New users should use the [new Image Search](https://ai.aliyun.com/imagesearch). After February 15, 2023, existing users are still supported. If you have questions about the Visual Search service, join the DingTalk group (23109592) to contact us.'."\n" + ."\n" + .'## Input limits'."\n" + .'- Image format: JPG, JPEG, or PNG.'."\n" + ."\n" + .'- Image size: up to 2 MB.'."\n" + ."\n" + .'- Image resolution: greater than 128 × 128 pixels and less than 1024 × 1024 pixels.'."\n" + ."\n" + .'- The URL cannot contain Chinese characters.', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - ], - 'ListImageDbs' => [ - 'methods' => [ - 'post', - 'get', + 'responseParamsDescription' => '## SDK reference'."\n" + .'Alibaba Cloud Vision AI capabilities are best used through SDKs, which support multiple programming languages. SDKs support both local files and arbitrary URLs as file parameters. For more information, see [SDK overview](~~145033~~).', + 'extraInfo' => '## Error codes'."\n" + .'For error codes of the AddImage operation, see [Common error codes](~~159136~~).'."\n" + ."\n" + .'## Security notice'."\n" + .'- Ensure that the uploaded images or files comply with applicable laws and regulations.'."\n" + .'- Temporary files uploaded through the debugging console are valid for 1 hour and are automatically deleted by the system after 24 hours.', + 'changeSet' => [ + ['createdAt' => '2022-11-07T01:48:22.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddImage'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'viapi-imgsearch:AddImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateImageDb' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -90,57 +133,74 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The database name. The name can contain lowercase letters, digits, and underscores (_) and must be 2 to 64 characters in length.'."\n" + .'> Each Alibaba Cloud account that has activated the visual search service can create only one database by default.', 'type' => 'string', 'required' => true, 'example' => 'default', 'title' => ''], + ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '4E010B89-B370-458A-A586-B9A9F3BC3058', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'properties' => [ - 'DbList' => [ - 'description' => '', - 'items' => [ - 'properties' => [ - 'Name' => [ - 'description' => '', - 'example' => 'default', - 'type' => 'string', - ], - ], - 'type' => 'object', - ], - 'type' => 'array', - ], - ], - 'type' => 'object', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD106AE3-838A-41D7-8CD0-B902DC2BC109', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4E010B89-B370-458A-A586-B9A9F3BC3058\\",\\n \\"Data\\": {\\n \\"DbList\\": [\\n {\\n \\"Name\\": \\"default\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>4E010B89-B370-458A-A586-B9A9F3BC3058</RequestId>\\n<Data>\\n <DbList>\\n <Name>default</Name>\\n </DbList>\\n</Data>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DD106AE3-838A-41D7-8CD0-B902DC2BC109\\"\\n}","type":"json"}]', + 'title' => 'Create a database', + 'summary' => 'This topic describes the syntax and examples of the CreateImageDb operation for creating a database.', + 'description' => '## Feature description'."\n" + .'The create database feature creates an image database.'."\n" + ."\n" + .'> - Each Alibaba Cloud account that has activated the visual search service can create only one database by default.'."\n" + .'- To learn more about the visual AI API operations on the Alibaba Cloud Vision Intelligence Open Platform, including API access, usage, or consultation, join the DingTalk group (23109592) to contact us.'."\n" + ."\n" + .'## Service notice'."\n" + .'The visual search service stopped receiving updates on February 15, 2023. New users can no longer activate or access this service. New users should use the [new Image Search](https://ai.aliyun.com/imagesearch). After February 15, 2023, existing users are still supported. If you have questions about the visual search service, search for and join the DingTalk group (23109592) to contact us.', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - ], - 'AddImage' => [ - 'methods' => [ - 'post', - 'get', + 'responseParamsDescription' => '## SDK reference'."\n" + .'We recommend that you use the Alibaba Cloud Vision AI SDK to call this operation. The SDK supports multiple programming languages and allows you to pass file parameters as local files or URLs. For more information, see [SDK overview](~~145033~~).', + 'extraInfo' => '## Error codes'."\n" + .'For error codes of the create database operation, see [Common error codes](~~159136~~).'."\n" + ."\n\n" + ."\n" + .'## Security notice'."\n" + .'- Make sure that the images or files you upload comply with applicable laws and regulations.'."\n" + .'- Temporary files uploaded through the debugging console are valid for 1 hour and will be automatically cleaned up and deleted by the system after 24 hours.', + 'changeSet' => [ + ['createdAt' => '2022-11-07T01:48:22.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateImageDb'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'viapi-imgsearch:CreateImageDb', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteImage' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -148,90 +208,242 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'DbName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'default', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'example' => 'default', 'title' => ''], ], [ - 'name' => 'ImageUrl', + 'name' => 'EntityId', 'in' => 'formData', + 'schema' => ['description' => 'The entity ID of the data to be deleted.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3F3F81A5-4C37-4716-AE5C-518D2537365C', 'title' => ''], + ], 'description' => '', - 'example' => 'https://viapi-test.oss-cn-shanghai.aliyuncs.com/test/imgsearch/xxxx.png', - 'isFileTransferUrl' => true, - 'required' => true, - 'type' => 'string', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F3F81A5-4C37-4716-AE5C-518D2537365C\\"\\n}","type":"json"}]', + 'title' => 'Delete an image', + 'summary' => 'Deletes an image from a specified database.', + 'description' => '## Description'."\n" + .'The DeleteImage operation deletes an image from a specified database.'."\n" + ."\n\n" + .'> To learn more about how to access and use the visual AI APIs on Alibaba Cloud Vision Intelligence Platform, or to consult on related issues, join the Alibaba Cloud Vision Intelligence Platform consultation group on DingTalk (group ID: 23109592).'."\n" + ."\n" + .'## Service notice'."\n" + .'The Visual Search service stopped receiving updates on February 15, 2023, and no longer supports new users. New users should use [Image Search](https://ai.aliyun.com/imagesearch). After February 15, 2023, existing users are still supported. If you have questions about the Visual Search service, join the Alibaba Cloud Vision Intelligence Platform consultation group on DingTalk (group ID: 23109592).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '## SDK reference'."\n" + .'Alibaba Cloud Visual AI recommends using the SDK to call this operation. The SDK supports multiple programming languages and allows you to use local files or URLs as file parameters. For more information, see [SDK overview](~~145033~~).', + 'extraInfo' => '## Error codes'."\n" + .'For error codes of the DeleteImage operation, see [Common error codes](~~159136~~).'."\n" + ."\n\n" + ."\n" + .'## Security notice'."\n" + .'- Ensure that the images or files you upload comply with applicable laws and regulations.'."\n" + .'- Temporary files uploaded through the debugging console are valid for 1 hour and are automatically cleaned up by the system after 24 hours.', + 'changeSet' => [ + ['createdAt' => '2022-11-07T01:48:22.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteImage'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'viapi-imgsearch:DeleteImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DeleteImageDb' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ExtraData', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ + [ + 'name' => 'Name', 'in' => 'formData', + 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'example' => 'default', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3F3F81A5-4C37-4716-AE5C-518D2537365C', 'title' => ''], + ], 'description' => '', + 'title' => '', 'example' => '', - 'required' => false, - 'type' => 'string', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F3F81A5-4C37-4716-AE5C-518D2537365C\\"\\n}","type":"json"}]', + 'title' => 'Delete a database', + 'summary' => 'This topic describes the syntax and examples of the DeleteImageDb operation.', + 'description' => '## Description'."\n" + .'The delete database feature deletes a specified database.'."\n" + ."\n" + .'><warning>'."\n" + .'A deleted database cannot be recovered. Proceed with caution.'."\n" + .'></warning>'."\n" + ."\n" + .'## Service notice'."\n" + .'Visual Search was discontinued for updates starting February 15, 2023. New users can no longer activate the service. New users can use [the new Image Search](https://ai.aliyun.com/imagesearch). After February 15, 2023, existing users are still supported. If you have questions about Visual Search, search for DingTalk group 23109592 to join the Alibaba Cloud Visual Intelligence Open Platform consultation group.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '## SDK reference'."\n" + .'We recommend that you use the Alibaba Cloud Visual AI SDK. The SDK supports multiple programming languages and allows you to pass file parameters as local files or URLs. For more information, see [SDK overview](~~145033~~).', + 'extraInfo' => '## Error codes'."\n" + .'For error codes of the DeleteImageDb operation, see [Common error codes](~~159136~~).'."\n" + ."\n\n" + ."\n" + .'## Security declaration'."\n" + .'- Make sure that the images or files you upload comply with applicable laws and regulations.'."\n" + .'- Temporary files uploaded for trial and debugging are valid for 1 hour and will be automatically cleaned up and deleted by the system after 24 hours.', + 'changeSet' => [ + ['createdAt' => '2022-11-07T01:48:22.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteImageDb'], + ], + ], + 'ramActions' => [ [ - 'name' => 'EntityId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '001', - 'required' => true, - 'type' => 'string', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'viapi-imgsearch:DeleteImageDb', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + ], + 'ListImageDbs' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '4DC6BB62-06D1-4242-939A-4AC500662E33', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4E010B89-B370-458A-A586-B9A9F3BC3058', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The returned result data.', + 'type' => 'object', 'properties' => [ - 'DataId' => [ - 'description' => '', - 'example' => '1585903814940000', - 'type' => 'string', + 'DbList' => [ + 'description' => 'The list of databases.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'default', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4DC6BB62-06D1-4242-939A-4AC500662E33\\",\\n \\"Data\\": {\\n \\"DataId\\": \\"1585903814940000\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>4DC6BB62-06D1-4242-939A-4AC500662E33</RequestId>\\n<Data>\\n <DataId>1585903814940000</DataId>\\n</Data>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E010B89-B370-458A-A586-B9A9F3BC3058\\",\\n \\"Data\\": {\\n \\"DbList\\": [\\n {\\n \\"Name\\": \\"default\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query database list', + 'summary' => 'This topic describes the syntax and examples of the ListImageDbs operation for querying the list of databases.', + 'description' => '## Description'."\n" + .'The ListImageDbs operation queries the list of databases.'."\n" + ."\n\n" + .'> To request access to Alibaba Cloud Vision AI capabilities, learn about API operations, or consult on related issues, join the Alibaba Cloud visual intelligence open platform consultation group on DingTalk (group ID: 23109592).'."\n" + ."\n" + .'## Service notice'."\n" + .'The Visual Search service stopped receiving updates on February 15, 2023, and no longer supports new user access. New users should use [Image Search](https://ai.aliyun.com/imagesearch). After February 15, 2023, existing users are still supported. If you have questions about the Visual Search service, join the Alibaba Cloud visual intelligence open platform consultation group by searching for DingTalk group ID 23109592.', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - ], - 'ListImages' => [ - 'methods' => [ - 'post', - 'get', + 'responseParamsDescription' => '## SDK reference'."\n" + .'We recommend that you use the Alibaba Cloud Vision AI SDK to call this operation. The SDK supports multiple programming languages and allows you to pass file parameters as local files or URLs. For more information, see [SDK overview](~~145033~~).', + 'extraInfo' => '## Error codes'."\n" + .'For error codes of the ListImageDbs operation, see [Common error codes](~~159136~~).'."\n" + ."\n\n" + ."\n" + .'## Security notice'."\n" + .'- Ensure that the images or files you upload comply with applicable laws and regulations.'."\n" + .'- Temporary files uploaded through the debugging console are valid for 1 hour and are automatically deleted by the system after 24 hours.', + 'changeSet' => [ + ['createdAt' => '2022-11-07T01:48:22.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListImageDbs'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'viapi-imgsearch:ListImageDbs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListImages' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -239,153 +451,128 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DbName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'default', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'example' => 'default', 'title' => ''], ], [ 'name' => 'Token', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '2', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The pagination method that combines Offset and Limit supports only the first 2,000 records. If the number of records exceeds 2,000, use the Token returned in the previous request as the parameter for requesting the next page.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'Offset', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The start record.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'Limit', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '50', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The maximum number of entries to return per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], ], [ 'name' => 'Order', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'asc', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The sort order. Valid values:'."\n" + .'- asc: ascending order.'."\n" + .'- desc: descending order.', 'type' => 'string', 'required' => false, 'example' => 'asc', 'title' => ''], ], [ 'name' => 'EntityIdPrefix', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'U1', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The prefix of the sample ID.', 'type' => 'string', 'required' => false, 'example' => 'U1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '2B93C43A-F824-40C8-AF79-844342B0F43A', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2B93C43A-F824-40C8-AF79-844342B0F43A', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The returned result data.', + 'type' => 'object', 'properties' => [ 'ImageList' => [ - 'description' => '', + 'description' => 'The returned image data list.', + 'type' => 'array', 'items' => [ + 'type' => 'object', 'properties' => [ - 'EntityId' => [ - 'description' => '', - 'example' => '5', - 'type' => 'string', - ], - 'CreatedAt' => [ - 'description' => '', - 'example' => '1582838489213', - 'format' => 'int64', - 'type' => 'integer', - ], - 'UpdatedAt' => [ - 'description' => '', - 'example' => '1582838489213', - 'format' => 'int64', - 'type' => 'integer', - ], - 'DataId' => [ - 'description' => '', - 'example' => '001', - 'type' => 'string', - ], - 'ExtraData' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], + 'EntityId' => ['description' => 'The entity ID or group ID.', 'type' => 'string', 'example' => '5', 'title' => ''], + 'CreatedAt' => ['description' => 'The time when the data was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1582838489213', 'title' => ''], + 'UpdatedAt' => ['description' => 'The time when the data was updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1582838489213', 'title' => ''], + 'DataId' => ['description' => 'The data ID.', 'type' => 'string', 'example' => '001', 'title' => ''], + 'ExtraData' => ['description' => 'The custom data content.', 'type' => 'string', 'example' => '元素', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'type' => 'array', - ], - 'Token' => [ - 'description' => '', - 'example' => '2', - 'type' => 'string', - ], - 'TotalCount' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int32', - 'type' => 'integer', + 'title' => '', + 'example' => '', ], + 'Token' => ['description' => 'The pagination method that combines Offset and Limit supports only the first 2,000 records.'."\n" + .'If the number of records exceeds 2,000, use the Token returned in the previous request as the parameter for requesting the next page.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2B93C43A-F824-40C8-AF79-844342B0F43A\\",\\n \\"Data\\": {\\n \\"ImageList\\": [\\n {\\n \\"EntityId\\": \\"5\\",\\n \\"CreatedAt\\": 1582838489213,\\n \\"UpdatedAt\\": 1582838489213,\\n \\"DataId\\": \\"001\\",\\n \\"ExtraData\\": \\"元素\\"\\n }\\n ],\\n \\"Token\\": \\"2\\",\\n \\"TotalCount\\": 100\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>2B93C43A-F824-40C8-AF79-844342B0F43A</RequestId>\\n<Data>\\n <Token>2</Token>\\n <TotalCount>100</TotalCount>\\n <ImageList>\\n <DataId>22</DataId>\\n <ExtraData>元素</ExtraData>\\n <EntityId>5</EntityId>\\n <UpdatedAt>1582838489213</UpdatedAt>\\n <CreatedAt>1582838489213</CreatedAt>\\n </ImageList>\\n</Data>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2B93C43A-F824-40C8-AF79-844342B0F43A\\",\\n \\"Data\\": {\\n \\"ImageList\\": [\\n {\\n \\"EntityId\\": \\"5\\",\\n \\"CreatedAt\\": 1582838489213,\\n \\"UpdatedAt\\": 1582838489213,\\n \\"DataId\\": \\"001\\",\\n \\"ExtraData\\": \\"元素\\"\\n }\\n ],\\n \\"Token\\": \\"2\\",\\n \\"TotalCount\\": 100\\n }\\n}","type":"json"}]', + 'title' => 'View image data list', + 'summary' => 'This topic describes the syntax and examples of the ListImages operation for viewing the image data list.', + 'description' => '## Feature description'."\n" + .'The image data list feature allows you to view the list of image data in a specified database.'."\n" + ."\n" + .'> To learn more about Alibaba Cloud Vision AI capabilities, including API integration, operation usage, or consultation, join the Alibaba Cloud Vision Intelligence Open Platform consultation group on DingTalk (group ID: 23109592).'."\n" + ."\n" + .'## Service notice'."\n" + .'The Visual Search service stopped receiving updates on February 15, 2023, and no longer supports new user registration. New users should use [the new Image Search service](https://ai.aliyun.com/imagesearch). After February 15, 2023, existing users are still supported. If you have questions about the Visual Search service, join the Alibaba Cloud Vision Intelligence Open Platform consultation group on DingTalk (group ID: 23109592).', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - ], - 'SearchImage' => [ - 'methods' => [ - 'post', - 'get', + 'responseParamsDescription' => '## SDK reference'."\n" + .'We recommend that you use an SDK to call Alibaba Cloud Vision AI operations. SDKs are available for multiple programming languages. You can use SDKs to pass local files or URLs as file parameters. For more information, see [SDK overview](~~145033~~).', + 'extraInfo' => '## Error codes'."\n" + .'For error codes of the image data list operation, see [Common error codes](~~159136~~).'."\n" + ."\n\n" + .'## Security notice'."\n" + .'- Make sure that the images or files you upload comply with applicable laws and regulations.'."\n" + .'- Temporary files uploaded through the China Chinese China debugging console are valid for 1 hour and are automatically deleted by the system after 24 hours.', + 'changeSet' => [ + ['createdAt' => '2022-11-07T01:48:22.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListImages'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'viapi-imgsearch:ListImages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'SearchImage' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -393,219 +580,305 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DbName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'default', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'example' => 'default', 'title' => ''], ], [ 'name' => 'ImageUrl', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/imgsearch/SearchImage/SearchImage-ku8.png', - 'isFileTransferUrl' => true, - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The URL of the image. We recommend that you use an Object Storage Service (OSS) URL in the Shanghai region. If the file is stored locally or the OSS URL is in a region other than Shanghai, see [File URL processing](~~155645~~).', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/imgsearch/SearchImage/SearchImage-ku8.png', 'title' => ''], ], [ 'name' => 'Limit', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '5', - 'format' => 'int32', - 'maximum' => '1000', - 'minimum' => '0', - 'required' => true, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The maximum number of results to return. Valid values: 1 to 200.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '1000', 'minimum' => '0', 'example' => '5', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '1', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'A98DBCEB-45E2-5F5F-B5ED-F2340182FD87', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A98DBCEB-45E2-5F5F-B5ED-F2340182FD87', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The returned result data.', + 'type' => 'object', 'properties' => [ 'MatchList' => [ - 'description' => '', + 'description' => 'The list of similar images.', + 'type' => 'array', 'items' => [ 'description' => '1', + 'type' => 'object', 'properties' => [ - 'ImageUrl' => [ - 'description' => '', - 'example' => 'http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1ie0c6-ipvnszc8584116.jpg?Expires=1635150265&OSSAccessKeyId=LTAI4Fp1Gt5RzwdEXL3o****&Signature=8rj0%2Bxg%2Bni5NxQAcEQqISX5j1w****', - 'type' => 'string', - ], - 'EntityId' => [ - 'description' => '', - 'example' => '123456', - 'type' => 'string', - ], - 'Score' => [ - 'description' => '', - 'example' => '10', - 'format' => 'float', - 'type' => 'number', - ], - 'DataId' => [ - 'description' => '', - 'example' => '001', - 'type' => 'string', - ], - 'ExtraData' => [ - 'description' => '', - 'example' => 'tangyan', - 'type' => 'string', - ], + 'ImageUrl' => ['description' => 'The URL of the similar image found in the search results.'."\n" + ."\n\n" + .'> - Use **EntryId** to determine results. The **ImageURL** returned here is only the string you entered when building the image library. The platform does not retain the original images in your image library. If you used time-limited access URLs when uploading images to the library, retain the images locally and save the mapping between **EntryID** and the images.'."\n" + .'- This URL is a temporary URL that is valid for 30 minutes. After it expires, the URL can no longer be accessed.', 'type' => 'string', 'example' => 'http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1ie0c6-ipvnszc8584116.jpg?Expires=1635150265&OSSAccessKeyId=LTAI****************&Signature=8rj0%2Bxg%2Bni5NxQAcEQqISX5j1w****', 'title' => ''], + 'EntityId' => ['description' => 'The entity ID.', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'Score' => ['description' => 'The similarity score. Valid values: 0 to 10. A higher score indicates a higher similarity.', 'type' => 'number', 'format' => 'float', 'example' => '10', 'title' => ''], + 'DataId' => ['description' => 'The data ID.', 'type' => 'string', 'example' => '001', 'title' => ''], + 'ExtraData' => ['description' => 'The custom data.', 'type' => 'string', 'example' => 'tangyan', 'title' => ''], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], - 'type' => 'array', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A98DBCEB-45E2-5F5F-B5ED-F2340182FD87\\",\\n \\"Data\\": {\\n \\"MatchList\\": [\\n {\\n \\"ImageUrl\\": \\"http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1ie0c6-ipvnszc8584116.jpg?Expires=1635150265&OSSAccessKeyId=LTAI****************&Signature=8rj0%2Bxg%2Bni5NxQAcEQqISX5j1w****\\",\\n \\"EntityId\\": \\"123456\\",\\n \\"Score\\": 10,\\n \\"DataId\\": \\"001\\",\\n \\"ExtraData\\": \\"tangyan\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<SearchImageResponse>\\n <RequestId>A98DBCEB-45E2-5F5F-B5ED-F2340182FD87</RequestId>\\n <Data>\\n <MatchList>\\n <EntityId>123456</EntityId>\\n <Score>10</Score>\\n <DataId>1</DataId>\\n <ImageUrl>http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1ie0c6-ipvnszc8584116.jpg?Expires=1635150265&OSSAccessKeyId=LTAI****************&Signature=8rj0%2Bxg%2Bni5NxQAcEQqISX5j1w****</ImageUrl>\\n <ExtraData>zhaoliu</ExtraData>\\n </MatchList>\\n <MatchList>\\n <EntityId>123457</EntityId>\\n <Score>1.1762875356333269</Score>\\n <DataId>2</DataId>\\n <ImageUrl>http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1uimages1.jpg?Expires=1635151060&OSSAccessKeyId=LTAI****************&Signature=%2Byceg79YwiShi1RWDSQ%2FSZcIec****</ImageUrl>\\n <ExtraData>wangwu</ExtraData>\\n </MatchList>\\n <MatchList>\\n <EntityId>123458</EntityId>\\n <Score>0.9932686334385976</Score>\\n <DataId>3</DataId>\\n <ImageUrl>http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1ximages2.jpg?Expires=1635151141&OSSAccessKeyId=LTAI****************&Signature=rHoEnFco%2BfLWyzHZGFwUpOaySZ****</ImageUrl>\\n <ExtraData>zhangsan</ExtraData>\\n </MatchList>\\n <MatchList>\\n <EntityId>123459</EntityId>\\n <Score>1.2938829068163327</Score>\\n <DataId>4</DataId>\\n <ImageUrl>http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1m641.jpg?Expires=1635150931&OSSAccessKeyId=LTAI****************&Signature=5m8NJ50eokih%2Fcxp%2B%2BnsA%2BTT%2BG****</ImageUrl>\\n <ExtraData>lisi</ExtraData>\\n </MatchList>\\n </Data>\\n</SearchImageResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A98DBCEB-45E2-5F5F-B5ED-F2340182FD87\\",\\n \\"Data\\": {\\n \\"MatchList\\": [\\n {\\n \\"ImageUrl\\": \\"http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1ie0c6-ipvnszc8584116.jpg?Expires=1635150265&OSSAccessKeyId=LTAI****************&Signature=8rj0%2Bxg%2Bni5NxQAcEQqISX5j1w****\\",\\n \\"EntityId\\": \\"123456\\",\\n \\"Score\\": 10,\\n \\"DataId\\": \\"001\\",\\n \\"ExtraData\\": \\"tangyan\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Search for images', + 'summary' => 'This topic describes the syntax and examples of the SearchImage operation.', + 'description' => '## Description'."\n" + .'The image search feature searches for similar images in a database based on an input image.'."\n" + ."\n" + .'> To request access to Alibaba Cloud Vision Intelligence Open Platform visual AI APIs, learn about API usage, or consult on related issues, join the DingTalk group (23109592) to contact us.'."\n" + ."\n" + .'## Service notice'."\n" + .'The visual search service stopped receiving updates on February 15, 2023. New users can no longer activate the service. New users should use [the new Image Search service](https://ai.aliyun.com/imagesearch). After February 15, 2023, existing users are still supported. If you have questions about the visual search service, search for the DingTalk group (23109592) to join the Alibaba Cloud Vision Intelligence Open Platform consultation group and contact us.'."\n" + ."\n" + .'## Input limits'."\n" + ."\n" + .'- Image format: JPG, JPEG, or PNG.'."\n" + ."\n" + .'- Image size: up to 3 MB.'."\n" + ."\n" + .'- Image resolution: greater than 128 × 128 pixels and less than 1024 × 1024 pixels.'."\n" + ."\n" + .'- The URL cannot contain Chinese characters.'."\n" + ."\n" + .'## Billing'."\n" + .'For information about the billable methods and pricing of the SearchImage operation, see [Billing overview](~~202486~~).'."\n" + .'> The debugging API below is a paid API.', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - ], - 'DeleteImageDb' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'responseParamsDescription' => '## SDK reference'."\n" + .'We recommend that you use an SDK to call Alibaba Cloud Vision AI operations. SDKs are available for multiple programming languages. File parameters can be passed as local files or arbitrary URLs through SDK calls. For more information, see [SDK overview](~~145033~~).', + 'extraInfo' => '## Error codes'."\n" + .'For error codes of the SearchImage operation, see [Common error codes](~~159136~~).'."\n" + ."\n\n" + .'## Security notice'."\n" + .'- Make sure that the images or files you upload comply with applicable laws and regulations.'."\n" + .'- Temporary files uploaded through the debugging console are valid for 1 hour and are automatically deleted by the system after 24 hours.', + 'changeSet' => [ + ['createdAt' => '2022-11-07T01:48:22.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchImage'], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'default', - 'required' => true, - 'type' => 'string', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'viapi-imgsearch:SearchImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '3F3F81A5-4C37-4716-AE5C-518D2537365C', - 'type' => 'string', - ], - ], - 'type' => 'object', + ], + ], + 'endpoints' => [ + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imgsearch.cn-shanghai.aliyuncs.com', 'endpoint' => 'imgsearch.cn-shanghai.aliyuncs.com', 'vpc' => 'imgsearch-vpc.cn-shanghai.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'AuthFailed', 'message' => 'An error occurred while performing authorization. Please check your RAM configuration.', 'http_code' => 403, 'description' => 'An error occurred while performing authorization. Please check your RAM configuration.'], + ['code' => 'ClientError.IllegalArgument', 'message' => '请检查参数，如参数值所代表的数据库是否存在', 'http_code' => 400, 'description' => ''], + ['code' => 'EntityNotExist.Role', 'message' => '没有Ram权限，请联系主账号给你添加AliyunVIAPIFullAccess权限，操作流程可参考https://help.aliyun.com/document_detail/145025.htmv', 'http_code' => 403, 'description' => ''], + ['code' => 'IllegalUrlParameter', 'message' => 'Url不合法，请检查url能否正常打开', 'http_code' => 400, 'description' => ''], + ['code' => 'InternalError.Algo', 'message' => 'An algorithm error occurred.', 'http_code' => 586, 'description' => ''], + ['code' => 'InternalError.Timeout', 'message' => '算法服务报错，请稍后重试', 'http_code' => 500, 'description' => ''], + ['code' => 'InvalidAccessKeyId.Inactive', 'message' => 'AccessKeyId非法，请检查AccessKeyId是否被禁用，或者AccessKeyId和AccessKeySecret是否填写正确。', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAccessKeyId.NotFound', 'message' => 'AccessKeyId未找到，请检查AccessKeyId和AccessKeySecret是否填写正确。', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAccessKeySecret', 'message' => 'AccessKeyId或AccessKeySecret填写错误，请检查AccessKeyId和AccessKeySecret是否填写正确。', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAction.NotFound', 'message' => '能力未找到，请检查类目与能力是否匹配，检查访问域名与能力是否匹配，关于访问域名可参考：https://help.aliyun.com/document_detail/143103.htm。SDK接入请参考：https://help.aliyun.com/document_detail/145033.html，选择合适编程语言根据实例代码作相关修改进行接入。', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidApi.ForbiddenInvoke', 'message' => '调用受限，请检查您调用的能力是否为受限能力，受限能力需要在控制台https://vision.console.aliyun.com/找到相应能力申请经过审批之后才能调用。如非上述情况，请检查账号是否欠费', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidApi.NotPurchase', 'message' => '产品未开通，请开通产品：https://common-buy.aliyun.com/?commodityCode=viapi_imgsearch_public_cn#/open', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidApi.OutOfService', 'message' => '产品未开通，请开通产品：https://common-buy.aliyun.com/?commodityCode=viapi_imgsearch_public_cn#/open', 'http_code' => 403, 'description' => ''], + ['code' => 'InvalidFile.Content', 'message' => '请参考算法文档检查文件内容，更换包含符合算法要求的', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFile.Decode', 'message' => '请检查文件是否能够正常打开', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFile.Download', 'message' => '文件无法下载，请检查链接是否可访问和本地网络情况 - 非上海OSS文件链接请参考：https://help.aliyun.com/document_detail/155645.html', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFile.REGION', 'message' => '文件链接地域不对，非上海OSS文件链接请参考：https://help.aliyun.com/document_detail/155645.html', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFile.Resolution', 'message' => '文件分辨率超出限制，请检查文件分辨率和内容，修改文件分辨率后重试', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFile.Type', 'message' => '文件类型错误，请检查文件类型 - 请参考算法API文档，使用算法支持的文件类型', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFile.URL', 'message' => '文件无法下载，请检查链接是否可访问和本地网络情况 - 非上海OSS文件链接请参考：https://help.aliyun.com/document_detail/155645.html', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImage.Content', 'message' => '请参考算法文档检查图片内容，更换包含符合算法要求的', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImage.Decode', 'message' => '请检查图片是否能够正常打开', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImage.Download', 'message' => '图片无法下载，请检查链接是否可访问和本地网络情况 - 非上海OSS图片链接请参考：https://help.aliyun.com/document_detail/155645.html', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImage.NotFoundFace', 'message' => '图像中没找到人脸，请检查您的图像中是否包含人脸或人脸太小', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImage.REGION', 'message' => '图片链接地域不对，非上海OSS图片链接请参考：https://help.aliyun.com/document_detail/155645.html', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImage.Resolution', 'message' => '文件分辨率超出限制，请检查文件分辨率和内容，修改文件分辨率后重试', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImage.Timeout', 'message' => '图片下载超时，请检查链接是否可访问和本地网络情况 - 非上海OSS图片链接请参考：https://help.aliyun.com/document_detail/155645.html。请检查OSS链接是否过期等。', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImage.Type', 'message' => '图片类型错误，请检查图片类型 - 请参考算法API文档，使用算法支持的图片类型', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImage.URL', 'message' => '图片链接非法，请检查图片链接是否可访问 - 非上海OSS图片链接请参考：https://help.aliyun.com/document_detail/155645.html', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidParameter', 'message' => 'The request parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidParameter.BadRequest', 'message' => 'The request parameter or the data has an error.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidParameter.NotFound', 'message' => '参数错误，请根据算法API文档和报错Message检查参数值。是否参数值前后多了空格或者其他特殊字符等。', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidParameter.TooLarge', 'message' => '参数错误，文件大小超出限制，请参考算法API文档调整文件大小', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidRamRole', 'message' => '没有Ram权限，请联系主账号给你添加AliyunVIAPIFullAccess权限，操作流程可参考https://help.aliyun.com/document_detail/145025.htm', 'http_code' => 403, 'description' => ''], + ['code' => 'InvalidResult', 'message' => '参数错误，请参考文档检查参数值，检查文件内容。请检查是否图片内容不完整或者太模糊等。', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidSide', 'message' => 'Specified parameter Side is not valid. 请参考文档填写正确的Side参数', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidTimeStamp.Expired', 'message' => '时间戳过期，请更新时间戳', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidVersion', 'message' => 'Specified parameter Version is not valid', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingAccessKeyId', 'message' => 'AccessKeyId未填写，请检查AccessKeyId和AccessKeySecret是否填写正确。', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingFileURL', 'message' => 'FileURL is required for this operation.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingImageURL', 'message' => 'ImageURL is required for this operation.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingLimit', 'message' => 'Limit is required for this operation', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingParameter', 'message' => 'A required parameter is not specified.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingTasks', 'message' => 'Tasks is required for this operation.', 'http_code' => 400, 'description' => ''], + ['code' => 'ParameterError', 'message' => 'The parameter is invalid. Please check again.', 'http_code' => 400, 'description' => 'The parameter is invalid. Please check again.'], + ['code' => 'ServiceUnavailable', 'message' => 'The service is unavailable.', 'http_code' => 503, 'description' => 'The service is unavailable.'], + ['code' => 'SignatureDoesNotMatch', 'message' => '签名不正确，请重新计算签名。关于签名可参考文档：https://help.aliyun.com/document_detail/144904.html', 'http_code' => 400, 'description' => ''], + ['code' => 'SignatureNonceUsed', 'message' => '签名已经被使用过，请重新计算签名。关于签名可参考文档：https://help.aliyun.com/document_detail/144904.html', 'http_code' => 400, 'description' => ''], + ['code' => 'Throttling', 'message' => 'The request was denied due to QPS limits.', 'http_code' => 400, 'description' => ''], + ['code' => 'Throttling.User', 'message' => 'The request was denied due to QPS limits.', 'http_code' => 400, 'description' => ''], + ['code' => 'Timeout', 'message' => 'The request has timed out.', 'http_code' => 408, 'description' => 'The request has timed out.'], + ['code' => 'Unauthorized', 'message' => '没有Ram权限，请联系主账号给你添加AliyunVIAPIFullAccess权限，操作流程可参考https://help.aliyun.com/document_detail/145025.htm', 'http_code' => 400, 'description' => ''], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'AddImage'], + ['description' => 'Error codes changed', 'api' => 'CreateImageDb'], + ['description' => 'Error codes changed', 'api' => 'DeleteImage'], + ['description' => 'Error codes changed', 'api' => 'DeleteImageDb'], + ['description' => 'Error codes changed', 'api' => 'ListImageDbs'], + ['description' => 'Error codes changed', 'api' => 'ListImages'], + ['description' => 'Error codes changed', 'api' => 'SearchImage'], + ], + 'createdAt' => '2022-11-07T01:48:42.000Z', + 'description' => '调整用户和API调用频率', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListImageDbs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateImageDb'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteImage'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddImage'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteImageDb'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListImages'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchImage'], + ], + ], + 'ram' => [ + 'productCode' => 'VisualIntelligenceAPI', + 'productName' => 'Visual Intelligence API', + 'ramCodes' => ['viapi-imageseg', 'viapi-imageaudit', 'viapi-ocr', 'viapi-objectdet', 'viapi-imageenhan', 'viapi-videorecog', 'viapi-imageprocess', 'viapi', 'viapi-ekyc', 'viapi-imgsearch', 'viapi-goodstech', 'viapi-facebody', 'viapi-threedvision', 'viapi-videoenhan', 'viapi-imagerecog', 'viapi-videoseg', 'viapi-regen', 'viapi-aigen'], + 'ramLevel' => 'SERVICE', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'AddImage', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'viapi-imgsearch:AddImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3F3F81A5-4C37-4716-AE5C-518D2537365C\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>3F3F81A5-4C37-4716-AE5C-518D2537365C</RequestId>","errorExample":""}]', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - ], - 'DeleteImage' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'CreateImageDb', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'viapi-imgsearch:CreateImageDb', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListImageDbs', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'viapi-imgsearch:ListImageDbs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'SearchImage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'viapi-imgsearch:SearchImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DeleteImageDb', + 'description' => '', 'operationType' => 'delete', - ], - 'parameters' => [ - [ - 'name' => 'DbName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'default', - 'required' => true, - 'type' => 'string', + 'ramAction' => [ + 'action' => 'viapi-imgsearch:DeleteImageDb', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EntityId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'required' => true, - 'type' => 'string', + ], + [ + 'apiName' => 'DeleteImage', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'viapi-imgsearch:DeleteImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '3F3F81A5-4C37-4716-AE5C-518D2537365C', - 'type' => 'string', - ], - ], - 'type' => 'object', + [ + 'apiName' => 'ListImages', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'viapi-imgsearch:ListImages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3F3F81A5-4C37-4716-AE5C-518D2537365C\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>3F3F81A5-4C37-4716-AE5C-518D2537365C</RequestId>","errorExample":""}]', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'imgsearch.cn-shanghai.aliyuncs.com', ], + 'resourceTypes' => [], ], ]; |