diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/imm | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/imm')
| -rw-r--r-- | data/en_us/imm/2017-09-06/api-docs.php | 10271 | ||||
| -rw-r--r-- | data/en_us/imm/2020-09-30/api-docs.php | 23640 |
2 files changed, 33911 insertions, 0 deletions
diff --git a/data/en_us/imm/2017-09-06/api-docs.php b/data/en_us/imm/2017-09-06/api-docs.php new file mode 100644 index 0000000..caf7638 --- /dev/null +++ b/data/en_us/imm/2017-09-06/api-docs.php @@ -0,0 +1,10271 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'imm', + 'version' => '2017-09-06', + ], + 'directories' => [ + [ + 'id' => 100259, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'OpenImmService', + ], + ], + [ + 'id' => 100262, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DeleteProject', + 'UpdateProject', + 'GetProject', + 'ListProjects', + 'PutProject', + ], + ], + [ + 'id' => 100308, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateSet', + 'DeleteSet', + 'UpdateSet', + 'GetSet', + 'ListSets', + ], + ], + [ + 'id' => 100269, + 'title' => null, + 'type' => 'directory', + 'children' => [ + [ + 'id' => 169900, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ConvertOfficeFormat', + ], + ], + [ + 'id' => 169901, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListOfficeConversionTask', + 'GetOfficeConversionTask', + 'DeleteOfficeConversionTask', + 'CreateOfficeConversionTask', + ], + ], + [ + 'id' => 169902, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'RefreshWebofficeToken', + 'RefreshOfficePreviewToken', + 'GetWebofficeURL', + 'GetOfficePreviewURL', + ], + ], + ], + ], + [ + 'id' => 100279, + 'title' => null, + 'type' => 'directory', + 'children' => [ + [ + 'id' => 169903, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetImage', + 'DeleteImage', + 'FindImages', + 'ListImages', + 'UpdateImage', + 'IndexImage', + ], + ], + [ + 'id' => 169904, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'FindSimilarFaces', + 'CompareImageFaces', + ], + ], + [ + 'id' => 169905, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListFaceGroups', + 'UpdateFaceGroup', + 'CreateGroupFacesJob', + 'CreateMergeFaceGroupsJob', + ], + ], + [ + 'id' => 169906, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListSetTags', + ], + ], + [ + 'id' => 169907, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetImageQuality', + 'GetImageCroppingSuggestions', + 'DetectQRCodes', + 'DetectImageQRCodes', + 'DetectImageTags', + ], + ], + [ + 'id' => 169908, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DetectImageFaces', + 'DetectImageBodies', + ], + ], + [ + 'id' => 169909, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'EncodeBlindWatermark', + 'DecodeBlindWatermark', + ], + ], + ], + ], + [ + 'id' => 100293, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetMediaMeta', + [ + 'id' => 169916, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'IndexVideo', + 'ListVideos', + 'GetVideo', + 'DeleteVideo', + ], + ], + [ + 'id' => 169917, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetVideoTask', + 'ListVideoTasks', + 'DeleteVideoTask', + 'CreateVideoCompressTask', + 'CreateGrabFrameTask', + ], + ], + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'OpenImmService' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + [ + 'PrivateKey' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D28EF0A3-36C0-406A-A8F0-A82019B329B0', + ], + 'OrderId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '20671870851****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ORDER.OPENED', + 'errorMessage' => '您已开通,请前往<a href="https://imm.console.aliyun.com/">控制台</a>使用', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D28EF0A3-36C0-406A-A8F0-A82019B329B0\\",\\n \\"OrderId\\": \\"20671870851****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>D28EF0A3-36C0-406A-A8F0-A82019B329B0</RequestId>\\n<OrderId>20671870851****</OrderId>","errorExample":""}]', + 'title' => 'OpenImmService', + 'requestParamsDescription' => ' ', + ], + 'DeleteProject' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'immtest', + 'required' => true, + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'example' => 'FEDC9B1F-30F2-4C1F-8ED2-B78601870B44', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEDC9B1F-30F2-4C1F-8ED2-B78601870B44\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>FEDC9B1F-30F2-4C1F-8ED2-B78601870B44</RequestId>","errorExample":""}]', + 'extraInfo' => ' ', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'UpdateProject' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'NewCU', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '6', + ], + ], + [ + 'name' => 'NewServiceRole', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'immroletest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Project' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'immtest', + ], + 'ModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-11T06:36:58Z', + ], + 'Type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'DocStarter', + ], + 'CU' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'ServiceRole' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'immroletest', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D33C3574-4093-448E-86E7-15BE2BD36963', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-10T03:50:28Z', + ], + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Project\\": \\"immtest\\",\\n \\"ModifyTime\\": \\"2020-11-11T06:36:58Z\\",\\n \\"Type\\": \\"DocStarter\\",\\n \\"CU\\": 6,\\n \\"ServiceRole\\": \\"immroletest\\",\\n \\"RequestId\\": \\"D33C3574-4093-448E-86E7-15BE2BD36963\\",\\n \\"CreateTime\\": \\"2020-11-10T03:50:28Z\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyTime>2020-11-11T06:36:58Z</ModifyTime>\\n<Project>immtest</Project>\\n<Type>DocStarter</Type>\\n<CU>6</CU>\\n<ServiceRole>immroletest</ServiceRole>\\n<RequestId>D33C3574-4093-448E-86E7-15BE2BD36963</RequestId>\\n<CreateTime>2020-11-10T03:50:28Z</CreateTime>\\n<RegionId>cn-hangzhou</RegionId>","errorExample":""}]', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'GetProject' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immtest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Project' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'immtest', + ], + 'ModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-10T03:50:28Z', + ], + 'Type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'DocStarter', + ], + 'CU' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ServiceRole' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'AliyunIMMDefaultRole', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '5A022F78-B9A8-4ACC-BB6B-B35975534551', + ], + 'Endpoint' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'imm.cn-hangzhou.aliyuncs.com', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-10T03:50:28Z', + ], + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'BillingType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ByCU', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Project\\": \\"immtest\\",\\n \\"ModifyTime\\": \\"2020-11-10T03:50:28Z\\",\\n \\"Type\\": \\"DocStarter\\",\\n \\"CU\\": 5,\\n \\"ServiceRole\\": \\"AliyunIMMDefaultRole\\",\\n \\"RequestId\\": \\"5A022F78-B9A8-4ACC-BB6B-B35975534551\\",\\n \\"Endpoint\\": \\"imm.cn-hangzhou.aliyuncs.com\\",\\n \\"CreateTime\\": \\"2020-11-10T03:50:28Z\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"BillingType\\": \\"ByCU\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyTime>2020-11-10T03:50:28Z</ModifyTime>\\n<Project>immtest</Project>\\n<CU>5</CU>\\n<Type>DocStarter</Type>\\n<ServiceRole>AliyunIMMDefaultRole</ServiceRole>\\n<Endpoint>imm.cn-hangzhou.aliyuncs.com</Endpoint>\\n<RequestId>5A022F78-B9A8-4ACC-BB6B-B35975534551</RequestId>\\n<CreateTime>2020-11-10T03:50:28Z</CreateTime>\\n<RegionId>cn-hangzhou</RegionId>\\n<BillingType>ByCU</BillingType>","errorExample":""}]', + 'title' => 'GetProject', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'ListProjects' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Marker', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'imm', + ], + ], + [ + 'name' => 'MaxKeys', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '4A7A2D0E-D8B8-4DA0-8127-EB32C6600ADE', + ], + 'Projects' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'DocStarter', + ], + 'CU' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-10T03:50:28Z', + ], + 'ServiceRole' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'AliyunIMMDefaultRole', + ], + 'Endpoint' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'imm.cn-hangzhou.aliyuncs.com', + ], + 'Project' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'immtest', + ], + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'BillingType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ByCU', + ], + 'ModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-10T03:50:28Z', + ], + ], + ], + ], + 'NextMarker' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'immimage', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4A7A2D0E-D8B8-4DA0-8127-EB32C6600ADE\\",\\n \\"Projects\\": [\\n {\\n \\"Type\\": \\"DocStarter\\",\\n \\"CU\\": 5,\\n \\"CreateTime\\": \\"2020-11-10T03:50:28Z\\",\\n \\"ServiceRole\\": \\"AliyunIMMDefaultRole\\",\\n \\"Endpoint\\": \\"imm.cn-hangzhou.aliyuncs.com\\",\\n \\"Project\\": \\"immtest\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"BillingType\\": \\"ByCU\\",\\n \\"ModifyTime\\": \\"2020-11-10T03:50:28Z\\"\\n }\\n ],\\n \\"NextMarker\\": \\"immimage\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>4A7A2D0E-D8B8-4DA0-8127-EB32C6600ADE</RequestId>\\n<Projects>\\n <ModifyTime>2020-11-10T03:50:28Z</ModifyTime>\\n <Project>immtest</Project>\\n <Type>DocStarter</Type>\\n <CU>5</CU>\\n <ServiceRole>AliyunIMMDefaultRole</ServiceRole>\\n <Endpoint>imm.cn-hangzhou.aliyuncs.com</Endpoint>\\n <CreateTime>2020-11-10T03:50:28Z</CreateTime>\\n <RegionId>cn-hangzhou</RegionId>\\n <BillingType>ByCU</BillingType>\\n</Projects>\\n<NextMarker>immimage</NextMarker>","errorExample":""}]', + 'title' => 'ListProjects', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PutProject' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => 'immtest', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'ServiceRole', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'AliyunIMMDefaultRole', + 'required' => false, + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'Project' => [ + 'description' => '', + 'example' => 'immtest', + 'type' => 'string', + ], + 'ModifyTime' => [ + 'description' => '', + 'example' => '2020-11-10T03:50:28Z', + 'type' => 'string', + ], + 'Type' => [ + 'description' => '', + 'example' => 'DocStarter', + 'type' => 'string', + ], + 'CU' => [ + 'description' => '', + 'example' => '5', + 'format' => 'int32', + 'type' => 'integer', + ], + 'ServiceRole' => [ + 'description' => '', + 'example' => 'AliyunIMMDefaultRole', + 'type' => 'string', + ], + 'RequestId' => [ + 'description' => '', + 'example' => '7F7D235C-76FF-4B65-800C-8238AE3F7230', + 'type' => 'string', + ], + 'Endpoint' => [ + 'description' => '', + 'example' => 'imm.cn-hangzhou.aliyuncs.com', + 'type' => 'string', + ], + 'CreateTime' => [ + 'description' => '', + 'example' => '2020-11-10T03:50:28Z', + 'type' => 'string', + ], + 'RegionId' => [ + 'description' => '', + 'example' => 'cn-hangzhou', + 'type' => 'string', + ], + 'BillingType' => [ + 'description' => '', + 'example' => 'ByCU', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Project\\": \\"immtest\\",\\n \\"ModifyTime\\": \\"2020-11-10T03:50:28Z\\",\\n \\"Type\\": \\"DocStarter\\",\\n \\"CU\\": 5,\\n \\"ServiceRole\\": \\"AliyunIMMDefaultRole\\",\\n \\"RequestId\\": \\"7F7D235C-76FF-4B65-800C-8238AE3F7230\\",\\n \\"Endpoint\\": \\"imm.cn-hangzhou.aliyuncs.com\\",\\n \\"CreateTime\\": \\"2020-11-10T03:50:28Z\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"BillingType\\": \\"ByCU\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyTime>2020-11-10T03:50:28Z</ModifyTime>\\n<Project>immtest</Project>\\n<Type>DocStarter</Type>\\n<CU>5</CU>\\n<ServiceRole>AliyunIMMDefaultRole</ServiceRole>\\n<Endpoint>imm.cn-hangzhou.aliyuncs.com</Endpoint>\\n<RequestId>7F7D235C-76FF-4B65-800C-8238AE3F7230</RequestId>\\n<CreateTime>2020-11-10T03:50:28Z</CreateTime>\\n<RegionId>cn-hangzhou</RegionId>\\n<BillingType>ByCU</BillingType>","errorExample":""}]', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'CreateSet' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'set001', + ], + ], + [ + 'name' => 'SetName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'myset', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-19T07:49:20.094Z', + ], + 'VideoCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ImageCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6D74B3A9-5AC0-49F9-914D-E01589D363FC', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-19T07:49:20.094Z', + ], + 'SetName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'myset', + ], + 'SetId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'set001', + ], + 'VideoLength' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'FaceCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ModifyTime\\": \\"2020-11-19T07:49:20.094Z\\",\\n \\"VideoCount\\": 0,\\n \\"ImageCount\\": 0,\\n \\"RequestId\\": \\"6D74B3A9-5AC0-49F9-914D-E01589D363FC\\",\\n \\"CreateTime\\": \\"2020-11-19T07:49:20.094Z\\",\\n \\"SetName\\": \\"myset\\",\\n \\"SetId\\": \\"set001\\",\\n \\"VideoLength\\": 0,\\n \\"FaceCount\\": 0\\n}","errorExample":""},{"type":"xml","example":"<ModifyTime>2020-11-19T07:49:20.094Z</ModifyTime>\\n<RequestId>6D74B3A9-5AC0-49F9-914D-E01589D363FC</RequestId>\\n<CreateTime>2020-11-19T07:49:20.094Z</CreateTime>\\n<SetName>myset</SetName>\\n<SetId>set001</SetId>","errorExample":""}]', + 'title' => 'CreateSet', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteSet' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Set-1126f303-6c5b-4ba3-863a-bac81aff8d2d', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EC564A9A-BA5C-4499-A087-D9B9E76E7C1C', + ], + 'SetId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Set-1126f303-6c5b-4ba3-863a-bac81aff8d2d', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC564A9A-BA5C-4499-A087-D9B9E76E7C1C\\",\\n \\"SetId\\": \\"Set-1126f303-6c5b-4ba3-863a-bac81aff8d2d\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EC564A9A-BA5C-4499-A087-D9B9E76E7C1C</RequestId>\\n<SetId>Set-1126f303-6c5b-4ba3-863a-bac81aff8d2d</SetId>","errorExample":""}]', + 'title' => 'DeleteSet', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateSet' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Set-e8dd5e4e-99f7-43d4-80d5-3456a5bd5077', + ], + ], + [ + 'name' => 'SetName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mysetnew', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-19T07:49:01.975Z', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '45234D4A-A3E3-4B23-AACA-8D897514462E', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-19T07:49:01.975Z', + ], + 'SetName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mysetnew', + ], + 'SetId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Set-e8dd5e4e-99f7-43d4-80d5-3456a5bd5077', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ModifyTime\\": \\"2020-11-19T07:49:01.975Z\\",\\n \\"RequestId\\": \\"45234D4A-A3E3-4B23-AACA-8D897514462E\\",\\n \\"CreateTime\\": \\"2020-11-19T07:49:01.975Z\\",\\n \\"SetName\\": \\"mysetnew\\",\\n \\"SetId\\": \\"Set-e8dd5e4e-99f7-43d4-80d5-3456a5bd5077\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyTime>2020-11-19T07:49:01.975Z</ModifyTime>\\n<RequestId>45234D4A-A3E3-4B23-AACA-8D897514462E</RequestId>\\n<CreateTime>2020-11-19T07:49:01.975Z</CreateTime>\\n<SetName>mysetnew</SetName>\\n<SetId>Set-e8dd5e4e-99f7-43d4-80d5-3456a5bd5077</SetId>","errorExample":""}]', + 'title' => 'UpdateSet', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetSet' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Set-d7ffb885-88c1-4702-a71f-60cf50c221c9', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-19T09:49:03.826Z', + ], + 'VideoCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ImageCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '93126E40-0296-4129-95E3-AFAC709372E5', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-19T09:49:03.826Z', + ], + 'SetName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'myimageset', + ], + 'SetId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Set-d7ffb885-88c1-4702-a71f-60cf50c221c9', + ], + 'VideoLength' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'FaceCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ModifyTime\\": \\"2020-11-19T09:49:03.826Z\\",\\n \\"VideoCount\\": 0,\\n \\"ImageCount\\": 6,\\n \\"RequestId\\": \\"93126E40-0296-4129-95E3-AFAC709372E5\\",\\n \\"CreateTime\\": \\"2020-11-19T09:49:03.826Z\\",\\n \\"SetName\\": \\"myimageset\\",\\n \\"SetId\\": \\"Set-d7ffb885-88c1-4702-a71f-60cf50c221c9\\",\\n \\"VideoLength\\": 0,\\n \\"FaceCount\\": 5\\n}","errorExample":""},{"type":"xml","example":"<ModifyTime>2020-11-19T09:49:03.826Z</ModifyTime>\\n<ImageCount>6</ImageCount>\\n<RequestId>93126E40-0296-4129-95E3-AFAC709372E5</RequestId>\\n<CreateTime>2020-11-19T09:49:03.826Z</CreateTime>\\n<SetName>myimageset</SetName>\\n<SetId>Set-d7ffb885-88c1-4702-a71f-60cf50c221c9</SetId>\\n<FaceCount>5</FaceCount>","errorExample":""}]', + 'title' => 'GetSet', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListSets' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'Marker', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Set-00', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'FEEDE356-C928-4A36-951A-6EB5A5923BEB', + ], + 'Sets' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VideoCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-19T07:49:01.975Z', + ], + 'VideoLength' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SetId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Set-435b5855-d100-4408-95f4-f2e901fa0694', + ], + 'ImageCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'FaceCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'SetName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mysetname', + ], + 'ModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-19T07:49:01.975Z', + ], + ], + ], + ], + 'NextMarker' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Set-e8dd5e4e-99f7-43d4-80d5-3456a5bd5077', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEEDE356-C928-4A36-951A-6EB5A5923BEB\\",\\n \\"Sets\\": [\\n {\\n \\"VideoCount\\": 0,\\n \\"CreateTime\\": \\"2020-11-19T07:49:01.975Z\\",\\n \\"VideoLength\\": 0,\\n \\"SetId\\": \\"Set-435b5855-d100-4408-95f4-f2e901fa0694\\",\\n \\"ImageCount\\": 6,\\n \\"FaceCount\\": 5,\\n \\"SetName\\": \\"mysetname\\",\\n \\"ModifyTime\\": \\"2020-11-19T07:49:01.975Z\\"\\n }\\n ],\\n \\"NextMarker\\": \\"Set-e8dd5e4e-99f7-43d4-80d5-3456a5bd5077\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>FEEDE356-C928-4A36-951A-6EB5A5923BEB</RequestId>\\n<Sets>\\n <ModifyTime>2020-11-19T07:49:01.975Z</ModifyTime>\\n <ImageCount>6</ImageCount>\\n <CreateTime>2020-11-19T07:49:01.975Z</CreateTime>\\n <SetName>mysetname</SetName>\\n <SetId>Set-435b5855-d100-4408-95f4-f2e901fa0694</SetId>\\n <FaceCount>5</FaceCount>\\n</Sets>\\n<NextMarker>Set-e8dd5e4e-99f7-43d4-80d5-3456a5bd5077</NextMarker>","errorExample":""}]', + 'title' => 'ListSets', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ConvertOfficeFormat' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => 'immdoctest', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'SrcUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => 'oss://bucket1/object', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'TgtType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'vector', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'TgtUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => 'oss://bucket1/converttasks/session123/', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'SrcType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'doc', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'StartPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '1', + 'format' => 'int64', + 'required' => false, + 'type' => 'integer', + ], + ], + [ + 'name' => 'EndPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '10', + 'format' => 'int64', + 'required' => false, + 'type' => 'integer', + ], + ], + [ + 'name' => 'MaxSheetRow', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '10', + 'format' => 'int64', + 'required' => false, + 'type' => 'integer', + ], + ], + [ + 'name' => 'MaxSheetCol', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '10', + 'format' => 'int64', + 'required' => false, + 'type' => 'integer', + ], + ], + [ + 'name' => 'MaxSheetCount', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '3', + 'format' => 'int64', + 'required' => false, + 'type' => 'integer', + ], + ], + [ + 'name' => 'SheetOnePage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'false', + 'required' => false, + 'type' => 'boolean', + ], + ], + [ + 'name' => 'ModelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '********', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'TgtFilePrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'aa', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'TgtFileSuffix', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'bb', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'TgtFilePages', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '[1, 2, 100]', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'FitToPagesTall', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'false', + 'required' => false, + 'type' => 'boolean', + ], + ], + [ + 'name' => 'FitToPagesWide', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'false', + 'required' => false, + 'type' => 'boolean', + ], + ], + [ + 'name' => 'PdfVector', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'false', + 'required' => false, + 'type' => 'boolean', + ], + ], + [ + 'name' => 'Hidecomments', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'false', + 'required' => false, + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'PageCount' => [ + 'description' => '', + 'example' => '10', + 'format' => 'int32', + 'type' => 'integer', + ], + 'RequestId' => [ + 'description' => '', + 'example' => 'FF3B7D81-66AE-47E0-BF69-157DCF187514', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidArgument.SrcUri', + 'errorMessage' => 'The source URI is too large or too complex to be converted within the time limit.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageCount\\": 10,\\n \\"RequestId\\": \\"FF3B7D81-66AE-47E0-BF69-157DCF187514\\"\\n}","errorExample":""},{"type":"xml","example":"<PageCount>10</PageCount>\\n<RequestId>FF3B7D81-66AE-47E0-BF69-157DCF187514</RequestId>","errorExample":""}]', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'ListOfficeConversionTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'immdoctest', + ], + ], + [ + 'name' => 'Marker', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'formatconvert-00', + ], + ], + [ + 'name' => 'MaxKeys', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Tasks' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Finished', + ], + 'Percent' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'FinishTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-13T09:33:03.520000Z', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-13T09:32:53.097000Z', + ], + 'PageCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'NotifyTopicName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'topic1', + ], + 'NotifyEndpoint' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + ], + 'TgtUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://bucket1/converttasks/session123/', + ], + 'TgtType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'png', + ], + 'SrcUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://bucket1/object', + ], + 'ImageSpec' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1024', + ], + 'ExternalID' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tasktest002', + ], + 'TaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'formatconvert-bab90254-2bfd-4ee5-a30a-bb671da7c960', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6253B819-3B81-4578-956B-7CF7E75E39E2', + ], + 'NextMarker' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'formatconvert-481c92f5-3033-4de3-8656-fcf07100d633', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Tasks\\": [\\n {\\n \\"Status\\": \\"Finished\\",\\n \\"Percent\\": 100,\\n \\"FinishTime\\": \\"2020-11-13T09:33:03.520000Z\\",\\n \\"CreateTime\\": \\"2020-11-13T09:32:53.097000Z\\",\\n \\"PageCount\\": 10,\\n \\"NotifyTopicName\\": \\"topic1\\",\\n \\"NotifyEndpoint\\": \\"http://1111111111.mns.cn-hangzhou.aliyuncs.com\\",\\n \\"TgtUri\\": \\"oss://bucket1/converttasks/session123/\\",\\n \\"TgtType\\": \\"png\\",\\n \\"SrcUri\\": \\"oss://bucket1/object\\",\\n \\"ImageSpec\\": \\"1024\\",\\n \\"ExternalID\\": \\"tasktest002\\",\\n \\"TaskId\\": \\"formatconvert-bab90254-2bfd-4ee5-a30a-bb671da7c960\\"\\n }\\n ],\\n \\"RequestId\\": \\"6253B819-3B81-4578-956B-7CF7E75E39E2\\",\\n \\"NextMarker\\": \\"formatconvert-481c92f5-3033-4de3-8656-fcf07100d633\\"\\n}","errorExample":""},{"type":"xml","example":"<Tasks>\\n <Status>Finished</Status>\\n <TgtType>png</TgtType>\\n <TaskId>formatconvert-bab90254-2bfd-4ee5-a30a-bb671da7c960</TaskId>\\n <Percent>100</Percent>\\n <CreateTime>2020-11-13T09:32:53.097000Z</CreateTime>\\n <NotifyEndpoint>http://1111111111.mns.cn-hangzhou.aliyuncs.com</NotifyEndpoint>\\n <TgtUri>oss://bucket1/converttasks/session123/</TgtUri>\\n <FinishTime>2020-11-13T09:33:03.520000Z</FinishTime>\\n <PageCount>10</PageCount>\\n <NotifyTopicName>topic1</NotifyTopicName>\\n <SrcUri>oss://bucket1/object</SrcUri>\\n</Tasks>\\n<RequestId>6253B819-3B81-4578-956B-7CF7E75E39E2</RequestId>\\n<NextMarker>formatconvert-481c92f5-3033-4de3-8656-fcf07100d633</NextMarker>","errorExample":""}]', + 'title' => 'ListOfficeConversionTask', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetOfficeConversionTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'immdoctest', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'formatconvert-a1749f07-1bb7-40ff-84af-c6df064e****', + 'required' => true, + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'Status' => [ + 'description' => '', + 'example' => 'Finished', + 'type' => 'string', + ], + 'FailDetail' => [ + 'description' => '', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'example' => 'NoError', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + 'TgtType' => [ + 'description' => '', + 'example' => 'png', + 'type' => 'string', + ], + 'TaskId' => [ + 'description' => '', + 'example' => 'formatconvert-a1749f07-1bb7-40ff-84af-c6df064e****', + 'type' => 'string', + ], + 'RequestId' => [ + 'description' => '', + 'example' => '0BC1F0C9-8E99-46C6-B502-10DEDCBA3E2E', + 'type' => 'string', + ], + 'Percent' => [ + 'description' => '', + 'example' => '100', + 'format' => 'int32', + 'type' => 'integer', + ], + 'CreateTime' => [ + 'description' => '', + 'example' => '2020-11-13T07:53:08.687000Z', + 'type' => 'string', + ], + 'ExternalID' => [ + 'description' => '', + 'example' => 'tasktest001', + 'type' => 'string', + ], + 'ImageSpec' => [ + 'description' => '', + 'example' => '1024', + 'type' => 'string', + ], + 'NotifyEndpoint' => [ + 'description' => '', + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + 'type' => 'string', + ], + 'TgtUri' => [ + 'description' => '', + 'example' => 'oss://bucket1/converttasks/session123/', + 'type' => 'string', + ], + 'FinishTime' => [ + 'description' => '', + 'example' => '2020-11-13T07:53:19.103000Z', + 'type' => 'string', + ], + 'PageCount' => [ + 'description' => '', + 'example' => '10', + 'format' => 'int32', + 'type' => 'integer', + ], + 'NotifyTopicName' => [ + 'description' => '', + 'example' => 'topic1', + 'type' => 'string', + ], + 'SrcUri' => [ + 'description' => '', + 'example' => 'oss://bucket1/object', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Finished\\",\\n \\"FailDetail\\": {\\n \\"Code\\": \\"NoError\\"\\n },\\n \\"TgtType\\": \\"png\\",\\n \\"TaskId\\": \\"formatconvert-a1749f07-1bb7-40ff-84af-c6df064e****\\",\\n \\"RequestId\\": \\"0BC1F0C9-8E99-46C6-B502-10DEDCBA3E2E\\",\\n \\"Percent\\": 100,\\n \\"CreateTime\\": \\"2020-11-13T07:53:08.687000Z\\",\\n \\"ExternalID\\": \\"tasktest001\\",\\n \\"ImageSpec\\": \\"1024\\",\\n \\"NotifyEndpoint\\": \\"http://1111111111.mns.cn-hangzhou.aliyuncs.com\\",\\n \\"TgtUri\\": \\"oss://bucket1/converttasks/session123/\\",\\n \\"FinishTime\\": \\"2020-11-13T07:53:19.103000Z\\",\\n \\"PageCount\\": 10,\\n \\"NotifyTopicName\\": \\"topic1\\",\\n \\"SrcUri\\": \\"oss://bucket1/object\\"\\n}","errorExample":""},{"type":"xml","example":"<Status>Finished</Status>\\n<FailDetail>\\n <Code>NoError</Code>\\n</FailDetail>\\n<TgtType>png</TgtType>\\n<TaskId>formatconvert-a1749f07-1bb7-40ff-84af-c6df064e3438</TaskId>\\n<RequestId>0BC1F0C9-8E99-46C6-B502-10DEDCBA3E2E</RequestId>\\n<Percent>100</Percent>\\n<CreateTime>2020-11-13T07:53:08.687000Z</CreateTime>\\n<NotifyEndpoint>http://1111111111.mns.cn-hangzhou.aliyuncs.com</NotifyEndpoint>\\n<TgtUri>oss://bucket1/converttasks/session123/</TgtUri>\\n<FinishTime>2020-11-13T07:53:19.103000Z</FinishTime>\\n<PageCount>10</PageCount>\\n<NotifyTopicName>topic1</NotifyTopicName>\\n<SrcUri>oss://bucket1/object</SrcUri>","errorExample":""}]', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DeleteOfficeConversionTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'formatconvert-35078200-b306-477e-ae82-aa5a73f38fbc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '37D69D8D-BAF1-44B7-A55C-D7D132B0238E', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"37D69D8D-BAF1-44B7-A55C-D7D132B0238E\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>37D69D8D-BAF1-44B7-A55C-D7D132B0238E</RequestId>","errorExample":""}]', + 'title' => 'DeleteOfficeConversionTask', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateOfficeConversionTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immdoctest', + ], + ], + [ + 'name' => 'SrcUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://bucket1/object', + ], + ], + [ + 'name' => 'TgtType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vector', + ], + ], + [ + 'name' => 'TgtUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://bucket1/imm-format-convert-tgt/session123/', + ], + ], + [ + 'name' => 'NotifyTopicName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'topic1', + ], + ], + [ + 'name' => 'NotifyEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + ], + ], + [ + 'name' => 'SrcType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'doc', + ], + ], + [ + 'name' => 'StartPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'EndPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MaxSheetRow', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MaxSheetCol', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MaxSheetCount', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'SheetOnePage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ModelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '********', + ], + ], + [ + 'name' => 'TgtFilePrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'aa', + ], + ], + [ + 'name' => 'TgtFileSuffix', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'bb', + ], + ], + [ + 'name' => 'TgtFilePages', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1, 2, 100', + ], + ], + [ + 'name' => 'FitToPagesTall', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'FitToPagesWide', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'IdempotentToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'd1fdd246-e187-11e8-9f32-f2801f1b9fd1', + ], + ], + [ + 'name' => 'PdfVector', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Hidecomments', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'DisplayDpi', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1024', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"fileid": "123"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Running', + ], + 'TaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd169b', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'FF3B7D81-66AE-47E0-BF69-157DCF187514', + ], + 'Percent' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-11T06:51:17.5Z', + ], + 'TgtLoc' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://bucket1/imm-format-convert-tgt/session123/', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Running\\",\\n \\"TaskId\\": \\"formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd169b\\",\\n \\"RequestId\\": \\"FF3B7D81-66AE-47E0-BF69-157DCF187514\\",\\n \\"Percent\\": 0,\\n \\"CreateTime\\": \\"2020-11-11T06:51:17.5Z\\",\\n \\"TgtLoc\\": \\"oss://bucket1/imm-format-convert-tgt/session123/\\"\\n}","errorExample":""},{"type":"xml","example":"<Status>Running</Status>\\n<TaskId>formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd169b</TaskId>\\n<RequestId>FF3B7D81-66AE-47E0-BF69-157DCF187514</RequestId>\\n<Percent>0</Percent>\\n<CreateTime>2020-11-11T06:51:17.5Z</CreateTime>\\n<TgtLoc>oss://bucket1/imm-format-convert-tgt/session123/</TgtLoc>","errorExample":""}]', + 'title' => 'CreateOfficeConversionTask', + 'responseParamsDescription' => ' ', + ], + 'RefreshWebofficeToken' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immdoctest', + ], + ], + [ + 'name' => 'AccessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '96c77f96d4c2487aba86549222********', + ], + ], + [ + 'name' => 'RefreshToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '4cdfb7fac3564268aff15360ac********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RefreshToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'e3f0fc87c5e24555835961e9a3********', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '488F3004-4105-4F28-A634-26353BBF866C', + ], + 'AccessToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0301d19407084bd0b9449d6ecc********', + ], + 'RefreshTokenExpiredTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-12-26T09:14:42.986876757Z', + ], + 'AccessTokenExpiredTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-12-25T09:44:42.986876757Z', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RefreshToken\\": \\"e3f0fc87c5e24555835961e9a3********\\",\\n \\"RequestId\\": \\"488F3004-4105-4F28-A634-26353BBF866C\\",\\n \\"AccessToken\\": \\"0301d19407084bd0b9449d6ecc********\\",\\n \\"RefreshTokenExpiredTime\\": \\"2020-12-26T09:14:42.986876757Z\\",\\n \\"AccessTokenExpiredTime\\": \\"2020-12-25T09:44:42.986876757Z\\"\\n}","errorExample":""},{"type":"xml","example":"<RefreshToken>e3f0fc87c5e24555835961e9a3********</RefreshToken>\\n<RequestId>488F3004-4105-4F28-A634-26353BBF866C</RequestId>\\n<AccessToken>0301d19407084bd0b9449d6ecc********</AccessToken>\\n<RefreshTokenExpiredTime>2020-12-26T09:14:42.986876757Z</RefreshTokenExpiredTime>\\n<AccessTokenExpiredTime>2020-12-25T09:44:42.986876757Z</AccessTokenExpiredTime>","errorExample":""}]', + 'title' => 'RefreshWebofficeToken', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RefreshOfficePreviewToken' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immdoctest', + ], + ], + [ + 'name' => 'AccessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'f3a3ad0ae32a4c6fb90ed00218********', + ], + ], + [ + 'name' => 'RefreshToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1eb6535cdf8a4732a7d7183891********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RefreshToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => '780ec2952b4c4173a4a2840bb2********', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9F9FB128-7588-4F5F-BAAB-85859D3912D3', + ], + 'AccessToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => '35108c3afca14570b98e352efa********', + ], + 'RefreshTokenExpiredTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-20T06:43:37.51Z', + ], + 'AccessTokenExpiredTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-19T07:13:37.51Z', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RefreshToken\\": \\"780ec2952b4c4173a4a2840bb2********\\",\\n \\"RequestId\\": \\"9F9FB128-7588-4F5F-BAAB-85859D3912D3\\",\\n \\"AccessToken\\": \\"35108c3afca14570b98e352efa********\\",\\n \\"RefreshTokenExpiredTime\\": \\"2020-11-20T06:43:37.51Z\\",\\n \\"AccessTokenExpiredTime\\": \\"2020-11-19T07:13:37.51Z\\"\\n}","errorExample":""},{"type":"xml","example":"<RefreshToken>780ec2952b4c4173a4a2840bb2********</RefreshToken>\\n<RequestId>9F9FB128-7588-4F5F-BAAB-85859D3912D3</RequestId>\\n<AccessToken>35108c3afca14570b98e352efa********</AccessToken>\\n<RefreshTokenExpiredTime>2020-11-20T06:43:37.51Z</RefreshTokenExpiredTime>\\n<AccessTokenExpiredTime>2020-11-19T07:13:37.51Z</AccessTokenExpiredTime>","errorExample":""}]', + 'title' => 'RefreshOfficePreviewToken', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetWebofficeURL' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immdoctest', + ], + ], + [ + 'name' => 'SrcType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'doc', + ], + ], + [ + 'name' => 'FileID', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mytest', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + ], + [ + 'name' => 'Permission', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{"Rename": true, "Readonly": false, "History": true}', + ], + ], + [ + 'name' => 'File', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"Modifier": {"Avatar": "http://example.com/?id=user1", "ID": "user1", "Name": "test-user1"}, "Name": "mytest.doc", "Creator": {"Avatar": "http://example.com/?id=user1", "ID": "user1", "Name": "test-user1"}, "SrcUri": "oss://test-bucket/mytest.doc", "Version": 3, "TgtUri": "oss://test-bucket/mytest.doc"}]', + ], + ], + [ + 'name' => 'NotifyEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'http://1111111111.mns.cn-hangzhou-internal.aliyuncs.com', + ], + ], + [ + 'name' => 'NotifyTopicName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'topic1', + ], + ], + [ + 'name' => 'Watermark', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"Rotate": -0.7853982, "Vertical": 100, "Value": "hatlonely", "FillStyle": "rgba(192, 192, 192, 0.6)", "Horizontal": 50, "Font": "bold 20px Serif", "Type": 1}', + ], + ], + [ + 'name' => 'Hidecmb', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RefreshToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => '4cdfb7fac3564268aff15360ac********', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6', + ], + 'AccessToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => '96c77f96d4c2487aba86549222********', + ], + 'RefreshTokenExpiredTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-12-26T07:13:38.322018529Z', + ], + 'WebofficeURL' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://office-cn-hangzhou.imm.aliyuncs.com/office/w/7c7bb3419a0918203026217468a8e9fe375723ae?_w_tokentype=1', + ], + 'AccessTokenExpiredTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-12-25T07:43:38.322018529Z', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RefreshToken\\": \\"4cdfb7fac3564268aff15360ac********\\",\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6\\",\\n \\"AccessToken\\": \\"96c77f96d4c2487aba86549222********\\",\\n \\"RefreshTokenExpiredTime\\": \\"2020-12-26T07:13:38.322018529Z\\",\\n \\"WebofficeURL\\": \\"https://office-cn-hangzhou.imm.aliyuncs.com/office/w/7c7bb3419a0918203026217468a8e9fe375723ae?_w_tokentype=1\\",\\n \\"AccessTokenExpiredTime\\": \\"2020-12-25T07:43:38.322018529Z\\"\\n}","errorExample":""},{"type":"xml","example":"<RefreshToken>4cdfb7fac3564268aff15360ac********</RefreshToken>\\n<RequestId>CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6</RequestId>\\n<AccessToken>96c77f96d4c2487aba86549222********</AccessToken>\\n<RefreshTokenExpiredTime>2020-12-26T07:13:38.322018529Z</RefreshTokenExpiredTime>\\n<WebofficeURL>https://office-cn-hangzhou.imm.aliyuncs.com/office/w/7c7bb3419a0918203026217468a8e9fe375723ae?_w_tokentype=1</WebofficeURL>\\n<AccessTokenExpiredTime>2020-12-25T07:43:38.322018529Z</AccessTokenExpiredTime>","errorExample":""}]', + 'title' => 'GetWebofficeURL', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetOfficePreviewURL' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => 'immdoctest', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'SrcUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => 'oss://test-bucket/mytest.doc', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'SrcType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'doc', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'WatermarkType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '1', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + ], + ], + [ + 'name' => 'WatermarkValue', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'imm', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'WatermarkFillStyle', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'rgba(192, 192, 192, 0.6)', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'WatermarkFont', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'bold 20px Serif', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'WatermarkRotate', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '-0.7853982', + 'format' => 'float', + 'required' => false, + 'type' => 'number', + ], + ], + [ + 'name' => 'WatermarkHorizontal', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '50', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + ], + ], + [ + 'name' => 'WatermarkVertical', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '100', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'PreviewURL' => [ + 'description' => '', + 'example' => 'https://office-cn-hangzhou.imm.aliyuncs.com/office/f/59db14bc9e97205734b31f9880622e043175ea4f?hidecmb=1&simple=1&_w_tokentype=1', + 'type' => 'string', + ], + 'RefreshToken' => [ + 'description' => '', + 'example' => '1eb6535cdf8a4732a7d7183891********', + 'type' => 'string', + ], + 'RequestId' => [ + 'description' => '', + 'example' => '14580EF3-442A-4AA2-959C-1464DC255EEB', + 'type' => 'string', + ], + 'AccessToken' => [ + 'description' => '', + 'example' => 'f3a3ad0ae32a4c6fb90ed00218********', + 'type' => 'string', + ], + 'RefreshTokenExpiredTime' => [ + 'description' => '', + 'example' => '2020-11-20T06:16:19.069Z', + 'type' => 'string', + ], + 'AccessTokenExpiredTime' => [ + 'description' => '', + 'example' => '2020-11-19T06:46:19.069Z', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PreviewURL\\": \\"https://office-cn-hangzhou.imm.aliyuncs.com/office/f/59db14bc9e97205734b31f9880622e043175ea4f?hidecmb=1&simple=1&_w_tokentype=1\\",\\n \\"RefreshToken\\": \\"1eb6535cdf8a4732a7d7183891********\\",\\n \\"RequestId\\": \\"14580EF3-442A-4AA2-959C-1464DC255EEB\\",\\n \\"AccessToken\\": \\"f3a3ad0ae32a4c6fb90ed00218********\\",\\n \\"RefreshTokenExpiredTime\\": \\"2020-11-20T06:16:19.069Z\\",\\n \\"AccessTokenExpiredTime\\": \\"2020-11-19T06:46:19.069Z\\"\\n}","errorExample":""},{"type":"xml","example":"<PreviewURL>https://office-cn-hangzhou.imm.aliyuncs.com/office/f/59db14bc9e97205734b31f9880622e043175ea4f?hidecmb=1&simple=1&_w_tokentype=1</PreviewURL>\\n<RefreshToken>1eb6535cdf8a4732a7d7183891********</RefreshToken>\\n<RequestId>14580EF3-442A-4AA2-959C-1464DC255EEB</RequestId>\\n<AccessToken>f3a3ad0ae32a4c6fb90ed00218********</AccessToken>\\n<RefreshTokenExpiredTime>2020-11-20T06:16:19.069Z</RefreshTokenExpiredTime>\\n<AccessTokenExpiredTime>2020-11-19T06:46:19.069Z</AccessTokenExpiredTime>","errorExample":""}]', + 'extraInfo' => ' ', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'GetImage' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'set001', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ImageQuality' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'OverallScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7759467363357544', + ], + 'Color' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ColorScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ContrastScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'Contrast' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ExposureScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ClarityScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'Clarity' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'Exposure' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'CompositionScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + ], + ], + 'ModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-24T10:56:52.461Z', + ], + 'Address' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Township' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'District' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'AddressLine' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Country' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'City' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Province' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + 'SourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'image', + ], + 'SourceUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + 'FacesFailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'CroppingSuggestionStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NotProcessed', + ], + 'CroppingSuggestionFailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'AddressFailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'RemarksA' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'remarka', + ], + 'AddressModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-24T10:56:52.461Z', + ], + 'RemarksB' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'remarkb', + ], + 'ImageFormat' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'jpg', + ], + 'TagsFailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'RemarksArrayB' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["remarkb1","remarkb2"]', + ], + 'FacesModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-24T10:56:52.461Z', + ], + 'Exif' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{"FileSize":{"value":"29304"},"Format":{"value":"jpg"},"ImageHeight":{"value":"417"},"ImageWidth":{"value":"500"},"ResolutionUnit":{"value":"2"},"XResolution":{"value":"96/1"},"YResolution":{"value":"96/1"}}', + ], + 'RemarksC' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'remarkc', + ], + 'RemarksD' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'remarkd', + ], + 'ImageWidth' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'RemarksArrayA' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["remarka1","remarka2"]', + ], + 'SourcePosition' => [ + 'description' => '', + 'type' => 'string', + 'example' => '00000000.010', + ], + 'Tags' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'TagConfidence' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9812195897102356', + ], + 'CentricScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'TagLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ParentTagName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'Faces' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Gender' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MALE', + ], + 'GenderConfidence' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'FaceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51', + ], + 'FaceAttributes' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'GlassesConfidence' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Glasses' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NONE', + ], + 'Mask' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NONE', + ], + 'BeardConfidence' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'MaskConfidence' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'FaceBoundary' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '191', + ], + 'Width' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '269', + ], + 'Height' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '252', + ], + 'Left' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '95', + ], + ], + ], + 'HeadPose' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Pitch' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '18.385589599609375', + ], + 'Roll' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '4.204030513763428', + ], + 'Yaw' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '2.4945924282073975', + ], + ], + ], + 'Beard' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NONE', + ], + ], + ], + 'FaceQuality' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9321779608726501', + ], + 'Emotion' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'HAPPY', + ], + 'Age' => [ + 'description' => '', + 'type' => 'string', + 'example' => '29', + ], + 'FaceConfidence' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9608758687973022', + ], + 'EmotionConfidence' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7079545259475708', + ], + 'Attractive' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.96', + ], + 'GroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'group-not-grouped', + ], + 'EmotionDetails' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'HAPPY' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7079545259475708', + ], + 'CALM' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.2918718755245209', + ], + 'SURPRISED' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.00006676767952740192', + ], + 'DISGUSTED' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.000033771051676012576', + ], + 'ANGRY' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.00001282201901631197', + ], + 'SAD' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.00001527295717096422', + ], + 'SCARED' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0000014976058082538657', + ], + ], + ], + ], + ], + ], + 'AddressStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'FacesStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'ImageQualityModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-24T10:56:52.461Z', + ], + 'CroppingSuggestion' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Score' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8979608535766602', + ], + 'CroppingBoundary' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Width' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Height' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'Left' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'AspectRatio' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2:3', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D349D345-4744-472C-ABDC-7A29A5E04042', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-24T9:56:52.461Z', + ], + 'ExternalId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'externalId001', + ], + 'TagsModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-24T10:56:52.461Z', + ], + 'ImageQualityFailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'Orientation' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{"val":"Right-top","type":3}', + ], + 'ImageUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + 'OCRStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NotProcessed', + ], + 'OCRModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-24T10:56:52.461Z', + ], + 'ImageTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-24T10:56:52.461Z', + ], + 'CroppingSuggestionModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-24T10:56:52.461Z', + ], + 'ImageHeight' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '861', + ], + 'ImageQualityStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'TagsStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'OCRFailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'SetId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'set001', + ], + 'FileSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '69732', + ], + 'Location' => [ + 'description' => '', + 'type' => 'string', + 'example' => '30.134390,120.074997', + ], + 'OCR' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OCRConfidence' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8254936695098877', + ], + 'OCRContents' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'OCRBoundary' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Width' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Height' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Left' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ImageQuality\\": {\\n \\"OverallScore\\": 0.7759467363357544,\\n \\"Color\\": 0.6101377010345459,\\n \\"ColorScore\\": 0.6101377010345459,\\n \\"ContrastScore\\": 0.6101377010345459,\\n \\"Contrast\\": 0.6101377010345459,\\n \\"ExposureScore\\": 0.6101377010345459,\\n \\"ClarityScore\\": 0.6101377010345459,\\n \\"Clarity\\": 0.6101377010345459,\\n \\"Exposure\\": 0.6101377010345459,\\n \\"CompositionScore\\": 0.6101377010345459\\n },\\n \\"ModifyTime\\": \\"2020-11-24T10:56:52.461Z\\",\\n \\"Address\\": {\\n \\"Township\\": \\"转塘街道\\",\\n \\"District\\": \\"西湖区\\",\\n \\"AddressLine\\": \\"中国浙江省杭州市西湖区转塘街道石龙山西路\\",\\n \\"Country\\": \\"中国\\",\\n \\"City\\": \\"杭州市\\",\\n \\"Province\\": \\"浙江省\\"\\n },\\n \\"SourceType\\": \\"image\\",\\n \\"SourceUri\\": \\"oss://imm-test/testcases/face1.jpg\\",\\n \\"FacesFailReason\\": \\"Timeout\\",\\n \\"CroppingSuggestionStatus\\": \\"NotProcessed\\",\\n \\"CroppingSuggestionFailReason\\": \\"Timeout\\",\\n \\"AddressFailReason\\": \\"Timeout\\",\\n \\"RemarksA\\": \\"remarka\\",\\n \\"AddressModifyTime\\": \\"2020-11-24T10:56:52.461Z\\",\\n \\"RemarksB\\": \\"remarkb\\",\\n \\"ImageFormat\\": \\"jpg\\",\\n \\"TagsFailReason\\": \\"Timeout\\",\\n \\"RemarksArrayB\\": \\"[\\\\\\"remarkb1\\\\\\",\\\\\\"remarkb2\\\\\\"]\\",\\n \\"FacesModifyTime\\": \\"2020-11-24T10:56:52.461Z\\",\\n \\"Exif\\": \\"{\\\\\\"FileSize\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"29304\\\\\\"},\\\\\\"Format\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"jpg\\\\\\"},\\\\\\"ImageHeight\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"417\\\\\\"},\\\\\\"ImageWidth\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"500\\\\\\"},\\\\\\"ResolutionUnit\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2\\\\\\"},\\\\\\"XResolution\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"96/1\\\\\\"},\\\\\\"YResolution\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"96/1\\\\\\"}}\\",\\n \\"RemarksC\\": \\"remarkc\\",\\n \\"RemarksD\\": \\"remarkd\\",\\n \\"ImageWidth\\": 500,\\n \\"RemarksArrayA\\": \\"[\\\\\\"remarka1\\\\\\",\\\\\\"remarka2\\\\\\"]\\",\\n \\"SourcePosition\\": \\"00000000.010\\",\\n \\"Tags\\": [\\n {\\n \\"TagName\\": \\"脸\\",\\n \\"TagConfidence\\": 0.9812195897102356,\\n \\"CentricScore\\": 0,\\n \\"TagLevel\\": 2,\\n \\"ParentTagName\\": \\"人物\\"\\n }\\n ],\\n \\"Faces\\": [\\n {\\n \\"Gender\\": \\"MALE\\",\\n \\"GenderConfidence\\": 1,\\n \\"FaceId\\": \\"59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51\\",\\n \\"FaceAttributes\\": {\\n \\"GlassesConfidence\\": 1,\\n \\"Glasses\\": \\"NONE\\",\\n \\"Mask\\": \\"NONE\\",\\n \\"BeardConfidence\\": 1,\\n \\"MaskConfidence\\": 1,\\n \\"FaceBoundary\\": {\\n \\"Top\\": 191,\\n \\"Width\\": 269,\\n \\"Height\\": 252,\\n \\"Left\\": 95\\n },\\n \\"HeadPose\\": {\\n \\"Pitch\\": 18.385589599609375,\\n \\"Roll\\": 4.204030513763428,\\n \\"Yaw\\": 2.4945924282073975\\n },\\n \\"Beard\\": \\"NONE\\"\\n },\\n \\"FaceQuality\\": 0.9321779608726501,\\n \\"Emotion\\": \\"HAPPY\\",\\n \\"Age\\": \\"29\\",\\n \\"FaceConfidence\\": 0.9608758687973022,\\n \\"EmotionConfidence\\": 0.7079545259475708,\\n \\"Attractive\\": 0.96,\\n \\"GroupId\\": \\"group-not-grouped\\",\\n \\"EmotionDetails\\": {\\n \\"HAPPY\\": 0.7079545259475708,\\n \\"CALM\\": 0.2918718755245209,\\n \\"SURPRISED\\": 0.00006676767952740192,\\n \\"DISGUSTED\\": 0.000033771051676012576,\\n \\"ANGRY\\": 0.00001282201901631197,\\n \\"SAD\\": 0.00001527295717096422,\\n \\"SCARED\\": 0.0000014976058082538657\\n }\\n }\\n ],\\n \\"AddressStatus\\": \\"Success\\",\\n \\"FacesStatus\\": \\"Success\\",\\n \\"ImageQualityModifyTime\\": \\"2020-11-24T10:56:52.461Z\\",\\n \\"CroppingSuggestion\\": [\\n {\\n \\"Score\\": 0.8979608535766602,\\n \\"CroppingBoundary\\": {\\n \\"Top\\": 30,\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10\\n },\\n \\"AspectRatio\\": \\"2:3\\"\\n }\\n ],\\n \\"RequestId\\": \\"D349D345-4744-472C-ABDC-7A29A5E04042\\",\\n \\"CreateTime\\": \\"2020-11-24T9:56:52.461Z\\",\\n \\"ExternalId\\": \\"externalId001\\",\\n \\"TagsModifyTime\\": \\"2020-11-24T10:56:52.461Z\\",\\n \\"ImageQualityFailReason\\": \\"Timeout\\",\\n \\"Orientation\\": \\"{\\\\\\"val\\\\\\":\\\\\\"Right-top\\\\\\",\\\\\\"type\\\\\\":3}\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/face1.jpg\\",\\n \\"OCRStatus\\": \\"NotProcessed\\",\\n \\"OCRModifyTime\\": \\"2020-11-24T10:56:52.461Z\\",\\n \\"ImageTime\\": \\"2020-11-24T10:56:52.461Z\\",\\n \\"CroppingSuggestionModifyTime\\": \\"2020-11-24T10:56:52.461Z\\",\\n \\"ImageHeight\\": 861,\\n \\"ImageQualityStatus\\": \\"Success\\",\\n \\"TagsStatus\\": \\"Success\\",\\n \\"OCRFailReason\\": \\"Timeout\\",\\n \\"SetId\\": \\"set001\\",\\n \\"FileSize\\": 69732,\\n \\"Location\\": \\"30.134390,120.074997\\",\\n \\"OCR\\": [\\n {\\n \\"OCRConfidence\\": 0.8254936695098877,\\n \\"OCRContents\\": \\"欢迎使用智能媒体管理\\",\\n \\"OCRBoundary\\": {\\n \\"Top\\": 12,\\n \\"Width\\": 12,\\n \\"Height\\": 12,\\n \\"Left\\": 12\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ImageQuality>\\n <OverallScore>0.7759467363357544</OverallScore>\\n</ImageQuality>\\n<Address>\\n <Township>转塘街道</Township>\\n <AddressLine>浙江省杭州市西湖区转塘街道石龙山西路</AddressLine>\\n <Country>中国</Country>\\n <City>杭州市</City>\\n <District>西湖区</District>\\n <Province>浙江省</Province>\\n</Address>\\n<SourceUri>oss://imm-test/testcases/face1.jpg</SourceUri>\\n<SourceType>image</SourceType>\\n<CroppingSuggestionFailReason/>\\n<FacesFailReason/>\\n<AddressFailReason/>\\n<ImageFormat>jpg</ImageFormat>\\n<RemarksArrayB>[\\"remarkb1\\",\\"remarkb2\\"]</RemarksArrayB>\\n<Exif>{\\"FileSize\\":{\\"value\\":\\"29304\\"},\\"Format\\":{\\"value\\":\\"jpg\\"},\\"ImageHeight\\":{\\"value\\":\\"417\\"},\\"ImageWidth\\":{\\"value\\":\\"500\\"},\\"ResolutionUnit\\":{\\"value\\":\\"2\\"},\\"XResolution\\":{\\"value\\":\\"96/1\\"},\\"YResolution\\":{\\"value\\":\\"96/1\\"}}</Exif>\\n<ImageWidth>500</ImageWidth>\\n<RemarksArrayA>[\\"remarka1\\",\\"remarka2\\"]</RemarksArrayA>\\n<Faces>\\n <FaceConfidence>0.9608758687973022</FaceConfidence>\\n <FaceId>59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51</FaceId>\\n <FaceQuality>0.9321779608726501</FaceQuality>\\n <Attractive>0.96</Attractive>\\n <GenderConfidence>1</GenderConfidence>\\n <EmotionConfidence>0.7079545259475708</EmotionConfidence>\\n <Emotion>HAPPY</Emotion>\\n <Gender>FEMALE</Gender>\\n <Age>29</Age>\\n <GroupId>group-not-grouped</GroupId>\\n</Faces>\\n<Faces>\\n <EmotionDetails>\\n <CALM>0.2918718755245209</CALM>\\n <SCARED>0.0000014976058082538657</SCARED>\\n <HAPPY>0.7079545259475708</HAPPY>\\n <SURPRISED>0.00006676767952740192</SURPRISED>\\n <SAD>0.00001527295717096422</SAD>\\n <DISGUSTED>0.000033771051676012576</DISGUSTED>\\n <ANGRY>0.00001282201901631197</ANGRY>\\n </EmotionDetails>\\n <FaceAttributes>\\n <Beard>NONE</Beard>\\n <FaceBoundary>\\n <Left>95</Left>\\n <Top>191</Top>\\n <Height>252</Height>\\n <Width>269</Width>\\n </FaceBoundary>\\n <BeardConfidence>1</BeardConfidence>\\n <HeadPose>\\n <Pitch>18.385589599609375</Pitch>\\n <Roll>4.204030513763428</Roll>\\n <Yaw>2.4945924282073975</Yaw>\\n </HeadPose>\\n <MaskConfidence>1</MaskConfidence>\\n <Mask>NONE</Mask>\\n <Glasses>NONE</Glasses>\\n <GlassesConfidence>1</GlassesConfidence>\\n </FaceAttributes>\\n</Faces>\\n<Tags>\\n <TagName>脸</TagName>\\n <TagConfidence>0.9812195897102356</TagConfidence>\\n <TagLevel>2</TagLevel>\\n <ParentTagName>人物</ParentTagName>\\n</Tags>\\n<Tags>\\n <TagName>人物</TagName>\\n <TagConfidence>0.9812195897102356</TagConfidence>\\n <TagLevel>1</TagLevel>\\n</Tags>\\n<Tags>\\n <TagName>微笑</TagName>\\n <TagConfidence>0.7626392841339111</TagConfidence>\\n <TagLevel>3</TagLevel>\\n <ParentTagName>日常行为</ParentTagName>\\n</Tags>\\n<Tags>\\n <TagName>日常行为</TagName>\\n <TagConfidence>0.7626392841339111</TagConfidence>\\n <TagLevel>2</TagLevel>\\n <ParentTagName>生活</ParentTagName>\\n</Tags>\\n<Tags>\\n <TagName>生活</TagName>\\n <TagConfidence>0.7626392841339111</TagConfidence>\\n <TagLevel>1</TagLevel>\\n</Tags>\\n<AddressStatus>Success</AddressStatus>\\n<ImageQualityModifyTime>2020-11-24T10:56:52.461Z</ImageQualityModifyTime>\\n<RequestId>D349D345-4744-472C-ABDC-7A29A5E04042</RequestId>\\n<ImageQualityFailReason/>\\n<ImageUri>oss://imm-test/testcases/face1.jpg</ImageUri>\\n<ImageQualityStatus>Success</ImageQualityStatus>\\n<TagsStatus>Success</TagsStatus>\\n<ImageHeight>861</ImageHeight>\\n<SetId>set001</SetId>\\n<FileSize>69732</FileSize>\\n<ModifyTime>2020-11-24T10:56:52.461Z</ModifyTime>\\n<CroppingSuggestionStatus>NotProcessed</CroppingSuggestionStatus>\\n<RemarksA>remarka</RemarksA>\\n<AddressModifyTime>2020-11-24T10:56:52.461Z</AddressModifyTime>\\n<RemarksB>remarkb</RemarksB>\\n<TagsFailReason/>\\n<FacesModifyTime>2020-11-24T10:56:52.461Z</FacesModifyTime>\\n<RemarksC>remarkc</RemarksC>\\n<RemarksD>remarkd</RemarksD>\\n<FacesStatus>Success</FacesStatus>\\n<ExternalId>externalId001</ExternalId>\\n<TagsModifyTime>2020-11-24T10:56:52.461Z</TagsModifyTime>\\n<CreateTime>2020-11-24T10:56:52.461Z</CreateTime>\\n<OCRStatus>NotProcessed</OCRStatus>\\n<Location>30.134390,120.074997</Location>","errorExample":""}]', + 'title' => 'GetImage', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteImage' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'set001', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '81A8F375-51D7-4523-852D-A940E37E62D0', + ], + 'SetId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'set001', + ], + 'ImageUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"81A8F375-51D7-4523-852D-A940E37E62D0\\",\\n \\"SetId\\": \\"set001\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/face1.jpg\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>81A8F375-51D7-4523-852D-A940E37E62D0</RequestId>\\n<ImageUri>oss://imm-test/testcases/face1.jpg</ImageUri>\\n<SetId>set001</SetId>","errorExample":""}]', + 'title' => 'DeleteImage ', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'FindImages' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => 'immimagetest', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => 'set001', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'ImageSizeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => '{"MinWidth":100,"MaxWidth":3000,"MinHeight":50,"MaxHeight":5000}', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'ImageTimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '{"Start":"2020-11-10T00:00:01.544Z","End":"2020-11-25T00:00:01.544Z"}', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'CreateTimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '{"Start":"2020-11-10T00:00:01.544Z","End":"2020-11-25T00:00:01.544Z"}', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'ModifyTimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '{"Start":"2020-11-10T00:00:01.544Z","End":"2020-11-25T00:00:01.544Z"}', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'image', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'SourceUriPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'oss://imm-test/', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'RemarksAPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'remark', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'RemarksBPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'remark', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'TagNames', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'OCRContentsMatch', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'myh', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'AgeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '{"Start":0,"End":99}', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'Gender', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'MALE', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'Emotion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'HAPPY', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'CreateTime', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'ASC', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'Marker', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'imm', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'LocationBoundary', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '{"TopLeft":"50.2,100.1","BottomRight":"30.5,120.1"}', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'RemarksCPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'remark', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'RemarksDPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'remark', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'ExternalId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => false, + 'example' => 'externalId001', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'group-not-grouped', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '20', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + ], + ], + [ + 'name' => 'FacesModifyTimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '{"Start":"2020-11-10T00:00:01.544Z","End":"2020-11-25T00:00:01.544Z"}', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'TagsModifyTimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '{"Start":"2020-11-10T00:00:01.544Z","End":"2020-11-25T00:00:01.544Z"}', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'AddressLineContentsMatch', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'zhejiang', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'RemarksArrayAIn', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '["remarka1","remarka2"]', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'RemarksArrayBIn', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '["remarkb1","remarkb2"]', + 'required' => false, + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'example' => '810FE908-522F-4951-8AF8-7211890D4B2A', + 'type' => 'string', + ], + 'Images' => [ + 'description' => '', + 'items' => [ + 'properties' => [ + 'CroppingSuggestionStatus' => [ + 'description' => '', + 'example' => 'NotProcessed', + 'type' => 'string', + ], + 'ImageQualityModifyTime' => [ + 'description' => '', + 'example' => '2020-11-25T10:12:59.57Z', + 'type' => 'string', + ], + 'TagsFailReason' => [ + 'description' => '', + 'example' => 'Timeout', + 'type' => 'string', + ], + 'RemarksC' => [ + 'description' => '', + 'example' => 'remarkc', + 'type' => 'string', + ], + 'CreateTime' => [ + 'description' => '', + 'example' => '2020-11-25T10:12:59.57Z', + 'type' => 'string', + ], + 'SourceType' => [ + 'description' => '', + 'example' => 'image', + 'type' => 'string', + ], + 'FacesFailReason' => [ + 'description' => '', + 'example' => 'Timeout', + 'type' => 'string', + ], + 'Tags' => [ + 'description' => '', + 'items' => [ + 'properties' => [ + 'TagConfidence' => [ + 'description' => '', + 'example' => '0.9812195897102356', + 'format' => 'float', + 'type' => 'number', + ], + 'CentricScore' => [ + 'description' => '', + 'example' => '0', + 'format' => 'float', + 'type' => 'number', + ], + 'TagName' => [ + 'description' => '', + 'example' => '', + 'type' => 'string', + ], + 'TagLevel' => [ + 'description' => '', + 'example' => '2', + 'format' => 'int32', + 'type' => 'integer', + ], + 'ParentTagName' => [ + 'description' => '', + 'example' => '', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + 'type' => 'array', + ], + 'FacesModifyTime' => [ + 'description' => '', + 'example' => '2020-11-25T10:12:59.57Z', + 'type' => 'string', + ], + 'ImageTime' => [ + 'description' => '', + 'example' => '2020-11-25T10:12:59.57Z', + 'type' => 'string', + ], + 'OCRModifyTime' => [ + 'description' => '', + 'example' => '2020-11-25T10:12:59.57Z', + 'type' => 'string', + ], + 'AddressModifyTime' => [ + 'description' => '', + 'example' => '2020-11-25T10:12:59.57Z', + 'type' => 'string', + ], + 'OCR' => [ + 'description' => '', + 'items' => [ + 'properties' => [ + 'OCRConfidence' => [ + 'description' => '', + 'example' => '0.8254936695098877', + 'format' => 'float', + 'type' => 'number', + ], + 'OCRContents' => [ + 'description' => '', + 'example' => '', + 'type' => 'string', + ], + 'OCRBoundary' => [ + 'description' => '', + 'properties' => [ + 'Top' => [ + 'description' => '', + 'example' => '12', + 'format' => 'int32', + 'type' => 'integer', + ], + 'Width' => [ + 'description' => '', + 'example' => '12', + 'format' => 'int32', + 'type' => 'integer', + ], + 'Height' => [ + 'description' => '', + 'example' => '12', + 'format' => 'int32', + 'type' => 'integer', + ], + 'Left' => [ + 'description' => '', + 'example' => '12', + 'format' => 'int32', + 'type' => 'integer', + ], + ], + 'type' => 'object', + ], + ], + 'type' => 'object', + ], + 'type' => 'array', + ], + 'ImageQualityFailReason' => [ + 'description' => '', + 'example' => 'Timeout', + 'type' => 'string', + ], + 'FacesStatus' => [ + 'description' => '', + 'example' => 'Success', + 'type' => 'string', + ], + 'ImageHeight' => [ + 'description' => '', + 'example' => '861', + 'format' => 'int32', + 'type' => 'integer', + ], + 'RemarksArrayA' => [ + 'description' => '', + 'example' => '["remarka1","remarka2"]', + 'type' => 'string', + ], + 'Address' => [ + 'description' => '', + 'properties' => [ + 'Township' => [ + 'description' => '', + 'example' => '', + 'type' => 'string', + ], + 'District' => [ + 'description' => '', + 'example' => '', + 'type' => 'string', + ], + 'AddressLine' => [ + 'description' => '', + 'example' => '', + 'type' => 'string', + ], + 'Country' => [ + 'description' => '', + 'example' => '', + 'type' => 'string', + ], + 'City' => [ + 'description' => '', + 'example' => '', + 'type' => 'string', + ], + 'Province' => [ + 'description' => '', + 'example' => '', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + 'ExternalId' => [ + 'description' => '', + 'example' => 'externalId001', + 'type' => 'string', + ], + 'SourceUri' => [ + 'description' => '', + 'example' => 'oss://imm-test/testcases/face1.jpg', + 'type' => 'string', + ], + 'ModifyTime' => [ + 'description' => '', + 'example' => '2020-11-25T10:12:59.57Z', + 'type' => 'string', + ], + 'FileSize' => [ + 'description' => '', + 'example' => '69732', + 'format' => 'int32', + 'type' => 'integer', + ], + 'SourcePosition' => [ + 'description' => '', + 'example' => '00000000.010', + 'type' => 'string', + ], + 'Faces' => [ + 'description' => '', + 'items' => [ + 'properties' => [ + 'Gender' => [ + 'description' => '', + 'example' => 'FEMALE', + 'type' => 'string', + ], + 'FaceId' => [ + 'description' => '', + 'example' => '59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51', + 'type' => 'string', + ], + 'GenderConfidence' => [ + 'description' => '', + 'example' => '1', + 'format' => 'float', + 'type' => 'number', + ], + 'FaceAttributes' => [ + 'description' => '', + 'properties' => [ + 'GlassesConfidence' => [ + 'description' => '', + 'example' => '1', + 'format' => 'float', + 'type' => 'number', + ], + 'Glasses' => [ + 'description' => '', + 'example' => 'NONE', + 'type' => 'string', + ], + 'Mask' => [ + 'description' => '', + 'example' => 'NONE', + 'type' => 'string', + ], + 'BeardConfidence' => [ + 'description' => '', + 'example' => '1', + 'format' => 'float', + 'type' => 'number', + ], + 'MaskConfidence' => [ + 'description' => '', + 'example' => '1', + 'format' => 'float', + 'type' => 'number', + ], + 'FaceBoundary' => [ + 'description' => '', + 'properties' => [ + 'Top' => [ + 'description' => '', + 'example' => '152', + 'format' => 'int32', + 'type' => 'integer', + ], + 'Width' => [ + 'description' => '', + 'example' => '139', + 'format' => 'int32', + 'type' => 'integer', + ], + 'Height' => [ + 'description' => '', + 'example' => '141', + 'format' => 'int32', + 'type' => 'integer', + ], + 'Left' => [ + 'description' => '', + 'example' => '267', + 'format' => 'int32', + 'type' => 'integer', + ], + ], + 'type' => 'object', + ], + 'HeadPose' => [ + 'description' => '', + 'properties' => [ + 'Pitch' => [ + 'description' => '', + 'example' => '18.385589599609375', + 'format' => 'float', + 'type' => 'number', + ], + 'Roll' => [ + 'description' => '', + 'example' => '4.204030513763428', + 'format' => 'float', + 'type' => 'number', + ], + 'Yaw' => [ + 'description' => '', + 'example' => '2.4945924282073975', + 'format' => 'float', + 'type' => 'number', + ], + ], + 'type' => 'object', + ], + 'Beard' => [ + 'description' => '', + 'example' => 'NONE', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + 'FaceQuality' => [ + 'description' => '', + 'example' => '0.9321779608726501', + 'format' => 'float', + 'type' => 'number', + ], + 'Emotion' => [ + 'description' => '', + 'example' => 'HAPPY', + 'type' => 'string', + ], + 'Age' => [ + 'description' => '', + 'example' => '29', + 'format' => 'int32', + 'type' => 'integer', + ], + 'FaceConfidence' => [ + 'description' => '', + 'example' => '0.9608758687973022', + 'format' => 'float', + 'type' => 'number', + ], + 'EmotionConfidence' => [ + 'description' => '', + 'example' => '0.7079545259475708', + 'format' => 'float', + 'type' => 'number', + ], + 'Attractive' => [ + 'description' => '', + 'example' => '0.96', + 'format' => 'float', + 'type' => 'number', + ], + 'GroupId' => [ + 'description' => '', + 'example' => 'group-not-grouped', + 'type' => 'string', + ], + 'EmotionDetails' => [ + 'description' => '', + 'properties' => [ + 'HAPPY' => [ + 'description' => '', + 'example' => '0.7079545259475708', + 'format' => 'float', + 'type' => 'number', + ], + 'SURPRISED' => [ + 'description' => '', + 'example' => '0.00006676767952740192', + 'format' => 'float', + 'type' => 'number', + ], + 'CALM' => [ + 'description' => '', + 'example' => '0.2918718755245209', + 'format' => 'float', + 'type' => 'number', + ], + 'DISGUSTED' => [ + 'description' => '', + 'example' => '0.000033771051676012576', + 'format' => 'float', + 'type' => 'number', + ], + 'ANGRY' => [ + 'description' => '', + 'example' => '0.00001282201901631197', + 'format' => 'float', + 'type' => 'number', + ], + 'SAD' => [ + 'description' => '', + 'example' => '0.00001527295717096422', + 'format' => 'float', + 'type' => 'number', + ], + 'SCARED' => [ + 'description' => '', + 'example' => '0.0000014976058082538657', + 'format' => 'float', + 'type' => 'number', + ], + ], + 'type' => 'object', + ], + ], + 'type' => 'object', + ], + 'type' => 'array', + ], + 'ImageQualityStatus' => [ + 'description' => '', + 'example' => 'Success', + 'type' => 'string', + ], + 'OCRFailReason' => [ + 'description' => '', + 'example' => 'Timeout', + 'type' => 'string', + ], + 'AddressFailReason' => [ + 'description' => '', + 'example' => 'Timeout', + 'type' => 'string', + ], + 'ImageQuality' => [ + 'description' => '', + 'properties' => [ + 'OverallScore' => [ + 'description' => '', + 'example' => '0.7759467363357544', + 'format' => 'float', + 'type' => 'number', + ], + 'Color' => [ + 'description' => '', + 'example' => '0.6101377010345459', + 'format' => 'float', + 'type' => 'number', + ], + 'ColorScore' => [ + 'description' => '', + 'example' => '0.6101377010345459', + 'format' => 'float', + 'type' => 'number', + ], + 'ContrastScore' => [ + 'description' => '', + 'example' => '0.6101377010345459', + 'format' => 'float', + 'type' => 'number', + ], + 'Contrast' => [ + 'description' => '', + 'example' => '0.6101377010345459', + 'format' => 'float', + 'type' => 'number', + ], + 'ExposureScore' => [ + 'description' => '', + 'example' => '0.6101377010345459', + 'format' => 'float', + 'type' => 'number', + ], + 'ClarityScore' => [ + 'description' => '', + 'example' => '0.6101377010345459', + 'format' => 'float', + 'type' => 'number', + ], + 'Clarity' => [ + 'description' => '', + 'example' => '0.6101377010345459', + 'format' => 'float', + 'type' => 'number', + ], + 'Exposure' => [ + 'description' => '', + 'example' => '0.6101377010345459', + 'format' => 'float', + 'type' => 'number', + ], + 'CompositionScore' => [ + 'description' => '', + 'example' => '0.6101377010345459', + 'format' => 'float', + 'type' => 'number', + ], + ], + 'type' => 'object', + ], + 'CroppingSuggestionModifyTime' => [ + 'description' => '', + 'example' => '2020-11-25T10:12:59.57Z', + 'type' => 'string', + ], + 'ImageFormat' => [ + 'description' => '', + 'example' => 'jpg', + 'type' => 'string', + ], + 'ImageWidth' => [ + 'description' => '', + 'example' => '500', + 'format' => 'int32', + 'type' => 'integer', + ], + 'RemarksArrayB' => [ + 'description' => '', + 'example' => '["remarkb1","remarkb2"]', + 'type' => 'string', + ], + 'CroppingSuggestion' => [ + 'description' => '', + 'items' => [ + 'properties' => [ + 'Score' => [ + 'description' => '', + 'example' => '0.8979608535766602', + 'format' => 'float', + 'type' => 'number', + ], + 'CroppingBoundary' => [ + 'description' => '', + 'properties' => [ + 'Top' => [ + 'description' => '', + 'example' => '77', + 'format' => 'int32', + 'type' => 'integer', + ], + 'Width' => [ + 'description' => '', + 'example' => '500', + 'format' => 'int32', + 'type' => 'integer', + ], + 'Height' => [ + 'description' => '', + 'example' => '499', + 'format' => 'int32', + 'type' => 'integer', + ], + 'Left' => [ + 'description' => '', + 'example' => '0', + 'format' => 'int32', + 'type' => 'integer', + ], + ], + 'type' => 'object', + ], + 'AspectRatio' => [ + 'description' => '', + 'example' => '1:1', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + 'type' => 'array', + ], + 'Orientation' => [ + 'description' => '', + 'example' => '{"val":"Right-top","type":3}', + 'type' => 'string', + ], + 'RemarksD' => [ + 'description' => '', + 'example' => 'remarkd', + 'type' => 'string', + ], + 'TagsStatus' => [ + 'description' => '', + 'example' => 'Success', + 'type' => 'string', + ], + 'CroppingSuggestionFailReason' => [ + 'description' => '', + 'example' => 'Timeout', + 'type' => 'string', + ], + 'RemarksA' => [ + 'description' => '', + 'example' => 'remarka', + 'type' => 'string', + ], + 'ImageUri' => [ + 'description' => '', + 'example' => 'oss://imm-test/testcases/face1.jpg', + 'type' => 'string', + ], + 'TagsModifyTime' => [ + 'description' => '', + 'example' => '2020-11-25T10:12:59.57Z', + 'type' => 'string', + ], + 'OCRStatus' => [ + 'description' => '', + 'example' => 'NotProcessed', + 'type' => 'string', + ], + 'AddressStatus' => [ + 'description' => '', + 'example' => 'Success', + 'type' => 'string', + ], + 'Exif' => [ + 'description' => '', + 'example' => '{"FileSize":{"value":"29304"},"Format":{"value":"jpg"},"ImageHeight":{"value":"417"},"ImageWidth":{"value":"500"},"ResolutionUnit":{"value":"2"},"XResolution":{"value":"96/1"},"YResolution":{"value":"96/1"}}', + 'type' => 'string', + ], + 'Location' => [ + 'description' => '', + 'example' => '30.134390,120.074997', + 'type' => 'string', + ], + 'RemarksB' => [ + 'description' => '', + 'example' => 'remarkb', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + 'type' => 'array', + ], + 'NextMarker' => [ + 'description' => '', + 'example' => 'CAESBgoEIgIIABgAIswBCskBA8QAAAAxUzMxMzczNDM2MzQzOTM1MzgzNTM3MzYzMDMyMzczNDM1M2E2OTZkNmQ2OTZkNjE2NzY1M2E3MzY1NzQzMDMwMzEzYTMxMzYzMzM1NjIzOTMzMzI2MTYyMzQzNzY2NjMzNjY2NjI2MTYxMzMzMjM1MzQzOTMzMzQzNzMwMzI2NTMxNjE2MjM3MzczMTY0NjM2NDM2MzgzNjM4NjQzMjM2MzEzNzM2MzYzNjM4NjUzNTYyMzc2NjM0MzU2MjYxNjE2NTMx', + 'type' => 'string', + ], + 'SetId' => [ + 'description' => '', + 'example' => 'set001', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"810FE908-522F-4951-8AF8-7211890D4B2A\\",\\n \\"Images\\": [\\n {\\n \\"CroppingSuggestionStatus\\": \\"NotProcessed\\",\\n \\"ImageQualityModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"TagsFailReason\\": \\"Timeout\\",\\n \\"RemarksC\\": \\"remarkc\\",\\n \\"CreateTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"SourceType\\": \\"image\\",\\n \\"FacesFailReason\\": \\"Timeout\\",\\n \\"Tags\\": [\\n {\\n \\"TagConfidence\\": 0.9812195897102356,\\n \\"CentricScore\\": 0,\\n \\"TagName\\": \\"脸\\",\\n \\"TagLevel\\": 2,\\n \\"ParentTagName\\": \\"人物\\"\\n }\\n ],\\n \\"FacesModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"ImageTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"OCRModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"AddressModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"OCR\\": [\\n {\\n \\"OCRConfidence\\": 0.8254936695098877,\\n \\"OCRContents\\": \\"欢迎使用智能媒体管理\\",\\n \\"OCRBoundary\\": {\\n \\"Top\\": 12,\\n \\"Width\\": 12,\\n \\"Height\\": 12,\\n \\"Left\\": 12\\n }\\n }\\n ],\\n \\"ImageQualityFailReason\\": \\"Timeout\\",\\n \\"FacesStatus\\": \\"Success\\",\\n \\"ImageHeight\\": 861,\\n \\"RemarksArrayA\\": \\"[\\\\\\"remarka1\\\\\\",\\\\\\"remarka2\\\\\\"]\\",\\n \\"Address\\": {\\n \\"Township\\": \\"转塘街道\\",\\n \\"District\\": \\"西湖区\\",\\n \\"AddressLine\\": \\"浙江省杭州市西湖区转塘街道石龙山西路\\",\\n \\"Country\\": \\"中国\\",\\n \\"City\\": \\"杭州市\\",\\n \\"Province\\": \\"浙江省\\"\\n },\\n \\"ExternalId\\": \\"externalId001\\",\\n \\"SourceUri\\": \\"oss://imm-test/testcases/face1.jpg\\",\\n \\"ModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"FileSize\\": 69732,\\n \\"SourcePosition\\": \\"00000000.010\\",\\n \\"Faces\\": [\\n {\\n \\"Gender\\": \\"FEMALE\\",\\n \\"FaceId\\": \\"59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51\\",\\n \\"GenderConfidence\\": 1,\\n \\"FaceAttributes\\": {\\n \\"GlassesConfidence\\": 1,\\n \\"Glasses\\": \\"NONE\\",\\n \\"Mask\\": \\"NONE\\",\\n \\"BeardConfidence\\": 1,\\n \\"MaskConfidence\\": 1,\\n \\"FaceBoundary\\": {\\n \\"Top\\": 152,\\n \\"Width\\": 139,\\n \\"Height\\": 141,\\n \\"Left\\": 267\\n },\\n \\"HeadPose\\": {\\n \\"Pitch\\": 18.385589599609375,\\n \\"Roll\\": 4.204030513763428,\\n \\"Yaw\\": 2.4945924282073975\\n },\\n \\"Beard\\": \\"NONE\\"\\n },\\n \\"FaceQuality\\": 0.9321779608726501,\\n \\"Emotion\\": \\"HAPPY\\",\\n \\"Age\\": 29,\\n \\"FaceConfidence\\": 0.9608758687973022,\\n \\"EmotionConfidence\\": 0.7079545259475708,\\n \\"Attractive\\": 0.96,\\n \\"GroupId\\": \\"group-not-grouped\\",\\n \\"EmotionDetails\\": {\\n \\"HAPPY\\": 0.7079545259475708,\\n \\"SURPRISED\\": 0.00006676767952740192,\\n \\"CALM\\": 0.2918718755245209,\\n \\"DISGUSTED\\": 0.000033771051676012576,\\n \\"ANGRY\\": 0.00001282201901631197,\\n \\"SAD\\": 0.00001527295717096422,\\n \\"SCARED\\": 0.0000014976058082538657\\n }\\n }\\n ],\\n \\"ImageQualityStatus\\": \\"Success\\",\\n \\"OCRFailReason\\": \\"Timeout\\",\\n \\"AddressFailReason\\": \\"Timeout\\",\\n \\"ImageQuality\\": {\\n \\"OverallScore\\": 0.7759467363357544,\\n \\"Color\\": 0.6101377010345459,\\n \\"ColorScore\\": 0.6101377010345459,\\n \\"ContrastScore\\": 0.6101377010345459,\\n \\"Contrast\\": 0.6101377010345459,\\n \\"ExposureScore\\": 0.6101377010345459,\\n \\"ClarityScore\\": 0.6101377010345459,\\n \\"Clarity\\": 0.6101377010345459,\\n \\"Exposure\\": 0.6101377010345459,\\n \\"CompositionScore\\": 0.6101377010345459\\n },\\n \\"CroppingSuggestionModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"ImageFormat\\": \\"jpg\\",\\n \\"ImageWidth\\": 500,\\n \\"RemarksArrayB\\": \\"[\\\\\\"remarkb1\\\\\\",\\\\\\"remarkb2\\\\\\"]\\",\\n \\"CroppingSuggestion\\": [\\n {\\n \\"Score\\": 0.8979608535766602,\\n \\"CroppingBoundary\\": {\\n \\"Top\\": 77,\\n \\"Width\\": 500,\\n \\"Height\\": 499,\\n \\"Left\\": 0\\n },\\n \\"AspectRatio\\": \\"1:1\\"\\n }\\n ],\\n \\"Orientation\\": \\"{\\\\\\"val\\\\\\":\\\\\\"Right-top\\\\\\",\\\\\\"type\\\\\\":3}\\",\\n \\"RemarksD\\": \\"remarkd\\",\\n \\"TagsStatus\\": \\"Success\\",\\n \\"CroppingSuggestionFailReason\\": \\"Timeout\\",\\n \\"RemarksA\\": \\"remarka\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/face1.jpg\\",\\n \\"TagsModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"OCRStatus\\": \\"NotProcessed\\",\\n \\"AddressStatus\\": \\"Success\\",\\n \\"Exif\\": \\"{\\\\\\"FileSize\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"29304\\\\\\"},\\\\\\"Format\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"jpg\\\\\\"},\\\\\\"ImageHeight\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"417\\\\\\"},\\\\\\"ImageWidth\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"500\\\\\\"},\\\\\\"ResolutionUnit\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2\\\\\\"},\\\\\\"XResolution\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"96/1\\\\\\"},\\\\\\"YResolution\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"96/1\\\\\\"}}\\",\\n \\"Location\\": \\"30.134390,120.074997\\",\\n \\"RemarksB\\": \\"remarkb\\"\\n }\\n ],\\n \\"NextMarker\\": \\"CAESBgoEIgIIABgAIswBCskBA8QAAAAxUzMxMzczNDM2MzQzOTM1MzgzNTM3MzYzMDMyMzczNDM1M2E2OTZkNmQ2OTZkNjE2NzY1M2E3MzY1NzQzMDMwMzEzYTMxMzYzMzM1NjIzOTMzMzI2MTYyMzQzNzY2NjMzNjY2NjI2MTYxMzMzMjM1MzQzOTMzMzQzNzMwMzI2NTMxNjE2MjM3MzczMTY0NjM2NDM2MzgzNjM4NjQzMjM2MzEzNzM2MzYzNjM4NjUzNTYyMzc2NjM0MzU2MjYxNjE2NTMx\\",\\n \\"SetId\\": \\"set001\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>810FE908-522F-4951-8AF8-7211890D4B2A</RequestId>\\n<Images>\\n <ModifyTime>2020-11-25T10:12:59.57Z</ModifyTime>\\n <SourceUri>oss://imm-test/testcases/face1.jpg</SourceUri>\\n <SourceType>image</SourceType>\\n <CroppingSuggestionStatus>NotProcessed</CroppingSuggestionStatus>\\n <AddressFailReason/>\\n <RemarksA>remarka</RemarksA>\\n <AddressModifyTime>2020-11-25T10:12:59.57Z</AddressModifyTime>\\n <RemarksB>remarkb</RemarksB>\\n <ImageFormat>jpg</ImageFormat>\\n <RemarksArrayB>[\\"remarkb1\\",\\"remarkb2\\"]</RemarksArrayB>\\n <TagsFailReason/>\\n <Exif>{\\"FileSize\\":{\\"value\\":\\"29304\\"},\\"Format\\":{\\"value\\":\\"jpg\\"},\\"ImageHeight\\":{\\"value\\":\\"417\\"},\\"ImageWidth\\":{\\"value\\":\\"500\\"},\\"ResolutionUnit\\":{\\"value\\":\\"2\\"},\\"XResolution\\":{\\"value\\":\\"96/1\\"},\\"YResolution\\":{\\"value\\":\\"96/1\\"}}</Exif>\\n <FacesModifyTime>2020-11-25T10:12:59.57Z</FacesModifyTime>\\n <RemarksC>remarkc</RemarksC>\\n <RemarksD>remarkd</RemarksD>\\n <ImageWidth>500</ImageWidth>\\n <RemarksArrayA>[\\"remarka1\\",\\"remarka2\\"]</RemarksArrayA>\\n <AddressStatus>Success</AddressStatus>\\n <FacesStatus>Success</FacesStatus>\\n <ImageQualityModifyTime>2020-11-25T10:12:59.57Z</ImageQualityModifyTime>\\n <ExternalId>externalId001</ExternalId>\\n <TagsModifyTime>2020-11-25T10:12:59.57Z</TagsModifyTime>\\n <CreateTime>2020-11-25T10:12:59.57Z</CreateTime>\\n <ImageQualityFailReason/>\\n <ImageUri>oss://imm-test/testcases/face1.jpg</ImageUri>\\n <OCRStatus>NotProcessed</OCRStatus>\\n <CroppingSuggestionModifyTime/>\\n <ImageQualityStatus>Success</ImageQualityStatus>\\n <TagsStatus>Success</TagsStatus>\\n <ImageHeight>861</ImageHeight>\\n <Location>30.134390,120.074997</Location>\\n <FileSize>69732</FileSize>\\n</Images>\\n<Images>\\n <Faces>\\n <FaceId>59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51</FaceId>\\n <FaceConfidence>0.9608758687973022</FaceConfidence>\\n <FaceQuality>0.9321779608726501</FaceQuality>\\n <Attractive>0.96</Attractive>\\n <GenderConfidence>1</GenderConfidence>\\n <EmotionConfidence>0.7079545259475708</EmotionConfidence>\\n <Emotion>HAPPY</Emotion>\\n <Gender>MALE</Gender>\\n <Age>29</Age>\\n <GroupId>group-not-grouped</GroupId>\\n </Faces>\\n <Faces>\\n <EmotionDetails>\\n <CALM>0.2918718755245209</CALM>\\n <SCARED>0.0000014976058082538657</SCARED>\\n <HAPPY>0.7079545259475708</HAPPY>\\n <SURPRISED>0.00006676767952740192</SURPRISED>\\n <SAD>0.00001527295717096422</SAD>\\n <DISGUSTED>0.000033771051676012576</DISGUSTED>\\n <ANGRY>0.00001282201901631197</ANGRY>\\n </EmotionDetails>\\n <FaceAttributes>\\n <Beard>NONE</Beard>\\n <FaceBoundary>\\n <Left>267</Left>\\n <Top>152</Top>\\n <Height>141</Height>\\n <Width>139</Width>\\n </FaceBoundary>\\n <BeardConfidence>1</BeardConfidence>\\n <HeadPose>\\n <Pitch>18.385589599609375</Pitch>\\n <Roll>4.204030513763428</Roll>\\n <Yaw>2.4945924282073975</Yaw>\\n </HeadPose>\\n <Mask>NONE</Mask>\\n <MaskConfidence>1</MaskConfidence>\\n <Glasses>NONE</Glasses>\\n <GlassesConfidence>1</GlassesConfidence>\\n </FaceAttributes>\\n </Faces>\\n <Tags>\\n <TagConfidence>0.7254936695098877</TagConfidence>\\n <TagName>脸</TagName>\\n <TagLevel>2</TagLevel>\\n <ParentTagName>人物</ParentTagName>\\n </Tags>\\n <Tags>\\n <TagConfidence>0.7254936695098877</TagConfidence>\\n <TagName>人物</TagName>\\n <TagLevel>1</TagLevel>\\n </Tags>\\n <Tags>\\n <TagConfidence>0.6851575970649719</TagConfidence>\\n <TagName>微笑</TagName>\\n <TagLevel>3</TagLevel>\\n <ParentTagName>日常行为</ParentTagName>\\n </Tags>\\n <Tags>\\n <TagConfidence>0.6851575970649719</TagConfidence>\\n <TagName>日常行为</TagName>\\n <TagLevel>2</TagLevel>\\n <ParentTagName>生活</ParentTagName>\\n </Tags>\\n <Tags>\\n <TagConfidence>0.6851575970649719</TagConfidence>\\n <TagName>生活</TagName>\\n <TagLevel>1</TagLevel>\\n </Tags>\\n</Images>\\n<Images>\\n <ImageQuality>\\n <OverallScore>0.7759467363357544</OverallScore>\\n </ImageQuality>\\n <Address>\\n <Township>转塘街道</Township>\\n <AddressLine>杭州市西湖区转塘街道石龙山西路</AddressLine>\\n <Country>中国</Country>\\n <City>杭州市</City>\\n <District>西湖区</District>\\n <Province>浙江省</Province>\\n </Address>\\n</Images>\\n<NextMarker>CAESBgoEIgIIABgAIswBCskBA8QAAAAxUzMxMzczNDM2MzQzOTM1MzgzNTM3MzYzMDMyMzczNDM1M2E2OTZkNmQ2OTZkNjE2NzY1M2E3MzY1NzQzMDMwMzEzYTMxMzYzMzM1NjIzOTMzMzI2MTYyMzQzNzY2NjMzNjY2NjI2MTYxMzMzMjM1MzQzOTMzMzQzNzMwMzI2NTMxNjE2MjM3MzczMTY0NjM2NDM2MzgzNjM4NjQzMjM2MzEzNzM2MzYzNjM4NjUzNTYyMzc2NjM0MzU2MjYxNjE2NTMx</NextMarker>\\n<SetId>set001</SetId>","errorExample":""}]', + 'extraInfo' => ' ', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'title' => 'FindImages', + ], + 'ListImages' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'set001', + ], + ], + [ + 'name' => 'CreateTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2020-11-23T07:49:01.975Z', + ], + ], + [ + 'name' => 'Marker', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'image', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A9C250B8-AC5B-4570-A7FE-73448DFCEFC8', + ], + 'Images' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CroppingSuggestionStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NotProcessed', + ], + 'ImageQualityModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'TagsFailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'RemarksC' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'remarkc', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'SourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'image', + ], + 'FacesFailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'Tags' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagConfidence' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9812195897102356', + ], + 'CentricScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'TagName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'TagLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ParentTagName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'FacesModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'ImageTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'OCRModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'AddressModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'OCR' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OCRConfidence' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8254936695098877', + ], + 'OCRContents' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'OCRBoundary' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Width' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Height' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Left' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + ], + ], + ], + ], + ], + 'ImageQualityFailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'FacesStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'ImageHeight' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '861', + ], + 'RemarksArrayA' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["remarka1","remarka2"]', + ], + 'Address' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Township' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'District' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'AddressLine' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Country' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'City' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Province' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + 'ExternalId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'externalId001', + ], + 'SourceUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + 'ModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'FileSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '69732', + ], + 'SourcePosition' => [ + 'description' => '', + 'type' => 'string', + 'example' => '00000000.010', + ], + 'Faces' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Gender' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MALE', + ], + 'FaceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51', + ], + 'GenderConfidence' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'FaceAttributes' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'GlassesConfidence' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Glasses' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NONE', + ], + 'Mask' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NONE', + ], + 'BeardConfidence' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'MaskConfidence' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'FaceBoundary' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '191', + ], + 'Width' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '269', + ], + 'Height' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '252', + ], + 'Left' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '95', + ], + ], + ], + 'HeadPose' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Pitch' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '18.385589599609375', + ], + 'Roll' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '4.204030513763428', + ], + 'Yaw' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '2.4945924282073975', + ], + ], + ], + 'Beard' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NONE', + ], + ], + ], + 'FaceQuality' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9321779608726501', + ], + 'Emotion' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'HAPPY', + ], + 'Age' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '29', + ], + 'FaceConfidence' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9608758687973022', + ], + 'EmotionConfidence' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7079545259475708', + ], + 'Attractive' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.96', + ], + 'GroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'group-not-grouped', + ], + 'EmotionDetails' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'HAPPY' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7079545259475708', + ], + 'SURPRISED' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.00006676767952740192', + ], + 'CALM' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.2918718755245209', + ], + 'DISGUSTED' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.000033771051676012576', + ], + 'ANGRY' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.00001282201901631197', + ], + 'SAD' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.00001527295717096422', + ], + 'SCARED' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0000014976058082538657', + ], + ], + ], + ], + ], + ], + 'ImageQualityStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'OCRFailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'AddressFailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'ImageQuality' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'OverallScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7759467363357544', + ], + 'Color' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ColorScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ContrastScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'Contrast' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ExposureScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ClarityScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'Clarity' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'Exposure' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'CompositionScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + ], + ], + 'CroppingSuggestionModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'ImageFormat' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'jpg', + ], + 'ImageWidth' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'RemarksArrayB' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["remarkb1","remarkb2"]', + ], + 'CroppingSuggestion' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Score' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8812195897102356', + ], + 'CroppingBoundary' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '70', + ], + 'Width' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Height' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Left' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'AspectRatio' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1:1', + ], + ], + ], + ], + 'Orientation' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{"val":"Right-top","type":3}', + ], + 'RemarksD' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'remarkd', + ], + 'TagsStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'CroppingSuggestionFailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'RemarksA' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'remarka', + ], + 'ImageUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + 'TagsModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'OCRStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NotProcessed', + ], + 'AddressStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Exif' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{"FileSize":{"value":"29304"},"Format":{"value":"jpg"},"ImageHeight":{"value":"417"},"ImageWidth":{"value":"500"},"ResolutionUnit":{"value":"2"},"XResolution":{"value":"96/1"},"YResolution":{"value":"96/1"}}', + ], + 'Location' => [ + 'description' => '', + 'type' => 'string', + 'example' => '30.134390,120.074997', + ], + 'RemarksB' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'remarkb', + ], + ], + ], + ], + 'NextMarker' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CAESEgoQCg4KCkNyZWF0ZVRpbWUQABgBItcBCgkAIUv1J88rSRYKyQEDxAAAADFTMzEzNzM0MzYzNDM5MzUzODM1MzczNjMwMzIzNzM0MzUzYTY5NmQ2ZDY5NmQ2MTY3NjUzYTczNjU3NDMwMzAzMTNhMzc2NTY1NjM2NTMyMzQzNjYyMzUzMjM3MzgzODMwMzA2MzM4NjE2NDM4NjQ2MzY2NjE2MTMxNjMzNDMxNjY2MTY0MzEzODM0NjMzOTMzNjQ2MTM2MzUzMjY2NjYzMjMzNjUzNzM1NjUzNzM3MzM2MTY0MzEzMTM2MzYzMTM4Mzk=', + ], + 'SetId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'set001', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A9C250B8-AC5B-4570-A7FE-73448DFCEFC8\\",\\n \\"Images\\": [\\n {\\n \\"CroppingSuggestionStatus\\": \\"NotProcessed\\",\\n \\"ImageQualityModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"TagsFailReason\\": \\"Timeout\\",\\n \\"RemarksC\\": \\"remarkc\\",\\n \\"CreateTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"SourceType\\": \\"image\\",\\n \\"FacesFailReason\\": \\"Timeout\\",\\n \\"Tags\\": [\\n {\\n \\"TagConfidence\\": 0.9812195897102356,\\n \\"CentricScore\\": 0,\\n \\"TagName\\": \\"脸\\",\\n \\"TagLevel\\": 1,\\n \\"ParentTagName\\": \\"人物\\"\\n }\\n ],\\n \\"FacesModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"ImageTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"OCRModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"AddressModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"OCR\\": [\\n {\\n \\"OCRConfidence\\": 0.8254936695098877,\\n \\"OCRContents\\": \\"欢迎使用智能媒体管理\\",\\n \\"OCRBoundary\\": {\\n \\"Top\\": 12,\\n \\"Width\\": 12,\\n \\"Height\\": 12,\\n \\"Left\\": 12\\n }\\n }\\n ],\\n \\"ImageQualityFailReason\\": \\"Timeout\\",\\n \\"FacesStatus\\": \\"Success\\",\\n \\"ImageHeight\\": 861,\\n \\"RemarksArrayA\\": \\"[\\\\\\"remarka1\\\\\\",\\\\\\"remarka2\\\\\\"]\\",\\n \\"Address\\": {\\n \\"Township\\": \\"转塘街道\\",\\n \\"District\\": \\"西湖区\\",\\n \\"AddressLine\\": \\"浙江省杭州市西湖区转塘街道石龙山西路\\",\\n \\"Country\\": \\"中国\\",\\n \\"City\\": \\"杭州市\\",\\n \\"Province\\": \\"浙江省\\"\\n },\\n \\"ExternalId\\": \\"externalId001\\",\\n \\"SourceUri\\": \\"oss://imm-test/testcases/face1.jpg\\",\\n \\"ModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"FileSize\\": 69732,\\n \\"SourcePosition\\": \\"00000000.010\\",\\n \\"Faces\\": [\\n {\\n \\"Gender\\": \\"MALE\\",\\n \\"FaceId\\": \\"59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51\\",\\n \\"GenderConfidence\\": 1,\\n \\"FaceAttributes\\": {\\n \\"GlassesConfidence\\": 1,\\n \\"Glasses\\": \\"NONE\\",\\n \\"Mask\\": \\"NONE\\",\\n \\"BeardConfidence\\": 1,\\n \\"MaskConfidence\\": 1,\\n \\"FaceBoundary\\": {\\n \\"Top\\": 191,\\n \\"Width\\": 269,\\n \\"Height\\": 252,\\n \\"Left\\": 95\\n },\\n \\"HeadPose\\": {\\n \\"Pitch\\": 18.385589599609375,\\n \\"Roll\\": 4.204030513763428,\\n \\"Yaw\\": 2.4945924282073975\\n },\\n \\"Beard\\": \\"NONE\\"\\n },\\n \\"FaceQuality\\": 0.9321779608726501,\\n \\"Emotion\\": \\"HAPPY\\",\\n \\"Age\\": 29,\\n \\"FaceConfidence\\": 0.9608758687973022,\\n \\"EmotionConfidence\\": 0.7079545259475708,\\n \\"Attractive\\": 0.96,\\n \\"GroupId\\": \\"group-not-grouped\\",\\n \\"EmotionDetails\\": {\\n \\"HAPPY\\": 0.7079545259475708,\\n \\"SURPRISED\\": 0.00006676767952740192,\\n \\"CALM\\": 0.2918718755245209,\\n \\"DISGUSTED\\": 0.000033771051676012576,\\n \\"ANGRY\\": 0.00001282201901631197,\\n \\"SAD\\": 0.00001527295717096422,\\n \\"SCARED\\": 0.0000014976058082538657\\n }\\n }\\n ],\\n \\"ImageQualityStatus\\": \\"Success\\",\\n \\"OCRFailReason\\": \\"Timeout\\",\\n \\"AddressFailReason\\": \\"Timeout\\",\\n \\"ImageQuality\\": {\\n \\"OverallScore\\": 0.7759467363357544,\\n \\"Color\\": 0.6101377010345459,\\n \\"ColorScore\\": 0.6101377010345459,\\n \\"ContrastScore\\": 0.6101377010345459,\\n \\"Contrast\\": 0.6101377010345459,\\n \\"ExposureScore\\": 0.6101377010345459,\\n \\"ClarityScore\\": 0.6101377010345459,\\n \\"Clarity\\": 0.6101377010345459,\\n \\"Exposure\\": 0.6101377010345459,\\n \\"CompositionScore\\": 0.6101377010345459\\n },\\n \\"CroppingSuggestionModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"ImageFormat\\": \\"jpg\\",\\n \\"ImageWidth\\": 500,\\n \\"RemarksArrayB\\": \\"[\\\\\\"remarkb1\\\\\\",\\\\\\"remarkb2\\\\\\"]\\",\\n \\"CroppingSuggestion\\": [\\n {\\n \\"Score\\": 0.8812195897102356,\\n \\"CroppingBoundary\\": {\\n \\"Top\\": 70,\\n \\"Width\\": 200,\\n \\"Height\\": 200,\\n \\"Left\\": 10\\n },\\n \\"AspectRatio\\": \\"1:1\\"\\n }\\n ],\\n \\"Orientation\\": \\"{\\\\\\"val\\\\\\":\\\\\\"Right-top\\\\\\",\\\\\\"type\\\\\\":3}\\",\\n \\"RemarksD\\": \\"remarkd\\",\\n \\"TagsStatus\\": \\"Success\\",\\n \\"CroppingSuggestionFailReason\\": \\"Timeout\\",\\n \\"RemarksA\\": \\"remarka\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/face1.jpg\\",\\n \\"TagsModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"OCRStatus\\": \\"NotProcessed\\",\\n \\"AddressStatus\\": \\"Success\\",\\n \\"Exif\\": \\"{\\\\\\"FileSize\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"29304\\\\\\"},\\\\\\"Format\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"jpg\\\\\\"},\\\\\\"ImageHeight\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"417\\\\\\"},\\\\\\"ImageWidth\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"500\\\\\\"},\\\\\\"ResolutionUnit\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2\\\\\\"},\\\\\\"XResolution\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"96/1\\\\\\"},\\\\\\"YResolution\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"96/1\\\\\\"}}\\",\\n \\"Location\\": \\"30.134390,120.074997\\",\\n \\"RemarksB\\": \\"remarkb\\"\\n }\\n ],\\n \\"NextMarker\\": \\"CAESEgoQCg4KCkNyZWF0ZVRpbWUQABgBItcBCgkAIUv1J88rSRYKyQEDxAAAADFTMzEzNzM0MzYzNDM5MzUzODM1MzczNjMwMzIzNzM0MzUzYTY5NmQ2ZDY5NmQ2MTY3NjUzYTczNjU3NDMwMzAzMTNhMzc2NTY1NjM2NTMyMzQzNjYyMzUzMjM3MzgzODMwMzA2MzM4NjE2NDM4NjQ2MzY2NjE2MTMxNjMzNDMxNjY2MTY0MzEzODM0NjMzOTMzNjQ2MTM2MzUzMjY2NjYzMjMzNjUzNzM1NjUzNzM3MzM2MTY0MzEzMTM2MzYzMTM4Mzk=\\",\\n \\"SetId\\": \\"set001\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>A9C250B8-AC5B-4570-A7FE-73448DFCEFC8</RequestId>\\n<Images>\\n <ImageQuality>\\n <OverallScore>0.7759467363357544</OverallScore>\\n </ImageQuality>\\n <ModifyTime>2020-11-25T10:12:59.57Z</ModifyTime>\\n <Address>\\n <Township>转塘街道</Township>\\n <AddressLine>中国浙江省杭州市西湖区转塘街道石龙山西路</AddressLine>\\n <Country>中国</Country>\\n <City>杭州市</City>\\n <District>西湖区</District>\\n <Province>浙江省</Province>\\n </Address>\\n <SourceUri>oss://imm-test/testcases/face1.jpg</SourceUri>\\n <SourceType>image</SourceType>\\n <FacesFailReason/>\\n <CroppingSuggestionStatus>NotProcessed</CroppingSuggestionStatus>\\n <AddressFailReason/>\\n <RemarksA>remarka</RemarksA>\\n <AddressModifyTime>2020-11-25T10:12:59.57Z</AddressModifyTime>\\n <RemarksB>remarkb</RemarksB>\\n <ImageFormat>jpg</ImageFormat>\\n <RemarksArrayB>[\\"remarkb1\\",\\"remarkb2\\"]</RemarksArrayB>\\n <TagsFailReason/>\\n <Exif>{\\"FileSize\\":{\\"value\\":\\"29304\\"},\\"Format\\":{\\"value\\":\\"jpg\\"},\\"ImageHeight\\":{\\"value\\":\\"417\\"},\\"ImageWidth\\":{\\"value\\":\\"500\\"},\\"ResolutionUnit\\":{\\"value\\":\\"2\\"},\\"XResolution\\":{\\"value\\":\\"96/1\\"},\\"YResolution\\":{\\"value\\":\\"96/1\\"}}</Exif>\\n <FacesModifyTime>2020-11-25T10:12:59.57Z</FacesModifyTime>\\n <RemarksC>remarkc</RemarksC>\\n <RemarksD>remarkd</RemarksD>\\n <ImageWidth>500</ImageWidth>\\n <RemarksArrayA>[\\"remarka1\\",\\"remarka2\\"]</RemarksArrayA>\\n <Faces>\\n <FaceConfidence>0.9608758687973022</FaceConfidence>\\n <FaceId>59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51</FaceId>\\n <EmotionDetails>\\n <CALM>0.2918718755245209</CALM>\\n <SCARED>0.0000014976058082538657</SCARED>\\n <HAPPY>0.7079545259475708</HAPPY>\\n <SAD>0.00001527295717096422</SAD>\\n <SURPRISED>0.00006676767952740192</SURPRISED>\\n <ANGRY>0.00001282201901631197</ANGRY>\\n <DISGUSTED>0.000033771051676012576</DISGUSTED>\\n </EmotionDetails>\\n <Attractive>0.96</Attractive>\\n <FaceQuality>0.9321779608726501</FaceQuality>\\n <FaceAttributes>\\n <Beard>NONE</Beard>\\n <FaceBoundary>\\n <Left>95</Left>\\n <Top>191</Top>\\n <Height>252</Height>\\n <Width>269</Width>\\n </FaceBoundary>\\n <BeardConfidence>1</BeardConfidence>\\n <HeadPose>\\n <Pitch>18.385589599609375</Pitch>\\n <Roll>4.204030513763428</Roll>\\n <Yaw>2.4945924282073975</Yaw>\\n </HeadPose>\\n <Glasses>NONE</Glasses>\\n <MaskConfidence>1</MaskConfidence>\\n <Mask>NONE</Mask>\\n <GlassesConfidence>1</GlassesConfidence>\\n </FaceAttributes>\\n <GenderConfidence>1</GenderConfidence>\\n <EmotionConfidence>0.7079545259475708</EmotionConfidence>\\n <Gender>FEMALE</Gender>\\n <Emotion>HAPPY</Emotion>\\n <Age>29</Age>\\n <GroupId>group-not-grouped</GroupId>\\n </Faces>\\n <Tags>\\n <TagConfidence>0.9812195897102356</TagConfidence>\\n <TagName>脸</TagName>\\n <TagLevel>2</TagLevel>\\n <ParentTagName>人物</ParentTagName>\\n </Tags>\\n <Tags>\\n <TagConfidence>0.9812195897102356</TagConfidence>\\n <TagName>人物</TagName>\\n <TagLevel>1</TagLevel>\\n </Tags>\\n <Tags>\\n <TagConfidence>0.7626392841339111</TagConfidence>\\n <TagName>微笑</TagName>\\n <TagLevel>3</TagLevel>\\n <ParentTagName>日常行为</ParentTagName>\\n </Tags>\\n <Tags>\\n <TagConfidence>0.7626392841339111</TagConfidence>\\n <TagName>日常行为</TagName>\\n <TagLevel>2</TagLevel>\\n <ParentTagName>生活</ParentTagName>\\n </Tags>\\n <Tags>\\n <TagConfidence>0.7626392841339111</TagConfidence>\\n <TagName>生活</TagName>\\n <TagLevel>1</TagLevel>\\n </Tags>\\n <AddressStatus>Success</AddressStatus>\\n <FacesStatus>Success</FacesStatus>\\n <ImageQualityModifyTime>2020-11-25T10:12:59.57Z</ImageQualityModifyTime>\\n <ExternalId>externalId001</ExternalId>\\n <TagsModifyTime>2020-11-25T10:12:59.57Z</TagsModifyTime>\\n <CreateTime>2020-11-25T10:12:59.57Z</CreateTime>\\n <ImageQualityFailReason/>\\n <Orientation/>\\n <ImageUri>oss://imm-test/testcases/face1.jpg</ImageUri>\\n <OCRStatus>NotProcessed</OCRStatus>\\n <OCRModifyTime/>\\n <CroppingSuggestionModifyTime/>\\n <ImageQualityStatus>Success</ImageQualityStatus>\\n <TagsStatus>Success</TagsStatus>\\n <ImageHeight>861</ImageHeight>\\n <OCRFailReason/>\\n <Location>30.134390,120.074997</Location>\\n <FileSize>69732</FileSize>\\n</Images>\\n<NextMarker>CAESEgoQCg4KCkNyZWF0ZVRpbWUQABgBItcBCgkAIUv1J88rSRYKyQEDxAAAADFTMzEzNzM0MzYzNDM5MzUzODM1MzczNjMwMzIzNzM0MzUzYTY5NmQ2ZDY5NmQ2MTY3NjUzYTczNjU3NDMwMzAzMTNhMzc2NTY1NjM2NTMyMzQzNjYyMzUzMjM3MzgzODMwMzA2MzM4NjE2NDM4NjQ2MzY2NjE2MTMxNjMzNDMxNjY2MTY0MzEzODM0NjMzOTMzNjQ2MTM2MzUzMjY2NjYzMjMzNjUzNzM1NjUzNzM3MzM2MTY0MzEzMTM2MzYzMTM4Mzk=</NextMarker>\\n<SetId>set001</SetId>","errorExample":""}]', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateImage' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ser001', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + ], + [ + 'name' => 'RemarksA', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'remarksa1', + ], + ], + [ + 'name' => 'RemarksB', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'remarksb1', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'image', + ], + ], + [ + 'name' => 'SourceUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + ], + [ + 'name' => 'SourcePosition', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://imm-test/testcases/', + ], + ], + [ + 'name' => 'RemarksC', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'remarksc1', + ], + ], + [ + 'name' => 'RemarksD', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'remarksd1', + ], + ], + [ + 'name' => 'ExternalId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'externalId002', + ], + ], + [ + 'name' => 'RemarksArrayA', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '["remarka11","remarka12"]', + ], + ], + [ + 'name' => 'RemarksArrayB', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '["remarkb11","remarkb12"]', + ], + ], + [ + 'name' => 'Faces', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FaceId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51', + ], + 'GroupId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Group-e3908e18-6eb9-4453-aacb-26620281870c', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RemarksArrayB' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["remarkb11","remarkb12"]', + ], + 'ModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-25T10:56:52.461Z', + ], + 'RemarksC' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'remarksc1', + ], + 'RemarksD' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'remarksd1', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '7A25A44E-5E7D-4F0C-95C5-BA5BD96B7890', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-24T10:56:52.461Z', + ], + 'ExternalId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'externalId002', + ], + 'RemarksArrayA' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["remarka11","remarka12"]', + ], + 'RemarksA' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'remarksa1', + ], + 'ImageUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + 'SetId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'set001', + ], + 'RemarksB' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'remarksb1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RemarksArrayB\\": \\"[\\\\\\"remarkb11\\\\\\",\\\\\\"remarkb12\\\\\\"]\\",\\n \\"ModifyTime\\": \\"2020-11-25T10:56:52.461Z\\",\\n \\"RemarksC\\": \\"remarksc1\\",\\n \\"RemarksD\\": \\"remarksd1\\",\\n \\"RequestId\\": \\"7A25A44E-5E7D-4F0C-95C5-BA5BD96B7890\\",\\n \\"CreateTime\\": \\"2020-11-24T10:56:52.461Z\\",\\n \\"ExternalId\\": \\"externalId002\\",\\n \\"RemarksArrayA\\": \\"[\\\\\\"remarka11\\\\\\",\\\\\\"remarka12\\\\\\"]\\",\\n \\"RemarksA\\": \\"remarksa1\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/face1.jpg\\",\\n \\"SetId\\": \\"set001\\",\\n \\"RemarksB\\": \\"remarksb1\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyTime>2020-11-25T10:56:52.461Z</ModifyTime>\\n<RequestId>7A25A44E-5E7D-4F0C-95C5-BA5BD96B7890</RequestId>\\n<ExternalId>externalId002</ExternalId>\\n<CreateTime>2020-11-24T10:56:52.461Z</CreateTime>\\n<RemarksA>remarksa1</RemarksA>\\n<ImageUri>oss://imm-test/testcases/face1.jpg</ImageUri>\\n<RemarksB>remarksb1</RemarksB>\\n<RemarksArrayB>[\\"remarkb11\\",\\"remarkb12\\"]</RemarksArrayB>\\n<RemarksC>remarksc1</RemarksC>\\n<RemarksD>remarksd1</RemarksD>\\n<RemarksArrayA>[\\"remarka11\\",\\"remarka12\\"]</RemarksArrayA>\\n<SetId>set001</SetId>","errorExample":""}]', + 'title' => 'UpdateImage', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'IndexImage' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'set001', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + ], + [ + 'name' => 'RemarksA', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'AdminGroup/AdminUserA/', + ], + ], + [ + 'name' => 'RemarksB', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'nas://path/to/file', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'image', + ], + ], + [ + 'name' => 'SourceUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + ], + [ + 'name' => 'SourcePosition', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '00000000.010', + ], + ], + [ + 'name' => 'RemarksC', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'remarkc', + ], + ], + [ + 'name' => 'RemarksD', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'remarkd', + ], + ], + [ + 'name' => 'ExternalId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'externalId001', + ], + ], + [ + 'name' => 'NotifyEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + ], + ], + [ + 'name' => 'NotifyTopicName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'topic2', + ], + ], + [ + 'name' => 'RemarksArrayA', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '["remarka1","remarka2"]', + ], + ], + [ + 'name' => 'RemarksArrayB', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '["remarkb1","remarkb2"]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RemarksArrayB' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["remarkb1","remarkb2"]', + ], + 'ModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-24T10:56:52.461Z', + ], + 'RemarksC' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'remarkc', + ], + 'RemarksD' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'remarkd', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '144A2D4C-12D5-46D6-BEC9-9AAEE1F10C25', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-24T10:56:52.461Z', + ], + 'ExternalId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'externalId001', + ], + 'RemarksArrayA' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["remarka1","remarka2"]', + ], + 'RemarksA' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'AdminGroup/AdminUserA/', + ], + 'ImageUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + 'SetId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'set001', + ], + 'RemarksB' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'nas://path/to/file', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RemarksArrayB\\": \\"[\\\\\\"remarkb1\\\\\\",\\\\\\"remarkb2\\\\\\"]\\",\\n \\"ModifyTime\\": \\"2020-11-24T10:56:52.461Z\\",\\n \\"RemarksC\\": \\"remarkc\\",\\n \\"RemarksD\\": \\"remarkd\\",\\n \\"RequestId\\": \\"144A2D4C-12D5-46D6-BEC9-9AAEE1F10C25\\",\\n \\"CreateTime\\": \\"2020-11-24T10:56:52.461Z\\",\\n \\"ExternalId\\": \\"externalId001\\",\\n \\"RemarksArrayA\\": \\"[\\\\\\"remarka1\\\\\\",\\\\\\"remarka2\\\\\\"]\\",\\n \\"RemarksA\\": \\"AdminGroup/AdminUserA/\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/face1.jpg\\",\\n \\"SetId\\": \\"set001\\",\\n \\"RemarksB\\": \\"nas://path/to/file\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyTime>2020-11-24T10:56:52.461Z</ModifyTime>\\n<RequestId>144A2D4C-12D5-46D6-BEC9-9AAEE1F10C25</RequestId>\\n<ExternalId>externalId001</ExternalId>\\n<CreateTime>2020-11-24T10:56:52.461Z</CreateTime>\\n<RemarksA>AdminGroup/AdminUserA/</RemarksA>\\n<ImageUri>oss://imm-test/testcases/face1.jpg</ImageUri>\\n<RemarksB>nas://path/to/file</RemarksB>\\n<RemarksArrayB>[\\"remarkb1\\",\\"remarkb2\\"]</RemarksArrayB>\\n<RemarksC>remarkc</RemarksC>\\n<RemarksD>remarkd</RemarksD>\\n<RemarksArrayA>[\\"remarka1\\",\\"remarka2\\"]</RemarksArrayA>\\n<SetId>set001</SetId>","errorExample":""}]', + 'title' => 'IndexImage', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'FindSimilarFaces' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'set001', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + ], + [ + 'name' => 'FaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'MinSimilarity', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.8', + ], + ], + [ + 'name' => 'ResponseFormat', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'v2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '31A201C4-6824-4A8F-81FE-E0659FDDF1D7', + ], + 'Faces' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FaceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51', + ], + 'ImageUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + 'ExternalId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'external001', + ], + 'FaceAttributes' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'FaceBoundary' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '191', + ], + 'Width' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '269', + ], + 'Height' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '252', + ], + 'Left' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '95', + ], + ], + ], + ], + ], + 'Similarity' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8609305739402771', + ], + 'SimilarFaces' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FaceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '98ae3c032337161f997a92f8ab9ac9624113368b9e4f93f6143d54a16e51b623', + ], + 'ImageUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/face3.jpg', + ], + 'ExternalId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'external003', + ], + 'FaceAttributes' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'FaceBoundary' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '152', + ], + 'Width' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '139', + ], + 'Height' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '141', + ], + 'Left' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '267', + ], + ], + ], + ], + ], + 'Similarity' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8609305739402771', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"31A201C4-6824-4A8F-81FE-E0659FDDF1D7\\",\\n \\"Faces\\": [\\n {\\n \\"FaceId\\": \\"59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/face1.jpg\\",\\n \\"ExternalId\\": \\"external001\\",\\n \\"FaceAttributes\\": {\\n \\"FaceBoundary\\": {\\n \\"Top\\": 191,\\n \\"Width\\": 269,\\n \\"Height\\": 252,\\n \\"Left\\": 95\\n }\\n },\\n \\"Similarity\\": 0.860930573940277,\\n \\"SimilarFaces\\": [\\n {\\n \\"FaceId\\": \\"98ae3c032337161f997a92f8ab9ac9624113368b9e4f93f6143d54a16e51b623\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/face3.jpg\\",\\n \\"ExternalId\\": \\"external003\\",\\n \\"FaceAttributes\\": {\\n \\"FaceBoundary\\": {\\n \\"Top\\": 152,\\n \\"Width\\": 139,\\n \\"Height\\": 141,\\n \\"Left\\": 267\\n }\\n },\\n \\"Similarity\\": 0.860930573940277\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>31A201C4-6824-4A8F-81FE-E0659FDDF1D7</RequestId>\\n<Faces>\\n <FaceId>59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51</FaceId>\\n <FaceAttributes>\\n <FaceBoundary>\\n <Left>95</Left>\\n <Top>191</Top>\\n <Height>252</Height>\\n <Width>269</Width>\\n </FaceBoundary>\\n </FaceAttributes>\\n <Similarity>0.9999998807907104</Similarity>\\n <ExternalId/>\\n <ImageUri>oss://imm-test/testcases/face1.jpg</ImageUri>\\n</Faces>\\n<Faces>\\n <FaceId>98ae3c032337161f997a92f8ab9ac9624113368b9e4f93f6143d54a16e51b623</FaceId>\\n <FaceAttributes>\\n <FaceBoundary>\\n <Left>267</Left>\\n <Top>152</Top>\\n <Height>141</Height>\\n <Width>139</Width>\\n </FaceBoundary>\\n </FaceAttributes>\\n <Similarity>0.6609989404678345</Similarity>\\n <ExternalId/>\\n <ImageUri>oss://imm-test/testcases/face3.jpg.jpg</ImageUri>\\n</Faces>","errorExample":""}]', + 'title' => 'FindSimilarFaces', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CompareImageFaces' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'set001', + ], + ], + [ + 'name' => 'ImageUriA', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + ], + [ + 'name' => 'ImageUriB', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://imm-test/testcases/face2.jpg', + ], + ], + [ + 'name' => 'FaceIdA', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a040****', + ], + ], + [ + 'name' => 'FaceIdB', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'b4a15b4f1618cdfa45a812974cfc160570052487ca1053e20bfdc12917e2****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F73AC982-2B9E-4ECD-AED5-F8331C5A1988', + ], + 'Similarity' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8848152756690983', + ], + 'SetId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'set001', + ], + 'FaceA' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'FaceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a040****', + ], + 'FaceAttributes' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'FaceBoundary' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '191', + ], + 'Width' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '269', + ], + 'Height' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '252', + ], + 'Left' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '95', + ], + ], + ], + ], + ], + ], + ], + 'FaceB' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'FaceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'b4a15b4f1618cdfa45a812974cfc160570052487ca1053e20bfdc12917e2****', + ], + 'FaceAttributes' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'FaceBoundary' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '72', + ], + 'Width' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '83', + ], + 'Height' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '89', + ], + 'Left' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '249', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F73AC982-2B9E-4ECD-AED5-F8331C5A1988\\",\\n \\"Similarity\\": 0.8848152756690983,\\n \\"SetId\\": \\"set001\\",\\n \\"FaceA\\": {\\n \\"FaceId\\": \\"59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a040****\\",\\n \\"FaceAttributes\\": {\\n \\"FaceBoundary\\": {\\n \\"Top\\": 191,\\n \\"Width\\": 269,\\n \\"Height\\": 252,\\n \\"Left\\": 95\\n }\\n }\\n },\\n \\"FaceB\\": {\\n \\"FaceId\\": \\"b4a15b4f1618cdfa45a812974cfc160570052487ca1053e20bfdc12917e2****\\",\\n \\"FaceAttributes\\": {\\n \\"FaceBoundary\\": {\\n \\"Top\\": 72,\\n \\"Width\\": 83,\\n \\"Height\\": 89,\\n \\"Left\\": 249\\n }\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<CompareImageFacesResponse>\\n <Similarity>0.8848152756690983</Similarity>\\n <RequestId>F73AC982-2B9E-4ECD-AED5-F8331C5A1988</RequestId>\\n <SetId>set001</SetId>\\n <FaceA>\\n <FaceId>59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a040****</FaceId>\\n <FaceAttributes>\\n <FaceBoundary>\\n <Left>95</Left>\\n <Top>191</Top>\\n <Height>252</Height>\\n <Width>269</Width>\\n </FaceBoundary>\\n </FaceAttributes>\\n </FaceA>\\n <FaceB>\\n <FaceId>b4a15b4f1618cdfa45a812974cfc160570052487ca1053e20bfdc12917e2****</FaceId>\\n <FaceAttributes>\\n <FaceBoundary>\\n <Left>249</Left>\\n <Top>72</Top>\\n <Height>89</Height>\\n <Width>83</Width>\\n </FaceBoundary>\\n </FaceAttributes>\\n </FaceB>\\n</CompareImageFacesResponse>","errorExample":""}]', + 'title' => 'CompareImageFaces', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListFaceGroups' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'set001', + ], + ], + [ + 'name' => 'Marker', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CAESEQoPCg0KCUZhY2VDb3VudBABGAEirQEKCQAFAAAAAAAAAAqfAQOaAAAAMVMzMTM3MzQzNjM0MzkzNTM4MzUzNzM2MzAzMjM3MzQzNTNhNjk2ZDZkNjk2ZDYxNjc2NTNhNzM2NTc0NzQ2NTczNzQuUzQ3NzI2Zjc1NzAyZDM0Mzg2NjY0NjQzNDYyNjQyZDM2MzI2MzMzMmQzNDY0NjE2MTJkNjE2NDM5MzgyZDYxNjUzNjYxMzQzMTM3MzM2MTMxMzMzMA==', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'FaceCount', + ], + ], + [ + 'name' => 'RemarksAQuery', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => ' {"PREFIX": "start-with-this","NOT-PREFIX": "not-start-with-this","IN": ["ONE","OF","THIS"],"NOT-IN": ["NONE","FROM","THOSE"]}', + ], + ], + [ + 'name' => 'RemarksBQuery', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => ' {"PREFIX": "start-with-this","NOT-PREFIX": "not-start-with-this","IN": ["ONE","OF","THIS"],"NOT-IN": ["NONE","FROM","THOSE"]}', + ], + ], + [ + 'name' => 'RemarksCQuery', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => ' {"PREFIX": "start-with-this","NOT-PREFIX": "not-start-with-this","IN": ["ONE","OF","THIS"],"NOT-IN": ["NONE","FROM","THOSE"]}', + ], + ], + [ + 'name' => 'RemarksDQuery', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => ' {"PREFIX": "start-with-this","NOT-PREFIX": "not-start-with-this","IN": ["ONE","OF","THIS"],"NOT-IN": ["NONE","FROM","THOSE"]}', + ], + ], + [ + 'name' => 'RemarksArrayAQuery', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => ' {"PREFIX": "start-with-this","NOT-PREFIX": "not-start-with-this","IN": ["ONE","OF","THIS"],"NOT-IN": ["NONE","FROM","THOSE"]}', + ], + ], + [ + 'name' => 'RemarksArrayBQuery', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => ' {"PREFIX": "start-with-this","NOT-PREFIX": "not-start-with-this","IN": ["ONE","OF","THIS"],"NOT-IN": ["NONE","FROM","THOSE"]}', + ], + ], + [ + 'name' => 'ExternalId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'externalId001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6CD6F064-6999-4B64-B057-5FBD09E48C46', + ], + 'NextMarker' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CAESEQoPCg0KCUZhY2VDb3VudBABGAEirQEKCQAFAAAAAAAAAAqfAQOaAAAAMVMzMTM3MzQzNjM0MzkzNTM4MzUzNzM2MzAzMjM3MzQzNTNhNjk2ZDZkNjk2ZDYxNjc2NTNhNzM2NTc0NzQ2NTczNzQuUzQ3NzI2Zjc1NzAyZDM0Mzg2NjY0NjQzNDYyNjQyZDM2MzI2MzMzMmQzNDY0NjE2MTJkNjE2NDM5MzgyZDYxNjUzNjYxMzQzMTM3MzM2MTMxMzMzMA==', + ], + 'FaceGroups' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Gender' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MALE', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-01-11T02:18:26.174Z', + ], + 'RemarksC' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'GroupCoverFace' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'FaceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'b30a7a36997ce986965680fed90c397fc70a533af511346f819976c6a138c594', + ], + 'ImageUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + 'FaceBoundary' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '49', + ], + 'Width' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '46', + ], + 'Height' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '45', + ], + 'Left' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + ], + ], + 'ExternalId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '61e24632982b3e7598f74d4a95a2706cb11b3408#61e2463254140e7b68044db1aeca52771ae6bdb3', + ], + 'ImageHeight' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '374', + ], + 'ImageWidth' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '739', + ], + ], + ], + 'FaceCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RemarksArrayB' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["remarksb1","remarksb2"]', + ], + 'RemarksD' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'MaxAge' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '28', + ], + 'GroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Group-48fdd4bd-62c3-4daa-ad98-ae6a4173a130', + ], + 'GroupName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'facegrouptest', + ], + 'RemarksA' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/', + ], + 'AverageAge' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '26.4', + ], + 'RemarksArrayA' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["remarksa1","remarksa2"]', + ], + 'MinAge' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '23', + ], + 'ImageCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ExternalId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'externalIdtest', + ], + 'RemarksB' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'face1.jpg', + ], + 'ModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-01-11T02:18:26.174Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6CD6F064-6999-4B64-B057-5FBD09E48C46\\",\\n \\"NextMarker\\": \\"CAESEQoPCg0KCUZhY2VDb3VudBABGAEirQEKCQAFAAAAAAAAAAqfAQOaAAAAMVMzMTM3MzQzNjM0MzkzNTM4MzUzNzM2MzAzMjM3MzQzNTNhNjk2ZDZkNjk2ZDYxNjc2NTNhNzM2NTc0NzQ2NTczNzQuUzQ3NzI2Zjc1NzAyZDM0Mzg2NjY0NjQzNDYyNjQyZDM2MzI2MzMzMmQzNDY0NjE2MTJkNjE2NDM5MzgyZDYxNjUzNjYxMzQzMTM3MzM2MTMxMzMzMA==\\",\\n \\"FaceGroups\\": [\\n {\\n \\"Gender\\": \\"MALE\\",\\n \\"CreateTime\\": \\"2021-01-11T02:18:26.174Z\\",\\n \\"RemarksC\\": \\"浙江省杭州市\\",\\n \\"GroupCoverFace\\": {\\n \\"FaceId\\": \\"b30a7a36997ce986965680fed90c397fc70a533af511346f819976c6a138c594\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/face1.jpg\\",\\n \\"FaceBoundary\\": {\\n \\"Top\\": 49,\\n \\"Width\\": 46,\\n \\"Height\\": 45,\\n \\"Left\\": 80\\n },\\n \\"ExternalId\\": \\"61e24632982b3e7598f74d4a95a2706cb11b3408#61e2463254140e7b68044db1aeca52771ae6bdb3\\",\\n \\"ImageHeight\\": 374,\\n \\"ImageWidth\\": 739\\n },\\n \\"FaceCount\\": 5,\\n \\"RemarksArrayB\\": \\"[\\\\\\"remarksb1\\\\\\",\\\\\\"remarksb2\\\\\\"]\\",\\n \\"RemarksD\\": \\"浙江省杭州市\\",\\n \\"MaxAge\\": 28,\\n \\"GroupId\\": \\"Group-48fdd4bd-62c3-4daa-ad98-ae6a4173a130\\",\\n \\"GroupName\\": \\"facegrouptest\\",\\n \\"RemarksA\\": \\"oss://imm-test/testcases/\\",\\n \\"AverageAge\\": 26.4,\\n \\"RemarksArrayA\\": \\"[\\\\\\"remarksa1\\\\\\",\\\\\\"remarksa2\\\\\\"]\\",\\n \\"MinAge\\": 23,\\n \\"ImageCount\\": 5,\\n \\"ExternalId\\": \\"externalIdtest\\",\\n \\"RemarksB\\": \\"face1.jpg\\",\\n \\"ModifyTime\\": \\"2021-01-11T02:18:26.174Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>6CD6F064-6999-4B64-B057-5FBD09E48C46</RequestId>\\n<NextMarker>CAESEQoPCg0KCUZhY2VDb3VudBABGAEirQEKCQAFAAAAAAAAAAqfAQOaAAAAMVMzMTM3MzQzNjM0MzkzNTM4MzUzNzM2MzAzMjM3MzQzNTNhNjk2ZDZkNjk2ZDYxNjc2NTNhNzM2NTc0NzQ2NTczNzQuUzQ3NzI2Zjc1NzAyZDM0Mzg2NjY0NjQzNDYyNjQyZDM2MzI2MzMzMmQzNDY0NjE2MTJkNjE2NDM5MzgyZDYxNjUzNjYxMzQzMTM3MzM2MTMxMzMzMA==</NextMarker>\\n<FaceGroups>\\n <GroupName>facegrouptest</GroupName>\\n <GroupCoverFace>\\n <FaceId>b30a7a36997ce986965680fed90c397fc70a533af511346f819976c6a138c594</FaceId>\\n <FaceBoundary>\\n <Left>80</Left>\\n <Top>49</Top>\\n <Height>45</Height>\\n <Width>46</Width>\\n </FaceBoundary>\\n <ImageUri>oss://imm-test/testcases/face1.jpg</ImageUri>\\n </GroupCoverFace>\\n <ModifyTime>2021-01-11T02:18:26.174Z</ModifyTime>\\n <ExternalId>externalIdtest</ExternalId>\\n <CreateTime>2021-01-11T02:18:26.174Z</CreateTime>\\n <MaxAge>28</MaxAge>\\n <Gender>MALE</Gender>\\n <AverageAge>26.4</AverageAge>\\n <RemarksA>oss://imm-test/testcases/</RemarksA>\\n <RemarksB>face1.jpg</RemarksB>\\n <GroupId>Group-48fdd4bd-62c3-4daa-ad98-ae6a4173a130</GroupId>\\n <RemarksArrayB>[\\"remarksb1\\",\\"remarksb2\\"]</RemarksArrayB>\\n <MinAge>23</MinAge>\\n <ImageCount>5</ImageCount>\\n <RemarksC>浙江省杭州市</RemarksC>\\n <RemarksD>浙江省杭州市</RemarksD>\\n <RemarksArrayA>[\\"remarksa1\\",\\"remarksa2\\"]</RemarksArrayA>\\n <FaceCount>5</FaceCount>\\n</FaceGroups>","errorExample":""}]', + 'title' => 'ListFaceGroups', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateFaceGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'set001', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'mygroup', + ], + ], + [ + 'name' => 'GroupCoverFaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '8ba3460c1dcaa81f53b56e30c69d46693db215cf19aa19265f979913c24c8ef1', + ], + ], + [ + 'name' => 'RemarksA', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'remarksa11', + ], + ], + [ + 'name' => 'RemarksB', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'remarksb11', + ], + ], + [ + 'name' => 'RemarksC', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'remarksc11', + ], + ], + [ + 'name' => 'RemarksD', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'remarksd11', + ], + ], + [ + 'name' => 'RemarksArrayA', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '["remarka11","remarka12"]', + ], + ], + [ + 'name' => 'RemarksArrayB', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '["remarkb11","remarkb12"]', + ], + ], + [ + 'name' => 'ExternalId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'externalIdtest', + ], + ], + [ + 'name' => 'ResetItems', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '["GroupName"]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A1104C7E-AA5E-4D5F-8A00-6BFD608103D2', + ], + 'SetId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'set001', + ], + 'GroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A1104C7E-AA5E-4D5F-8A00-6BFD608103D2\\",\\n \\"SetId\\": \\"set001\\",\\n \\"GroupId\\": \\"Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>A1104C7E-AA5E-4D5F-8A00-6BFD608103D2</RequestId>\\n<SetId>set001</SetId>\\n<GroupId>Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09</GroupId>","errorExample":""}]', + 'title' => 'UpdateFaceGroup', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateGroupFacesJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'set001', + ], + ], + [ + 'name' => 'NotifyTopicName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'topic1', + ], + ], + [ + 'name' => 'NotifyEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'JobType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'GroupImageFacesJob', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'BCF7B6EC-F97D-4594-866C-B421B82B24FE', + ], + 'SetId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'set001', + ], + 'JobId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'GroupImageFacesJob-fb9586a7-f91d-46b9-8e70-b669892cf34d', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"JobType\\": \\"GroupImageFacesJob\\",\\n \\"RequestId\\": \\"BCF7B6EC-F97D-4594-866C-B421B82B24FE\\",\\n \\"SetId\\": \\"set001\\",\\n \\"JobId\\": \\"GroupImageFacesJob-fb9586a7-f91d-46b9-8e70-b669892cf34d\\"\\n}","errorExample":""},{"type":"xml","example":"<JobType>GroupImageFacesJob</JobType>\\n<RequestId>BCF7B6EC-F97D-4594-866C-B421B82B24FE</RequestId>\\n<SetId>set001</SetId>\\n<JobId>GroupImageFacesJob-fb9586a7-f91d-46b9-8e70-b669892cf34d</JobId>","errorExample":""}]', + 'title' => 'CreateGroupFacesJob', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateMergeFaceGroupsJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'set001', + ], + ], + [ + 'name' => 'NotifyTopicName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'topic1', + ], + ], + [ + 'name' => 'NotifyEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + ], + ], + [ + 'name' => 'GroupIdFrom', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Group-c1f55987-360b-4640-9e2c-f5c29f930a3b', + ], + ], + [ + 'name' => 'GroupIdTo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09', + ], + ], + [ + 'name' => 'CustomMessage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'GroupIdFrom' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Group-c1f55987-360b-4640-9e2c-f5c29f930a3b', + ], + 'JobType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MergeFaceGroupsJob', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3FF344BF-87A9-4AC3-A3DE-9E1FAED7D1FE', + ], + 'SetId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'set001', + ], + 'GroupIdTo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09', + ], + 'JobId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MergeFaceGroupsJob-055995ef-9c5e-4db4-a99a-0900d1e31d26', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"GroupIdFrom\\": \\"Group-c1f55987-360b-4640-9e2c-f5c29f930a3b\\",\\n \\"JobType\\": \\"MergeFaceGroupsJob\\",\\n \\"RequestId\\": \\"3FF344BF-87A9-4AC3-A3DE-9E1FAED7D1FE\\",\\n \\"SetId\\": \\"set001\\",\\n \\"GroupIdTo\\": \\"Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09\\",\\n \\"JobId\\": \\"MergeFaceGroupsJob-055995ef-9c5e-4db4-a99a-0900d1e31d26\\"\\n}","errorExample":""},{"type":"xml","example":"<GroupIdFrom>Group-c1f55987-360b-4640-9e2c-f5c29f930a3b</GroupIdFrom>\\n<JobType>MergeFaceGroupsJob</JobType>\\n<RequestId>3FF344BF-87A9-4AC3-A3DE-9E1FAED7D1FE</RequestId>\\n<SetId>set001</SetId>\\n<GroupIdTo>Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09</GroupIdTo>\\n<JobId>MergeFaceGroupsJob-055995ef-9c5e-4db4-a99a-0900d1e31d26</JobId>","errorExample":""}]', + 'title' => 'CreateMergeFaceGroupsJob ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListSetTags' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'set001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'DC5CF0A7-7A3A-43D0-888C-AC275EA4A6F9', + ], + 'SetId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'set001', + ], + 'Tags' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'TagCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TagLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DC5CF0A7-7A3A-43D0-888C-AC275EA4A6F9\\",\\n \\"SetId\\": \\"set001\\",\\n \\"Tags\\": [\\n {\\n \\"TagName\\": \\"人物\\",\\n \\"TagCount\\": 5,\\n \\"TagLevel\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>DC5CF0A7-7A3A-43D0-888C-AC275EA4A6F9</RequestId>\\n<SetId>set001</SetId>\\n<Tags>\\n <TagCount>5</TagCount>\\n <TagName>人物</TagName>\\n <TagLevel>1</TagLevel>\\n</Tags>\\n<Tags>\\n <TagCount>5</TagCount>\\n <TagName>脸</TagName>\\n <TagLevel>2</TagLevel>\\n</Tags>","errorExample":""}]', + 'title' => 'ListSetTags', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetImageQuality' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/qualitytest.jpg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ImageQuality' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'OverallScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7759467363357544', + ], + 'Color' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ColorScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ContrastScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'Contrast' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ExposureScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ClarityScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'Clarity' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'Exposure' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'CompositionScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '7F89F18C-40BF-4E1C-95C4-324FF00BFAE8', + ], + 'ImageUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/qualitytest.jpg', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ImageQuality\\": {\\n \\"OverallScore\\": 0.7759467363357544,\\n \\"Color\\": 0.6101377010345459,\\n \\"ColorScore\\": 0.6101377010345459,\\n \\"ContrastScore\\": 0.6101377010345459,\\n \\"Contrast\\": 0.6101377010345459,\\n \\"ExposureScore\\": 0.6101377010345459,\\n \\"ClarityScore\\": 0.6101377010345459,\\n \\"Clarity\\": 0.6101377010345459,\\n \\"Exposure\\": 0.6101377010345459,\\n \\"CompositionScore\\": 0.6101377010345459\\n },\\n \\"RequestId\\": \\"7F89F18C-40BF-4E1C-95C4-324FF00BFAE8\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/qualitytest.jpg\\"\\n}","errorExample":""},{"type":"xml","example":"<ImageQuality>\\n <OverallScore>0.7759467363357544</OverallScore>\\n</ImageQuality>\\n<RequestId>7F89F18C-40BF-4E1C-95C4-324FF00BFAE8</RequestId>\\n<ImageUri>oss://imm-test/testcases/qualitytest.jpg</ImageUri>","errorExample":""}]', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetImageCroppingSuggestions' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/imagecroppingtest.jpg', + ], + ], + [ + 'name' => 'AspectRatios', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '["1:1","2:3"]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EA153782-13A5-44EE-835A-90A14FC51352', + ], + 'ImageUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/imagecroppingtest.jpg', + ], + 'CroppingSuggestions' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Score' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6979608535766602', + ], + 'CroppingBoundary' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '77', + ], + 'Width' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'Height' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'Left' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'AspectRatio' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1:1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EA153782-13A5-44EE-835A-90A14FC51352\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/imagecroppingtest.jpg\\",\\n \\"CroppingSuggestions\\": [\\n {\\n \\"Score\\": 0.6979608535766602,\\n \\"CroppingBoundary\\": {\\n \\"Top\\": 77,\\n \\"Width\\": 500,\\n \\"Height\\": 500,\\n \\"Left\\": 0\\n },\\n \\"AspectRatio\\": \\"1:1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EA153782-13A5-44EE-835A-90A14FC51352</RequestId>\\n<ImageUri>oss://imm-test/testcases/imagecroppingtest.jpg</ImageUri>\\n<CroppingSuggestions>\\n <AspectRatio>1:1</AspectRatio>\\n <Score>0.6979608535766602</Score>\\n <CroppingBoundary>\\n <Left>0</Left>\\n <Top>77</Top>\\n <Height>500</Height>\\n <Width>500</Width>\\n </CroppingBoundary>\\n</CroppingSuggestions>\\n<CroppingSuggestions>\\n <AspectRatio>2:3</AspectRatio>\\n <Score>0.781792938709259</Score>\\n <CroppingBoundary>\\n <Left>0</Left>\\n <Top>77</Top>\\n <Height>750</Height>\\n <Width>500</Width>\\n </CroppingBoundary>\\n</CroppingSuggestions>","errorExample":""}]', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DetectQRCodes' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SrcUris', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '[“oss://imm-test/testcases/QRcodetest.jpg”]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SuccessDetails' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SrcUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/QRcodetest.jpg', + ], + 'QRCodes' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'QRCodesRectangle' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '', + 'type' => 'string', + 'example' => '295', + ], + 'Width' => [ + 'description' => '', + 'type' => 'string', + 'example' => '741', + ], + 'Height' => [ + 'description' => '', + 'type' => 'string', + 'example' => '706', + ], + 'Left' => [ + 'description' => '', + 'type' => 'string', + 'example' => '460', + ], + ], + ], + 'Content' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://www.aliyun.com/product/imm', + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'E6A558B8-87C1-45BE-90B9-26049B0BAB01', + ], + 'FailDetails' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'The resource SrcUris is not valid. Please check.', + ], + 'SrcUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/QRcodetest.jpg', + ], + 'ErrorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'InvalidSrcUris', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"SuccessDetails\\": [\\n {\\n \\"SrcUri\\": \\"oss://imm-test/testcases/QRcodetest.jpg\\",\\n \\"QRCodes\\": [\\n {\\n \\"QRCodesRectangle\\": {\\n \\"Top\\": \\"295\\",\\n \\"Width\\": \\"741\\",\\n \\"Height\\": \\"706\\",\\n \\"Left\\": \\"460\\"\\n },\\n \\"Content\\": \\"https://www.aliyun.com/product/imm\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"E6A558B8-87C1-45BE-90B9-26049B0BAB01\\",\\n \\"FailDetails\\": [\\n {\\n \\"ErrorMessage\\": \\"The resource SrcUris is not valid. Please check.\\",\\n \\"SrcUri\\": \\"oss://imm-test/testcases/QRcodetest.jpg\\",\\n \\"ErrorCode\\": \\"InvalidSrcUris\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<SuccessDetails>\\n <SrcUri>oss://imm-test/testcases/QRcodetest.jpg</SrcUri>\\n <QRCodes>\\n <QRCodesRectangle>\\n <Left>460</Left>\\n <Top>295</Top>\\n <Height>706</Height>\\n <Width>741</Width>\\n </QRCodesRectangle>\\n <Content>https://www.aliyun.com/product/imm</Content>\\n </QRCodes>\\n</SuccessDetails>\\n<RequestId>E6A558B8-87C1-45BE-90B9-26049B0BAB01</RequestId>","errorExample":""}]', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DetectImageQRCodes' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/QRcodetest.jpg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '52D33EAE-88B2-4ADE-A5DB-18BD426617A5', + ], + 'ImageUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/QRcodetest.jpg', + ], + 'QRCodes' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://www.aliyun.com/product/imm', + ], + 'QRCodeBoundary' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '295', + ], + 'Width' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '741', + ], + 'Height' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '706', + ], + 'Left' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '460', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"52D33EAE-88B2-4ADE-A5DB-18BD426617A5\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/QRcodetest.jpg\\",\\n \\"QRCodes\\": [\\n {\\n \\"Content\\": \\"https://www.aliyun.com/product/imm\\",\\n \\"QRCodeBoundary\\": {\\n \\"Top\\": 295,\\n \\"Width\\": 741,\\n \\"Height\\": 706,\\n \\"Left\\": 460\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>52D33EAE-88B2-4ADE-A5DB-18BD426617A5</RequestId>\\n<ImageUri>oss://imm-test/testcases/QRcodetest.jpg</ImageUri>\\n<QRCodes>\\n <Content>https://www.aliyun.com/product/imm</Content>\\n <QRCodeBoundary>\\n <Left>460</Left>\\n <Top>295</Top>\\n <Height>706</Height>\\n <Width>741</Width>\\n </QRCodeBoundary>\\n</QRCodes>","errorExample":""}]', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DetectImageTags' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/facetest.jpg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '91AC8C98-0F36-49D2-8290-742E24DF1F69', + ], + 'ImageUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/facetest.jpg', + ], + 'Tags' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParentTagEnName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'person', + ], + 'TagName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'TagConfidence' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9897482395172119', + ], + 'CentricScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'TagEnName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'face', + ], + 'TagLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ParentTagName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"91AC8C98-0F36-49D2-8290-742E24DF1F69\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/facetest.jpg\\",\\n \\"Tags\\": [\\n {\\n \\"ParentTagEnName\\": \\"person\\",\\n \\"TagName\\": \\"脸\\",\\n \\"TagConfidence\\": 0.9897482395172119,\\n \\"CentricScore\\": 0,\\n \\"TagEnName\\": \\"face\\",\\n \\"TagLevel\\": 2,\\n \\"ParentTagName\\": \\"人物\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>91AC8C98-0F36-49D2-8290-742E24DF1F69</RequestId>\\n<ImageUri>oss://imm-test/testcases/facetest.jpg</ImageUri>\\n<Tags>\\n <TagName>脸</TagName>\\n <TagConfidence>0.9897482395172119</TagConfidence>\\n <TagLevel>2</TagLevel>\\n <ParentTagName>人物</ParentTagName>\\n</Tags>\\n<Tags>\\n <TagName>人物</TagName>\\n <TagConfidence>0.9897482395172119</TagConfidence>\\n <TagLevel>1</TagLevel>\\n</Tags>","errorExample":""}]', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DetectImageFaces' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => 'immimagetest', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/facetest.jpg', + 'required' => true, + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'example' => 'D2C628B8-35DF-473C-8A41-757F30202ADC', + 'type' => 'string', + ], + 'ImageUri' => [ + 'description' => '', + 'example' => 'oss://imm-test/testcases/facetest.png', + 'type' => 'string', + ], + 'Faces' => [ + 'description' => '', + 'items' => [ + 'properties' => [ + 'AttractiveConfidence' => [ + 'description' => '', + 'example' => '0.9321795701980591', + 'format' => 'float', + 'type' => 'number', + ], + 'Gender' => [ + 'description' => '', + 'example' => 'FEMALE', + 'type' => 'string', + ], + 'GenderConfidence' => [ + 'description' => '', + 'example' => '1', + 'format' => 'float', + 'type' => 'number', + ], + 'FaceId' => [ + 'description' => '', + 'example' => '59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51', + 'type' => 'string', + ], + 'FaceAttributes' => [ + 'description' => '', + 'properties' => [ + 'GlassesConfidence' => [ + 'description' => '', + 'example' => '1', + 'format' => 'float', + 'type' => 'number', + ], + 'Glasses' => [ + 'description' => '', + 'example' => 'NONE', + 'type' => 'string', + ], + 'Mask' => [ + 'description' => '', + 'example' => 'NONE', + 'type' => 'string', + ], + 'BeardConfidence' => [ + 'description' => '', + 'example' => '1', + 'format' => 'float', + 'type' => 'number', + ], + 'MaskConfidence' => [ + 'description' => '', + 'example' => '1', + 'format' => 'float', + 'type' => 'number', + ], + 'FaceBoundary' => [ + 'description' => '', + 'properties' => [ + 'Top' => [ + 'description' => '', + 'example' => '191', + 'format' => 'int32', + 'type' => 'integer', + ], + 'Width' => [ + 'description' => '', + 'example' => '269', + 'format' => 'int32', + 'type' => 'integer', + ], + 'Height' => [ + 'description' => '', + 'example' => '252', + 'format' => 'int32', + 'type' => 'integer', + ], + 'Left' => [ + 'description' => '', + 'example' => '95', + 'format' => 'int32', + 'type' => 'integer', + ], + ], + 'type' => 'object', + ], + 'HeadPose' => [ + 'description' => '', + 'properties' => [ + 'Pitch' => [ + 'description' => '', + 'example' => '18.38559913635254', + 'format' => 'float', + 'type' => 'number', + ], + 'Roll' => [ + 'description' => '', + 'example' => '4.204077243804932', + 'format' => 'float', + 'type' => 'number', + ], + 'Yaw' => [ + 'description' => '', + 'example' => '2.49458646774292', + 'format' => 'float', + 'type' => 'number', + ], + ], + 'type' => 'object', + ], + 'Beard' => [ + 'description' => '', + 'example' => 'NONE', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + 'FaceQuality' => [ + 'description' => '', + 'example' => '0.9321795701980591', + 'format' => 'float', + 'type' => 'number', + ], + 'Emotion' => [ + 'description' => '', + 'example' => 'HAPPY', + 'type' => 'string', + ], + 'Age' => [ + 'description' => '', + 'example' => '29', + 'format' => 'int32', + 'type' => 'integer', + ], + 'FaceConfidence' => [ + 'description' => '', + 'example' => '0.960875928401947', + 'format' => 'float', + 'type' => 'number', + ], + 'EmotionConfidence' => [ + 'description' => '', + 'example' => '0.7078456878662109', + 'format' => 'float', + 'type' => 'number', + ], + 'Attractive' => [ + 'description' => '', + 'example' => '0.96', + 'format' => 'float', + 'type' => 'number', + ], + 'AgeConfidence' => [ + 'description' => '', + 'example' => '0.9321795701980591', + 'format' => 'float', + 'type' => 'number', + ], + 'EmotionDetails' => [ + 'description' => '', + 'properties' => [ + 'HAPPY' => [ + 'description' => '', + 'example' => '0.7078456878662109', + 'format' => 'float', + 'type' => 'number', + ], + 'CALM' => [ + 'description' => '', + 'example' => '0.2919808030128479', + 'format' => 'float', + 'type' => 'number', + ], + 'SURPRISED' => [ + 'description' => '', + 'example' => '0.00006672900053672493', + 'format' => 'float', + 'type' => 'number', + ], + 'DISGUSTED' => [ + 'description' => '', + 'example' => '0.00003373104118509218', + 'format' => 'float', + 'type' => 'number', + ], + 'ANGRY' => [ + 'description' => '', + 'example' => '0.000012824941222788766', + 'format' => 'float', + 'type' => 'number', + ], + 'SAD' => [ + 'description' => '', + 'example' => '0.00001525594689155696', + 'format' => 'float', + 'type' => 'number', + ], + 'SCARED' => [ + 'description' => '', + 'example' => '0.0000014968593404773856', + 'format' => 'float', + 'type' => 'number', + ], + ], + 'type' => 'object', + ], + ], + 'type' => 'object', + ], + 'type' => 'array', + ], + ], + 'type' => 'object', + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D2C628B8-35DF-473C-8A41-757F30202ADC\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/facetest.png\\",\\n \\"Faces\\": [\\n {\\n \\"AttractiveConfidence\\": 0.9321795701980591,\\n \\"Gender\\": \\"FEMALE\\",\\n \\"GenderConfidence\\": 1,\\n \\"FaceId\\": \\"59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51\\",\\n \\"FaceAttributes\\": {\\n \\"GlassesConfidence\\": 1,\\n \\"Glasses\\": \\"NONE\\",\\n \\"Mask\\": \\"NONE\\",\\n \\"BeardConfidence\\": 1,\\n \\"MaskConfidence\\": 1,\\n \\"FaceBoundary\\": {\\n \\"Top\\": 191,\\n \\"Width\\": 269,\\n \\"Height\\": 252,\\n \\"Left\\": 95\\n },\\n \\"HeadPose\\": {\\n \\"Pitch\\": 18.38559913635254,\\n \\"Roll\\": 4.204077243804932,\\n \\"Yaw\\": 2.49458646774292\\n },\\n \\"Beard\\": \\"NONE\\"\\n },\\n \\"FaceQuality\\": 0.9321795701980591,\\n \\"Emotion\\": \\"HAPPY\\",\\n \\"Age\\": 29,\\n \\"FaceConfidence\\": 0.960875928401947,\\n \\"EmotionConfidence\\": 0.7078456878662109,\\n \\"Attractive\\": 0.96,\\n \\"AgeConfidence\\": 0.9321795701980591,\\n \\"EmotionDetails\\": {\\n \\"HAPPY\\": 0.7078456878662109,\\n \\"CALM\\": 0.2919808030128479,\\n \\"SURPRISED\\": 0.00006672900053672493,\\n \\"DISGUSTED\\": 0.00003373104118509218,\\n \\"ANGRY\\": 0.000012824941222788766,\\n \\"SAD\\": 0.00001525594689155696,\\n \\"SCARED\\": 0.0000014968593404773856\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>D2C628B8-35DF-473C-8A41-757F30202ADC</RequestId>\\n<ImageUri>oss://imm-test/testcases/facetest.png</ImageUri>\\n<Faces>\\n <FaceConfidence>0.960875928401947</FaceConfidence>\\n <FaceId>59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51</FaceId>\\n <FaceQuality>0.9321795701980591</FaceQuality>\\n <Attractive>0.96</Attractive>\\n <GenderConfidence>1</GenderConfidence>\\n <EmotionConfidence>0.7078456878662109</EmotionConfidence>\\n <Emotion>HAPPY</Emotion>\\n <Gender>FEMALE</Gender>\\n <Age>29</Age>\\n</Faces>\\n<Faces>\\n <EmotionDetails>\\n <CALM>0.2919808030128479</CALM>\\n <SCARED>0.0000014968593404773856</SCARED>\\n <HAPPY>0.7078456878662109</HAPPY>\\n <SURPRISED>0.00006672900053672493</SURPRISED>\\n <SAD>0.00001525594689155696</SAD>\\n <DISGUSTED>0.00003373104118509218</DISGUSTED>\\n <ANGRY>0.000012824941222788766</ANGRY>\\n </EmotionDetails>\\n <FaceAttributes>\\n <Beard>NONE</Beard>\\n <FaceBoundary>\\n <Left>95</Left>\\n <Top>191</Top>\\n <Height>252</Height>\\n <Width>269</Width>\\n </FaceBoundary>\\n <BeardConfidence>1</BeardConfidence>\\n <HeadPose>\\n <Pitch>18.38559913635254</Pitch>\\n <Roll>4.204077243804932</Roll>\\n <Yaw>2.49458646774292</Yaw>\\n </HeadPose>\\n <MaskConfidence>1</MaskConfidence>\\n <Mask>NONE</Mask>\\n <Glasses>NONE</Glasses>\\n <GlassesConfidence>1</GlassesConfidence>\\n </FaceAttributes>\\n</Faces>","errorExample":""}]', + 'extraInfo' => ' ', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DetectImageBodies' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/bodytest.jpg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8AE4DA72-07F7-4BBC-8ECD-CBE8877BAD06', + ], + 'Bodies' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BodyConfidence' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9966312050819397', + ], + 'BodyBoundary' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '65', + ], + 'Width' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '372', + ], + 'Height' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '560', + ], + 'Left' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '51', + ], + ], + ], + ], + ], + ], + 'ImageUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/bodytest.jpg', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8AE4DA72-07F7-4BBC-8ECD-CBE8877BAD06\\",\\n \\"Bodies\\": [\\n {\\n \\"BodyConfidence\\": 0.9966312050819397,\\n \\"BodyBoundary\\": {\\n \\"Top\\": 65,\\n \\"Width\\": 372,\\n \\"Height\\": 560,\\n \\"Left\\": 51\\n }\\n }\\n ],\\n \\"ImageUri\\": \\"oss://imm-test/testcases/bodytest.jpg\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>8AE4DA72-07F7-4BBC-8ECD-CBE8877BAD06</RequestId>\\n<Bodies>\\n <BodyConfidence>0.9966312050819397</BodyConfidence>\\n <BodyBoundary>\\n <Left>51</Left>\\n <Top>65</Top>\\n <Height>560</Height>\\n <Width>372</Width>\\n </BodyBoundary>\\n</Bodies>\\n<ImageUri>oss://imm-test/testcases/bodytest.jpg</ImageUri>","errorExample":""}]', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'EncodeBlindWatermark' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => 'immimagetest', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/watermarktestbefore.jpg', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'WatermarkUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => false, + 'example' => 'oss://imm-test/testcases/test.jpg', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'TargetUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/watermarktestafter.jpg', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'ImageQuality', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '90', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'TargetImageType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'jpg', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'Model', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'DWT_IBG', + 'required' => false, + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'example' => '8E0DD64B-28C6-4653-8FF7-93E4C234BCF0', + 'type' => 'string', + ], + 'Content' => [ + 'description' => '', + 'example' => '', + 'type' => 'string', + ], + 'TargetUri' => [ + 'description' => '', + 'example' => 'oss://imm-test/testcases/watermarktestafter.jpg', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8E0DD64B-28C6-4653-8FF7-93E4C234BCF0\\",\\n \\"Content\\": \\"阿里云版权所有\\",\\n \\"TargetUri\\": \\"oss://imm-test/testcases/watermarktestafter.jpg\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>8E0DD64B-28C6-4653-8FF7-93E4C234BCF0</RequestId>\\n<Content>阿里云版权所有</Content>\\n<TargetUri>oss://imm-test/testcases/watermarktestafter.jpg</TargetUri>","errorExample":""}]', + 'extraInfo' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DecodeBlindWatermark' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/watermarktestafter.jpg', + ], + ], + [ + 'name' => 'OriginalImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/watermarktestbefore.jpg', + ], + ], + [ + 'name' => 'TargetUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/decodewatermarktest.jpg', + ], + ], + [ + 'name' => 'ImageQuality', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'example' => '90', + ], + ], + [ + 'name' => 'Model', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'DWT_IBG', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3B2ED30A-5C90-40D7-903B-8C31C7DBA3C6', + ], + 'TargetUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/decodewatermarktest.jpg', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3B2ED30A-5C90-40D7-903B-8C31C7DBA3C6\\",\\n \\"TargetUri\\": \\"oss://imm-test/testcases/decodewatermarktest.jpg\\"\\n}","errorExample":""},{"type":"xml","example":"\\n<RequestId>3B2ED30A-5C90-40D7-903B-8C31C7DBA3C6</RequestId>\\n<TargetUri>oss://imm-test/testcases/decodewatermarktest.jpg</TargetUri>\\n","errorExample":""}]', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetMediaMeta' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immvideotest', + ], + ], + [ + 'name' => 'MediaUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'MediaUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2213B1A9-EB3D-4666-84E0-24980BCC4649', + ], + 'MediaMeta' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MediaFormat' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-10-25T09:16:09.000000Z', + ], + 'NumberPrograms' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'NumberStreams' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Tag' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-10-25T09:16:09.000000Z', + ], + 'Album' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'unable', + ], + 'AlbumArtist' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'unable', + ], + 'Performer' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'unable', + ], + 'Composer' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'unable', + ], + 'Artist' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'unable', + ], + 'Title' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'unable', + ], + 'Language' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'unable', + ], + ], + ], + 'Bitrate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '13164131', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0.000000', + ], + 'Size' => [ + 'description' => '', + 'type' => 'string', + 'example' => '25115517', + ], + 'Address' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Township' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'District' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'AddressLine' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Country' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'City' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Province' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + 'FormatLongName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'QuickTime / MOV', + ], + 'Duration' => [ + 'description' => '', + 'type' => 'string', + 'example' => '15.263000', + ], + 'FormatName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mov,mp4,m4a,3gp,3g2,mj2', + ], + 'Location' => [ + 'description' => '', + 'type' => 'string', + 'example' => '30.134390,120.074997', + ], + ], + ], + 'MediaStreams' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'VideoStreams' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CodecLongName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', + ], + 'Height' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1920', + ], + 'SampleAspectRatio' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1:1', + ], + 'AverageFrameRate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '41580000/1373627', + ], + 'Bitrate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '13091201', + ], + 'Rotate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '90', + ], + 'CodecTagString' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'avc1', + ], + 'Language' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'eng', + ], + 'HasBFrames' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'FrameRrate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '90000/1', + ], + 'Profile' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Baseline', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0.000000', + ], + 'Frames' => [ + 'description' => '', + 'type' => 'string', + 'example' => '462', + ], + 'CodecName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'h264', + ], + 'Width' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1080', + ], + 'Duration' => [ + 'description' => '', + 'type' => 'string', + 'example' => '15.262522', + ], + 'DisplayAspectRatio' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9:16', + ], + 'CodecTag' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0x31637661', + ], + 'CodecTimeBase' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1373627/83160000', + ], + 'TimeBase' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1/90000', + ], + 'Level' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'PixelFormat' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'yuv420p', + ], + ], + ], + ], + 'AudioStreams' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SampleRate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '44100', + ], + 'ChannelLayout' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mono', + ], + 'CodecLongName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'AAC (Advanced Audio Coding)', + ], + 'Channels' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Bitrate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '64003', + ], + 'CodecTagString' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mp4a', + ], + 'Language' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'eng', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0.000000', + ], + 'SampleFormat' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'fltp', + ], + 'Frames' => [ + 'description' => '', + 'type' => 'string', + 'example' => '656', + ], + 'CodecName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'aac', + ], + 'Duration' => [ + 'description' => '', + 'type' => 'string', + 'example' => '15.256803', + ], + 'CodecTag' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0x6134706d', + ], + 'CodecTimeBase' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1/44100', + ], + 'TimeBase' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1/44100', + ], + ], + ], + ], + 'SubtitleStreams' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Language' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'eng', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"MediaUri\\": \\"oss://imm-test/testcases/video.mp4\\",\\n \\"RequestId\\": \\"2213B1A9-EB3D-4666-84E0-24980BCC4649\\",\\n \\"MediaMeta\\": {\\n \\"MediaFormat\\": {\\n \\"CreationTime\\": \\"2020-10-25T09:16:09.000000Z\\",\\n \\"NumberPrograms\\": 2,\\n \\"NumberStreams\\": 2,\\n \\"Tag\\": {\\n \\"CreationTime\\": \\"2020-10-25T09:16:09.000000Z\\",\\n \\"Album\\": \\"unable\\",\\n \\"AlbumArtist\\": \\"unable\\",\\n \\"Performer\\": \\"unable\\",\\n \\"Composer\\": \\"unable\\",\\n \\"Artist\\": \\"unable\\",\\n \\"Title\\": \\"unable\\",\\n \\"Language\\": \\"unable\\"\\n },\\n \\"Bitrate\\": \\"13164131\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"Size\\": \\"25115517\\",\\n \\"Address\\": {\\n \\"Township\\": \\"转塘街道\\",\\n \\"District\\": \\"西湖区\\",\\n \\"AddressLine\\": \\"中国浙江省杭州市西湖区转塘街道石龙山西路\\",\\n \\"Country\\": \\"中国\\",\\n \\"City\\": \\"杭州市\\",\\n \\"Province\\": \\"浙江省\\"\\n },\\n \\"FormatLongName\\": \\"QuickTime / MOV\\",\\n \\"Duration\\": \\"15.263000\\",\\n \\"FormatName\\": \\"mov,mp4,m4a,3gp,3g2,mj2\\",\\n \\"Location\\": \\"30.134390,120.074997\\"\\n },\\n \\"MediaStreams\\": {\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Height\\": 1920,\\n \\"SampleAspectRatio\\": \\"1:1\\",\\n \\"AverageFrameRate\\": \\"41580000/1373627\\",\\n \\"Bitrate\\": \\"13091201\\",\\n \\"Rotate\\": \\"90\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"Language\\": \\"eng\\",\\n \\"HasBFrames\\": 2,\\n \\"FrameRrate\\": \\"90000/1\\",\\n \\"Profile\\": \\"Baseline\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"Frames\\": \\"462\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"Width\\": 1080,\\n \\"Duration\\": \\"15.262522\\",\\n \\"DisplayAspectRatio\\": \\"9:16\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"CodecTimeBase\\": \\"1373627/83160000\\",\\n \\"TimeBase\\": \\"1/90000\\",\\n \\"Level\\": 40,\\n \\"PixelFormat\\": \\"yuv420p\\"\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 1,\\n \\"SampleRate\\": \\"44100\\",\\n \\"ChannelLayout\\": \\"mono\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"Channels\\": 1,\\n \\"Bitrate\\": \\"64003\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"Language\\": \\"eng\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"SampleFormat\\": \\"fltp\\",\\n \\"Frames\\": \\"656\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"Duration\\": \\"15.256803\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"TimeBase\\": \\"1/44100\\"\\n }\\n ],\\n \\"SubtitleStreams\\": [\\n {\\n \\"Index\\": 2,\\n \\"Language\\": \\"eng\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<MediaUri>oss://imm-test/testcases/video.mp4</MediaUri>\\n<RequestId>2213B1A9-EB3D-4666-84E0-24980BCC4649</RequestId>\\n<MediaMeta>\\n <MediaFormat>\\n <Address>\\n <Township>转塘街道</Township>\\n <AddressLine>中国浙江省杭州市西湖区转塘街道石龙山西路</AddressLine>\\n <Country>中国</Country>\\n <City>杭州市</City>\\n <District>西湖区</District>\\n <Province>浙江省</Province>\\n </Address>\\n <Size>25115517</Size>\\n <NumberStreams>2</NumberStreams>\\n <FormatLongName>QuickTime / MOV</FormatLongName>\\n <CreationTime>2020-10-25T09:16:09.000000Z</CreationTime>\\n <StartTime>0</StartTime>\\n <FormatName>mov,mp4,m4a,3gp,3g2,mj2</FormatName>\\n <Duration>15.263</Duration>\\n <Bitrate>13164131</Bitrate>\\n <Location>30.134390,120.074997</Location>\\n <NumberPrograms/>\\n </MediaFormat>\\n <MediaStreams>\\n <VideoStreams>\\n <CodecTag>0x31637661</CodecTag>\\n <Frames>462</Frames>\\n <CodecTimeBase>1373627/83160000</CodecTimeBase>\\n <Rotate>90</Rotate>\\n <SampleAspectRatio>1:1</SampleAspectRatio>\\n <StartTime>0</StartTime>\\n <Duration>15.262522</Duration>\\n <Index>0</Index>\\n <Bitrate>13091201</Bitrate>\\n <CodecName>h264</CodecName>\\n <Profile>Baseline</Profile>\\n <DisplayAspectRatio>9:16</DisplayAspectRatio>\\n <HasBFrames>2</HasBFrames>\\n <CodecTagString>avc1</CodecTagString>\\n <AverageFrameRate>41580000/1373627</AverageFrameRate>\\n <Language>eng</Language>\\n <CodecLongName>H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10</CodecLongName>\\n <Level>40</Level>\\n <PixelFormat>yuv420p</PixelFormat>\\n <Height>1920</Height>\\n <FrameRrate>90000/1</FrameRrate>\\n <Width>1080</Width>\\n <TimeBase>1/90000</TimeBase>\\n </VideoStreams>\\n <SubtitleStreams>\\n <Language>eng</Language>\\n <Index>2</Index>\\n </SubtitleStreams>\\n <AudioStreams>\\n <CodecTag>0x31637661</CodecTag>\\n <Frames>656</Frames>\\n <CodecTimeBase>1/44100</CodecTimeBase>\\n <ChannelLayout>mono</ChannelLayout>\\n <StartTime>0</StartTime>\\n <Duration>15.256803</Duration>\\n <Index>1</Index>\\n <Bitrate>64003</Bitrate>\\n <CodecName>aac</CodecName>\\n <Channels>1</Channels>\\n <SampleFormat>fltp</SampleFormat>\\n <CodecTagString>mp4a</CodecTagString>\\n <SampleRate>44100</SampleRate>\\n <Language>eng</Language>\\n <CodecLongName>AAC (Advanced Audio Coding)</CodecLongName>\\n <TimeBase>1/44100</TimeBase>\\n </AudioStreams>\\n </MediaStreams>\\n</MediaMeta>","errorExample":""}]', + 'title' => 'GetMediaMeta', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'IndexVideo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immvideotest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'videotest', + ], + ], + [ + 'name' => 'VideoUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + ], + [ + 'name' => 'RemarksA', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'AdminGroup/AdminUserA/', + ], + ], + [ + 'name' => 'RemarksB', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'nas://path/to/file', + ], + ], + [ + 'name' => 'TgtUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://imm-test/testcases', + ], + ], + [ + 'name' => 'RemarksC', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'remarkc', + ], + ], + [ + 'name' => 'RemarksD', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'remarkd', + ], + ], + [ + 'name' => 'ExternalId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'externalId001', + ], + ], + [ + 'name' => 'NotifyTopicName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'topic2', + ], + ], + [ + 'name' => 'NotifyEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-01-21T07:40:41.683Z', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '896ABAD1-C452-4BED-B5E0-302955F8BAB5', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-01-21T07:40:41.683Z', + ], + 'ExternalId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'externalId001', + ], + 'VideoUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + 'RemarksA' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'AdminGroup/AdminUserA/', + ], + 'RemarksB' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'nas://path/to/file', + ], + 'RemarksC' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'remarkc', + ], + 'RemarksD' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'remarkd', + ], + 'SetId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'videoset', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ModifyTime\\": \\"2021-01-21T07:40:41.683Z\\",\\n \\"RequestId\\": \\"896ABAD1-C452-4BED-B5E0-302955F8BAB5\\",\\n \\"CreateTime\\": \\"2021-01-21T07:40:41.683Z\\",\\n \\"ExternalId\\": \\"externalId001\\",\\n \\"VideoUri\\": \\"oss://imm-test/testcases/video.mp4\\",\\n \\"RemarksA\\": \\"AdminGroup/AdminUserA/\\",\\n \\"RemarksB\\": \\"nas://path/to/file\\",\\n \\"RemarksC\\": \\"remarkc\\",\\n \\"RemarksD\\": \\"remarkd\\",\\n \\"SetId\\": \\"videoset\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyTime>2021-01-21T07:40:41.683Z</ModifyTime>\\n<RemarksC>remarkc</RemarksC>\\n<RemarksD>remarkd</RemarksD>\\n<RequestId>896ABAD1-C452-4BED-B5E0-302955F8BAB5</RequestId>\\n<ExternalId>externalId001</ExternalId>\\n<CreateTime>2021-01-21T07:40:41.683Z</CreateTime>\\n<VideoUri>oss://imm-test/testcases/video.mp4</VideoUri>\\n<RemarksA>AdminGroup/AdminUserA/</RemarksA>\\n<SetId>videoset</SetId>\\n<RemarksB>nas://path/to/file</RemarksB>","errorExample":""}]', + 'title' => 'IndexVideo', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListVideos' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immvideotest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'videotest', + ], + ], + [ + 'name' => 'CreateTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2021-01-21T06:40:41.683Z', + ], + ], + [ + 'name' => 'Marker', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CAESEgoQCg4KCkNyZWF0ZVRpbWUQABgBItcBCgkAIUv1J88rSRYKyQEDxAAAADFTMzEzNzM0MzYzNDM5MzUzODM1MzczNjMwMzIzNzM0MzUzYTY5NmQ2ZDY5NmQ2MTY3NjUzYTczNjU3NDMwMzAzMTNhMzc2NTY1NjM2NTMyMzQzNjYyMzUzMjM3MzgzODMwMzA2MzM4NjE2NDM4NjQ2MzY2NjE2MTMxNjMzNDMxNjY2MTY0MzEzODM0NjMzOTMzNjQ2MTM2MzUzMjY2NjYzMjMzNjUzNzM1NjUzNzM3MzM2MTY0MzEzMTM2MzYzMTM4Mzk=', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'B1469D0A-862A-405E-B81B-37760516627D', + ], + 'NextMarker' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CAESEgoQCg4KCkNyZWF0ZVRpbWUQABgBItcBCgkAIUv1J88rSRYKyQEDxAAAADFTMzEzNzM0MzYzNDM5MzUzODM1MzczNjMwMzIzNzM0MzUzYTY5NmQ2ZDY5NmQ2MTY3NjUzYTczNjU3NDMwMzAzMTNhMzc2NTY1NjM2NTMyMzQzNjYyMzUzMjM3MzgzODMwMzA2MzM4NjE2NDM4NjQ2MzY2NjE2MTMxNjMzNDMxNjY2MTY0MzEzODM0NjMzOTMzNjQ2MTM2MzUzMjY2NjYzMjMzNjUzNzM1NjUzNzM3MzM2MTY0MzEzMTM2MzYzMTM4Mzk=', + ], + 'SetId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'videoset', + ], + 'Videos' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-01-21T07:40:41.683Z', + ], + 'RemarksC' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'remarkc', + ], + 'VideoTagsFailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'SourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'video', + ], + 'VideoDuration' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '15.263', + ], + 'VideoTags' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'TagConfidence' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8933850526809692', + ], + 'TagLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ParentTagName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'ProcessModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-01-21T07:40:53.955Z', + ], + 'VideoFrames' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '462', + ], + 'VideoTagsStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'ExternalId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'externalId001', + ], + 'SourceUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + 'FileSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '25115517', + ], + 'ModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-01-21T07:40:41.683Z', + ], + 'SourcePosition' => [ + 'description' => '', + 'type' => 'string', + 'example' => '00000000.010', + ], + 'VideoWidth' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1080', + ], + 'VideoFormat' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mov,mp4,m4a,3gp,3g2,mj2', + ], + 'VideoHeight' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1920', + ], + 'RemarksD' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'remarkd', + ], + 'VideoUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + 'ProcessFailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'VideoTagsModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-01-21T07:40:53.95Z', + ], + 'RemarksA' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'AdminGroup/AdminUserA/', + ], + 'ProcessStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'RemarksB' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'nas://path/to/file', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B1469D0A-862A-405E-B81B-37760516627D\\",\\n \\"NextMarker\\": \\"CAESEgoQCg4KCkNyZWF0ZVRpbWUQABgBItcBCgkAIUv1J88rSRYKyQEDxAAAADFTMzEzNzM0MzYzNDM5MzUzODM1MzczNjMwMzIzNzM0MzUzYTY5NmQ2ZDY5NmQ2MTY3NjUzYTczNjU3NDMwMzAzMTNhMzc2NTY1NjM2NTMyMzQzNjYyMzUzMjM3MzgzODMwMzA2MzM4NjE2NDM4NjQ2MzY2NjE2MTMxNjMzNDMxNjY2MTY0MzEzODM0NjMzOTMzNjQ2MTM2MzUzMjY2NjYzMjMzNjUzNzM1NjUzNzM3MzM2MTY0MzEzMTM2MzYzMTM4Mzk=\\",\\n \\"SetId\\": \\"videoset\\",\\n \\"Videos\\": [\\n {\\n \\"CreateTime\\": \\"2021-01-21T07:40:41.683Z\\",\\n \\"RemarksC\\": \\"remarkc\\",\\n \\"VideoTagsFailReason\\": \\"Timeout\\",\\n \\"SourceType\\": \\"video\\",\\n \\"VideoDuration\\": 15.263,\\n \\"VideoTags\\": [\\n {\\n \\"TagName\\": \\"大型超市\\",\\n \\"TagConfidence\\": 0.8933850526809692,\\n \\"TagLevel\\": 2,\\n \\"ParentTagName\\": \\"内部场景\\"\\n }\\n ],\\n \\"ProcessModifyTime\\": \\"2021-01-21T07:40:53.955Z\\",\\n \\"VideoFrames\\": 462,\\n \\"VideoTagsStatus\\": \\"Success\\",\\n \\"ExternalId\\": \\"externalId001\\",\\n \\"SourceUri\\": \\"oss://imm-test/testcases/video.mp4\\",\\n \\"FileSize\\": 25115517,\\n \\"ModifyTime\\": \\"2021-01-21T07:40:41.683Z\\",\\n \\"SourcePosition\\": \\"00000000.010\\",\\n \\"VideoWidth\\": 1080,\\n \\"VideoFormat\\": \\"mov,mp4,m4a,3gp,3g2,mj2\\",\\n \\"VideoHeight\\": 1920,\\n \\"RemarksD\\": \\"remarkd\\",\\n \\"VideoUri\\": \\"oss://imm-test/testcases/video.mp4\\",\\n \\"ProcessFailReason\\": \\"Timeout\\",\\n \\"VideoTagsModifyTime\\": \\"2021-01-21T07:40:53.95Z\\",\\n \\"RemarksA\\": \\"AdminGroup/AdminUserA/\\",\\n \\"ProcessStatus\\": \\"Success\\",\\n \\"RemarksB\\": \\"nas://path/to/file\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>B1469D0A-862A-405E-B81B-37760516627D</RequestId>\\n<NextMarker/>\\n<SetId>videoset</SetId>\\n<Videos>\\n <ModifyTime>2021-01-21T07:40:41.683Z</ModifyTime>\\n <ProcessStatus>Success</ProcessStatus>\\n <VideoWidth>1080</VideoWidth>\\n <SourceUri>oss://imm-test/testcases/video.mp4</SourceUri>\\n <SourceType>video</SourceType>\\n <RemarksA>AdminGroup/AdminUserA/</RemarksA>\\n <RemarksB>nas://path/to/file</RemarksB>\\n <RemarksC>remarkc</RemarksC>\\n <RemarksD>remarkd</RemarksD>\\n <VideoHeight>1920</VideoHeight>\\n <VideoTagsFailReason>Timeout</VideoTagsFailReason>\\n <VideoTagsModifyTime>2021-01-21T07:40:53.95Z</VideoTagsModifyTime>\\n <VideoFrames>462</VideoFrames>\\n <ProcessModifyTime>2021-01-21T07:40:53.955Z</ProcessModifyTime>\\n <ProcessFailReason>Timeout</ProcessFailReason>\\n <ExternalId>externalId001</ExternalId>\\n <CreateTime>2021-01-21T07:40:41.683Z</CreateTime>\\n <VideoUri>oss://imm-test/testcases/video.mp4</VideoUri>\\n <VideoFormat>mov,mp4,m4a,3gp,3g2,mj2</VideoFormat>\\n <VideoDuration>15.263</VideoDuration>\\n <VideoTagsStatus>Success</VideoTagsStatus>\\n <FileSize>25115517</FileSize>\\n <VideoTags>\\n <TagName>内部场景</TagName>\\n <TagConfidence>0.9230213165283203</TagConfidence>\\n <TagLevel>1</TagLevel>\\n </VideoTags>\\n <VideoTags>\\n <TagName>大型超市</TagName>\\n <TagConfidence>0.8933850526809692</TagConfidence>\\n <TagLevel>2</TagLevel>\\n <ParentTagName>内部场景</ParentTagName>\\n </VideoTags>\\n</Videos>","errorExample":""}]', + 'title' => 'ListVideos', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetVideo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immvideotest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'videoset', + ], + ], + [ + 'name' => 'VideoUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-01-21T07:40:41.683Z', + ], + 'ProcessStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'VideoWidth' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1080', + ], + 'SourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'video', + ], + 'SourceUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + 'VideoInfo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{"MediaStreams":{"VideoStreams":[{"Index":0,"Language":"eng","CodecName":"h264","CodecLongName":"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10","Profile":"Baseline","CodecTimeBase":"1373627/83160000","CodecTagString":"avc1","CodecTag":"0x31637661","Width":1080,"Height":1920,"SampleAspectRatio":"1:1","DisplayAspectRatio":"9:16","PixelFormat":"yuv420p","Level":40,"FrameRrate":"90000/1","AverageFrameRate":"41580000/1373627","TimeBase":"1/90000","StartTime":"0.000000","Duration":"15.262522","Bitrate":"13091201","Frames":"462"}],"AudioStreams":[],"SubtitleStreams":[]},"MediaFormat":{"NumberStreams":2,"FormatName":"mov,mp4,m4a,3gp,3g2,mj2","FormatLongName":"QuickTime / MOV","Size":"25115517","Duration":"15.263000","StartTime":"0.000000","Bitrate":"13164131","CreationTime":"2020-10-25T09:16:09.000000Z","Address":{},"Tag":{}}}', + ], + 'VideoFrameTagsModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1970-01-01T00:00:00Z', + ], + 'RemarksA' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'AdminGroup/AdminUserA/', + ], + 'VideoFacesFailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'RemarksB' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'nas://path/to/file', + ], + 'VideoFacesStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'RemarksC' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'remarkc', + ], + 'VideoOCRModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1970-01-01T00:00:00Z', + ], + 'RemarksD' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'remarkd', + ], + 'VideoHeight' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1920', + ], + 'SourcePosition' => [ + 'description' => '', + 'type' => 'string', + 'example' => '00000000.010', + ], + 'VideoOCRFailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'VideoFrameTagsStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'VideoTagsFailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'VideoTagsModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-01-21T07:40:53.95Z', + ], + 'VideoOCRStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'VideoFrames' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '462', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '5FC2B195-B43E-45ED-9BEC-169358550193', + ], + 'ProcessModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-01-21T07:40:53.955Z', + ], + 'VideoSTTModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-01-21T07:40:53.95Z', + ], + 'ProcessFailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-01-21T07:40:41.683Z', + ], + 'ExternalId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'externalId001', + ], + 'VideoSTTFailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'VideoUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + 'VideoFrameTagsFailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'VideoFormat' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mov,mp4,m4a,3gp,3g2,mj2', + ], + 'VideoSTTStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'VideoFacesModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1970-01-01T00:00:00Z', + ], + 'VideoTags' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'TagConfidence' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8933850526809692', + ], + 'TagLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ParentTagName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'VideoDuration' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '15.263', + ], + 'SetId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'videoset', + ], + 'VideoTagsStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'FileSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '25115517', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ModifyTime\\": \\"2021-01-21T07:40:41.683Z\\",\\n \\"ProcessStatus\\": \\"Success\\",\\n \\"VideoWidth\\": 1080,\\n \\"SourceType\\": \\"video\\",\\n \\"SourceUri\\": \\"oss://imm-test/testcases/video.mp4\\",\\n \\"VideoInfo\\": \\"{\\\\\\"MediaStreams\\\\\\":{\\\\\\"VideoStreams\\\\\\":[{\\\\\\"Index\\\\\\":0,\\\\\\"Language\\\\\\":\\\\\\"eng\\\\\\",\\\\\\"CodecName\\\\\\":\\\\\\"h264\\\\\\",\\\\\\"CodecLongName\\\\\\":\\\\\\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\\\\\",\\\\\\"Profile\\\\\\":\\\\\\"Baseline\\\\\\",\\\\\\"CodecTimeBase\\\\\\":\\\\\\"1373627/83160000\\\\\\",\\\\\\"CodecTagString\\\\\\":\\\\\\"avc1\\\\\\",\\\\\\"CodecTag\\\\\\":\\\\\\"0x31637661\\\\\\",\\\\\\"Width\\\\\\":1080,\\\\\\"Height\\\\\\":1920,\\\\\\"SampleAspectRatio\\\\\\":\\\\\\"1:1\\\\\\",\\\\\\"DisplayAspectRatio\\\\\\":\\\\\\"9:16\\\\\\",\\\\\\"PixelFormat\\\\\\":\\\\\\"yuv420p\\\\\\",\\\\\\"Level\\\\\\":40,\\\\\\"FrameRrate\\\\\\":\\\\\\"90000/1\\\\\\",\\\\\\"AverageFrameRate\\\\\\":\\\\\\"41580000/1373627\\\\\\",\\\\\\"TimeBase\\\\\\":\\\\\\"1/90000\\\\\\",\\\\\\"StartTime\\\\\\":\\\\\\"0.000000\\\\\\",\\\\\\"Duration\\\\\\":\\\\\\"15.262522\\\\\\",\\\\\\"Bitrate\\\\\\":\\\\\\"13091201\\\\\\",\\\\\\"Frames\\\\\\":\\\\\\"462\\\\\\"}],\\\\\\"AudioStreams\\\\\\":[],\\\\\\"SubtitleStreams\\\\\\":[]},\\\\\\"MediaFormat\\\\\\":{\\\\\\"NumberStreams\\\\\\":2,\\\\\\"FormatName\\\\\\":\\\\\\"mov,mp4,m4a,3gp,3g2,mj2\\\\\\",\\\\\\"FormatLongName\\\\\\":\\\\\\"QuickTime / MOV\\\\\\",\\\\\\"Size\\\\\\":\\\\\\"25115517\\\\\\",\\\\\\"Duration\\\\\\":\\\\\\"15.263000\\\\\\",\\\\\\"StartTime\\\\\\":\\\\\\"0.000000\\\\\\",\\\\\\"Bitrate\\\\\\":\\\\\\"13164131\\\\\\",\\\\\\"CreationTime\\\\\\":\\\\\\"2020-10-25T09:16:09.000000Z\\\\\\",\\\\\\"Address\\\\\\":{},\\\\\\"Tag\\\\\\":{}}}\\",\\n \\"VideoFrameTagsModifyTime\\": \\"1970-01-01T00:00:00Z\\",\\n \\"RemarksA\\": \\"AdminGroup/AdminUserA/\\",\\n \\"VideoFacesFailReason\\": \\"Timeout\\",\\n \\"RemarksB\\": \\"nas://path/to/file\\",\\n \\"VideoFacesStatus\\": \\"Success\\",\\n \\"RemarksC\\": \\"remarkc\\",\\n \\"VideoOCRModifyTime\\": \\"1970-01-01T00:00:00Z\\",\\n \\"RemarksD\\": \\"remarkd\\",\\n \\"VideoHeight\\": 1920,\\n \\"SourcePosition\\": \\"00000000.010\\",\\n \\"VideoOCRFailReason\\": \\"Timeout\\",\\n \\"VideoFrameTagsStatus\\": \\"Success\\",\\n \\"VideoTagsFailReason\\": \\"Timeout\\",\\n \\"VideoTagsModifyTime\\": \\"2021-01-21T07:40:53.95Z\\",\\n \\"VideoOCRStatus\\": \\"Success\\",\\n \\"VideoFrames\\": 462,\\n \\"RequestId\\": \\"5FC2B195-B43E-45ED-9BEC-169358550193\\",\\n \\"ProcessModifyTime\\": \\"2021-01-21T07:40:53.955Z\\",\\n \\"VideoSTTModifyTime\\": \\"2021-01-21T07:40:53.95Z\\",\\n \\"ProcessFailReason\\": \\"Timeout\\",\\n \\"CreateTime\\": \\"2021-01-21T07:40:41.683Z\\",\\n \\"ExternalId\\": \\"externalId001\\",\\n \\"VideoSTTFailReason\\": \\"Timeout\\",\\n \\"VideoUri\\": \\"oss://imm-test/testcases/video.mp4\\",\\n \\"VideoFrameTagsFailReason\\": \\"Timeout\\",\\n \\"VideoFormat\\": \\"mov,mp4,m4a,3gp,3g2,mj2\\",\\n \\"VideoSTTStatus\\": \\"Success\\",\\n \\"VideoFacesModifyTime\\": \\"1970-01-01T00:00:00Z\\",\\n \\"VideoTags\\": [\\n {\\n \\"TagName\\": \\"大型超市\\",\\n \\"TagConfidence\\": 0.8933850526809692,\\n \\"TagLevel\\": 2,\\n \\"ParentTagName\\": \\"内部场景\\"\\n }\\n ],\\n \\"VideoDuration\\": 15.263,\\n \\"SetId\\": \\"videoset\\",\\n \\"VideoTagsStatus\\": \\"Success\\",\\n \\"FileSize\\": 25115517\\n}","errorExample":""},{"type":"xml","example":"<ModifyTime>2021-01-21T07:40:41.683Z</ModifyTime>\\n<ProcessStatus>Success</ProcessStatus>\\n<VideoWidth>1080</VideoWidth>\\n<SourceUri>oss://imm-test/testcases/video.mp4</SourceUri>\\n<SourceType>video</SourceType>\\n<VideoInfo>{\\"MediaStreams\\":{\\"VideoStreams\\":[{\\"Index\\":0,\\"Language\\":\\"eng\\",\\"CodecName\\":\\"h264\\",\\"CodecLongName\\":\\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\"Profile\\":\\"Baseline\\",\\"CodecTimeBase\\":\\"1373627/83160000\\",\\"CodecTagString\\":\\"avc1\\",\\"CodecTag\\":\\"0x31637661\\",\\"Width\\":1080,\\"Height\\":1920,\\"SampleAspectRatio\\":\\"1:1\\",\\"DisplayAspectRatio\\":\\"9:16\\",\\"PixelFormat\\":\\"yuv420p\\",\\"Level\\":40,\\"FrameRrate\\":\\"90000/1\\",\\"AverageFrameRate\\":\\"41580000/1373627\\",\\"TimeBase\\":\\"1/90000\\",\\"StartTime\\":\\"0.000000\\",\\"Duration\\":\\"15.262522\\",\\"Bitrate\\":\\"13091201\\",\\"Frames\\":\\"462\\"}],\\"AudioStreams\\":[{\\"Index\\":1,\\"CodecName\\":\\"aac\\",\\"CodecLongName\\":\\"AAC (Advanced Audio Coding)\\",\\"CodecTimeBase\\":\\"1/44100\\",\\"CodecTagString\\":\\"mp4a\\",\\"CodecTag\\":\\"0x6134706d\\",\\"SampleFormat\\":\\"fltp\\",\\"SampleRate\\":\\"44100\\",\\"Channels\\":1,\\"ChannelLayout\\":\\"mono\\",\\"TimeBase\\":\\"1/44100\\",\\"StartTime\\":\\"0.000000\\",\\"Duration\\":\\"15.256803\\",\\"Bitrate\\":\\"64003\\",\\"Frames\\":\\"656\\",\\"Language\\":\\"eng\\"}],\\"SubtitleStreams\\":[]},\\"MediaFormat\\":{\\"NumberStreams\\":2,\\"FormatName\\":\\"mov,mp4,m4a,3gp,3g2,mj2\\",\\"FormatLongName\\":\\"QuickTime / MOV\\",\\"Size\\":\\"25115517\\",\\"Duration\\":\\"15.263000\\",\\"StartTime\\":\\"0.000000\\",\\"Bitrate\\":\\"13164131\\",\\"CreationTime\\":\\"2020-10-25T09:16:09.000000Z\\",\\"Address\\":{},\\"Tag\\":{\\"CreationTime\\":\\"2020-10-25T09:16:09.000000Z\\"}}}</VideoInfo>\\n<VideoFrameTagsModifyTime>1970-01-01T00:00:00Z</VideoFrameTagsModifyTime>\\n<RemarksA>AdminGroup/AdminUserA/</RemarksA>\\n<RemarksB>nas://path/to/file</RemarksB>\\n<VideoFacesStatus>Success</VideoFacesStatus>\\n<VideoOCRModifyTime>1970-01-01T00:00:00Z</VideoOCRModifyTime>\\n<RemarksC>remarkc</RemarksC>\\n<RemarksD>remarkd</RemarksD>\\n<VideoHeight>1920</VideoHeight>\\n<SourcePosition>0.01</SourcePosition>\\n<VideoFrameTagsStatus>Success</VideoFrameTagsStatus>\\n<VideoTagsModifyTime>2021-01-21T07:40:53.95Z</VideoTagsModifyTime>\\n<VideoOCRStatus>Success</VideoOCRStatus>\\n<VideoFrames>462</VideoFrames>\\n<RequestId>5FC2B195-B43E-45ED-9BEC-169358550193</RequestId>\\n<VideoSTTModifyTime>2021-01-21T07:40:53.95Z</VideoSTTModifyTime>\\n<ProcessModifyTime>2021-01-21T07:40:53.955Z</ProcessModifyTime>\\n<ExternalId>externalId001</ExternalId>\\n<CreateTime>2021-01-21T07:40:41.683Z</CreateTime>\\n<VideoUri>oss://imm-test/testcases/video.mp4</VideoUri>\\n<VideoFormat>mp4</VideoFormat>\\n<VideoSTTStatus>Success</VideoSTTStatus>\\n<VideoFacesModifyTime>1970-01-01T00:00:00Z</VideoFacesModifyTime>\\n<VideoTags>\\n <TagName>内部场景</TagName>\\n <TagConfidence>0.9230213165283203</TagConfidence>\\n <TagLevel>1</TagLevel>\\n</VideoTags>\\n<VideoTags>\\n <TagName>大型超市</TagName>\\n <TagConfidence>0.8933850526809692</TagConfidence>\\n <TagLevel>2</TagLevel>\\n <ParentTagName>内部场景</ParentTagName>\\n</VideoTags>\\n<VideoDuration>15.263</VideoDuration>\\n<SetId>videoset</SetId>\\n<VideoTagsStatus>Success</VideoTagsStatus>\\n<FileSize>25115517</FileSize>","errorExample":""}]', + 'title' => 'GetVideo', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteVideo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immvideotest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'videoset', + ], + ], + [ + 'name' => 'VideoUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + ], + [ + 'name' => 'Resources', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => true, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '7A740EB3-23C6-4002-98D8-F4183328D40C', + ], + 'VideoUri' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + 'SetId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'videoset', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7A740EB3-23C6-4002-98D8-F4183328D40C\\",\\n \\"VideoUri\\": \\"oss://imm-test/testcases/video.mp4\\",\\n \\"SetId\\": \\"videoset\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteVideoResponse>\\n <RequestId>7A740EB3-23C6-4002-98D8-F4183328D40C</RequestId>\\n <VideoUri>oss://imm-test/testcases/video.mp4</VideoUri>\\n <SetId>videoset</SetId>\\n</DeleteVideoResponse>","errorExample":""}]', + 'title' => 'DeleteVideo', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetVideoTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immvideotest', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'VideoAnalyseTask', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'VideoAnalyseTask-c091c3f5-e6a5-46ce-a0f2-454bd779', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Finished', + ], + 'Progress' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'NotifyEndpoint' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + ], + 'Parameters' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{"EndTime":"","GrabType":"time","Interval":"1","RequestId":"B8982C37-E03A-47CD-A715-D83D128D9FEB","SrcUri":"oss://imm-test/testcases/video.mp4","StartTime":"","TaskType":"VideoAnalyseTask","TgtUri":"oss://imm-test/testcases"}', + ], + 'TaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'VideoAnalyseTask-c091c3f5-e6a5-46ce-a0f2-454bd779', + ], + 'EndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-01-28T03:24:25.915048Z', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'C7593402-F428-47B1-80B2-F94B6859F119', + ], + 'TaskType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'VideoAnalyseTask', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-01-28T03:24:23.726372Z', + ], + 'NotifyTopicName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'topic1', + ], + 'ErrorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Invalid Argument:VideoUri', + ], + 'Result' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{"Key":"{\\"TgtUri\\":\\"oss://imm-test/testcases\\",\\"ImgsUri\\":\\"oss://imm-test/testcases/imgs\\",\\"AudioUri\\":\\"oss://imm-test/testcases/audio\\",\\"ProcessLength\\":\\"10\\",\\"ResultUri\\":\\"oss://imm-test/testcases/result/result.txt\\"}"}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Finished\\",\\n \\"Progress\\": 100,\\n \\"NotifyEndpoint\\": \\"http://1111111111.mns.cn-hangzhou.aliyuncs.com\\",\\n \\"Parameters\\": \\"{\\\\n \\\\\\"EndTime\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"GrabType\\\\\\": \\\\\\"time\\\\\\",\\\\n \\\\\\"Interval\\\\\\": \\\\\\"1\\\\\\",\\\\n \\\\\\"RequestId\\\\\\": \\\\\\"B8982C37-E03A-47CD-A715-D83D128D9FEB\\\\\\",\\\\n \\\\\\"SrcUri\\\\\\": \\\\\\"oss://imm-test/testcases/video.mp4\\\\\\",\\\\n \\\\\\"StartTime\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"TaskType\\\\\\": \\\\\\"CompressVideoTask\\\\\\",\\\\n \\\\\\"TgtUri\\\\\\": \\\\\\"oss://imm-test/testcases\\\\\\"\\\\n}\\",\\n \\"TaskId\\": \\"CompressVideoTask-c091c3f5-e6a5-46ce-a0f2-454bd779\\",\\n \\"EndTime\\": \\"2021-01-28T03:24:25.915048Z\\",\\n \\"RequestId\\": \\"C7593402-F428-47B1-80B2-F94B6859F119\\",\\n \\"TaskType\\": \\"CompressVideoTask\\",\\n \\"StartTime\\": \\"2021-01-28T03:24:23.726372Z\\",\\n \\"NotifyTopicName\\": \\"topic1\\",\\n \\"ErrorMessage\\": \\"Invalid Argument:VideoUri\\",\\n \\"Result\\": \\"{\\\\\\"Key\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"TgtUri\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss://imm-test/testcases\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ImgsUri\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss://imm-test/testcases/imgs\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AudioUri\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss://imm-test/testcases/audio\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ProcessLength\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"10\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ResultUri\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss://imm-test/testcases/result/result.txt\\\\\\\\\\\\\\"}\\\\\\"}\\"\\n}","errorExample":""},{"type":"xml","example":"<Status>Finished</Status>\\n<Progress>100</Progress>\\n<Parameters>{\\"EndTime\\":\\"\\",\\"GrabType\\":\\"time\\",\\"Interval\\":\\"1\\",\\"RequestId\\":\\"B8982C37-E03A-47CD-A715-D83D128D9FEB\\",\\"SrcUri\\":\\"oss://imm-test/testcases/video.mp4\\",\\"StartTime\\":\\"\\",\\"TaskType\\":\\"VideoAnalyseTask\\",\\"TgtUri\\":\\"oss://imm-test/testcases\\"}</Parameters>\\n<TaskId>VideoAnalyseTask-c091c3f5-e6a5-46ce-a0f2-454bd779</TaskId>\\n<EndTime>2021-01-28T03:24:25.915048Z</EndTime>\\n<RequestId>C7593402-F428-47B1-80B2-F94B6859F119</RequestId>\\n<StartTime>2021-01-28T03:24:23.726372Z</StartTime>\\n<Result>{\\"Key\\":\\"{\\\\\\"TgtUri\\\\\\":\\\\\\"oss://imm-test/testcases\\\\\\",\\\\\\"ImgsUri\\\\\\":\\\\\\"oss://imm-test/testcases/imgs\\\\\\",\\\\\\"AudioUri\\\\\\":\\\\\\"oss://imm-test/testcases/audio\\\\\\",\\\\\\"ProcessLength\\\\\\":\\\\\\"10\\\\\\",\\\\\\"ResultUri\\\\\\":\\\\\\"oss://imm-test/testcases/result/result.txt\\\\\\"}\\"}</Result>\\n<NotifyEndpoint>http://1111111111.mns.cn-hangzhou.aliyuncs.com</NotifyEndpoint>\\n<TaskType>VideoAnalyseTask</TaskType>\\n<NotifyTopicName>topic1</NotifyTopicName>\\n<ErrorMessage>Success</ErrorMessage>","errorExample":""}]', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListVideoTasks' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immvideotest', + ], + ], + [ + 'name' => 'Marker', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'VideoAnalyseTask-4b5c5b94-ba39-4008-9342-30abe341792b', + ], + ], + [ + 'name' => 'MaxKeys', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'VideoAnalyseTask', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Tasks' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-01-28T03:24:25.915048Z', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Finished', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-01-28T03:24:23.726372Z', + ], + 'TaskType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'VideoAnalyseTask', + ], + 'Progress' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'NotifyEndpoint' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + ], + 'ErrorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Invalid Argument:VideoUri', + ], + 'Parameters' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{"EndTime":"","GrabType":"time","Interval":"1","RequestId":"B8982C37-E03A-47CD-A715-D83D128D9FEB","SrcUri":"oss://imm-test/testcases/video.mp4","StartTime":"","TaskType":"VideoAnalyseTask","TgtUri":"oss://imm-test/testcases"}', + ], + 'Result' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{"Key":"{\\"TgtUri\\":\\"oss://imm-test/testcases\\",\\"ImgsUri\\":\\"oss://imm-test/testcases/imgs\\",\\"AudioUri\\":\\"oss://imm-test/testcases/audio\\",\\"ProcessLength\\":\\"10\\",\\"ResultUri\\":\\"oss://imm-test/testcases/result/result.txt\\"}"}', + ], + 'TaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'VideoAnalyseTask-8d7a4a32-f445-47fd-bdff-397a87651879', + ], + 'NotifyTopicName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'topic1', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'B70908A5-02B8-4CEC-A660-2A8A10ADE862', + ], + 'NextMarker' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'VideoAnalyseTask-4b5c5b94-ba39-4008-9342-30abe341792b', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Tasks\\": [\\n {\\n \\"EndTime\\": \\"2021-01-28T03:24:25.915048Z\\",\\n \\"Status\\": \\"Finished\\",\\n \\"StartTime\\": \\"2021-01-28T03:24:23.726372Z\\",\\n \\"TaskType\\": \\"VideoAnalyseTask\\",\\n \\"Progress\\": 100,\\n \\"NotifyEndpoint\\": \\"http://1111111111.mns.cn-hangzhou.aliyuncs.com\\",\\n \\"ErrorMessage\\": \\"Invalid Argument:VideoUri\\",\\n \\"Parameters\\": \\"{\\\\\\"EndTime\\\\\\":\\\\\\"\\\\\\",\\\\\\"GrabType\\\\\\":\\\\\\"time\\\\\\",\\\\\\"Interval\\\\\\":\\\\\\"1\\\\\\",\\\\\\"RequestId\\\\\\":\\\\\\"B8982C37-E03A-47CD-A715-D83D128D9FEB\\\\\\",\\\\\\"SrcUri\\\\\\":\\\\\\"oss://imm-test/testcases/video.mp4\\\\\\",\\\\\\"StartTime\\\\\\":\\\\\\"\\\\\\",\\\\\\"TaskType\\\\\\":\\\\\\"VideoAnalyseTask\\\\\\",\\\\\\"TgtUri\\\\\\":\\\\\\"oss://imm-test/testcases\\\\\\"}\\",\\n \\"Result\\": \\"{\\\\\\"Key\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"TgtUri\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss://imm-test/testcases\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ImgsUri\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss://imm-test/testcases/imgs\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AudioUri\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss://imm-test/testcases/audio\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ProcessLength\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"10\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ResultUri\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss://imm-test/testcases/result/result.txt\\\\\\\\\\\\\\"}\\\\\\"}\\",\\n \\"TaskId\\": \\"VideoAnalyseTask-8d7a4a32-f445-47fd-bdff-397a87651879\\",\\n \\"NotifyTopicName\\": \\"topic1\\"\\n }\\n ],\\n \\"RequestId\\": \\"B70908A5-02B8-4CEC-A660-2A8A10ADE862\\",\\n \\"NextMarker\\": \\"VideoAnalyseTask-4b5c5b94-ba39-4008-9342-30abe341792b\\"\\n}","errorExample":""},{"type":"xml","example":"<Tasks>\\n <Status>Finished</Status>\\n <Progress>100</Progress>\\n <NotifyEndpoint>http://1111111111.mns.cn-hangzhou.aliyuncs.com</NotifyEndpoint>\\n <Parameters>{\\"EndTime\\":\\"\\",\\"GrabType\\":\\"time\\",\\"Interval\\":\\"1\\",\\"RequestId\\":\\"B8982C37-E03A-47CD-A715-D83D128D9FEB\\",\\"SrcUri\\":\\"oss://imm-test/testcases/video.mp4\\",\\"StartTime\\":\\"\\",\\"TaskType\\":\\"VideoAnalyseTask\\",\\"TgtUri\\":\\"oss://imm-test/testcases\\"}</Parameters>\\n <TaskId>VideoAnalyseTask-8d7a4a32-f445-47fd-bdff-397a87651879</TaskId>\\n <EndTime>2021-01-28T03:24:25.915048Z</EndTime>\\n <TaskType>VideoAnalyseTask</TaskType>\\n <StartTime>2021-01-28T03:24:23.726372Z</StartTime>\\n <NotifyTopicName>topic1</NotifyTopicName>\\n <ErrorMessage>Success</ErrorMessage>\\n <Result>{\\"Key\\":\\"{\\\\\\"TgtUri\\\\\\":\\\\\\"oss://imm-test/testcases\\\\\\",\\\\\\"ImgsUri\\\\\\":\\\\\\"oss://imm-test/testcases/imgs\\\\\\",\\\\\\"AudioUri\\\\\\":\\\\\\"oss://imm-test/testcases/audio\\\\\\",\\\\\\"ProcessLength\\\\\\":\\\\\\"10\\\\\\",\\\\\\"ResultUri\\\\\\":\\\\\\"oss://imm-test/testcases/result/result.txt\\\\\\"}\\"}</Result>\\n</Tasks>\\n<RequestId>B70908A5-02B8-4CEC-A660-2A8A10ADE862</RequestId>\\n<NextMarker>VideoAnalyseTask-4b5c5b94-ba39-4008-9342-30abe341792b</NextMarker>","errorExample":""}]', + 'title' => 'ListVideoTasks', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteVideoTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immvideotest', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'VideoAnalyseTask', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'VideoAnalyseTask-d9ee284f-857b-4d64-a73d-88fffe59f354', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '02CDECFE-4234-4734-9D4A-F1BB8D3C3374', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"02CDECFE-4234-4734-9D4A-F1BB8D3C3374\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>02CDECFE-4234-4734-9D4A-F1BB8D3C3374</RequestId>","errorExample":""}]', + 'title' => 'DeleteVideoTask', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateVideoCompressTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immvideotest', + ], + ], + [ + 'name' => 'VideoUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + ], + [ + 'name' => 'NotifyTopicName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'topic1', + ], + ], + [ + 'name' => 'NotifyEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'http://1111111111.mns.cn-beijing.aliyuncs.com', + ], + ], + [ + 'name' => 'TargetList', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '[{"AudioBitrate":"64k","VideoBitrate":"128k","TargetUri":"oss://imm-test/testcases/example.m3u8"}]', + ], + ], + [ + 'name' => 'CustomMessage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CompressTaskTest', + ], + ], + [ + 'name' => 'TargetSegment', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '[]', + ], + ], + [ + 'name' => 'TargetSubtitle', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"ExtractFormat":ass,"SubtitleUri":"oss://imm-test/testcases","ExtractType":[]}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CompressVideoTask-c09b0943-ed79-4983-8dbe-7a882574****', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CB4D73A3-BAF4-4A9D-A631-15F219AF****', + ], + 'TaskType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CompressVideoTask', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"CompressVideoTask-c09b0943-ed79-4983-8dbe-7a882574****\\",\\n \\"RequestId\\": \\"CB4D73A3-BAF4-4A9D-A631-15F219AF****\\",\\n \\"TaskType\\": \\"CompressVideoTask\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateVideoCompressTaskResponse>\\n <TaskId>CompressVideoTask-c09b0943-ed79-4983-8dbe-7a882574****</TaskId>\\n <RequestId>CB4D73A3-BAF4-4A9D-A631-15F219AF****</RequestId>\\n <TaskType>CompressVideoTask</TaskType>\\n</CreateVideoCompressTaskResponse>","errorExample":""}]', + 'title' => 'CreateVideoCompressTask', + ], + 'CreateGrabFrameTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immvideotest', + ], + ], + [ + 'name' => 'VideoUri', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + ], + [ + 'name' => 'NotifyTopicName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'topic1', + ], + ], + [ + 'name' => 'NotifyEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + ], + ], + [ + 'name' => 'TargetList', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"GrabType":"interval","GrabNumber":"1","TargetUri":"oss://imm-test/testcases/grabframeimage.jpg"}]', + ], + ], + [ + 'name' => 'CustomMessage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'GrabFrameTest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'GrabFrameTask-ffcdec0c-73ba-451a-bec4-a9fe3f4cd765', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10AFFE69-73BA-47C2-8A85-029AA9DA72A3', + ], + 'TaskType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'GrabFrameTask', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"GrabFrameTask-ffcdec0c-73ba-451a-bec4-a9fe3f4cd765\\",\\n \\"RequestId\\": \\"10AFFE69-73BA-47C2-8A85-029AA9DA72A3\\",\\n \\"TaskType\\": \\"GrabFrameTask\\"\\n}","errorExample":""},{"type":"xml","example":"<TaskId>GrabFrameTask-ffcdec0c-73ba-451a-bec4-a9fe3f4cd765</TaskId>\\n<RequestId>10AFFE69-73BA-47C2-8A85-029AA9DA72A3</RequestId>\\n<TaskType>GrabFrameTask</TaskType>","errorExample":""}]', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-beijing-gov-1', + 'endpoint' => 'imm-vpc.cn-beijing-gov-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'imm.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'imm.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'imm.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'imm.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'imm.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'imm.cn-north-2-gov-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'imm.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'imm.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'imm.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'imm.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'imm.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'imm.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'imm.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'imm.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'imm.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'imm.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'imm.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'imm.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'imm.cn-wulanchabu.aliyuncs.com', + ], + ], +]; diff --git a/data/en_us/imm/2020-09-30/api-docs.php b/data/en_us/imm/2020-09-30/api-docs.php new file mode 100644 index 0000000..9ad9316 --- /dev/null +++ b/data/en_us/imm/2020-09-30/api-docs.php @@ -0,0 +1,23640 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'imm', + 'version' => '2020-09-30', + ], + 'directories' => [ + [ + 'id' => 178523, + 'title' => 'Service Region', + 'type' => 'directory', + 'children' => [ + 'ListRegions', + ], + ], + [ + 'id' => 178609, + 'title' => 'Project Management', + 'type' => 'directory', + 'children' => [ + 'CreateProject', + 'UpdateProject', + 'GetProject', + 'ListProjects', + 'DeleteProject', + ], + ], + [ + 'id' => 178610, + 'title' => 'Metadata Management', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 178611, + 'title' => 'Data set management', + 'type' => 'directory', + 'children' => [ + 'CreateDataset', + 'UpdateDataset', + 'GetDataset', + 'ListDatasets', + 'DeleteDataset', + ], + ], + [ + 'id' => 178612, + 'title' => 'Metadata Index', + 'type' => 'directory', + 'children' => [ + 'IndexFileMeta', + 'BatchIndexFileMeta', + 'UpdateFileMeta', + 'BatchUpdateFileMeta', + 'GetFileMeta', + 'BatchGetFileMeta', + 'DeleteFileMeta', + 'BatchDeleteFileMeta', + ], + ], + [ + 'id' => 178699, + 'title' => 'Query and statistics', + 'type' => 'directory', + 'children' => [ + 'SimpleQuery', + 'SemanticQuery', + 'FuzzyQuery', + ], + ], + [ + 'id' => 178700, + 'title' => 'intelligent management', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 178701, + 'title' => 'face clustering', + 'type' => 'directory', + 'children' => [ + 'CreateFigureClusteringTask', + 'CreateFigureClustersMergingTask', + 'GetFigureCluster', + 'QueryFigureClusters', + 'BatchGetFigureCluster', + 'UpdateFigureCluster', + 'SearchImageFigureCluster', + 'CreateFacesSearchingTask', + ], + ], + [ + 'id' => 178702, + 'title' => 'spatio-temporal clustering', + 'type' => 'directory', + 'children' => [ + 'CreateLocationDateClusteringTask', + 'QueryLocationDateClusters', + 'UpdateLocationDateCluster', + 'DeleteLocationDateCluster', + ], + ], + [ + 'id' => 178703, + 'title' => 'Story', + 'type' => 'directory', + 'children' => [ + 'CreateStory', + 'QueryStories', + 'GetStory', + 'CreateCustomizedStory', + 'UpdateStory', + 'AddStoryFiles', + 'RemoveStoryFiles', + 'DeleteStory', + ], + ], + [ + 'id' => 181692, + 'title' => 'image clustering', + 'type' => 'directory', + 'children' => [ + 'CreateSimilarImageClusteringTask', + 'QuerySimilarImageClusters', + ], + ], + ], + ], + [ + 'id' => 178704, + 'title' => 'Data Binding', + 'type' => 'directory', + 'children' => [ + 'CreateBinding', + 'GetBinding', + 'ListBindings', + 'DeleteBinding', + 'AttachOSSBucket', + 'DetachOSSBucket', + 'GetOSSBucketAttachment', + ], + ], + ], + ], + [ + 'id' => 178705, + 'title' => 'Image Processing', + 'type' => 'directory', + 'children' => [ + 'EncodeBlindWatermark', + 'CreateDecodeBlindWatermarkTask', + 'GetDecodeBlindWatermarkResult', + 'DetectImageLabels', + 'DetectImageScore', + 'DetectImageCodes', + 'DetectImageFaces', + 'DetectImageCropping', + 'AddImageMosaic', + 'CreateImageToPDFTask', + 'CreateImageSplicingTask', + 'CompareImageFaces', + 'DetectImageBodies', + 'DetectImageCars', + 'DetectImageTexts', + ], + ], + [ + 'id' => 178706, + 'title' => 'Media Processing', + 'type' => 'directory', + 'children' => [ + 'CreateMediaConvertTask', + 'DetectMediaMeta', + 'CreateVideoLabelClassificationTask', + 'GetVideoLabelClassificationResult', + 'GenerateVideoPlaylist', + ], + ], + [ + 'id' => 178707, + 'title' => 'Document processing', + 'type' => 'directory', + 'children' => [ + 'GenerateWebofficeToken', + 'RefreshWebofficeToken', + 'CreateOfficeConversionTask', + 'ExtractDocumentText', + ], + ], + [ + 'id' => 178708, + 'title' => 'File Processing', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 178709, + 'title' => 'Compression Decompression', + 'type' => 'directory', + 'children' => [ + 'CreateFileCompressionTask', + 'CreateArchiveFileInspectionTask', + 'CreateFileUncompressionTask', + ], + ], + [ + 'id' => 178710, + 'title' => 'point cloud compression', + 'type' => 'directory', + 'children' => [ + 'CreateCompressPointCloudTask', + ], + ], + ], + ], + [ + 'id' => 178711, + 'title' => 'Content Security', + 'type' => 'directory', + 'children' => [ + 'DetectTextAnomaly', + 'CreateImageModerationTask', + 'CreateVideoModerationTask', + 'GetImageModerationResult', + 'GetVideoModerationResult', + ], + ], + [ + 'id' => 178712, + 'title' => 'Task Management', + 'type' => 'directory', + 'children' => [ + 'GetTask', + 'ListTasks', + [ + 'id' => 178931, + 'title' => 'Trigger', + 'type' => 'directory', + 'children' => [ + 'CreateTrigger', + 'SuspendTrigger', + 'ResumeTrigger', + 'UpdateTrigger', + 'GetTrigger', + 'ListTriggers', + 'DeleteTrigger', + ], + ], + [ + 'id' => 180710, + 'title' => 'Batch Processing', + 'type' => 'directory', + 'children' => [ + 'CreateBatch', + 'SuspendBatch', + 'ResumeBatch', + 'UpdateBatch', + 'ListBatches', + 'GetBatch', + 'DeleteBatch', + ], + ], + ], + ], + [ + 'id' => 371156, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListAttachedOSSBuckets', + 'ContextualAnswer', + 'ContextualRetrieval', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'Address' => [ + 'title' => 'A short description of struct', + 'description' => 'The address information.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Language' => [ + 'title' => 'Language', + 'description' => 'The BCP 47 language code.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'zh-hans', + 'backendName' => 'Language', + ], + 'AddressLine' => [ + 'title' => 'AddressLine', + 'description' => 'The full address.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'AddressLine', + ], + 'Country' => [ + 'title' => 'Country', + 'description' => 'The country or region.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'Country', + ], + 'Province' => [ + 'title' => 'Province', + 'description' => 'The province.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'Province', + ], + 'City' => [ + 'title' => 'City', + 'description' => 'The city.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'City', + ], + 'District' => [ + 'title' => 'District', + 'description' => 'The district.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'District', + ], + 'Township' => [ + 'title' => 'Township', + 'description' => 'The street.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'Township', + ], + ], + 'nullToEmpty' => true, + ], + 'AddressForStory' => [ + 'title' => 'A short description of struct', + 'description' => 'The address used for the story.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Country' => [ + 'title' => '', + 'description' => 'The country.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'Country', + ], + 'Province' => [ + 'title' => '', + 'description' => 'The province.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'Province', + ], + 'City' => [ + 'title' => '', + 'description' => 'The city.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'City', + ], + 'District' => [ + 'title' => '', + 'description' => 'The district.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'District', + ], + 'Township' => [ + 'title' => '', + 'description' => 'The township.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'Township', + ], + ], + ], + 'AlgorithmDefinition' => [ + 'title' => '', + 'description' => 'The structure of the algorithm definition.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'title' => '', + 'description' => 'The description.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'test', + 'backendName' => 'Description', + ], + 'OwnerId' => [ + 'title' => '', + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'user1', + 'backendName' => 'OwnerId', + ], + 'ProjectName' => [ + 'title' => '', + 'description' => 'The name of the project.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'traningtest', + 'backendName' => 'ProjectName', + ], + 'CreateTime' => [ + 'title' => '', + 'description' => 'The creation time.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2023-05-31T10:19:40.572325888+08:00', + 'backendName' => 'CreateTime', + ], + 'UpdateTime' => [ + 'title' => '', + 'description' => 'The update time.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2023-05-31T10:19:40.572325888+08:00', + 'backendName' => 'UpdateTime', + ], + 'TrainingSpecification' => [ + 'title' => '', + 'description' => 'The model training parameters.'."\n", + 'visibility' => 'Public', + 'backendName' => 'TrainingSpecification', + '$ref' => '#/components/schemas/TrainingSpecification', + ], + 'AlgorithmDefinitionId' => [ + 'title' => '', + 'description' => 'The ID of the algorithm definition.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '8fc6e718-8d19-495f-a510-bcee3c598588', + 'backendName' => 'AlgorithmDefinitionId', + ], + 'Name' => [ + 'title' => '', + 'description' => 'The name of the algorithm.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'algoName', + 'backendName' => 'Name', + ], + 'CustomLabels' => [ + 'title' => '', + 'description' => 'Custom labels.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => 'The custom labels of the file. This parameter is optional. A custom label stores custom key names and key-value pairs, which can be used to filter data. For more information, see [Supported fields and operators](https://help.aliyun.com/zh/imm/developer-reference/imm-supported-fields-and-operators?spm=a2c4g.11186623.0.0.43ea47b1QctPRi).'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '{'."\n" + .' "MemberName": "Tim",'."\n" + .' "Enabled": "True",'."\n" + .' "ItemCount": "10"'."\n" + .'}', + ], + 'extendType' => 'true', + 'description' => '', + ], + 'backendName' => 'CustomLabels', + ], + ], + ], + 'Answer' => [ + 'title' => '', + 'description' => 'The information about the answer generated by the large language model for the AI assistant.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'title' => '', + 'description' => 'The answer.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Hello', + 'backendName' => 'Content', + ], + 'References' => [ + 'title' => '', + 'description' => 'The reference sources of the answer.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The reference file based on which the smart chatbot provides the answer.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/ReferenceFile', + ], + 'backendName' => 'References', + ], + ], + ], + 'App' => [ + 'title' => 'App', + 'description' => 'App'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'AppDescription' => [ + 'title' => 'AppDescription', + 'description' => 'AppDescription'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'AppDescription', + ], + 'AppId' => [ + 'title' => 'AppId', + 'description' => 'AppId'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '1234567890', + 'backendName' => 'AppId', + ], + 'PackageName' => [ + 'title' => 'PackageName', + 'description' => 'PackageName'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ThisIsAPackageName', + 'backendName' => 'PackageName', + ], + 'AppType' => [ + 'title' => 'AppType', + 'description' => 'AppType'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + 'backendName' => 'AppType', + ], + 'EnglishName' => [ + 'title' => 'EnglishName', + 'description' => 'EnglishName'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Taobao', + 'backendName' => 'EnglishName', + ], + 'AppName' => [ + 'title' => 'AppName', + 'description' => 'AppName'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'AppName', + ], + 'AppRegion' => [ + 'title' => 'AppRegion', + 'description' => 'AppRegion'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + 'backendName' => 'AppRegion', + ], + 'OwnerId' => [ + 'title' => 'OwnerId', + 'description' => 'OwnerId'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '1023210024677934', + 'backendName' => 'OwnerId', + ], + 'AppKey' => [ + 'title' => 'AppKey', + 'description' => 'AppKey'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ryBOBW0Z6NnQ3fV9', + 'backendName' => 'AppKey', + ], + ], + ], + 'AssumeRoleChain' => [ + 'title' => '', + 'description' => 'The authorization chain of the assumed role.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Policy' => [ + 'title' => '', + 'description' => 'The policy.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'test', + 'backendName' => 'Policy', + ], + 'Chain' => [ + 'title' => '', + 'description' => 'The authorization chains.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The authorization chain node.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/AssumeRoleChainNode', + ], + 'backendName' => 'Chain', + 'itemName' => 'Chain', + ], + ], + ], + 'AssumeRoleChainNode' => [ + 'title' => '', + 'description' => 'The chained authorization node.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '', + 'description' => 'The type of the account. Valid values:'."\n" + ."\n" + .'* user: Alibaba Cloud account.'."\n" + .'* service: Alibaba Cloud service.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'example' => 'user', + 'backendName' => 'Type', + ], + 'OwnerId' => [ + 'title' => '', + 'description' => 'The UID of the account.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'example' => '10232100********', + 'backendName' => 'OwnerId', + ], + 'Role' => [ + 'title' => '', + 'description' => 'The role.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'example' => 'test-role', + 'backendName' => 'Role', + ], + ], + ], + 'AudioStream' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the audio stream.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => 'Index', + 'description' => 'The index number of the audio stream.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'backendName' => 'Index', + ], + 'Language' => [ + 'title' => 'Language', + 'description' => 'The audio language in the BCP 47 standard.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'en', + 'backendName' => 'Language', + ], + 'CodecName' => [ + 'title' => 'CodecName', + 'description' => 'The abbreviated name of the codec.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'aac', + 'backendName' => 'CodecName', + ], + 'CodecLongName' => [ + 'title' => 'CodecLongName', + 'description' => 'The full name of the codec.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'AAC (Advanced Audio Coding)', + 'backendName' => 'CodecLongName', + ], + 'CodecTimeBase' => [ + 'title' => 'CodecTimeBase', + 'description' => 'The time base of the codec.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '1/44100', + 'backendName' => 'CodecTimeBase', + ], + 'CodecTagString' => [ + 'title' => 'CodecTagString', + 'description' => 'The description of the codec tag.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'mp4a', + 'backendName' => 'CodecTagString', + ], + 'CodecTag' => [ + 'title' => 'CodecTag', + 'description' => 'The tag of the codec.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '0x6134706d', + 'backendName' => 'CodecTag', + ], + 'TimeBase' => [ + 'title' => 'TimeBase', + 'description' => 'The time base.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '1/48000', + 'backendName' => 'TimeBase', + ], + 'StartTime' => [ + 'title' => 'StartTime', + 'description' => 'The start time of the audio stream in seconds.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0235', + 'backendName' => 'StartTime', + ], + 'Duration' => [ + 'title' => 'Duration', + 'description' => 'The duration of the audio stream in seconds.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '3.690667', + 'backendName' => 'Duration', + ], + 'Bitrate' => [ + 'title' => 'Bitrate', + 'description' => 'The bitrate. Unit: bit/s.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '320087', + 'backendName' => 'Bitrate', + ], + 'FrameCount' => [ + 'title' => 'FrameCount', + 'description' => 'The number of frames.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '173', + 'backendName' => 'FrameCount', + ], + 'Lyric' => [ + 'title' => 'Lyric', + 'description' => 'The lyric.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'test', + 'backendName' => 'Lyric', + ], + 'SampleFormat' => [ + 'title' => 'SampleFormat', + 'description' => 'The sample format.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'fltp', + 'backendName' => 'SampleFormat', + ], + 'SampleRate' => [ + 'title' => 'SampleRate', + 'description' => 'The sampling rate. Unit: Hz.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '48000', + 'backendName' => 'SampleRate', + ], + 'Channels' => [ + 'title' => 'Channels', + 'description' => 'The number of sound channels.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + 'backendName' => 'Channels', + ], + 'ChannelLayout' => [ + 'title' => 'ChannelLayout', + 'description' => 'The sound channel layout.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'stereo', + 'backendName' => 'ChannelLayout', + ], + ], + ], + 'Binding' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the binding.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'ProjectName' => [ + 'title' => 'ProjectName', + 'description' => 'The name of the project.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'immtest', + 'backendName' => 'ProjectName', + ], + 'DatasetName' => [ + 'title' => 'DatasetName', + 'description' => 'The name of the dataset.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'dataset001', + 'backendName' => 'DatasetName', + ], + 'URI' => [ + 'title' => 'URI', + 'description' => 'The URI of the OSS bucket to which the dataset is bound.'."\n" + ."\n" + .'The URI is in the `oss://${bucketname}` format, where `bucketname` is the name of the OSS bucket.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss://examplebucket', + 'backendName' => 'URI', + ], + 'State' => [ + 'title' => 'State', + 'description' => 'The status of the binding between the dataset and the OSS bucket. Valid values:'."\n" + ."\n" + .'* Ready: IMM is ready to create the binding.'."\n" + .'* Stopped: The binding creation is suspended.'."\n" + .'* Running: The binding is running.'."\n" + .'* Retrying: IMM is retrying the binding.'."\n" + .'* Failed: The binding failed.'."\n" + .'* Deleted: The binding is deleted.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Running', + 'backendName' => 'State', + ], + 'Phase' => [ + 'title' => 'Phase', + 'description' => 'The type of the scan. Valid values:'."\n" + ."\n" + .'* FullScanning'."\n" + .'* IncrementalScanning'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'FullScanning', + 'backendName' => 'Phase', + ], + 'Detail' => [ + 'title' => 'Detail', + 'description' => '', + 'visibility' => 'public', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'start oss tunnel failed', + 'backendName' => 'Detail', + ], + 'CreateTime' => [ + 'title' => 'CreateTime', + 'description' => 'The RFC3339Nano timestamp when the OSS bucket was bound to the dataset.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + 'backendName' => 'CreateTime', + ], + 'UpdateTime' => [ + 'title' => 'UpdateTime', + 'description' => 'The RFC3339Nano timestamp when the binding was modified.'."\n" + ."\n" + .'> If you never suspend or retry the binding between the dataset and the OSS bucket after you complete the binding, the value of UpdateTime is the same as that of CreateTime.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + 'backendName' => 'UpdateTime', + ], + 'Reason' => [ + 'title' => 'Reason', + 'description' => 'Reason'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'Reason', + ], + 'Filters' => [ + 'description' => '', + 'visibility' => 'Private', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '['."\n" + .' "Size > 1024,FileModifiedTime > 2025-06-03T09:20:47.999Z",'."\n" + .' "Filename prefix (YWEvYmIv)"'."\n" + .']', + 'extendType' => 'true', + ], + 'backendName' => 'Filters', + ], + 'ServiceRole' => [ + 'title' => '服务角色', + 'description' => '服务角色', + 'visibility' => 'Private', + 'type' => 'string', + 'example' => 'AliyunIMMDefaultRole', + 'backendName' => 'ServiceRole', + ], + 'Notification' => [ + 'title' => '消息订阅', + 'description' => '消息订阅', + 'visibility' => 'Private', + 'type' => 'object', + 'properties' => [ + 'MNS' => [ + 'description' => '', + 'visibility' => 'cn', + 'type' => 'object', + 'properties' => [ + 'TopicName' => [ + 'description' => '', + 'visibility' => 'cn', + 'type' => 'string', + 'example' => 'topic1', + 'backendName' => 'TopicName', + ], + ], + 'backendName' => 'MNS', + ], + 'WithFields' => [ + 'description' => '', + 'visibility' => 'cn', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Filename', + 'extendType' => 'true', + ], + 'backendName' => 'WithFields', + ], + ], + 'backendName' => 'Notification', + ], + 'WorkflowParameters' => [ + 'title' => '自定义参数列表', + 'description' => '自定义参数列表', + 'visibility' => 'Private', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/WorkflowParameter', + ], + 'nullable' => true, + 'backendName' => 'WorkflowParameters', + ], + ], + ], + 'Body' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the human body.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Confidence' => [ + 'title' => 'Confidence', + 'description' => 'The confidence level of the result. A higher value indicates greater confidence. Specifically, a value exceeding 0.8 signifies a high degree of confidence in the result.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.75', + 'backendName' => 'Confidence', + ], + 'Boundary' => [ + 'title' => 'Boundary', + 'description' => 'The boundary of the human body.'."\n", + 'visibility' => 'public', + 'backendName' => 'Boundary', + '$ref' => '#/components/schemas/Boundary', + ], + ], + ], + 'Boundary' => [ + 'title' => 'A short description of struct', + 'description' => 'The boundary information.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Width' => [ + 'title' => 'Width', + 'description' => 'The width. Unit: pixel.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + 'backendName' => 'Width', + ], + 'Height' => [ + 'title' => 'Height', + 'description' => 'The height. Unit: pixel.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300', + 'backendName' => 'Height', + ], + 'Left' => [ + 'title' => 'Left', + 'description' => 'The distance from the X-coordinate of the vertex to the left edge.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + 'backendName' => 'Left', + ], + 'Top' => [ + 'title' => 'Top', + 'description' => 'The distance from the Y-coordinate of the vertex to the top.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + 'backendName' => 'Top', + ], + 'Polygon' => [ + 'title' => '', + 'description' => 'The polygon formed by a number of points. This parameter takes effect only when the boundary describes a polygon rather than a rectangle.'."\n" + ."\n" + .'> This parameter is mutually exclusive to the following parameters that form a rectangle: Width, Height, Left, and Top. A boundary describes only a rectangle or a polygon.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The coordinates of points that form the polygon.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/PointInt64', + ], + 'backendName' => 'Polygon', + ], + ], + ], + 'Car' => [ + 'title' => 'A short description of struct', + 'description' => 'The vehicle information.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'LicensePlates' => [ + 'title' => '', + 'description' => 'The license plates.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The license plate.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/LicensePlate', + ], + 'backendName' => 'LicensePlates', + ], + 'CarType' => [ + 'title' => '', + 'description' => 'The vehicle type. Valid values:'."\n" + ."\n" + .'* car'."\n" + .'* bus'."\n" + .'* truck'."\n" + .'* van'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'van', + 'backendName' => 'CarType', + ], + 'CarTypeConfidence' => [ + 'title' => '', + 'description' => 'The confidence level of the vehicle type. Valid values: 0 to 1. The value 0 indicates the lowest confidence level. The value 1 indicates the highest confidence level.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.516', + 'backendName' => 'CarTypeConfidence', + ], + 'CarColor' => [ + 'title' => '', + 'description' => 'The vehicle color. Valid values'."\n" + ."\n" + .'* white'."\n" + .'* grey'."\n" + .'* yellow'."\n" + .'* red'."\n" + .'* green'."\n" + .'* blue'."\n" + .'* black'."\n" + .'* purple'."\n" + .'* brown'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'white', + 'backendName' => 'CarColor', + ], + 'CarColorConfidence' => [ + 'title' => '', + 'description' => 'The confidence level of the vehicle color. Valid values: 0 to 1. The value 0 indicates the lowest confidence level. The value 1 indicates the highest confidence level.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.604', + 'backendName' => 'CarColorConfidence', + ], + 'Boundary' => [ + 'title' => '', + 'description' => 'The boundary information.'."\n", + 'visibility' => 'public', + 'backendName' => 'Boundary', + '$ref' => '#/components/schemas/Boundary', + ], + 'Confidence' => [ + 'title' => '', + 'description' => 'The confidence level of the vehicle detection result. Valid values: 0 to 1. The value 0 indicates the lowest confidence level. The value 1 indicates the highest confidence level.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.999', + 'backendName' => 'Confidence', + ], + ], + ], + 'ClusterForReq' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the face cluster.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'ObjectId' => [ + 'title' => 'ObjectId', + 'description' => 'The ID of the cluster.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Cluster-99b1c333-86dc-45da-8c6****', + 'backendName' => 'ObjectId', + ], + 'CustomId' => [ + 'title' => 'CustomId', + 'description' => 'The custom ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'abc', + 'backendName' => 'CustomId', + ], + 'CustomLabels' => [ + 'title' => 'CustomLabels', + 'description' => 'The custom labels.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'example' => '{"Bucket": "examplebucket"}', + 'backendName' => 'CustomLabels', + ], + 'Name' => [ + 'title' => 'Name', + 'description' => 'The name of the cluster.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'abc', + 'backendName' => 'Name', + ], + 'Cover' => [ + 'title' => 'Cover', + 'description' => 'The cover.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Figures' => [ + 'title' => 'Figures', + 'description' => 'The persons.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The person.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'FigureId' => [ + 'title' => 'FigureId', + 'description' => 'The person ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2cb3c51e-b406-4b0c-af1b-897d88e1****', + 'backendName' => 'FigureId', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'Figures', + 'itemName' => 'Figures', + ], + ], + 'backendName' => 'Cover', + ], + ], + ], + 'Codes' => [ + 'title' => 'A short description of struct', + 'description' => 'The code information.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'title' => 'Content', + 'description' => 'The content of the code.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'https://www.example.com', + 'backendName' => 'Content', + ], + 'Confidence' => [ + 'title' => 'Confidence', + 'description' => 'The confidence level of the code. A greater value indicates a higher confidence level. A value exceeding 0.8 signifies a high degree of confidence in the result.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9', + 'backendName' => 'Confidence', + ], + 'Boundary' => [ + 'title' => 'Boundary', + 'description' => 'The boundary of the code.'."\n", + 'visibility' => 'public', + 'backendName' => 'Boundary', + '$ref' => '#/components/schemas/Boundary', + ], + 'Type' => [ + 'title' => 'Type', + 'description' => 'The type of the code.'."\n" + ."\n" + .'Enumerated values:'."\n" + ."\n" + .'* qrcode'."\n" + .'* barcode'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'qrcode' => '', + 'barcode' => '', + ], + 'example' => 'qrcode', + 'backendName' => 'Type', + ], + ], + ], + 'ContextualFile' => [ + 'title' => 'A short description of struct', + 'description' => 'File'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'OwnerId' => [ + 'title' => 'OwnerId', + 'description' => 'User ID'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '1482910009923706', + 'backendName' => 'OwnerId', + ], + 'ProjectName' => [ + 'title' => 'ProjectName', + 'description' => 'Name of the project'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'test-project', + 'backendName' => 'ProjectName', + ], + 'DatasetName' => [ + 'title' => 'DatasetName', + 'description' => 'Name of the dataset'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'test-dataset', + 'backendName' => 'DatasetName', + ], + 'ObjectId' => [ + 'title' => 'ObjectId', + 'description' => 'The identifier of the corresponding file that exists in the dataset.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '0939d7ed-73fa-4009-bbe6-fbbe07b92b2e', + 'backendName' => 'ObjectId', + ], + 'URI' => [ + 'title' => 'URI', + 'description' => 'URI of the file. Specify the OSS URI in the oss://${bucketname}/${objectname} format, where ${bucketname} is the name of the bucket in the same region as the current project and ${objectname} is the path of the object. The URI of a file in Photo and Drive Service follows the pds://domains/${domain}/drives/${drive}/files/${file}/revisions/${revision} format.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'oss://test-bucket', + 'backendName' => 'URI', + ], + 'OSSURI' => [ + 'title' => 'OSSURI', + 'description' => 'The URI of the OSS object. This parameter is available only if the value of the URI parameter is the URI of a file in Photo and Drive Service.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'oss://test-bucket/test-object.jpg', + 'backendName' => 'OSSURI', + ], + 'MediaType' => [ + 'title' => 'MediaType', + 'description' => 'Media type of the current file'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* image'."\n" + .'* other'."\n" + .'* document'."\n" + .'* archive'."\n" + .'* audio'."\n" + .'* video'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'enumValueTitles' => [ + 'image' => 'image', + 'other' => 'other', + 'document' => 'document', + 'archive' => 'archive', + 'audio' => 'audio', + 'video' => 'video', + ], + 'example' => 'document', + 'backendName' => 'MediaType', + ], + 'ContentType' => [ + 'title' => 'ContentType', + 'description' => 'The Multipurpose Internet Mail Extensions (MIME) type of the file.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'text/x-imm-faq', + 'backendName' => 'ContentType', + ], + 'Elements' => [ + 'title' => 'Elements', + 'description' => 'Elements'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The element information that generated via document analytics.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/Element', + ], + 'backendName' => 'Elements', + ], + 'SmartClusters' => [ + 'title' => 'SmartClusters', + 'description' => 'SmartClusters', + 'visibility' => 'Private', + 'type' => 'array', + 'items' => [ + 'description' => 'A short description of struct', + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/FileSmartCluster', + ], + 'backendName' => 'SmartClusters', + ], + ], + 'nullable' => true, + 'nullToEmpty' => true, + ], + 'ContextualMessage' => [ + 'title' => '', + 'description' => 'The message in a multi-turn dialogue with the AI assistant.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Role' => [ + 'title' => '', + 'description' => 'The role in the dialogue.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'user', + 'backendName' => 'Role', + ], + 'Content' => [ + 'title' => '', + 'description' => 'The message content.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'Content', + ], + 'Files' => [ + 'title' => '', + 'description' => 'The files involved in the dialogue.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure for file information.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/ContextualFile', + ], + 'backendName' => 'Files', + ], + ], + ], + 'CredentialConfig' => [ + 'title' => '', + 'description' => 'The authorization chain settings. In most cases, this parameter is left empty.'."\n" + ."\n" + .'> If Account A is used to call an API operation of Intelligent Media Management (IMM) to process Object Storage Service (OSS) data in Account B, you must set the ServiceRole parameter to a role in Account A, and set the Chain parameter to a role in Account B.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'ServiceRole' => [ + 'title' => '', + 'description' => 'The service role in the account that is used to call an IMM API operation. The role must have the `sts:AssumeRole` permission. You can configure permissions for the role in the Resource Access Management (RAM) console.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'AliyunSTSAssumeForIMMServiceRole', + 'backendName' => 'ServiceRole', + ], + 'Policy' => [ + 'title' => '', + 'description' => 'The policy that is attached to the role specified by the ServiceRole parameter. For example, the policy allows access to OSS. This parameter is optional.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '{"Statement": [{"Action": "oss:*","Effect": "Allow","Resource": "*"}],"Version": "1"}', + 'backendName' => 'Policy', + ], + 'Chain' => [ + 'title' => '', + 'description' => 'The authorization chains. All roles in the array must have the `sts:AssumeRole` permission. You need to only grant other permissions, such as read and write permissions on OSS, to the last role in the array. You can grant permissions in the RAM console.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The authorization chain.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'AssumeRoleFor' => [ + 'title' => '', + 'description' => 'The ID of the account that you use to grant permissions.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '10232100246xxxxx', + 'backendName' => 'AssumeRoleFor', + ], + 'Role' => [ + 'title' => '', + 'description' => 'The RAM role that can be assumed.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'AliyunOSSRole', + 'backendName' => 'Role', + ], + 'RoleType' => [ + 'title' => '', + 'description' => 'The role type. Valid values:'."\n" + ."\n" + .'* user: Alibaba Cloud account.'."\n" + .'* service: Alibaba Cloud service.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'user', + 'backendName' => 'RoleType', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'Chain', + 'itemName' => 'Chain', + ], + ], + ], + 'CroppingSuggestion' => [ + 'title' => 'A short description of struct', + 'description' => 'The cropping suggestion.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'AspectRatio' => [ + 'title' => 'AspectRatio', + 'description' => 'The aspect ratio.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2:3', + 'backendName' => 'AspectRatio', + ], + 'Confidence' => [ + 'title' => 'Confidence', + 'description' => 'The confidence score. Valid values: 0 to 1. A higher score indicates greater confidence in the result.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7079545259475708', + 'backendName' => 'Confidence', + ], + 'Boundary' => [ + 'title' => 'Boundary', + 'description' => 'The boundary of the cropping.'."\n", + 'visibility' => 'public', + 'backendName' => 'Boundary', + '$ref' => '#/components/schemas/Boundary', + ], + ], + ], + 'CustomParams' => [ + 'title' => '', + 'description' => 'The custom parameters for model training.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Properties' => [ + 'title' => '', + 'description' => 'The properties.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the properties.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/Property', + ], + 'backendName' => 'Properties', + ], + 'Name' => [ + 'title' => '', + 'description' => 'The name of the parameter.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Normalize', + 'backendName' => 'Name', + ], + ], + ], + 'DataIngestion' => [ + 'title' => 'A short description of struct', + 'description' => 'The data ingestion object.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '', + 'description' => 'The unique ID of the data ingestion.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'trigger-9f72636a-0f0c-4baf-ae78-38b27bfe****', + 'backendName' => 'Id', + ], + 'Input' => [ + 'title' => '', + 'description' => 'The information about the data source.'."\n", + 'visibility' => 'public', + 'backendName' => 'Input', + '$ref' => '#/components/schemas/Input', + ], + 'Actions' => [ + 'title' => '', + 'description' => 'The templates.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The template.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '', + 'description' => 'The name of the template.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'doc/convert', + 'backendName' => 'Name', + ], + 'Parameters' => [ + 'title' => '', + 'description' => 'The template parameters.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The template parameter.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'pages=3', + 'extendType' => 'true', + ], + 'backendName' => 'Parameters', + ], + 'FastFailPolicy' => [ + 'title' => '', + 'description' => 'The on-error policy that is used to quickly troubleshoot an error.'."\n", + 'visibility' => 'Public', + 'backendName' => 'FastFailPolicy', + '$ref' => '#/components/schemas/FastFailPolicy', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'Actions', + ], + 'Notification' => [ + 'title' => '', + 'description' => 'The notification for task completion.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Endpoint' => [ + 'title' => '', + 'description' => 'The Simple Message Queue (SMQ) endpoint.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + 'backendName' => 'Endpoint', + ], + 'Topic' => [ + 'title' => '', + 'description' => 'The SMQ topic.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'topic1', + 'backendName' => 'Topic', + ], + 'MNS' => [ + 'title' => 'MNS', + 'description' => 'MNS'."\n", + 'visibility' => 'Public', + 'backendName' => 'MNS', + '$ref' => '#/components/schemas/MNS', + ], + 'RocketMQ' => [ + 'title' => 'RocketMQ', + 'description' => 'RocketMQ'."\n", + 'visibility' => 'Public', + 'backendName' => 'RocketMQ', + '$ref' => '#/components/schemas/RocketMQ', + ], + ], + 'backendName' => 'Notification', + ], + 'Statistic' => [ + 'title' => '', + 'description' => 'The statistical information.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'SubmitSuccess' => [ + 'title' => '', + 'description' => 'The number of files that are submitted.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + 'backendName' => 'SubmitSuccess', + ], + 'SubmitFailure' => [ + 'title' => '', + 'description' => 'The number of files that fail to be submitted.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'backendName' => 'SubmitFailure', + ], + 'SkipFiles' => [ + 'title' => '', + 'description' => 'The number of files that are skipped.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + 'backendName' => 'SkipFiles', + ], + ], + 'backendName' => 'Statistic', + ], + 'State' => [ + 'title' => '', + 'description' => 'The status of the batch processing task.'."\n" + ."\n" + .'* Ready: The task is created.'."\n" + .'* Running: The task is running.'."\n" + .'* Failed: The task fails and cannot be automatically recovered.'."\n" + .'* Suspended: The task is suspended.'."\n" + .'* Succeeded: The task is successful.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Succeeded', + 'backendName' => 'State', + ], + 'Marker' => [ + 'title' => '', + 'description' => 'The task execution location.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****', + 'backendName' => 'Marker', + ], + 'CreateTime' => [ + 'title' => '', + 'description' => 'The time when the task was created.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2020-11-10T03:50:28Z', + 'backendName' => 'CreateTime', + ], + 'UpdateTime' => [ + 'title' => '', + 'description' => 'The time when the task was updated.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2021-12-18T07:40:29Z', + 'backendName' => 'UpdateTime', + ], + 'Tags' => [ + 'title' => '', + 'description' => 'The task tags.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'backendName' => 'Tags', + ], + 'Error' => [ + 'title' => '', + 'description' => 'The error message.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'api returns error: SDKError: StatusCode: 404 Code: ResourceNotFound', + 'backendName' => 'Error', + ], + 'Phase' => [ + 'title' => '', + 'description' => 'The scanning phase.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'IncrementalScanning', + 'backendName' => 'Phase', + ], + 'ServiceRole' => [ + 'title' => '', + 'description' => 'The service-linked role.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'AliyunIMMBatchTriggerRole', + 'backendName' => 'ServiceRole', + ], + ], + ], + 'Dataset' => [ + 'title' => '', + 'description' => 'The dataset information.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'ProjectName' => [ + 'title' => '', + 'description' => 'The name of the project.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'immtest', + 'backendName' => 'ProjectName', + ], + 'DatasetName' => [ + 'title' => '', + 'description' => 'The name of the dataset.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'dataset001', + 'backendName' => 'DatasetName', + ], + 'TemplateId' => [ + 'title' => '', + 'description' => 'The ID of the workflow template.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'DefaultId', + 'backendName' => 'TemplateId', + ], + 'CreateTime' => [ + 'title' => '', + 'description' => 'The timestamp when the dataset was created. The timestamp must be in the RFC3339Nano format.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + 'backendName' => 'CreateTime', + ], + 'UpdateTime' => [ + 'title' => '', + 'description' => 'The timestamp when the dataset was last modified. The timestamp must be in the RFC3339Nano format.'."\n" + ."\n" + .'> If a dataset has never been modified after it was created, the timestamp when the dataset was last modified is the same as the timestamp when the dataset was created.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + 'backendName' => 'UpdateTime', + ], + 'Description' => [ + 'title' => '', + 'description' => 'The dataset description.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'Description', + ], + 'DatasetMaxBindCount' => [ + 'title' => '', + 'description' => 'The maximum number of bindings for the dataset.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + 'backendName' => 'DatasetMaxBindCount', + ], + 'DatasetMaxFileCount' => [ + 'title' => '', + 'description' => 'The maximum number of files for the dataset.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000000', + 'backendName' => 'DatasetMaxFileCount', + ], + 'DatasetMaxEntityCount' => [ + 'title' => '', + 'description' => 'The maximum number of metadata entities for the dataset.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000000000', + 'backendName' => 'DatasetMaxEntityCount', + ], + 'DatasetMaxRelationCount' => [ + 'title' => '', + 'description' => 'The maximum number of metadata relationships for the dataset.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000000000', + 'backendName' => 'DatasetMaxRelationCount', + ], + 'DatasetMaxTotalFileSize' => [ + 'title' => '', + 'description' => 'The maximum total size of files in the dataset. Unit: bytes.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '90000000000000000', + 'backendName' => 'DatasetMaxTotalFileSize', + ], + 'BindCount' => [ + 'title' => '', + 'description' => 'The current number of OSS buckets that are bound to the dataset.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + 'backendName' => 'BindCount', + ], + 'FileCount' => [ + 'title' => '', + 'description' => 'The current number of files in the dataset.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + 'backendName' => 'FileCount', + ], + 'TotalFileSize' => [ + 'title' => '', + 'description' => 'The total size of files in the dataset. Unit: bytes.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000', + 'backendName' => 'TotalFileSize', + ], + 'ClusterType' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Private', + 'type' => 'string', + 'example' => 'manual', + 'backendName' => 'ClusterType', + ], + 'SmartClusterTaskStatus' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Private', + 'backendName' => 'SmartClusterTaskStatus', + '$ref' => '#/components/schemas/DatasetTaskStatus', + ], + 'WorkflowParameters' => [ + 'title' => '自定义参数', + 'description' => '自定义参数', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/WorkflowParameter', + ], + 'nullable' => true, + 'backendName' => 'WorkflowParameters', + ], + ], + ], + 'DatasetTaskStatus' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the dataset task.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '', + 'description' => 'The status of the task.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Succeeded', + 'backendName' => 'Status', + ], + 'LastSucceededTime' => [ + 'title' => '', + 'description' => 'The time of the last completion.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2024-06-29T14:50:13.011643661+08:00', + 'backendName' => 'LastSucceededTime', + ], + 'StartTime' => [ + 'title' => '', + 'description' => 'The start time of the task.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2024-06-29T14:50:13.011643661+08:00', + 'backendName' => 'StartTime', + ], + ], + ], + 'Element' => [ + 'title' => 'A short description of struct', + 'description' => 'The element information generated via document analytics.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ElementContents' => [ + 'title' => '', + 'description' => 'The element contents.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The element content.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/ElementContent', + ], + 'backendName' => 'ElementContents', + ], + 'ObjectId' => [ + 'title' => '', + 'description' => 'The unique ID of the element.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'id1', + 'backendName' => 'ObjectId', + ], + 'ElementType' => [ + 'title' => '', + 'description' => 'The element type.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'title; image; table; narrative-text', + 'backendName' => 'ElementType', + ], + 'SemanticSimilarity' => [ + 'title' => '', + 'description' => 'The similarity between the current file and its extracted semantics.'."\n", + 'visibility' => 'Public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8', + 'backendName' => 'SemanticSimilarity', + ], + 'ElementRelations' => [ + 'title' => '', + 'description' => 'The relationships between the current element and other elements.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The relationship structure between the current element and other elements.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/ElementRelation', + ], + 'backendName' => 'ElementRelations', + ], + ], + ], + 'ElementContent' => [ + 'title' => 'A short description of struct', + 'description' => 'The element content generated via document analytics.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '', + 'description' => 'The type of the element content.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* text'."\n" + .'* image'."\n" + .'* link'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'text', + 'backendName' => 'Type', + ], + 'Content' => [ + 'title' => '', + 'description' => 'The content of the element.'."\n" + ."\n" + .'If the value of the Type parameter is image or link, this parameter indicates the placeholder text.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Text', + 'backendName' => 'Content', + ], + 'URL' => [ + 'title' => '', + 'description' => 'The link to the element content. This parameter takes effect only if the Type parameter is set to image or link.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'http://aliyun.com', + 'backendName' => 'URL', + ], + 'TimeRange' => [ + 'title' => '', + 'description' => 'The time range. The array length is fixed to 2. One element indicates the start time and the other one indicates the end time. Unit: milliseconds.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The time range.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '500', + 'extendType' => 'true', + ], + 'backendName' => 'TimeRange', + ], + ], + ], + 'ElementRelation' => [ + 'title' => 'A short description of struct', + 'description' => 'The relationship between the current element and another element.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '', + 'description' => 'The type.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'child，parent', + 'backendName' => 'Type', + ], + 'ObjectId' => [ + 'title' => '', + 'description' => 'The ID of the element.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'id1', + 'backendName' => 'ObjectId', + ], + ], + ], + 'FastFailPolicy' => [ + 'title' => '', + 'description' => 'The on-error policy.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'title' => '', + 'description' => 'The action when the batch processor or trigger encounters an error.'."\n" + ."\n" + .'Enumerated values:'."\n" + ."\n" + .'* abort: stops running.'."\n" + .'* ignore: ignores the error and keeps running.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'enumValueTitles' => [ + 'abort' => '', + 'ignore' => 'ignore', + ], + 'example' => 'abort', + 'backendName' => 'Action', + ], + ], + ], + 'Figure' => [ + 'title' => 'A short description of struct', + 'description' => 'The figure information.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'FigureId' => [ + 'title' => 'FigureId', + 'description' => 'The figure ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '868a9e74-cde5-4c7a-9013-28bb984****', + 'backendName' => 'FigureId', + ], + 'FigureConfidence' => [ + 'title' => 'FigureConfidence', + 'description' => 'The confidence level of the figure. Valid values: 0 to 1. The value 0 indicates the lowest confidence level. The value 1 indicates the highest confidence level.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + 'backendName' => 'FigureConfidence', + ], + 'FigureClusterId' => [ + 'title' => 'FigureClusterId', + 'description' => 'The ID of the face clustering task. The following IDs of special face clustering tasks are reserved:'."\n" + ."\n" + .'* figure-cluster-id-independent: the ID of a face clustering task in which faces do not belong to any face group. After images are added to a dataset, the faces may be categorized into different face groups when you perform face clustering.'."\n" + .'* figure-cluster-id-unavailable: the ID of a face clustering task in which face clustering is not performed after images are added to a dataset.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Cluster-dbe72fec-b84c-4ab6-885b-3678e64****', + 'backendName' => 'FigureClusterId', + ], + 'FigureClusterConfidence' => [ + 'title' => 'FigureClusterConfidence', + 'description' => 'The confidence level of the face clustering task. Valid values: 0 to 1. The value 0 indicates the lowest confidence level. The value 1 indicates the highest confidence level.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + 'backendName' => 'FigureClusterConfidence', + ], + 'FigureType' => [ + 'title' => 'FigureType', + 'description' => 'The figure type.'."\n" + ."\n" + .'Set this parameter to face.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'face' => '人脸', + ], + 'example' => 'face', + 'backendName' => 'FigureType', + ], + 'Age' => [ + 'title' => 'Age', + 'description' => 'The age.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '29', + 'backendName' => 'Age', + ], + 'AgeSD' => [ + 'title' => 'AgeSD', + 'description' => 'The standard deviation of the age.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '5', + 'backendName' => 'AgeSD', + ], + 'Gender' => [ + 'title' => 'Gender', + 'description' => 'The gender. Valid values:'."\n" + ."\n" + .'* female'."\n" + .'* male'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'female' => '女性', + 'male' => '男性', + ], + 'example' => 'female', + 'backendName' => 'Gender', + ], + 'GenderConfidence' => [ + 'title' => 'GenderConfidence', + 'description' => 'The confidence level of the gender. Valid values: 0 to 1. The value 0 indicates the lowest confidence level. The value 1 indicates the highest confidence level.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + 'backendName' => 'GenderConfidence', + ], + 'Emotion' => [ + 'title' => 'Emotion', + 'description' => 'The emotion. Valid values:'."\n" + ."\n" + .'* happiness'."\n" + .'* none'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'happiness' => '开心', + 'none' => '无', + ], + 'example' => 'happiness', + 'backendName' => 'Emotion', + ], + 'EmotionConfidence' => [ + 'title' => 'EmotionConfidence', + 'description' => 'The confidence level of the emotion. Valid values: 0 to 1. The value 0 indicates the lowest confidence level. The value 1 indicates the highest confidence level.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.707845687866210', + 'backendName' => 'EmotionConfidence', + ], + 'FaceQuality' => [ + 'title' => 'FaceQuality', + 'description' => 'The face quality.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.960875928401947', + 'backendName' => 'FaceQuality', + ], + 'Boundary' => [ + 'title' => 'Boundary', + 'description' => 'The face boundary information.'."\n", + 'visibility' => 'public', + 'backendName' => 'Boundary', + '$ref' => '#/components/schemas/Boundary', + ], + 'Mouth' => [ + 'title' => 'Mouth', + 'description' => 'Specifies whether the mouth is open. Valid values:'."\n" + ."\n" + .'* open'."\n" + .'* close'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'close' => '否', + 'open' => '是', + ], + 'example' => 'close', + 'backendName' => 'Mouth', + ], + 'MouthConfidence' => [ + 'title' => 'MouthConfidence', + 'description' => 'The confidence level of detecting whether the mouth is open. Valid values: 0 to 1. The value 0 indicates the lowest confidence level. The value 1 indicates the highest confidence level.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + 'backendName' => 'MouthConfidence', + ], + 'Beard' => [ + 'title' => 'Beard', + 'description' => 'Specifies whether the figure has a beard. Valid values:'."\n" + ."\n" + .'* beard'."\n" + .'* none'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'beard' => '是', + 'none' => '否', + ], + 'example' => 'none', + 'backendName' => 'Beard', + ], + 'BeardConfidence' => [ + 'title' => 'BeardConfidence', + 'description' => 'The confidence level of detecting whether the figure has a beard. Valid values: 0 to 1. The value 0 indicates the lowest confidence level. The value 1 indicates the highest confidence level.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + 'backendName' => 'BeardConfidence', + ], + 'Hat' => [ + 'title' => 'Hat', + 'description' => 'Specifies whether the figure wears a hat. Valid values:'."\n" + ."\n" + .'* hat'."\n" + .'* none'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'hat' => '是', + 'none' => '否', + ], + 'example' => 'none', + 'backendName' => 'Hat', + ], + 'HatConfidence' => [ + 'title' => 'HatConfidence', + 'description' => 'The confidence level of detecting whether the figure wears a hat.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + 'backendName' => 'HatConfidence', + ], + 'Mask' => [ + 'title' => 'Mask', + 'description' => 'Specifies whether the figure wears a mask. Valid values:'."\n" + ."\n" + .'* mask'."\n" + .'* none'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'none' => '否', + 'mask' => '是', + ], + 'example' => 'none', + 'backendName' => 'Mask', + ], + 'MaskConfidence' => [ + 'title' => 'MaskConfidence', + 'description' => 'The confidence level of detecting whether the figure wears a mask. Valid values: 0 to 1. The value 0 indicates the lowest confidence level. The value 1 indicates the highest confidence level.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + 'backendName' => 'MaskConfidence', + ], + 'Glasses' => [ + 'title' => 'Glasses', + 'description' => 'Specifies whether the figure wears glasses. Valid values:'."\n" + ."\n" + .'* glasses'."\n" + .'* sunglasses'."\n" + .'* none'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'glasses' => '戴眼镜', + 'sunglasses' => '戴太阳镜', + 'none' => '否', + ], + 'example' => 'none', + 'backendName' => 'Glasses', + ], + 'GlassesConfidence' => [ + 'title' => 'GlassesConfidence', + 'description' => 'The confidence level of detecting whether the figure wears glasses. Valid values: 0 to 1. The value 0 indicates the lowest confidence level. The value 1 indicates the highest confidence level.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8', + 'backendName' => 'GlassesConfidence', + ], + 'Sharpness' => [ + 'title' => 'Sharpness', + 'description' => 'The clarity.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7', + 'backendName' => 'Sharpness', + ], + 'Attractive' => [ + 'title' => 'Attractive', + 'description' => 'The face attractiveness. A high score indicates strong attractiveness. Valid values: 0 to 1.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.96', + 'backendName' => 'Attractive', + ], + 'HeadPose' => [ + 'description' => 'The head orientation.'."\n", + 'visibility' => 'public', + 'backendName' => 'HeadPose', + '$ref' => '#/components/schemas/HeadPose', + ], + ], + ], + 'FigureCluster' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the clustering task.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'OwnerId' => [ + 'title' => 'OwnerId', + 'description' => 'The user ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '102321002****', + 'backendName' => 'OwnerId', + ], + 'ProjectName' => [ + 'title' => 'ProjectName', + 'description' => 'The name of the project.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'immtest', + 'backendName' => 'ProjectName', + ], + 'DatasetName' => [ + 'title' => 'DatasetName', + 'description' => 'The name of the dataset.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'dataset001', + 'backendName' => 'DatasetName', + ], + 'ObjectType' => [ + 'title' => 'ObjectType', + 'description' => 'The type of the cluster.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'figure-cluster', + 'backendName' => 'ObjectType', + ], + 'ObjectId' => [ + 'title' => 'ObjectId', + 'description' => 'The ID of the cluster.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Cluster-ae6e3472-999e-410b-b54e-cd5dba****', + 'backendName' => 'ObjectId', + ], + 'UpdateTime' => [ + 'title' => 'UpdateTime', + 'description' => 'The update time.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2022-01-14T10:10:52.83948013+08:00', + 'backendName' => 'UpdateTime', + ], + 'CreateTime' => [ + 'title' => 'CreateTime', + 'description' => 'The creation time.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2022-01-14T10:10:52.83948013+08:00', + 'backendName' => 'CreateTime', + ], + 'Name' => [ + 'title' => 'Name', + 'description' => 'The name of the cluster.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'abc', + 'backendName' => 'Name', + ], + 'Gender' => [ + 'title' => 'Gender', + 'description' => 'The gender.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'female', + 'backendName' => 'Gender', + ], + 'FaceCount' => [ + 'title' => 'FaceCount', + 'description' => 'The number of faces.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + 'backendName' => 'FaceCount', + ], + 'ImageCount' => [ + 'title' => 'ImageCount', + 'description' => 'The number of images.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + 'backendName' => 'ImageCount', + ], + 'VideoCount' => [ + 'title' => 'VideoCount', + 'description' => 'The number of videos.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + 'backendName' => 'VideoCount', + ], + 'AverageAge' => [ + 'title' => 'AverageAge', + 'description' => 'The average age.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '26', + 'backendName' => 'AverageAge', + ], + 'MinAge' => [ + 'title' => 'MinAge', + 'description' => 'The minimum age.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '12', + 'backendName' => 'MinAge', + ], + 'MaxAge' => [ + 'title' => 'MaxAge', + 'description' => 'The maximum age.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '44', + 'backendName' => 'MaxAge', + ], + 'Cover' => [ + 'title' => 'Cover', + 'description' => 'The cover image.'."\n", + 'visibility' => 'public', + 'backendName' => 'Cover', + '$ref' => '#/components/schemas/File', + ], + 'BaseImages' => [ + 'title' => 'BaseImages', + 'description' => 'BaseImages', + 'visibility' => 'Private', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/File', + ], + 'backendName' => 'BaseImages', + 'itemName' => 'BaseImages', + ], + 'CustomId' => [ + 'title' => 'CustomId', + 'description' => 'The custom ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'abc', + 'backendName' => 'CustomId', + ], + 'CustomLabels' => [ + 'title' => 'CustomLabels', + 'description' => 'The custom labels. You can search for clusters by label.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'example' => '{"Bucket": "examplebucket"}', + 'backendName' => 'CustomLabels', + 'itemName' => 'CustomLabels', + ], + 'MetaLockVersion' => [ + 'title' => 'MetaLockVersion', + 'description' => 'The version of the metadata lock. A metadata lock version can be obtained by using a get or list operation. If you include the MetaLockVersion parameter in a request to update the cluster, the server checks consistency between the MetaLockVersion parameter value sent in the request and the one on the server side and updates the cluster only when they are consistent. This parameter prevents update conflicts in concurrent scenarios. The initial version is 0. The version is automatically increased by 1 after each successful update.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + 'backendName' => 'MetaLockVersion', + ], + ], + ], + 'FigureClusterForReq' => [ + 'title' => 'A short description of struct', + 'description' => 'The information for updating a face cluster.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'ObjectId' => [ + 'title' => 'ObjectId', + 'description' => 'The ID of the face cluster.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Cluster-99b1c333-86dc-45da-8c6****', + 'backendName' => 'ObjectId', + ], + 'Name' => [ + 'title' => 'Name', + 'description' => 'The name of the cluster.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'abc', + 'backendName' => 'Name', + ], + 'Cover' => [ + 'title' => 'Cover', + 'description' => 'The cover image.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Figures' => [ + 'title' => 'Figures', + 'description' => 'The persons.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The person.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'FigureId' => [ + 'title' => 'FigureId', + 'description' => 'The person ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2cb3c51e-b406-4b0c-af1b-897d88e1****', + 'backendName' => 'FigureId', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'Figures', + ], + ], + 'backendName' => 'Cover', + ], + 'BaseImages' => [ + 'title' => 'BaseImages', + 'description' => '', + 'visibility' => 'Private', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'OSSURI' => [ + 'title' => 'OSSURI', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'oss://examplebucket/sampleobject.jpg'."\n", + 'backendName' => 'OSSURI', + ], + 'URI' => [ + 'title' => 'URI', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'oss://test-bucket/test-object.jpg'."\n", + 'backendName' => 'URI', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'BaseImages', + ], + 'CustomId' => [ + 'title' => 'CustomId', + 'description' => 'The custom ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'abc', + 'backendName' => 'CustomId', + ], + 'CustomLabels' => [ + 'title' => 'CustomLabels', + 'description' => 'The custom labels. You can search for the cluster by label.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'example' => '{"Bucket": "examplebucket"}', + 'backendName' => 'CustomLabels', + 'itemName' => 'CustomLabels', + ], + 'MetaLockVersion' => [ + 'title' => 'MetaLockVersion', + 'description' => 'The version of the metadata lock. A metadata lock version can be obtained by using a get or list operation. If you include the MetaLockVersion parameter in a request to update the cluster, the server checks consistency between the MetaLockVersion parameter value sent in the request and the one on the server side and updates the cluster only when they are consistent. This parameter is used to prevent update conflicts in concurrent scenarios. The initial version is 0. The version is automatically increased by 1 after each successful update.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'backendName' => 'MetaLockVersion', + ], + ], + ], + 'File' => [ + 'title' => 'A short description of struct', + 'description' => 'The metadata of the object.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'OwnerId' => [ + 'title' => 'OwnerId', + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '102321002467****', + 'backendName' => 'OwnerId', + ], + 'ProjectName' => [ + 'title' => 'ProjectName', + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'test-project', + 'backendName' => 'ProjectName', + ], + 'DatasetName' => [ + 'title' => 'DatasetName', + 'description' => 'The name of the dataset. You can obtain the name of the dataset from the response of the [CreateDataset](~~478160~~) operation.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'test-dataset', + 'backendName' => 'DatasetName', + ], + 'ObjectType' => [ + 'title' => 'ObjectType', + 'description' => 'The type of the object. Set the value to **file**.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'file', + 'backendName' => 'ObjectType', + ], + 'ObjectId' => [ + 'title' => 'ObjectId', + 'description' => 'The unique ID of the object.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7', + 'backendName' => 'ObjectId', + ], + 'UpdateTime' => [ + 'title' => 'UpdateTime', + 'description' => 'The RFC3339Nano timestamp when the metadata was modified.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + 'backendName' => 'UpdateTime', + ], + 'CreateTime' => [ + 'title' => 'CreateTime', + 'description' => 'The RFC3339Nano timestamp when the metadata was created.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + 'backendName' => 'CreateTime', + ], + 'URI' => [ + 'title' => 'URI', + 'description' => 'The URI of the file.'."\n" + ."\n" + .'The URI of an OSS object follows the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Object}` is the path of the object with the extension included.'."\n" + ."\n" + .'The URI of a file in Photo and Drive Service follows the pds://domains/${domain}/drives/${drive}/files/${file}/revisions/${revision} format.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss://examplebucket/sampleobject.jpg', + 'backendName' => 'URI', + ], + 'OSSURI' => [ + 'title' => 'OSSURI', + 'description' => 'The URI of the OSS object. This parameter is available only if the value of the URI parameter is the URI of a file in Photo and Drive Service.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss://examplebucket/sampleobject.jpg', + 'backendName' => 'OSSURI', + ], + 'Filename' => [ + 'title' => 'Filename', + 'description' => 'The name of the object. For an OSS object, the value of this parameter is the object name.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'sampleobject.jpg', + 'backendName' => 'Filename', + ], + 'MediaType' => [ + 'title' => 'MediaType', + 'description' => 'The media type of the file.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* image'."\n" + .'* other'."\n" + .'* document'."\n" + .'* archive'."\n" + .'* audio'."\n" + .'* video'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'image' => '', + 'other' => '', + 'document' => '', + 'archive' => '', + 'audio' => '', + 'video' => '', + ], + 'example' => 'image', + 'backendName' => 'MediaType', + ], + 'ContentType' => [ + 'title' => 'ContentType', + 'description' => 'The Multipurpose Internet Mail Extensions (MIME) type of the file.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'image/jpeg', + 'backendName' => 'ContentType', + ], + 'Size' => [ + 'title' => 'Size', + 'description' => 'The size of the object. Unit: bytes.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + 'backendName' => 'Size', + ], + 'FileHash' => [ + 'title' => 'FileHash', + 'description' => 'The hash value of the file.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '1d9c280a7c4f67f7ef873e28449dbe17', + 'backendName' => 'FileHash', + ], + 'FileModifiedTime' => [ + 'title' => 'FileModifiedTime', + 'description' => 'The RFC3339Nano timestamp when the file was last modified.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + 'backendName' => 'FileModifiedTime', + ], + 'FileCreateTime' => [ + 'title' => 'FileCreateTime', + 'description' => 'The RFC3339Nano timestamp when the file was created.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + 'backendName' => 'FileCreateTime', + ], + 'FileAccessTime' => [ + 'title' => 'FileAccessTime', + 'description' => 'The RFC3339Nano timestamp when the file was accessed.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + 'backendName' => 'FileAccessTime', + ], + 'ProduceTime' => [ + 'title' => 'ProduceTime', + 'description' => 'The time when the image was taken.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + 'backendName' => 'ProduceTime', + ], + 'LatLong' => [ + 'title' => 'LatLong', + 'description' => 'The latitude and longitude.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '30.134390,120.074997', + 'backendName' => 'LatLong', + ], + 'Timezone' => [ + 'title' => 'Timezone', + 'description' => 'The time zone.'."\n" + ."\n" + .'> Not supported.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '""', + 'backendName' => 'Timezone', + ], + 'Addresses' => [ + 'title' => 'Addresses', + 'description' => 'The addresses.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The address.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/Address', + ], + 'backendName' => 'Addresses', + ], + 'TravelClusterId' => [ + 'title' => 'TravelClusterId', + 'description' => 'A reserved parameter.'."\n" + ."\n" + .'> Not supported.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '-', + 'backendName' => 'TravelClusterId', + ], + 'Orientation' => [ + 'title' => 'Orientation', + 'description' => 'The image rotation angle. You can obtain the value from the exchangeable image file format (EXIF).'."\n" + ."\n" + .'If the EXIF metadata does not contain the image rotation angle, this parameter is not included in the response.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + 'backendName' => 'Orientation', + ], + 'Figures' => [ + 'title' => 'Figures', + 'description' => 'The list of persons. The persons are detected via AI models.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The persons.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/Figure', + ], + 'backendName' => 'Figures', + 'itemName' => 'Figures', + ], + 'FigureCount' => [ + 'title' => 'FigureCount', + 'description' => 'The number of persons.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + 'backendName' => 'FigureCount', + ], + 'Labels' => [ + 'title' => 'Labels', + 'description' => 'The labels of the file. The labels are detected via AI models.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The label of the file.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/Label', + ], + 'backendName' => 'Labels', + 'itemName' => 'Labels', + ], + 'Title' => [ + 'title' => 'Title', + 'description' => 'The title of the file.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'test', + 'backendName' => 'Title', + ], + 'ImageWidth' => [ + 'title' => 'ImageWidth', + 'description' => 'The width of the image. Unit: pixels.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '270', + 'backendName' => 'ImageWidth', + ], + 'ImageHeight' => [ + 'title' => 'ImageHeight', + 'description' => 'The height of the image. Unit: pixels.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '500', + 'backendName' => 'ImageHeight', + ], + 'EXIF' => [ + 'title' => 'EXIF', + 'description' => 'The original EXIF information about the image. The EXIF information is stored in the serialized JSON format. For more information, see [Query image information](~~44975~~).'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '{"Compression":{"value":"6"},"DateTime":{"value":"2020:08:19 17:11:11"}}', + 'backendName' => 'EXIF', + ], + 'ImageScore' => [ + 'description' => 'The score of the image. The score is calculated by using AI models.'."\n", + 'visibility' => 'public', + 'backendName' => 'ImageScore', + '$ref' => '#/components/schemas/ImageScore', + ], + 'CroppingSuggestions' => [ + 'title' => 'CroppingSuggestions', + 'description' => 'The cropping suggestions for the image.'."\n" + ."\n" + .'> Not supported.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The cropping suggestion for the image.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/CroppingSuggestion', + ], + 'backendName' => 'CroppingSuggestions', + 'itemName' => 'CroppingSuggestions', + ], + 'OCRContents' => [ + 'title' => 'OCRContents', + 'description' => 'The Optical Character Recognition (OCR) results.'."\n" + ."\n" + .'> Not supported.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The OCR result.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/OCRContents', + ], + 'backendName' => 'OCRContents', + ], + 'VideoWidth' => [ + 'title' => 'VideoWidth', + 'description' => 'The width of the video. Unit: pixels.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1080', + 'backendName' => 'VideoWidth', + ], + 'VideoHeight' => [ + 'title' => 'VideoHeight', + 'description' => 'The height of the video. Unit: pixels.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1920', + 'backendName' => 'VideoHeight', + ], + 'VideoStreams' => [ + 'title' => 'VideoStreams', + 'description' => 'The list of video streams.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The video stream.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/VideoStream', + ], + 'backendName' => 'VideoStreams', + 'itemName' => 'VideoStreams', + ], + 'Subtitles' => [ + 'title' => 'Subtitles', + 'description' => 'The list of subtitle streams.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The subtitle stream.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/SubtitleStream', + ], + 'backendName' => 'Subtitles', + 'itemName' => 'Subtitles', + ], + 'AudioStreams' => [ + 'title' => 'AudioStreams', + 'description' => 'The list of audio streams.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The audio stream.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/AudioStream', + ], + 'backendName' => 'AudioStreams', + 'itemName' => 'AudioStreams', + ], + 'Artist' => [ + 'title' => 'Artist', + 'description' => 'The artist.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Jane', + 'backendName' => 'Artist', + 'itemName' => 'Artists', + ], + 'AlbumArtist' => [ + 'title' => 'AlbumArtist', + 'description' => 'The singer.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Jane', + 'backendName' => 'AlbumArtist', + ], + 'AudioCovers' => [ + 'title' => 'AudioCovers', + 'description' => 'The audio covers.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The audio cover.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/Image', + ], + 'backendName' => 'AudioCovers', + 'itemName' => 'AudioCovers', + ], + 'Composer' => [ + 'title' => 'Composer', + 'description' => 'The composer.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Jane', + 'backendName' => 'Composer', + ], + 'Performer' => [ + 'title' => 'Performer', + 'description' => 'The performer.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Jane', + 'backendName' => 'Performer', + ], + 'Language' => [ + 'title' => 'Language', + 'description' => 'The language specified by using a BCP 47 language tag.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'eng', + 'backendName' => 'Language', + ], + 'Album' => [ + 'title' => 'Album', + 'description' => 'The album.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'FirstAlbum', + 'backendName' => 'Album', + ], + 'PageCount' => [ + 'title' => 'PageCount', + 'description' => 'The number of pages.'."\n" + ."\n" + .'> Not supported.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + 'backendName' => 'PageCount', + ], + 'ETag' => [ + 'title' => 'ETag', + 'description' => 'The ETag of the object. ETags are used to identify the content of objects.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '"1D9C280A7C4F67F7EF873E28449****"', + 'backendName' => 'ETag', + ], + 'CacheControl' => [ + 'title' => 'CacheControl', + 'description' => 'The caching behavior of the web page when the object is downloaded.'."\n" + ."\n" + .'This parameter corresponds to the Cache-Control HTTP header of the OSS object. For more information, see [Manage object metadata](~~31859~~).'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'no-cache', + 'backendName' => 'CacheControl', + ], + 'ContentDisposition' => [ + 'title' => 'ContentDisposition', + 'description' => 'The name of the object during the download.'."\n" + ."\n" + .'This parameter corresponds to the Content-Disposition HTTP header of the OSS object. For more information, see [Manage object metadata](~~31859~~).'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'attachment; filename =test.jpg', + 'backendName' => 'ContentDisposition', + ], + 'ContentEncoding' => [ + 'title' => 'ContentEncoding', + 'description' => 'The content encoding format of the object when the object is downloaded.'."\n" + ."\n" + .'This parameter corresponds to the Content-Encoding HTTP header of the OSS object. For more information, see [Manage object metadata](~~31859~~).'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'UTF-8', + 'backendName' => 'ContentEncoding', + ], + 'ContentLanguage' => [ + 'title' => 'ContentLanguage', + 'description' => 'The language of the object content.'."\n" + ."\n" + .'This parameter corresponds to the Content-Language HTTP header of the OSS object. For more information, see [Manage object metadata](~~31859~~).'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'zh-CN', + 'backendName' => 'ContentLanguage', + ], + 'AccessControlAllowOrigin' => [ + 'title' => 'AccessControlAllowOrigin', + 'description' => 'The origin allowed in cross-origin requests.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'https://aliyundoc.com', + 'backendName' => 'AccessControlAllowOrigin', + ], + 'AccessControlRequestMethod' => [ + 'title' => 'AccessControlRequestMethod', + 'description' => 'The method to be used in the actual cross-origin request.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'PUT', + 'backendName' => 'AccessControlRequestMethod', + ], + 'ServerSideEncryptionCustomerAlgorithm' => [ + 'title' => 'ServerSideEncryptionCustomerAlgorithm', + 'description' => 'The algorithm that is used to encrypt the file on the server side.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'SM4', + 'backendName' => 'ServerSideEncryptionCustomerAlgorithm', + ], + 'ServerSideEncryption' => [ + 'title' => 'ServerSideEncryption', + 'description' => 'The encryption method on the server side.'."\n" + ."\n" + .'This parameter is available only if server encryption is configured for the OSS bucket. For more information, see [Server-side encryption](~~31871~~).'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'AES256', + 'backendName' => 'ServerSideEncryption', + ], + 'ServerSideDataEncryption' => [ + 'title' => 'ServerSideDataEncryption', + 'description' => 'The encryption method of the object.'."\n" + ."\n" + .'This parameter is available only if server encryption is configured for the OSS bucket. For more information, see [Server-side encryption](~~31871~~).'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'SM4', + 'backendName' => 'ServerSideDataEncryption', + ], + 'ServerSideEncryptionKeyId' => [ + 'title' => 'ServerSideEncryptionKeyId', + 'description' => 'The ID of the customer master key (CMK) managed by Key Management Service (KMS).'."\n" + ."\n" + .'This parameter is available only if server encryption is configured for the OSS bucket. For more information, see [Server-side encryption](~~31871~~).'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '9468da86-3509-4f8d-a61e-6eab1eac****', + 'backendName' => 'ServerSideEncryptionKeyId', + ], + 'OSSStorageClass' => [ + 'title' => 'OSSStorageClass', + 'description' => 'The storage class of the OSS bucket.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Standard', + 'backendName' => 'OSSStorageClass', + ], + 'OSSCRC64' => [ + 'title' => 'OSSCRC64', + 'description' => 'The CRC64 value.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '559890638950338001', + 'backendName' => 'OSSCRC64', + ], + 'ObjectACL' => [ + 'title' => 'ObjectACL', + 'description' => 'The access control list (ACL) of the OSS object.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'default', + 'backendName' => 'ObjectACL', + ], + 'ContentMd5' => [ + 'title' => 'ContentMd5', + 'description' => 'The MD5 value.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'HZwoCnxPZ/fvhz4oRJ2+Fw==', + 'backendName' => 'ContentMd5', + ], + 'OSSUserMeta' => [ + 'title' => 'OSSUserMeta', + 'description' => 'The user metadata of the OSS object.'."\n" + ."\n" + .'This parameter is available only if user metadata is configured for the OSS object. For more information, see [Manage object metadata](~~31859~~).'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'example' => '{"key": "val"}', + 'backendName' => 'OSSUserMeta', + 'itemName' => 'OSSUserMeta', + ], + 'OSSTaggingCount' => [ + 'title' => 'OSSTaggingCount', + 'description' => 'The number of OSS object tags.'."\n" + ."\n" + .'This parameter is available only if tags are added to the corresponding OSS object. For more information, see [Add tags to an object](~~106678~~).'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + 'backendName' => 'OSSTaggingCount', + ], + 'OSSTagging' => [ + 'title' => 'OSSTagging', + 'description' => 'The tag of the object.'."\n" + ."\n" + .'For more information, see [Add tags to an object](~~106678~~).'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'example' => '{"key": "val"}', + 'backendName' => 'OSSTagging', + 'itemName' => 'OSSTagging', + ], + 'OSSExpiration' => [ + 'title' => 'OSSExpiration', + 'description' => 'The expiration time of the OSS object.'."\n" + ."\n" + .'This parameter corresponds to the Expires HTTP header of the OSS object. For more information, see [Manage object metadata](~~31859~~).'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2120-01-01T12:00:00.000Z', + 'backendName' => 'OSSExpiration', + ], + 'OSSVersionId' => [ + 'title' => 'OSSVersionId', + 'description' => 'The version of the object.'."\n" + ."\n" + .'This parameter is available only if versioning is enabled for the bucket. For more information, see [Overview](~~109695~~).'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'CAEQNhiBgMDJgZCA0BYiIDc4MGZjZGI2OTBjOTRmNTE5NmU5NmFhZjhjYmY0****', + 'backendName' => 'OSSVersionId', + ], + 'OSSDeleteMarker' => [ + 'title' => 'OSSDeleteMarker', + 'description' => 'The delete marker of the object.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'CAEQMhiBgIDXiaaB0BYiIGQzYmRkZGUxMTM1ZDRjOTZhNjk4YjRjMTAyZjhl****', + 'backendName' => 'OSSDeleteMarker', + ], + 'OSSObjectType' => [ + 'title' => 'OSSObjectType', + 'description' => 'The type of the OSS object. Set the value to `Normal`.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Normal', + 'backendName' => 'OSSObjectType', + ], + 'CustomId' => [ + 'title' => 'CustomId', + 'description' => 'The custom ID of the file. When the cluster is indexed into the dataset, the custom ID is stored as the data attribute. You can map the custom ID to other data in your business system. Configure this parameter based on your business requirements. For example, you can associate a URI with an ID in your system. We recommend that you set this parameter to a globally unique value.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => ' '."\n" + .'member-image-id-0001', + 'backendName' => 'CustomId', + ], + 'CustomLabels' => [ + 'title' => 'CustomLabels', + 'description' => 'The custom labels of the file. This parameter is optional. The parameter stores custom key-value labels, which can be used to filter data.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'example' => '{'."\n" + .' "MemberName": "Tim",'."\n" + .' "Enabled": "True",'."\n" + .' "ItemCount": "10"'."\n" + .'}', + 'backendName' => 'CustomLabels', + 'itemName' => 'CustomLabels', + ], + 'StreamCount' => [ + 'title' => 'StreamCount', + 'description' => 'The number of media streams in the media container.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'backendName' => 'StreamCount', + ], + 'ProgramCount' => [ + 'title' => 'ProgramCount', + 'description' => 'The number of programs in the media container.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'backendName' => 'ProgramCount', + ], + 'FormatName' => [ + 'title' => 'FormatName', + 'description' => 'The name of the media format.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'mov', + 'backendName' => 'FormatName', + ], + 'FormatLongName' => [ + 'title' => 'FormatLongName', + 'description' => 'The full name of the media format.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'QuickTime / MOV', + 'backendName' => 'FormatLongName', + ], + 'StartTime' => [ + 'title' => 'StartTime', + 'description' => 'The time of the first frame. Unit: seconds.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.000000', + 'backendName' => 'StartTime', + ], + 'Bitrate' => [ + 'title' => 'Bitrate', + 'description' => 'The bitrate. Unit: bit/s.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '13091201', + 'backendName' => 'Bitrate', + ], + 'Duration' => [ + 'title' => 'Duration', + 'description' => 'The total duration of the video. Unit: seconds.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '15.263000', + 'backendName' => 'Duration', + ], + 'SemanticSimilarity' => [ + 'title' => 'SemanticSimilarity', + 'description' => '', + 'visibility' => 'Private', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.855123', + 'backendName' => 'SemanticSimilarity', + ], + 'SemanticTypes' => [ + 'title' => 'SemanticTypes', + 'description' => 'The reasons for which the current file is included in the search results when you call the SemanticQuery operation for semantic search.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The reason for which the current file is included in the search results when you call the SemanticQuery operation for semantic search.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* content: The semantic content of the document or the content of the image matches the query criteria.'."\n" + ."\n" + .'* text: The text of the document or image matches the query criteria.'."\n" + ."\n" + .'* datetime: The creation time of the file matches the query criteria.'."\n" + ."\n" + .'* address: The authoring location of the file matches the query criteria.'."\n" + ."\n" + .'* figure: The character names contained in the file match the query criteria.'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** The number of the valid values may increase as the algorithm evolves.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'content', + 'extendType' => 'true', + ], + 'backendName' => 'SemanticTypes', + ], + 'Elements' => [ + 'title' => 'Elements', + 'description' => 'The document elements that match the current query content when you call the SemanticQuery operation for semantic search.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The document element that matches the current query content.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/Element', + ], + 'backendName' => 'Elements', + ], + 'SceneElements' => [ + 'title' => 'SceneElements', + 'description' => 'The elements in the video segment, which are scene elements that you can extract from the video by using an AI model.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The element in the video segment.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/SceneElement', + ], + 'backendName' => 'SceneElements', + ], + 'OCRTexts' => [ + 'title' => 'OCRTexts', + 'description' => 'The text detected in the image.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Alibaba Cloud IMM'."\n", + 'backendName' => 'OCRTexts', + ], + 'FileStatus' => [ + 'title' => 'FileStatus', + 'description' => '', + 'visibility' => 'Private', + 'type' => 'string', + 'deprecated' => true, + 'example' => '""', + 'backendName' => 'FileStatus', + ], + 'Reason' => [ + 'title' => 'Reason', + 'description' => 'The reason why the file failed to run the index.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '[InternalError] The request has been failed due to some unknown error. status: 500, requestId: CC5ACFBD-BB7A-496D-A9D6-****', + 'backendName' => 'Reason', + ], + 'SmartClusters' => [ + 'title' => 'SmartClusters', + 'description' => 'SmartClusters', + 'visibility' => 'Private', + 'type' => 'array', + 'items' => [ + 'description' => 'A short description of struct', + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/FileSmartCluster', + ], + 'backendName' => 'SmartClusters', + ], + 'ObjectStatus' => [ + 'title' => 'ObjectStatus', + 'description' => 'The status of the object.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'enumValueTitles' => [ + 'Failed' => '文件执行索引构建失败。', + 'Indexed' => '文件执行索引构建完成。', + 'Pending' => '文件已经提交索引任务，准备进入索引构建。', + 'Deleting' => '文件处于删除中，此时该文件进入清理阶段，此阶段用户无法对文件进行写操作，如IndexFileMeta、UpdateFileMeta会返回409', + 'Indexing' => '文件执行索引构建任务过程中。', + ], + 'example' => 'Indexed', + 'backendName' => 'ObjectStatus', + ], + 'SequenceNumber' => [ + 'title' => 'SequenceNumber', + 'description' => '', + 'visibility' => 'Private', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + 'backendName' => 'SequenceNumber', + ], + 'ClusterStatus' => [ + 'title' => 'ClusterStatus', + 'description' => 'ClusterStatus', + 'visibility' => 'Private', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => 'ClusterStatus', + 'visibility' => 'Public', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => 'Cluster', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'Cluster Name', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'smart-cluster-modified-0001', + 'extendType' => 'true', + ], + ], + ], + 'backendName' => 'ClusterStatus', + ], + 'ClusterModifications' => [ + 'title' => 'ClusterModifications', + 'description' => 'ClusterModifications', + 'visibility' => 'Private', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => 'ClusterModificationType', + 'visibility' => 'Public', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => 'ClusterModificationType', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'ClusterModificationType', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'exlude', + 'extendType' => 'true', + ], + ], + ], + 'backendName' => 'ClusterModifications', + ], + 'Insights' => [ + 'description' => 'Summary and description of the file.'."\n" + ."\n" + .'> Not supported.'."\n", + 'visibility' => 'Public', + 'nullable' => true, + 'backendName' => 'Insights', + '$ref' => '#/components/schemas/Insights', + ], + 'MetaLockVersion' => [ + 'title' => '内部使用，不对外开放', + 'description' => '内部使用，不对外开放', + 'visibility' => 'Private', + 'type' => 'integer', + 'format' => 'int64', + 'backendName' => 'MetaLockVersion', + ], + ], + 'nullable' => true, + 'nullToEmpty' => true, + ], + 'FileForReq' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'title' => 'URI', + 'description' => '', + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss://examplebucket/sampleobject.jpg', + 'backendName' => 'URI', + ], + 'CustomId' => [ + 'title' => 'CustomId', + 'description' => '', + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'abc', + 'backendName' => 'CustomId', + ], + 'CustomLabels' => [ + 'title' => 'CustomLabels', + 'description' => '', + 'visibility' => 'public', + 'type' => 'object', + 'example' => '{"Bucket": "examplebucket"}', + 'backendName' => 'CustomLabels', + ], + 'FileHash' => [ + 'title' => 'FileHash', + 'description' => '', + 'visibility' => 'public', + 'type' => 'string', + 'example' => '1d9c280a7c4f67f7ef873e28449dbe17', + 'backendName' => 'FileHash', + ], + 'OSSURI' => [ + 'title' => 'OSSURI', + 'description' => '', + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss://examplebucket', + 'backendName' => 'OSSURI', + ], + 'MediaType' => [ + 'title' => 'MediaType', + 'description' => '', + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'image', + 'backendName' => 'MediaType', + ], + 'ContentType' => [ + 'title' => 'ContentType', + 'description' => '', + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'image/jpeg', + 'backendName' => 'ContentType', + ], + 'Figures' => [ + 'title' => 'Figures', + 'description' => '', + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'FigureId' => [ + 'title' => 'FigureId', + 'description' => '', + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2cb3c51e-b406-4b0c-af1b-897d88e1****', + 'backendName' => 'FigureId', + ], + 'FigureClusterId' => [ + 'title' => 'FigureClusterId', + 'description' => '', + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2cb3c51e-b406-4b0c-af1b-897d88e1****', + 'backendName' => 'FigureClusterId', + ], + 'FigureType' => [ + 'title' => 'FigureType', + 'description' => '', + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'face', + 'backendName' => 'FigureType', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'Figures', + 'itemName' => 'Figures', + ], + ], + ], + 'FileSmartCluster' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'SmartClusterId' => [ + 'title' => 'SmartClusterId', + 'description' => 'SmartClusterId'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'SmartCluster-12cd1645-deae-4b5e-9434-613747b75f6d', + 'backendName' => 'SmartClusterId', + ], + 'Similarity' => [ + 'title' => 'Similarity', + 'description' => 'Similarity'."\n", + 'visibility' => 'Public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9', + 'backendName' => 'Similarity', + ], + ], + ], + 'FunctionCall' => [ + 'title' => '', + 'description' => 'The definition of the function that can be called by the AI assistant.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '', + 'description' => 'The function name.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'example' => 'search_file', + 'backendName' => 'Name', + ], + 'Arguments' => [ + 'title' => '', + 'description' => 'The parameters detected by the large language model.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'Arguments', + ], + ], + ], + 'HeadPose' => [ + 'title' => 'A short description of struct', + 'description' => 'The head orientation information.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Pitch' => [ + 'title' => 'Pitch', + 'description' => 'The angel of elevation or depression of the head. Unit: degree. Valid values: -180 to 180. A recommended range for reliable results is from -30 to 30.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '18.385589599609375', + 'backendName' => 'Pitch', + ], + 'Roll' => [ + 'title' => 'Roll', + 'description' => 'The angle of the tilt to the side. Unit: degree. Valid values: -180 to 180. A recommended range for reliable results is from -45 to 45.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '4.204030513763428', + 'backendName' => 'Roll', + ], + 'Yaw' => [ + 'title' => 'Yaw', + 'description' => 'The angle of leftward or rightward rotation of the head. Unit: degree. Valid values: -180 to 180. A recommended range for reliable results is from -80 to 80.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '2.4945924282073975', + 'backendName' => 'Yaw', + ], + ], + ], + 'Hyperparameters' => [ + 'title' => '', + 'description' => 'The hyperparameters.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'BatchSize' => [ + 'title' => '', + 'description' => 'The batch size for model training.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + 'backendName' => 'BatchSize', + ], + 'InputSize' => [ + 'title' => '', + 'description' => 'The image size. The array contains the width and height of the image.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The image size. The array contains the width and height of the image.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '640', + 'extendType' => 'true', + ], + 'required' => true, + 'backendName' => 'InputSize', + ], + 'Schedule' => [ + 'description' => 'The learning rate scheduler.'."\n", + 'visibility' => 'Public', + 'backendName' => 'Schedule', + '$ref' => '#/components/schemas/Schedule', + ], + 'MaxEpoch' => [ + 'title' => '', + 'description' => 'The number of epochs.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + 'backendName' => 'MaxEpoch', + ], + 'Evaluator' => [ + 'description' => 'The custom parameters for model training.'."\n", + 'visibility' => 'Public', + 'required' => true, + 'backendName' => 'Evaluator', + '$ref' => '#/components/schemas/CustomParams', + ], + 'DataLoaderWorkers' => [ + 'title' => '', + 'description' => 'The number of threads used to read the training data.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + 'backendName' => 'DataLoaderWorkers', + ], + 'Optimization' => [ + 'description' => 'The optimization algorithm.'."\n", + 'visibility' => 'Public', + 'backendName' => 'Optimization', + '$ref' => '#/components/schemas/Optimization', + ], + 'BackupInterval' => [ + 'title' => '', + 'description' => 'The frequency at which the model configuration is saved. If you set this parameter to 1, model configuration is saved every epoch.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'backendName' => 'BackupInterval', + ], + ], + ], + 'Image' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the image.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'ImageWidth' => [ + 'title' => 'ImageWidth', + 'description' => 'The width of the image. Unit: pixels.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '500', + 'backendName' => 'ImageWidth', + ], + 'ImageHeight' => [ + 'title' => 'ImageHeight', + 'description' => 'The height of the image. Unit: pixels.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '820', + 'backendName' => 'ImageHeight', + ], + 'EXIF' => [ + 'title' => 'EXIF', + 'description' => 'The original EXIF information about the image. The EXIF information is stored in the serialized JSON format. For more information, see [Query image information](~~44975~~).'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '{"FileSize":{"value":"29304"},"Format":{"value":"jpg"}}', + 'backendName' => 'EXIF', + ], + 'ImageScore' => [ + 'description' => 'The image scoring information.'."\n", + 'visibility' => 'public', + 'backendName' => 'ImageScore', + '$ref' => '#/components/schemas/ImageScore', + ], + 'CroppingSuggestions' => [ + 'title' => 'CroppingSuggestions', + 'description' => 'The image cropping suggestions. This parameter is reserved and not available.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The cropping suggestion.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/CroppingSuggestion', + ], + 'backendName' => 'CroppingSuggestions', + 'itemName' => 'CroppingSuggestions', + ], + 'OCRContents' => [ + 'title' => 'OCRContents', + 'description' => 'The results of optical character recognition (OCR). This parameter is reserved and not available.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The OCR result.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/OCRContents', + ], + 'backendName' => 'OCRContents', + 'itemName' => 'OCRContents', + ], + ], + ], + 'ImageInsight' => [ + 'description' => 'The summary and description of the image.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Caption' => [ + 'description' => 'Image summary.'."\n" + ."\n" + .'> Not supported.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'nullable' => true, + 'backendName' => 'Caption', + ], + 'Description' => [ + 'description' => 'The description of the image.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'nullable' => true, + 'backendName' => 'Description', + 'valueMapping' => [ + 'cases' => [], + ], + ], + ], + 'nullable' => true, + ], + 'ImageScore' => [ + 'title' => 'A short description of struct', + 'description' => 'The image scoring information.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'OverallQualityScore' => [ + 'title' => 'OverallQualityScore', + 'description' => 'The score for the overall image quality. The image is automatically evaluated by AI. The evaluation is mainly based on subjective aesthetics and is affected by various factors, such as composition, brightness, contrast, color, and definition.'."\n" + ."\n" + .'Valid values: 0 to 1. A higher value indicates better quality.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.736', + 'backendName' => 'OverallQualityScore', + ], + ], + ], + 'Input' => [ + 'title' => 'A short description of struct', + 'description' => 'The data input configuration.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'OSS' => [ + 'description' => 'The input data source from Object Storage Service (OSS).'."\n", + 'visibility' => 'public', + 'backendName' => 'OSS', + '$ref' => '#/components/schemas/InputOSS', + ], + ], + ], + 'InputFile' => [ + 'title' => 'A short description of struct', + 'description' => 'The file that is used to create or update indexes. For information about how to create indexes, see [IndexFileMeta](~~478166~~). For information about how to update indexes, see [UpdateFileMeta](~~478168~~).'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'title' => 'URI', + 'description' => 'The URI of the file for which you want to create or update an index in the request. This parameter is required. The URI can represent an object in Object Storage Service (OSS) or a file in Photo and Drive Service.'."\n" + ."\n" + .'The OSS URI must be in the oss://${Bucket}/${Object} format. `${Bucket}` specifies the name of the OSS bucket that is in the same region as the current project. `${Object}` specifies the full file path that contains the object name extension.'."\n" + ."\n" + .'The URI of a file in Photo and Drive Service must be in the `pds://domains/${domain}/drives/${drive}/files/${file}/revisions/${revision}` format.'."\n" + ."\n" + .'> URIs that start with HTTP are not supported.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss://examplebucket/sampleobject.jpg', + 'backendName' => 'URI', + ], + 'CustomId' => [ + 'title' => 'CustomId', + 'description' => 'The custom ID of the file. This parameter is optional. When the metadata of the file is indexed into the dataset, the custom ID is stored as the data attribute. You can map the custom ID to other data in your business system. You can configure this parameter based on your business requirements. For example, you can associate a URI with an ID in your business system. We recommend that you set this parameter to a unique value.'."\n" + ."\n" + .'This parameter supports prefix searches and sorting during queries. For more information, see [Supported fields and operators](~~252856~~).'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'member-image-id-0001', + 'backendName' => 'CustomId', + ], + 'CustomLabels' => [ + 'title' => 'CustomLabels', + 'description' => 'The custom labels of the file. This parameter is optional. The parameter stores custom key-value labels, which can be used to filter data. For more information, see [Supported fields and operators](~~252856~~).'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'example' => '{'."\n" + .' "MemberName": "Tim",'."\n" + .' "Enabled": "True",'."\n" + .' "ItemCount": "10"'."\n" + .'}', + 'backendName' => 'CustomLabels', + ], + 'FileHash' => [ + 'title' => 'FileHash', + 'description' => 'The file hash. In most cases, you can leave this parameter empty. This parameter is required only when the URI parameter specifies a file in Photo and Drive Service.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '1d9c280a7c4f67f7ef873e28449dbe17', + 'backendName' => 'FileHash', + ], + 'OSSURI' => [ + 'title' => 'OSSURI', + 'description' => 'The path of the OSS object. In most cases, you can leave this parameter empty. You can specify this parameter only if the URI parameter specifies a file in Photo and Drive Service.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss://test-bucket/test-object.jpg', + 'backendName' => 'OSSURI', + ], + 'MediaType' => [ + 'title' => 'MediaType', + 'description' => 'In most cases, you can leave this parameter empty. The media type of the file.'."\n" + ."\n" + .'Enumerated values:'."\n" + ."\n" + .'* image'."\n" + .'* other'."\n" + .'* document'."\n" + .'* archive'."\n" + .'* video'."\n" + .'* audio'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'image' => '', + 'other' => '', + 'document' => '', + 'archive' => '', + 'video' => '', + 'audio' => '', + ], + 'example' => 'image', + 'backendName' => 'MediaType', + ], + 'ContentType' => [ + 'title' => 'ContentType', + 'description' => 'In most cases, you can leave this parameter empty. The Multipurpose Internet Mail Extensions (MIME) type of the file.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'image/jpeg', + 'backendName' => 'ContentType', + ], + 'Figures' => [ + 'title' => 'Figures', + 'description' => 'This parameter is optional. The persons. This parameter is used to remove a face from a face group or modify a face group. For more information, see [Face clustering](~~477175~~).'."\n" + ."\n" + .'> This parameter takes effect only for the UpdateFileMeta or BatchUpdateFileMeta operation.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The object that stores the person information.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'FigureId' => [ + 'title' => 'FigureId', + 'description' => 'The person ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2cb3c51e-b406-4b0c-af1b-897d88e1****', + 'backendName' => 'FigureId', + ], + 'FigureClusterId' => [ + 'title' => 'FigureClusterId', + 'description' => 'The ID of the face cluster. The following IDs of special face clusters are reserved:'."\n" + ."\n" + .'* figure-cluster-id-independent: indicates that the face does not belong to any face cluster. The face may be added to a face cluster in subsequent face clustering tasks after new images are added to the dataset.'."\n" + .'* figure-cluster-id-unavailable: indicates that the face has not been included in a face clustering task since a new image was added to the dataset.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Cluster-dbe72fec-b84c-4ab6-885b-3678e64****'."\n", + 'backendName' => 'FigureClusterId', + ], + 'FigureType' => [ + 'title' => 'FigureType', + 'description' => 'The figure type. Set this parameter to `face`.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'face' => 'face', + ], + 'example' => 'face', + 'backendName' => 'FigureType', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'Figures', + 'itemName' => 'Figures', + ], + 'LatLong' => [ + 'title' => 'LatLong', + 'description' => 'The GPS latitude and longitude information.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '30.134390,120.074997', + 'backendName' => 'LatLong', + ], + 'ProduceTime' => [ + 'title' => 'ProduceTime', + 'description' => 'The time when the image was taken.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + 'backendName' => 'ProduceTime', + ], + 'Title' => [ + 'title' => 'Title', + 'description' => 'The file title.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'test', + 'backendName' => 'Title', + ], + 'Artist' => [ + 'title' => 'Artist', + 'description' => 'The artist.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Jane', + 'backendName' => 'Artist', + ], + 'AlbumArtist' => [ + 'title' => 'AlbumArtist', + 'description' => 'The album artist.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Jane', + 'backendName' => 'AlbumArtist', + ], + 'Composer' => [ + 'title' => 'Composer', + 'description' => 'The composer.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Jane', + 'backendName' => 'Composer', + ], + 'Performer' => [ + 'title' => 'Performer', + 'description' => 'The performer.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Jane', + 'backendName' => 'Performer', + ], + 'Album' => [ + 'title' => 'Album', + 'description' => 'The album.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'FirstAlbum', + 'backendName' => 'Album', + ], + 'Labels' => [ + 'title' => 'Labels', + 'description' => 'The intelligent labels.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The object that stores information about the intelligent label.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/Label', + ], + 'backendName' => 'Labels', + 'itemName' => 'Labels', + ], + 'Addresses' => [ + 'title' => 'Addresses', + 'description' => 'The addresses.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The address information.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/Address', + ], + 'backendName' => 'Addresses', + 'itemName' => 'Addresses', + ], + 'ClusterModifications' => [ + 'title' => 'ClusterModifications', + 'description' => 'ClusterModifications', + 'visibility' => 'Private', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'SmartCluster-12cd1645-deae-4b5e-9434-613747b75f6d', + 'extendType' => 'true', + ], + ], + ], + 'backendName' => 'ClusterModifications', + ], + ], + ], + 'InputOSS' => [ + 'title' => 'A short description of struct', + 'description' => 'The input settings for data access to Object Storage Service (OSS).'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'title' => '', + 'description' => 'The name of the OSS bucket.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'example' => 'test-bucket', + 'backendName' => 'Bucket', + ], + 'Prefix' => [ + 'title' => '', + 'description' => 'The object key prefix.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'test-object', + 'backendName' => 'Prefix', + ], + 'MatchExpressions' => [ + 'title' => '', + 'description' => 'The match expressions.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The match mode.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'key prefix (abc)', + 'extendType' => 'true', + ], + 'backendName' => 'MatchExpressions', + ], + ], + ], + 'Insights' => [ + 'description' => 'Summary and description of the file.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Video' => [ + 'description' => 'The summary and description of the video.'."\n", + 'visibility' => 'Public', + 'nullable' => true, + 'backendName' => 'Video', + '$ref' => '#/components/schemas/VideoInsight', + ], + 'Image' => [ + 'description' => 'The summary and description of the image.'."\n", + 'visibility' => 'Public', + 'nullable' => true, + 'backendName' => 'Image', + '$ref' => '#/components/schemas/ImageInsight', + ], + ], + 'nullable' => true, + ], + 'KdtreeOption' => [ + 'title' => 'KdtreeOption', + 'description' => 'The k-d tree options.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'CompressionLevel' => [ + 'title' => 'CompressionLevel', + 'description' => 'The compression level. Valid values: 0 to 10. A greater value specifies a higher compression ratio and ensures better detail effects.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10', + 'minimum' => '0', + 'example' => '1', + 'backendName' => 'CompressionLevel', + ], + 'QuantizationBits' => [ + 'title' => 'QuantizationBits', + 'description' => 'The number of bits for quantization. Valid values: 0 to 31. A greater value ensures that more details are retained. A value of 0 specifies that vertex compression is not performed.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '31', + 'minimum' => '0', + 'example' => '1', + 'backendName' => 'QuantizationBits', + ], + 'LibraryName' => [ + 'title' => 'LibraryName', + 'description' => 'The name of the library supported by a k-d tree. Set the value to draco. Default value: draco.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'draco', + 'backendName' => 'LibraryName', + 'trim' => true, + 'default' => 'draco', + 'enum' => [ + 'draco', + ], + ], + ], + ], + 'KeyValuePair' => [ + 'title' => 'A short description of struct', + 'description' => 'The key-value pair.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '', + 'description' => 'The key.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'bucket', + 'backendName' => 'Key', + ], + 'Value' => [ + 'title' => '', + 'description' => 'The value.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'testbucket', + 'backendName' => 'Value', + ], + ], + ], + 'Label' => [ + 'title' => 'A short description of struct', + 'description' => 'The label information.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Language' => [ + 'title' => 'Language', + 'description' => 'The label language, which is represented as a BCP 47 language tag.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'zh-Hans', + 'backendName' => 'Language', + ], + 'LabelName' => [ + 'title' => 'LabelName', + 'description' => 'The label name.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'LabelName', + ], + 'LabelLevel' => [ + 'title' => 'LabelLevel', + 'description' => 'The label level. Valid values: 1, 2, and 3.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'backendName' => 'LabelLevel', + ], + 'LabelConfidence' => [ + 'title' => 'LabelConfidence', + 'description' => 'The confidence level of the label. Valid values: 0 to 1. A higher value indicates greater confidence.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9891784601980591', + 'backendName' => 'LabelConfidence', + ], + 'ParentLabelName' => [ + 'title' => 'ParentLabelName', + 'description' => 'The name of the parent label.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'ParentLabelName', + ], + 'CentricScore' => [ + 'title' => 'CentricScore', + 'description' => 'The central value of the label. This value indicates the confidence that the label is the majority component of the image. Valid values: 0 to 1. A higher value indicates greater confidence.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7319999933242798', + 'backendName' => 'CentricScore', + ], + ], + ], + 'LicensePlate' => [ + 'title' => 'A short description of struct', + 'description' => 'The license plate.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'title' => '', + 'description' => 'The license plate number.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => '', + 'backendName' => 'Content', + ], + 'Boundary' => [ + 'title' => '', + 'description' => 'The boundary information of the license plate.'."\n", + 'visibility' => 'public', + 'backendName' => 'Boundary', + '$ref' => '#/components/schemas/Boundary', + ], + 'Confidence' => [ + 'title' => '', + 'description' => 'The confidence level.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.789', + 'backendName' => 'Confidence', + ], + ], + ], + 'LocationDateCluster' => [ + 'title' => '', + 'description' => 'The spatiotemporal cluster.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Title' => [ + 'title' => '', + 'description' => 'The custom title.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'Title', + ], + 'LocationDateClusterLevel' => [ + 'title' => '', + 'description' => 'The administrative level of the spatiotemporal cluster.'."\n" + ."\n" + .'Enumerated values:'."\n" + ."\n" + .'* country'."\n" + .'* province'."\n" + .'* city'."\n" + .'* district'."\n" + .'* township'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'country' => '', + 'province' => '', + 'city' => '', + 'district' => '', + 'township' => '', + ], + 'example' => 'province', + 'backendName' => 'LocationDateClusterLevel', + ], + 'LocationDateClusterStartTime' => [ + 'title' => '', + 'description' => 'The start time of the spatiotemporal cluster.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2022-05-01T00:00:00+08:00', + 'backendName' => 'LocationDateClusterStartTime', + ], + 'LocationDateClusterEndTime' => [ + 'title' => '', + 'description' => 'The end time of the spatiotemporal cluster.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2022-05-02T23:59:59.999999999+08:00', + 'backendName' => 'LocationDateClusterEndTime', + ], + 'Addresses' => [ + 'title' => '', + 'description' => 'The addresses.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The address.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/Address', + ], + 'backendName' => 'Addresses', + ], + 'ObjectId' => [ + 'title' => '', + 'description' => 'The cluster ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'location-date-cluster-14f48cb3-079d-4595-80c4-5735284b****', + 'backendName' => 'ObjectId', + ], + 'UpdateTime' => [ + 'title' => '', + 'description' => 'The time when the spatiotemporal cluster was updated.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2022-11-16T13:15:05.65746784+08:00', + 'backendName' => 'UpdateTime', + ], + 'CreateTime' => [ + 'title' => '', + 'description' => 'The time when the spatiotemporal cluster was created.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2022-11-16T13:14:34.882523669+08:00', + 'backendName' => 'CreateTime', + ], + 'CustomId' => [ + 'title' => '', + 'description' => 'The custom ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'user-01', + 'backendName' => 'CustomId', + ], + 'CustomLabels' => [ + 'title' => '', + 'description' => 'The custom labels.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'example' => '{'."\n" + .' "User": "Jane"'."\n" + .'}', + 'backendName' => 'CustomLabels', + ], + ], + ], + 'Message' => [ + 'title' => '', + 'description' => 'The message from the AI assistant.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '', + 'description' => 'The time when the message was created.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2022-01-14T10:10:52.83948013+08:00', + 'backendName' => 'CreateTime', + ], + 'Regenerate' => [ + 'title' => '', + 'description' => 'Indicates whether the message is a regenerated answer.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'false', + 'backendName' => 'Regenerate', + ], + 'Score' => [ + 'title' => '', + 'description' => 'Rate'."\n", + 'visibility' => 'Public', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.99', + 'backendName' => 'Score', + ], + 'AssistantType' => [ + 'title' => '', + 'description' => 'Assistant type.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'doc/translate', + 'backendName' => 'AssistantType', + ], + 'AssistantMode' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Private', + 'type' => 'string', + 'example' => '', + 'backendName' => 'AssistantMode', + ], + 'DatasetName' => [ + 'title' => '', + 'description' => 'The dataset that the answer references to.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'test-dataset', + 'backendName' => 'DatasetName', + ], + 'SourceURI' => [ + 'title' => '', + 'description' => 'The URI of the source file from which the answer was generated.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'oss://test-bucket/sample.docx', + 'backendName' => 'SourceURI', + ], + 'Topic' => [ + 'title' => '', + 'description' => 'The topic in the question.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'The value varies based on the value of the AssistantType parameter.', + 'backendName' => 'Topic', + ], + 'Content' => [ + 'title' => '', + 'description' => 'The content of the question.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Hello, which park is closest to me?', + 'backendName' => 'Content', + ], + 'Language' => [ + 'title' => '', + 'description' => 'The language of the answer.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'zh-Hans', + 'backendName' => 'Language', + ], + 'Tone' => [ + 'title' => '', + 'description' => 'The tone of the answer.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'professional', + 'backendName' => 'Tone', + ], + 'Reply' => [ + 'title' => '', + 'description' => 'The answer.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Hello, I\'m your assistant.', + 'backendName' => 'Reply', + ], + 'Suggestion' => [ + 'title' => '', + 'description' => 'The compliance check results. Valid values: pass block'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'pass', + 'backendName' => 'Suggestion', + ], + ], + ], + 'MetaData' => [ + 'title' => '', + 'description' => 'The basic model information.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Identifier' => [ + 'title' => '', + 'description' => 'The model type identifier.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'detection', + 'backendName' => 'Identifier', + ], + 'Version' => [ + 'title' => '', + 'description' => 'The model version.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'v1', + 'backendName' => 'Version', + ], + 'Provider' => [ + 'title' => '', + 'description' => 'The model provider.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'imm', + 'backendName' => 'Provider', + ], + ], + ], + 'MNS' => [ + 'title' => 'A short description of struct', + 'description' => 'The Simple Message Queue (SMQ) notification configuration.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'TopicName' => [ + 'title' => 'TopicName', + 'description' => 'The SMQ topic. You can check topics within a region in the [SMQ console](https://mns.console.aliyun.com/). This parameter is required if you want to use SMQ for notifications.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'topic1', + 'backendName' => 'TopicName', + ], + 'Endpoint' => [ + 'title' => 'Endpoint', + 'description' => 'MNS Endpoint。', + 'visibility' => 'Private', + 'type' => 'string', + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + 'backendName' => 'Endpoint', + ], + ], + ], + 'ModelSpecification' => [ + 'title' => '', + 'description' => 'The model specification details.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'MetaData' => [ + 'description' => 'The basic model information.'."\n", + 'visibility' => 'Public', + 'required' => true, + 'backendName' => 'MetaData', + '$ref' => '#/components/schemas/MetaData', + ], + 'Spec' => [ + 'description' => 'The model specification information.'."\n", + 'visibility' => 'Public', + 'required' => true, + 'backendName' => 'Spec', + '$ref' => '#/components/schemas/Spec', + ], + ], + ], + 'Notification' => [ + 'description' => 'The notification settings. The operation supports multiple messaging middleware options. For more information about notification messages, see [Asynchronous message examples](~~2743997~~). You can use one of the following methods to receive notification messages:'."\n" + ."\n" + .'* Activate and connect to [EventBridge](~~161886~~) in the same region as the IMM project. For more information, see [IMM events](~~205730~~).'."\n" + ."\n" + .'* In the region in which the IMM project is located, configure a [Simple Message Queue (SMQ)](~~27412~~) subscription.'."\n" + ."\n" + .'* In the region in which the IMM project is located, create an [ApsaraMQ for RocketMQ](~~29530~~) 4.0 instance, a topic, and a group.'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** The Notification object does not support custom callback URLs.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'MNS' => [ + 'title' => 'MNS', + 'description' => 'The SMQ notification settings.'."\n", + 'visibility' => 'public', + 'backendName' => 'MNS', + '$ref' => '#/components/schemas/MNS', + ], + 'RocketMQ' => [ + 'title' => 'RocketMQ', + 'description' => 'The ApsaraMQ for RocketMQ notification settings.'."\n", + 'visibility' => 'public', + 'backendName' => 'RocketMQ', + '$ref' => '#/components/schemas/RocketMQ', + ], + 'ExtendedMessageURI' => [ + 'title' => 'ExtendedMessageURI', + 'description' => 'The Object Storage Service (OSS) URI of the object that stores task notifications. Task information is written to the object in the JSON format. In most cases, you can receive notifications only by using [EventBridge](~~161886~~), [Simple Message Queue](~~27412~~), or [ApsaraMQ for RocketMQ](~~29530~~). For tasks that have a large amount of task information, such as archive file inspection tasks and decompression tasks, you can use an OSS object to store detailed task information.'."\n" + ."\n" + .'The OSS URI follows the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Object}` is the path of the object with the extension included.'."\n" + ."\n" + .'> The object is not a messaging method. It serves only as a container for detailed task information. Task status information is sent as a message, whereas the object stores detailed task information.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'oss://test-bucket/test-object.json', + 'backendName' => 'ExtendedMessageURI', + ], + ], + ], + 'OCRContents' => [ + 'title' => 'A short description of struct', + 'description' => 'The OCR content.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Language' => [ + 'title' => 'Language', + 'description' => 'The BCP 47 language code. This parameter is not supported in the current version.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'zh-hans', + 'backendName' => 'Language', + ], + 'Contents' => [ + 'title' => 'Contents', + 'description' => 'The content.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'Contents', + ], + 'Confidence' => [ + 'title' => 'Confidence', + 'description' => 'The confidence level of the content. Valid values: 0 to 1. The value 0 indicates the lowest confidence level. The value 1 indicates the highest confidence level.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8254936695098877', + 'backendName' => 'Confidence', + ], + 'Boundary' => [ + 'title' => 'Boundary', + 'description' => 'The boundary information.'."\n", + 'visibility' => 'public', + 'backendName' => 'Boundary', + '$ref' => '#/components/schemas/Boundary', + ], + ], + ], + 'OctreeOption' => [ + 'title' => 'OctreeOption', + 'description' => 'The octree option object.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'PointResolution' => [ + 'title' => 'PointResolution', + 'description' => 'The point cloud resolution. This parameter determines the precision of the point coordinates during encoding. Default value: 0.01.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.01', + 'backendName' => 'PointResolution', + 'trim' => false, + 'default' => '0.01', + ], + 'OctreeResolution' => [ + 'title' => 'OctreeResolution', + 'description' => 'The minimum block size when an octree is partitioned. The minimum block size indicates the edge length of a voxel. Default value: 0.01.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.01', + 'backendName' => 'OctreeResolution', + 'default' => '0.01', + ], + 'DoVoxelGridDownDownSampling' => [ + 'title' => 'DoVoxelGridDownDownSampling', + 'description' => 'Specifies whether to downsample the point cloud file. Valid values:'."\n" + ."\n" + .'* true: The point cloud file is downsampled, and the coordinates of the points in a voxel are replaced with the coordinates of the center point of the voxel. The average color of all points in the voxel is used as the color of the voxel. In this case, the PointResolution parameter does not take effect.'."\n" + .'* false: Specific coordinates and colors in a voxel are encoded by calculating the offsets from each point to the lower-left corner of the voxel. The offsets are divided by the PointResolution value to obtain the integer coordinates. The residual of the color for each point relative to the average color of all points in the voxel is encoded.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'false', + 'backendName' => 'DoVoxelGridDownDownSampling', + 'default' => 'false', + ], + 'LibraryName' => [ + 'title' => 'LibraryName', + 'description' => 'The library name. Set the value to pcl. Default value: pcl.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'pcl', + 'backendName' => 'LibraryName', + 'trim' => true, + 'default' => 'pcl', + 'enum' => [ + 'pcl', + ], + ], + ], + ], + 'Optimization' => [ + 'title' => '', + 'description' => 'Optimization algorithm information.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'LearningRate' => [ + 'title' => '', + 'description' => 'The initial learning rate.'."\n", + 'visibility' => 'Public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.01', + 'backendName' => 'LearningRate', + ], + 'Optimizer' => [ + 'title' => '', + 'description' => 'The optimization method.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'SGD', + 'backendName' => 'Optimizer', + ], + ], + ], + 'PointInt64' => [ + 'title' => '', + 'description' => 'The coordinates of the vertex.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'X' => [ + 'title' => '', + 'description' => 'The distance from the X-coordinate of the vertex to the left edge. Unit: pixel.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + 'backendName' => 'X', + ], + 'Y' => [ + 'title' => '', + 'description' => 'The distance from the Y-coordinate of the vertex to the top. Unit: pixel.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + 'backendName' => 'Y', + ], + ], + ], + 'PresetReference' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'visibility' => 'Private', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'example' => 'Custom', + 'backendName' => 'Type', + ], + 'Name' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + 'backendName' => 'Name', + ], + ], + 'deprecated' => false, + ], + 'Project' => [ + 'title' => '', + 'description' => 'The project information.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'ProjectName' => [ + 'title' => '', + 'description' => 'The name of the project.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'immtest', + 'backendName' => 'ProjectName', + ], + 'ServiceRole' => [ + 'title' => '', + 'description' => 'The service role.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'AliyunIMMDefaultRole', + 'backendName' => 'ServiceRole', + ], + 'TemplateId' => [ + 'title' => '', + 'description' => 'The ID of the workflow template.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'DefaultId', + 'backendName' => 'TemplateId', + ], + 'CreateTime' => [ + 'title' => '', + 'description' => 'The timestamp when the project was created. The timestamp is in the RFC3339Nano format.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + 'backendName' => 'CreateTime', + ], + 'UpdateTime' => [ + 'title' => '', + 'description' => 'The timestamp when the project was last modified. The timestamp is in the RFC3339Nano format.'."\n" + ."\n" + .'> If a project is not modified after it is created, the timestamp when the project was created is the same as the timestamp when the project was last modified.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + 'backendName' => 'UpdateTime', + ], + 'Description' => [ + 'title' => '', + 'description' => 'The project description.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'Description', + ], + 'ProjectQueriesPerSecond' => [ + 'title' => '', + 'description' => 'The maximum number of requests that can be processed by the project per second. This corresponds to the maximum number of API operations that can be called in the project per second. Default value: 100.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + 'backendName' => 'ProjectQueriesPerSecond', + ], + 'EngineConcurrency' => [ + 'title' => '', + 'description' => 'The maximum number of tasks that the project can process per second. This corresponds to the maximum number of operators that can run in parallel in the project. Default value: 100.'."\n" + ."\n" + .'* If the number of synchronous tasks that run in parallel exceeds this limit, the task execution time will be extended until a timeout occurs.'."\n" + .'* If the number of asynchronous tasks that run in parallel exceeds this limit, the tasks will be queued. This causes delayed task completion. If a task remains in the queue for longer than the specified time limit (usually dozens of seconds), the task will fail.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + 'backendName' => 'EngineConcurrency', + ], + 'ProjectMaxDatasetCount' => [ + 'title' => '', + 'description' => 'The maximum number of datasets that a project can contain. Valid values: 1 to 1000000000. Default value: 1000000000.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000000000', + 'backendName' => 'ProjectMaxDatasetCount', + ], + 'DatasetMaxBindCount' => [ + 'title' => '', + 'description' => 'The maximum number of bindings that a dataset can have. Valid values: 1 to 10. Default value: 10.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + 'backendName' => 'DatasetMaxBindCount', + ], + 'DatasetMaxFileCount' => [ + 'title' => '', + 'description' => 'The maximum number of files in a dataset. Valid values: 1 to 100000000. Default value: 100000000.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000000', + 'backendName' => 'DatasetMaxFileCount', + ], + 'DatasetMaxEntityCount' => [ + 'title' => '', + 'description' => 'The maximum number of metadata entities in a dataset. Default value: 10000000000.'."\n" + ."\n" + .'> This parameter is reserved and does not actually apply a limit.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000000000', + 'backendName' => 'DatasetMaxEntityCount', + ], + 'DatasetMaxRelationCount' => [ + 'title' => '', + 'description' => 'The maximum number of metadata relationships in a dataset. Default value: 100000000000.'."\n" + ."\n" + .'> This parameter is reserved and does not actually apply a limit.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000000000', + 'backendName' => 'DatasetMaxRelationCount', + ], + 'DatasetMaxTotalFileSize' => [ + 'title' => '', + 'description' => 'The maximum total file size for a dataset. If the total file size exceeds this limit, indexes can no longer be added. Default value: 90000000000000000. Unit: bytes.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '90000000000000000', + 'backendName' => 'DatasetMaxTotalFileSize', + ], + 'DatasetCount' => [ + 'title' => '', + 'description' => 'The current number of datasets in the project.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + 'backendName' => 'DatasetCount', + ], + 'FileCount' => [ + 'title' => '', + 'description' => 'The current number of files in the project.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + 'backendName' => 'FileCount', + ], + 'TotalFileSize' => [ + 'title' => '', + 'description' => 'The current total size of files in the project. Unit: bytes.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000', + 'backendName' => 'TotalFileSize', + ], + 'Tags' => [ + 'title' => '', + 'description' => 'The tag list.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The tags.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'title' => 'TagKey', + 'description' => 'The tag key.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'TestKey', + 'backendName' => 'TagKey', + ], + 'TagValue' => [ + 'title' => 'TagValue', + 'description' => 'The tag value.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'TestValue', + 'backendName' => 'TagValue', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'Tags', + 'itemName' => 'Tags', + ], + ], + ], + 'Property' => [ + 'title' => '', + 'description' => 'The property information.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ItemsType' => [ + 'title' => '', + 'description' => 'If you set the ValueType field to array, you must specify the type of the elements within the array. The enumerated values include float, integer, and string.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'float', + 'backendName' => 'ItemsType', + ], + 'ValueType' => [ + 'title' => '', + 'description' => 'The type of the property. Supported enumerated values: float, integer, string, and array.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'array', + 'backendName' => 'ValueType', + ], + 'Value' => [ + 'title' => '', + 'description' => 'The value.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '[40, 80, 160, 320]', + 'backendName' => 'Value', + ], + 'Name' => [ + 'title' => '', + 'description' => 'The property name.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'channels', + 'backendName' => 'Name', + ], + ], + ], + 'ReferenceFile' => [ + 'title' => 'A short description of struct', + 'description' => 'The reference file based on which the smart chatbot provides the answer.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ProjectName' => [ + 'title' => '', + 'description' => 'The name of the project.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'test-project', + 'backendName' => 'ProjectName', + ], + 'DatasetName' => [ + 'title' => '', + 'description' => 'The name of the dataset.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'test-dataset', + 'backendName' => 'DatasetName', + ], + 'ObjectId' => [ + 'title' => '', + 'description' => 'The unique ID of the file.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7', + 'backendName' => 'ObjectId', + ], + 'URI' => [ + 'title' => '', + 'description' => 'The URI of the file.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'oss://test-bucket/test-object.jpg', + 'backendName' => 'URI', + ], + ], + ], + 'RegionType' => [ + 'title' => 'RegionType', + 'description' => 'The region.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'title' => 'RegionId', + 'description' => 'The ID of the region.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'cn-beijing', + 'backendName' => 'RegionId', + ], + 'LocalName' => [ + 'title' => 'LocalName', + 'description' => 'The name of the region.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'LocalName', + ], + ], + ], + 'Resource' => [ + 'title' => '', + 'description' => 'The resource.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ECSInstance' => [ + 'title' => '', + 'description' => 'The Elastic Compute Service (ECS) instance.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ecs.gn5i-c2g1.large', + 'backendName' => 'ECSInstance', + ], + 'CPU' => [ + 'title' => '', + 'description' => 'The number of CPU cores. Valid values: 4 to 96.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + 'backendName' => 'CPU', + ], + 'GPUNum' => [ + 'title' => '', + 'description' => 'The number of GPUs.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'backendName' => 'GPUNum', + ], + 'Name' => [ + 'title' => '', + 'description' => 'The displayed name of the resource.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'string ecs.gn5i-c2g1.large-2vCPU-8GB-1*NVIDIA_P4', + 'backendName' => 'Name', + ], + 'RAM' => [ + 'title' => '', + 'description' => 'The RAM size. Unit: GB. Valid values: 30 to 736.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8', + 'backendName' => 'RAM', + ], + 'GPUModel' => [ + 'title' => '', + 'description' => 'The GPU.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'string NVIDIA_P4', + 'backendName' => 'GPUModel', + ], + ], + ], + 'RocketMQ' => [ + 'title' => 'A short description of struct', + 'description' => 'ApsaraMQ for RocketMQ parameters.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Endpoint' => [ + 'title' => 'Endpoint', + 'description' => 'RocketMQ Endpoint。', + 'visibility' => 'Private', + 'type' => 'string', + 'example' => 'http://11111111111.mqrest.cn-hangzhou.aliyuncs.com', + 'backendName' => 'Endpoint', + ], + 'TopicName' => [ + 'title' => 'TopicName', + 'description' => 'The name of the topic in ApsaraMQ for RocketMQ. If you want to use ApsaraMQ for RocketMQ for notifications, you must specify this parameter.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'topic1', + 'backendName' => 'TopicName', + ], + 'InstanceId' => [ + 'title' => 'InstanceId', + 'description' => 'The ID of the ApsaraMQ for RocketMQ instance. If you want to use ApsaraMQ for RocketMQ for notifications, you must specify this parameter.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'MQ_INST_11111111111_BYcNy2Nc', + 'backendName' => 'InstanceId', + ], + ], + ], + 'Row' => [ + 'title' => 'A short description of struct', + 'description' => 'The file information.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'title' => 'URI', + 'description' => 'The OSS URI of the file.'."\n" + ."\n" + .'The OSS URI is in the `oss://${bucketname}/${objectname}` format, where `${bucketname}` is the name of the OSS bucket that is in the same region as the current project and `${objectname}` is the path of the file.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss://examplebucket/exampleobject.jpg', + 'backendName' => 'URI', + ], + 'CustomLabels' => [ + 'title' => 'CustomLabels', + 'description' => 'The custom labels.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The key-value pair of the label.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/KeyValuePair', + ], + 'backendName' => 'CustomLabels', + ], + ], + ], + 'Runtime' => [ + 'title' => '', + 'description' => 'The information about the runtime for model training.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Hyperparameters' => [ + 'description' => 'The hyperparameters.'."\n", + 'visibility' => 'Public', + 'required' => true, + 'backendName' => 'Hyperparameters', + '$ref' => '#/components/schemas/Hyperparameters', + ], + 'Resource' => [ + 'description' => 'The resource.'."\n", + 'visibility' => 'Public', + 'required' => true, + 'backendName' => 'Resource', + '$ref' => '#/components/schemas/Resource', + ], + ], + ], + 'SceneElement' => [ + 'title' => '', + 'description' => 'The video scene element.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'TimeRange' => [ + 'title' => '', + 'description' => 'The time range of the element. The array length is fixed at 2. One is the start time and the other is the end time. Unit: milliseconds.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The time range of the video element.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + 'extendType' => 'true', + ], + 'backendName' => 'TimeRange', + ], + 'FrameTimes' => [ + 'title' => '', + 'description' => 'The time points of frames that match the searched content within the element. Unit: milliseconds.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The time points of frames that match the searched content within the element. Unit: milliseconds.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + 'extendType' => 'true', + ], + 'backendName' => 'FrameTimes', + ], + ], + ], + 'Schedule' => [ + 'title' => '', + 'description' => 'The information about the learning rate scheduler.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Gamma' => [ + 'title' => '', + 'description' => 'The learning rate decay. This parameter takes effect only when LRScheduler is set to StepLR.'."\n", + 'visibility' => 'Public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.97', + 'backendName' => 'Gamma', + ], + 'StepSize' => [ + 'title' => '', + 'description' => 'The number of epochs the learning rate is changed after. This parameter takes effect only when LRScheduler is set to StepLR.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'backendName' => 'StepSize', + ], + 'LRScheduler' => [ + 'title' => '', + 'description' => 'The learning rate scheduler.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'StepLR', + 'backendName' => 'LRScheduler', + ], + ], + ], + 'SimilarImage' => [ + 'title' => 'A short description of struct', + 'description' => 'The similar image.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'title' => '', + 'description' => 'The URI of the image.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss://test-bucket/test-object', + 'backendName' => 'URI', + ], + 'ImageScore' => [ + 'title' => '', + 'description' => 'The aesthetic score.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.709', + 'backendName' => 'ImageScore', + ], + ], + ], + 'SimilarImageCluster' => [ + 'title' => 'A short description of struct', + 'description' => 'The cluster of similar images.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'ObjectId' => [ + 'title' => '', + 'description' => 'The ID of the cluster.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'SimilarImageCluster-748a041e-4ebc-4487-9e74-9c89b1****', + 'backendName' => 'ObjectId', + ], + 'UpdateTime' => [ + 'title' => '', + 'description' => 'The time when the cluster was updated.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2023-02-08T09:42:34.354969088+08:00', + 'backendName' => 'UpdateTime', + ], + 'CreateTime' => [ + 'title' => '', + 'description' => 'The creation time.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2023-02-08T09:42:34.354969088+08:00', + 'backendName' => 'CreateTime', + ], + 'CustomLabels' => [ + 'title' => '', + 'description' => 'The custom tag.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'backendName' => 'CustomLabels', + ], + 'Files' => [ + 'title' => '', + 'description' => 'The similar images.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The similar image.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/SimilarImage', + ], + 'backendName' => 'Files', + ], + ], + ], + 'SimpleQuery' => [ + 'title' => '', + 'description' => 'The search conditions that can be nested in SimpleQuery.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Field' => [ + 'title' => '', + 'description' => 'This parameter is required. The field name. For a list of the supported fields, see [Supported fields and operators](~~252856~~).'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Size', + 'backendName' => 'Field', + ], + 'Value' => [ + 'title' => '', + 'description' => 'The field value. If you set the Operation parameter to and, or, not, or nested, this parameter is invalid.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '10', + 'backendName' => 'Value', + ], + 'Operation' => [ + 'title' => '', + 'description' => 'This parameter is required. The operator.'."\n" + ."\n" + .'Enumerated values:'."\n" + ."\n" + .'* exist: exists query.'."\n" + .'* not: logical NOT.'."\n" + .'* or: logical OR.'."\n" + .'* prefix: prefix query.'."\n" + .'* and: logical AND.'."\n" + .'* It: less than.'."\n" + .'* match-phrase: string match query.'."\n" + .'* gte: greater than or equal to.'."\n" + .'* eq: equal to.'."\n" + .'* lte: less than or equal to.'."\n" + .'* gt: greater than.'."\n" + .'* nested: You can perform logical condition queries within the same object when the data type of a field is ARRAY.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'exist' => '', + 'not' => '', + 'or' => '', + 'prefix' => '', + 'and' => '', + 'lt' => '', + 'match-phrase' => '', + 'gte' => '', + 'eq' => '', + 'lte' => '', + 'gt' => '', + 'nested' => '', + ], + 'example' => 'and', + 'backendName' => 'Operation', + ], + 'SubQueries' => [ + 'title' => '', + 'description' => 'The subquery structure.'."\n" + ."\n" + .'You can configure Subquery conditions only if you set the Operation parameter to and, or, not, or nested.'."\n" + ."\n" + .'If you set the Operation parameter to and, or, or not, all query conditions specified by the SubQueries parameter must comply with the logical relationship of the parent query condition.'."\n" + ."\n" + .'If you set the Operation parameter to nested, the parent field of a subquery must be of the ARRAY type, such as Labels. The operator of a subquery condition must be one or more of the following operators: and, or, and not. The field of the subquery must be a sub-field of the parent field.'."\n" + ."\n" + .'For information about how to call the SimpleQuery operation, see [SimpleQuery](~~478175~~).'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The subquery condition.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/SimpleQuery', + ], + 'backendName' => 'SubQueries', + ], + ], + ], + 'SmartCluster' => [ + 'title' => 'A short description of struct', + 'description' => 'The cluster created based on smart clustering.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'OwnerId' => [ + 'title' => '', + 'description' => 'The user ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '1023210024677934', + 'backendName' => 'OwnerId', + ], + 'ProjectName' => [ + 'title' => '', + 'description' => 'The name of the project.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'MyProject', + 'backendName' => 'ProjectName', + ], + 'DatasetName' => [ + 'title' => '', + 'description' => 'The name of the dataset.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'MyDataset', + 'backendName' => 'DatasetName', + ], + 'ObjectType' => [ + 'title' => '', + 'description' => 'The type of the cluster.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'smart-cluster', + 'backendName' => 'ObjectType', + ], + 'ObjectId' => [ + 'title' => '', + 'description' => 'The ID of the cluster.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'SmartCluster-12cd1645-deae-4b5e-9434-613747b75f6d', + 'backendName' => 'ObjectId', + ], + 'CreateTime' => [ + 'title' => '', + 'description' => 'The time when the cluster was created.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2022-01-14T10:17:18.102700407+08:00', + 'backendName' => 'CreateTime', + ], + 'UpdateTime' => [ + 'title' => '', + 'description' => 'The time when the cluster was updated.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2022-01-14T10:17:18.102700407+08:00', + 'backendName' => 'UpdateTime', + ], + 'Name' => [ + 'title' => '', + 'description' => 'The name of the cluster.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'MySmartCluster1', + 'backendName' => 'Name', + ], + 'Description' => [ + 'title' => '', + 'description' => 'The description of the cluster.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'Description', + ], + 'ObjectStatus' => [ + 'title' => '', + 'description' => 'The status of the cluster.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Succeeded', + 'backendName' => 'ObjectStatus', + ], + 'Rule' => [ + 'title' => '', + 'description' => 'The clustering rule.'."\n", + 'visibility' => 'Public', + 'backendName' => 'Rule', + '$ref' => '#/components/schemas/SmartClusterRule', + ], + ], + ], + 'SmartClusterRule' => [ + 'title' => 'A short description of struct', + 'description' => 'Intelligent clustering rule'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Keywords' => [ + 'title' => '', + 'description' => 'Keywords'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'Keyword'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Machine learning', + 'extendType' => 'true', + ], + 'backendName' => 'Keywords', + ], + 'Sensitivity' => [ + 'title' => '', + 'description' => 'Sensitivity'."\n", + 'visibility' => 'Public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + 'backendName' => 'Sensitivity', + ], + ], + ], + 'Spec' => [ + 'title' => '', + 'description' => 'The model specification information.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Backbone' => [ + 'description' => 'The custom parameters for model training.'."\n", + 'visibility' => 'Public', + 'backendName' => 'Backbone', + '$ref' => '#/components/schemas/CustomParams', + ], + 'ClassNum' => [ + 'title' => '', + 'description' => 'The number of output classes of the last layer.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + 'backendName' => 'ClassNum', + ], + 'Head' => [ + 'description' => 'The custom parameters for model training.'."\n", + 'visibility' => 'Public', + 'backendName' => 'Head', + '$ref' => '#/components/schemas/CustomParams', + ], + 'Loss' => [ + 'description' => 'The custom parameters for model training.'."\n", + 'visibility' => 'Public', + 'backendName' => 'Loss', + '$ref' => '#/components/schemas/CustomParams', + ], + 'InputChannel' => [ + 'title' => '3', + 'description' => '3'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + 'backendName' => 'InputChannel', + ], + 'Name' => [ + 'title' => '', + 'description' => 'The name of the model. The available model names vary with the model category.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'example' => 'ClsResNet', + 'backendName' => 'Name', + ], + 'Neck' => [ + 'description' => 'The custom parameters for model training.'."\n", + 'visibility' => 'Public', + 'backendName' => 'Neck', + '$ref' => '#/components/schemas/CustomParams', + ], + 'NumLandmarks' => [ + 'title' => '', + 'description' => 'The number of face landmarks. This parameter is required for face detection. In most cases, you can set the parameter to 5.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + 'backendName' => 'NumLandmarks', + ], + 'PretrainedPath' => [ + 'title' => '', + 'description' => 'The path to the pretrained model.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'oss://bucket/abc/xxx.json', + 'backendName' => 'PretrainedPath', + ], + ], + ], + 'Story' => [ + 'title' => 'A short description of struct', + 'description' => 'The story information.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'OwnerId' => [ + 'title' => 'OwnerId', + 'description' => 'The ID of the owner to which the story belongs.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '102321002****', + 'backendName' => 'OwnerId', + ], + 'ProjectName' => [ + 'title' => 'ProjectName', + 'description' => 'The name of the project.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'immtest', + 'backendName' => 'ProjectName', + ], + 'DatasetName' => [ + 'title' => 'DatasetName', + 'description' => 'The name of the dataset.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'dataset001', + 'backendName' => 'DatasetName', + ], + 'ObjectId' => [ + 'title' => 'ObjectId', + 'description' => 'The ID of the story object.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'id1', + 'backendName' => 'ObjectId', + ], + 'ObjectType' => [ + 'title' => 'ObjectType', + 'description' => 'The type of the object.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'story', + 'backendName' => 'ObjectType', + ], + 'UpdateTime' => [ + 'title' => 'UpdateTime', + 'description' => 'The time when the story was updated.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2022-01-14T10:17:18.102700407+08:00', + 'backendName' => 'UpdateTime', + ], + 'CreateTime' => [ + 'title' => 'CreateTime', + 'description' => 'The time when the story was created.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2022-01-14T10:17:18.102700407+08:00', + 'backendName' => 'CreateTime', + ], + 'StoryName' => [ + 'title' => 'StoryName', + 'description' => 'The name of the story.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'name1', + 'backendName' => 'StoryName', + ], + 'StoryType' => [ + 'title' => 'StoryType', + 'description' => 'The story type.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'PeopleMemory', + 'backendName' => 'StoryType', + ], + 'StorySubType' => [ + 'title' => 'StorySubType', + 'description' => 'The subtype of the story.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'ImportantPerson', + 'backendName' => 'StorySubType', + ], + 'StoryStartTime' => [ + 'title' => 'StoryStartTime', + 'description' => 'The time when the story starts.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2022-01-14T10:17:18.102700407+08:00', + 'backendName' => 'StoryStartTime', + ], + 'StoryEndTime' => [ + 'title' => 'StoryEndTime', + 'description' => 'The time when the story ends.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2022-01-14T10:17:18.102700407+08:00', + 'backendName' => 'StoryEndTime', + ], + 'Files' => [ + 'title' => 'Files', + 'description' => 'The story files.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The story file.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/File', + ], + 'backendName' => 'Files', + ], + 'Cover' => [ + 'description' => 'The story cover.'."\n", + 'visibility' => 'public', + 'backendName' => 'Cover', + '$ref' => '#/components/schemas/File', + ], + 'FigureClusterIds' => [ + 'title' => 'FigureClusterIds', + 'description' => 'The fluster IDs.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The cluster ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2cb3c51e-b406-4b0c-af1b-897d88e1****', + 'extendType' => 'true', + ], + 'backendName' => 'FigureClusterIds', + ], + 'CustomId' => [ + 'title' => 'CustomId', + 'description' => 'The custom ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'test', + 'backendName' => 'CustomId', + ], + 'CustomLabels' => [ + 'title' => 'CustomLabels', + 'description' => 'The custom labels.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'required' => false, + 'example' => '{"key": "val"}', + 'backendName' => 'CustomLabels', + ], + 'Addresses' => [ + 'title' => 'Addresses', + 'description' => 'The addresses.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The address.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/Address', + ], + 'backendName' => 'Addresses', + ], + ], + ], + 'SubtitleStream' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the subtitle stream.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => 'Index', + 'description' => 'The index number of the subtitle stream.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + 'backendName' => 'Index', + ], + 'Language' => [ + 'title' => 'Language', + 'description' => 'The subtitle language in the BCP 47 standard.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'en', + 'backendName' => 'Language', + ], + 'CodecName' => [ + 'title' => 'CodecName', + 'description' => 'The abbreviated name of the codec.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'mov_text', + 'backendName' => 'CodecName', + ], + 'CodecLongName' => [ + 'title' => 'CodecLongName', + 'description' => 'The full name of the codec.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'MOV text', + 'backendName' => 'CodecLongName', + ], + 'CodecTagString' => [ + 'title' => 'CodecTagString', + 'description' => 'The description of the codec tag.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'tx3g', + 'backendName' => 'CodecTagString', + ], + 'CodecTag' => [ + 'title' => 'CodecTag', + 'description' => 'The tag of the codec.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '0x67337874', + 'backendName' => 'CodecTag', + ], + 'StartTime' => [ + 'title' => 'StartTime', + 'description' => 'The start time of the subtitle stream in seconds.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.000000', + 'backendName' => 'StartTime', + ], + 'Duration' => [ + 'title' => 'Duration', + 'description' => 'The duration of the subtitle stream in seconds.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '71.378', + 'backendName' => 'Duration', + ], + 'Bitrate' => [ + 'title' => 'Bitrate', + 'description' => 'The bitrate. Unit: bit/s.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '74', + 'backendName' => 'Bitrate', + ], + 'Content' => [ + 'title' => 'Content', + 'description' => 'The subtitle content.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'Content', + ], + 'Width' => [ + 'title' => 'Width', + 'description' => 'The width of the subtitles. Unit: pixels.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '600', + 'backendName' => 'Width', + ], + 'Height' => [ + 'title' => 'Height', + 'description' => 'The height of the subtitles. Unit: pixels.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + 'backendName' => 'Height', + ], + ], + ], + 'TargetAudio' => [ + 'title' => 'Audio Struct', + 'description' => 'The audio processing settings.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'DisableAudio' => [ + 'title' => 'DisableAudio', + 'description' => 'Specifies whether to disable audio stream generation. Valid values:'."\n" + ."\n" + .'* true: disables audio stream generation. No audio stream is included in the output file.'."\n" + .'* false: does not disable audio stream generation. This is the default value.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'false', + 'backendName' => 'DisableAudio', + ], + 'Stream' => [ + 'title' => 'Stream', + 'description' => 'The index numbers of audio streams. If you do not specify this parameter, the first audio stream (the one with the smallest index number) is processed. If the array contains an element greater than 100, all audio streams are processed.'."\n" + ."\n" + .'* For example, you can set the parameter to `[0,1]` to process audio streams with index numbers 0 and 1, `[1]` to process only the audio stream with the index number 1, or `[101]` to process all audio streams.'."\n" + ."\n" + .'> If you specify an index number but no audio stream with the index number is found, the index number is ignored.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The index number of the audio stream.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + 'extendType' => 'true', + ], + 'backendName' => 'Stream', + ], + 'TranscodeAudio' => [ + 'title' => 'TranscodeAudio', + 'description' => 'The audio transcoding settings. If you do not specify this parameter, no audio streams are included in the output file.'."\n" + ."\n" + .'> We recommend that you do not use this parameter to disable audio stream generation.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'title' => 'Codec', + 'description' => 'The codec. Valid values:'."\n" + ."\n" + .'* copy, mp3, vorbis, aac, flac, ac3, opus, and amr for the CreateMediaConvert operation. The default value is copy.'."\n" + .'* aac for the GenerateVideoPlaylist operation. The default value is aac.'."\n" + ."\n" + .'> When you set the parameter to copy, the audio stream is directly copied into the output file and all other parameters in **TranscodeAudio** do not take effect. The copy value is commonly used in container format conversion scenarios. You cannot use this value in audio merging scenarios.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'aac', + 'backendName' => 'Codec', + ], + 'BitrateOption' => [ + 'title' => 'BitrateOption', + 'description' => 'The audio bitrate option. Valid values:'."\n" + ."\n" + .'* fixed: always uses the target bitrate.'."\n" + .'* adaptive: uses the source bitrate when the source bitrate is smaller than the target bitrate.'."\n" + .'* fall: returns a failure when the source bitrate is smaller than the target bitrate.'."\n" + ."\n" + .'Default values:'."\n" + ."\n" + .'* fixed for the CreateMediaConvert operation.'."\n" + .'* adaptive for the GenerateVideoPlaylist operation.'."\n" + ."\n" + .'> This parameter must be used in conjunction with the **Bitrate** parameter.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'fixed', + 'backendName' => 'BitrateOption', + ], + 'Bitrate' => [ + 'title' => 'Bitrate', + 'description' => 'The bitrate of the audio stream. Unit: bit/s. This parameter and the **Quality** parameter are mutually exclusive. Valid values: 1000 to 10000000.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '64000', + 'backendName' => 'Bitrate', + ], + 'Quality' => [ + 'title' => 'Quality', + 'description' => 'The audio quality. Valid values: 0 to 100. The greater the value, the higher the quality. This parameter and the **Bitrate** parameter are mutually exclusive.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + 'backendName' => 'Quality', + ], + 'SampleRateOption' => [ + 'title' => 'SampleRateOption', + 'description' => 'The sampling rate option. Valid values:'."\n" + ."\n" + .'* fixed: always uses the target sampling rate.'."\n" + .'* adaptive: uses the source sampling rate when the source sampling rate is smaller than the target sampling rate.'."\n" + .'* fall: returns a failure when the source sampling rate is smaller than the target sampling rate.'."\n" + ."\n" + .'Default values:'."\n" + ."\n" + .'* fixed for the CreateMediaConvert operation.'."\n" + .'* adaptive for the GenerateVideoPlaylist operation.'."\n" + ."\n" + .'> This parameter must be used in conjunction with the **SampleRate** parameter.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'fixed', + 'backendName' => 'SampleRateOption', + ], + 'SampleRate' => [ + 'title' => 'SampleRate', + 'description' => 'The sampling rate option. Unit: Hz. By default, the source sampling rate is used. Valid values: 8000, 12025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, and 96000.'."\n" + ."\n" + .'> Supported sampling rates vary with formats: 48 kHz and lower for MP3, 8 kHz, 12 kHz, 16 kHz, 24 kHz, and 48 kHz for Opus, 32 kHz, 44.1 kHz, and 48 kHz for AC3, and 8 kHz and 16 kHz for AMR.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12050', + 'backendName' => 'SampleRate', + ], + 'Channel' => [ + 'title' => 'Channel', + 'description' => 'The number of sound channels. By default, the audio stream has the same number of sound channels as the source audio. Valid values: \\[1,8].'."\n" + ."\n" + .'> The number of sound channels varies with audio formats: one or two for MP3, up to six for AC3 5.1, and one for AMR.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'backendName' => 'Channel', + ], + 'BitsPerSample' => [ + 'title' => 'BitsPerSample', + 'description' => 'The audio bit depth. Valid values: 16 and 24.'."\n" + ."\n" + .'> This parameter takes effect only when Codec is set to flac.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + 'backendName' => 'BitsPerSample', + ], + ], + 'backendName' => 'TranscodeAudio', + ], + 'FilterAudio' => [ + 'title' => 'FilterAudio', + 'description' => 'The audio processing settings. This parameter is invalid if **TranscodeAudio** is left empty or **TranscodeAudio.Codec** is set to copy.'."\n" + ."\n" + .'> This parameter is not available to the GenerateVideoPlaylist operation.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Mixing' => [ + 'title' => 'Mixing', + 'description' => 'Specifies whether to mix all sound tracks into a single track. Valid values:'."\n" + ."\n" + .'* false (default)'."\n" + .'* true'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'false', + 'backendName' => 'Mixing', + ], + ], + 'backendName' => 'FilterAudio', + ], + ], + ], + 'TargetImage' => [ + 'title' => 'Image Struct', + 'description' => 'The information about the frames captured, sprites, or animated images.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Sprites' => [ + 'title' => 'Sprites', + 'description' => 'The sprites.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the sprite.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'ScaleType' => [ + 'title' => 'ScaleType', + 'description' => 'The resizing mode. Valid values:'."\n" + ."\n" + .'* stretch: stretches the image to fill the entire space. This is the default value.'."\n" + .'* crop: resizes and crops the image.'."\n" + .'* fill: resizes the image and keeps the black border.'."\n" + .'* fit: resizes the image and removes the black border.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'crop', + 'backendName' => 'ScaleType', + ], + 'Mode' => [ + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'interval', + 'backendName' => 'mode', + ], + 'StartTime' => [ + 'title' => 'StartTime', + 'description' => 'The time in seconds at which frame capturing starts. The default value is 0, which indicates that frame capturing starts at the beginning of the video.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + 'backendName' => 'StartTime', + 'parseType' => 'struct', + ], + 'TileHeight' => [ + 'title' => 'TileHeight', + 'description' => 'The number of small images in each column. Default value: 6.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + 'backendName' => 'TileHeight', + ], + 'URI' => [ + 'title' => 'URI', + 'description' => 'The URI of the sprite in Object Storage Service (OSS).'."\n" + ."\n" + .'The OSS URI follows the oss://bucket/object format, where bucket is the name of the bucket in the same region as the current project and object is the path of the object with the extension included.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/sprites', + 'backendName' => 'URI', + ], + 'ScaleWidth' => [ + 'title' => 'ScaleWidth', + 'description' => 'The width of individual small images. The default value is 1. The value can be an integer or a decimal.'."\n" + ."\n" + .'* An integer: the number of pixels. Valid values: (1,4096).'."\n" + .'* A decimal: the ratio relative to the width of the target video resolution. Valid values: (0,1].'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '1280', + 'backendName' => 'ScaleWidth', + ], + 'Pad' => [ + 'title' => 'Pad', + 'description' => 'The padding between small images. Default value: 2.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'backendName' => 'Pad', + ], + 'Format' => [ + 'title' => 'Format', + 'description' => 'The format of the sprite. Valid values:'."\n" + ."\n" + .'* jpg'."\n" + .'* png'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'example' => 'jpg'."\n", + 'backendName' => 'Format', + ], + 'Number' => [ + 'title' => 'Number', + 'description' => 'The number of small images in the sprite. The default value is 0, which indicates that frames are captured until the end of the video.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'backendName' => 'Number', + ], + 'ScaleHeight' => [ + 'title' => 'ScaleHeight', + 'description' => 'The height of individual small images. The default value is 1. The value can be an integer or a decimal.'."\n" + ."\n" + .'* An integer: the number of pixels. Valid values: (1,4096).'."\n" + .'* A decimal: the ratio relative to the height of the target video resolution. Valid values: (0,1].'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '960', + 'backendName' => 'ScaleHeight', + ], + 'TileWidth' => [ + 'title' => 'TileWidth', + 'description' => 'The number of small images in each row. Default value: 6.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + 'backendName' => 'TileWidth', + ], + 'Interval' => [ + 'title' => 'Interval', + 'description' => 'The time interval of frame capturing in seconds.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '1', + 'backendName' => 'Interval', + 'parseType' => 'struct', + ], + 'Margin' => [ + 'title' => 'Margin', + 'description' => 'The margin between the small images and the edges of the sprite. Default value: 2.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'backendName' => 'Margin', + ], + 'Threshold' => [ + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'backendName' => 'Threshold', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'Sprites', + ], + 'Animations' => [ + 'title' => 'Animations', + 'description' => 'The animated images.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the animated image.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'FrameRate' => [ + 'title' => 'FrameRate', + 'description' => 'The frame rate of the animated image. You can use this parameter together with the Interval parameter to slow down the animation.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '25', + 'backendName' => 'FrameRate', + 'parseType' => 'struct', + ], + 'Format' => [ + 'title' => 'Format', + 'description' => 'The format of the animated image. Valid values:'."\n" + ."\n" + .'* gif'."\n" + .'* webp'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'example' => 'gif', + 'backendName' => 'Format', + ], + 'Number' => [ + 'title' => 'Number', + 'description' => 'The number of extracted frames. The default value is 0, which indicates that frames are extracted until the end of the video.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + 'backendName' => 'Number', + ], + 'ScaleType' => [ + 'title' => 'ScaleType', + 'description' => 'The resizing mode. Valid values:'."\n" + ."\n" + .'* stretch: stretches the image to fill the entire space. This is the default value.'."\n" + .'* crop: resizes and crops the image.'."\n" + .'* fill: resizes the image and keeps the black border.'."\n" + .'* fit: resizes the image and removes the black border.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'crop', + 'backendName' => 'ScaleType', + ], + 'StartTime' => [ + 'title' => 'StartTime', + 'description' => 'The start time for extracting frames. Unit: seconds. Default value: 0.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + 'backendName' => 'StartTime', + 'parseType' => 'struct', + ], + 'Height' => [ + 'title' => 'Height', + 'description' => 'The height of the animated image. By default, the animated image has the same height as the source video. The value of the parameter can be an integer or a decimal.'."\n" + ."\n" + .'* An integer: the number of pixels. Valid values: \\[1,4096].'."\n" + .'* A decimal: the ratio relative to the height of the target image resolution. Valid values: (0,1).'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '960', + 'backendName' => 'Height', + ], + 'URI' => [ + 'title' => 'URI', + 'description' => 'The URI of the animated image.'."\n" + ."\n" + .'The OSS URI follows the oss://bucket/object format, where bucket is the name of the bucket in the same region as the current project and object is the path of the object with the extension included.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/animations', + 'backendName' => 'URI', + ], + 'Width' => [ + 'title' => 'Width', + 'description' => 'The width of the animated image. By default, the animated image has the same width as the source video. The value of the parameter can be an integer or a decimal.'."\n" + ."\n" + .'* An integer: the number of pixels. Valid values: \\[1,4096].'."\n" + .'* A decimal: the ratio relative to the width of the target image resolution. Valid values: (0,1).'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '1280', + 'backendName' => 'Width', + ], + 'Interval' => [ + 'title' => 'Interval', + 'description' => 'The time interval for extracting frames. Unit: seconds.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0.5', + 'backendName' => 'Interval', + 'parseType' => 'struct', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'Animations', + ], + 'Snapshots' => [ + 'title' => 'Snapshots', + 'description' => 'The frames.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the frame.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'title' => 'Format', + 'description' => 'The format of the frame. Valid values:'."\n" + ."\n" + .'* jpg'."\n" + .'* png'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'example' => 'jpg', + 'backendName' => 'Format', + ], + 'Number' => [ + 'title' => 'Number', + 'description' => 'The number of frames. The default value is 0, which indicates that frames are captured until the end of the video.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'backendName' => 'Number', + ], + 'ScaleType' => [ + 'title' => 'ScaleType', + 'description' => 'The resizing mode. Valid values:'."\n" + ."\n" + .'* stretch: stretches the image to fill the entire space. This is the default value.'."\n" + .'* crop: resizes and crops the image.'."\n" + .'* fill: resizes the image and keeps the black border.'."\n" + .'* fit: resizes the image and removes the black border.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'crop', + 'backendName' => 'ScaleType', + ], + 'Mode' => [ + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'interval', + 'backendName' => 'Mode', + ], + 'StartTime' => [ + 'title' => 'StartTime', + 'description' => 'The time in seconds at which frame capturing starts. The default value is 0, which indicates that frame capturing starts at the beginning of the video.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + 'backendName' => 'StartTime', + 'parseType' => 'struct', + ], + 'Height' => [ + 'title' => 'Height', + 'description' => 'The height of the frame image. By default, the image has the same height as the source video. The value of the parameter can be an integer or a decimal.'."\n" + ."\n" + .'* An integer: the number of pixels. Valid values: \\[1,4096].'."\n" + .'* A decimal: the ratio relative to the height of the target image resolution. Valid values: (0,1).'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '960', + 'backendName' => 'Height', + ], + 'URI' => [ + 'title' => 'URI', + 'description' => 'The OSS URI of the frame.'."\n" + ."\n" + .'The OSS URI follows the oss://bucket/object format, where bucket is the name of the bucket in the same region as the current project and object is the path of the object with the extension included.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/snapshots', + 'backendName' => 'URI', + ], + 'Width' => [ + 'title' => 'Width', + 'description' => 'The width of the frame image. By default, the image has the same width as the source video. The value of the parameter can be an integer or a decimal.'."\n" + ."\n" + .'* An integer: the number of pixels. Valid values: \\[1,4096].'."\n" + .'* A decimal: the ratio relative to the width of the target image resolution. Valid values: (0,1).'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '1280', + 'backendName' => 'Width', + ], + 'Interval' => [ + 'title' => 'Interval', + 'description' => 'The time interval of frame capturing in seconds.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0.5', + 'backendName' => 'Interval', + 'parseType' => 'struct', + ], + 'Threshold' => [ + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'backendName' => 'Threshold', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'Snapshots', + ], + ], + ], + 'TargetSubtitle' => [ + 'title' => 'Subtitle Struct', + 'description' => 'The subtitle processing settings.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'DisableSubtitle' => [ + 'title' => 'DisableSubtitle', + 'description' => 'Specifies whether to disable subtitle generation. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false (default)'."\n" + ."\n" + .'> If you call the GenerateVideoPlaylist operation and subtitles are required, you must set this parameter to false.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'false', + 'backendName' => 'DisableSubtitle', + ], + 'Stream' => [ + 'title' => 'Stream', + 'description' => 'The index numbers of subtitle streams that need to be processed. If you set this parameter to null (default) or a value greater than 100, all subtitle streams are processed.'."\n" + ."\n" + .'* For example, you can set the parameter to `[0,1]` to process subtitle streams with index numbers 0 and 1, `[1]` to process only the subtitle stream with the index number 1, and `[101]` to process all subtitle streams.'."\n" + ."\n" + .'> If you specify an index number but no subtitle stream with the index number is found, the index number is ignored.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The index number of the subtitle stream that needs to be processed.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'extendType' => 'true', + ], + 'backendName' => 'Stream', + ], + 'ExtractSubtitle' => [ + 'title' => 'ExtractSubtitle', + 'description' => 'The subtitle extraction settings.'."\n" + ."\n" + .'> The GenerateVideoPlaylist operation does not support this parameter.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'title' => 'URI', + 'description' => 'The prefix of the OSS URI where the extracted subtitles are stored. The OSS URI is in the oss://bucket/object format, where bucket specifies the name of the OSS bucket that is in the same region as the current project and object specifies the full file path that includes the file name extension.'."\n" + ."\n" + .'* Example: If the prefix is oss://examplebucket/outputSubtitle, an output subtitle file has a URI in the format of oss://examplebucket/outputSubitile\\_${index}.${ext}. In the URI format, ${ext} is the file name extension of the output subtitle file, and ${index} is the same 0-based index number as that of the corresponding source subtitle stream file.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss://test-bucket/extractsubtitle', + 'backendName' => 'URI', + ], + 'Format' => [ + 'title' => 'Format', + 'description' => 'The format of the extracted subtitle file. Valid values:'."\n" + ."\n" + .'* ass'."\n" + .'* srt'."\n" + .'* webvtt'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'webvtt', + 'backendName' => 'Format', + ], + ], + 'backendName' => 'ExtractSubtitle', + ], + ], + ], + 'TargetVideo' => [ + 'title' => 'Video Struct', + 'description' => 'The video processing settings.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'DisableVideo' => [ + 'title' => 'DisableVideo', + 'description' => 'Specifies whether to disable video stream generation. Valid values:'."\n" + ."\n" + .'* true: disables video stream generation. No video stream is included in the output file.'."\n" + .'* false: does not disable video stream generation. This is the default value.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'false', + 'backendName' => 'DisableVideo', + ], + 'TranscodeVideo' => [ + 'title' => 'TranscodeVideo', + 'description' => 'The video transcoding parameters. If you do not specify this parameter, no video streams are included in the output file.'."\n" + ."\n" + .'> We recommend that you do not use this parameter to disable video stream generation.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'FrameRate' => [ + 'title' => 'FrameRate', + 'description' => 'The target frame rate. By default, the target frame rate is the same as the source frame rate.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '25', + 'backendName' => 'FrameRate', + ], + 'FrameRateOption' => [ + 'title' => 'FrameRateOption', + 'description' => 'The frame rate option. Valid values:'."\n" + ."\n" + .'* fixed: always uses the target frame rate.'."\n" + .'* adaptive: uses the source frame rate when the source frame rate is less than the target frame rate.'."\n" + .'* fall: returns a failure if the source frame rate is less than the target frame rate.'."\n" + ."\n" + .'Default value:'."\n" + ."\n" + .'* fixed for the CreateMediaConvert operation.'."\n" + .'* adaptive for the GenerateVideoPlaylist operation.'."\n" + ."\n" + .'> This parameter must be used together with the **FrameRate** parameter.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'fixed', + 'backendName' => 'FrameRateOption', + ], + 'Refs' => [ + 'title' => 'Refs', + 'description' => 'The number of reference frames. Default value: 2.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'backendName' => 'Refs', + ], + 'Preset' => [ + 'title' => 'Preset', + 'description' => 'Preset', + 'visibility' => 'Private', + 'type' => 'string', + 'example' => '{}', + 'backendName' => 'Preset', + ], + 'ScaleType' => [ + 'title' => 'ScaleType', + 'description' => 'The resizing mode. Valid values:'."\n" + ."\n" + .'* stretch: forcibly stretches the video based on the specified width and height or long side and short side to fill any remaining space. This is the default value.'."\n" + .'* crop: proportionally resizes the video to the minimum resolution outside the rectangular shape based on the specified width and height or long side and short side, and crops the parts beyond the rectangular shape from the center.'."\n" + .'* fill: proportionally resizes the video to the maximum resolution within the rectangular shape based on the specified width and height or long side and short side, and fills empty space with black from the center.'."\n" + .'* fit: proportionally resizes the video to the maximum resolution that fits within the specified width and height or long side and short side.'."\n" + ."\n" + .'> This parameter must be used together with the **Resolution** parameter.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'crop', + 'backendName' => 'ScaleType', + ], + 'ResolutionOption' => [ + 'title' => 'ResolutionOption', + 'description' => 'The resolution option. Valid values:'."\n" + ."\n" + .'* fixed: always uses the target video resolution.'."\n" + .'* adaptive: uses the source video resolution when the source video resolution is less than the target video resolution.'."\n" + .'* fall: returns a failure when the source video resolution is less than the target video resolution.'."\n" + ."\n" + .'Default value:'."\n" + ."\n" + .'* fixed for the CreateMediaConvert operation.'."\n" + .'* adaptive for the GenerateVideoPlaylist operation.'."\n" + ."\n" + .'> This parameter must be used together with the **Resolution** parameter.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'fixed', + 'backendName' => 'ResolutionOption', + ], + 'BFrames' => [ + 'title' => 'BFrames', + 'description' => 'The number of consecutive B frames. Default value: 3.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + 'backendName' => 'BFrames', + ], + 'Rotation' => [ + 'title' => 'Rotation', + 'description' => 'The degrees to rotate the video clockwise. Valid values:'."\n" + ."\n" + .'* 0 (default)'."\n" + .'* 90'."\n" + .'* 180'."\n" + .'* 270'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + 'backendName' => 'Rotation', + ], + 'Bitrate' => [ + 'title' => 'Bitrate', + 'description' => 'The bitrate of the video stream. Unit: bit/s.'."\n" + ."\n" + .'> This parameter and the **CRF** parameter are mutually exclusive. If you leave both the parameters empty, the **CRF** parameter with a value of 23 applies.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '128000', + 'backendName' => 'Bitrate', + ], + 'BufferSize' => [ + 'title' => 'BufferSize', + 'description' => 'The size of the buffer for decoding when the dynamic bitrate is used. Unit: bit/s.'."\n" + ."\n" + .'> This parameter must be used together with the **CRF** parameter.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4000000', + 'backendName' => 'BufferSize', + ], + 'Codec' => [ + 'title' => 'Codec', + 'description' => 'The video coding format. Valid values:'."\n" + ."\n" + .'* copy, h264, h265, and vp9 for the CreateMediaConvert operation. The default value is copy.'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Warning **When you set the parameter to copy, the video stream is directly copied into the output file and all other parameters in TranscodeVideo do not take effect. The copy value is commonly used in container format conversion scenarios. You cannot use this value in video merging scenarios.'."\n" + ."\n" + .'* h264 and h265 for the GenerateVideoPlaylist operation. The default value is h264.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'h264', + 'backendName' => 'Codec', + ], + 'CRF' => [ + 'title' => 'CRF', + 'description' => 'The constant rate factor (CRF) of the video. The value of this parameter falls within the \\[0,51] range. A greater indicates lower quality. We recommend that you specify a value within the \\[18,38] range. This parameter and the **Bitrate** parameter are mutually exclusive.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '18', + 'backendName' => 'CRF', + ], + 'BitrateOption' => [ + 'title' => 'BitrateOption', + 'description' => 'The video bitrate option. Valid values:'."\n" + ."\n" + .'* fixed: always uses the target bitrate.'."\n" + .'* adaptive: uses the source bitrate when the source bitrate is less than the target bitrate.'."\n" + .'* fall: returns a failure when the source bitrate is less than the target bitrate.'."\n" + ."\n" + .'Default value:'."\n" + ."\n" + .'* fixed for the CreateMediaConvert operation.'."\n" + .'* adaptive for the GenerateVideoPlaylist operation.'."\n" + ."\n" + .'> This parameter must be used together with the **Bitrate** parameter.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'fixed', + 'backendName' => 'BitrateOption', + ], + 'PixelFormat' => [ + 'title' => 'PixelFormat', + 'description' => 'The pixel format. By default, the pixel format matches that of the source video. Valid values:'."\n" + ."\n" + .'* yuv420p'."\n" + .'* yuv422p'."\n" + .'* yuv444p'."\n" + .'* yuv420p10le'."\n" + .'* yuv422p10le'."\n" + .'* yuv444p10le'."\n" + .'* yuva420p'."\n" + ."\n" + .'> You can set the parameter to yuva420p only when you call the CreateMediaConvert operation and set the **Codec** parameter to vp9.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'yuv420p', + 'backendName' => 'PixelFormat', + ], + 'AdaptiveResolutionDirection' => [ + 'title' => 'AdaptiveResolutionDirection', + 'description' => 'Specifies whether to enable adaptation to resolution based on long and short sides. Valid values:'."\n" + ."\n" + .'* true: The format of the **Resolution** parameter is `LongSide×ShortSide`. This is the default value.'."\n" + .'* false: The format of the **Resolution** parameter is `Width×Height`.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'AdaptiveResolutionDirection', + ], + 'MaxBitrate' => [ + 'title' => 'MaxBitrate', + 'description' => 'The maximum bitrate when the dynamic bitrate is used. If you specify this parameter, you must also specify the BufferSize parameter.'."\n" + ."\n" + .'> This parameter must be used together with the **CRF** parameter.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '128000', + 'backendName' => 'MaxBitrate', + ], + 'GOPSize' => [ + 'title' => 'GOPSize', + 'description' => 'The keyframe interval. Default value: 150.'."\n" + ."\n" + .'> This parameter is not available to the GenerateVideoPlaylist operation.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + 'backendName' => 'GOPSize', + ], + 'Resolution' => [ + 'title' => 'Resolution', + 'description' => 'The target resolution in the `WidthxHeight` format. By default, the target resolution is the same as the source resolution. You can specify both width and height, or only one of them. You can use this parameter together with the **AdaptiveResolutionDirection** parameter to set both the long side and short side or one of them. The value of each side falls within the range of (0,4096].'."\n" + ."\n" + .'* Example 1: If **AdaptiveResolutionDirection** is set to false, `1280x720` specifies a width of 1280 pixels and a height of 720 pixels, `1280x` specifies a width of 1280 pixels and the same height as the source video, and `x720` specifies a height of 720 pixels and the same width as the source video.'."\n" + .'* Example 2: If **AdaptiveResolutionDirection** is set to true, `1280x720` specifies a long side of 1280 pixels and a short side of 720 pixels, `1280x` specifies a long side of 1280 pixels and the same short side as the source video, and `x720` specifies a short side of 720 pixels and the same long side as the source video.'."\n" + ."\n" + .'> If the source video contains rotation information, the width, height, long side, and short side depend on the frame after rotation (the playback resolution).'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '640x480', + 'backendName' => 'Resolution', + ], + ], + 'backendName' => 'TranscodeVideo', + ], + 'FilterVideo' => [ + 'title' => 'FilterVideo', + 'description' => 'The video processing parameters. This parameter is invalid if **TranscodeVideo** is left empty or **TranscodeVideo.Codec** is set to copy.'."\n" + ."\n" + .'> This parameter is not available to the GenerateVideoPlaylist operation.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Delogos' => [ + 'title' => 'Delogos', + 'description' => 'The configurations for blurring a rectangular area of the video. This parameter is used to remove logos from videos, such as TV channel logos.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The video blurring parameters.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Dx' => [ + 'title' => 'Dx', + 'description' => 'The value of the parameter can be an integer or a decimal.'."\n" + ."\n" + .'* 0: indicates that both the offset in pixels and the ratio of the horizontal offset relative to the height of the target resolution are 0. This is the default value.'."\n" + .'* An integer: the offset in pixels. Valid values: \\[1,4096].'."\n" + .'* A decimal: the ratio of the horizontal offset relative to the height of the target resolution. Valid values: (0,1).'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + 'backendName' => 'Dx', + ], + 'Dy' => [ + 'title' => 'Dy', + 'description' => 'Default value: 0. The value of the parameter can be an integer or a decimal.'."\n" + ."\n" + .'* 0: indicates that both the offset in pixels and the ratio of the vertical offset relative to the height of the target resolution are 0. This is the default value.'."\n" + .'* An integer: the offset in pixels. Valid values: \\[1,4096].'."\n" + .'* A decimal: the ratio of the vertical offset relative to the height of the target resolution. Valid values: (0,1).'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + 'backendName' => 'Dy', + ], + 'StartTime' => [ + 'title' => 'StartTime', + 'description' => 'The start time of blurring (in seconds). By default, the blur begins at the start time of the video.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + 'backendName' => 'StartTime', + 'parseType' => 'struct', + ], + 'Duration' => [ + 'title' => 'Duration', + 'description' => 'The duration of the blur in seconds. By default, the blur lasts until the end of the video.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '15', + 'backendName' => 'Duration', + 'parseType' => 'struct', + ], + 'Height' => [ + 'title' => 'Height', + 'description' => 'The height of the blur. The default value is 1.0, which specifies that the blur is as high as the video. The value can be a decimal or an integer.'."\n" + ."\n" + .'* An integer: the number of pixels. Valid values: \\[1,4096].'."\n" + .'* A decimal: the ratio relative to the height of the target resolution. Valid values: (0,1).'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '40', + 'backendName' => 'Height', + ], + 'ReferPos' => [ + 'title' => 'ReferPos', + 'description' => 'The reference position of the blur. Valid values:'."\n" + ."\n" + .'* topleft: the upper-left corner. This is the default value.'."\n" + .'* topright: the upper-right corner.'."\n" + .'* bottomright: the lower-right corner.'."\n" + .'* bottomleft: the lower-left corner.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'topleft', + 'backendName' => 'ReferPos', + ], + 'Width' => [ + 'title' => 'Width', + 'description' => 'The width of the blur. The default value is 1.0, which specifies that the blur is as wide as the video. The value can be a decimal or an integer.'."\n" + ."\n" + .'* An integer: the number of pixels. Valid values: \\[1,4096].'."\n" + .'* A decimal: the ratio relative to the width of the target resolution. Valid values: (0,1).'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + 'backendName' => 'Width', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'Delogos', + ], + 'Speed' => [ + 'description' => 'The video playback speed. Valid values: \\[0.5,1.0]. Default value: 1.0.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* This parameter specifies the ratio of the playback speed of the output media file to the default playback speed of the source media file. It does not indicate transcoding acceleration.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* This parameter only applies to the CreateMediaConvertTask operation.'."\n", + 'visibility' => 'Public', + 'type' => 'number', + 'format' => 'float', + 'example' => '1.0', + 'backendName' => 'Speed', + ], + 'Desensitization' => [ + 'description' => 'The video anonymization settings.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* This parameter only applies to the CreateMediaConvertTask operation.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'LicensePlate' => [ + 'description' => 'The settings for license plate anonymization.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'MinSize' => [ + 'description' => 'The minimum threshold for license plate size. This parameter does not take effect if the width or height of the bounding box of a license plate falls below the specified minimum threshold. Default value: 0.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'backendName' => 'MinSize', + ], + 'Confidence' => [ + 'description' => 'The minimum confidence threshold. Valid values: 0 to 1. Default value: 0.'."\n", + 'visibility' => 'Public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + 'backendName' => 'Confidence', + ], + ], + 'backendName' => 'LicensePlate', + ], + 'Face' => [ + 'description' => 'The settings for face anonymization.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'MinSize' => [ + 'description' => 'This parameter does not take effect if the width or height of the bounding box of a face falls below the specified minimum threshold. Default value: 0.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'backendName' => 'MinSize', + ], + 'Confidence' => [ + 'description' => 'The minimum confidence threshold. Valid values: 0 to 1. Default value: 0.'."\n", + 'visibility' => 'Public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + 'backendName' => 'Confidence', + ], + ], + 'backendName' => 'Face', + ], + ], + 'backendName' => 'Desensitization', + ], + 'Watermarks' => [ + 'title' => 'Watermarks', + 'description' => 'The video watermarks.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the watermark.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'title' => 'StartTime', + 'description' => 'The start time of watermarking (in seconds). By default, the watermark begins at the start time of the video.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + 'backendName' => 'StartTime', + 'parseType' => 'struct', + ], + 'FontColor' => [ + 'title' => 'FontColor', + 'description' => 'The color of the text watermark. You can specify a color name, such as "red" or "green", or an RGB color code. The default color is #000000.'."\n" + ."\n" + .'> This parameter takes effect only when the Type parameter is set to text.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'red', + 'backendName' => 'FontColor', + ], + 'BorderColor' => [ + 'title' => 'BorderColor', + 'description' => 'The color of the text watermark border. You can specify a color name, such as "red" or "green", or an RGB color code. The default color is #000000.'."\n" + ."\n" + .'> This parameter takes effect only when the Type parameter is set to text.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'red', + 'backendName' => 'BorderColor', + ], + 'Duration' => [ + 'title' => 'Duration', + 'description' => 'The duration of watermarking (in seconds). By default, the watermark lasts until the video ends.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + 'backendName' => 'Duration', + 'parseType' => 'struct', + ], + 'FontApha' => [ + 'title' => 'FontApha', + 'description' => 'The font transparency of the text watermark. Valid values: (0,1]. Default value: 1, which specifies that the text watermark is fully opaque.'."\n" + ."\n" + .'> This parameter takes effect only when the Type parameter is set to text.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8', + 'backendName' => 'FontApha', + ], + 'BorderWidth' => [ + 'title' => 'BorderWidth', + 'description' => 'The width of the text watermark border. Unit: pixels. The value must be an integer within the \\[0,4096] range. Default value: 0.'."\n" + ."\n" + .'> This parameter takes effect only when the Type parameter is set to text.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'backendName' => 'BorderWidth', + ], + 'URI' => [ + 'title' => 'URI', + 'description' => 'The Object Storage Service (OSS) URI of the watermark file. The watermark file can be a PNG or MOV file.'."\n" + ."\n" + .'The URI is in the `oss://<bucket>/<object>` format, where `<bucket>` is the name of the bucket in the same region as the current project and `<object>` is the path of the object with the extension included.'."\n" + ."\n" + .'> This parameter takes effect only when the Type parameter is set to file.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss://test-bucket/watermark', + 'backendName' => 'URI', + ], + 'Type' => [ + 'title' => 'Type', + 'description' => 'The watermark type. Valid values:'."\n" + ."\n" + .'* text: a text watermark. This is the default value.'."\n" + .'* file: a still or animated image watermark.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'text', + 'backendName' => 'Type', + ], + 'Dx' => [ + 'title' => 'Dx', + 'description' => 'The value of the parameter can be an integer or a decimal.'."\n" + ."\n" + .'* 0: indicates that both the offset in pixels and the ratio of the horizontal offset relative to the height of the target resolution are 0. This is the default value.'."\n" + .'* An integer: the offset in pixels. Valid values: \\[1,4096].'."\n" + .'* A decimal: the ratio of the horizontal offset relative to the height of the target resolution. Valid values: (0,1).'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + 'backendName' => 'Dx', + ], + 'Dy' => [ + 'title' => 'Dy', + 'description' => 'The value of the parameter can be an integer or a decimal.'."\n" + ."\n" + .'* 0: indicates that both the offset in pixels and the ratio of the vertical offset relative to the height of the target resolution are 0. This is the default value.'."\n" + .'* An integer: the offset in pixels. Valid values: \\[1,4096].'."\n" + .'* A decimal: the ratio of the vertical offset relative to the height of the target resolution. Valid values: (0,1).'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + 'backendName' => 'Dy', + ], + 'FontSize' => [ + 'title' => 'FontSize', + 'description' => 'The size of the text watermark. Default value: 16. The value must be an integer within the (4,120) range.'."\n" + ."\n" + .'> This parameter takes effect only when the Type parameter is set to text.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '18', + 'backendName' => 'FontSize', + ], + 'Content' => [ + 'title' => 'Content', + 'description' => 'The content of the text watermark. By default, this parameter is left empty.'."\n" + ."\n" + .'> This parameter takes effect only when the Type parameter is set to text.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'example', + 'backendName' => 'Content', + ], + 'FontName' => [ + 'title' => 'FontName', + 'description' => 'The font of the text watermark. Valid values:'."\n" + ."\n" + .'* SourceHanSans-Regular (default)'."\n" + .'* SourceHanSans-Bold'."\n" + .'* SourceHanSerif-Regular'."\n" + .'* SourceHanSerif-Bold'."\n" + ."\n" + .'> This parameter takes effect only when the Type parameter is set to text.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'SourceHanSans-Bold', + 'backendName' => 'FontName', + ], + 'Height' => [ + 'title' => 'Height', + 'description' => 'The height of the image watermark. By default, the height is the same as the height of the original watermark file. The value of the parameter can be an integer or a decimal.'."\n" + ."\n" + .'* An integer: the number of pixels excluding the height of the logo. Valid values: \\[1,4096].'."\n" + .'* A decimal: the ratio relative to the height of the target resolution. Valid values: (0,1).'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '40', + 'backendName' => 'Height', + ], + 'ReferPos' => [ + 'title' => 'ReferPos', + 'description' => 'The reference position for adding the watermark. Valid values:'."\n" + ."\n" + .'* topleft: the upper-left corner. This is the default value.'."\n" + .'* topright: the upper-right corner.'."\n" + .'* bottomright: the lower-right corner.'."\n" + .'* bottomleft: the lower-left corner.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'topleft', + 'backendName' => 'ReferPos', + ], + 'Width' => [ + 'title' => 'Width', + 'description' => 'The width of the image watermark. By default, the width is the same as the width of the original watermark file. The value of the parameter can be an integer or a decimal.'."\n" + ."\n" + .'* An integer: the number of pixels excluding the width of the logo. Valid values: \\[1,4096].'."\n" + .'* A decimal: the ratio relative to the width of the target resolution. Valid values: (0,1).'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'float', + 'example' => '80', + 'backendName' => 'Width', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'Watermarks', + ], + ], + 'backendName' => 'FilterVideo', + ], + 'Stream' => [ + 'title' => 'Stream', + 'description' => 'The index numbers of video streams. If you do not specify this parameter, the first video stream (the one with the smallest index number) is processed. If the array contains an element greater than 100, all video streams are processed.'."\n" + ."\n" + .'* For example, you can set the parameter to `[0,1]` to process video streams with index numbers 0 and 1, `[1]` to process only the video stream with the index number 1, and `[101]` to process all video streams.'."\n" + ."\n" + .'> If you specify an index number but no video stream with the index number is found, the index number is ignored.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The index number of the video stream.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'extendType' => 'true', + ], + 'backendName' => 'Stream', + ], + ], + ], + 'TaskInfo' => [ + 'title' => '', + 'description' => 'The task information.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '', + 'description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'* Running: The task is running.'."\n" + .'* Succeeded: The task is successful.'."\n" + .'* Failed: The task failed.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Running', + 'backendName' => 'Status', + ], + 'Code' => [ + 'title' => '', + 'description' => 'The error code.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'ResourceNotFound', + 'backendName' => 'Code', + ], + 'Message' => [ + 'title' => '', + 'description' => 'The error message.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'The specified resource project is not found.', + 'backendName' => 'Message', + ], + 'StartTime' => [ + 'title' => '', + 'description' => 'The start time of the task.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2021-12-24T03:01:41.662060377Z', + 'backendName' => 'StartTime', + ], + 'EndTime' => [ + 'title' => '', + 'description' => 'The end time of the task.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2021-12-24T03:01:49.480109219Z', + 'backendName' => 'EndTime', + ], + 'UserData' => [ + 'title' => '', + 'description' => 'The custom user data.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + 'backendName' => 'UserData', + ], + 'TaskType' => [ + 'title' => '', + 'description' => 'The type of the task.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'VideoLabelClassification', + 'backendName' => 'TaskType', + ], + 'TaskId' => [ + 'title' => '', + 'description' => 'The ID of the task.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'c2b277b9-0d30-4882-ad6d-ad661382****', + 'backendName' => 'TaskId', + ], + 'Tags' => [ + 'title' => '', + 'description' => 'The tags of the task. You can search for tasks by tag.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'backendName' => 'Tags', + ], + 'TaskRequestDefinition' => [ + 'title' => '', + 'description' => 'The parameter definition in the JSON string format. For more information, see the Request parameters section of the topic about an asynchronous processing task.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '{'."\n" + .' "ProjectName":"test-project",'."\n" + .' "CompressedFormat":"zip",'."\n" + .' "TargetURI":"oss://test-bucket/output/test.zip",'."\n" + .' "Sources":[{"URI":"oss://test-bucket/input/test.jpg"}]'."\n" + .'}', + 'backendName' => 'TaskRequestDefinition', + ], + 'Progress' => [ + 'title' => '', + 'description' => 'The progress of the task.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'backendName' => 'Progress', + ], + ], + ], + 'TimeRange' => [ + 'title' => 'A short description of struct', + 'description' => 'The time range.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'title' => 'start time', + 'description' => 'The start time.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2016-12-31T00:00:00+08:00', + 'backendName' => 'Start', + ], + 'End' => [ + 'title' => 'end time', + 'description' => 'The end time.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2016-12-31T00:00:00+08:00', + 'backendName' => 'End', + ], + ], + ], + 'ToolCall' => [ + 'title' => '', + 'description' => 'The tool that can be used by the AI assistant.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '', + 'description' => 'The type of the tool.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'function', + 'backendName' => 'Type', + ], + 'Function' => [ + 'description' => 'The definition of the function that can be called by the AI assistant.'."\n", + 'visibility' => 'Public', + 'backendName' => 'Function', + '$ref' => '#/components/schemas/FunctionCall', + ], + ], + ], + 'TrainingSpecification' => [ + 'title' => 'x', + 'description' => 'x'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ValidationSourceURI' => [ + 'title' => '', + 'description' => 'The URI of the evaluation dataset. You must specify this parameter or the ValidationSplit parameter.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'oss://imm-alg-dataset-bj/cifar10/test_index.json', + 'backendName' => 'ValidationSourceURI', + ], + 'Runtime' => [ + 'description' => 'The information about the runtime for model training.'."\n", + 'visibility' => 'Public', + 'required' => true, + 'backendName' => 'Runtime', + '$ref' => '#/components/schemas/Runtime', + ], + 'Endpoint' => [ + 'title' => '', + 'description' => 'The endpoint of the storage where the dataset is stored.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + 'backendName' => 'Endpoint', + ], + 'ModelSpecification' => [ + 'description' => 'The model specification details.'."\n", + 'visibility' => 'Public', + 'required' => true, + 'backendName' => 'ModelSpecification', + '$ref' => '#/components/schemas/ModelSpecification', + ], + 'DatasetName' => [ + 'title' => '', + 'description' => 'Name of the dataset'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'test-dataset', + 'backendName' => 'DatasetName', + ], + 'SourceURI' => [ + 'title' => '', + 'description' => 'URI of the dataset'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://imm-alg-dataset-bj/cifar10/test_index.json', + 'backendName' => 'SourceURI', + ], + 'Transforms' => [ + 'title' => '', + 'description' => 'Local preprocessing parameters for the dataset.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'Custom parameters for model training.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/CustomParams', + ], + 'backendName' => 'Transforms', + ], + 'ValidationSplit' => [ + 'title' => '', + 'description' => 'The ratio for splitting the training dataset into the evaluation dataset. You must specify this parameter or the ValidationSourceURI parameter.'."\n", + 'visibility' => 'Public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.95', + 'backendName' => 'ValidationSplit', + ], + 'TargetURI' => [ + 'title' => '', + 'description' => 'The storage path to the model data. Only an Object Storage Service (OSS) path is supported.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://imm-alg-dataset-bj/model_training_test/', + 'backendName' => 'TargetURI', + ], + ], + ], + 'TrimPolicy' => [ + 'title' => '', + 'description' => 'The trim policy for document conversion.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'DisableDeleteEmptyCell' => [ + 'title' => '', + 'description' => 'Specifies whether to prevent all empty cells from being deleted. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'DisableDeleteEmptyCell', + ], + 'DisableDeleteRepeatedStyle' => [ + 'title' => '', + 'description' => 'Specifies whether to prevent all duplicate styles from being deleted. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'DisableDeleteRepeatedStyle', + ], + 'DisableDeleteUnusedShape' => [ + 'title' => '', + 'description' => 'Specifies whether to prevent unused shapes from being deleted. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'DisableDeleteUnusedShape', + ], + 'DisableDeleteUnusedPicture' => [ + 'title' => '', + 'description' => 'Specifies whether to prevent unused cell images from being deleted. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'DisableDeleteUnusedPicture', + ], + ], + ], + 'VideoInsight' => [ + 'description' => 'Video summary and description.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => 'The description of the video file.'."\n" + ."\n" + .'> Not supported.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'nullable' => true, + 'backendName' => 'Description', + ], + 'Caption' => [ + 'description' => 'Video summary.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'nullable' => true, + 'backendName' => 'Caption', + ], + ], + 'nullable' => true, + ], + 'VideoStream' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the video stream.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => 'Index', + 'description' => 'The index number of the video stream.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + 'backendName' => 'Index', + ], + 'Language' => [ + 'title' => 'Language', + 'description' => 'The language used in the video stream. The language is indicated by using a BCP 47 language tag.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'en', + 'backendName' => 'Language', + ], + 'CodecName' => [ + 'title' => 'CodecName', + 'description' => 'The abbreviated name of the codec.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'h264', + 'backendName' => 'CodecName', + ], + 'CodecLongName' => [ + 'title' => 'CodecLongName', + 'description' => 'The full name of the codec.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', + 'backendName' => 'CodecLongName', + ], + 'Profile' => [ + 'title' => 'Profile', + 'description' => 'The profile.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'High', + 'backendName' => 'Profile', + ], + 'CodecTimeBase' => [ + 'title' => 'CodecTimeBase', + 'description' => 'The time base of the codec.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '1373627/83160000', + 'backendName' => 'CodecTimeBase', + ], + 'CodecTagString' => [ + 'title' => 'CodecTagString', + 'description' => 'The description of the codec tag.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'avc1', + 'backendName' => 'CodecTagString', + ], + 'CodecTag' => [ + 'title' => 'CodecTag', + 'description' => 'The tag of the codec.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '0x31637661', + 'backendName' => 'CodecTag', + ], + 'Width' => [ + 'title' => 'Width', + 'description' => 'The image width of the video stream. Unit: pixels.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1280', + 'backendName' => 'Width', + ], + 'Height' => [ + 'title' => 'Height', + 'description' => 'The image height of the video stream. Unit: pixels.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '720', + 'backendName' => 'Height', + ], + 'HasBFrames' => [ + 'title' => 'HasBFrames', + 'description' => 'Specifies whether the video stream contains B frames.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + 'backendName' => 'HasBFrames', + ], + 'SampleAspectRatio' => [ + 'title' => 'SampleAspectRatio', + 'description' => 'The sampling aspect ratio of the video stream.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '1:1', + 'backendName' => 'SampleAspectRatio', + ], + 'DisplayAspectRatio' => [ + 'title' => 'DisplayAspectRatio', + 'description' => 'The display aspect ratio of the video stream.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '16:9', + 'backendName' => 'DisplayAspectRatio', + ], + 'PixelFormat' => [ + 'title' => 'PixelFormat', + 'description' => 'The pixel format of the video stream.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'yuv420p', + 'backendName' => 'PixelFormat', + ], + 'Level' => [ + 'title' => 'Level', + 'description' => 'The level.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '40', + 'backendName' => 'Level', + ], + 'FrameRate' => [ + 'title' => 'FrameRate', + 'description' => 'The frame rate of the video stream.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '25/1', + 'backendName' => 'FrameRate', + ], + 'AverageFrameRate' => [ + 'title' => 'AverageFrameRate', + 'description' => 'The average frame rate of the video stream.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '25/1', + 'backendName' => 'AverageFrameRate', + ], + 'TimeBase' => [ + 'title' => 'TimeBase', + 'description' => 'The time base.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '1/12800', + 'backendName' => 'TimeBase', + ], + 'StartTime' => [ + 'title' => 'StartTime', + 'description' => 'The start time of the video stream. Unit: seconds.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.000000', + 'backendName' => 'StartTime', + ], + 'Duration' => [ + 'title' => 'Duration', + 'description' => 'The duration of the video stream. Unit: seconds.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '22.88', + 'backendName' => 'Duration', + ], + 'Bitrate' => [ + 'title' => 'Bitrate', + 'description' => 'The bitrate. Unit: bit/s.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5407765', + 'backendName' => 'Bitrate', + ], + 'FrameCount' => [ + 'title' => 'FrameCount', + 'description' => 'The number of frames.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '572', + 'backendName' => 'FrameCount', + ], + 'Rotate' => [ + 'title' => 'Rotate', + 'description' => 'The image rotation angle of the video stream.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '90', + 'backendName' => 'Rotate', + ], + 'BitDepth' => [ + 'title' => 'BitDepth', + 'description' => 'The bit depth.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8', + 'backendName' => 'BitDepth', + ], + 'ColorSpace' => [ + 'title' => 'ColorSpace', + 'description' => 'The color space.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'bt709', + 'backendName' => 'ColorSpace', + ], + 'ColorRange' => [ + 'title' => 'ColorRange', + 'description' => 'The color range.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'tv', + 'backendName' => 'ColorRange', + ], + 'ColorTransfer' => [ + 'title' => 'ColorTransfer', + 'description' => 'The color transfer function.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'bt709', + 'backendName' => 'ColorTransfer', + ], + 'ColorPrimaries' => [ + 'title' => 'ColorPrimaries', + 'description' => 'The primary colors.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'bt709', + 'backendName' => 'ColorPrimaries', + ], + ], + ], + 'WebofficePermission' => [ + 'title' => '', + 'description' => 'The WebOffice user permissions.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Rename' => [ + 'title' => '', + 'description' => 'Specifies whether the user has the permission to rename a file. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'> You can query the operation information only based a notification sent to Simple Message Queue (SMQ). A rename event is included in the notification.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'Rename', + ], + 'Readonly' => [ + 'title' => '', + 'description' => 'Specifies whether the user has read-only access to the file. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'false', + 'backendName' => 'Readonly', + ], + 'History' => [ + 'title' => '', + 'description' => 'Specifies whether the user has the permission to view historical versions. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'History', + ], + 'Print' => [ + 'title' => '', + 'description' => 'Specifies whether the user has the printing permission. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'false', + 'backendName' => 'Print', + ], + 'Export' => [ + 'title' => '', + 'description' => 'Specifies whether the user has the permission to export the file as a PDF file. Valid values:'."\n" + ."\n" + .'* true: The user has the permission to export the file as a PDF file. If you set this parameter to true, you must set the Print parameter to true.'."\n" + .'* false: The user does not have the permission to export the file as a PDF file.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'false', + 'backendName' => 'Export', + ], + 'Copy' => [ + 'title' => '', + 'description' => 'Specifies whether the user has the copy permission. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'false', + 'backendName' => 'Copy', + ], + ], + ], + 'WebofficeUser' => [ + 'title' => '', + 'description' => 'The WebOffice user information.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'Id', + 'description' => 'The custom user ID. The user ID is displayed on the WebOffice page. A user ID can contain letters and digits and cannot exceed 15 characters in length.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'user1', + 'backendName' => 'Id', + ], + 'Name' => [ + 'title' => '', + 'description' => 'The custom username. The username is displayed on the WebOffice page. The username must meet the following requirements:'."\n" + ."\n" + .'* A username can contain digits, letters, hyphens (-), underscores (\\_), plus signs (+), forward slashes (/), equal signs (=), and at signs (@).'."\n" + .'* A username can contain up to 32 characters.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'test-user1', + 'backendName' => 'Name', + ], + 'Avatar' => [ + 'title' => '', + 'description' => 'The custom URL of the avatar picture. The avatar picture is displayed on the WebOffice page.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'http://example.com/?id=user1', + 'backendName' => 'Avatar', + ], + ], + ], + 'WebofficeWatermark' => [ + 'title' => '', + 'description' => 'The WebOffice watermark information.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '', + 'description' => 'The watermark type. Valid values:'."\n" + ."\n" + .'* 0: no watermark.'."\n" + .'* 1: text watermark.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'backendName' => 'Type', + ], + 'Value' => [ + 'title' => '', + 'description' => 'The watermark text.'."\n" + ."\n" + .'> This parameter takes effect only if you set the Type parameter to 1.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'example', + 'backendName' => 'Value', + ], + 'Rotate' => [ + 'title' => '', + 'description' => 'The rotation of the text watermark. Unit: radian.'."\n", + 'visibility' => 'Public', + 'type' => 'number', + 'format' => 'float', + 'example' => '-0.7853982', + 'backendName' => 'Rotate', + ], + 'Vertical' => [ + 'title' => '', + 'description' => 'The vertical spacing of the text watermark. Unit: pixel.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + 'backendName' => 'Vertical', + ], + 'Horizontal' => [ + 'title' => '', + 'description' => 'The horizontal spacing of the text watermark. Unit: pixel.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + 'backendName' => 'Horizontal', + ], + 'Font' => [ + 'title' => '', + 'description' => 'The font of the text watermark.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'bold 20px Serif', + 'backendName' => 'Font', + ], + 'FillStyle' => [ + 'title' => '', + 'description' => 'The color and transparency of the text watermark.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'rgba(192, 192, 192, 0.6)', + 'backendName' => 'FillStyle', + ], + ], + ], + ], + ], + 'apis' => [ + 'ListRegions' => [ + 'summary' => 'Get the list of regions', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'abilityTreeCode' => '143479', + 'abilityTreeNodes' => [ + 'FEATUREimmKH590Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => 'Language type. The range of values is as follows:'."\n" + .'- zh-CN: Chinese'."\n" + .'- en-US: English'."\n" + .'- ja: Japanese', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => 'Response structure', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => 'Request ID for the interface.', + 'type' => 'string', + 'example' => '7F7D235C-76FF-4B65-800C-8238AE3F****', + ], + 'Regions' => [ + 'description' => 'List of Regions.', + 'type' => 'array', + 'items' => [ + 'description' => 'Region structure information.', + 'enumValueTitles' => [], + '$ref' => '#/components/schemas/RegionType', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F7D235C-76FF-4B65-800C-8238AE3F****\\",\\n \\"Regions\\": [\\n {\\n \\"RegionId\\": \\"\\",\\n \\"LocalName\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'List of Regions Supporting IMM Service', + 'translator' => 'machine', + ], + 'CreateProject' => [ + 'summary' => 'Creates a project.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '436', + 'abilityTreeNodes' => [ + 'FEATUREimmKH590Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project. The name must meet the following requirements:'."\n" + ."\n" + .'* The name must be 1 to 128 characters in length'."\n" + .'* and can contain only letters, digits, hyphens (-), and underscores (\\_).'."\n" + .'* The name must start with a letter or an underscores (\\_).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the project. The description must be 1 to 256 characters in length. You can leave this parameter empty.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'immtest', + ], + ], + [ + 'name' => 'ServiceRole', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Resource Access Management (RAM) role. You must attach the RAM role to IMM to allow IMM to access other cloud resources, such as Object Storage Service (OSS). Default value: `AliyunIMMDefaultRole`.'."\n" + ."\n" + .'You can also create a custom role in the RAM console and grant the required permissions to the role based on your business requirements. For more information, see [Grant permissions to a RAM user](~~477257~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunIMMDefaultRole', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the workflow template. You can leave this parameter empty. For more information, see [Workflow templates and operators](~~466304~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Official:AllFunction', + ], + ], + [ + 'name' => 'ProjectMaxDatasetCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of datasets in the project. Valid values: 1 to 1000000000. Default value: 1000000000.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000000000', + ], + ], + [ + 'name' => 'DatasetMaxBindCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of bindings for each dataset. Valid values: 1 to 10. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'DatasetMaxFileCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of files in each dataset. Valid values: 1 to 100000000. Default value: 10000000000.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000000', + ], + ], + [ + 'name' => 'DatasetMaxEntityCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of metadata entities in each dataset. Default value: 10000000000.'."\n" + ."\n" + .'> This is a precautionary setting that does not impose practical limitations.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000000000', + ], + ], + [ + 'name' => 'DatasetMaxRelationCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of metadata relationships in each dataset. Default value: 100000000000.'."\n" + ."\n" + .'> This is a precautionary setting that does not impose practical limitations.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000000000', + ], + ], + [ + 'name' => 'DatasetMaxTotalFileSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum size of files in each dataset. If the maximum size is exceeded, no indexes can be added. Unit: bytes. Default value: 90000000000000000.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '90000000000000000', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '本次请求的唯一 ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7F7D235C-76FF-4B65-800C-8238AE3F****', + ], + 'Project' => [ + 'description' => 'The project.'."\n", + '$ref' => '#/components/schemas/Project', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7F7D235C-76FF-4B65-800C-8238AE3F****\\",\\n \\"Project\\": {\\n \\"ProjectName\\": \\"\\",\\n \\"ServiceRole\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"ProjectQueriesPerSecond\\": 0,\\n \\"EngineConcurrency\\": 0,\\n \\"ProjectMaxDatasetCount\\": 0,\\n \\"DatasetMaxBindCount\\": 0,\\n \\"DatasetMaxFileCount\\": 0,\\n \\"DatasetMaxEntityCount\\": 0,\\n \\"DatasetMaxRelationCount\\": 0,\\n \\"DatasetMaxTotalFileSize\\": 0,\\n \\"DatasetCount\\": 0,\\n \\"FileCount\\": 0,\\n \\"TotalFileSize\\": 0,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"\\",\\n \\"TagValue\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateProject', + 'description' => '* The name of a project must be unique in a region.'."\n" + ."\n" + .'* By default, you can create up to 100 projects in a region. If you want to request a quota increase to create more projects, submit a ticket or join the DingTalk chat group (ID: 88490020073).'."\n" + ."\n" + .'* After you create a project, you can create other Intelligent Media Management (IMM) resources in the project. For more information, see the following links:'."\n" + ."\n" + .' * [CreateDataset](~~478160~~)'."\n" + .' * [CreateTrigger](~~479912~~)'."\n" + .' * [CreateBatch](~~606694~~)'."\n" + .' * [CreateBinding](~~478202~~)'."\n", + ], + 'UpdateProject' => [ + 'summary' => 'Updates information about a project.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '495', + 'abilityTreeNodes' => [ + 'FEATUREimmKH590Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'ServiceRole', + 'in' => 'query', + 'schema' => [ + 'title' => '服务角色', + 'description' => 'The name of the Resource Access Management (RAM) role. You must grant the RAM role to Intelligent Media Management (IMM) before IMM can access other cloud resources such as Object Storage Service (OSS).'."\n" + ."\n" + .'You can also create a custom service role in the RAM console and grant the required permissions to the role based on your business requirements. For more information, see [Create a regular service role](~~116800~~) and [Grant permissions to a role](~~116147~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunIMMDefaultRole', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '项目描述', + 'description' => 'The description of the project. The description must be 1 to 256 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板Id', + 'description' => 'The ID of the workflow template. For more information, see [Workflow templates and operators](~~466304~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunIMMDefaultRole', + ], + ], + [ + 'name' => 'ProjectMaxDatasetCount', + 'in' => 'query', + 'schema' => [ + 'title' => '项目最多媒体集数', + 'description' => 'The maximum number of datasets in the project. Valid values: 1 to 1000000000.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000000000', + ], + ], + [ + 'name' => 'DatasetMaxBindCount', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最多绑定数', + 'description' => 'The maximum number of bindings for each dataset. Valid values: 1 to 10.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'DatasetMaxFileCount', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最多文件数', + 'description' => 'The maximum number of files in each dataset. Valid values: 1 to 100000000.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000000', + ], + ], + [ + 'name' => 'DatasetMaxEntityCount', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最多实体数', + 'description' => 'The maximum number of metadata entities in each dataset.'."\n" + ."\n" + .'> This is a precautionary setting that does not impose practical limitations.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000000000', + ], + ], + [ + 'name' => 'DatasetMaxRelationCount', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最多关系数', + 'description' => 'The maximum number of metadata relationships in a dataset.'."\n" + ."\n" + .'> This is a precautionary setting that does not impose practical limitations.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000000000', + ], + ], + [ + 'name' => 'DatasetMaxTotalFileSize', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最大文件总大小', + 'description' => 'The maximum size of files in each dataset. If the maximum size is exceeded, indexes can no longer be added. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '90000000000000000', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D33C3574-4093-448E-86E7-15BE2BD3****', + ], + 'Project' => [ + 'description' => 'The project.'."\n", + '$ref' => '#/components/schemas/Project', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D33C3574-4093-448E-86E7-15BE2BD3****\\",\\n \\"Project\\": {\\n \\"ProjectName\\": \\"\\",\\n \\"ServiceRole\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"ProjectQueriesPerSecond\\": 0,\\n \\"EngineConcurrency\\": 0,\\n \\"ProjectMaxDatasetCount\\": 0,\\n \\"DatasetMaxBindCount\\": 0,\\n \\"DatasetMaxFileCount\\": 0,\\n \\"DatasetMaxEntityCount\\": 0,\\n \\"DatasetMaxRelationCount\\": 0,\\n \\"DatasetMaxTotalFileSize\\": 0,\\n \\"DatasetCount\\": 0,\\n \\"FileCount\\": 0,\\n \\"TotalFileSize\\": 0,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"\\",\\n \\"TagValue\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'UpdateProject', + 'description' => '* Before you call this operation, make sure that the project exists. For information about how to create a project, see "CreateProject".'."\n" + .'* When you call this operation, you need to specify only the parameters that you want to update. The parameters that you do not specify remain unchanged after you call this operation.'."\n" + .'* Wait for up to 5 minutes for the update to take effect.'."\n", + ], + 'GetProject' => [ + 'summary' => 'Queries the basic information, datasets, and file statistics of a project.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '450', + 'abilityTreeNodes' => [ + 'FEATUREimmKH590Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project. You can obtain the name from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'WithStatistics', + 'in' => 'query', + 'schema' => [ + 'title' => '是否获取详细信息', + 'description' => 'Specifies whether to enable real-time retrieval of file statistics. Default value: false.'."\n" + ."\n" + .'* If you set the value to true, the returned values of FileCount and TotalFileSize in the response are valid.'."\n" + .'* If you set the value to false, the returned values of FileCount and TotalFileSize in the response are invalid or equal to 0.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A022F78-B9A8-4ACC-BB6B-B3597553', + ], + 'Project' => [ + 'description' => 'The project information.'."\n", + '$ref' => '#/components/schemas/Project', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5A022F78-B9A8-4ACC-BB6B-B3597553\\",\\n \\"Project\\": {\\n \\"ProjectName\\": \\"\\",\\n \\"ServiceRole\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"ProjectQueriesPerSecond\\": 0,\\n \\"EngineConcurrency\\": 0,\\n \\"ProjectMaxDatasetCount\\": 0,\\n \\"DatasetMaxBindCount\\": 0,\\n \\"DatasetMaxFileCount\\": 0,\\n \\"DatasetMaxEntityCount\\": 0,\\n \\"DatasetMaxRelationCount\\": 0,\\n \\"DatasetMaxTotalFileSize\\": 0,\\n \\"DatasetCount\\": 0,\\n \\"FileCount\\": 0,\\n \\"TotalFileSize\\": 0,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"\\",\\n \\"TagValue\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'GetProject', + 'description' => 'When you call this operation, you can enable the real-time retrieval of file statistics based on your business requirements. For more information, see the "Request parameters" section of this topic.'."\n", + ], + 'ListProjects' => [ + 'summary' => 'Queries projects. You can call this operation to query the basic information, datasets, and file statistics of multiple projects at the same time.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '763', + 'abilityTreeNodes' => [ + 'FEATUREimmKH590Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '返回结果的最大个数', + 'description' => 'The maximum number of entries to return. Valid values: 0 to 200. Default value: 100.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '当总结果个数大于MaxResults时，用于翻页的token', + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken. The operation returns the projects in lexicographical order starting from the location specified by NextToken.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDAx', + ], + ], + [ + 'name' => 'Prefix', + 'in' => 'query', + 'schema' => [ + 'title' => '列出包含某前缀的project', + 'description' => 'The prefix used by the projects that you want to query. The prefix must be up to 128 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'title' => '当总结果个数大于MaxResults时，用于翻页的token', + 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", + 'type' => 'string', + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDAx', + ], + 'Projects' => [ + 'title' => '由ProjectItem组成的数组', + 'description' => 'The projects.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The project information.'."\n", + '$ref' => '#/components/schemas/Project', + ], + ], + 'RequestId' => [ + 'title' => '本次请求的唯一 ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4A7A2D0E-D8B8-4DA0-8127-EB32C660', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"MTIzNDU2Nzg6aW1tdGVzdDAx\\",\\n \\"Projects\\": [\\n {\\n \\"ProjectName\\": \\"\\",\\n \\"ServiceRole\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"ProjectQueriesPerSecond\\": 0,\\n \\"EngineConcurrency\\": 0,\\n \\"ProjectMaxDatasetCount\\": 0,\\n \\"DatasetMaxBindCount\\": 0,\\n \\"DatasetMaxFileCount\\": 0,\\n \\"DatasetMaxEntityCount\\": 0,\\n \\"DatasetMaxRelationCount\\": 0,\\n \\"DatasetMaxTotalFileSize\\": 0,\\n \\"DatasetCount\\": 0,\\n \\"FileCount\\": 0,\\n \\"TotalFileSize\\": 0,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"\\",\\n \\"TagValue\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"4A7A2D0E-D8B8-4DA0-8127-EB32C660\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'ListProjects', + 'description' => 'The ListProjects operation supports pagination. When you call this operation, you must specify the token that is obtained from the previous query as the value of NextToken. You must also specify MaxResults to limit the number of entries to return.'."\n", + ], + 'DeleteProject' => [ + 'summary' => 'Deletes a project.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project. For more information, see [Create a project](~~478153~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '本次请求的唯一 ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'FEDC9B1F-30F2-4C1F-8ED2-B7860187****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'StatusConflict', + 'errorMessage' => 'Message: cannot delete when sub resoures exist', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEDC9B1F-30F2-4C1F-8ED2-B7860187****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'DeleteProject', + 'description' => '* Before you delete a project, make sure that all resources in the project, such as datasets, bindings, batch processing tasks, and triggers, are deleted. For more information, see [DeleteDataset](~~478164~~), [DeleteBatch](~~479918~~), and [DeleteTrigger](~~479915~~).'."\n" + .'* After a project is deleted, all resources used by the project are recycled, and all related data is lost and cannot be recovered.'."\n", + ], + 'CreateDataset' => [ + 'summary' => 'Creates a dataset.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project. For more information on how to obtain it, see [Create Project](~~478153~~).', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'title' => '数据集名称', + 'description' => 'The name of the dataset, which must be unique under the same Project. Naming rules are as follows:'."\n" + .'- Length should be 1~128 characters.'."\n" + .'- Can only contain English letters, numbers, hyphens (-), and underscores (_).'."\n" + .'- Must start with an English letter or underscore (_).', + 'type' => 'string', + 'required' => true, + 'example' => 'dataset001', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '对数据集的描述', + 'description' => 'Description of the dataset. The length should be 1~256 English or Chinese characters, with a default value of empty.', + 'type' => 'string', + 'required' => false, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板Id', + 'description' => 'Workflow template ID. For more information, see [Workflow Templates and Operators](~~466304~~). The default value is empty.', + 'type' => 'string', + 'required' => false, + 'example' => 'Official:ImageManagement', + ], + ], + [ + 'name' => 'DatasetMaxBindCount', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最多帮定数', + 'description' => 'The maximum number of bindings per dataset. The range is 1~10, with a default value of 10.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'DatasetMaxFileCount', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最多文件数', + 'description' => 'The maximum number of files in each dataset. The range is 1~100000000, with a default value of 100000000.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000000', + ], + ], + [ + 'name' => 'DatasetMaxEntityCount', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最多实体数', + 'description' => 'The maximum number of metadata entities in each dataset. The default value is 10000000000.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000000000', + ], + ], + [ + 'name' => 'DatasetMaxRelationCount', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最多关系数', + 'description' => 'The maximum number of metadata relationships in each dataset. The default value is 100000000000.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000000000', + ], + ], + [ + 'name' => 'DatasetMaxTotalFileSize', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最大文件总大小', + 'description' => 'The maximum total size of files in each dataset. Once the limit is exceeded, no more indexes can be added. The default value is 90000000000000000, in bytes.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '90000000000000000', + ], + ], + [ + 'name' => 'WorkflowParameters', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Invalid parameter.', + 'type' => 'array', + 'items' => [ + 'description' => 'Invalid parameter.', + 'required' => false, + '$ref' => '#/components/schemas/WorkflowParameter', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => 'Response structure', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 ID', + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '6D74B3A9-5AC0-49F9-914D-E01589D3****', + ], + 'Dataset' => [ + 'description' => 'Dataset information.', + '$ref' => '#/components/schemas/Dataset', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6D74B3A9-5AC0-49F9-914D-E01589D3****\\",\\n \\"Dataset\\": {\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"DatasetMaxBindCount\\": 0,\\n \\"DatasetMaxFileCount\\": 0,\\n \\"DatasetMaxEntityCount\\": 0,\\n \\"DatasetMaxRelationCount\\": 0,\\n \\"DatasetMaxTotalFileSize\\": 0,\\n \\"BindCount\\": 0,\\n \\"FileCount\\": 0,\\n \\"TotalFileSize\\": 0,\\n \\"ClusterType\\": \\"\\",\\n \\"SmartClusterTaskStatus\\": {\\n \\"Status\\": \\"Succeeded\\",\\n \\"LastSucceededTime\\": \\"2024-06-29T14:50:13.011643661+08:00\\",\\n \\"StartTime\\": \\"2024-06-29T14:50:13.011643661+08:00\\"\\n },\\n \\"WorkflowParameters\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateDataset', + 'description' => '- **Please ensure that you fully understand the billing method and [pricing](~~477042~~) of the Intelligent Media Management product before using this interface.**'."\n" + .'- The dataset name must be unique within the same project.'."\n" + .'- There is a limit to the number of datasets that can be created, which can be queried through [GetProject](~~478155~~).'."\n" + .'- After creating a dataset, you can use [IndexFileMeta](~~478166~~) to build file metadata indexes, enabling diversified [data retrieval and statistics](~~478175~~) and intelligent management.', + 'translator' => 'machine', + ], + 'UpdateDataset' => [ + 'summary' => 'Update Media Set', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'Project name, for how to obtain it, please refer to [Create Project](~~478153~~).', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集名称', + 'description' => 'Dataset name, for how to obtain it, please refer to [Create Dataset](~~478160~~).', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '描述', + 'description' => 'Description of the dataset.', + 'type' => 'string', + 'required' => false, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板Id', + 'description' => 'Workflow template ID. For more information, please refer to [Workflow Templates and Operators](~~466304~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'Official:ImageManagement', + ], + ], + [ + 'name' => 'DatasetMaxBindCount', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最多绑定数', + 'description' => 'The maximum number of bindings per dataset. The value range is from 1 to 10.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'DatasetMaxFileCount', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最多文件数', + 'description' => 'The maximum number of files per dataset. The value range is from 1 to 100000000.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000000', + ], + ], + [ + 'name' => 'DatasetMaxEntityCount', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最多实体数', + 'description' => 'The maximum number of metadata entities (including data files, file relationships, clustering groups, etc.) per dataset, with a maximum value of 2^63-1.'."\n" + .'>Reserved parameter, no actual restriction in use.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000000000', + ], + ], + [ + 'name' => 'DatasetMaxRelationCount', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最多关系数', + 'description' => 'The maximum number of metadata relationships per dataset, with a maximum value of 2^63-1.'."\n" + .'>Reserved parameter, no actual restriction in use.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000000000', + ], + ], + [ + 'name' => 'DatasetMaxTotalFileSize', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最大文件总大小', + 'description' => 'The maximum total size of files in each dataset. Once the limit is exceeded, no more indexes can be added. The maximum value is 2^63-1, measured in bytes.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '90000000000000000', + ], + ], + [ + 'name' => 'WorkflowParameters', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Invalid parameter.', + 'type' => 'array', + 'items' => [ + 'description' => '无效参数。', + 'required' => false, + '$ref' => '#/components/schemas/WorkflowParameter', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '45234D4A-A3E3-4B23-AACA-8D897514****', + ], + 'Dataset' => [ + 'description' => '数据集。', + '$ref' => '#/components/schemas/Dataset', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"45234D4A-A3E3-4B23-AACA-8D897514****\\",\\n \\"Dataset\\": {\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"DatasetMaxBindCount\\": 0,\\n \\"DatasetMaxFileCount\\": 0,\\n \\"DatasetMaxEntityCount\\": 0,\\n \\"DatasetMaxRelationCount\\": 0,\\n \\"DatasetMaxTotalFileSize\\": 0,\\n \\"BindCount\\": 0,\\n \\"FileCount\\": 0,\\n \\"TotalFileSize\\": 0,\\n \\"ClusterType\\": \\"\\",\\n \\"SmartClusterTaskStatus\\": {\\n \\"Status\\": \\"Succeeded\\",\\n \\"LastSucceededTime\\": \\"2024-06-29T14:50:13.011643661+08:00\\",\\n \\"StartTime\\": \\"2024-06-29T14:50:13.011643661+08:00\\"\\n },\\n \\"WorkflowParameters\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'Update Dataset', + 'description' => '- **Please ensure that you fully understand the billing method and [pricing](~~477042~~) of the Intelligent Media Management product before using this interface.**'."\n" + ."\n" + .'- When updating dataset information, make sure the dataset has been successfully created. For creating a dataset, please refer to the request parameter description.'."\n" + .'- When updating dataset information, only fill in the fields that need to be updated; unfilled fields will not change.'."\n" + .'- The update of the dataset will not take effect immediately and may require up to 5 minutes to become effective.', + 'translator' => 'machine', + ], + 'GetDataset' => [ + 'summary' => 'Queries a dataset.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset. You can obtain the name of the dataset from the response of the [CreateDataset](~~478160~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dataset001', + ], + ], + [ + 'name' => 'WithStatistics', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable real-time retrieval of file statistics. Default value: false.'."\n" + ."\n" + .'* If you set the value to true, FileCount and TotalFileSize in the response return true and valid values.'."\n" + .'* If you set the value to false, FileCount and TotalFileSize in the response return invalid values or 0.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6D74B3A9-5AC0-49F9-914D-E01589D3****', + ], + 'Dataset' => [ + 'description' => 'The dataset.'."\n", + '$ref' => '#/components/schemas/Dataset', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6D74B3A9-5AC0-49F9-914D-E01589D3****\\",\\n \\"Dataset\\": {\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"DatasetMaxBindCount\\": 0,\\n \\"DatasetMaxFileCount\\": 0,\\n \\"DatasetMaxEntityCount\\": 0,\\n \\"DatasetMaxRelationCount\\": 0,\\n \\"DatasetMaxTotalFileSize\\": 0,\\n \\"BindCount\\": 0,\\n \\"FileCount\\": 0,\\n \\"TotalFileSize\\": 0,\\n \\"ClusterType\\": \\"\\",\\n \\"SmartClusterTaskStatus\\": {\\n \\"Status\\": \\"Succeeded\\",\\n \\"LastSucceededTime\\": \\"2024-06-29T14:50:13.011643661+08:00\\",\\n \\"StartTime\\": \\"2024-06-29T14:50:13.011643661+08:00\\"\\n },\\n \\"WorkflowParameters\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'GetDataset', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* The GetDataset operation supports real-time retrieval of file statistics. You can specify WithStatistics to enable real-time retrieval of file statistics.'."\n", + ], + 'ListDatasets' => [ + 'summary' => 'Queries a list of datasets. You can query the list by dataset prefix.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '返回最大个数', + 'description' => 'The maximum number of datasets to return. Valid values: 0 to 200.'."\n" + ."\n" + .'If this parameter is left empty or set to 0, 100 datasets are returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '当总结果个数大于MaxResults时，用于翻页的token', + 'description' => 'The pagination token.'."\n" + ."\n" + .'If the total number of datasets is greater than the value of MaxResults, you must specify this parameter. The list is returned in lexicographic order starting from the value of NextToken.'."\n" + ."\n" + .'> The first time you call this operation in a query, set this parameter to null.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12345678:immtest:dataset002', + ], + ], + [ + 'name' => 'Prefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dataset prefix.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dataset', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回结构体', + 'description' => 'The data structure returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'FEEDE356-C928-4A36-951A-6EB5A592****', + ], + 'NextToken' => [ + 'description' => 'The pagination token. If the total number of datasets is greater than the value of MaxResults, you must specify this parameter. This parameter has a value only if not all the datasets that meet the conditions are returned.'."\n" + ."\n" + .'Pass this value as the value of NextToken in the next call to query subsequent datasets.'."\n", + 'type' => 'string', + 'example' => '12345678:immtest:dataset002', + ], + 'Datasets' => [ + 'title' => 'Datasets', + 'description' => 'The datasets.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The dataset details.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The ListDatasets operation does not support file statistics, which may result in inaccuracies in the FileCount and TotalFileSize fields within the Dataset structure. For example, these fields can report a value of 0. To get accurate file statistics, call the [GetDataset](https://www.alibabacloud.com/help/zh/imm/developer-reference/api-imm-2020-09-30-getdataset) operation.'."\n", + '$ref' => '#/components/schemas/Dataset', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEEDE356-C928-4A36-951A-6EB5A592****\\",\\n \\"NextToken\\": \\"12345678:immtest:dataset002\\",\\n \\"Datasets\\": [\\n {\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"DatasetMaxBindCount\\": 0,\\n \\"DatasetMaxFileCount\\": 0,\\n \\"DatasetMaxEntityCount\\": 0,\\n \\"DatasetMaxRelationCount\\": 0,\\n \\"DatasetMaxTotalFileSize\\": 0,\\n \\"BindCount\\": 0,\\n \\"FileCount\\": 0,\\n \\"TotalFileSize\\": 0,\\n \\"ClusterType\\": \\"\\",\\n \\"SmartClusterTaskStatus\\": {\\n \\"Status\\": \\"Succeeded\\",\\n \\"LastSucceededTime\\": \\"2024-06-29T14:50:13.011643661+08:00\\",\\n \\"StartTime\\": \\"2024-06-29T14:50:13.011643661+08:00\\"\\n },\\n \\"WorkflowParameters\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'ListDatasets', + ], + 'DeleteDataset' => [ + 'summary' => 'Deletes a dataset.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset. For information about how to create a dataset, see [CreateDataset](~~478160~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dataset001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'EC564B8B-BA5C-4499-B196-D9B9E76E****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC564B8B-BA5C-4499-B196-D9B9E76E****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'DeleteDataset', + 'description' => '* Before you delete a dataset, make sure that you have deleted all indexes in the dataset. For more information about how to delete indexes, see [DeleteFileMeta](~~478172~~) and [BatchDeleteFileMeta](~~478173~~).'."\n" + .'* Before you [delete a dataset](~~478160~~), make sure that you have deleted all bindings between the dataset and Object Storage Service (OSS) buckets. For more information about how to delete a binding, see [DeleteBinding](~~478205~~). The [DeleteBinding](~~478205~~) operation does not delete an index that is manually created, even if you set the `Cleanup` parameter to `true`. To delete indexes that are manually created, you must call the [DeleteFileMeta](~~478172~~) or [BatchDeleteFileMeta](~~478173~~) operation. For more information about the differences between automatically and manually created indexes, see [Create a metadata index](~~478166~~).'."\n", + ], + 'IndexFileMeta' => [ + 'summary' => 'Creates an index from metadata extracted by using techniques such as label recognition, face detection, and location detection from input files. You can retrieve data from the same dataset by using multiple methods.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '32774', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset. You can obtain the name of the dataset from the response of the [CreateDataset](~~478160~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'File', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The file for which you want to create a metadata index. The value must be in the JSON format.'."\n", + 'required' => true, + '$ref' => '#/components/schemas/InputFile', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom user information, which is returned in an asynchronous notification. The maximum length of a notification is 2048 bytes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The notification settings. For information about the asynchronous notification format, see [Asynchronous message examples](~~2743997~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****', + ], + 'EventId' => [ + 'description' => 'The event ID.'."\n", + 'type' => 'string', + 'example' => '30F-1D8FxFzDXKJH9YQdve4CjR****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'asynchronous', + 'callback' => 'imm::2020-09-30::GetFileMeta', + 'callbackInterval' => 10000, + 'maxCallbackTimes' => 3, + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6E93D6C9-5AC0-49F9-914D-E02678D3****\\",\\n \\"EventId\\": \\"30F-1D8FxFzDXKJH9YQdve4CjR****\\"\\n}","type":"json"}]', + 'title' => 'IndexFileMeta', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* For information about how to create indexes from metadata, see [Workflow templates and operators](~~466304~~).'."\n" + .'* For information about the limits on the maximum number and size of index files that you can create, see the "Limits on datasets" section of the [Limits](~~475569~~) topic. For information about how to create a dataset, see the "CreateDataset" topic.'."\n" + .'* For information about the regions in which you can create index files from metadata, see the "Datasets and indexes" section of the [Limits](~~475569~~) topic.'."\n" + .'* After you create an index from metadata, you can try [simple query](~~478175~~) to retrieve data. For information about other query capabilities, see [Query and statistics](~~2402363~~). You can also [create a face clustering task](~~478180~~) to group faces. For information about other clustering capabilities, see [Intelligent management](~~2402365~~).'."\n" + ."\n" + .'**'."\n" + ."\n" + .'**Usage notes**'."\n" + ."\n" + .'* The IndexFileMeta operation is asynchronous, indicating that it takes some time to process the data after a request is submitted. After the processing is complete, the metadata is stored in your dataset. The amount of time it takes for this process varies based on [the workflow template, the operator](~~466304~~), and the content of the file, ranging from several seconds to several minutes or even longer. You can subscribe to [Simple Message Service](~~2743997~~) for task completion notifications.', + ], + 'BatchIndexFileMeta' => [ + 'summary' => 'Indexes metadata of multiple objects into the specified dataset. The process involves data processing operations such as label detection, face detection, and location detection. Metadata indexing helps meet diverse data retrieval requirements.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '33174', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset.[](~~478160~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'Files', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The objects in Object Storage Service (OSS). Specify OSS objects by using a JSON array. You can specify up to 100 objects in an array.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the OSS object.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/InputFile', + ], + 'required' => true, + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The user-defined data that you want to return in asynchronous messages. This parameter takes effect only when you specify the MNS settings in the Notification parameter. The maximum information length is 2,048 bytes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "id": "test-id",'."\n" + .' "name": "test-name"'."\n" + .'}', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The notification settings. For information about the asynchronous notification format, see [Asynchronous message examples](~~2743997~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8F93E6D9-5AC0-49F9-914D-E02678A3****', + ], + 'EventId' => [ + 'description' => 'The event ID.'."\n", + 'type' => 'string', + 'example' => '387-1DAPFFZplUZhuCuhnB6I9H****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'asynchronous', + 'callback' => 'imm::2020-09-30::BatchGetFileMeta', + 'callbackInterval' => 10000, + 'maxCallbackTimes' => 3, + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8F93E6D9-5AC0-49F9-914D-E02678A3****\\",\\n \\"EventId\\": \\"387-1DAPFFZplUZhuCuhnB6I9H****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'BatchIndexFileMeta', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* Data processing operations supported for metadata processing vary with workflow templates. For more information, see [Workflow templates and operators](~~466304~~).'."\n" + .'* Metadata indexing poses limits on the total number and size of objects. For more information about these limits, see [Limits](~~475569~~). For more information about how to create'."\n" + .'* Metadata indexing is available in specific regions. For information about regions that support metadata indexing, see the "Data management and indexing" section of the [Limits](~~475569~~) topic.'."\n", + ], + 'UpdateFileMeta' => [ + 'summary' => 'Updates the partial metadata of the indexed files in a dataset.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '33172', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset. You can obtain the name of the dataset from the response of the [CreateDataset](~~478160~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'File', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The file and its metadata items to be updated. The value must be in the JSON format.'."\n", + 'required' => true, + '$ref' => '#/components/schemas/InputFile', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6D53E6C9-5AC0-48F9-825F-D02678E3****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6D53E6C9-5AC0-48F9-825F-D02678E3****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'UpdateFileMeta', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* You cannot call this operation to update all metadata. You can update only metadata specified by CustomLabels, CustomId, and Figures. For more information, see the "Request parameters" section of this topic.'."\n", + ], + 'BatchUpdateFileMeta' => [ + 'summary' => 'Updates some metadata items of files indexed into a dataset.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '33177', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset.[](~~478160~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'Files', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The files whose metadata you want to update.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The file and its metadata items that you want to update. The value must be in the JSON format.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/InputFile', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F5BF215E-3237-0852-B9C6-F233D44A****', + ], + 'Files' => [ + 'description' => 'The files whose metadata was updated.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The file.'."\n", + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => 'The URI of the file.'."\n", + 'type' => 'string', + 'example' => 'oss://examplebucket/example.jpg', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'Enumerated values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + 'Message' => [ + 'description' => 'The error message returned when the value of the Success parameter is false.'."\n", + 'type' => 'string', + 'example' => '*error.OpError : InvalidArgument | Index KV count exceeded, should be no more than 100.', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F5BF215E-3237-0852-B9C6-F233D44A****\\",\\n \\"Files\\": [\\n {\\n \\"URI\\": \\"oss://examplebucket/example.jpg\\",\\n \\"Success\\": false,\\n \\"Message\\": \\"*error.OpError : InvalidArgument | Index KV count exceeded, should be no more than 100.\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'BatchUpdateFileMeta', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* You cannot call this operation to update all metadata. You can update only metadata fields such as CustomLabels, CustomId, and Figures. For more information, see the "Request parameters" section of this topic.'."\n", + ], + 'GetFileMeta' => [ + 'summary' => 'Queries metadata of a file whose metadata is indexed into the dataset.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '32848', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset.[](~~478160~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'URI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URI of the file. Make sure that the file is indexed****.'."\n" + ."\n" + .'Specify the OSS URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Object}` is the path of the object with the extension included.'."\n" + ."\n" + .'Specify the URI of the file in Photo and Drive Service in the pds://domains/${domain}/drives/${drive}/files/${file}/revisions/${revision} format.'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'oss://test-bucket/test-object', + ], + ], + [ + 'name' => 'WithFields', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The metadata fields that you want to include in the response. You can use this parameter to reduce the size of the response.'."\n" + ."\n" + .'If you do not specify this parameter or leave this parameter empty, the operation returns all metadata fields of the file.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The metadata fields that you want to include in the response. If this parameter is omitted or left empty, all available metadata fields are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Size', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7F84C6D9-5AC0-49F9-914D-F02678E3****', + ], + 'Files' => [ + 'title' => 'File list.', + 'description' => 'The metadata returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The structure of the metadata. The returned metadata may not include all attributes of the object, and it varies depending on the object and the [workflow template](~~466304~~) used for indexing the metadata of the object.'."\n", + '$ref' => '#/components/schemas/File', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7F84C6D9-5AC0-49F9-914D-F02678E3****\\",\\n \\"Files\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'GetFileMeta', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* Before you call this operation, make sure that you have indexed file metadata into the dataset automatically by calling the [CreateBinding](~~478202~~) operation or manually by calling the [IndexFileMeta](~~478166~~) or [BatchIndexFileMeta](~~478167~~) operation.'."\n" + .'* The sample response is provided for reference only. The metadata type and content in your response may differ based on factors such as the [workflow template configurations](~~466304~~). For any inquiries, join the DingTalk chat group (ID: 31690030817) and share your questions with us.'."\n", + ], + 'BatchGetFileMeta' => [ + 'summary' => 'Queries metadata of multiple objects or files in the specified dataset.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '33178', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset.[](~~478160~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'URIs', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The array of object URIs. You can specify up to 100 object URIs in an array.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The URI of the object or file.'."\n" + ."\n" + .'Specify the OSS URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Object}` is the path of the object with the extension included.'."\n" + ."\n" + .'Specify the URI of the file in Photo and Drive Service in the pds://domains/${domain}/drives/${drive}/files/${file}/revisions/${revision} format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://examplebucket/sampleobject.jpg', + ], + 'required' => true, + ], + ], + [ + 'name' => 'WithFields', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The fields to return. If you specify this parameter, only specified metadata fields are returned. You can use this parameter to control the size of the response.'."\n" + ."\n" + .'If you do not specify this parameter or leave this parameter empty, the operation returns all metadata fields.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The field name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'URI', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7F84C6D9-5AC0-49F9-914D-F02678E3****', + ], + 'Files' => [ + 'description' => 'The metadata returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The structure of the metadata. The returned metadata may not include all attributes of the object, and it varies depending on the object and the [workflow template](~~466304~~) used for indexing the metadata of the object.'."\n", + '$ref' => '#/components/schemas/File', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7F84C6D9-5AC0-49F9-914D-F02678E3****\\",\\n \\"Files\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'BatchGetFileMeta', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* Before you call this operation, make sure that you have indexed file metadata into the dataset automatically by calling the [CreateBinding](~~478202~~) operation or manually by calling the [IndexFileMeta](~~478166~~) or [BatchIndexFileMeta](~~478167~~) operation.'."\n" + .'* The sample response is provided for reference only. The metadata type and content in your response may differ based on factors such as the [workflow template configurations](~~466304~~). For any inquiries, feel free to join the DingTalk chat group (ID: 31690030817) and share your questions with us.'."\n", + ], + 'DeleteFileMeta' => [ + 'summary' => 'Removes the metadata of a file from a dataset.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '33169', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset. For more information, see [Create a dataset](~~478160~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-datset', + ], + ], + [ + 'name' => 'URI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URI of the file in OSS.'."\n" + ."\n" + .'Specify the value in the oss://${Bucket}/${Object} format. `${Bucket}` specifies the name of the OSS bucket that resides in the same region as the current project. `${Object}` specifies the path of the object with the extension included.'."\n" + ."\n" + .'The URI of the file in Photo and Drive Service must be in the pds://domains/${domain}/drives/${drive}/files/${file}/revisions/${revision} format.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://examplebucket/exampleobject.txt', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7F82D6C9-5AC0-49F9-914D-F02678F3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7F82D6C9-5AC0-49F9-914D-F02678F3****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'DeleteFileMeta', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* A successful deletion message is returned regardless of whether the metadata of the file exists in the dataset.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The objects stored in Object Storage Service (OSS) or Photo and Drive Service are **not** deleted if you delete metadata from a dataset. If you want to delete the file, call the corresponding operations of OSS and Photo and Drive Service.'."\n" + ."\n" + .'* When you delete file metadata, the corresponding face clustering group information and story (if any) are changed, but the spatiotemporal clustering is not changed.'."\n", + ], + 'BatchDeleteFileMeta' => [ + 'summary' => 'Deletes the metadata of multiple files from a dataset.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '33176', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset. You can obtain the name of the dataset from the response of the [CreateDataset](~~478160~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'URIs', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The URIs of the OSS buckets in which the files whose metadata you want to delete are stored. You can specify up to 100 URIs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The URI of the OSS bucket in which the file whose metadata you want to delete is stored.'."\n" + ."\n" + .'Specify the value in the oss://${Bucket}/${Object} format. `${Bucket}` specifies the name of the OSS bucket that resides in the same region as the current project. `${Object}` specifies the complete path to the file that has an extension.'."\n" + ."\n" + .'The URI of the file in Photo and Drive Service must be in the pds://domains/${domain}/drives/${drive}/files/${file}/revisions/${revision} format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://examplebucket/exampleobject.txt', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '3A82F6C9-5AC0-38F9-914F-F02623B3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3A82F6C9-5AC0-38F9-914F-F02623B3****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'BatchDeleteFileMeta', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* A successful deletion message is returned regardless of whether the metadata of the file exists in the dataset.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If you delete the metadata of a file from a dataset, the file stored in Object Storage Service (OSS) or Photo and Drive Service is **not** deleted. If you want to delete the file, use the operations provided by OSS or Photo and Drive Service.'."\n" + ."\n" + .'* Metadata deletion affects existing face groups and stories but does not affect existing spatiotemporal groups.'."\n", + ], + 'SimpleQuery' => [ + 'summary' => 'Queries files in a dataset by performing a simple query operation. The operation supports logical expressions.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '4489', + 'abilityTreeNodes' => [ + 'FEATUREimmDN11M0', + ], + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '标记当前开始读取的位置，置空表示从头开始', + 'description' => 'The pagination token is used in the next request to retrieve a new page of results if the total number of results exceeds the value of the MaxResults parameter.'."\n" + ."\n" + .'The next call to the operation returns results lexicographically after the NextToken parameter value.'."\n" + ."\n" + .'You do not need to specify this parameter in your initial request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '本次读取的最大数据记录数量', + 'description' => '* If the Aggregations parameter is not specified, this parameter specifies the maximum number of files that can be returned. Valid values: 1 to 100.'."\n" + .'* If the Aggregations parameter is specified, this parameter specifies the maximum number of aggregation groups that can be returned. Valid values: 0 to 2000.'."\n" + .'* If you do not specify this parameter or set the parameter to 0, the default value of 100 is used.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'title' => 'Dataset 名称', + 'description' => 'The name of the dataset.[](~~478160~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'Query', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The query conditions.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/SimpleQuery', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方式，默认 DESC', + 'description' => 'The sort fields. For more information, see [Supported fields and operators](~~2743991~~).'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If you specify multiple sort fields, separate them with commas (,), as in Size,Filename.'."\n" + ."\n" + .'* You can specify up to five sort fields.'."\n" + ."\n" + .'* The order of the sort fields determines their precedence in the sorting process.', + 'type' => 'string', + 'required' => false, + 'example' => 'Size,Filename', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段', + 'description' => 'The sort order. Valid values:'."\n" + ."\n" + .'* asc: sorts the results in ascending order.'."\n" + .'* desc: sorts the results in descending order. This is the default value.'."\n" + ."\n" + .'* You can specify multiple sort orders that are separated by commas. Example: asc,desc.'."\n" + ."\n" + .'* The number of elements in the Order parameter must be less than or equal to the number of elements in the Sort parameter. For example, if the value of the Sort parameter is Size,Filename, you can set the Order parameter to desc,asc.'."\n" + ."\n" + .'* If the number of sort orders is less than the number of sort fields, the sort fields for which no sorting orders are explicitly specified use the asc order by default. For example, if you set Sort to Size,Filename and Order to asc, the Filename field defaults to the value of asc.', + 'type' => 'string', + 'required' => false, + 'example' => 'asc,desc', + ], + ], + [ + 'name' => 'Aggregations', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '聚合字段', + 'description' => 'The aggregations.'."\n" + ."\n" + .'> If you perform an aggregate query, the aggregation returned in the response contains only statistical results, not the actual metadata.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The structure of the aggregation.'."\n", + 'type' => 'object', + 'properties' => [ + 'Field' => [ + 'title' => '聚合字段的字段名', + 'description' => 'The name of the field. For more information about supported fields, see [Supported fields and operators](~~2743991~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'Size', + ], + 'Operation' => [ + 'title' => '聚合字段的聚合操作符', + 'description' => 'The operator.'."\n" + ."\n" + .'Enumerated values:'."\n" + ."\n" + .'* average: calculates the average number.'."\n" + .'* min: finds the minimum value.'."\n" + .'* max: finds the maximum value.'."\n" + .'* count: counts the number of results.'."\n" + .'* distinct: counts the number of distinct results.'."\n" + .'* sum: calculates the sum of all matching results..'."\n" + .'* group: counts the number of results by group. The results are sorted by the count number in descending order.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'average' => '', + 'min' => '', + 'max' => '', + 'count' => '', + 'distinct' => '', + 'sum' => '', + 'group' => '', + ], + 'example' => 'sum', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'WithFields', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '仅返回哪些字段', + 'description' => 'The fields that you want to include in the response. You can use this parameter to reduce the size of the response.'."\n" + ."\n" + .'If you do not specify this parameter or leave this parameter empty, the operation returns all metadata fields.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the field. Fields in the [File](~~478261~~) structure are supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Filename', + ], + 'required' => false, + ], + ], + [ + 'name' => 'WithoutTotalHits', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'Specifies whether to return the total number of hits. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'description' => 'The pagination token is used in the next request to retrieve a new page of results if the total number of results exceeds the value of the MaxResults parameter.'."\n" + ."\n" + .'It can be used in the next request to retrieve a new page of results.'."\n" + ."\n" + .'If NextToken is empty, no next page exists.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', + ], + 'RequestId' => [ + 'title' => '本次请求的唯一 Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2C5C1E0F-D8B8-4DA0-8127-EC32C771****', + ], + 'Files' => [ + 'title' => '文件列表', + 'description' => 'The files. This parameter is returned only when the value of the Aggregations request parameter is empty.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure for file information.'."\n", + '$ref' => '#/components/schemas/File', + ], + ], + 'Aggregations' => [ + 'title' => '聚合字段的字段名', + 'description' => 'The aggregations. This parameter is returned only when the value of the Aggregations request parameter is not empty.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The structure of the aggregation.'."\n", + 'type' => 'object', + 'properties' => [ + 'Field' => [ + 'title' => '聚合字段名', + 'description' => 'The name of the field.'."\n", + 'type' => 'string', + 'example' => 'Size', + ], + 'Operation' => [ + 'title' => '聚合字段的聚合操作符', + 'description' => 'The operator.'."\n", + 'type' => 'string', + 'example' => 'sum', + ], + 'Value' => [ + 'description' => 'The statistical result.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '200', + ], + 'Groups' => [ + 'title' => '分组聚合的结果', + 'description' => 'The grouped aggregations. This parameter is returned only when the group operator is specified in the Aggregations request parameter.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The grouped aggregation.'."\n", + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'title' => '分组聚合的值', + 'description' => 'The value for the grouped aggregation.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'Count' => [ + 'title' => '分组聚合的计数', + 'description' => 'The number of results in the grouped aggregation.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + 'TotalHits' => [ + 'description' => 'The number of total hits.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==\\",\\n \\"RequestId\\": \\"2C5C1E0F-D8B8-4DA0-8127-EC32C771****\\",\\n \\"Files\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ],\\n \\"Aggregations\\": [\\n {\\n \\"Field\\": \\"Size\\",\\n \\"Operation\\": \\"sum\\",\\n \\"Value\\": 200,\\n \\"Groups\\": [\\n {\\n \\"Value\\": \\"100\\",\\n \\"Count\\": 5\\n }\\n ]\\n }\\n ],\\n \\"TotalHits\\": 10\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'SimpleQuery', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* Before you call this operation, make sure that you have indexed file metadata into the dataset automatically by calling the [CreateBinding](~~478202~~) operation or manually by calling the [IndexFileMeta](~~478166~~) or [BatchIndexFileMeta](~~478167~~) operation.'."\n" + .'* The sample response is provided for reference only. The metadata type and content in your response may differ based on factors such as the [workflow template configurations](~~466304~~). For any inquiries, join the DingTalk chat group (ID: 31690030817) and share your questions with us.'."\n" + ."\n" + .'**Limits**'."\n" + ."\n" + .'* Each query returns information about up to 100 files.'."\n" + .'* Each query returns up to 2,000 aggregations.'."\n" + .'* A subquery supports up to 100 conditions.'."\n" + .'* A subquery can have a maximum nesting depth of 5 levels.'."\n" + ."\n" + .'**Example query conditions**'."\n" + ."\n" + .'* Retrieve JPEG images larger than 1,000 pixels:'."\n" + ."\n" + .'<!---->'."\n" + ."\n" + .' {'."\n" + .' "SubQueries":['."\n" + .' {'."\n" + .' "Field":"ContentType",'."\n" + .' "Value": "image/jpeg",'."\n" + .' "Operation":"eq"'."\n" + .' }, '."\n" + .' {'."\n" + .' "Field":"ImageWidth",'."\n" + .' "Value":"1000",'."\n" + .' "Operation":"gt"'."\n" + .' }'."\n" + .' ],'."\n" + .' "Operation":"and"'."\n" + .' }'."\n" + ."\n" + .'* Search `oss://examplebucket/path/` for objects that have the `TV` or `Stereo` label and are larger than 10 MB in size:'."\n" + ."\n" + .'> This query requires matching files to have the `TV` or `Stereo` label. The two labels are specified as separate objects in the `Labels` fields.'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "SubQueries": ['."\n" + .' {'."\n" + .' "Field": "URI",'."\n" + .' "Value": "oss://examplebucket/path/",'."\n" + .' "Operation": "prefix"'."\n" + .' },'."\n" + .' {'."\n" + .' "Field": "Size",'."\n" + .' "Value": "1048576",'."\n" + .' "Operation": "gt"'."\n" + .' },'."\n" + .' {'."\n" + .' "SubQueries": ['."\n" + .' {'."\n" + .' "Field": "Labels.LabelName",'."\n" + .' "Value": "TV",'."\n" + .' "Operation": "eq"'."\n" + .' },'."\n" + .' {'."\n" + .' "Field": "Labels.LabelName",'."\n" + .' "Value": "Stereo",'."\n" + .' "Operation": "eq"'."\n" + .' }'."\n" + .' ],'."\n" + .' "Operation": "or"'."\n" + .' }'."\n" + .' ],'."\n" + .' "Operation": "and"'."\n" + .'}'."\n" + .' '."\n" + .'```'."\n" + ."\n" + .'* Exclude images that contain a face of a male over the age of 36:'."\n" + ."\n" + .'> In this example query, an image will be excluded from the query results if it contains a face of a male over the age of 36. This query is different from excluding an image that contains a male face or a face of a person over the age of 36. In this query, you need to use the `nested` operator to specify that the conditions are met on the same element.'."\n" + ."\n" + .' {'."\n" + .' "Operation": "not",'."\n" + .' "SubQueries": [{'."\n" + .' "Operation": "nested",'."\n" + .' "SubQueries": [{'."\n" + .' "Operation": "and",'."\n" + .' "SubQueries": [{'."\n" + .' "Field": "Figures.Age",'."\n" + .' "Operation": "gt",'."\n" + .' "Value": "36"'."\n" + .' }, {'."\n" + .' "Field": "Figures.Gender",'."\n" + .' "Operation": "eq",'."\n" + .' "Value": "male"'."\n" + .' }]'."\n" + .' }]'."\n" + .' }]'."\n" + .' }'."\n" + ."\n" + .'* Query JPEG images that have both custom labels and system labels:'."\n" + ."\n" + .'<!---->'."\n" + ."\n" + .' {'."\n" + .' "SubQueries":['."\n" + .' {'."\n" + .' "Field":"ContentType",'."\n" + .' "Value": "image/jpeg",'."\n" + .' "Operation":"eq"'."\n" + .' }, '."\n" + .' {'."\n" + .' "Field":"CustomLabels.test",'."\n" + .' "Operation":"exist"'."\n" + .' }, '."\n" + .' {'."\n" + .' "Field":"Labels.LabelName",'."\n" + .' "Operation":"exist"'."\n" + .' }'."\n" + .' ],'."\n" + .' "Operation":"and"'."\n" + .' }'."\n" + ."\n" + .'You can also perform aggregate operations to collect and analyze different data based on the specified conditions. For example, you can calculate the sum, count, average value, or maximum value of all files that meet the query conditions. You can also calculate the size distribution of images that meet the query conditions.', + ], + 'SemanticQuery' => [ + 'summary' => 'Queries metadata in a dataset by inputting natural language.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '103885', + 'abilityTreeNodes' => [ + 'FEATUREimmDN11M0', + ], + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '标记当前开始读取的位置，置空表示从头开始', + 'description' => 'This parameter is no longer available.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '本次读取的最大数据记录数量', + 'description' => 'The maximum number of entries to return. Valid values: 1 to 1000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'title' => 'Dataset 名称', + 'description' => 'The name of the dataset.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immDatatest', + ], + ], + [ + 'name' => 'Query', + 'in' => 'query', + 'schema' => [ + 'title' => '需要搜索的内容，使用自然语言描述', + 'description' => 'The content of the query that you input.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Scenery of Hangzhou in April 2021', + ], + ], + [ + 'name' => 'WithFields', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '> Either this parameter or the SourceURI parameter must be specified.'."\n" + ."\n" + .'The content of the query that you input.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The field that you want to include in the response. Including only necessary metadata fields can help reduce the size of the response.'."\n" + ."\n" + .'If you do not specify this parameter or set the value to null, all existing metadata fields are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["URI", "Filename"]', + ], + 'required' => false, + ], + ], + [ + 'name' => 'MediaTypes', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The types of the media that you want to query. Default value:'."\n" + ."\n" + .'\\["image"]'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The type of the medium that you want to query. Set the value to'."\n" + ."\n" + .'image.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["image"]', + ], + 'required' => false, + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => '> Either this parameter or the Query parameter must be specified. This parameter is valid only for image searches on datasets configured with a search-by-image workflow.'."\n" + .'>'."\n" + .'URI of the source data for retrieval.'."\n" + .'The URI must be in the oss://${Bucket}/${Object} format. ${Bucket} specifies the name of the OSS bucket that is in the same region as the current project. ${Object} specifies the full path of the file that contains the file name extension.'."\n" + ."\n" + .'Contact us if you need to configure a workflow template.', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '本次请求的唯一 Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2C5C1E0F-D8B8-4DA0-8127-EC32C771****', + ], + 'Files' => [ + 'title' => '文件列表', + 'description' => 'The files.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The file information.'."\n", + '$ref' => '#/components/schemas/File', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2C5C1E0F-D8B8-4DA0-8127-EC32C771****\\",\\n \\"Files\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'SemanticQuery', + 'description' => '### [](#)Precautions'."\n" + ."\n" + .'* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).**** Each time you call this operation, you are charged for semantic understanding and query fees.'."\n" + .'* Before you call this operation, make sure that the file that you want to use is indexed into the dataset that you use. To index a file into a dataset, you can call one of the following operations: [CreateBinding](~~478202~~), [IndexFileMeta](~~478166~~), and [BatchIndexFileMeta](~~478167~~).'."\n" + .'* The response provided in this example is for reference only. The categories and content of metadata vary based on configurations of [workflow templates](~~466304~~). If you have questions, search for and join the DingTalk group numbered 21714099.'."\n" + ."\n" + .'### [](#)Usage limits'."\n" + ."\n" + .'* Each time you call this operation, up to 1,000 metadata files are returned.'."\n" + .'* Pagination is not supported.'."\n" + .'* The natural language processing capability may not always produce completely accurate results.'."\n" + ."\n" + .'### [](#)Usage methods'."\n" + ."\n" + .'You can query files within a dataset by using natural language keywords. Key information supported for understanding includes labels (Labels.LabelName), time (ProduceTime), and location (Address.AddressLine). For example, if you use `2023 Hangzhou scenery` as the query criterion, the operation intelligently breaks the query criterion down into the following sub-criteria, and returns the files that meet all the sub-criteria:'."\n" + ."\n" + .'* ProduceTime: 00:00 on January 1, 2023 to 00:00 on December 31, 2023.'."\n" + .'* Address.AddressLine: `Hangzhou`'."\n" + .'* Labels.LabelName: `scenery`.'."\n" + ."\n" + .'When you call this operation, you can configure a [workflow template](~~466304~~) that includes the `ImageEmbeddingExtraction` operator. This allows the operation to return image content when the query you input matches the image content, thereby achieving intelligent image retrieval.``'."\n", + ], + 'FuzzyQuery' => [ + 'summary' => 'Queries the extracted file metadata, including the file name, labels, path, custom tags, text, and other fields. If the value of a metadata field of a file matches the specified string, the metadata of the file is returned.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '8960', + 'abilityTreeNodes' => [ + 'FEATUREimmDN11M0', + ], + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '标记当前开始读取的位置，置空表示从头开始', + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. If the total number of files is greater than the value of MaxResults, you must specify NextToken.'."\n" + ."\n" + .'The file information is returned in alphabetical order starting from the value of NextToken.'."\n" + ."\n" + .'You do not need to specify this parameter for the first request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '本次读取的最大数据记录数量', + 'description' => 'The maximum number of entries to return. Valid values: 0 to 200.'."\n" + ."\n" + .'Default value: 100.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'title' => 'Dataset 名称', + 'description' => 'The name of the dataset. You can obtain the name of the dataset from the response of the [CreateDataset](~~478160~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'Query', + 'in' => 'query', + 'schema' => [ + 'title' => '用于搜索的字符串', + 'description' => 'The query content. The value can be up to 1 MB in size.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sort fields. For more information, see [Supported fields and operators](~~2743991~~).'."\n" + ."\n" + .'* Separate multiple sort fields with commas (,). Example: `Size,Filename`.'."\n" + .'* You can specify up to five sort fields.'."\n" + .'* The priority order of sorting is determined based on the order of the sort fields.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Size,Filename', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sorting method. Valid values:'."\n" + ."\n" + .'* asc: ascending order.'."\n" + .'* desc (default): descending order.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* Separate multiple sorting methods with commas (,). Example: asc,desc.'."\n" + ."\n" + .'* The number of values for Order must be less than or equal to the number of values for Sort. For example, if you set Sort to Size,Filename, you can set Order only to desc or asc.'."\n" + ."\n" + .'* If the number of values for Order is less than the number of values for Sort, the unsorted fields are default to the value of asc. For example, if you set Sort to Size,Filename and Order to asc, the Filename field is default to the value of asc.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asc,desc', + ], + ], + [ + 'name' => 'WithFields', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The fields that you want to include in the response. To help reduce the size of the response, include only necessary metadata fields.'."\n" + ."\n" + .'If you do not specify this parameter or set the value to null, all existing metadata fields are returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The field that you want to include in the response. To help reduce the size of the response, include only necessary metadata fields.'."\n" + ."\n" + .'If you do not specify this parameter or set the value to null, all existing metadata fields are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Filename', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'description' => 'A pagination token.'."\n" + ."\n" + .'It can be used in the next request to retrieve a new page of results.'."\n" + ."\n" + .'If NextToken is empty, no next page exists.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', + ], + 'RequestId' => [ + 'title' => '本次请求的唯一 Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****', + ], + 'Files' => [ + 'description' => 'The files.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The file information.'."\n", + '$ref' => '#/components/schemas/File', + ], + ], + 'TotalHits' => [ + 'description' => 'The number of hits.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==\\",\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\",\\n \\"Files\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ],\\n \\"TotalHits\\": 10\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'FuzzyQuery', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of IMM.****'."\n" + .'* Before you call this operation, make sure that you have indexed file metadata into the dataset automatically by calling the [CreateBinding](~~478202~~) operation or manually by calling the [IndexFileMeta](~~478166~~) or [BatchIndexFileMeta](~~478167~~) operation.'."\n" + .'* The sample response is provided for reference only. The metadata type and content in your response may differ based on factors such as the [workflow template configurations](~~466304~~). For any inquiries, join the DingTalk chat group (ID: 88490020073) and share your questions with us.'."\n" + .'* For information about the fields that you can use as query conditions, see [Supported fields and operators](~~2743991~~).'."\n", + ], + 'CreateFigureClusteringTask' => [ + 'summary' => 'Creates a face clustering task to cluster faces of different persons in images by person based on the intelligent algorithms.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '116906', + 'abilityTreeNodes' => [ + 'FEATUREimm3DNGQD', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset.[](~~478160~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dataset001', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom information, which is returned in an asynchronous notification and facilitates notification management. The maximum length of the value is 2,048 bytes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The custom tags. You can search for or filter asynchronous tasks by custom tag.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{"test": "val1"}', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The notification settings. For information about the asynchronous notification format, see [Asynchronous message examples](~~2743997~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The information about the face clustering task.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => 'formatconvert-00bec802-073a-4b61-ba3b-39bc****', + ], + 'EventId' => [ + 'description' => 'The event ID.'."\n", + 'type' => 'string', + 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\",\\n \\"TaskId\\": \\"formatconvert-00bec802-073a-4b61-ba3b-39bc****\\",\\n \\"EventId\\": \\"0ED-1Bz8z71k5TtsUejT4UJ16****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateFigureClusteringTask', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** Asynchronous processing does not guarantee timely task completion.'."\n" + ."\n" + .'* Before you call this operation, make sure that you have indexed file metadata into the [dataset](~~CreateDataset~~) automatically by calling the [CreateBinding](~~CreateBinding~~) operation or manually by calling the [IndexFileMeta](~~IndexFileMeta~~) or [BatchIndexFileMeta](~~BatchIndexFileMeta~~) operation.'."\n" + ."\n" + .'* Each call to the operation incrementally processes metadata in the [dataset](~~CreateDataset~~). You can regularly call this operation to process incremental files.'."\n" + ."\n" + .'* After the clustering task is complete, you can call the [GetFigureCluster](~~GetFigureCluster~~) or [BatchGetFigureCluster](~~BatchGetFigureCluster~~) operation to query information about a specific cluster. You can also call the [QueryFigureClusters](~~QueryFigureClusters~~) operation to query all face clusters of the specified dataset.'."\n" + ."\n" + .'* Removing image information from the dataset causes changes to face clusters. When images that contain all faces in a cluster are removed, the cluster is deleted.'."\n" + ."\n" + .'* This operation is an asynchronous operation. After a task is executed, the task information is saved only for seven days. When the retention period ends, the task information can no longer be retrieved. You can call the [GetTask](~~GetTask~~) or [ListTasks](~~ListTasks~~) operation to query information about the task. If you specify [Notification](~~2743997~~), you can obtain information about the task based on notifications.'."\n", + ], + 'CreateFigureClustersMergingTask' => [ + 'summary' => 'Merges two or more face clustering groups into one face clustering group.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '117038', + 'abilityTreeNodes' => [ + 'FEATUREimm3DNGQD', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset. For more information, see [Create a dataset](~~478160~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dataset001', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'title' => '源cluster', + 'description' => 'The ID of the source group. You must specify either From or Froms, but not both.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Cluster-2ab85905-23ba-4632-b2d8-1c21cfe****', + ], + ], + [ + 'name' => 'To', + 'in' => 'query', + 'schema' => [ + 'title' => '目的cluster', + 'description' => 'The ID of the destination clustering group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Cluster-4a3a71c1-c092-4788-8826-2f65d17****', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom data, which is returned in an asynchronous notification and facilitates notification management. The maximum length is 2,048 bytes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The custom tags, which can be used to search for and filter asynchronous tasks.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{"key":"val"}', + ], + ], + [ + 'name' => 'Froms', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The IDs of source clustering groups. You must specify either From or Froms, but not both. You can specify up to 100 task IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of a single source clustering group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Cluster-2ab85905-23ba-4632-b2d8-1c21cfe****'."\n", + ], + 'required' => false, + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The notification settings. For information about the asynchronous notification format, see [Asynchronous message examples](~~2743997~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FF****', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => '92376fbb-171f-4259-913f-705f7ee0****', + ], + 'EventId' => [ + 'description' => 'The event ID.'."\n", + 'type' => 'string', + 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16E****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FF****\\",\\n \\"TaskId\\": \\"92376fbb-171f-4259-913f-705f7ee0****\\",\\n \\"EventId\\": \\"0ED-1Bz8z71k5TtsUejT4UJ16E****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateFigureClustersMergingTask', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* Before you call this operation, make sure that you have called the [CreateFigureClusteringTask](~~478180~~) operation to cluster all faces in the dataset.'."\n" + .'* If you merge unrelated groups, the feature values of the target groups are affected. As a result, the incremental data may be inaccurately grouped when you create a face clustering task.'."\n" + .'* This operation is an asynchronous operation. After a task is executed, the task information is retained only for seven days and cannot be retrieved when the retention period elapses. You can call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation to query information about the task.`` If you specify [Notification](~~2743997~~), you can obtain information about the task based on notifications.'."\n", + ], + 'GetFigureCluster' => [ + 'summary' => 'Obtains basic information about face clustering, including the creation time, number of images, and cover.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '103841', + 'abilityTreeNodes' => [ + 'FEATUREimm3DNGQD', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The project name.[](~~CreateProject~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dataset name.[](~~CreateDataset~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dataset001', + ], + ], + [ + 'name' => 'ObjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the face clustering task. You can obtain the ID from the face clustering information returned after you call the [QueryFigureClusters](~~QueryFigureClusters~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Cluster-1f2e1a2c-d5ee-4bc5-84f6-fef94ea****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5F74C5C9-5AC0-49F9-914D-E01589D3****', + ], + 'FigureCluster' => [ + 'description' => 'The information about the face cluster.'."\n", + '$ref' => '#/components/schemas/FigureCluster', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5F74C5C9-5AC0-49F9-914D-E01589D3****\\",\\n \\"FigureCluster\\": {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Gender\\": \\"\\",\\n \\"FaceCount\\": 0,\\n \\"ImageCount\\": 0,\\n \\"VideoCount\\": 0,\\n \\"AverageAge\\": 0,\\n \\"MinAge\\": 0,\\n \\"MaxAge\\": 0,\\n \\"Cover\\": {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n },\\n \\"BaseImages\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"CroppingSuggestions\\": [],\\n \\"OCRContents\\": []\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ],\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'GetFigureCluster', + 'description' => '* **Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).**'."\n" + .'* Before you call this operation, make sure that a face clustering task is created to group all faces in a dataset. For information about how to create a face clustering task, see [CreateFigureClusteringTask](~~CreateFigureClusteringTask~~). For information about how to create a dataset, see [CreateDataset](~~CreateDataset~~).'."\n", + ], + 'QueryFigureClusters' => [ + 'summary' => 'Queries face groups based on given conditions.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '117066', + 'abilityTreeNodes' => [ + 'FEATUREimm3DNGQD', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset. You can obtain the name of the dataset from the response of the [CreateDataset](~~478160~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段', + 'description' => 'The sort field. If you leave this parameter empty, the group ID is used as the sort field.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* ImageCount: the number of images.'."\n" + .'* VideoCount: the number of videos.'."\n" + .'* ProjectName: the name of the project.'."\n" + .'* DatasetName: the name of the dataset.'."\n" + .'* CreateTime: the point in time when the group is created.'."\n" + .'* UpdateTime: the most recent point in time when the group is updated.'."\n" + .'* Gender: the gender.'."\n" + .'* FaceCount: the number of faces.'."\n" + .'* GroupName: the name of the group.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ImageCount' => '', + 'VideoCount' => '', + 'ProjectName' => '', + 'DatasetName' => '', + 'CreateTime' => '', + 'UpdateTime' => '', + 'Gender' => '', + 'FaceCount' => '', + 'Name' => '', + ], + 'example' => 'ImageCount', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '升降序', + 'description' => 'The sort order. Default value: asc.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* asc: ascending order.'."\n" + .'* desc: descending order.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => '', + 'desc' => '', + ], + 'example' => 'asc', + ], + ], + [ + 'name' => 'CustomLabels', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom labels, which can be used as query conditions.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'key=value', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return. Valid values: 0 to 100. Default value: 100.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CreateTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The time range within which the face group was created.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/TimeRange', + ], + ], + [ + 'name' => 'UpdateTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The time range within which the face group was last updated.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/TimeRange', + ], + ], + [ + 'name' => 'WithTotalCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return the total number of face groups that match the current query conditions. Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FFF****', + ], + 'NextToken' => [ + 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'FigureClusters' => [ + 'description' => 'The face groups.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The face group details.'."\n", + '$ref' => '#/components/schemas/FigureCluster', + ], + ], + 'TotalCount' => [ + 'description' => 'The total number of face groups that matches the current query conditions.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FFF****\\",\\n \\"NextToken\\": \\"CAESEgoQCg4KCkltYWdlQ291bnQQARgBIr0ECgkABAAAAAAAAAAKrwQDKgIAADFTMzEzMDMyMzMzMjMxMzAzMDMyMzQzNjM3MzczOTMzMzQzYTY5NmQ2ZDJkNjk2ZDYxNjc2NTJkNzQ2NTczNzQyZDY4N2E2NDY1NzYyZDMyMzUzMjM0MzIzOTMzMzczMTJkMzY1NDZhNzk3MzU2Njk3MjM0M2E2OTZkNmQyZDc0NjU3Mzc0MmQ3MzY1NzQyZDYzMzYzNjY0MzY2NjYxMzQyZDM1MzMzODM3MmQzMTMxNjU2NjJkNjI2NTM5MzYyZDM5MzgzMDMzMzk2MjMwMzE2NDYzNjMzMjNhNjY2OTY3NzU3MjY1MmQ2MzZjNzU3Mzc0NjU3MjNhNDM2Yzc1NzM3NDY1NzIyZDYxNjUzOTY0MzQzMzMxNjEyZDM3MzQ2NTY2MmQzNDM5Mzc2MjJkMzg2MjMxMzUyZDM0MzUzOTM1MzYzNzYxMzQ2NDM2MzE2Ni5TMzEzMDMyMzMzMjMxMzAzMDMyMzQzNjM3MzczOTMzMzQzYTY5NmQ2ZDJkNjk2ZDYxNjc2NTJkNzQ2NTczNzQyZDY4N2E2NDY1NzYyZDMyMzUzMjM0MzIzOTMzMzczMTJkMzY1NDZhNzk3MzU2Njk3MjM0M2E2OTZkNmQyZDc0NjU3Mzc0MmQ3MzY1NzQyZDYzMzYzNjY0MzY2NjYxMzQyZDM1MzMzODM3MmQzMTMxNjU2NjJkNjI2NTM5MzYyZDM5MzgzMDMzMzk2MjMwMzE2NDYzNjM*****\\",\\n \\"FigureClusters\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Gender\\": \\"\\",\\n \\"FaceCount\\": 0,\\n \\"ImageCount\\": 0,\\n \\"VideoCount\\": 0,\\n \\"AverageAge\\": 0,\\n \\"MinAge\\": 0,\\n \\"MaxAge\\": 0,\\n \\"Cover\\": {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n },\\n \\"BaseImages\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"CroppingSuggestions\\": [],\\n \\"OCRContents\\": []\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ],\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ],\\n \\"TotalCount\\": 100\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'QueryFigureClusters', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* Before you call this operation, make sure that a face clustering task is created to group all faces in a dataset. For information about how to create a face clustering task, see [CreateFigureClusteringTask](~~CreateFigureClusteringTask~~). For information about how to create a dataset, see [CreateDataset](~~CreateDataset~~).'."\n", + ], + 'BatchGetFigureCluster' => [ + 'summary' => 'Queries face clusters.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '166908', + 'abilityTreeNodes' => [ + 'FEATUREimm3DNGQD', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'ObjectIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The cluster IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Cluster-99b1c333-86dc-45da-8c6****', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FFF****', + ], + 'FigureClusters' => [ + 'description' => 'The clusters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the cluster.'."\n", + '$ref' => '#/components/schemas/FigureCluster', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FFF****\\",\\n \\"FigureClusters\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Gender\\": \\"\\",\\n \\"FaceCount\\": 0,\\n \\"ImageCount\\": 0,\\n \\"VideoCount\\": 0,\\n \\"AverageAge\\": 0,\\n \\"MinAge\\": 0,\\n \\"MaxAge\\": 0,\\n \\"Cover\\": {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n },\\n \\"BaseImages\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"CroppingSuggestions\\": [],\\n \\"OCRContents\\": []\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ],\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'BatchGetFigureCluster', + ], + 'UpdateFigureCluster' => [ + 'summary' => 'Updates information about a face cluster, such as the cluster name and labels.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '103839', + 'abilityTreeNodes' => [ + 'FEATUREimm3DNGQD', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset.[](~~478160~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'FigureCluster', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about the cluster.'."\n", + 'required' => true, + '$ref' => '#/components/schemas/FigureClusterForReq', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5F74C5C9-5AC0-49F9-914D-E01589D3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5F74C5C9-5AC0-49F9-914D-E01589D3****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'UpdateFigureCluster', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* Before you call this operation, make sure that you have called the [CreateFigureClusteringTask](~~478180~~) operation to cluster all faces in the dataset.'."\n" + .'* The operation updates only the cover image, cluster name, and tags.'."\n" + .'* After the operation is successful, you can call the [GetFigureCluster](~~478182~~) or [BatchGetFigureCluster](~~2248450~~) operation to query the updated cluster.'."\n", + ], + 'SearchImageFigureCluster' => [ + 'summary' => 'Queries face clusters that contain a specific face in an image. Each face cluster contains information such as bounding boxes and similarity.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'chargeType' => 'free', + 'abilityTreeCode' => '160046', + 'abilityTreeNodes' => [ + 'FEATUREimm3DNGQD', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset.[](~~478160~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The OSS URI of the image.'."\n" + ."\n" + .'Specify the OSS URI in the `oss://${Bucket}/${Object}` format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Object}` is the path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**If you have no special requirements, leave this parameter empty.**'."\n" + ."\n" + .'The authorization chain settings. For more information, see [Use authorization chains to access resources of other entities](~~465340~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C2734912-E6D5-052C-AC67-6A9FD02*****', + ], + 'Clusters' => [ + 'description' => 'The face clusters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The face cluster details.'."\n", + 'type' => 'object', + 'properties' => [ + 'Boundary' => [ + 'description' => 'The bounding box of the face.'."\n", + '$ref' => '#/components/schemas/Boundary', + ], + 'ClusterId' => [ + 'description' => 'The ID of the face cluster that contains faces similar to the face within the bounding box.'."\n", + 'type' => 'string', + 'example' => 'Cluster-ca730577-06b1-42c7-a25b-8f2c7******', + ], + 'Similarity' => [ + 'description' => 'The similarity between the face within the bounding box and the face cluster. Valid value: 0 to 1.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.87413794', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C2734912-E6D5-052C-AC67-6A9FD02*****\\",\\n \\"Clusters\\": [\\n {\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"ClusterId\\": \\"Cluster-ca730577-06b1-42c7-a25b-8f2c7******\\",\\n \\"Similarity\\": 0.87413794\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'SearchImageFigureCluster', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~88317~~) of Intelligent Media Management (IMM).****'."\n" + .'* Before you call this operation, make sure that you have created a face clustering task by calling the [CreateFigureClusteringTask](~~478180~~) operation to cluster all faces in the dataset.'."\n", + ], + 'CreateFacesSearchingTask' => [ + 'summary' => 'Searches the dataset for the specified number of images most similar to the specified image or face and returns face IDs and boundaries in descending order of similarity.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '160409', + 'abilityTreeNodes' => [ + 'FEATUREimmQ9NXNO', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset.[](~~478160~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom information, which is returned in an asynchronous notification and facilitates notification management. The maximum length of the value is 2,048 bytes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"}', + ], + ], + [ + 'name' => 'Sources', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The images.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The image.'."\n", + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => 'The OSS URI of the image.'."\n" + ."\n" + .'Specify the OSS URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Object}` is the path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'MaxResult', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the most similar faces that you want to return. Valid values: 1 to 100. Default value: 5.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The notification settings. For information about the asynchronous notification format, see [Asynchronous message examples](~~2743997~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'B1E79399-05F7-06D8-95FE-EBE17BA*****', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => 'CreateFacesSearchingTask-00bec802-073a-4b61-ba*****', + ], + 'EventId' => [ + 'description' => 'The event ID.'."\n", + 'type' => 'string', + 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B1E79399-05F7-06D8-95FE-EBE17BA*****\\",\\n \\"TaskId\\": \\"CreateFacesSearchingTask-00bec802-073a-4b61-ba*****\\",\\n \\"EventId\\": \\"0ED-1Bz8z71k5TtsUejT4UJ16****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateFacesSearchingTask', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** Asynchronous processing does not guarantee timely task completion.'."\n" + ."\n" + .'* The operation searches for faces that are similar to the face within the largest bounding box in each input image.'."\n" + ."\n" + .'* This operation is an asynchronous operation. After a task is executed, the task information is retained only for seven days and cannot be retrieved when the retention period elapses. You can call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation to query information about the task.`` If you specify [Notification](~~2743997~~), you can obtain information about the task based on notifications.'."\n", + ], + 'CreateLocationDateClusteringTask' => [ + 'summary' => 'Creates a spatiotemporal clustering task to cluster photos and videos based on geolocation and time information. Spatiotemporal clustering allows you to group photos and videos taken during a travel or at different places by their spatial and temporal similarity. Based on spatiotemporal clustering, you can develop media capabilities such as media file categorization, photo collections, and image and video-based stories.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '157768', + 'abilityTreeNodes' => [ + 'FEATUREimmPECUUL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset.[](~~478160~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom information, which is returned in an asynchronous notification and facilitates notification management. The maximum length of the value is 2,048 bytes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test-data', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The custom tags. You can search for or filter asynchronous tasks by custom tag.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "User": "Jane"'."\n" + .'}', + ], + ], + [ + 'name' => 'DateOptions', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The date configurations for clustering.'."\n" + ."\n" + .'> Adjusting these configurations affects existing spatiotemporal clusters for the dataset.'."\n", + 'type' => 'object', + 'properties' => [ + 'GapDays' => [ + 'description' => 'The maximum number of days allowed in a gap for a single spatiotemporal cluster. Valid values: 0 to 99999.'."\n" + ."\n" + .'For example, if travel photos were produced on March 4, 5, and 7, 2024, but not on Marh 6, 2024, and you set the parameter to 1, IMM considers the travel spanning the date range from March 4, 2024 to March 7, 2024 and includes photos within the data range in the same cluster.````'."\n" + ."\n" + .'We recommend that you set the parameter to a value within the range from 0 to 3.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + 'MinDays' => [ + 'description' => 'The minimum number of days that a single spatiotemporal cluster can span. Valid values: 1 to 99999. IMM does not create a cluster that spans less than the minimum number of days.'."\n" + ."\n" + .'For example, if you do not want a one-day tour cluster, you can set the parameter to 2.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + 'MaxDays' => [ + 'description' => 'The maximum number of days that a single spatiotemporal cluster can span. Valid values: 1 to 99999. IMM does not create a cluster that spans more than the maximum number of days.'."\n" + ."\n" + .'For example, if you want to create travel photo clusters, you may want to exclude photos that were taken within 15 consecutive days in the same city, because it is likely that these photos were not taken during a travel. In this case, you can set the parameter to 15 to exclude this time range and location from the clustering task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '15', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'LocationOptions', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The geolocation configurations for clustering.'."\n" + ."\n" + .'> Adjusting these configurations affects existing spatiotemporal clusters for the dataset.'."\n", + 'type' => 'object', + 'properties' => [ + 'LocationDateClusterLevels' => [ + 'description' => 'The administrative division levels. You can specify multiple administrative division levels.'."\n" + ."\n" + .'For example, you uploaded photos that were taken from March 3, 2024 to March 5, 2024 in Hangzhou and photos that were taken from March 6, 2024 to March 8, 2024 in Jiaxing. When you call the operation and set the parameter to `["city", "province"]`, the following spatiotemporal clusters are created from these photos:'."\n" + ."\n" + .'* March 3, 2024 to March 5, 2024, Hangzhou'."\n" + .'* March 6, 2024 to March 8, 2024, Jiaxing'."\n" + .'* March 3, 2024 to March 8, 2024, Zhejiang'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The administrative division level.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* country'."\n" + .'* province'."\n" + .'* city'."\n" + .'* district'."\n" + .'* township'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'country' => '', + 'province' => '', + 'city' => '', + 'district' => '', + 'township' => '', + ], + 'example' => 'province', + 'enum' => [], + ], + 'required' => true, + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The notification settings. For information about the asynchronous notification format, see [Asynchronous message examples](~~2743997~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The information about the spatiotemporal clustering task.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'B121940C-9794-4EE3-8D6E-F8EC525F****', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => 'LocationDateClustering-c10dce07-1de7-4da7-abee-1a3aba7****', + ], + 'EventId' => [ + 'description' => 'The event ID.'."\n", + 'type' => 'string', + 'example' => '25B-1W2ChgujA3Q8MbBY6mSp2mh****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B121940C-9794-4EE3-8D6E-F8EC525F****\\",\\n \\"TaskId\\": \\"LocationDateClustering-c10dce07-1de7-4da7-abee-1a3aba7****\\",\\n \\"EventId\\": \\"25B-1W2ChgujA3Q8MbBY6mSp2mh****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateLocationDateClusteringTask', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** Asynchronous processing does not guarantee timely task completion.'."\n" + ."\n" + .'* Before you call this operation, make sure that you have indexed file metadata into the dataset automatically by calling the [CreateBinding](~~478202~~) operation or manually by calling the [IndexFileMeta](~~478166~~) or [BatchIndexFileMeta](~~478167~~) operation.'."\n" + ."\n" + .'* Each call to the operation incrementally processes metadata in the dataset.****`` You can regularly call this operation to process incremental files.'."\n" + ."\n" + .'* After a spatiotemporal clustering task is complete, you can call the [QueryLocationDateClusters](~~478189~~) operation to query the spatiotemporal clustering result.'."\n" + ."\n" + .'* Removing metadata from a dataset does not affect existing spatiotemporal clusters for the dataset. To delete a spatiotemporal cluster, call the [DeleteLocationDateCluster](~~478191~~) operation.'."\n" + ."\n" + .'* This operation is an asynchronous operation. After a task is executed, the task information is retained only for seven days and cannot be retrieved when the retention period elapses. You can call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation to query information about the task.`` If you specify [Notification](~~2743997~~), you can obtain information about the task based on notifications.', + ], + 'QueryLocationDateClusters' => [ + 'summary' => 'Queries a list of spatiotemporal clusters based on the specified conditions.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '157769', + 'abilityTreeNodes' => [ + 'FEATUREimmPECUUL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset. For information about how to create a dataset, see [CreateDataset](~~478160~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'ObjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster that you want to query. Specify this parameter if you want to query a specific spatiotemporal cluster. Otherwise, leave this parameter empty to query spatiotemporal clusters that meet the specified conditions.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'location-date-cluster-71dd4f32-9597-4085-a2ab-3a7b0fd0aff9', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => 'The characters that are included in the titles of spatiotemporal clusters to be queried. Matches are found by using fuzzy matching.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Address', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The address information.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Address', + ], + ], + [ + 'name' => 'LocationDateClusterLevels', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The container for the administrative division level of the spatiotemporal clusters to be queried.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The administrative division level.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* country'."\n" + .'* province'."\n" + .'* district'."\n" + .'* city'."\n" + .'* township'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'country' => '', + ' province' => '', + ' district' => '', + ' city' => '', + 'township' => '', + ], + 'example' => 'province', + ], + 'required' => false, + ], + ], + [ + 'name' => 'LocationDateClusterStartTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The time range during which the earliest photo in a cluster was taken.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/TimeRange', + ], + ], + [ + 'name' => 'LocationDateClusterEndTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The time range during which the latest photo in a cluster was taken.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/TimeRange', + ], + ], + [ + 'name' => 'CreateTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The time range during which the spatiotemporal clusters were generated.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/TimeRange', + ], + ], + [ + 'name' => 'UpdateTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The time range during which the spatiotemporal clusters were updated.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/TimeRange', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MzQNjmY2MzYxNhNjk2ZNjEu****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values: \\[1,100]. Default value: 20.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CustomLabels', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom labels.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'key=value', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The field that you use to sort the query results.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* LocationDateClusterEndTime: by the time at which the latest photo in a cluster was taken.'."\n" + .'* CreateTime: by the creation time of a spatiotemporal cluster.'."\n" + .'* UpdateTime: by the update time of a spatiotemporal cluster.'."\n" + .'* LocationDateClusterStartTime: by the time at which the earliest photo in a cluster was taken. This is the default value.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'LocationDateClusterEndTime' => '', + 'CreateTime' => '', + 'UpdateTime' => '', + 'LocationDateClusterStartTime' => '', + ], + 'example' => 'LocationDateClusterStartTime', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order that you use to sort the query results.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* asc: ascending order. This is the default value.'."\n" + .'* desc: descending order.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => '', + 'desc' => '', + ], + 'example' => 'asc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7055FCF7-4D7B-098E-BD4D-DD2932B0****', + ], + 'LocationDateClusters' => [ + 'description' => 'The list of spatiotemporal clusters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The spatiotemporal cluster information.'."\n", + '$ref' => '#/components/schemas/LocationDateCluster', + ], + ], + 'NextToken' => [ + 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'example' => 'MzQNjmY2MzYxNhNjk2ZNjEu****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7055FCF7-4D7B-098E-BD4D-DD2932B0****\\",\\n \\"LocationDateClusters\\": [\\n {\\n \\"Title\\": \\"\\",\\n \\"LocationDateClusterLevel\\": \\"\\",\\n \\"LocationDateClusterStartTime\\": \\"\\",\\n \\"LocationDateClusterEndTime\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"NextToken\\": \\"MzQNjmY2MzYxNhNjk2ZNjEu****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'QueryLocationDateClusters', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of IMM.****'."\n" + .'* Before you call this operation, make sure that you have called the [CreateLocationDateClusteringTask](~~478188~~) operation to create spatiotemporal clusters in the project.'."\n", + ], + 'UpdateLocationDateCluster' => [ + 'summary' => 'Updates a spatiotemporal cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '157778', + 'abilityTreeNodes' => [ + 'FEATUREimmPECUUL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset.[](~~478160~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'ObjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster that you want to update.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'location-date-cluster-71dd4f32-9597-4085-a2ab-3a7b0fd0aff9', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the cluster. The name can be used to search for the cluster. The value can be up to 1,024 bytes in size.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'CustomId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom ID of the cluster. When the cluster is indexed into the dataset, the custom ID is stored as the data attribute. You can map the custom ID to other data in your business system. For example, you can pass the custom ID to map a URI to an ID. We recommend that you specify a globally unique value. The value can be up to 1,024 bytes in size.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'member-id-0001', + ], + ], + [ + 'name' => 'CustomLabels', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The custom labels. The parameter stores custom key-value labels, which can be used to filter data. You can specify up to 100 custom labels for a cluster.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "UserScore": "5"'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '52B017A8-FEF5-0A61-BAEE-234A8AD8****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"52B017A8-FEF5-0A61-BAEE-234A8AD8****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'UpdateLocationDateCluster', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* Before you call this operation, make sure that you have called the [CreateLocationDateClusteringTask](~~478188~~) operation to create spatiotemporal clusters in the project.'."\n", + ], + 'DeleteLocationDateCluster' => [ + 'summary' => 'Deletes a spatiotemporal cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '158363', + 'abilityTreeNodes' => [ + 'FEATUREimmPECUUL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset. For information about how to create a dataset, see [CreateDataset](~~478160~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'ObjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the group to be deleted.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'location-date-cluster-71dd4f32-9597-4085-a2ab-3a7b0fd0aff9', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data struct returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'B121940C-9794-4EE3-8D6E-F8EC525F****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B121940C-9794-4EE3-8D6E-F8EC525F****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'DeleteLocationDateCluster', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of IMM.****'."\n" + .'* Before you call this operation, you must call the [CreateLocationDateClusteringTask](~~478188~~) operation to perform spatiotemporal clustering.'."\n" + .'* A successful deletion is returned regardless of whether a spatiotemporal clustering group ID exists.'."\n", + ], + 'CreateStory' => [ + 'summary' => 'Creates a story.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '103261', + 'abilityTreeNodes' => [ + 'FEATUREimmPQ568C', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the dataset. For information about how to obtain the name of a dataset, see [Create a dataset](~~478160~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'ObjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the story. This parameter is optional. If you leave this parameter empty, IMM assigns a unique identifier to the story. You can query and update a story based on its ID. You can also manually create an ID for a story. After you create an ID for a story, you must specify this parameter to pass the ID into the system. This way, IMM can record the ID as the unique identifier of the story. If you pass an existing ID into the system, IMM updates the story that corresponds to the ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'id1', + ], + ], + [ + 'name' => 'StoryType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The type of the story. For information about valid types, see [Story types and subtypes](~~2743998~~).', + 'type' => 'string', + 'required' => true, + 'example' => 'PeopleMemory', + ], + ], + [ + 'name' => 'StorySubType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The subtype of the story. For information about valid subtypes, see [Story types and subtypes](~~2743998~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'Solo', + ], + ], + [ + 'name' => 'StoryStartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The start time of the photo collection for which you want to create the story. StoryStartTime and StoryEndTime form a time interval based on which IMM filters candidate photos to generate a story. The value must be a string in the RFC3339 format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2016-12-30T16:00:00Z', + ], + ], + [ + 'name' => 'StoryEndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The end time of the photo collection for which you want to create the story. StoryStartTime and StoryEndTime form a time interval based on which IMM filters candidate photos to generate a story. The value must be a string in the RFC3339 format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-12-30T16:00:00Z', + ], + ], + [ + 'name' => 'StoryName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the story.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'name1', + ], + ], + [ + 'name' => 'MinFileCount', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The minimum number of photo files in the story. The actual number of photo files ranges from the value of MinFileCount to the value of MaxFileCount. The value of this parameter must be an integer greater than 1. If the actual number of candidate photos is less than the value of this parameter, a null story is returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MaxFileCount', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The maximum number of photo files in the story. The actual number of photo files ranges from the value of MinFileCount to the value of MaxFileCount. The value of this parameter must be an integer greater than the value of MinFileCount. To provide the desired effect, the algorithm limits the maximum number of photo files to 1,500. If you set MaxFileCount to a value greater than 1,500, this parameter does not take effect.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'NotifyTopicName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The topic name of the asynchronous reverse notification.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test-topic', + ], + ], + [ + 'name' => 'CustomLabels', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The custom labels. Labels specify the custom information of the story. This enables retrieval based on your business requirements.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{"Bucket": "examplebucket"}', + ], + ], + [ + 'name' => 'CustomId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The custom ID. A custom ID of a generated story may differ from the value of ObjectID and can be utilized for subsequent retrieval and sorting of stories.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Address', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The address of the story. IMM filters candidate photos to generate a story based on the value of this parameter. This parameter takes effect only if you set StoryType to TravelMemory.'."\n" + ."\n" + .'> If the caller of the operation is located in Hong Kong (China), Macao (China), Taiwan (China), or another region outside the Chinese mainland, the system cannot convert the GPS information in the Chinese mainland into the textual address version.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/AddressForStory', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The tags. You can specify this parameter in one of the following scenarios:'."\n" + ."\n" + .'* Specify tags as custom data, which is returned in messages provided by Simple Message Queue.'."\n" + .'* Search for tasks by tag.'."\n" + .'* Specify tags as variables in destination URIs.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{"key":"val"}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom information, which is returned as asynchronous notifications to facilitate notification management in your system. The maximum information length is 2,048 bytes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"}', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The notification settings. For information about the asynchronous notification format, see [Asynchronous message examples](~~2743997~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => 'CreateStory-4ef6ff43-edf3-4612-9cc4-0c7f9e19****', + ], + 'EventId' => [ + 'description' => 'The event ID.'."\n", + 'type' => 'string', + 'example' => '392-1CqzvESGTEeNZ2OWFbRKIM****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\",\\n \\"TaskId\\": \\"CreateStory-4ef6ff43-edf3-4612-9cc4-0c7f9e19****\\",\\n \\"EventId\\": \\"392-1CqzvESGTEeNZ2OWFbRKIM****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateStory', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* Before you call this operation, make sure that you have indexed file metadata into the dataset automatically by calling the [CreateBinding](~~478202~~) operation or manually by calling the [IndexFileMeta](~~478166~~) or [BatchIndexFileMeta](~~478167~~) operation.'."\n" + .'* The operation is an asynchronous operation. After a task is executed, the task information is saved only for seven days. When the retention period ends, the task information can no longer be retrieved. You can call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) to query information about the task. If you specify [Notification](~~2743997~~), you can obtain information about the task based on notifications.', + ], + 'QueryStories' => [ + 'summary' => 'Queries stories based on the specified conditions.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '102513', + 'abilityTreeNodes' => [ + 'FEATUREimmPQ568C', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset.[](~~478160~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'ObjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the story.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'id1', + ], + ], + [ + 'name' => 'StoryName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the story.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'name1', + ], + ], + [ + 'name' => 'StoryType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the story. For a list of valid values, see [Story types and subtypes](~~2743998~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'TimeMemory', + ], + ], + [ + 'name' => 'StorySubType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The subtype of the story. For a list of valid values, see [Story types and subtypes](~~2743998~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'SeasonHighlights', + ], + ], + [ + 'name' => 'FigureClusterIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The IDs of the face clusters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the face cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Cluster-773d9c7e-3fd4-480c-a24b-30a82****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'CreateTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The time range in which stories were created.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/TimeRange', + ], + ], + [ + 'name' => 'StoryStartTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The time range for the creation time of the first photo or video in the story.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/TimeRange', + ], + ], + [ + 'name' => 'StoryEndTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The time range for the creation time of the last photo or video in the story.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/TimeRange', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. If you do not specify this token in the next request, results are returned from the beginning.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return. Valid values: 1 to 100. Default value: 100.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CustomLabels', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom labels in key-value pairs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'key=value', + ], + ], + [ + 'name' => 'WithEmptyStories', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return empty stories. Valid values:'."\n" + ."\n" + .'* true (The default value)'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sort field. Valid values:'."\n" + ."\n" + .'* CreateTime: sorts by story creation time.'."\n" + .'* StoryName: sorts by story name.'."\n" + .'* StoryStartTime: sorts by story start time.'."\n" + .'* StoryEndTime: sorts by story end time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTime', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sort order. Valid values:'."\n" + ."\n" + .'* asc: in ascending order.'."\n" + .'* desc: in descending order.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2C5C1E0F-D8B8-4DA0-8127-EC32C771****', + ], + 'Stories' => [ + 'description' => 'The stories.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the story.'."\n", + '$ref' => '#/components/schemas/Story', + ], + ], + 'NextToken' => [ + 'description' => 'The pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", + 'type' => 'string', + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3Qx****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2C5C1E0F-D8B8-4DA0-8127-EC32C771****\\",\\n \\"Stories\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"StoryName\\": \\"\\",\\n \\"StoryType\\": \\"\\",\\n \\"StorySubType\\": \\"\\",\\n \\"StoryStartTime\\": \\"\\",\\n \\"StoryEndTime\\": \\"\\",\\n \\"Files\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ],\\n \\"Cover\\": {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"CroppingSuggestions\\": [],\\n \\"OCRContents\\": []\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n },\\n \\"FigureClusterIds\\": [\\n \\"\\"\\n ],\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3Qx****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'QueryStories', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* Before you call this operation, make sure that you have indexed file metadata into the dataset automatically by calling the [CreateBinding](~~478202~~) operation or manually by calling the [IndexFileMeta](~~478166~~) or [BatchIndexFileMeta](~~478167~~) operation.'."\n" + .'* Before you call this operation, make sure that you have called the [CreateStory](~~478193~~) or [CreateCustomizedStory](~~478196~~) operation to create a story.'."\n", + ], + 'GetStory' => [ + 'summary' => 'Queries a story.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '102496', + 'abilityTreeNodes' => [ + 'FEATUREimmPQ568C', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset.[](~~478160~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'ObjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the story.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'id1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****', + ], + 'Story' => [ + 'description' => 'The information about the story.'."\n", + '$ref' => '#/components/schemas/Story', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\",\\n \\"Story\\": {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"StoryName\\": \\"\\",\\n \\"StoryType\\": \\"\\",\\n \\"StorySubType\\": \\"\\",\\n \\"StoryStartTime\\": \\"\\",\\n \\"StoryEndTime\\": \\"\\",\\n \\"Files\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ],\\n \\"Cover\\": {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"CroppingSuggestions\\": [],\\n \\"OCRContents\\": []\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n },\\n \\"FigureClusterIds\\": [\\n \\"\\"\\n ],\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'GetStory', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* Before you call this operation, make sure that you have indexed file metadata into the dataset automatically by calling the [CreateBinding](~~478202~~) operation or manually by calling the [IndexFileMeta](~~478166~~) or [BatchIndexFileMeta](~~478167~~) operation.'."\n" + .'* Before you call this operation, make sure that you have called the [CreateStory](~~478193~~) or [CreateCustomizedStory](~~478196~~) operation to create a story.'."\n", + ], + 'CreateCustomizedStory' => [ + 'summary' => 'Creates a story based on the specified images and videos.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '156038', + 'abilityTreeNodes' => [ + 'FEATUREimmPQ568C', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the dataset.[](~~478160~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dataset001', + ], + ], + [ + 'name' => 'StoryType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The type of the story. For information about valid types, see [Story types and subtypes](~~2743998~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'PeopleMemory', + ], + ], + [ + 'name' => 'StorySubType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The subtype of the story. For information about valid subtypes, see [Story types and subtypes](~~2743998~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Solo', + ], + ], + [ + 'name' => 'StoryName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the story.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'name1', + ], + ], + [ + 'name' => 'Cover', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The cover image of the story. You can specify an image as the cover image of the custom story.'."\n", + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => 'The URI of the cover image.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://bucket1/cover', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'Files', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The files of the story. You can specify up to 100 files in a custom story.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => 'The URIs of the files.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '[{"URI":"oss://bucket1/file1"}]', + ], + ], + 'required' => true, + 'description' => '', + ], + 'required' => true, + ], + ], + [ + 'name' => 'CustomLabels', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The custom labels. You can specify labels to help you identify and retrieve the story.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{"Bucket": "examplebucket"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'BC91D091-D49F-0ACD-95D5-F0621045****', + ], + 'ObjectId' => [ + 'description' => 'The ID of the story.'."\n", + 'type' => 'string', + 'example' => '563062c0b085733f34ab****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC91D091-D49F-0ACD-95D5-F0621045****\\",\\n \\"ObjectId\\": \\"563062c0b085733f34ab****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateCustomizedStory', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* Before you call this operation, make sure that you have indexed file metadata into the dataset automatically by calling the [CreateBinding](~~478202~~) operation or manually by calling the [IndexFileMeta](~~478166~~) or [BatchIndexFileMeta](~~478167~~) operation.'."\n", + ], + 'UpdateStory' => [ + 'summary' => 'Updates the information about a story, such as the story name and cover image.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '123272', + 'abilityTreeNodes' => [ + 'FEATUREimmPQ568C', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the project.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the dataset.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testdata', + ], + ], + [ + 'name' => 'ObjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the story.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'StoryName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the story.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'newstory', + ], + ], + [ + 'name' => 'Cover', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The cover image of the story.'."\n", + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => 'The URI of the cover image.'."\n" + ."\n" + .'Specify the OSS URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Object}` is the path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://bucket1/object', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'CustomLabels', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The custom tags. You can specify up to 100 custom tags.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{"key": "value"}', + ], + ], + [ + 'name' => 'CustomId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The custom ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6E93D6C9-5AC0-49F9-914D-E02678D3****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'UpdateStory', + ], + 'AddStoryFiles' => [ + 'summary' => 'Adds objects to a story.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '142648', + 'abilityTreeNodes' => [ + 'FEATUREimmPQ568C', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The name of the project.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the dataset.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'ObjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the story.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'Files', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The objects that you want to add.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the object.'."\n", + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => 'The URI of the object.'."\n" + ."\n" + .'Specify the OSS URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Object}` is the path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****', + ], + 'Files' => [ + 'description' => 'The objects that were added.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the object.'."\n", + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => 'The URI of the object.'."\n" + ."\n" + .'The OSS URI follows the `oss://{bucketname}/{objectname}` format, where `bucketname` is the name of the bucket in the same region as the current project and `objectname` is the path of the object with the extension included.'."\n", + 'type' => 'string', + 'example' => 'oss://test-bucket/test-object', + ], + 'ErrorCode' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'ResourceNotFound', + ], + 'ErrorMessage' => [ + 'description' => 'The error message that is returned.'."\n", + 'type' => 'string', + 'example' => 'The specified resource %s is not found.', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6E93D6C9-5AC0-49F9-914D-E02678D3****\\",\\n \\"Files\\": [\\n {\\n \\"URI\\": \\"oss://test-bucket/test-object\\",\\n \\"ErrorCode\\": \\"ResourceNotFound\\",\\n \\"ErrorMessage\\": \\"The specified resource %s is not found.\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'AddStoryFiles', + ], + 'RemoveStoryFiles' => [ + 'summary' => 'Deletes files from a story.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '142653', + 'abilityTreeNodes' => [ + 'FEATUREimmPQ568C', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The name of the project.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the dataset.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testdataset', + ], + ], + [ + 'name' => 'ObjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the story.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'Files', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The files that you want to delete.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The file that you want to delete.'."\n", + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => 'The URI of the Object Storage Service (OSS) bucket where you store the files that you want to delete.'."\n" + ."\n" + .'Specify the value in the oss://${Bucket}/${Object} format. `${Bucket}` specifies the name of the OSS bucket that resides in the same region as the current project. `${Object}` specifies the complete path to the files that have an extension.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://bucket1/object', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6E93D6C9-5AC0-49F9-914D-E02678D3****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'RemoveStoryFiles', + ], + 'DeleteStory' => [ + 'summary' => 'Deletes a story.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '102497', + 'abilityTreeNodes' => [ + 'FEATUREimmPQ568C', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset.[](~~478160~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dataset001', + ], + ], + [ + 'name' => 'ObjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the story to delete.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'id1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'DeleteStory', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* Before you call this operation, make sure that you have indexed file metadata into the dataset automatically by calling the [CreateBinding](~~478202~~) operation or manually by calling the [IndexFileMeta](~~478166~~) or [BatchIndexFileMeta](~~478167~~) operation.'."\n" + .'* Before you call this operation, make sure that you have called the [CreateStory](~~478193~~) or [CreateCustomizedStory](~~478196~~) operation to create a story.'."\n", + ], + 'CreateSimilarImageClusteringTask' => [ + 'summary' => 'Clusters images indexed into a dataset by similarity. Image clustering is suitable for image deduplication and selection. For example, you can use image clustering to filter photos in your album that are taken in continuous shooting mode.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '161810', + 'abilityTreeNodes' => [ + 'FEATUREimm8BY6HG', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset.[](~~478160~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom information, which is returned in an asynchronous notification and facilitates notification management. The maximum length of the value is 2,048 bytes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test-data', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The custom tags. You can search for or filter asynchronous tasks by custom tag.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "User": "Jane"'."\n" + .'}', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The notification settings. For information about the asynchronous notification format, see [Asynchronous message examples](~~2743997~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The information about the image clustering task.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => 'SimilarImageClustering-48d0a0f3-8459-47f4-b8af-ff49c64****', + ], + 'EventId' => [ + 'description' => 'The event ID.'."\n", + 'type' => 'string', + 'example' => '3BF-1UhtFyrua71eOkFlqYq23Co****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\",\\n \\"TaskId\\": \\"SimilarImageClustering-48d0a0f3-8459-47f4-b8af-ff49c64****\\",\\n \\"EventId\\": \\"3BF-1UhtFyrua71eOkFlqYq23Co****\\"\\n}","type":"json"}]', + 'title' => 'CreateSimilarImageClusteringTask', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note that** Asynchronous processing does not guarantee timely task completion.'."\n" + ."\n" + .'* Before you call this operation, make sure that you have indexed file metadata into the dataset automatically by calling the [CreateBinding](~~478202~~) operation or manually by calling the [IndexFileMeta](~~478166~~) or [BatchIndexFileMeta](~~478167~~) operation.'."\n" + ."\n" + .'* Each call to the operation incrementally processes metadata in the dataset.****`` You can regularly call this operation to process incremental files.'."\n" + ."\n" + .'* After clustering is completed, you can call the [QuerySimilarImageClusters](~~611304~~) operation to query image clustering results.'."\n" + ."\n" + .'* An image cluster contains at lest two images. Removing similar images from the dataset affects existing image clusters. If image deletion reduces the number of images in a cluster to less than 2, the cluster is automatically deleted.'."\n" + ."\n" + .'* This operation is an asynchronous operation. After a task is executed, the task information is retained only for seven days and cannot be retrieved when the retention period elapses. You can call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation to query information about the task.`` If you specify [Notification](~~2743997~~), you can obtain information about the task based on notifications.'."\n", + ], + 'QuerySimilarImageClusters' => [ + 'summary' => 'You can call this operation to query the list of similar image clusters.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '161811', + 'abilityTreeNodes' => [ + 'FEATUREimm8BY6HG', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset. For more information, see [Create a dataset](~~478160~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token.'."\n" + ."\n" + .'If the total number of clusters is greater than the value of MaxResults, you must specify this parameter. The next call to the operation returns results lexicographically after the NextToken parameter value.'."\n" + ."\n" + .'> The first time you call this operation in a query, set this parameter to null.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CAESEgoQCg4KClVwZGF0ZVRpbWUQARgBIs8ECgkAAJLUwUCAQ****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Value range: 0 to 100. Default value: 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CustomLabels', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom tags, which are used to filter tasks.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"key": "val"}', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sorting field.'."\n" + ."\n" + .'* CreateTime: the time when the clusters were created.'."\n" + .'* UpdateTime: the time when the clusters were updated. This is the default value.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'UpdateTime', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sorting order. Valid values:'."\n" + ."\n" + .'* asc: ascending order.'."\n" + .'* desc: descending order. This is the default value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FFF****'."\n", + ], + 'SimilarImageClusters' => [ + 'description' => 'The list of similar image clusters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about similar image clusters.'."\n", + '$ref' => '#/components/schemas/SimilarImageCluster', + ], + ], + 'NextToken' => [ + 'description' => 'The pagination token. If the total number of clusters is greater than the value of MaxResults, this token can be used to retrieve the next page. This parameter has a value only if not all the clusters that meet the condition are returned.'."\n" + ."\n" + .'Pass this value as the value of NextToken in the next query to return the subsequent clusters.'."\n", + 'type' => 'string', + 'example' => 'CAESEgoQCg4KClVwZGF0ZVRpbWUQARgBIs8ECgkAAJLUwUCAQ****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FFF****\\\\n\\",\\n \\"SimilarImageClusters\\": [\\n {\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Files\\": [\\n {\\n \\"URI\\": \\"\\",\\n \\"ImageScore\\": 0\\n }\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"CAESEgoQCg4KClVwZGF0ZVRpbWUQARgBIs8ECgkAAJLUwUCAQ****\\"\\n}","type":"json"}]', + 'title' => 'QuerySimilarImageClusters', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* Before you call this operation, you must call the [CreateSimilarImageClusteringTask](~~611302~~) operation to cluster similar images in the dataset.'."\n", + ], + 'CreateBinding' => [ + 'summary' => 'Creates a binding relationship between a dataset and an Object Storage Service (OSS) bucket. This allows for the automatic synchronization of incremental and full data and indexing.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '18909', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + 'title' => 'ProjectName', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset. You can obtain the name of the dataset from the response of the [CreateDataset](~~478160~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + 'title' => 'DatasetName', + ], + ], + [ + 'name' => 'URI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URI of the OSS bucket to which you bind the dataset.'."\n" + ."\n" + .'Specify the value in the oss://${Bucket} format. `${Bucket}` specifies the name of the OSS bucket that resides in the same region as the current project.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://examplebucket', + 'title' => 'URI', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5F74C5C9-5AC0-49F9-914D-E01589D3****', + 'title' => 'Id of the request', + ], + 'Binding' => [ + 'description' => 'The information about the binding.'."\n", + '$ref' => '#/components/schemas/Binding', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5F74C5C9-5AC0-49F9-914D-E01589D3****\\",\\n \\"Binding\\": {\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"State\\": \\"\\",\\n \\"Phase\\": \\"\\",\\n \\"Detail\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"Filters\\": [\\n \\"\\"\\n ],\\n \\"ServiceRole\\": \\"\\",\\n \\"Notification\\": {\\n \\"MNS\\": {\\n \\"TopicName\\": \\"\\"\\n },\\n \\"WithFields\\": [\\n \\"\\"\\n ]\\n },\\n \\"WorkflowParameters\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateBinding', + 'description' => 'Before you call this operation, make sure that you are familiar with the [billing](~~2743997~~) of Intelligent Media Management (IMM).****'."\n" + ."\n" + .'> Asynchronous processing does not guarantee timely task completion.'."\n" + ."\n" + .'Before you create a binding, make sure that the project and the dataset that you want to use exist.'."\n" + ."\n" + .'* For information about how to create a project, see [CreateProject](~~478153~~).'."\n" + .'* For information about how to create a dataset, see [CreateDataset](~~478160~~).'."\n" + ."\n" + .'> The CreateBinding operation works by using the [workflow template](~~466304~~) that is specified when you created the project or dataset.'."\n" + ."\n" + .'After you create a binding between a dataset and an OSS bucket, IMM scans the existing objects in the bucket and extracts metadata based on the scanning result. Then, IMM creates an index from the extracted metadata. If new objects are uploaded to the OSS bucket, IMM tracks and scans the objects and updates the index. For objects whose metadata index is created by calling this operation, you can call query operations, such as [SimpleQuery](~~478175~~), to query objects, manage objects, and collect statistics on objects.'."\n", + ], + 'GetBinding' => [ + 'summary' => 'Queries the binding relationship between a specific dataset and an Object Storage Service (OSS) bucket.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '33029', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset. You can obtain the name of the dataset from the response of the [CreateDataset](~~478160~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dataset001', + ], + ], + [ + 'name' => 'URI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URI of the OSS bucket to which you bind the dataset.'."\n" + ."\n" + .'Specify the value in the oss://${Bucket} format. `${Bucket}` specifies the name of the OSS bucket that resides in the same region as the current project.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'AEFCD467-C928-4A36-951A-6EB5A592****', + 'title' => 'Id of the request', + ], + 'Binding' => [ + 'description' => 'The details of the binding.'."\n", + '$ref' => '#/components/schemas/Binding', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AEFCD467-C928-4A36-951A-6EB5A592****\\",\\n \\"Binding\\": {\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"State\\": \\"\\",\\n \\"Phase\\": \\"\\",\\n \\"Detail\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"Filters\\": [\\n \\"\\"\\n ],\\n \\"ServiceRole\\": \\"\\",\\n \\"Notification\\": {\\n \\"MNS\\": {\\n \\"TopicName\\": \\"\\"\\n },\\n \\"WithFields\\": [\\n \\"\\"\\n ]\\n },\\n \\"WorkflowParameters\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'GetBinding', + 'description' => '* **Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).**'."\n" + .'* Make sure that the binding relationship that you want to query exists. For information about how to create a binding relationship, see [CreateBinding](~~478202~~).'."\n", + ], + 'ListBindings' => [ + 'summary' => 'Queries bindings between a dataset and Object Storage Service (OSS) buckets.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10879', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset.[](~~478160~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '* The maximum number of bindings to return. Valid values: 0 to 200.'."\n" + .'* If you do not specify this parameter or set the parameter to 0, the default value of 100 is used.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '* The pagination token that is used in the next request to retrieve a new page of results if the total number of results exceeds the value of the MaxResults parameter.'."\n" + .'* The next call to the operation returns results lexicographically after the NextToken parameter value.'."\n" + .'* You do not need to specify this parameter in your initial request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'immtest:dataset001:examplebucket01', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'EFDFD356-C928-4A36-951A-6EB5A592****', + ], + 'NextToken' => [ + 'description' => '* The pagination token that is used in the next request to retrieve a new page of results if the total number of results exceeds the value of the MaxResults parameter.'."\n" + .'* The next request returns remaining results starting from the position marked by the NextToken parameter value.'."\n" + .'* This parameter has a non-empty value only when not all bindings are returned.'."\n", + 'type' => 'string', + 'example' => 'immtest:dataset001:examplebucket01', + ], + 'Bindings' => [ + 'description' => 'The bindings between the dataset and OSS buckets.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the binding between the dataset and the bucket.'."\n", + '$ref' => '#/components/schemas/Binding', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EFDFD356-C928-4A36-951A-6EB5A592****\\",\\n \\"NextToken\\": \\"immtest:dataset001:examplebucket01\\",\\n \\"Bindings\\": [\\n {\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"State\\": \\"\\",\\n \\"Phase\\": \\"\\",\\n \\"Detail\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"Filters\\": [\\n \\"\\"\\n ],\\n \\"ServiceRole\\": \\"\\",\\n \\"Notification\\": {\\n \\"MNS\\": {\\n \\"TopicName\\": \\"\\"\\n },\\n \\"WithFields\\": [\\n \\"\\"\\n ]\\n },\\n \\"WorkflowParameters\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'ListBindings', + 'description' => 'Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).'."\n", + ], + 'DeleteBinding' => [ + 'summary' => 'Deletes the binding between a dataset and an Object Storage Service (OSS) bucket.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '38133', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset. For more information, see [Create a dataset](~~478160~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dataset001', + ], + ], + [ + 'name' => 'URI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URI of the OSS bucket to which the dataset is bound.'."\n" + ."\n" + .'Specify the value in the oss://${Bucket} format. `${Bucket}` specifies the name of the OSS bucket that resides in the same region as the current project.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'ACDFE467-C817-4B36-951A-6EB5A592****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ACDFE467-C817-4B36-951A-6EB5A592****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'DeleteBinding', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* If you delete a binding, new changes in the OSS bucket are not synchronized to the dataset. Exercise caution when you perform this operation.'."\n", + ], + 'AttachOSSBucket' => [ + 'summary' => 'Binds an Object Storage Service (OSS) bucket to the specified project. The binding enables you to use IMM features by using the x-oss-process parameter.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '135038', + 'abilityTreeNodes' => [ + 'FEATUREimmKH590Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project. For information about how to create a project, see [CreateProject](~~478153~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'OSSBucket', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the OSS bucket in the same region as the project.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the binding. The description must be 1 to 128 characters in length. By default, no description is applied.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test-attachment', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5F74C5C9-5AC0-49F9-914D-E01589D3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5F74C5C9-5AC0-49F9-914D-E01589D3****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'AttachOSSBucket', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* To use data processing capabilities of IMM based on the x-oss-process parameter, you must bind an OSS bucket to an IMM project. For more information, see [x-oss-process](~~2391270~~).'."\n" + .'* Make sure that the specified project exists in the current region. For more information, see [Project management](~~478152~~).'."\n", + ], + 'DetachOSSBucket' => [ + 'summary' => 'Unbinds an Object Storage Service (OSS) bucket from the corresponding project.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '135041', + 'abilityTreeNodes' => [ + 'FEATUREimmKH590Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'OSSBucket', + 'in' => 'query', + 'schema' => [ + 'description' => 'The OSS bucket that you want to unbind.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5F74C5C9-5AC0-49F9-914D-E01589D3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5F74C5C9-5AC0-49F9-914D-E01589D3****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'DetachOSSBucket', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~88317~~) of Intelligent Media Management (IMM).****'."\n" + .'* Before you call this operation, make sure that the project is bound to a bucket. For more information, see [AttachOSSBucket](~~478206~~).'."\n", + ], + 'GetOSSBucketAttachment' => [ + 'summary' => 'Queries the name of the project bound to an Object Storage Service (OSS) bucket.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '135040', + 'abilityTreeNodes' => [ + 'FEATUREimmKH590Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'OSSBucket', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the OSS bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5F74C5C9-5AC0-49F9-914D-E01589D3****', + ], + 'ProjectName' => [ + 'description' => 'The name of the project.'."\n", + 'type' => 'string', + 'example' => 'immtest', + ], + 'Description' => [ + 'description' => 'The description of the dataset.'."\n", + 'type' => 'string', + 'example' => '"Dataset"'."\n", + ], + 'CreateTime' => [ + 'description' => 'The time when the dataset was created.'."\n", + 'type' => 'string', + 'example' => '""2023-12-19T17:29:34.790931971+08:00"', + ], + 'UpdateTime' => [ + 'description' => 'The time when the dataset was last updated.'."\n", + 'type' => 'string', + 'example' => '"2023-12-19T17:29:34.790931971+08:00"', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5F74C5C9-5AC0-49F9-914D-E01589D3****\\",\\n \\"ProjectName\\": \\"immtest\\",\\n \\"Description\\": \\"\\\\\\"数据集\\\\\\"\\",\\n \\"CreateTime\\": \\"\\\\\\"\\\\\\"2023-12-19T17:29:34.790931971+08:00\\\\\\"\\",\\n \\"UpdateTime\\": \\"\\\\\\"2023-12-19T17:29:34.790931971+08:00\\\\\\"\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'GetOSSBucketAttachment', + 'description' => '* **Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).**'."\n" + .'* Before you call this operation, make sure that [the project whose name you want to query is bound to the specified OSS bucket](~~478206~~).'."\n", + ], + 'EncodeBlindWatermark' => [ + 'summary' => 'Embeds specific textual information into an image as watermarks. These watermarks are visually imperceptible and do not affect the aesthetics of the image or the integrity of the original data. The watermarks can be extracted by using the CreateDecodeBlindWatermarkTask operation.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '199817', + 'abilityTreeNodes' => [ + 'FEATUREimmSCVT08', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Object Storage Service (OSS) URI of the image.'."\n" + ."\n" + .'Specify the value in the oss://${Bucket}/${Object} format. `${Bucket}` specifies the name of the OSS bucket that resides in the same region with the current project. `${Object}` specifies the path of the object with the extension included.'."\n" + ."\n" + .'Supported image formats: JPG, PNG, BMP, TIFF, and WebP.'."\n" + ."\n" + .'Image size limit: 10,000 px maximum and 80 px x 80 px minimum.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-object.jpg', + ], + ], + [ + 'name' => 'TargetURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URI of the output image in OSS.'."\n" + ."\n" + .'Specify the URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Object}` is the path of the object with the extension included.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The format of the output image is the same as that of the input image.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/target-object.jpg', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => 'The text content of watermarks. It can be up to 256 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'StrengthLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The watermark strength level. The higher the strength, the more resistant the watermarked image is to attacks, but the more the image is distorted. Default value: low. Valid values: \\[low, medium, high].'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'high' => 'high', + 'low' => 'low', + 'medium' => 'medium', + ], + 'example' => 'low', + ], + ], + [ + 'name' => 'ImageQuality', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter takes effect only if the input image format is JPG.'."\n" + ."\n" + .'The storage quality of the output image that carries the watermarks. Default value: 90. Valid values: 70 to 100. The higher the quality, the larger the image size and the higher the watermark resolution quality.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '90', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8E0DD64B-28C6-4653-8FF7-93E4C234BCF0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8E0DD64B-28C6-4653-8FF7-93E4C234BCF0\\"\\n}","type":"json"}]', + 'title' => 'EncodeBlindWatermark', + 'description' => '* Before you call this operation, make sure that you are familiar with the billing of Intelligent Media Management (IMM).'."\n" + .'* Make sure that an IMM project is created. For information about how to create a project, see [CreateProject](~~478153~~).'."\n" + .'* You can embed only text as blind watermarks to an image.'."\n" + .'* The format of the output image is the same as that of the input image.'."\n" + .'* A blind watermark can still be extracted even if attacks, such as compression, scaling, cropping, and color transformation, are performed on the image.'."\n" + .'* Pure black and white images and images with low resolution (roughly less than 200 px × 200 px,) are not supported.'."\n", + ], + 'CreateDecodeBlindWatermarkTask' => [ + 'summary' => 'Decodes the blind watermark in an image.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '200063', + 'abilityTreeNodes' => [ + 'FEATUREimmSCVT08', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The name of the project.[](~~478153~~)'."\n" + ."\n" + .'> The project specified in the request must match the one in the EncodeBlindWatermark request to encode the blind watermark.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The OSS URI of the image.'."\n" + ."\n" + .'Specify the OSS URI in the `oss://<bucket>/<object>` format, where `<bucket>` is the name of the bucket in the same region as the current project and `<object>` is the path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://target/sampleobject.jpg', + ], + ], + [ + 'name' => 'StrengthLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The level of watermark extraction. A higher level indicates a longer time and a higher quality. Valid values:'."\n" + ."\n" + .'* low'."\n" + .'* medium'."\n" + .'* high'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'low', + ], + ], + [ + 'name' => 'WatermarkType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the watermark. Valid value: text.'."\n" + ."\n" + .'No image watermarks are supported.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'text' => 'text', + ], + 'example' => 'text', + ], + ], + [ + 'name' => 'TargetURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The OSS URI of the output image. This parameter is also available in the earlier DecodeBlindWatermark operation.'."\n" + ."\n" + .'Specify the OSS URI in the `oss://<bucket>/<object>` format, where `<bucket>` is the name of the bucket in the same region as the current project and `<object>` is the path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://target/targetobject.jpg', + ], + ], + [ + 'name' => 'ImageQuality', + 'in' => 'query', + 'schema' => [ + 'description' => 'The quality of the output image. This parameter is also available in the earlier DecodeBlindWatermark operation.'."\n" + ."\n" + .'Higher image quality indicates a larger image size and higher watermark resolution quality.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '90', + ], + ], + [ + 'name' => 'Model', + 'in' => 'query', + 'schema' => [ + 'description' => 'The watermark algorithm model. This parameter is also available in the earlier DecodeBlindWatermark operation. Valid values: FFT, FFT_FULL, DWT, and DWT_IBG. Default value: FFT.'."\n" + ."\n" + .'If this parameter is left empty, the CreateDecodeBlindWatermarkTask operation is called. Otherwise, the earlier DecodeBlindWatermark operation is called.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DWT' => 'DWT', + 'FFT_FULL' => 'FFT_FULL', + 'FFT' => 'FFT', + 'DWT_IBG' => 'DWT_IBG', + ], + 'example' => 'FFT', + ], + ], + [ + 'name' => 'OriginalImageURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The OSS URI of the image before the blind watermark is added. This parameter is also available in the earlier DecodeBlindWatermark operation.'."\n" + ."\n" + .'Do not specify this parameter when you set the Model parameter to DWT or DWT_IBG.'."\n" + ."\n" + .'Specify the OSS URI in the `oss://<bucket>/<object>` format, where `<bucket>` is the name of the bucket in the same region as the current project and `<object>` is the path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://imm-test/testcases/watermarktestbefore.jpg', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The notification settings. For information about the asynchronous notification format, see [Asynchronous message examples](~~2743997~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4A7A2D0E-D8B8-4DA0-8127-EB32C6600ADE', + ], + 'EventId' => [ + 'description' => 'The event ID.'."\n", + 'type' => 'string', + 'example' => '27C-1jyAP5qQI7RoI8lFFwvMrWtl0ft', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => 'DecodeBlindWatermark-78ac8f3b-59e0-45a6-9b67-32168c3f22b9', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4A7A2D0E-D8B8-4DA0-8127-EB32C6600ADE\\",\\n \\"EventId\\": \\"27C-1jyAP5qQI7RoI8lFFwvMrWtl0ft\\",\\n \\"TaskId\\": \\"DecodeBlindWatermark-78ac8f3b-59e0-45a6-9b67-32168c3f22b9\\"\\n}","type":"json"}]', + 'title' => 'CreateDecodeBlindWatermarkTask', + 'description' => '* Before you call this operation, make sure that you are familiar with the billing of Intelligent Media Management (IMM).'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note that** Asynchronous processing does not guarantee timely task completion.'."\n" + ."\n" + .'* Make sure that an IMM project is created. For information about how to create a project, see [CreateProject](~~478153~~).'."\n" + ."\n" + .'* The region and project specified in the request to decode a blind watermark must match those in the [EncodeBlindWatermark](~~2743655~~) request to encode the blind watermark.'."\n" + ."\n" + .'* A blind watermark can still be extracted even if attacks, such as compression, scaling, cropping, and color transformation, are performed on the image.'."\n" + ."\n" + .'* This operation is compatible with its earlier version DecodeBlindWatermark.'."\n" + ."\n" + .'* This operation is an asynchronous operation. After a task is executed, the task information is retained only for seven days and cannot be retrieved when the retention period elapses. You can call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation to query information about the task. If you specify [Notification](~~2743997~~), you can obtain information about the task based on notifications.'."\n", + ], + 'GetDecodeBlindWatermarkResult' => [ + 'summary' => 'Queries the result of an invisible watermark parsing task.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'abilityTreeCode' => '204408', + 'abilityTreeNodes' => [ + 'FEATUREimmSCVT08', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the task.'."\n" + ."\n" + .'* Set the value to DecodeBlindWatermark.'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'DecodeBlindWatermark' => 'DecodeBlindWatermark', + ], + 'example' => 'DecodeBlindWatermark', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the task. You can obtain the ID of the task from the response of the CreateDecodeBlindWatermarkTask operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'DecodeBlindWatermark-c09b0943-ed79-4983-8dbe-7a882574****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '93126E40-0296-4129-95E3-AFAC709372E5', + ], + 'ProjectName' => [ + 'description' => 'The project name.'."\n", + 'type' => 'string', + 'example' => 'test-project', + ], + 'EventId' => [ + 'description' => 'The event ID.'."\n", + 'type' => 'string', + 'example' => '2C2-1I0EG57VR37J4rQ8oKG6C9*****', + ], + 'Status' => [ + 'description' => 'The task status.'."\n", + 'type' => 'string', + 'example' => 'Succeeded', + ], + 'Code' => [ + 'description' => 'The error code of the task.'."\n", + 'type' => 'string', + 'example' => 'ResourceNotFound', + ], + 'Message' => [ + 'description' => 'The error message of the task.'."\n", + 'type' => 'string', + 'example' => 'The specified resource project is not found.', + ], + 'StartTime' => [ + 'description' => 'The start time of the task.'."\n", + 'type' => 'string', + 'example' => '2024-03-03T09:44:31.029Z', + ], + 'EndTime' => [ + 'description' => 'The end time of the task.'."\n", + 'type' => 'string', + 'example' => '2024-03-03T09:45:56.87Z', + ], + 'UserData' => [ + 'description' => 'The user data of the task.'."\n", + 'type' => 'string', + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + 'TaskType' => [ + 'description' => 'The task type.'."\n", + 'type' => 'string', + 'example' => 'DecodeBlindWatermark', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => 'DecodeBlindWatermark-c09b0943-ed79-4983-8dbe-7a882574****', + ], + 'Content' => [ + 'description' => 'The watermark content.'."\n", + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"93126E40-0296-4129-95E3-AFAC709372E5\\",\\n \\"ProjectName\\": \\"test-project\\",\\n \\"EventId\\": \\"2C2-1I0EG57VR37J4rQ8oKG6C9*****\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"Code\\": \\"ResourceNotFound\\",\\n \\"Message\\": \\"The specified resource project is not found.\\",\\n \\"StartTime\\": \\"2024-03-03T09:44:31.029Z\\",\\n \\"EndTime\\": \\"2024-03-03T09:45:56.87Z\\",\\n \\"UserData\\": \\"{\\\\\\"ID\\\\\\": \\\\\\"user1\\\\\\",\\\\\\"Name\\\\\\": \\\\\\"test-user1\\\\\\",\\\\\\"Avatar\\\\\\": \\\\\\"http://example.com?id=user1\\\\\\"}\\",\\n \\"TaskType\\": \\"DecodeBlindWatermark\\",\\n \\"TaskId\\": \\"DecodeBlindWatermark-c09b0943-ed79-4983-8dbe-7a882574****\\",\\n \\"Content\\": \\"阿里云版权所有\\"\\n}","type":"json"}]', + 'title' => 'GetDecodeBlindWatermarkResult', + 'description' => '* Before you call this operation, make sure that an Intelligent Media Management (IMM) project is created. For information about how to create a project, see [CreateProject](~~478153~~).'."\n" + .'* Before you call this operation, make sure that an invisible watermark task is created and the task ID is obtained.``'."\n", + ], + 'DetectImageLabels' => [ + 'summary' => 'Detects scene, object, and event information in an image. Scene information includes natural landscapes, daily life, and disasters. Event information includes talent shows, office events, performances, and production events. Object information includes tableware, electronics, furniture, and transportation. The DetectImageLabels operation supports more than 30 different categories and thousands of labels.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '82228', + 'abilityTreeNodes' => [ + 'FEATUREimmELX4L2', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'title' => 'SourceURI', + 'description' => 'The URI of the Object Storage Service (OSS) bucket in which you store the image.'."\n" + ."\n" + .'Specify the value in the oss://${Bucket}/${Object} format. `${Bucket}` specifies the name of the OSS bucket that resides in the same region as the current project. `${Object}` specifies the complete path to the image file that has an extension.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://imm-test/testcases/facetest.jpg', + ], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => [ + 'title' => 'Threshold', + 'description' => 'The threshold of the label confidence. Labels whose confidence is lower than the specified threshold are not returned in the response. Valid values: 0 to 1. If you leave this parameter empty, the algorithm provides a default threshold.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**If you have no special requirements, leave this parameter empty.**'."\n" + ."\n" + .'The authorization chain settings. For more information, see [Use authorization chains to access resources of other entities](~~465340~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片检测结果', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Labels' => [ + 'title' => '内容标签列表', + 'description' => 'The list of labels detected.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The labels.'."\n", + '$ref' => '#/components/schemas/Label', + ], + ], + 'RequestId' => [ + 'title' => '请求唯一ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '91AC8C98-0F36-49D2-8290-742E24DF1F69', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"RequestId\\": \\"91AC8C98-0F36-49D2-8290-742E24DF1F69\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'DetectImageLabels', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* Make sure that an IMM [project](~~478273~~) is created. For information about how to create a project, see [CreateProject](~~478153~~).'."\n" + .'* For more information about the features of this operation, see [Image label detection](~~477179~~).'."\n" + .'* For more information about the input images supported by this operation, see [Limits on images](~~475569~~).'."\n", + ], + 'DetectImageScore' => [ + 'summary' => 'Calculates the aesthetics quality score of an image based on metrics such as the composition, brightness, contrast, color, and resolution. The operation returns a score within the range from 0 to 1. A higher score indicates better image quality.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '129324', + 'abilityTreeNodes' => [ + 'FEATUREimmEAXWFI', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project.[](~~477051~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The OSS URI of the input image.'."\n" + ."\n" + .'Specify the OSS URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Object}` is the path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://bucketname/objectname', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**If you have no special requirements, leave this parameter empty.**'."\n" + ."\n" + .'The authorization chain settings. For more information, see [Use authorization chains to access resources of other entities](~~465340~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****', + ], + 'ImageScore' => [ + 'description' => 'The quality score of the image.'."\n", + 'type' => 'object', + 'properties' => [ + 'OverallQualityScore' => [ + 'description' => 'The overall quality score.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6E93D6C9-5AC0-49F9-914D-E02678D3****\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.6\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'DetectImageScore', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~88317~~) of Intelligent Media Management (IMM).****'."\n" + .'* Make sure that the specified project exists in the current region. For more information, see [Project management](~~478273~~).[](~~478152~~)'."\n" + .'* For information about the image encoding formats supported by this operation, see [Limits](~~475569~~).'."\n", + ], + 'DetectImageCodes' => [ + 'summary' => 'Detects barcodes and QR codes in an image.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '142280', + 'abilityTreeNodes' => [ + 'FEATUREimmSL7X1M', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'title' => 'SourceURI', + 'description' => 'The URI of the Object Storage Service (OSS) bucket in which the image file is stored.'."\n" + ."\n" + .'Specify the value in the oss://${Bucket}/${Object} format. `${Bucket}` specifies the name of the OSS bucket that resides in the same region as the current project. `${Object}` specifies the complete path to the file that has an extension.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://bucketname/objectname', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**If you have no special requirements, leave this parameter empty.**'."\n" + ."\n" + .'The authorization chain settings. For more information, see [Use authorization chains to access resources of other entities](~~465340~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片二维码检测结果', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Codes' => [ + 'title' => '二维码检测结果', + 'description' => 'The barcodes or QR codes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The barcode or QR code information.'."\n", + '$ref' => '#/components/schemas/Codes', + ], + 'required' => true, + 'minItems' => 0, + ], + 'RequestId' => [ + 'title' => '请求唯一ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Codes\\": [\\n {\\n \\"Content\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"RequestId\\": \\"6E93D6C9-5AC0-49F9-914D-E02678D3****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'DetectImageCodes', + 'description' => '* For information about the image encoding formats supported by this operation, see [Limits on images](~~475569~~).'."\n", + ], + 'DetectImageFaces' => [ + 'summary' => 'Detects faces from an image, including face boundary information, attributes, and quality. The boundary information includes the distance from the y-coordinate of the vertex to the top edge (Top), distance from the x-coordinate of the vertex to the left edge (Left), height (Height), and width (Width). Face attributes include the age (Age), age standard deviation (AgeSD), gender (Gender), emotion (Emotion), mouth opening (Mouth), beard (Beard), hat wearing (Hat), mask wearing (Mask), glasses wearing (Glasses), head orientation (HeadPose), attractiveness (Attractive), and confidence levels for preceding attributes. Quality information includes the face quality score (FaceQuality) and face resolution (Sharpness).', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '129323', + 'abilityTreeNodes' => [ + 'FEATUREimmU4U2B0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The OSS URI of the image object.'."\n" + ."\n" + .'Specify the OSS URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Object}` is the path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object.jpg', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**If you have no special requirements, leave this parameter empty.**'."\n" + ."\n" + .'The authorization chain settings. For more information, see [Use authorization chains to access resources of other entities](~~465340~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****', + ], + 'Faces' => [ + 'description' => 'The faces.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The face details.'."\n", + '$ref' => '#/components/schemas/Figure', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6E93D6C9-5AC0-49F9-914D-E02678D3****\\",\\n \\"Faces\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'DetectImageFaces', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* For information about the image encoding formats supported by this operation, see [Limits](~~475569~~).'."\n", + ], + 'DetectImageCropping' => [ + 'summary' => 'Detects the cropping area that produces the optimal visual effect based on a given image ratio by using AI model capabilities.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '133405', + 'abilityTreeNodes' => [ + 'FEATUREimm1NT5J6', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'title' => 'SourceURI', + 'description' => 'The URI of the Object Storage Service (OSS) bucket in which you store the image.'."\n" + ."\n" + .'Specify the value in the oss://${Bucket}/${Object} format. `${Bucket}` specifies the name of the OSS bucket that resides in the same region as the current project. `${Object}` specifies the complete path to the image file that has an extension.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://imm-test/testcases/facetest.jpg', + ], + ], + [ + 'name' => 'AspectRatios', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cropping ratios. You can specify up to five cropping ratios. Take note of the following requirements:'."\n" + ."\n" + .'* The ratio must be an integer between 0 and 20.'."\n" + .'* The ratio must range from 0.5 to 2.'."\n" + .'* If you leave this parameter empty, the default processing logic is `["auto"]`.'."\n" + ."\n" + .'> Errors are reported in one of the following cases:\\'."\n" + .'You specify more than five cropping ratios.\\'."\n" + .'You pass an empty list to the system.\\'."\n" + .'You specify a ratio that is not an integer, such as `4.1:3`.\\'."\n" + .'The ratio is beyond the range of 0.5 to 2.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["1:1"]', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**If you have no special requirements, leave this parameter empty.**'."\n" + ."\n" + .'The authorization chain settings. For more information, see [Use authorization chains to access resources of other entities](~~465340~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片裁剪结果', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Croppings' => [ + 'title' => '图片裁剪结果', + 'description' => 'The image cropping suggestions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The image cropping details.'."\n", + '$ref' => '#/components/schemas/CroppingSuggestion', + ], + ], + 'RequestId' => [ + 'title' => '请求唯一ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '91AC8C98-0F36-49D2-8290-742E24D*****', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Croppings\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"RequestId\\": \\"91AC8C98-0F36-49D2-8290-742E24D*****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'DetectImageCropping', + ], + 'AddImageMosaic' => [ + 'summary' => 'Adds mosaics, Gaussian blurs, or solid color shapes to blur one or more areas of an image for privacy protection and saves the output image to the specified path in Object Storage Service (OSS).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '147967', + 'abilityTreeNodes' => [ + 'FEATUREimmQT4435', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The OSS URI of the input image.'."\n" + ."\n" + .'Specify the OSS URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Object}` is the path of the object with the extension included.'."\n" + ."\n" + .'Supported formats of input images include JPG, PNG, TIFF, JP2, and BMP.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://examplebucket/sampleobject.jpg', + ], + ], + [ + 'name' => 'TargetURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The OSS URI of the output image.'."\n" + ."\n" + .'Specify the OSS URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Object}` is the path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://examplebucket/outputImage.jpg', + ], + ], + [ + 'name' => 'ImageFormat', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encoding of the output image. By default, the output image uses the same encoding as the input image. Valid values: jpg, png, and webp.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'jpg' => 'jpg', + 'png' => 'png', + 'webp' => 'webp', + ], + 'example' => 'jpg', + ], + ], + [ + 'name' => 'Quality', + 'in' => 'query', + 'schema' => [ + 'description' => 'The quality of the output image. This parameter applies only to JPG and WebP images. Valid values: 0 to 100. Default value: 80.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'Targets', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The bounding boxes and processing parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The bounding box and the corresponding processing parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the mosaic effect. Valid values:'."\n" + ."\n" + .'* square: squares.'."\n" + .'* diamond: diamonds.'."\n" + .'* hexagon: hexagons.'."\n" + .'* blur: Gaussian blurs.'."\n" + .'* pure: solid color shapes.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'square', + ], + 'Boundary' => [ + 'description' => 'The position of the bounding box.'."\n", + 'type' => 'object', + 'properties' => [ + 'ReferPos' => [ + 'description' => 'The reference position of the bounding box on the image. Valid values:'."\n" + ."\n" + .'* topright: the upper-right corner.'."\n" + .'* topleft: the upper-left corner. This is the default value.'."\n" + .'* bottomright: the lower-right corner.'."\n" + .'* bottomleft: the lower-left corner.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'topleft', + ], + 'X' => [ + 'description' => 'The horizontal offset relative to the reference position. The value can be an integer greater than or equal to 0 or a decimal within the range of \\[0,1):'."\n" + ."\n" + .'* An integer value greater than or equal to 0 indicates the horizontal offset in pixels.'."\n" + .'* A decimal value within the range of \\[0,1) indicates the horizontal offset as a ratio of the offset to the image width.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => true, + 'example' => '0', + ], + 'Y' => [ + 'description' => 'The vertical offset relative to the reference position. The value can be an integer greater than or equal to 0 or a decimal within the range of \\[0,1):'."\n" + ."\n" + .'* An integer value greater than or equal to 0 indicates the vertical offset in pixels.'."\n" + .'* A decimal value within the range of \\[0,1) indicates the vertical offset as a ratio of the offset to the image height.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => true, + 'example' => '0', + ], + 'Height' => [ + 'description' => 'The height of the bounding box. The value can be an integer greater than or equal to 0 or a decimal within the range of \\[0,1):'."\n" + ."\n" + .'* An integer value greater than or equal to 0 indicates the height of the bounding box in pixels.'."\n" + .'* A decimal value within the range of \\[0,1) indicates the height of the bounding box as a ratio of its height to the image height.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => true, + 'example' => '200', + ], + 'Width' => [ + 'description' => 'The width of the bounding box. The value can be an integer greater than or equal to 0 or a decimal within the range of \\[0,1):'."\n" + ."\n" + .'* An integer value greater than or equal to 0 indicates the width of the bounding box in pixels.'."\n" + .'* A decimal value within the range of \\[0,1) indicates the width of the bounding box as a ratio of its width to the image width.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => true, + 'example' => '200', + ], + ], + 'required' => true, + ], + 'MosaicRadius' => [ + 'description' => 'The radius of the mosaic. Default value: 5. Unit: pixels.'."\n" + ."\n" + .'> This parameter does not take effect for Gaussian blurs and solid color shapes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + 'BlurRadius' => [ + 'description' => 'The radius of the Gaussian blur. Valid values: 1 to 50. Default value: 3. Unit: pixels.'."\n" + ."\n" + .'> This parameter takes effect only for a Gaussian blur.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'Sigma' => [ + 'description' => 'The standard deviation of the Gaussian blur. The value must be greater than 0. Default value: 5.'."\n" + ."\n" + .'> This parameter takes effect only for a Gaussian blur.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + 'Color' => [ + 'description' => 'The color of the color shape. You can specify a color by using a color code such as`#RRGGBB` or preset color names such as `red` and `white`. The default value is #FFFFFF, which is white.'."\n" + ."\n" + .'> This parameter takes effect only for solid color shapes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '#FFFFFF', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**If you do not have special requirements, leave this parameter empty.**'."\n" + ."\n" + .'The authorization chain settings. For more information, see [Use authorization chains to access resources of other entities](~~465340~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FF*****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FF*****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'AddImageMosaic', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~88317~~) of Intelligent Media Management (IMM).****'."\n" + .'* Make sure that the specified project exists in the current region. For more information, see [Project management](~~478152~~).'."\n" + .'* The operation accepts JPG and PNG images with a maximum side length of 30,000 pixels and a total of up to 250 million pixels.'."\n", + ], + 'CreateImageToPDFTask' => [ + 'summary' => 'Converts multiple images into one single PDF file and stores the PDF file to the specified path in Object Storage Service (OSS).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '147624', + 'abilityTreeNodes' => [ + 'FEATUREimmEPY4NE', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Sources', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The list of images. The sequence of image URIs in the list determines the order in which they are converted.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The image.'."\n", + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => 'The OSS URI of the input image.'."\n" + ."\n" + .'Specify the OSS URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Object}` is the path of the object with the extension included.'."\n" + ."\n" + .'The operation supports the following image formats: JPG, JP2, PNG, TIFF, WebP, BMP, and SVG.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://examplebucket/sampleobject.jpg', + ], + 'Rotate' => [ + 'description' => 'The rotation angle. Valid values:'."\n" + ."\n" + .'* 0 (default)'."\n" + .'* 90'."\n" + .'* 180'."\n" + .'* 270'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '90', + ], + ], + 'required' => false, + ], + 'required' => true, + 'minItems' => 1, + ], + ], + [ + 'name' => 'TargetURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The OSS URI of the output file.'."\n" + ."\n" + .'Specify the OSS URI in the oss://${bucketname}/${objectname} format, where ${bucketname} is the name of the bucket in the same region as the current project and ${objectname} is the path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://examplebucket/outputDocument.pdf', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom information, which is returned in an asynchronous notification and facilitates notification management. The maximum length of the value is 2,048 bytes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test-data', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**If you have no special requirements, leave this parameter empty.**'."\n" + ."\n" + .'The authorization chain settings. For more information, see [Use authorization chains to access resources of other entities](~~465340~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The custom tags. You can search for or filter asynchronous tasks by custom tag.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "User": "Jane"'."\n" + .'}', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The notification settings. For information about the asynchronous notification format, see [Asynchronous message examples](~~2743997~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'EC564A9A-BA5C-4499-A087-D9B9E76E*****', + ], + 'EventId' => [ + 'description' => 'The event ID.'."\n", + 'type' => 'string', + 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16Es*****', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => 'ImageToPDF-cbe6ae3e-f8dc-4566-9da7-535d5d*****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC564A9A-BA5C-4499-A087-D9B9E76E*****\\",\\n \\"EventId\\": \\"0ED-1Bz8z71k5TtsUejT4UJ16Es*****\\",\\n \\"TaskId\\": \\"ImageToPDF-cbe6ae3e-f8dc-4566-9da7-535d5d*****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateImageToPDFTask', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~88317~~) of Intelligent Media Management (IMM).****'."\n" + .'* Make sure that the specified project exists in the current region. For more information, see [Project management](~~478152~~).'."\n" + .'* You can specify up to 100 images in a call to the operation.'."\n" + .'* This operation is an asynchronous operation. After a task is executed, the task information is saved only for seven days. When the retention period ends, the task information can no longer be retrieved. You can call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation to query information about the task.`` If you specify [Notification](~~2743997~~), you can obtain information about the task based on notifications.', + ], + 'CreateImageSplicingTask' => [ + 'summary' => 'Creates an image splicing task. You can call this operation to splice multiple images into one based on a given rule and save the final image into an Object Storage Service (OSS) bucket.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '144838', + 'abilityTreeNodes' => [ + 'FEATUREimm4NW8UR', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Sources', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The input images. The images are sliced in the order of the input image URIs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The input image.'."\n", + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => 'The Object Storage Service (OSS) bucket in which you store the input images.'."\n" + ."\n" + .'Specify the value in the oss://${Bucket}/${Object} format. `${Bucket}` specifies the name of the OSS bucket that resides in the same region as the current project. `${Object}` specifies the complete path to the input images that have an extension.'."\n" + ."\n" + .'The following image formats are supported: jpg and png.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://examplebucket/sampleobject.jpg', + ], + 'Rotate' => [ + 'description' => 'The rotation angle. Valid values:'."\n" + ."\n" + .'* 0 (default)'."\n" + .'* 90'."\n" + .'* 180'."\n" + .'* 270'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '90', + ], + ], + 'required' => false, + ], + 'required' => true, + 'minItems' => 1, + ], + ], + [ + 'name' => 'TargetURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The OSS bucket in which you want to store the output image.'."\n" + ."\n" + .'Specify the value in the oss://${bucketname}/${objectname} format. ${bucketname} specifies the name of the OSS bucket that resides in the same region as the current project. ${objectname} specifies the path to the output image.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://examplebucket/outputImage.jpg', + ], + ], + [ + 'name' => 'ImageFormat', + 'in' => 'query', + 'schema' => [ + 'description' => 'The compression format of the output image. Valid values:'."\n" + ."\n" + .'* jpg (default)'."\n" + .'* png'."\n" + .'* webp'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'jpg' => 'jpg', + 'png' => 'png', + 'webp' => 'webp', + ], + 'example' => 'jpg', + ], + ], + [ + 'name' => 'Quality', + 'in' => 'query', + 'schema' => [ + 'description' => 'The compression quality of the output image. This parameter takes effect only for JPG and WebP images. Valid values: 0 to 100. Default value: 80.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The splicing method. Valid values:'."\n" + ."\n" + .'* vertical (default): All input images are vertically aligned and have the same width.'."\n" + .'* horizontal: All input images are horizontally aligned and have the same height.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vertical', + ], + ], + [ + 'name' => 'ScaleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The scaling mode of the input images that are vertically or horizontally aligned. Valid values:'."\n" + ."\n" + .'* fit (default): Input images are scaled proportionally, and black edges are not retained.'."\n" + .'* stretch: Input images are stretched to fill the space.'."\n" + .'* horizon: Input images are horizontally stretched.'."\n" + .'* vertical: Input images are vertically stretched.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'stretch', + ], + ], + [ + 'name' => 'Align', + 'in' => 'query', + 'schema' => [ + 'description' => 'The width or height with which the input images must align. Valid values: 1 to 4096. Unit: px.'."\n" + ."\n" + .'* If you set **Direction** to `vertical`, this parameter specifies the width with which the input images must align.'."\n" + .'* If you set **Direction** to `horizontal`, this parameter specifies the height with which the input images must align.'."\n" + ."\n" + .'> If you do not specify this parameter, the width or height of the first input image is used.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '192', + ], + ], + [ + 'name' => 'Padding', + 'in' => 'query', + 'schema' => [ + 'description' => 'The space between component images in the output image. Default value: 0. Unit: px.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Margin', + 'in' => 'query', + 'schema' => [ + 'description' => 'The empty space or border around the edges of the output image. Default value: 0. Unit: px.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'BackgroundColor', + 'in' => 'query', + 'schema' => [ + 'description' => 'The padding color of the spaces specified by `Padding` and `Margin`. Colors encoded in the `#FFFFFF` format and colors that are related to preset keywords such as `red` and `alpha` are supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'red', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The user data, which is returned as asynchronous notifications to help manage notifications within your system. The maximum length of the user data is 2,048 bytes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test-data', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The authorization chain settings. For more information, see [Use authorization chains to access resources of other entities](~~465340~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The custom tags. You can search for or filter asynchronous tasks by custom tag.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "User": "Jane"'."\n" + .'}', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The notification settings. For information about the asynchronous notification format, see [Asynchronous message examples](~~2743997~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '94D6F994-E298-037E-8E8B-0090F27*****', + ], + 'EventId' => [ + 'description' => 'The event ID.'."\n", + 'type' => 'string', + 'example' => '10C-1R6p7Km0H5Ieg38LKXTIvw*****', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => 'ImageSplicing-537cc157-7645-444a-a631-c8db4d02*****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"94D6F994-E298-037E-8E8B-0090F27*****\\",\\n \\"EventId\\": \\"10C-1R6p7Km0H5Ieg38LKXTIvw*****\\",\\n \\"TaskId\\": \\"ImageSplicing-537cc157-7645-444a-a631-c8db4d02*****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateImageSplicingTask', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~88317~~) of Intelligent Media Management (IMM).****'."\n" + .'* Make sure that the specified project exists in the current region. For more information, see [Project management](~~478152~~).'."\n" + .'* You can call this operation to merge up to 10 images. Each side of an image cannot exceed 32,876 pixels, and the total number of pixels of the image cannot exceed 1 billion.'."\n" + .'* This operation is an asynchronous operation. After a task is executed, the task information is retained only for seven days and cannot be retrieved when the retention period elapses. You can call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation to query information about the task.`` If you specify [Notification](~~2743997~~), you can obtain information about the task based on notifications.'."\n", + ], + 'CompareImageFaces' => [ + 'summary' => 'Compares the similarity of the largest faces in two images. The largest face refers to the largest face frame in an image after face detection.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '160091', + 'abilityTreeNodes' => [ + 'FEATUREimmE6F82K', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**If you have no special requirements, leave this parameter empty.**'."\n" + ."\n" + .'The authorization chain settings. For more information, see [Use authorization chains to access resources of other entities](~~465340~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The URLs of the two images for compression.'."\n", + 'type' => 'object', + 'properties' => [ + 'URI1' => [ + 'description' => 'The OSS URL of the image file.'."\n" + ."\n" + .'Specify the URL in the `oss://<bucket>/<object>` format. `<bucket>` specifies the name of the OSS bucket that is in the same region as the current project. `<object>` specifies path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object1', + ], + 'URI2' => [ + 'description' => 'The OSS URL of the image file.'."\n" + ."\n" + .'Specify the URL in the `oss://<bucket>/<object>` format. `<bucket>` specifies the name of the OSS bucket that is in the same region as the current project, and `<object>` specifies the path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object2', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F73AC982-2B9E-4ECD-AED5-F8331C5******', + ], + 'Similarity' => [ + 'description' => 'The face similarity. A larger value indicates a higher face similarity. Valid values: 0 to 1.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8848152756690983', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F73AC982-2B9E-4ECD-AED5-F8331C5******\\",\\n \\"Similarity\\": 0.8848152756690983\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CompareImageFaces', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~88317~~) of Intelligent Media Management (IMM).****'."\n" + .'* For the input image, only the face with the largest face frame in the image is used for face comparison. The face frame detection result is consistent with the responses of the [DetectImageFaces](~~478213~~) operation.'."\n", + ], + 'DetectImageBodies' => [ + 'summary' => 'Detects human body information, such as the confidence level and body bounding box, in an image.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '143909', + 'abilityTreeNodes' => [ + 'FEATUREimm0QJK19', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'title' => 'SourceURI', + 'description' => 'The URI of the Object Storage Service (OSS) bucket in which the image file is stored.'."\n" + ."\n" + .'Specify the value in the oss://${Bucket}/${Object} format. `${Bucket}` specifies the name of the OSS bucket that resides in the same region as the current project. `${Object}` specifies the complete path to the file that has an extension.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object', + ], + ], + [ + 'name' => 'Sensitivity', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The accuracy level of detecting and recognizing specific content in the image. Valid values: 0 to 1. Default value: 0.6. A higher sensitivity specifies that more image details can be detected.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.6', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**If you have no special requirements, leave this parameter empty.**'."\n" + ."\n" + .'The authorization chain settings. For more information, see [Use authorization chains to access resources of other entities](~~465340~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片裁剪结果', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Bodies' => [ + 'title' => '图片裁剪结果', + 'description' => 'The human bodies.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The human body details.'."\n", + '$ref' => '#/components/schemas/Body', + ], + ], + 'RequestId' => [ + 'title' => '请求唯一ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '501339F9-4B70-0CE2-AB8C-866C********', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Bodies\\": [\\n {\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"RequestId\\": \\"501339F9-4B70-0CE2-AB8C-866C********\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'DetectImageBodies', + 'description' => '* Before you call this operation, make sure that an Intelligent Media Management (IMM) project is created. For information about how to create a project, see [CreateProject](~~478153~~).'."\n" + .'* For information about the image encoding formats supported by this operation, see [Limits on images](~~475569~~).'."\n", + ], + 'DetectImageCars' => [ + 'summary' => 'Detects the outline data, attributes, and license plate information of vehicles in an image. The vehicle attributes include the vehicle color (CarColor) and vehicle type (CarType). The license plate information includes the recognition content (Content) and plate frame (Boundary).', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '172472', + 'abilityTreeNodes' => [ + 'FEATUREimmIT7OSY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'title' => 'SourceURI', + 'description' => 'The URI of the Object Storage Service (OSS) bucket in which you store the image file.'."\n" + ."\n" + .'Specify the value in the oss://${Bucket}/${Object} format. `${Bucket}` specifies the name of the OSS bucket that resides in the same region as the current project. `${Object}` specifies the complete path to the file that has an extension.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-object', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**If you do not have special requirements, leave this parameter empty.**'."\n" + ."\n" + .'The authorization chain. This parameter is optional. For more information, see [Use authorization chains to access resources of other entities](~~465340~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片二维码检测结果', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Cars' => [ + 'title' => '二维码检测结果', + 'description' => 'The vehicles.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The vehicle.'."\n", + '$ref' => '#/components/schemas/Car', + ], + 'required' => true, + 'minItems' => 0, + ], + 'RequestId' => [ + 'title' => '请求唯一ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A8745209-DD0E-027E-8ABA-085E0C******', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Cars\\": [\\n {\\n \\"LicensePlates\\": [\\n {\\n \\"Content\\": \\"川A0123\\",\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"CarType\\": \\"\\",\\n \\"CarTypeConfidence\\": 0,\\n \\"CarColor\\": \\"\\",\\n \\"CarColorConfidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"RequestId\\": \\"A8745209-DD0E-027E-8ABA-085E0C******\\"\\n}","type":"json"}]', + 'title' => 'DetectImageCars', + 'description' => '* For information about the image encoding formats supported by this operation, see [Limits](~~475569~~).'."\n", + ], + 'DetectImageTexts' => [ + 'summary' => 'Recognizes and extracts text content from an image.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '207351', + 'abilityTreeNodes' => [ + 'FEATUREimmYZZZWM', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'title' => 'SourceURI', + 'description' => 'The Object Storage Service (OSS) URI of the file.'."\n" + ."\n" + .'Specify the URI in the oss://${Bucket}/${Object} format. ${Bucket} specifies the name of an OSS bucket that is in the same region as the current project. ${Object} specifies the path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-object.jpg', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**If you have no special requirements, leave this parameter empty.**'."\n" + ."\n" + .'The authorization chain settings. For more information, see [Use authorization chains to access resources of other entities](~~465340~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片二维码检测结果', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求唯一ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****', + ], + 'OCRTexts' => [ + 'title' => 'OCR文本全文，由OCRContents拼接而成。', + 'description' => 'The full Optical Character Recognition (OCR) text, which is spliced by using the content of OCRContents.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'OCRContents' => [ + 'title' => 'OCR文本片段列表', + 'description' => 'OCR text blocks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The text blocks extracted from the image. Each element contains text block information such as the content and location.'."\n", + '$ref' => '#/components/schemas/OCRContents', + ], + ], + ], + ], + ], + 500 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\",\\n \\"OCRTexts\\": \\"智能媒体管理。\\",\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DetectImageTexts', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + .'* The size of the image cannot exceed 20 MB.'."\n" + .'* The shortest side of the image is not less than 20 px, and the longest side is not more than 30,000 px.'."\n" + .'* The aspect ratio of the image is less than 1:2.'."\n" + .'* We recommend that you do not use an image that is smaller than 15 px × 15 px in size. Otherwise, the recognition rate is low.'."\n", + ], + 'CreateMediaConvertTask' => [ + 'summary' => 'Creates an asynchronous media transcoding task to provide audio and video file processing abilities, such as media transcoding, media splicing, video frame capturing, and video to GIF conversion.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '132611', + 'abilityTreeNodes' => [ + 'FEATUREimmCUOMK0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project. For how to obtain it, see [Creating a Project](~~478153~~).', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Sources', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'A list of media files. If the list contains more than one element, it indicates that the Concat (concatenation) function is enabled. The Concat order follows the sequence of the input video file URIs.', + 'type' => 'array', + 'items' => [ + 'description' => 'Source media file.', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => 'The OSS address rule is `oss://${Bucket}/${Object}`, where `${Bucket}` is the name of the OSS Bucket in the same region (Region) as the current project, and `${Object}` is the complete path of the file including the file extension.', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object', + ], + 'StartTime' => [ + 'description' => 'The start time for media transcoding, in seconds. The value range is as follows:'."\n" + .'- 0 (default): Start transcoding from the beginning of the media.'."\n" + .'- n (greater than 0): Start transcoding n seconds after the beginning of the media.', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0', + ], + 'Duration' => [ + 'description' => 'The duration of media transcoding, in seconds. The default value is 0, indicating until the end of the video.', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0', + ], + 'Subtitles' => [ + 'description' => 'A list of subtitles to add, which is empty by default.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Subtitle information.', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => 'The OSS address rule is `oss://${Bucket}/${Object}`, where `${Bucket}` is the name of the OSS Bucket in the same region (Region) as the current project, and `${Object}` is the complete path of the file including the file extension.'."\n" + .'Supported subtitle formats include: srt, vtt, mov_text, ass, dvd_sub, pgs.', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object'."\n", + ], + 'TimeOffset' => [ + 'description' => 'The subtitle delay time, in seconds, with a default value of 0.', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '10.5', + ], + 'Language' => [ + 'description' => 'The language of the subtitle, referenced by ISO 639-2, with a default value of empty.', + 'type' => 'string', + 'required' => false, + 'example' => 'eng', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Attached' => [ + 'description' => 'Add the current source media file as a synchronized audio or video stream to the output media file, with a default value of false.'."\n" + ."\n" + .'> - The AlignmentIndex parameter pointing to the Attached parameter of the Source cannot be true.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'AlignMode' => [ + 'description' => 'The alignment strategy for adding audio and video streams, with the following value range:'."\n" + .'- false (default): No alignment.'."\n" + .'- loop: Loop the audio and video content to align.'."\n" + .'- pad: Align by padding silent frames and black video frames.'."\n" + .'> - Only valid when the Attached parameter is true.', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + 'DisableVideo' => [ + 'description' => 'Whether to disable the video in the source media file. The value range is as follows:'."\n" + ."\n" + .'- true: Disable.'."\n" + .'- false (default): Do not disable.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'DisableAudio' => [ + 'description' => 'Whether to disable the audio in the source media file. The value range is as follows:'."\n" + ."\n" + .'- true: Disable.'."\n" + .'- false (default): Do not disable.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Targets', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'List of media processing tasks, supporting multiple task configurations.', + 'type' => 'array', + 'items' => [ + 'description' => 'Detailed information of the elements in the Targets array.', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => 'OSS address for the output file of media transcoding.'."\n" + ."\n" + .'The OSS address rule is `oss://${Bucket}/${Object}`, where `${Bucket}` is the name of the OSS Bucket in the same region (Region) as the current project, and `${Object}` is the complete path of the file including the file extension.'."\n" + .'- When **URI** has an extension, the OSS address for the transcoded media file will be **URI**. If there are multiple output files, they may overwrite each other.'."\n" + .'- When **URI** does not have an extension, the OSS address for the transcoded media file is determined by the **URI**, **Container**, and **Segment** parameters. For example, if **URI** is `oss://examplebucket/outputVideo`:'."\n" + .' - When **Container** is `mp4` and **Segment** is empty, the generated media file\'s OSS address will be `oss://examplebucket/outputVideo.mp4`.'."\n" + .' - When **Container** is `ts` and **Segment**\'s **Format** is `hls`, it will generate an m3u8 file with the OSS address `oss://examplebucket/outputVideo.m3u8` and multiple ts files with the prefix `oss://examplebucket/outputVideo`.', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-target-object.mp4', + ], + 'Container' => [ + 'description' => 'Media container type. Available container types are as follows:'."\n" + .'- Audio and video containers: mp4, mkv, mov, asf, avi, mxf, ts, flv'."\n" + .'- Audio containers: mp3, aac, flac, oga, ac3, opus'."\n" + .'><notice>Both Container and URI parameters need to be set. If only subtitle extraction, frame capture, sprite image capture, or media-to-gif conversion is performed, both Container and URI should be set to null, making the Segment, Video, Audio, and Speed parameters meaningless.</notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'mp4', + ], + 'Speed' => [ + 'description' => 'Media playback speed setting, with a value range of [0.5,1.0], default is 1.0.'."\n" + .'> The ratio of the playback speed of the transcoded media file to the original media file, not a speed-up transcoding.', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '1.0', + ], + 'Segment' => [ + 'description' => 'Media segment settings, no segmentation by default.', + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'description' => 'Media slicing method. The value range is as follows:'."\n" + .'- hls'."\n" + .'- dash', + 'type' => 'string', + 'required' => false, + 'example' => 'hls', + ], + 'Duration' => [ + 'description' => 'Segment length. Unit: seconds.', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '30', + ], + 'StartNumber' => [ + 'description' => 'Starting sequence number, supported only for hls, default is 0.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + 'required' => false, + ], + 'Video' => [ + 'description' => 'Video processing parameter configuration.'."\n" + .'><notice>If Video is null, the first video stream (if present) will be directly copied to the output file.</notice>', + 'required' => false, + '$ref' => '#/components/schemas/TargetVideo', + ], + 'Audio' => [ + 'description' => 'Audio processing parameter configuration.'."\n" + .'><notice>If Audio is null, the first audio stream (if present) will be directly copied to the output file.</notice>', + 'required' => false, + '$ref' => '#/components/schemas/TargetAudio', + ], + 'Subtitle' => [ + 'description' => 'Subtitle processing parameter configuration.'."\n" + .'><notice>If Subtitle is null, the first subtitle stream (if present) will be directly copied to the output file.</notice>', + 'required' => false, + '$ref' => '#/components/schemas/TargetSubtitle', + ], + 'Image' => [ + 'description' => 'Configuration for frame capture, sprite image capture, and media to animated image conversion.', + 'required' => false, + '$ref' => '#/components/schemas/TargetImage', + ], + 'StripMetadata' => [ + 'description' => 'Removes metadata from the media file, such as `title`, `album`, etc. The default value is false.', + 'type' => 'boolean', + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'User-defined information that will be returned in asynchronous message notifications, used for convenient association and processing within your system. The maximum length is 2048 bytes.', + 'type' => 'string', + 'required' => false, + 'example' => '{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"}', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Custom tags used for searching and filtering asynchronous tasks.', + 'type' => 'object', + 'required' => false, + 'example' => '{"test":"val1"}', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**If there are no special requirements, please leave this blank.**'."\n" + ."\n" + .'Chain authorization configuration. For more information, see [Using Chain Authorization to Access Other Entity Resources](~~465340~~).', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Notification configuration. For details, click Notification. The format of asynchronous notification messages can be found in [Asynchronous Notification Message Format](~~2743997~~).', + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + [ + 'name' => 'AlignmentIndex', + 'in' => 'query', + 'schema' => [ + 'description' => 'When performing media concatenation, the index of the primary media file (which provides the default transcoding parameters for `Video` and `Audio`, including resolution, frame rate, etc.) in the concatenation list. The default value is 0 (aligning with the first media file in the concatenation list).', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => 'Response structure.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 ID', + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6', + ], + 'EventId' => [ + 'description' => 'Event ID.', + 'type' => 'string', + 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16Es****', + ], + 'TaskId' => [ + 'description' => 'Task ID.', + 'type' => 'string', + 'example' => 'MediaConvert-adb1ee28-c4c9-42a7-9f54-3b8eadcb****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6\\",\\n \\"EventId\\": \\"0ED-1Bz8z71k5TtsUejT4UJ16Es****\\",\\n \\"TaskId\\": \\"MediaConvert-adb1ee28-c4c9-42a7-9f54-3b8eadcb****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateMediaConvertTask', + 'description' => '- **Please ensure that you fully understand the billing method and [pricing](~~88317~~) of the Intelligent Media Management product before using this interface.**'."\n" + .'- Before calling this interface, make sure that there is an available project (Project) in the current Region. For more details, see [Project Management](~~478152~~).'."\n" + .'><notice>Asynchronous tasks do not guarantee timeliness.></notice>'."\n" + .'- When using this interface for media transcoding, by default, only one video/audio/subtitle stream is processed, but you can also configure the number of video/audio/subtitle streams to be processed.'."\n" + .'- When using this interface for media concatenation, a maximum of 11 media files are supported. In this case, the configured transcoding, frame extraction, and other parameters will apply to the concatenated media data.'."\n" + .'- This is an asynchronous interface. After the task starts, the task information is retained for 7 days. If it exceeds 7 days, the information cannot be retrieved. Call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) interface to get the returned `TaskId` and view the task information. You can also set the [Notification](~~2743997~~) message notification parameter to obtain task information through message notifications.', + 'translator' => 'machine', + ], + 'DetectMediaMeta' => [ + 'summary' => 'Queries media metadata, including the media format and stream information.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '161491', + 'abilityTreeNodes' => [ + 'FEATUREimmGWMCEO', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URI of the media object in Object Storage Service (OSS).'."\n" + ."\n" + .'Specify the OSS URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Object}` is the path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://examplebucket/sampleobject.mp4', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**If you have no special requirements, leave this parameter empty.**'."\n" + ."\n" + .'The authorization chain settings. For more information, see [Use authorization chains to access resources of other entities](~~465340~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2213B1A9-EB3D-4666-84E0-24980BC*****', + ], + 'Language' => [ + 'description' => 'The language of the content. For more information, see the ISO 639-2 Alpha-3 codes for the representation of names of languages.'."\n", + 'type' => 'string', + 'example' => 'eng', + ], + 'Title' => [ + 'description' => 'The title of the media object.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'VideoStreams' => [ + 'description' => 'The video streams.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the video streams.'."\n", + '$ref' => '#/components/schemas/VideoStream', + ], + ], + 'AudioStreams' => [ + 'description' => 'The audio streams.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the audio streams.'."\n", + '$ref' => '#/components/schemas/AudioStream', + ], + ], + 'Subtitles' => [ + 'description' => 'The subtitle streams.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the subtitle streams.'."\n", + '$ref' => '#/components/schemas/SubtitleStream', + ], + ], + 'StreamCount' => [ + 'description' => 'The number of media streams.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'ProgramCount' => [ + 'description' => 'The number of programs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'FormatName' => [ + 'description' => 'The abbreviated format name.'."\n", + 'type' => 'string', + 'example' => 'mov,mp4,m4a,3gp,3g2,mj2', + ], + 'FormatLongName' => [ + 'description' => 'The full format name.'."\n", + 'type' => 'string', + 'example' => 'QuickTime / MOV', + ], + 'Size' => [ + 'description' => 'The size of the media object. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '25115517', + ], + 'StartTime' => [ + 'description' => 'The initial playback time.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0.000000', + ], + 'Bitrate' => [ + 'description' => 'The bitrate. Unit: bit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '13164131', + ], + 'Artist' => [ + 'description' => 'The artist.'."\n", + 'type' => 'string', + 'example' => 'unable', + ], + 'AlbumArtist' => [ + 'description' => 'The album artist.'."\n", + 'type' => 'string', + 'example' => 'unable', + ], + 'Composer' => [ + 'description' => 'The composer.'."\n", + 'type' => 'string', + 'example' => 'unable', + ], + 'Performer' => [ + 'description' => 'The performer.'."\n", + 'type' => 'string', + 'example' => 'unable', + ], + 'Album' => [ + 'description' => 'The album.'."\n", + 'type' => 'string', + 'example' => 'unable', + ], + 'Duration' => [ + 'description' => 'The total duration of the video. Unit: seconds.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '15.263000', + ], + 'ProduceTime' => [ + 'description' => 'The time of recording. For more information about the time formats, see the RFC3339 Nano standard.'."\n", + 'type' => 'string', + 'example' => '2022-04-24T02:39:57Z', + ], + 'LatLong' => [ + 'description' => 'The coordinate pair of the central point. The coordinate pair consists of latitude and longitude values. This parameter value must be in the "latitude,longitude" format. Valid values of the latitude: \\[-90,+90]. Valid values of the longitude: \\[-180,+180].'."\n", + 'type' => 'string', + 'example' => '+120.029003,+30.283095', + ], + 'VideoWidth' => [ + 'description' => 'The video width in pixels.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1080', + ], + 'VideoHeight' => [ + 'description' => 'The video height in pixels.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1920', + ], + 'Addresses' => [ + 'description' => 'The addresses.'."\n" + ."\n" + .'This parameter is returned only when address information is detected.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The address details.'."\n", + '$ref' => '#/components/schemas/Address', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2213B1A9-EB3D-4666-84E0-24980BC*****\\",\\n \\"Language\\": \\"eng\\",\\n \\"Title\\": \\"test\\",\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"StreamCount\\": 2,\\n \\"ProgramCount\\": 2,\\n \\"FormatName\\": \\"mov,mp4,m4a,3gp,3g2,mj2\\",\\n \\"FormatLongName\\": \\"QuickTime / MOV\\",\\n \\"Size\\": 25115517,\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 13164131,\\n \\"Artist\\": \\"unable\\",\\n \\"AlbumArtist\\": \\"unable\\",\\n \\"Composer\\": \\"unable\\",\\n \\"Performer\\": \\"unable\\",\\n \\"Album\\": \\"unable\\",\\n \\"Duration\\": 15.263,\\n \\"ProduceTime\\": \\"2022-04-24T02:39:57Z\\",\\n \\"LatLong\\": \\"+120.029003,+30.283095\\",\\n \\"VideoWidth\\": 1080,\\n \\"VideoHeight\\": 1920,\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'DetectMediaMeta', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~88317~~) of Intelligent Media Management (IMM).****'."\n" + .'* Make sure that the specified project exists in the current region. For more information, see [Project management](~~478152~~).'."\n", + ], + 'CreateVideoLabelClassificationTask' => [ + 'summary' => 'Detects the scene, object, and event tag information of video content. Scene information includes categories such as natural landscapes, life scenes, and disaster scenes. Event information includes categories such as talent shows, office events, performances, and production events. Object information includes categories such as tableware, electronic products, furniture, and transportation. Video tag detection supports more than 30 tag categories and thousands of tags.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '157766', + 'abilityTreeNodes' => [ + 'FEATUREimmQZSDER', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'title' => 'SourceURI', + 'description' => 'The OSS URI of the video file.'."\n" + ."\n" + .'Specify the value in the oss://${Bucket}/${Object} format. `${Bucket}` specifies the name of the OSS bucket that resides in the same region as the current project. `${Object}` specifies the path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://bucket1/object', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => 'UserData', + 'description' => 'The custom data, which is returned in an asynchronous notification and facilitates notification management. The maximum length is 2,048 bytes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The custom tags, which can be used to search for and filter asynchronous tasks.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{"test":"val1"}', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**If you have no special requirements, leave this parameter empty.**'."\n" + ."\n" + .'The authorization chain settings. For more information, see [Use authorization chains to access resources of other entities](~~465340~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The notification settings. For information about the asynchronous notification format, see [Asynchronous message examples](~~2743997~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片检测结果', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求唯一Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6', + ], + 'EventId' => [ + 'title' => '事件Id', + 'description' => 'The event ID of the current task. You can use [EventBridge](https://www.alibabacloud.com/en/product/eventbridge) to query the ID and obtain the task information notification.', + 'type' => 'string', + 'example' => '03F-1Qt1Yn5RZZ0Zh3ZdYlDblv7****', + ], + 'TaskId' => [ + 'title' => '任务唯一ID', + 'description' => 'The ID of the current task. You can call the [GetTask](~~GetTask~~) operation to view the task information or the [GetVideoLabelClassificationResult](~~478224~~) operation to obtain the result of the video label detection task.'."\n", + 'type' => 'string', + 'example' => 'VideoLabelClassification-2f157087-91df-4fda-8c3e-232407ec*****', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6\\",\\n \\"EventId\\": \\"03F-1Qt1Yn5RZZ0Zh3ZdYlDblv7****\\",\\n \\"TaskId\\": \\"VideoLabelClassification-2f157087-91df-4fda-8c3e-232407ec*****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateVideoLabelClassificationTask', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~2747104~~) of Intelligent Media Management (IMM).****'."\n" + ."\n" + .'* Before you call this operation, make sure that an IMM project is created. For information about how to create a project, see [CreateProject](~~478153~~).'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** Asynchronous processing does not guarantee timely task completion.'."\n" + ."\n" + .'* For more information about video label detection, see [Video label detection](~~477189~~).'."\n" + ."\n" + .'* This operation supports multiple video formats, such as MP4, MPEG-TS, MKV, MOV, AVI, FLV, and M3U8.'."\n" + ."\n" + .'* This operation is an asynchronous operation. After a task is executed, the task information is retained only for seven days and cannot be retrieved when the retention period elapses. You can call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation to query information about the task.`` If you specify [Notification](~~2743997~~), you can obtain information about the task based on notifications.'."\n", + ], + 'GetVideoLabelClassificationResult' => [ + 'summary' => 'Queries the results of a video label detection task.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '157767', + 'abilityTreeNodes' => [ + 'FEATUREimmQZSDER', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'title' => 'TaskType', + 'description' => 'The type of the task. Valid values:'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'VideoLabelClassification', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => 'TaskId', + 'description' => 'The task ID, which is obtained from response parameters of [CreateVideoLabelClassificationTask](~~478223~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'VideoLabelClassification-2f157087-91df-4fda-8c3e-232407ec****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片检测结果', + 'description' => 'The results of the video label detection task.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求唯一Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7F84C6D9-5AC0-49F9-914D-F02678E3****', + ], + 'ProjectName' => [ + 'title' => '项目名称', + 'description' => 'The project name.'."\n", + 'type' => 'string', + 'example' => 'immtest', + ], + 'EventId' => [ + 'title' => '事件Id', + 'description' => 'The event ID.'."\n", + 'type' => 'string', + 'example' => '2F6-1Bz99Xi93EnRpNEyLudILJm****', + ], + 'Status' => [ + 'title' => '任务运行状态', + 'description' => 'The task status.'."\n", + 'type' => 'string', + 'example' => 'Succeeded', + ], + 'Code' => [ + 'title' => '任务错误码', + 'description' => 'The error code of the task.'."\n", + 'type' => 'string', + 'example' => 'ResourceNotFound', + ], + 'Message' => [ + 'title' => '任务错误消息', + 'description' => 'The error message of the task.'."\n", + 'type' => 'string', + 'example' => 'The specified resource project is not found.', + ], + 'StartTime' => [ + 'title' => '任务开始时间', + 'description' => 'The start time of the task.'."\n", + 'type' => 'string', + 'example' => '2021-12-24T03:00:38.892462383Z', + ], + 'EndTime' => [ + 'title' => '任务结束时间', + 'description' => 'The end time of the task.'."\n", + 'type' => 'string', + 'example' => '2021-12-24T03:00:42.134971294Z', + ], + 'UserData' => [ + 'title' => '用户自定义信息', + 'description' => 'The custom information.'."\n", + 'type' => 'string', + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => 'The type of the task.'."\n", + 'type' => 'string', + 'example' => 'VideoLabelClassification', + ], + 'TaskId' => [ + 'title' => '任务唯一ID', + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => 'VideoLabelClassification-2f157087-91df-4fda-8c3e-232407ec****', + ], + 'Labels' => [ + 'title' => '标签列表', + 'description' => 'The labels.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The label details.'."\n", + '$ref' => '#/components/schemas/Label', + ], + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7F84C6D9-5AC0-49F9-914D-F02678E3****\\",\\n \\"ProjectName\\": \\"immtest\\",\\n \\"EventId\\": \\"2F6-1Bz99Xi93EnRpNEyLudILJm****\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"Code\\": \\"ResourceNotFound\\",\\n \\"Message\\": \\"The specified resource project is not found.\\",\\n \\"StartTime\\": \\"2021-12-24T03:00:38.892462383Z\\",\\n \\"EndTime\\": \\"2021-12-24T03:00:42.134971294Z\\",\\n \\"UserData\\": \\"{\\\\\\"ID\\\\\\": \\\\\\"user1\\\\\\",\\\\\\"Name\\\\\\": \\\\\\"test-user1\\\\\\",\\\\\\"Avatar\\\\\\": \\\\\\"http://example.com?id=user1\\\\\\"}\\",\\n \\"TaskType\\": \\"VideoLabelClassification\\",\\n \\"TaskId\\": \\"VideoLabelClassification-2f157087-91df-4fda-8c3e-232407ec****\\",\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'GetVideoLabelClassificationResult', + 'description' => '* Before you call this operation, make sure that a [project](~~478273~~) is created on Intelligent Media Management (IMM). For more information, see [CreateProject](~~478153~~).'."\n" + .'* Before you call this operation, make sure that a video label detection task is created and the `TaskId` of the task is obtained. For more information, see [CreateVideoLabelClassificationTask](~~478223~~).'."\n", + ], + 'GenerateVideoPlaylist' => [ + 'summary' => 'Generates a live transcoding playlist and converts video files into M3U8 files. After a playlist is generated, the videos in the playlist are immediately played and the video files are transcoded based on the playback progress. Compared with offline transcoding, online transcoding significantly reduces the time spent in waiting for the videos to be transcoded and reduces transcoding and storage costs.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '161492', + 'abilityTreeNodes' => [ + 'FEATUREimmCUOMK0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The project name.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom user information, which is returned in asynchronous notifications to help you handle the notifications in the system. The maximum length of a notification is 2048 bytes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The OSS path of the video file.'."\n" + ."\n" + .'The OSS path must be in the oss://${Bucket}/${Object} format. ${Bucket} specifies the name of the OSS bucket that is in the same region as the current project. ${Object} specifies the full path of the file that contains the file name extension.'."\n" + ."\n" + .'> Only OSS buckets of the Standard storage class are supported. OSS buckets for which hotlink protection whitelists are configured are not supported.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + ], + [ + 'name' => 'SourceStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the playlist starts to generate. Unit: seconds.'."\n" + ."\n" + .'* If you set this parameter to 0 (default) or leave this parameter empty, the start time of the source video is used as the time when a playlist starts to generate.'."\n" + .'* If you set this parameter to a value greater than 0, the time when a playlist starts to generate is the specified point in time.'."\n" + ."\n" + .'> If you use this parameter together with the **SourceDuration** parameter, a playlist can be generated based on the partial content of a source video.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'SourceDuration', + 'in' => 'query', + 'schema' => [ + 'description' => 'The period of time during which the playlist is generated. Unit: seconds.'."\n" + ."\n" + .'* If you set this parameter to 0 (default) or leave this parameter empty, a playlist is generated until the end time of the source video.'."\n" + .'* If you set this parameter to a value greater than 0, a playlist is generated for the specified period of time from the start time that you specify.'."\n" + ."\n" + .'> If you set this parameter to a value that exceeds the end time of a source video, use the default value.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'SourceSubtitles', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The subtitle files. By default, this parameter is left empty. Up to two subtitle files are supported.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The subtitle file.'."\n", + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => 'The OSS path of the subtitle file.'."\n" + ."\n" + .'The OSS path must be in the oss://${Bucket}/${Object} format. ${Bucket} specifies the name of the OSS bucket that is in the same region as the current project. ${Object} specifies the full path of the file.'."\n" + ."\n" + .'> The **MasterURI** parameter cannot be left empty, and the OSS path `oss://${Bucket}/${Object}` of a subtitle file must be in the directory specified by the **MasterURI** parameter or its subdirectory.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-object/subtitle/eng.vtt', + ], + 'Language' => [ + 'description' => 'The subtitle language. If you configure this parameter, the value must comply with the ISO 639-2 standard. By default, this parameter is left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'eng', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'MasterURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The OSS path of the master playlist.'."\n" + ."\n" + .'The OSS path must be in the oss://${Bucket}/${Object} format. ${Bucket} specifies the name of the OSS bucket that is in the same region as the current project. ${Object} specifies the full path of the file that is suffixed with .m3u8.'."\n" + ."\n" + .'> If a playlist contains subtitles or multiple outputs, the MasterURI parameter is required and the URI of subtitle files or outputs must be in the directory specified by the MasterURI parameter or its subdirectory.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://bucket/object/master.m3u8', + ], + ], + [ + 'name' => 'Targets', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The array of live transcoding playlists. The maximum length of the array is 6. Each element corresponds to at most one video media playlist and one or more subtitle media playlists.'."\n" + ."\n" + .'> If the array contains more than one element, the **MasterURI** parameter cannot be left empty.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The live transcoding information.'."\n", + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => 'The prefix of the OSS path that is used to store the live transcoding files. The live transcoding files include a M3U8 file and multiple TS files.'."\n" + ."\n" + .'The OSS path must be in the oss://${Bucket}/${Object} format. ${Bucket} specifies the name of the OSS bucket that is in the same region as the current project. ${Object} specifies the prefix of the full path that does not contain the file name extension.'."\n" + ."\n" + .'* Example: If the URI is oss://test-bucket/test-object/output-video, the output-video.m3u8 file and multiple output-video-${token}-${index}.ts files are generated in the oss://test-bucket/test-object/ directory. ${token} is a unique string generated based on the transcoding parameters. The ${token} parameter is included in the response of the operation. ${index} is the serial number of the generated TS files that are numbered starting from 0.'."\n" + ."\n" + .'> If the **MasterURI** parameter is not left empty, the path specified by this parameter must be in the directory specified by the **MasterURI** parameter or its subdirectory.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://imm-test/testcases/video', + ], + 'Video' => [ + 'description' => 'The video processing configuration. If you set this parameter to null (default), video processing is disabled. The generated TS files do not contain video streams.'."\n" + ."\n" + .'> The Video and Subtitle parameters in the same element are mutually exclusive. If the Video parameter is configured, the Subtitle parameter is ignored.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/TargetVideo', + ], + 'Audio' => [ + 'description' => 'The audio processing configuration. If you set this parameter to null (default), audio processing is disabled. The generated TS files do not contain audio streams.'."\n" + ."\n" + .'> The Audio and Subtitle parameters in the same element are mutually exclusive. If the Audio parameter is configured, the Subtitle parameter is ignored. The Audio and Video parameters can be configured at the same time. You can also configure only the Audio parameter to generate only audio.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/TargetAudio', + ], + 'Subtitle' => [ + 'description' => 'The subtitle processing configuration.'."\n" + ."\n" + .'> The Subtitle and Video or Audio parameters in the same element are mutually exclusive. You must configure the Subtitle parameter independently to generate subtitles.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/TargetSubtitle', + ], + 'TranscodeAhead' => [ + 'description' => 'The number of TS files that are pre-transcoded when the live transcoding is triggered. By default, a 2-minute video is pre-transcoded.'."\n" + ."\n" + .'* Example: If you set the **Duration** parameter to 10, the value of the **TranscodeAhead** parameter is 12 by default. You can configure this parameter to manage the number of pre-transcoded files. Valid values: 10 to 30.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'Duration' => [ + 'description' => 'The playback duration of a single TS file. Unit: seconds. Default value: 10. Valid values: 5 to 15.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '5', + ], + 'InitialTranscode' => [ + 'description' => 'The pre-transcoding duration. Unit: seconds. Default value: 30.'."\n" + ."\n" + .'* If you set this parameter to 0, pre-transcoding is disabled.'."\n" + .'* If you set this parameter to a value that is less than 0 or greater than the duration of a source video, the entire video is pre-transcoded.'."\n" + .'* If you set this parameter to a value that is within the middle of the playback duration of a TS file, the transcoding continues until the end of the playback duration.'."\n" + ."\n" + .'> This parameter reduces the time required to start the first playback, which enhances the viewing experience. If you want to use live transcoding in traditional video-on-demand scenarios, you can pre-transcode entire videos.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '30.0', + ], + 'InitialSegments' => [ + 'description' => 'The array of the durations of the pre-transcoded TS files. The maximum length of the array is 6. By default, this parameter is left empty. This parameter is independent of the **Duration** parameter.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The duration of the pre-transcoded TS file. Valid values: \\[1,**Duration**].'."\n" + ."\n" + .'* Example: If the array of the durations for the pre-transcoded TS files is `[2, 2, 4, 4, 8, 8]`, the duration of the TS file whose serial number is 0 is 2, the duration of the TS file whose serial number is 1 is 2, and so on.'."\n" + ."\n" + .'> If you set the duration of a pre-transcoded TS file to a small value, video loading can be smooth.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '2.0', + ], + 'required' => false, + ], + 'Tags' => [ + 'description' => 'The [tags](~~106678~~) that you want to add to a TS file in OSS. You can use tags to manage the lifecycles of TS files in OSS.'."\n" + ."\n" + .'> The combination of the value of the Tags parameter and the value of the Tags parameter in the upper level is used as the tag value of the current output. If the value of the Tags parameter in the current level is the same as the value of the Tags parameter in the upper level, the value of the Tags parameter in the current level is used.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{\\"key1\\":\\"value1\\"}', + 'description' => 'The value of the tag.'."\n", + ], + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The [tags](~~106678~~) that you want to add to a TS file in OSS. You can use tags to manage the lifecycles of TS files in OSS.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'The tag value.'."\n", + 'example' => '{"key1": "value1", "key2": "value2"}', + ], + 'example' => '{"key1": "value1", "key2": "value2"}', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**If you have no special requirements, leave this parameter empty.**'."\n" + ."\n" + .'The authorization chain settings. For more information, see [Use authorization chains to access resources of other entities](~~465340~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The notification settings. For information about the asynchronous notification format, see [Asynchronous message examples](~~2743997~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + [ + 'name' => 'OverwritePolicy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The overwrite policy when the media playlist exists. Valid values:'."\n" + ."\n" + .'* overwrite (default): overwrites an existing media playlist.'."\n" + .'* skip-existing: skips generation and retains the existing media playlist.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'overwrite', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FFF*****', + ], + 'Duration' => [ + 'description' => 'The total duration of the generated video.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1082', + ], + 'Token' => [ + 'description' => 'The token of the master playlist.'."\n", + 'type' => 'string', + 'example' => '92376fbb-171f-4259-913f-705f7ee0****', + ], + 'MasterURI' => [ + 'description' => 'The OSS path of the master playlist.'."\n", + 'type' => 'string', + 'example' => 'oss://test-bucket/test-object/master.m3u8', + ], + 'VideoPlaylist' => [ + 'description' => 'The video media playlist files.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The video media playlist file.'."\n", + 'type' => 'object', + 'properties' => [ + 'Token' => [ + 'description' => 'The token of the video media playlist. You can use this parameter to generate the path of a TS file.'."\n" + ."\n" + .'> You can generate the path of a transcoded TS file based on the value of this parameter. The path must be in the oss://${Bucket}/${Object}-${Token}-${Index}.ts format. oss://${Bucket}/${Object} specifies the URI specified by input parameters for output files. ${Token} specifies the returned token, and ${Index} specifies the serial number of a TS file.'."\n", + 'type' => 'string', + 'example' => 'affe0c6042f09722fec95a21b8b******', + ], + 'URI' => [ + 'description' => 'The OSS path of the video media playlist.'."\n", + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/video.m3u8', + ], + 'Resolution' => [ + 'description' => 'The video resolution.'."\n", + 'type' => 'string', + 'example' => '640x480', + ], + 'FrameRate' => [ + 'description' => 'The video frame rate.'."\n", + 'type' => 'string', + 'example' => '25/1', + ], + ], + ], + ], + 'AudioPlaylist' => [ + 'description' => 'The audio media playlist files.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The audio media playlist file.'."\n", + 'type' => 'object', + 'properties' => [ + 'Token' => [ + 'description' => 'The token of the audio media playlist. You can use this parameter to generate the path of a TS file.'."\n", + 'type' => 'string', + 'example' => 'affe0c6042f09722fec95a21b8b******'."\n", + ], + 'URI' => [ + 'description' => 'The OSS path of the audio media playlist.'."\n", + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/video.m3u8'."\n", + ], + 'Channels' => [ + 'description' => 'The number of audio channels.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'SubtitlePlaylist' => [ + 'description' => 'The subtitle media playlist files.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The subtitle media playlist file.'."\n", + 'type' => 'object', + 'properties' => [ + 'Token' => [ + 'description' => 'The token of the subtitle media playlist. You can use this parameter to generate the path of a subtitle file.'."\n" + ."\n" + .'> You can generate the path of a transcoded subtitle file based on the returned token value. The path must be in the oss://${Bucket}/${Object}-${Token}\\_${Index}.ts format. oss://${Bucket}/${Object} specifies the URI specified by input parameters for output files. ${Token} specifies the returned token value, and ${Index} specifies the serial number of a subtitle file.'."\n", + 'type' => 'string', + 'example' => 'affe0c6042f09722fec95a21b8b******'."\n", + ], + 'URI' => [ + 'description' => 'The OSS path of the subtitle media playlist.'."\n", + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/vide_0.m3u8', + ], + 'Language' => [ + 'description' => 'The language of the subtitle stream.'."\n" + ."\n" + .'> The language is derived from the subtitle stream information in the OSS path specified by the SourceURI parameter for a source video. If no language information exists in the source video, null is returned.'."\n", + 'type' => 'string', + 'example' => 'en', + ], + 'Index' => [ + 'description' => 'The serial number of the subtitle stream. The value starts from 0.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'title' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FFF*****\\",\\n \\"Duration\\": 1082,\\n \\"Token\\": \\"92376fbb-171f-4259-913f-705f7ee0****\\",\\n \\"MasterURI\\": \\"oss://test-bucket/test-object/master.m3u8\\",\\n \\"VideoPlaylist\\": [\\n {\\n \\"Token\\": \\"affe0c6042f09722fec95a21b8b******\\",\\n \\"URI\\": \\"oss://test-bucket/test-object/output-video.m3u8\\",\\n \\"Resolution\\": \\"640x480\\",\\n \\"FrameRate\\": \\"25/1\\"\\n }\\n ],\\n \\"AudioPlaylist\\": [\\n {\\n \\"Token\\": \\"affe0c6042f09722fec95a21b8b******\\",\\n \\"URI\\": \\"oss://test-bucket/test-object/output-audio.m3u8\\",\\n \\"Channels\\": 1\\n }\\n ],\\n \\"SubtitlePlaylist\\": [\\n {\\n \\"Token\\": \\"affe0c6042f09722fec95a21b8b******\\",\\n \\"URI\\": \\"oss://test-bucket/test-object/output-subtitle.m3u8\\",\\n \\"Language\\": \\"eng\\",\\n \\"Index\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'GenerateVideoPlaylist', + 'description' => '* **Before you call this operation, make sure that you are familiar with the [billing](~~88317~~) of Intelligent Media Management (IMM).**'."\n" + .'* Make sure that the project that you want to use is available in the current region. For more information, see [Project Management](~~478152~~).'."\n" + .'* By default, you can call this operation to process only one video, audio, or subtitle track. You can specify the number of the video, audio, or subtitle tracks that you want to process.'."\n" + .'* You can call this operation to generate a media playlist and a master playlist. For more information, see the parameter description.'."\n" + .'* This operation is a synchronous operation. Synchronous or asynchronous transcoding is triggered only during playback or pre-transcoding. You can configure the [Notification](~~2743997~~) parameter to obtain the transcoding task result.'."\n" + .'* For information about the feature description of this operation, see [Live transcoding](~~477192~~).'."\n" + .'* The data processing capability of Object Storage Service (OSS) also provides the playlist generation feature. However, this feature can generate only a media playlist, and related parameters are simplified.', + ], + 'GenerateWebofficeToken' => [ + 'summary' => 'Obtain Document Preview and Edit Token', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '161499', + 'abilityTreeNodes' => [ + 'FEATUREimm4TQO1Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'Project name, for how to obtain it, please refer to [Create Project](~~478153~~).', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'title' => '预览编辑地址', + 'description' => 'OSS address of the document to be previewed or edited. The OSS address follows the rule `oss://${Bucket}/${Object}`, where `Bucket` is the name of the OSS Bucket in the same region as the current project, and `Object` is the full path of the file including the file extension.', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-object.docx', + ], + ], + [ + 'name' => 'Filename', + 'in' => 'query', + 'schema' => [ + 'title' => '文件名，必须带文件名后缀，默认是 SourceUri 的最后一级', + 'description' => 'Filename, which must include the file extension. By default, it is the last segment of the **SourceURI** parameter.'."\n" + .'Supported file extensions (PDF is only supported for preview):'."\n" + .'- Text documents (Word): doc, docx, txt, dot, wps, wpt, dotx, docm, dotm, rtf '."\n" + .'- Presentation documents (PPT): ppt, pptx, pptm, ppsx, ppsm, pps, potx, potm, dpt, dps - Spreadsheet documents (Excel): et, xls, xlt, xlsx, xlsm, xltx, xltm, csv '."\n" + .'- PDF documents: pdf', + 'type' => 'string', + 'required' => false, + 'example' => 'test-Object.pptx', + ], + ], + [ + 'name' => 'CachePreview', + 'in' => 'query', + 'schema' => [ + 'title' => '缓存预览标识', + 'description' => 'Cache preview flag: '."\n" + .'- true: When enabled, the document preview will no longer update collaborative editing content, suitable for scenarios where only preview is needed. '."\n" + .'- false: When disabled, it defaults to collaborative preview, allowing the preview to synchronously update collaborative editing content.'."\n" + .'><notice>The price for cache preview and non-cache preview differs. Please refer to the billing item description for more details.</notice> ><notice>Search and print functions are not supported during cache preview.</notice> <notice>Updating cached content is currently not supported in cache preview mode.</notice>', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true、false', + ], + ], + [ + 'name' => 'Referer', + 'in' => 'query', + 'schema' => [ + 'title' => 'oss 防盗链 referer', + 'description' => 'OSS anti-leeching. IMM needs to obtain the source file from OSS. If OSS has set up anti-leeching, IMM must pass the corresponding header to OSS to get the source file.'."\n" + .'> If the Bucket where the document is located has Referer set, please configure this parameter.', + 'type' => 'string', + 'required' => false, + 'example' => '*', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => '用户自定义数据，在消息通知中返回', + 'description' => 'User-defined information. It only takes effect when Notification parameters are filled in for MNS configuration. It will be returned in asynchronous message notifications, which can help you correlate and process messages within your system. The maximum length is 2048 bytes.', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "id": "test-id",'."\n" + .' "name": "test-name"'."\n" + .'}', + ], + ], + [ + 'name' => 'PreviewPages', + 'in' => 'query', + 'schema' => [ + 'title' => '预览前几页', + 'description' => 'Limits the number of pages that can be previewed. By default, there is no limit. The maximum cannot exceed 5000.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'title' => '文件密码', + 'description' => 'The password to open the document.'."\n" + .'> If you need to preview or edit a password-protected document, set this parameter.', + 'type' => 'string', + 'required' => false, + 'example' => '123456', + ], + ], + [ + 'name' => 'ExternalUploaded', + 'in' => 'query', + 'schema' => [ + 'title' => '是否支持外部上传', + 'description' => 'Indicates whether uploading a file with the same name to OSS is an expected behavior. Possible values are as follows:'."\n" + ."\n" + .'- true: Uploading a file with the same name to OSS is an expected behavior. The uploaded document will overwrite the original document and generate a new version. After setting it to true, you still need to close the currently editing document and wait for about 5 minutes before reopening it to load the new document. The upload is only effective when the document is closed; if the document is open, the new save will overwrite the uploaded file.'."\n" + .'- false (default): Uploading a file with the same name to OSS is not an expected behavior, and the interface will return an error.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'NotifyTopicName', + 'in' => 'query', + 'schema' => [ + 'title' => 'mns 消息通知 topic', + 'description' => 'Supports notifying some events to customers via MNS messages. This parameter is the topic for MNS asynchronous message notifications.', + 'type' => 'string', + 'required' => false, + 'example' => 'test-topic', + ], + ], + [ + 'name' => 'Hidecmb', + 'in' => 'query', + 'schema' => [ + 'title' => '隐藏工具栏，预览模式下使用', + 'description' => 'Whether to hide the toolbar. This parameter can be set in document preview mode. Possible values are as follows:'."\n" + ."\n" + .'- false (default): Do not hide the toolbar.'."\n" + .'- true: Hide the toolbar.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Permission', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '权限', + 'description' => 'User permission information, represented in JSON format.'."\n" + ."\n" + .'User permissions include the following options:'."\n" + ."\n" + .'Each option is of type Boolean, with a default value of false, and can be set to true or false.'."\n" + ."\n" + .'- Readonly (optional): Preview mode.'."\n" + .'- Rename (optional): File renaming permission, which only provides message notification functionality. The renaming event will be sent to MNS.'."\n" + .'- History (optional): Permission to view historical versions.'."\n" + .'- Copy (optional): Copy permission.'."\n" + .'- Export (optional): PDF export permission.'."\n" + .'- Print (optional): Print permission.'."\n" + ."\n" + .'>PDF only supports preview functionality, so the "Readonly" parameter must be set to true.'."\n" + .'>'."\n" + .'>PDF files do not support exporting.'."\n" + .'> '."\n" + .'>To use the multi-version feature, you must first enable the multi-version feature in OSS and then set the "History" parameter to true.'."\n" + .'>'."\n" + .'><notice>Printing is not supported in cached preview.></notice>'."\n" + .'><notice>Historical versions can be viewed in edit mode but not in preview mode.></notice>', + 'required' => false, + '$ref' => '#/components/schemas/WebofficePermission', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '用户', + 'description' => 'User information. You can pass in user information from the business side, which will be displayed on the WebOffice page.'."\n" + ."\n" + .'The system distinguishes different users by User.Id, and User.Name is used only for front-end display. If User.Id is not provided, the backend will generate a random ID. Users with different IDs are considered different entities and cannot modify or delete each other\'s comments.'."\n" + ."\n" + .'The default format is: Unknown_random string. If User.Id is not provided, the user information will default to "Unknown".', + 'required' => false, + '$ref' => '#/components/schemas/WebofficeUser', + ], + ], + [ + 'name' => 'Watermark', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '水印', + 'description' => 'Watermark information. The watermark is generated on the front end and is not written into the source document. The same document with different parameters will result in different watermarks.', + 'required' => false, + '$ref' => '#/components/schemas/WebofficeWatermark', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**If there are no special requirements, leave this blank.**'."\n" + ."\n" + .'Chained authorization configuration, not required. For more information, see [Using Chained Authorization to Access Other Entity Resources](~~465340~~).', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Notification message configuration, currently supporting only MNS. For the asynchronous notification message format, refer to [WebOffice Message Notification Format](~~2743999~~).'."\n" + ."\n" + .'> There will be message notifications when the file is saved or renamed.', + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '文档转换任务', + 'description' => 'Weboffice access credentials.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '1759315A-CB33-0A75-A72B-62D7********', + ], + 'WebofficeURL' => [ + 'title' => '预览编辑地址', + 'description' => 'Weboffice entry URL. Used for online preview or editing of documents.'."\n" + .'> Cannot be opened directly in a browser; it needs to be used with the Weboffice JS-SDK and access token (AccessToken) to preview or edit documents. For more information, see [Getting Started](~~468066~~).', + 'type' => 'string', + 'example' => 'https://office-cn-shanghai.imm.aliyuncs.com/office/s/dd221b2cdb44fb66e9070d1d70a8b9bbb6d6fff7?_w_tokentype=1', + ], + 'AccessToken' => [ + 'title' => 'access token', + 'description' => 'Weboffice access token.', + 'type' => 'string', + 'example' => '2d73dd5d87524c5e8a194c3eb5********', + ], + 'RefreshToken' => [ + 'title' => 'refresh token', + 'description' => 'Weboffice refresh token.', + 'type' => 'string', + 'example' => 'e374995ec532432bb678074d36********', + ], + 'AccessTokenExpiredTime' => [ + 'title' => 'access token 过期时间', + 'description' => 'Expiration time of the access token. The expiration time is 30 minutes.', + 'type' => 'string', + 'example' => '2021-08-30T13:13:11.347146982Z', + ], + 'RefreshTokenExpiredTime' => [ + 'title' => 'refresh token 过期时间', + 'description' => 'Expiration time of the refresh token. The expiration time is 1 day.', + 'type' => 'string', + 'example' => '2021-08-31T12:43:11.347146982Z', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1759315A-CB33-0A75-A72B-62D7********\\",\\n \\"WebofficeURL\\": \\"https://office-cn-shanghai.imm.aliyuncs.com/office/s/dd221b2cdb44fb66e9070d1d70a8b9bbb6d6fff7?_w_tokentype=1\\",\\n \\"AccessToken\\": \\"2d73dd5d87524c5e8a194c3eb5********\\",\\n \\"RefreshToken\\": \\"e374995ec532432bb678074d36********\\",\\n \\"AccessTokenExpiredTime\\": \\"2021-08-30T13:13:11.347146982Z\\",\\n \\"RefreshTokenExpiredTime\\": \\"2021-08-31T12:43:11.347146982Z\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'Obtain Weboffice Token', + 'description' => '- **Please ensure that you fully understand the billing method and [pricing](~~477042~~) of the Intelligent Media Management product before using this interface.**'."\n" + ."\n" + .'- The access token expires in 30 minutes, and the refresh token expires in 1 day.'."\n" + .'- The returned expiration time is in UTC, which has an 8-hour difference from Beijing Time.'."\n" + .'- Supported input file formats:'."\n" + .' - Word documents: doc, docx, txt, dot, wps, wpt, dotx, docm, dotm, rtf.'."\n" + .' - Presentation documents (PPT): ppt, pptx, pptm, ppsx, ppsm, pps, potx, potm, dpt, dps.'."\n" + .' - Spreadsheet documents (Excel): et, xls, xlt, xlsx, xlsm, xltx, xltm, csv'."\n" + .' - PDF documents: pdf.'."\n" + .'- Supports files up to 200MB.'."\n" + .'- Supports documents with a maximum of 5000 pages.'."\n" + .'- Projects created before 2023-12-01 are billed based on the number of document openings. Currently, billing is based on the number of API calls. To switch to the new billing model, simply create a new project. Note that one API call can only be used by one user; if reused, only the last user will have normal access, and the access rights of other users will be revoked.'."\n" + ."\n" + .'- In the same region as the Intelligent Media Management, activate MNS service, create topics and queues, and configure subscription relationships. You can pass the MNS topic name through the NotifyTopicName parameter to receive message notifications for file saves. For more information about the MNS SDK, see [Receiving and Deleting Messages](~~32449~~).'."\n" + .'For an example of the JSON format of the Message field in file save message notifications, refer to [WebOffice Message Notification Format](~~2743999~~).'."\n" + ."\n" + .'> To use the multi-version feature, you must first enable the multi-version feature in OSS, then set the \'History\' parameter to true.'."\n" + .'>', + 'requestParamsDescription' => '#### 典型场景举例'."\n" + ."\n" + .'对于如下示例的参数结构，对一些经典的场景示例说明：'."\n" + .'##### 预览只读文件（如果是预览pdf文件，必须这样设置）'."\n" + ."\n" + .'文档预览模式，文档只能预览不可编辑规则：'."\n" + ."\n" + .'```json'."\n" + .' {'."\n" + .' "ProjectName" : "test-project",'."\n" + .' "SourceURI" : "oss://test-bucket/test-object.pdf",'."\n" + .' "Filename" : "test-object.docx",'."\n" + .' "PreviewPages" : "5",'."\n" + .' "Permission" : "{\'Readonly\':\'true\'}"'."\n" + .'}'."\n" + ."\n" + .'```'."\n" + .'##### 预览文件后缀为大写的文件'."\n" + ."\n" + .'预览文件后缀为大写的文件，需要设置Filename参数后缀为小写：'."\n" + ."\n" + .'```json'."\n" + .' {'."\n" + .' "ProjectName" : "test-project",'."\n" + .' "SourceURI" : "oss://test-bucket/test-object.DOCX",'."\n" + .' "Filename" : "test-object.docx",'."\n" + .' "PreviewPages" : "5",'."\n" + .' "Permission" : "{\'Readonly\':\'true\'}"'."\n" + .'}'."\n" + ."\n" + .'```'."\n" + .'##### 对指定文档只预览前5页'."\n" + ."\n" + .'文档一共10页，只显示前5页规则：'."\n" + ."\n" + .'```json'."\n" + .' {'."\n" + .' "ProjectName" : "test-project",'."\n" + .' "SourceURI" : "oss://test-bucket/test-object.docx",'."\n" + .' "Filename" : "test-object.docx",'."\n" + .' "PreviewPages" : "5",'."\n" + .' "Permission" : "{\'Readonly\':\'true\'}"'."\n" + .'}'."\n" + ."\n" + .'```'."\n" + .'##### 对指定文档预览添加密码'."\n" + ."\n" + .'文档预览时设置密码，或者源文件设置了密码预览时直接打开不需要密码规则：'."\n" + ."\n" + .'```json'."\n" + .' {'."\n" + .' "ProjectName" : "test-project",'."\n" + .' "SourceURI" : "oss://test-bucket/test-object.docx",'."\n" + .' "Filename" : "test-object.docx",'."\n" + .' "Password" : "123456",'."\n" + .' "Permission" : "{\'Readonly\':\'true\'}"'."\n" + .'}'."\n" + .'```'."\n" + .'##### 对指定的文档预览添加水印'."\n" + ."\n" + .'文档预览时添加水印规则：'."\n" + ."\n" + .'```json'."\n" + .' {'."\n" + .' "ProjectName" : "test-project",'."\n" + .' "SourceURI" : "oss://test-bucket/test-object.docx",'."\n" + .' "Filename" : "test-object.docx",'."\n" + .' "Watermark" : "{\'Type\':\'1\',\'Value\':\'水印值\',\'Font\':\'bold 20px Serif\'}",'."\n" + .' "Permission" : "{\'Readonly\':\'true\'}"'."\n" + .'}'."\n" + .'```'."\n" + .'##### 对指定的文档预览时隐藏工具栏'."\n" + ."\n" + .'文档预览时隐藏工具栏规则：'."\n" + ."\n" + .'```json'."\n" + .' {'."\n" + .' "ProjectName" : "test-project",'."\n" + .' "SourceURI" : "oss://test-bucket/test-object.docx",'."\n" + .' "Filename" : "test-object.docx",'."\n" + .' "Hidecmb" : "true",'."\n" + .' "Permission" : "{\'Readonly\':\'true\'}"'."\n" + .'}'."\n" + .'```'."\n" + .'##### 对指定的文档进行在线编辑，查看历史版本，拷贝，打印，导出PDF权限'."\n" + ."\n" + .'文档在线编辑，查看历史版本，拷贝，打印，导出PDF权限规则：'."\n" + ."\n" + .'```json'."\n" + .' {'."\n" + .' "ProjectName" : "test-project",'."\n" + .' "SourceURI" : "oss://test-bucket/test-object.docx",'."\n" + .' "Filename" : "test-object.docx",'."\n" + .' "Permission" : "{\'Readonly\':\'false\',\'History\':\'true\',\'Copy\':\'true\',\'Print\':\'true\',\'Export\':\'true\'}"'."\n" + .'}'."\n" + .'```', + 'responseParamsDescription' => '**常见错误**'."\n" + ."\n" + .'ProjectName对应的项目未找到，请到新版本IMM控制台检查地域下该项目是否存在。'."\n" + .'```'."\n" + .'{'."\n" + .' "Code": "ResourceNotFound",'."\n" + .' "Message": "The specified resource acs:imm::xxx:project/xxx is not found"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'User参数是必填参数，请检查该参数是否填写。'."\n" + .'```'."\n" + .'{'."\n" + .' "Code": "InvalidArgument.User",'."\n" + .' "Message": "The parameter User is required but not provided"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'User参数不正确，请检查该参数值是否是正确的JSON格式。'."\n" + .'```'."\n" + .'{'."\n" + .' "Code": "InvalidJSON parsing error, User",'."\n" + .' "Message": "Specified parameter JSON parsing error, User is not valid."'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'Permission参数不正确，请检查该参数值是否是正确的JSON格式。'."\n" + .'```'."\n" + .'{'."\n" + .' "Code": "InvalidJSON parsing error, Permission",'."\n" + .' "Message": "Specified parameter JSON parsing error, Permission is not valid."'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'Watermark参数不正确，请检查该参数值是否是正确的JSON格式。'."\n" + .'```'."\n" + .'{'."\n" + .' "Code": "InvalidJSON parsing error, Watermark",'."\n" + .' "Message": "Specified parameter JSON parsing error, Watermark is not valid."'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'PreviewPages参数格式不正确，请检查PreviewPages参数值。'."\n" + .'``` '."\n" + .'{'."\n" + .' "Code": "InvalidPreviewPages",'."\n" + .' "Message": "Specified parameter PreviewPages is not valid."'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'SourceURI对应的OSS文件不存在，请检查Bucket下该文件是否存在。'."\n" + .'```'."\n" + .'{'."\n" + .' "Code": "ResourceNotFound",'."\n" + .' "Message": "The specified resource oss://xx is not found"'."\n" + .'}'."\n" + .'```', + 'extraInfo' => '### 相关文档 '."\n" + .' - 关于OSS多版本的介绍，请参见[OSS版本控制概述](~~109695~~)。'."\n" + .' - 关于OSS防盗链的介绍，请参见[使用防盗链策略避免非法流量盗用](~~31869~~)。', + 'translator' => 'machine', + ], + 'RefreshWebofficeToken' => [ + 'summary' => 'Refresh Document Preview and Editing Token', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '39679', + 'abilityTreeNodes' => [ + 'FEATUREimm4TQO1Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'Project name. For more information on how to obtain it, see [Create Project](~~478153~~).', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'AccessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'access token', + 'description' => 'Weboffice access token. Obtain it through the [GenerateWebofficeToken](~~478226~~) or [RefreshWebofficeToken](~~478227~~) interfaces.', + 'type' => 'string', + 'required' => true, + 'example' => '99d1b8b478b641c1b3372f5bd6********', + ], + ], + [ + 'name' => 'RefreshToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'refresh token', + 'description' => 'Weboffice refresh token. Obtain it through the [GenerateWebofficeToken](~~478226~~) or [RefreshWebofficeToken](~~478227~~) interfaces.', + 'type' => 'string', + 'required' => true, + 'example' => 'a730ae0d7c6a487d87c661d199********', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**If there are no special requirements, leave it blank.**'."\n" + ."\n" + .'Chained authorization configuration, optional. For more information, see [Access Other Entity Resources Using Chained Authorization](~~465340~~).', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '文档转换任务', + 'description' => 'Weboffice Access Token', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 Id', + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '501339F9-4B70-0CE2-AB8C-866C********', + ], + 'RefreshToken' => [ + 'title' => 'refresh token', + 'description' => 'Weboffice refresh token.', + 'type' => 'string', + 'example' => '72a52ab3702a4123ab5594671a********', + ], + 'AccessToken' => [ + 'title' => 'access token', + 'description' => 'Weboffice access token.', + 'type' => 'string', + 'example' => '4996466c690a4902846ce00f96********', + ], + 'RefreshTokenExpiredTime' => [ + 'title' => 'refresh token 过期时间', + 'description' => 'Expiration time of the refresh token. The expiration period is 1 day.', + 'type' => 'string', + 'example' => '2021-09-01T12:37:28.950065359Z', + ], + 'AccessTokenExpiredTime' => [ + 'title' => 'access token 过期时间', + 'description' => 'Expiration time of the access token. The expiration period is 30 minutes.', + 'type' => 'string', + 'example' => '2021-08-31T13:07:28.950065359Z', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"501339F9-4B70-0CE2-AB8C-866C********\\",\\n \\"RefreshToken\\": \\"72a52ab3702a4123ab5594671a********\\",\\n \\"AccessToken\\": \\"4996466c690a4902846ce00f96********\\",\\n \\"RefreshTokenExpiredTime\\": \\"2021-09-01T12:37:28.950065359Z\\",\\n \\"AccessTokenExpiredTime\\": \\"2021-08-31T13:07:28.950065359Z\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'Refresh Weboffice Token', + 'description' => '**Please ensure that you fully understand the billing method and [pricing](~~477042~~) of the Intelligent Media Management product before using this interface.**'."\n" + .'- For detailed billing information, refer to the [WebOffice Billing Instructions](~~2639703~~).'."\n" + .'- The access token expires after 30 minutes. You must open the preview before the access token expires; otherwise, you will not be able to preview.'."\n" + .'- The refresh token expires after 1 day. You need to call the refresh interface before the refresh token expires; otherwise, the token will become invalid.'."\n" + .'- The expiration time returned is in UTC, which has an 8-hour difference from Beijing Time.'."\n" + .'> The access token is used for actual preview session access, while the refresh token is used to reduce the parameters required for users to refresh tokens. You can use the refresh token to directly obtain a new token based on previous configurations.'."\n" + .'>', + 'translator' => 'machine', + ], + 'CreateOfficeConversionTask' => [ + 'summary' => 'Creates a document format conversion task to convert the format of a document stored in an Object Storage Service (OSS) bucket.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '129600', + 'abilityTreeNodes' => [ + 'FEATUREimmV2RAAA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'title' => '文档转换输入文件地址', + 'description' => 'The URI of the source file.'."\n" + ."\n" + .'Specify the OSS URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Object}` is the path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object', + ], + ], + [ + 'name' => 'Sources', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The list of images. The sequence of image URIs in the list determines the order in which they are converted. (**This parameter is not officially available and is not recommended.**)'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The input image.'."\n", + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => 'The OSS URI of the input image.'."\n" + ."\n" + .'The URI must be in the oss://${Bucket}/${Object} format. ${Bucket} specifies the name of the OSS bucket that is in the same region as the current project. ${Object} specifies the full path of the file that contains the file name extension.'."\n" + ."\n" + .'The operation supports the following image formats: JPG, JP2, PNG, TIFF, WebP, BMP, and SVG.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://examplebucket/sampleobject.jpg', + ], + 'Rotate' => [ + 'description' => 'The rotation angle. Valid values:'."\n" + ."\n" + .'* 0 (default)'."\n" + .'* 90'."\n" + .'* 180'."\n" + .'* 270'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '90', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => 'oss://imm-test/test.pptx', + ], + ], + [ + 'name' => 'TargetURI', + 'in' => 'query', + 'schema' => [ + 'title' => '文档转换输出地址模式', + 'description' => 'The address template of the output file.'."\n" + ."\n" + .'Specify the value in the `oss://{bucket}/{tags.custom}/{dirname}/{barename}.{autoext}` format. For more information, see [TargetURI template](~~465762~~).'."\n" + ."\n" + .'> Specify at least one of the TargetURI and TargetURIPrefix parameters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://{bucket}/{tags.custom}/{dirname}/{barename}.{autoext}', + ], + ], + [ + 'name' => 'TargetURIPrefix', + 'in' => 'query', + 'schema' => [ + 'title' => '文档转换输出文件地址前缀', + 'description' => 'The prefix of the storage address of the output file.'."\n" + ."\n" + .'Specify the prefix in the `oss://${Bucket}/${Prefix}/` format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Prefix}` is the prefix of the output file.'."\n" + ."\n" + .'> Specify at least one of the TargetURI and TargetURIPrefix parameters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://bucket1/', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '输入文件格式，默认使用文件名后缀小写格式', + 'description' => 'The name extension of the source file. By default, the type of the source file is determined based on the name extension of the source object in OSS. If the object in OSS does not have a name extension, you can specify this parameter. Valid values:'."\n" + ."\n" + .'* Text documents: doc, docx, wps, wpss, docm, dotm, dot, dotx, and html'."\n" + .'* Presentation documents: pptx, ppt, pot, potx, pps, ppsx, dps, dpt, pptm, potm, ppsm, and dpss'."\n" + .'* Spreadsheet documents: xls, xlt, et, ett, xlsx, xltx, csv, xlsb, xlsm, xltm, and ets'."\n" + .'* PDF documents: pdf'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'doc', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'title' => '输出文件格式', + 'description' => 'The format of the output file. Valid values:'."\n" + ."\n" + .'* png: a PNG image.'."\n" + .'* jpg: a JPG image.'."\n" + .'* pdf: a PDF file.'."\n" + .'* txt: a TXT file. You can specify this value to extract the text content of the source document. Only presentation, text, or spreadsheet documents can be converted to a TXT file. If the source document is a spreadsheet, only one TXT is created and sheet-related parameters do not take effect.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'png', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => '用户自定义数据，在消息通知中返回', + 'description' => 'The custom information, which is returned in an asynchronous notification and facilitates notification management. The maximum information length is 2,048 bytes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"file_id": "abc"}', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '用户自定义标签', + 'description' => 'The custom tags in dictionary format. You can use the custom tags to search for the task.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{"test":"val1"}', + ], + ], + [ + 'name' => 'StartPage', + 'in' => 'query', + 'schema' => [ + 'title' => '转换起始页，从 1 开始，包含起始页，默认从第一页开始转换，表格转图片时需要指定 SheetIndex 才有效', + 'description' => 'The starting page for document conversion. Default value: 1.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If the document is a spreadsheet file, specify the index number of the corresponding sheet instead.'."\n" + ."\n" + .'* This parameter takes effect only when you convert the file to an image format. It does not take effect when you convert the file into a PDF or TXT file.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'EndPage', + 'in' => 'query', + 'schema' => [ + 'title' => '转换终止页，包含终止页，默认转换到最后一页，表格转图片时需要指定 SheetIndex 才有效', + 'description' => 'The ending page for document conversion. The default value is -1, which converts the file until the last page of the file.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If the source is a spreadsheet file, specify the index number of the corresponding sheet instead.'."\n" + ."\n" + .'* If you convert a large number of pages within the document, we recommend that you split the pages into several document conversion tasks to prevent conversion timeouts.'."\n" + ."\n" + .'* This parameter takes effect only when you convert the file into an image. It does not take effect when you convert the file into a PDF or TXT file.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'title' => '文档密码', + 'description' => 'The password that protects the source document. To convert a password-protected document, specify this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '********', + ], + ], + [ + 'name' => 'ScalePercentage', + 'in' => 'query', + 'schema' => [ + 'title' => '缩放参数，允许范围 20~200，100代表不缩放，小于100表示缩小，大于100表示放大，默认不缩放', + 'description' => 'The percentage scale relative to the source document. Valid values: 20 to 199. The default value is 100, which indicates that the document is not scaled.'."\n" + ."\n" + .'> A value that is less than 100 indicates a size reduction. A value that is greater than 100 indicates an enlargement.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'Quality', + 'in' => 'query', + 'schema' => [ + 'title' => '质量参数，范围是0-100，越大质量越好，默认系统自动选择适合的分辨率', + 'description' => 'The quality of the output file. Valid values: 0 to 100. A smaller value indicates lower quality and better conversion performance. By default, the system specifies an appropriate value that provides an optimal balance between the quality and conversion performance based on the document content.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'Pages', + 'in' => 'query', + 'schema' => [ + 'title' => '指定转换页码，优先级高于 StartPage/EndPage，格式：多个页码用 “," 拼接，连续页码用 "-" 连接，样例参考: 1,2-4,7', + 'description' => 'The numbers of pages to be converted. This parameter takes precedence over the StartPage and EndPage parameters. The value of this parameter can be in different formats:'."\n" + ."\n" + .'* If you specify pages separately by page number, separate page numbers with commas (,). Example: 1,2'."\n" + .'* If you specify consecutive pages by using a page range, connect the starting and ending page numbers with a hyphen (-). Example: 1,2-4,7'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1,2-4,7', + ], + ], + [ + 'name' => 'MaxSheetRow', + 'in' => 'query', + 'schema' => [ + 'title' => '表格转图片的最大行数，在 LongPicture 为 true 时生效，默认转所有行', + 'description' => 'The maximum number of spreadsheet rows to be converted to an image. By default, all rows within the spreadsheet file are converted.'."\n" + ."\n" + .'> This parameter takes effect only when the **LongPicture** parameter is set to `true`.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MaxSheetColumn', + 'in' => 'query', + 'schema' => [ + 'title' => '表格转图片的最大列数，在 LongPicture 为 true 时生效，默认转所有列', + 'description' => 'The maximum number of spreadsheet columns to be converted to an image. By default, all columns within the spreadsheet file are converted.'."\n" + ."\n" + .'> This parameter takes effect only when the **LongPicture** parameter is set to `true`.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SheetCount', + 'in' => 'query', + 'schema' => [ + 'title' => '表格转图片参数，指定转换表格中的 sheet 数量，默认转换所有 sheet', + 'description' => 'The number of sheets to be converted to an image. By default, all sheets within the spreadsheet file are converted.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SheetIndex', + 'in' => 'query', + 'schema' => [ + 'title' => '表格转图片参数，指定转换哪一个 sheet，从 1 开始，默认从起始页开始转', + 'description' => 'The index number of the sheet to be converted to an image. The value ranges from 1 to the index number of the last sheet. By default, the conversion starts from the first sheet.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FitToWidth', + 'in' => 'query', + 'schema' => [ + 'title' => '表格转图片参数，是否将所有列输出到一张图片，默认为否', + 'description' => 'Specifies whether to convert all columns of a spreadsheet document to one single image or a single-page PDF document when you convert the spreadsheet file to an image or a PDF document. Valid values:'."\n" + ."\n" + .'* false (default): converts all columns of the document to multiple images or a multi-page PDF document.'."\n" + .'* true: converts all columns of the document to one single image or a single-page PDF document.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'FitToHeight', + 'in' => 'query', + 'schema' => [ + 'title' => '表格转图片参数，是否将所有行输出到一张图片，默认为否', + 'description' => 'Specifies whether to convert all rows of a spreadsheet document to one single image or a single-page PDF document when you convert the table document to an image or a PDF document. Valid values:'."\n" + ."\n" + .'* false (default): converts all rows of the document to multiple images or a multi-page PDF document. This is the default value.'."\n" + .'* true: converts all rows of the document to one single image or a single-page PDF document.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'FirstPage', + 'in' => 'query', + 'schema' => [ + 'title' => '表格转图片参数，是否只返回表格的第一张图片，默认为否', + 'description' => 'Specifies whether to return only the first resulting image when you convert a spreadsheet document to images. The number of rows and the number of columns in the first image are determined by the automatic splitting process. Valid values:'."\n" + ."\n" + .'* false (default): does not return only the first resulting image. All the resulting images are returned.'."\n" + .'* true: returns only the first resulting image. A thumbnail is generated.'."\n" + ."\n" + .'> This parameter takes effect only when the **LongPicture** parameter is set to `true`.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'PaperSize', + 'in' => 'query', + 'schema' => [ + 'title' => '表格转图片纸张大小，支持 A4/A2/A0，默认A4，配合 FitToHeight 或 FitToWidth 一起使用才有效', + 'description' => 'The paper size for converting a spreadsheet document to images. Conversion to images is similar to printing the content on a sheet of paper. Valid values:'."\n" + ."\n" + .'* A0'."\n" + .'* A2'."\n" + .'* A4 (default)'."\n" + ."\n" + .'> This parameter takes effect only when the **FitToHeight** and **FitToWidth** parameters are specified.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'A4', + ], + ], + [ + 'name' => 'PaperHorizontal', + 'in' => 'query', + 'schema' => [ + 'title' => '表格转图片纸张是否水平放置，默认为否', + 'description' => 'Specifies whether to place sheets of paper horizontally for converting a spreadsheet document to images. Conversion to images is similar to printing the content on a sheet of paper. Valid values:'."\n" + ."\n" + .'* false (default): does not place sheets of paper horizontally. Paper sheets are placed vertically.'."\n" + .'* true: places sheets of paper horizontally.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'TrimPolicy', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '表格瘦身', + 'description' => 'The trim policy for converting a spreadsheet file. Empty rows and columns may generate blank spaces in the output file if no appropriate trim policy is specified.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/TrimPolicy', + ], + ], + [ + 'name' => 'ShowComments', + 'in' => 'query', + 'schema' => [ + 'title' => '文字转图片，是否显示批注，目前只支持文字转图片时携带批注，默认不显示批注', + 'description' => 'Specifies whether to display comments in resulting images when a text document is converted to images. Valid values:'."\n" + ."\n" + .'* false (default): does not display comments in resulting images.'."\n" + .'* true: displays comments in resulting images.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'LongPicture', + 'in' => 'query', + 'schema' => [ + 'title' => '转图片时是否转换成一张长图，最多支持将 20 页合成一张长图，超过可能报错，默认为不转成长图', + 'description' => 'Specifies whether to convert the document to a long image. Valid values:'."\n" + ."\n" + .'* false (default): does not convert the document to a long image.'."\n" + .'* true: converts the document to a long image.'."\n" + ."\n" + .'> You can convert up to 20 pages of a document into a long image. If you convert more than 20 pages to a long image, an error may occur.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ImageDPI', + 'in' => 'query', + 'schema' => [ + 'title' => '输出图片 DPI，允许范围 96-600，默认 96', + 'description' => 'The dots per inch (DPI) of output images. Valid values: 96 to 600. Default value: 96.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '96', + ], + ], + [ + 'name' => 'LongText', + 'in' => 'query', + 'schema' => [ + 'title' => '转文本时是否转换成长文本，默认每页是个独立的文本', + 'description' => 'Specifies whether to convert the document to a long text file. Valid values:'."\n" + ."\n" + .'* false (default): does not convert the document to a long text file. Each page of the document is converted to a text file.'."\n" + .'* true: converts the entire document to a long text file.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'HoldLineFeed', + 'in' => 'query', + 'schema' => [ + 'title' => '转文本时是否保留文档中的换行符，默认不保留', + 'description' => 'Specifies whether to retain line feeds in the output file when a document is converted to a text file. Valid values:'."\n" + ."\n" + .'* false (default): does not retain the line feeds.'."\n" + .'* true: retains the line feeds.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**If you have no special requirements, leave this parameter empty.**'."\n" + ."\n" + .'The authorization chain settings. For more information, see [Use authorization chains to access resources of other entities](~~465340~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The notification settings. For information about the asynchronous notification format, see [Asynchronous message examples](~~2743997~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '文档转换任务', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'FF3B7D81-66AE-47E0-BF69-157DCF18*****', + ], + 'TaskId' => [ + 'title' => '任务 id', + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => 'formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd*****', + ], + 'EventId' => [ + 'description' => 'The event ID.'."\n", + 'type' => 'string', + 'example' => '2C2-1I0EG57VR37J4rQ8oKG6C9*****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FF3B7D81-66AE-47E0-BF69-157DCF18*****\\",\\n \\"TaskId\\": \\"formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd*****\\",\\n \\"EventId\\": \\"2C2-1I0EG57VR37J4rQ8oKG6C9*****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateOfficeConversionTask', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** Asynchronous processing does not guarantee timely task completion.'."\n" + ."\n" + .'* Supported input formats:'."\n" + ."\n" + .' * Text documents: doc, docx, wps, wpss, docm, dotm, dot, dotx, and html'."\n" + .' * Presentation documents: pptx, ppt, pot, potx, pps, ppsx, dps, dpt, pptm, potm, ppsm, and dpss'."\n" + .' * Spreadsheet documents: xls, xlt, et, ett, xlsx, xltx, csv, xlsb, xlsm, xltm, and ets'."\n" + .' * PDF documents: pdf'."\n" + ."\n" + .'* Supported output formats:'."\n" + ."\n" + .' * Image files: png and jpg'."\n" + .' * Text files: txt'."\n" + .' * PDF files: pdf'."\n" + ."\n" + .'* Each input document can be up to 200 MB in size. The upper limit cannot be adjusted.'."\n" + ."\n" + .'* If the document size is large or the content is complex, the conversion task may time out.'."\n" + ."\n" + .'* The limit on the number of requests per second for a single user is 50.'."\n" + ."\n" + .'* The operation is an asynchronous operation. After a task is executed, the task information is saved only for seven days. When the retention period ends, the task information can no longer be retrieved. You can use one of the following methods to query the task information in a timely manner:'."\n" + ."\n" + .' * Call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation to query information about the task.``'."\n" + .' * In the region in which the IMM project is located, configure a Simple Message Queue (SMQ) subscription to receive task information notifications. For information about the asynchronous notification format, see [Asynchronous message examples](~~2743997~~). For information about SMQ SDKs, see [Use queues](~~32449~~).'."\n" + .' * In the region in which the IMM project is located, create an ApsaraMQ for RocketMQ 4.0 instance, a topic, and a group to receive task notifications. For information about the asynchronous notification format, see [Asynchronous message examples](~~2743997~~). For more information about how to use ApsaraMQ for RocketMQ, see [Call HTTP SDKs to send and subscribe to messages](~~169009~~).'."\n" + .' * In the region in which the IMM project is located, use [EventBridge](https://www.aliyun.com/product/aliware/eventbridge) to receive task information notifications. For more information, see [IMM events](~~205730~~).'."\n", + ], + 'ExtractDocumentText' => [ + 'summary' => 'Extract text from the document', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '173181', + 'abilityTreeNodes' => [ + 'FEATUREimmMBRC1J', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'Project name. For how to obtain it, see [Creating a Project](~~477051~~).', + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'title' => '文档转换输入文件地址', + 'description' => 'Storage address of the source data.'."\n" + ."\n" + .'The OSS address rule is oss://${Bucket}/${Object}, where `${Bucket}` is the name of the OSS Bucket in the same region (Region) as the current project, and `${Object}` is the complete path of the file including the file extension.'."\n" + .'><notice>Currently, only HTTP protocol addresses are supported.></notice>', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-object', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '输入文件格式，默认使用文件名后缀小写格式', + 'description' => 'Suffix type of the source data. By default, the type of the source data is determined based on the suffix of the input object. When the input object does not have a suffix, you can set this parameter. The available values are as follows:'."\n" + ."\n" + .'- Word Documents: doc, docx, wps, wpss, docm, dotm, dot, dotx, html'."\n" + .'- Presentation Documents (PPT): pptx, ppt, pot, potx, pps, ppsx, dps, dpt, pptm, potm, ppsm, dpss'."\n" + .'- Spreadsheet Documents (Excel): xls, xlt, et, ett, xlsx, xltx, csv, xlsb, xlsm, xltm, ets'."\n" + .'- PDF Documents: pdf', + 'type' => 'string', + 'required' => false, + 'example' => 'docx', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '授权配置', + 'description' => '**If there are no special requirements, leave it blank.**'."\n" + ."\n" + .'Chain authorization configuration, optional. For more information, see [Using Chain Authorization to Access Other Entity Resources](~~465340~~).', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片裁剪结果', + 'description' => 'Response body structure.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求唯一ID', + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '94D6F994-E298-037E-8E8B-0090F27*****', + ], + 'DocumentText' => [ + 'title' => '文档的文本正文内容', + 'description' => 'The text content of the document.', + 'type' => 'string', + 'example' => '测试内容。', + ], + ], + ], + ], + 500 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94D6F994-E298-037E-8E8B-0090F27*****\\",\\n \\"DocumentText\\": \\"测试内容。\\"\\n}","type":"json"}]', + 'title' => 'Extract Document Text', + 'description' => '- **Before using this interface, please make sure you fully understand the billing method and [pricing](~~88317~~) of the Intelligent Media Management product.**'."\n" + ."\n" + .'- Before calling this interface, ensure that there is an available project ([Project](~~478273~~)) in the current Region. For more details, see [Project Management](~~478152~~).'."\n" + ."\n" + .'- Supports common Word, Excel, PPT, PDF, and TXT documents.'."\n" + ."\n" + .'- The file size must not exceed 200 MB. The extracted plain text file size should not exceed 2 MB (approximately 600,000 Chinese characters).'."\n" + ."\n" + .'><notice>If the document format is complex or the text volume is too large, a timeout error may occur. In such scenarios, it is recommended to use the [CreateOfficeConversionTask](478228) interface and specify the output format as txt to achieve similar functionality.></notice>', + 'translator' => 'machine', + ], + 'CreateFileCompressionTask' => [ + 'summary' => 'Creates a file packing task.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '156182', + 'abilityTreeNodes' => [ + 'FEATUREimmSETH07', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'Sources', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The objects to be packed and packing rules.'."\n" + ."\n" + .'> You must specify this parameter or the SourceManifestURI parameter. The Sources parameter can hold up to 100 packing rules. If you want to include more than 100 packing rules, use the SourceManifestURI parameter.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The OSS URI of the object and the corresponding packing rules.'."\n", + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => 'The OSS URI of the object or directory.'."\n" + ."\n" + .'Specify the OSS URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Object}` is a directory or object:'."\n" + ."\n" + .'When you pack a directory, `${Object}` is the path of the directory.'."\n" + ."\n" + .'* When you pack an object, `${Object}` is the path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object', + ], + 'Alias' => [ + 'description' => 'Specifies the path of the object in the package, or renames the object in the package.'."\n" + ."\n" + .'* Leave this parameter empty to retain the original directory structure of the object in the package. For example, if the object is stored at `oss://test-bucket/test-dir/test-object.doc` and you do not specify this parameter, the path of the object in the package is `/test-dir/test-object.doc`.'."\n" + .'* Rename the object. For example, if the object is stored at `oss://test-bucket/test-object.jpg` and you set the **Alias** parameter to `test-rename-object.jpg`, the name of the object in the package is `test-rename-object.jpg`.'."\n" + .'* Specify a different path for the object in the package. For example, if the directory to be packed is `oss://test-bucket/test-dir/` and you set the **Alias** parameter to `/new-dir/`, all objects in the directory are placed in the `/new-dir/` path in the package.'."\n" + .'* Set the parameter to `/` to remove the original directory structure.'."\n" + ."\n" + .'> Duplicate object names may cause a failure in extracting the objects from the package, depending on the packing tool that you use. We recommend that you avoid using duplicate object names when you rename objects in the packing task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/new-dir/', + ], + 'Mode' => [ + 'description' => 'The object matching rule. Valid values: `fullname` and `prefix`. Default value: `prefix`'."\n" + ."\n" + .'* `prefix`: matches objects by object name prefix.'."\n" + .'* `fullname`: exactly matches one single object by its full object name.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'prefix' => 'prefix', + 'fullname' => 'fullname', + ], + 'example' => 'fullname', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**If you have no special requirements, leave this parameter empty.**'."\n" + ."\n" + .'The configurations of authorization chains. For more information, see [Use authorization chains to access resources of other entities](~~465340~~).', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'SourceManifestURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The OSS URI of the inventory object that contains the objects to compress. The inventory object stores the objects to compress by using the same data structure of the Sources parameter in the JSON format. This parameter is suitable for specifying a large number of objects to compress.'."\n" + ."\n" + .'> You must specify this parameter or the `Sources` parameter. The `URI` parameter is required and the `Alias` parameter is optional. You can specify up to 80,000 compression rule by using SourceManifestURI in one single call to the operation. The following line provides an example of the content within an inventory object.'."\n" + ."\n" + .' [{"URI":"oss://<bucket>/<object>", "Alias":"/new-dir/new-name"}]'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object.json', + ], + ], + [ + 'name' => 'TargetURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The OSS URI of the package. The object name part in the URI is used as the name of the package. Example: `name.zip`.'."\n" + ."\n" + .'Specify the OSS URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Object}` is the path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-target-object.zip', + ], + ], + [ + 'name' => 'CompressedFormat', + 'in' => 'query', + 'schema' => [ + 'description' => 'The format of the output file.'."\n" + ."\n" + .'> Only the ZIP format is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'zip', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom information, which is returned in an asynchronous notification and facilitates notification management. The maximum length of the value is 2,048 bytes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"}', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The notification settings. For information about the asynchronous notification format, see [Asynchronous message examples](~~2743997~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'EC564A9A-BA5C-4499-A087-D9B9E76E*****', + ], + 'EventId' => [ + 'description' => 'The event ID.'."\n", + 'type' => 'string', + 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16Es*****', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => 'FileCompression-3579a380-6f7a-4a9d-b9d2-65996*****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC564A9A-BA5C-4499-A087-D9B9E76E*****\\",\\n \\"EventId\\": \\"0ED-1Bz8z71k5TtsUejT4UJ16Es*****\\",\\n \\"TaskId\\": \\"FileCompression-3579a380-6f7a-4a9d-b9d2-65996*****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateFileCompressionTask', + 'description' => '> The operation is in public preview. For any inquires, join our DingTalk group (ID: 88490020073) and share your questions with us.'."\n" + ."\n" + .'> The operation supports file packing only. Compression support will be added later.'."\n" + ."\n" + .'* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** Asynchronous processing does not guarantee timely task completion.'."\n" + ."\n" + .'* A call to the operation can pack up to 80,000 objects into a package.'."\n" + ."\n" + .'* The total size of all objects to be packed into a package cannot exceed 200 GB.'."\n" + ."\n" + .'* The operation can pack only Standard objects in Object Storage Service (OSS). To pack an object in another storage class, you must first [convert the storage class of the object](~~90090~~).'."\n" + ."\n" + .'* This operation is an asynchronous operation. After a task is executed, the task information is retained only for seven days and cannot be retrieved when the retention period elapses. You can call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation to query information about the task.`` If you specify [Notification](~~2743997~~), you can obtain information about the task based on notifications.'."\n", + 'requestParamsDescription' => '#### [](#)Compression examples'."\n" + ."\n" + .'This section provides some compression examples based on the following objects in the bucket:'."\n" + ."\n" + .' (bucket)'."\n" + .' ├── test-dir1'."\n" + .' │ ├── file1.txt'."\n" + .' │ ├── file2.doc'."\n" + .' │ ├── file3.png'."\n" + .' │ └── my-file.json'."\n" + .' └── test-dir2'."\n" + .' ├── AAA'."\n" + .' │ └── file.txt'."\n" + .' ├── AAA'."\n" + .' ├── file6.doc'."\n" + .' ├── file7.doc'."\n" + .' └── file8.doc'."\n" + ."\n" + .'##### [](#)Compress the specified directory'."\n" + ."\n" + .'If you want to compress the `test-dir1` directory into a package at the `test-dir` directory, specify the following compression rule:'."\n" + ."\n" + .'```json'."\n" + .'['."\n" + .' {'."\n" + .' "URI" : "oss://bucket/test-dir1/",'."\n" + .' "Alias" : "/test-dir/"'."\n" + .' }'."\n" + .']'."\n" + .'```'."\n" + ."\n" + .'The following structure illustrates the content structure of the generated package:'."\n" + ."\n" + .' .'."\n" + .' └── test-dir'."\n" + .' ├── file1.txt'."\n" + .' ├── file2.doc'."\n" + .' ├── file3.png'."\n" + .' └── my-file.json'."\n" + ."\n" + .'##### [](#)Compress objects that have the specified name prefix'."\n" + ."\n" + .'If you want to compress objects whose names contain the `test-dir1/file` prefix into a package at the `test-dir` directory, specify the following compression rule:'."\n" + ."\n" + .'```json'."\n" + .'['."\n" + .' {'."\n" + .' "URI" : "oss://bucket/test-dir1/file",'."\n" + .' "Alias" : "/test-dir/"'."\n" + .' }'."\n" + .']'."\n" + .'```'."\n" + ."\n" + .'The following structure illustrates the content structure of the generated package:'."\n" + ."\n" + .' .'."\n" + .' └── test-dir'."\n" + .' ├── file1.txt'."\n" + .' ├── file2.doc'."\n" + .' └── file3.png'."\n" + ."\n" + .'Take note that compression based on prefix matching also includes the directory or object that has exactly the same name as the prefix. For example, if you specify the following compression rule:'."\n" + ."\n" + .'```json'."\n" + .'['."\n" + .' {'."\n" + .' "URI" : "oss://bucket/test-dir2/AAA",'."\n" + .' "Alias" : "/AAA/"'."\n" + .' }'."\n" + .']'."\n" + .'```'."\n" + ."\n" + .'the content structure of the generated package is as follows:'."\n" + ."\n" + .' .'."\n" + .' └── AAA'."\n" + .' ├── AAA'."\n" + .' └── file.txt'."\n" + ."\n" + .'##### [](#)Compress the specified objects'."\n" + ."\n" + .'If you do not want to compress objects by name prefix, you can set the `mode` parameter to full name to compress only the exact objects. For example, if you specify the following compression rule:'."\n" + ."\n" + .'```json'."\n" + .'['."\n" + .' {'."\n" + .' "URI" : "oss://bucket/test-dir2/AAA",'."\n" + .' "Alias" : "AAA",'."\n" + .' "mode" : "fullname",'."\n" + .' },'."\n" + .' {'."\n" + .' "URI" : "oss://bucket/test-dir1/",'."\n" + .' "Alias" : "/test-dir1/",'."\n" + .' "mode" : "fullname",'."\n" + .' }'."\n" + .']'."\n" + .'```'."\n" + ."\n" + .'the content structure of the generated package is as follows:'."\n" + ."\n" + .' .'."\n" + .' ├── AAA'."\n" + .' └ ── test-dir1'."\n", + ], + 'CreateArchiveFileInspectionTask' => [ + 'summary' => 'Creates an archive file inspection task to preview the files in a package without decompressing the package.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '157951', + 'abilityTreeNodes' => [ + 'FEATUREimm2Z44LQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**If you have no special requirements, leave this parameter empty.**'."\n" + ."\n" + .'The configurations of authorization chains. For more information, see [Use authorization chains to access resources of other entities](~~465340~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password that protects the package. If the package is password-protected, you must provide the password to view the contents of the package.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123456', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom information, which is returned in an asynchronous notification and facilitates notification management. The maximum length of the value is 2,048 bytes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URI of the package.'."\n" + ."\n" + .'Specify the OSS URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Object}` is the path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://imm-apitest-fxf2/name.zip', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The notification settings. For information about the asynchronous notification format, see [Asynchronous message examples](~~2743997~~).'."\n" + ."\n" + .'> The IMM operation does not support a callback URL. We recommend that you use Simple Message Queue (SMQ) to receive notifications.'."\n", + 'deprecated' => false, + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'EC564A9A-BA5C-4499-A087-D9B9E76E*****', + ], + 'EventId' => [ + 'description' => 'The event ID.'."\n", + 'type' => 'string', + 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16Es*****', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => 'ArchiveFileInspection-8475218e-d86e-4c66-b3cf-50e74d6c****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC564A9A-BA5C-4499-A087-D9B9E76E*****\\",\\n \\"EventId\\": \\"0ED-1Bz8z71k5TtsUejT4UJ16Es*****\\",\\n \\"TaskId\\": \\"ArchiveFileInspection-8475218e-d86e-4c66-b3cf-50e74d6c****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateArchiveFileInspectionTask', + 'description' => '> The operation is in public preview. For any inquires, join our DingTalk chat group (ID: 31690030817) and share your questions with us.'."\n" + ."\n" + .'* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** Asynchronous processing does not guarantee timely task completion.'."\n" + ."\n" + .'* The operation supports a package that contains up to 80,000 files.'."\n" + ."\n" + .'* The operation supports ZIP or RAR packages up to 200 GB in size, or 7z packages up to 50 GB in size.'."\n" + ."\n" + .'* This operation is an asynchronous operation. After a task is executed, the task information is retained only for seven days and cannot be retrieved when the retention period elapses. You can call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation to query information about the task.`` If you specify [Notification](~~2743997~~), you can obtain information about the task based on notifications.'."\n", + 'requestParamsDescription' => '* When you can call the operation to preview the files in a package, you can specify the `ExtendedMessageURI` parameter in `Notification` to query information about files in the package. The following content provides an example of the information about files in a package:'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "Password" : "the password that protects the package.",'."\n" + .' "IsEncryption": "indicates whether the package is password-protected. The value is true or false.",'."\n" + .' "ArchiveFiles": ['."\n" + .' {'."\n" + .' "PathName": "the path of the file relative to the package. Example: ./test-dir/test.txt",'."\n" + .' "Reason": "the reason for a preview failure.",'."\n" + .' "IsFolder": "indicates whether the object is a directory. The value is true or false.",'."\n" + .' "PackedSize": "the size of the file in the package.",'."\n" + .' "UnPackedSize": "the size of the file after it is extracted from the package.",'."\n" + .' "FileAccessTime": "the last access time of the file.",'."\n" + .' },'."\n" + .' {'."\n" + .' "PathName": "./test-dir/",'."\n" + .' "Reason": "",'."\n" + .' "IsFolder": "true",'."\n" + .' "PackedSize": "0",'."\n" + .' "UnPackedSize": "0",'."\n" + .' "FileAccessTime": "2023-07-21T09:46:35Z",'."\n" + .' },'."\n" + .' ]'."\n" + .'}'."\n" + .'```'."\n", + ], + 'CreateFileUncompressionTask' => [ + 'summary' => 'Extracts the specified files from a ZIP, RAR, or 7z package to the specified directory or decompresses the entire package.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '157566', + 'abilityTreeNodes' => [ + 'FEATUREimm2Z44LQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**If you do not have special requirements, leave this parameter empty.**'."\n" + ."\n" + .'The authorization chain settings. For more information, see [Use authorization chains to access resources of other entities](~~465340~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password that protects the package.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123456', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom information, which is returned in an asynchronous notification and facilitates notification management. The maximum length of the value is 2,048 bytes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + ], + [ + 'name' => 'SelectedFiles', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The files to extract. If you do not specify this parameter, the entire package is decompressed.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The path of the file to extract. The path is relative to the root directory of the package.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rar5/1.jpg', + ], + 'required' => false, + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The OSS URI of the package.'."\n" + ."\n" + .'Specify the OSS URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Object}` is the path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://imm-apitest-fxf2/name.zip', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The notification settings. For information about the asynchronous notification format, see [Asynchronous message examples](~~2743997~~).'."\n" + ."\n" + .'> The IMM operation does not support a callback URL. We recommend that you use Simple Message Queue (SMQ) to receive notifications.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + [ + 'name' => 'TargetURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The OSS URI to which you want to extract files from the package or decompress the entire package.'."\n" + ."\n" + .'Specify the OSS URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Object}` is the path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-dir/', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'EC564A9A-BA5C-4499-A087-D9B9E76E*****', + ], + 'EventId' => [ + 'description' => 'The event ID.'."\n", + 'type' => 'string', + 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16Es*****', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => 'FileUncompression-16ab5dd6-af02-480e-9ed7-a8d51b1*****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC564A9A-BA5C-4499-A087-D9B9E76E*****\\",\\n \\"EventId\\": \\"0ED-1Bz8z71k5TtsUejT4UJ16Es*****\\",\\n \\"TaskId\\": \\"FileUncompression-16ab5dd6-af02-480e-9ed7-a8d51b1*****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateFileUncompressionTask', + 'description' => '> The operation is in public preview. For any inquires, join our DingTalk group (ID: 88490020073) and share your questions with us.'."\n" + ."\n" + .'* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** Asynchronous processing does not guarantee timely task completion.'."\n" + ."\n" + .'* The operation supports a package that contains up to 80,000 files.'."\n" + ."\n" + .'* The operation supports ZIP or RAR packages up to 200 GB in size, or 7z packages up to 50 GB in size.'."\n" + ."\n" + .'* The operation extracts files in streams to the specified directory. If the file extraction task is interrupted by a corrupt file, files that have been extracted are not deleted.'."\n" + ."\n" + .'* This operation is an asynchronous operation. After a task is executed, the task information is retained only for seven days and cannot be retrieved when the retention period elapses. You can call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation to query information about the task.`` If you specify [Notification](~~2743997~~), you can obtain information about the task based on notifications.'."\n", + 'requestParamsDescription' => 'If you want to obtain detailed information about the decompression task, specify the `ExtendedMessageURI` parameter in `Notification`. The object specified by this parameter contains task information organized in the following structure:'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "Password" : "the password that protects the package.",'."\n" + .' "IsEncryption": "indicates whether the package is password-protected. The value is true or false.",'."\n" + .' "ArchiveFiles": ['."\n" + .' {'."\n" + .' "URI": "the URI of the extracted file. Example: oss://test-bucket/test-dir/test.txt",'."\n" + .' "PathName": "the path of the file relative to the package. Example: ./test.txt",'."\n" + .' "Reason": "the reason for a preview failure",'."\n" + .' "IsFolder": "indicates whether the file is a directory. The value is true or false.",'."\n" + .' "PackedSize": "the size of the file in the package.",'."\n" + .' "UnPackedSize": "the size of the file after it is extracted from the package.",'."\n" + .' "FileAccessTime": "the last access time of the file.",'."\n" + .' },'."\n" + .' {'."\n" + .' "URI": "oss://test-bucket/test-dir/text.doc",'."\n" + .' "PathName": "./text.doc",'."\n" + .' "Reason": "",'."\n" + .' "IsFolder": "true",'."\n" + .' "PackedSize": "102",'."\n" + .' "UnPackedSize": "150",'."\n" + .' "FileAccessTime": "2023-07-21T09:46:35Z",'."\n" + .' },'."\n" + .' ]'."\n" + .'}'."\n" + .'```'."\n", + ], + 'CreateCompressPointCloudTask' => [ + 'summary' => 'Compresses point cloud data (PCD) in Object Storage Service (OSS) to reduce the amount of data transferred over networks.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '145992', + 'abilityTreeNodes' => [ + 'FEATUREimm0H0W4Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The OSS URL of the PCD file.'."\n" + ."\n" + .'Specify the value in the oss://${Bucket}/${Object} format. `${Bucket}` specifies the name of the OSS bucket that resides in the same region as the current project. `${Object}` specifies the path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test/src/test.pcd', + ], + ], + [ + 'name' => 'TargetURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The OSS URL of the output file after compression.'."\n" + ."\n" + .'Specify the value in the oss://${Bucket}/${Object} format. `${Bucket}` specifies the name of the OSS bucket that resides in the same region as the current project. `${Object}` specifies the path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test/tgt', + ], + ], + [ + 'name' => 'PointCloudFileFormat', + 'in' => 'query', + 'schema' => [ + 'description' => 'The file format. Set the value to the default value: pcd.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pcd', + 'default' => 'pcd', + 'enum' => [ + 'pcd', + ], + ], + ], + [ + 'name' => 'CompressMethod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The compression algorithm. Valid values:'."\n" + ."\n" + .'* octree'."\n" + .'* kdtree'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'octree', + 'enum' => [ + 'octree', + 'kdtree', + ], + ], + ], + [ + 'name' => 'PointCloudFields', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'json', + 'schema' => [ + 'description' => 'The PCD property fields and the compression order in which the data is decompressed after the compression is complete.'."\n" + ."\n" + .'* If octree of Point Cloud Library (PCL) is used for compression, \\["xyz"] is supported.'."\n" + .'* If Draco k-dimensional (k-d) tree is used for compression, \\["xyz"] and \\["xyz", "intensity"] are supported.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The value of the PCD property field in compression. Valid values:'."\n" + ."\n" + .'* xyz'."\n" + .'* intensity'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["xyz"]', + ], + 'required' => true, + ], + ], + [ + 'name' => 'KdtreeOption', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The k-d tree compression options.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/KdtreeOption', + ], + ], + [ + 'name' => 'OctreeOption', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The octree compression options.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/OctreeOption', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom data, which is returned in an asynchronous notification and facilitates notification management. The maximum length is 2,048 bytes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The custom tags, which can be used to search for and filter asynchronous tasks.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{"LabelKey": "Value"}', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**If you have no special requirements, leave this parameter empty.**'."\n" + ."\n" + .'The configurations of authorization chains. This parameter is optional. For more information, see [Use authorization chains to access resources of other entities](~~465340~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The notification settings. For information about the asynchronous notification format, see [Asynchronous message examples](~~2743997~~).'."\n" + ."\n" + .'> The IMM operation does not support a callback URL. We recommend that you use Simple Message Queue (SMQ) to receive notifications.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FFF****', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => 'PointCloudCompress-badda57d-a3ab-4e6d-938f-49b77ce****', + ], + 'EventId' => [ + 'description' => 'The event ID.'."\n", + 'type' => 'string', + 'example' => '0B7-1LR4Wcue1aBhk2xT85MfL*****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FFF****\\",\\n \\"TaskId\\": \\"PointCloudCompress-badda57d-a3ab-4e6d-938f-49b77ce****\\",\\n \\"EventId\\": \\"0B7-1LR4Wcue1aBhk2xT85MfL*****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateCompressPointCloudTask', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** Asynchronous processing does not guarantee timely task completion.'."\n" + ."\n" + .'* This operation supports only Point Cloud Data (PCD) files.'."\n" + ."\n" + .'* This operation is an asynchronous operation. After a task is executed, the task information is retained only for seven days and cannot be retrieved when the retention period elapses. You can call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation to query information about the task.`` If you specify [Notification](~~2743997~~), you can obtain information about the task based on notifications. >'."\n", + ], + 'DetectTextAnomaly' => [ + 'summary' => 'Detects whether specified text contains anomalies, such as pornography, advertisements, excessive junk content, politically sensitive content, and abuse.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '130698', + 'abilityTreeNodes' => [ + 'FEATUREimmUCA5MV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => 'The text to be detected. It can contain up to 10,000 characters (including punctuation marks). Only Chinese text can be detected.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'content', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '91AC8C98-0F36-49D2-8290-742E24DF*****', + ], + 'Suggestion' => [ + 'description' => 'Indicates whether the text contains anomalies. Valid values:'."\n" + ."\n" + .'* pass: the text does not contain anomalies.'."\n" + .'* block: the text contains anomalies.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'pass' => '', + 'block' => '', + ], + 'example' => 'pass', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"91AC8C98-0F36-49D2-8290-742E24DF*****\\",\\n \\"Suggestion\\": \\"pass\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'DetectTextAnomaly', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + ."\n" + .'> The text compliance detection feature only supports Chinese characters.'."\n", + ], + 'CreateImageModerationTask' => [ + 'summary' => 'Creates an image moderation task to ensure image content compliance. You can call this operation to identify inappropriate content, such as pornography, violence, terrorism, politically sensitive content, undesirable scenes, unauthorized logos, and non-compliant ads.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '130695', + 'abilityTreeNodes' => [ + 'FEATUREimmRIZXZT', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The user data, which is returned in an asynchronous notification and facilitates notification management. The maximum length of the user data is 2,048 bytes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URI of the Object Storage Service (OSS) bucket in which you store the image.'."\n" + ."\n" + .'Specify the value in the `oss://<Bucket>/<Object>` format. `<Bucket>` specifies the name of the OSS bucket that resides in the same region as the current project. `<Object>` specifies the complete path to the image file that has an extension.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-object', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The custom tags. You can search for or filter asynchronous tasks by custom tag.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{"test": "val1"}', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The authorization chain settings. For more information, see [Use authorization chains to access resources of other entities](~~465340~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Scenes', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The scenarios in which you want to apply the image moderation task.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The scenario in which you want to apply the image moderation task.'."\n" + ."\n" + .'* porn: detects pornography.'."\n" + .'* terrorism: detects terrorism or politically sensitive content.'."\n" + .'* live: detects undesirable scenes.'."\n" + .'* logo: detects unauthorized logos.'."\n" + .'* ad: detects non-compliant ads.'."\n" + ."\n" + .'> If you do not specify this parameter, `porn`, `terrorism`, and `ad` are automatically used.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ad' => '', + 'terrorism' => '', + 'logo' => '', + 'live' => '', + 'porn' => '', + ], + 'example' => 'porn', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time interval between two consecutive frames in a GIF or long image. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'MaxFrames', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of frames that can be captured in a GIF or long image. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The notification settings. For information about the asynchronous notification format, see [Asynchronous message examples](~~2743997~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => 'ImageModeration-179ef4f8-d583-4f0c-a293-7c0889c*****', + ], + 'EventId' => [ + 'description' => 'The event ID.'."\n", + 'type' => 'string', + 'example' => '2E6-1I0FGn0zFnl5AflRfhzClma*****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\",\\n \\"TaskId\\": \\"ImageModeration-179ef4f8-d583-4f0c-a293-7c0889c*****\\",\\n \\"EventId\\": \\"2E6-1I0FGn0zFnl5AflRfhzClma*****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateImageModerationTask', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** Asynchronous processing does not guarantee timely task completion.'."\n" + ."\n" + .'* The image for which you want to create a content moderation task must meet the following requirements:'."\n" + ."\n" + .' * The image URL uses the HTTP or HTTPS protocol.'."\n" + .' * The image is in one of the following formats: PNG, JPG, JPEG, BMP, GIF, and WebP'."\n" + .' * The image size is limited to 20 MB for synchronous and asynchronous calls, with a maximum height or width of 30,000 pixels. The total number of pixels in the image cannot exceed 250 million. GIF images are limited to 4,194,304 pixels, with a maximum height or width of 30,000 pixels.'."\n" + .' * The image download time is limited to 3 seconds. If the download takes longer, a timeout error occurs.'."\n" + .' * To ensure effective moderation, we recommend that you submit an image with dimensions of at least 256 × 256 pixels.'."\n" + .' * The response time of the CreateImageModerationTask operation varies based on the duration of the image download. Make sure that the image is stored in a stable and reliable service. We recommend that you store images on Alibaba Cloud Object Storage Service (OSS) or cache them on Alibaba Cloud CDN.'."\n" + ."\n" + .'* This operation is an asynchronous operation. After a task is executed, the task information is retained only for seven days and cannot be retrieved when the retention period elapses. You can call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation to query information about the task.`` If you specify [Notification](~~2743997~~), you can also obtain information about the task based on notifications.'."\n" + ."\n" + .'> The detection result is sent as an asynchronous notification. The Suggestion field of the notification can have one of the following values:'."\n" + ."\n" + .'* pass: No non-compliant content is found.'."\n" + ."\n" + .'* block: Non-compliant content is detected. The Categories field value indicates the non-compliance categories. For more information, see Content moderation results.'."\n" + ."\n" + .'* review: A manual review is needed. After the manual review is completed, an asynchronous notification is sent to inform you of the result. >'."\n", + ], + 'CreateVideoModerationTask' => [ + 'summary' => 'Detects risky or non-compliant content from videos. You can use this operation in scenarios such as intelligent pornography detection, terrorist content and political bias detection, ad violation detection, and logo detection.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '130694', + 'abilityTreeNodes' => [ + 'FEATUREimmO3TV2W', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom information, which is returned in an asynchronous notification and facilitates notification management. The maximum length of the value is 2,048 bytes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'The OSS URI of the video.'."\n" + ."\n" + .'Specify the OSS URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Object}` is the path of the object with the extension included.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-object', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The custom tags. The custom tags help you retrieve the task.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{"test": "val1"}', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The authorization chain settings. For more information, see [Use authorization chains to access resources of other entities](~~465340~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Scenes', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The scenarios of video moderation.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The video moderation scenario. Valid values:'."\n" + ."\n" + .'* porn: intelligent pornography detection.'."\n" + .'* terrorism: terrorist content and political bias detection.'."\n" + .'* live: undesirable scene detection.'."\n" + .'* logo: logo detection.'."\n" + .'* ad: ad violation detection.'."\n" + ."\n" + .'> If you do not specify a specific detection scenario, `porn`, `terrorism`, and `ad` are used.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ad' => '', + 'terrorism' => '', + 'logo' => '', + 'live' => '', + 'porn' => '', + ], + 'example' => 'porn', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => 'The interval of capturing video frames. Unit: seconds. Valid values: 1 to 600. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MaxFrames', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of frames that can be captured from the video. Valid values: 5 to 3600. Default value: 200.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The notification settings. For information about the asynchronous notification format, see [Asynchronous message examples](~~2743997~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => 'VideoModeration-9442a216-4691-4a48-846d-76daccaf*****', + ], + 'EventId' => [ + 'description' => 'The event ID.'."\n", + 'type' => 'string', + 'example' => '2E6-1I0FGn0zFnl5AflRfhzClma*****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\",\\n \\"TaskId\\": \\"VideoModeration-9442a216-4691-4a48-846d-76daccaf*****\\",\\n \\"EventId\\": \\"2E6-1I0FGn0zFnl5AflRfhzClma*****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateVideoModerationTask', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~88317~~) of Intelligent Media Management (IMM).****'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** Asynchronous processing does not guarantee timely task completion.'."\n" + ."\n" + .'* The detection result is sent as an asynchronous notification. The Suggestion parameter in asynchronous notifications supports the following values:'."\n" + ."\n" + .' * pass: No non-compliant content is found.'."\n" + .' * block: Non-compliant content is detected. The Categories field value indicates the non-compliance category. For more information, see [Content moderation results](~~2743995~~).'."\n" + .' * review: A manual review is needed. After the manual review is completed, an asynchronous notification is sent to inform you about the result.'."\n" + ."\n" + .'* The following video frame requirements apply:'."\n" + ."\n" + .' * The URLs for video frames must use HTTP or HTTPS.'."\n" + .' * Video frames must be in PNG, JPG, JPEG, BMP, GIF, or WebP format.'."\n" + .' * The size of a video frame cannot exceed 10 MB.'."\n" + .' * The resolution for video frames is not lower than 256 × 256 pixels. A frame resolution lower than this recommended resolution may affect detection accuracy.'."\n" + .' * The response time of the operation varies based on the amount of time required to download frames. Make sure that video frames to be detected are stored in a reliable and stable service. We recommend that you store video frames in OSS or cache video frames on Alibaba Cloud CDN.'."\n" + ."\n" + .'* This operation is an asynchronous operation. After a task is executed, the task information is retained only for seven days and cannot be retrieved when the retention period elapses. You can call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation to query information about the task.`` If you specify [Notification](~~2743997~~), you can obtain information about the task based on notifications. >'."\n", + ], + 'GetImageModerationResult' => [ + 'summary' => 'Queries an image compliance detection task.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '173754', + 'abilityTreeNodes' => [ + 'FEATUREimmRIZXZT', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'title' => 'TaskType', + 'description' => 'The type of the task.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ImageModeration', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => 'TaskId', + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ImageModeration-ff207203-3f93-4645-a041-7b8f0f******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片检测结果', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求唯一Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E6A120B1-BEB3-0F63-A7C2-0783B6******', + ], + 'ProjectName' => [ + 'title' => '项目名称', + 'description' => 'The name of the project.'."\n", + 'type' => 'string', + 'example' => 'test-project', + ], + 'EventId' => [ + 'title' => '事件Id', + 'description' => 'The event ID.'."\n", + 'type' => 'string', + 'example' => '1B6-1XBMX3BixLMILvXVGtlkr******', + ], + 'Status' => [ + 'title' => '任务运行状态', + 'description' => 'The task status. Valid values:'."\n" + ."\n" + .'* Running'."\n" + .'* Succeeded'."\n" + .'* Failed'."\n", + 'type' => 'string', + 'example' => 'Succeeded', + ], + 'Code' => [ + 'title' => '任务错误码', + 'description' => 'The error code of the task.'."\n", + 'type' => 'string', + 'example' => 'ResourceNotFound', + ], + 'Message' => [ + 'title' => '任务错误消息', + 'description' => 'The error message of the task.'."\n", + 'type' => 'string', + 'example' => 'The specified resource TaskId is not found.', + ], + 'StartTime' => [ + 'title' => '任务开始时间', + 'description' => 'The start time of the task.'."\n", + 'type' => 'string', + 'example' => '2023-04-03T09:44:31.029Z', + ], + 'EndTime' => [ + 'title' => '任务结束时间', + 'description' => 'The end time of the task.'."\n", + 'type' => 'string', + 'example' => '2023-04-03T09:44:32Z', + ], + 'UserData' => [ + 'title' => '用户自定义信息', + 'description' => 'The custom information.'."\n", + 'type' => 'string', + 'example' => '{'."\n" + .' "fileId": "123"'."\n" + .'}', + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => 'The type of the task.'."\n", + 'type' => 'string', + 'example' => 'ImageModeration', + ], + 'TaskId' => [ + 'title' => '任务唯一ID', + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => 'ImageModeration-ff207203-3f93-4645-a041-7b8f0f******', + ], + 'ModerationResult' => [ + 'description' => 'The result of the image compliance detection task.'."\n", + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => 'The OSS URI of the file. The URI follows the oss://${bucketname}/${objectname} format. bucketname indicates the name of an OSS bucket that is in the same region as the current project, and objectname is the file path.'."\n", + 'type' => 'string', + 'example' => 'oss://test-bucket/test-object', + ], + 'Suggestion' => [ + 'description' => 'The recommended operation. Valid values:'."\n" + ."\n" + .'* pass: The image has passed the check. No action is required.'."\n" + .'* review: The image contains suspected violations and requires human review.'."\n" + .'* block: The image contains violations. Further actions, such as deleting or blocking the image, are recommended.'."\n", + 'type' => 'string', + 'example' => 'block', + ], + 'Categories' => [ + 'description' => 'List of categories.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The category.'."\n", + 'type' => 'string', + 'example' => 'porn', + ], + ], + 'Frames' => [ + 'description' => 'The information about video and motion detection frames.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of detected frames.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'BlockFrames' => [ + 'description' => 'The violated frames.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about violated frames.'."\n", + 'type' => 'object', + 'properties' => [ + 'Rate' => [ + 'description' => 'The confidence level of the violation.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '30', + ], + 'Offset' => [ + 'description' => 'The offset of the frame.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Label' => [ + 'description' => 'The label of the violation.'."\n", + 'type' => 'string', + 'example' => '{'."\n" + .' "test": "val"'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 500 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6A120B1-BEB3-0F63-A7C2-0783B6******\\",\\n \\"ProjectName\\": \\"test-project\\",\\n \\"EventId\\": \\"1B6-1XBMX3BixLMILvXVGtlkr******\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"Code\\": \\"ResourceNotFound\\",\\n \\"Message\\": \\"The specified resource TaskId is not found.\\",\\n \\"StartTime\\": \\"2023-04-03T09:44:31.029Z\\",\\n \\"EndTime\\": \\"2023-04-03T09:44:32Z\\",\\n \\"UserData\\": \\"{\\\\n \\\\\\"fileId\\\\\\": \\\\\\"123\\\\\\"\\\\n}\\",\\n \\"TaskType\\": \\"ImageModeration\\",\\n \\"TaskId\\": \\"ImageModeration-ff207203-3f93-4645-a041-7b8f0f******\\",\\n \\"ModerationResult\\": {\\n \\"URI\\": \\"oss://test-bucket/test-object\\",\\n \\"Suggestion\\": \\"block\\",\\n \\"Categories\\": [\\n \\"porn\\"\\n ],\\n \\"Frames\\": {\\n \\"TotalCount\\": 30,\\n \\"BlockFrames\\": [\\n {\\n \\"Rate\\": 30,\\n \\"Offset\\": 2,\\n \\"Label\\": \\"{\\\\n \\\\\\"test\\\\\\": \\\\\\"val\\\\\\"\\\\n}\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => 'GetImageModerationResult', + ], + 'GetVideoModerationResult' => [ + 'summary' => 'Queries the result of a video moderation task.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '173750', + 'abilityTreeNodes' => [ + 'FEATUREimmO3TV2W', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The project name.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'title' => 'TaskType', + 'description' => 'The task type.', + 'type' => 'string', + 'required' => true, + 'example' => 'VideoModeration', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => 'TaskId', + 'description' => 'The task ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'VideoModeration-d0f0df1d-531d-4ab4-b353-e7f475******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片检测结果', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求唯一Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'VideoModeration-d0f0df1d-531d-4ab4-b353-e7f475******', + ], + 'ProjectName' => [ + 'title' => '项目名称', + 'description' => 'The project name.', + 'type' => 'string', + 'example' => 'test-project', + ], + 'EventId' => [ + 'title' => '事件Id', + 'description' => 'The event ID.', + 'type' => 'string', + 'example' => '05C-1XBQvsG2Tn5kBx2dUWo43******', + ], + 'Status' => [ + 'title' => '任务运行状态', + 'description' => 'The task status. Valid values:'."\n" + ."\n" + .'* Running: The task is running.'."\n" + .'* Succeeded: The task is successful.'."\n" + .'* Failed: The task failed.'."\n", + 'type' => 'string', + 'example' => 'Succeeded', + ], + 'Code' => [ + 'title' => '任务错误码', + 'description' => 'The error code of the task.'."\n", + 'type' => 'string', + 'example' => 'ResourceNotFound', + ], + 'Message' => [ + 'title' => '任务错误消息', + 'description' => 'The error message of the task.'."\n", + 'type' => 'string', + 'example' => 'The specified resource TaskId is not found.', + ], + 'StartTime' => [ + 'title' => '任务开始时间', + 'description' => 'The start time of the task.'."\n", + 'type' => 'string', + 'example' => '2023-04-03T10:20:41.432Z', + ], + 'EndTime' => [ + 'title' => '任务结束时间', + 'description' => 'The end time of the task.'."\n", + 'type' => 'string', + 'example' => '2023-04-03T10:20:56.87Z', + ], + 'UserData' => [ + 'title' => '用户自定义信息', + 'description' => 'The user-defined data.'."\n", + 'type' => 'string', + 'example' => '{'."\n" + .' "id": "test-id",'."\n" + .' "name": "test-name"'."\n" + .'}', + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => 'The type of the task.'."\n", + 'type' => 'string', + 'example' => 'VideoModeration', + ], + 'TaskId' => [ + 'title' => '任务唯一ID', + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => 'VideoModeration-d0f0df1d-531d-4ab4-b353-e7f4750******', + ], + 'ModerationResult' => [ + 'description' => 'The result of the image compliance detection task.'."\n", + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => 'The OSS URI of the file. The URI follows the oss://${bucketname}/${objectname} format. bucketname indicates the name of an OSS bucket that is in the same region as the current project, and objectname is the file path.'."\n", + 'type' => 'string', + 'example' => 'oss://test-bucket/test-object', + ], + 'Suggestion' => [ + 'description' => 'The recommended operation. Valid values:'."\n" + ."\n" + .'* pass: The image has passed the check. No action is required.'."\n" + .'* review: The image contains suspected violations and requires human review.'."\n" + .'* block: The image contains violations. Further actions, such as deleting or blocking the image, are recommended.'."\n", + 'type' => 'string', + 'example' => 'block', + ], + 'Categories' => [ + 'description' => 'The category list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The category information.', + 'type' => 'string', + 'example' => 'porn', + ], + ], + 'Frames' => [ + 'description' => 'The information about video and motion detection frames.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of detected frames.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'BlockFrames' => [ + 'description' => 'The information about violated frames.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about violated frames.'."\n", + 'type' => 'object', + 'properties' => [ + 'Rate' => [ + 'description' => 'The confidence level of the violation.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '10', + ], + 'Offset' => [ + 'description' => 'The offset of the frame.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Label' => [ + 'description' => 'The label of the violation.'."\n", + 'type' => 'string', + 'example' => '{"teat":"val"}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 500 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"VideoModeration-d0f0df1d-531d-4ab4-b353-e7f475******\\",\\n \\"ProjectName\\": \\"test-project\\",\\n \\"EventId\\": \\"05C-1XBQvsG2Tn5kBx2dUWo43******\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"Code\\": \\"ResourceNotFound\\",\\n \\"Message\\": \\"The specified resource TaskId is not found.\\",\\n \\"StartTime\\": \\"2023-04-03T10:20:41.432Z\\",\\n \\"EndTime\\": \\"2023-04-03T10:20:56.87Z\\",\\n \\"UserData\\": \\"{\\\\n \\\\\\"id\\\\\\": \\\\\\"test-id\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"test-name\\\\\\"\\\\n}\\",\\n \\"TaskType\\": \\"VideoModeration\\",\\n \\"TaskId\\": \\"VideoModeration-d0f0df1d-531d-4ab4-b353-e7f4750******\\",\\n \\"ModerationResult\\": {\\n \\"URI\\": \\"oss://test-bucket/test-object\\",\\n \\"Suggestion\\": \\"block\\",\\n \\"Categories\\": [\\n \\"porn\\"\\n ],\\n \\"Frames\\": {\\n \\"TotalCount\\": 12,\\n \\"BlockFrames\\": [\\n {\\n \\"Rate\\": 10,\\n \\"Offset\\": 1,\\n \\"Label\\": \\"{\\\\\\"teat\\\\\\":\\\\\\"val\\\\\\"}\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => 'GetVideoModerationResult', + ], + 'GetTask' => [ + 'summary' => 'Queries information about an asynchronous task. Intelligent Media Management (IMM) has multiple asynchronous data processing capabilities, each of which has its own operation for creating tasks. For example, you can call the CreateFigureClusteringTask operation to create a face clustering task and the CreateFileCompressionTask operation to create a file compression task. The GetTask operation is a general operation. You can call this operation to query information about asynchronous tasks by task ID or type.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '106466', + 'abilityTreeNodes' => [ + 'FEATUREimmTGV2Z7', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'title' => 'TaskType', + 'description' => 'The type of the task. For information about valid values, see [Task types](~~2743993~~).', + 'type' => 'string', + 'required' => true, + 'example' => 'VideoLabelClassification', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => 'TaskId', + 'description' => 'The ID of the task. You can obtain the ID of a task after you create the task.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'c2b277b9-0d30-4882-ad6d-ad661382****', + ], + ], + [ + 'name' => 'RequestDefinition', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return original request parameters specified to create the task.'."\n" + ."\n" + .'* true'."\n" + .'* false (default)'."\n" + ."\n" + .'This parameter applies only to the following tasks:'."\n" + ."\n" + .'* MediaConvert'."\n" + .'* VideoLabelClassification'."\n" + .'* FaceClustering'."\n" + .'* FileCompression'."\n" + .'* ArchiveFileInspection'."\n" + .'* FileUncompression'."\n" + .'* PointCloudCompress'."\n" + .'* ImageToPDF'."\n" + .'* StoryCreation'."\n" + .'* LocationDateClustering'."\n" + .'* ImageSplicing'."\n" + .'* FacesSearching'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片检测结果', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求唯一Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2C5C1E0F-D8B8-4DA0-8127-EC32C771****', + ], + 'ProjectName' => [ + 'title' => '项目名称', + 'description' => 'The project name.'."\n", + 'type' => 'string', + 'example' => 'immtest', + ], + 'EventId' => [ + 'title' => '事件Id', + 'description' => 'The event ID.'."\n", + 'type' => 'string', + 'example' => '2F6-1Bz99Xi93EnRpNEyLudILJm****', + ], + 'Status' => [ + 'title' => '任务运行状态', + 'description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'* RUNNING: The task is running.'."\n" + .'* Succeeded: The task is successful.'."\n" + .'* Failed: The task failed.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'Code' => [ + 'title' => '任务错误码', + 'description' => 'The error code of the task.'."\n", + 'type' => 'string', + 'example' => 'ResourceNotFound', + ], + 'Message' => [ + 'title' => '任务错误消息', + 'description' => 'The error message of the task.'."\n", + 'type' => 'string', + 'example' => 'The specified resource project is not found.', + ], + 'StartTime' => [ + 'title' => '任务开始时间', + 'description' => 'The start time of the task.'."\n", + 'type' => 'string', + 'example' => '2021-12-24T03:01:41.662060377Z', + ], + 'EndTime' => [ + 'title' => '任务结束时间', + 'description' => 'The end time of the task.'."\n", + 'type' => 'string', + 'example' => '2021-12-24T03:01:49.480109219Z', + ], + 'UserData' => [ + 'title' => '用户自定义信息', + 'description' => 'The user data of the task.'."\n", + 'type' => 'string', + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => 'The type of the task. For more information, see [Task types](~~2743993~~).', + 'type' => 'string', + 'example' => 'VideoLabelClassification', + ], + 'TaskId' => [ + 'title' => '任务唯一ID', + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => 'c2b277b9-0d30-4882-ad6d-ad661382****', + ], + 'Tags' => [ + 'description' => 'The tags. This parameter is returned only if you specified Tags when you created the task.'."\n", + 'type' => 'object', + 'example' => '{"test": "val1"}', + ], + 'TaskRequestDefinition' => [ + 'description' => 'The initial request parameters used to create the task.'."\n", + 'type' => 'string', + 'example' => '{'."\n" + .' "ProjectName":"test-project",'."\n" + .' "CompressedFormat":"zip",'."\n" + .' "TargetURI":"oss://test-bucket/output/test.zip",'."\n" + .' "Sources":[{"URI":"oss://test-bucket/input/test.jpg"}]'."\n" + .'}', + ], + 'Progress' => [ + 'description' => 'The task progress. Valid values: 0 to 100. Unit: %.'."\n" + ."\n" + .'> This parameter is valid only if the task is in the `Running` state.``'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2C5C1E0F-D8B8-4DA0-8127-EC32C771****\\",\\n \\"ProjectName\\": \\"test-project\\",\\n \\"EventId\\": \\"2F6-1Bz99Xi93EnRpNEyLudILJm****\\",\\n \\"Status\\": \\"Running\\",\\n \\"Code\\": \\"ResourceNotFound\\",\\n \\"Message\\": \\"The specified resource project is not found.\\",\\n \\"StartTime\\": \\"2021-12-24T03:01:41.662060377Z\\",\\n \\"EndTime\\": \\"2021-12-24T03:01:49.480109219Z\\",\\n \\"UserData\\": \\"{\\\\\\"ID\\\\\\": \\\\\\"user1\\\\\\",\\\\\\"Name\\\\\\": \\\\\\"test-user1\\\\\\",\\\\\\"Avatar\\\\\\": \\\\\\"http://example.com?id=user1\\\\\\"}\\",\\n \\"TaskType\\": \\"FileCompression\\",\\n \\"TaskId\\": \\"c2b277b9-0d30-4882-ad6d-ad661382****\\",\\n \\"Tags\\": {\\n \\"test\\": \\"val1\\"\\n },\\n \\"TaskRequestDefinition\\": \\"{\\\\n\\\\t\\\\\\"ProjectName\\\\\\":\\\\\\"test-project\\\\\\",\\\\n\\\\t\\\\\\"CompressedFormat\\\\\\":\\\\\\"zip\\\\\\",\\\\n\\\\t\\\\\\"TargetURI\\\\\\":\\\\\\"oss://test-bucket/output/test.zip\\\\\\",\\\\n\\\\t\\\\\\"Sources\\\\\\":[{\\\\\\"URI\\\\\\":\\\\\\"oss://test-bucket/input/test.jpg\\\\\\"}]\\\\n}\\",\\n \\"Progress\\": 100\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'GetTask', + 'description' => 'Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of IMM.'."\n", + ], + 'ListTasks' => [ + 'summary' => 'Lists tasks based on specific conditions, such as by time range and by tag.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '106467', + 'abilityTreeNodes' => [ + 'FEATUREimmTGV2Z7', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'TaskTypes', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The task types.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The task type. For more information, see [Task types](~~2743993~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["OfficeConversion","VideoLabelClassification"]', + ], + 'required' => false, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'NextToken', + 'description' => 'The pagination token.'."\n" + ."\n" + .'The pagination token is used in the next request to retrieve a new page of results if the total number of results exceeds the value of the MaxResults parameter. The next call to the operation returns results lexicographically after the NextToken parameter value.'."\n" + ."\n" + .'> Leave this parameter empty in your first call to the operation.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'title' => 'MaxResults', + 'description' => 'The maximum number of results to return. Valid value range: (0, 100]. Default value: 100.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TagSelector', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom tags of tasks.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test=val1', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The field used to sort the results by. Valid values:'."\n" + ."\n" + .'* TaskId: sorts the results by task ID. This is the default sort field.'."\n" + .'* StartTime: sorts the results by task start time.'."\n" + .'* StartTime: sorts the results by task end time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TaskId', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sort order. Valid values:'."\n" + ."\n" + .'* asc: in ascending order. This is the default value.'."\n" + .'* desc: in descending order.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => '', + 'desc' => '', + ], + 'example' => 'ASC', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task status. Valid values:'."\n" + ."\n" + .'* Running: The task is running.'."\n" + .'* Succeeded: The task is successful.'."\n" + .'* Failed: The task failed.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Succeeded' => '', + 'Failed' => '', + 'Running' => '', + ], + 'example' => 'Succeeded', + ], + ], + [ + 'name' => 'StartTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The task start time range. You can specify this parameter to filter tasks that start within the specified range.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/TimeRange', + ], + ], + [ + 'name' => 'EndTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The task end time range. You can specify this parameter to filter tasks that end within the specified range.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/TimeRange', + ], + ], + [ + 'name' => 'RequestDefinition', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return request parameters in the initial request to create the task. Default value: False.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片检测结果', + 'description' => 'The matched tasks.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求唯一Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9847E7D0-A9A3-0053-84C6-BA16FFFA726E', + ], + 'ProjectName' => [ + 'title' => '项目名称', + 'description' => 'The name of the project.'."\n", + 'type' => 'string', + 'example' => 'immtest', + ], + 'NextToken' => [ + 'title' => '翻页标记', + 'description' => 'The pagination token. The pagination token is used in the next request to retrieve a new page of results if the total number of results exceeds the value of the MaxResults parameter. This parameter has a value only when not all results are returned.'."\n" + ."\n" + .'You can specify the value of the NextToken parameter in the next request to list remaining results.'."\n", + 'type' => 'string', + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', + ], + 'MaxResults' => [ + 'title' => '最大结果数量', + 'description' => 'The length of the returned result list.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Tasks' => [ + 'title' => '任务信息', + 'description' => 'The tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the task.'."\n", + '$ref' => '#/components/schemas/TaskInfo', + ], + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9847E7D0-A9A3-0053-84C6-BA16FFFA726E\\",\\n \\"ProjectName\\": \\"immtest\\",\\n \\"NextToken\\": \\"MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==\\",\\n \\"MaxResults\\": \\"1\\",\\n \\"Tasks\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"UserData\\": \\"\\",\\n \\"TaskType\\": \\"\\",\\n \\"TaskId\\": \\"\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"TaskRequestDefinition\\": \\"\\",\\n \\"Progress\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'ListTasks', + 'description' => 'Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).'."\n", + ], + 'CreateTrigger' => [ + 'summary' => 'Creates a trigger. A trigger can trigger Intelligent Media Management (IMM) based on events such as events in Object Storage Service (OSS) to process files, such as images, videos, and documents based on data processing templates.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '135761', + 'abilityTreeNodes' => [ + 'FEATUREimmJ1ILHI', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Input', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The data source configurations.'."\n", + 'required' => true, + '$ref' => '#/components/schemas/Input', + ], + ], + [ + 'name' => 'Actions', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The templates.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The template.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the template.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'doc/convert', + ], + 'Parameters' => [ + 'description' => 'The template parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The template parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pages=3', + ], + 'required' => false, + ], + 'FastFailPolicy' => [ + 'description' => 'The policy configurations for handling failures.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/FastFailPolicy', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Notification', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The notification settings. The operation supports multiple messaging middleware options. For more information about notification messages, see Asynchronous message examples. You can use one of the following methods to receive notification messages:'."\n" + ."\n" + .'In the region in which the IMM project is located, use EventBridge to receive task notifications. For more information, see IMM events. In the region in which the IMM project is located, configure a Simple Message Queue (SMQ) subscription to receive task notifications.'."\n", + 'type' => 'object', + 'properties' => [ + 'MNS' => [ + 'description' => 'The SMQ notification settings.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/MNS', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The custom tags. You can search for or filter asynchronous tasks by custom tag.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{"key":"val"}', + ], + ], + [ + 'name' => 'ServiceRole', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The service role. IMM assumes the service role so that it can access resources in other cloud services, such as OSS. Default value: AliyunIMMBatchTriggerRole.'."\n" + ."\n" + .'You can also create a custom service role in the RAM console and grant the required permissions to the role based on your business requirements. For more information, see [Create a regular service role](~~116800~~) and [Grant permissions to a role](~~116147~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'AliyunIMMDefaultRole', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'EC564A9A-BA5C-4499-A087-D9B9E76E*****', + ], + 'Id' => [ + 'description' => 'The ID of the trigger.'."\n", + 'type' => 'string', + 'example' => 'trigger-9f72636a-0f0c-4baf-ae78-38b27b******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EC564A9A-BA5C-4499-A087-D9B9E76E*****\\",\\n \\"Id\\": \\"trigger-9f72636a-0f0c-4baf-ae78-38b27b******\\"\\n}","type":"json"}]', + 'title' => 'CreateTrigger', + 'description' => 'If you want to create a trigger to process data in [OSS](~~99372~~), make sure that you have bound the dataset to the OSS bucket where the data is stored. For more information about how to bind a dataset to a bucket, see [AttachOSSBucket](~~478206~~).'."\n", + ], + 'SuspendTrigger' => [ + 'summary' => 'Suspends a running trigger.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '135764', + 'abilityTreeNodes' => [ + 'FEATUREimmJ1ILHI', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the trigger.[](~~479912~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'trigger-9f72636a-0f0c-4baf-ae78-38b27b******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0BC1F0C9-8E99-46C6-B502-10DED******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0BC1F0C9-8E99-46C6-B502-10DED******\\"\\n}","type":"json"}]', + 'title' => 'SuspendTrigger', + 'description' => 'The operation can be used to suspend a trigger only in the Running state. If you want to resume a suspended trigger, call the [ResumeTrigger](~~479919~~) operation.'."\n", + ], + 'ResumeTrigger' => [ + 'summary' => 'Resumes a trigger that is in the Suspended or Failed state.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '135767', + 'abilityTreeNodes' => [ + 'FEATUREimmJ1ILHI', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the trigger. You can obtain the ID from the response of the [CreateTrigger](~~479912~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'trigger-9f72636a-0f0c-4baf-ae78-38b27b******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'FEDC9B1F-30F2-4C1F-8ED2-B7860187****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FEDC9B1F-30F2-4C1F-8ED2-B7860187****\\"\\n}","type":"json"}]', + 'title' => 'ResumeTrigger', + 'description' => 'You can resume only a trigger that is in the Suspended or Failed state. After you resume a trigger, the trigger continues to provide services as expected.'."\n", + ], + 'UpdateTrigger' => [ + 'summary' => 'Updates information about a trigger, such as the input data source, data processing settings, and tags.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '135765', + 'abilityTreeNodes' => [ + 'FEATUREimmJ1ILHI', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the trigger. You can obtain the ID of the trigger from the response of the [CreateTrigger](~~479912~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'trigger-9f72636a-0f0c-4baf-ae78-38b27b******', + ], + ], + [ + 'name' => 'Input', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The data source configurations.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Input', + ], + ], + [ + 'name' => 'Actions', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The processing templates.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The processing template.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The template name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'doc/convert', + ], + 'Parameters' => [ + 'description' => 'The template parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The template parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pages=3', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The custom tags. You can search for or filter asynchronous tasks by custom tag.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{"test": "val1"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A022F78-B9A8-4ACC-BB6B-B35975******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A022F78-B9A8-4ACC-BB6B-B35975******\\"\\n}","type":"json"}]', + 'title' => 'UpdateTrigger', + 'description' => '* You can update only a trigger that is in the Ready or Failed state. The update operation does not change the trigger status.'."\n" + .'* After you update a trigger, the uncompleted tasks under the original trigger are no longer executed. You can call the [ResumeTrigger](~~479916~~) operation to resume the execution of the trigger.'."\n", + ], + 'GetTrigger' => [ + 'summary' => 'Queries the information about a trigger.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '135766', + 'abilityTreeNodes' => [ + 'FEATUREimmJ1ILHI', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The ID of the trigger. You can obtain the ID from the response parameters of the [CreateTrigger](~~479912~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'trigger-9f72636a-0f0c-4baf-ae78-38b27b******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'Trigger' => [ + 'description' => 'The trigger information.'."\n", + '$ref' => '#/components/schemas/DataIngestion', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4A7A2D0E-D8B8-4DA0-8127-EB32C6******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Trigger\\": {\\n \\"Id\\": \\"\\",\\n \\"Input\\": {\\n \\"OSS\\": {\\n \\"Bucket\\": \\"\\",\\n \\"Prefix\\": \\"\\",\\n \\"MatchExpressions\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Actions\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": [\\n \\"\\"\\n ],\\n \\"FastFailPolicy\\": {\\n \\"Action\\": \\"abort\\"\\n }\\n }\\n ],\\n \\"Notification\\": {\\n \\"Endpoint\\": \\"\\",\\n \\"Topic\\": \\"\\",\\n \\"MNS\\": {\\n \\"TopicName\\": \\"\\",\\n \\"Endpoint\\": \\"\\"\\n },\\n \\"RocketMQ\\": {\\n \\"Endpoint\\": \\"\\",\\n \\"TopicName\\": \\"\\",\\n \\"InstanceId\\": \\"\\"\\n }\\n },\\n \\"Statistic\\": {\\n \\"SubmitSuccess\\": 0,\\n \\"SubmitFailure\\": 0,\\n \\"SkipFiles\\": 0\\n },\\n \\"State\\": \\"\\",\\n \\"Marker\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Error\\": \\"\\",\\n \\"Phase\\": \\"IncrementalScanning\\",\\n \\"ServiceRole\\": \\"AliyunIMMBatchTriggerRole\\"\\n },\\n \\"RequestId\\": \\"4A7A2D0E-D8B8-4DA0-8127-EB32C6******\\"\\n}","type":"json"}]', + 'title' => 'GetTrigger', + ], + 'ListTriggers' => [ + 'summary' => 'Queries triggers by tag or status.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '135763', + 'abilityTreeNodes' => [ + 'FEATUREimmJ1ILHI', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the trigger. Valid values:'."\n" + ."\n" + .'* Ready: The trigger is ready.'."\n" + .'* Running: The trigger is running.'."\n" + .'* Failed: The trigger failed and cannot be automatically recovered.'."\n" + .'* Suspended: The trigger is suspended.'."\n" + .'* Succeeded: The trigger is complete.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Succeeded', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sort field. Valid values:'."\n" + ."\n" + .'* CreateTime: the point in time when the trigger is created.'."\n" + .'* UpdateTime: the most recent point in time when the trigger is updated.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-11-11T06:51:17.5Z'."\n", + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sort order. Default value: DESC.'."\n" + ."\n" + .'* ASC (default): ascending order.'."\n" + .'* DESC: descending order.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ASC', + ], + ], + [ + 'name' => 'TagSelector', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom tag. You can specify this parameter only if you specified Tags when you called the CreateTrigger operation.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test=val1', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n" + ."\n" + .'If the total number of triggers is greater than the value of MaxResults, you must specify NextToken.'."\n" + ."\n" + .'You do not need to specify this parameter for the first request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return. Valid values: 0 to 100.'."\n" + ."\n" + .'Default value: 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'Triggers' => [ + 'description' => 'The triggers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The trigger.'."\n", + '$ref' => '#/components/schemas/DataIngestion', + ], + ], + 'NextToken' => [ + 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n" + ."\n" + .'If NextToken is empty, no next page exists.'."\n", + 'type' => 'string', + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F480BFAF-E778-5079-93AD-1E4631******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Triggers\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Input\\": {\\n \\"OSS\\": {\\n \\"Bucket\\": \\"\\",\\n \\"Prefix\\": \\"\\",\\n \\"MatchExpressions\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Actions\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": [\\n \\"\\"\\n ],\\n \\"FastFailPolicy\\": {\\n \\"Action\\": \\"abort\\"\\n }\\n }\\n ],\\n \\"Notification\\": {\\n \\"Endpoint\\": \\"\\",\\n \\"Topic\\": \\"\\",\\n \\"MNS\\": {\\n \\"TopicName\\": \\"\\",\\n \\"Endpoint\\": \\"\\"\\n },\\n \\"RocketMQ\\": {\\n \\"Endpoint\\": \\"\\",\\n \\"TopicName\\": \\"\\",\\n \\"InstanceId\\": \\"\\"\\n }\\n },\\n \\"Statistic\\": {\\n \\"SubmitSuccess\\": 0,\\n \\"SubmitFailure\\": 0,\\n \\"SkipFiles\\": 0\\n },\\n \\"State\\": \\"\\",\\n \\"Marker\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Error\\": \\"\\",\\n \\"Phase\\": \\"IncrementalScanning\\",\\n \\"ServiceRole\\": \\"AliyunIMMBatchTriggerRole\\"\\n }\\n ],\\n \\"NextToken\\": \\"MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==\\",\\n \\"RequestId\\": \\"F480BFAF-E778-5079-93AD-1E4631******\\"\\n}","type":"json"}]', + 'title' => 'ListTriggers', + ], + 'DeleteTrigger' => [ + 'summary' => 'Deletes a trigger.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '135762', + 'abilityTreeNodes' => [ + 'FEATUREimmJ1ILHI', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The ID of the trigger. You can obtain the ID of the trigger from the response of the [CreateTrigger](~~479912~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'trigger-9f72636a-0f0c-4baf-ae78-38b27b******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'FEDC9B1F-30F2-4C1F-8ED2-B7860187****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FEDC9B1F-30F2-4C1F-8ED2-B7860187****\\"\\n}","type":"json"}]', + 'title' => 'DeleteTrigger', + 'description' => 'You can delete a trigger only if the trigger is in one of the following states: Ready, Failed, Suspended, and Succeeded. You cannot delete a trigger that is in the Running state.'."\n", + ], + 'CreateBatch' => [ + 'summary' => 'Creates a batch processing task to perform a data processing operation, such as transcoding or format conversion, on multiple existing files at a time.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '131090', + 'abilityTreeNodes' => [ + 'FEATUREimmTATRRB', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Input', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The data source configurations.'."\n", + 'required' => true, + '$ref' => '#/components/schemas/Input', + ], + ], + [ + 'name' => 'Actions', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The templates.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The template.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the template.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'doc/convert', + ], + 'Parameters' => [ + 'description' => 'The template parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The template parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pages=3', + ], + 'required' => false, + ], + 'FastFailPolicy' => [ + 'description' => 'The policy configurations for handling failures.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/FastFailPolicy', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Notification', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The notification settings. The operation supports multiple messaging middleware options. For more information about notification messages, see Asynchronous message examples. You can use one of the following methods to receive notification messages:'."\n" + ."\n" + .'In the region in which the IMM project is located, use EventBridge to receive task notifications. For more information, see IMM events. In the region in which the IMM project is located, configure a Simple Message Queue (SMQ) subscription to receive task notifications.'."\n", + 'type' => 'object', + 'properties' => [ + 'MNS' => [ + 'description' => 'The SMQ notification settings.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/MNS', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The custom tags. You can search for or filter asynchronous tasks by custom tag.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{"key": "val"}'."\n", + ], + ], + [ + 'name' => 'ServiceRole', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The service role. IMM assumes the service role so that it can access resources in other cloud services, such as OSS. Default value: AliyunIMMBatchTriggerRole.'."\n" + ."\n" + .'You can also create a custom service role in the RAM console and grant the required permissions to the role based on your business requirements. For more information, see [Create a regular service role](~~116800~~) and [Grant permissions to a role](~~116147~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'AliyunIMMDefaultRole', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'EC564A9A-BA5C-4499-A087-D9B9E76E*****', + ], + 'Id' => [ + 'description' => 'The ID of the batch processing task.'."\n", + 'type' => 'string', + 'example' => 'batch-4eb9223f-3e88-42d3-a578-3f2852******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EC564A9A-BA5C-4499-A087-D9B9E76E*****\\",\\n \\"Id\\": \\"batch-4eb9223f-3e88-42d3-a578-3f2852******\\"\\n}","type":"json"}]', + 'title' => 'CreateBatch', + 'description' => 'If you want to create a batch processing task to process data in [OSS](~~99372~~), make sure that you have bound the dataset to the OSS bucket where the data is stored. For more information about how to bind a dataset to a bucket, see [AttachOSSBucket](~~478206~~).'."\n", + ], + 'SuspendBatch' => [ + 'summary' => 'Suspends a batch processing task.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '131169', + 'abilityTreeNodes' => [ + 'FEATUREimmTATRRB', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the batch processing task. You can obtain the ID of the batch processing task from the response of the [CreateBatch](~~606694~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'batch-4eb9223f-3e88-42d3-a578-3f2852******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'EC564A9A-BA5C-4499-A087-D9B9E76E*****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EC564A9A-BA5C-4499-A087-D9B9E76E*****\\"\\n}","type":"json"}]', + 'title' => 'SuspendBatch', + 'description' => 'You can suspend a batch processing task that is in the Running state. You can call the [ResumeBatch](~~479914~~) operation to resume a batch processing task that is suspended.'."\n", + ], + 'ResumeBatch' => [ + 'summary' => 'Resumes a batch processing task that is in the Suspended or Failed state.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '131172', + 'abilityTreeNodes' => [ + 'FEATUREimmTATRRB', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the batch processing task. You can obtain the ID of the batch processing task from the response of the [CreateBatch](~~606694~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'batch-4eb9223f-3e88-42d3-a578-3f2852******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D2C628B8-35DF-473C-8A41-757F30******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D2C628B8-35DF-473C-8A41-757F30******\\"\\n}","type":"json"}]', + 'title' => 'ResumeBatch', + 'description' => 'You can resume a batch processing task only when the task is in the Suspended or Failed state. A batch processing task continues to provide services after you resume the task.'."\n", + ], + 'UpdateBatch' => [ + 'summary' => 'Updates information about a batch processing task, including the input data source, data processing settings, and tags.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '131143', + 'abilityTreeNodes' => [ + 'FEATUREimmTATRRB', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the batch processing task. You can obtain the ID of the batch processing task from the response of the [CreateBatch](~~606694~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'batch-4eb9223f-3e88-42d3-a578-3f2852******', + ], + ], + [ + 'name' => 'Input', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The input data source.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Input', + ], + ], + [ + 'name' => 'Actions', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The processing templates.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The processing template.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'doc/convert', + ], + 'Parameters' => [ + 'description' => 'The template parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The template parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pages=3', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The custom tags. You can search for or filter asynchronous tasks by custom tag.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{"key":"val"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CB4D73A3-BAF4-4A9D-A631-15F219AF****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB4D73A3-BAF4-4A9D-A631-15F219AF****\\"\\n}","type":"json"}]', + 'title' => 'UpdateBatch', + 'description' => '* You can update only a batch processing task that is in the Ready or Failed state. The update operation does not change the status of the batch processing task.'."\n" + .'* If you update a batch processing task that is in progress, the task is not automatically resumed after the update is complete. You must call the [ResumeBatch](~~479914~~) operation to resume the task.'."\n", + ], + 'ListBatches' => [ + 'summary' => 'Queries batch processing tasks. You can query batch processing tasks based on conditions such task tags and status. The results can be sorted.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '131116', + 'abilityTreeNodes' => [ + 'FEATUREimmTATRRB', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project.[](~~478153~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task status.'."\n" + ."\n" + .'* Ready: The task is newly created and ready.'."\n" + .'* Running: The task is running.'."\n" + .'* Failed: The task failed and cannot be automatically recovered.'."\n" + .'* Suspended: The task is suspended.'."\n" + .'* Succeeded: The task is successful.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Succeed', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sort field. Valid values:'."\n" + ."\n" + .'* CreateTime'."\n" + .'* UpdateTime'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-11-11T06:51:17.5Z', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sort order. Valid values:'."\n" + ."\n" + .'* ASC: sorts the results in ascending order. This is the default sort order.'."\n" + .'* DES: sorts the results in descending order.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ASC', + ], + ], + [ + 'name' => 'TagSelector', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom tag. You can use this parameter to query tasks that have the specified tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test=val1', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token.'."\n" + ."\n" + .'The pagination token is used in the next request to retrieve a new page of results if the total number of results exceeds the value of the MaxResults parameter. The next call to the operation returns results lexicographically after the NextToken parameter value.'."\n" + ."\n" + .'You do not need to specify this parameter in your initial request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of results to return. Valid values: 0 to 100.'."\n" + ."\n" + .'If you do not specify this parameter or set the parameter to 0, the default value of 100 is used.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'Batches' => [ + 'description' => 'The batch processing tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the batch processing task.'."\n", + '$ref' => '#/components/schemas/DataIngestion', + ], + ], + 'NextToken' => [ + 'description' => 'The pagination token.'."\n" + ."\n" + .'The pagination token is used in the next request to retrieve a new page of results if the total number of results exceeds the value of the MaxResults parameter. The next call to the operation returns results lexicographically after the NextToken parameter value.'."\n", + 'type' => 'string', + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'FEDC9B1F-30F2-4C1F-8ED2-B7860187****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Batches\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Input\\": {\\n \\"OSS\\": {\\n \\"Bucket\\": \\"\\",\\n \\"Prefix\\": \\"\\",\\n \\"MatchExpressions\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Actions\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": [\\n \\"\\"\\n ],\\n \\"FastFailPolicy\\": {\\n \\"Action\\": \\"abort\\"\\n }\\n }\\n ],\\n \\"Notification\\": {\\n \\"Endpoint\\": \\"\\",\\n \\"Topic\\": \\"\\",\\n \\"MNS\\": {\\n \\"TopicName\\": \\"\\",\\n \\"Endpoint\\": \\"\\"\\n },\\n \\"RocketMQ\\": {\\n \\"Endpoint\\": \\"\\",\\n \\"TopicName\\": \\"\\",\\n \\"InstanceId\\": \\"\\"\\n }\\n },\\n \\"Statistic\\": {\\n \\"SubmitSuccess\\": 0,\\n \\"SubmitFailure\\": 0,\\n \\"SkipFiles\\": 0\\n },\\n \\"State\\": \\"\\",\\n \\"Marker\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Error\\": \\"\\",\\n \\"Phase\\": \\"IncrementalScanning\\",\\n \\"ServiceRole\\": \\"AliyunIMMBatchTriggerRole\\"\\n }\\n ],\\n \\"NextToken\\": \\"MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****\\",\\n \\"RequestId\\": \\"FEDC9B1F-30F2-4C1F-8ED2-B7860187****\\"\\n}","type":"json"}]', + 'title' => 'ListBatches', + ], + 'GetBatch' => [ + 'summary' => 'Queries the information about a batch processing task.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '131105', + 'abilityTreeNodes' => [ + 'FEATUREimmTATRRB', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The ID of the batch processing task. For more information about how to obtain the ID, see [CreateBatch](~~606694~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'batch-4eb9223f-3e88-42d3-a578-3f2852******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'Batch' => [ + 'description' => 'The information about the batch processing task.'."\n", + '$ref' => '#/components/schemas/DataIngestion', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Batch\\": {\\n \\"Id\\": \\"\\",\\n \\"Input\\": {\\n \\"OSS\\": {\\n \\"Bucket\\": \\"\\",\\n \\"Prefix\\": \\"\\",\\n \\"MatchExpressions\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Actions\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": [\\n \\"\\"\\n ],\\n \\"FastFailPolicy\\": {\\n \\"Action\\": \\"abort\\"\\n }\\n }\\n ],\\n \\"Notification\\": {\\n \\"Endpoint\\": \\"\\",\\n \\"Topic\\": \\"\\",\\n \\"MNS\\": {\\n \\"TopicName\\": \\"\\",\\n \\"Endpoint\\": \\"\\"\\n },\\n \\"RocketMQ\\": {\\n \\"Endpoint\\": \\"\\",\\n \\"TopicName\\": \\"\\",\\n \\"InstanceId\\": \\"\\"\\n }\\n },\\n \\"Statistic\\": {\\n \\"SubmitSuccess\\": 0,\\n \\"SubmitFailure\\": 0,\\n \\"SkipFiles\\": 0\\n },\\n \\"State\\": \\"\\",\\n \\"Marker\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Error\\": \\"\\",\\n \\"Phase\\": \\"IncrementalScanning\\",\\n \\"ServiceRole\\": \\"AliyunIMMBatchTriggerRole\\"\\n },\\n \\"RequestId\\": \\"6E93D6C9-5AC0-49F9-914D-E02678D3****\\"\\n}","type":"json"}]', + 'title' => 'GetBatch', + ], + 'DeleteBatch' => [ + 'summary' => 'Deletes a batch processing task.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '131141', + 'abilityTreeNodes' => [ + 'FEATUREimmTATRRB', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The ID of the batch processing task.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'batch-4eb9223f-3e88-42d3-a578-3f2852******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '91AC8C98-0F36-49D2-8290-742E24******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"91AC8C98-0F36-49D2-8290-742E24******\\"\\n}","type":"json"}]', + 'title' => 'DeleteBatch', + 'description' => '* You can delete only a batch processing task that is in one of the following states: Ready, Failed, Suspended, and Succeeded.'."\n" + .'* Before you delete a batch processing task, you can call the [GetBatch](~~479922~~) operation to query the task status. This ensures a successful deletion.'."\n", + ], + 'ListAttachedOSSBuckets' => [ + 'summary' => 'List bound attachments', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '185053', + 'abilityTreeNodes' => [ + 'FEATUREimmKH590Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => 'Project name, for more information on how to obtain it, see [Create Project](~~478153~~).', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of tasks in the returned result list. The value range is (0, 200], with a default value of 100.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'Pagination token.'."\n" + ."\n" + .'When the total number of files exceeds the set MaxResults, this token is used for pagination. It returns the list of file information in lexicographical order starting from NextToken.'."\n" + ."\n" + .'> When calling this interface for the first time in a single query, set this value to empty.', + 'type' => 'string', + 'required' => false, + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => 'Response structure.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '9847E7D0-A9A3-0053-84C6-BA16FF******', + ], + 'NextToken' => [ + 'description' => 'Pagination token. When the total number of tasks in the list exceeds the set MaxResults, this token is used for pagination. This parameter has a value only when not all matching task lists are returned.'."\n" + ."\n" + .'Use this value as NextToken in the next call to return the subsequent task list.', + 'type' => 'string', + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', + ], + 'AttachedOSSBuckets' => [ + 'description' => 'List of bound OSS Buckets.', + 'type' => 'array', + 'items' => [ + 'description' => 'Binding relationship information.', + 'type' => 'object', + 'properties' => [ + 'OwnerId' => [ + 'description' => 'User ID.', + 'type' => 'string', + 'example' => '1023***********', + ], + 'ProjectName' => [ + 'description' => 'Project name.', + 'type' => 'string', + 'example' => 'test-project', + ], + 'OSSBucket' => [ + 'description' => 'OSS Bucket name.', + 'type' => 'string', + 'example' => 'test-bucket', + ], + 'CreateTime' => [ + 'description' => 'Timestamp of the project creation time, formatted as RFC3339Nano.', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + ], + 'UpdateTime' => [ + 'description' => 'Timestamp of the project modification time, formatted as RFC3339Nano.', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + ], + 'Description' => [ + 'description' => 'Description', + 'type' => 'string', + 'example' => 'test bucket', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9847E7D0-A9A3-0053-84C6-BA16FF******\\",\\n \\"NextToken\\": \\"MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==\\",\\n \\"AttachedOSSBuckets\\": [\\n {\\n \\"OwnerId\\": \\"1023***********\\",\\n \\"ProjectName\\": \\"test-project\\",\\n \\"OSSBucket\\": \\"test-bucket\\",\\n \\"CreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"UpdateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"Description\\": \\"test bucket\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'List OSS Bucket Binding Relationships', + 'description' => '- **Please ensure that you fully understand the billing method and [pricing](~~88317~~) of the Intelligent Media Management product before using this interface.**'."\n" + .'- Ensure that you have called [Bind Object Storage Bucket](～～478206～～) to bind the OSS Bucket to the project.', + 'translator' => 'machine', + ], + 'ContextualAnswer' => [ + 'summary' => 'Phase II of AI Assistant, Q\\\\\\&A API', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'sse', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226491', + 'abilityTreeNodes' => [ + 'FEATUREimmDN11M0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'Project name. For how to obtain it, see [Creating a Project](https://help.aliyun.com/zh/imm/getting-started/create-a-project-1?spm=a2c4g.11186623.help-menu-search-62354.d_0).', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project'."\n", + ], + ], + [ + 'name' => 'Messages', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'Yes, the history of conversations and tool invocations. The latest message is at the end (index n-1), and the oldest message is at the beginning (index 0).'."\n" + .'It must be in the form of user-assistant pairs, with a total count of 2*n+1, and the length of the latest question should not exceed 1000 characters.'."\n" + .'The length of the historical conversation is limited to 100.', + 'type' => 'array', + 'items' => [ + 'description' => 'List of conversation messages', + 'required' => false, + '$ref' => '#/components/schemas/ContextualMessage', + ], + 'required' => true, + ], + ], + [ + 'name' => 'Files', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The content of the files involved in the current Q&A. It is recommended to use the return value of the ContextualRetrieval interface as input.', + 'type' => 'array', + 'items' => [ + 'description' => 'List of files involved in the Q&A', + 'required' => false, + '$ref' => '#/components/schemas/ContextualFile', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Request ID of the current request.', + 'type' => 'string', + 'example' => '22F081FB-90D7-525A-BFE4-D28DC906A28F', + ], + 'Answer' => [ + 'description' => 'Content of the response from the large model.', + '$ref' => '#/components/schemas/Answer', + ], + 'Code' => [ + 'description' => 'Error code.', + 'type' => 'string', + 'example' => 'ResourceNotFound', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => 'The specified resource project is not found.', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22F081FB-90D7-525A-BFE4-D28DC906A28F\\",\\n \\"Answer\\": {\\n \\"Content\\": \\"你好\\",\\n \\"References\\": [\\n {\\n \\"ProjectName\\": \\"test-project\\",\\n \\"DatasetName\\": \\"test-dataset\\",\\n \\"ObjectId\\": \\"75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7\\",\\n \\"URI\\": \\"oss://test-bucket/test-object.jpg\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"ResourceNotFound\\",\\n \\"Message\\": \\"The specified resource project is not found.\\"\\n}","type":"json"}]', + 'title' => 'ContextualAnswer', + 'description' => '### Precautions'."\n" + ."\n" + .'- Before using this interface, please make sure you fully understand the billing method and [pricing](https://help.aliyun.com/zh/imm/product-overview/billable-items?spm=openapi-amp.newDocPublishment.0.0.1ecd281fi27Zgk) of the Intelligent Media Management product.'."\n" + ."\n" + .'- Before calling this interface, ensure that you have indexed the files into the dataset (Dataset) through binding ([CreateBinding](https://help.aliyun.com/zh/imm/developer-reference/api-imm-2020-09-30-createbinding?spm=a2c4g.11186623.0.0.a3d76f44xJrOnF)) or active indexing ([IndexFileMeta](https://help.aliyun.com/zh/imm/developer-reference/api-imm-2020-09-30-indexfilemeta?spm=a2c4g.11186623.help-menu-search-62354.d_0) or [BatchIndexFileMeta](https://help.aliyun.com/zh/imm/developer-reference/api-imm-2020-09-30-batchindexfilemeta?spm=a2c4g.11186623.help-menu-62354.d_5_2_4_2_1_1.f1d86f44iBs3QZ)).'."\n" + ."\n" + .'- The returned result is only an example. Depending on the [workflow template configuration](https://help.aliyun.com/zh/imm/user-guide/workflow-templates-and-operators?spm=a2c4g.11186623.0.0.a3d775abr3hDFp), the categories and content of the file metadata information obtained may differ from the example. If you have any questions, please join the DingTalk group by searching for the group number 21714099 in DingTalk.'."\n" + ."\n" + .'### Usage Restrictions'."\n" + ."\n" + .'- The maximum length of the historical conversation is 100, including both user and assistant messages.'."\n" + ."\n" + .'- Each message should not exceed 1000 Chinese characters.', + 'translator' => 'machine', + ], + 'ContextualRetrieval' => [ + 'summary' => 'Retrieves semantically similar documents. The operation is designed for multi-turn conversations and can process message input in historical conversations. The operation returns results that are highly related to the current conversation based on an in-depth understanding of contextual content. It provides consistent and efficient information retrieval in multi-turn conversations.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226437', + 'abilityTreeNodes' => [ + 'FEATUREimmDN11M0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The name of the project. For more information, see [CreateProject](https://help.aliyun.com/zh/imm/getting-started/create-a-project-1?spm=a2c4g.11186623.help-menu-search-62354.d\\_0).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dataset.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'Messages', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The conversation or tool invocation history. The latest message is at the end of the list (with an index number of n-1), whereas the earliest message is at the beginning of the list (with an index number of 0). Historical messages must be provided in user-assistant pairs. The maximum number of messages that you can specify is 2\\*n+1. The current question cannot exceed 1,000 characters in length. The maximum number of historical messages allowed is 100.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The message list.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/ContextualMessage', + ], + 'required' => true, + ], + ], + [ + 'name' => 'RecallOnly', + 'in' => 'query', + 'schema' => [ + 'description' => 'Indicates whether to enable recall-only (embedding-based search). If you set this parameter to true, returned results have not been re-ranked and can be ranked in custom order. Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'SmartClusterIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The IDs of clusters from which results are retrieved.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SmartCluster-01686226-be59-4391-a1ac-b7b073455de3', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****', + ], + 'Results' => [ + 'description' => 'The list of files retrieved. The document structure and content are contained in File.Elements.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The file.'."\n", + '$ref' => '#/components/schemas/File', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6E93D6C9-5AC0-49F9-914D-E02678D3****\\",\\n \\"Results\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ContextualRetrieval', + 'description' => '### [](#)Usage notes'."\n" + ."\n" + .'* Before you call this operation, make sure that you are familiar with the [billing](https://help.aliyun.com/zh/imm/product-overview/billable-items?spm=openapi-amp.newDocPublishment.0.0.1ecd281fi27Zgk) of Intelligent Media Management (IMM).'."\n" + .'* Before you call this operation, make sure that you have indexed file metadata into the dataset automatically by calling the [CreateBinding](https://help.aliyun.com/zh/imm/developer-reference/api-imm-2020-09-30-createbinding?spm=a2c4g.11186623.0.0.a3d76f44xJrOnF) operation or manually by calling the [IndexFileMeta](https://help.aliyun.com/zh/imm/developer-reference/api-imm-2020-09-30-indexfilemeta?spm=a2c4g.11186623.help-menu-search-62354.d\\_0) or [BatchIndexFileMeta](https://help.aliyun.com/zh/imm/developer-reference/api-imm-2020-09-30-batchindexfilemeta?spm=a2c4g.11186623.help-menu-62354.d\\_5\\_2\\_4\\_2\\_1\\_1.f1d86f44iBs3QZ) operation.'."\n" + .'* The response provided in this example is for reference only. The categories and content of metadata vary based on configurations of [workflow templates](https://help.aliyun.com/zh/imm/user-guide/workflow-templates-and-operators?spm=a2c4g.11186623.0.0.a3d775abr3hDFp). For any inquiries, join the DingTalk chat group (ID: 21714099) for feedback.'."\n" + ."\n" + .'### [](#)Limitations'."\n" + ."\n" + .'* The conversation history can hold up to 100 messages, including user-sent messages and assistant-generated messages.'."\n" + .'* Each message cannot exceed 1,000 characters in length.'."\n", + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-beijing-gov-1', + 'endpoint' => 'imm-vpc.cn-beijing-gov-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'imm.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'imm.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'imm.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'imm.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'imm.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'imm.cn-north-2-gov-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'imm.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'imm.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'imm.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'imm.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'imm.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'imm.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'imm.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'imm.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'imm.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'imm.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'imm.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'imm.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'imm.cn-wulanchabu.aliyuncs.com', + ], + ], +]; |