diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/imm/2020-09-30/api-docs.php | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/imm/2020-09-30/api-docs.php')
| -rw-r--r-- | data/en_us/imm/2020-09-30/api-docs.php | 31178 |
1 files changed, 13133 insertions, 18045 deletions
diff --git a/data/en_us/imm/2020-09-30/api-docs.php b/data/en_us/imm/2020-09-30/api-docs.php index 9ad9316..644987e 100644 --- a/data/en_us/imm/2020-09-30/api-docs.php +++ b/data/en_us/imm/2020-09-30/api-docs.php @@ -1,2104 +1,897 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'imm', - 'version' => '2020-09-30', - ], + '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', + 'children' => ['IndexFileMeta', 'BatchIndexFileMeta', 'UpdateFileMeta', 'BatchUpdateFileMeta', 'GetFileMeta', 'BatchGetFileMeta', 'DeleteFileMeta', 'BatchDeleteFileMeta'], 'type' => 'directory', - 'children' => [ - 'CreateDataset', - 'UpdateDataset', - 'GetDataset', - 'ListDatasets', - 'DeleteDataset', - ], + 'title' => 'Metadata indexing', ], [ - 'id' => 178612, - 'title' => 'Metadata Index', + 'children' => ['SimpleQuery', 'SemanticQuery', 'FuzzyQuery'], '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', + 'children' => ['CreateFigureClusteringTask', 'CreateFigureClustersMergingTask', 'GetFigureCluster', 'QueryFigureClusters', 'BatchGetFigureCluster', 'UpdateFigureCluster', 'SearchImageFigureCluster', 'CreateFacesSearchingTask'], 'type' => 'directory', - 'children' => [ - 'CreateFigureClusteringTask', - 'CreateFigureClustersMergingTask', - 'GetFigureCluster', - 'QueryFigureClusters', - 'BatchGetFigureCluster', - 'UpdateFigureCluster', - 'SearchImageFigureCluster', - 'CreateFacesSearchingTask', - ], + 'title' => 'Face clustering', ], [ - 'id' => 178702, - 'title' => 'spatio-temporal clustering', + 'children' => ['CreateLocationDateClusteringTask', 'QueryLocationDateClusters', 'UpdateLocationDateCluster', 'DeleteLocationDateCluster'], 'type' => 'directory', - 'children' => [ - 'CreateLocationDateClusteringTask', - 'QueryLocationDateClusters', - 'UpdateLocationDateCluster', - 'DeleteLocationDateCluster', - ], + 'title' => 'Spatiotemporal clustering', ], [ - 'id' => 178703, - 'title' => 'Story', + 'children' => ['QueryStories'], 'type' => 'directory', - 'children' => [ - 'CreateStory', - 'QueryStories', - 'GetStory', - 'CreateCustomizedStory', - 'UpdateStory', - 'AddStoryFiles', - 'RemoveStoryFiles', - 'DeleteStory', - ], + 'title' => 'Stories', ], [ - 'id' => 181692, - 'title' => 'image clustering', + 'children' => ['CreateSimilarImageClusteringTask', 'QuerySimilarImageClusters'], 'type' => 'directory', - 'children' => [ - 'CreateSimilarImageClusteringTask', - 'QuerySimilarImageClusters', - ], + 'title' => 'Image clustering', ], ], + 'type' => 'directory', + 'title' => 'Intelligent management', ], [ - 'id' => 178704, - 'title' => 'Data Binding', + 'children' => ['CreateBinding', 'GetBinding', 'ListBindings', 'DeleteBinding', 'AttachOSSBucket', 'DetachOSSBucket', 'GetOSSBucketAttachment'], 'type' => 'directory', - 'children' => [ - 'CreateBinding', - 'GetBinding', - 'ListBindings', - 'DeleteBinding', - 'AttachOSSBucket', - 'DetachOSSBucket', - 'GetOSSBucketAttachment', - ], + 'title' => 'Data binding', ], ], + 'type' => 'directory', + 'title' => 'Metadata management', ], [ - 'id' => 178705, - 'title' => 'Image Processing', + 'children' => ['EncodeBlindWatermark', 'CreateDecodeBlindWatermarkTask', 'GetDecodeBlindWatermarkResult', 'DetectImageLabels', 'DetectImageScore', 'DetectImageCodes', 'DetectImageFaces', 'DetectImageCropping', 'AddImageMosaic', 'CreateImageToPDFTask', 'CreateImageSplicingTask', 'CompareImageFaces', 'DetectImageBodies', 'DetectImageCars', 'DetectImageTexts'], 'type' => 'directory', - 'children' => [ - 'EncodeBlindWatermark', - 'CreateDecodeBlindWatermarkTask', - 'GetDecodeBlindWatermarkResult', - 'DetectImageLabels', - 'DetectImageScore', - 'DetectImageCodes', - 'DetectImageFaces', - 'DetectImageCropping', - 'AddImageMosaic', - 'CreateImageToPDFTask', - 'CreateImageSplicingTask', - 'CompareImageFaces', - 'DetectImageBodies', - 'DetectImageCars', - 'DetectImageTexts', - ], + 'title' => 'Image processing', ], [ - 'id' => 178706, - 'title' => 'Media Processing', + 'children' => ['CreateMediaConvertTask', 'DetectMediaMeta', 'CreateVideoLabelClassificationTask', 'GetVideoLabelClassificationResult', 'GenerateVideoPlaylist', 'CreateHighlightTask'], 'type' => 'directory', - 'children' => [ - 'CreateMediaConvertTask', - 'DetectMediaMeta', - 'CreateVideoLabelClassificationTask', - 'GetVideoLabelClassificationResult', - 'GenerateVideoPlaylist', - ], + 'title' => 'Media processing', ], [ - 'id' => 178707, - 'title' => 'Document processing', + 'children' => ['GenerateWebofficeToken', 'RefreshWebofficeToken', 'CreateOfficeConversionTask', 'ExtractDocumentText'], 'type' => 'directory', - 'children' => [ - 'GenerateWebofficeToken', - 'RefreshWebofficeToken', - 'CreateOfficeConversionTask', - 'ExtractDocumentText', - ], + 'title' => 'Document processing', ], [ - 'id' => 178708, - 'title' => 'File Processing', - 'type' => 'directory', 'children' => [ [ - 'id' => 178709, - 'title' => 'Compression Decompression', + 'children' => ['CreateFileCompressionTask', 'CreateArchiveFileInspectionTask', 'CreateFileUncompressionTask'], 'type' => 'directory', - 'children' => [ - 'CreateFileCompressionTask', - 'CreateArchiveFileInspectionTask', - 'CreateFileUncompressionTask', - ], + 'title' => 'Compression and decompression', ], [ - 'id' => 178710, - 'title' => 'point cloud compression', + 'children' => ['CreateCompressPointCloudTask'], 'type' => 'directory', - 'children' => [ - 'CreateCompressPointCloudTask', - ], + 'title' => 'Point cloud compression', ], ], + 'type' => 'directory', + 'title' => 'File processing', ], [ - 'id' => 178711, - 'title' => 'Content Security', + 'children' => ['DetectTextAnomaly', 'CreateImageModerationTask', 'CreateVideoModerationTask', 'GetImageModerationResult', 'GetVideoModerationResult'], 'type' => 'directory', - 'children' => [ - 'DetectTextAnomaly', - 'CreateImageModerationTask', - 'CreateVideoModerationTask', - 'GetImageModerationResult', - 'GetVideoModerationResult', - ], + 'title' => 'Content security', ], [ - 'id' => 178712, - 'title' => 'Task Management', - 'type' => 'directory', 'children' => [ - 'GetTask', - 'ListTasks', [ - 'id' => 178931, - 'title' => 'Trigger', + 'children' => ['SuspendTrigger', 'ResumeTrigger', 'UpdateTrigger', 'GetTrigger', 'ListTriggers'], 'type' => 'directory', - 'children' => [ - 'CreateTrigger', - 'SuspendTrigger', - 'ResumeTrigger', - 'UpdateTrigger', - 'GetTrigger', - 'ListTriggers', - 'DeleteTrigger', - ], + 'title' => 'Triggers', ], [ - 'id' => 180710, - 'title' => 'Batch Processing', + 'children' => ['CreateBatch', 'SuspendBatch', 'ResumeBatch', 'UpdateBatch', 'ListBatches', 'GetBatch', 'DeleteBatch'], 'type' => 'directory', - 'children' => [ - 'CreateBatch', - 'SuspendBatch', - 'ResumeBatch', - 'UpdateBatch', - 'ListBatches', - 'GetBatch', - 'DeleteBatch', - ], + 'title' => 'Batch processing', ], ], + 'type' => 'directory', + 'title' => 'Task management', ], [ - 'id' => 371156, - 'title' => null, - 'type' => 'directory', 'children' => [ - 'ListAttachedOSSBuckets', - 'ContextualAnswer', - 'ContextualRetrieval', + 'ContextualAnswer', 'ContextualRetrieval', 'ListAttachedOSSBuckets', 'AddStoryFiles', 'CreateCustomizedStory', 'CreateDataset', 'CreateProject', 'CreateStory', 'CreateTrigger', 'DeleteDataset', 'DeleteProject', 'DeleteStory', 'DeleteTrigger', 'GetDataset', 'GetProject', 'GetStory', 'GetTask', 'ListDatasets', 'ListProjects', 'ListRegions', + 'ListTasks', 'RemoveStoryFiles', 'UpdateDataset', 'UpdateProject', 'UpdateStory', ], + 'type' => 'directory', + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [ 'Address' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'Language' => ['title' => '', 'description' => 'The BCP 47 language code.'."\n", 'type' => 'string', 'example' => 'zh-Hans', 'visibility' => 'Public', 'backendName' => 'Language'], + 'AddressLine' => ['title' => '', 'description' => 'The full address.'."\n", 'type' => 'string', 'example' => '中国浙江省杭州市余杭区文一西路969号', 'visibility' => 'Public', 'backendName' => 'AddressLine'], + 'Country' => ['title' => '', 'description' => 'The country or region.'."\n", 'type' => 'string', 'example' => '中国', 'visibility' => 'Public', 'backendName' => 'Country'], + 'Province' => ['title' => '', 'description' => 'The province.'."\n", 'type' => 'string', 'example' => '浙江省', 'visibility' => 'Public', 'backendName' => 'Province'], + 'City' => ['title' => '', 'description' => 'The city.'."\n", 'type' => 'string', 'example' => '杭州市', 'visibility' => 'Public', 'backendName' => 'City'], + 'District' => ['title' => '', 'description' => 'The district.'."\n", 'type' => 'string', 'example' => '余杭区', 'visibility' => 'Public', 'backendName' => 'District'], + 'Township' => ['title' => '', 'description' => 'The street.'."\n", 'type' => 'string', 'example' => '文一西路', 'visibility' => 'Public', 'backendName' => 'Township'], ], + 'visibility' => 'Public', 'nullToEmpty' => true, + 'example' => '', ], 'AddressForStory' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'Country' => ['title' => '', 'description' => 'The country.'."\n", 'type' => 'string', 'example' => '中国', 'visibility' => 'Public', 'backendName' => 'Country'], + 'Province' => ['title' => '', 'description' => 'The province.'."\n", 'type' => 'string', 'example' => '浙江省', 'visibility' => 'Public', 'backendName' => 'Province'], + 'City' => ['title' => '', 'description' => 'The city.'."\n", 'type' => 'string', 'example' => '杭州市', 'visibility' => 'Public', 'backendName' => 'City'], + 'District' => ['title' => '', 'description' => 'The district.'."\n", 'type' => 'string', 'example' => '滨江区', 'visibility' => 'Public', 'backendName' => 'District'], + 'Township' => ['title' => '', 'description' => 'The township.'."\n", 'type' => 'string', 'example' => '长河街道', 'visibility' => 'Public', 'backendName' => 'Township'], ], + 'visibility' => 'Public', + 'example' => '', ], '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', - ], + 'Description' => ['description' => 'The description.'."\n", 'type' => 'string', 'title' => '', 'example' => 'test'], + 'OwnerId' => ['description' => 'The ID of the Alibaba Cloud account.'."\n", 'type' => 'string', 'title' => '', 'example' => 'user1'], + 'ProjectName' => ['description' => 'The name of the project.'."\n", 'type' => 'string', 'title' => '', 'example' => 'traningtest'], + 'CreateTime' => ['description' => 'The creation time.'."\n", 'type' => 'string', 'title' => '', 'example' => '2023-05-31T10:19:40.572325888+08:00'], + 'UpdateTime' => ['description' => 'The update time.'."\n", 'type' => 'string', 'title' => '', 'example' => '2023-05-31T10:19:40.572325888+08:00'], + 'TrainingSpecification' => ['description' => 'The model training parameters.'."\n", 'title' => '', '$ref' => '#/components/schemas/TrainingSpecification', 'example' => ''], + 'AlgorithmDefinitionId' => ['description' => 'The ID of the algorithm definition.'."\n", 'type' => 'string', 'title' => '', 'example' => '8fc6e718-8d19-495f-a510-bcee3c598588'], + 'Name' => ['description' => 'The name of the algorithm.'."\n", 'type' => 'string', 'title' => '', 'example' => 'algoName'], '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', + '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", 'type' => 'string', 'title' => '', 'example' => '{'."\n" + .' "MemberName": "Tim",'."\n" + .' "Enabled": "True",'."\n" + .' "ItemCount": "10"'."\n" + .'}'], 'description' => '', + 'title' => '', + 'example' => '', ], - 'backendName' => 'CustomLabels', + 'example' => '', ], ], + 'example' => '', ], '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', - ], + 'Content' => ['title' => '', 'description' => 'The answer.'."\n", 'type' => 'string', 'example' => '你好', 'visibility' => 'Public', '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', - ], + 'items' => ['description' => 'The reference file based on which the smart chatbot provides the answer.'."\n", '$ref' => '#/components/schemas/ReferenceFile', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'], + 'example' => '', + 'visibility' => 'Public', 'backendName' => 'References', ], ], + 'example' => '', + 'visibility' => 'Public', ], 'App' => [ - 'title' => 'App', + 'title' => '', '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', - ], + 'AppDescription' => ['title' => '', 'description' => 'AppDescription'."\n", 'type' => 'string', 'example' => '中国最大的电商购物商城', 'visibility' => 'Public', 'backendName' => 'AppDescription'], + 'AppId' => ['title' => '', 'description' => 'AppId'."\n", 'type' => 'string', 'example' => '1234567890', 'visibility' => 'Public', 'backendName' => 'AppId'], + 'PackageName' => ['title' => '', 'description' => 'PackageName'."\n", 'type' => 'string', 'example' => 'ThisIsAPackageName', 'visibility' => 'Public', 'backendName' => 'PackageName'], + 'AppType' => ['title' => '', 'description' => 'AppType'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'AppType'], + 'EnglishName' => ['title' => '', 'description' => 'EnglishName'."\n", 'type' => 'string', 'example' => 'Taobao', 'visibility' => 'Public', 'backendName' => 'EnglishName'], + 'AppName' => ['title' => '', 'description' => 'AppName'."\n", 'type' => 'string', 'example' => '淘宝', 'visibility' => 'Public', 'backendName' => 'AppName'], + 'AppRegion' => ['title' => '', 'description' => 'AppRegion'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'AppRegion'], + 'OwnerId' => ['title' => '', 'description' => 'OwnerId'."\n", 'type' => 'string', 'example' => '1023210024677934', 'visibility' => 'Public', 'backendName' => 'OwnerId'], + 'AppKey' => ['title' => '', 'description' => 'AppKey'."\n", 'type' => 'string', 'example' => 'ryBOBW0Z6NnQ3fV9', 'visibility' => 'Public', 'backendName' => 'AppKey'], ], + 'visibility' => 'Public', + 'example' => '', ], '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', - ], + 'Policy' => ['title' => '', 'description' => 'The policy.'."\n", 'type' => 'string', 'example' => '{'."\n" + .' "Statement": ['."\n" + .' {'."\n" + .' "Action": "oss:*",'."\n" + .' "Effect": "Allow",'."\n" + .' "Resource": "*"'."\n" + .' }'."\n" + .' ],'."\n" + .' "Version": "1"'."\n" + .'}', 'visibility' => 'Public', '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', - ], + 'items' => ['description' => 'The authorization chain node.'."\n", '$ref' => '#/components/schemas/AssumeRoleChainNode', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', 'backendName' => 'Chain', 'itemName' => 'Chain', + 'example' => '', ], ], + 'visibility' => 'Public', + 'example' => '', ], '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', - ], + 'Type' => ['title' => '', 'description' => 'The type of the account. Valid values:'."\n" + ."\n" + .'* user: Alibaba Cloud account.'."\n" + .'* service: Alibaba Cloud service.'."\n", 'type' => 'string', 'required' => true, 'example' => 'user'], + 'OwnerId' => ['title' => '', 'description' => 'The UID of the account.'."\n", 'type' => 'string', 'required' => true, 'example' => '10232100********'], + 'Role' => ['title' => '', 'description' => 'The role.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-role'], ], + 'example' => '', ], 'AudioStream' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'Index' => ['title' => '', 'description' => 'The index number of the audio stream.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'Index'], + 'Language' => ['title' => '', 'description' => 'The audio language in the BCP 47 standard.'."\n", 'type' => 'string', 'example' => 'en', 'visibility' => 'Public', 'backendName' => 'Language'], + 'CodecName' => ['title' => '', 'description' => 'The abbreviated name of the codec.'."\n", 'type' => 'string', 'example' => 'aac', 'visibility' => 'Public', 'backendName' => 'CodecName'], + 'CodecLongName' => ['title' => '', 'description' => 'The full name of the codec.'."\n", 'type' => 'string', 'example' => 'AAC (Advanced Audio Coding)', 'visibility' => 'Public', 'backendName' => 'CodecLongName'], + 'CodecTimeBase' => ['title' => '', 'description' => 'The time base of the codec.'."\n", 'type' => 'string', 'example' => '1/44100', 'visibility' => 'Public', 'backendName' => 'CodecTimeBase'], + 'CodecTagString' => ['title' => '', 'description' => 'The description of the codec tag.'."\n", 'type' => 'string', 'example' => 'mp4a', 'visibility' => 'Public', 'backendName' => 'CodecTagString'], + 'CodecTag' => ['title' => '', 'description' => 'The tag of the codec.'."\n", 'type' => 'string', 'example' => '0x6134706d', 'visibility' => 'Public', 'backendName' => 'CodecTag'], + 'TimeBase' => ['title' => '', 'description' => 'The time base.'."\n", 'type' => 'string', 'example' => '1/48000', 'visibility' => 'Public', 'backendName' => 'TimeBase'], + 'StartTime' => ['title' => '', 'description' => 'The start time of the audio stream in seconds.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '0.0235', 'visibility' => 'Public', 'backendName' => 'StartTime'], + 'Duration' => ['title' => '', 'description' => 'The duration of the audio stream in seconds.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '3.690667', 'visibility' => 'Public', 'backendName' => 'Duration'], + 'Bitrate' => ['title' => '', 'description' => 'The bitrate. Unit: bit/s.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '320087', 'visibility' => 'Public', 'backendName' => 'Bitrate'], + 'FrameCount' => ['title' => '', 'description' => 'The number of frames.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '173', 'visibility' => 'Public', 'backendName' => 'FrameCount'], + 'Lyric' => ['title' => '', 'description' => 'The lyric.'."\n", 'type' => 'string', 'example' => 'test', 'visibility' => 'Public', 'backendName' => 'Lyric'], + 'SampleFormat' => ['title' => '', 'description' => 'The sample format.'."\n", 'type' => 'string', 'example' => 'fltp', 'visibility' => 'Public', 'backendName' => 'SampleFormat'], + 'SampleRate' => ['title' => '', 'description' => 'The sampling rate. Unit: Hz.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '48000', 'visibility' => 'Public', 'backendName' => 'SampleRate'], + 'Channels' => ['title' => '', 'description' => 'The number of sound channels.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'visibility' => 'Public', 'backendName' => 'Channels'], + 'ChannelLayout' => ['title' => '', 'description' => 'The sound channel layout.'."\n", 'type' => 'string', 'example' => 'stereo', 'visibility' => 'Public', 'backendName' => 'ChannelLayout'], ], + 'visibility' => 'Public', + 'example' => '', ], 'Binding' => [ - 'title' => 'A short description of struct', - 'description' => 'The information about the binding.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'Information about the binding.', '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', - ], - ], + 'ProjectName' => ['title' => '', 'description' => 'The name of the project.', 'type' => 'string', 'example' => 'immtest'], + 'DatasetName' => ['title' => '', 'description' => 'The name of the dataset.', 'type' => 'string', 'example' => 'dataset001'], + 'URI' => ['title' => '', 'description' => 'The URI of the Object Storage Service (OSS) bucket attached to the dataset.'."\n" + ."\n" + .'The format of an OSS bucket URI is `oss://${bucketname}`. The `bucketname` is the name of an OSS bucket that is in the same region as the current project.', 'type' => 'string', 'example' => 'oss://examplebucket'], + 'State' => ['title' => '', 'description' => 'The state of the binding between the dataset and the OSS bucket. Valid values:'."\n" + ."\n" + .'- Ready: The binding is being prepared after it is created.'."\n" + ."\n" + .'- Stopped: The binding is paused.'."\n" + ."\n" + .'- Running: The binding is running.'."\n" + ."\n" + .'- Retrying: The binding is being retried after it is created.'."\n" + ."\n" + .'- Failed: The binding failed to be created.'."\n" + ."\n" + .'- Deleted: The binding is deleted.', 'type' => 'string', 'example' => 'Running'], + 'Phase' => ['title' => '', 'description' => 'The scan type. Valid values:'."\n" + ."\n" + .'- FullScanning: A full scan is in progress.'."\n" + ."\n" + .'- IncrementalScanning: An incremental scan is in progress.', 'type' => 'string', 'example' => 'FullScanning'], + 'CreateTime' => ['title' => '', 'description' => 'The timestamp when the binding between the dataset and the OSS bucket was created. The format is RFC3339Nano.', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00'], + 'UpdateTime' => ['title' => '', 'description' => 'The timestamp when the binding between the dataset and the OSS bucket was last modified. The format is RFC3339Nano.'."\n" + ."\n" + .'> After a binding is created, if the binding has not been paused or restarted, this timestamp is the same as the creation timestamp.', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00'], + 'Reason' => ['title' => '', 'description' => 'Reason', 'type' => 'string', 'example' => 'pause usage'], + ], + 'example' => '', ], 'Body' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'Confidence' => ['title' => '', '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", 'type' => 'number', 'format' => 'float', 'example' => '0.82', 'visibility' => 'Public', 'backendName' => 'Confidence'], + 'Boundary' => ['title' => '', 'description' => 'The boundary of the human body.'."\n", '$ref' => '#/components/schemas/Boundary', 'visibility' => 'Public', 'backendName' => 'Boundary', 'example' => ''], ], + 'visibility' => 'Public', + 'example' => '', ], 'Boundary' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'Width' => ['title' => '', 'description' => 'The width. Unit: pixel.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'visibility' => 'Public', 'backendName' => 'Width'], + 'Height' => ['title' => '', 'description' => 'The height. Unit: pixel.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '300', 'visibility' => 'Public', 'backendName' => 'Height'], + 'Left' => ['title' => '', 'description' => 'The distance from the X-coordinate of the vertex to the left edge.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'visibility' => 'Public', 'backendName' => 'Left'], + 'Top' => ['title' => '', 'description' => 'The distance from the Y-coordinate of the vertex to the top.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'visibility' => 'Public', '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', - ], + 'items' => ['description' => 'The coordinates of points that form the polygon.'."\n", '$ref' => '#/components/schemas/PointInt64', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', 'backendName' => 'Polygon', + 'example' => '', ], ], + 'visibility' => 'Public', + 'example' => '', ], 'Car' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'items' => ['description' => 'The license plate.'."\n", '$ref' => '#/components/schemas/LicensePlate', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', 'backendName' => 'LicensePlates', + 'example' => '', ], - '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' => [ + 'CarType' => ['title' => '', 'description' => 'The vehicle type. Valid values:'."\n" + ."\n" + .'* car'."\n" + .'* bus'."\n" + .'* truck'."\n" + .'* van'."\n", 'type' => 'string', 'example' => 'van', 'visibility' => 'Public', '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", 'type' => 'number', 'format' => 'double', 'example' => '0.516', 'visibility' => 'Public', '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", 'type' => 'string', 'example' => 'white', 'visibility' => 'Public', '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", 'type' => 'number', 'format' => 'double', 'example' => '0.604', 'visibility' => 'Public', 'backendName' => 'CarColorConfidence'], + 'Boundary' => ['title' => '', 'description' => 'The boundary information.'."\n", '$ref' => '#/components/schemas/Boundary', 'visibility' => 'Public', 'backendName' => 'Boundary', 'example' => ''], + '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", 'type' => 'number', 'format' => 'double', 'example' => '0.999', 'visibility' => 'Public', 'backendName' => 'Confidence'], + ], + 'visibility' => 'Public', + 'example' => '', + ], + 'Clip' => [ + 'type' => 'object', + 'properties' => [ + 'TimeRange' => [ + 'type' => 'array', + 'items' => ['description' => 'The start and end time', 'type' => 'integer', 'title' => '', 'example' => '100', 'format' => 'int64'], + 'description' => 'The time range of the event clip', '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', + 'example' => '', ], ], + 'description' => 'Event clip', + 'title' => '', + 'example' => '', ], 'ClusterForReq' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'ObjectId' => ['title' => '', 'description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'Cluster-99b1c333-86dc-45da-8c6****', 'visibility' => 'Public', 'backendName' => 'ObjectId'], + 'CustomId' => ['title' => '', 'description' => 'The custom ID.'."\n", 'type' => 'string', 'example' => 'abc', 'visibility' => 'Public', 'backendName' => 'CustomId'], + 'CustomLabels' => ['title' => '', 'description' => 'The custom labels.'."\n", 'type' => 'object', 'example' => '{"Bucket": "examplebucket"}', 'visibility' => 'Public', 'backendName' => 'CustomLabels'], + 'Name' => ['title' => '', 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'example' => 'abc', 'visibility' => 'Public', 'backendName' => 'Name'], 'Cover' => [ - 'title' => 'Cover', + 'title' => '', 'description' => 'The cover.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ 'Figures' => [ - 'title' => 'Figures', + 'title' => '', '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', - ], + 'FigureId' => ['title' => '', 'description' => 'The person ID.'."\n", 'type' => 'string', 'example' => '2cb3c51e-b406-4b0c-af1b-897d88e1****', 'visibility' => 'Public', 'backendName' => 'FigureId'], ], + 'visibility' => 'Public', 'extendType' => 'true', + 'title' => '', + 'example' => '', ], + 'visibility' => 'Public', 'backendName' => 'Figures', 'itemName' => 'Figures', + 'example' => '', ], ], + 'visibility' => 'Public', 'backendName' => 'Cover', + 'example' => '', ], ], + 'visibility' => 'Public', + 'example' => '', ], 'Codes' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'Content' => ['title' => '', 'description' => 'The content of the code.'."\n", 'type' => 'string', 'example' => 'https://www.example.com', 'visibility' => 'Public', 'backendName' => 'Content'], + 'Confidence' => ['title' => '', '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", 'type' => 'number', 'format' => 'float', 'example' => '0.9', 'visibility' => 'Public', 'backendName' => 'Confidence'], + 'Boundary' => ['title' => '', 'description' => 'The boundary of the code.'."\n", '$ref' => '#/components/schemas/Boundary', 'visibility' => 'Public', 'backendName' => 'Boundary', 'example' => ''], 'Type' => [ - 'title' => 'Type', + 'title' => '', 'description' => 'The type of the code.'."\n" ."\n" .'Enumerated values:'."\n" ."\n" .'* qrcode'."\n" .'* barcode'."\n", - 'visibility' => 'public', 'type' => 'string', - 'enumValueTitles' => [ - 'qrcode' => '', - 'barcode' => '', - ], + 'enumValueTitles' => ['qrcode' => '二维码', 'barcode' => '条码'], 'example' => 'qrcode', + 'visibility' => 'Public', 'backendName' => 'Type', ], ], + 'visibility' => 'Public', + 'example' => '', ], 'ContextualFile' => [ - 'title' => 'A short description of struct', - 'description' => 'File'."\n", - 'visibility' => 'Public', + 'title' => '', + 'description' => 'The file.', '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', - ], + 'OwnerId' => ['description' => 'The user ID.', 'type' => 'string', 'title' => '', 'example' => '1482910009923706'], + 'ProjectName' => ['description' => 'The project name.', 'type' => 'string', 'title' => '', 'example' => 'test-project'], + 'DatasetName' => ['description' => 'The dataset name.', 'type' => 'string', 'title' => '', 'example' => 'test-dataset'], + 'ObjectId' => ['description' => 'The identifier of the file in the dataset.', 'type' => 'string', 'title' => '', 'example' => '0939d7ed-73fa-4009-bbe6-fbbe07b92b2e'], + 'URI' => ['description' => 'The URI of the file.'."\n" + .'The format of an OSS URI is oss\\://${bucketname}/${objectname}. ${bucketname} is the name of an OSS bucket in the same region as the current project. ${objectname} is the file path.'."\n" + .'The format of a PDS URI is pds\\://domains/${domain}/drives/${drive}/files/${file}/revisions/${revision}.', 'type' => 'string', 'title' => '', 'example' => 'oss://test-bucket'], + 'OSSURI' => ['description' => 'The URI path of the OSS file. This parameter is used only when the URI is a PDS address.', 'type' => 'string', 'title' => '', 'example' => 'oss://test-bucket/test-object.jpg'], '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', + 'description' => 'The media type of the file.', + 'enumValueTitles' => ['image' => 'image', 'other' => 'other', 'document' => 'document', 'archive' => 'archive', 'audio' => 'audio', 'video' => 'video'], 'type' => 'string', - 'enumValueTitles' => [ - 'image' => 'image', - 'other' => 'other', - 'document' => 'document', - 'archive' => 'archive', - 'audio' => 'audio', - 'video' => 'video', - ], + 'title' => '', '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', ], + 'ContentType' => ['description' => 'The Multipurpose Internet Mail Extensions (MIME) type of the file.', 'type' => 'string', 'title' => '', 'example' => 'text/x-imm-faq'], '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', + 'title' => '', + 'description' => 'Elements.', 'type' => 'array', - 'items' => [ - 'description' => 'A short description of struct', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/FileSmartCluster', - ], - 'backendName' => 'SmartClusters', + 'items' => ['description' => 'The document elements generated from document analysis.', '$ref' => '#/components/schemas/Element', 'title' => '', 'example' => ''], + 'example' => '', ], ], - 'nullable' => true, - 'nullToEmpty' => true, + 'example' => '', ], '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', - ], + 'Role' => ['title' => '', 'description' => 'The role in the dialogue.'."\n", 'type' => 'string', 'example' => 'user', 'visibility' => 'Public', 'backendName' => 'Role'], + 'Content' => ['title' => '', 'description' => 'The message content.'."\n", 'type' => 'string', 'example' => '你好', 'visibility' => 'Public', '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', - ], + 'items' => ['description' => 'The data structure for file information.'."\n", '$ref' => '#/components/schemas/ContextualFile', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', 'backendName' => 'Files', + 'example' => '', ], ], + 'visibility' => 'Public', + 'example' => '', ], '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', - ], + '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", 'type' => 'string', 'example' => 'AliyunSTSAssumeForIMMServiceRole', 'visibility' => 'Public', '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", 'type' => 'string', 'example' => '{"Statement": [{"Action": "oss:*","Effect": "Allow","Resource": "*"}],"Version": "1"}', 'visibility' => 'Public', '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', - ], + 'AssumeRoleFor' => ['title' => '', 'description' => 'The ID of the account that you use to grant permissions.'."\n", 'type' => 'string', 'example' => '10232100246xxxxx', 'visibility' => 'Public', 'backendName' => 'AssumeRoleFor'], + 'Role' => ['title' => '', 'description' => 'The RAM role that can be assumed.'."\n", 'type' => 'string', 'example' => 'AliyunOSSRole', 'visibility' => 'Public', 'backendName' => 'Role'], + 'RoleType' => ['title' => '', 'description' => 'The role type. Valid values:'."\n" + ."\n" + .'* user: Alibaba Cloud account.'."\n" + .'* service: Alibaba Cloud service.'."\n", 'type' => 'string', 'example' => 'user', 'visibility' => 'Public', 'backendName' => 'RoleType'], ], + 'visibility' => 'Public', 'extendType' => 'true', + 'title' => '', + 'example' => '', ], + 'visibility' => 'Public', 'backendName' => 'Chain', 'itemName' => 'Chain', + 'example' => '', ], ], + 'visibility' => 'Public', + 'example' => '', ], 'CroppingSuggestion' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'AspectRatio' => ['title' => '', 'description' => 'The aspect ratio.'."\n", 'type' => 'string', 'example' => '2:3'], + 'Confidence' => ['title' => '', 'description' => 'The confidence score. Valid values: 0 to 1. A higher score indicates greater confidence in the result.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0.742'], + 'Boundary' => ['title' => '', 'description' => 'The boundary of the cropping.'."\n", '$ref' => '#/components/schemas/Boundary', 'example' => ''], ], + 'example' => '', ], '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", + 'items' => ['description' => 'The information about the properties.'."\n", '$ref' => '#/components/schemas/Property', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Normalize', - 'backendName' => 'Name', + 'backendName' => 'Properties', + 'example' => '', ], + 'Name' => ['title' => '', 'description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => 'Normalize', 'visibility' => 'Public', 'backendName' => 'Name'], ], + 'visibility' => 'Public', + 'example' => '', ], 'DataIngestion' => [ - 'title' => 'A short description of struct', - 'description' => 'The data ingestion object.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'A data ingestion instance.', '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', - ], + 'Id' => ['title' => '', 'description' => 'The unique ID of the data ingestion.', 'type' => 'string', 'example' => 'trigger-9f72636a-0f0c-4baf-ae78-38b27bfe****'], + 'Input' => ['title' => '', 'description' => 'The data source information.', '$ref' => '#/components/schemas/Input', 'example' => ''], 'Actions' => [ 'title' => '', - 'description' => 'The templates.'."\n", - 'visibility' => 'public', + 'description' => 'A list of processing templates.', 'type' => 'array', 'items' => [ - 'description' => 'The template.'."\n", - 'visibility' => 'public', + 'description' => 'The template information.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '', - 'description' => 'The name of the template.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'doc/convert', - 'backendName' => 'Name', - ], + 'Name' => ['title' => '', 'description' => 'The template name.', 'type' => 'string', 'example' => 'doc/convert'], 'Parameters' => [ 'title' => '', - 'description' => 'The template parameters.'."\n", - 'visibility' => 'public', + 'description' => 'The template parameters.', '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', + 'items' => ['description' => 'A template parameter.', 'type' => 'string', 'example' => 'pages=3', 'title' => ''], + 'example' => '', ], + 'FastFailPolicy' => ['title' => '', 'description' => 'The configuration of the fast-fail policy for data processing.', '$ref' => '#/components/schemas/FastFailPolicy', 'example' => ''], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'Actions', + 'example' => '', ], 'Notification' => [ 'title' => '', - 'description' => 'The notification for task completion.'."\n", - 'visibility' => 'public', + 'description' => 'The notification for task completion.', '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', - ], + 'Endpoint' => ['title' => '', 'description' => 'The MNS Endpoint.', 'type' => 'string', 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com'], + 'Topic' => ['title' => '', 'description' => 'The MNS topic.', 'type' => 'string', 'example' => 'topic1'], + 'MNS' => ['title' => '', 'description' => 'MNS', '$ref' => '#/components/schemas/MNS', 'example' => ''], + 'RocketMQ' => ['title' => '', 'description' => 'RocketMQ', '$ref' => '#/components/schemas/RocketMQ', 'example' => ''], ], - 'backendName' => 'Notification', + 'example' => '', ], 'Statistic' => [ 'title' => '', - 'description' => 'The statistical information.'."\n", - 'visibility' => 'public', + 'description' => 'The statistics information.', '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', - ], + 'SubmitSuccess' => ['title' => '', 'description' => 'The number of successful submissions.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'SubmitFailure' => ['title' => '', 'description' => 'The number of failed submissions.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'SkipFiles' => ['title' => '', 'description' => 'The number of skipped files.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], - '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', + 'example' => '', ], - ], + 'State' => ['title' => '', 'description' => 'The state of the batch processing task:'."\n" + ."\n" + .'- Ready: The task is ready. A newly created task is in the Ready state.'."\n" + ."\n" + .'- Running: The task is running. This is the state of a task that is executing normally.'."\n" + ."\n" + .'- Failed: The task failed. An error occurred during task execution, and the task cannot be automatically recovered.'."\n" + ."\n" + .'- Suspended: The task is paused.'."\n" + ."\n" + .'- Succeeded: The task is complete.', 'type' => 'string', 'example' => 'Succeeded'], + 'Marker' => ['title' => '', 'description' => 'The task execution position.', 'type' => 'string', 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****'], + 'CreateTime' => ['title' => '', 'description' => 'The time when the task was created.', 'type' => 'string', 'example' => '2020-11-10T03:50:28Z'], + 'UpdateTime' => ['title' => '', 'description' => 'The time when the task was last updated.', 'type' => 'string', 'example' => '2021-12-18T07:40:29Z'], + 'Tags' => ['title' => '', 'description' => 'The task tags.', 'type' => 'object', 'example' => ''], + 'Error' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'api returns error: SDKError: StatusCode: 404 Code: ResourceNotFound'], + 'Phase' => ['title' => '', 'description' => 'The scanning phase.', 'type' => 'string', 'example' => 'IncrementalScanning'], + 'ServiceRole' => ['title' => '', 'description' => 'The service authorization role.', 'type' => 'string', 'example' => 'AliyunIMMBatchTriggerRole'], + ], + 'example' => '', ], 'Dataset' => [ 'title' => '', - 'description' => 'The dataset information.'."\n", - 'visibility' => 'public', + 'description' => 'The dataset information.', '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', - ], + 'ProjectName' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'immtest'], + 'DatasetName' => ['title' => '', 'description' => 'The dataset name.', 'type' => 'string', 'example' => 'dataset001'], + 'TemplateId' => ['title' => '', 'description' => 'The workflow template ID.', 'type' => 'string', 'example' => 'Official:ImageManagement'], + 'CreateTime' => ['title' => '', 'description' => 'The timestamp when the dataset was created, in RFC3339Nano format.', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00'], + 'UpdateTime' => ['title' => '', 'description' => 'The timestamp when the dataset was last modified, in RFC3339Nano format.'."\n" + ."\n" + .'>If the dataset has not been updated since it was created, this timestamp is the same as the creation timestamp.', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00'], + 'Description' => ['title' => '', 'description' => 'The description of the dataset.', 'type' => 'string', 'example' => '测试数据集'], + 'DatasetMaxBindCount' => ['title' => '', 'description' => 'The maximum number of bindings allowed for each dataset.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'DatasetMaxFileCount' => ['title' => '', 'description' => 'The maximum number of files allowed in the dataset.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000000'], + 'DatasetMaxEntityCount' => ['title' => '', 'description' => 'The maximum number of metadata entities allowed in the dataset.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000000000'], + 'DatasetMaxRelationCount' => ['title' => '', 'description' => 'The maximum number of metadata relationships allowed in the dataset.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000000000'], + 'DatasetMaxTotalFileSize' => ['title' => '', 'description' => 'The maximum total file size allowed in the dataset, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '90000000000000000'], + 'BindCount' => ['title' => '', 'description' => 'The number of OSS buckets currently bound to the dataset.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'FileCount' => ['title' => '', 'description' => 'The current number of files in the dataset.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'TotalFileSize' => ['title' => '', 'description' => 'The total file size in the dataset, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000'], 'WorkflowParameters' => [ - 'title' => '自定义参数', - 'description' => '自定义参数', - 'visibility' => 'Public', + 'title' => '', + 'description' => 'The custom parameters.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/WorkflowParameter', - ], - 'nullable' => true, - 'backendName' => 'WorkflowParameters', + 'items' => ['description' => 'The custom parameter struct.', '$ref' => '#/components/schemas/WorkflowParameter', 'title' => '', 'example' => ''], + 'deprecated' => true, + 'example' => '', ], ], + 'example' => '', + ], + 'DatasetConfig' => [ + 'description' => 'The dataset configuration.', + 'type' => 'object', + 'properties' => [ + 'Insights' => ['title' => '', 'description' => 'The content awareness configuration.', 'example' => '', '$ref' => '#/components/schemas/InsightsConfig'], + 'SmartCluster' => ['description' => 'The intelligent clustering configuration.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/SmartClusterConfig'], + 'ReverseImage' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ReverseImageConfig'], + ], + 'title' => '', + 'example' => '', ], 'DatasetTaskStatus' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'Status' => ['title' => '', 'description' => 'The status of the task.'."\n", 'type' => 'string', 'example' => 'Succeeded'], + 'LastSucceededTime' => ['title' => '', 'description' => 'The time of the last completion.'."\n", 'type' => 'string', 'example' => '2024-06-29T14:50:13.011643661+08:00'], + 'StartTime' => ['title' => '', 'description' => 'The start time of the task.'."\n", 'type' => 'string', 'example' => '2024-06-29T14:50:13.011643661+08:00'], ], + 'example' => '', + ], + 'DocumentChapterSummarizeOption' => [ + 'description' => 'The article section-by-section summary options.', + 'type' => 'object', + 'properties' => [ + 'Marker' => ['description' => 'The start position for section-by-section summarization.', 'type' => 'integer', 'title' => '', 'example' => '0', 'format' => 'int32'], + 'Limit' => ['description' => 'The number of section-by-section summaries. If neither Marker nor Index is specified, the entire article is summarized by default. Marker and Index must either both be specified or both be omitted.', 'type' => 'integer', 'title' => '', 'example' => '5', 'format' => 'int32'], + 'Version' => ['description' => 'The version of section-by-section summarization.', 'type' => 'string', 'title' => '', 'example' => 'v1'], + ], + 'title' => '', + 'example' => '', + ], + 'DocumentParseKeywordOption' => [ + 'type' => 'object', + 'properties' => [ + 'Extract' => ['title' => '', 'description' => 'Specifies whether to extract keywords.', 'type' => 'boolean', 'example' => ''], + 'Count' => ['title' => '', 'description' => 'The number of keywords to extract. The value must be an integer from 0 to 10.', 'type' => 'integer', 'example' => '1', 'format' => 'int32'], + ], + 'description' => 'Options for extracting keywords from a document.', + 'title' => '', + 'example' => '', + ], + 'DocumentParseNarratorOption' => [ + 'type' => 'object', + 'properties' => [ + 'Narrate' => ['title' => '', 'description' => 'The summary of the document.', 'type' => 'boolean', 'example' => ''], + ], + 'description' => 'Document parsing narrator options', + 'title' => '', + 'example' => '', + ], + 'DocumentParseOption' => [ + 'type' => 'object', + 'properties' => [ + 'Narrator' => ['description' => 'Document parsing guidance options', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DocumentParseNarratorOption'], + 'Summary' => ['description' => 'Document parsing summary options', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DocumentParseSummaryOption'], + 'Question' => ['description' => 'Document parsing question generation options', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DocumentParseQuestionOption'], + 'Keyword' => ['description' => 'Document parsing keyword extraction options', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DocumentParseKeywordOption'], + ], + 'description' => 'Document parsing options', + 'title' => '', + 'example' => '', + ], + 'DocumentParseQuestionOption' => [ + 'type' => 'object', + 'properties' => [ + 'Extract' => ['title' => '', 'description' => 'Whether to extract', 'type' => 'boolean', 'example' => ''], + 'Count' => ['title' => '', 'description' => 'Number of questions (range: 0 to 10)', 'type' => 'integer', 'example' => '1', 'format' => 'int32'], + ], + 'description' => 'Options for generating questions during document parsing', + 'title' => '', + 'example' => '', + ], + 'DocumentParseSummaryOption' => [ + 'type' => 'object', + 'properties' => [ + 'Summarize' => ['title' => '', 'description' => 'Article summary', 'type' => 'boolean', 'example' => ''], + 'ChapterSummarize' => ['title' => '', 'description' => 'Document chapter summary', 'type' => 'boolean', 'example' => ''], + ], + 'description' => 'Document parsing summary options', + 'title' => '', + 'example' => '', + ], + 'DocumentReadKeywordOption' => [ + 'description' => 'The keyword extraction options for document intensive reading.', + 'type' => 'object', + 'properties' => [ + 'Extract' => ['description' => 'Specifies whether to extract keywords.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Count' => ['description' => 'The number of keywords. Valid values: 0 to 10.', 'type' => 'integer', 'title' => '', 'example' => '1', 'format' => 'int32'], + ], + 'title' => '', + 'example' => '', + ], + 'DocumentReadNarratorOption' => [ + 'description' => 'The document intensive reading guide options.', + 'type' => 'object', + 'properties' => [ + 'Narrate' => ['description' => 'Specifies whether to fetch.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'title' => '', + 'example' => '', + ], + 'DocumentReadOption' => [ + 'description' => 'The document intensive reading options.', + 'type' => 'object', + 'properties' => [ + 'Summary' => ['description' => 'The document intensive reading summary options.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DocumentReadSummaryOption'], + 'Narrator' => ['description' => 'The document intensive reading guide options.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DocumentReadNarratorOption'], + 'Question' => ['description' => 'The document intensive reading question guide options.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DocumentReadQuestionOption'], + 'Keyword' => ['description' => 'The document intensive reading keyword extraction options.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DocumentReadKeywordOption'], + ], + 'title' => '', + 'example' => '', + ], + 'DocumentReadSummaryOption' => [ + 'description' => 'The document intensive reading summary options.', + 'type' => 'object', + 'properties' => [ + 'Summarize' => ['description' => 'Specifies whether to extract the article summary.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ChapterSummarize' => ['description' => 'Specifies whether to extract the chapter-level summary of the article.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ChapterSummarizeOption' => ['description' => 'The chapter-level summary options for the article.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DocumentChapterSummarizeOption'], + ], + 'title' => '', + 'example' => '', ], 'Element' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', + 'items' => ['description' => 'The element content.'."\n", '$ref' => '#/components/schemas/ElementContent', 'title' => '', 'example' => ''], + 'example' => '', ], + 'ObjectId' => ['description' => 'The unique ID of the element.'."\n", 'type' => 'string', 'title' => '', 'example' => 'id1'], + 'ElementType' => ['description' => 'The element type.'."\n", 'type' => 'string', 'title' => '', 'example' => 'title - 标题； image - 图片 ； table - 表格 ； narrative-text - 正文'], + 'SemanticSimilarity' => ['description' => 'The similarity between the current file and its extracted semantics.'."\n", 'type' => 'number', 'title' => '', 'format' => 'float', 'example' => '0.8'], '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', + 'items' => ['description' => 'The relationship structure between the current element and other elements.'."\n", '$ref' => '#/components/schemas/ElementRelation', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], 'ElementContent' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'Type' => ['description' => 'The type of the element content.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* text'."\n" + .'* image'."\n" + .'* link'."\n", 'type' => 'string', 'title' => '', 'example' => 'text'], + 'Content' => ['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", 'type' => 'string', 'title' => '', 'example' => '文本片段'], + 'URL' => ['description' => 'The link to the element content. This parameter takes effect only if the Type parameter is set to image or link.'."\n", 'type' => 'string', 'title' => '', 'example' => 'http://aliyun.com'], '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', + 'items' => ['description' => 'The time range.'."\n", 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '500'], + 'example' => '', ], ], + 'example' => '', ], 'ElementRelation' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'Type' => ['title' => '', 'description' => 'The type.'."\n", 'type' => 'string', 'example' => 'child，parent', 'visibility' => 'Public', 'backendName' => 'Type'], + 'ObjectId' => ['title' => '', 'description' => 'The ID of the element.'."\n", 'type' => 'string', 'example' => 'id1', 'visibility' => 'Public', 'backendName' => 'ObjectId'], ], + 'visibility' => 'Public', + 'example' => '', ], 'FastFailPolicy' => [ 'title' => '', 'description' => 'The on-error policy.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'Action' => [ @@ -2109,2003 +902,686 @@ ."\n" .'* abort: stops running.'."\n" .'* ignore: ignores the error and keeps running.'."\n", - 'visibility' => 'Public', 'type' => 'string', - 'enumValueTitles' => [ - 'abort' => '', - 'ignore' => 'ignore', - ], + 'enumValueTitles' => ['abort' => '遇到错误停止运行', 'ignore' => '忽略错误继续执行'], 'example' => 'abort', + 'visibility' => 'Public', 'backendName' => 'Action', ], ], + 'visibility' => 'Public', + 'example' => '', ], 'Figure' => [ - 'title' => 'A short description of struct', - 'description' => 'The figure information.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'The figure information.', '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', - ], + 'FigureId' => ['title' => '', 'description' => 'The ID of the figure object.', 'type' => 'string', 'example' => '868a9e74-cde5-4c7a-9013-28bb984****'], + 'FigureConfidence' => ['title' => '', 'description' => 'The confidence score of the figure object. Valid values: 0 (lowest confidence) to 1 (highest confidence).', 'type' => 'number', 'format' => 'float', 'example' => '1'], + 'FigureClusterId' => ['title' => '', 'description' => 'The figure cluster ID. The following reserved special cluster ID names are included:'."\n" + ."\n" + .'- figure-cluster-id-independent: The face does not currently belong to any suitable group. After new images are added to the dataset and face clustering is performed, the face may be assigned to a group.'."\n" + ."\n" + .'- figure-cluster-id-unavailable: The face has not been clustered yet. This means that after new images were added to the dataset, face clustering has not been performed.', 'type' => 'string', 'example' => 'Cluster-dbe72fec-b84c-4ab6-885b-3678e64****'], + 'FigureClusterConfidence' => ['title' => '', 'description' => 'The clustering confidence score. Valid values: 0 (lowest confidence) to 1 (highest confidence).', 'type' => 'number', 'format' => 'float', 'example' => '1'], 'FigureType' => [ - 'title' => 'FigureType', - 'description' => 'The figure type.'."\n" - ."\n" - .'Set this parameter to face.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'The figure type.', + 'enumValueTitles' => ['face' => '人脸'], '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', ], + 'Age' => ['title' => '', 'description' => 'The age.', 'type' => 'integer', 'format' => 'int64', 'example' => '29'], + 'AgeSD' => ['title' => '', 'description' => 'The age standard deviation.', 'type' => 'number', 'format' => 'float', 'example' => '5'], 'Gender' => [ - 'title' => 'Gender', - 'description' => 'The gender. Valid values:'."\n" - ."\n" - .'* female'."\n" - .'* male'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'The gender.', + 'enumValueTitles' => ['female' => '女性', 'male' => '男性'], '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', ], + 'GenderConfidence' => ['title' => '', 'description' => 'The gender confidence score. Valid values: 0 (lowest confidence) to 1 (highest confidence).', 'type' => 'number', 'format' => 'float', 'example' => '1'], 'Emotion' => [ - 'title' => 'Emotion', - 'description' => 'The emotion. Valid values:'."\n" - ."\n" - .'* happiness'."\n" - .'* none'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'The emotion.', + 'enumValueTitles' => ['happiness' => '开心', 'none' => '无'], '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', ], + 'EmotionConfidence' => ['title' => '', 'description' => 'The emotion confidence score. Valid values: 0 (lowest confidence) to 1 (highest confidence).', 'type' => 'number', 'format' => 'float', 'example' => '0.707845687866210'], + 'FaceQuality' => ['title' => '', 'description' => 'The face quality score, which evaluates whether the image quality is suitable for face recognition. A higher score indicates better quality. Valid values: 0 to 1.', 'type' => 'number', 'format' => 'float', 'example' => '0.960875928401947'], + 'Boundary' => ['title' => '', 'description' => 'The face boundary information.', '$ref' => '#/components/schemas/Boundary', 'example' => ''], 'Mouth' => [ - 'title' => 'Mouth', - 'description' => 'Specifies whether the mouth is open. Valid values:'."\n" - ."\n" - .'* open'."\n" - .'* close'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'Indicates whether the mouth is open.', + 'enumValueTitles' => ['close' => '否', 'open' => '是'], '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', ], + 'MouthConfidence' => ['title' => '', 'description' => 'The confidence score for whether the mouth is open. Valid values: 0 (lowest confidence) to 1 (highest confidence).', 'type' => 'number', 'format' => 'float', 'example' => '1'], 'Beard' => [ - 'title' => 'Beard', - 'description' => 'Specifies whether the figure has a beard. Valid values:'."\n" - ."\n" - .'* beard'."\n" - .'* none'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'Indicates whether the person has a beard.', + 'enumValueTitles' => ['beard' => '是', 'none' => '否'], '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', ], + 'BeardConfidence' => ['title' => '', 'description' => 'The confidence score for whether the person has a beard. Valid values: 0 (lowest confidence) to 1 (highest confidence).', 'type' => 'number', 'format' => 'float', 'example' => '1'], 'Hat' => [ - 'title' => 'Hat', - 'description' => 'Specifies whether the figure wears a hat. Valid values:'."\n" - ."\n" - .'* hat'."\n" - .'* none'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'Indicates whether the person is wearing a hat.', + 'enumValueTitles' => ['hat' => '是', 'none' => '否'], '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', ], + 'HatConfidence' => ['title' => '', 'description' => 'The confidence score for whether the person is wearing a hat. Valid values: 0 (lowest confidence) to 1 (highest confidence).', 'type' => 'number', 'format' => 'float', 'example' => '1'], 'Mask' => [ - 'title' => 'Mask', - 'description' => 'Specifies whether the figure wears a mask. Valid values:'."\n" - ."\n" - .'* mask'."\n" - .'* none'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'Indicates whether the person is wearing a mask.', + 'enumValueTitles' => ['none' => '否', 'mask' => '是'], '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', ], + 'MaskConfidence' => ['title' => '', 'description' => 'The confidence score for whether the person is wearing a mask. Valid values: 0 (lowest confidence) to 1 (highest confidence).', 'type' => 'number', 'format' => 'float', 'example' => '1'], 'Glasses' => [ - 'title' => 'Glasses', - 'description' => 'Specifies whether the figure wears glasses. Valid values:'."\n" - ."\n" - .'* glasses'."\n" - .'* sunglasses'."\n" - .'* none'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'Indicates whether the person is wearing glasses.', + 'enumValueTitles' => ['glasses' => '戴眼镜', 'sunglasses' => '戴太阳镜', 'none' => '否'], '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', ], + 'GlassesConfidence' => ['title' => '', 'description' => 'The confidence score for whether the person is wearing glasses. Valid values: 0 (lowest confidence) to 1 (highest confidence).', 'type' => 'number', 'format' => 'float', 'example' => '0.8'], + 'Sharpness' => ['title' => '', 'description' => 'The sharpness score. A higher score indicates a clearer face. Valid values: 0 to 1.', 'type' => 'number', 'format' => 'float', 'example' => '0.7'], + 'Attractive' => ['title' => '', 'description' => 'The face attractiveness score. A higher score indicates greater attractiveness. Valid values: 0 to 1.', 'type' => 'number', 'format' => 'float', 'example' => '0.96'], + 'HeadPose' => ['description' => 'The head pose information.', '$ref' => '#/components/schemas/HeadPose', 'title' => '', 'example' => ''], ], + 'example' => '', ], 'FigureCluster' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', + 'OwnerId' => ['title' => '', 'description' => 'The user ID.'."\n", 'type' => 'string', 'example' => '102321002****'], + 'ProjectName' => ['title' => '', 'description' => 'The name of the project.'."\n", 'type' => 'string', 'example' => 'immtest'], + 'DatasetName' => ['title' => '', 'description' => 'The name of the dataset.'."\n", 'type' => 'string', 'example' => 'dataset001'], + 'ObjectType' => ['title' => '', 'description' => 'The type of the cluster.'."\n", 'type' => 'string', 'example' => 'figure-cluster'], + 'ObjectId' => ['title' => '', 'description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'Cluster-ae6e3472-999e-410b-b54e-cd5dba****'], + 'UpdateTime' => ['title' => '', 'description' => 'The update time.'."\n", 'type' => 'string', 'example' => '2022-01-14T10:10:52.83948013+08:00'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.'."\n", 'type' => 'string', 'example' => '2022-01-14T10:10:52.83948013+08:00'], + 'Name' => ['title' => '', 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'example' => 'abc'], + 'Gender' => ['title' => '', 'description' => 'The gender.'."\n", 'type' => 'string', 'example' => 'female'], + 'FaceCount' => ['title' => '', 'description' => 'The number of faces.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'ImageCount' => ['title' => '', 'description' => 'The number of images.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'VideoCount' => ['title' => '', 'description' => 'The number of videos.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'AverageAge' => ['title' => '', 'description' => 'The average age.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '26'], + 'MinAge' => ['title' => '', 'description' => 'The minimum age.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '12'], + 'MaxAge' => ['title' => '', 'description' => 'The maximum age.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '44'], + 'Cover' => ['title' => '', 'description' => 'The cover image.'."\n", '$ref' => '#/components/schemas/File', 'example' => ''], + 'CustomId' => ['title' => '', 'description' => 'The custom ID.'."\n", 'type' => 'string', 'example' => 'abc'], + 'CustomLabels' => ['title' => '', 'description' => 'The custom labels. You can search for clusters by label.'."\n", 'type' => 'object', 'example' => '{"Bucket": "examplebucket"}'], + 'MetaLockVersion' => ['title' => '', '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", 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + 'example' => '', + ], + 'FigureClusterConfig' => [ + 'type' => 'object', + 'properties' => [ + 'AutoClustering' => ['description' => 'Whether to automatically group similar figures into clusters.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'AutoGenerate' => ['description' => 'Whether to automatically generate metadata for each cluster, such as a representative cover image.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'MinEntityCount' => ['description' => 'The minimum number of figures required to form a cluster.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int64'], + 'EnabledFeatures' => [ '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', + 'items' => ['description' => 'The clustering strategy. Valid values are `metadata-based clustering` and `time-based clustering`.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'An array of strings specifying the clustering strategies to use.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'Configuration for figure clustering.', + 'title' => '', + 'example' => '', ], 'FigureClusterForReq' => [ - 'title' => 'A short description of struct', - 'description' => 'The information for updating a face cluster.'."\n", - 'visibility' => 'public', + 'description' => 'The information required to update a figure cluster.', + 'title' => '', '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', - ], + 'ObjectId' => ['description' => 'The object ID of the cluster.', 'type' => 'string', 'title' => '', 'example' => 'Cluster-99b1c333-86dc-45da-8c6****'], + 'Name' => ['description' => 'The cluster name.', 'type' => 'string', 'title' => '', 'example' => 'abc'], 'Cover' => [ - 'title' => 'Cover', - 'description' => 'The cover image.'."\n", - 'visibility' => 'public', + 'description' => 'The cover of the cluster.', + 'title' => '', 'type' => 'object', 'properties' => [ 'Figures' => [ - 'title' => 'Figures', - 'description' => 'The persons.'."\n", - 'visibility' => 'public', + 'description' => 'The figure list.', + 'title' => '', 'type' => 'array', 'items' => [ - 'description' => 'The person.'."\n", - 'visibility' => 'public', + 'description' => 'A figure object in the figure list.', 'type' => 'object', 'properties' => [ - 'FigureId' => [ - 'title' => 'FigureId', - 'description' => 'The person ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2cb3c51e-b406-4b0c-af1b-897d88e1****', - 'backendName' => 'FigureId', - ], + 'FigureId' => ['description' => 'The figure ID.', 'type' => 'string', 'title' => '', 'example' => '2cb3c51e-b406-4b0c-af1b-897d88e1****'], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'Figures', + 'example' => '', ], ], - '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', + 'example' => '', ], + 'CustomId' => ['description' => 'The custom ID.', 'type' => 'string', 'title' => '', 'example' => 'abc'], + 'CustomLabels' => ['description' => 'A key-value map of custom labels that can be used to search for the figure cluster.', 'type' => 'object', 'title' => '', 'example' => '{"Bucket": "examplebucket"}'], + 'MetaLockVersion' => ['description' => 'The metadata lock version. This parameter enables optimistic locking to prevent conflicting updates during high concurrency. To ensure data consistency, pass the current MetaLockVersion value when updating a figure cluster. You can retrieve this value from a Get or List operation. The service proceeds with the update only if the provided version matches the system\'s current version. The initial value is 0 and is incremented by 1 after each successful update.', 'type' => 'integer', 'title' => '', 'example' => '1', 'format' => 'int64'], ], + 'example' => '', ], 'File' => [ - 'title' => 'A short description of struct', - 'description' => 'The metadata of the object.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'The file\'s metadata.', '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', - ], + 'OwnerId' => ['title' => '', 'description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'example' => '102321002467****'], + 'ProjectName' => ['title' => '', 'description' => 'The project name. For more information, see [Create a project](~~478153~~).', 'type' => 'string', 'example' => 'test-project'], + 'DatasetName' => ['title' => '', 'description' => 'The dataset name. For more information, see [Create a dataset](~~478160~~).', 'type' => 'string', 'example' => 'test-dataset'], + 'ObjectType' => ['title' => '', 'description' => 'The type of the object. The value is always **file**.', 'type' => 'string', 'example' => 'file'], + 'ObjectId' => ['title' => '', 'description' => 'The unique ID of the object.', 'type' => 'string', 'example' => '75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7'], + 'UpdateTime' => ['title' => '', 'description' => 'The time when the metadata was last updated. The time is in the RFC3339Nano format.', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00'], + 'CreateTime' => ['title' => '', 'description' => 'The time when the metadata was created. The time is in the RFC3339Nano format.', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00'], + 'URI' => ['title' => '', 'description' => 'The address of the file.'."\n" + ."\n" + .'An OSS URI must be 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 full path to the object, including the file extension.'."\n" + ."\n" + .'A PDS URI must be in the `pds://domains/${domain}/drives/${drive}/files/${file}/revisions/${revision}` format.', 'type' => 'string', 'example' => 'oss://test-bucket/test-object.jpg'], + 'OSSURI' => ['title' => '', 'description' => 'The URI of the OSS file. This parameter is returned only if the URI is a PDS address.', 'type' => 'string', 'example' => 'oss://examplebucket/sampleobject.jpg'], + 'Filename' => ['title' => '', 'description' => 'The name of the file. For an OSS object, this parameter is the ObjectKey.', 'type' => 'string', 'example' => 'sampleobject.jpg'], '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', + 'title' => '', + 'description' => 'The media type of the file.', + 'enumValueTitles' => ['image' => '', 'other' => '', 'document' => '', 'archive' => '', 'audio' => '', 'video' => ''], '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', ], + 'ContentType' => ['title' => '', 'description' => 'The content type of the file (MIME type).', 'type' => 'string', 'example' => 'image/jpeg'], + 'Size' => ['title' => '', 'description' => 'The size of the file, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], + 'FileHash' => ['title' => '', 'description' => 'The hash of the file.', 'type' => 'string', 'example' => '1d9c280a7c4f67f7ef873e28449dbe17'], + 'FileModifiedTime' => ['title' => '', 'description' => 'The time when the file was last modified. The time is in the RFC3339Nano format.', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00'], + 'FileCreateTime' => ['title' => '', 'description' => 'The time when the file was created. The time is in the RFC3339Nano format.', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00'], + 'FileAccessTime' => ['title' => '', 'description' => 'The time when the file was last accessed. The time is in the RFC3339Nano format.', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00'], + 'ProduceTime' => ['title' => '', 'description' => 'The time when the photo was taken.', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00'], + 'LatLong' => ['title' => '', 'description' => 'The GPS latitude and longitude.', 'type' => 'string', 'example' => '30.134390,120.074997'], + 'Timezone' => ['title' => '', 'description' => 'The timezone.'."\n" + ."\n" + .'> This feature is not supported.', 'type' => 'string', 'example' => '""'], 'Addresses' => [ - 'title' => 'Addresses', - 'description' => 'The addresses.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'The address information.', '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', + 'items' => ['description' => 'The address information.', '$ref' => '#/components/schemas/Address', 'title' => '', 'example' => ''], + 'example' => '', ], + 'TravelClusterId' => ['title' => '', 'description' => 'A reserved parameter.'."\n" + ."\n" + .'> This feature is not supported.', 'type' => 'string', 'example' => '-'], + 'Orientation' => ['title' => '', 'description' => 'The rotation value of the image, read from its EXIF data.'."\n" + ."\n" + .'This parameter is returned only if this value is available in the EXIF data.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], 'Figures' => [ - 'title' => 'Figures', - 'description' => 'The list of persons. The persons are detected via AI models.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'A list of figures detected by the AI model.', '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', + 'items' => ['description' => 'The information about the figure.', '$ref' => '#/components/schemas/Figure', 'title' => '', 'example' => ''], + 'example' => '', ], + 'FigureCount' => ['title' => '', 'description' => 'The number of figures.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], 'Labels' => [ - 'title' => 'Labels', - 'description' => 'The labels of the file. The labels are detected via AI models.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'A list of AI-detected labels for the file.', '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', + 'items' => ['description' => 'The information about the file label.', '$ref' => '#/components/schemas/Label', 'title' => '', 'example' => ''], + 'example' => '', ], + 'Title' => ['title' => '', 'description' => 'The title of the file.', 'type' => 'string', 'example' => 'test'], + 'ImageWidth' => ['title' => '', 'description' => 'The width of the image, in pixels (px).', 'type' => 'integer', 'format' => 'int64', 'example' => '270'], + 'ImageHeight' => ['title' => '', 'description' => 'The height of the image, in pixels (px).', 'type' => 'integer', 'format' => 'int64', 'example' => '500'], + 'EXIF' => ['title' => '', 'description' => 'The original EXIF information of the image, stored as a serialized JSON object. For more information, see [Obtain image information](~~44975~~).', 'type' => 'string', 'example' => '{"Compression":{"value":"6"},"DateTime":{"value":"2020:08:19 17:11:11"}}'], + 'ImageScore' => ['description' => 'The image score information, detected by an AI model.', '$ref' => '#/components/schemas/ImageScore', 'title' => '', 'example' => ''], 'CroppingSuggestions' => [ - 'title' => 'CroppingSuggestions', + 'title' => '', 'description' => 'The cropping suggestions for the image.'."\n" ."\n" - .'> Not supported.'."\n", - 'visibility' => 'public', + .'> This feature is not supported.', 'type' => 'array', - 'items' => [ - 'description' => 'The cropping suggestion for the image.'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/CroppingSuggestion', - ], - 'backendName' => 'CroppingSuggestions', - 'itemName' => 'CroppingSuggestions', + 'items' => ['description' => 'A cropping suggestion for the image.', '$ref' => '#/components/schemas/CroppingSuggestion', 'title' => '', 'example' => ''], + 'example' => '', ], 'OCRContents' => [ - 'title' => 'OCRContents', - 'description' => 'The Optical Character Recognition (OCR) results.'."\n" + 'title' => '', + 'description' => 'The OCR results.'."\n" ."\n" - .'> Not supported.'."\n", - 'visibility' => 'public', + .'> This feature is not supported.', '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', + 'items' => ['description' => 'The OCR results.', '$ref' => '#/components/schemas/OCRContents', 'title' => '', 'example' => ''], + 'example' => '', ], + 'VideoWidth' => ['title' => '', 'description' => 'The width of the video, in pixels (px).', 'type' => 'integer', 'format' => 'int64', 'example' => '1080'], + 'VideoHeight' => ['title' => '', 'description' => 'The height of the video, in pixels (px).', 'type' => 'integer', 'format' => 'int64', 'example' => '1920'], 'VideoStreams' => [ - 'title' => 'VideoStreams', - 'description' => 'The list of video streams.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'A list of video streams.', 'type' => 'array', - 'items' => [ - 'description' => 'The video stream.'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/VideoStream', - ], - 'backendName' => 'VideoStreams', - 'itemName' => 'VideoStreams', + 'items' => ['description' => 'A video stream.', '$ref' => '#/components/schemas/VideoStream', 'title' => '', 'example' => ''], + 'example' => '', ], 'Subtitles' => [ - 'title' => 'Subtitles', - 'description' => 'The list of subtitle streams.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'A list of subtitle streams.', 'type' => 'array', - 'items' => [ - 'description' => 'The subtitle stream.'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/SubtitleStream', - ], - 'backendName' => 'Subtitles', - 'itemName' => 'Subtitles', + 'items' => ['description' => 'A subtitle stream.', '$ref' => '#/components/schemas/SubtitleStream', 'title' => '', 'example' => ''], + 'example' => '', ], 'AudioStreams' => [ - 'title' => 'AudioStreams', - 'description' => 'The list of audio streams.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'A list of audio streams.', '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', + 'items' => ['description' => 'An audio stream.', '$ref' => '#/components/schemas/AudioStream', 'title' => '', 'example' => ''], + 'example' => '', ], + 'Artist' => ['title' => '', 'description' => 'The artist.', 'type' => 'string', 'example' => 'Jane'], + 'AlbumArtist' => ['title' => '', 'description' => 'The album artist.', 'type' => 'string', 'example' => 'Jane'], 'AudioCovers' => [ - 'title' => 'AudioCovers', - 'description' => 'The audio covers.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'The cover images for the audio.', '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', + 'items' => ['description' => 'A cover image for the audio.', '$ref' => '#/components/schemas/Image', 'title' => '', 'example' => ''], + 'example' => '', ], - 'PageCount' => [ - 'title' => 'PageCount', - 'description' => 'The number of pages.'."\n" + 'Composer' => ['title' => '', 'description' => 'The composer.', 'type' => 'string', 'example' => 'Jane'], + 'Performer' => ['title' => '', 'description' => 'The performer.', 'type' => 'string', 'example' => 'Jane'], + 'Language' => ['title' => '', 'description' => 'The language in BCP 47 format.', 'type' => 'string', 'example' => 'eng'], + 'Album' => ['title' => '', 'description' => 'The album.', 'type' => 'string', 'example' => 'FirstAlbum'], + 'PageCount' => ['title' => '', 'description' => 'The number of pages.'."\n" + ."\n" + .'> This feature is not supported.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'ETag' => ['title' => '', 'description' => 'An ETag is generated when an object is created. The ETag identifies the content of an object.', 'type' => 'string', 'example' => '"1D9C280A7C4F67F7EF873E28449****"'], + 'CacheControl' => ['title' => '', 'description' => 'The web cache behavior that the browser should use when the object is downloaded.'."\n" + ."\n" + .'This parameter is returned only if the Cache-Control HTTP header is set for the OSS object. For more information, see [Manage object metadata](~~31859~~).', 'type' => 'string', 'example' => 'no-cache'], + 'ContentDisposition' => ['title' => '', 'description' => 'The name of the object when it is downloaded.'."\n" + ."\n" + .'This parameter is returned only if the Content-Disposition HTTP header is set for the OSS object. For more information, see [Manage object metadata](~~31859~~).', 'type' => 'string', 'example' => 'attachment; filename =test.jpg'], + 'ContentEncoding' => ['title' => '', 'description' => 'The content encoding format of the object when it is downloaded.'."\n" + ."\n" + .'This parameter is returned only if the Content-Encoding HTTP header is set for the OSS object. For more information, see [Manage object metadata](~~31859~~).', 'type' => 'string', 'example' => 'UTF-8'], + 'ContentLanguage' => ['title' => '', 'description' => 'The language of the object content.'."\n" + ."\n" + .'This parameter is returned only if the Content-Language HTTP header is set for the OSS object. For more information, see [Manage object metadata](~~31859~~).', 'type' => 'string', 'example' => 'zh-CN'], + 'AccessControlAllowOrigin' => ['title' => '', 'description' => 'The allowed origins for cross-origin requests.', 'type' => 'string', 'example' => 'https://aliyundoc.com'], + 'AccessControlRequestMethod' => ['title' => '', 'description' => 'The allowed methods for the cross-origin request.', 'type' => 'string', 'example' => 'PUT'], + 'ServerSideEncryptionCustomerAlgorithm' => ['title' => '', 'description' => 'The encryption algorithm used for server-side encryption with customer-provided keys.', 'type' => 'string', 'example' => 'SM4'], + 'ServerSideEncryption' => ['title' => '', 'description' => 'The server-side encryption method.'."\n" + ."\n" + .'This parameter is returned only if server-side encryption is enabled for the bucket. For more information, see [Server-side encryption](~~31871~~).', 'type' => 'string', 'example' => 'AES256'], + 'ServerSideDataEncryption' => ['title' => '', 'description' => 'The encryption algorithm of the object.'."\n" + ."\n" + .'This parameter is returned only if server-side encryption is enabled for the bucket. For more information, see [Server-side encryption](~~31871~~).', 'type' => 'string', 'example' => 'SM4'], + 'ServerSideEncryptionKeyId' => ['title' => '', 'description' => 'The ID of the customer master key (CMK) that is managed by KMS.'."\n" + ."\n" + .'This parameter is returned only if server-side encryption is enabled for the bucket. For more information, see [Server-side encryption](~~31871~~).', 'type' => 'string', 'example' => '9468da86-3509-4f8d-a61e-6eab1eac****'], + 'OSSStorageClass' => ['title' => '', 'description' => 'The storage class of the OSS object.', 'type' => 'string', 'example' => 'Standard'], + 'OSSCRC64' => ['title' => '', 'description' => 'The CRC-64 value of the object.', 'type' => 'string', 'example' => '559890638950338001'], + 'ObjectACL' => ['title' => '', 'description' => 'The access control list (ACL) of the OSS object.', 'type' => 'string', 'example' => 'default'], + 'ContentMd5' => ['title' => '', 'description' => 'The MD5 hash of the object content.', 'type' => 'string', 'example' => 'HZwoCnxPZ/fvhz4oRJ2+Fw=='], + 'OSSUserMeta' => ['title' => '', 'description' => 'The user-defined metadata of the OSS object.'."\n" + ."\n" + .'This parameter is returned only if user-defined metadata is set for the OSS object. For more information, see [Manage object metadata](~~31859~~).', 'type' => 'object', 'example' => '{"key": "val"}'], + 'OSSTaggingCount' => ['title' => '', 'description' => 'The number of tags on the OSS object.'."\n" + ."\n" + .'This parameter is returned only if tags are set for the OSS object. For more information, see [Object tagging](~~106678~~).', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'OSSTagging' => ['title' => '', 'description' => 'The tags of the OSS object.'."\n" + ."\n" + .'For more information, see [Object tagging](~~106678~~).', 'type' => 'object', 'example' => '{"key": "val"}'], + 'OSSExpiration' => ['title' => '', 'description' => 'The expiration time of the OSS object.'."\n" + ."\n" + .'This parameter is returned only if the Expires HTTP header is set for the OSS object. For more information, see [Manage object metadata](~~31859~~).', 'type' => 'string', 'example' => '2120-01-01T12:00:00.000Z'], + 'OSSVersionId' => ['title' => '', 'description' => 'The version ID of the OSS object.'."\n" + ."\n" + .'This parameter is returned only if versioning is enabled for the bucket. For more information, see [Overview of versioning](~~109695~~).', 'type' => 'string', 'example' => 'CAEQNhiBgMDJgZCA0BYiIDc4MGZjZGI2OTBjOTRmNTE5NmU5NmFhZjhjYmY0****'], + 'OSSDeleteMarker' => ['title' => '', 'description' => 'The OSS delete marker.', 'type' => 'string', 'example' => 'CAEQMhiBgIDXiaaB0BYiIGQzYmRkZGUxMTM1ZDRjOTZhNjk4YjRjMTAyZjhl****'], + 'OSSObjectType' => ['title' => '', 'description' => 'The type of the OSS object. A common value is `Normal`.', 'type' => 'string', 'example' => 'Normal'], + 'CustomId' => ['title' => '', 'description' => 'The custom ID of the file, which you can use to associate the file with an ID in your business system. When the file is indexed into a dataset, this ID is stored as a metadata attribute. We recommend using a globally unique value.', 'type' => 'string', 'example' => ' '."\n" + .'member-image-id-0001'], + 'CustomLabels' => ['title' => '', 'description' => 'Custom key-value labels for the file. This parameter is optional and can be used to store business-specific data and to filter queries.', 'type' => 'object', 'example' => '{'."\n" + .' "MemberName": "Tim",'."\n" + .' "Enabled": "True",'."\n" + .' "ItemCount": "10"'."\n" + .'}'], + 'StreamCount' => ['title' => '', 'description' => 'The number of media streams in the media container.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ProgramCount' => ['title' => '', 'description' => 'The number of programs in the media container.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'FormatName' => ['title' => '', 'description' => 'The name of the media format.', 'type' => 'string', 'example' => 'mov'], + 'FormatLongName' => ['title' => '', 'description' => 'The full name of the media format.', 'type' => 'string', 'example' => 'QuickTime / MOV'], + 'StartTime' => ['title' => '', 'description' => 'The start time of the first frame, in seconds.', 'type' => 'number', 'format' => 'double', 'example' => '0.000000'], + 'Bitrate' => ['title' => '', 'description' => 'The bitrate, in bit/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '13091201'], + 'Duration' => ['title' => '', 'description' => 'The total duration of the video, in seconds.', 'type' => 'number', 'format' => 'double', 'example' => '15.263000'], + 'SemanticTypes' => [ + 'title' => '', + 'description' => 'Indicates why this file was returned when you use the SemanticQuery API to perform a semantic search.', + 'type' => 'array', + 'items' => ['description' => 'The reason the current file is returned when you use the SemanticQuery API to perform a semantic search.'."\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" + .'Valid values:'."\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" + .'- content: The semantic meaning of the document\'s content or image matches the search query.'."\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" + .'- text: The text string in the document or the text in the image matches the search query.'."\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" + .'- datetime: The creation time of the file matches the search query.'."\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" + .'- address: The creation location of the file matches the search query.'."\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" + .'- figure: The name of a figure in the file matches the search query.'."\n" + ."\n\n" + .' ><notice>'."\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" + .' More values may be added as the algorithm evolves.'."\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', + .' ></notice>', 'type' => 'string', 'title' => '', 'example' => 'content'], + 'example' => '', ], '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', + 'title' => '', + 'description' => 'A list of document fragments that match the current search content when you use the SemanticQuery API to perform a semantic search.', 'type' => 'array', - 'items' => [ - 'description' => 'The document element that matches the current query content.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/Element', - ], - 'backendName' => 'Elements', + 'items' => ['description' => 'The information about the document fragment that matches the current search content.', '$ref' => '#/components/schemas/Element', 'title' => '', 'example' => ''], + 'example' => '', ], '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', + 'title' => '', + 'description' => 'A list of scene elements extracted from the video by the AI model during analysis.', 'type' => 'array', - 'items' => [ - 'description' => 'A short description of struct', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/FileSmartCluster', - ], - 'backendName' => 'SmartClusters', + 'items' => ['description' => 'The information about the scene element.', '$ref' => '#/components/schemas/SceneElement', 'title' => '', 'example' => ''], + 'example' => '', ], + 'OCRTexts' => ['title' => '', 'description' => 'The text detected in the image.', 'type' => 'string', 'example' => '阿里云IMM'], + 'Reason' => ['title' => '', 'description' => 'The reason the file failed to be indexed.', 'type' => 'string', 'example' => '[InternalError] The request has been failed due to some unknown error. status: 500, requestId: CC5ACFBD-BB7A-496D-A9D6-****'], 'ObjectStatus' => [ - 'title' => 'ObjectStatus', - 'description' => 'The status of the object.'."\n", - 'visibility' => 'Public', + 'title' => '', + 'description' => 'File index status.', + 'enumValueTitles' => ['Failed' => '文件执行索引构建失败。', 'Indexed' => '文件执行索引构建完成。', 'Pending' => '文件已经提交索引任务，准备进入索引构建。', 'Deleting' => '文件处于删除中，此时该文件进入清理阶段，此阶段用户无法对文件进行写操作，如IndexFileMeta、UpdateFileMeta会返回409', 'Indexing' => '文件执行索引构建任务过程中。'], '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', ], + 'Insights' => ['description' => 'Summary and description of the file.'."\n" + ."\n" + .'> Currently not supported', '$ref' => '#/components/schemas/Insights', 'title' => '', 'example' => ''], ], + 'example' => '', ], 'FileSmartCluster' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'SmartClusterId' => ['title' => '', 'description' => 'SmartClusterId'."\n", 'type' => 'string', 'example' => 'SmartCluster-12cd1645-deae-4b5e-9434-613747b75f6d', 'visibility' => 'Public', 'backendName' => 'SmartClusterId'], + 'Similarity' => ['title' => '', 'description' => 'Similarity'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0.9', 'visibility' => 'Public', 'backendName' => 'Similarity'], ], + 'visibility' => 'Public', + 'example' => '', ], 'FunctionCall' => [ 'title' => '', 'description' => 'The definition of the function that can be called by the AI assistant.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The function name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'search_file', 'visibility' => 'Public', 'backendName' => 'Name'], + 'Arguments' => ['title' => '', 'description' => 'The parameters detected by the large language model.'."\n", 'type' => 'string', 'example' => '{'."\n" + .' "type": "object",'."\n" + .' "name": {'."\n" + .' "type": "string", '."\n" + .' "description": "需要检索的文件的文件名。可以为空 null"'."\n" + .' }, '."\n" + .' "required": ['."\n" + .' "category"'."\n" + .' ]'."\n" + .'}', 'visibility' => 'Public', 'backendName' => 'Arguments'], + ], 'visibility' => 'Public', + 'example' => '', + ], + 'GetDocumentAnalysisOption' => [ + 'description' => 'The options for retrieving document intensive reading results.', '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', - ], + 'Summary' => ['description' => 'Specifies whether to retrieve the full-text summary.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Question' => ['description' => 'Specifies whether to retrieve the generated questions and corresponding answers.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'Keyword' => ['description' => 'Specifies whether to retrieve keywords.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'Narrator' => ['description' => 'Specifies whether to retrieve the document reading guide results.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'Layouts' => ['description' => 'Specifies whether to retrieve the layout.jsonl file.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'Images' => ['description' => 'Specifies whether to retrieve images extracted from the document, such as pictures, tables, and formulas.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'ChapterSummaryOption' => ['description' => 'The options for retrieving chapter-by-chapter summaries of the document.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DocumentChapterSummarizeOption'], + 'ChapterSummary' => ['description' => 'Specifies whether to retrieve chapter-by-chapter summaries of the document.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + ], + 'title' => '', + 'example' => '', + ], + 'GetVideoAnalysisOption' => [ + 'description' => 'The options for retrieving video intensive reading results.', + 'type' => 'object', + 'properties' => [ + 'Summary' => ['description' => 'Specifies whether to retrieve the full-text summary.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'Question' => ['description' => 'Specifies whether to retrieve the generated questions and corresponding answers.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'Keyword' => ['description' => 'Specifies whether to retrieve keywords.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'ChapterSummary' => ['description' => 'Specifies whether to retrieve the chapter-based summary of the video.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'Transcript' => ['description' => 'Specifies whether to retrieve the dialogue in the video. Default value: false.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'TranscriptSummary' => ['description' => 'Specifies whether to retrieve the summary generated from the dialogue in the video. Default value: false.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'TranscriptChapterSummary' => ['description' => 'Specifies whether to retrieve the segmented summary generated from the dialogue in the video. Default value: false.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'PPT' => ['description' => 'Specifies whether to retrieve the PPT from the video. Default value: false.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + ], + 'title' => '', + 'example' => '', + ], + 'GuidingQuestion' => [ + 'description' => 'The question guide.', + 'type' => 'object', + 'properties' => [ + 'Question' => ['description' => 'The question.', 'type' => 'string', 'title' => '', 'example' => '"为什么将场景文本检测和布局分析统一起来是重要的？"'], + 'Answer' => ['description' => 'The answer.', 'type' => 'string', 'title' => '', 'example' => '"将场景文本检测和布局分析统一起来是重要的，因为这两个任务虽然在文献中通常被独立研究，但实际上是紧密相关的。"'], ], + 'title' => '', + 'example' => '', ], 'HeadPose' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'Pitch' => ['title' => '', '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", 'type' => 'number', 'format' => 'float', 'example' => '18.385589599609375', 'visibility' => 'Public', 'backendName' => 'Pitch'], + 'Roll' => ['title' => '', '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", 'type' => 'number', 'format' => 'float', 'example' => '4.204030513763428', 'visibility' => 'Public', 'backendName' => 'Roll'], + 'Yaw' => ['title' => '', '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", 'type' => 'number', 'format' => 'float', 'example' => '2.4945924282073975', 'visibility' => 'Public', 'backendName' => 'Yaw'], ], + 'visibility' => 'Public', + 'example' => '', ], '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', - ], + 'BatchSize' => ['title' => '', 'description' => 'The batch size for model training.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'visibility' => 'Public', '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', + 'items' => ['description' => 'The image size. The array contains the width and height of the image.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '640', 'visibility' => 'Public', 'extendType' => 'true', 'title' => ''], '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', + 'backendName' => 'InputSize', + 'example' => '', ], - 'BackupInterval' => [ + 'Schedule' => ['description' => 'The learning rate scheduler.'."\n", '$ref' => '#/components/schemas/Schedule', 'visibility' => 'Public', 'backendName' => 'Schedule', 'title' => '', 'example' => ''], + 'MaxEpoch' => ['title' => '', 'description' => 'The number of epochs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'visibility' => 'Public', 'backendName' => 'MaxEpoch'], + 'Evaluator' => ['description' => 'The custom parameters for model training.'."\n", 'required' => true, '$ref' => '#/components/schemas/CustomParams', 'visibility' => 'Public', 'backendName' => 'Evaluator', 'title' => '', 'example' => ''], + 'DataLoaderWorkers' => ['title' => '', 'description' => 'The number of threads used to read the training data.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'visibility' => 'Public', 'backendName' => 'DataLoaderWorkers'], + 'Optimization' => ['description' => 'The optimization algorithm.'."\n", '$ref' => '#/components/schemas/Optimization', 'visibility' => 'Public', 'backendName' => 'Optimization', 'title' => '', 'example' => ''], + '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", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'BackupInterval'], + ], + 'visibility' => 'Public', + 'example' => '', + ], + 'Illustration' => [ + 'description' => 'The image information in the article.', + 'type' => 'object', + 'properties' => [ + 'ImagePath' => ['description' => 'The relative path of the image.', 'type' => 'string', 'title' => '', 'example' => '"imgs/page_0_img_image_box_770_540_1367_860.png"'], + 'Text' => ['description' => 'The text result recognized by optical character recognition (OCR) from the image.', 'type' => 'string', 'title' => '', 'example' => '"图片"'], + 'Type' => ['description' => 'The type of the image.', 'type' => 'string', 'title' => '', 'example' => 'image、table、code'], + 'ImageIndex' => ['description' => 'The index of the image.', 'type' => 'integer', 'title' => '', 'example' => '0', 'format' => 'int32'], + 'PageNumber' => ['description' => 'The page number where the image is located.', 'type' => 'integer', 'title' => '', 'example' => '1', 'format' => 'int32'], + 'NormalizedBox' => [ + 'description' => 'The normalized coordinate of the image on the page.', + 'type' => 'array', + 'items' => ['description' => 'The normalized coordinate.', 'type' => 'number', 'title' => '', 'example' => '0.5029411911964417', 'format' => 'float'], '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', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'Image' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'ImageWidth' => ['title' => '', 'description' => 'The width of the image. Unit: pixels.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '500', 'visibility' => 'Public', 'backendName' => 'ImageWidth'], + 'ImageHeight' => ['title' => '', 'description' => 'The height of the image. Unit: pixels.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '820', 'visibility' => 'Public', 'backendName' => 'ImageHeight'], + 'EXIF' => ['title' => '', '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", 'type' => 'string', 'example' => '{"FileSize":{"value":"29304"},"Format":{"value":"jpg"}}', 'visibility' => 'Public', 'backendName' => 'EXIF'], + 'ImageScore' => ['description' => 'The image scoring information.'."\n", '$ref' => '#/components/schemas/ImageScore', 'visibility' => 'Public', 'backendName' => 'ImageScore', 'title' => '', 'example' => ''], 'CroppingSuggestions' => [ - 'title' => 'CroppingSuggestions', + 'title' => '', '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', - ], + 'items' => ['description' => 'The cropping suggestion.'."\n", '$ref' => '#/components/schemas/CroppingSuggestion', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', 'backendName' => 'CroppingSuggestions', 'itemName' => 'CroppingSuggestions', + 'example' => '', ], 'OCRContents' => [ - 'title' => 'OCRContents', + 'title' => '', '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', - ], + 'items' => ['description' => 'The OCR result.'."\n", '$ref' => '#/components/schemas/OCRContents', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', 'backendName' => 'OCRContents', 'itemName' => 'OCRContents', + 'example' => '', ], ], + 'visibility' => 'Public', + 'example' => '', ], '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', - ], + 'Caption' => ['description' => 'Image summary.'."\n" + ."\n" + .'> Not supported.'."\n", 'type' => 'string', 'example' => '无。', 'visibility' => 'Public', 'nullable' => true, 'backendName' => 'Caption', 'title' => ''], 'Description' => [ 'description' => 'The description of the image.'."\n", - 'visibility' => 'Public', 'type' => 'string', - 'example' => '', + 'example' => '图片中有一人，穿着深色西装外套，内搭白色衬衫。背景为渐变的浅蓝色至灰色。', + 'visibility' => 'Public', 'nullable' => true, 'backendName' => 'Description', 'valueMapping' => [ 'cases' => [], ], + 'title' => '', ], ], + 'visibility' => 'Public', 'nullable' => true, + 'title' => '', + 'example' => '', + ], + 'ImageInsightsCaptionConfig' => [ + 'description' => 'The image content perception Caption configuration.', + 'type' => 'object', + 'properties' => [ + 'Enable' => ['description' => 'Specifies whether to enable this feature.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'Prompt' => ['description' => 'The prompt.', 'type' => 'string', 'title' => '', 'example' => 'Provide a concise title for this monitoring section, capturing the core subject and key event. Keep the title within 10 characters.'], + ], + 'title' => '', + 'example' => '', + ], + 'ImageInsightsConfig' => [ + 'description' => 'The image content recognition configuration.', + 'type' => 'object', + 'properties' => [ + 'Caption' => ['description' => 'The image content recognition Caption configuration.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ImageInsightsCaptionConfig'], + ], + 'title' => '', + 'example' => '', + ], + 'ImageReverseImageConfig' => [ + 'description' => 'The image-to-image search configuration.', + 'type' => 'object', + 'properties' => [ + 'Enable' => ['description' => 'Specifies whether to enable the feature.', 'type' => 'boolean', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], 'ImageScore' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'OverallQualityScore' => ['title' => '', '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", 'type' => 'number', 'format' => 'float', 'example' => '0.736', 'visibility' => 'Public', 'backendName' => 'OverallQualityScore'], ], + 'visibility' => 'Public', + 'example' => '', ], 'Input' => [ - 'title' => 'A short description of struct', - 'description' => 'The data input configuration.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'The input configuration object for data ingestion.', 'type' => 'object', 'properties' => [ - 'OSS' => [ - 'description' => 'The input data source from Object Storage Service (OSS).'."\n", - 'visibility' => 'public', - 'backendName' => 'OSS', - '$ref' => '#/components/schemas/InputOSS', - ], + 'OSS' => ['description' => 'The OSS data source.', '$ref' => '#/components/schemas/InputOSS', 'title' => '', 'example' => ''], ], + 'example' => '', ], 'InputFile' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'URI' => ['title' => '', '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", 'type' => 'string', 'example' => 'oss://test-bucket/test-object'], + 'CustomId' => ['title' => '', '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", 'type' => 'string', 'example' => 'member-image-id-0001'], + 'CustomLabels' => ['title' => '', '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", 'type' => 'object', 'example' => '{'."\n" + .' "MemberName": "Tim",'."\n" + .' "Enabled": "True",'."\n" + .' "ItemCount": "10"'."\n" + .'}'], + 'FileHash' => ['title' => '', '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", 'type' => 'string', 'example' => '1d9c280a7c4f67f7ef873e28449dbe17'], + 'OSSURI' => ['title' => '', '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", 'type' => 'string', 'example' => 'oss://test-bucket/test-object.jpg'], 'MediaType' => [ - 'title' => 'MediaType', + 'title' => '', 'description' => 'In most cases, you can leave this parameter empty. The media type of the file.'."\n" ."\n" .'Enumerated values:'."\n" @@ -4116,430 +1592,197 @@ .'* archive'."\n" .'* video'."\n" .'* audio'."\n", - 'visibility' => 'public', 'type' => 'string', - 'enumValueTitles' => [ - 'image' => '', - 'other' => '', - 'document' => '', - 'archive' => '', - 'video' => '', - 'audio' => '', - ], + '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', ], + 'ContentType' => ['title' => '', 'description' => 'In most cases, you can leave this parameter empty. The Multipurpose Internet Mail Extensions (MIME) type of the file.'."\n", 'type' => 'string', 'example' => 'image/jpeg'], 'Figures' => [ - 'title' => 'Figures', + 'title' => '', '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', - ], + 'FigureId' => ['title' => '', 'description' => 'The person ID.'."\n", 'type' => 'string', 'example' => '2cb3c51e-b406-4b0c-af1b-897d88e1****'], + 'FigureClusterId' => ['title' => '', '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", 'type' => 'string', 'example' => 'Cluster-dbe72fec-b84c-4ab6-885b-3678e64****'."\n"], 'FigureType' => [ - 'title' => 'FigureType', + 'title' => '', 'description' => 'The figure type. Set this parameter to `face`.'."\n", - 'visibility' => 'public', 'type' => 'string', - 'enumValueTitles' => [ - 'face' => 'face', - ], + 'enumValueTitles' => ['face' => 'face'], 'example' => 'face', - 'backendName' => 'FigureType', ], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - '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', + 'example' => '', ], + 'LatLong' => ['title' => '', 'description' => 'The GPS latitude and longitude information.'."\n", 'type' => 'string', 'example' => '30.134390,120.074997'], + 'ProduceTime' => ['title' => '', 'description' => 'The time when the image was taken.'."\n", 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00'], + 'Title' => ['title' => '', 'description' => 'The file title.'."\n", 'type' => 'string', 'example' => 'test'], + 'Artist' => ['title' => '', 'description' => 'The artist.'."\n", 'type' => 'string', 'example' => 'Jane'], + 'AlbumArtist' => ['title' => '', 'description' => 'The album artist.'."\n", 'type' => 'string', 'example' => 'Jane'], + 'Composer' => ['title' => '', 'description' => 'The composer.'."\n", 'type' => 'string', 'example' => 'Jane'], + 'Performer' => ['title' => '', 'description' => 'The performer.'."\n", 'type' => 'string', 'example' => 'Jane'], + 'Album' => ['title' => '', 'description' => 'The album.'."\n", 'type' => 'string', 'example' => 'FirstAlbum'], 'Labels' => [ - 'title' => 'Labels', + 'title' => '', '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', + 'items' => ['description' => 'The object that stores information about the intelligent label.'."\n", '$ref' => '#/components/schemas/Label', 'title' => '', 'example' => ''], + 'example' => '', ], 'Addresses' => [ - 'title' => 'Addresses', + 'title' => '', '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', + 'items' => ['description' => 'The address information.'."\n", '$ref' => '#/components/schemas/Address', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], 'InputOSS' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'Bucket' => ['title' => '', 'description' => 'The name of the OSS bucket.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-bucket', 'visibility' => 'Public', 'backendName' => 'Bucket'], + 'Prefix' => ['title' => '', 'description' => 'The object key prefix.'."\n", 'type' => 'string', 'example' => 'test-object', 'visibility' => 'Public', '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', - ], + 'items' => ['description' => 'The match mode.'."\n", 'type' => 'string', 'example' => 'key prefix (abc)', 'visibility' => 'Public', 'extendType' => 'true', 'title' => ''], + 'visibility' => 'Public', 'backendName' => 'MatchExpressions', + 'example' => '', ], ], + 'visibility' => 'Public', + 'example' => '', ], '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', - ], + 'Video' => ['description' => 'The summary and description of the video.'."\n", '$ref' => '#/components/schemas/VideoInsight', 'title' => '', 'example' => ''], + 'Image' => ['description' => 'The summary and description of the image.'."\n", '$ref' => '#/components/schemas/ImageInsight', 'title' => '', 'example' => ''], ], - 'nullable' => true, + 'title' => '', + 'example' => '', + ], + 'InsightsConfig' => [ + 'description' => 'The content-aware configuration.', + 'type' => 'object', + 'properties' => [ + 'Language' => ['title' => '', 'description' => 'The language.', 'type' => 'string', 'example' => 'zh-Hans'], + 'Video' => ['description' => 'The video content-aware configuration.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/VideoInsightsConfig'], + 'Image' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ImageInsightsConfig'], + ], + 'title' => '', + 'example' => '', + ], + 'InsightsLabel' => [ + 'description' => 'The label.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The label name.', 'type' => 'string', 'title' => '', 'example' => '摔倒'], + 'Description' => ['description' => 'The label description.', 'type' => 'string', 'title' => '', 'example' => '有人摔倒'], + ], + 'title' => '', + 'example' => '', ], 'KdtreeOption' => [ - 'title' => 'KdtreeOption', + 'title' => '', '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', - ], + 'CompressionLevel' => ['title' => '', 'description' => 'The compression level. Valid values: 0 to 10. A greater value specifies a higher compression ratio and ensures better detail effects.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10', 'minimum' => '0', 'example' => '5', 'visibility' => 'Public', 'backendName' => 'CompressionLevel'], + 'QuantizationBits' => ['title' => '', '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", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '31', 'minimum' => '0', 'example' => '10', 'visibility' => 'Public', 'backendName' => 'QuantizationBits'], 'LibraryName' => [ - 'title' => 'LibraryName', + 'title' => '', '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', + 'default' => 'draco', + 'enum' => ['draco'], + 'visibility' => 'Public', 'backendName' => 'LibraryName', 'trim' => true, - 'default' => 'draco', - 'enum' => [ - 'draco', - ], ], ], + 'visibility' => 'Public', + 'example' => '', ], 'KeyValuePair' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'Key' => ['title' => '', 'description' => 'The key.'."\n", 'type' => 'string', 'example' => 'bucket', 'visibility' => 'Public', 'backendName' => 'Key'], + 'Value' => ['title' => '', 'description' => 'The value.'."\n", 'type' => 'string', 'example' => 'testbucket', 'visibility' => 'Public', 'backendName' => 'Value'], ], + 'visibility' => 'Public', + 'example' => '', ], 'Label' => [ - 'title' => 'A short description of struct', - 'description' => 'The label information.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'Tag information.', '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', + 'Language' => ['title' => '', 'description' => 'The tag language, in BCP 47 format.', 'type' => 'string', 'example' => 'zh-Hans'], + 'LabelName' => ['title' => '', 'description' => 'The tag name.', 'type' => 'string', 'example' => '椅子'], + 'LabelLevel' => ['title' => '', 'description' => 'The tag level. Valid values are 1, 2, and 3, representing first-level, second-level, and third-level tags, respectively.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'LabelConfidence' => ['title' => '', 'description' => 'The tag confidence level. The value ranges from 0 (lowest confidence) to 1 (highest confidence).', 'type' => 'number', 'format' => 'float', 'example' => '0.95'], + 'ParentLabelName' => ['title' => '', 'description' => 'The parent tag name.', 'type' => 'string', 'example' => '家具'], + 'CentricScore' => ['title' => '', 'description' => 'The centric score of the tag. This indicates whether the tag is the main subject in the image. The value ranges from 0 to 1. A higher value indicates higher confidence that the tag is the main subject of the image.', 'type' => 'number', 'format' => 'float', 'example' => '0.877'], + 'LabelAlias' => ['description' => 'The tag alias.', 'type' => 'string', 'title' => '', 'example' => '座椅'], + 'Clips' => [ + 'type' => 'array', + 'items' => ['description' => 'Event clips.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/Clip'], + 'description' => 'Event clips.', + 'title' => '', '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', ], ], + 'example' => '', ], 'LicensePlate' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'The license plate.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ 'Content' => [ 'title' => '', 'description' => 'The license plate number.'."\n", - 'visibility' => 'public', 'type' => 'string', 'enumValueTitles' => [], - 'example' => '', + 'example' => '鲁A8***8', + 'visibility' => 'Public', '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', - ], + 'Boundary' => ['title' => '', 'description' => 'The boundary information of the license plate.'."\n", '$ref' => '#/components/schemas/Boundary', 'visibility' => 'Public', 'backendName' => 'Boundary', 'example' => ''], + 'Confidence' => ['title' => '', 'description' => 'The confidence level.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '0.789', 'visibility' => 'Public', 'backendName' => 'Confidence'], ], + 'visibility' => 'Public', + 'example' => '', ], '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', - ], + 'Title' => ['title' => '', 'description' => 'The custom title.'."\n", 'type' => 'string', 'example' => '杭州一日游', 'visibility' => 'Public', 'backendName' => 'Title'], 'LocationDateClusterLevel' => [ 'title' => '', 'description' => 'The administrative level of the spatiotemporal cluster.'."\n" @@ -4551,1116 +1794,459 @@ .'* city'."\n" .'* district'."\n" .'* township'."\n", - 'visibility' => 'public', 'type' => 'string', - 'enumValueTitles' => [ - 'country' => '', - 'province' => '', - 'city' => '', - 'district' => '', - 'township' => '', - ], + 'enumValueTitles' => ['country' => '国家或地区', 'province' => '省', 'city' => '市', 'district' => '区', 'township' => '街道'], 'example' => 'province', + 'visibility' => 'Public', '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', - ], + 'LocationDateClusterStartTime' => ['title' => '', 'description' => 'The start time of the spatiotemporal cluster.'."\n", 'type' => 'string', 'example' => '2022-05-01T00:00:00+08:00', 'visibility' => 'Public', 'backendName' => 'LocationDateClusterStartTime'], + 'LocationDateClusterEndTime' => ['title' => '', 'description' => 'The end time of the spatiotemporal cluster.'."\n", 'type' => 'string', 'example' => '2022-05-02T23:59:59.999999999+08:00', 'visibility' => 'Public', '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', - ], + 'items' => ['description' => 'The address.'."\n", '$ref' => '#/components/schemas/Address', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', 'backendName' => 'Addresses', + 'example' => '', ], - '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', - ], + 'ObjectId' => ['title' => '', 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'location-date-cluster-14f48cb3-079d-4595-80c4-5735284b****', 'visibility' => 'Public', 'backendName' => 'ObjectId'], + 'UpdateTime' => ['title' => '', 'description' => 'The time when the spatiotemporal cluster was updated.'."\n", 'type' => 'string', 'example' => '2022-11-16T13:15:05.65746784+08:00', 'visibility' => 'Public', 'backendName' => 'UpdateTime'], + 'CreateTime' => ['title' => '', 'description' => 'The time when the spatiotemporal cluster was created.'."\n", 'type' => 'string', 'example' => '2022-11-16T13:14:34.882523669+08:00', 'visibility' => 'Public', 'backendName' => 'CreateTime'], + 'CustomId' => ['title' => '', 'description' => 'The custom ID.'."\n", 'type' => 'string', 'example' => 'user-01', 'visibility' => 'Public', 'backendName' => 'CustomId'], + 'CustomLabels' => ['title' => '', 'description' => 'The custom labels.'."\n", 'type' => 'object', 'example' => '{'."\n" + .' "User": "Jane"'."\n" + .'}', 'visibility' => 'Public', 'backendName' => 'CustomLabels'], ], + 'visibility' => 'Public', + 'example' => '', ], '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', - ], - ], + 'CreateTime' => ['description' => 'The time when the message was created.'."\n", 'type' => 'string', 'title' => '', 'example' => '2022-01-14T10:10:52.83948013+08:00'], + 'Regenerate' => ['description' => 'Indicates whether the message is a regenerated answer.'."\n", 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'Score' => ['description' => 'Rate'."\n", 'type' => 'number', 'title' => '', 'format' => 'double', 'example' => '0.99'], + 'AssistantType' => ['description' => 'Assistant type.'."\n", 'type' => 'string', 'title' => '', 'example' => 'doc/translate'], + 'DatasetName' => ['description' => 'The dataset that the answer references to.'."\n", 'type' => 'string', 'title' => '', 'example' => 'test-dataset'], + 'SourceURI' => ['description' => 'The URI of the source file from which the answer was generated.'."\n", 'type' => 'string', 'title' => '', 'example' => 'oss://test-bucket/sample.docx'], + 'Topic' => ['description' => 'The topic in the question.'."\n", 'type' => 'string', 'title' => '', 'example' => '根据 AssistantType 不同具体含义不同。'], + 'Content' => ['description' => 'The content of the question.'."\n", 'type' => 'string', 'title' => '', 'example' => '你好，哪个公园距离我最近？'], + 'Language' => ['description' => 'The language of the answer.'."\n", 'type' => 'string', 'title' => '', 'example' => 'zh-Hans'], + 'Tone' => ['description' => 'The tone of the answer.'."\n", 'type' => 'string', 'title' => '', 'example' => 'professional'], + 'Reply' => ['description' => 'The answer.'."\n", 'type' => 'string', 'title' => '', 'example' => '你好，我是你的助手'], + 'Suggestion' => ['description' => 'The compliance check results. Valid values: pass block'."\n", 'type' => 'string', 'title' => '', 'example' => 'pass'], + ], + 'example' => '', ], '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', - ], + 'Identifier' => ['title' => '', 'description' => 'The model type identifier.'."\n", 'type' => 'string', 'example' => 'detection', 'visibility' => 'Public', 'backendName' => 'Identifier'], + 'Version' => ['title' => '', 'description' => 'The model version.'."\n", 'type' => 'string', 'example' => 'v1', 'visibility' => 'Public', 'backendName' => 'Version'], + 'Provider' => ['title' => '', 'description' => 'The model provider.'."\n", 'type' => 'string', 'example' => 'imm', 'visibility' => 'Public', 'backendName' => 'Provider'], ], + 'visibility' => 'Public', + 'example' => '', ], 'MNS' => [ - 'title' => 'A short description of struct', - 'description' => 'The Simple Message Queue (SMQ) notification configuration.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'Message notification parameters for ApsaraMQ for MNS.', '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', - ], + 'TopicName' => ['description' => 'Specifies the name of the ApsaraMQ for MNS topic, which can be found in the topic list for the current region in the left-side navigation pane of the [ApsaraMQ for MNS console](https://mns.console.aliyun.com/). This parameter is required for ApsaraMQ for MNS message notification.', 'type' => 'string', 'title' => '', 'example' => 'topic1'], ], + 'example' => '', ], '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', - ], + 'MetaData' => ['description' => 'The basic model information.'."\n", 'required' => true, '$ref' => '#/components/schemas/MetaData', 'visibility' => 'Public', 'backendName' => 'MetaData', 'title' => '', 'example' => ''], + 'Spec' => ['description' => 'The model specification information.'."\n", 'required' => true, '$ref' => '#/components/schemas/Spec', 'visibility' => 'Public', 'backendName' => 'Spec', 'title' => '', 'example' => ''], ], + 'visibility' => 'Public', + 'example' => '', ], '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" + 'description' => 'The notification object. It supports multiple message middleware. For more information about the message format, see [Asynchronous notification message format](~~2743997~~). Choose one of the following methods to receive 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" + .'- Activate and integrate with the [EventBridge](~~161886~~) service in the same region as Intelligent Media Management (IMM) to receive task notifications promptly. 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" + .'- Activate the [MNS](~~27412~~) service in the same region as IMM and configure a 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" + .'- Activate the [RocketMQ](~~29530~~) service in the same region as IMM, and create a RocketMQ 4.0 instance, Topic, and Group.'."\n" + ."\n\n" + .' ><notice>'."\n" ."\n" - .' **'."\n" + .' The Notification object does not support custom webhook addresses.'."\n" ."\n" - .' **Note** The Notification object does not support custom callback URLs.'."\n", - 'visibility' => 'public', + .' ></notice>', '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', - ], + 'MNS' => ['title' => '', 'description' => 'The MNS notification parameter object.', '$ref' => '#/components/schemas/MNS', 'example' => ''], + 'RocketMQ' => ['title' => '', 'description' => 'The RocketMQ notification parameter object.', '$ref' => '#/components/schemas/RocketMQ', 'example' => ''], + 'ExtendedMessageURI' => ['title' => '', 'description' => 'Use an Object Storage Service (OSS) file to receive task notifications. If you provide the URI of this file, detailed task execution information is written to the file in a JSON structure. Normally, you receive notifications through [EventBridge](~~161886~~), [MNS](~~27412~~), or [RocketMQ](~~29530~~). However, some tasks generate large amounts of information, such as archive previews or decompression tasks. For these tasks, provide this file to get the complete execution results.'."\n" + ."\n" + .'The OSS URI format is oss\\://${Bucket}/${Object}. `${Bucket}` is the name of an OSS bucket in the same region as the current project. `${Object}` is the full path of the file, including the file name extension.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'This file is not a notification method. It only serves as a medium to receive detailed task execution information. Task status is sent through standard message notifications. This file contains only the detailed execution information.'."\n" + ."\n" + .'></notice>', 'type' => 'string', 'example' => 'oss://test-bucket/test-object.json'], ], + 'title' => '', + 'example' => '', ], 'OCRContents' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'Language' => ['title' => '', 'description' => 'The BCP 47 language code. This parameter is not supported in the current version.'."\n", 'type' => 'string', 'example' => 'zh-hans', 'visibility' => 'Public', 'backendName' => 'Language'], + 'Contents' => ['title' => '', 'description' => 'The content.'."\n", 'type' => 'string', 'example' => '欢迎使用智能媒体管理', 'visibility' => 'Public', 'backendName' => 'Contents'], + 'Confidence' => ['title' => '', '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", 'type' => 'number', 'format' => 'float', 'example' => '0.8254936695098877', 'visibility' => 'Public', 'backendName' => 'Confidence'], + 'Boundary' => ['title' => '', 'description' => 'The boundary information.'."\n", '$ref' => '#/components/schemas/Boundary', 'visibility' => 'Public', 'backendName' => 'Boundary', 'example' => ''], ], + 'visibility' => 'Public', + 'example' => '', ], 'OctreeOption' => [ - 'title' => 'OctreeOption', + 'title' => '', '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', + 'title' => '', 'description' => 'The point cloud resolution. This parameter determines the precision of the point coordinates during encoding. Default value: 0.01.'."\n", 'type' => 'number', 'format' => 'double', 'maximum' => '1', 'minimum' => '0', 'example' => '0.01', 'default' => '0.01', 'visibility' => 'Public', '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', ], + 'OctreeResolution' => ['title' => '', '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", 'type' => 'number', 'format' => 'double', 'maximum' => '1', 'minimum' => '0', 'example' => '0.01', 'default' => '0.01', 'visibility' => 'Public', 'backendName' => 'OctreeResolution'], + 'DoVoxelGridDownDownSampling' => ['title' => '', '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", 'type' => 'boolean', 'example' => 'false', 'default' => 'false', 'visibility' => 'Public', 'backendName' => 'DoVoxelGridDownDownSampling'], 'LibraryName' => [ - 'title' => 'LibraryName', + 'title' => '', 'description' => 'The library name. Set the value to pcl. Default value: pcl.'."\n", - 'visibility' => 'public', 'type' => 'string', 'example' => 'pcl', + 'default' => 'pcl', + 'enum' => ['pcl'], + 'visibility' => 'Public', 'backendName' => 'LibraryName', 'trim' => true, - 'default' => 'pcl', - 'enum' => [ - 'pcl', - ], ], ], + 'visibility' => 'Public', + 'example' => '', ], 'Optimization' => [ 'title' => '', 'description' => 'Optimization algorithm information.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'LearningRate' => [ + 'LearningRate' => ['title' => '', 'description' => 'The initial learning rate.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0.01'], + 'Optimizer' => ['title' => '', 'description' => 'The optimization method.'."\n", 'type' => 'string', 'example' => 'SGD'], + ], + 'example' => '', + ], + 'PaperDescription' => [ + 'description' => 'The document guide result.', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => 'The guide result.', + 'type' => 'array', + 'items' => ['description' => 'The navigation result.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/Summary'], 'title' => '', - 'description' => 'The initial learning rate.'."\n", - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.01', - 'backendName' => 'LearningRate', + 'example' => '', ], - 'Optimizer' => [ + 'TitleID' => [ + 'description' => 'The section heading included in the guide result.', + 'type' => 'array', + 'items' => ['description' => 'The section title.', 'type' => 'string', 'title' => '', 'example' => 'f79aa209-b08b-4d7d-984f-21e77c21541b'], 'title' => '', - 'description' => 'The optimization method.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SGD', - 'backendName' => 'Optimizer', + 'example' => '', ], ], + 'title' => '', + 'example' => '', + ], + 'PersonReferenceConfig' => [ + 'type' => 'object', + 'properties' => [ + 'Enable' => ['description' => 'Specifies whether to enable person referencing. Set to `true` to enable this feature. The default value is `false`.', 'type' => 'boolean', 'title' => '', 'example' => ''], + ], + 'description' => 'Specifies the configuration for person referencing.', + 'title' => '', + 'example' => '', ], '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', - ], + 'X' => ['title' => '', 'description' => 'The distance from the X-coordinate of the vertex to the left edge. Unit: pixel.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'visibility' => 'Public', 'backendName' => 'X'], + 'Y' => ['title' => '', 'description' => 'The distance from the Y-coordinate of the vertex to the top. Unit: pixel.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'visibility' => 'Public', 'backendName' => 'Y'], ], + 'visibility' => 'Public', + 'example' => '', ], - 'PresetReference' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'visibility' => 'Private', + 'PPTDetails' => [ + 'description' => 'The PPT information.', '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', - ], + 'StartTime' => ['description' => 'The time in the video.', 'type' => 'integer', 'title' => '', 'example' => '5000', 'format' => 'int64'], + 'PPTShotIndex' => ['description' => 'The index of the PPT frame capture.', 'type' => 'integer', 'title' => '', 'example' => '0', 'format' => 'int64'], + 'ImagePath' => ['description' => 'The image path of the PPT frame capture.', 'type' => 'string', 'title' => '', 'example' => '"ppts/video_snapshots_0.jpg"'], ], - 'deprecated' => false, + 'title' => '', + 'example' => '', ], 'Project' => [ 'title' => '', - 'description' => 'The project information.'."\n", - 'visibility' => 'public', + 'description' => 'The project information.', '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', - ], + 'ProjectName' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'immtest'], + 'ServiceRole' => ['title' => '', 'description' => 'The service role.', 'type' => 'string', 'example' => 'AliyunIMMDefaultRole'], + 'TemplateId' => ['title' => '', 'description' => 'The workflow template ID.', 'type' => 'string', 'example' => 'Official:ImageManagement'], + 'CreateTime' => ['title' => '', 'description' => 'The timestamp when the project was created, in RFC3339Nano format.', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00'], + 'UpdateTime' => ['title' => '', 'description' => 'The timestamp when the project was last modified, in RFC3339Nano format.'."\n" + ."\n" + .'> If the project has not been updated since it was created, the modification timestamp is the same as the creation timestamp.', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00'], + 'Description' => ['title' => '', 'description' => 'The description of the project.', 'type' => 'string', 'example' => 'test project'], + 'ProjectQueriesPerSecond' => ['title' => '', 'description' => 'The maximum number of requests that the project can process per second. This specifies the maximum number of API calls allowed per second for all APIs in the project. Default value: 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'EngineConcurrency' => ['title' => '', 'description' => 'The maximum number of tasks that the project can process per second. This specifies the maximum number of operators across the project that can run in parallel at the same time. Default value: 100.'."\n" + ."\n" + .'- Synchronous tasks: if the number of concurrent tasks exceeds this limit, task execution time increases until a timeout occurs.'."\n" + ."\n" + .'- Asynchronous tasks: if the number of concurrent tasks exceeds this limit, tasks are queued for a period of time, which delays task completion. If the queuing time also exceeds the limit (typically tens of minutes), the task returns a failure.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'ProjectMaxDatasetCount' => ['title' => '', 'description' => 'The maximum number of datasets in the project. Valid values: 1 to 1000000000. Default value: 1000000000.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000000000'], + 'DatasetMaxBindCount' => ['title' => '', 'description' => 'The maximum number of bindings per dataset. Valid values: 1 to 10. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'DatasetMaxFileCount' => ['title' => '', 'description' => 'The maximum number of files per dataset. Valid values: 1 to 100000000. Default value: 100000000.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000000'], + 'DatasetMaxEntityCount' => ['title' => '', 'description' => 'The maximum number of metadata entities per dataset. Default value: 10000000000.'."\n" + ."\n" + .'> This field is reserved for future use and is not enforced.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000000000'], + 'DatasetMaxRelationCount' => ['title' => '', 'description' => 'The maximum number of metadata relationships per dataset. Default value: 100000000000.'."\n" + ."\n" + .'> This field is reserved for future use and is not enforced.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000000000'], + 'DatasetMaxTotalFileSize' => ['title' => '', 'description' => 'The maximum total file size per dataset, in bytes. After this limit is exceeded, no more indexes can be added. Default value: 90000000000000000.', 'type' => 'integer', 'format' => 'int64', 'example' => '90000000000000000'], + 'DatasetCount' => ['title' => '', 'description' => 'The current number of datasets in the project.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'FileCount' => ['title' => '', 'description' => 'The current number of files in the project.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'TotalFileSize' => ['title' => '', 'description' => 'The current total file size in the project, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000'], 'Tags' => [ 'title' => '', - 'description' => 'The tag list.'."\n", - 'visibility' => 'Public', + 'description' => 'The list of tags.', 'type' => 'array', 'items' => [ - 'description' => 'The tags.'."\n", - 'visibility' => 'Public', + 'description' => 'The tag information.', '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', - ], + 'TagKey' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => 'TestKey'], + 'TagValue' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'example' => 'TestValue'], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'Tags', - 'itemName' => 'Tags', + 'example' => '', ], ], + 'example' => '', ], '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', - ], + '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", 'type' => 'string', 'example' => 'float', 'visibility' => 'Public', 'backendName' => 'ItemsType'], + 'ValueType' => ['title' => '', 'description' => 'The type of the property. Supported enumerated values: float, integer, string, and array.'."\n", 'type' => 'string', 'example' => 'array', 'visibility' => 'Public', 'backendName' => 'ValueType'], + 'Value' => ['title' => '', 'description' => 'The value.'."\n", 'type' => 'string', 'example' => '[40, 80, 160, 320]', 'visibility' => 'Public', 'backendName' => 'Value'], + 'Name' => ['title' => '', 'description' => 'The property name.'."\n", 'type' => 'string', 'example' => 'channels', 'visibility' => 'Public', 'backendName' => 'Name'], ], + 'visibility' => 'Public', + 'example' => '', ], 'ReferenceFile' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'ProjectName' => ['title' => '', 'description' => 'The name of the project.'."\n", 'type' => 'string', 'example' => 'test-project', 'visibility' => 'Public', 'backendName' => 'ProjectName'], + 'DatasetName' => ['title' => '', 'description' => 'The name of the dataset.'."\n", 'type' => 'string', 'example' => 'test-dataset', 'visibility' => 'Public', 'backendName' => 'DatasetName'], + 'ObjectId' => ['title' => '', 'description' => 'The unique ID of the file.'."\n", 'type' => 'string', 'example' => '75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7', 'visibility' => 'Public', 'backendName' => 'ObjectId'], + 'URI' => ['title' => '', 'description' => 'The URI of the file.'."\n", 'type' => 'string', 'example' => 'oss://test-bucket/test-object.jpg', 'visibility' => 'Public', 'backendName' => 'URI'], ], + 'visibility' => 'Public', + 'example' => '', ], 'RegionType' => [ - 'title' => 'RegionType', + 'title' => '', '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', - ], + 'RegionId' => ['title' => '', 'description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-beijing', 'visibility' => 'Public', 'backendName' => 'RegionId'], + 'LocalName' => ['title' => '', 'description' => 'The name of the region.'."\n", 'type' => 'string', 'example' => '华北2（北京）', 'visibility' => 'Public', 'backendName' => 'LocalName'], ], + 'visibility' => 'Public', + 'example' => '', ], 'Resource' => [ 'title' => '', 'description' => 'The resource.'."\n", + 'type' => 'object', + 'properties' => [ + 'ECSInstance' => ['title' => '', 'description' => 'The Elastic Compute Service (ECS) instance.'."\n", 'type' => 'string', 'example' => 'ecs.gn5i-c2g1.large', 'visibility' => 'Public', 'backendName' => 'ECSInstance'], + 'CPU' => ['title' => '', 'description' => 'The number of CPU cores. Valid values: 4 to 96.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'visibility' => 'Public', 'backendName' => 'CPU'], + 'GPUNum' => ['title' => '', 'description' => 'The number of GPUs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'GPUNum'], + 'Name' => ['title' => '', 'description' => 'The displayed name of the resource.'."\n", 'type' => 'string', 'example' => 'ecs.gn5i-c2g1.large-2vCPU-8GB-1*NVIDIA_P4', 'visibility' => 'Public', 'backendName' => 'Name'], + 'RAM' => ['title' => '', 'description' => 'The RAM size. Unit: GB. Valid values: 30 to 736.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'visibility' => 'Public', 'backendName' => 'RAM'], + 'GPUModel' => ['title' => '', 'description' => 'The GPU.'."\n", 'type' => 'string', 'example' => 'NVIDIA_P4', 'visibility' => 'Public', 'backendName' => 'GPUModel'], + ], 'visibility' => 'Public', + 'example' => '', + ], + 'ReverseImageConfig' => [ + 'description' => 'The image search configuration.', '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', - ], + 'Video' => ['description' => 'The image-to-video search configuration.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/VideoReverseImageConfig'], + 'Image' => ['description' => 'The image-to-image search configuration.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ImageReverseImageConfig'], ], + 'title' => '', + 'example' => '', ], 'RocketMQ' => [ - 'title' => 'A short description of struct', - 'description' => 'ApsaraMQ for RocketMQ parameters.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'RocketMQ message notification parameters.', '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', - ], + 'TopicName' => ['description' => 'The name of the RocketMQ topic. Required for RocketMQ message notifications.', 'type' => 'string', 'title' => '', 'example' => 'topic1'], + 'InstanceId' => ['description' => 'The RocketMQ instance ID. Required for RocketMQ message notifications.', 'type' => 'string', 'title' => '', 'example' => 'MQ_INST_11111111111_BYcNy2Nc'], ], + 'example' => '', ], 'Row' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'URI' => ['title' => '', '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", 'type' => 'string', 'example' => 'oss://examplebucket/exampleobject.jpg', 'visibility' => 'Public', 'backendName' => 'URI'], 'CustomLabels' => [ - 'title' => 'CustomLabels', + 'title' => '', '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', - ], + 'items' => ['description' => 'The key-value pair of the label.'."\n", '$ref' => '#/components/schemas/KeyValuePair', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', 'backendName' => 'CustomLabels', + 'example' => '', ], ], + 'visibility' => 'Public', + 'example' => '', ], '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', - ], + 'Hyperparameters' => ['description' => 'The hyperparameters.'."\n", 'required' => true, '$ref' => '#/components/schemas/Hyperparameters', 'visibility' => 'Public', 'backendName' => 'Hyperparameters', 'title' => '', 'example' => ''], + 'Resource' => ['description' => 'The resource.'."\n", 'required' => true, '$ref' => '#/components/schemas/Resource', 'visibility' => 'Public', 'backendName' => 'Resource', 'title' => '', 'example' => ''], ], + 'visibility' => 'Public', + 'example' => '', ], 'SceneElement' => [ 'title' => '', - 'description' => 'The video scene element.'."\n", - 'visibility' => 'Public', + 'description' => 'A video scene element.', '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', + 'description' => 'The time range of the video element. The array has a fixed length of 2. The two values represent the start time and end time in milliseconds.', 'type' => 'array', - 'items' => [ - 'description' => 'The time range of the video element.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - 'extendType' => 'true', - ], - 'backendName' => 'TimeRange', + 'items' => ['description' => 'The time range of the video element.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'example' => '', ], 'FrameTimes' => [ 'title' => '', - 'description' => 'The time points of frames that match the searched content within the element. Unit: milliseconds.'."\n", - 'visibility' => 'Public', + 'description' => 'The timestamps of the frames within the current video element that match the search content. The unit is milliseconds.', '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', + 'items' => ['description' => 'The timestamps, in milliseconds, of the frames in the current video element that match the search content.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'example' => '', + ], + 'VideoStreamIndex' => ['description' => 'The index of the video stream to which the current video scene element belongs. This corresponds to the index in the [VideoStreams](https://help.aliyun.com/zh/imm/developer-reference/api-imm-2020-09-30-detectmediameta?spm=a2c4g.11186623.0.0.463e600fIDdM8r#api-detail-40) array.', 'type' => 'integer', 'title' => '', 'example' => '0', 'format' => 'int64'], + 'Labels' => [ + 'type' => 'array', + 'items' => ['description' => 'The label information.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/Label'], + 'description' => 'The label information.', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], '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', - ], + 'Gamma' => ['title' => '', 'description' => 'The learning rate decay. This parameter takes effect only when LRScheduler is set to StepLR.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0.97', 'visibility' => 'Public', '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", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'StepSize'], + 'LRScheduler' => ['title' => '', 'description' => 'The learning rate scheduler.'."\n", 'type' => 'string', 'example' => 'StepLR', 'visibility' => 'Public', 'backendName' => 'LRScheduler'], ], + 'visibility' => 'Public', + 'example' => '', ], 'SimilarImage' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'URI' => ['title' => '', 'description' => 'The URI of the image.'."\n", 'type' => 'string', 'example' => 'oss://test-bucket/test-object', 'visibility' => 'Public', 'backendName' => 'URI'], + 'ImageScore' => ['title' => '', 'description' => 'The aesthetic score.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '0.709', 'visibility' => 'Public', 'backendName' => 'ImageScore'], ], + 'visibility' => 'Public', + 'example' => '', ], 'SimilarImageCluster' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'ObjectId' => ['title' => '', 'description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'SimilarImageCluster-748a041e-4ebc-4487-9e74-9c89b1****', 'visibility' => 'Public', 'backendName' => 'ObjectId'], + 'UpdateTime' => ['title' => '', 'description' => 'The time when the cluster was updated.'."\n", 'type' => 'string', 'example' => '2023-02-08T09:42:34.354969088+08:00', 'visibility' => 'Public', 'backendName' => 'UpdateTime'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.'."\n", 'type' => 'string', 'example' => '2023-02-08T09:42:34.354969088+08:00', 'visibility' => 'Public', 'backendName' => 'CreateTime'], + 'CustomLabels' => ['title' => '', 'description' => 'The custom tag.'."\n", 'type' => 'object', 'visibility' => 'Public', 'backendName' => 'CustomLabels', 'example' => ''], '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', - ], + 'items' => ['description' => 'The similar image.'."\n", '$ref' => '#/components/schemas/SimilarImage', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', 'backendName' => 'Files', + 'example' => '', ], ], + 'visibility' => 'Public', + 'example' => '', ], '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', - ], + 'Field' => ['title' => '', 'description' => 'This parameter is required. The field name. For a list of the supported fields, see [Supported fields and operators](~~252856~~).'."\n", 'type' => 'string', 'example' => 'Size', 'visibility' => 'Public', '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", 'type' => 'string', 'example' => '10', 'visibility' => 'Public', 'backendName' => 'Value'], 'Operation' => [ 'title' => '', 'description' => 'This parameter is required. The operator.'."\n" @@ -5679,23 +2265,13 @@ .'* 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' => '', + 'exist' => '存在性查询', 'not' => '逻辑非', 'or' => '逻辑或', 'prefix' => '前缀查询', 'and' => '逻辑与', 'lt' => '小于', 'match-phrase' => '字符串匹配查询', 'gte' => '大于等于', 'eq' => '等于', 'lte' => '小于等于', + 'gt' => '大于', 'nested' => '字段为数组时，其中同一对象内逻辑条件查询', ], 'example' => 'and', + 'visibility' => 'Public', 'backendName' => 'Operation', ], 'SubQueries' => [ @@ -5709,3044 +2285,1456 @@ .'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', - ], + 'items' => ['description' => 'The subquery condition.'."\n", '$ref' => '#/components/schemas/SimpleQuery', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', 'backendName' => 'SubQueries', + 'example' => '', ], ], + 'visibility' => 'Public', + 'example' => '', ], 'SmartCluster' => [ - 'title' => 'A short description of struct', - 'description' => 'The cluster created based on smart clustering.'."\n", - 'visibility' => 'Public', + 'title' => '', + 'description' => 'The intelligent grouping.', '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' => [ + 'OwnerId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '1023210024677934'], + 'ProjectName' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'MyProject'], + 'DatasetName' => ['title' => '', 'description' => 'The dataset name.', 'type' => 'string', 'example' => 'MyDataset'], + 'ObjectType' => ['title' => '', 'description' => 'The grouping type.', 'type' => 'string', 'example' => 'smart-cluster'], + 'ObjectId' => ['title' => '', 'description' => 'The intelligent grouping ID.', 'type' => 'string', 'example' => 'SmartCluster-12cd1645-deae-4b5e-9434-613747b75f6d'], + 'CreateTime' => ['title' => '', 'description' => 'The time when the grouping was created.', 'type' => 'string', 'example' => '2022-01-14T10:17:18.102700407+08:00'], + 'UpdateTime' => ['title' => '', 'description' => 'The time when the grouping was last updated.', 'type' => 'string', 'example' => '2022-01-14T10:17:18.102700407+08:00'], + 'Name' => ['title' => '', 'description' => 'The grouping name.', 'type' => 'string', 'example' => 'MySmartCluster1'], + 'Description' => ['title' => '', 'description' => 'The description of the grouping.', 'type' => 'string', 'example' => '这是一个智能分组的描述示例，它用于展示记录的格式。'], + 'ObjectStatus' => ['title' => '', 'description' => 'The status of the grouping.', 'type' => 'string', 'example' => 'Succeeded'], + 'ClusterType' => ['description' => 'The category of the grouping.', 'type' => 'string', 'title' => '', 'example' => 'figure'], + 'Rule' => ['description' => 'The grouping rule. This parameter is deprecated. Use the Rules parameter instead.', 'title' => '', '$ref' => '#/components/schemas/SmartClusterRule', 'example' => ''], + 'Rules' => [ + 'description' => 'The list of grouping rules.', + 'type' => 'array', + 'items' => ['description' => '分组规则', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/SmartClusterRule'], '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', ], + 'Reason' => ['description' => 'The reason why the grouping failed.', 'type' => 'string', 'title' => '', 'example' => '[InvalidArgument.BaseURIs] Each BaseURI must contain exactly one figure'], ], + 'example' => '', + ], + 'SmartClusterConfig' => [ + 'type' => 'object', + 'properties' => [ + 'Figure' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/FigureClusterConfig'], + ], + 'description' => 'The configuration object for a smart cluster.', + 'title' => '', + 'example' => '', ], 'SmartClusterRule' => [ - 'title' => 'A short description of struct', - 'description' => 'Intelligent clustering rule'."\n", - 'visibility' => 'Public', + 'title' => '', + 'description' => 'The intelligent grouping rule.', 'type' => 'object', 'properties' => [ 'Keywords' => [ 'title' => '', - 'description' => 'Keywords'."\n", - 'visibility' => 'Public', + 'description' => 'The keywords.', 'type' => 'array', - 'items' => [ - 'description' => 'Keyword'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Machine learning', - 'extendType' => 'true', - ], - 'backendName' => 'Keywords', + 'items' => ['description' => 'The keyword.', 'type' => 'string', 'example' => '机器学习', 'title' => ''], + 'example' => '', ], - 'Sensitivity' => [ + 'Sensitivity' => ['title' => '', 'description' => 'The sensitivity.', 'type' => 'number', 'format' => 'float', 'example' => '0.5'], + 'RuleType' => ['description' => 'The rule type.', 'type' => 'string', 'title' => '', 'example' => 'figure'], + 'BaseURIs' => [ + 'description' => 'The array of URIs for the reference files.', + 'type' => 'array', + 'items' => ['description' => 'The URI of the reference file.', 'type' => 'string', 'title' => '', 'example' => 'oss://testbucket/example_file'], 'title' => '', - 'description' => 'Sensitivity'."\n", - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - 'backendName' => 'Sensitivity', + 'example' => '', ], ], + 'example' => '', ], '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', - ], + 'Backbone' => ['description' => 'The custom parameters for model training.'."\n", '$ref' => '#/components/schemas/CustomParams', 'visibility' => 'Public', 'backendName' => 'Backbone', 'title' => '', 'example' => ''], + 'ClassNum' => ['title' => '', 'description' => 'The number of output classes of the last layer.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'visibility' => 'Public', 'backendName' => 'ClassNum'], + 'Head' => ['description' => 'The custom parameters for model training.'."\n", '$ref' => '#/components/schemas/CustomParams', 'visibility' => 'Public', 'backendName' => 'Head', 'title' => '', 'example' => ''], + 'Loss' => ['description' => 'The custom parameters for model training.'."\n", '$ref' => '#/components/schemas/CustomParams', 'visibility' => 'Public', 'backendName' => 'Loss', 'title' => '', 'example' => ''], + 'InputChannel' => ['title' => '', 'description' => '3'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'visibility' => 'Public', 'backendName' => 'InputChannel'], + 'Name' => ['title' => '', 'description' => 'The name of the model. The available model names vary with the model category.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ClsResNet', 'visibility' => 'Public', 'backendName' => 'Name'], + 'Neck' => ['description' => 'The custom parameters for model training.'."\n", '$ref' => '#/components/schemas/CustomParams', 'visibility' => 'Public', 'backendName' => 'Neck', 'title' => '', 'example' => ''], + '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", 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'visibility' => 'Public', 'backendName' => 'NumLandmarks'], + 'PretrainedPath' => ['title' => '', 'description' => 'The path to the pretrained model.'."\n", 'type' => 'string', 'example' => 'oss://bucket/abc/xxx.json', 'visibility' => 'Public', 'backendName' => 'PretrainedPath'], ], + 'visibility' => 'Public', + 'example' => '', ], 'Story' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'OwnerId' => ['title' => '', 'description' => 'The ID of the owner to which the story belongs.'."\n", 'type' => 'string', 'example' => '102321002****'], + 'ProjectName' => ['title' => '', 'description' => 'The name of the project.'."\n", 'type' => 'string', 'example' => 'immtest'], + 'DatasetName' => ['title' => '', 'description' => 'The name of the dataset.'."\n", 'type' => 'string', 'example' => 'dataset001'], + 'ObjectId' => ['title' => '', 'description' => 'The ID of the story object.'."\n", 'type' => 'string', 'example' => 'id1'], + 'ObjectType' => ['title' => '', 'description' => 'The type of the object.'."\n", 'type' => 'string', 'example' => 'story'], + 'UpdateTime' => ['title' => '', 'description' => 'The time when the story was updated.'."\n", 'type' => 'string', 'example' => '2022-01-14T10:17:18.102700407+08:00'], + 'CreateTime' => ['title' => '', 'description' => 'The time when the story was created.'."\n", 'type' => 'string', 'example' => '2022-01-14T10:17:18.102700407+08:00'], + 'StoryName' => ['title' => '', 'description' => 'The name of the story.'."\n", 'type' => 'string', 'example' => 'name1'], + 'StoryType' => ['title' => '', 'description' => 'The story type.'."\n", 'type' => 'string', 'example' => 'PeopleMemory'], + 'StorySubType' => ['title' => '', 'description' => 'The subtype of the story.'."\n", 'type' => 'string', 'example' => 'ImportantPerson'], + 'StoryStartTime' => ['title' => '', 'description' => 'The time when the story starts.'."\n", 'type' => 'string', 'example' => '2022-01-14T10:17:18.102700407+08:00'], + 'StoryEndTime' => ['title' => '', 'description' => 'The time when the story ends.'."\n", 'type' => 'string', 'example' => '2022-01-14T10:17:18.102700407+08:00'], 'Files' => [ - 'title' => 'Files', + 'title' => '', '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', + 'items' => ['description' => 'The story file.'."\n", '$ref' => '#/components/schemas/File', 'title' => '', 'example' => ''], + 'example' => '', ], + 'Cover' => ['description' => 'The story cover.'."\n", '$ref' => '#/components/schemas/File', 'title' => '', 'example' => ''], 'FigureClusterIds' => [ - 'title' => 'FigureClusterIds', + 'title' => '', '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', + 'items' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => '2cb3c51e-b406-4b0c-af1b-897d88e1****', 'title' => ''], + 'example' => '', ], + 'CustomId' => ['title' => '', 'description' => 'The custom ID.'."\n", 'type' => 'string', 'example' => 'test'], + 'CustomLabels' => ['title' => '', 'description' => 'The custom labels.'."\n", 'type' => 'object', 'required' => false, 'example' => '{"key": "val"}'], 'Addresses' => [ - 'title' => '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', + 'items' => ['description' => 'The address.'."\n", '$ref' => '#/components/schemas/Address', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], 'SubtitleStream' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'Index' => ['title' => '', 'description' => 'The index number of the subtitle stream.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'visibility' => 'Public', 'backendName' => 'Index'], + 'Language' => ['title' => '', 'description' => 'The subtitle language in the BCP 47 standard.'."\n", 'type' => 'string', 'example' => 'en', 'visibility' => 'Public', 'backendName' => 'Language'], + 'CodecName' => ['title' => '', 'description' => 'The abbreviated name of the codec.'."\n", 'type' => 'string', 'example' => 'mov_text', 'visibility' => 'Public', 'backendName' => 'CodecName'], + 'CodecLongName' => ['title' => '', 'description' => 'The full name of the codec.'."\n", 'type' => 'string', 'example' => 'MOV text', 'visibility' => 'Public', 'backendName' => 'CodecLongName'], + 'CodecTagString' => ['title' => '', 'description' => 'The description of the codec tag.'."\n", 'type' => 'string', 'example' => 'tx3g', 'visibility' => 'Public', 'backendName' => 'CodecTagString'], + 'CodecTag' => ['title' => '', 'description' => 'The tag of the codec.'."\n", 'type' => 'string', 'example' => '0x67337874', 'visibility' => 'Public', 'backendName' => 'CodecTag'], + 'StartTime' => ['title' => '', 'description' => 'The start time of the subtitle stream in seconds.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '0.000000', 'visibility' => 'Public', 'backendName' => 'StartTime'], + 'Duration' => ['title' => '', 'description' => 'The duration of the subtitle stream in seconds.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '71.378', 'visibility' => 'Public', 'backendName' => 'Duration'], + 'Bitrate' => ['title' => '', 'description' => 'The bitrate. Unit: bit/s.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '74', 'visibility' => 'Public', 'backendName' => 'Bitrate'], + 'Content' => ['title' => '', 'description' => 'The subtitle content.'."\n", 'type' => 'string', 'example' => '欢迎', 'visibility' => 'Public', 'backendName' => 'Content'], + 'Width' => ['title' => '', 'description' => 'The width of the subtitles. Unit: pixels.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '600', 'visibility' => 'Public', 'backendName' => 'Width'], + 'Height' => ['title' => '', 'description' => 'The height of the subtitles. Unit: pixels.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'visibility' => 'Public', 'backendName' => 'Height'], ], + 'visibility' => 'Public', + 'example' => '', ], 'TargetAudio' => [ - 'title' => 'Audio Struct', + 'title' => '', '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', - ], + 'DisableAudio' => ['title' => '', '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", 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public', 'backendName' => 'DisableAudio'], 'Stream' => [ - 'title' => 'Stream', + 'title' => '', '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', - ], + 'items' => ['description' => 'The index number of the audio stream.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'visibility' => 'Public', 'extendType' => 'true', 'title' => ''], + 'visibility' => 'Public', 'backendName' => 'Stream', + 'example' => '', ], 'TranscodeAudio' => [ - 'title' => 'TranscodeAudio', + 'title' => '', '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', - ], + 'Codec' => ['title' => '', '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", 'type' => 'string', 'example' => 'aac', 'visibility' => 'Public', 'backendName' => 'Codec'], + 'BitrateOption' => ['title' => '', '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", 'type' => 'string', 'example' => 'fixed', 'visibility' => 'Public', 'backendName' => 'BitrateOption'], + 'Bitrate' => ['title' => '', '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", 'type' => 'integer', 'format' => 'int32', 'example' => '64000', 'visibility' => 'Public', 'backendName' => 'Bitrate'], + 'Quality' => ['title' => '', '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", 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'visibility' => 'Public', 'backendName' => 'Quality'], + 'SampleRateOption' => ['title' => '', '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", 'type' => 'string', 'example' => 'fixed', 'visibility' => 'Public', 'backendName' => 'SampleRateOption'], + 'SampleRate' => ['title' => '', '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", 'type' => 'integer', 'format' => 'int32', 'example' => '12050', 'visibility' => 'Public', 'backendName' => 'SampleRate'], + 'Channel' => ['title' => '', '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", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'visibility' => 'Public', 'backendName' => 'Channel'], + 'BitsPerSample' => ['title' => '', 'description' => 'The audio bit depth. Valid values: 16 and 24.'."\n" + ."\n" + .'> This parameter takes effect only when Codec is set to flac.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'visibility' => 'Public', 'backendName' => 'BitsPerSample'], ], + 'visibility' => 'Public', 'backendName' => 'TranscodeAudio', + 'example' => '', ], 'FilterAudio' => [ - 'title' => 'FilterAudio', + 'title' => '', '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', - ], + 'Mixing' => ['title' => '', 'description' => 'Specifies whether to mix all sound tracks into a single track. Valid values:'."\n" + ."\n" + .'* false (default)'."\n" + .'* true'."\n", 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public', 'backendName' => 'Mixing'], ], + 'visibility' => 'Public', 'backendName' => 'FilterAudio', + 'example' => '', ], ], + 'visibility' => 'Public', + 'example' => '', ], 'TargetImage' => [ - 'title' => 'Image Struct', - 'description' => 'The information about the frames captured, sprites, or animated images.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'Image structure', 'type' => 'object', 'properties' => [ 'Sprites' => [ - 'title' => 'Sprites', - 'description' => 'The sprites.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'Sprites', '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', - ], - ], + 'ScaleType' => ['title' => '', 'description' => 'Scaling method', 'type' => 'string', 'example' => 'crop', 'visibility' => 'Public', 'backendName' => 'ScaleType'], + 'Mode' => ['type' => 'string', 'description' => '', 'example' => 'interval', 'title' => '', 'visibility' => 'Public', 'backendName' => 'mode'], + 'StartTime' => ['title' => '', 'description' => 'StartTime', 'type' => 'number', 'format' => 'double', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'StartTime', 'parseType' => 'struct'], + 'TileHeight' => ['title' => '', 'description' => 'Height of each sprite tile, in pixels', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'visibility' => 'Public', 'backendName' => 'TileHeight'], + 'URI' => ['title' => '', 'description' => 'URI', 'type' => 'string', 'required' => true, 'example' => 'oss://test-bucket/sprites', 'visibility' => 'Public', 'backendName' => 'URI'], + 'ScaleWidth' => ['title' => '', 'description' => 'Output width after scaling, in pixels', 'type' => 'number', 'format' => 'float', 'example' => '1280', 'visibility' => 'Public', 'backendName' => 'ScaleWidth'], + 'Pad' => ['title' => '', 'description' => 'Padding between sprite tiles, in pixels', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'visibility' => 'Public', 'backendName' => 'Pad'], + 'Format' => ['title' => '', 'description' => 'Image format', 'type' => 'string', 'required' => true, 'example' => 'jpg'."\n", 'visibility' => 'Public', 'backendName' => 'Format'], + 'Number' => ['title' => '', 'description' => 'Total number of sprites to generate', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'Number'], + 'ScaleHeight' => ['title' => '', 'description' => 'Output height after scaling, in pixels', 'type' => 'number', 'format' => 'float', 'example' => '960', 'visibility' => 'Public', 'backendName' => 'ScaleHeight'], + 'TileWidth' => ['title' => '', 'description' => 'Width of each sprite tile, in pixels', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'visibility' => 'Public', 'backendName' => 'TileWidth'], + 'Interval' => ['title' => '', 'description' => 'Time interval between sprites, in seconds', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1', 'visibility' => 'Public', 'backendName' => 'Interval', 'parseType' => 'struct'], + 'Margin' => ['title' => '', 'description' => 'Margin around the sprite grid, in pixels', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'visibility' => 'Public', 'backendName' => 'Margin'], + 'Threshold' => ['type' => 'integer', 'description' => '', 'format' => 'int32', 'example' => '0', 'title' => '', 'visibility' => 'Public', 'backendName' => 'Threshold'], + ], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', 'extendType' => 'true', ], + 'example' => '', + 'visibility' => 'Public', 'backendName' => 'Sprites', ], 'Animations' => [ - 'title' => 'Animations', - 'description' => 'The animated images.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'Animations', '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', - ], - ], + 'FrameRate' => ['title' => '', 'description' => 'Animation frame rate, in frames per second', 'type' => 'number', 'format' => 'double', 'example' => '25', 'visibility' => 'Public', 'backendName' => 'FrameRate', 'parseType' => 'struct'], + 'Format' => ['title' => '', 'description' => 'Format', 'type' => 'string', 'required' => true, 'example' => 'gif', 'visibility' => 'Public', 'backendName' => 'Format'], + 'Number' => ['title' => '', 'description' => 'Total number of animation frames to generate', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'visibility' => 'Public', 'backendName' => 'Number'], + 'ScaleType' => ['title' => '', 'description' => 'Scaling method', 'type' => 'string', 'example' => 'crop', 'visibility' => 'Public', 'backendName' => 'ScaleType'], + 'StartTime' => ['title' => '', 'description' => 'StartTime', 'type' => 'number', 'format' => 'double', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'StartTime', 'parseType' => 'struct'], + 'Height' => ['title' => '', 'description' => 'Height', 'type' => 'number', 'format' => 'double', 'example' => '960', 'visibility' => 'Public', 'backendName' => 'Height'], + 'URI' => ['title' => '', 'description' => 'The URI of the animation.', 'type' => 'string', 'required' => true, 'example' => 'oss://test-bucket/animations', 'visibility' => 'Public', 'backendName' => 'URI'], + 'Width' => ['title' => '', 'description' => 'Output width, in pixels', 'type' => 'number', 'format' => 'double', 'example' => '1280', 'visibility' => 'Public', 'backendName' => 'Width'], + 'Interval' => ['title' => '', 'description' => 'Time interval between animation frames, in seconds', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.5', 'visibility' => 'Public', 'backendName' => 'Interval', 'parseType' => 'struct'], + ], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', 'extendType' => 'true', ], + 'example' => '', + 'visibility' => 'Public', 'backendName' => 'Animations', ], 'Snapshots' => [ - 'title' => 'Snapshots', - 'description' => 'The frames.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'Snapshots', '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', - ], - ], + 'Format' => ['title' => '', 'description' => 'Image format', 'type' => 'string', 'required' => true, 'example' => 'jpg', 'visibility' => 'Public', 'backendName' => 'Format'], + 'Number' => ['title' => '', 'description' => 'The sequence number of the snapshot.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'visibility' => 'Public', 'backendName' => 'Number'], + 'ScaleType' => ['title' => '', 'description' => 'Scaling method', 'type' => 'string', 'example' => 'crop', 'visibility' => 'Public', 'backendName' => 'ScaleType'], + 'Mode' => ['type' => 'string', 'description' => '', 'example' => 'interval', 'title' => '', 'visibility' => 'Public', 'backendName' => 'Mode'], + 'StartTime' => ['title' => '', 'description' => 'The start time of the snapshot.', 'type' => 'number', 'format' => 'double', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'StartTime', 'parseType' => 'struct'], + 'Height' => ['title' => '', 'description' => 'Output height, in pixels', 'type' => 'number', 'format' => 'double', 'example' => '960', 'visibility' => 'Public', 'backendName' => 'Height'], + 'URI' => ['title' => '', 'description' => 'OSS URI where snapshots are stored', 'type' => 'string', 'required' => true, 'example' => 'oss://test-bucket/snapshots', 'visibility' => 'Public', 'backendName' => 'URI'], + 'Width' => ['title' => '', 'description' => 'The width of the snapshot.', 'type' => 'number', 'format' => 'double', 'example' => '1280', 'visibility' => 'Public', 'backendName' => 'Width'], + 'Interval' => ['title' => '', 'description' => 'Time interval between snapshots, in seconds', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.5', 'visibility' => 'Public', 'backendName' => 'Interval', 'parseType' => 'struct'], + 'Threshold' => ['type' => 'integer', 'description' => '', 'format' => 'int32', 'example' => '0', 'title' => '', 'visibility' => 'Public', 'backendName' => 'Threshold'], + ], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', 'extendType' => 'true', ], + 'example' => '', + 'visibility' => 'Public', 'backendName' => 'Snapshots', ], ], + 'example' => '', + 'visibility' => 'Public', ], 'TargetSubtitle' => [ - 'title' => 'Subtitle Struct', + 'title' => '', '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', - ], + 'DisableSubtitle' => ['title' => '', '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", 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public', 'backendName' => 'DisableSubtitle'], 'Stream' => [ - 'title' => 'Stream', + 'title' => '', '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', - ], + 'items' => ['description' => 'The index number of the subtitle stream that needs to be processed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'visibility' => 'Public', 'extendType' => 'true', 'title' => ''], + 'visibility' => 'Public', 'backendName' => 'Stream', + 'example' => '', ], 'ExtractSubtitle' => [ - 'title' => 'ExtractSubtitle', + 'title' => '', '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', - ], + 'URI' => ['title' => '', '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", 'type' => 'string', 'example' => 'oss://test-bucket/extractsubtitle', 'visibility' => 'Public', 'backendName' => 'URI'], + 'Format' => ['title' => '', 'description' => 'The format of the extracted subtitle file. Valid values:'."\n" + ."\n" + .'* ass'."\n" + .'* srt'."\n" + .'* webvtt'."\n", 'type' => 'string', 'example' => 'webvtt', 'visibility' => 'Public', 'backendName' => 'Format'], ], + 'visibility' => 'Public', 'backendName' => 'ExtractSubtitle', + 'example' => '', ], ], + 'visibility' => 'Public', + 'example' => '', ], 'TargetVideo' => [ - 'title' => 'Video Struct', - 'description' => 'The video processing settings.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'Parameter settings for video processing.', 'type' => 'object', 'properties' => [ - 'DisableVideo' => [ - 'title' => 'DisableVideo', - 'description' => 'Specifies whether to disable video stream generation. Valid values:'."\n" + 'DisableVideo' => ['description' => 'Specifies whether to disable video stream generation. Valid values:'."\n" + ."\n" + .'- true: Disables video stream generation. The output file will not contain a video stream.'."\n" + ."\n" + .'- false (default): Enables video stream generation.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'Stream' => [ + 'title' => '', + 'description' => 'A list of index numbers for the source video streams to process. If you leave this parameter empty (default), the system processes the video stream with the smallest index number (the first video stream). If you set the index number to a value greater than 100, the system processes all video streams.'."\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', + .'- Example: `[0,1]` processes video streams with index numbers 0 and 1. `[1]` processes the video stream with index number 1. `[101]` processes all video streams.'."\n" + ."\n" + .'> The system only processes video streams with existing index numbers. If a video stream corresponding to an index number does not exist, the system ignores that index number.', + 'type' => 'array', + 'items' => ['description' => 'The index number of the video stream to process.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'example' => '', ], '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" + 'title' => '', + 'description' => 'The video transcoding parameters. An empty value disables video processing. The output file will not contain a video stream.'."\n" ."\n" - .'> We recommend that you do not use this parameter to disable video stream generation.'."\n", - 'visibility' => 'public', + .'> Do not disable video processing by leaving this parameter empty.', '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', - ], + 'Codec' => ['description' => 'The video encoding format. Valid values:'."\n" + ."\n" + .'- For the CreateMediaConvert API: copy (default), h264, h265, and vp9.'."\n" + ."\n\n" + .' ><warning>'."\n" + ."\n" + .' If you set this parameter to copy, the system directly copies the video stream to the output file. In this case, the other parameters under **TranscodeVideo** are invalid. The copy value cannot be used for video concatenation and is typically used for container format conversion.'."\n" + ."\n" + .' ></warning>'."\n" + ."\n" + .'- For the GenerateVideoPlaylist API: h264 (default) and h265.', 'type' => 'string', 'title' => '', 'example' => 'h264'], + 'PixelFormat' => ['description' => 'The pixel format. By default, this is the same as the source video. Valid values:'."\n" + ."\n" + .'- yuv420p'."\n" + ."\n" + .'- yuv422p'."\n" + ."\n" + .'- yuv444p'."\n" + ."\n" + .'- yuv420p10le'."\n" + ."\n" + .'- yuv422p10le'."\n" + ."\n" + .'- yuv444p10le'."\n" + ."\n" + .'- yuva420p'."\n" + ."\n" + .'> The yuva420p value is available only for the CreateMediaConvert API, and the **Codec** parameter must be set to vp9.', 'type' => 'string', 'title' => '', 'example' => 'yuv420p'], + 'FrameRateOption' => ['description' => 'The frame rate option. Valid values:'."\n" + ."\n" + .'- fixed: Always uses the specified target video frame rate.'."\n" + ."\n" + .'- adaptive: Uses the source video frame rate if it is lower than the specified target video frame rate.'."\n" + ."\n" + .'- fall: The task fails if the source video frame rate is lower than the specified target video frame rate.'."\n" + ."\n" + .'Default value:'."\n" + ."\n" + .'- For the CreateMediaConvert API, the default value is fixed.'."\n" + ."\n" + .'- For the GenerateVideoPlaylist API, the default value is adaptive.'."\n" + ."\n" + .'> This parameter must be set together with the **FrameRate** parameter.', 'type' => 'string', 'title' => '', 'example' => 'fixed'], + 'FrameRate' => ['description' => 'The video frame rate. By default, this is the same as the source video.', 'type' => 'number', 'title' => '', 'format' => 'float', 'example' => '25'], + 'ResolutionOption' => ['description' => 'The resolution option. Valid values:'."\n" + ."\n" + .'- fixed: Always uses the specified target video resolution.'."\n" + ."\n" + .'- adaptive: Uses the source video resolution if its area is smaller than the area of the specified target video resolution.'."\n" + ."\n" + .'- fall: The task fails if the area of the source video resolution is smaller than the area of the specified target video resolution.'."\n" + ."\n" + .'Default value:'."\n" + ."\n" + .'- For the CreateMediaConvert API, the default value is fixed.'."\n" + ."\n" + .'- For the GenerateVideoPlaylist API, the default value is adaptive.'."\n" + ."\n" + .'> This parameter must be set together with the **Resolution** parameter.', 'type' => 'string', 'title' => '', 'example' => 'fixed'], + 'Resolution' => ['description' => 'The resolution of the output video in the format of `width × height`. By default, this is the same as the playback resolution of the source video. You can configure both width and height, or only width or height. You can also use this parameter with the **AdaptiveResolutionDirection** parameter to configure both the long and short edges, or only the long or short edge. The value for a single edge ranges from (0, 4096].'."\n" + ."\n" + .'- Example 1: If **AdaptiveResolutionDirection** is set to false, `1280x720` sets the width to 1280 and the height to 720. `1280x` sets the width to 1280 and keeps the height the same as the source video. `x720` sets the height to 720 and keeps the width the same as the source video.'."\n" + ."\n" + .'- Example 2: If **AdaptiveResolutionDirection** is set to true, `1280x720` sets the long edge to 1280 and the short edge to 720. `1280x` sets the long edge to 1280 and keeps the short edge the same as the source video. `x720` sets the short edge to 720 and keeps the long edge the same as the source video.'."\n" + ."\n" + .'> If the source video contains rotation information, the width, height, long edge, and short edge are determined based on the rotated video, which means the playback resolution is used.', 'type' => 'string', 'title' => '', 'example' => '640x480'], + 'AdaptiveResolutionDirection' => ['description' => 'Specifies whether to enable adaptive resolution for long and short edges. Valid values:'."\n" + ."\n" + .'- true: Yes. In this case, the format for the **Resolution** parameter is `long edge × short edge`.'."\n" + ."\n" + .'- false (default): No. In this case, the format for the **Resolution** parameter is `width × height`.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ScaleType' => ['description' => 'The scaling mode. Valid values:'."\n" + ."\n" + .'- stretch (default): Fixes the width and height or the long and short edges, and forces scaling to stretch and fill any blank areas.'."\n" + ."\n" + .'- crop: Scales the video proportionally to the minimum resolution that extends beyond the specified rectangle (defined by width/height or long/short edges), and then center-crops the excess parts.'."\n" + ."\n" + .'- fill: Scales the video proportionally to the maximum resolution that fits within the specified rectangle (defined by width/height or long/short edges), and then center-fills any blank areas with black.'."\n" + ."\n" + .'- fit: Scales the video proportionally to the maximum resolution that fits within the specified rectangle (defined by width/height or long/short edges).'."\n" + ."\n" + .'> This parameter must be set together with the **Resolution** parameter.', 'type' => 'string', 'title' => '', 'example' => 'crop'], + 'Rotation' => ['description' => 'The clockwise rotation angle of the video in degrees. Valid values:'."\n" + ."\n" + .'- 0 (default)'."\n" + ."\n" + .'- 90'."\n" + ."\n" + .'- 180'."\n" + ."\n" + .'- 270', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'example' => '90'], + 'BitrateOption' => ['description' => 'The video bitrate option. Valid values:'."\n" + ."\n" + .'- fixed: Always uses the specified target video bitrate.'."\n" + ."\n" + .'- adaptive: Uses the source video bitrate if it is lower than the specified target video bitrate.'."\n" + ."\n" + .'- fall: The task fails if the source video bitrate is lower than the specified target video bitrate.'."\n" + ."\n" + .'Default value:'."\n" + ."\n" + .'- For the CreateMediaConvert API, the default value is fixed.'."\n" + ."\n" + .'- For the GenerateVideoPlaylist API, the default value is adaptive.'."\n" + ."\n" + .'> This parameter must be set together with the **Bitrate** parameter.', 'type' => 'string', 'title' => '', 'example' => 'fixed'], + 'Bitrate' => ['description' => 'The video stream bitrate in bits per second (bit/s).'."\n" + ."\n" + .'> This parameter is mutually exclusive with **CRF**. If both this parameter and the **CRF** parameter are empty, the system encodes the video with a CRF value of 23.', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'example' => '128000'], + 'GOPSize' => ['description' => 'The size of the Group of Pictures (GOP) in frames. The default value is 150.'."\n" + ."\n" + .'> This parameter is not supported by the GenerateVideoPlaylist API.', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'example' => '60'], + 'CRF' => ['description' => 'Specifies the Constant Rate Factor (CRF) mode. This parameter is mutually exclusive with **Bitrate**. The value ranges from 0 to 51. A larger value indicates lower image quality. A value from 18 to 38 is recommended.', 'type' => 'number', 'title' => '', 'format' => 'float', 'example' => '18'], + 'BufferSize' => ['description' => 'The size of the decoding buffer for dynamic bitrate, in bits per second (bps).'."\n" + ."\n" + .'> This parameter is effective only when used with the **CRF** parameter.', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'example' => '4000000'], + 'MaxBitrate' => ['description' => 'The maximum bitrate limit for dynamic bitrate. When you use this parameter, you must also specify the BufferSize parameter.'."\n" + ."\n" + .'> This parameter is effective only when used with the **CRF** parameter.', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'example' => '128000'], + 'BFrames' => ['description' => 'The number of consecutive B-frames. The default value is 3.', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'example' => '3'], + 'Refs' => ['description' => 'The number of reference frames. The default value is 2.', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'example' => '2'], + 'VideoSlim' => ['description' => 'Enables the Narrowband HD mode. Set the value as follows:'."\n" + ."\n" + .'0: The default value. Disables the mode.'."\n" + ."\n" + .'1: Enables transcoding in Narrowband HD mode.'."\n" + ."\n" + .'> For best results, use the officially recommended Bitrate or CRF parameters for video transcoding and encoding in Narrowband HD mode.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'Narrowband HD only supports the h.264/h.265 format, yuv420p, and an 8-bit depth. It does not support transcoding output for multiple target videos or video concatenation. For more information, see [Introduction to Narrowband HD](~~2984556~~).'."\n" + ."\n" + .'></notice>', 'type' => 'integer', 'title' => '', 'example' => '0', 'format' => 'int32'], ], - 'backendName' => 'TranscodeVideo', + 'example' => '', ], '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" + 'title' => '', + 'description' => 'The video processing parameters. This parameter is invalid if **TranscodeVideo** is empty or if **TranscodeVideo.Codec** is set to copy.'."\n" ."\n" - .'> This parameter is not available to the GenerateVideoPlaylist operation.'."\n", - 'visibility' => 'public', + .'> You cannot set this parameter for the GenerateVideoPlaylist API.', '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', + 'Watermarks' => [ + 'title' => '', + 'description' => 'A list of video watermarks.', 'type' => 'array', 'items' => [ - 'description' => 'The video blurring parameters.'."\n", - 'visibility' => 'public', + 'description' => 'The video watermark information.', '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', - ], + 'Type' => ['description' => 'The watermark type. Valid values:'."\n" + ."\n" + .'- text (default): A text watermark.'."\n" + ."\n" + .'- file: An image or animated image watermark.', 'type' => 'string', 'title' => '', 'example' => 'text'], + 'Dx' => ['description' => 'The meaning of this parameter varies depending on whether the value is an integer or a decimal:'."\n" + ."\n" + .'- 0 (default): The pixel offset is 0. The ratio of the horizontal offset to the output video width is also 0.'."\n" + ."\n" + .'- Integer: The offset in pixels (px). The value ranges from 1 to 4096.'."\n" + ."\n" + .'- Decimal: The ratio of the horizontal offset to the output video width. The value ranges from (0, 1).', 'type' => 'number', 'title' => '', 'format' => 'float', 'example' => '0'], + 'Dy' => ['description' => 'The meaning of this parameter varies depending on whether the value is an integer or a decimal:'."\n" + ."\n" + .'- 0 (default): The pixel offset is 0. The ratio of the vertical offset to the output video height is also 0.'."\n" + ."\n" + .'- Integer: The offset in pixels (px). The value ranges from 1 to 4096.'."\n" + ."\n" + .'- Decimal: The ratio of the vertical offset to the output video height. The value ranges from (0, 1).', 'type' => 'number', 'title' => '', 'format' => 'float', 'example' => '0'], + 'StartTime' => ['description' => 'The start time for adding the watermark, in seconds (s). By default, the watermark is added from the beginning of the video.', 'type' => 'number', 'title' => '', 'format' => 'double', 'example' => '0'], + 'Duration' => ['description' => 'The duration for which the watermark is displayed, in seconds (s). By default, the watermark is displayed until the end of the video.', 'type' => 'number', 'title' => '', 'format' => 'double', 'example' => '0'], + 'ReferPos' => ['description' => 'The reference position for adding the watermark. Valid values:'."\n" + ."\n" + .'- topleft (default): The top-left corner.'."\n" + ."\n" + .'- topright: The top-right corner.'."\n" + ."\n" + .'- bottomright: The bottom-right corner.'."\n" + ."\n" + .'- bottomleft: The bottom-left corner.', 'type' => 'string', 'title' => '', 'example' => 'topleft'], + 'Content' => ['description' => 'The content of the text watermark. The default value is empty.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'This parameter is effective only when the `Type` parameter is set to `text`.'."\n" + ."\n" + .'></notice>', 'type' => 'string', 'title' => '', 'example' => 'example'], + 'FontName' => ['description' => 'The font name for the text watermark. Valid values:'."\n" + ."\n" + .'- SourceHanSans-Regular (default)'."\n" + ."\n" + .'- SourceHanSans-Bold'."\n" + ."\n" + .'- SourceHanSerif-Regular'."\n" + ."\n" + .'- SourceHanSerif-Bold'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'This parameter is effective only when the `Type` parameter is set to `text`.'."\n" + ."\n" + .'></notice>', 'type' => 'string', 'title' => '', 'example' => 'SourceHanSans-Bold'], + 'FontSize' => ['description' => 'The font size for the text watermark. The default value is 16. The value must be an integer in the range (4, 120).'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'This parameter is effective only when the `Type` parameter is set to `text`.'."\n" + ."\n" + .'></notice>', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'example' => '18'], + 'FontColor' => ['description' => 'The font color of the watermark text. The format is #RRGGBB. The default value is #000000. You can also enter values such as "red" or "green".'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'This parameter is effective only when the `Type` parameter is set to `text`.'."\n" + ."\n" + .'></notice>', 'type' => 'string', 'title' => '', 'example' => 'red'], + 'FontApha' => ['description' => 'The font opacity of the text watermark. The value ranges from (0, 1]. The default value is 1, which means fully opaque.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'This parameter is effective only when the `Type` parameter is set to `text`.'."\n" + ."\n" + .'></notice>', 'type' => 'number', 'title' => '', 'format' => 'float', 'example' => '0.8'], + 'BorderWidth' => ['description' => 'The outline width for the text watermark, in pixels (px). The value must be an integer from 0 to 4096. The default value is 0.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'This parameter is effective only when the `Type` parameter is set to `text`.'."\n" + ."\n" + .'></notice>', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'example' => '2'], + 'BorderColor' => ['description' => 'The outline color of the watermark text. The format is #RRGGBB. The default value is #000000. You can also enter values such as "red" or "green".'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'This parameter is effective only when the `Type` parameter is set to `text`.'."\n" + ."\n" + .'></notice>', 'type' => 'string', 'title' => '', 'example' => 'red'], + 'URI' => ['description' => 'The OSS URL of the watermark file. Supported formats are PNG and MOV.'."\n" + ."\n" + .'The OSS URL must follow the format `oss://<bucket>/<object>`, where `<bucket>` is the name of an OSS bucket in the same region as the current project, and `<object>` is the full path of the file, including the file name extension.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'This parameter is effective only when the `Type` parameter is set to `file`.'."\n" + ."\n" + .'></notice>', 'type' => 'string', 'title' => '', 'example' => 'oss://test-bucket/watermark.jpg'], + 'Width' => ['description' => 'The width of the watermark image. By default, this is the width of the original watermark image. The meaning of this parameter varies depending on whether the value is an integer or a decimal:'."\n" + ."\n" + .'- Integer: The width of the watermark in pixels (px). The value ranges from 1 to 4096.'."\n" + ."\n" + .'- Decimal: The ratio of the watermark width to the output video width. The value ranges from (0, 1).', 'type' => 'number', 'title' => '', 'format' => 'float', 'example' => '80'], + 'Height' => ['description' => 'The height of the watermark image. By default, this is the height of the original watermark image. The meaning of this parameter varies depending on whether the value is an integer or a decimal:'."\n" + ."\n" + .'- Integer: The height of the watermark in pixels (px). The value ranges from 1 to 4096.'."\n" + ."\n" + .'- Decimal: The ratio of the watermark height to the output video height. The value ranges from (0, 1).', 'type' => 'number', 'title' => '', 'format' => 'float', 'example' => '40'], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'Delogos', + 'example' => '', ], - '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', + 'Delogos' => [ + 'title' => '', + 'description' => 'Blurs a rectangular area of the video to remove logos, station icons, and other elements.', + 'type' => 'array', + 'items' => [ + 'description' => 'The parameters for video blurring.', + 'type' => 'object', + 'properties' => [ + 'StartTime' => ['description' => 'The start time for adding the mosaic, in seconds (s). By default, the mosaic is added from the beginning of the video.', 'type' => 'number', 'title' => '', 'format' => 'double', 'example' => '0'], + 'Duration' => ['description' => 'The duration for which the mosaic is displayed, in seconds (s). By default, the mosaic is displayed until the end of the video.', 'type' => 'number', 'title' => '', 'format' => 'double', 'example' => '15'], + 'Dx' => ['description' => 'The meaning of this parameter varies depending on whether the value is an integer or a decimal:'."\n" + ."\n" + .'- 0 (default): The pixel offset is 0. The ratio of the horizontal offset to the output video width is also 0.'."\n" + ."\n" + .'- Integer: The offset in pixels (px). The value ranges from 1 to 4096.'."\n" + ."\n" + .'- Decimal: The ratio of the horizontal offset to the output video width. The value ranges from (0, 1).', 'type' => 'number', 'title' => '', 'format' => 'float', 'example' => '0'], + 'Dy' => ['description' => 'The default value is 0. The meaning of this parameter varies depending on whether the value is an integer or a decimal:'."\n" + ."\n" + .'- 0 (default): The pixel offset is 0. The ratio of the vertical offset to the output video height is also 0.'."\n" + ."\n" + .'- Integer: The offset in pixels (px). The value ranges from 1 to 4096.'."\n" + ."\n" + .'- Decimal: The ratio of the vertical offset to the output video height. The value ranges from (0, 1).', 'type' => 'number', 'title' => '', 'format' => 'float', 'example' => '0'], + 'Width' => ['description' => 'The width of the mosaic. The default value is the decimal 1.0, which means it fills the entire width of the output video. The meaning of this parameter varies depending on whether the value is an integer or a decimal:'."\n" + ."\n" + .'- Integer: The width in pixels (px). The value ranges from 1 to 4096.'."\n" + ."\n" + .'- Decimal: The ratio of the mosaic width to the output video width. The value ranges from (0, 1).', 'type' => 'number', 'title' => '', 'format' => 'float', 'example' => '100'], + 'Height' => ['description' => 'The height of the mosaic. The default value is the decimal 1.0, which means it fills the entire height of the output video. The meaning of this parameter varies depending on whether the value is an integer or a decimal:'."\n" + ."\n" + .'- Integer: The height in pixels (px). The value ranges from 1 to 4096.'."\n" + ."\n" + .'- Decimal: The ratio of the mosaic height to the output video height. The value ranges from (0, 1).', 'type' => 'number', 'title' => '', 'format' => 'float', 'example' => '40'], + 'ReferPos' => ['description' => 'The reference position for adding the mosaic. Valid values:'."\n" + ."\n" + .'- topleft (default): The top-left corner.'."\n" + ."\n" + .'- topright: The top-right corner.'."\n" + ."\n" + .'- bottomright: The bottom-right corner.'."\n" + ."\n" + .'- bottomleft: The bottom-left corner.', 'type' => 'string', 'title' => '', 'example' => 'topleft'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'Speed' => ['description' => 'The video playback speed setting. The value ranges from 0.5 to 1.0. The default value is 1.0.'."\n" + ."\n" + .'> - This is the ratio of the default playback speed of the transcoded media file to that of the source media file. This is not a high-speed transcoding feature.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'- This parameter applies only to the CreateMediaConvertTask API.'."\n" + ."\n" + .'></notice>', 'type' => 'number', 'format' => 'float', 'example' => '1.0', 'title' => ''], 'Desensitization' => [ - 'description' => 'The video anonymization settings.'."\n" + 'description' => 'The video desensitization configuration.'."\n" ."\n" - .'> '."\n" + .'><notice>'."\n" ."\n" - .'* This parameter only applies to the CreateMediaConvertTask operation.'."\n", - 'visibility' => 'Public', + .'- This parameter applies only to the CreateMediaConvertTask API.'."\n" + ."\n" + .'></notice>', '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', + 'description' => 'The facial desensitization configuration.'."\n" + ."\n" + .'> This feature is in public preview. If you have any questions, join the DingTalk group for feedback. For the DingTalk group number, see [Contact us](~~84454~~).', '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" + 'Confidence' => ['description' => 'The confidence threshold for facial recognition. This sets the lower limit for the confidence level. If the confidence level of a detected face is below this threshold, the face is not desensitized.'."\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" + .'- Value range: 0.0 to 1.0.'."\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', + .'- Default value: 0.0 (no confidence filtering).', 'type' => 'number', 'format' => 'float', 'example' => '0.4', 'title' => ''], + 'MinSize' => ['description' => 'The minimum face size threshold. This sets the minimum size for a face to be desensitized. If the width or height of a detected face is smaller than this threshold, the face is not desensitized. The unit is pixels. The default value is 0, which means there is no restriction on face size.', 'type' => 'integer', 'format' => 'int32', 'example' => '0.4', 'title' => ''], ], - '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" + 'title' => '', + 'example' => '', + ], + 'LicensePlate' => [ + 'description' => 'The license plate desensitization configuration.'."\n" + ."\n" + .'> This feature is in public preview. If you have any questions, join the DingTalk group for feedback. For the DingTalk group number, see [Contact us](~~84454~~).', + 'type' => 'object', + 'properties' => [ + 'Confidence' => ['description' => 'The confidence threshold for license plate recognition. This sets the lower limit for the confidence level. If the confidence level of a detected license plate is below this threshold, the license plate is not desensitized.'."\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" + .'- Value range: 0.0 to 1.0.'."\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', + .'- Default value: 0.0 (no confidence filtering).', 'type' => 'number', 'format' => 'float', 'example' => '0.4', 'title' => ''], + 'MinSize' => ['description' => 'The minimum license plate size threshold. This sets the minimum size for a license plate to be desensitized. If the width or height of a detected license plate is smaller than this threshold, the license plate is not desensitized. The unit is pixels. The default value is 0, which means there is no restriction on license plate size.', 'type' => 'integer', 'format' => 'int32', 'example' => '0.4', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'extendType' => 'true', ], - 'backendName' => 'Watermarks', + 'title' => '', + 'example' => '', ], ], - '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', + 'example' => '', ], ], + 'example' => '', ], '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', - ], + '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', 'visibility' => 'Public', 'backendName' => 'Status'], + 'Code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'ResourceNotFound', 'visibility' => 'Public', 'backendName' => 'Code'], + 'Message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The specified resource project is not found.', 'visibility' => 'Public', 'backendName' => 'Message'], + 'StartTime' => ['title' => '', 'description' => 'The start time of the task.'."\n", 'type' => 'string', 'example' => '2021-12-24T03:01:41.662060377Z', 'visibility' => 'Public', 'backendName' => 'StartTime'], + 'EndTime' => ['title' => '', 'description' => 'The end time of the task.'."\n", 'type' => 'string', 'example' => '2021-12-24T03:01:49.480109219Z', 'visibility' => 'Public', 'backendName' => 'EndTime'], + 'UserData' => ['title' => '', 'description' => 'The custom user data.'."\n", 'type' => 'string', 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', 'visibility' => 'Public', 'backendName' => 'UserData'], + 'TaskType' => ['title' => '', 'description' => 'The type of the task.'."\n", 'type' => 'string', 'example' => 'VideoLabelClassification', 'visibility' => 'Public', 'backendName' => 'TaskType'], + 'TaskId' => ['title' => '', 'description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => 'c2b277b9-0d30-4882-ad6d-ad661382****', 'visibility' => 'Public', 'backendName' => 'TaskId'], + 'Tags' => ['title' => '', 'description' => 'The tags of the task. You can search for tasks by tag.'."\n", 'type' => 'object', 'visibility' => 'Public', 'backendName' => 'Tags', 'example' => ''], + '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", '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" + .'}', 'visibility' => 'Public', 'backendName' => 'TaskRequestDefinition'], + 'Progress' => ['title' => '', 'description' => 'The progress of the task.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'Progress'], ], + 'visibility' => 'Public', + 'example' => '', ], 'TimeRange' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'Start' => ['title' => '', 'description' => 'The start time.'."\n", 'type' => 'string', 'example' => '2016-12-31T00:00:00+08:00', 'visibility' => 'Public', 'backendName' => 'Start'], + 'End' => ['title' => '', 'description' => 'The end time.'."\n", 'type' => 'string', 'example' => '2016-12-31T00:00:00+08:00', 'visibility' => 'Public', 'backendName' => 'End'], ], + 'visibility' => 'Public', + 'example' => '', ], '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', - ], + 'Type' => ['title' => '', 'description' => 'The type of the tool.'."\n", 'type' => 'string', 'example' => 'function', 'visibility' => 'Public', 'backendName' => 'Type'], + 'Function' => ['description' => 'The definition of the function that can be called by the AI assistant.'."\n", '$ref' => '#/components/schemas/FunctionCall', 'visibility' => 'Public', 'backendName' => 'Function', 'title' => '', 'example' => ''], ], + 'visibility' => 'Public', + 'example' => '', ], 'TrainingSpecification' => [ - 'title' => 'x', + 'title' => '', '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', - ], + 'ValidationSourceURI' => ['title' => '', 'description' => 'The URI of the evaluation dataset. You must specify this parameter or the ValidationSplit parameter.'."\n", 'type' => 'string', 'example' => 'oss://imm-alg-dataset-bj/cifar10/test_index.json', 'visibility' => 'Public', 'backendName' => 'ValidationSourceURI'], + 'Runtime' => ['description' => 'The information about the runtime for model training.'."\n", 'required' => true, '$ref' => '#/components/schemas/Runtime', 'visibility' => 'Public', 'backendName' => 'Runtime', 'title' => '', 'example' => ''], + 'Endpoint' => ['title' => '', 'description' => 'The endpoint of the storage where the dataset is stored.'."\n", 'type' => 'string', 'required' => true, 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', 'visibility' => 'Public', 'backendName' => 'Endpoint'], + 'ModelSpecification' => ['description' => 'The model specification details.'."\n", 'required' => true, '$ref' => '#/components/schemas/ModelSpecification', 'visibility' => 'Public', 'backendName' => 'ModelSpecification', 'title' => '', 'example' => ''], + 'DatasetName' => ['title' => '', 'description' => 'Name of the dataset'."\n", 'type' => 'string', 'example' => 'test-dataset', 'visibility' => 'Public', 'backendName' => 'DatasetName'], + 'SourceURI' => ['title' => '', 'description' => 'URI of the dataset'."\n", 'type' => 'string', 'required' => true, 'example' => 'oss://imm-alg-dataset-bj/cifar10/test_index.json', 'visibility' => 'Public', '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", + 'items' => ['description' => 'Custom parameters for model training.'."\n", '$ref' => '#/components/schemas/CustomParams', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], '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', + 'backendName' => 'Transforms', + 'example' => '', ], + 'ValidationSplit' => ['title' => '', 'description' => 'The ratio for splitting the training dataset into the evaluation dataset. You must specify this parameter or the ValidationSourceURI parameter.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0.95', 'visibility' => 'Public', 'backendName' => 'ValidationSplit'], + 'TargetURI' => ['title' => '', 'description' => 'The storage path to the model data. Only an Object Storage Service (OSS) path is supported.'."\n", 'type' => 'string', 'required' => true, 'example' => 'oss://imm-alg-dataset-bj/model_training_test/', 'visibility' => 'Public', 'backendName' => 'TargetURI'], ], + 'visibility' => 'Public', + 'example' => '', ], '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', - ], + 'DisableDeleteEmptyCell' => ['title' => '', 'description' => 'Specifies whether to prevent all empty cells from being deleted. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'DisableDeleteEmptyCell'], + 'DisableDeleteRepeatedStyle' => ['title' => '', 'description' => 'Specifies whether to prevent all duplicate styles from being deleted. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'DisableDeleteRepeatedStyle'], + 'DisableDeleteUnusedShape' => ['title' => '', 'description' => 'Specifies whether to prevent unused shapes from being deleted. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'DisableDeleteUnusedShape'], + 'DisableDeleteUnusedPicture' => ['title' => '', 'description' => 'Specifies whether to prevent unused cell images from being deleted. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public', 'backendName' => 'DisableDeleteUnusedPicture'], ], + 'visibility' => 'Public', + 'example' => '', ], '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', - ], + 'Description' => ['description' => 'The description of the video file.'."\n" + ."\n" + .'> Not supported.'."\n", 'type' => 'string', 'example' => '无。', 'title' => ''], + 'Caption' => ['description' => 'Video summary.'."\n", 'type' => 'string', 'example' => '视频中展示了两个不同场景：一个是静止的白色盘子、黑色瓶子和透明玻璃杯，另一个是手拿着标有“YEZOLU”的洗发水瓶在浴室中缓慢上移。', 'title' => ''], ], - 'nullable' => true, + 'title' => '', + 'example' => '', ], - 'VideoStream' => [ - 'title' => 'A short description of struct', - 'description' => 'The information about the video stream.'."\n", - 'visibility' => 'public', + 'VideoInsightsCaptionConfig' => [ + 'description' => 'The video synopsis configuration.', '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', - ], + 'PersonReference' => ['description' => 'The person reference configuration.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/PersonReferenceConfig'], + 'Enable' => ['description' => 'Specifies whether to enable video captioning.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'Prompt' => ['description' => 'The custom prompt for video captioning.', 'type' => 'string', 'title' => '', 'example' => '请用一句话描述这个视频'], ], + 'title' => '', + 'example' => '', ], - 'WebofficePermission' => [ + 'VideoInsightsConfig' => [ + 'description' => 'The video content perception configuration.', + 'type' => 'object', + 'properties' => [ + 'Caption' => ['description' => 'The video synopsis configuration.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/VideoInsightsCaptionConfig'], + 'Label' => ['description' => 'The label configuration.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/VideoInsightsLabelConfig'], + 'MultiStream' => ['description' => 'The video multi-stream configuration.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/VideoInsightsMultiStreamConfig'], + ], 'title' => '', - 'description' => 'The WebOffice user permissions.'."\n", - 'visibility' => 'public', + 'example' => '', + ], + 'VideoInsightsHighlightLabelConfig' => [ + 'description' => 'The highlight label configuration.', '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' => [ + 'Enable' => ['description' => 'Specifies whether highlight labels are supported.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'Labels' => [ + 'description' => 'The list of labels.', + 'type' => 'array', + 'items' => ['description' => 'The label.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/InsightsLabel'], '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', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'WebofficeUser' => [ + 'VideoInsightsLabelConfig' => [ + 'description' => 'The label configuration.', + 'type' => 'object', + 'properties' => [ + 'System' => ['description' => 'The system label configuration.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/VideoInsightsSystemLabelConfig'], + 'UserDefined' => ['description' => 'The custom label configuration.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/VideoInsightsUserDefinedLabelConfig'], + 'Highlight' => ['description' => 'The highlight label configuration.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/VideoInsightsHighlightLabelConfig'], + ], 'title' => '', - 'description' => 'The WebOffice user information.'."\n", - 'visibility' => 'public', + 'example' => '', + ], + 'VideoInsightsMultiStreamConfig' => [ + 'description' => 'The video multi-stream configuration.', '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', - ], + 'Enable' => ['description' => 'Specifies whether video multi-stream is supported.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], ], + 'title' => '', + 'example' => '', ], - 'WebofficeWatermark' => [ + 'VideoInsightsSystemLabelConfig' => [ + 'description' => 'The system label configuration.', + 'type' => 'object', + 'properties' => [ + 'Enable' => ['description' => 'Specifies whether system labels are supported.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + ], 'title' => '', - 'description' => 'The WebOffice watermark information.'."\n", - 'visibility' => 'Public', + 'example' => '', + ], + 'VideoInsightsUserDefinedLabelConfig' => [ + 'description' => 'The custom label configuration.', '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' => [ + 'Enable' => ['description' => 'Specifies whether to enable custom labels.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'Labels' => [ + 'description' => 'The list of custom labels.', + 'type' => 'array', + 'items' => ['description' => 'The custom label.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/InsightsLabel'], 'title' => '', - 'description' => 'The horizontal spacing of the text watermark. Unit: pixel.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - 'backendName' => 'Horizontal', + 'example' => '', ], - 'Font' => [ - 'title' => '', - 'description' => 'The font of the text watermark.'."\n", - 'visibility' => 'Public', + 'Mode' => [ + 'description' => 'The custom label matching mode. The SDK passes this as an optional string.', + 'enumValueTitles' => ['Enhanced' => 'Enhanced', 'Simple' => 'Simple'], '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', + 'example' => 'Enhanced', ], ], + 'title' => '', + 'example' => '', ], - ], - ], - 'apis' => [ - 'ListRegions' => [ - 'summary' => 'Get the list of regions', - 'methods' => [ - 'get', - 'post', + 'VideoReadKeywordOption' => [ + 'description' => 'The keyword extraction options for video intensive reading.', + 'type' => 'object', + 'properties' => [ + 'Extract' => ['description' => 'Specifies whether to fetch keywords.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Count' => ['description' => 'The number of keywords. Valid values: 0 to 10.', 'type' => 'integer', 'title' => '', 'example' => '1', 'format' => 'int32'], + ], + 'title' => '', + 'example' => '', ], - 'schemes' => [ - 'http', - 'https', + 'VideoReadPPTOption' => [ + 'description' => 'The video intensive reading PPT fetch options.', + 'type' => 'object', + 'properties' => [ + 'Extract' => ['description' => 'Specifies whether to fetch.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'title' => '', + 'example' => '', ], - 'security' => [ - [ - 'AK' => [], + 'VideoReadQuestionOption' => [ + 'description' => 'The video intensive reading question generation options.', + 'type' => 'object', + 'properties' => [ + 'Extract' => ['description' => 'Specifies whether to fetch.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Count' => ['description' => 'The number of keywords. Valid values: 0 to 10.', 'type' => 'integer', 'title' => '', 'example' => '1', 'format' => 'int32'], ], + 'title' => '', + 'example' => '', ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'abilityTreeCode' => '143479', - 'abilityTreeNodes' => [ - 'FEATUREimmKH590Y', + 'VideoReverseImageConfig' => [ + 'description' => 'The image-to-video search configuration.', + 'type' => 'object', + 'properties' => [ + 'Enable' => ['description' => 'Specifies whether to enable the feature.', 'type' => 'boolean', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], - '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', - ], + 'VideoStream' => [ + 'title' => '', + 'description' => 'The information about the video stream.'."\n", + 'type' => 'object', + 'properties' => [ + 'Index' => ['title' => '', 'description' => 'The index number of the video stream.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'Index'], + 'Language' => ['title' => '', 'description' => 'The language used in the video stream. The language is indicated by using a BCP 47 language tag.'."\n", 'type' => 'string', 'example' => 'en', 'visibility' => 'Public', 'backendName' => 'Language'], + 'CodecName' => ['title' => '', 'description' => 'The abbreviated name of the codec.'."\n", 'type' => 'string', 'example' => 'h264', 'visibility' => 'Public', 'backendName' => 'CodecName'], + 'CodecLongName' => ['title' => '', 'description' => 'The full name of the codec.'."\n", 'type' => 'string', 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', 'visibility' => 'Public', 'backendName' => 'CodecLongName'], + 'Profile' => ['title' => '', 'description' => 'The profile.'."\n", 'type' => 'string', 'example' => 'High', 'visibility' => 'Public', 'backendName' => 'Profile'], + 'CodecTimeBase' => ['title' => '', 'description' => 'The time base of the codec.'."\n", 'type' => 'string', 'example' => '1373627/83160000', 'visibility' => 'Public', 'backendName' => 'CodecTimeBase'], + 'CodecTagString' => ['title' => '', 'description' => 'The description of the codec tag.'."\n", 'type' => 'string', 'example' => 'avc1', 'visibility' => 'Public', 'backendName' => 'CodecTagString'], + 'CodecTag' => ['title' => '', 'description' => 'The tag of the codec.'."\n", 'type' => 'string', 'example' => '0x31637661', 'visibility' => 'Public', 'backendName' => 'CodecTag'], + 'Width' => ['title' => '', 'description' => 'The image width of the video stream. Unit: pixels.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1280', 'visibility' => 'Public', 'backendName' => 'Width'], + 'Height' => ['title' => '', 'description' => 'The image height of the video stream. Unit: pixels.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '720', 'visibility' => 'Public', 'backendName' => 'Height'], + 'HasBFrames' => ['title' => '', 'description' => 'Specifies whether the video stream contains B frames.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'visibility' => 'Public', 'backendName' => 'HasBFrames'], + 'SampleAspectRatio' => ['title' => '', 'description' => 'The sampling aspect ratio of the video stream.'."\n", 'type' => 'string', 'example' => '1:1', 'visibility' => 'Public', 'backendName' => 'SampleAspectRatio'], + 'DisplayAspectRatio' => ['title' => '', 'description' => 'The display aspect ratio of the video stream.'."\n", 'type' => 'string', 'example' => '16:9', 'visibility' => 'Public', 'backendName' => 'DisplayAspectRatio'], + 'PixelFormat' => ['title' => '', 'description' => 'The pixel format of the video stream.'."\n", 'type' => 'string', 'example' => 'yuv420p', 'visibility' => 'Public', 'backendName' => 'PixelFormat'], + 'Level' => ['title' => '', 'description' => 'The level.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '40', 'visibility' => 'Public', 'backendName' => 'Level'], + 'FrameRate' => ['title' => '', 'description' => 'The frame rate of the video stream.'."\n", 'type' => 'string', 'example' => '25/1', 'visibility' => 'Public', 'backendName' => 'FrameRate'], + 'AverageFrameRate' => ['title' => '', 'description' => 'The average frame rate of the video stream.'."\n", 'type' => 'string', 'example' => '25/1', 'visibility' => 'Public', 'backendName' => 'AverageFrameRate'], + 'TimeBase' => ['title' => '', 'description' => 'The time base.'."\n", 'type' => 'string', 'example' => '1/12800', 'visibility' => 'Public', 'backendName' => 'TimeBase'], + 'StartTime' => ['title' => '', 'description' => 'The start time of the video stream. Unit: seconds.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '0.000000', 'visibility' => 'Public', 'backendName' => 'StartTime'], + 'Duration' => ['title' => '', 'description' => 'The duration of the video stream. Unit: seconds.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '22.88', 'visibility' => 'Public', 'backendName' => 'Duration'], + 'Bitrate' => ['title' => '', 'description' => 'The bitrate. Unit: bit/s.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5407765', 'visibility' => 'Public', 'backendName' => 'Bitrate'], + 'FrameCount' => ['title' => '', 'description' => 'The number of frames.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '572', 'visibility' => 'Public', 'backendName' => 'FrameCount'], + 'Rotate' => ['title' => '', 'description' => 'The image rotation angle of the video stream.'."\n", 'type' => 'string', 'example' => '90', 'visibility' => 'Public', 'backendName' => 'Rotate'], + 'BitDepth' => ['title' => '', 'description' => 'The bit depth.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'visibility' => 'Public', 'backendName' => 'BitDepth'], + 'ColorSpace' => ['title' => '', 'description' => 'The color space.'."\n", 'type' => 'string', 'example' => 'bt709', 'visibility' => 'Public', 'backendName' => 'ColorSpace'], + 'ColorRange' => ['title' => '', 'description' => 'The color range.'."\n", 'type' => 'string', 'example' => 'tv', 'visibility' => 'Public', 'backendName' => 'ColorRange'], + 'ColorTransfer' => ['title' => '', 'description' => 'The color transfer function.'."\n", 'type' => 'string', 'example' => 'bt709', 'visibility' => 'Public', 'backendName' => 'ColorTransfer'], + 'ColorPrimaries' => ['title' => '', 'description' => 'The primary colors.'."\n", 'type' => 'string', 'example' => 'bt709', 'visibility' => 'Public', 'backendName' => 'ColorPrimaries'], ], + 'visibility' => 'Public', + 'example' => '', ], - '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', - ], - ], - ], - ], + 'WebofficePermission' => [ + 'title' => '', + 'description' => 'The WebOffice user permissions.'."\n", + '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", 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'Rename'], + 'Readonly' => ['title' => '', 'description' => 'Specifies whether the user has read-only access to the file. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public', 'backendName' => 'Readonly'], + 'History' => ['title' => '', 'description' => 'Specifies whether the user has the permission to view historical versions. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'History'], + 'Print' => ['title' => '', 'description' => 'Specifies whether the user has the printing permission. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public', '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", 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public', 'backendName' => 'Export'], + 'Copy' => ['title' => '', 'description' => 'Specifies whether the user has the copy permission. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public', 'backendName' => 'Copy'], ], + 'visibility' => 'Public', + 'example' => '', ], - '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', + 'WebofficeUser' => [ + 'title' => '', + 'description' => 'The WebOffice user information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', '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", 'type' => 'string', 'example' => 'user1', 'visibility' => 'Public', '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", 'type' => 'string', 'example' => 'test-user1', 'visibility' => 'Public', 'backendName' => 'Name'], + 'Avatar' => ['title' => '', 'description' => 'The custom URL of the avatar picture. The avatar picture is displayed on the WebOffice page.'."\n", 'type' => 'string', 'example' => 'http://example.com/?id=user1', 'visibility' => 'Public', 'backendName' => 'Avatar'], + ], + 'visibility' => 'Public', + 'example' => '', + ], + 'WebofficeWatermark' => [ + 'title' => '', + 'description' => 'The WebOffice watermark information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The watermark type. Valid values:'."\n" + ."\n" + .'* 0: no watermark.'."\n" + .'* 1: text watermark.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'Type'], + 'Value' => ['title' => '', 'description' => 'The watermark text.'."\n" + ."\n" + .'> This parameter takes effect only if you set the Type parameter to 1.'."\n", 'type' => 'string', 'example' => 'example', 'visibility' => 'Public', 'backendName' => 'Value'], + 'Rotate' => ['title' => '', 'description' => 'The rotation of the text watermark. Unit: radian.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '-0.7853982', 'visibility' => 'Public', 'backendName' => 'Rotate'], + 'Vertical' => ['title' => '', 'description' => 'The vertical spacing of the text watermark. Unit: pixel.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'visibility' => 'Public', 'backendName' => 'Vertical'], + 'Horizontal' => ['title' => '', 'description' => 'The horizontal spacing of the text watermark. Unit: pixel.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'visibility' => 'Public', 'backendName' => 'Horizontal'], + 'Font' => ['title' => '', 'description' => 'The font of the text watermark.'."\n", 'type' => 'string', 'example' => 'bold 20px Serif', 'visibility' => 'Public', 'backendName' => 'Font'], + 'FillStyle' => ['title' => '', 'description' => 'The color and transparency of the text watermark.'."\n", 'type' => 'string', 'example' => 'rgba(192, 192, 192, 0.6)', 'visibility' => 'Public', 'backendName' => 'FillStyle'], + ], + 'visibility' => 'Public', + 'example' => '', ], - 'schemes' => [ - 'http', - 'https', + 'WorkflowParameter' => [ + 'description' => 'The invalid parameter.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The invalid parameter.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'Value' => ['description' => 'The invalid parameter.', 'type' => 'string', 'example' => 'value', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + ], + ], + 'apis' => [ + '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' => 'write', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '436', - 'abilityTreeNodes' => [ - 'FEATUREimmKH590Y', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '147967', + 'abilityTreeNodes' => ['FEATUREimmQT4435'], ], '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', - ], + 'schema' => ['description' => 'The name of the project.[](~~478153~~)'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'SourceURI', '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', - ], + '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', 'title' => ''], ], [ - 'name' => 'ServiceRole', + 'name' => 'TargetURI', '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', - ], + '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', 'title' => ''], ], [ - 'name' => 'TemplateId', + 'name' => 'ImageFormat', '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", + '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, - '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', + 'enumValueTitles' => ['jpg' => 'jpg', 'png' => 'png', 'webp' => 'webp'], + 'example' => 'jpg', + 'title' => '', ], ], [ - 'name' => 'DatasetMaxTotalFileSize', + 'name' => 'Quality', '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', - ], + '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', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'Targets', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The tags.'."\n", + 'description' => 'The bounding boxes and processing parameters.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The tag.'."\n", + 'description' => 'The bounding box and the corresponding processing parameters.'."\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', + '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', 'title' => ''], + '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', 'title' => ''], + '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', 'title' => ''], + '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', 'title' => ''], + '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', 'title' => ''], + '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', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', ], + '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', 'title' => ''], + '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', 'title' => ''], + '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', 'title' => ''], + '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', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, + 'required' => true, + 'title' => '', + 'example' => '', ], ], + [ + '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', 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结构体', - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\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', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FF*****'], ], + 'example' => '', ], ], - 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', + '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", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddImageMosaic'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:AddImageMosaic', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + ], + 'AddStoryFiles' => [ + 'summary' => 'Adds objects to a story.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '495', - 'abilityTreeNodes' => [ - 'FEATUREimmKH590Y', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '142648', + 'abilityTreeNodes' => ['FEATUREimmPQ568C'], ], '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', - ], + 'in' => 'formData', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ - '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' => 'DatasetName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the dataset.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-dataset', 'title' => ''], ], [ - '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' => 'ObjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the story.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testid', 'title' => ''], ], [ - 'name' => 'Tag', - 'in' => 'query', + 'name' => 'Files', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The tags.'."\n", + 'description' => 'The objects that you want to add.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The tag.'."\n", + 'description' => 'The information about the object.'."\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', - ], + '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', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, + 'required' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结构体', - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\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', + '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', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'ResourceNotFound', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message that is returned.'."\n", 'type' => 'string', 'example' => 'The specified resource %s is not found.', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + 'title' => 'AddStoryFiles', + 'changeSet' => [ + ['createdAt' => '2022-07-07T07:23:26.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddStoryFiles'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:AddStoryFiles', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], ], + '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":""}]', + 'operationType' => 'readAndWrite', + ], + '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' => [], @@ -8754,154 +3742,110 @@ ], 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '450', - 'abilityTreeNodes' => [ - 'FEATUREimmKH590Y', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '135038', + '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', - ], + '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' => 'WithStatistics', + 'name' => 'OSSBucket', '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', - ], + 'schema' => ['description' => 'The name of the OSS bucket in the same region as the project.'."\n", 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], + ], + [ + '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', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结构体', + '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', - ], + 'RequestId' => ['title' => 'RequestId', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5F74C5C9-5AC0-49F9-914D-E01589D3****'], ], + 'example' => '', ], ], ], - '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', + '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", + 'changeSet' => [ + ['createdAt' => '2024-04-19T09:44:00.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-11-07T04:13:15.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-04-18T06:16:09.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachOSSBucket'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:AttachOSSBucket', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + ], + 'BatchDeleteFileMeta' => [ + 'summary' => 'Deletes the metadata of multiple files from a dataset.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '763', - 'abilityTreeNodes' => [ - 'FEATUREimmKH590Y', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '33176', + 'abilityTreeNodes' => ['FEATUREimmSZD9WY'], ], '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', + 'name' => 'ProjectName', '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', - ], + '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' => ''], ], [ - 'name' => 'Prefix', + 'name' => 'DatasetName', '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', - ], + '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' => ''], ], [ - 'name' => 'Tag', + 'name' => 'URIs', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The tags.'."\n", + '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 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, + '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://test-bucket/test-object', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', ], ], ], @@ -8912,678 +3856,603 @@ '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', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '3A82F6C9-5AC0-38F9-914F-F02623B3****'], ], + 'example' => '', ], ], ], - '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', + '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", + 'changeSet' => [ + ['createdAt' => '2021-06-15T02:14:00.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchDeleteFileMeta'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imm:BatchDeleteFileMeta', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + ], + ], + 'BatchGetFigureCluster' => [ + 'summary' => 'Queries face clusters.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', + 'abilityTreeCode' => '166908', + 'abilityTreeNodes' => ['FEATUREimm3DNGQD'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the dataset.', 'type' => 'string', 'required' => true, 'example' => 'test-dataset', 'title' => ''], + ], + [ + 'name' => 'ObjectIds', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '项目名称', - 'description' => 'The name of the project. For more information, see [Create a project](~~478153~~).'."\n", - 'type' => 'string', + 'description' => 'The cluster IDs.', + 'type' => 'array', + 'items' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'Cluster-99b1c333-86dc-45da-8c6****', 'title' => ''], 'required' => true, - 'example' => 'immtest', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => '响应结构体', - 'description' => 'The returned data.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '本次请求的唯一 ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'FEDC9B1F-30F2-4C1F-8ED2-B7860187****', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FFF****'], + 'FigureClusters' => [ + 'description' => 'The clusters.', + 'type' => 'array', + 'items' => ['description' => 'The information about the cluster.', '$ref' => '#/components/schemas/FigureCluster', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'StatusConflict', - 'errorMessage' => 'Message: cannot delete when sub resoures exist', + 'title' => 'BatchGetFigureCluster', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchGetFigureCluster'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:BatchGetFigureCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], ], ], ], - '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", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FFF****\\",\\n \\"FigureClusters\\": [\\n {\\n \\"OwnerId\\": \\"102321002****\\",\\n \\"ProjectName\\": \\"immtest\\",\\n \\"DatasetName\\": \\"dataset001\\",\\n \\"ObjectType\\": \\"figure-cluster\\",\\n \\"ObjectId\\": \\"Cluster-ae6e3472-999e-410b-b54e-cd5dba****\\",\\n \\"UpdateTime\\": \\"2022-01-14T10:10:52.83948013+08:00\\",\\n \\"CreateTime\\": \\"2022-01-14T10:10:52.83948013+08:00\\",\\n \\"Name\\": \\"abc\\",\\n \\"Gender\\": \\"female\\",\\n \\"FaceCount\\": 3,\\n \\"ImageCount\\": 5,\\n \\"VideoCount\\": 3,\\n \\"AverageAge\\": 26,\\n \\"MinAge\\": 12,\\n \\"MaxAge\\": 44,\\n \\"Cover\\": {\\n \\"OwnerId\\": \\"102321002467****\\",\\n \\"ProjectName\\": \\"test-project\\",\\n \\"DatasetName\\": \\"test-dataset\\",\\n \\"ObjectType\\": \\"file\\",\\n \\"ObjectId\\": \\"75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7\\",\\n \\"UpdateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"CreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"URI\\": \\"oss://test-bucket/test-object.jpg\\",\\n \\"OSSURI\\": \\"oss://examplebucket/sampleobject.jpg\\",\\n \\"Filename\\": \\"sampleobject.jpg\\",\\n \\"MediaType\\": \\"image\\",\\n \\"ContentType\\": \\"image/jpeg\\",\\n \\"Size\\": 1000,\\n \\"FileHash\\": \\"1d9c280a7c4f67f7ef873e28449dbe17\\",\\n \\"FileModifiedTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileCreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileAccessTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"ProduceTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"LatLong\\": \\"30.134390,120.074997\\",\\n \\"Timezone\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"AddressLine\\": \\"中国浙江省杭州市余杭区文一西路969号\\",\\n \\"Country\\": \\"中国\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"District\\": \\"余杭区\\",\\n \\"Township\\": \\"文一西路\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"-\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"868a9e74-cde5-4c7a-9013-28bb984****\\",\\n \\"FigureConfidence\\": 1,\\n \\"FigureClusterId\\": \\"Cluster-dbe72fec-b84c-4ab6-885b-3678e64****\\",\\n \\"FigureClusterConfidence\\": 1,\\n \\"FigureType\\": \\"face\\",\\n \\"Age\\": 29,\\n \\"AgeSD\\": 5,\\n \\"Gender\\": \\"female\\",\\n \\"GenderConfidence\\": 1,\\n \\"Emotion\\": \\"happiness\\",\\n \\"EmotionConfidence\\": 0.70784568786621,\\n \\"FaceQuality\\": 0.960875928401947,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n },\\n \\"Mouth\\": \\"close\\",\\n \\"MouthConfidence\\": 1,\\n \\"Beard\\": \\"none\\",\\n \\"BeardConfidence\\": 1,\\n \\"Hat\\": \\"none\\",\\n \\"HatConfidence\\": 1,\\n \\"Mask\\": \\"none\\",\\n \\"MaskConfidence\\": 1,\\n \\"Glasses\\": \\"none\\",\\n \\"GlassesConfidence\\": 0.8,\\n \\"Sharpness\\": 0.7,\\n \\"Attractive\\": 0.96,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 18.385589599609375,\\n \\"Roll\\": 4.204030513763428,\\n \\"Yaw\\": 2.4945924282073975\\n }\\n }\\n ],\\n \\"FigureCount\\": 10,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"座椅\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Title\\": \\"test\\",\\n \\"ImageWidth\\": 270,\\n \\"ImageHeight\\": 500,\\n \\"EXIF\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.736\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 1080,\\n \\"VideoHeight\\": 1920,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"CodecTimeBase\\": \\"1373627/83160000\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"Width\\": 1280,\\n \\"Height\\": 720,\\n \\"HasBFrames\\": 2,\\n \\"SampleAspectRatio\\": \\"1:1\\",\\n \\"DisplayAspectRatio\\": \\"16:9\\",\\n \\"PixelFormat\\": \\"yuv420p\\",\\n \\"Level\\": 40,\\n \\"FrameRate\\": \\"25/1\\",\\n \\"AverageFrameRate\\": \\"25/1\\",\\n \\"TimeBase\\": \\"1/12800\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 22.88,\\n \\"Bitrate\\": 5407765,\\n \\"FrameCount\\": 572,\\n \\"Rotate\\": \\"90\\",\\n \\"BitDepth\\": 8,\\n \\"ColorSpace\\": \\"bt709\\",\\n \\"ColorRange\\": \\"tv\\",\\n \\"ColorTransfer\\": \\"bt709\\",\\n \\"ColorPrimaries\\": \\"bt709\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 2,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"mov_text\\",\\n \\"CodecLongName\\": \\"MOV text\\",\\n \\"CodecTagString\\": \\"tx3g\\",\\n \\"CodecTag\\": \\"0x67337874\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 71.378,\\n \\"Bitrate\\": 74,\\n \\"Content\\": \\"欢迎\\",\\n \\"Width\\": 600,\\n \\"Height\\": 30\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 1,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"TimeBase\\": \\"1/48000\\",\\n \\"StartTime\\": 0.0235,\\n \\"Duration\\": 3.690667,\\n \\"Bitrate\\": 320087,\\n \\"FrameCount\\": 173,\\n \\"Lyric\\": \\"test\\",\\n \\"SampleFormat\\": \\"fltp\\",\\n \\"SampleRate\\": 48000,\\n \\"Channels\\": 2,\\n \\"ChannelLayout\\": \\"stereo\\"\\n }\\n ],\\n \\"Artist\\": \\"Jane\\",\\n \\"AlbumArtist\\": \\"Jane\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 500,\\n \\"ImageHeight\\": 820,\\n \\"EXIF\\": \\"{\\\\\\"FileSize\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"29304\\\\\\"},\\\\\\"Format\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"jpg\\\\\\"}}\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.736\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"Jane\\",\\n \\"Performer\\": \\"Jane\\",\\n \\"Language\\": \\"eng\\",\\n \\"Album\\": \\"FirstAlbum\\",\\n \\"PageCount\\": 5,\\n \\"ETag\\": \\"\\\\\\"1D9C280A7C4F67F7EF873E28449****\\\\\\"\\",\\n \\"CacheControl\\": \\"no-cache\\",\\n \\"ContentDisposition\\": \\"attachment; filename =test.jpg\\",\\n \\"ContentEncoding\\": \\"UTF-8\\",\\n \\"ContentLanguage\\": \\"zh-CN\\",\\n \\"AccessControlAllowOrigin\\": \\"https://aliyundoc.com\\",\\n \\"AccessControlRequestMethod\\": \\"PUT\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"SM4\\",\\n \\"ServerSideEncryption\\": \\"AES256\\",\\n \\"ServerSideDataEncryption\\": \\"SM4\\",\\n \\"ServerSideEncryptionKeyId\\": \\"9468da86-3509-4f8d-a61e-6eab1eac****\\",\\n \\"OSSStorageClass\\": \\"Standard\\",\\n \\"OSSCRC64\\": \\"559890638950338001\\",\\n \\"ObjectACL\\": \\"default\\",\\n \\"ContentMd5\\": \\"HZwoCnxPZ/fvhz4oRJ2+Fw==\\",\\n \\"OSSUserMeta\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSTaggingCount\\": 2,\\n \\"OSSTagging\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSExpiration\\": \\"2120-01-01T12:00:00.000Z\\",\\n \\"OSSVersionId\\": \\"CAEQNhiBgMDJgZCA0BYiIDc4MGZjZGI2OTBjOTRmNTE5NmU5NmFhZjhjYmY0****\\",\\n \\"OSSDeleteMarker\\": \\"CAEQMhiBgIDXiaaB0BYiIGQzYmRkZGUxMTM1ZDRjOTZhNjk4YjRjMTAyZjhl****\\",\\n \\"OSSObjectType\\": \\"Normal\\",\\n \\"CustomId\\": \\"\\\\t\\\\nmember-image-id-0001\\",\\n \\"CustomLabels\\": {\\n \\"MemberName\\": \\"Tim\\",\\n \\"Enabled\\": \\"True\\",\\n \\"ItemCount\\": \\"10\\"\\n },\\n \\"StreamCount\\": 1,\\n \\"ProgramCount\\": 1,\\n \\"FormatName\\": \\"mov\\",\\n \\"FormatLongName\\": \\"QuickTime / MOV\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 13091201,\\n \\"Duration\\": 15.263,\\n \\"SemanticTypes\\": [\\n \\"content\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"text\\",\\n \\"Content\\": \\"文本片段\\",\\n \\"URL\\": \\"http://aliyun.com\\",\\n \\"TimeRange\\": [\\n 500\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"id1\\",\\n \\"ElementType\\": \\"title - 标题； image - 图片 ； table - 表格 ； narrative-text - 正文\\",\\n \\"SemanticSimilarity\\": 0.8,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"child，parent\\",\\n \\"ObjectId\\": \\"id1\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ],\\n \\"FrameTimes\\": [\\n 30\\n ],\\n \\"VideoStreamIndex\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"座椅\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"OCRTexts\\": \\"阿里云IMM\\",\\n \\"Reason\\": \\"[InternalError] The request has been failed due to some unknown error. status: 500, requestId: CC5ACFBD-BB7A-496D-A9D6-****\\",\\n \\"ObjectStatus\\": \\"Indexed\\",\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"无。\\",\\n \\"Caption\\": \\"视频中展示了两个不同场景：一个是静止的白色盘子、黑色瓶子和透明玻璃杯，另一个是手拿着标有“YEZOLU”的洗发水瓶在浴室中缓慢上移。\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"无。\\",\\n \\"Description\\": \\"图片中有一人，穿着深色西装外套，内搭白色衬衫。背景为渐变的浅蓝色至灰色。\\"\\n }\\n }\\n },\\n \\"CustomId\\": \\"abc\\",\\n \\"CustomLabels\\": {\\n \\"Bucket\\": \\"examplebucket\\"\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ]\\n}","type":"json"}]', ], - 'CreateDataset' => [ - 'summary' => 'Creates a dataset.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'BatchGetFileMeta' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREimmSZD9WY', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '33178', + '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', - ], + 'schema' => ['description' => 'The name of the project.[](~~478153~~)', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The name of the dataset.[](~~478160~~)', 'type' => 'string', 'required' => true, 'example' => 'test-dataset', 'title' => ''], ], [ - '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', + 'name' => 'URIs', 'in' => 'query', + 'style' => 'json', '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', + 'description' => 'The array of object URIs. You can specify up to 100 object URIs in an array.', + '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.', 'type' => 'string', 'required' => false, 'example' => 'oss://test-bucket/test-object', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'WorkflowParameters', + 'name' => 'WithFields', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'Invalid parameter.', + '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.', 'type' => 'array', - 'items' => [ - 'description' => 'Invalid parameter.', - 'required' => false, - '$ref' => '#/components/schemas/WorkflowParameter', - ], + 'items' => ['description' => 'The field name.', 'type' => 'string', 'required' => false, 'example' => 'URI', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结构体', - 'description' => 'Response structure', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', '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', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7F84C6D9-5AC0-49F9-914D-F02678E3****'], + 'Files' => [ + 'description' => 'The metadata returned.', + '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.', '$ref' => '#/components/schemas/File', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'BatchGetFileMeta', + 'summary' => 'Queries metadata of multiple objects or files in the specified dataset.', + 'description' => '- Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).\\*\\*\\*\\*'."\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" + .'- 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.', + 'changeSet' => [ + ['createdAt' => '2024-07-30T05:45:55.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-06-15T02:13:47.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchGetFileMeta'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:BatchGetFileMeta', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F84C6D9-5AC0-49F9-914D-F02678E3****\\",\\n \\"Files\\": [\\n {\\n \\"OwnerId\\": \\"102321002467****\\",\\n \\"ProjectName\\": \\"test-project\\",\\n \\"DatasetName\\": \\"test-dataset\\",\\n \\"ObjectType\\": \\"file\\",\\n \\"ObjectId\\": \\"75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7\\",\\n \\"UpdateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"CreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"URI\\": \\"oss://test-bucket/test-object.jpg\\",\\n \\"OSSURI\\": \\"oss://examplebucket/sampleobject.jpg\\",\\n \\"Filename\\": \\"sampleobject.jpg\\",\\n \\"MediaType\\": \\"image\\",\\n \\"ContentType\\": \\"image/jpeg\\",\\n \\"Size\\": 1000,\\n \\"FileHash\\": \\"1d9c280a7c4f67f7ef873e28449dbe17\\",\\n \\"FileModifiedTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileCreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileAccessTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"ProduceTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"LatLong\\": \\"30.134390,120.074997\\",\\n \\"Timezone\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"AddressLine\\": \\"中国浙江省杭州市余杭区文一西路969号\\",\\n \\"Country\\": \\"中国\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"District\\": \\"余杭区\\",\\n \\"Township\\": \\"文一西路\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"-\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"868a9e74-cde5-4c7a-9013-28bb984****\\",\\n \\"FigureConfidence\\": 1,\\n \\"FigureClusterId\\": \\"Cluster-dbe72fec-b84c-4ab6-885b-3678e64****\\",\\n \\"FigureClusterConfidence\\": 1,\\n \\"FigureType\\": \\"face\\",\\n \\"Age\\": 29,\\n \\"AgeSD\\": 5,\\n \\"Gender\\": \\"female\\",\\n \\"GenderConfidence\\": 1,\\n \\"Emotion\\": \\"happiness\\",\\n \\"EmotionConfidence\\": 0.70784568786621,\\n \\"FaceQuality\\": 0.960875928401947,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n },\\n \\"Mouth\\": \\"close\\",\\n \\"MouthConfidence\\": 1,\\n \\"Beard\\": \\"none\\",\\n \\"BeardConfidence\\": 1,\\n \\"Hat\\": \\"none\\",\\n \\"HatConfidence\\": 1,\\n \\"Mask\\": \\"none\\",\\n \\"MaskConfidence\\": 1,\\n \\"Glasses\\": \\"none\\",\\n \\"GlassesConfidence\\": 0.8,\\n \\"Sharpness\\": 0.7,\\n \\"Attractive\\": 0.96,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 18.385589599609375,\\n \\"Roll\\": 4.204030513763428,\\n \\"Yaw\\": 2.4945924282073975\\n }\\n }\\n ],\\n \\"FigureCount\\": 10,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"座椅\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Title\\": \\"test\\",\\n \\"ImageWidth\\": 270,\\n \\"ImageHeight\\": 500,\\n \\"EXIF\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.736\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 1080,\\n \\"VideoHeight\\": 1920,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"CodecTimeBase\\": \\"1373627/83160000\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"Width\\": 1280,\\n \\"Height\\": 720,\\n \\"HasBFrames\\": 2,\\n \\"SampleAspectRatio\\": \\"1:1\\",\\n \\"DisplayAspectRatio\\": \\"16:9\\",\\n \\"PixelFormat\\": \\"yuv420p\\",\\n \\"Level\\": 40,\\n \\"FrameRate\\": \\"25/1\\",\\n \\"AverageFrameRate\\": \\"25/1\\",\\n \\"TimeBase\\": \\"1/12800\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 22.88,\\n \\"Bitrate\\": 5407765,\\n \\"FrameCount\\": 572,\\n \\"Rotate\\": \\"90\\",\\n \\"BitDepth\\": 8,\\n \\"ColorSpace\\": \\"bt709\\",\\n \\"ColorRange\\": \\"tv\\",\\n \\"ColorTransfer\\": \\"bt709\\",\\n \\"ColorPrimaries\\": \\"bt709\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 2,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"mov_text\\",\\n \\"CodecLongName\\": \\"MOV text\\",\\n \\"CodecTagString\\": \\"tx3g\\",\\n \\"CodecTag\\": \\"0x67337874\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 71.378,\\n \\"Bitrate\\": 74,\\n \\"Content\\": \\"欢迎\\",\\n \\"Width\\": 600,\\n \\"Height\\": 30\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 1,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"TimeBase\\": \\"1/48000\\",\\n \\"StartTime\\": 0.0235,\\n \\"Duration\\": 3.690667,\\n \\"Bitrate\\": 320087,\\n \\"FrameCount\\": 173,\\n \\"Lyric\\": \\"test\\",\\n \\"SampleFormat\\": \\"fltp\\",\\n \\"SampleRate\\": 48000,\\n \\"Channels\\": 2,\\n \\"ChannelLayout\\": \\"stereo\\"\\n }\\n ],\\n \\"Artist\\": \\"Jane\\",\\n \\"AlbumArtist\\": \\"Jane\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 500,\\n \\"ImageHeight\\": 820,\\n \\"EXIF\\": \\"{\\\\\\"FileSize\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"29304\\\\\\"},\\\\\\"Format\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"jpg\\\\\\"}}\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.736\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"Jane\\",\\n \\"Performer\\": \\"Jane\\",\\n \\"Language\\": \\"eng\\",\\n \\"Album\\": \\"FirstAlbum\\",\\n \\"PageCount\\": 5,\\n \\"ETag\\": \\"\\\\\\"1D9C280A7C4F67F7EF873E28449****\\\\\\"\\",\\n \\"CacheControl\\": \\"no-cache\\",\\n \\"ContentDisposition\\": \\"attachment; filename =test.jpg\\",\\n \\"ContentEncoding\\": \\"UTF-8\\",\\n \\"ContentLanguage\\": \\"zh-CN\\",\\n \\"AccessControlAllowOrigin\\": \\"https://aliyundoc.com\\",\\n \\"AccessControlRequestMethod\\": \\"PUT\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"SM4\\",\\n \\"ServerSideEncryption\\": \\"AES256\\",\\n \\"ServerSideDataEncryption\\": \\"SM4\\",\\n \\"ServerSideEncryptionKeyId\\": \\"9468da86-3509-4f8d-a61e-6eab1eac****\\",\\n \\"OSSStorageClass\\": \\"Standard\\",\\n \\"OSSCRC64\\": \\"559890638950338001\\",\\n \\"ObjectACL\\": \\"default\\",\\n \\"ContentMd5\\": \\"HZwoCnxPZ/fvhz4oRJ2+Fw==\\",\\n \\"OSSUserMeta\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSTaggingCount\\": 2,\\n \\"OSSTagging\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSExpiration\\": \\"2120-01-01T12:00:00.000Z\\",\\n \\"OSSVersionId\\": \\"CAEQNhiBgMDJgZCA0BYiIDc4MGZjZGI2OTBjOTRmNTE5NmU5NmFhZjhjYmY0****\\",\\n \\"OSSDeleteMarker\\": \\"CAEQMhiBgIDXiaaB0BYiIGQzYmRkZGUxMTM1ZDRjOTZhNjk4YjRjMTAyZjhl****\\",\\n \\"OSSObjectType\\": \\"Normal\\",\\n \\"CustomId\\": \\"\\\\t\\\\nmember-image-id-0001\\",\\n \\"CustomLabels\\": {\\n \\"MemberName\\": \\"Tim\\",\\n \\"Enabled\\": \\"True\\",\\n \\"ItemCount\\": \\"10\\"\\n },\\n \\"StreamCount\\": 1,\\n \\"ProgramCount\\": 1,\\n \\"FormatName\\": \\"mov\\",\\n \\"FormatLongName\\": \\"QuickTime / MOV\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 13091201,\\n \\"Duration\\": 15.263,\\n \\"SemanticTypes\\": [\\n \\"content\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"text\\",\\n \\"Content\\": \\"文本片段\\",\\n \\"URL\\": \\"http://aliyun.com\\",\\n \\"TimeRange\\": [\\n 500\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"id1\\",\\n \\"ElementType\\": \\"title - 标题； image - 图片 ； table - 表格 ； narrative-text - 正文\\",\\n \\"SemanticSimilarity\\": 0.8,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"child，parent\\",\\n \\"ObjectId\\": \\"id1\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ],\\n \\"FrameTimes\\": [\\n 30\\n ],\\n \\"VideoStreamIndex\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"座椅\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"OCRTexts\\": \\"阿里云IMM\\",\\n \\"Reason\\": \\"[InternalError] The request has been failed due to some unknown error. status: 500, requestId: CC5ACFBD-BB7A-496D-A9D6-****\\",\\n \\"ObjectStatus\\": \\"Indexed\\",\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"无。\\",\\n \\"Caption\\": \\"视频中展示了两个不同场景：一个是静止的白色盘子、黑色瓶子和透明玻璃杯，另一个是手拿着标有“YEZOLU”的洗发水瓶在浴室中缓慢上移。\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"无。\\",\\n \\"Description\\": \\"图片中有一人，穿着深色西装外套，内搭白色衬衫。背景为渐变的浅蓝色至灰色。\\"\\n }\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'BatchIndexFileMeta' => [ + 'summary' => 'This operation performs a batch index of object metadata by processing input files for tasks such as label detection, face detection, and location detection. The object metadata is then indexed into a dataset to support various data retrieval methods.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREimmSZD9WY', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '33174', + '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', - ], + 'schema' => ['description' => 'The project name. For more information about how to obtain the project name, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The dataset name. For more information about how to obtain the dataset name, see [Create a dataset](~~478160~~).', 'type' => 'string', 'required' => true, 'example' => 'test-dataset', 'title' => ''], ], [ - 'name' => 'DatasetMaxRelationCount', + 'name' => 'Files', 'in' => 'query', + 'style' => 'json', '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', + 'description' => 'A list of OSS files. This is an array in JSON format that can contain up to 100 files.', + 'type' => 'array', + 'items' => ['description' => 'The struct of an OSS file.', '$ref' => '#/components/schemas/InputFile', 'required' => false, 'title' => '', 'example' => ''], + 'required' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DatasetMaxTotalFileSize', + 'name' => 'UserData', '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', - ], + 'schema' => ['description' => 'Custom user data. This parameter takes effect only when you specify an MNS configuration for the Notification parameter. The data is returned in the asynchronous notification message, which you can use to associate the message with your services. The maximum length is 2048 bytes.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "id": "test-id",'."\n" + .' "name": "test-name"'."\n" + .'}', 'title' => ''], ], [ - 'name' => 'WorkflowParameters', + 'name' => 'Notification', 'in' => 'query', 'style' => 'json', - 'schema' => [ - 'description' => 'Invalid parameter.', - 'type' => 'array', - 'items' => [ - 'description' => '无效参数。', - 'required' => false, - '$ref' => '#/components/schemas/WorkflowParameter', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The notification configuration. For more information, click Notification. For the format of asynchronous notification messages, see the metadata indexing section in [Asynchronous notification message formats](~~2743997~~).', '$ref' => '#/components/schemas/Notification', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应结构体', + 'description' => 'The response struct.', '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', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8F93E6D9-5AC0-49F9-914D-E02678A3****'], + 'EventId' => ['description' => 'The event ID.', 'type' => 'string', 'example' => '387-1DAPFFZplUZhuCuhnB6I9H****', 'title' => ''], ], + 'example' => '', ], ], ], - '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" + 'staticInfo' => ['returnType' => 'asynchronous', 'callback' => 'imm::2020-09-30::BatchGetFileMeta', 'callbackInterval' => 10000, 'maxCallbackTimes' => 3], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8F93E6D9-5AC0-49F9-914D-E02678A3****\\",\\n \\"EventId\\": \\"387-1DAPFFZplUZhuCuhnB6I9H****\\"\\n}","type":"json"}]', + 'title' => 'BatchIndexFileMeta', + 'description' => '- **Before you use this API, review the billing methods and [pricing](~~477042~~) of Intelligent Media Management.**'."\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', + .'- For a list of supported data processing tasks, see [Define a workflow](~~466304~~).'."\n" + ."\n" + .'- The files to be indexed are subject to limits on their total number and size. For more information about dataset limits, see [Limits](~~475569~~). For information about how to create a dataset, see the parameter descriptions.'."\n" + ."\n" + .'- For information about the regions that support file indexing, see the dataset and index information in [Limits](~~475569~~).', + 'changeSet' => [ + ['createdAt' => '2024-04-15T08:38:43.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-27T09:02:45.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-09T10:57:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-16T06:44:21.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-16T06:44:21.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-06-15T02:14:00.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchIndexFileMeta'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:BatchIndexFileMeta', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + ], + ], + 'BatchUpdateFileMeta' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '33177', + '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', - ], + 'schema' => ['description' => 'The name of the project.[](~~478153~~)'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The name of the dataset.[](~~478160~~)'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-dataset', 'title' => ''], ], [ - 'name' => 'WithStatistics', + 'name' => 'Files', 'in' => 'query', + 'style' => 'json', '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', + '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', 'title' => '', 'example' => ''], + 'required' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', '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', + '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', 'title' => ''], + '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', + 'title' => '', + ], + '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.', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'BatchUpdateFileMeta', + 'summary' => 'Updates some metadata items of files indexed into a dataset.', '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', + .'* 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", + 'changeSet' => [ + ['createdAt' => '2023-04-23T08:06:47.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-06-15T02:13:47.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchUpdateFileMeta'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:BatchUpdateFileMeta', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], ], + '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":""}]', + ], + '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' => 'list', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '160091', + 'abilityTreeNodes' => ['FEATUREimmE6F82K'], ], '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', - ], + 'schema' => ['description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - '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', + 'name' => 'CredentialConfig', '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', - ], + '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', 'title' => '', 'example' => ''], ], [ - 'name' => 'Prefix', + 'name' => 'Source', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The dataset prefix.'."\n", - 'type' => 'string', + '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', 'title' => ''], + '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', 'title' => ''], + ], 'required' => false, - 'example' => 'dataset', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => '返回结构体', - 'description' => 'The data structure returned.'."\n", + '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' => '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', - ], - ], + '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', 'title' => ''], ], + 'example' => '', ], ], ], - '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', + '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", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CompareImageFaces'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:CompareImageFaces', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F73AC982-2B9E-4ECD-AED5-F8331C5******\\",\\n \\"Similarity\\": 0.8848152756690983\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'operationType' => 'read', + ], + 'ContextualAnswer' => [ + 'summary' => 'Phase II of AI Assistant, Q\\&A API', + 'methods' => ['post', 'get'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + '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' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", - 'type' => 'string', + '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', 'title' => '', 'example' => ''], 'required' => true, - 'example' => 'immtest', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DatasetName', - 'in' => 'query', + 'name' => 'Files', + 'in' => 'formData', + 'style' => 'json', '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', + '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', 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -9591,99 +4460,111 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EC564B8B-BA5C-4499-B196-D9B9E76E****', - ], + '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', 'title' => '', 'example' => ''], + 'Code' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'ResourceNotFound', 'title' => ''], + 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'The specified resource project is not found.', 'title' => ''], ], + 'example' => '', ], ], ], - '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', + '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' => 'Q\\&A API in AI Assistant', + '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.', + 'changeSet' => [ + ['createdAt' => '2025-01-02T06:37:56.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:ContextualAnswer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ContextualRetrieval' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '32774', - 'abilityTreeNodes' => [ - 'FEATUREimmSZD9WY', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '226437', + 'abilityTreeNodes' => ['FEATUREimmDN11M0'], ], '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', - ], + '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).', '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', - ], + 'schema' => ['description' => 'The dataset.', 'type' => 'string', 'required' => true, 'example' => 'test-dataset', 'title' => ''], ], [ - 'name' => 'File', - 'in' => 'query', + 'name' => 'Messages', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The file for which you want to create a metadata index. The value must be in the JSON format.'."\n", + '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.', + 'type' => 'array', + 'items' => ['description' => 'The message list.', '$ref' => '#/components/schemas/ContextualMessage', 'required' => false, 'title' => '', 'example' => ''], 'required' => true, - '$ref' => '#/components/schemas/InputFile', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'UserData', + 'name' => 'RecallOnly', '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"}', - ], + '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.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'Notification', - 'in' => 'query', + 'name' => 'SmartClusterIds', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The notification settings. For information about the asynchronous notification format, see [Asynchronous message examples](~~2743997~~).'."\n", + 'description' => 'The IDs of clusters from which results are retrieved.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => false, 'example' => 'SmartCluster-01686226-be59-4391-a1ac-b7b073455de3', 'title' => ''], 'required' => false, - '$ref' => '#/components/schemas/Notification', + 'title' => '', + 'example' => '', ], ], ], @@ -9691,53 +4572,61 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', '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****', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', '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.', + 'type' => 'array', + 'items' => ['description' => 'The file.', '$ref' => '#/components/schemas/File', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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" + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '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.', + 'description' => '### 注意事项'."\n" ."\n" - .'**'."\n" + .'- 请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](https://help.aliyun.com/zh/imm/product-overview/billable-items?spm=openapi-amp.newDocPublishment.0.0.1ecd281fi27Zgk)。'."\n" ."\n" - .'**Usage notes**'."\n" + .'- 调用该接口前，请确保您已通过绑定方式（ [CreateBinding](https://help.aliyun.com/zh/imm/developer-reference/api-imm-2020-09-30-createbinding?spm=a2c4g.11186623.0.0.a3d76f44xJrOnF) ）或者主动索引（ [IndexFileMeta](https://help.aliyun.com/zh/imm/developer-reference/api-imm-2020-09-30-indexfilemeta?spm=a2c4g.11186623.help-menu-search-62354.d_0) 或者 [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) ）方式将文件索引到数据集（Dataset）中。'."\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', + .'- 返回结果仅为示例，根据[工作流模板配置](https://help.aliyun.com/zh/imm/user-guide/workflow-templates-and-operators?spm=a2c4g.11186623.0.0.a3d775abr3hDFp)不同，获取到的文件元数据信息的类别和包含的内容均有可能与示例不同。如果有疑问，请使用钉钉搜索钉钉群号 21714099 加入钉钉群进行反馈。'."\n" + ."\n" + .'### 使用限制'."\n" + ."\n" + .'- 历史对话长度最长限制为 100，包括用户消息和助手消息。'."\n" + ."\n" + .'- 每条消息长度不超过 1000 个汉字。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:ContextualRetrieval', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6E93D6C9-5AC0-49F9-914D-E02678D3****\\",\\n \\"Results\\": [\\n {\\n \\"OwnerId\\": \\"102321002467****\\",\\n \\"ProjectName\\": \\"test-project\\",\\n \\"DatasetName\\": \\"test-dataset\\",\\n \\"ObjectType\\": \\"file\\",\\n \\"ObjectId\\": \\"75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7\\",\\n \\"UpdateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"CreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"URI\\": \\"oss://test-bucket/test-object.jpg\\",\\n \\"OSSURI\\": \\"oss://examplebucket/sampleobject.jpg\\",\\n \\"Filename\\": \\"sampleobject.jpg\\",\\n \\"MediaType\\": \\"image\\",\\n \\"ContentType\\": \\"image/jpeg\\",\\n \\"Size\\": 1000,\\n \\"FileHash\\": \\"1d9c280a7c4f67f7ef873e28449dbe17\\",\\n \\"FileModifiedTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileCreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileAccessTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"ProduceTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"LatLong\\": \\"30.134390,120.074997\\",\\n \\"Timezone\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"AddressLine\\": \\"中国浙江省杭州市余杭区文一西路969号\\",\\n \\"Country\\": \\"中国\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"District\\": \\"余杭区\\",\\n \\"Township\\": \\"文一西路\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"-\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"868a9e74-cde5-4c7a-9013-28bb984****\\",\\n \\"FigureConfidence\\": 1,\\n \\"FigureClusterId\\": \\"Cluster-dbe72fec-b84c-4ab6-885b-3678e64****\\",\\n \\"FigureClusterConfidence\\": 1,\\n \\"FigureType\\": \\"face\\",\\n \\"Age\\": 29,\\n \\"AgeSD\\": 5,\\n \\"Gender\\": \\"female\\",\\n \\"GenderConfidence\\": 1,\\n \\"Emotion\\": \\"happiness\\",\\n \\"EmotionConfidence\\": 0.70784568786621,\\n \\"FaceQuality\\": 0.960875928401947,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n },\\n \\"Mouth\\": \\"close\\",\\n \\"MouthConfidence\\": 1,\\n \\"Beard\\": \\"none\\",\\n \\"BeardConfidence\\": 1,\\n \\"Hat\\": \\"none\\",\\n \\"HatConfidence\\": 1,\\n \\"Mask\\": \\"none\\",\\n \\"MaskConfidence\\": 1,\\n \\"Glasses\\": \\"none\\",\\n \\"GlassesConfidence\\": 0.8,\\n \\"Sharpness\\": 0.7,\\n \\"Attractive\\": 0.96,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 18.385589599609375,\\n \\"Roll\\": 4.204030513763428,\\n \\"Yaw\\": 2.4945924282073975\\n }\\n }\\n ],\\n \\"FigureCount\\": 10,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"座椅\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Title\\": \\"test\\",\\n \\"ImageWidth\\": 270,\\n \\"ImageHeight\\": 500,\\n \\"EXIF\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.736\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 1080,\\n \\"VideoHeight\\": 1920,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"CodecTimeBase\\": \\"1373627/83160000\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"Width\\": 1280,\\n \\"Height\\": 720,\\n \\"HasBFrames\\": 2,\\n \\"SampleAspectRatio\\": \\"1:1\\",\\n \\"DisplayAspectRatio\\": \\"16:9\\",\\n \\"PixelFormat\\": \\"yuv420p\\",\\n \\"Level\\": 40,\\n \\"FrameRate\\": \\"25/1\\",\\n \\"AverageFrameRate\\": \\"25/1\\",\\n \\"TimeBase\\": \\"1/12800\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 22.88,\\n \\"Bitrate\\": 5407765,\\n \\"FrameCount\\": 572,\\n \\"Rotate\\": \\"90\\",\\n \\"BitDepth\\": 8,\\n \\"ColorSpace\\": \\"bt709\\",\\n \\"ColorRange\\": \\"tv\\",\\n \\"ColorTransfer\\": \\"bt709\\",\\n \\"ColorPrimaries\\": \\"bt709\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 2,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"mov_text\\",\\n \\"CodecLongName\\": \\"MOV text\\",\\n \\"CodecTagString\\": \\"tx3g\\",\\n \\"CodecTag\\": \\"0x67337874\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 71.378,\\n \\"Bitrate\\": 74,\\n \\"Content\\": \\"欢迎\\",\\n \\"Width\\": 600,\\n \\"Height\\": 30\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 1,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"TimeBase\\": \\"1/48000\\",\\n \\"StartTime\\": 0.0235,\\n \\"Duration\\": 3.690667,\\n \\"Bitrate\\": 320087,\\n \\"FrameCount\\": 173,\\n \\"Lyric\\": \\"test\\",\\n \\"SampleFormat\\": \\"fltp\\",\\n \\"SampleRate\\": 48000,\\n \\"Channels\\": 2,\\n \\"ChannelLayout\\": \\"stereo\\"\\n }\\n ],\\n \\"Artist\\": \\"Jane\\",\\n \\"AlbumArtist\\": \\"Jane\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 500,\\n \\"ImageHeight\\": 820,\\n \\"EXIF\\": \\"{\\\\\\"FileSize\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"29304\\\\\\"},\\\\\\"Format\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"jpg\\\\\\"}}\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.736\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"Jane\\",\\n \\"Performer\\": \\"Jane\\",\\n \\"Language\\": \\"eng\\",\\n \\"Album\\": \\"FirstAlbum\\",\\n \\"PageCount\\": 5,\\n \\"ETag\\": \\"\\\\\\"1D9C280A7C4F67F7EF873E28449****\\\\\\"\\",\\n \\"CacheControl\\": \\"no-cache\\",\\n \\"ContentDisposition\\": \\"attachment; filename =test.jpg\\",\\n \\"ContentEncoding\\": \\"UTF-8\\",\\n \\"ContentLanguage\\": \\"zh-CN\\",\\n \\"AccessControlAllowOrigin\\": \\"https://aliyundoc.com\\",\\n \\"AccessControlRequestMethod\\": \\"PUT\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"SM4\\",\\n \\"ServerSideEncryption\\": \\"AES256\\",\\n \\"ServerSideDataEncryption\\": \\"SM4\\",\\n \\"ServerSideEncryptionKeyId\\": \\"9468da86-3509-4f8d-a61e-6eab1eac****\\",\\n \\"OSSStorageClass\\": \\"Standard\\",\\n \\"OSSCRC64\\": \\"559890638950338001\\",\\n \\"ObjectACL\\": \\"default\\",\\n \\"ContentMd5\\": \\"HZwoCnxPZ/fvhz4oRJ2+Fw==\\",\\n \\"OSSUserMeta\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSTaggingCount\\": 2,\\n \\"OSSTagging\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSExpiration\\": \\"2120-01-01T12:00:00.000Z\\",\\n \\"OSSVersionId\\": \\"CAEQNhiBgMDJgZCA0BYiIDc4MGZjZGI2OTBjOTRmNTE5NmU5NmFhZjhjYmY0****\\",\\n \\"OSSDeleteMarker\\": \\"CAEQMhiBgIDXiaaB0BYiIGQzYmRkZGUxMTM1ZDRjOTZhNjk4YjRjMTAyZjhl****\\",\\n \\"OSSObjectType\\": \\"Normal\\",\\n \\"CustomId\\": \\"\\\\t\\\\nmember-image-id-0001\\",\\n \\"CustomLabels\\": {\\n \\"MemberName\\": \\"Tim\\",\\n \\"Enabled\\": \\"True\\",\\n \\"ItemCount\\": \\"10\\"\\n },\\n \\"StreamCount\\": 1,\\n \\"ProgramCount\\": 1,\\n \\"FormatName\\": \\"mov\\",\\n \\"FormatLongName\\": \\"QuickTime / MOV\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 13091201,\\n \\"Duration\\": 15.263,\\n \\"SemanticTypes\\": [\\n \\"content\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"text\\",\\n \\"Content\\": \\"文本片段\\",\\n \\"URL\\": \\"http://aliyun.com\\",\\n \\"TimeRange\\": [\\n 500\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"id1\\",\\n \\"ElementType\\": \\"title - 标题； image - 图片 ； table - 表格 ； narrative-text - 正文\\",\\n \\"SemanticSimilarity\\": 0.8,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"child，parent\\",\\n \\"ObjectId\\": \\"id1\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ],\\n \\"FrameTimes\\": [\\n 30\\n ],\\n \\"VideoStreamIndex\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"座椅\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"OCRTexts\\": \\"阿里云IMM\\",\\n \\"Reason\\": \\"[InternalError] The request has been failed due to some unknown error. status: 500, requestId: CC5ACFBD-BB7A-496D-A9D6-****\\",\\n \\"ObjectStatus\\": \\"Indexed\\",\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"无。\\",\\n \\"Caption\\": \\"视频中展示了两个不同场景：一个是静止的白色盘子、黑色瓶子和透明玻璃杯，另一个是手拿着标有“YEZOLU”的洗发水瓶在浴室中缓慢上移。\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"无。\\",\\n \\"Description\\": \\"图片中有一人，穿着深色西装外套，内搭白色衬衫。背景为渐变的浅蓝色至灰色。\\"\\n }\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateArchiveFileInspectionTask' => [ + 'summary' => 'Creates a task to inspect a compressed file and retrieve a list of its contents without decompressing the file.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9747,118 +4636,130 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '33174', - 'abilityTreeNodes' => [ - 'FEATUREimmSZD9WY', - ], + 'abilityTreeCode' => '157951', + 'abilityTreeNodes' => ['FEATUREimm2Z44LQ'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the project.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['description' => 'The project name. For more information, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'DatasetName', + 'name' => 'CredentialConfig', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the dataset.[](~~478160~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-dataset', - ], + 'style' => 'json', + 'schema' => ['description' => '**Leave this parameter empty if you do not have special requirements.**'."\n" + ."\n" + .'The configuration for chained authorization. This parameter is not required. For more information, see [Use chained authorization to access resources of other entities](~~465340~~).', '$ref' => '#/components/schemas/CredentialConfig', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'Files', + 'name' => 'Password', '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, - ], + 'schema' => ['description' => 'The password of the compressed file. If the file is encrypted, provide the password to inspect its contents.', 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''], ], [ '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" - .'}', - ], + 'schema' => ['description' => 'Custom information that is returned in the asynchronous notification message. You can use this information to associate the notification message with your services. The maximum length is 2,048 bytes.', 'type' => 'string', 'required' => false, 'example' => 'test-data', 'title' => ''], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => ['description' => 'The location of the compressed file.'."\n" + ."\n" + .'The Object Storage Service (OSS) URI must be in the oss\\://${Bucket}/${Object} format. In this format, `${Bucket}` is the name of the OSS bucket that is in the same region as the current project, and `${Object}` is the full path of the file, including the file name extension.', 'type' => 'string', 'required' => false, 'example' => 'oss://bucket/test-object.zip', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The notification configuration. For more information, see Notification. For the format of asynchronous notification messages, see [Asynchronous notification message format](~~2743997~~).'."\n" + ."\n" + .'> Currently, API callbacks in IMM do not support custom webhook addresses. Use MNS instead.', 'deprecated' => false, '$ref' => '#/components/schemas/Notification', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response struct.', '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****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'EC564A9A-BA5C-4499-A087-D9B9E76E*****'], + 'EventId' => ['description' => 'The event ID.', 'type' => 'string', 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16Es*****', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'ArchiveFileInspection-8475218e-d86e-4c66-b3cf-50e74d6c****', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'asynchronous', - 'callback' => 'imm::2020-09-30::BatchGetFileMeta', - 'callbackInterval' => 10000, - 'maxCallbackTimes' => 3, + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EC564A9A-BA5C-4499-A087-D9B9E76E*****\\",\\n \\"EventId\\": \\"0ED-1Bz8z71k5TtsUejT4UJ16Es*****\\",\\n \\"TaskId\\": \\"ArchiveFileInspection-8475218e-d86e-4c66-b3cf-50e74d6c****\\"\\n}","type":"json"}]', + 'title' => 'CreateArchiveFileInspectionTask', + 'description' => '> This API is in public preview. If you have any questions, join the DingTalk group to provide feedback. For the DingTalk group number, see [Contact us](~~84454~~).'."\n" + ."\n" + .'- **Before using this API, make sure you understand the billing methods and [pricing](~~477042~~) of Intelligent Media Management (IMM)**.'."\n" + .' ><notice>The completion time of asynchronous tasks is not guaranteed.></notice>'."\n" + ."\n" + .'- File count limit: A compressed file can contain a maximum of 80,000 files.'."\n" + ."\n" + .'- File size limit: The maximum size is 200 GB for ZIP and RAR files, and 50 GB for 7z files.'."\n" + ."\n" + .'- This is an asynchronous API. Task information is saved for 7 days after a task starts and is then deleted. To view the task information, call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation with the returned `TaskId`. You can also set the [Notification](~~2743997~~) parameter to receive task information through notification messages.', + 'requestParamsDescription' => '- To retrieve the list of files in the compressed file, set the `ExtendedMessageURI` parameter in `Notification`. The generated file list is structured as follows:'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "Password" : "The password of the compressed file",'."\n" + .' "IsEncryption": "true/false, specifies whether the compressed file is encrypted",'."\n" + .' "ArchiveFiles": ['."\n" + .' {'."\n" + .' "PathName": "The path of the file relative to the compressed file. Example: ./test-dir/test.txt",'."\n" + .' "Reason": "If the inspection fails, the reason for the failure.",'."\n" + .' "IsFolder": "true/false, specifies whether the entry is a folder",'."\n" + .' "PackedSize": "The size of the file within the compressed file",'."\n" + .' "UnPackedSize": "The size of the file after decompression",'."\n" + .' "FileAccessTime": "The file access time.",'."\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" + .'```', + 'changeSet' => [ + ['createdAt' => '2023-08-30T07:22:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-03T02:37:21.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-09T10:57:44.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - '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', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateArchiveFileInspectionTask'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateArchiveFileInspectionTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + ], + 'CreateBatch' => [ + 'summary' => 'Creates a batch processing task that performs specified operations, such as transcoding and format conversion, on multiple existing files.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9867,1045 +4768,652 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', - 'abilityTreeCode' => '33172', - 'abilityTreeNodes' => [ - 'FEATUREimmSZD9WY', - ], + 'abilityTreeCode' => '131090', + 'abilityTreeNodes' => ['FEATUREimmTATRRB'], ], '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', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The project name. For more information, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'DatasetName', - 'in' => 'query', + 'name' => 'Input', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['description' => 'The input data source configuration.', 'required' => true, '$ref' => '#/components/schemas/Input', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Actions', + 'in' => 'formData', + 'style' => 'json', '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', + 'description' => 'A list of processing templates.', + 'type' => 'array', + 'items' => [ + 'description' => 'A processing template.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The template name.', 'type' => 'string', 'required' => true, 'example' => 'doc/convert', 'title' => ''], + 'Parameters' => [ + 'description' => 'A list of template parameters.', + 'type' => 'array', + 'items' => ['description' => 'A template parameter.', 'type' => 'string', 'required' => false, 'example' => 'pages=3', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'FastFailPolicy' => ['description' => 'The fast-fail policy configuration.', '$ref' => '#/components/schemas/FastFailPolicy', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => 'test-dataset', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'File', - 'in' => 'query', + 'name' => 'Notification', + 'in' => 'formData', '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', + 'description' => 'The notification recipient. Multiple middleware services are supported. For details about the message format, see Asynchronous notification message. Select one of the following methods to receive messages:'."\n" + ."\n" + .'Activate and access EventBridge in the same region as Intelligent Media Management (IMM) to promptly receive task notifications. For more information, see IMM events.'."\n" + .'Activate MNS in the same region as IMM and configure a subscription.', + 'type' => 'object', + 'properties' => [ + 'MNS' => ['description' => 'The parameters for MNS notifications.', '$ref' => '#/components/schemas/MNS', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['description' => 'Custom tags used to search and filter asynchronous tasks.', 'type' => 'object', 'required' => false, 'example' => '{"key": "val"}'."\n", 'title' => ''], + ], + [ + 'name' => 'ServiceRole', + 'in' => 'formData', + 'schema' => ['description' => 'The service role that grants IMM the permissions to access other cloud resources, such as OSS. The default value is AliyunIMMBatchTriggerRole.'."\n" + ."\n" + .'To use a custom service role, create a service role and grant permissions to the role in the RAM console. For more information, see [Create a service role](~~116800~~) and [Grant permissions to a RAM role](~~116147~~).', 'type' => 'string', 'required' => true, 'example' => 'AliyunIMMBatchTriggerRole', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6D53E6C9-5AC0-48F9-825F-D02678E3****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EC564A9A-BA5C-4499-A087-D9B9E76E*****', 'title' => ''], + 'Id' => ['description' => 'The batch processing task ID.', 'type' => 'string', 'example' => 'batch-4eb9223f-3e88-42d3-a578-3f2852******', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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 process data using [Object Storage Service (OSS) data processing](~~99372~~), make sure you [bind an OSS bucket](~~478206~~) before you create a batch processing task.', + 'changeSet' => [ + ['createdAt' => '2023-07-05T05:47:24.000Z', 'description' => 'Request parameters changed'], ], - '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', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBatch'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateBatch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Batch', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/batch/*'], + ], + ], + ], ], + ], + 'CreateBinding' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '33177', - 'abilityTreeNodes' => [ - 'FEATUREimmSZD9WY', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '18909', + 'abilityTreeNodes' => ['FEATUREimmSZD9WY'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the project.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['title' => 'ProjectName', 'description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.', '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', - ], + 'schema' => ['title' => 'DatasetName', 'description' => 'The name of the dataset. You can obtain the name of the dataset from the response of the [CreateDataset](~~478160~~) operation.', 'type' => 'string', 'required' => false, 'example' => 'test-dataset'], ], [ - 'name' => 'Files', + 'name' => 'URI', '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, - ], + 'schema' => ['title' => 'URI', '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.', 'type' => 'string', 'required' => true, 'example' => 'oss://test-bucket'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', '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.', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5F74C5C9-5AC0-49F9-914D-E01589D3****'], + 'Binding' => ['description' => 'The information about the binding.', '$ref' => '#/components/schemas/Binding', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '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.', + '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" + ."\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.', + 'changeSet' => [ + ['createdAt' => '2024-09-03T10:58:54.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-04-19T09:44:00.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-06-15T02:14:12.000Z', 'description' => 'OpenAPI offline'], ], - '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', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBinding'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateBinding', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5F74C5C9-5AC0-49F9-914D-E01589D3****\\",\\n \\"Binding\\": {\\n \\"ProjectName\\": \\"immtest\\",\\n \\"DatasetName\\": \\"dataset001\\",\\n \\"URI\\": \\"oss://examplebucket\\",\\n \\"State\\": \\"Running\\",\\n \\"Phase\\": \\"FullScanning\\",\\n \\"CreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"UpdateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"Reason\\": \\"pause usage\\"\\n }\\n}","type":"json"}]', + ], + 'CreateCompressPointCloudTask' => [ + 'summary' => 'Compresses point cloud data stored in Object Storage Service (OSS) to reduce network data transmission.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '32848', - 'abilityTreeNodes' => [ - 'FEATUREimmSZD9WY', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '145992', + 'abilityTreeNodes' => ['FEATUREimm0H0W4Y'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the project.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['description' => 'The project name. For information about how to obtain the project name, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'DatasetName', + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The OSS URI of the point cloud file.'."\n" + ."\n" + .'The OSS URI follows the format oss://${Bucket}/${Object}, where `${Bucket}` is the name of an OSS bucket in the same region as the current project, and `${Object}` is the full path of the file including the file name extension.', 'type' => 'string', 'required' => true, 'example' => 'oss://test/src/test.pcd'], + ], + [ + 'name' => 'TargetURI', + 'in' => 'query', + 'schema' => ['description' => 'The OSS URI of the compressed output file.'."\n" + ."\n" + .'The OSS URI follows the format oss://${Bucket}/${Object}, where `${Bucket}` is the name of an OSS bucket in the same region as the current project, and `${Object}` is the full path of the file including the file name extension.', 'type' => 'string', 'required' => true, 'example' => 'oss://test/tgt', 'title' => ''], + ], + [ + 'name' => 'PointCloudFileFormat', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the dataset.[](~~478160~~)'."\n", + 'description' => 'The point cloud file format. Only PCD format is supported. Default value: pcd.', + 'enumValueTitles' => ['pcd' => 'point cloud file format.'], 'type' => 'string', - 'required' => true, - 'example' => 'test-dataset', + 'example' => 'pcd', + 'default' => 'pcd', + 'enum' => ['pcd'], + 'required' => false, + 'title' => '', ], ], [ - 'name' => 'URI', + 'name' => 'CompressMethod', 'in' => 'query', 'schema' => [ - 'description' => 'The URI of the file. Make sure that the file is indexed****.'."\n" + 'description' => 'The compression algorithm. Valid values:'."\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" + .'- octree: octree'."\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", + .'- kdtree: K-d tree', + 'enumValueTitles' => ['octree' => 'octree.', 'kdtree' => 'K-d tree.'], 'type' => 'string', 'required' => true, - 'enumValueTitles' => [], - 'example' => 'oss://test-bucket/test-object', + 'example' => 'octree', + 'enum' => ['octree', 'kdtree'], + 'title' => '', ], ], [ - 'name' => 'WithFields', + 'name' => 'PointCloudFields', 'in' => 'query', + 'allowEmptyValue' => false, '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" + 'description' => 'The PCD attribute fields that participate in compression and the compression order. After compression, data is decompressed in this order.'."\n" + ."\n" + .'- If you use PCL library octree compression, \\["xyz"] is supported.'."\n" ."\n" - .'If you do not specify this parameter or leave this parameter empty, the operation returns all metadata fields of the file.'."\n", + .'- If you use Draco library K-d tree compression, \\["xyz"] or \\["xyz", "intensity"] is supported.', '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', - ], - ], - ], + 'items' => ['description' => 'The PCD attribute field value that participates in compression. Valid values:'."\n" + ."\n" + .'- xyz'."\n" + ."\n" + .'- intensity', 'type' => 'string', 'example' => '["xyz"]', 'required' => false, 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', ], ], - ], - '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' => [], + 'name' => 'KdtreeOption', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The K-d tree compression parameters.', '$ref' => '#/components/schemas/KdtreeOption', 'required' => false, 'title' => '', 'example' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '33178', - 'abilityTreeNodes' => [ - 'FEATUREimmSZD9WY', + [ + 'name' => 'OctreeOption', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The octree compression parameters.', '$ref' => '#/components/schemas/OctreeOption', 'required' => false, 'title' => '', 'example' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'ProjectName', + 'name' => 'UserData', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the project.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['description' => 'The custom information, which is returned in asynchronous message notifications to help you associate message notifications within your system. Maximum length: 2,048 bytes.', 'type' => 'string', 'required' => false, 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', 'title' => ''], ], [ - 'name' => 'DatasetName', + 'name' => 'Tags', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the dataset.[](~~478160~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-dataset', - ], + 'style' => 'json', + 'schema' => ['description' => 'The custom tags that are used to search for and filter asynchronous tasks.', 'type' => 'object', 'required' => false, 'example' => '{"LabelKey": "Value"}', 'title' => ''], ], [ - 'name' => 'URIs', + 'name' => 'CredentialConfig', '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, - ], + 'schema' => ['description' => '**Leave this parameter empty unless you have special requirements.**'."\n" + ."\n" + .'The China authorization configuration. This parameter is optional. For more information, see [Use chained authorization to access resources of other entities](~~465340~~).', '$ref' => '#/components/schemas/CredentialConfig', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'WithFields', + 'name' => 'Notification', '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, - ], + 'schema' => ['description' => 'The message notification configuration. For more information, click Notification. For information about the format of asynchronous notification messages, see [Asynchronous notification message format](~~2743997~~).'."\n" + ."\n" + .'> Intelligent Media Management does not support specifying a callback URL for API call callbacks. Use Message Service (MNS) instead.'."\n" + .'>', '$ref' => '#/components/schemas/Notification', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', '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', - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FFF****'], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'PointCloudCompress-badda57d-a3ab-4e6d-938f-49b77ce****', 'title' => ''], + 'EventId' => ['description' => 'The event ID.', 'type' => 'string', 'example' => '0B7-1LR4Wcue1aBhk2xT85MfL*****', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FFF****\\",\\n \\"TaskId\\": \\"PointCloudCompress-badda57d-a3ab-4e6d-938f-49b77ce****\\",\\n \\"EventId\\": \\"0B7-1LR4Wcue1aBhk2xT85MfL*****\\"\\n}","type":"json"}]', + 'title' => 'Create a point cloud compression task', + 'description' => '* **Before you use this operation, make sure that you are familiar with the billing of Intelligent Media Management (IMM). For more information, see [Billing](~~477042~~).**'."\n" + .'<notice>Asynchronous tasks do not guarantee timeliness.</notice>'."\n" + .'* File format limit: Only point cloud files in PCD format are supported.'."\n" + ."\n" + .'* This is an asynchronous operation. After the task starts, task information is retained for only 7 days. After 7 days, the task information can no longer be retrieved. Call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation to obtain the returned `TaskId` and view the task information. You can also configure the [Notification](~~2743997~~) parameter to receive task information through message notifications.', + 'changeSet' => [ + ['createdAt' => '2023-04-03T02:37:21.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-09T10:57:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-16T02:32:03.000Z', 'description' => 'OpenAPI offline'], ], - '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', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCompressPointCloudTask'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateCompressPointCloudTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + ], + 'CreateCustomizedStory' => [ + 'summary' => 'Creates a story based on the specified images and videos.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '33169', - 'abilityTreeNodes' => [ - 'FEATUREimmSZD9WY', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '156038', + 'abilityTreeNodes' => ['FEATUREimmPQ568C'], ], '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', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The name of the project.[](~~478153~~)'."\n", 'type' => 'string', 'required' => true, 'example' => 'immtest', 'title' => ''], ], [ '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', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The name of the dataset.[](~~478160~~)'."\n", 'type' => 'string', 'required' => true, 'example' => 'dataset001', 'title' => ''], ], [ - '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****', - ], - ], - ], + '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', 'title' => ''], ], - ], - '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', + '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', 'title' => ''], ], - ], - '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' => 'StoryName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the story.'."\n", 'type' => 'string', 'required' => true, 'example' => 'name1', 'title' => ''], ], [ - 'name' => 'DatasetName', - 'in' => 'query', + 'name' => 'Cover', + 'in' => 'formData', + 'style' => 'json', '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', + '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://test-bucket/test-object.jpg', 'title' => ''], + ], 'required' => true, - 'example' => 'test-dataset', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'URIs', - 'in' => 'query', + 'name' => 'Files', + 'in' => 'formData', '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", + 'description' => 'The files of the story. You can specify up to 100 files in a custom story.'."\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', + 'type' => 'object', + 'properties' => [ + 'URI' => ['description' => 'The URIs of the files.'."\n", 'type' => 'string', 'required' => true, 'example' => '['."\n" + .' {'."\n" + .' "URI": "oss://test-bucket/test-object_1.jpg"'."\n" + .' },'."\n" + .'{'."\n" + .' "URI": "oss://test-bucket/test-object_2.jpg"'."\n" + .' }'."\n" + .']', 'title' => ''], + ], + 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => true, + 'title' => '', + 'example' => '', ], ], + [ + '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' => '{'."\n" + .' "MyStoryLabel": "HolidayStory"'."\n" + .'}', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3A82F6C9-5AC0-38F9-914F-F02623B3****', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'BC91D091-D49F-0ACD-95D5-F0621045****', 'title' => ''], + 'ObjectId' => ['description' => 'The ID of the story.'."\n", 'type' => 'string', 'example' => '563062c0b085733f34ab****', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3A82F6C9-5AC0-38F9-914F-F02623B3****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'BatchDeleteFileMeta', + '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" - .'* 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', + .'* 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", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomizedStory'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateCustomizedStory', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], ], + ], + 'CreateDataset' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '4489', - 'abilityTreeNodes' => [ - 'FEATUREimmDN11M0', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREimmSZD9WY'], ], 'parameters' => [ [ - 'name' => 'NextToken', + 'name' => 'ProjectName', '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==', - ], + 'schema' => ['title' => '', 'description' => 'The project name. For information about how to obtain the project name, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ - 'name' => 'MaxResults', + 'name' => 'DatasetName', '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', - ], + 'schema' => ['title' => '', 'description' => 'The dataset name. The name must be unique within the same project. The following naming rules apply:'."\n" + .'- The name must be 1 to 128 characters in length.'."\n" + .'- The name can contain only letters, digits, hyphens (-), and underscores (_).'."\n" + .'- The name must start with a letter or an underscore (_).', 'type' => 'string', 'required' => true, 'example' => 'dataset001'], ], [ - 'name' => 'ProjectName', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'title' => '项目名称', - 'description' => 'The name of the project.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['title' => '', 'description' => 'The description of the dataset. The description can be 1 to 256 characters in length. Default value: empty.', 'type' => 'string', 'required' => false, 'example' => 'immtest'], ], [ - 'name' => 'DatasetName', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'title' => 'Dataset 名称', - 'description' => 'The name of the dataset.[](~~478160~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-dataset', - ], + 'schema' => ['title' => '', 'description' => 'The workflow template ID. For more information, see [Workflow templates and operators](~~466304~~). Default value: empty.', 'type' => 'string', 'required' => false, 'example' => 'Official:ImageManagement'], ], [ - 'name' => 'Query', + 'name' => 'DatasetMaxBindCount', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The query conditions.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/SimpleQuery', - ], + 'schema' => ['title' => '', 'description' => 'The maximum number of bindings per dataset. Valid values: 1 to 10. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], ], [ - 'name' => 'Sort', + 'name' => 'DatasetMaxFileCount', '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', - ], + 'schema' => ['title' => '', 'description' => 'The maximum number of files per dataset. Valid values: 1 to 100000000. Default value: 100000000.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000000'], ], [ - 'name' => 'Order', + 'name' => 'DatasetMaxEntityCount', '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', - ], + 'schema' => ['title' => '', 'description' => 'The maximum number of metadata entities per dataset. Default value: 10000000000.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000000000'], ], [ - 'name' => 'Aggregations', + 'name' => 'DatasetMaxRelationCount', '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, - ], + 'schema' => ['title' => '', 'description' => 'The maximum number of metadata relationships per dataset. Default value: 100000000000.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000000000'], ], [ - 'name' => 'WithFields', + 'name' => 'DatasetMaxTotalFileSize', '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, - ], + 'schema' => ['title' => '', 'description' => 'The maximum total file size per dataset, in bytes. After this limit is exceeded, no more indexes can be added. Default value: 90000000000000000.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '90000000000000000'], ], [ - 'name' => 'WithoutTotalHits', + 'name' => 'WorkflowParameters', 'in' => 'query', - 'allowEmptyValue' => true, + 'style' => 'json', 'schema' => [ - 'description' => 'Specifies whether to return the total number of hits. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', + 'description' => 'Invalid parameter.', + 'type' => 'array', + 'items' => ['description' => 'Invalid parameter.', '$ref' => '#/components/schemas/WorkflowParameter', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, + 'deprecated' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure returned.'."\n", + 'title' => '', + 'description' => 'The response struct.', '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', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '6D74B3A9-5AC0-49F9-914D-E01589D3****'], + 'Dataset' => ['description' => 'The dataset information.', '$ref' => '#/components/schemas/Dataset', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - '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', + 'title' => 'Create a dataset', + 'summary' => 'Creates a dataset.', + 'description' => '- **Before you use this operation, make sure that you fully understand the billing of Intelligent Media Management (IMM) and its [pricing](~~477042~~)**.'."\n" + .'- Dataset names must be unique within the same project.'."\n" + .'- The number of datasets that can be created is limited. You can call [GetProjcet](~~478155~~) to query this limit.'."\n" + .'- After you create a dataset, you can call [IndexFileMeta](~~478166~~) to create file metadata indexes for diversified [data retrieval, statistics](~~478175~~), and intelligent management.', + 'changeSet' => [ + ['createdAt' => '2025-06-12T08:03:49.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-06-15T02:14:12.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataset'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateDataset', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], ], + ], + 'CreateDecodeBlindWatermarkTask' => [ + 'summary' => 'Extracts a blind watermark.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10914,386 +5422,268 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '103885', - 'abilityTreeNodes' => [ - 'FEATUREimmDN11M0', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '200063', + 'abilityTreeNodes' => ['FEATUREimmSCVT08'], ], 'parameters' => [ [ - 'name' => 'NextToken', + 'name' => 'ProjectName', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '标记当前开始读取的位置，置空表示从头开始', - 'description' => 'This parameter is no longer available.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The project name. For information about how to obtain the project name, see [Create a project](~~478153~~).'."\n" + .'><notice>The project name must be the same as the one used to add the blind watermark with the [EncodeBlindWatermark](~~2743655~~) operation. Otherwise, the watermark cannot be extracted.></notice>', 'type' => 'string', 'required' => true, 'example' => 'immtest'], ], [ - 'name' => 'MaxResults', + 'name' => 'SourceURI', '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', - ], + 'schema' => ['description' => 'The Object Storage Service (OSS) URI of the image.'."\n" + ."\n" + .'The OSS URI must be in the `oss://<bucket>/<object>` format. `<bucket>` is the name of the OSS bucket that is in the same region as the current project. `<object>` is the full path of the file, including the file name extension.', 'type' => 'string', 'required' => true, 'example' => 'oss://target/sampleobject.jpg', 'title' => ''], ], [ - 'name' => 'ProjectName', + 'name' => 'StrengthLevel', 'in' => 'query', - 'schema' => [ - 'title' => '项目名称', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'immtest', - ], + 'schema' => ['description' => 'The watermark extraction level, which controls the extraction precision. A higher level indicates a longer processing time and a better extraction effect. Valid values:'."\n" + ."\n" + .'- low'."\n" + ."\n" + .'- medium'."\n" + ."\n" + .'- high', 'type' => 'string', 'required' => false, 'example' => 'low', 'title' => ''], ], [ - 'name' => 'DatasetName', + 'name' => 'WatermarkType', 'in' => 'query', 'schema' => [ - 'title' => 'Dataset 名称', - 'description' => 'The name of the dataset.'."\n", + 'description' => 'The type of the embedded watermark. Valid value: text'."\n" + ."\n" + .'(Image watermarks are not supported. Therefore, this parameter can only be set to text.)', + 'enumValueTitles' => ['text' => 'text'], 'type' => 'string', - 'required' => true, - 'example' => 'immDatatest', + 'required' => false, + 'example' => 'text', + 'title' => '', ], ], [ - 'name' => 'Query', + 'name' => 'TargetURI', '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', - ], + 'schema' => ['description' => 'A parameter from the earlier DecodeBlindWatermark API. It specifies the OSS URI where the image is saved after the blind watermark is parsed.'."\n" + ."\n" + .'The OSS URI must be in the `oss://<bucket>/<object>` format. `<bucket>` is the name of the OSS bucket that is in the same region as the current project. `<object>` is the full path of the file, including the file name extension.', 'type' => 'string', 'required' => false, 'example' => 'oss://target/targetobject.jpg', 'title' => ''], ], [ - 'name' => 'WithFields', + 'name' => 'ImageQuality', '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, - ], + 'schema' => ['description' => 'A parameter from the earlier DecodeBlindWatermark API. It specifies the quality of the output image. The default value is 90. The value must be in the range of 70 to 100.'."\n" + ."\n" + .'A higher quality results in a larger image size and better watermark parsing quality.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '90', 'title' => ''], ], [ - 'name' => 'MediaTypes', + 'name' => 'Model', 'in' => 'query', - 'style' => 'json', 'schema' => [ - 'description' => 'The types of the media that you want to query. Default value:'."\n" + 'description' => 'A parameter from the earlier DecodeBlindWatermark API. It specifies the watermark algorithm model. Valid values include FFT, FFT\\_FULL, DWT, and DWT\\_IBG. The default value is FFT.'."\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"]', - ], + .'If this parameter is left empty, the new version of the blind watermarking feature is used. Otherwise, the earlier version is used.', + 'enumValueTitles' => ['DWT' => 'DWT', 'FFT_FULL' => 'FFT\\_FULL', 'FFT' => 'FFT', 'DWT_IBG' => 'DWT\\_IBG'], + 'type' => 'string', 'required' => false, + 'example' => 'FFT', + 'title' => '', ], ], [ - 'name' => 'SourceURI', + 'name' => 'OriginalImageURI', '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', - ], + 'schema' => ['description' => 'A parameter from the earlier DecodeBlindWatermark API. It specifies the OSS URI of the image before the blind watermark was added.'."\n" + ."\n" + .'This parameter is not required when Model is set to DWT or DWT\\_IBG.'."\n" + ."\n" + .'The OSS URI must be in the `oss://<bucket>/<object>` format. `<bucket>` is the name of the OSS bucket that is in the same region as the current project. `<object>` is the full path of the file, including the file name extension.', 'type' => 'string', 'required' => false, 'example' => 'oss://imm-test/testcases/watermarktestbefore.jpg', 'title' => ''], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The notification configuration. For more information, click Notification. For the format of asynchronous notification messages, see [Asynchronous notification message format](~~2743997~~).', '$ref' => '#/components/schemas/Notification', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Response parameters', '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', - ], - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '4A7A2D0E-D8B8-4DA0-8127-EB32C6600ADE', 'title' => ''], + 'EventId' => ['description' => 'The event ID.', 'type' => 'string', 'example' => '27C-1jyAP5qQI7RoI8lFFwvMrWtl0ft', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'DecodeBlindWatermark-78ac8f3b-59e0-45a6-9b67-32168c3f22b9', 'title' => ''], ], + 'example' => '', ], ], ], - '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" + '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 use this API, make sure that you understand the billing methods and pricing of Intelligent Media Management (IMM).'."\n" + .' ><notice>Asynchronous tasks are not guaranteed to be completed within a specific time frame.></notice>'."\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" + .'- Make sure that a project is created in IMM. For more information, see [Create a project](~~478153~~).'."\n" ."\n" - .'### [](#)Usage methods'."\n" + .'- Make sure the service region and project are the same as those used to add the blind watermark using the [EncodeBlindWatermark](~~2743655~~) operation. Otherwise, the watermark cannot be extracted.'."\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" + .'- The watermark can be extracted even after the image undergoes attacks such as compression, scaling, clipping, and color changes.'."\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" + .'- This API is compatible with the previous version of the blind watermarking feature. Some parameters are from the previous DecodeBlindWatermark API.'."\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', + .'- This is an asynchronous API. After a task starts, its information is saved for only 7 days. After this period, the information can no longer be retrieved. Call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) API to retrieve the TaskId and view task information. Alternatively, set the [Notification](~~2743997~~) parameter to receive task information through asynchronous notification messages.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDecodeBlindWatermarkTask'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateDecodeBlindWatermarkTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + ], + 'CreateFacesSearchingTask' => [ + 'summary' => 'Searches a media set for the top N images most similar to a specified image or face ID. The operation returns the corresponding face IDs and bounding boxes, sorted by similarity in descending order.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '8960', - 'abilityTreeNodes' => [ - 'FEATUREimmDN11M0', - ], + 'abilityTreeCode' => '160409', + 'abilityTreeNodes' => ['FEATUREimmQ9NXNO'], ], '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', - ], + 'schema' => ['description' => 'The name of the project. For more information, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The name of the dataset. For more information, see [Create a dataset](~~478160~~).', 'type' => 'string', 'required' => true, 'example' => 'test-dataset', 'title' => ''], ], [ - 'name' => 'Query', + 'name' => 'UserData', 'in' => 'query', - 'schema' => [ - 'title' => '用于搜索的字符串', - 'description' => 'The query content. The value can be up to 1 MB in size.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['description' => 'Custom user information. This information is returned in the asynchronous notification message to help you associate the message with your system. The maximum length is 2048 bytes.', 'type' => 'string', 'required' => false, 'example' => '{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"}', 'title' => ''], ], [ - 'name' => 'Sort', + 'name' => 'Sources', 'in' => 'query', + 'style' => 'json', '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', + 'description' => 'A list of images.', + 'type' => 'array', + 'items' => [ + 'description' => 'An image object.', + 'type' => 'object', + 'properties' => [ + 'URI' => ['description' => 'The OSS URI of the image.'."\n" + ."\n" + .'The OSS URI must follow the format oss\\://${Bucket}/${Object}. `${Bucket}` is the name of the OSS bucket in the same region as the current project. `${Object}` is the full path of the file, including the file name extension.', 'type' => 'string', 'required' => false, 'example' => 'oss://test-bucket/test-object', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'Size,Filename', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Order', + 'name' => 'MaxResult', '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', - ], + 'schema' => ['description' => 'The number of most similar faces to return. Valid values: 0 to 100. Default value: 5.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], ], [ - 'name' => 'WithFields', + 'name' => 'Notification', '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, - ], + 'schema' => ['description' => 'The notification configuration. For more information about the format of asynchronous notification messages, see [Asynchronous notification message format](~~2743997~~).', '$ref' => '#/components/schemas/Notification', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response object.', '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', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B1E79399-05F7-06D8-95FE-EBE17BA*****'], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'CreateFacesSearchingTask-00bec802-073a-4b61-ba*****', 'title' => ''], + 'EventId' => ['description' => 'The event ID.', 'type' => 'string', 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16****', 'title' => ''], ], + 'example' => '', ], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B1E79399-05F7-06D8-95FE-EBE17BA*****\\",\\n \\"TaskId\\": \\"CreateFacesSearchingTask-00bec802-073a-4b61-ba*****\\",\\n \\"EventId\\": \\"0ED-1Bz8z71k5TtsUejT4UJ16****\\"\\n}","type":"json"}]', + 'title' => 'CreateFacesSearchingTask', + 'description' => '- **Before you use this operation, review the billing methods and [pricing](~~477042~~)**'."\n" + ."\n\n" + .' ><notice>'."\n" + ."\n" + .' The execution time of asynchronous tasks is not guaranteed.'."\n" + ."\n" + .' ></notice>'."\n" + ."\n" + .'- For each input image, only the face with the largest bounding box is used for the face search.'."\n" + ."\n" + .'- This is an asynchronous operation. After a task starts, the task information is retained for 7 days and cannot be retrieved after this period. To retrieve task information, you can call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation with the returned `TaskId`. Alternatively, you can configure the [Notification](~~2743997~~) parameter to receive asynchronous notifications that contain task information.', + 'changeSet' => [ + ['createdAt' => '2023-08-21T03:51:46.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-03T02:37:24.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-09T10:57:44.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFacesSearchingTask'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:CreateFacesSearchingTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + ], + ], + 'CreateFigureClusteringTask' => [ + 'summary' => 'Creates a figure clustering task. This task uses an intelligent algorithm to group the faces of different people in images that are indexed in a dataset.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11303,118 +5693,95 @@ 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '116906', - 'abilityTreeNodes' => [ - 'FEATUREimm3DNGQD', - ], + 'abilityTreeNodes' => ['FEATUREimm3DNGQD'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the project.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'immtest', - ], + 'schema' => ['description' => 'The project name. For more information, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'immtest', 'title' => ''], ], [ 'name' => 'DatasetName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the dataset.[](~~478160~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dataset001', - ], + 'schema' => ['description' => 'The dataset name. For more information, see [Create a dataset](~~478160~~).', 'type' => 'string', 'required' => true, 'example' => 'dataset001', 'title' => ''], ], [ '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"}', - ], + 'schema' => ['description' => 'Custom user data that is returned in the asynchronous notification message. You can use this data to associate the notification message with your services. The maximum length is 2048 bytes.', 'type' => 'string', 'required' => false, 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', 'title' => ''], ], [ '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"}', - ], + 'schema' => ['description' => 'Custom tags that you can use to search for and filter asynchronous tasks.', 'type' => 'object', 'required' => false, 'example' => '{"test": "val1"}', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The notification configuration. For more information, see Notification. For more information about the message format, see [Asynchronous notification message format](~~2743997~~).', '$ref' => '#/components/schemas/Notification', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The information about the face clustering task.'."\n", + 'description' => 'The information about the figure clustering task.', '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****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****'], + 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => 'formatconvert-00bec802-073a-4b61-ba3b-39bc****', 'title' => ''], + 'EventId' => ['description' => 'The ID of the event.', 'type' => 'string', 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16****', 'title' => ''], ], + 'example' => '', ], ], ], - '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":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\",\\n \\"TaskId\\": \\"formatconvert-00bec802-073a-4b61-ba3b-39bc****\\",\\n \\"EventId\\": \\"0ED-1Bz8z71k5TtsUejT4UJ16****\\"\\n}","type":"json"}]', 'title' => 'CreateFigureClusteringTask', - 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).****'."\n" + 'description' => '- **Before you call this operation, make sure that you fully understand the billing methods and [pricing](~~477042~~) of Intelligent Media Management.**'."\n" + .' ><notice>The completion time of asynchronous tasks is not guaranteed.></notice>'."\n" ."\n" - .' **'."\n" + .'- Before you call this operation, make sure that you have indexed files to a dataset ([CreateDataset](~~CreateDataset~~)) by attaching them ([CreateBinding](~~CreateBinding~~)) or by indexing them ([IndexFileMeta](~~IndexFileMeta~~) or [BatchIndexFileMeta](~~BatchIndexFileMeta~~)).'."\n" ."\n" - .' **Note** Asynchronous processing does not guarantee timely task completion.'."\n" + .'- Each time you call this operation, files in the dataset ([CreateDataset](~~CreateDataset~~)) are incrementally processed. You can periodically call this operation to process new files.'."\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" + .'- After the clustering is complete, you can call the [GetFigureCluster](~~GetFigureCluster~~) or [BatchGetFigureCluster](~~BatchGetFigureCluster~~) operation to retrieve information about specific groups. You can also call [QueryFigureClusters](~~QueryFigureClusters~~) to query and list the groups in the dataset.'."\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" + .'- Deleting files from a dataset changes the face clustering results. When all images that contain the faces in a cluster are deleted, the cluster is also deleted.'."\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', + .'- This is an asynchronous operation. After a task starts, its information is saved for only 7 days. You cannot retrieve the task information after this period. You can call the [GetTask](~~GetTask~~) or [ListTasks](~~ListTasks~~) operation to view the task information. Alternatively, you can set the [Notification](~~2743997~~) parameter to receive task information from asynchronous notification messages.', + 'changeSet' => [ + ['createdAt' => '2023-04-03T02:37:24.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-09T10:57:44.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-08-16T06:49:46.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-31T06:17:53.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFigureClusteringTask'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateFigureClusteringTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], ], + ], + 'CreateFigureClustersMergingTask' => [ + 'summary' => 'Merges two or more figure clustering groups into a single figure clustering group.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11424,857 +5791,1411 @@ 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '117038', - 'abilityTreeNodes' => [ - 'FEATUREimm3DNGQD', - ], + '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', - ], + 'schema' => ['description' => 'The name of the project. For more information, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'immtest', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The name of the dataset. For more information, see [Create a dataset](~~478160~~).', 'type' => 'string', 'required' => true, 'example' => 'dataset001', 'title' => ''], ], [ '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****', - ], + 'schema' => ['description' => 'The ID of the source clustering group. You must specify a value for either \\`From\\` or \\`Froms\\`. You cannot specify values for both parameters.', 'type' => 'string', 'required' => false, 'title' => '', '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****', - ], + 'schema' => ['description' => 'The ID of the destination clustering group.', 'type' => 'string', 'required' => true, 'title' => '', '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"}', - ], + 'schema' => ['description' => 'The custom information. This information is returned in the asynchronous notification message to help you associate the message with your system. The value can be up to 2,048 bytes in length.', 'type' => 'string', 'required' => false, 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', 'title' => ''], ], [ '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"}', - ], + 'schema' => ['description' => 'The custom tags. You can use custom tags to search for and filter asynchronous tasks.', 'type' => 'object', 'required' => false, 'example' => '{"key":"val"}', 'title' => ''], ], [ '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", + 'description' => 'A list of the IDs of the source clustering groups. You must specify a value for either \\`From\\` or \\`Froms\\`. You cannot specify values for both parameters. The list can contain up to 100 IDs.', '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", - ], + 'items' => ['description' => 'A single ID of a source clustering group.', 'type' => 'string', 'required' => false, 'example' => 'Cluster-2ab85905-23ba-4632-b2d8-1c21cfe****'."\n", 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ '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', - ], + 'schema' => ['description' => 'The configuration of the notification message. For more information, click Notification. For more information about the format of an asynchronous notification message, see [Asynchronous notification messages](~~2743997~~).', '$ref' => '#/components/schemas/Notification', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The returned data.'."\n", + 'description' => 'The response struct.', '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****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FF****'], + 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => '92376fbb-171f-4259-913f-705f7ee0****', 'title' => ''], + 'EventId' => ['description' => 'The ID of the event.', 'type' => 'string', 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16E****', 'title' => ''], ], + 'example' => '', ], ], ], - '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":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FF****\\",\\n \\"TaskId\\": \\"92376fbb-171f-4259-913f-705f7ee0****\\",\\n \\"EventId\\": \\"0ED-1Bz8z71k5TtsUejT4UJ16E****\\"\\n}","type":"json"}]', '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', + 'description' => '- **Before you call this operation, make sure that you understand the billing methods and [pricing](~~477042~~) of Intelligent Media Management.**'."\n" + ."\n" + .'- Before you call this operation, make sure that you have clustered all faces in the dataset by calling the [CreateFigureClusteringTask](~~478180~~) operation.'."\n" + ."\n" + .'- Merging unrelated groups affects the feature values of the destination group. This may cause inaccurate grouping of incremental data when you create a figure clustering task.'."\n" + ."\n" + .'- This operation is asynchronous. Task information is retained for only 7 days. During this period, you can query task information by calling the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation with the returned `TaskId`. You can also set the [Notification](~~2743997~~) parameter to receive asynchronous notification messages about the task.', + 'changeSet' => [ + ['createdAt' => '2023-04-03T02:37:23.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-09T10:57:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-16T06:44:23.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-16T06:44:23.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-31T06:17:53.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFigureClustersMergingTask'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateFigureClustersMergingTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], ], + ], + 'CreateFileCompressionTask' => [ + 'summary' => 'Package Download API', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '103841', - 'abilityTreeNodes' => [ - 'FEATUREimm3DNGQD', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '156182', + 'abilityTreeNodes' => ['FEATUREimmSETH07'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => 'The project name.[](~~CreateProject~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'immtest', - ], + 'schema' => ['description' => 'The name of the project. For more information, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'DatasetName', + 'name' => 'Sources', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The dataset name.[](~~CreateDataset~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dataset001', + 'description' => 'A list of files to package and their packaging rules.'."\n" + ."\n" + .'> Specify either this parameter or \\`SourceManifestURI\\`. \\`Sources\\` supports a maximum of 100 packaging rules.'."\n" + .'> ><warning>If you have more than 100 packaging rules, use the \\`SourceManifestURI\\` parameter.></warning>', + 'type' => 'array', + 'items' => [ + 'description' => 'The OSS address of a file to package and its packaging rule.', + 'type' => 'object', + 'properties' => [ + 'URI' => ['description' => 'The OSS address of the directory or file to package.'."\n" + ."\n" + .'The OSS address must be in the \\`oss\\://${Bucket}/${Object}\\` format. \\`${Bucket}\\` is the name of the OSS bucket that is in the same region as the current project. \\`${Object}\\` is described as follows:'."\n" + ."\n" + .'- To package a directory, \\`${Object}\\` is the directory name.'."\n" + ."\n" + .'- To package a file, \\`${Object}\\` is the full path of the file, including the file name extension.', 'type' => 'string', 'required' => false, 'example' => 'oss://test-bucket/test-object', 'title' => ''], + 'Alias' => ['description' => 'Specifies a new path or name for the source file within the output compressed file.'."\n" + ."\n" + .'- If you do not specify this parameter, the source directory structure is preserved. For example, if the source file is at `oss://test-bucket/test-dir/test-object.doc`, the path of the file in the compressed file is `/test-dir/test-object.doc`.'."\n" + ."\n" + .'- Rename the file. For example, if the source file is at `oss://test-bucket/test-object.jpg` and you set this parameter to `/test-rename-object.jpg`, the file in the compressed file is named `test-rename-object.jpg`.'."\n" + ."\n" + .'- Specify a new path for the source file in the compressed file. For example, if the source directory is `oss://test-bucket/test-dir/` and you set this parameter to `/new-dir/`, all files in the source directory are compressed into the `/new-dir/` path.'."\n" + ."\n" + .'- Set the value to `/` to remove the source directory structure. All files are placed directly in the root directory of the compressed file, and the original directory structure is not preserved.'."\n" + ."\n" + .'- Specify both a path and a file name. The file is renamed and moved to the specified path. For example, if you set this parameter to `/new-dir/alias.doc`, the file is renamed to `alias.doc` and placed in the `/new-dir/` path of the compressed file.'."\n" + ."\n" + .'> * Avoid creating files with duplicate names during the renaming process. If duplicate names exist, you may not be able to decompress the file in the compressed package. This depends on the decompression program you use.'."\n" + .'>'."\n" + .'> * Format requirement: The value must start with a forward slash (\\`/\\`), such as `/new-dir/alias.doc`.', 'type' => 'string', 'required' => false, 'example' => '/new-dir/', 'title' => ''], + 'Mode' => [ + 'description' => 'The pattern matching mode for the packaging rule. Valid values include `prefix` (prefix matching) and `fullname` (exact matching). The default value is `prefix`.'."\n" + ."\n" + .'- `prefix`: In this mode, all files that match the prefix are packaged.'."\n" + ."\n" + .'- `fullname`: In this mode, only the file that exactly matches the rule is packaged.', + 'enumValueTitles' => ['prefix' => 'prefix', 'fullname' => 'fullname'], + 'type' => 'string', + 'required' => false, + 'example' => 'fullname', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ObjectId', + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => '**If you do not have special requirements, leave this parameter empty.**'."\n" + ."\n" + .'The chained authorization configuration. This parameter is not required. For more information, see [Use chained authorization to access resources of other entities](~~465340~~).', '$ref' => '#/components/schemas/CredentialConfig', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'SourceManifestURI', + 'in' => 'query', + 'schema' => ['description' => 'The address where the file manifest is stored. The file manifest stores the \\`Sources\\` structure in JSON format on OSS. This is suitable for scenarios with many files to package.'."\n" + ."\n" + .'> Specify either this parameter or `Sources`. In the manifest file, the `URI` parameter is required and the `Alias` parameter is optional. \\`SourceManifestURI\\` supports up to 80,000 packaging rules.'."\n" + .'> ><warning>When you save the content to OSS, specify the OSS address of the file for this parameter.></warning>'."\n" + ."\n" + .'The following is an example of the file structure:'."\n" + ."\n" + .'```'."\n" + .'[{"URI":"oss://<bucket>/<object>", "Alias":"/new-dir/new-name"}]'."\n" + .'```', 'type' => 'string', 'required' => false, 'example' => 'oss://test-bucket/test-object.json', 'title' => ''], + ], + [ + 'name' => 'TargetURI', + 'in' => 'query', + 'schema' => ['description' => 'The OSS address of the output file. The compressed file is named after the file name in this path, such as `name.zip`.'."\n" + ."\n" + .'The OSS address must be in the \\`oss\\://${Bucket}/${Object}\\` format. \\`${Bucket}\\` is the name of the OSS bucket that is in the same region as the current project. \\`${Object}\\` is the full path of the file, including the file name extension.', 'type' => 'string', 'required' => true, 'example' => 'oss://test-bucket/test-target-object.zip', 'title' => ''], + ], + [ + 'name' => 'CompressedFormat', '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", + 'description' => 'The compression format for file packaging.'."\n" + ."\n" + .'> Currently, only the zip format is supported.', + 'enumValueTitles' => [], 'type' => 'string', - 'required' => true, - 'example' => 'Cluster-1f2e1a2c-d5ee-4bc5-84f6-fef94ea****', + 'required' => false, + 'example' => 'zip', + 'title' => '', ], ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => ['description' => 'Custom user data. This data is returned in the asynchronous notification message, which helps you associate the notification with your internal system. The maximum length is 2,048 bytes.', 'type' => 'string', 'required' => false, 'example' => 'test-data', 'title' => ''], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The message notification configuration. For more information, see the Notification data type. For the format of asynchronous notification messages, see [Asynchronous notification message format](~~2743997~~).'."\n" + ."\n" + .'> IMM API callbacks do not currently support specifying a webhook address. Use MNS instead.', '$ref' => '#/components/schemas/Notification', 'required' => false, 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response structure.', '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', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'EC564A9A-BA5C-4499-A087-D9B9E76E*****'], + 'EventId' => ['description' => 'The event ID.', 'type' => 'string', 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16Es*****', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'FileCompression-3579a380-6f7a-4a9d-b9d2-65996*****', 'title' => ''], ], + 'example' => '', ], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EC564A9A-BA5C-4499-A087-D9B9E76E*****\\",\\n \\"EventId\\": \\"0ED-1Bz8z71k5TtsUejT4UJ16Es*****\\",\\n \\"TaskId\\": \\"FileCompression-3579a380-6f7a-4a9d-b9d2-65996*****\\"\\n}","type":"json"}]', + 'title' => 'CreateFileCompressionTask', + 'description' => '> This API is in public preview. If you have any questions, join our DingTalk group to provide feedback. For the group number, see [Contact us](~~84454~~).'."\n" + ."\n" + .'> This API currently supports packaging but not compression. The compression feature will be added later.'."\n" + ."\n" + .'- **Before using this API, make sure you understand the billing methods and [pricing](~~477042~~) of Intelligent Media Management (IMM)**.'."\n" + .' ><notice>The completion time of asynchronous tasks is not guaranteed.></notice>'."\n" + ."\n" + .'- File count limit: You can package up to 80,000 files.'."\n" + ."\n" + .'- File size limit: The total size of all files before packaging must not exceed 200 GB.'."\n" + ."\n" + .'- This feature supports files of the Standard storage class on OSS. To package files of other storage classes, first [convert their storage class](~~90090~~).'."\n" + ."\n" + .'- This is an asynchronous API. After a task starts, its information is stored for 7 days. After 7 days, the information can no longer be retrieved. To view task information, call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation with the returned `TaskId`. You can also set the [Notification](~~2743997~~) parameter to receive task information through asynchronous notification messages.', + 'requestParamsDescription' => '#### Examples of packaging rules for typical scenarios'."\n" + ."\n" + .'The following examples show how to configure packaging rules for typical scenarios based on the sample file structure:'."\n" + ."\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" + ."\n" + .'##### Package a specified directory'."\n" + ."\n" + .'To package all files in the `test-dir1` directory into a specified directory named `test-dir`, use the following packaging rule:'."\n" + ."\n" + .'```json'."\n" + .'['."\n" + .' {'."\n" + .' "URI" : "oss://bucket/test-dir1/",'."\n" + .' "Alias" : "/test-dir/"'."\n" + .' }'."\n" + .']'."\n" + .'```'."\n" + ."\n" + .'The structure of the generated compressed file is as follows:'."\n" + ."\n" + .'```'."\n" + .'.'."\n" + .'└── test-dir'."\n" + .' ├── file1.txt'."\n" + .' ├── file2.doc'."\n" + .' ├── file3.png'."\n" + .' └── my-file.json'."\n" + .'```'."\n" + ."\n" + .'##### Package files with a specified prefix'."\n" + ."\n" + .'To package all files with the prefix `test-dir1/file` into a specified directory named `test-dir`, use the following packaging rule:'."\n" + ."\n" + .'```json'."\n" + .'['."\n" + .' {'."\n" + .' "URI" : "oss://bucket/test-dir1/file",'."\n" + .' "Alias" : "/test-dir/"'."\n" + .' }'."\n" + .']'."\n" + .'```'."\n" + ."\n" + .'The structure of the generated compressed file is as follows:'."\n" + ."\n" + .'```'."\n" + .'.'."\n" + .'└── test-dir'."\n" + .' ├── file1.txt'."\n" + .' ├── file2.doc'."\n" + .' └── file3.png'."\n" + .'```'."\n" + ."\n" + .'Note that if you use the prefix mode for packaging and the prefix matches both a file and a folder, both the file and the folder are packaged into the compressed file. For example:'."\n" + ."\n" + .'```json'."\n" + .'['."\n" + .' {'."\n" + .' "URI" : "oss://bucket/test-dir2/AAA",'."\n" + .' "Alias" : "/AAA/"'."\n" + .' }'."\n" + .']'."\n" + .'```'."\n" + ."\n" + .'The structure of the generated compressed file is as follows:'."\n" + ."\n" + .'```'."\n" + .'.'."\n" + .'└── AAA'."\n" + .' ├── AAA'."\n" + .' └── file.txt'."\n" + .'```'."\n" + ."\n" + .'##### Package specified files'."\n" + ."\n" + .'If you do not want to use the prefix mode, set the `mode` parameter to package only specified files:'."\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 structure of the generated compressed file is as follows:'."\n" + ."\n" + .'```'."\n" + .'.'."\n" + .'├── AAA'."\n" + .'└── test-dir1'."\n" + .'```', + 'changeSet' => [ + ['createdAt' => '2023-11-20T06:17:47.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-12T08:01:23.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-03T02:37:23.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-09T10:57:44.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-10-28T04:03:43.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFileCompressionTask'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateFileCompressionTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + ], + 'CreateFileUncompressionTask' => [ + 'summary' => 'A file decompression task lets you decompress specific files or an entire compressed package to a specified location. Supported formats include Zip, RAR, and 7z.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '117066', - 'abilityTreeNodes' => [ - 'FEATUREimm3DNGQD', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '157566', + 'abilityTreeNodes' => ['FEATUREimm2Z44LQ'], ], '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', - ], + 'schema' => ['description' => 'The name of the project. For more information, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => ' test-project', 'title' => ''], ], [ - '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', + 'name' => 'CredentialConfig', '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', - ], + 'style' => 'json', + 'schema' => ['description' => '**Leave this parameter empty unless you have specific requirements.**'."\n" + ."\n" + .'The chained authorization configuration. This parameter is optional. For more information, see [Use chained authorization to access other entity resources](~~465340~~).', '$ref' => '#/components/schemas/CredentialConfig', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'CustomLabels', + 'name' => 'Password', 'in' => 'query', - 'schema' => [ - 'description' => 'The custom labels, which can be used as query conditions.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key=value', - ], + 'schema' => ['description' => 'The password for the encrypted compressed package.', 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'UserData', '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', - ], + 'schema' => ['description' => 'Custom user information. It is returned in the asynchronous notification message to help you associate the notification with your system. The maximum length is 2,048 bytes.', 'type' => 'string', 'required' => false, 'example' => 'test-data', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'SelectedFiles', 'in' => 'query', + 'style' => 'json', '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', + 'description' => 'The list of files to decompress. If this parameter is empty, the entire compressed package is decompressed. The default value is empty.', + 'type' => 'array', + 'items' => ['description' => 'The name of the file to decompress. This is the path relative to the root directory of the compressed package.', 'type' => 'string', 'required' => false, 'example' => 'test-dir/test.jpg', 'title' => ''], 'required' => false, - 'example' => '10', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'CreateTimeRange', + 'name' => 'SourceURI', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The time range within which the face group was created.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/TimeRange', - ], + 'schema' => ['description' => 'The Object Storage Service (OSS) address where the compressed file is stored.'."\n" + ."\n" + .'The OSS address must be in the \\`oss\\://${Bucket}/${Object}\\` format. \\`${Bucket}\\` is the name of the OSS bucket in the same region as the current project. \\`${Object}\\` is the full path of the file, including the file name extension.', 'type' => 'string', 'required' => true, 'example' => 'oss://test-bucket/test-object.zip', 'title' => ''], ], [ - 'name' => 'UpdateTimeRange', + 'name' => 'Notification', 'in' => 'query', 'style' => 'json', - 'schema' => [ - 'description' => 'The time range within which the face group was last updated.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/TimeRange', - ], + 'schema' => ['description' => 'The message notification configuration. For details, click Notification. For the format of asynchronous notification messages, see [Asynchronous notification message format](~~2743997~~).'."\n" + ."\n" + .'> Intelligent Media Management API callbacks do not support custom webhook addresses. Use MNS instead.', 'required' => false, '$ref' => '#/components/schemas/Notification', 'title' => '', 'example' => ''], ], [ - 'name' => 'WithTotalCount', + 'name' => 'TargetURI', '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', - ], + 'schema' => ['description' => 'The destination OSS address for the decompressed files. The selected files or the entire compressed package are decompressed to this address.'."\n" + ."\n" + .'The OSS address must be in the \\`oss\\://${Bucket}/${Object}\\` format. \\`${Bucket}\\` is the name of the OSS bucket in the same region as the current project. \\`${Object}\\` is the full path of the file, including the file name extension.', 'type' => 'string', 'required' => false, 'example' => 'oss://test-bucket/test-dir/', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Response struct', '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', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'EC564A9A-BA5C-4499-A087-D9B9E76E*****'], + 'EventId' => ['description' => 'The event ID.', 'type' => 'string', 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16Es*****', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'FileUncompression-16ab5dd6-af02-480e-9ed7-a8d51b1*****', 'title' => ''], ], + 'example' => '', ], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EC564A9A-BA5C-4499-A087-D9B9E76E*****\\",\\n \\"EventId\\": \\"0ED-1Bz8z71k5TtsUejT4UJ16Es*****\\",\\n \\"TaskId\\": \\"FileUncompression-16ab5dd6-af02-480e-9ed7-a8d51b1*****\\"\\n}","type":"json"}]', + 'title' => 'CreateFileUncompressionTask', + 'description' => '> This API is in public preview. If you have any questions, join our DingTalk group to provide feedback. For the group number, see [Contact us](~~84454~~).'."\n" + ."\n" + .'- **Before you use this API, review the billing methods and [pricing](~~477042~~) for Intelligent Media Management.**'."\n" + .' ><notice>Timeliness is not guaranteed for asynchronous tasks.></notice>'."\n" + ."\n" + .'- File count limit: A compressed package can contain a maximum of 80,000 files.'."\n" + ."\n" + .'- File size limit: 200 GB for Zip and RAR formats, and 50 GB for 7z format.'."\n" + ."\n" + .'- File decompression tasks use stream decompression, which outputs files as they are decompressed. If an operation is aborted due to file corruption, the files that have already been decompressed are not deleted.'."\n" + ."\n" + .'- This is an asynchronous API. Task information is stored for only 7 days and cannot be retrieved after this period. To view the task information, you can call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation with the returned `TaskId`. Alternatively, you can set the [Notification](~~2743997~~) parameter to receive task information through an asynchronous notification message.', + 'requestParamsDescription' => 'To obtain detailed decompression information when you create a decompression task, set the \\`ExtendedMessageURI\\` parameter in \\`Notification\\`. The file contains information in the following structure:'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "Password" : "The password of the compressed package",'."\n" + .' "IsEncryption": "true/false, specifies whether the compressed package is encrypted",'."\n" + .' "ArchiveFiles": ['."\n" + .' {'."\n" + .' "URI": "The address of the decompressed file. Example: oss://test-bucket/test-dir/test.txt",'."\n" + .' "PathName": "The path of the file relative to the compressed package. Example: ./test.txt",'."\n" + .' "Reason": "If the preview fails, this parameter indicates the reason for the failure.",'."\n" + .' "IsFolder": "true/false, specifies whether the file is a folder",'."\n" + .' "PackedSize": "The size of the file in the compressed package",'."\n" + .' "UnPackedSize": "The size of the file after decompression",'."\n" + .' "FileAccessTime": "File time information",'."\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" + .'```', + 'changeSet' => [ + ['createdAt' => '2023-08-30T07:22:03.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-03T02:37:23.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-09T10:57:44.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFileUncompressionTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateFileUncompressionTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + ], + 'CreateHighlightTask' => [ + 'summary' => 'Creates a video highlight task. This feature is in invitational preview.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '166908', - 'abilityTreeNodes' => [ - 'FEATUREimm3DNGQD', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREimmCUOMK0'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'title' => '', 'required' => true, 'example' => 'immtest'], + ], + [ + 'name' => 'Sources', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The list of media resources to process.'."\n" + .'A maximum of 10 videos are supported.', + 'type' => 'array', + 'items' => [ + 'description' => 'The media resource to process.', + 'type' => 'object', + 'properties' => [ + 'URI' => ['description' => 'The URI of the media resource (OSS URI). Only videos are supported.', 'type' => 'string', 'title' => '', 'required' => true, 'example' => 'oss://test-bucket/test-object'], + 'StartTime' => ['description' => 'The start time of the media resource. Valid values: [0, video duration]. Unit: seconds.'."\n" + .'This parameter takes effect only when Type is set to Concat.', 'type' => 'number', 'title' => '', 'format' => 'double', 'required' => false, 'example' => '0'], + 'Duration' => ['description' => 'The duration of the media segment. Unit: seconds. Default value: 0, which indicates the end of the video.'."\n" + .'This parameter takes effect only when Type is set to Concat.', 'type' => 'number', 'title' => '', 'format' => 'double', 'required' => false, 'example' => '0'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => 'test-project', + 'example' => '', ], ], [ - 'name' => 'DatasetName', - 'in' => 'query', + 'name' => 'Mode', + 'in' => 'formData', + 'schema' => ['description' => 'The highlight recognition mode. Valid values:'."\n" + ."\n" + .'- Scene: scene and frame recognition.'."\n" + ."\n" + .'- Average (default): average slice recognition.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Average'], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => ['description' => 'The processing type. Valid values:'."\n" + ."\n" + .'- Retrieval: highlight extraction.'."\n" + ."\n" + .'- Concat: video composition.'."\n" + ."\n" + .'- Compose: one-click video production.', 'type' => 'string', 'title' => '', 'required' => true, 'example' => 'Retrieval'], + ], + [ + 'name' => 'Highlight', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the dataset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-dataset', + 'title' => '', + 'description' => 'The highlight configuration.', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => 'The highlight content. Valid values:'."\n" + ."\n" + .'- 宠物'."\n" + ."\n" + .'- 人物'."\n" + ."\n" + .'- 运动'."\n" + ."\n" + .'- 会议'."\n" + ."\n" + .'The value cannot exceed 100 characters.', 'type' => 'string', 'title' => '', 'required' => true, 'example' => 'character'], + ], + 'required' => false, + 'example' => '', ], ], [ - 'name' => 'ObjectIds', - 'in' => 'query', + 'name' => 'Edit', + 'in' => 'formData', '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****', + 'title' => '', + 'description' => 'The editing configuration.', + 'type' => 'object', + 'properties' => [ + 'Mode' => ['description' => 'The editing mode. Valid values:'."\n" + ."\n" + .'- Sequential: sequential mode.', 'type' => 'string', 'title' => '', 'required' => true, 'example' => 'Sequential'], + 'BackgroundMusicMode' => ['description' => 'The background music mode. Default value: Closed. Valid values:'."\n" + ."\n" + .'- Random: custom background music, randomly selected based on weight.'."\n" + ."\n" + .'- Sequential: custom background music, applied in order.'."\n" + ."\n" + .'- Closed: no background music.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Closed'], + 'BackgroundMusics' => [ + 'title' => '', + 'description' => 'The background music list. This parameter takes effect only when BackgroundMusicMode is set to Random or Sequential.'."\n" + .'**The maximum number is 1.**', + 'type' => 'array', + 'items' => [ + 'description' => 'The background music.', + 'type' => 'object', + 'properties' => [ + 'URI' => ['description' => 'The URI of the background music (OSS URI). Only audio files are supported.', 'type' => 'string', 'title' => '', 'required' => true, 'example' => 'oss://test-bucket/test-object/test.mp3'], + 'Volume' => ['description' => 'The volume intensity of the background music. Valid values: [0, 10]. Default value: 0.2. A value of 1 indicates the original volume.', 'type' => 'number', 'title' => '', 'format' => 'double', 'required' => false, 'example' => '0.2'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'TransitionMode' => ['description' => 'The transition mode. Default value: Closed. Valid values:'."\n" + ."\n" + .'- Auto: automatic transition.'."\n" + ."\n" + .'- Random: custom transition, randomly selected based on weight.'."\n" + ."\n" + .'- Sequential: custom transition, applied in order.'."\n" + ."\n" + .'- Closed: no transition.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Closed'], + 'Transitions' => [ + 'title' => '', + 'description' => 'The transition effects.'."\n" + .'This parameter takes effect only when TransitionMode is set to Random or Sequential.'."\n" + .'A maximum of 10 transitions are supported.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Transition' => ['description' => 'The transition effect. For more information, see [Transition effects](https://www.alibabacloud.com/help/en/imm/developer-reference/transition-effect).', 'type' => 'string', 'title' => '', 'required' => true, 'example' => 'fade'], + 'Duration' => ['description' => 'The transition duration. Unit: seconds. If the transition duration is greater than the segment duration minus 1, the transition effect on that segment does not take effect.'."\n" + .'Valid values: [0, 5].', 'type' => 'number', 'title' => '', 'format' => 'double', 'required' => false, 'example' => '0'], + 'Weight' => ['description' => 'The transition weight. Valid values: [1, 100]. Default value: 50.'."\n" + .'This parameter takes effect only when TransitionMode is set to Random.', 'type' => 'integer', 'title' => '', 'format' => 'int64', 'required' => false, 'example' => '50'], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'VfxEffectMode' => ['description' => 'The effect mode. Default value: Closed. Valid values:'."\n" + ."\n" + .'- Auto: automatic effect.'."\n" + ."\n" + .'- Random: custom effect, randomly selected based on weight.'."\n" + ."\n" + .'- Sequential: custom effect, applied in order.'."\n" + ."\n" + .'- Closed: no effect.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Closed'], + 'VfxEffects' => [ + 'title' => '', + 'description' => 'The visual effects. This parameter takes effect only when VfxEffectMode is set to Random or Sequential.'."\n" + .'A maximum of 10 effects are supported.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VfxEffect' => ['description' => 'The visual effect. For more information, see [Effects](https://www.alibabacloud.com/help/en/imm/developer-reference/effects).', 'type' => 'string', 'title' => '', 'required' => true, 'example' => 'letterboxed'], + 'Weight' => ['description' => 'The effect weight. Valid values: [1, 100]. Default value: 50.'."\n" + .'This parameter takes effect only when VfxEffectMode is set to Random.', 'type' => 'integer', 'title' => '', 'format' => 'int64', 'required' => false, 'example' => '50'], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Output', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The output configuration.', + 'type' => 'object', + 'properties' => [ + 'URI' => ['description' => 'The URI of the output file.', 'type' => 'string', 'title' => '', 'required' => true, 'example' => 'oss://test-bucket/test-target-object.mp4'], + 'Container' => ['description' => 'The media container type. This parameter is required when Type is set to Concat or Compose. Valid values:'."\n" + ."\n" + .'- Audio and video containers: mp4, mkv, mov, asf, avi, mxf, ts, flv.'."\n" + ."\n" + .'><notice>Container and URI must be specified together.></notice>', 'type' => 'string', 'required' => false, 'example' => 'mp4', 'title' => ''], + 'Speed' => ['description' => 'The playback speed of the media. Valid values: [0.5, 1.0]. Default value: 1.0.'."\n" + ."\n" + .'> This value is the ratio of the playback speed of the transcoded media file to the default playback speed of the source media file. This is not speed-adjusted transcoding.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1.0', 'title' => ''], + 'Segment' => [ + 'description' => 'The media segmentation settings. By default, no segmentation is performed.', + 'type' => 'object', + 'properties' => [ + 'Format' => ['description' => 'The media segmentation format. Valid values:'."\n" + ."\n" + .'- hls'."\n" + ."\n" + .'- dash', 'type' => 'string', 'required' => false, 'example' => 'hls', 'title' => ''], + 'Duration' => ['description' => 'The segment length. Unit: seconds.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1', 'title' => ''], + 'StartNumber' => ['description' => 'The start number. Only hls is supported. Default value: 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Video' => ['description' => 'The video processing parameter settings.'."\n" + .'><notice>If Video is empty, the first video stream (if any) is directly copied to the output file.></notice>', '$ref' => '#/components/schemas/TargetVideo', 'required' => false, 'title' => '', 'example' => ''], + 'Audio' => ['description' => 'The audio processing parameter settings.'."\n" + .'><notice>If Audio is empty, the first audio stream (if any) is directly copied to the output file.></notice>', '$ref' => '#/components/schemas/TargetAudio', 'required' => false, 'title' => '', 'example' => ''], + 'MaxDuration' => ['description' => 'The maximum duration of the clipped video. Unit: seconds.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '10.0', 'title' => ''], ], 'required' => true, + 'example' => '', ], ], + [ + 'name' => 'UserData', + 'in' => 'formData', + 'schema' => ['description' => 'The custom information, which is returned in asynchronous message notifications.', 'type' => 'string', 'required' => false, 'example' => '{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"}', 'title' => ''], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['description' => 'The custom tags used to search for and filter asynchronous tasks.', 'type' => 'object', 'required' => false, 'example' => '{"test":"val1"}', 'title' => ''], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['description' => 'The China authorization configuration. **Leave this parameter empty unless you have specific requirements.**', '$ref' => '#/components/schemas/CredentialConfig', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Notification', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['description' => 'The message notification configuration. For more information, click Notification. For the format of asynchronous notification messages, see [Asynchronous notification message format](https://www.alibabacloud.com/help/en/imm/developer-reference/asynchronous-notification-message-examples).', '$ref' => '#/components/schemas/Notification', 'required' => false, 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', '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', - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6'], + 'EventId' => ['description' => 'The event ID.', 'type' => 'string', 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16Es****', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'Highlight-4d51241b-04d4-4343-aa25-****', 'title' => ''], ], + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'asynchronous', 'callback' => 'imm::2020-09-30::GetTask', 'callbackInterval' => 1000, 'maxCallbackTimes' => 60], + 'title' => 'Create a video highlight clipping task', + 'description' => '- **Before you use this operation, make sure that you fully understand the billing of Intelligent Media Management (IMM).** For more information, see [Billing overview](https://www.alibabacloud.com/help/en/imm/product-overview/billing-overview). This operation incurs fees for highlight extraction and media processing.'."\n" + ."\n" + .'- Before you call this operation, make sure that a project already exists in the current region. For more information, see [Project management](https://www.alibabacloud.com/help/en/imm/developer-reference/api-imm-2020-09-30-createproject).'."\n" + .'><notice>Asynchronous tasks do not guarantee timeliness.></notice>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateHighlightTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6\\",\\n \\"EventId\\": \\"0ED-1Bz8z71k5TtsUejT4UJ16Es****\\",\\n \\"TaskId\\": \\"Highlight-4d51241b-04d4-4343-aa25-****\\"\\n}","type":"json"}]', + ], + 'CreateImageModerationTask' => [ + 'summary' => 'Detects non-compliant content in images, such as pornography, terrorism, undesirable scenes, logos, and text-in-image violations.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '103839', - 'abilityTreeNodes' => [ - 'FEATUREimm3DNGQD', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '130695', + 'abilityTreeNodes' => ['FEATUREimmRIZXZT'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the project.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['description' => 'The project name. For more information about how to obtain the project name, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test-project'], ], [ - 'name' => 'DatasetName', + 'name' => 'UserData', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the dataset.[](~~478160~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-dataset', - ], + 'schema' => ['description' => 'The custom information. This information is returned in the asynchronous notification message to help you associate the message with your system. The value can be up to 2,048 bytes long.', 'type' => 'string', 'required' => false, 'example' => 'test-data', 'title' => ''], ], [ - 'name' => 'FigureCluster', + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => ['description' => 'The OSS URI of the image.'."\n" + ."\n" + .'The URI must follow the `oss://<Bucket>/<Object>` format. `<Bucket>` is the name of the OSS bucket that is in the same region as the project. `<Object>` is the full path of the file, including the file name extension.', 'type' => 'string', 'required' => true, 'example' => 'oss://test-bucket/test-object', 'title' => ''], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The custom tags. You can use tags to search for and filter asynchronous tasks.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "User": "Jane"'."\n" + .'}', 'title' => ''], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The chained authorization configuration. This parameter is optional. For more information, see [Use chained authorization to access resources of other entities](~~465340~~).', '$ref' => '#/components/schemas/CredentialConfig', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Scenes', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The information about the cluster.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/FigureClusterForReq', + 'description' => 'The image detection scenarios.', + 'type' => 'array', + 'items' => [ + 'description' => 'The image detection scenario. Valid values:'."\n" + ."\n" + .'- porn: pornography detection.'."\n" + ."\n" + .'- terrorism: terrorism and political content detection.'."\n" + ."\n" + .'- live: undesirable scene detection.'."\n" + ."\n" + .'- logo: logo detection.'."\n" + ."\n" + .'- ad: text and image violation detection.'."\n" + ."\n" + .'> If you do not specify a detection scenario, the `porn`, `terrorism`, and `ad` scenarios are used by default.', + 'enumValueTitles' => ['ad' => 'Ad violations', 'terrorism' => 'Terrorism and political content', 'logo' => 'Logo detection', 'live' => 'Inappropriate scenes', 'porn' => 'Pornography detection'], + 'type' => 'string', + 'required' => false, + 'example' => 'porn', + 'title' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => ['description' => 'The frame capture frequency. This parameter is used for GIF and long image detection. The default value is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'MaxFrames', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of frames to capture. This parameter is used for GIF and long image detection. The default value is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The notification configuration. For more information about the format of asynchronous notification messages, see [Asynchronous notification message format](~~2743997~~).', '$ref' => '#/components/schemas/Notification', 'required' => false, 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5F74C5C9-5AC0-49F9-914D-E01589D3****', - ], + 'RequestId' => ['title' => 'RequestId', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****'], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'ImageModeration-179ef4f8-d583-4f0c-a293-7c0889c*****', 'title' => ''], + 'EventId' => ['description' => 'The event ID.', 'type' => 'string', 'example' => '2E6-1I0FGn0zFnl5AflRfhzClma*****', 'title' => ''], ], + 'example' => '', ], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\",\\n \\"TaskId\\": \\"ImageModeration-179ef4f8-d583-4f0c-a293-7c0889c*****\\",\\n \\"EventId\\": \\"2E6-1I0FGn0zFnl5AflRfhzClma*****\\"\\n}","type":"json"}]', + 'title' => 'CreateImageModerationTask', + 'description' => '- **Before you use this operation, make sure that you understand the billing methods and [pricing](~~477042~~) of Intelligent Media Management.**'."\n" + ."\n\n" + .' ><notice>'."\n" + ."\n" + .' The execution time of asynchronous tasks is not guaranteed.'."\n" + ."\n" + .' ></notice>'."\n" + ."\n" + .'- Image requirements:'."\n" + ."\n" + .' - Image URLs support the HTTP and HTTPS protocols.'."\n" + ."\n" + .' - The following image formats are supported: PNG, JPG, JPEG, BMP, GIF, and WEBP.'."\n" + ."\n" + .' - The image size cannot exceed 20 MB for both synchronous and asynchronous invocations. The height or width cannot exceed 30,000 pixels, and the total number of pixels cannot exceed 250 million. For GIF images, the total number of pixels cannot exceed 4,194,304, and the height or width cannot exceed 30,000 pixels.'."\n" + ."\n" + .' - The image download timeout period is 3 seconds. If the download takes longer than 3 seconds, a timeout error is returned.'."\n" + ."\n" + .' - For best results, the image resolution should be at least 256 × 256 pixels. Low resolution may affect detection accuracy.'."\n" + ."\n" + .' - The response time for image detection depends on the image download time. Ensure the storage service where the image is stored is stable and reliable. Use Alibaba Cloud Object Storage Service (OSS) or CDN.'."\n" + ."\n" + .'- This is an asynchronous operation. After a task starts, its information is saved for only 7 days. You cannot query the information after this period. To view task information, you can call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation and use the returned `TaskId`. Alternatively, you can set the [Notification](~~2743997~~) parameter to receive task information through asynchronous notification messages.'."\n" + ."\n" + .'> The detection results are returned in an asynchronous notification message. The Suggestion field in the message has one of the following values:'."\n" + .'>'."\n" + .'> - pass: The image passed the review. No non-compliant content was detected.'."\n" + .'>'."\n" + .'> - block: The image failed the review. Non-compliant content was detected. The Categories field indicates the non-compliant category. For more information about the categories, see Content Moderation detection results.'."\n" + .'>'."\n" + .'> - review: The image requires manual review. After the manual review is complete, another asynchronous notification message is sent to inform you of the result.', + 'changeSet' => [ + ['createdAt' => '2024-04-19T09:43:54.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-08-21T03:51:45.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-03T02:37:23.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-09T10:57:44.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-08-16T06:44:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-16T06:44:22.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateImageModerationTask'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateImageModerationTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + ], + 'CreateImageSplicingTask' => [ + 'summary' => 'Stitches multiple images into a single image based on specified rules and saves the output to a specified OSS object.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'chargeType' => 'free', - 'abilityTreeCode' => '160046', - 'abilityTreeNodes' => [ - 'FEATUREimm3DNGQD', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '144838', + 'abilityTreeNodes' => ['FEATUREimm4NW8UR'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the project.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The project name. For more information about how to obtain the project name, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ - 'name' => 'DatasetName', + 'name' => 'Sources', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the dataset.[](~~478160~~)'."\n", - 'type' => 'string', + 'description' => 'The list of input images. The images are stitched in the order of their URIs in the list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about an input image.', + 'type' => 'object', + 'properties' => [ + 'URI' => ['description' => 'The OSS URI of the source image.'."\n" + ."\n" + .'The URI must be in the oss\\://${Bucket}/${Object} format. `${Bucket}` is the name of the OSS bucket that is in the same region as the project. `${Object}` is the full path of the file, including the file name extension.'."\n" + ."\n" + .'Supported image formats: JPG and PNG.', 'type' => 'string', 'required' => true, 'example' => 'oss://examplebucket/sampleobject.jpg', 'title' => ''], + 'Rotate' => ['description' => 'The rotation angle of the image. Valid values:'."\n" + ."\n" + .'- 0 (default)'."\n" + ."\n" + .'- 90'."\n" + ."\n" + .'- 180'."\n" + ."\n" + .'- 270', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '90', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => 'test-dataset', + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'SourceURI', + 'name' => 'TargetURI', + 'in' => 'query', + 'schema' => ['description' => 'The OSS URI where the output image is stored.'."\n" + ."\n" + .'The URI must be in the oss\\://${bucketname}/${objectname} format. ${bucketname} is the name of the OSS bucket that is in the same region as the project. ${objectname} is the path of the file, including the file name.', 'type' => 'string', 'required' => true, 'example' => 'oss://examplebucket/outputImage.jpg', 'title' => ''], + ], + [ + 'name' => 'ImageFormat', 'in' => 'query', 'schema' => [ - 'description' => 'The OSS URI of the image.'."\n" + 'description' => 'The compression format of the output image. Valid values:'."\n" + ."\n" + .'- jpg (default)'."\n" + ."\n" + .'- png'."\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", + .'- webp', + 'enumValueTitles' => ['jpg' => 'jpg', 'png' => 'png', 'webp' => 'webp'], 'type' => 'string', 'required' => false, - 'example' => 'oss://test-bucket/test-object', + 'example' => 'jpg', + 'title' => '', ], ], [ + 'name' => 'Quality', + 'in' => 'query', + 'schema' => ['description' => 'The compression quality of the output image. This parameter is valid only for JPG and WebP images. The value range is 0 to 100. The default value is 80.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '80', 'title' => ''], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => ['description' => 'The image stitching method. Valid values:'."\n" + ."\n" + .'- vertical (default): Stitches images vertically. The widths of all images must be the same.'."\n" + ."\n" + .'- horizontal: Stitches images horizontally. The heights of all images must be the same.', 'type' => 'string', 'required' => false, 'example' => 'vertical', 'title' => ''], + ], + [ + 'name' => 'ScaleType', + 'in' => 'query', + 'schema' => ['description' => 'The scaling method used when the width or height of an image is aligned. Valid values:'."\n" + ."\n" + .'- fit (default): Scales the image without adding black bars. Only proportional scaling is supported.'."\n" + ."\n" + .'- stretch: Stretches the image to fill the space.', 'type' => 'string', 'required' => false, 'example' => 'stretch', 'title' => ''], + ], + [ + 'name' => 'Align', + 'in' => 'query', + 'schema' => ['description' => 'The alignment value, in pixels, for the width or height of the images to be stitched. The value can range from 1 to 4096.'."\n" + ."\n" + .'- If you set **Direction** to `vertical`, this parameter specifies the width alignment.'."\n" + ."\n" + .'- If you set **Direction** to `horizontal`, this parameter specifies the height alignment.'."\n" + ."\n" + .'> If you do not specify this parameter, the width or height of the first image is used for alignment by default.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '192', 'title' => ''], + ], + [ + 'name' => 'Padding', + 'in' => 'query', + 'schema' => ['description' => 'The space, in pixels, between sub-images in the stitched image. The default value is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'Margin', + 'in' => 'query', + 'schema' => ['description' => 'The blank margin, in pixels, of the stitched image. The default value is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'BackgroundColor', + 'in' => 'query', + 'schema' => ['description' => 'The fill color for the areas specified by `Padding` and `Margin`. The value can be in the `#FFFFFF` format or a keyword such as `red` or `alpha`.', 'type' => 'string', 'required' => false, 'example' => 'red', 'title' => ''], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => ['description' => 'The custom information. This information is returned in the asynchronous notification message. Use this information to associate the notification message with your system. The maximum length is 2,048 bytes.', 'type' => 'string', 'required' => false, 'example' => 'test-data', 'title' => ''], + ], + [ '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', - ], + 'schema' => ['description' => 'The chained authorization configuration. For more information, see [Use chained authorization to access resources of other entities](~~465340~~).', '$ref' => '#/components/schemas/CredentialConfig', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'Custom tags used to search for and filter asynchronous tasks.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "User": "Jane"'."\n" + .'}', 'title' => ''], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The message notification configuration. For information about the format of asynchronous notification messages, see [Asynchronous notification message format](~~2743997~~).', '$ref' => '#/components/schemas/Notification', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The result of image stitching.', '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', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '94D6F994-E298-037E-8E8B-0090F27*****', 'title' => ''], + 'EventId' => ['description' => 'The event ID.', 'type' => 'string', 'example' => '10C-1R6p7Km0H5Ieg38LKXTIvw*****', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'ImageSplicing-537cc157-7645-444a-a631-c8db4d02*****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94D6F994-E298-037E-8E8B-0090F27*****\\",\\n \\"EventId\\": \\"10C-1R6p7Km0H5Ieg38LKXTIvw*****\\",\\n \\"TaskId\\": \\"ImageSplicing-537cc157-7645-444a-a631-c8db4d02*****\\"\\n}","type":"json"}]', + 'title' => 'CreateImageSplicingTask', + 'description' => '- **Before you call this operation, make sure that you understand the billing methods and [pricing](~~88317~~) of Intelligent Media Management.**'."\n" + ."\n" + .'- Before you call this operation, ensure that an active project exists in the current region. For more information, see [Project management](~~478152~~).'."\n" + ."\n" + .'- You can stitch a maximum of 10 images in this operation. The length of a single edge of each image cannot exceed 32,876 pixels. The total number of pixels cannot exceed 1 billion.'."\n" + ."\n" + .'- This is an asynchronous operation. After a task starts, its information is saved for 7 days. After this period, you can no longer query the task information. To query task information, call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation and use the returned `TaskId`. You can also set the [Notification](~~2743997~~) parameter to receive asynchronous notifications about the task.', + 'changeSet' => [ + ['createdAt' => '2023-04-03T02:37:23.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-09T10:57:43.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-08-16T06:44:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-16T06:44:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-20T02:53:53.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-19T02:09:08.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateImageSplicingTask'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateImageSplicingTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + ], + 'CreateImageToPDFTask' => [ + 'summary' => 'Converts multiple images into a single PDF file and saves the file as a specified OSS object.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '160409', - 'abilityTreeNodes' => [ - 'FEATUREimmQ9NXNO', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '147624', + 'abilityTreeNodes' => ['FEATUREimmEPY4NE'], ], '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"}', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project. For more information, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ 'name' => 'Sources', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The images.'."\n", + 'description' => 'A list of input images. The images are converted in the order of their URIs in this list.', 'type' => 'array', 'items' => [ - 'description' => 'The image.'."\n", + 'description' => 'The information about an input image.', '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', - ], + 'URI' => ['description' => 'The OSS address of the source image.'."\n" + ."\n" + .'The address must be in the \\`oss\\://${Bucket}/${Object}\\` format. \\``${Bucket}`\\` must be an OSS bucket in the same region as the project. \\``${Object}`\\` must be the full path of the file, including its file name extension.'."\n" + ."\n" + .'Supported formats: JPG, JP2, PNG, TIFF, WebP, BMP, and SVG.', 'type' => 'string', 'required' => true, 'example' => 'oss://examplebucket/sampleobject.jpg', 'title' => ''], + 'Rotate' => ['description' => 'The rotation angle of the image in degrees. Valid values:'."\n" + ."\n" + .'- 0 (default)'."\n" + ."\n" + .'- 90'."\n" + ."\n" + .'- 180'."\n" + ."\n" + .'- 270', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '90', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, + 'required' => true, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'MaxResult', + 'name' => 'TargetURI', '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', - ], + 'schema' => ['description' => 'The OSS address where the output PDF file is stored.'."\n" + ."\n" + .'The address must be in the \\`oss\\://${bucketname}/${objectname}\\` format. \\`${bucketname}\\` must be an OSS bucket in the same region as the project. \\`${objectname}\\` must be the path of the file, including the file name.', 'type' => 'string', 'required' => true, 'example' => 'oss://examplebucket/outputDocument.pdf', 'title' => ''], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => ['description' => 'Custom user information that is returned in the asynchronous notification message. This helps you associate the notification message with your system. The maximum length is 2048 bytes.', 'type' => 'string', 'required' => false, 'example' => 'test-data', 'title' => ''], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => '**If you have no special requirements, leave this parameter empty.**'."\n" + ."\n" + .'The chained authorization configuration. For more information, see [Use chained authorization to access resources of other entities](~~465340~~).', '$ref' => '#/components/schemas/CredentialConfig', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'Custom tags used to search for and filter asynchronous tasks.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "User": "Jane"'."\n" + .'}', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The message notification configuration. For more information, click Notification. For the format of asynchronous notification messages, see [Asynchronous notification message format](~~2743997~~).', '$ref' => '#/components/schemas/Notification', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', '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****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EC564A9A-BA5C-4499-A087-D9B9E76E*****'], + 'EventId' => ['description' => 'The event ID.', 'type' => 'string', 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16Es*****', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'ImageToPDF-cbe6ae3e-f8dc-4566-9da7-535d5d*****', 'title' => ''], ], + 'example' => '', ], ], ], - '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" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EC564A9A-BA5C-4499-A087-D9B9E76E*****\\",\\n \\"EventId\\": \\"0ED-1Bz8z71k5TtsUejT4UJ16Es*****\\",\\n \\"TaskId\\": \\"ImageToPDF-cbe6ae3e-f8dc-4566-9da7-535d5d*****\\"\\n}","type":"json"}]', + 'title' => 'CreateImageToPDFTask', + 'description' => '- **Before using this API, make sure you understand the billing methods and [pricing](~~88317~~) of Intelligent Media Management.**'."\n" ."\n" - .' **Note** Asynchronous processing does not guarantee timely task completion.'."\n" + .'- Before calling this API, make sure that an active project exists in the current region. For more information, see [Project management](~~478152~~).'."\n" ."\n" - .'* The operation searches for faces that are similar to the face within the largest bounding box in each input image.'."\n" + .'- This API supports up to 100 input images.'."\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', + .'- This is an asynchronous API. After a task starts, its information is stored for only 7 days and cannot be retrieved after this period. To view task information, call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) API with the returned `TaskId`. You can also receive task information through asynchronous notification messages by setting the [Notification](~~2743997~~) parameter.', + 'changeSet' => [ + ['createdAt' => '2023-04-03T02:37:22.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-09T10:57:43.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateImageToPDFTask'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateImageToPDFTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + ], + 'CreateLocationDateClusteringTask' => [ + 'summary' => 'The spatio-temporal clustering feature classifies files in a dataset based on their time and location. This feature works on indexed files, such as images and videos, that contain shooting time and location data. These classifications can represent content from a user\'s trip, where files have similar timestamps and locations. The classifications can also represent content shot at different places where a user lives or works. Analyzing the locations and time ranges of these classifications lets you categorize media files, create highlight reels, and generate photo and video stories.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12285,95 +7206,56 @@ 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '157768', - 'abilityTreeNodes' => [ - 'FEATUREimmPECUUL', - ], + 'abilityTreeNodes' => ['FEATUREimmPECUUL'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the project.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['description' => 'The project name. For more information, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ 'name' => 'DatasetName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the dataset.[](~~478160~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-dataset', - ], + 'schema' => ['description' => 'The dataset name. For more information, see [Create a dataset](~~478160~~).', 'type' => 'string', 'required' => true, 'example' => 'test-dataset', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'Custom information that is returned in the asynchronous notification message. This helps you associate the notification message with your system. The maximum length is 2,048 bytes.', 'type' => 'string', 'required' => false, 'example' => 'test-data', 'title' => ''], ], [ '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" - .'}', - ], + 'schema' => ['description' => 'Custom tags used to search for and filter asynchronous tasks.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "User": "Jane"'."\n" + .'}', 'title' => ''], ], [ '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", + 'description' => 'The date clustering settings.'."\n" + .'><notice>Modifying this setting also affects existing spatio-temporal clusters in your `Dataset`.></notice>', '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', - ], + 'GapDays' => ['description' => 'The maximum number of gap days allowed in a single spatio-temporal group. The value must be in the range of 0 to 99,999.'."\n" + ."\n" + .'For example, a user has photos from March 4–5 and March 7, but not from March 6. If you assume that the photos from March 4–7 belong to the same trip, set this parameter to `1 day`. This allows the gap of `1 day` on March 6 to be included in the same spatio-temporal cluster.'."\n" + ."\n" + .'Set this parameter to a value from 0 to 3.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + 'MinDays' => ['description' => 'The minimum number of days in a single spatio-temporal group. The value must be in the range of 1 to 99,999. Clusters with fewer days than this value are not detected or stored.'."\n" + ."\n" + .'For example, if you do not want to include one-day trips in the generated groups, set this parameter to 2.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + 'MaxDays' => ['description' => 'The maximum number of days in a single spatio-temporal group. The value must be in the range of 1 to 99,999. Clusters with more days than this value are not detected or stored.'."\n" + ."\n" + .'For example, if a user takes photos in the same location for more than 15 consecutive days, this location might be their residence rather than a travel destination. If you want to exclude this time period and location from the spatio-temporal clusters, set this parameter to 15.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '15', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ @@ -12381,1829 +7263,1523 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The geolocation configurations for clustering.'."\n" - ."\n" - .'> Adjusting these configurations affects existing spatiotemporal clusters for the dataset.'."\n", + 'description' => 'The location clustering settings.'."\n" + .'><notice>Modifying this setting also affects existing spatio-temporal clusters in your `Dataset`.></notice>', 'type' => 'object', 'properties' => [ 'LocationDateClusterLevels' => [ - 'description' => 'The administrative division levels. You can specify multiple administrative division levels.'."\n" + 'description' => 'A list of administrative levels for grouping. You can select multiple levels.'."\n" + ."\n" + .'For example, a user uploads photos taken in Hangzhou from March 3 to March 5 and photos taken in Jiaxing from March 6 to March 8. If you set this parameter to `["city", "province"]`, the following spatio-temporal clusters are generated:'."\n" + ."\n" + .'- March 3 to March 5, Hangzhou'."\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" + .'- March 6 to March 8, Jiaxing'."\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", + .'- March 3 to March 8, Zhejiang', 'type' => 'array', 'items' => [ - 'description' => 'The administrative division level.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* country'."\n" - .'* province'."\n" - .'* city'."\n" - .'* district'."\n" - .'* township'."\n", + 'description' => 'The administrative level for grouping.', + 'enumValueTitles' => ['country' => 'Country or region', 'province' => 'Province', 'city' => 'City', 'district' => 'District', 'township' => 'Township'], 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'country' => '', - 'province' => '', - 'city' => '', - 'district' => '', - 'township' => '', - ], - 'example' => 'province', 'enum' => [], + 'example' => 'province', + 'title' => '', ], 'required' => true, + 'title' => '', + 'example' => '', ], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ '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', - ], + 'schema' => ['description' => 'The message notification configuration. For more information, see Notification. For the format of asynchronous notification messages, see [Asynchronous notification message format](~~2743997~~).', '$ref' => '#/components/schemas/Notification', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The information about the spatiotemporal clustering task.'."\n", + 'description' => 'The information about the spatio-temporal clustering task.', '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****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'B121940C-9794-4EE3-8D6E-F8EC525F****'], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'LocationDateClustering-c10dce07-1de7-4da7-abee-1a3aba7****', 'title' => ''], + 'EventId' => ['description' => 'The event ID.', 'type' => 'string', 'example' => '25B-1W2ChgujA3Q8MbBY6mSp2mh****', 'title' => ''], ], + 'example' => '', ], ], ], - '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":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B121940C-9794-4EE3-8D6E-F8EC525F****\\",\\n \\"TaskId\\": \\"LocationDateClustering-c10dce07-1de7-4da7-abee-1a3aba7****\\",\\n \\"EventId\\": \\"25B-1W2ChgujA3Q8MbBY6mSp2mh****\\"\\n}","type":"json"}]', '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" + 'description' => '- **Before you use this operation, you must understand the billing methods and [pricing](~~477042~~) of Intelligent Media Management (IMM)**.'."\n" + .' ><notice>Asynchronous tasks do not have a guaranteed processing time.></notice>'."\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" + .'- Before you call this operation, you must index files into a dataset. You can index files by binding data sources using [CreateBinding](~~478202~~) or by indexing files using [IndexFileMeta](~~478166~~) or [BatchIndexFileMeta](~~478167~~).'."\n" ."\n" - .'* Each call to the operation incrementally processes metadata in the dataset.****`` You can regularly call this operation to process incremental files.'."\n" + .'- Each call to this operation processes the files in the specified `Dataset` **incrementally**. You can call this operation periodically to process new files.'."\n" ."\n" - .'* After a spatiotemporal clustering task is complete, you can call the [QueryLocationDateClusters](~~478189~~) operation to query the spatiotemporal clustering result.'."\n" + .'- After clustering is complete, you can call the [QueryLocationDateClusters](~~478189~~) operation to retrieve the clustering results.'."\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" + .'- Deleting a file from a dataset does not change the spatio-temporal clusters. To delete existing spatio-temporal clusters, you can 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', + .'- This is an asynchronous operation. After a task starts, its information is saved for only 7 days. You cannot retrieve task information after 7 days. You can call the [GetTask](~~GetTask~~) or [ListTasks](~~ListTasks~~) operation to view task information using the returned `TaskId`. You can also configure the [Notification](~~2743997~~) parameter to receive task information through message notifications.', + 'changeSet' => [ + ['createdAt' => '2023-04-03T02:37:22.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-09T10:57:43.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLocationDateClusteringTask'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateLocationDateClusteringTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + ], + ], + 'CreateMediaConvertTask' => [ + 'summary' => 'Create an asynchronous media transcoding task. This task processes audio and video files for media transcoding, media concatenation, video frame capture, and animated GIF generation.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '157769', - 'abilityTreeNodes' => [ - 'FEATUREimmPECUUL', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '132611', + 'abilityTreeNodes' => ['FEATUREimmCUOMK0'], ], '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', - ], + 'schema' => ['description' => 'The name of the project. For more information about how to obtain the project name, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'DatasetName', + 'name' => 'Sources', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the dataset. For information about how to create a dataset, see [CreateDataset](~~478160~~).'."\n", - 'type' => 'string', + 'description' => 'A list of media files. If you provide more than one file, they are concatenated in the order of their URIs.', + 'type' => 'array', + 'items' => [ + 'description' => 'The source media file.', + 'type' => 'object', + 'properties' => [ + 'URI' => ['description' => 'The OSS URI of the object. The URI must use the `oss://${Bucket}/${Object}` format, where `${Bucket}` is the name of an OSS bucket in the same region as the project, and `${Object}` is the full path to the object, including its file extension.', 'type' => 'string', 'required' => false, 'example' => 'oss://test-bucket/test-object', 'title' => ''], + 'StartTime' => ['description' => 'The start time of media transcoding, in seconds. Valid values include:'."\n" + ."\n" + .'- 0 (default): Transcoding starts from the beginning of the media file.'."\n" + ."\n" + .'- n (a value greater than 0): Transcoding starts n seconds into the media file.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0', 'title' => ''], + 'Duration' => ['description' => 'The duration of media transcoding in seconds. The default value, 0, transcodes the media until its end.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0', 'title' => ''], + 'Subtitles' => [ + 'description' => 'A list of subtitles to add.', + 'type' => 'array', + 'items' => [ + 'description' => 'The subtitle settings.', + 'type' => 'object', + 'properties' => [ + 'URI' => ['description' => 'The OSS URI of the object. The URI must use the `oss://${Bucket}/${Object}` format, where `${Bucket}` is the name of an OSS bucket in the same region as the project, and `${Object}` is the full path to the object, including its file extension.'."\n" + .'Supported subtitle formats include: srt, vtt, mov\\_text, ass, dvd\\_sub, and pgs.', 'type' => 'string', 'required' => false, 'example' => 'oss://test-bucket/test-object'."\n", 'title' => ''], + 'TimeOffset' => ['description' => 'The subtitle delay, in seconds. The default value is 0.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '10.5', 'title' => ''], + 'Language' => ['description' => 'The language of the subtitle. The value must comply with the ISO 639-2 standard.', 'type' => 'string', 'required' => false, 'example' => 'eng', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Attached' => ['description' => 'If true, adds the current source media file to the output as a synchronized audio stream or video stream. The default is false.'."\n" + ."\n" + .'> - You cannot set Attached to true for the source media file referenced by AlignmentIndex.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'AlignMode' => ['description' => 'The alignment mode for the added audio and video streams. Valid values include:'."\n" + ."\n" + .'- false (default): No alignment is performed.'."\n" + ."\n" + .'- loop: Aligns content by looping the audio or video.'."\n" + ."\n" + .'- pad: Aligns content by padding with silent frames or black frames.'."\n" + ."\n" + .'> * This parameter only takes effect if Attached is set to true.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''], + 'DisableVideo' => ['description' => 'Specifies whether to disable the video from the source media file. Valid values include:'."\n" + ."\n" + .'- true: Disables the video.'."\n" + ."\n" + .'- false (default): Includes the video.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'DisableAudio' => ['description' => 'Specifies whether to disable the audio from the source media file. Valid values include:'."\n" + ."\n" + .'- true: Disables the audio.'."\n" + ."\n" + .'- false (default): Includes the audio.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], '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, + 'title' => '', 'example' => '', ], ], [ - 'name' => 'Address', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The address information.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/Address', - ], - ], - [ - 'name' => 'LocationDateClusterLevels', + 'name' => 'Targets', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The container for the administrative division level of the spatiotemporal clusters to be queried.'."\n", + 'description' => 'A list of media processing tasks.', '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' => '', + 'description' => 'The settings for an output media file.', + 'type' => 'object', + 'properties' => [ + 'URI' => ['description' => 'The OSS URI of the output file for media transcoding.'."\n" + ."\n" + .'The URI must be in the `oss://${Bucket}/${Object}` format. In this format, `${Bucket}` is the name of the OSS bucket, which must be in the same region as the project, and `${Object}` is the full path to the object, including the file extension.'."\n" + ."\n" + .'- If the **URI** has a file extension, all output media files are saved to this **URI**. If multiple files are generated, they will overwrite each other.'."\n" + ."\n" + .'- If the **URI** does not have a file extension, the final output URI is generated based on the **URI**, **Container**, and **Segment** parameters. For example, if the **URI** is `oss://examplebucket/outputVideo`:'."\n" + ."\n" + .' - If **Container** is `mp4` and **Segment** is empty, the OSS URI of the generated media file is `oss://examplebucket/outputVideo.mp4`.'."\n" + ."\n" + .' - If **Container** is `ts` and **Format** in **Segment** is `hls`, the process generates an m3u8 file with the OSS URI `oss://examplebucket/outputVideo.m3u8` and multiple TS files prefixed with `oss://examplebucket/outputVideo`.', 'type' => 'string', 'required' => false, 'example' => 'oss://test-bucket/test-target-object.mp4', 'title' => ''], + 'Container' => ['description' => 'The media container type. Valid container types include:'."\n" + ."\n" + .'- Audio/video containers: mp4, mkv, mov, asf, avi, mxf, ts, flv'."\n" + ."\n" + .'- Audio-only containers: mp3, aac, flac, oga, ac3, opus'."\n" + ."\n\n" + .' ><notice>'."\n" + ."\n" + .' The `Container` and `URI` parameters must be set together. To perform only subtitle extraction, frame capture, sprite generation, or animated image generation, leave both `Container` and `URI` empty. In this case, parameters such as `Segment`, `Video`, `Audio`, and `Speed` are ignored.'."\n" + ."\n" + .' ></notice>', 'type' => 'string', 'required' => false, 'example' => 'mp4', 'title' => ''], + 'Speed' => ['description' => 'The playback speed of the output media. The value must be between 0.5 and 1.0, inclusive. The default value is 1.0.'."\n" + ."\n" + .'> This parameter specifies the default playback speed of the output file as a ratio of the source file\'s speed. It does not perform speed-up transcoding.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '1.0', 'title' => ''], + 'Segment' => [ + 'description' => 'Settings for media segmentation.', + 'type' => 'object', + 'properties' => [ + 'Format' => ['description' => 'The segmentation method. Valid values include:'."\n" + ."\n" + .'- hls'."\n" + ."\n" + .'- dash', 'type' => 'string', 'required' => false, 'example' => 'hls', 'title' => ''], + 'Duration' => ['description' => 'The duration of each segment, in seconds.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '30', 'title' => ''], + 'StartNumber' => ['description' => 'The starting sequence number. This parameter is supported only for HLS. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Video' => ['description' => 'The video processing parameters.'."\n" + .'><notice>If this parameter is left empty, the first video stream, if it exists, is copied directly to the output file.></notice>', '$ref' => '#/components/schemas/TargetVideo', 'required' => false, 'title' => '', 'example' => ''], + 'Audio' => ['description' => 'The audio processing parameters.'."\n" + .'><notice>If this parameter is left empty, the first audio stream, if it exists, is copied directly to the output file.></notice>', '$ref' => '#/components/schemas/TargetAudio', 'required' => false, 'title' => '', 'example' => ''], + 'Subtitle' => ['description' => 'The subtitle processing parameters.'."\n" + .'><notice>If this parameter is left empty, the first subtitle stream, if it exists, is copied directly to the output file.></notice>', '$ref' => '#/components/schemas/TargetSubtitle', 'required' => false, 'title' => '', 'example' => ''], + 'Image' => ['description' => 'The parameters for frame capture, sprite generation, and animated image generation.', '$ref' => '#/components/schemas/TargetImage', 'required' => false, 'title' => '', 'example' => ''], + 'StripMetadata' => ['description' => 'If true, removes metadata such as `title` and `album` from the media file. The default is false.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Stream' => [ + 'type' => 'array', + 'items' => ['description' => 'The index of the data stream to process.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'description' => 'A list of indexes of the data streams in the source file to process. An empty list (default) indicates that no data streams are retained. An index of -1 indicates that all data streams are retained.'."\n" + ."\n" + .'- Example: `[0,1]` processes the data streams with index 0 and 1; `[1]` processes the data stream with index 1; `[-1]` processes all data streams.'."\n" + ."\n" + .'> If a specified index does not correspond to an existing data stream, it is ignored.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'Settings for retaining data streams.'."\n" + .'><notice>Retaining data streams is supported only when the `Container` parameter is set to `mp4`.></notice>', + 'title' => '', + 'example' => '', + 'required' => false, + ], + 'AttachedPicture' => [ + 'type' => 'object', + 'properties' => [ + 'Stream' => [ + 'type' => 'array', + 'items' => ['description' => 'The index of the attached picture to process.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'description' => 'A list of indexes of the attached pictures in the source file to process. An empty list (default) indicates that no attached pictures are retained. An index of -1 indicates that all attached pictures are retained.'."\n" + ."\n" + .'- Example: `[0,1]` processes the attached pictures with index 0 and 1; `[1]` processes the attached picture with index 1; `[-1]` processes all attached pictures.'."\n" + ."\n" + .'> If a specified index does not correspond to an existing attached picture, it is ignored.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'Settings for retaining attached pictures.'."\n" + .'><notice>Retaining attached pictures is supported only when the `Container` parameter is set to `mp4` or `mkv`.></notice>', + 'title' => '', + 'example' => '', + 'required' => false, + ], ], - 'example' => 'province', + 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'LocationDateClusterStartTimeRange', + 'name' => 'UserData', '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', - ], + 'schema' => ['description' => 'The custom user data. This data is returned in the asynchronous notification, allowing you to associate the notification with your internal system. The maximum length is 2,048 bytes.', 'type' => 'string', 'required' => false, 'example' => '{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"}', 'title' => ''], ], [ - 'name' => 'LocationDateClusterEndTimeRange', + 'name' => 'Tags', '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', - ], + 'schema' => ['description' => 'Custom tags for searching and filtering asynchronous tasks.', 'type' => 'object', 'required' => false, 'example' => '{"test":"val1"}', 'title' => ''], ], [ - 'name' => 'CreateTimeRange', + 'name' => 'CredentialConfig', 'in' => 'query', 'style' => 'json', - 'schema' => [ - 'description' => 'The time range during which the spatiotemporal clusters were generated.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/TimeRange', - ], + 'schema' => ['description' => '**You can leave this parameter empty if you do not have special requirements.**'."\n" + ."\n" + .'The chained authorization configuration. For more information, see [Use chained authorization to access resources of other entities](~~465340~~).', '$ref' => '#/components/schemas/CredentialConfig', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'UpdateTimeRange', + 'name' => 'Notification', 'in' => 'query', 'style' => 'json', - 'schema' => [ - 'description' => 'The time range during which the spatiotemporal clusters were updated.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/TimeRange', - ], + 'schema' => ['description' => 'The message notification settings. For more information, click Notification. For information about the format of asynchronous notifications, see [Asynchronous notification format](~~2743997~~).', '$ref' => '#/components/schemas/Notification', 'required' => false, 'title' => '', 'example' => ''], ], [ - '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', + 'name' => 'AlignmentIndex', 'in' => 'query', - 'schema' => [ - 'description' => 'The custom labels.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key=value', - ], + 'schema' => ['description' => 'When concatenating media files, this specifies the index of the primary file in the Sources list. The default transcoding parameters (such as resolution and frame rate from the `Video` and `Audio` objects) are taken from this primary file. The default index is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'Sort', + 'name' => 'TargetGroups', 'in' => 'query', + 'style' => 'json', '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' => '', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'URI' => ['description' => 'The OSS URI of the output HLS master playlist file for the packaging task.', 'type' => 'string', 'required' => false, 'example' => 'oss://test-bucket/test-object/master.m3u8', 'title' => ''], + 'Targets' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'URI' => ['description' => 'The OSS URI of the output HLS media playlist file for the subtask.'."\n" + .'><notice>This URI must be in the same directory as or a subdirectory of `TargetGroups.URI`.></notice>', 'type' => 'string', 'required' => false, 'example' => 'oss://test-bucket/test-target-object.mp4', 'title' => ''], + 'Container' => ['description' => 'The packaging container type. Only `mp4` and `ts` are supported.', 'type' => 'string', 'required' => false, 'example' => 'mp4', 'title' => ''], + 'Speed' => ['description' => 'The playback speed of the output media. The value must be between 0.5 and 1.0, inclusive. The default value is 1.0.'."\n" + ."\n" + .'> This parameter specifies the default playback speed of the output file as a ratio of the source file\'s speed. It does not perform speed-up transcoding.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '1.0', 'title' => ''], + 'Segment' => [ + 'type' => 'object', + 'properties' => [ + 'Format' => ['description' => 'The media packaging format. Only `hls` is supported.', 'type' => 'string', 'required' => false, 'example' => 'hls', 'title' => ''], + 'Duration' => ['description' => 'The duration of each segment, in seconds.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '30', 'title' => ''], + 'StartNumber' => ['description' => 'The starting sequence number for segments. The default is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], + ], + 'description' => 'The media packaging settings.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Video' => ['description' => 'The video processing parameters.'."\n" + .'><notice>If this parameter is left empty, the first video stream, if it exists, is copied directly to the output file.></notice>', '$ref' => '#/components/schemas/TargetVideo', 'required' => false, 'title' => '', 'example' => ''], + 'Audio' => ['description' => 'The audio processing parameters.'."\n" + .'><notice>If this parameter is left empty, the first audio stream, if it exists, is copied directly to the output file.></notice>', '$ref' => '#/components/schemas/TargetAudio', 'required' => false, 'title' => '', 'example' => ''], + 'Subtitle' => ['description' => 'The subtitle processing parameters.'."\n" + .'><notice>You must use the `Subtitle.ExtractSubtitle` parameter to package subtitle streams. The `URI` in `Subtitle.ExtractSubtitle` must be in the same directory as or a subdirectory of `TargetGroups.URI`. The `Format` in `Subtitle.ExtractSubtitle` must be `vtt`. You only need to configure this parameter in one `Target` to package all subtitle streams.></notice>', '$ref' => '#/components/schemas/TargetSubtitle', 'required' => false, 'title' => '', 'example' => ''], + 'StripMetadata' => ['description' => 'If true, removes metadata from the output file. The default is false.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of media packaging subtasks. Each `Target` corresponds to a variant stream (`#EXT-X-STREAM-INF`) in the HLS master playlist and generates a corresponding HLS media playlist.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], - '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', + 'description' => 'A list of media packaging tasks to convert and package the input media into HLS outputs. Each TargetGroup corresponds to one HLS master playlist.', 'required' => false, - 'enumValueTitles' => [ - 'asc' => '', - 'desc' => '', - ], - 'example' => 'asc', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '响应结构体', + 'description' => 'The response body.', '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****', - ], + 'RequestId' => ['title' => '请求 ID', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6'], + 'EventId' => ['description' => 'The ID of the event.', 'type' => 'string', 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16Es****', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => 'MediaConvert-adb1ee28-c4c9-42a7-9f54-3b8eadcb****', 'title' => ''], ], + 'example' => '', ], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6\\",\\n \\"EventId\\": \\"0ED-1Bz8z71k5TtsUejT4UJ16Es****\\",\\n \\"TaskId\\": \\"MediaConvert-adb1ee28-c4c9-42a7-9f54-3b8eadcb****\\"\\n}","type":"json"}]', + 'title' => 'Create Media Transcoding Task', + 'description' => '- **Before you call this operation, ensure you understand the billing methods and [pricing](~~88317~~) for Intelligent Media Management.**'."\n" + ."\n" + .'- Before calling this operation, ensure a project is available in the current region. For more information, see [Project Management](~~478152~~).'."\n" + ."\n\n" + .' ><notice>'."\n" + ."\n" + .' The completion time of an asynchronous task is not guaranteed.'."\n" + ."\n" + .' ></notice>'."\n" + ."\n" + .'- When you use this operation for media transcoding, it processes only one video, audio, or subtitle stream by default. You can also configure the number of streams to process.'."\n" + ."\n" + .'- When you use this operation for media concatenation, you can specify a maximum of 11 media files. Parameters for operations such as media transcoding and frame capture apply to the final concatenated output.'."\n" + ."\n" + .'- This operation is asynchronous. After a task starts, its information is retained for only 7 days. After this period, you cannot retrieve it. To view task information, call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation with the returned `TaskId`. You can also set the [Notification](~~2743997~~) parameter to receive task information via message notifications.', + 'changeSet' => [ + ['createdAt' => '2025-04-17T09:26:17.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-09T03:31:19.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-03T02:29:58.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-09T10:57:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-16T06:44:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-16T06:44:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-04-26T03:30:15.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMediaConvertTask'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateMediaConvertTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + ], + ], + 'CreateOfficeConversionTask' => [ + 'summary' => 'Creates a document conversion task that converts documents, such as Word, PowerPoint, Excel, and PDF files, stored in Object Storage Service (OSS) into images, text files, or PDF files.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '157778', - 'abilityTreeNodes' => [ - 'FEATUREimmPECUUL', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '129600', + 'abilityTreeNodes' => ['FEATUREimmV2RAAA'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the project.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['description' => 'The project name. For more information about how to obtain the project name, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'DatasetName', + 'name' => 'SourceURI', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the dataset.[](~~478160~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-dataset', - ], + 'schema' => ['description' => 'The storage address of the source data.'."\n" + ."\n" + .'The OSS address must be in the oss\\://${Bucket}/${Object} format. \\`${Bucket}\\` is the name of the OSS bucket that is in the same region as the current project. \\`${Object}\\` is the full path of the file, including the file name extension.', 'type' => 'string', 'required' => false, 'example' => 'oss://test-bucket/test-object', 'title' => ''], ], [ - 'name' => 'ObjectId', - 'in' => 'query', + 'name' => 'Sources', + 'in' => 'formData', + 'style' => 'json', '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', + 'description' => 'A list of input images. The images are converted in the order of their URIs in the list. (**This parameter is not yet published. Do not use it.**)', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about an input image.', + 'type' => 'object', + 'properties' => [ + 'URI' => ['description' => 'The OSS address of the source image.'."\n" + ."\n" + .'The OSS address must be in the oss\\://${Bucket}/${Object} format. ${Bucket} is the name of the OSS bucket that is in the same region as the current project. ${Object} is the full path of the file, including the file name extension.'."\n" + ."\n" + .'Supported image formats: jpg, jp2, png, tiff, webp, bmp, and svg.', 'type' => 'string', 'required' => false, 'example' => 'oss://examplebucket/sampleobject.jpg', 'title' => ''], + 'Rotate' => ['description' => 'The rotation angle of the image. Valid values:'."\n" + ."\n" + .'- 0 (default)'."\n" + ."\n" + .'- 90'."\n" + ."\n" + .'- 180'."\n" + ."\n" + .'- 270', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '90', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => 'oss://imm-test/test.pptx', + 'title' => '', ], ], [ - 'name' => 'Title', + 'name' => 'TargetURI', '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' => '', - ], + 'schema' => ['description' => 'The template for the output address of the converted document.'."\n" + ."\n" + .'The address must be in the `oss://{bucket}/{tags.custom}/{dirname}/{barename}.{autoext}` format. For more information, see [TargetURI templates](~~465762~~).'."\n" + ."\n" + .'> Specify either this parameter or \\`TargetURIPrefix\\`.', 'type' => 'string', 'example' => 'oss://examplebucket/outputDocument.pdf', 'title' => '', 'required' => false], ], [ - 'name' => 'CustomId', + 'name' => 'TargetURIPrefix', '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', - ], + 'schema' => ['description' => 'The prefix of the storage address for the output file after document conversion.'."\n" + ."\n" + .'The prefix must be in the `oss://${Bucket}/${Prefix}/` format. \\`${Bucket}\\` is the name of the OSS bucket that is in the same region as the current project. \\`${Prefix}\\` is the prefix of the storage address for the output file.'."\n" + ."\n" + .'> Specify either this parameter or \\`TargetURI\\`.', 'type' => 'string', 'required' => false, 'example' => 'oss://examplebucket/outputprefix/', 'title' => ''], ], [ - 'name' => 'CustomLabels', + 'name' => 'SourceType', '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" - .'}', - ], + 'schema' => ['description' => 'The extension type of the source data. By default, the type of the source data is determined by the extension of the OSS object. If the OSS object does not have an extension, you can set this parameter. Valid values:'."\n" + ."\n" + .'- Word processor documents (Word): doc, docx, wps, wpss, docm, dotm, dot, and dotx'."\n" + ."\n" + .'- Presentation documents (PowerPoint): pptx, ppt, pot, potx, pps, ppsx, dps, dpt, pptm, potm, ppsm, and dpss'."\n" + ."\n" + .'- Spreadsheet documents (Excel): xls, xlt, et, ett, xlsx, xltx, csv, xlsb, xlsm, xltm, and ets'."\n" + ."\n" + .'- PDF documents: pdf', 'type' => 'string', 'required' => false, 'example' => 'doc', 'title' => ''], ], - ], - '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****', - ], - ], - ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the output file. Valid values:'."\n" + ."\n" + .'- png: Converts the document to PNG images.'."\n" + ."\n" + .'- jpg: Converts the document to JPG images.'."\n" + ."\n" + .'- pdf: Converts the document to a PDF file.'."\n" + ."\n" + .'- txt: Converts the document to a text-only file. This is mainly used to extract text content from the file. This option is supported only for presentation documents, word processor documents, and spreadsheet documents. When you convert a spreadsheet document, a single txt file is generated, and settings for sheet-related variables do not take effect.', 'type' => 'string', 'required' => true, 'example' => 'png', 'title' => ''], ], - ], - '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' => [], + 'name' => 'UserData', + 'in' => 'query', + 'schema' => ['description' => 'The custom information. This information is returned in the asynchronous notification message to help you associate the notification with your services. The value can be up to 2,048 bytes in length.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '{'."\n" + .' "id": "test-id",'."\n" + .' "name": "test-name"'."\n" + .'}'], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '158363', - 'abilityTreeNodes' => [ - 'FEATUREimmPECUUL', + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The custom tags. The value is a dictionary. You can use tags to search for tasks.', 'type' => 'object', 'title' => '', 'required' => false, 'example' => '{'."\n" + .' "key": "value"'."\n" + .'}'], ], - ], - 'parameters' => [ [ - 'name' => 'ProjectName', + 'name' => 'StartPage', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['description' => 'The start page for the document conversion. The default value is 1.'."\n" + ."\n" + .'> - If the source file is a spreadsheet, you must specify the worksheet number.'."\n" + .'>'."\n" + .'> - This parameter takes effect only when you convert the document to images. It does not take effect when you convert the document to a PDF file or a text file.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1'], ], [ - 'name' => 'DatasetName', + 'name' => 'EndPage', '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', - ], + 'schema' => ['description' => 'The end page for the document conversion. The default value is -1, which indicates that all pages from the start page to the last page are converted.'."\n" + ."\n" + .'> - If the source file is a spreadsheet, you must specify the worksheet number (\\`SheetIndex\\`).'."\n" + .'>'."\n" + .'> - If the document has many pages, we recommend that you convert them in batches. Otherwise, the conversion may time out.'."\n" + .'>'."\n" + .'> - This parameter takes effect only when you convert the document to images. It does not take effect when you convert the document to a PDF file or a text file.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '-1'], ], [ - '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', - ], + 'name' => 'Password', + 'in' => 'query', + 'schema' => ['description' => 'The password to open the document. Set this parameter if you want to convert a password-protected document.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '123456'], ], - ], - '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****', - ], - ], - ], + [ + 'name' => 'ScalePercentage', + 'in' => 'query', + 'schema' => ['description' => 'The scaling ratio of the document. Valid values: 20 to 199. The default value is 100, which indicates that the document is not scaled.'."\n" + ."\n" + .'> A value less than 100 indicates that the document is scaled down. A value greater than 100 indicates that the document is scaled up.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '100'], ], - ], - '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' => [], + 'name' => 'Quality', + 'in' => 'query', + 'schema' => ['description' => 'The quality of the converted file. Valid values: 0 to 100. A value of 0 indicates the lowest quality and the best performance. A value of 100 indicates the highest quality and the poorest performance. By default, the system sets an appropriate value based on the document content to balance quality and performance.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '60'], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '103261', - 'abilityTreeNodes' => [ - 'FEATUREimmPQ568C', + [ + 'name' => 'Pages', + 'in' => 'query', + 'schema' => ['description' => 'The page numbers to convert. This parameter has a higher priority than the \\`StartPage\\` and \\`EndPage\\` parameters. The format is as follows:'."\n" + ."\n" + .'- Separate multiple page numbers with commas (,), for example, 1,2.'."\n" + ."\n" + .'- Specify a range of consecutive pages with a hyphen (-), for example, 1,2-4,7.', 'type' => 'string', 'example' => '1,2-4,7', 'title' => '', 'required' => false], ], - ], - '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' => 'MaxSheetRow', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of rows to convert when you convert a spreadsheet document to images. By default, all rows are converted.'."\n" + ."\n" + .'> This parameter takes effect only when you set **LongPicture** to `true`.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'], ], [ - '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' => 'MaxSheetColumn', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of columns to convert when you convert a spreadsheet document to images. By default, all columns are converted.'."\n" + ."\n" + .'> This parameter takes effect only when you set **LongPicture** to `true`.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'], ], [ - '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' => 'SheetCount', + 'in' => 'query', + 'schema' => ['description' => 'The number of worksheets to convert to images in the spreadsheet document. By default, all worksheets are converted.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1'], ], [ - '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' => 'SheetIndex', + 'in' => 'query', + 'schema' => ['description' => 'The number of the worksheet to convert to images in the spreadsheet document. Valid values: 1 to the number of the last worksheet. The default value is 1.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1'], ], [ - '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' => 'FitToWidth', + 'in' => 'query', + 'schema' => ['description' => 'When you convert a spreadsheet document to images or a PDF file, specifies whether to render all columns on a single image or PDF page. Valid values:'."\n" + ."\n" + .'- false (default): No. The content is rendered on multiple images or PDF pages.'."\n" + ."\n" + .'- true: Yes. The content is rendered on a single image or PDF page.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], ], [ - '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' => 'FitToHeight', + 'in' => 'query', + 'schema' => ['description' => 'When you convert a spreadsheet document to images or a PDF file, specifies whether to render all rows on a single image or PDF page. Valid values:'."\n" + ."\n" + .'- false (default): No. The content is rendered on multiple images or PDF pages.'."\n" + ."\n" + .'- true: Yes. The content is rendered on a single image or PDF page.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], ], [ - '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' => 'FirstPage', + 'in' => 'query', + 'schema' => ['description' => 'When you convert a spreadsheet document to images, specifies whether to return only the first image of the conversion result. The number of rows and columns in the image is the result of automatic splitting. Valid values:'."\n" + ."\n" + .'- false (default): No. All images are returned.'."\n" + ."\n" + .'- true: Yes. Only the first image is returned. This is used to extract a thumbnail.'."\n" + ."\n" + .'> This parameter takes effect only if you set the **LongPicture** parameter to `true`.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'StoryName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the story.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name1', - ], + 'name' => 'PaperSize', + 'in' => 'query', + 'schema' => ['description' => 'The paper size for converting a spreadsheet document to images. The output image is similar to a printed page. Valid values:'."\n" + ."\n" + .'- A0'."\n" + ."\n" + .'- A2'."\n" + ."\n" + .'- A4 (default)'."\n" + ."\n" + .'> This parameter takes effect only when you use it with the **FitToHeight** and **FitToWidth** parameters.', 'type' => 'string', 'example' => 'A4', 'title' => '', 'required' => false], ], [ - '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' => 'PaperHorizontal', + 'in' => 'query', + 'schema' => ['description' => 'When you convert a spreadsheet document to images, specifies whether to place the paper horizontally. The output image is similar to a printed page. Valid values:'."\n" + ."\n" + .'- false (default): No. The paper is placed vertically.'."\n" + ."\n" + .'- true: Yes. The paper is placed horizontally.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], ], [ - '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' => 'TrimPolicy', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The trimming policy for spreadsheet conversion. For example, if a spreadsheet contains many empty rows and columns, a large amount of white space may be generated if no trimming policy is specified.', '$ref' => '#/components/schemas/TrimPolicy', 'title' => '', 'required' => false, 'example' => ''], ], [ - 'name' => 'NotifyTopicName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The topic name of the asynchronous reverse notification.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-topic', - ], + 'name' => 'ShowComments', + 'in' => 'query', + 'schema' => ['description' => 'When you convert a word processor document to images, specifies whether to show comments. Valid values:'."\n" + ."\n" + .'- false (default): No. Comments are not shown.'."\n" + ."\n" + .'- true: Yes. Comments are shown.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], ], [ - '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' => 'LongPicture', + 'in' => 'query', + 'schema' => ['description' => 'When you convert a document to images, specifies whether to convert it into a long image. Valid values:'."\n" + ."\n" + .'- false (default): No. The document is converted into multiple images.'."\n" + ."\n" + .'- true: Yes. The document is converted into a long image.'."\n" + ."\n" + .'> You can combine a maximum of 20 pages into a long image. If the number of pages exceeds this limit, the conversion task may fail.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], ], [ - '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' => 'ImageDPI', + 'in' => 'query', + 'schema' => ['description' => 'The DPI of the output image. Valid values: 96 to 600. The default value is 96.', 'type' => 'integer', 'format' => 'int64', 'example' => '96', 'title' => '', 'required' => false], ], [ - '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' => 'LongText', + 'in' => 'query', + 'schema' => ['description' => 'When you convert a document to text, specifies whether to convert it into a long text file. Valid values:'."\n" + ."\n" + .'- false (default): No. Each page of the document is converted into a separate text file.'."\n" + ."\n" + .'- true: Yes. All content is placed in a single text file.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'Tags', + 'name' => 'HoldLineFeed', '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"}', - ], + 'schema' => ['description' => 'When you convert a document to text, specifies whether to keep the line feeds in the document. Valid values:'."\n" + ."\n" + .'- false (default): No. Line feeds are not kept.'."\n" + ."\n" + .'- true: Yes. Line feeds are kept.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'UserData', + 'name' => 'CredentialConfig', '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"}', - ], + 'style' => 'json', + 'schema' => ['description' => '**If you do not have special requirements, leave this parameter empty.**'."\n" + ."\n" + .'The chained authorization configuration. This parameter is not required. For more information, see [Use chained authorization to access resources of other entities](~~465340~~).', '$ref' => '#/components/schemas/CredentialConfig', 'required' => false, 'title' => '', 'example' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The message notification configuration. For more information, click Notification. For more information about the format of asynchronous notification messages, see [Asynchronous notification message format](~~2743997~~).', '$ref' => '#/components/schemas/Notification', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response for the asynchronous task.', '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****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'FF3B7D81-66AE-47E0-BF69-157DCF18*****'], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'title' => '', 'example' => 'formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd*****'], + 'EventId' => ['description' => 'The event ID.', 'type' => 'string', 'example' => '2C2-1I0EG57VR37J4rQ8oKG6C9*****', 'title' => ''], ], + 'example' => '', ], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FF3B7D81-66AE-47E0-BF69-157DCF18*****\\",\\n \\"TaskId\\": \\"formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd*****\\",\\n \\"EventId\\": \\"2C2-1I0EG57VR37J4rQ8oKG6C9*****\\"\\n}","type":"json"}]', + 'title' => 'CreateOfficeConversionTask', + 'description' => '- **Before you use this operation, make sure that you understand the billing methods and [pricing](~~477042~~) of Intelligent Media Management (IMM).**'."\n" + .' ><notice>The execution time of asynchronous tasks is not guaranteed.></notice>'."\n" + ."\n" + .'- Supported input file formats:'."\n" + ."\n" + .' - Word processor documents (Word): doc, docx, wps, wpss, docm, dotm, dot, and dotx.'."\n" + ."\n" + .' - Presentation documents (PowerPoint): pptx, ppt, pot, potx, pps, ppsx, dps, dpt, pptm, potm, ppsm, and dpss.'."\n" + ."\n" + .' - Spreadsheet documents (Excel): xls, xlt, et, ett, xlsx, xltx, csv, xlsb, xlsm, xltm, and ets.'."\n" + ."\n" + .' - PDF documents: pdf.'."\n" + ."\n" + .'- Supported output file formats:'."\n" + ."\n" + .' - Images: png and jpg.'."\n" + ."\n" + .' - Text: txt.'."\n" + ."\n" + .' - PDF: pdf.'."\n" + ."\n" + .'- The maximum size of a single file is 200 MB. This limit cannot be changed.'."\n" + ."\n" + .'- If a file is large or its content is complex, the conversion may time out.'."\n" + ."\n" + .'- The number of requests per second is limited to 50 for a single user.'."\n" + ."\n" + .'- Task information is stored for only 7 days after a task starts. After this period, the information cannot be retrieved. You can promptly obtain task information using one of the following methods:'."\n" + ."\n" + .' - You can call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation to obtain the returned `TaskId` and view the task information.'."\n" + ."\n" + .' - You can activate Message Service (MNS) in the same region as IMM and configure a subscription to promptly receive task information notifications. For more information about the format of asynchronous notification messages, see [Asynchronous notification message format](~~2743997~~). For more information about the MNS software development kit (SDK), see [Receive and delete messages](~~32449~~).'."\n" + ."\n" + .' - You can activate RocketMQ in the same region as IMM, and create a RocketMQ 4.0 instance, a topic, and a group to promptly receive task information notifications. For more information about the format of asynchronous notification messages, see [Asynchronous notification message format](~~2743997~~). For more information about how to use RocketMQ, see [Use an SDK for HTTP to send and receive normal messages](~~169009~~).'."\n" + ."\n" + .' - You can activate and connect to [EventBridge](https://www.aliyun.com/product/aliware/eventbridge) in the same region as IMM to promptly receive task information notifications. For more information, see [Intelligent Media Management IMM events](~~205730~~).', + 'changeSet' => [ + ['createdAt' => '2024-11-29T02:32:06.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-10-18T06:40:17.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-03T02:37:22.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-09T10:57:43.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-08-16T06:44:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-16T06:44:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-04-26T03:33:32.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2022-04-26T03:33:32.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOfficeConversionTask'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateOfficeConversionTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + ], + ], + 'CreateProject' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'deprecated' => false, + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '102513', - 'abilityTreeNodes' => [ - 'FEATUREimmPQ568C', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '436', + 'abilityTreeNodes' => ['FEATUREimmKH590Y'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the project.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['title' => '', 'description' => 'The project name. The following naming rules apply:'."\n" + ."\n" + .'- The name must be 1 to 128 characters in length.'."\n" + ."\n" + .'- The name can contain letters, digits, hyphens (-), and underscores (_).'."\n" + ."\n" + .'- The name must start with a letter or an underscore (_).', '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', + 'name' => 'Description', 'in' => 'query', 'schema' => [ - 'description' => 'The subtype of the story. For a list of valid values, see [Story types and subtypes](~~2743998~~).', + 'description' => 'The project description. The description can be 1 to 256 characters in length. Default value: empty.', + 'enumValueTitles' => [], '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, + 'example' => 'immtest', + 'title' => '', ], ], [ - 'name' => 'CreateTimeRange', + 'name' => 'ServiceRole', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The time range in which stories were created.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/TimeRange', - ], + 'schema' => ['description' => 'The service role that grants IMM permissions to access other Alibaba Cloud resources such as Object Storage Service (OSS). Default value: `AliyunIMMDefaultRole`.'."\n" + ."\n" + .'To customize a service role, create a regular service role in the Resource Access Management (RAM) console and grant permissions to the role. For more information, see [Grant permissions to a role](~~477258~~).', 'type' => 'string', 'required' => false, 'example' => 'AliyunIMMDefaultRole', 'title' => ''], ], [ - 'name' => 'StoryStartTimeRange', + 'name' => 'TemplateId', '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', - ], + 'schema' => ['description' => 'The workflow template ID. Default value: empty. For more information, see [Workflow templates and operators](~~466304~~).', 'type' => 'string', 'required' => false, 'example' => 'Official:ImageManagement', 'title' => ''], ], [ - 'name' => 'StoryEndTimeRange', + 'name' => 'ProjectMaxDatasetCount', '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', - ], + 'schema' => ['description' => 'The maximum number of datasets in the project. Valid values: 1 to 1000000000. Default value: 1000000000.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000000000', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'DatasetMaxBindCount', '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****', - ], + 'schema' => ['description' => 'The maximum number of bindings per dataset. Valid values: 1 to 10. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'DatasetMaxFileCount', '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', - ], + 'schema' => ['description' => 'The maximum number of files per dataset. Valid values: 1 to 100000000. Default value: 10000000000.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000000', 'title' => ''], ], [ - 'name' => 'CustomLabels', + 'name' => 'DatasetMaxEntityCount', 'in' => 'query', - 'schema' => [ - 'description' => 'The custom labels in key-value pairs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key=value', - ], + 'schema' => ['description' => 'The maximum number of metadata entities per dataset. Default value: 10000000000.'."\n" + .'>This parameter is reserved for future use and is not enforced.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000000000', 'title' => ''], ], [ - 'name' => 'WithEmptyStories', + 'name' => 'DatasetMaxRelationCount', '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', - ], + 'schema' => ['description' => 'The maximum number of metadata relationships per dataset. Default value: 100000000000.'."\n" + .'>This parameter is reserved for future use and is not enforced.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000000000', 'title' => ''], ], [ - 'name' => 'Sort', + 'name' => 'DatasetMaxTotalFileSize', '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', - ], + 'schema' => ['description' => 'The maximum total file size per dataset. After this limit is reached, no more indexes can be added. Unit: bytes. Default value: 90000000000000000.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '90000000000000000', 'title' => ''], ], [ - 'name' => 'Order', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The sort order. Valid values:'."\n" - ."\n" - .'* asc: in ascending order.'."\n" - .'* desc: in descending order.'."\n", - 'type' => 'string', + 'description' => 'The list of tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag information.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'asc', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response struct.', '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****', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7F7D235C-76FF-4B65-800C-8238AE3F****'], + 'Project' => ['description' => 'The project information. Click Project to view details.', '$ref' => '#/components/schemas/Project', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], + 500 => [], ], - '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', + 'title' => 'Create a project', + 'summary' => 'Creates a project.', + 'description' => '* Project names must be unique within the same region.'."\n" + .'* The number of projects that can be created is limited. By default, you can create up to 100 projects. To increase the quota, submit a ticket or search for DingTalk group 88490020073 to join the group and submit a request.'."\n" + .'* After you create a project, you can create other Intelligent Media Management (IMM) resources:'."\n" + .' + [Create a dataset](~~478160~~)'."\n" + .' + [Create a trigger](~~479912~~)'."\n" + .' + [Create a batch task](~~606694~~)'."\n" + .' + [Create a binding task](~~478202~~)', + 'changeSet' => [ + ['createdAt' => '2024-05-23T03:29:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-02-28T03:44:04.000Z', 'description' => 'Response parameters changed, Error codes changed'], + ['createdAt' => '2021-06-15T02:14:20.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProject'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F7D235C-76FF-4B65-800C-8238AE3F****\\",\\n \\"Project\\": {\\n \\"ProjectName\\": \\"immtest\\",\\n \\"ServiceRole\\": \\"AliyunIMMDefaultRole\\",\\n \\"TemplateId\\": \\"Official:ImageManagement\\",\\n \\"CreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"UpdateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"Description\\": \\"test project\\",\\n \\"ProjectQueriesPerSecond\\": 100,\\n \\"EngineConcurrency\\": 100,\\n \\"ProjectMaxDatasetCount\\": 1000000000,\\n \\"DatasetMaxBindCount\\": 10,\\n \\"DatasetMaxFileCount\\": 100000000,\\n \\"DatasetMaxEntityCount\\": 10000000000,\\n \\"DatasetMaxRelationCount\\": 100000000000,\\n \\"DatasetMaxTotalFileSize\\": 90000000000000000,\\n \\"DatasetCount\\": 5,\\n \\"FileCount\\": 10,\\n \\"TotalFileSize\\": 100000,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"TestKey\\",\\n \\"TagValue\\": \\"TestValue\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'CreateSimilarImageClusteringTask' => [ + 'summary' => 'The similar image clustering feature groups images that you have indexed in a dataset into clusters based on visual similarity. This feature is useful for scenarios such as deduplicating images or selecting the best shots. For example, you can use it to filter burst photos in an album.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '102496', - 'abilityTreeNodes' => [ - 'FEATUREimmPQ568C', - ], + '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', - ], + 'schema' => ['description' => 'The name of the project. For more information, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ 'name' => 'DatasetName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the dataset.[](~~478160~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-dataset', - ], + 'schema' => ['description' => 'The name of the dataset. For more information, see [Create a dataset](~~478160~~).', 'type' => 'string', 'required' => true, 'example' => 'test-dataset', 'title' => ''], ], [ - 'name' => 'ObjectId', + 'name' => 'UserData', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the story.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'id1', - ], + 'schema' => ['description' => 'The custom information. This information is returned in the asynchronous notification message to help you associate the message with your system. The value can be up to 2,048 bytes in length.', 'type' => 'string', 'required' => false, 'example' => 'test-data', 'title' => ''], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The custom tags that are used to search for and filter asynchronous tasks.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "User": "Jane"'."\n" + .'}', 'title' => ''], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The configuration of the notification message. For more information, click Notification. For more information about the format of asynchronous notification messages, see [Asynchronous notification messages](~~2743997~~).', '$ref' => '#/components/schemas/Notification', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The information about the similar image clustering task.', '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', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****'], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'SimilarImageClustering-48d0a0f3-8459-47f4-b8af-ff49c64****', 'title' => ''], + 'EventId' => ['description' => 'The event ID.', 'type' => 'string', 'example' => '3BF-1UhtFyrua71eOkFlqYq23Co****', 'title' => ''], ], + 'example' => '', ], ], ], - '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', + '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 calling this operation, review the billing methods and [pricing](~~477042~~) of Intelligent Media Management (IMM).**'."\n" + .' ><notice>The execution time of asynchronous tasks is not guaranteed.></notice>'."\n" + ."\n" + .'- Before calling this operation, index files to a dataset. You can index files by attaching a data source using [CreateBinding](~~478202~~), or by actively indexing files using [IndexFileMeta](~~478166~~) or [BatchIndexFileMeta](~~478167~~).'."\n" + ."\n" + .'- Each call to this operation **incrementally** processes the files in the specified `Dataset`. You can call this operation periodically to process new files.'."\n" + ."\n" + .'- After clustering completes, call the [QuerySimilarImageClusters](~~611304~~) operation to retrieve the clustering results.'."\n" + ."\n" + .'- Each similar image cluster must contain at least two images. Deleting a file from a dataset changes the similar image clusters. If deleting an image reduces a cluster to fewer than two images, the cluster is automatically deleted.'."\n" + ."\n" + .'- This operation is asynchronous. After a task starts, its information is retained for only seven days. You cannot query the information after this period. Call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation and use the returned `TaskId` to view task information. You can also set the [Notification](~~2743997~~) parameter to receive asynchronous notification messages about the task.', + 'changeSet' => [ + ['createdAt' => '2023-04-03T02:37:22.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSimilarImageClusteringTask'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateSimilarImageClusteringTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + ], + ], + 'CreateStory' => [ + 'summary' => 'Creates a story.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', - 'abilityTreeCode' => '156038', - 'abilityTreeNodes' => [ - 'FEATUREimmPQ568C', - ], + 'abilityTreeCode' => '103261', + 'abilityTreeNodes' => ['FEATUREimmPQ568C'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the project.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'immtest', - ], + 'schema' => ['description' => 'The name of the project. For more information, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ 'name' => 'DatasetName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the dataset.[](~~478160~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dataset001', - ], + 'schema' => ['description' => 'The name of the dataset. For more information, see [Create a dataset](~~478160~~).', 'type' => 'string', 'required' => true, 'example' => 'test-dataset', 'title' => ''], ], [ - 'name' => 'StoryType', + 'name' => 'ObjectId', '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', - ], + 'schema' => ['description' => 'The ID for the story object. This parameter is optional. If you do not specify an ID, IMM generates one. You can use the story ID to query or update the story. If you specify an ID that already exists, the corresponding story is updated.', 'type' => 'string', 'required' => false, 'example' => 'id1', 'title' => ''], ], [ - 'name' => 'StorySubType', + 'name' => 'StoryType', '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', - ], + 'schema' => ['description' => 'The type of the story to generate. For more information about story types and their valid values, see [Story types and subtypes](~~2743998~~).', 'type' => 'string', 'required' => true, 'example' => 'PeopleMemory', 'title' => ''], ], [ - 'name' => 'StoryName', + 'name' => 'StorySubType', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the story.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'name1', - ], + 'schema' => ['description' => 'The subtype of the story to generate. For more information about story subtypes and their valid values, see [Story types and subtypes](~~2743998~~).', 'type' => 'string', 'required' => false, 'example' => 'Solo', 'title' => ''], ], [ - 'name' => 'Cover', + 'name' => 'StoryStartTime', '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, - ], + 'schema' => ['description' => 'The start time of the photo collection for the story. This parameter and StoryEndTime define a time range. IMM filters candidate photos within this time range to generate the story. The value must be a string in the RFC 3339 format.', 'type' => 'string', 'required' => false, 'example' => '2016-12-30T16:00:00Z', 'title' => ''], ], [ - 'name' => 'Files', + 'name' => 'StoryEndTime', '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, - ], + 'schema' => ['description' => 'The end time of the photo collection for the story. This parameter and StoryStartTime define a time range. IMM filters candidate photos within this time range to generate the story. The value must be a string in the RFC 3339 format.', 'type' => 'string', 'required' => false, 'example' => '2021-12-30T16:00:00Z', 'title' => ''], ], [ - 'name' => 'CustomLabels', + 'name' => 'StoryName', '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"}', - ], + 'schema' => ['description' => 'The name of the story.', 'type' => 'string', 'required' => false, 'example' => 'name1', 'title' => ''], ], - ], - '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', + 'name' => 'MinFileCount', + 'in' => 'formData', + 'schema' => ['description' => 'The minimum number of photos in the generated story. The actual number of photos is between the values of MinFileCount and MaxFileCount. The value must be an integer greater than 1. If the number of available candidate photos is less than this value, an empty story is returned.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'ProjectName', + 'name' => 'MaxFileCount', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'immtest', - ], + 'schema' => ['description' => 'The maximum number of photos in the generated story. The actual number of photos is between the values of MinFileCount and MaxFileCount. The value must be an integer greater than the value of MinFileCount. To ensure the quality of the generated story, the internal algorithm limits the maximum number of photos to 1,500. If you set MaxFileCount to a value greater than 1,500, the setting does not take effect.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'title' => ''], ], [ - 'name' => 'DatasetName', + 'name' => 'NotifyTopicName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the dataset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testdata', - ], + 'schema' => ['description' => 'The name of the topic for asynchronous notifications.', 'type' => 'string', 'required' => false, 'example' => 'test-topic', 'title' => ''], ], [ - 'name' => 'ObjectId', + 'name' => 'CustomLabels', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the story.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testid', - ], + 'style' => 'json', + 'schema' => ['description' => 'The custom labels. These labels contain custom information about the story and can be used for retrieval.', 'type' => 'object', 'required' => false, 'example' => '{"Bucket": "examplebucket"}', 'title' => ''], ], [ - 'name' => 'StoryName', + 'name' => 'CustomId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the story.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'newstory', - ], + 'schema' => ['description' => 'A custom identifier for the story. This ID can be different from ObjectId. You can use this ID to retrieve or sort stories.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'Cover', + 'name' => 'Address', '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, - ], + 'schema' => ['description' => 'The address information for the story. IMM filters photos whose shooting locations match the specified address to generate the story. This parameter takes effect only when StoryType is set to TravelMemory.'."\n" + ."\n" + .'> Due to regulatory requirements, parsing GPS information into addresses is not supported in Hong Kong (China), Macao (China), Taiwan (China), or regions outside of mainland China.', '$ref' => '#/components/schemas/AddressForStory', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'CustomLabels', - 'in' => 'formData', + 'name' => 'Tags', + 'in' => 'query', 'style' => 'json', - 'schema' => [ - 'description' => 'The custom tags. You can specify up to 100 custom tags.'."\n", - 'type' => 'object', - 'required' => false, - 'example' => '{"key": "value"}', - ], + 'schema' => ['description' => 'This parameter provides a tagging mechanism that can be used in the following scenarios:'."\n" + ."\n" + .'- Set custom data that is returned in MNS messages.'."\n" + ."\n" + .'- Use as a search condition to search for tasks.'."\n" + ."\n" + .'- Use as a variable in TargetURI.', 'type' => 'object', 'required' => false, 'example' => '{"key":"val"}', 'title' => ''], ], [ - 'name' => 'CustomId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The custom ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'name' => 'UserData', + 'in' => 'query', + 'schema' => ['description' => 'The custom information that is returned in an asynchronous notification message. You can use this information to associate the notification message with your services. The maximum length is 2,048 bytes.', 'type' => 'string', 'required' => false, 'example' => '{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"}', 'title' => ''], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The notification configuration. For more information about the format of asynchronous notification messages, see [Asynchronous notification message format](~~2743997~~).', '$ref' => '#/components/schemas/Notification', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The schema for the response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****'], + 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => 'CreateStory-4ef6ff43-edf3-4612-9cc4-0c7f9e19****', 'title' => ''], + 'EventId' => ['description' => 'The ID of the event.', 'type' => 'string', 'example' => '392-1CqzvESGTEeNZ2OWFbRKIM****', 'title' => ''], ], + 'example' => '', ], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\",\\n \\"TaskId\\": \\"CreateStory-4ef6ff43-edf3-4612-9cc4-0c7f9e19****\\",\\n \\"EventId\\": \\"392-1CqzvESGTEeNZ2OWFbRKIM****\\"\\n}","type":"json"}]', + 'title' => 'CreateStory', + 'description' => '- **Before calling this operation, understand the billing methods and [pricing](~~477042~~) of Intelligent Media Management (IMM).**'."\n" + ."\n" + .'- Before calling this operation, index files to a dataset by calling [CreateBinding](~~478202~~), [IndexFileMeta](~~478166~~), or [BatchIndexFileMeta](~~478167~~).'."\n" + ."\n" + .'- This is an asynchronous operation. After a task starts, its information is saved for only 7 days. The information cannot be retrieved after this period. Call [GetTask](~~478241~~) or [ListTasks](~~478242~~) with the returned TaskId to view task information. Alternatively, set the [Notification](~~2743997~~) parameter to obtain task information from notification messages.', + 'changeSet' => [ + ['createdAt' => '2023-03-09T10:57:42.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-11-15T08:49:30.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ['createdAt' => '2022-08-16T06:44:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-16T06:44:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-02-24T06:44:23.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-31T07:38:30.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStory'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateStory', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], ], + ], + 'CreateTrigger' => [ + 'summary' => 'Creates a trigger to start data processing in Intelligent Media Management (IMM). The trigger is activated by event sources, such as Object Storage Service (OSS), and uses data processing templates to process media files, such as images, videos, and documents.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', - 'abilityTreeCode' => '142648', - 'abilityTreeNodes' => [ - 'FEATUREimmPQ568C', - ], + 'abilityTreeCode' => '135761', + 'abilityTreeNodes' => ['FEATUREimmJ1ILHI'], ], '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', - ], + 'schema' => ['description' => 'The project name. For more information, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'DatasetName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the dataset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-dataset', - ], - ], - [ - 'name' => 'ObjectId', + 'name' => 'Input', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the story.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testid', - ], + 'style' => 'json', + 'schema' => ['description' => 'The data source configuration.', 'required' => true, '$ref' => '#/components/schemas/Input', 'title' => '', 'example' => ''], ], [ - 'name' => 'Files', + 'name' => 'Actions', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The objects that you want to add.'."\n", + 'description' => 'A list of data processing templates.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the object.'."\n", + 'description' => 'The template information.', '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', + 'Name' => ['description' => 'The name of the template.', 'type' => 'string', 'required' => true, 'example' => 'doc/convert', 'title' => ''], + 'Parameters' => [ + 'description' => 'A list of template parameters.', + 'type' => 'array', + 'items' => ['description' => 'A template parameter.', 'type' => 'string', 'required' => false, 'example' => 'pages=3', 'title' => ''], 'required' => false, - 'example' => 'oss://test-bucket/test-object', + 'title' => '', + 'example' => '', ], + 'FastFailPolicy' => ['description' => 'The fast-fail policy configuration.', '$ref' => '#/components/schemas/FastFailPolicy', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => true, + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'Notification', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The notification recipient. Various message intermediaries are supported. For details about the message format, see Asynchronous notification message. Choose one of the following methods to receive messages:'."\n" + ."\n" + .'Activate and connect to EventBridge in the same region as Intelligent Media Management (IMM) to receive task notifications. For more information, see IMM events. Activate Message Service (MNS) in the same region as IMM and configure a subscription.', '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.', - ], - ], - ], - ], + 'MNS' => ['description' => 'The parameter object for MNS notifications.', '$ref' => '#/components/schemas/MNS', 'required' => false, 'title' => '', 'example' => ''], ], - ], - ], - ], - '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', + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ObjectId', + 'name' => 'Tags', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the story.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testid', - ], + 'style' => 'json', + 'schema' => ['description' => 'Custom tags used to search and filter asynchronous tasks.', 'type' => 'object', 'required' => false, 'example' => '{"key":"val"}', 'title' => ''], ], [ - 'name' => 'Files', + 'name' => 'ServiceRole', '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, - ], + 'schema' => ['description' => 'The service role that grants Intelligent Media Management (IMM) permissions to access other cloud resources, such as Object Storage Service (OSS). The default value is AliyunIMMBatchTriggerRole.'."\n" + ."\n" + .'To use a custom service role, create a service role and grant permissions to the role in the Resource Access Management (RAM) console. For more information, see [Create a service role](~~116800~~) and [Grant permissions to a RAM role](~~116147~~).', 'type' => 'string', 'required' => true, 'example' => 'AliyunIMMBatchTriggerRole', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EC564A9A-BA5C-4499-A087-D9B9E76E*****', 'title' => ''], + 'Id' => ['description' => 'The data ingestion ID.', 'type' => 'string', 'example' => 'trigger-9f72636a-0f0c-4baf-ae78-38b27b******', 'title' => ''], ], + 'example' => '', ], ], ], - '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' => [], - ], + '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' => 'To process data from [Object Storage Service](~~99372~~), ensure that you have [attached an OSS bucket](~~478206~~).', + 'changeSet' => [ + ['createdAt' => '2023-07-05T05:47:24.000Z', 'description' => 'Request parameters changed'], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '102497', - 'abilityTreeNodes' => [ - 'FEATUREimmPQ568C', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTrigger'], ], ], - 'parameters' => [ - [ - 'name' => 'ProjectName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the project.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'immtest', - ], - ], + 'ramActions' => [ [ - '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****', - ], + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateTrigger', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Trigger', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/trigger/*'], ], ], ], ], - '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', - ], + 'CreateVideoLabelClassificationTask' => [ + 'summary' => 'Detects labels for scenarios, objects, and events in video content. This feature supports more than 30 categories and thousands of labels. Scenario labels include natural landscapes, life scenes, and disaster scenes. Event labels include talent shows, office work, performances, and production. Object labels include tableware, electronic products, furniture, and vehicles.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', - 'abilityTreeCode' => '161810', - 'abilityTreeNodes' => [ - 'FEATUREimm8BY6HG', - ], + 'abilityTreeCode' => '157766', + 'abilityTreeNodes' => ['FEATUREimmQZSDER'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the project.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['description' => 'The project name. For more information about how to obtain the project name, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'immtest'], ], [ - 'name' => 'DatasetName', + 'name' => 'SourceURI', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the dataset.[](~~478160~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-dataset', - ], + 'schema' => ['title' => 'SourceURI', 'description' => 'The Object Storage Service (OSS) URI of the video.'."\n" + ."\n" + .'The OSS URI must follow the format oss\\://${Bucket}/${Object}. ${Bucket} is the name of the OSS bucket that is in the same region as the current project. ${Object} is the full path of the file, including the file name extension.', 'type' => 'string', 'required' => true, 'example' => 'oss://bucket1/object.mp4'], ], [ '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', - ], + 'schema' => ['title' => 'UserData', 'description' => 'Custom information. This information is returned in the asynchronous notification message. You can use this information to associate the notification message with your services. The maximum length is 2,048 bytes.', 'type' => 'string', 'example' => '{'."\n" + .' "ID": "testuid",'."\n" + .' "Name": "test-user",'."\n" + .' "Avatar": "http://test.com/testuid"'."\n" + .'}', 'required' => false], ], [ '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" - .'}', - ], + 'schema' => ['description' => 'Custom tags that you can use to search for and filter asynchronous tasks.', 'type' => 'object', 'required' => false, 'example' => '{"test":"val1"}', 'title' => ''], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => '**If you do not have special requirements, leave this parameter empty.**'."\n" + ."\n" + .'The chained authorization configuration. This parameter is not required. For more information, see [Use chained authorization to access resources of other entities](~~465340~~).', '$ref' => '#/components/schemas/CredentialConfig', 'required' => false, 'title' => '', 'example' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The message notification configuration. For more information, click Notification. For more information about the format of asynchronous notification messages, see [Asynchronous notification message format](~~2743997~~).', '$ref' => '#/components/schemas/Notification', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The information about the image clustering task.'."\n", + 'title' => '', + 'description' => 'The response struct for creating a video label detection task.', '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****', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6'], + 'EventId' => ['description' => 'The event ID of the task. You can use this ID to query task information notifications in the [EventBridge](https://www.aliyun.com/product/aliware/eventbridge) service.', 'type' => 'string', 'title' => '', 'example' => '03F-1Qt1Yn5RZZ0Zh3ZdYlDblv7****'], + 'TaskId' => ['description' => 'The ID of the task. You can use the [GetTask](~~478241~~) operation to view task information or the [GetVideoLabelClassificationResult](~~478224~~) operation to obtain the results of the video label detection task.', 'type' => 'string', 'title' => '', 'example' => 'VideoLabelClassification-2f157087-91df-4fda-8c3e-232407ec*****'], ], + 'example' => '', ], ], + 500 => [], ], - '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" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6\\",\\n \\"EventId\\": \\"03F-1Qt1Yn5RZZ0Zh3ZdYlDblv7****\\",\\n \\"TaskId\\": \\"VideoLabelClassification-2f157087-91df-4fda-8c3e-232407ec*****\\"\\n}","type":"json"}]', + 'title' => 'CreateVideoLabelClassificationTask', + 'description' => '- **Before you call this operation, make sure that you understand the billing methods and [pricing](~~2747104~~) of Intelligent Media Management.**'."\n" ."\n" - .' **Note that** Asynchronous processing does not guarantee timely task completion.'."\n" + .'- Before you call this operation, make sure that you have created a project in Intelligent Media Management. For more information, see [Create a project](~~478153~~).'."\n" + ."\n\n" + .' ><notice>'."\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" + .' The completion time of asynchronous tasks is not guaranteed.'."\n" ."\n" - .'* Each call to the operation incrementally processes metadata in the dataset.****`` You can regularly call this operation to process incremental files.'."\n" + .' ></notice>'."\n" ."\n" - .'* After clustering is completed, you can call the [QuerySimilarImageClusters](~~611304~~) operation to query image clustering results.'."\n" + .'- For more information about the features of this operation, see [Video label detection](~~477189~~).'."\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" + .'- 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", - ], - 'QuerySimilarImageClusters' => [ - 'summary' => 'You can call this operation to query the list of similar image clusters.', - 'methods' => [ - 'get', - 'post', + .'- This is an asynchronous operation. After a task starts, its information is stored for seven days. You cannot retrieve the information after this period. Call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation with the returned `TaskId` to view task information. You can also set the [Notification](~~2743997~~) parameter to receive task information through message notifications.', + 'changeSet' => [ + ['createdAt' => '2023-04-03T02:37:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-09T10:57:40.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateVideoLabelClassificationTask'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateVideoLabelClassificationTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + ], + ], + 'CreateVideoModerationTask' => [ + 'summary' => 'Detects threats or non-compliant content in videos. This operation can be used in scenarios such as pornography detection, terrorism and politically sensitive content detection, text and image violation detection, undesirable scene detection, and logo detection.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14212,194 +8788,187 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '161811', - 'abilityTreeNodes' => [ - 'FEATUREimm8BY6HG', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '130694', + 'abilityTreeNodes' => ['FEATUREimmO3TV2W'], ], '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', - ], + 'schema' => ['description' => 'The name of the project. For more information about how to get the project name, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'immtest'], ], [ - 'name' => 'DatasetName', + 'name' => 'UserData', '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', - ], + 'schema' => ['description' => 'Custom information that is returned in the asynchronous notification message. Use this information to associate the notification message with your internal system. The maximum length is 2,048 bytes.', 'type' => 'string', 'required' => false, 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'SourceURI', '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****', - ], + 'schema' => ['description' => 'The OSS URI of the video.'."\n" + ."\n" + .'The OSS URI must follow the format oss\\://${Bucket}/${Object}. `${Bucket}` is the name of the OSS bucket in the same region as the project. `${Object}` is the full path of the file, including the file name extension.', 'type' => 'string', 'required' => true, 'example' => 'oss://test-bucket/test-object', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'Tags', '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', - ], + 'style' => 'json', + 'schema' => ['description' => 'Custom tags used to search for tasks.', 'type' => 'object', 'required' => false, 'example' => '{"test": "val1"}', 'title' => ''], ], [ - 'name' => 'CustomLabels', + 'name' => 'CredentialConfig', 'in' => 'query', - 'schema' => [ - 'description' => 'The custom tags, which are used to filter tasks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"key": "val"}', - ], + 'style' => 'json', + 'schema' => ['description' => 'The chained authorization configuration. This parameter is optional. For more information, see [Use chained authorization to access resources of other entities](~~465340~~).', '$ref' => '#/components/schemas/CredentialConfig', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'Sort', + 'name' => 'Scenes', 'in' => 'query', + 'style' => 'json', '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', + 'description' => 'The video detection scenarios.', + 'type' => 'array', + 'items' => [ + 'description' => 'The video detection scenario. Valid values:'."\n" + ."\n" + .'- porn: Pornography detection.'."\n" + ."\n" + .'- terrorism: Terrorism and politically sensitive content detection.'."\n" + ."\n" + .'- live: Undesirable scene detection.'."\n" + ."\n" + .'- logo: Logo detection.'."\n" + ."\n" + .'- ad: Text and image violation detection.'."\n" + ."\n" + .'> If you do not specify a detection scenario, the `porn`, `terrorism`, and `ad` scenarios are used by default.', + 'enumValueTitles' => ['ad' => 'Text and image violation detection', 'terrorism' => 'Terrorism and politically sensitive content detection', 'logo' => 'Logo detection', 'live' => 'Undesirable scene detection', 'porn' => 'Pornography detection'], + 'type' => 'string', + 'required' => false, + 'example' => 'porn', + 'title' => '', + ], 'required' => false, - 'enumValueTitles' => [], - 'example' => 'UpdateTime', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Order', + 'name' => 'Interval', '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', - ], + 'schema' => ['description' => 'The interval for video snapshots, in seconds. The value can be an integer from 1 to 600. The default value is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'MaxFrames', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of frames that can be captured for this detection task. The value can be an integer from 5 to 3,600. The default value is 200.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200', 'title' => ''], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The notification configuration. For the format of asynchronous notification messages, see the metadata index section in [Asynchronous notification message format](~~2743997~~).', '$ref' => '#/components/schemas/Notification', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response struct.', '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****', - ], + 'RequestId' => ['title' => 'RequestId', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****'], + 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => 'VideoModeration-9442a216-4691-4a48-846d-76daccaf*****', 'title' => ''], + 'EventId' => ['description' => 'The ID of the event.', 'type' => 'string', 'example' => '2E6-1I0FGn0zFnl5AflRfhzClma*****', 'title' => ''], ], + 'example' => '', ], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\",\\n \\"TaskId\\": \\"VideoModeration-9442a216-4691-4a48-846d-76daccaf*****\\",\\n \\"EventId\\": \\"2E6-1I0FGn0zFnl5AflRfhzClma*****\\"\\n}","type":"json"}]', + 'title' => 'CreateVideoModerationTask', + 'description' => '- **Before you use this operation, make sure that you understand the billing methods and [pricing](~~88317~~) of Intelligent Media Management.**'."\n" + ."\n\n" + .' ><notice>'."\n" + ."\n" + .' The completion time of asynchronous tasks is not guaranteed.'."\n" + ."\n" + .' ></notice>'."\n" + ."\n" + .'- The detection results are returned in an asynchronous notification message. The Suggestion field in the asynchronous notification message can have the following values:'."\n" + ."\n" + .' - pass: The video passed the review. No non-compliant content was detected.'."\n" + ."\n" + .' - block: The video must be blocked. This value is returned when non-compliant content is detected. The Categories field indicates the category of the non-compliant content. For more information about the categories, see [Content Moderation detection results](~~2743995~~).'."\n" + ."\n" + .' - review: The video requires manual review. After the manual review is complete, another asynchronous notification message is sent with the result.'."\n" + ."\n" + .'- Video snapshot requirements:'."\n" + ."\n" + .' - Video frame URLs support the HTTP and HTTPS protocols.'."\n" + ."\n" + .' - Supported video frame formats: PNG, JPG, JPEG, BMP, GIF, and WEBP.'."\n" + ."\n" + .' - The size of a video frame cannot exceed 10 MB.'."\n" + ."\n" + .' - The recommended resolution for video frames is at least 256 × 256 pixels. A lower resolution may affect detection accuracy.'."\n" + ."\n" + .' - The response time for the video detection operation depends on the download time of the video frames. Make sure that the storage service for your video frames is stable and reliable. We recommend that you use Alibaba Cloud Object Storage Service (OSS) or cache frames with Alibaba Cloud CDN.'."\n" + ."\n" + .'- This is an asynchronous operation. After a task is created, the task information is saved for only 7 days. After this period, the information cannot be retrieved. You can call the [GetTask](~~478241~~) or [ListTasks](~~478242~~) operation to query the task information using the returned `TaskId`. You can also set the [Notification](~~2743997~~) parameter to receive task information through asynchronous notification messages.', + 'changeSet' => [ + ['createdAt' => '2024-04-19T09:43:53.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-08-21T03:51:46.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-03T02:37:21.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-09T10:57:42.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-08-16T06:44:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-16T06:44:22.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateVideoModerationTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateVideoModerationTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + ], + 'DeleteBatch' => [ + 'summary' => 'Deletes a batch processing task.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '18909', - 'abilityTreeNodes' => [ - 'FEATUREimmSZD9WY', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '131141', + 'abilityTreeNodes' => ['FEATUREimmTATRRB'], ], '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', - ], + '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', 'title' => ''], ], [ - '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', - ], + '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' => [ @@ -14409,239 +8978,179 @@ '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', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '91AC8C98-0F36-49D2-8290-742E24******'], ], + 'example' => '', ], ], ], - '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', + '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", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteBatch'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imm:DeleteBatch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Batch', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/batch/*'], + ], + ], + ], ], + ], + 'DeleteBinding' => [ + 'summary' => 'Deletes the binding between a dataset and an Object Storage Service (OSS) bucket.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '33029', - 'abilityTreeNodes' => [ - 'FEATUREimmSZD9WY', - ], + 'abilityTreeCode' => '38133', + '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', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).', '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' => 'dataset001', - ], + 'schema' => ['description' => 'The name of the dataset. For more information, see [Create a dataset](~~478160~~).', 'type' => 'string', 'required' => false, 'example' => 'test-dataset', 'title' => ''], ], [ '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', - ], + '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.', 'type' => 'string', 'required' => false, 'example' => 'oss://test-bucket', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The returned data.'."\n", + 'description' => 'Schema of Response', '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', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ACDFE467-C817-4B36-951A-6EB5A592****'], ], + 'example' => '', ], ], ], - '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', + 'title' => 'DeleteBinding', + 'description' => '- Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).\\*\\*\\*\\*'."\n" + ."\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.', + 'changeSet' => [ + ['createdAt' => '2023-07-20T08:51:03.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteBinding'], + ], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imm:DeleteBinding', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '10879', - 'abilityTreeNodes' => [ - 'FEATUREimmSZD9WY', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ACDFE467-C817-4B36-951A-6EB5A592****\\"\\n}","type":"json"}]', + ], + 'DeleteDataset' => [ + 'summary' => 'Deletes a dataset.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], ], ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete'], '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', - ], + 'schema' => ['description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", 'type' => 'string', 'required' => true, 'example' => 'immtest', 'title' => ''], ], [ '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', - ], + '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', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结构体', + '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' => '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', - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EC564B8B-BA5C-4499-B196-D9B9E76E****'], ], + 'example' => '', ], ], ], - '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', + '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", + 'changeSet' => [ + ['createdAt' => '2021-06-15T02:14:12.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDataset'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imm:DeleteDataset', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], ], + ], + 'DeleteFileMeta' => [ + 'summary' => 'Removes the metadata of a file from a dataset.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14651,390 +9160,248 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', - 'abilityTreeCode' => '38133', - 'abilityTreeNodes' => [ - 'FEATUREimmSZD9WY', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '33169', + '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', - ], + 'schema' => ['description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The name of the dataset. For more information, see [Create a dataset](~~478160~~).'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-datset', 'title' => ''], ], [ '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', - ], + '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://test-bucket/test-object', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ACDFE467-C817-4B36-951A-6EB5A592****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7F82D6C9-5AC0-49F9-914D-F02678F3****'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ACDFE467-C817-4B36-951A-6EB5A592****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DeleteBinding', + '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" - .'* 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', + .'* 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", + 'changeSet' => [ + ['createdAt' => '2021-06-15T02:14:00.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFileMeta'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imm:DeleteFileMeta', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], ], + ], + 'DeleteLocationDateCluster' => [ + 'summary' => 'Deletes a spatiotemporal cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '135038', - 'abilityTreeNodes' => [ - 'FEATUREimmKH590Y', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '158363', + 'abilityTreeNodes' => ['FEATUREimmPECUUL'], ], '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', - ], + 'schema' => ['description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'OSSBucket', + 'name' => 'DatasetName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the OSS bucket in the same region as the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'examplebucket', - ], + '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', 'title' => ''], ], [ - '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', - ], + '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', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结构体', - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The data struct returned.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5F74C5C9-5AC0-49F9-914D-E01589D3****', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B121940C-9794-4EE3-8D6E-F8EC525F****', 'title' => ''], ], + 'example' => '', ], ], ], - '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', + '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", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLocationDateCluster'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imm:DeleteLocationDateCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], ], + ], + 'DeleteProject' => [ + 'summary' => 'Deletes a project.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'delete', - 'abilityTreeCode' => '135041', - 'abilityTreeNodes' => [ - 'FEATUREimmKH590Y', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREimmKH590Y'], ], 'parameters' => [ [ - 'name' => 'OSSBucket', + 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => 'The OSS bucket that you want to unbind.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'examplebucket', - ], + 'schema' => ['description' => 'The name of the project. For more information, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'immtest'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结构体', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5F74C5C9-5AC0-49F9-914D-E01589D3****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'FEDC9B1F-30F2-4C1F-8ED2-B7860187****'], ], + 'example' => '', ], ], ], - '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' => [], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'StatusConflict', 'errorMessage' => 'Message: cannot delete when sub resoures exist', 'description' => ''], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '135040', - 'abilityTreeNodes' => [ - 'FEATUREimmKH590Y', - ], + '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" + ."\n" + .'- After a project is deleted, all resources used by the project are recycled, and all related data is lost and cannot be recovered.', + 'changeSet' => [ + ['createdAt' => '2024-03-01T02:19:27.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-02-28T03:44:04.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-06-15T02:14:20.000Z', 'description' => 'OpenAPI offline'], ], - 'parameters' => [ - [ - 'name' => 'OSSBucket', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the OSS bucket.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'examplebucket', - ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteProject'], ], ], - '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"', - ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imm:DeleteProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], ], - '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", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FEDC9B1F-30F2-4C1F-8ED2-B7860187****\\"\\n}","type":"json"}]', ], - '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', - ], + 'DeleteStory' => [ + 'summary' => 'Deletes a story.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '199817', - 'abilityTreeNodes' => [ - 'FEATUREimmSCVT08', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '102497', + 'abilityTreeNodes' => ['FEATUREimmPQ568C'], ], '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', - ], + 'schema' => ['description' => 'The name of the project.[](~~478153~~)'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - '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', + 'name' => 'DatasetName', 'in' => 'query', - 'schema' => [ - 'description' => 'The text content of watermarks. It can be up to 256 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The name of the dataset.[](~~478160~~)'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-dataset', 'title' => ''], ], [ - 'name' => 'StrengthLevel', + 'name' => 'ObjectId', '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', - ], + 'schema' => ['description' => 'The ID of the story to delete.'."\n", 'type' => 'string', 'required' => true, 'example' => 'id1', 'title' => ''], ], ], 'responses' => [ @@ -15044,234 +9411,104 @@ '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', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****', 'title' => ''], ], + 'example' => '', ], ], ], - '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', + '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", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteStory'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imm:DeleteStory', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], ], + ], + 'DeleteTrigger' => [ + 'summary' => 'Deletes a trigger.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '200063', - 'abilityTreeNodes' => [ - 'FEATUREimmSCVT08', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '135762', + 'abilityTreeNodes' => ['FEATUREimmJ1ILHI'], ], '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', - ], + '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', 'title' => ''], ], [ - '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' => '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' => 'Schema of Response'."\n", + 'description' => 'The response parameters.'."\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', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FEDC9B1F-30F2-4C1F-8ED2-B7860187****'], ], + 'example' => '', ], ], ], - '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', + '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", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTrigger'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imm:DeleteTrigger', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Trigger', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/trigger/*'], + ], + ], + ], ], + ], + 'DetachOSSBucket' => [ + 'summary' => 'Unbinds an Object Storage Service (OSS) bucket from the corresponding project.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15280,140 +9517,61 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'abilityTreeCode' => '204408', - 'abilityTreeNodes' => [ - 'FEATUREimmSCVT08', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '135041', + 'abilityTreeNodes' => ['FEATUREimmKH590Y'], ], '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', + 'name' => 'OSSBucket', '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****', - ], + 'schema' => ['description' => 'The OSS bucket that you want to unbind.'."\n", 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - ], + 'RequestId' => ['title' => 'RequestId', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5F74C5C9-5AC0-49F9-914D-E01589D3****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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", + 'changeSet' => [ + ['createdAt' => '2024-04-19T09:44:00.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-04-18T06:16:09.000Z', 'description' => 'OpenAPI offline'], ], - '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', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachOSSBucket'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imm:DetachOSSBucket', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + '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' => [], @@ -15423,105 +9581,88 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '82228', - 'abilityTreeNodes' => [ - 'FEATUREimmELX4L2', - ], + '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' => 'immimagetest', - ], + '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.'."\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', - ], + '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.jpg'], ], [ - 'name' => 'Threshold', + 'name' => 'Sensitivity', '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', - ], + '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', 'title' => ''], ], [ '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', - ], + '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', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '图片检测结果', + 'title' => '', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Labels' => [ - 'title' => '内容标签列表', - 'description' => 'The list of labels detected.'."\n", + 'Bodies' => [ + 'title' => '', + 'description' => 'The human bodies.'."\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', + 'items' => ['description' => 'The human body details.'."\n", '$ref' => '#/components/schemas/Body', 'title' => '', 'example' => ''], + 'example' => '', ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '501339F9-4B70-0CE2-AB8C-866C********'], ], + 'example' => '', ], ], 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', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Bodies\\": [\\n {\\n \\"Confidence\\": 0.82,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\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", + 'changeSet' => [ + ['createdAt' => '2022-07-19T02:09:12.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetectImageBodies'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:DetectImageBodies', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + ], + ], + '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' => [], @@ -15531,93 +9672,81 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '129324', - 'abilityTreeNodes' => [ - 'FEATUREimmEAXWFI', - ], + 'abilityTreeCode' => '172472', + 'abilityTreeNodes' => ['FEATUREimmIT7OSY'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'title' => '项目名称', - 'description' => 'The name of the project.[](~~477051~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'immtest', - ], + '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' => [ - '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', - ], + '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.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', - ], + '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', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结构体', + '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', - ], - ], + 'Cars' => [ + 'title' => '', + 'description' => 'The vehicles.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The vehicle.'."\n", '$ref' => '#/components/schemas/Car', 'title' => '', 'example' => ''], + 'required' => true, + 'minItems' => 0, + 'example' => '', ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A8745209-DD0E-027E-8ABA-085E0C******'], + ], + 'example' => '', + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Cars\\": [\\n {\\n \\"LicensePlates\\": [\\n {\\n \\"Content\\": \\"鲁A8***8\\",\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n },\\n \\"Confidence\\": 0.789\\n }\\n ],\\n \\"CarType\\": \\"van\\",\\n \\"CarTypeConfidence\\": 0.516,\\n \\"CarColor\\": \\"white\\",\\n \\"CarColorConfidence\\": 0.604,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n },\\n \\"Confidence\\": 0.999\\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", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetectImageCars'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:DetectImageCars', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], ], - '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', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15628,181 +9757,82 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '142280', - 'abilityTreeNodes' => [ - 'FEATUREimmSL7X1M', - ], + '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', - ], + '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' => true, - 'example' => 'oss://bucketname/objectname', - ], + '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://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', - ], + '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', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '图片二维码检测结果', + 'title' => '', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Codes' => [ - 'title' => '二维码检测结果', + 'title' => '', 'description' => 'The barcodes or QR codes.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The barcode or QR code information.'."\n", - '$ref' => '#/components/schemas/Codes', - ], + 'items' => ['description' => 'The barcode or QR code information.'."\n", '$ref' => '#/components/schemas/Codes', 'title' => '', 'example' => ''], 'required' => true, 'minItems' => 0, + 'example' => '', ], - 'RequestId' => [ - 'title' => '请求唯一ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****'], ], + 'example' => '', ], ], 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":""}]', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Codes\\": [\\n {\\n \\"Content\\": \\"https://www.example.com\\",\\n \\"Confidence\\": 0.9,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n },\\n \\"Type\\": \\"qrcode\\"\\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', + 'changeSet' => [ + ['createdAt' => '2022-07-07T06:44:30.000Z', 'description' => 'OpenAPI offline'], ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '129323', - 'abilityTreeNodes' => [ - 'FEATUREimmU4U2B0', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetectImageCodes'], ], ], - 'parameters' => [ - [ - 'name' => 'ProjectName', - 'in' => 'query', - 'schema' => [ - 'title' => '项目名称', - 'description' => 'The name of the project.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'immtest', - ], - ], + 'ramActions' => [ [ - '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', - ], - ], + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:DetectImageCodes', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], ], - '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', - ], + 'summary' => 'Detects visually optimal cropping regions in an image at a specified aspect ratio by using AI model capabilities.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15812,792 +9842,303 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', 'abilityTreeCode' => '133405', - 'abilityTreeNodes' => [ - 'FEATUREimm1NT5J6', - ], + 'abilityTreeNodes' => ['FEATUREimm1NT5J6'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'title' => '项目名称', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'immtest', - ], + 'schema' => ['title' => '', 'description' => 'The project name.', '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', - ], + 'schema' => ['title' => '', 'description' => 'The OSS URI of the image.'."\n" + ."\n" + .'The OSS URI follows the format oss://${Bucket}/${Object}, where `${Bucket}` is the name of an OSS bucket in the same region as the current project, and `${Object}` is the full path of the file including the file name extension.', '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"]', - ], + 'schema' => ['description' => 'The list of cropping aspect ratios. You can specify up to 5 ratios. Each ratio must meet the following requirements:'."\n" + ."\n" + .'- The ratio must consist of integers in the range of (0, 20).'."\n" + ."\n" + .'- The ratio value must be in the range of \\[0.5, 2].'."\n" + ."\n" + .'- If you do not specify this parameter, the default value `["auto"]` is used.'."\n" + ."\n" + .'> The following cases cause an error:<br>- More than 5 ratios are specified.<br>- An empty list is passed.<br>- The ratio contains non-integer values, such as `4.1:3`.<br>- The ratio value is less than 0.5 or greater than 2.', 'type' => 'string', 'required' => false, 'example' => '["1:1"]', 'title' => ''], ], [ 'name' => 'CredentialConfig', 'in' => 'query', 'style' => 'json', + 'schema' => ['description' => '**Leave this parameter empty unless otherwise required.**'."\n" + ."\n" + .'The China authorization configuration. This parameter is optional. For more information, see [Use chained authorization to access resources of other entities](~~465340~~).', '$ref' => '#/components/schemas/CredentialConfig', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'InclusionHints', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'json', 'schema' => [ - 'description' => '**If you have no special requirements, leave this parameter empty.**'."\n" + 'description' => 'The list of semantic text descriptions for objects that you want the cropping result to include. Each element is free-form text, such as "signboard" or "dish".'."\n" ."\n" - .'The authorization chain settings. For more information, see [Use authorization chains to access resources of other entities](~~465340~~).'."\n", + .'> Usage limits of the InclusionHints parameter:'."\n" + .'<br>- You can pass in up to 1 hint in the array to specify the type of object to include in the cropping result, such as "signboard".'."\n" + .'<br>- The algorithm detects all objects in the image that match the hint and generates cropping regions that include as many matched objects as possible.'."\n" + .'<br>- Each cropping region includes up to 10 matched objects. If more than 10 objects match in the image, the cropping region includes up to 10 of them.'."\n" + .'<br>- You can use the MatchedInclusionHints response field to determine whether the hint was successfully matched.'."\n" + .'<br>- This parameter is supported only in regions in the Chinese mainland.', + 'type' => 'array', + 'items' => ['description' => 'The semantic text description of an object that you want the cropping result to include.', 'type' => 'string', 'required' => false, 'example' => 'sign', 'title' => ''], 'required' => false, - '$ref' => '#/components/schemas/CredentialConfig', + 'example' => '["sign"]', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '图片裁剪结果', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The image cropping result.', 'type' => 'object', 'properties' => [ 'Croppings' => [ - 'title' => '图片裁剪结果', - 'description' => 'The image cropping suggestions.'."\n", + 'title' => '', + 'description' => 'The array of image cropping information.', 'type' => 'array', - 'items' => [ - 'description' => 'The image cropping details.'."\n", - '$ref' => '#/components/schemas/CroppingSuggestion', - ], + 'items' => ['description' => 'The detailed cropping information of the image.', '$ref' => '#/components/schemas/CroppingSuggestion', 'title' => '', 'example' => ''], + 'example' => '', ], - 'RequestId' => [ - 'title' => '请求唯一ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '91AC8C98-0F36-49D2-8290-742E24D*****', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '91AC8C98-0F36-49D2-8290-742E24D*****'], + 'MatchedInclusionHints' => [ + 'description' => 'The list of objects included in the cropping region, corresponding to the InclusionHints input parameter. This field is empty if no objects are included.', + 'type' => 'array', + 'items' => ['description' => 'The object included in the cropping region.', 'type' => 'string', 'example' => 'sign', 'title' => ''], + 'enumValueTitles' => [], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], 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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Croppings\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n }\\n }\\n ],\\n \\"RequestId\\": \\"91AC8C98-0F36-49D2-8290-742E24D*****\\",\\n \\"MatchedInclusionHints\\": [\\n \\"sign\\"\\n ]\\n}","type":"json"}]', + 'title' => 'Detect optimal image cropping regions by using AI model capabilities', + 'changeSet' => [ + ['createdAt' => '2022-04-26T03:27:09.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetectImageCropping'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:DetectImageCropping', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + ], + ], + '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' => 'readAndWrite', - 'deprecated' => false, + 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '147967', - 'abilityTreeNodes' => [ - 'FEATUREimmQT4435', - ], + 'abilityTreeCode' => '129323', + 'abilityTreeNodes' => ['FEATUREimmU4U2B0'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the project.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['title' => '', '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, - ], + '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', 'title' => ''], ], [ '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', - ], + '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', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + '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-BDF75FF*****', + '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', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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' => [], - ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6E93D6C9-5AC0-49F9-914D-E02678D3****\\",\\n \\"Faces\\": [\\n {\\n \\"FigureId\\": \\"868a9e74-cde5-4c7a-9013-28bb984****\\",\\n \\"FigureConfidence\\": 1,\\n \\"FigureClusterId\\": \\"Cluster-dbe72fec-b84c-4ab6-885b-3678e64****\\",\\n \\"FigureClusterConfidence\\": 1,\\n \\"FigureType\\": \\"face\\",\\n \\"Age\\": 29,\\n \\"AgeSD\\": 5,\\n \\"Gender\\": \\"female\\",\\n \\"GenderConfidence\\": 1,\\n \\"Emotion\\": \\"happiness\\",\\n \\"EmotionConfidence\\": 0.70784568786621,\\n \\"FaceQuality\\": 0.960875928401947,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n },\\n \\"Mouth\\": \\"close\\",\\n \\"MouthConfidence\\": 1,\\n \\"Beard\\": \\"none\\",\\n \\"BeardConfidence\\": 1,\\n \\"Hat\\": \\"none\\",\\n \\"HatConfidence\\": 1,\\n \\"Mask\\": \\"none\\",\\n \\"MaskConfidence\\": 1,\\n \\"Glasses\\": \\"none\\",\\n \\"GlassesConfidence\\": 0.8,\\n \\"Sharpness\\": 0.7,\\n \\"Attractive\\": 0.96,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 18.385589599609375,\\n \\"Roll\\": 4.204030513763428,\\n \\"Yaw\\": 2.4945924282073975\\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", + 'changeSet' => [ + ['createdAt' => '2024-04-19T03:54:12.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-04-13T03:46:17.000Z', 'description' => 'OpenAPI offline'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '147624', - 'abilityTreeNodes' => [ - 'FEATUREimmEPY4NE', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetectImageFaces'], ], ], - 'parameters' => [ + 'ramActions' => [ [ - '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, + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:DetectImageFaces', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], ], - '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', - ], + 'DetectImageLabels' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '144838', - 'abilityTreeNodes' => [ - 'FEATUREimm4NW8UR', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '82228', + 'abilityTreeNodes' => ['FEATUREimmELX4L2'], ], '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', - ], + 'schema' => ['description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test-project'], ], [ - 'name' => 'BackgroundColor', + 'name' => 'SourceURI', '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', - ], + '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.', 'type' => 'string', 'required' => true, 'example' => 'oss://test-bucket/test-object.jpg'], ], [ - 'name' => 'UserData', + 'name' => 'Threshold', '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', - ], + '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.', 'type' => 'number', 'format' => 'float', 'example' => '0.7', 'required' => false], ], [ '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', - ], + '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~~).', '$ref' => '#/components/schemas/CredentialConfig', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', '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*****', + 'Labels' => [ + 'title' => '', + 'description' => 'The list of labels detected.', + 'type' => 'array', + 'items' => ['description' => 'The labels.', '$ref' => '#/components/schemas/Label', 'title' => '', 'example' => ''], + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '91AC8C98-0F36-49D2-8290-742E24DF1F69'], ], + 'example' => '', ], ], + 500 => [], ], - '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', + 'title' => '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.', + 'description' => '- Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).\\*\\*\\*\\*'."\n" + ."\n" + .'- Make sure that an IMM [project](~~478273~~) is created. For information about how to create a project, see [CreateProject](~~478153~~).'."\n" + ."\n" + .'- For more information about the features of this operation, see [Image label detection](~~477179~~).'."\n" + ."\n" + .'- For more information about the input images supported by this operation, see [Limits on images](~~475569~~).', + 'changeSet' => [ + ['createdAt' => '2021-10-18T02:46:47.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetectImageLabels'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:DetectImageLabels', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"座椅\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ]\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"91AC8C98-0F36-49D2-8290-742E24DF1F69\\"\\n}","type":"json"}]', + ], + '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' => [], @@ -16607,970 +10148,587 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '160091', - 'abilityTreeNodes' => [ - 'FEATUREimmE6F82K', - ], + 'abilityTreeCode' => '129324', + 'abilityTreeNodes' => ['FEATUREimmEAXWFI'], ], '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', - ], + 'schema' => ['title' => '', 'description' => 'The name of the project.[](~~477051~~)'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ - 'name' => 'CredentialConfig', + 'name' => 'SourceURI', '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', - ], + '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://examplebucket/sampleobject.jpg', 'title' => ''], ], [ - 'name' => 'Source', + 'name' => 'CredentialConfig', '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, - ], + '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', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned data.'."\n", + 'title' => '', + 'description' => 'The response parameters.'."\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', + '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', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F73AC982-2B9E-4ECD-AED5-F8331C5******\\",\\n \\"Similarity\\": 0.8848152756690983\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'CompareImageFaces', + '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" - .'* 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', + .'* 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", + 'changeSet' => [ + ['createdAt' => '2024-04-19T09:43:59.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-04-13T03:46:17.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetectImageScore'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:DetectImageScore', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + ], + 'DetectImageTexts' => [ + 'summary' => 'Recognizes and extracts text content from an image.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '143909', - 'abilityTreeNodes' => [ - 'FEATUREimm0QJK19', - ], + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '207351', + 'abilityTreeNodes' => ['FEATUREimmYZZZWM'], ], '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', - ], + '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 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', - ], + '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', - ], + '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', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '图片裁剪结果', + 'title' => '', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Bodies' => [ - 'title' => '图片裁剪结果', - 'description' => 'The human bodies.'."\n", + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****'], + 'OCRTexts' => ['title' => '', 'description' => 'The full Optical Character Recognition (OCR) text, which is spliced by using the content of OCRContents.'."\n", 'type' => 'string', 'example' => 'Intelligent Media Management.'], + 'OCRContents' => [ + 'title' => '', + 'description' => 'OCR text blocks.'."\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********', + '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', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], ], 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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\",\\n \\"OCRTexts\\": \\"Intelligent Media Management.\\",\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\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", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:DetectImageTexts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + ], + 'DetectMediaMeta' => [ + 'summary' => 'Retrieves the metadata of a media file, including media format information and media stream information.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '172472', - 'abilityTreeNodes' => [ - 'FEATUREimmIT7OSY', - ], + 'abilityTreeCode' => '161491', + 'abilityTreeNodes' => ['FEATUREimmGWMCEO'], ], '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', - ], + 'schema' => ['description' => 'The project name. For information about how to obtain the project name, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => false, 'example' => 'test-project', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The Object Storage Service (OSS) URI of the media file.'."\n" + ."\n" + .'The OSS URI follows the format oss://${Bucket}/${Object}, where `${Bucket}` is the name of an OSS bucket in the same region as the current project, and `${Object}` is the full path of the file including the file name extension.', 'type' => 'string', 'required' => false, 'example' => 'oss://examplebucket/sampleobject.mp4', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => '**Leave this parameter empty unless you have special requirements.**'."\n" + ."\n" + .'The chain authorization configuration. This parameter is optional. For more information, see [Use chain authorization to access resources of other entities](~~465340~~).', '$ref' => '#/components/schemas/CredentialConfig', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => '图片二维码检测结果', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Cars' => [ - 'title' => '二维码检测结果', - 'description' => 'The vehicles.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2213B1A9-EB3D-4666-84E0-24980BC*****', 'title' => ''], + 'Language' => ['description' => 'The language used in the video. The value follows the ISO 639-2 standard.', 'type' => 'string', 'example' => 'eng', 'title' => ''], + 'Title' => ['description' => 'The title of the media file.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'VideoStreams' => [ + 'description' => 'The array of video streams.', 'type' => 'array', - 'items' => [ - 'description' => 'The vehicle.'."\n", - '$ref' => '#/components/schemas/Car', - ], - 'required' => true, - 'minItems' => 0, + 'items' => ['description' => 'The video stream information.', '$ref' => '#/components/schemas/VideoStream', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'title' => '请求唯一ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A8745209-DD0E-027E-8ABA-085E0C******', + 'AudioStreams' => [ + 'description' => 'The array of audio streams.', + 'type' => 'array', + 'items' => ['description' => 'The audio stream information.', '$ref' => '#/components/schemas/AudioStream', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'Subtitles' => [ + 'description' => 'The array of subtitle streams.', + 'type' => 'array', + 'items' => ['description' => 'The subtitle stream information.', '$ref' => '#/components/schemas/SubtitleStream', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'StreamCount' => ['description' => 'The number of media streams.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'ProgramCount' => ['description' => 'The number of programs.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'FormatName' => ['description' => 'The format name.', 'type' => 'string', 'example' => 'mov,mp4,m4a,3gp,3g2,mj2', 'title' => ''], + 'FormatLongName' => ['description' => 'The full name of the format.', 'type' => 'string', 'example' => 'QuickTime / MOV', 'title' => ''], + 'Size' => ['description' => 'The size of the media file, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '25115517', 'title' => ''], + 'StartTime' => ['description' => 'The start playback time of the media, in seconds.', 'type' => 'number', 'format' => 'double', 'example' => '0.000000', 'title' => ''], + 'Bitrate' => ['description' => 'The bitrate of the media file, in bit/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '13164131', 'title' => ''], + 'Artist' => ['description' => 'The artist.', 'type' => 'string', 'example' => 'unable', 'title' => ''], + 'AlbumArtist' => ['description' => 'The album artist.', 'type' => 'string', 'example' => 'unable', 'title' => ''], + 'Composer' => ['description' => 'The composer.', 'type' => 'string', 'example' => 'unable', 'title' => ''], + 'Performer' => ['description' => 'The performer.', 'type' => 'string', 'example' => 'unable', 'title' => ''], + 'Album' => ['description' => 'The album.', 'type' => 'string', 'example' => 'unable', 'title' => ''], + 'Duration' => ['description' => 'The total duration of the video, in seconds.', 'type' => 'number', 'format' => 'double', 'example' => '15.263000', 'title' => ''], + 'ProduceTime' => ['description' => 'The time when the video was recorded. The value follows the RFC 3339 Nano standard.', 'type' => 'string', 'example' => '2022-04-24T02:39:57Z', 'title' => ''], + 'LatLong' => ['description' => 'The central geographic coordinate point, which is a latitude and longitude value.'."\n" + .'The format is latitude,longitude, with latitude first and longitude second. The latitude range is \\[-90,+90] and the longitude range is \\[-180,+180]. Example: 35.8,-45.91.', 'type' => 'string', 'example' => '+120.029003,+30.283095', 'title' => ''], + 'VideoWidth' => ['description' => 'The width of the video frame in the media file, in pixels.', 'type' => 'integer', 'format' => 'int64', 'example' => '1080', 'title' => ''], + 'VideoHeight' => ['description' => 'The height of the video frame in the media file, in pixels.', 'type' => 'integer', 'format' => 'int64', 'example' => '1920', 'title' => ''], + 'Addresses' => [ + 'description' => 'The geolocation detection results of the video.'."\n" + ."\n" + .'This parameter has a value only when the video contains geolocation information.', + 'type' => 'array', + 'items' => ['description' => 'The detailed location information.', '$ref' => '#/components/schemas/Address', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2213B1A9-EB3D-4666-84E0-24980BC*****\\",\\n \\"Language\\": \\"eng\\",\\n \\"Title\\": \\"test\\",\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"CodecTimeBase\\": \\"1373627/83160000\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"Width\\": 1280,\\n \\"Height\\": 720,\\n \\"HasBFrames\\": 2,\\n \\"SampleAspectRatio\\": \\"1:1\\",\\n \\"DisplayAspectRatio\\": \\"16:9\\",\\n \\"PixelFormat\\": \\"yuv420p\\",\\n \\"Level\\": 40,\\n \\"FrameRate\\": \\"25/1\\",\\n \\"AverageFrameRate\\": \\"25/1\\",\\n \\"TimeBase\\": \\"1/12800\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 22.88,\\n \\"Bitrate\\": 5407765,\\n \\"FrameCount\\": 572,\\n \\"Rotate\\": \\"90\\",\\n \\"BitDepth\\": 8,\\n \\"ColorSpace\\": \\"bt709\\",\\n \\"ColorRange\\": \\"tv\\",\\n \\"ColorTransfer\\": \\"bt709\\",\\n \\"ColorPrimaries\\": \\"bt709\\"\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 1,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"TimeBase\\": \\"1/48000\\",\\n \\"StartTime\\": 0.0235,\\n \\"Duration\\": 3.690667,\\n \\"Bitrate\\": 320087,\\n \\"FrameCount\\": 173,\\n \\"Lyric\\": \\"test\\",\\n \\"SampleFormat\\": \\"fltp\\",\\n \\"SampleRate\\": 48000,\\n \\"Channels\\": 2,\\n \\"ChannelLayout\\": \\"stereo\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 2,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"mov_text\\",\\n \\"CodecLongName\\": \\"MOV text\\",\\n \\"CodecTagString\\": \\"tx3g\\",\\n \\"CodecTag\\": \\"0x67337874\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 71.378,\\n \\"Bitrate\\": 74,\\n \\"Content\\": \\"欢迎\\",\\n \\"Width\\": 600,\\n \\"Height\\": 30\\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\\": \\"zh-Hans\\",\\n \\"AddressLine\\": \\"中国浙江省杭州市余杭区文一西路969号\\",\\n \\"Country\\": \\"中国\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"District\\": \\"余杭区\\",\\n \\"Township\\": \\"文一西路\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve media file metadata', + 'description' => '- **Before you use this operation, make sure that you are familiar with the billing of Intelligent Media Management (IMM) and its [pricing](~~88317~~).**'."\n" + .'- Before you call this operation, make sure that a project is available in the current region. For more information, see [Project management](~~478152~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetectMediaMeta'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:DetectMediaMeta', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + ], + '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' => 'write', - 'deprecated' => false, + 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '207351', - 'abilityTreeNodes' => [ - 'FEATUREimmYZZZWM', - ], + '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' => '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', - ], + 'schema' => ['title' => '', 'description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", 'type' => 'string', 'required' => true, 'example' => 'immtest'], ], [ - 'name' => 'CredentialConfig', + 'name' => 'Content', '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', - ], + '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', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '图片二维码检测结果', + '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", + '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', - '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', - ], + 'enumValueTitles' => ['pass' => '', 'block' => ''], + 'example' => 'pass', + 'title' => '', ], ], + 'example' => '', ], ], - 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', + '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" - .'* 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', + ."\n" + .'> The text compliance detection feature only supports Chinese characters.'."\n", + 'changeSet' => [ + ['createdAt' => '2024-04-19T09:43:54.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetectTextAnomaly'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:DetectTextAnomaly', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + ], + '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' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '132611', - 'abilityTreeNodes' => [ - 'FEATUREimmCUOMK0', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '199817', + 'abilityTreeNodes' => ['FEATUREimmSCVT08'], ], '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', - ], + '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' => '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', + 'name' => 'SourceURI', '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"}', - ], + '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', 'title' => ''], ], [ - 'name' => 'Tags', + 'name' => 'TargetURI', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'Custom tags used for searching and filtering asynchronous tasks.', - 'type' => 'object', - 'required' => false, - 'example' => '{"test":"val1"}', - ], + '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', 'title' => ''], ], [ - 'name' => 'CredentialConfig', + 'name' => 'Content', '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', - ], + 'schema' => ['description' => 'The text content of watermarks. It can be up to 256 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Copyright Alibaba Cloud', 'title' => ''], ], [ - 'name' => 'Notification', + 'name' => 'StrengthLevel', '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~~).', + '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, - '$ref' => '#/components/schemas/Notification', + 'enumValueTitles' => ['high' => 'high', 'low' => 'low', 'medium' => 'medium'], + 'example' => 'low', + 'title' => '', ], ], [ - 'name' => 'AlignmentIndex', + 'name' => 'ImageQuality', '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', - ], + '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', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结构体', - 'description' => 'Response structure.', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", '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****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8E0DD64B-28C6-4653-8FF7-93E4C234BCF0'], ], + 'example' => '', ], ], ], - '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', + '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", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EncodeBlindWatermark'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:EncodeBlindWatermark', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + ], + 'ExtractDocumentText' => [ + 'summary' => 'Extract text from the document', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '161491', - 'abilityTreeNodes' => [ - 'FEATUREimmGWMCEO', - ], + 'abilityTreeCode' => '173181', + 'abilityTreeNodes' => ['FEATUREimmMBRC1J'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the project.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-project', - ], + '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' => [ - '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', - ], + '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' => [ - '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', - ], + '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', 'example' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ + 'title' => '图片裁剪结果', + 'description' => 'Response body structure.', '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', - ], - ], + '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' => 'Test content.'], ], - 'description' => '', + 'example' => '', ], ], + 500 => [], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94D6F994-E298-037E-8E8B-0090F27*****\\",\\n \\"DocumentText\\": \\"Test content.\\"\\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>', + 'changeSet' => [ + ['createdAt' => '2023-12-13T05:59:29.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExtractDocumentText'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:ExtractDocumentText', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'FuzzyQuery' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -17579,289 +10737,155 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '157766', - 'abilityTreeNodes' => [ - 'FEATUREimmQZSDER', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '8960', + 'abilityTreeNodes' => ['FEATUREimmDN11M0'], ], 'parameters' => [ [ + 'name' => 'NextToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['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.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw=='], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The maximum number of entries to return. Valid values: 0 to 200.'."\n" + ."\n" + .'Default value: 100.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1'], + ], + [ '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', - ], + 'schema' => ['description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test-project'], ], [ - 'name' => 'SourceURI', + 'name' => 'DatasetName', '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', - ], + 'schema' => ['description' => 'The name of the dataset. You can obtain the name of the dataset from the response of the [CreateDataset](~~478160~~) operation.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test-dataset'], ], [ - 'name' => 'UserData', + 'name' => 'Query', '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"}', - ], + 'schema' => ['description' => 'The query content. The value can be up to 1 MB in size.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '阿里云'], ], [ - 'name' => 'Tags', + 'name' => 'Sort', '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"}', - ], + '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" + ."\n" + .'- You can specify up to five sort fields.'."\n" + ."\n" + .'- The priority order of sorting is determined based on the order of the sort fields.', 'type' => 'string', 'required' => false, 'example' => 'Size,Filename', 'title' => ''], ], [ - 'name' => 'CredentialConfig', + 'name' => 'Order', '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', - ], + 'schema' => ['description' => 'The sorting method. Valid values:'."\n" + ."\n" + .'- asc: ascending order.'."\n" + ."\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.', 'type' => 'string', 'required' => false, 'example' => 'asc,desc', 'title' => ''], ], [ - 'name' => 'Notification', + 'name' => 'WithFields', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The notification settings. For information about the asynchronous notification format, see [Asynchronous message examples](~~2743997~~).'."\n", + '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.', + '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.', 'type' => 'string', 'required' => false, 'example' => 'Filename', 'title' => ''], 'required' => false, - '$ref' => '#/components/schemas/Notification', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '图片检测结果', - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', '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*****', + 'NextToken' => ['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.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw=='], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****'], + 'Files' => [ + 'description' => 'The files.', + 'type' => 'array', + 'items' => ['description' => 'The file information.', '$ref' => '#/components/schemas/File', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'TotalHits' => ['description' => 'The number of hits.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], ], + 'example' => '', ], ], - 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" + 'title' => 'FuzzyQuery', + 'summary' => 'Queries the extracted file metadata, including the file name, labels, path, custom tags, and other fields. If the value of a metadata field of a file matches the specified string, the metadata of the file is returned.', + 'description' => '- Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of IMM.\\*\\*\\*\\*'."\n" ."\n" - .'* For more information about video label detection, see [Video label detection](~~477189~~).'."\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" - .'* This operation supports multiple video formats, such as MP4, MPEG-TS, MKV, MOV, AVI, FLV, and M3U8.'."\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" ."\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', + .'- For information about the fields that you can use as query conditions, see [Supported fields and operators](~~2743991~~).', + 'changeSet' => [ + ['createdAt' => '2023-11-20T06:58:49.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-09-04T06:34:40.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-12-13T05:33:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-06-15T02:12:16.000Z', 'description' => 'OpenAPI offline'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FuzzyQuery'], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '157767', - 'abilityTreeNodes' => [ - 'FEATUREimmQZSDER', - ], - ], - 'parameters' => [ + 'ramActions' => [ [ - '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', - ], - ], + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:FuzzyQuery', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], ], ], ], - 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", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==\\",\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\",\\n \\"Files\\": [\\n {\\n \\"OwnerId\\": \\"102321002467****\\",\\n \\"ProjectName\\": \\"test-project\\",\\n \\"DatasetName\\": \\"test-dataset\\",\\n \\"ObjectType\\": \\"file\\",\\n \\"ObjectId\\": \\"75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7\\",\\n \\"UpdateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"CreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"URI\\": \\"oss://test-bucket/test-object.jpg\\",\\n \\"OSSURI\\": \\"oss://examplebucket/sampleobject.jpg\\",\\n \\"Filename\\": \\"sampleobject.jpg\\",\\n \\"MediaType\\": \\"image\\",\\n \\"ContentType\\": \\"image/jpeg\\",\\n \\"Size\\": 1000,\\n \\"FileHash\\": \\"1d9c280a7c4f67f7ef873e28449dbe17\\",\\n \\"FileModifiedTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileCreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileAccessTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"ProduceTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"LatLong\\": \\"30.134390,120.074997\\",\\n \\"Timezone\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"AddressLine\\": \\"中国浙江省杭州市余杭区文一西路969号\\",\\n \\"Country\\": \\"中国\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"District\\": \\"余杭区\\",\\n \\"Township\\": \\"文一西路\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"-\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"868a9e74-cde5-4c7a-9013-28bb984****\\",\\n \\"FigureConfidence\\": 1,\\n \\"FigureClusterId\\": \\"Cluster-dbe72fec-b84c-4ab6-885b-3678e64****\\",\\n \\"FigureClusterConfidence\\": 1,\\n \\"FigureType\\": \\"face\\",\\n \\"Age\\": 29,\\n \\"AgeSD\\": 5,\\n \\"Gender\\": \\"female\\",\\n \\"GenderConfidence\\": 1,\\n \\"Emotion\\": \\"happiness\\",\\n \\"EmotionConfidence\\": 0.70784568786621,\\n \\"FaceQuality\\": 0.960875928401947,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n },\\n \\"Mouth\\": \\"close\\",\\n \\"MouthConfidence\\": 1,\\n \\"Beard\\": \\"none\\",\\n \\"BeardConfidence\\": 1,\\n \\"Hat\\": \\"none\\",\\n \\"HatConfidence\\": 1,\\n \\"Mask\\": \\"none\\",\\n \\"MaskConfidence\\": 1,\\n \\"Glasses\\": \\"none\\",\\n \\"GlassesConfidence\\": 0.8,\\n \\"Sharpness\\": 0.7,\\n \\"Attractive\\": 0.96,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 18.385589599609375,\\n \\"Roll\\": 4.204030513763428,\\n \\"Yaw\\": 2.4945924282073975\\n }\\n }\\n ],\\n \\"FigureCount\\": 10,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"座椅\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Title\\": \\"test\\",\\n \\"ImageWidth\\": 270,\\n \\"ImageHeight\\": 500,\\n \\"EXIF\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.736\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 1080,\\n \\"VideoHeight\\": 1920,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"CodecTimeBase\\": \\"1373627/83160000\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"Width\\": 1280,\\n \\"Height\\": 720,\\n \\"HasBFrames\\": 2,\\n \\"SampleAspectRatio\\": \\"1:1\\",\\n \\"DisplayAspectRatio\\": \\"16:9\\",\\n \\"PixelFormat\\": \\"yuv420p\\",\\n \\"Level\\": 40,\\n \\"FrameRate\\": \\"25/1\\",\\n \\"AverageFrameRate\\": \\"25/1\\",\\n \\"TimeBase\\": \\"1/12800\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 22.88,\\n \\"Bitrate\\": 5407765,\\n \\"FrameCount\\": 572,\\n \\"Rotate\\": \\"90\\",\\n \\"BitDepth\\": 8,\\n \\"ColorSpace\\": \\"bt709\\",\\n \\"ColorRange\\": \\"tv\\",\\n \\"ColorTransfer\\": \\"bt709\\",\\n \\"ColorPrimaries\\": \\"bt709\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 2,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"mov_text\\",\\n \\"CodecLongName\\": \\"MOV text\\",\\n \\"CodecTagString\\": \\"tx3g\\",\\n \\"CodecTag\\": \\"0x67337874\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 71.378,\\n \\"Bitrate\\": 74,\\n \\"Content\\": \\"欢迎\\",\\n \\"Width\\": 600,\\n \\"Height\\": 30\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 1,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"TimeBase\\": \\"1/48000\\",\\n \\"StartTime\\": 0.0235,\\n \\"Duration\\": 3.690667,\\n \\"Bitrate\\": 320087,\\n \\"FrameCount\\": 173,\\n \\"Lyric\\": \\"test\\",\\n \\"SampleFormat\\": \\"fltp\\",\\n \\"SampleRate\\": 48000,\\n \\"Channels\\": 2,\\n \\"ChannelLayout\\": \\"stereo\\"\\n }\\n ],\\n \\"Artist\\": \\"Jane\\",\\n \\"AlbumArtist\\": \\"Jane\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 500,\\n \\"ImageHeight\\": 820,\\n \\"EXIF\\": \\"{\\\\\\"FileSize\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"29304\\\\\\"},\\\\\\"Format\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"jpg\\\\\\"}}\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.736\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"Jane\\",\\n \\"Performer\\": \\"Jane\\",\\n \\"Language\\": \\"eng\\",\\n \\"Album\\": \\"FirstAlbum\\",\\n \\"PageCount\\": 5,\\n \\"ETag\\": \\"\\\\\\"1D9C280A7C4F67F7EF873E28449****\\\\\\"\\",\\n \\"CacheControl\\": \\"no-cache\\",\\n \\"ContentDisposition\\": \\"attachment; filename =test.jpg\\",\\n \\"ContentEncoding\\": \\"UTF-8\\",\\n \\"ContentLanguage\\": \\"zh-CN\\",\\n \\"AccessControlAllowOrigin\\": \\"https://aliyundoc.com\\",\\n \\"AccessControlRequestMethod\\": \\"PUT\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"SM4\\",\\n \\"ServerSideEncryption\\": \\"AES256\\",\\n \\"ServerSideDataEncryption\\": \\"SM4\\",\\n \\"ServerSideEncryptionKeyId\\": \\"9468da86-3509-4f8d-a61e-6eab1eac****\\",\\n \\"OSSStorageClass\\": \\"Standard\\",\\n \\"OSSCRC64\\": \\"559890638950338001\\",\\n \\"ObjectACL\\": \\"default\\",\\n \\"ContentMd5\\": \\"HZwoCnxPZ/fvhz4oRJ2+Fw==\\",\\n \\"OSSUserMeta\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSTaggingCount\\": 2,\\n \\"OSSTagging\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSExpiration\\": \\"2120-01-01T12:00:00.000Z\\",\\n \\"OSSVersionId\\": \\"CAEQNhiBgMDJgZCA0BYiIDc4MGZjZGI2OTBjOTRmNTE5NmU5NmFhZjhjYmY0****\\",\\n \\"OSSDeleteMarker\\": \\"CAEQMhiBgIDXiaaB0BYiIGQzYmRkZGUxMTM1ZDRjOTZhNjk4YjRjMTAyZjhl****\\",\\n \\"OSSObjectType\\": \\"Normal\\",\\n \\"CustomId\\": \\"\\\\t\\\\nmember-image-id-0001\\",\\n \\"CustomLabels\\": {\\n \\"MemberName\\": \\"Tim\\",\\n \\"Enabled\\": \\"True\\",\\n \\"ItemCount\\": \\"10\\"\\n },\\n \\"StreamCount\\": 1,\\n \\"ProgramCount\\": 1,\\n \\"FormatName\\": \\"mov\\",\\n \\"FormatLongName\\": \\"QuickTime / MOV\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 13091201,\\n \\"Duration\\": 15.263,\\n \\"SemanticTypes\\": [\\n \\"content\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"text\\",\\n \\"Content\\": \\"文本片段\\",\\n \\"URL\\": \\"http://aliyun.com\\",\\n \\"TimeRange\\": [\\n 500\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"id1\\",\\n \\"ElementType\\": \\"title - 标题； image - 图片 ； table - 表格 ； narrative-text - 正文\\",\\n \\"SemanticSimilarity\\": 0.8,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"child，parent\\",\\n \\"ObjectId\\": \\"id1\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ],\\n \\"FrameTimes\\": [\\n 30\\n ],\\n \\"VideoStreamIndex\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"座椅\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"OCRTexts\\": \\"阿里云IMM\\",\\n \\"Reason\\": \\"[InternalError] The request has been failed due to some unknown error. status: 500, requestId: CC5ACFBD-BB7A-496D-A9D6-****\\",\\n \\"ObjectStatus\\": \\"Indexed\\",\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"无。\\",\\n \\"Caption\\": \\"视频中展示了两个不同场景：一个是静止的白色盘子、黑色瓶子和透明玻璃杯，另一个是手拿着标有“YEZOLU”的洗发水瓶在浴室中缓慢上移。\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"无。\\",\\n \\"Description\\": \\"图片中有一人，穿着深色西装外套，内搭白色衬衫。背景为渐变的浅蓝色至灰色。\\"\\n }\\n }\\n }\\n ],\\n \\"TotalHits\\": 10\\n}","type":"json"}]', ], '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', - ], + 'summary' => 'Creates a just-in-time transcoding playlist that generates an M3U8 file from a video file. The playlist can be played immediately after generation, and transcoding is performed on demand based on playback progress. Compared with offline transcoding, this significantly reduces transcoding wait time and substantially lowers transcoding and storage costs.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -17872,231 +10896,148 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '161492', - 'abilityTreeNodes' => [ - 'FEATUREimmCUOMK0', - ], + 'abilityTreeNodes' => ['FEATUREimmCUOMK0'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => 'The project name.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'immtest', - ], + 'schema' => ['description' => 'The project name. For information about how to obtain the project name, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'immtest', 'title' => ''], ], [ '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"}', - ], + 'schema' => ['description' => 'The custom information, which is returned in asynchronous message notifications. This helps you associate message notifications within your system. Maximum length: 2,048 bytes.', 'type' => 'string', 'required' => false, 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The OSS URI of the video.'."\n" + ."\n" + .'The OSS URI follows the format 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 name extension.'."\n" + .'> Only OSS buckets with Standard storage are supported.'."\n" + .'> Buckets with hotlink protection whitelists configured are not supported.', 'type' => 'string', 'required' => true, 'example' => 'oss://test-bucket/test-source-object/video.mp4', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The start time for generating the playlist. Unit: seconds. Valid values:'."\n" + ."\n" + .'- 0 (default) or empty: starts from the beginning of the source video.'."\n" + ."\n" + .'- A value greater than 0: starts from the specified time point in the source video.'."\n" + ."\n" + .'> You can set this parameter together with **SourceDuration** to generate a playlist for a specific portion of the source video.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The duration for generating the playlist. Unit: seconds. Valid values:'."\n" + ."\n" + .'- 0 (default) or empty: continues until the end of the source video.'."\n" + ."\n" + .'- A value greater than 0: continues for the specified duration from the start time of the playlist.'."\n" + ."\n" + .'> If the time point corresponding to the specified parameter exceeds the end of the source video, the default value is used.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0', 'title' => ''], ], [ '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", + 'description' => 'The list of subtitles to add. Default value: empty. A maximum of two subtitles are supported.', 'type' => 'array', 'items' => [ - 'description' => 'The subtitle file.'."\n", + 'description' => 'The subtitle information.', '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', - ], + 'URI' => ['description' => 'The OSS URI of the subtitle to embed.'."\n" + ."\n" + .'The OSS URI follows the format 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.'."\n" + .'> The **MasterURI** parameter must not be empty, and the OSS URI `oss://${Bucket}/${Object}` of the subtitle must be in the same directory as or a subdirectory of the **MasterURI** parameter.', 'type' => 'string', 'required' => true, 'example' => 'oss://test-bucket/test-object/subtitle/eng.vtt', 'title' => ''], + 'Language' => ['description' => 'The subtitle language. The value follows the ISO 639-2 standard. Default value: empty.', 'type' => 'string', 'required' => false, 'example' => 'eng', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ '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', - ], + 'schema' => ['description' => 'The OSS URI of the Master Playlist.'."\n" + ."\n" + .'The OSS URI follows the format 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 with the ".m3u8" extension.'."\n" + .'> If the playlist has subtitle input or multiple Target outputs, MasterURI is required. The subtitle URI or Target URI must be in the same directory as or a subdirectory of MasterURI.', 'type' => 'string', 'required' => false, 'example' => 'oss://test-bucket/test-object/master.m3u8', 'title' => ''], ], [ '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", + 'description' => 'The array of just-in-time transcoding playlists. The maximum array length is 6. Each Target corresponds to at most one video Media Playlist and one or more subtitle Media Playlists.'."\n" + .'> If more than one Target is configured, the **MasterURI** parameter must not be empty.', 'type' => 'array', 'items' => [ - 'description' => 'The live transcoding information.'."\n", + 'description' => 'The details of the just-in-time transcoding task.', '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', - ], + 'URI' => ['description' => 'The OSS URI prefix for the just-in-time transcoding output files, including M3U8 files and TS files.'."\n" + ."\n" + .'The OSS URI follows the format 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 prefix of the file without the file name extension.'."\n" + ."\n" + .'- Example: If URI is oss://test-bucket/test-object/output-video, an oss://test-bucket/test-object/output-video.m3u8 file and multiple oss://test-bucket/test-object/output-video-${token}-${index}.ts files are generated. ${token} is a unique string generated based on the transcoding parameters and is included in the API response. ${index} is the sequence number of the TS file starting from 0.'."\n" + ."\n" + .'> If the **MasterURI** parameter is not empty, the URI must be in the same directory as or a subdirectory of the **MasterURI** parameter.', 'type' => 'string', 'required' => false, 'example' => 'oss://test-bucket/test-object/output-video', 'title' => ''], + 'Video' => ['description' => 'The video processing parameter settings. An empty value (default) indicates that video processing is disabled and the output TS files do not contain video streams.'."\n" + .'> The Video and Subtitle fields within the same Target are mutually exclusive. If the Video field is set, the Subtitle field is ignored.', '$ref' => '#/components/schemas/TargetVideo', 'required' => false, 'title' => '', 'example' => ''], + 'Audio' => ['description' => 'The audio processing parameter settings. An empty value (default) indicates that audio processing is disabled and the output TS files do not contain audio streams.'."\n" + .'> The Audio and Subtitle fields within the same Target are mutually exclusive. If the Audio field is set, the Subtitle field is ignored. Audio and Video can be set at the same time. Audio specifies the audio information in the output video. You can also set only Audio to generate audio-only output.', '$ref' => '#/components/schemas/TargetAudio', 'required' => false, 'title' => '', 'example' => ''], + 'Subtitle' => ['description' => 'The subtitle processing parameter settings.'."\n" + .'> The Subtitle field is mutually exclusive with the Video and Audio fields within the same Target. Subtitles are generated only when Subtitle is set independently.', '$ref' => '#/components/schemas/TargetSubtitle', 'required' => false, 'title' => '', 'example' => ''], + 'TranscodeAhead' => ['description' => 'The number of TS files to transcode ahead when just-in-time transcoding is triggered. By default, 2 minutes of video is transcoded ahead.'."\n" + ."\n" + .'- Example: If **Duration** is 10, the default value of **TranscodeAhead** is 12. You can specify this parameter to control the number of asynchronous ahead-of-time transcoding files. Valid values: [10, 30].', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '12', 'title' => ''], + 'Duration' => ['description' => 'The playback duration of a single TS file. Unit: seconds. Default value: 10. Valid values: [5, 15].', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '10', 'title' => ''], + 'InitialTranscode' => ['description' => 'The initial transcoding duration. Unit: seconds. Default value: 30.'."\n" + ."\n" + .'- If the value is set to 0, no pre-transcoding is performed.'."\n" + .'- If the value is less than 0 or exceeds the source video length, the entire video is initially transcoded.'."\n" + .'- If the specified duration falls in the middle of a TS file, transcoding continues until the end of that TS file.'."\n" + ."\n" + .'> This parameter is mainly used to reduce the wait time for the first playback and improve the playback experience. If you want to replace a traditional VOD scenario, try initially transcoding the entire video.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '30', 'title' => ''], '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", + 'description' => 'The array of initial transcoding TS file durations. The maximum array length is 6. Default value: empty. This parameter is independent of the **Duration** parameter.', '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', - ], + 'items' => ['description' => 'The duration of an initial transcoding TS file. Valid values: [1, **Duration**].'."\n" + ."\n" + .'- Example: If the initial transcoding TS duration array is `[2, 2, 4, 4, 8, 8]`, the TS file at index 0 has a duration of 2, the TS file at index 1 has a duration of 2, the TS file at index 2 has a duration of 4, the TS file at index 3 has a duration of 4, the TS file at index 4 has a duration of 8, and the TS file at index 5 has a duration of 8.'."\n" + .'> Customizing smaller initial transcoding TS file durations makes video loading smoother.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '2', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], '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", + 'description' => 'The OSS object [tags](~~106678~~) to add to the generated TS files. You can use OSS tags to control the lifecycle of OSS files.'."\n" + .'> The tag values at this level are merged with the Tags defined at the parent level to form the tag values for the current Target. If a tag with the same name exists, the value at this level takes precedence.', 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{\\"key1\\":\\"value1\\"}', - 'description' => 'The value of the tag.'."\n", - ], + 'additionalProperties' => ['description' => 'The tag value.', 'type' => 'string', 'example' => '{\\"key1\\":\\"value1\\"}', 'title' => ''], + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ @@ -18104,199 +11045,147 @@ '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", + 'description' => 'The OSS object [tags](~~106678~~) to add to the generated TS files. You can use tags to control the lifecycle of OSS files.', 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The tag value.'."\n", - 'example' => '{"key1": "value1", "key2": "value2"}', - ], + 'additionalProperties' => ['description' => 'The tag value.', 'type' => 'string', 'example' => '{"key1": "value1", "key2": "value2"}', 'title' => ''], 'example' => '{"key1": "value1", "key2": "value2"}', + 'title' => '', ], ], [ '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', - ], + 'schema' => ['description' => '**Leave this parameter empty unless you have special requirements.**'."\n" + ."\n" + .'The China authorization configuration. This parameter is optional. For more information, see [Use chained authorization to access resources of other entities](~~465340~~).', '$ref' => '#/components/schemas/CredentialConfig', 'required' => false, 'title' => '', 'example' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The message notification configuration. Click Notification for details. For the format of asynchronous notification messages, see [Asynchronous notification message format](~~2743997~~).', '$ref' => '#/components/schemas/Notification', 'required' => false, 'title' => '', 'example' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The overwrite policy when a Media Playlist already exists. Valid values:'."\n" + ."\n" + .'- overwrite (default): overwrites the existing Media Playlist.'."\n" + .'- skip-existing: skips generation and retains the existing Media Playlist.', 'type' => 'string', 'required' => false, 'example' => 'overwrite', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', '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', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FFF*****'], + 'Duration' => ['description' => 'The total duration of the output video.', 'type' => 'number', 'format' => 'float', 'example' => '1082', 'title' => ''], + 'Token' => ['description' => 'The token of the Master Playlist.', 'type' => 'string', 'example' => '92376fbb-171f-4259-913f-705f7ee0****', 'title' => ''], + 'MasterURI' => ['description' => 'The OSS URI of the Master Playlist.', 'type' => 'string', 'example' => 'oss://test-bucket/test-object/master.m3u8', 'title' => ''], 'VideoPlaylist' => [ - 'description' => 'The video media playlist files.'."\n", + 'description' => 'The list of video Media Playlist files.', 'type' => 'array', 'items' => [ - 'description' => 'The video media playlist file.'."\n", + 'description' => 'The video Media Playlist file information.', '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', - ], + 'Token' => ['description' => 'The token generated for the video Media Playlist. You can use this parameter to construct the addresses of the generated TS files.'."\n" + .'> Based on the returned Token value, you can construct the addresses of the transcoded TS files. The format is: oss://${Bucket}/${Object}-${Token}-${Index}.ts, where oss://${Bucket}/${Object} is the Target URI specified in the input parameters, ${Token} is the returned parameter, and ${Index} is the sequence number of the TS file.', 'type' => 'string', 'example' => 'affe0c6042f09722fec95a21b8b******', 'title' => ''], + 'URI' => ['description' => 'The OSS URI of the video Media Playlist.', 'type' => 'string', 'example' => 'oss://test-bucket/test-object/output-video.m3u8', 'title' => ''], + 'Resolution' => ['description' => 'The video resolution.', 'type' => 'string', 'example' => '640x480', 'title' => ''], + 'FrameRate' => ['description' => 'The video frame rate.', 'type' => 'string', 'example' => '25/1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'AudioPlaylist' => [ - 'description' => 'The audio media playlist files.'."\n", + 'description' => 'The list of audio Media Playlist files.', 'type' => 'array', 'items' => [ - 'description' => 'The audio media playlist file.'."\n", + 'description' => 'The audio Media Playlist file information.', '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', - ], + 'Token' => ['description' => 'The token generated for the audio Media Playlist. You can use this parameter to construct the addresses of the generated TS files.', 'type' => 'string', 'example' => 'affe0c6042f09722fec95a21b8b******', 'title' => ''], + 'URI' => ['description' => 'The OSS URI of the audio Media Playlist.', 'type' => 'string', 'example' => 'oss://test-bucket/test-object/output-audio.m3u8', 'title' => ''], + 'Channels' => ['description' => 'The number of audio channels.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'SubtitlePlaylist' => [ - 'description' => 'The subtitle media playlist files.'."\n", + 'description' => 'The list of subtitle Media Playlist files.', 'type' => 'array', 'items' => [ - 'description' => 'The subtitle media playlist file.'."\n", + 'description' => 'The subtitle Media Playlist file information.', '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', - ], + 'Token' => ['description' => 'The token generated for the subtitle Media Playlist. You can use this parameter to construct the addresses of the generated subtitle files.'."\n" + .'> Based on the returned Token value, you can construct the addresses of the transcoded subtitle files. The format is: oss://${Bucket}/${Object}-${Token}_${Index}.ts, where oss://${Bucket}/${Object} is the Subtitle URI specified in the input parameters, ${Token} is the returned parameter, and ${Index} is the sequence number of the subtitle file.', 'type' => 'string', 'example' => 'affe0c6042f09722fec95a21b8b******', 'title' => ''], + 'URI' => ['description' => 'The OSS URI of the subtitle Media Playlist.', 'type' => 'string', 'example' => 'oss://test-bucket/test-object/output-subtitle.m3u8', 'title' => ''], + 'Language' => ['description' => 'The language of the subtitle stream.'."\n" + .'> The language is obtained from the subtitle stream information of the source video specified by SourceURI. If the source video does not contain language information, an empty value is returned.', 'type' => 'string', 'example' => 'eng', 'title' => ''], + 'Index' => ['description' => 'The sequence number of the subtitle stream, starting from 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], 'title' => '', + 'example' => '', ], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Generate a just-in-time transcoding playlist', + 'description' => '- **Before you use this operation, make sure that you understand the billing of Intelligent Media Management (IMM) and its [pricing](~~88317~~).**'."\n" + .'- Before you invoke this operation, make sure that an active project exists in the current region. For more information, see [Project management](~~478152~~).'."\n" + .'- By default, this operation processes only one video, audio, or subtitle stream. You can configure the number of video, audio, and subtitle streams to process.'."\n" + .'<notice>The Video, Audio, and Subtitle parameters under Targets cannot all be empty. An empty value indicates that the corresponding processing is disabled. For example, if Video is empty, video processing is disabled and the output TS files do not contain video streams.></notice>'."\n" + .'- The minimum duration of the source video is approximately 0.x seconds, which varies depending on the output frame rate.'."\n" + .'- This operation supports generating both Media Playlists and Master Playlists. Pay attention to the metric descriptions in this document.'."\n" + .'- This is a synchronous operation. Synchronous or asynchronous transcoding is triggered only during playback or pre-transcoding. You can set the [Notification](~~2743997~~) parameter to receive transcoding task results through message notifications.'."\n" + .'- For more information about this feature, see [Just-in-time transcoding](~~477192~~).'."\n" + .'- OSS data processing also provides a playlist generation feature, but it only supports generating Media Playlists with simplified parameters. For details, see [Generate a playlist](~~2709281~~) in OSS data processing.', + 'changeSet' => [ + ['createdAt' => '2024-03-26T10:10:41.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-04-04T06:11:11.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateVideoPlaylist'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:GenerateVideoPlaylist', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + ], + ], + 'GenerateWebofficeToken' => [ + 'summary' => 'Retrieves the preview and editing credentials for a document.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18307,308 +11196,205 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '161499', - 'abilityTreeNodes' => [ - 'FEATUREimm4TQO1Z', - ], + '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', - ], + 'schema' => ['title' => '', 'description' => 'The project name. For information about how to obtain the project name, see [Create a 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', - ], + 'schema' => ['title' => '', 'description' => 'The OSS URI of the document to preview or edit.'."\n" + ."\n" + .'The OSS URI follows the format `oss://${Bucket}/${Object}`, where `Bucket` is the name of an OSS bucket in the same region as the current project, and `Object` is the full path of the file including the file name 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', - ], + 'schema' => ['title' => '', 'description' => 'The file name, which must include the file name extension. The default value is the last segment of the **SourceURI** parameter.'."\n" + ."\n" + .'Supported file name extensions (PDF supports preview only):'."\n" + ."\n" + .'- Word documents: doc, docx, txt, dot, wps, wpt, dotx, docm, dotm, and rtf'."\n" + .'- PowerPoint documents: ppt, pptx, pptm, ppsx, ppsm, pps, potx, potm, dpt, and dps'."\n" + .'- Excel documents: et, xls, xlt, xlsx, xlsm, xltx, xltm, and 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', - ], + 'schema' => ['title' => '', 'description' => 'Specifies whether to enable cached preview.'."\n" + ."\n" + .'- true: When enabled, the document preview no longer updates collaborative editing content. This is suitable for preview-only scenarios.'."\n" + .'- false: When disabled, collaborative preview is used by default, which synchronizes collaborative editing content during preview.'."\n" + ."\n" + .'><notice>Cached preview and non-cached preview have different unit prices. For more information, see the billing item description.'."\n" + .'</notice>><notice>Cached preview does not support document content search or printing.</notice>'."\n" + .'<notice>Cached preview does not support updating cached content.</notice>.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ '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' => '*', - ], + 'schema' => ['title' => '', 'description' => 'The OSS hotlink protection referer. Intelligent Media Management (IMM) needs to retrieve the source file from OSS. If hotlink protection is configured for OSS, IMM must pass the corresponding header to OSS to retrieve the source file.'."\n" + .'> Set this parameter if the bucket that stores the document has a referer configured.', '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" - .'}', - ], + 'schema' => ['title' => '', 'description' => 'The custom user data. This parameter takes effect only when the Notification parameter is specified with MNS configurations. The data is returned in asynchronous message notifications for you to associate and process message notifications within your system. Maximum length: 2,048 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', - ], + 'schema' => ['title' => '', 'description' => 'The maximum number of pages that can be previewed. By default, no limit is imposed. The maximum value is 5,000.', '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', - ], + 'schema' => ['title' => '', 'description' => 'The password to open the document.'."\n" + .'> Set this parameter if you want to preview or edit a password-protected document.', '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', - ], + 'schema' => ['title' => '', 'description' => 'Specifies whether uploading a file with the same name to OSS is expected behavior. Valid values:'."\n" + ."\n" + .'- true: Uploading a file with the same name to OSS is expected behavior. The uploaded document overwrites the original document and generates a new version. After this parameter is set to true, you must first close the document that is being edited, wait about 5 minutes, and then reopen it to load the new document. The upload takes effect only when the document is closed. If the document is open, new saves overwrite the uploaded file.'."\n" + .'- false (default): Uploading a file with the same name to OSS is not expected behavior. The operation returns 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', - ], + 'schema' => ['title' => '', 'description' => 'Sends event notifications to you as MNS messages. This parameter specifies the MNS topic for 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', - ], + 'schema' => ['title' => '', 'description' => 'Specifies whether to hide the toolbar. This parameter is supported in document preview mode. Valid values:'."\n" + ."\n" + .'- false (default): The toolbar is not hidden.'."\n" + ."\n" + .'- true: The toolbar is hidden.', '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', - ], + 'schema' => ['title' => '', 'description' => 'The user permission information in JSON format.'."\n" + ."\n" + .'User permissions include the following options:'."\n" + ."\n" + .'Each option is of the Boolean type. The default value is false. Valid values: true and false.'."\n" + ."\n" + .'- Readonly (optional): Preview mode.'."\n" + ."\n" + .'- Rename (optional): The permission to rename a file. Only message notification is provided. The rename event is sent to MNS.'."\n" + ."\n" + .'- History (optional): The permission to view historical versions.'."\n" + ."\n" + .'- Copy (optional): The copy permission.'."\n" + ."\n" + .'- Export (optional): The permission to export to PDF.'."\n" + ."\n" + .'- Print (optional): The print permission.'."\n" + ."\n\n" + .'> PDF supports only the preview feature. You must set the Readonly parameter to true.'."\n" + .'>'."\n" + ."\n" + .'> PDF files do not support export.'."\n" + .'> '."\n" + ."\n" + .'> To use the versioning feature, you must first enable versioning 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>.', '$ref' => '#/components/schemas/WebofficePermission', 'required' => false, 'example' => ''], ], [ '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', - ], + 'schema' => ['title' => '', 'description' => 'The user information. You can pass in user information from the business side, and the WebOffice page displays this information.'."\n" + ."\n" + .'The system distinguishes different users by User.Id. User.Name is used only for frontend display. If User.Id is not specified, the backend automatically generates a random ID. Users with different IDs are treated as different principals and cannot modify or delete each other\'s comments.'."\n" + ."\n" + .'The default format is: Unknown_RandomString. If User.Id is not specified, the user information is displayed as "Unknown" by default.', '$ref' => '#/components/schemas/WebofficeUser', 'required' => false, 'example' => ''], ], [ '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', - ], + 'schema' => ['title' => '', 'description' => 'The watermark information. The watermark is generated on the frontend and is not written to the source document. Different parameters passed for the same document produce different watermarks.', '$ref' => '#/components/schemas/WebofficeWatermark', 'required' => false, 'example' => ''], ], [ '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', - ], + 'schema' => ['description' => '**Leave this parameter empty unless you have specific requirements.**'."\n" + ."\n" + .'The China authorization configuration. This parameter is optional. For more information, see [Use chained authorization to access resources of other entities](~~465340~~).', '$ref' => '#/components/schemas/CredentialConfig', 'required' => false, 'title' => '', 'example' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The notification configuration. Currently, only MNS is supported. For the format of asynchronous notification messages, see [WebOffice message notification format](~~2743999~~).'."\n" + ."\n" + .'> Message notifications are sent when a file is saved or renamed.', '$ref' => '#/components/schemas/Notification', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '文档转换任务', - 'description' => 'Weboffice access credentials.', + 'title' => '', + 'description' => 'The 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', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1759315A-CB33-0A75-A72B-62D7********'], + 'WebofficeURL' => ['title' => '', 'description' => 'The Weboffice entry URL for previewing or editing documents online.'."\n" + .'> This URL cannot be opened directly in a browser. You must use it together with the Weboffice JS-SDK and the access credential (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' => '', 'description' => 'The Weboffice access credential.', 'type' => 'string', 'example' => '2d73dd5d87524c5e8a194c3eb5********'], + 'RefreshToken' => ['title' => '', 'description' => 'The Weboffice refresh credential.', 'type' => 'string', 'example' => 'e374995ec532432bb678074d36********'], + 'AccessTokenExpiredTime' => ['title' => '', 'description' => 'The expiration time of the access credential. The credential expires in 30 minutes. Format: YYYY-MM-DDTHH:mm:ss.', 'type' => 'string', 'example' => '2021-08-30T13:13:11.347146982Z'], + 'RefreshTokenExpiredTime' => ['title' => '', 'description' => 'The expiration time of the refresh credential. The credential expires in 1 day. Format: YYYY-MM-DDTHH:mm:ss.', 'type' => 'string', 'example' => '2021-08-31T12:43:11.347146982Z'], ], + 'example' => '', ], ], 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" + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Retrieve weboffice credentials', + 'description' => '- **Before you use this operation, make sure that you are familiar with the billing of Intelligent Media Management. For more information, see [Pricing](~~477042~~)**.'."\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" + .'- Do not perform cross-border access on OSS files. For example, if a file is stored in a bucket in the Singapore region, do not initiate preview, read, or download requests from the Chinese mainland. In such scenarios, the network link quality is significantly affected by the cross-border network environment, which may cause increased access latency, preview failures, download interruptions, or unstable connections. Network stability and access experience cannot be guaranteed. Make sure that the access point and the bucket are in the same region to avoid uncertainties caused by cross-border access.'."\n" + .'- The access credential expires in 30 minutes, and the refresh credential expires in 1 day.'."\n" + .'- The returned expiration time is in UTC, which is 8 hours behind UTC+8.'."\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" + .' - Word documents: doc, docx, txt, dot, wps, wpt, dotx, docm, dotm, and rtf.'."\n" + .' - Presentation documents (PPT): ppt, pptx, pptm, ppsx, ppsm, pps, potx, potm, dpt, and dps.'."\n" + .' - Excel documents: et, xls, xlt, xlsx, xlsm, xltx, xltm, and 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" + .'- The maximum supported file size is 200 MB.'."\n" + .'- The maximum supported number of document pages is 5,000.'."\n" + .'- For projects created before December 1, 2023, billing is based on the number of document opens. Currently, billing is based on the number of API calls. To switch to the new billing mode, create a new project. Note that each API call can be used by only one user. If the call is reused, only the last user can access the document normally, and the access permissions of other users are 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" + .'- Activate Message Service (MNS) in the same region as Intelligent Media Management, create a topic and a queue, and configure a subscription. You can pass in the MNS topic name by using the NotifyTopicName parameter to receive message notifications about file saves. For more information about the MNS SDK, see [Receive and delete messages](~~32449~~).'."\n" + .'For an example of the JSON format of the Message field in file save message notifications, see [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" + .'> To use the versioning feature, you must first enable versioning in OSS and then set the History parameter to true.'."\n" + .'>.', + 'requestParamsDescription' => '#### Typical scenario examples'."\n" ."\n" - .'对于如下示例的参数结构，对一些经典的场景示例说明：'."\n" - .'##### 预览只读文件（如果是预览pdf文件，必须这样设置）'."\n" + .'The following examples describe some typical scenarios based on the parameter structure:'."\n" + .'##### Preview a read-only file (required for previewing PDF files)'."\n" ."\n" - .'文档预览模式，文档只能预览不可编辑规则：'."\n" + .'Document preview mode. The document can only be previewed and cannot be edited:'."\n" ."\n" .'```json'."\n" .' {'."\n" @@ -18620,9 +11406,9 @@ .'}'."\n" ."\n" .'```'."\n" - .'##### 预览文件后缀为大写的文件'."\n" + .'##### Preview a file with an uppercase file name extension'."\n" ."\n" - .'预览文件后缀为大写的文件，需要设置Filename参数后缀为小写：'."\n" + .'To preview a file with an uppercase file name extension, set the Filename parameter with a lowercase extension:'."\n" ."\n" .'```json'."\n" .' {'."\n" @@ -18634,9 +11420,9 @@ .'}'."\n" ."\n" .'```'."\n" - .'##### 对指定文档只预览前5页'."\n" + .'##### Preview only the first 5 pages of a document'."\n" ."\n" - .'文档一共10页，只显示前5页规则：'."\n" + .'The document has 10 pages in total. Only the first 5 pages are displayed:'."\n" ."\n" .'```json'."\n" .' {'."\n" @@ -18648,9 +11434,9 @@ .'}'."\n" ."\n" .'```'."\n" - .'##### 对指定文档预览添加密码'."\n" + .'##### Set a password for document preview'."\n" ."\n" - .'文档预览时设置密码，或者源文件设置了密码预览时直接打开不需要密码规则：'."\n" + .'Set a password for document preview, or directly open a password-protected source file without requiring a password:'."\n" ."\n" .'```json'."\n" .' {'."\n" @@ -18661,9 +11447,9 @@ .' "Permission" : "{\'Readonly\':\'true\'}"'."\n" .'}'."\n" .'```'."\n" - .'##### 对指定的文档预览添加水印'."\n" + .'##### Add a watermark to document preview'."\n" ."\n" - .'文档预览时添加水印规则：'."\n" + .'Add a watermark when previewing a document:'."\n" ."\n" .'```json'."\n" .' {'."\n" @@ -18674,9 +11460,9 @@ .' "Permission" : "{\'Readonly\':\'true\'}"'."\n" .'}'."\n" .'```'."\n" - .'##### 对指定的文档预览时隐藏工具栏'."\n" + .'##### Hide the toolbar during document preview'."\n" ."\n" - .'文档预览时隐藏工具栏规则：'."\n" + .'Hide the toolbar when previewing a document:'."\n" ."\n" .'```json'."\n" .' {'."\n" @@ -18687,9 +11473,9 @@ .' "Permission" : "{\'Readonly\':\'true\'}"'."\n" .'}'."\n" .'```'."\n" - .'##### 对指定的文档进行在线编辑，查看历史版本，拷贝，打印，导出PDF权限'."\n" + .'##### Edit a document online with permissions to view historical versions, copy, print, and export to PDF'."\n" ."\n" - .'文档在线编辑，查看历史版本，拷贝，打印，导出PDF权限规则：'."\n" + .'Edit a document online with permissions to view historical versions, copy, print, and export to PDF:'."\n" ."\n" .'```json'."\n" .' {'."\n" @@ -18698,759 +11484,934 @@ .' "Filename" : "test-object.docx",'."\n" .' "Permission" : "{\'Readonly\':\'false\',\'History\':\'true\',\'Copy\':\'true\',\'Print\':\'true\',\'Export\':\'true\'}"'."\n" .'}'."\n" - .'```', - 'responseParamsDescription' => '**常见错误**'."\n" + .'```.', + 'responseParamsDescription' => '**Common errors**.'."\n" ."\n" - .'ProjectName对应的项目未找到，请到新版本IMM控制台检查地域下该项目是否存在。'."\n" + .'The project specified by ProjectName is not found. Go to the IMM console and check whether the project exists in the region.'."\n" .'```'."\n" .'{'."\n" .' "Code": "ResourceNotFound",'."\n" .' "Message": "The specified resource acs:imm::xxx:project/xxx is not found"'."\n" .'}'."\n" - .'```'."\n" + .'```.'."\n" ."\n" - .'User参数是必填参数，请检查该参数是否填写。'."\n" + .'The User parameter is required. Check whether this parameter is specified.'."\n" .'```'."\n" .'{'."\n" .' "Code": "InvalidArgument.User",'."\n" .' "Message": "The parameter User is required but not provided"'."\n" .'}'."\n" - .'```'."\n" + .'```.'."\n" ."\n" - .'User参数不正确，请检查该参数值是否是正确的JSON格式。'."\n" + .'The User parameter is invalid. Check whether the parameter value is in valid JSON format.'."\n" .'```'."\n" .'{'."\n" .' "Code": "InvalidJSON parsing error, User",'."\n" .' "Message": "Specified parameter JSON parsing error, User is not valid."'."\n" .'}'."\n" - .'```'."\n" + .'```.'."\n" ."\n" - .'Permission参数不正确，请检查该参数值是否是正确的JSON格式。'."\n" + .'The Permission parameter is invalid. Check whether the parameter value is in valid JSON format.'."\n" .'```'."\n" .'{'."\n" .' "Code": "InvalidJSON parsing error, Permission",'."\n" .' "Message": "Specified parameter JSON parsing error, Permission is not valid."'."\n" .'}'."\n" - .'```'."\n" + .'```.'."\n" ."\n" - .'Watermark参数不正确，请检查该参数值是否是正确的JSON格式。'."\n" + .'The Watermark parameter is invalid. Check whether the parameter value is in valid JSON format.'."\n" .'```'."\n" .'{'."\n" .' "Code": "InvalidJSON parsing error, Watermark",'."\n" .' "Message": "Specified parameter JSON parsing error, Watermark is not valid."'."\n" .'}'."\n" - .'```'."\n" + .'```.'."\n" ."\n" - .'PreviewPages参数格式不正确，请检查PreviewPages参数值。'."\n" + .'The PreviewPages parameter format is invalid. Check the PreviewPages parameter value.'."\n" .'``` '."\n" .'{'."\n" .' "Code": "InvalidPreviewPages",'."\n" .' "Message": "Specified parameter PreviewPages is not valid."'."\n" .'}'."\n" - .'```'."\n" + .'```.'."\n" ."\n" - .'SourceURI对应的OSS文件不存在，请检查Bucket下该文件是否存在。'."\n" + .'The OSS file specified by SourceURI does not exist. Check whether the file exists in the 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', + .'```.', + 'extraInfo' => '### Related documentation '."\n" + .' - For more information about OSS versioning, see [Overview of versioning](~~109695~~).'."\n" + .' - For more information about OSS hotlink protection, see [Use hotlink protection to prevent unauthorized traffic](~~31869~~).', + 'changeSet' => [ + ['createdAt' => '2023-08-30T08:32:41.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-03-09T10:57:42.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateWebofficeToken'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:GenerateWebofficeToken', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + ], + 'GetBatch' => [ + 'summary' => 'Queries the information about a batch processing task.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '39679', - 'abilityTreeNodes' => [ - 'FEATUREimm4TQO1Z', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '131105', + 'abilityTreeNodes' => ['FEATUREimmTATRRB'], ], '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', - ], + 'schema' => ['description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'AccessToken', + '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' => 'access token', - 'description' => 'Weboffice access token. Obtain it through the [GenerateWebofficeToken](~~478226~~) or [RefreshWebofficeToken](~~478227~~) interfaces.', - 'type' => 'string', - 'required' => true, - 'example' => '99d1b8b478b641c1b3372f5bd6********', + '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', 'title' => '', 'example' => ''], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****'], + ], + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Batch\\": {\\n \\"Id\\": \\"trigger-9f72636a-0f0c-4baf-ae78-38b27bfe****\\",\\n \\"Input\\": {\\n \\"OSS\\": {\\n \\"Bucket\\": \\"test-bucket\\",\\n \\"Prefix\\": \\"test-object\\",\\n \\"MatchExpressions\\": [\\n \\"key prefix (abc)\\"\\n ]\\n }\\n },\\n \\"Actions\\": [\\n {\\n \\"Name\\": \\"doc/convert\\",\\n \\"Parameters\\": [\\n \\"pages=3\\"\\n ],\\n \\"FastFailPolicy\\": {\\n \\"Action\\": \\"abort\\"\\n }\\n }\\n ],\\n \\"Notification\\": {\\n \\"Endpoint\\": \\"http://1111111111.mns.cn-hangzhou.aliyuncs.com\\",\\n \\"Topic\\": \\"topic1\\",\\n \\"MNS\\": {\\n \\"TopicName\\": \\"topic1\\",\\n \\"Endpoint\\": \\"http://1111111111.mns.cn-hangzhou.aliyuncs.com\\"\\n },\\n \\"RocketMQ\\": {\\n \\"Endpoint\\": \\"http://11111111111.mqrest.cn-hangzhou.aliyuncs.com\\",\\n \\"TopicName\\": \\"topic1\\",\\n \\"InstanceId\\": \\"MQ_INST_11111111111_BYcNy2Nc\\"\\n }\\n },\\n \\"Statistic\\": {\\n \\"SubmitSuccess\\": 10,\\n \\"SubmitFailure\\": 1,\\n \\"SkipFiles\\": 0\\n },\\n \\"State\\": \\"Succeeded\\",\\n \\"Marker\\": \\"MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****\\",\\n \\"CreateTime\\": \\"2020-11-10T03:50:28Z\\",\\n \\"UpdateTime\\": \\"2021-12-18T07:40:29Z\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Error\\": \\"api returns error: SDKError: StatusCode: 404 Code: ResourceNotFound\\",\\n \\"Phase\\": \\"IncrementalScanning\\",\\n \\"ServiceRole\\": \\"AliyunIMMBatchTriggerRole\\"\\n },\\n \\"RequestId\\": \\"6E93D6C9-5AC0-49F9-914D-E02678D3****\\"\\n}","type":"json"}]', + 'title' => 'GetBatch', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBatch'], + ], + ], + 'ramActions' => [ [ - '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********', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetBatch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Batch', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/batch/*'], + ], ], ], + ], + ], + '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' => 'CredentialConfig', + 'name' => 'ProjectName', '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', - ], + 'schema' => ['description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], + ], + [ + '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.', 'type' => 'string', 'required' => false, 'example' => 'test-dataset', 'title' => ''], + ], + [ + '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.', 'type' => 'string', 'required' => false, 'example' => 'oss://test-bucket', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '文档转换任务', - 'description' => 'Weboffice Access Token', + 'title' => 'Schema of Response', + 'description' => 'The returned data.', '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', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'AEFCD467-C928-4A36-951A-6EB5A592****'], + 'Binding' => ['description' => 'The details of the binding.', '$ref' => '#/components/schemas/Binding', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], - 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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AEFCD467-C928-4A36-951A-6EB5A592****\\",\\n \\"Binding\\": {\\n \\"ProjectName\\": \\"immtest\\",\\n \\"DatasetName\\": \\"dataset001\\",\\n \\"URI\\": \\"oss://examplebucket\\",\\n \\"State\\": \\"Running\\",\\n \\"Phase\\": \\"FullScanning\\",\\n \\"CreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"UpdateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"Reason\\": \\"pause usage\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetBinding', + 'description' => '- **Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).**'."\n" + ."\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~~).', + 'changeSet' => [ + ['createdAt' => '2024-09-03T10:58:54.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-06-15T02:14:00.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBinding'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetBinding', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + ], + ], + 'GetDataset' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '129600', - 'abilityTreeNodes' => [ - 'FEATUREimmV2RAAA', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREimmSZD9WY'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'title' => '项目名称', - 'description' => 'The name of the project.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'immtest', - ], + 'schema' => ['description' => 'The name of the project. You can obtain the name of the project from the response of the [CreateProject](~~478153~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'immtest', 'title' => ''], ], [ - 'name' => 'SourceURI', + 'name' => 'DatasetName', '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', - ], + 'schema' => ['description' => 'The name of the dataset. You can obtain the name of the dataset from the response of the [CreateDataset](~~478160~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'dataset001', 'title' => ''], ], [ - 'name' => 'Sources', - 'in' => 'formData', - 'style' => 'json', + '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" + ."\n" + .'- If you set the value to false, FileCount and TotalFileSize in the response return invalid values or 0.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ '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, + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6D74B3A9-5AC0-49F9-914D-E01589D3****', 'title' => ''], + 'Dataset' => ['description' => 'The dataset.', '$ref' => '#/components/schemas/Dataset', 'title' => '', 'example' => ''], ], - 'required' => false, - 'example' => 'oss://imm-test/test.pptx', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'GetDataset', + 'summary' => 'Queries a dataset.', + 'description' => '- Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).\\*\\*\\*\\*'."\n" + ."\n" + .'- The GetDataset operation supports real-time retrieval of file statistics. You can specify WithStatistics to enable real-time retrieval of file statistics.', + 'changeSet' => [ + ['createdAt' => '2021-06-15T02:14:12.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDataset'], + ], + ], + 'ramActions' => [ [ - '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}', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetDataset', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], ], ], + ], + ], + 'GetDecodeBlindWatermarkResult' => [ + 'summary' => 'Retrieves the result of a blind watermark extraction task for an image.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - '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/', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'abilityTreeCode' => '204408', + 'abilityTreeNodes' => ['FEATUREimmSCVT08'], + ], + 'parameters' => [ [ - 'name' => 'SourceType', + 'name' => 'ProjectName', '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', - ], + 'schema' => ['description' => 'The project name. For information about how to obtain the project name, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'immtest', 'title' => ''], ], [ - 'name' => 'TargetType', + 'name' => 'TaskType', '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", + 'description' => 'The task type.', + 'enumValueTitles' => ['DecodeBlindWatermark' => 'DecodeBlindWatermark'], 'type' => 'string', 'required' => true, - 'example' => 'png', + 'example' => 'DecodeBlindWatermark', + 'title' => '', ], ], [ - 'name' => 'UserData', + 'name' => 'TaskId', 'in' => 'query', + 'schema' => ['description' => 'The task ID. You can obtain the task ID from the response parameters of the blind watermark extraction task creation operation.', 'type' => 'string', 'required' => true, 'example' => 'DecodeBlindWatermark-c09b0943-ed79-4983-8dbe-7a882574****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ '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"}', + 'title' => '', + 'description' => 'The watermark extraction result.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '93126E40-0296-4129-95E3-AFAC709372E5'], + 'ProjectName' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'test-project', 'title' => ''], + 'EventId' => ['description' => 'The event ID.', 'type' => 'string', 'example' => '2C2-1I0EG57VR37J4rQ8oKG6C9*****', 'title' => ''], + 'Status' => ['description' => 'The task status.', 'type' => 'string', 'example' => 'Succeeded', 'title' => ''], + 'Code' => ['description' => 'The task error code.', 'type' => 'string', 'example' => 'ResourceNotFound', 'title' => ''], + 'Message' => ['description' => 'The task error message.', 'type' => 'string', 'example' => 'The specified resource project is not found.', 'title' => ''], + 'StartTime' => ['description' => 'The time when the task started. The time is in the ISO 8601 UTC timestamp format with millisecond precision.', 'type' => 'string', 'example' => '2024-03-03T09:44:31.029Z', 'title' => ''], + 'EndTime' => ['description' => 'The time when the task ended. The time is in the ISO 8601 UTC timestamp format with millisecond precision.', 'type' => 'string', 'example' => '2024-03-03T09:45:56.87Z', 'title' => ''], + 'UserData' => ['description' => 'The custom information.', 'type' => 'string', 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', 'title' => ''], + 'TaskType' => ['description' => 'The task type.', 'type' => 'string', 'example' => 'DecodeBlindWatermark', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'DecodeBlindWatermark-c09b0943-ed79-4983-8dbe-7a882574****', 'title' => ''], + 'Content' => ['description' => 'The watermark content.', 'type' => 'string', 'example' => '阿里云版权所有', 'title' => ''], + ], + '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' => 'Get blind watermark extraction task result', + 'description' => '- Before you call this operation, make sure that you have created a project in Intelligent Media Management (IMM). For more information, see [Create a project](~~478153~~).'."\n" + .'- Before you call this operation, make sure that you have created a blind watermark extraction task for an image and obtained the `TaskId` of the task.', + 'changeSet' => [ + ['createdAt' => '2024-04-19T07:28:03.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDecodeBlindWatermarkResult'], + ], + ], + 'ramActions' => [ [ - '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"}', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:GetDecodeBlindWatermarkResult', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'GetFigureCluster' => [ + 'summary' => 'Obtains basic information about face clustering, including the creation time, number of images, and cover.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'StartPage', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '103841', + 'abilityTreeNodes' => ['FEATUREimm3DNGQD'], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', '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', - ], + 'schema' => ['description' => 'The project name.[](~~CreateProject~~)', 'type' => 'string', 'required' => true, 'example' => 'immtest', 'title' => ''], ], [ - 'name' => 'EndPage', + 'name' => 'DatasetName', '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', - ], + 'schema' => ['description' => 'The dataset name.[](~~CreateDataset~~)', 'type' => 'string', 'required' => true, 'example' => 'dataset001', 'title' => ''], ], [ - 'name' => 'Password', + '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.', 'type' => 'string', 'required' => true, 'example' => 'Cluster-1f2e1a2c-d5ee-4bc5-84f6-fef94ea****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ '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' => '********', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5F74C5C9-5AC0-49F9-914D-E01589D3****'], + 'FigureCluster' => ['description' => 'The information about the face cluster.', '$ref' => '#/components/schemas/FigureCluster', 'title' => '', 'example' => ''], + ], + 'example' => '', ], ], + ], + 'title' => 'GetFigureCluster', + 'description' => '- **Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).**'."\n" + ."\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~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFigureCluster'], + ], + ], + 'ramActions' => [ [ - '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', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetFigureCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5F74C5C9-5AC0-49F9-914D-E01589D3****\\",\\n \\"FigureCluster\\": {\\n \\"OwnerId\\": \\"102321002****\\",\\n \\"ProjectName\\": \\"immtest\\",\\n \\"DatasetName\\": \\"dataset001\\",\\n \\"ObjectType\\": \\"figure-cluster\\",\\n \\"ObjectId\\": \\"Cluster-ae6e3472-999e-410b-b54e-cd5dba****\\",\\n \\"UpdateTime\\": \\"2022-01-14T10:10:52.83948013+08:00\\",\\n \\"CreateTime\\": \\"2022-01-14T10:10:52.83948013+08:00\\",\\n \\"Name\\": \\"abc\\",\\n \\"Gender\\": \\"female\\",\\n \\"FaceCount\\": 3,\\n \\"ImageCount\\": 5,\\n \\"VideoCount\\": 3,\\n \\"AverageAge\\": 26,\\n \\"MinAge\\": 12,\\n \\"MaxAge\\": 44,\\n \\"Cover\\": {\\n \\"OwnerId\\": \\"102321002467****\\",\\n \\"ProjectName\\": \\"test-project\\",\\n \\"DatasetName\\": \\"test-dataset\\",\\n \\"ObjectType\\": \\"file\\",\\n \\"ObjectId\\": \\"75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7\\",\\n \\"UpdateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"CreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"URI\\": \\"oss://test-bucket/test-object.jpg\\",\\n \\"OSSURI\\": \\"oss://examplebucket/sampleobject.jpg\\",\\n \\"Filename\\": \\"sampleobject.jpg\\",\\n \\"MediaType\\": \\"image\\",\\n \\"ContentType\\": \\"image/jpeg\\",\\n \\"Size\\": 1000,\\n \\"FileHash\\": \\"1d9c280a7c4f67f7ef873e28449dbe17\\",\\n \\"FileModifiedTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileCreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileAccessTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"ProduceTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"LatLong\\": \\"30.134390,120.074997\\",\\n \\"Timezone\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"AddressLine\\": \\"中国浙江省杭州市余杭区文一西路969号\\",\\n \\"Country\\": \\"中国\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"District\\": \\"余杭区\\",\\n \\"Township\\": \\"文一西路\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"-\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"868a9e74-cde5-4c7a-9013-28bb984****\\",\\n \\"FigureConfidence\\": 1,\\n \\"FigureClusterId\\": \\"Cluster-dbe72fec-b84c-4ab6-885b-3678e64****\\",\\n \\"FigureClusterConfidence\\": 1,\\n \\"FigureType\\": \\"face\\",\\n \\"Age\\": 29,\\n \\"AgeSD\\": 5,\\n \\"Gender\\": \\"female\\",\\n \\"GenderConfidence\\": 1,\\n \\"Emotion\\": \\"happiness\\",\\n \\"EmotionConfidence\\": 0.70784568786621,\\n \\"FaceQuality\\": 0.960875928401947,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n },\\n \\"Mouth\\": \\"close\\",\\n \\"MouthConfidence\\": 1,\\n \\"Beard\\": \\"none\\",\\n \\"BeardConfidence\\": 1,\\n \\"Hat\\": \\"none\\",\\n \\"HatConfidence\\": 1,\\n \\"Mask\\": \\"none\\",\\n \\"MaskConfidence\\": 1,\\n \\"Glasses\\": \\"none\\",\\n \\"GlassesConfidence\\": 0.8,\\n \\"Sharpness\\": 0.7,\\n \\"Attractive\\": 0.96,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 18.385589599609375,\\n \\"Roll\\": 4.204030513763428,\\n \\"Yaw\\": 2.4945924282073975\\n }\\n }\\n ],\\n \\"FigureCount\\": 10,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"座椅\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Title\\": \\"test\\",\\n \\"ImageWidth\\": 270,\\n \\"ImageHeight\\": 500,\\n \\"EXIF\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.736\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 1080,\\n \\"VideoHeight\\": 1920,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"CodecTimeBase\\": \\"1373627/83160000\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"Width\\": 1280,\\n \\"Height\\": 720,\\n \\"HasBFrames\\": 2,\\n \\"SampleAspectRatio\\": \\"1:1\\",\\n \\"DisplayAspectRatio\\": \\"16:9\\",\\n \\"PixelFormat\\": \\"yuv420p\\",\\n \\"Level\\": 40,\\n \\"FrameRate\\": \\"25/1\\",\\n \\"AverageFrameRate\\": \\"25/1\\",\\n \\"TimeBase\\": \\"1/12800\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 22.88,\\n \\"Bitrate\\": 5407765,\\n \\"FrameCount\\": 572,\\n \\"Rotate\\": \\"90\\",\\n \\"BitDepth\\": 8,\\n \\"ColorSpace\\": \\"bt709\\",\\n \\"ColorRange\\": \\"tv\\",\\n \\"ColorTransfer\\": \\"bt709\\",\\n \\"ColorPrimaries\\": \\"bt709\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 2,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"mov_text\\",\\n \\"CodecLongName\\": \\"MOV text\\",\\n \\"CodecTagString\\": \\"tx3g\\",\\n \\"CodecTag\\": \\"0x67337874\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 71.378,\\n \\"Bitrate\\": 74,\\n \\"Content\\": \\"欢迎\\",\\n \\"Width\\": 600,\\n \\"Height\\": 30\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 1,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"TimeBase\\": \\"1/48000\\",\\n \\"StartTime\\": 0.0235,\\n \\"Duration\\": 3.690667,\\n \\"Bitrate\\": 320087,\\n \\"FrameCount\\": 173,\\n \\"Lyric\\": \\"test\\",\\n \\"SampleFormat\\": \\"fltp\\",\\n \\"SampleRate\\": 48000,\\n \\"Channels\\": 2,\\n \\"ChannelLayout\\": \\"stereo\\"\\n }\\n ],\\n \\"Artist\\": \\"Jane\\",\\n \\"AlbumArtist\\": \\"Jane\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 500,\\n \\"ImageHeight\\": 820,\\n \\"EXIF\\": \\"{\\\\\\"FileSize\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"29304\\\\\\"},\\\\\\"Format\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"jpg\\\\\\"}}\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.736\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"Jane\\",\\n \\"Performer\\": \\"Jane\\",\\n \\"Language\\": \\"eng\\",\\n \\"Album\\": \\"FirstAlbum\\",\\n \\"PageCount\\": 5,\\n \\"ETag\\": \\"\\\\\\"1D9C280A7C4F67F7EF873E28449****\\\\\\"\\",\\n \\"CacheControl\\": \\"no-cache\\",\\n \\"ContentDisposition\\": \\"attachment; filename =test.jpg\\",\\n \\"ContentEncoding\\": \\"UTF-8\\",\\n \\"ContentLanguage\\": \\"zh-CN\\",\\n \\"AccessControlAllowOrigin\\": \\"https://aliyundoc.com\\",\\n \\"AccessControlRequestMethod\\": \\"PUT\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"SM4\\",\\n \\"ServerSideEncryption\\": \\"AES256\\",\\n \\"ServerSideDataEncryption\\": \\"SM4\\",\\n \\"ServerSideEncryptionKeyId\\": \\"9468da86-3509-4f8d-a61e-6eab1eac****\\",\\n \\"OSSStorageClass\\": \\"Standard\\",\\n \\"OSSCRC64\\": \\"559890638950338001\\",\\n \\"ObjectACL\\": \\"default\\",\\n \\"ContentMd5\\": \\"HZwoCnxPZ/fvhz4oRJ2+Fw==\\",\\n \\"OSSUserMeta\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSTaggingCount\\": 2,\\n \\"OSSTagging\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSExpiration\\": \\"2120-01-01T12:00:00.000Z\\",\\n \\"OSSVersionId\\": \\"CAEQNhiBgMDJgZCA0BYiIDc4MGZjZGI2OTBjOTRmNTE5NmU5NmFhZjhjYmY0****\\",\\n \\"OSSDeleteMarker\\": \\"CAEQMhiBgIDXiaaB0BYiIGQzYmRkZGUxMTM1ZDRjOTZhNjk4YjRjMTAyZjhl****\\",\\n \\"OSSObjectType\\": \\"Normal\\",\\n \\"CustomId\\": \\"\\\\t\\\\nmember-image-id-0001\\",\\n \\"CustomLabels\\": {\\n \\"MemberName\\": \\"Tim\\",\\n \\"Enabled\\": \\"True\\",\\n \\"ItemCount\\": \\"10\\"\\n },\\n \\"StreamCount\\": 1,\\n \\"ProgramCount\\": 1,\\n \\"FormatName\\": \\"mov\\",\\n \\"FormatLongName\\": \\"QuickTime / MOV\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 13091201,\\n \\"Duration\\": 15.263,\\n \\"SemanticTypes\\": [\\n \\"content\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"text\\",\\n \\"Content\\": \\"文本片段\\",\\n \\"URL\\": \\"http://aliyun.com\\",\\n \\"TimeRange\\": [\\n 500\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"id1\\",\\n \\"ElementType\\": \\"title - 标题； image - 图片 ； table - 表格 ； narrative-text - 正文\\",\\n \\"SemanticSimilarity\\": 0.8,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"child，parent\\",\\n \\"ObjectId\\": \\"id1\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ],\\n \\"FrameTimes\\": [\\n 30\\n ],\\n \\"VideoStreamIndex\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"座椅\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"OCRTexts\\": \\"阿里云IMM\\",\\n \\"Reason\\": \\"[InternalError] The request has been failed due to some unknown error. status: 500, requestId: CC5ACFBD-BB7A-496D-A9D6-****\\",\\n \\"ObjectStatus\\": \\"Indexed\\",\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"无。\\",\\n \\"Caption\\": \\"视频中展示了两个不同场景：一个是静止的白色盘子、黑色瓶子和透明玻璃杯，另一个是手拿着标有“YEZOLU”的洗发水瓶在浴室中缓慢上移。\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"无。\\",\\n \\"Description\\": \\"图片中有一人，穿着深色西装外套，内搭白色衬衫。背景为渐变的浅蓝色至灰色。\\"\\n }\\n }\\n },\\n \\"CustomId\\": \\"abc\\",\\n \\"CustomLabels\\": {\\n \\"Bucket\\": \\"examplebucket\\"\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n}","type":"json"}]', + ], + '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' => 'Quality', + 'name' => 'ProjectName', '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', - ], + 'schema' => ['description' => 'The name of the project.[](~~478153~~)', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'Pages', + 'name' => 'DatasetName', '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', - ], + 'schema' => ['description' => 'The name of the dataset.[](~~478160~~)', 'type' => 'string', 'required' => true, 'example' => 'test-dataset', 'title' => ''], ], [ - 'name' => 'MaxSheetRow', + 'name' => 'URI', '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" + 'description' => 'The URI of the file. Make sure that the file is indexed\\*\\*\\*\\*.'."\n" ."\n" - .'> This parameter takes effect only when the **LongPicture** parameter is set to `true`.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', + .'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.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-object', + 'title' => '', ], ], [ - 'name' => 'MaxSheetColumn', + 'name' => 'WithFields', 'in' => 'query', + 'style' => 'json', '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" + '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" - .'> This parameter takes effect only when the **LongPicture** parameter is set to `true`.'."\n", - 'type' => 'integer', - 'format' => 'int64', + .'If you do not specify this parameter or leave this parameter empty, the operation returns all metadata fields of the file.', + '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.', 'type' => 'string', 'required' => false, 'example' => 'Size', 'title' => ''], 'required' => false, - 'example' => '10', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'SheetCount', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ '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', + 'title' => 'Schema of Response', + 'description' => 'The data structure returned.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7F84C6D9-5AC0-49F9-914D-F02678E3****'], + 'Files' => [ + 'title' => 'File list.', + 'description' => 'The metadata returned.', + '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.', '$ref' => '#/components/schemas/File', 'title' => '', 'example' => ''], + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'title' => 'GetFileMeta', + 'description' => '- Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).\\*\\*\\*\\*'."\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" + .'- 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.', + 'changeSet' => [ + ['createdAt' => '2024-07-30T05:45:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-06-15T02:14:00.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFileMeta'], + ], + ], + 'ramActions' => [ [ - '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', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetFileMeta', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F84C6D9-5AC0-49F9-914D-F02678E3****\\",\\n \\"Files\\": [\\n {\\n \\"OwnerId\\": \\"102321002467****\\",\\n \\"ProjectName\\": \\"test-project\\",\\n \\"DatasetName\\": \\"test-dataset\\",\\n \\"ObjectType\\": \\"file\\",\\n \\"ObjectId\\": \\"75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7\\",\\n \\"UpdateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"CreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"URI\\": \\"oss://test-bucket/test-object.jpg\\",\\n \\"OSSURI\\": \\"oss://examplebucket/sampleobject.jpg\\",\\n \\"Filename\\": \\"sampleobject.jpg\\",\\n \\"MediaType\\": \\"image\\",\\n \\"ContentType\\": \\"image/jpeg\\",\\n \\"Size\\": 1000,\\n \\"FileHash\\": \\"1d9c280a7c4f67f7ef873e28449dbe17\\",\\n \\"FileModifiedTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileCreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileAccessTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"ProduceTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"LatLong\\": \\"30.134390,120.074997\\",\\n \\"Timezone\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"AddressLine\\": \\"中国浙江省杭州市余杭区文一西路969号\\",\\n \\"Country\\": \\"中国\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"District\\": \\"余杭区\\",\\n \\"Township\\": \\"文一西路\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"-\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"868a9e74-cde5-4c7a-9013-28bb984****\\",\\n \\"FigureConfidence\\": 1,\\n \\"FigureClusterId\\": \\"Cluster-dbe72fec-b84c-4ab6-885b-3678e64****\\",\\n \\"FigureClusterConfidence\\": 1,\\n \\"FigureType\\": \\"face\\",\\n \\"Age\\": 29,\\n \\"AgeSD\\": 5,\\n \\"Gender\\": \\"female\\",\\n \\"GenderConfidence\\": 1,\\n \\"Emotion\\": \\"happiness\\",\\n \\"EmotionConfidence\\": 0.70784568786621,\\n \\"FaceQuality\\": 0.960875928401947,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n },\\n \\"Mouth\\": \\"close\\",\\n \\"MouthConfidence\\": 1,\\n \\"Beard\\": \\"none\\",\\n \\"BeardConfidence\\": 1,\\n \\"Hat\\": \\"none\\",\\n \\"HatConfidence\\": 1,\\n \\"Mask\\": \\"none\\",\\n \\"MaskConfidence\\": 1,\\n \\"Glasses\\": \\"none\\",\\n \\"GlassesConfidence\\": 0.8,\\n \\"Sharpness\\": 0.7,\\n \\"Attractive\\": 0.96,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 18.385589599609375,\\n \\"Roll\\": 4.204030513763428,\\n \\"Yaw\\": 2.4945924282073975\\n }\\n }\\n ],\\n \\"FigureCount\\": 10,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"座椅\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Title\\": \\"test\\",\\n \\"ImageWidth\\": 270,\\n \\"ImageHeight\\": 500,\\n \\"EXIF\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.736\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 1080,\\n \\"VideoHeight\\": 1920,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"CodecTimeBase\\": \\"1373627/83160000\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"Width\\": 1280,\\n \\"Height\\": 720,\\n \\"HasBFrames\\": 2,\\n \\"SampleAspectRatio\\": \\"1:1\\",\\n \\"DisplayAspectRatio\\": \\"16:9\\",\\n \\"PixelFormat\\": \\"yuv420p\\",\\n \\"Level\\": 40,\\n \\"FrameRate\\": \\"25/1\\",\\n \\"AverageFrameRate\\": \\"25/1\\",\\n \\"TimeBase\\": \\"1/12800\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 22.88,\\n \\"Bitrate\\": 5407765,\\n \\"FrameCount\\": 572,\\n \\"Rotate\\": \\"90\\",\\n \\"BitDepth\\": 8,\\n \\"ColorSpace\\": \\"bt709\\",\\n \\"ColorRange\\": \\"tv\\",\\n \\"ColorTransfer\\": \\"bt709\\",\\n \\"ColorPrimaries\\": \\"bt709\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 2,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"mov_text\\",\\n \\"CodecLongName\\": \\"MOV text\\",\\n \\"CodecTagString\\": \\"tx3g\\",\\n \\"CodecTag\\": \\"0x67337874\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 71.378,\\n \\"Bitrate\\": 74,\\n \\"Content\\": \\"欢迎\\",\\n \\"Width\\": 600,\\n \\"Height\\": 30\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 1,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"TimeBase\\": \\"1/48000\\",\\n \\"StartTime\\": 0.0235,\\n \\"Duration\\": 3.690667,\\n \\"Bitrate\\": 320087,\\n \\"FrameCount\\": 173,\\n \\"Lyric\\": \\"test\\",\\n \\"SampleFormat\\": \\"fltp\\",\\n \\"SampleRate\\": 48000,\\n \\"Channels\\": 2,\\n \\"ChannelLayout\\": \\"stereo\\"\\n }\\n ],\\n \\"Artist\\": \\"Jane\\",\\n \\"AlbumArtist\\": \\"Jane\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 500,\\n \\"ImageHeight\\": 820,\\n \\"EXIF\\": \\"{\\\\\\"FileSize\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"29304\\\\\\"},\\\\\\"Format\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"jpg\\\\\\"}}\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.736\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"Jane\\",\\n \\"Performer\\": \\"Jane\\",\\n \\"Language\\": \\"eng\\",\\n \\"Album\\": \\"FirstAlbum\\",\\n \\"PageCount\\": 5,\\n \\"ETag\\": \\"\\\\\\"1D9C280A7C4F67F7EF873E28449****\\\\\\"\\",\\n \\"CacheControl\\": \\"no-cache\\",\\n \\"ContentDisposition\\": \\"attachment; filename =test.jpg\\",\\n \\"ContentEncoding\\": \\"UTF-8\\",\\n \\"ContentLanguage\\": \\"zh-CN\\",\\n \\"AccessControlAllowOrigin\\": \\"https://aliyundoc.com\\",\\n \\"AccessControlRequestMethod\\": \\"PUT\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"SM4\\",\\n \\"ServerSideEncryption\\": \\"AES256\\",\\n \\"ServerSideDataEncryption\\": \\"SM4\\",\\n \\"ServerSideEncryptionKeyId\\": \\"9468da86-3509-4f8d-a61e-6eab1eac****\\",\\n \\"OSSStorageClass\\": \\"Standard\\",\\n \\"OSSCRC64\\": \\"559890638950338001\\",\\n \\"ObjectACL\\": \\"default\\",\\n \\"ContentMd5\\": \\"HZwoCnxPZ/fvhz4oRJ2+Fw==\\",\\n \\"OSSUserMeta\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSTaggingCount\\": 2,\\n \\"OSSTagging\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSExpiration\\": \\"2120-01-01T12:00:00.000Z\\",\\n \\"OSSVersionId\\": \\"CAEQNhiBgMDJgZCA0BYiIDc4MGZjZGI2OTBjOTRmNTE5NmU5NmFhZjhjYmY0****\\",\\n \\"OSSDeleteMarker\\": \\"CAEQMhiBgIDXiaaB0BYiIGQzYmRkZGUxMTM1ZDRjOTZhNjk4YjRjMTAyZjhl****\\",\\n \\"OSSObjectType\\": \\"Normal\\",\\n \\"CustomId\\": \\"\\\\t\\\\nmember-image-id-0001\\",\\n \\"CustomLabels\\": {\\n \\"MemberName\\": \\"Tim\\",\\n \\"Enabled\\": \\"True\\",\\n \\"ItemCount\\": \\"10\\"\\n },\\n \\"StreamCount\\": 1,\\n \\"ProgramCount\\": 1,\\n \\"FormatName\\": \\"mov\\",\\n \\"FormatLongName\\": \\"QuickTime / MOV\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 13091201,\\n \\"Duration\\": 15.263,\\n \\"SemanticTypes\\": [\\n \\"content\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"text\\",\\n \\"Content\\": \\"文本片段\\",\\n \\"URL\\": \\"http://aliyun.com\\",\\n \\"TimeRange\\": [\\n 500\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"id1\\",\\n \\"ElementType\\": \\"title - 标题； image - 图片 ； table - 表格 ； narrative-text - 正文\\",\\n \\"SemanticSimilarity\\": 0.8,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"child，parent\\",\\n \\"ObjectId\\": \\"id1\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ],\\n \\"FrameTimes\\": [\\n 30\\n ],\\n \\"VideoStreamIndex\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"座椅\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"OCRTexts\\": \\"阿里云IMM\\",\\n \\"Reason\\": \\"[InternalError] The request has been failed due to some unknown error. status: 500, requestId: CC5ACFBD-BB7A-496D-A9D6-****\\",\\n \\"ObjectStatus\\": \\"Indexed\\",\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"无。\\",\\n \\"Caption\\": \\"视频中展示了两个不同场景：一个是静止的白色盘子、黑色瓶子和透明玻璃杯，另一个是手拿着标有“YEZOLU”的洗发水瓶在浴室中缓慢上移。\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"无。\\",\\n \\"Description\\": \\"图片中有一人，穿着深色西装外套，内搭白色衬衫。背景为渐变的浅蓝色至灰色。\\"\\n }\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetImageModerationResult' => [ + 'summary' => 'Retrieves an image content moderation task.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - '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', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '173754', + 'abilityTreeNodes' => ['FEATUREimmRIZXZT'], + ], + 'parameters' => [ [ - 'name' => 'FitToHeight', + 'name' => 'ProjectName', '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', - ], + 'schema' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ - 'name' => 'FirstPage', + 'name' => 'TaskType', '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', - ], + 'schema' => ['title' => '', 'description' => 'The task type.', 'type' => 'string', 'required' => true, 'example' => 'ImageModeration'], ], [ - 'name' => 'PaperSize', + 'name' => 'TaskId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'required' => true, 'example' => 'ImageModeration-ff207203-3f93-4645-a041-7b8f0f******'], + ], + ], + 'responses' => [ + 200 => [ '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', + 'title' => '', + 'description' => 'The image moderation result.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E6A120B1-BEB3-0F63-A7C2-0783B6******'], + 'ProjectName' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'test-project'], + 'EventId' => ['title' => '', 'description' => 'The event ID.', 'type' => 'string', 'example' => '1B6-1XBMX3BixLMILvXVGtlkr******'], + 'Status' => ['title' => '', 'description' => 'The running status of the task. Valid values:'."\n" + ."\n" + .'- Running: The task is running.'."\n" + .'- Succeeded: The task is completed successfully.'."\n" + .'- Failed: The task failed.', 'type' => 'string', 'example' => 'Succeeded'], + 'Code' => ['title' => '', 'description' => 'The error code of the task.', 'type' => 'string', 'example' => 'ResourceNotFound'], + 'Message' => ['title' => '', 'description' => 'The error message of the task.', 'type' => 'string', 'example' => 'The specified resource TaskId is not found.'], + 'StartTime' => ['title' => '', 'description' => 'The start time of the task. The value is a UTC timestamp in ISO 8601 format with millisecond precision.', 'type' => 'string', 'example' => '2023-04-03T09:44:31.029Z'], + 'EndTime' => ['title' => '', 'description' => 'The end time of the task. The value is a UTC timestamp in ISO 8601 format with millisecond precision.', 'type' => 'string', 'example' => '2023-04-03T09:44:32Z'], + 'UserData' => ['title' => '', 'description' => 'The custom user data.', 'type' => 'string', 'example' => '{'."\n" + .' "fileId": "123"'."\n" + .'}'], + 'TaskType' => ['title' => '', 'description' => 'The task type.', 'type' => 'string', 'example' => 'ImageModeration'], + 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => 'ImageModeration-ff207203-3f93-4645-a041-7b8f0f******'], + 'ModerationResult' => [ + 'description' => 'The content moderation result.', + 'type' => 'object', + 'properties' => [ + 'URI' => ['description' => 'The storage location of the OSS file. The address follows the format oss://${bucketname}/${objectname}, where bucketname is the name of an OSS bucket in the same region as the current project, and objectname is the file path.', 'type' => 'string', 'example' => 'oss://test-bucket/test-object', 'title' => ''], + 'Suggestion' => ['description' => 'The recommended action. Valid values:'."\n" + ."\n" + .'- pass: The image is normal. No further action is required.'."\n" + ."\n" + .'- review: The moderation result is uncertain. Manual review is required.'."\n" + ."\n" + .'- block: The image violates content policies. Further action is recommended, such as deleting or restricting the image.', 'type' => 'string', 'example' => 'block', 'title' => ''], + 'Categories' => [ + 'description' => 'The list of categories.', + 'type' => 'array', + 'items' => ['description' => 'The category.', 'type' => 'string', 'example' => 'porn', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Frames' => [ + 'description' => 'The frame information for video or animated image moderation.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of frames that were moderated.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'BlockFrames' => [ + 'description' => 'The frames that violate content policies.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about a frame that violates content policies.', + 'type' => 'object', + 'properties' => [ + 'Rate' => ['description' => 'The confidence level of the violation.', 'type' => 'number', 'format' => 'double', 'example' => '30', 'title' => ''], + 'Offset' => ['description' => 'The offset of the frame.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Label' => ['description' => 'The label of the violation.', 'type' => 'string', 'example' => '{'."\n" + .' "test": "val"'."\n" + .'}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + 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' => 'Retrieve an image content moderation task', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - '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', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetImageModerationResult', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], ], ], + ], + ], + 'GetOSSBucketAttachment' => [ + 'summary' => 'Retrieves the project name of a project that is bound to a specified OSS bucket in the same region.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TrimPolicy', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '135040', + 'abilityTreeNodes' => ['FEATUREimmKH590Y'], + ], + 'parameters' => [ + [ + 'name' => 'OSSBucket', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => 'The name of the OSS bucket.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ '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', + 'title' => '', + 'description' => 'The response struct.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5F74C5C9-5AC0-49F9-914D-E01589D3****'], + 'ProjectName' => ['description' => 'The name of the bound project.', 'type' => 'string', 'example' => 'immtest', 'title' => ''], + 'Description' => ['description' => 'The dataset description.', 'type' => 'string', 'example' => '"数据集"', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the dataset was created. The value is a UTC timestamp in ISO 8601 format with millisecond precision.', 'type' => 'string', 'example' => '""2023-12-19T17:29:34.790931971+08:00"', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the dataset was last updated. The value is a UTC timestamp in ISO 8601 format with millisecond precision.', 'type' => 'string', 'example' => '"2023-12-19T17:29:34.790931971+08:00"', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Get OSS bucket binding information', + 'description' => '- **Before you use this operation, make sure that you are familiar with the billing of Intelligent Media Management (IMM) and its [pricing](~~477042~~).**'."\n" + .'- Before you call this operation, make sure that you have called the [AttachOSSBucket](~~478206~~) operation to bind a project to an OSS bucket.', + 'changeSet' => [ + ['createdAt' => '2024-04-19T09:44:00.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-11-07T04:13:15.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-04-18T06:16:09.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOSSBucketAttachment'], + ], + ], + 'ramActions' => [ [ - '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', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetOSSBucketAttachment', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'GetProject' => [ + 'summary' => 'Queries information about a specified project, including basic information and statistics information related to datasets and files.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'LongPicture', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '450', + 'abilityTreeNodes' => ['FEATUREimmKH590Y'], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', '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', - ], + 'schema' => ['title' => '', 'description' => 'The project name. For information about how to obtain the project name, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ - 'name' => 'ImageDPI', + 'name' => 'WithStatistics', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to collect file statistics. Default value: false, which indicates that file statistics are not collected.'."\n" + ."\n" + .'- File statistics are collected. The FileCount and TotalFileSize values in the returned Project struct are valid.'."\n" + ."\n" + .'- File statistics are not collected. The FileCount and TotalFileSize values in the returned Project struct may be inaccurate or zero.'."\n" + ."\n" + .'><notice>Only files in datasets created before December 20, 2025 can be counted.></notice>', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + ], + 'responses' => [ + 200 => [ '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', + 'title' => '', + 'description' => 'The response struct.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A022F78-B9A8-4ACC-BB6B-B3597553'], + 'Project' => ['description' => 'The project information.', '$ref' => '#/components/schemas/Project', 'title' => '', 'example' => ''], + ], + 'example' => '', ], ], + ], + 'title' => 'Query project information', + 'description' => 'Querying project information supports real-time retrieval of file statistics information. You can enable this feature through parameter settings. For details, see the request parameters section.'."\n" + .'><notice>Only files in datasets created before December 20, 2025 can be counted.></notice>', + 'changeSet' => [ + ['createdAt' => '2024-02-28T03:44:04.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-06-15T02:14:20.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProject'], + ], + ], + 'ramActions' => [ [ - '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', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A022F78-B9A8-4ACC-BB6B-B3597553\\",\\n \\"Project\\": {\\n \\"ProjectName\\": \\"immtest\\",\\n \\"ServiceRole\\": \\"AliyunIMMDefaultRole\\",\\n \\"TemplateId\\": \\"Official:ImageManagement\\",\\n \\"CreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"UpdateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"Description\\": \\"test project\\",\\n \\"ProjectQueriesPerSecond\\": 100,\\n \\"EngineConcurrency\\": 100,\\n \\"ProjectMaxDatasetCount\\": 1000000000,\\n \\"DatasetMaxBindCount\\": 10,\\n \\"DatasetMaxFileCount\\": 100000000,\\n \\"DatasetMaxEntityCount\\": 10000000000,\\n \\"DatasetMaxRelationCount\\": 100000000000,\\n \\"DatasetMaxTotalFileSize\\": 90000000000000000,\\n \\"DatasetCount\\": 5,\\n \\"FileCount\\": 10,\\n \\"TotalFileSize\\": 100000,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"TestKey\\",\\n \\"TagValue\\": \\"TestValue\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetStory' => [ + 'summary' => 'Queries a story.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'HoldLineFeed', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '102496', + 'abilityTreeNodes' => ['FEATUREimmPQ568C'], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', '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', - ], + 'schema' => ['description' => 'The name of the project.[](~~478153~~)', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'CredentialConfig', + 'name' => 'DatasetName', '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', - ], + 'schema' => ['description' => 'The name of the dataset.[](~~478160~~)', 'type' => 'string', 'required' => true, 'example' => 'test-dataset', 'title' => ''], ], [ - 'name' => 'Notification', + 'name' => 'ObjectId', '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', - ], + 'schema' => ['description' => 'The ID of the story.', 'type' => 'string', 'required' => true, 'example' => 'id1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '文档转换任务', - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', '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*****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****'], + 'Story' => ['description' => 'The information about the story.', '$ref' => '#/components/schemas/Story', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - '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" + 'title' => 'GetStory', + 'description' => '- Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).\\*\\*\\*\\*'."\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" + .'- 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" - .' * 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', + .'- Before you call this operation, make sure that you have called the [CreateStory](~~478193~~) or [CreateCustomizedStory](~~478196~~) operation to create a story.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetStory'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetStory', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\",\\n \\"Story\\": {\\n \\"OwnerId\\": \\"102321002****\\",\\n \\"ProjectName\\": \\"immtest\\",\\n \\"DatasetName\\": \\"dataset001\\",\\n \\"ObjectId\\": \\"id1\\",\\n \\"ObjectType\\": \\"story\\",\\n \\"UpdateTime\\": \\"2022-01-14T10:17:18.102700407+08:00\\",\\n \\"CreateTime\\": \\"2022-01-14T10:17:18.102700407+08:00\\",\\n \\"StoryName\\": \\"name1\\",\\n \\"StoryType\\": \\"PeopleMemory\\",\\n \\"StorySubType\\": \\"ImportantPerson\\",\\n \\"StoryStartTime\\": \\"2022-01-14T10:17:18.102700407+08:00\\",\\n \\"StoryEndTime\\": \\"2022-01-14T10:17:18.102700407+08:00\\",\\n \\"Files\\": [\\n {\\n \\"OwnerId\\": \\"102321002467****\\",\\n \\"ProjectName\\": \\"test-project\\",\\n \\"DatasetName\\": \\"test-dataset\\",\\n \\"ObjectType\\": \\"file\\",\\n \\"ObjectId\\": \\"75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7\\",\\n \\"UpdateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"CreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"URI\\": \\"oss://test-bucket/test-object.jpg\\",\\n \\"OSSURI\\": \\"oss://examplebucket/sampleobject.jpg\\",\\n \\"Filename\\": \\"sampleobject.jpg\\",\\n \\"MediaType\\": \\"image\\",\\n \\"ContentType\\": \\"image/jpeg\\",\\n \\"Size\\": 1000,\\n \\"FileHash\\": \\"1d9c280a7c4f67f7ef873e28449dbe17\\",\\n \\"FileModifiedTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileCreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileAccessTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"ProduceTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"LatLong\\": \\"30.134390,120.074997\\",\\n \\"Timezone\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"AddressLine\\": \\"中国浙江省杭州市余杭区文一西路969号\\",\\n \\"Country\\": \\"中国\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"District\\": \\"余杭区\\",\\n \\"Township\\": \\"文一西路\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"-\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"868a9e74-cde5-4c7a-9013-28bb984****\\",\\n \\"FigureConfidence\\": 1,\\n \\"FigureClusterId\\": \\"Cluster-dbe72fec-b84c-4ab6-885b-3678e64****\\",\\n \\"FigureClusterConfidence\\": 1,\\n \\"FigureType\\": \\"face\\",\\n \\"Age\\": 29,\\n \\"AgeSD\\": 5,\\n \\"Gender\\": \\"female\\",\\n \\"GenderConfidence\\": 1,\\n \\"Emotion\\": \\"happiness\\",\\n \\"EmotionConfidence\\": 0.70784568786621,\\n \\"FaceQuality\\": 0.960875928401947,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n },\\n \\"Mouth\\": \\"close\\",\\n \\"MouthConfidence\\": 1,\\n \\"Beard\\": \\"none\\",\\n \\"BeardConfidence\\": 1,\\n \\"Hat\\": \\"none\\",\\n \\"HatConfidence\\": 1,\\n \\"Mask\\": \\"none\\",\\n \\"MaskConfidence\\": 1,\\n \\"Glasses\\": \\"none\\",\\n \\"GlassesConfidence\\": 0.8,\\n \\"Sharpness\\": 0.7,\\n \\"Attractive\\": 0.96,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 18.385589599609375,\\n \\"Roll\\": 4.204030513763428,\\n \\"Yaw\\": 2.4945924282073975\\n }\\n }\\n ],\\n \\"FigureCount\\": 10,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"座椅\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Title\\": \\"test\\",\\n \\"ImageWidth\\": 270,\\n \\"ImageHeight\\": 500,\\n \\"EXIF\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.736\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 1080,\\n \\"VideoHeight\\": 1920,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"CodecTimeBase\\": \\"1373627/83160000\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"Width\\": 1280,\\n \\"Height\\": 720,\\n \\"HasBFrames\\": 2,\\n \\"SampleAspectRatio\\": \\"1:1\\",\\n \\"DisplayAspectRatio\\": \\"16:9\\",\\n \\"PixelFormat\\": \\"yuv420p\\",\\n \\"Level\\": 40,\\n \\"FrameRate\\": \\"25/1\\",\\n \\"AverageFrameRate\\": \\"25/1\\",\\n \\"TimeBase\\": \\"1/12800\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 22.88,\\n \\"Bitrate\\": 5407765,\\n \\"FrameCount\\": 572,\\n \\"Rotate\\": \\"90\\",\\n \\"BitDepth\\": 8,\\n \\"ColorSpace\\": \\"bt709\\",\\n \\"ColorRange\\": \\"tv\\",\\n \\"ColorTransfer\\": \\"bt709\\",\\n \\"ColorPrimaries\\": \\"bt709\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 2,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"mov_text\\",\\n \\"CodecLongName\\": \\"MOV text\\",\\n \\"CodecTagString\\": \\"tx3g\\",\\n \\"CodecTag\\": \\"0x67337874\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 71.378,\\n \\"Bitrate\\": 74,\\n \\"Content\\": \\"欢迎\\",\\n \\"Width\\": 600,\\n \\"Height\\": 30\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 1,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"TimeBase\\": \\"1/48000\\",\\n \\"StartTime\\": 0.0235,\\n \\"Duration\\": 3.690667,\\n \\"Bitrate\\": 320087,\\n \\"FrameCount\\": 173,\\n \\"Lyric\\": \\"test\\",\\n \\"SampleFormat\\": \\"fltp\\",\\n \\"SampleRate\\": 48000,\\n \\"Channels\\": 2,\\n \\"ChannelLayout\\": \\"stereo\\"\\n }\\n ],\\n \\"Artist\\": \\"Jane\\",\\n \\"AlbumArtist\\": \\"Jane\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 500,\\n \\"ImageHeight\\": 820,\\n \\"EXIF\\": \\"{\\\\\\"FileSize\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"29304\\\\\\"},\\\\\\"Format\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"jpg\\\\\\"}}\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.736\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"Jane\\",\\n \\"Performer\\": \\"Jane\\",\\n \\"Language\\": \\"eng\\",\\n \\"Album\\": \\"FirstAlbum\\",\\n \\"PageCount\\": 5,\\n \\"ETag\\": \\"\\\\\\"1D9C280A7C4F67F7EF873E28449****\\\\\\"\\",\\n \\"CacheControl\\": \\"no-cache\\",\\n \\"ContentDisposition\\": \\"attachment; filename =test.jpg\\",\\n \\"ContentEncoding\\": \\"UTF-8\\",\\n \\"ContentLanguage\\": \\"zh-CN\\",\\n \\"AccessControlAllowOrigin\\": \\"https://aliyundoc.com\\",\\n \\"AccessControlRequestMethod\\": \\"PUT\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"SM4\\",\\n \\"ServerSideEncryption\\": \\"AES256\\",\\n \\"ServerSideDataEncryption\\": \\"SM4\\",\\n \\"ServerSideEncryptionKeyId\\": \\"9468da86-3509-4f8d-a61e-6eab1eac****\\",\\n \\"OSSStorageClass\\": \\"Standard\\",\\n \\"OSSCRC64\\": \\"559890638950338001\\",\\n \\"ObjectACL\\": \\"default\\",\\n \\"ContentMd5\\": \\"HZwoCnxPZ/fvhz4oRJ2+Fw==\\",\\n \\"OSSUserMeta\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSTaggingCount\\": 2,\\n \\"OSSTagging\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSExpiration\\": \\"2120-01-01T12:00:00.000Z\\",\\n \\"OSSVersionId\\": \\"CAEQNhiBgMDJgZCA0BYiIDc4MGZjZGI2OTBjOTRmNTE5NmU5NmFhZjhjYmY0****\\",\\n \\"OSSDeleteMarker\\": \\"CAEQMhiBgIDXiaaB0BYiIGQzYmRkZGUxMTM1ZDRjOTZhNjk4YjRjMTAyZjhl****\\",\\n \\"OSSObjectType\\": \\"Normal\\",\\n \\"CustomId\\": \\"\\\\t\\\\nmember-image-id-0001\\",\\n \\"CustomLabels\\": {\\n \\"MemberName\\": \\"Tim\\",\\n \\"Enabled\\": \\"True\\",\\n \\"ItemCount\\": \\"10\\"\\n },\\n \\"StreamCount\\": 1,\\n \\"ProgramCount\\": 1,\\n \\"FormatName\\": \\"mov\\",\\n \\"FormatLongName\\": \\"QuickTime / MOV\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 13091201,\\n \\"Duration\\": 15.263,\\n \\"SemanticTypes\\": [\\n \\"content\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"text\\",\\n \\"Content\\": \\"文本片段\\",\\n \\"URL\\": \\"http://aliyun.com\\",\\n \\"TimeRange\\": [\\n 500\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"id1\\",\\n \\"ElementType\\": \\"title - 标题； image - 图片 ； table - 表格 ； narrative-text - 正文\\",\\n \\"SemanticSimilarity\\": 0.8,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"child，parent\\",\\n \\"ObjectId\\": \\"id1\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ],\\n \\"FrameTimes\\": [\\n 30\\n ],\\n \\"VideoStreamIndex\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"座椅\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"OCRTexts\\": \\"阿里云IMM\\",\\n \\"Reason\\": \\"[InternalError] The request has been failed due to some unknown error. status: 500, requestId: CC5ACFBD-BB7A-496D-A9D6-****\\",\\n \\"ObjectStatus\\": \\"Indexed\\",\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"无。\\",\\n \\"Caption\\": \\"视频中展示了两个不同场景：一个是静止的白色盘子、黑色瓶子和透明玻璃杯，另一个是手拿着标有“YEZOLU”的洗发水瓶在浴室中缓慢上移。\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"无。\\",\\n \\"Description\\": \\"图片中有一人，穿着深色西装外套，内搭白色衬衫。背景为渐变的浅蓝色至灰色。\\"\\n }\\n }\\n }\\n ],\\n \\"Cover\\": {\\n \\"OwnerId\\": \\"102321002467****\\",\\n \\"ProjectName\\": \\"test-project\\",\\n \\"DatasetName\\": \\"test-dataset\\",\\n \\"ObjectType\\": \\"file\\",\\n \\"ObjectId\\": \\"75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7\\",\\n \\"UpdateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"CreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"URI\\": \\"oss://test-bucket/test-object.jpg\\",\\n \\"OSSURI\\": \\"oss://examplebucket/sampleobject.jpg\\",\\n \\"Filename\\": \\"sampleobject.jpg\\",\\n \\"MediaType\\": \\"image\\",\\n \\"ContentType\\": \\"image/jpeg\\",\\n \\"Size\\": 1000,\\n \\"FileHash\\": \\"1d9c280a7c4f67f7ef873e28449dbe17\\",\\n \\"FileModifiedTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileCreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileAccessTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"ProduceTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"LatLong\\": \\"30.134390,120.074997\\",\\n \\"Timezone\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"AddressLine\\": \\"中国浙江省杭州市余杭区文一西路969号\\",\\n \\"Country\\": \\"中国\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"District\\": \\"余杭区\\",\\n \\"Township\\": \\"文一西路\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"-\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"868a9e74-cde5-4c7a-9013-28bb984****\\",\\n \\"FigureConfidence\\": 1,\\n \\"FigureClusterId\\": \\"Cluster-dbe72fec-b84c-4ab6-885b-3678e64****\\",\\n \\"FigureClusterConfidence\\": 1,\\n \\"FigureType\\": \\"face\\",\\n \\"Age\\": 29,\\n \\"AgeSD\\": 5,\\n \\"Gender\\": \\"female\\",\\n \\"GenderConfidence\\": 1,\\n \\"Emotion\\": \\"happiness\\",\\n \\"EmotionConfidence\\": 0.70784568786621,\\n \\"FaceQuality\\": 0.960875928401947,\\n \\"Mouth\\": \\"close\\",\\n \\"MouthConfidence\\": 1,\\n \\"Beard\\": \\"none\\",\\n \\"BeardConfidence\\": 1,\\n \\"Hat\\": \\"none\\",\\n \\"HatConfidence\\": 1,\\n \\"Mask\\": \\"none\\",\\n \\"MaskConfidence\\": 1,\\n \\"Glasses\\": \\"none\\",\\n \\"GlassesConfidence\\": 0.8,\\n \\"Sharpness\\": 0.7,\\n \\"Attractive\\": 0.96,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 18.385589599609375,\\n \\"Roll\\": 4.204030513763428,\\n \\"Yaw\\": 2.4945924282073975\\n }\\n }\\n ],\\n \\"FigureCount\\": 10,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"座椅\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Title\\": \\"test\\",\\n \\"ImageWidth\\": 270,\\n \\"ImageHeight\\": 500,\\n \\"EXIF\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.736\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877\\n }\\n ],\\n \\"VideoWidth\\": 1080,\\n \\"VideoHeight\\": 1920,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"CodecTimeBase\\": \\"1373627/83160000\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"Width\\": 1280,\\n \\"Height\\": 720,\\n \\"HasBFrames\\": 2,\\n \\"SampleAspectRatio\\": \\"1:1\\",\\n \\"DisplayAspectRatio\\": \\"16:9\\",\\n \\"PixelFormat\\": \\"yuv420p\\",\\n \\"Level\\": 40,\\n \\"FrameRate\\": \\"25/1\\",\\n \\"AverageFrameRate\\": \\"25/1\\",\\n \\"TimeBase\\": \\"1/12800\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 22.88,\\n \\"Bitrate\\": 5407765,\\n \\"FrameCount\\": 572,\\n \\"Rotate\\": \\"90\\",\\n \\"BitDepth\\": 8,\\n \\"ColorSpace\\": \\"bt709\\",\\n \\"ColorRange\\": \\"tv\\",\\n \\"ColorTransfer\\": \\"bt709\\",\\n \\"ColorPrimaries\\": \\"bt709\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 2,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"mov_text\\",\\n \\"CodecLongName\\": \\"MOV text\\",\\n \\"CodecTagString\\": \\"tx3g\\",\\n \\"CodecTag\\": \\"0x67337874\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 71.378,\\n \\"Bitrate\\": 74,\\n \\"Content\\": \\"欢迎\\",\\n \\"Width\\": 600,\\n \\"Height\\": 30\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 1,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"TimeBase\\": \\"1/48000\\",\\n \\"StartTime\\": 0.0235,\\n \\"Duration\\": 3.690667,\\n \\"Bitrate\\": 320087,\\n \\"FrameCount\\": 173,\\n \\"Lyric\\": \\"test\\",\\n \\"SampleFormat\\": \\"fltp\\",\\n \\"SampleRate\\": 48000,\\n \\"Channels\\": 2,\\n \\"ChannelLayout\\": \\"stereo\\"\\n }\\n ],\\n \\"Artist\\": \\"Jane\\",\\n \\"AlbumArtist\\": \\"Jane\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 500,\\n \\"ImageHeight\\": 820,\\n \\"EXIF\\": \\"{\\\\\\"FileSize\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"29304\\\\\\"},\\\\\\"Format\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"jpg\\\\\\"}}\\",\\n \\"CroppingSuggestions\\": [],\\n \\"OCRContents\\": []\\n }\\n ],\\n \\"Composer\\": \\"Jane\\",\\n \\"Performer\\": \\"Jane\\",\\n \\"Language\\": \\"eng\\",\\n \\"Album\\": \\"FirstAlbum\\",\\n \\"PageCount\\": 5,\\n \\"ETag\\": \\"\\\\\\"1D9C280A7C4F67F7EF873E28449****\\\\\\"\\",\\n \\"CacheControl\\": \\"no-cache\\",\\n \\"ContentDisposition\\": \\"attachment; filename =test.jpg\\",\\n \\"ContentEncoding\\": \\"UTF-8\\",\\n \\"ContentLanguage\\": \\"zh-CN\\",\\n \\"AccessControlAllowOrigin\\": \\"https://aliyundoc.com\\",\\n \\"AccessControlRequestMethod\\": \\"PUT\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"SM4\\",\\n \\"ServerSideEncryption\\": \\"AES256\\",\\n \\"ServerSideDataEncryption\\": \\"SM4\\",\\n \\"ServerSideEncryptionKeyId\\": \\"9468da86-3509-4f8d-a61e-6eab1eac****\\",\\n \\"OSSStorageClass\\": \\"Standard\\",\\n \\"OSSCRC64\\": \\"559890638950338001\\",\\n \\"ObjectACL\\": \\"default\\",\\n \\"ContentMd5\\": \\"HZwoCnxPZ/fvhz4oRJ2+Fw==\\",\\n \\"OSSUserMeta\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSTaggingCount\\": 2,\\n \\"OSSTagging\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSExpiration\\": \\"2120-01-01T12:00:00.000Z\\",\\n \\"OSSVersionId\\": \\"CAEQNhiBgMDJgZCA0BYiIDc4MGZjZGI2OTBjOTRmNTE5NmU5NmFhZjhjYmY0****\\",\\n \\"OSSDeleteMarker\\": \\"CAEQMhiBgIDXiaaB0BYiIGQzYmRkZGUxMTM1ZDRjOTZhNjk4YjRjMTAyZjhl****\\",\\n \\"OSSObjectType\\": \\"Normal\\",\\n \\"CustomId\\": \\"\\\\t\\\\nmember-image-id-0001\\",\\n \\"CustomLabels\\": {\\n \\"MemberName\\": \\"Tim\\",\\n \\"Enabled\\": \\"True\\",\\n \\"ItemCount\\": \\"10\\"\\n },\\n \\"StreamCount\\": 1,\\n \\"ProgramCount\\": 1,\\n \\"FormatName\\": \\"mov\\",\\n \\"FormatLongName\\": \\"QuickTime / MOV\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 13091201,\\n \\"Duration\\": 15.263,\\n \\"SemanticTypes\\": [\\n \\"content\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"text\\",\\n \\"Content\\": \\"文本片段\\",\\n \\"URL\\": \\"http://aliyun.com\\",\\n \\"TimeRange\\": [\\n 500\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"id1\\",\\n \\"ElementType\\": \\"title - 标题； image - 图片 ； table - 表格 ； narrative-text - 正文\\",\\n \\"SemanticSimilarity\\": 0.8,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"child，parent\\",\\n \\"ObjectId\\": \\"id1\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ],\\n \\"FrameTimes\\": [\\n 30\\n ],\\n \\"VideoStreamIndex\\": 0,\\n \\"Labels\\": []\\n }\\n ],\\n \\"OCRTexts\\": \\"阿里云IMM\\",\\n \\"Reason\\": \\"[InternalError] The request has been failed due to some unknown error. status: 500, requestId: CC5ACFBD-BB7A-496D-A9D6-****\\",\\n \\"ObjectStatus\\": \\"Indexed\\",\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"无。\\",\\n \\"Caption\\": \\"视频中展示了两个不同场景：一个是静止的白色盘子、黑色瓶子和透明玻璃杯，另一个是手拿着标有“YEZOLU”的洗发水瓶在浴室中缓慢上移。\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"无。\\",\\n \\"Description\\": \\"图片中有一人，穿着深色西装外套，内搭白色衬衫。背景为渐变的浅蓝色至灰色。\\"\\n }\\n }\\n },\\n \\"FigureClusterIds\\": [\\n \\"2cb3c51e-b406-4b0c-af1b-897d88e1****\\"\\n ],\\n \\"CustomId\\": \\"test\\",\\n \\"CustomLabels\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"AddressLine\\": \\"中国浙江省杭州市余杭区文一西路969号\\",\\n \\"Country\\": \\"中国\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"District\\": \\"余杭区\\",\\n \\"Township\\": \\"文一西路\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetTask' => [ + 'summary' => 'Queries the information about a specified asynchronous task. Intelligent Media Management (IMM) supports various asynchronous data processing capabilities, each with its own task creation operation, such as CreateFigureClusteringTask for creating figure clustering tasks and CreateFileCompressionTask for creating file compression tasks. This operation is a general-purpose operation that allows you to query the details of an asynchronous task by task ID and type.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19459,594 +12420,404 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '173181', - 'abilityTreeNodes' => [ - 'FEATUREimmMBRC1J', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '106466', + 'abilityTreeNodes' => ['FEATUREimmTGV2Z7'], ], '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', - ], + 'schema' => ['title' => '', 'description' => 'The project name. For information about how to obtain the project name, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'immtest'], ], [ - 'name' => 'SourceURI', + 'name' => 'TaskType', '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', - ], + 'schema' => ['title' => '', 'description' => 'The type of the task. For valid values, see [Task type list](~~2743993~~).', 'type' => 'string', 'required' => true, 'example' => 'FileCompression'], ], [ - 'name' => 'SourceType', + 'name' => 'TaskId', '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', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the task that you want to query. This value is returned when you create the task.', 'type' => 'string', 'required' => true, 'example' => 'FileCompression-2f157087-91df-4fda-8c3e-232407ec*****'], ], [ - 'name' => 'CredentialConfig', + 'name' => 'RequestDefinition', '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', - ], + 'schema' => ['description' => 'Specifies whether to return the original request parameters used to create the task. Valid values:'."\n" + .'- true'."\n" + .'- false (default)'."\n" + ."\n" + .'This parameter takes effect only for the following task types:'."\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.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '图片裁剪结果', - 'description' => 'Response body structure.', + 'title' => '', + 'description' => 'The details of the specified task.', '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' => '测试内容。', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2C5C1E0F-D8B8-4DA0-8127-EC32C771****'], + 'ProjectName' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'test-project'], + 'EventId' => ['title' => '', 'description' => 'The event ID.', 'type' => 'string', 'example' => '2F6-1Bz99Xi93EnRpNEyLudILJm****'], + 'Status' => ['title' => '', 'description' => 'The running status of the task. Valid values:'."\n" + ."\n" + .'- Running: The task is running.'."\n" + ."\n" + .'- Succeeded: The task is completed.'."\n" + ."\n" + .'- Failed: The task failed.', 'type' => 'string', 'example' => 'Running'], + 'Code' => ['title' => '', 'description' => 'The error code of the task.', 'type' => 'string', 'example' => 'ResourceNotFound'], + 'Message' => ['title' => '', 'description' => 'The error message of the task.', 'type' => 'string', 'example' => 'The specified resource project is not found.'], + 'StartTime' => ['title' => '', 'description' => 'The time when the task started. The value is a UTC timestamp in ISO 8601 format with millisecond precision.', 'type' => 'string', 'example' => '2021-12-24T03:01:41.662060377Z'], + 'EndTime' => ['title' => '', 'description' => 'The time when the task ended. The value is a UTC timestamp in ISO 8601 format with millisecond precision.', 'type' => 'string', 'example' => '2021-12-24T03:01:49.480109219Z'], + 'UserData' => ['title' => '', 'description' => 'The custom information specified by the user.', 'type' => 'string', 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}'], + 'TaskType' => ['title' => '', 'description' => 'The type of the task. For valid values, see [Task type list](~~2743993~~).', 'type' => 'string', 'example' => 'FileCompression'], + 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => 'c2b277b9-0d30-4882-ad6d-ad661382****'], + 'Tags' => ['description' => 'The task tags. These are the tags that the user passed in when creating the task.', 'type' => 'object', 'example' => '{"test": "val1"}', 'title' => ''], + 'TaskRequestDefinition' => ['description' => 'The original request parameters used to create the task.', '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" + .'}', 'title' => ''], + 'Progress' => ['description' => 'The task progress. Valid values: 0 to 100. Unit: percent (%).'."\n" + ."\n" + .'> - The GetTask operation does not support this parameter.'."\n" + .'> - This parameter is meaningful only when the task status `State` is `Running`.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], + 'example' => '', ], ], 500 => [], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Retrieve task information', + 'description' => '**Before you use this operation, make sure that you are familiar with the billing of Intelligent Media Management and its [pricing](~~477042~~).**.', + 'changeSet' => [ + ['createdAt' => '2023-05-11T14:10:13.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-12-23T09:25:41.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2021-12-23T09:25:41.000Z', 'description' => 'Response parameters changed'], ], - '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', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTask'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + ], + 'GetTrigger' => [ + 'summary' => 'Queries the information about a trigger.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '156182', - 'abilityTreeNodes' => [ - 'FEATUREimmSETH07', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '135766', + 'abilityTreeNodes' => ['FEATUREimmJ1ILHI'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the project.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'immtest', - ], + 'schema' => ['description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'Sources', + 'name' => 'Id', 'in' => 'query', - 'style' => 'json', + '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' => [ - '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, + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'Trigger' => ['description' => 'The trigger information.'."\n", '$ref' => '#/components/schemas/DataIngestion', 'title' => '', 'example' => ''], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4A7A2D0E-D8B8-4DA0-8127-EB32C6******'], ], - 'required' => false, + 'example' => '', ], ], - [ - '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', - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Trigger\\": {\\n \\"Id\\": \\"trigger-9f72636a-0f0c-4baf-ae78-38b27bfe****\\",\\n \\"Input\\": {\\n \\"OSS\\": {\\n \\"Bucket\\": \\"test-bucket\\",\\n \\"Prefix\\": \\"test-object\\",\\n \\"MatchExpressions\\": [\\n \\"key prefix (abc)\\"\\n ]\\n }\\n },\\n \\"Actions\\": [\\n {\\n \\"Name\\": \\"doc/convert\\",\\n \\"Parameters\\": [\\n \\"pages=3\\"\\n ],\\n \\"FastFailPolicy\\": {\\n \\"Action\\": \\"abort\\"\\n }\\n }\\n ],\\n \\"Notification\\": {\\n \\"Endpoint\\": \\"http://1111111111.mns.cn-hangzhou.aliyuncs.com\\",\\n \\"Topic\\": \\"topic1\\",\\n \\"MNS\\": {\\n \\"TopicName\\": \\"topic1\\",\\n \\"Endpoint\\": \\"http://1111111111.mns.cn-hangzhou.aliyuncs.com\\"\\n },\\n \\"RocketMQ\\": {\\n \\"Endpoint\\": \\"http://11111111111.mqrest.cn-hangzhou.aliyuncs.com\\",\\n \\"TopicName\\": \\"topic1\\",\\n \\"InstanceId\\": \\"MQ_INST_11111111111_BYcNy2Nc\\"\\n }\\n },\\n \\"Statistic\\": {\\n \\"SubmitSuccess\\": 10,\\n \\"SubmitFailure\\": 1,\\n \\"SkipFiles\\": 0\\n },\\n \\"State\\": \\"Succeeded\\",\\n \\"Marker\\": \\"MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****\\",\\n \\"CreateTime\\": \\"2020-11-10T03:50:28Z\\",\\n \\"UpdateTime\\": \\"2021-12-18T07:40:29Z\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Error\\": \\"api returns error: SDKError: StatusCode: 404 Code: ResourceNotFound\\",\\n \\"Phase\\": \\"IncrementalScanning\\",\\n \\"ServiceRole\\": \\"AliyunIMMBatchTriggerRole\\"\\n },\\n \\"RequestId\\": \\"4A7A2D0E-D8B8-4DA0-8127-EB32C6******\\"\\n}","type":"json"}]', + 'title' => 'GetTrigger', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTrigger'], ], + ], + 'ramActions' => [ [ - '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', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetTrigger', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Trigger', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/trigger/*'], + ], ], ], + ], + ], + 'GetVideoLabelClassificationResult' => [ + 'summary' => 'Retrieves the result of a video label detection task.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - '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', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '157767', + 'abilityTreeNodes' => ['FEATUREimmQZSDER'], + ], + 'parameters' => [ [ - 'name' => 'CompressedFormat', + 'name' => 'ProjectName', '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', - ], + 'schema' => ['title' => '', 'description' => 'The project name. For information about how to obtain the project name, see [CreateProject](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'immtest'], ], [ - 'name' => 'UserData', + 'name' => 'TaskType', '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"}', - ], + 'schema' => ['title' => '', 'description' => 'The task type.', 'type' => 'string', 'required' => true, 'example' => 'VideoLabelClassification'], ], [ - 'name' => 'Notification', + 'name' => 'TaskId', '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', - ], + 'schema' => ['title' => '', 'description' => 'The task ID. For information about how to obtain the task ID, see the response parameters of [CreateVideoLabelClassificationTask](~~478223~~).', 'type' => 'string', 'required' => true, 'example' => 'VideoLabelClassification-2f157087-91df-4fda-8c3e-232407ec****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结构体', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The video label detection result.', '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*****', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7F84C6D9-5AC0-49F9-914D-F02678E3****'], + 'ProjectName' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'immtest'], + 'EventId' => ['title' => '', 'description' => 'The event ID.', 'type' => 'string', 'example' => '2F6-1Bz99Xi93EnRpNEyLudILJm****'], + 'Status' => ['title' => '', 'description' => 'The task status.', 'type' => 'string', 'example' => 'Succeeded'], + 'Code' => ['title' => '', 'description' => 'The task error code.', 'type' => 'string', 'example' => 'ResourceNotFound'], + 'Message' => ['title' => '', 'description' => 'The task error message.', 'type' => 'string', 'example' => 'The specified resource project is not found.'], + 'StartTime' => ['title' => '', 'description' => 'The time when the task started. The time is in the ISO 8601 UTC timestamp format with millisecond-level precision.', 'type' => 'string', 'example' => '2021-12-24T03:00:38.892462383Z'], + 'EndTime' => ['title' => '', 'description' => 'The time when the task ended. The time is in the ISO 8601 UTC timestamp format with millisecond-level precision.', 'type' => 'string', 'example' => '2021-12-24T03:00:42.134971294Z'], + 'UserData' => ['title' => '', 'description' => 'The user-defined information.', 'type' => 'string', 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}'], + 'TaskType' => ['title' => '', 'description' => 'The task type.', 'type' => 'string', 'example' => 'VideoLabelClassification'], + 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => 'VideoLabelClassification-2f157087-91df-4fda-8c3e-232407ec****'], + 'Labels' => [ + 'title' => '', + 'description' => 'The list of labels.', + 'type' => 'array', + 'items' => ['description' => 'The label information.', '$ref' => '#/components/schemas/Label', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], ], + 500 => [], ], - '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', + 'responseDemo' => '[{"errorExample":"","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\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"座椅\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Get video label detection task', + 'description' => '- Before you call this operation, make sure that you have created a project ([Project](~~478273~~)) in Intelligent Media Management. For more information, see [CreateProject](~~478153~~).'."\n" + .'- Before you call this operation, make sure that you have created a [video label detection task](~~478223~~) and obtained the `TaskId` of the task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetVideoLabelClassificationResult'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetVideoLabelClassificationResult', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + ], + 'GetVideoModerationResult' => [ + 'summary' => 'Retrieves a video content moderation task.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '157951', - 'abilityTreeNodes' => [ - 'FEATUREimm2Z44LQ', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '173750', + 'abilityTreeNodes' => ['FEATUREimmO3TV2W'], ], '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', - ], + 'schema' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ - 'name' => 'UserData', + 'name' => 'TaskType', '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"}', - ], + 'schema' => ['title' => '', 'description' => 'The task type.', 'type' => 'string', 'required' => true, 'example' => 'VideoModeration'], ], [ - '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', + 'name' => 'TaskId', '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', - ], + 'schema' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'required' => true, 'example' => 'VideoModeration-d0f0df1d-531d-4ab4-b353-e7f475******'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结构体', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The video moderation result.', '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****', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'VideoModeration-d0f0df1d-531d-4ab4-b353-e7f475******'], + 'ProjectName' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'test-project'], + 'EventId' => ['title' => '', '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 succeeded.'."\n" + .'- Failed: The task failed.', 'type' => 'string', 'example' => 'Succeeded'], + 'Code' => ['title' => '', 'description' => 'The task error code.', 'type' => 'string', 'example' => 'ResourceNotFound'], + 'Message' => ['title' => '', 'description' => 'The task error message.', 'type' => 'string', 'example' => 'The specified resource TaskId is not found.'], + 'StartTime' => ['title' => '', 'description' => 'The time when the task started. The value is a UTC timestamp in ISO 8601 format with millisecond precision.', 'type' => 'string', 'example' => '2023-04-03T10:20:41.432Z'], + 'EndTime' => ['title' => '', 'description' => 'The time when the task ended. The value is a UTC timestamp in ISO 8601 format with millisecond precision.', 'type' => 'string', 'example' => '2023-04-03T10:20:56.87Z'], + 'UserData' => ['title' => '', 'description' => 'The custom user data.', 'type' => 'string', 'example' => '{'."\n" + .' "id": "test-id",'."\n" + .' "name": "test-name"'."\n" + .'}'], + 'TaskType' => ['title' => '', 'description' => 'The task type.', 'type' => 'string', 'example' => 'VideoModeration'], + 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => 'VideoModeration-d0f0df1d-531d-4ab4-b353-e7f4750******'], + 'ModerationResult' => [ + 'description' => 'The content moderation details.', + 'type' => 'object', + 'properties' => [ + 'URI' => ['description' => 'The file URI. The storage address of the OSS file. The address follows the format `oss://${bucketname}/${objectname}`, where `bucketname` is the name of an OSS bucket in the same region as the current project, and `objectname` is the file path.', 'type' => 'string', 'example' => 'oss://test-bucket/test-object', 'title' => ''], + 'Suggestion' => ['description' => 'The moderation result suggestion. Valid values:'."\n" + ."\n" + .'- **block**: Violation detected.'."\n" + .'- **review**: Suspected violation.'."\n" + .'- **pass**: Passed.', 'type' => 'string', 'example' => 'block', 'title' => ''], + 'Categories' => [ + 'description' => 'The category list.', + 'type' => 'array', + 'items' => ['description' => 'The category information.', 'type' => 'string', 'example' => 'porn', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Frames' => [ + 'description' => 'The frame-related information for video and animated image moderation.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of frames inspected.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'BlockFrames' => [ + 'description' => 'The frames that contain violations.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about a frame that contains a violation.', + 'type' => 'object', + 'properties' => [ + 'Rate' => ['description' => 'The confidence score of the violation.', 'type' => 'number', 'format' => 'double', 'example' => '10', 'title' => ''], + 'Offset' => ['description' => 'The offset of the frame.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Label' => ['description' => 'The violation label.', 'type' => 'string', 'example' => '{"teat":"val"}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], + 500 => [], ], - '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', + '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' => 'Retrieve a video content moderation task', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetVideoModerationResult', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + ], + 'IndexFileMeta' => [ + 'summary' => 'Performs data processing on input files for tasks such as label detection, face detection, and location detection. This operation extracts object metadata and creates an index, which lets you retrieve data from a dataset.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -20058,489 +12829,490 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', - 'abilityTreeCode' => '157566', - 'abilityTreeNodes' => [ - 'FEATUREimm2Z44LQ', - ], + 'abilityTreeCode' => '32774', + 'abilityTreeNodes' => ['FEATUREimmSZD9WY'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the project.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'immtest', - ], + 'schema' => ['description' => 'The name of the project. To get the project name, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'CredentialConfig', + 'name' => 'DatasetName', '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', - ], + 'schema' => ['description' => 'The name of the dataset. To get the dataset name, see [Create a dataset](~~478160~~).', 'type' => 'string', 'required' => true, 'example' => 'test-dataset', 'title' => ''], ], [ - 'name' => 'Password', + 'name' => 'File', 'in' => 'query', - 'schema' => [ - 'description' => 'The password that protects the package.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123456', - ], + 'style' => 'json', + 'schema' => ['description' => 'The file to be indexed, in JSON format. For more information, see the struct definition.', 'required' => true, '$ref' => '#/components/schemas/InputFile', 'title' => '', 'example' => ''], ], [ '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"}', - ], + 'schema' => ['description' => 'Custom information that is returned in the asynchronous notification message. This helps you associate the notification with your services. The maximum length is 2048 bytes.', 'type' => 'string', 'required' => false, 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', 'title' => ''], ], [ - 'name' => 'SelectedFiles', + 'name' => 'Notification', 'in' => 'query', 'style' => 'json', + 'schema' => ['description' => 'The message notification configuration. For more information, see Notification. For the format of the asynchronous notification message, see the Metadata Indexing section in [Asynchronous notification message formats](~~2743997~~).', '$ref' => '#/components/schemas/Notification', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ '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', + 'title' => 'Schema of Response', + 'description' => 'The response struct.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****'], + 'EventId' => ['description' => 'The event ID.', 'type' => 'string', 'example' => '30F-1D8FxFzDXKJH9YQdve4CjR****', 'title' => ''], ], - 'required' => false, + 'example' => '', ], ], + ], + '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' => '- **Make sure you understand the billing methods and [pricing](~~477042~~) of Intelligent Media Management before you use this API.**'."\n" + ."\n" + .'- For a list of supported data processing operations for indexing object metadata, see [Workflow templates and operators](~~466304~~).'."\n" + ."\n" + .'- The total number and size of files that can be indexed are limited. For more information, see the Dataset limits section in [Limits](~~475569~~). For information about how to create a dataset, see the parameter descriptions.'."\n" + ."\n" + .'- For a list of regions where you can index object metadata, see the \'Features supported by region, Datasets and indexes\' section in [Limits](~~475569~~).'."\n" + ."\n" + .'- After you index object metadata, you can retrieve data using [Simple query](~~478175~~). For information about other retrieval features, see [Query and statistics](~~2402363~~). You can also create face groups using [Create a face clustering task](~~478180~~). For information about other clustering features, see [Intelligent management](~~2402365~~).'."\n" + ."\n" + .'> * This is an asynchronous operation. After you submit a request, the file is processed. The processing time can range from several seconds to several minutes or longer, depending on the [workflow template and operators](~~466304~~) and file content. After the processing is complete, the metadata is stored in the dataset. You can use the [message subscription](~~603317~~) feature to receive a notification when the task is complete.', + 'changeSet' => [ + ['createdAt' => '2024-04-15T08:38:42.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-04-23T08:07:38.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-03-27T09:02:44.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-09T10:57:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-16T06:44:21.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-16T06:44:21.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-06-15T02:14:12.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'IndexFileMeta'], + ], + ], + 'ramActions' => [ [ - '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', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:IndexFileMeta', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], ], ], + ], + ], + 'ListAttachedOSSBuckets' => [ + 'summary' => 'List bound attachments', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Notification', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '185053', + 'abilityTreeNodes' => ['FEATUREimmKH590Y'], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', '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', - ], + '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' => 'TargetURI', + 'name' => 'MaxResults', '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/', - ], + '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', 'title' => ''], + ], + [ + '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==', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '响应结构体', - 'description' => 'The response parameters.'."\n", + 'description' => 'Response structure.', '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*****', + '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==', 'title' => ''], + '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***********', 'title' => ''], + 'ProjectName' => ['description' => 'Project name.', 'type' => 'string', 'example' => 'test-project', 'title' => ''], + 'OSSBucket' => ['description' => 'OSS Bucket name.', 'type' => 'string', 'example' => 'test-bucket', 'title' => ''], + 'CreateTime' => ['description' => 'Timestamp of the project creation time, formatted as RFC3339Nano.', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00', 'title' => ''], + 'UpdateTime' => ['description' => 'Timestamp of the project modification time, formatted as RFC3339Nano.', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00', 'title' => ''], + 'Description' => ['description' => 'Description', 'type' => 'string', 'example' => 'test bucket', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + '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.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:ListAttachedOSSBuckets', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + ], + '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' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '145992', - 'abilityTreeNodes' => [ - 'FEATUREimm0H0W4Y', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '131116', + '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', - ], + 'schema' => ['description' => 'The name of the project.[](~~478153~~)'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'SourceURI', + 'name' => 'State', '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', - ], + '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', 'title' => ''], ], [ - 'name' => 'TargetURI', + 'name' => 'Sort', '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', - ], + 'schema' => ['description' => 'The sort field. Valid values:'."\n" + ."\n" + .'* CreateTime'."\n" + .'* UpdateTime'."\n", 'type' => 'string', 'required' => false, 'example' => '2020-11-11T06:51:17.5Z', 'title' => ''], ], [ - 'name' => 'PointCloudFileFormat', + 'name' => 'Order', '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', - ], - ], + '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', 'title' => ''], ], [ - 'name' => 'CompressMethod', + 'name' => 'TagSelector', 'in' => 'query', - 'schema' => [ - 'description' => 'The compression algorithm. Valid values:'."\n" - ."\n" - .'* octree'."\n" - .'* kdtree'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'octree', - 'enum' => [ - 'octree', - 'kdtree', - ], - ], + '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', 'title' => ''], ], [ - 'name' => 'PointCloudFields', + 'name' => 'NextToken', 'in' => 'query', - 'allowEmptyValue' => false, - 'style' => 'json', + '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==', 'title' => ''], + ], + [ + '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', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ '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" + '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', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'NextToken' => ['description' => 'The pagination token.'."\n" ."\n" - .'* xyz'."\n" - .'* intensity'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["xyz"]', + .'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****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FEDC9B1F-30F2-4C1F-8ED2-B7860187****', 'title' => ''], ], - 'required' => true, + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Batches\\": [\\n {\\n \\"Id\\": \\"trigger-9f72636a-0f0c-4baf-ae78-38b27bfe****\\",\\n \\"Input\\": {\\n \\"OSS\\": {\\n \\"Bucket\\": \\"test-bucket\\",\\n \\"Prefix\\": \\"test-object\\",\\n \\"MatchExpressions\\": [\\n \\"key prefix (abc)\\"\\n ]\\n }\\n },\\n \\"Actions\\": [\\n {\\n \\"Name\\": \\"doc/convert\\",\\n \\"Parameters\\": [\\n \\"pages=3\\"\\n ],\\n \\"FastFailPolicy\\": {\\n \\"Action\\": \\"abort\\"\\n }\\n }\\n ],\\n \\"Notification\\": {\\n \\"Endpoint\\": \\"http://1111111111.mns.cn-hangzhou.aliyuncs.com\\",\\n \\"Topic\\": \\"topic1\\",\\n \\"MNS\\": {\\n \\"TopicName\\": \\"topic1\\",\\n \\"Endpoint\\": \\"http://1111111111.mns.cn-hangzhou.aliyuncs.com\\"\\n },\\n \\"RocketMQ\\": {\\n \\"Endpoint\\": \\"http://11111111111.mqrest.cn-hangzhou.aliyuncs.com\\",\\n \\"TopicName\\": \\"topic1\\",\\n \\"InstanceId\\": \\"MQ_INST_11111111111_BYcNy2Nc\\"\\n }\\n },\\n \\"Statistic\\": {\\n \\"SubmitSuccess\\": 10,\\n \\"SubmitFailure\\": 1,\\n \\"SkipFiles\\": 0\\n },\\n \\"State\\": \\"Succeeded\\",\\n \\"Marker\\": \\"MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****\\",\\n \\"CreateTime\\": \\"2020-11-10T03:50:28Z\\",\\n \\"UpdateTime\\": \\"2021-12-18T07:40:29Z\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Error\\": \\"api returns error: SDKError: StatusCode: 404 Code: ResourceNotFound\\",\\n \\"Phase\\": \\"IncrementalScanning\\",\\n \\"ServiceRole\\": \\"AliyunIMMBatchTriggerRole\\"\\n }\\n ],\\n \\"NextToken\\": \\"MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****\\",\\n \\"RequestId\\": \\"FEDC9B1F-30F2-4C1F-8ED2-B7860187****\\"\\n}","type":"json"}]', + 'title' => 'ListBatches', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBatches'], + ], + ], + 'ramActions' => [ [ - 'name' => 'KdtreeOption', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The k-d tree compression options.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/KdtreeOption', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:ListBatches', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Batch', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/batch/*'], + ], ], ], + ], + ], + 'ListBindings' => [ + 'summary' => 'Query the list of bindings between datasets and Object Storage Service (OSS) buckets.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'OctreeOption', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10879', + 'abilityTreeNodes' => ['FEATUREimmSZD9WY'], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The octree compression options.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/OctreeOption', - ], + 'schema' => ['title' => '', 'description' => 'The project name. For information about how to obtain the project name, see [CreateProject](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ - 'name' => 'UserData', + 'name' => 'DatasetName', '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"}', - ], + 'schema' => ['description' => 'The dataset name. For information about how to obtain the dataset name, see [CreateDataset](~~478160~~).', 'type' => 'string', 'required' => false, 'example' => 'test-dataset', 'title' => ''], ], [ - 'name' => 'Tags', + 'name' => 'MaxResults', '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"}', - ], + 'schema' => ['description' => '- The maximum number of bindings to return. Valid values: 0 to 200.'."\n" + .'- If this parameter is not set or is set to 0, the default value 100 is used.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'CredentialConfig', + 'name' => 'NextToken', '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', - ], + 'schema' => ['description' => '- The pagination token that is used when the total number of bindings exceeds the MaxResults value.'."\n" + .'- Binding information is returned in alphabetical order starting from the NextToken value.'."\n" + .'- Leave this parameter empty for the first request.', 'type' => 'string', 'required' => false, 'example' => 'immtest:dataset001:examplebucket01', 'title' => ''], ], [ - 'name' => 'Notification', + 'name' => 'Name', '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', - ], + 'schema' => ['title' => '', 'description' => 'The name of the binding task.', 'type' => 'string', 'example' => 'imm', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response structure.', '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*****', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EFDFD356-C928-4A36-951A-6EB5A592****'], + 'NextToken' => ['description' => '- The pagination token that is used when the total number of bindings exceeds the MaxResults value.'."\n" + .'- Use this value as the NextToken in the next request to return the remaining results.'."\n" + .'- This parameter has a value only when not all bindings are returned.', 'type' => 'string', 'example' => 'immtest:dataset001:examplebucket01', 'title' => ''], + 'Bindings' => [ + 'description' => 'The list of binding information between datasets and OSS buckets.', + 'type' => 'array', + 'items' => ['description' => 'The information about the binding between a dataset and an OSS bucket.', '$ref' => '#/components/schemas/Binding', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EFDFD356-C928-4A36-951A-6EB5A592****\\",\\n \\"NextToken\\": \\"immtest:dataset001:examplebucket01\\",\\n \\"Bindings\\": [\\n {\\n \\"ProjectName\\": \\"immtest\\",\\n \\"DatasetName\\": \\"dataset001\\",\\n \\"URI\\": \\"oss://examplebucket\\",\\n \\"State\\": \\"Running\\",\\n \\"Phase\\": \\"FullScanning\\",\\n \\"CreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"UpdateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"Reason\\": \\"pause usage\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query the list of bindings', + 'description' => '**Before you use this operation, make sure that you are familiar with the billing method and [pricing](~~477042~~) of Intelligent Media Management (IMM).**', + 'changeSet' => [ + ['createdAt' => '2021-06-15T02:14:12.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBindings'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:ListBindings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + ], + ], + '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' => 'none', - 'abilityTreeCode' => '130698', - 'abilityTreeNodes' => [ - 'FEATUREimmUCA5MV', - ], - ], + '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' => 'immtest', - ], + 'schema' => ['title' => '', 'description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ - 'name' => 'Content', + 'name' => 'MaxResults', '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', - ], + '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' => '', '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', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结构体', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The data structure returned.'."\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" + 'RequestId' => ['title' => '', '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', 'title' => ''], + 'Datasets' => [ + 'title' => '', + 'description' => 'The datasets.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The dataset details.'."\n" ."\n" - .'* pass: the text does not contain anomalies.'."\n" - .'* block: the text contains anomalies.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'pass' => '', - 'block' => '', - ], - 'example' => 'pass', + .'> '."\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', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + 'title' => 'ListDatasets', + 'changeSet' => [ + ['createdAt' => '2021-06-15T02:14:12.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatasets'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:ListDatasets', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/*'], + ], + ], + ], + ], + ], + 'ListProjects' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -20549,128 +13321,132 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '130695', - 'abilityTreeNodes' => [ - 'FEATUREimmRIZXZT', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '763', + 'abilityTreeNodes' => ['FEATUREimmKH590Y'], ], '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', + 'name' => 'MaxResults', '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', - ], + 'allowEmptyValue' => false, + 'schema' => ['title' => '', 'description' => 'The maximum number of projects to return. Valid values: 0 to 200. If you do not set this parameter or set it to 0, the default value 100 is used.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'], ], [ - 'name' => 'Tags', + 'name' => 'NextToken', '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"}', - ], + 'schema' => ['title' => '', 'description' => 'The pagination token. Set this parameter to the NextToken value returned in the previous API call. Project information is returned in alphabetical order starting from the NextToken position. Leave this parameter empty for the first call.', 'type' => 'string', 'required' => false, 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDAx'], ], [ - 'name' => 'CredentialConfig', + 'name' => 'Prefix', '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', - ], + 'schema' => ['title' => '', 'description' => 'The prefix used to list projects. The value can be 0 to 128 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'immtest'], ], [ - 'name' => 'Scenes', + 'name' => 'Tag', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The scenarios in which you want to apply the image moderation task.'."\n", + 'description' => 'The list of tags.', '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' => '', + 'description' => 'The tag information.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], ], - 'example' => 'porn', + 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Interval', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ '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', + 'title' => '', + 'description' => 'The response struct.', + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['title' => '', 'description' => 'The credential for querying subsequent pages when the total number of expected projects exceeds the specified MaxResults value. This parameter has a value only when not all projects are returned.', 'type' => 'string', 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDAx'], + 'Projects' => [ + 'title' => '', + 'description' => 'The array of projects. Project information is returned.', + 'type' => 'array', + 'items' => ['description' => 'The project information.', '$ref' => '#/components/schemas/Project', 'title' => '', 'example' => ''], + 'example' => '', + ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4A7A2D0E-D8B8-4DA0-8127-EB32C660'], + ], + 'example' => '', ], ], + ], + 'title' => 'Query all project information', + 'summary' => 'Queries information about all projects, including basic information and statistics information related to datasets and files.', + 'description' => 'Paging is supported for viewing returned data. When performing a paged query for the first page, set only MaxResults to limit the number of returned entries. The NextToken value in the response serves as the credential for querying subsequent pages. When querying subsequent pages, set the NextToken parameter to the NextToken value obtained from the previous response as the query credential, and set MaxResults to limit the number of returned entries.', + 'changeSet' => [ + ['createdAt' => '2024-05-23T03:29:16.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProjects'], + ], + ], + 'ramActions' => [ [ - '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', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:ListProjects', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"MTIzNDU2Nzg6aW1tdGVzdDAx\\",\\n \\"Projects\\": [\\n {\\n \\"ProjectName\\": \\"immtest\\",\\n \\"ServiceRole\\": \\"AliyunIMMDefaultRole\\",\\n \\"TemplateId\\": \\"Official:ImageManagement\\",\\n \\"CreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"UpdateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"Description\\": \\"test project\\",\\n \\"ProjectQueriesPerSecond\\": 100,\\n \\"EngineConcurrency\\": 100,\\n \\"ProjectMaxDatasetCount\\": 1000000000,\\n \\"DatasetMaxBindCount\\": 10,\\n \\"DatasetMaxFileCount\\": 100000000,\\n \\"DatasetMaxEntityCount\\": 10000000000,\\n \\"DatasetMaxRelationCount\\": 100000000000,\\n \\"DatasetMaxTotalFileSize\\": 90000000000000000,\\n \\"DatasetCount\\": 5,\\n \\"FileCount\\": 10,\\n \\"TotalFileSize\\": 100000,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"TestKey\\",\\n \\"TagValue\\": \\"TestValue\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"4A7A2D0E-D8B8-4DA0-8127-EB32C660\\"\\n}","type":"json"}]', + ], + 'ListRegions' => [ + 'summary' => 'Get the list of regions', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Notification', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'abilityTreeCode' => '143479', + 'abilityTreeNodes' => ['FEATUREimmKH590Y'], + ], + 'parameters' => [ + [ + 'name' => 'AcceptLanguage', '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', + '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', + 'title' => '', ], ], ], @@ -20678,66 +13454,45 @@ 200 => [ 'schema' => [ 'title' => '响应结构体', - 'description' => 'The response parameters.'."\n", + 'description' => 'Response structure', '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*****', + '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', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F7D235C-76FF-4B65-800C-8238AE3F****\\",\\n \\"Regions\\": [\\n {\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"LocalName\\": \\"华北2（北京）\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'List of Regions Supporting IMM Service', + 'changeSet' => [ + ['createdAt' => '2024-04-19T03:54:11.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-07-07T06:43:05.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegions'], + ], ], + 'ramActions' => [], + ], + 'ListTasks' => [ + 'summary' => 'Lists tasks based on specific conditions, such as by time range and by tag.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -20746,629 +13501,444 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '130694', - 'abilityTreeNodes' => [ - 'FEATUREimmO3TV2W', - ], + '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' => 'immtest', - ], + 'schema' => ['title' => '', 'description' => 'The name of the project.[](~~478153~~)'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ - 'name' => 'UserData', + 'name' => 'TaskTypes', 'in' => 'query', + 'style' => 'json', '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', + '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"]', 'title' => ''], 'required' => false, - 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'SourceURI', + 'name' => 'NextToken', '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', - ], + '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' => 'Tags', + 'name' => 'MaxResults', '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"}', - ], + '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' => 'CredentialConfig', + 'name' => 'TagSelector', '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', - ], + 'schema' => ['description' => 'The custom tags of tasks.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test=val1', 'title' => ''], ], [ - 'name' => 'Scenes', + 'name' => 'Sort', '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, - ], + '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', 'title' => ''], ], [ - 'name' => 'Interval', + 'name' => 'Order', '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', + '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, - 'example' => '1', + 'enumValueTitles' => ['asc' => '', 'desc' => ''], + 'example' => 'asc', + 'title' => '', ], ], [ - 'name' => 'MaxFrames', + 'name' => 'Status', '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', + '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, - 'example' => '200', + 'enumValueTitles' => ['Succeeded' => '', 'Failed' => '', 'Running' => ''], + 'example' => 'Succeeded', + 'title' => '', ], ], [ - 'name' => 'Notification', + 'name' => 'StartTimeRange', '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', - ], + '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', 'title' => '', 'example' => ''], + ], + [ + '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', 'title' => '', 'example' => ''], + ], + [ + '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', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结构体', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The matched tasks.'."\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*****', + 'RequestId' => ['title' => '', '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', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], ], + 500 => [], ], - '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', + '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\\": \\"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\\": \\"VideoLabelClassification\\",\\n \\"TaskId\\": \\"c2b277b9-0d30-4882-ad6d-ad661382****\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\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\\": 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", + 'changeSet' => [ + ['createdAt' => '2023-05-11T14:10:13.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-23T09:25:41.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2021-12-23T09:25:41.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTasks'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:ListTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + ], + 'ListTriggers' => [ + 'summary' => 'Queries triggers by tag or status.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '173754', - 'abilityTreeNodes' => [ - 'FEATUREimmRIZXZT', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '135763', + 'abilityTreeNodes' => ['FEATUREimmJ1ILHI'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'title' => '项目名称', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + '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' => ''], ], [ - 'name' => 'TaskType', + 'name' => 'State', 'in' => 'query', - 'schema' => [ - 'title' => 'TaskType', - 'description' => 'The type of the task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ImageModeration', - ], + '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', 'title' => ''], ], [ - 'name' => 'TaskId', + 'name' => 'Sort', 'in' => 'query', - 'schema' => [ - 'title' => 'TaskId', - 'description' => 'The task ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ImageModeration-ff207203-3f93-4645-a041-7b8f0f******', - ], + '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", 'title' => ''], + ], + [ + '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', 'title' => ''], + ], + [ + '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', 'title' => ''], + ], + [ + '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==', 'title' => ''], + ], + [ + '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', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '图片检测结果', - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\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" - .'}', - ], - ], - ], - ], - ], - ], - ], + 'Triggers' => [ + 'description' => 'The triggers.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The trigger.'."\n", '$ref' => '#/components/schemas/DataIngestion', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + '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==', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F480BFAF-E778-5079-93AD-1E4631******', 'title' => ''], ], + 'example' => '', ], ], - 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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Triggers\\": [\\n {\\n \\"Id\\": \\"trigger-9f72636a-0f0c-4baf-ae78-38b27bfe****\\",\\n \\"Input\\": {\\n \\"OSS\\": {\\n \\"Bucket\\": \\"test-bucket\\",\\n \\"Prefix\\": \\"test-object\\",\\n \\"MatchExpressions\\": [\\n \\"key prefix (abc)\\"\\n ]\\n }\\n },\\n \\"Actions\\": [\\n {\\n \\"Name\\": \\"doc/convert\\",\\n \\"Parameters\\": [\\n \\"pages=3\\"\\n ],\\n \\"FastFailPolicy\\": {\\n \\"Action\\": \\"abort\\"\\n }\\n }\\n ],\\n \\"Notification\\": {\\n \\"Endpoint\\": \\"http://1111111111.mns.cn-hangzhou.aliyuncs.com\\",\\n \\"Topic\\": \\"topic1\\",\\n \\"MNS\\": {\\n \\"TopicName\\": \\"topic1\\",\\n \\"Endpoint\\": \\"http://1111111111.mns.cn-hangzhou.aliyuncs.com\\"\\n },\\n \\"RocketMQ\\": {\\n \\"Endpoint\\": \\"http://11111111111.mqrest.cn-hangzhou.aliyuncs.com\\",\\n \\"TopicName\\": \\"topic1\\",\\n \\"InstanceId\\": \\"MQ_INST_11111111111_BYcNy2Nc\\"\\n }\\n },\\n \\"Statistic\\": {\\n \\"SubmitSuccess\\": 10,\\n \\"SubmitFailure\\": 1,\\n \\"SkipFiles\\": 0\\n },\\n \\"State\\": \\"Succeeded\\",\\n \\"Marker\\": \\"MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****\\",\\n \\"CreateTime\\": \\"2020-11-10T03:50:28Z\\",\\n \\"UpdateTime\\": \\"2021-12-18T07:40:29Z\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Error\\": \\"api returns error: SDKError: StatusCode: 404 Code: ResourceNotFound\\",\\n \\"Phase\\": \\"IncrementalScanning\\",\\n \\"ServiceRole\\": \\"AliyunIMMBatchTriggerRole\\"\\n }\\n ],\\n \\"NextToken\\": \\"MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==\\",\\n \\"RequestId\\": \\"F480BFAF-E778-5079-93AD-1E4631******\\"\\n}","type":"json"}]', + 'title' => 'ListTriggers', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTriggers'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:ListTriggers', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Trigger', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/trigger/*'], + ], + ], + ], ], + ], + 'QueryFigureClusters' => [ + 'summary' => 'Queries face groups based on given conditions.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '173750', - 'abilityTreeNodes' => [ - 'FEATUREimmO3TV2W', - ], + '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.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], + ], + [ + '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.', 'type' => 'string', 'required' => true, 'example' => 'test-dataset', 'title' => ''], + ], + [ + 'name' => 'Sort', + 'in' => 'query', 'schema' => [ - 'title' => '项目名称', - 'description' => 'The project name.[](~~478153~~)'."\n", + '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" + ."\n" + .'- VideoCount: the number of videos.'."\n" + ."\n" + .'- ProjectName: the name of the project.'."\n" + ."\n" + .'- DatasetName: the name of the dataset.'."\n" + ."\n" + .'- CreateTime: the point in time when the group is created.'."\n" + ."\n" + .'- UpdateTime: the most recent point in time when the group is updated.'."\n" + ."\n" + .'- Gender: the gender.'."\n" + ."\n" + .'- FaceCount: the number of faces.'."\n" + ."\n" + .'- GroupName: the name of the group.', + 'enumValueTitles' => ['ImageCount' => '', 'VideoCount' => '', 'ProjectName' => '', 'DatasetName' => '', 'CreateTime' => '', 'UpdateTime' => '', 'Gender' => '', 'FaceCount' => '', 'Name' => ''], 'type' => 'string', - 'required' => true, - 'example' => 'test-project', + 'example' => 'ImageCount', + 'title' => '', + 'required' => false, ], ], [ - 'name' => 'TaskType', + 'name' => 'Order', 'in' => 'query', 'schema' => [ - 'title' => 'TaskType', - 'description' => 'The task type.', + 'description' => 'The sort order. Default value: asc.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- asc: ascending order.'."\n" + ."\n" + .'- desc: descending order.', + 'enumValueTitles' => ['asc' => '', 'desc' => ''], 'type' => 'string', - 'required' => true, - 'example' => 'VideoModeration', + 'example' => 'asc', + 'title' => '', + 'required' => false, ], ], [ - 'name' => 'TaskId', + 'name' => 'CustomLabels', + 'in' => 'query', + 'schema' => ['description' => 'The custom labels, which can be used as query conditions.', 'type' => 'string', 'required' => false, 'example' => 'key=value', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of entries to return. Valid values: 0 to 100. Default value: 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + '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.', 'type' => 'string', 'required' => false, 'example' => 'CAESEgoQCg4KCkltYWdlQ291bnQQARgBIr0ECgkABAAAAAAAAAAKrwQDKgIAADFTMzEzMDMyMzMzMjMxMzAzMDMyMzQzNjM3MzczOTMzMzQzYTY5NmQ2ZDJkNjk2ZDYxNjc2NTJkNzQ2NTczNzQyZDY4N2E2NDY1NzYyZDMyMzUzMjM0MzIzOTMzMzczMTJkMzY1NDZhNzk3MzU2Njk3MjM0M2E2OTZkNmQyZDc0NjU3Mzc0MmQ3MzY1NzQyZDYzMzYzNjY0MzY2NjYxMzQyZDM1MzMzODM3MmQzMTMxNjU2NjJkNjI2NTM5MzYyZDM5MzgzMDMzMzk2MjMwMzE2NDYzNjMzMjNhNjY2OTY3NzU3MjY1MmQ2MzZjNzU3Mzc0NjU3MjNhNDM2Yzc1NzM3NDY1NzIyZDYxNjUzOTY0MzQzMzMxNjEyZDM3MzQ2NTY2MmQzNDM5Mzc2MjJkMzg2MjMxMzUyZDM0MzUzOTM1MzYzNzYxMzQ2NDM2MzE2Ni5TMzEzMDMyMzMzMjMxMzAzMDMyMzQzNjM3MzczOTMzMzQzYTY5NmQ2ZDJkNjk2ZDYxNjc2NTJkNzQ2NTczNzQyZDY4N2E2NDY1NzYyZDMyMzUzMjM0MzIzOTMzMzczMTJkMzY1NDZhNzk3MzU2Njk3MjM0M2E2OTZkNmQyZDc0NjU3Mzc0MmQ3MzY1NzQyZDYzMzYzNjY0MzY2NjYxMzQyZDM1MzMzODM3MmQzMTMxNjU2NjJkNjI2NTM5MzYyZDM5MzgzMDMzMzk2MjMwMzE2NDYzNjM*****', 'title' => ''], + ], + [ + 'name' => 'CreateTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The time range within which the face group was created.', '$ref' => '#/components/schemas/TimeRange', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'UpdateTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The time range within which the face group was last updated.', '$ref' => '#/components/schemas/TimeRange', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'WithTotalCount', 'in' => 'query', 'schema' => [ - 'title' => 'TaskId', - 'description' => 'The task ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'VideoModeration-d0f0df1d-531d-4ab4-b353-e7f475******', + 'description' => 'Specifies whether to return the total number of face groups that match the current query conditions. Default value: false.', + 'enumValueTitles' => [], + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '图片检测结果', - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', '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"}', - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', '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.', 'type' => 'string', 'example' => 'CAESEgoQCg4KCkltYWdlQ291bnQQARgBIr0ECgkABAAAAAAAAAAKrwQDKgIAADFTMzEzMDMyMzMzMjMxMzAzMDMyMzQzNjM3MzczOTMzMzQzYTY5NmQ2ZDJkNjk2ZDYxNjc2NTJkNzQ2NTczNzQyZDY4N2E2NDY1NzYyZDMyMzUzMjM0MzIzOTMzMzczMTJkMzY1NDZhNzk3MzU2Njk3MjM0M2E2OTZkNmQyZDc0NjU3Mzc0MmQ3MzY1NzQyZDYzMzYzNjY0MzY2NjYxMzQyZDM1MzMzODM3MmQzMTMxNjU2NjJkNjI2NTM5MzYyZDM5MzgzMDMzMzk2MjMwMzE2NDYzNjMzMjNhNjY2OTY3NzU3MjY1MmQ2MzZjNzU3Mzc0NjU3MjNhNDM2Yzc1NzM3NDY1NzIyZDYxNjUzOTY0MzQzMzMxNjEyZDM3MzQ2NTY2MmQzNDM5Mzc2MjJkMzg2MjMxMzUyZDM0MzUzOTM1MzYzNzYxMzQ2NDM2MzE2Ni5TMzEzMDMyMzMzMjMxMzAzMDMyMzQzNjM3MzczOTMzMzQzYTY5NmQ2ZDJkNjk2ZDYxNjc2NTJkNzQ2NTczNzQyZDY4N2E2NDY1NzYyZDMyMzUzMjM0MzIzOTMzMzczMTJkMzY1NDZhNzk3MzU2Njk3MjM0M2E2OTZkNmQyZDc0NjU3Mzc0MmQ3MzY1NzQyZDYzMzYzNjY0MzY2NjYxMzQyZDM1MzMzODM3MmQzMTMxNjU2NjJkNjI2NTM5MzYyZDM5MzgzMDMzMzk2MjMwMzE2NDYzNjM*****', 'title' => ''], + 'FigureClusters' => [ + 'description' => 'The face groups.', + 'type' => 'array', + 'items' => ['description' => 'The face group details.', '$ref' => '#/components/schemas/FigureCluster', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['description' => 'The total number of face groups that matches the current query conditions.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], ], + 'example' => '', ], ], - 500 => [], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'QueryFigureClusters', + 'description' => '- Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).\\*\\*\\*\\*'."\n" + ."\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~~).', + 'changeSet' => [ + ['createdAt' => '2023-04-27T10:07:16.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-10-28T03:52:46.000Z', 'description' => 'Request parameters changed'], ], - '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', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFigureClusters'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:QueryFigureClusters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FFF****\\",\\n \\"NextToken\\": \\"CAESEgoQCg4KCkltYWdlQ291bnQQARgBIr0ECgkABAAAAAAAAAAKrwQDKgIAADFTMzEzMDMyMzMzMjMxMzAzMDMyMzQzNjM3MzczOTMzMzQzYTY5NmQ2ZDJkNjk2ZDYxNjc2NTJkNzQ2NTczNzQyZDY4N2E2NDY1NzYyZDMyMzUzMjM0MzIzOTMzMzczMTJkMzY1NDZhNzk3MzU2Njk3MjM0M2E2OTZkNmQyZDc0NjU3Mzc0MmQ3MzY1NzQyZDYzMzYzNjY0MzY2NjYxMzQyZDM1MzMzODM3MmQzMTMxNjU2NjJkNjI2NTM5MzYyZDM5MzgzMDMzMzk2MjMwMzE2NDYzNjMzMjNhNjY2OTY3NzU3MjY1MmQ2MzZjNzU3Mzc0NjU3MjNhNDM2Yzc1NzM3NDY1NzIyZDYxNjUzOTY0MzQzMzMxNjEyZDM3MzQ2NTY2MmQzNDM5Mzc2MjJkMzg2MjMxMzUyZDM0MzUzOTM1MzYzNzYxMzQ2NDM2MzE2Ni5TMzEzMDMyMzMzMjMxMzAzMDMyMzQzNjM3MzczOTMzMzQzYTY5NmQ2ZDJkNjk2ZDYxNjc2NTJkNzQ2NTczNzQyZDY4N2E2NDY1NzYyZDMyMzUzMjM0MzIzOTMzMzczMTJkMzY1NDZhNzk3MzU2Njk3MjM0M2E2OTZkNmQyZDc0NjU3Mzc0MmQ3MzY1NzQyZDYzMzYzNjY0MzY2NjYxMzQyZDM1MzMzODM3MmQzMTMxNjU2NjJkNjI2NTM5MzYyZDM5MzgzMDMzMzk2MjMwMzE2NDYzNjM*****\\",\\n \\"FigureClusters\\": [\\n {\\n \\"OwnerId\\": \\"102321002****\\",\\n \\"ProjectName\\": \\"immtest\\",\\n \\"DatasetName\\": \\"dataset001\\",\\n \\"ObjectType\\": \\"figure-cluster\\",\\n \\"ObjectId\\": \\"Cluster-ae6e3472-999e-410b-b54e-cd5dba****\\",\\n \\"UpdateTime\\": \\"2022-01-14T10:10:52.83948013+08:00\\",\\n \\"CreateTime\\": \\"2022-01-14T10:10:52.83948013+08:00\\",\\n \\"Name\\": \\"abc\\",\\n \\"Gender\\": \\"female\\",\\n \\"FaceCount\\": 3,\\n \\"ImageCount\\": 5,\\n \\"VideoCount\\": 3,\\n \\"AverageAge\\": 26,\\n \\"MinAge\\": 12,\\n \\"MaxAge\\": 44,\\n \\"Cover\\": {\\n \\"OwnerId\\": \\"102321002467****\\",\\n \\"ProjectName\\": \\"test-project\\",\\n \\"DatasetName\\": \\"test-dataset\\",\\n \\"ObjectType\\": \\"file\\",\\n \\"ObjectId\\": \\"75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7\\",\\n \\"UpdateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"CreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"URI\\": \\"oss://test-bucket/test-object.jpg\\",\\n \\"OSSURI\\": \\"oss://examplebucket/sampleobject.jpg\\",\\n \\"Filename\\": \\"sampleobject.jpg\\",\\n \\"MediaType\\": \\"image\\",\\n \\"ContentType\\": \\"image/jpeg\\",\\n \\"Size\\": 1000,\\n \\"FileHash\\": \\"1d9c280a7c4f67f7ef873e28449dbe17\\",\\n \\"FileModifiedTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileCreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileAccessTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"ProduceTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"LatLong\\": \\"30.134390,120.074997\\",\\n \\"Timezone\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"AddressLine\\": \\"中国浙江省杭州市余杭区文一西路969号\\",\\n \\"Country\\": \\"中国\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"District\\": \\"余杭区\\",\\n \\"Township\\": \\"文一西路\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"-\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"868a9e74-cde5-4c7a-9013-28bb984****\\",\\n \\"FigureConfidence\\": 1,\\n \\"FigureClusterId\\": \\"Cluster-dbe72fec-b84c-4ab6-885b-3678e64****\\",\\n \\"FigureClusterConfidence\\": 1,\\n \\"FigureType\\": \\"face\\",\\n \\"Age\\": 29,\\n \\"AgeSD\\": 5,\\n \\"Gender\\": \\"female\\",\\n \\"GenderConfidence\\": 1,\\n \\"Emotion\\": \\"happiness\\",\\n \\"EmotionConfidence\\": 0.70784568786621,\\n \\"FaceQuality\\": 0.960875928401947,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n },\\n \\"Mouth\\": \\"close\\",\\n \\"MouthConfidence\\": 1,\\n \\"Beard\\": \\"none\\",\\n \\"BeardConfidence\\": 1,\\n \\"Hat\\": \\"none\\",\\n \\"HatConfidence\\": 1,\\n \\"Mask\\": \\"none\\",\\n \\"MaskConfidence\\": 1,\\n \\"Glasses\\": \\"none\\",\\n \\"GlassesConfidence\\": 0.8,\\n \\"Sharpness\\": 0.7,\\n \\"Attractive\\": 0.96,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 18.385589599609375,\\n \\"Roll\\": 4.204030513763428,\\n \\"Yaw\\": 2.4945924282073975\\n }\\n }\\n ],\\n \\"FigureCount\\": 10,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"座椅\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Title\\": \\"test\\",\\n \\"ImageWidth\\": 270,\\n \\"ImageHeight\\": 500,\\n \\"EXIF\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.736\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 1080,\\n \\"VideoHeight\\": 1920,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"CodecTimeBase\\": \\"1373627/83160000\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"Width\\": 1280,\\n \\"Height\\": 720,\\n \\"HasBFrames\\": 2,\\n \\"SampleAspectRatio\\": \\"1:1\\",\\n \\"DisplayAspectRatio\\": \\"16:9\\",\\n \\"PixelFormat\\": \\"yuv420p\\",\\n \\"Level\\": 40,\\n \\"FrameRate\\": \\"25/1\\",\\n \\"AverageFrameRate\\": \\"25/1\\",\\n \\"TimeBase\\": \\"1/12800\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 22.88,\\n \\"Bitrate\\": 5407765,\\n \\"FrameCount\\": 572,\\n \\"Rotate\\": \\"90\\",\\n \\"BitDepth\\": 8,\\n \\"ColorSpace\\": \\"bt709\\",\\n \\"ColorRange\\": \\"tv\\",\\n \\"ColorTransfer\\": \\"bt709\\",\\n \\"ColorPrimaries\\": \\"bt709\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 2,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"mov_text\\",\\n \\"CodecLongName\\": \\"MOV text\\",\\n \\"CodecTagString\\": \\"tx3g\\",\\n \\"CodecTag\\": \\"0x67337874\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 71.378,\\n \\"Bitrate\\": 74,\\n \\"Content\\": \\"欢迎\\",\\n \\"Width\\": 600,\\n \\"Height\\": 30\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 1,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"TimeBase\\": \\"1/48000\\",\\n \\"StartTime\\": 0.0235,\\n \\"Duration\\": 3.690667,\\n \\"Bitrate\\": 320087,\\n \\"FrameCount\\": 173,\\n \\"Lyric\\": \\"test\\",\\n \\"SampleFormat\\": \\"fltp\\",\\n \\"SampleRate\\": 48000,\\n \\"Channels\\": 2,\\n \\"ChannelLayout\\": \\"stereo\\"\\n }\\n ],\\n \\"Artist\\": \\"Jane\\",\\n \\"AlbumArtist\\": \\"Jane\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 500,\\n \\"ImageHeight\\": 820,\\n \\"EXIF\\": \\"{\\\\\\"FileSize\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"29304\\\\\\"},\\\\\\"Format\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"jpg\\\\\\"}}\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.736\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"Jane\\",\\n \\"Performer\\": \\"Jane\\",\\n \\"Language\\": \\"eng\\",\\n \\"Album\\": \\"FirstAlbum\\",\\n \\"PageCount\\": 5,\\n \\"ETag\\": \\"\\\\\\"1D9C280A7C4F67F7EF873E28449****\\\\\\"\\",\\n \\"CacheControl\\": \\"no-cache\\",\\n \\"ContentDisposition\\": \\"attachment; filename =test.jpg\\",\\n \\"ContentEncoding\\": \\"UTF-8\\",\\n \\"ContentLanguage\\": \\"zh-CN\\",\\n \\"AccessControlAllowOrigin\\": \\"https://aliyundoc.com\\",\\n \\"AccessControlRequestMethod\\": \\"PUT\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"SM4\\",\\n \\"ServerSideEncryption\\": \\"AES256\\",\\n \\"ServerSideDataEncryption\\": \\"SM4\\",\\n \\"ServerSideEncryptionKeyId\\": \\"9468da86-3509-4f8d-a61e-6eab1eac****\\",\\n \\"OSSStorageClass\\": \\"Standard\\",\\n \\"OSSCRC64\\": \\"559890638950338001\\",\\n \\"ObjectACL\\": \\"default\\",\\n \\"ContentMd5\\": \\"HZwoCnxPZ/fvhz4oRJ2+Fw==\\",\\n \\"OSSUserMeta\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSTaggingCount\\": 2,\\n \\"OSSTagging\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSExpiration\\": \\"2120-01-01T12:00:00.000Z\\",\\n \\"OSSVersionId\\": \\"CAEQNhiBgMDJgZCA0BYiIDc4MGZjZGI2OTBjOTRmNTE5NmU5NmFhZjhjYmY0****\\",\\n \\"OSSDeleteMarker\\": \\"CAEQMhiBgIDXiaaB0BYiIGQzYmRkZGUxMTM1ZDRjOTZhNjk4YjRjMTAyZjhl****\\",\\n \\"OSSObjectType\\": \\"Normal\\",\\n \\"CustomId\\": \\"\\\\t\\\\nmember-image-id-0001\\",\\n \\"CustomLabels\\": {\\n \\"MemberName\\": \\"Tim\\",\\n \\"Enabled\\": \\"True\\",\\n \\"ItemCount\\": \\"10\\"\\n },\\n \\"StreamCount\\": 1,\\n \\"ProgramCount\\": 1,\\n \\"FormatName\\": \\"mov\\",\\n \\"FormatLongName\\": \\"QuickTime / MOV\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 13091201,\\n \\"Duration\\": 15.263,\\n \\"SemanticTypes\\": [\\n \\"content\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"text\\",\\n \\"Content\\": \\"文本片段\\",\\n \\"URL\\": \\"http://aliyun.com\\",\\n \\"TimeRange\\": [\\n 500\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"id1\\",\\n \\"ElementType\\": \\"title - 标题； image - 图片 ； table - 表格 ； narrative-text - 正文\\",\\n \\"SemanticSimilarity\\": 0.8,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"child，parent\\",\\n \\"ObjectId\\": \\"id1\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ],\\n \\"FrameTimes\\": [\\n 30\\n ],\\n \\"VideoStreamIndex\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"座椅\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"OCRTexts\\": \\"阿里云IMM\\",\\n \\"Reason\\": \\"[InternalError] The request has been failed due to some unknown error. status: 500, requestId: CC5ACFBD-BB7A-496D-A9D6-****\\",\\n \\"ObjectStatus\\": \\"Indexed\\",\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"无。\\",\\n \\"Caption\\": \\"视频中展示了两个不同场景：一个是静止的白色盘子、黑色瓶子和透明玻璃杯，另一个是手拿着标有“YEZOLU”的洗发水瓶在浴室中缓慢上移。\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"无。\\",\\n \\"Description\\": \\"图片中有一人，穿着深色西装外套，内搭白色衬衫。背景为渐变的浅蓝色至灰色。\\"\\n }\\n }\\n },\\n \\"CustomId\\": \\"abc\\",\\n \\"CustomLabels\\": {\\n \\"Bucket\\": \\"examplebucket\\"\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ],\\n \\"TotalCount\\": 100\\n}","type":"json"}]', + ], + 'QueryLocationDateClusters' => [ + 'summary' => 'Queries a list of spatiotemporal clusters based on the specified conditions.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -21377,194 +13947,190 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '106466', - 'abilityTreeNodes' => [ - 'FEATUREimmTGV2Z7', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '157769', + 'abilityTreeNodes' => ['FEATUREimmPECUUL'], ], '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', - ], + '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' => ''], ], [ - 'name' => 'TaskType', + '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', 'title' => ''], + ], + [ + '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', 'title' => ''], + ], + [ + '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' => 'Hangzhou', 'title' => ''], + ], + [ + 'name' => 'Address', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The address information.'."\n", 'required' => false, '$ref' => '#/components/schemas/Address', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'LocationDateClusterLevels', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'TaskType', - 'description' => 'The type of the task. For information about valid values, see [Task types](~~2743993~~).', - 'type' => 'string', - 'required' => true, - 'example' => 'VideoLabelClassification', + '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', + 'title' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'TaskId', + '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', 'title' => '', 'example' => ''], + ], + [ + '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', 'title' => '', 'example' => ''], + ], + [ + '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', 'title' => '', 'example' => ''], + ], + [ + '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', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token.'."\n", 'type' => 'string', 'required' => false, 'example' => 'MzQNjmY2MzYxNhNjk2ZNjEu****', 'title' => ''], + ], + [ + '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', 'title' => ''], + ], + [ + 'name' => 'CustomLabels', + 'in' => 'query', + 'schema' => ['description' => 'The custom labels.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key=value', 'title' => ''], + ], + [ + 'name' => 'Sort', '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", + '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' => true, - 'example' => 'c2b277b9-0d30-4882-ad6d-ad661382****', + 'required' => false, + 'enumValueTitles' => ['LocationDateClusterEndTime' => '', 'CreateTime' => '', 'UpdateTime' => '', 'LocationDateClusterStartTime' => ''], + 'example' => 'LocationDateClusterStartTime', + 'title' => '', ], ], [ - 'name' => 'RequestDefinition', + 'name' => 'Order', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to return original request parameters specified to create the task.'."\n" - ."\n" - .'* true'."\n" - .'* false (default)'."\n" + 'description' => 'The order that you use to sort the query results.'."\n" ."\n" - .'This parameter applies only to the following tasks:'."\n" + .'Valid values:'."\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', + .'* asc: ascending order. This is the default value.'."\n" + .'* desc: descending order.'."\n", + 'type' => 'string', 'required' => false, - 'example' => 'True', + 'enumValueTitles' => ['asc' => '', 'desc' => ''], + 'example' => 'asc', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '图片检测结果', - 'description' => 'The response parameters.'."\n", + '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****', - ], - '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', + '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', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + '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****', 'title' => ''], ], + 'example' => '', ], ], - 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', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7055FCF7-4D7B-098E-BD4D-DD2932B0****\\",\\n \\"LocationDateClusters\\": [\\n {\\n \\"Title\\": \\"杭州一日游\\",\\n \\"LocationDateClusterLevel\\": \\"province\\",\\n \\"LocationDateClusterStartTime\\": \\"2022-05-01T00:00:00+08:00\\",\\n \\"LocationDateClusterEndTime\\": \\"2022-05-02T23:59:59.999999999+08:00\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"AddressLine\\": \\"中国浙江省杭州市余杭区文一西路969号\\",\\n \\"Country\\": \\"中国\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"District\\": \\"余杭区\\",\\n \\"Township\\": \\"文一西路\\"\\n }\\n ],\\n \\"ObjectId\\": \\"location-date-cluster-14f48cb3-079d-4595-80c4-5735284b****\\",\\n \\"UpdateTime\\": \\"2022-11-16T13:15:05.65746784+08:00\\",\\n \\"CreateTime\\": \\"2022-11-16T13:14:34.882523669+08:00\\",\\n \\"CustomId\\": \\"user-01\\",\\n \\"CustomLabels\\": {\\n \\"User\\": \\"Jane\\"\\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", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryLocationDateClusters'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:QueryLocationDateClusters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], ], + ], + 'QuerySimilarImageClusters' => [ + 'summary' => 'You can call this operation to query the list of similar image clusters.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -21574,217 +14140,290 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '106467', - 'abilityTreeNodes' => [ - 'FEATUREimmTGV2Z7', - ], + 'abilityTreeCode' => '161811', + 'abilityTreeNodes' => ['FEATUREimm8BY6HG'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'title' => '项目名称', - 'description' => 'The name of the project.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['description' => 'The name of the project. For more information, see [CreateProject](~~478153~~).'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'TaskTypes', + 'name' => 'DatasetName', '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, - ], + 'schema' => ['description' => 'The name of the dataset. For more information, see [Create a dataset](~~478160~~).'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-dataset', 'title' => ''], ], [ '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==', - ], + '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****', 'title' => ''], ], [ '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', - ], + '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', 'title' => ''], ], [ - 'name' => 'TagSelector', + 'name' => 'CustomLabels', 'in' => 'query', - 'schema' => [ - 'description' => 'The custom tags of tasks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test=val1', - ], + 'schema' => ['description' => 'The custom tags, which are used to filter tasks.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"key": "val"}', 'title' => ''], ], [ 'name' => 'Sort', 'in' => 'query', 'schema' => [ - 'description' => 'The field used to sort the results by. Valid values:'."\n" + 'description' => 'The sorting field.'."\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", + .'* 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, - 'example' => 'TaskId', + 'enumValueTitles' => [], + 'example' => 'UpdateTime', + 'title' => '', ], ], [ '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', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ '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' => '', + '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', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + '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****', 'title' => ''], ], - 'example' => 'ASC', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FFF****\\\\n\\",\\n \\"SimilarImageClusters\\": [\\n {\\n \\"ObjectId\\": \\"SimilarImageCluster-748a041e-4ebc-4487-9e74-9c89b1****\\",\\n \\"UpdateTime\\": \\"2023-02-08T09:42:34.354969088+08:00\\",\\n \\"CreateTime\\": \\"2023-02-08T09:42:34.354969088+08:00\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Files\\": [\\n {\\n \\"URI\\": \\"oss://test-bucket/test-object\\",\\n \\"ImageScore\\": 0.709\\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", + 'changeSet' => [ + ['createdAt' => '2024-04-19T09:44:01.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySimilarImageClusters'], + ], + ], + 'ramActions' => [ [ - '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' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:QuerySimilarImageClusters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], ], - 'example' => 'Succeeded', ], ], + ], + ], + 'QueryStories' => [ + 'summary' => 'Queries stories based on the specified conditions.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'StartTimeRange', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '102513', + 'abilityTreeNodes' => ['FEATUREimmPQ568C'], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the project.[](~~478153~~)', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the dataset.[](~~478160~~)', 'type' => 'string', 'required' => true, 'example' => 'test-dataset', 'title' => ''], + ], + [ + 'name' => 'ObjectId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the story.', 'type' => 'string', 'required' => false, 'example' => 'id1', 'title' => ''], + ], + [ + 'name' => 'StoryName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the story.', 'type' => 'string', 'required' => false, 'example' => 'name1', 'title' => ''], + ], + [ + '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', 'title' => ''], + ], + [ + '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', 'title' => ''], + ], + [ + 'name' => 'FigureClusterIds', '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", + 'description' => 'The IDs of the face clusters.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the face cluster.', 'type' => 'string', 'required' => false, 'example' => 'Cluster-773d9c7e-3fd4-480c-a24b-30a82****', 'title' => ''], 'required' => false, - '$ref' => '#/components/schemas/TimeRange', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'EndTimeRange', + 'name' => 'CreateTimeRange', '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', - ], + 'schema' => ['description' => 'The time range in which stories were created.', '$ref' => '#/components/schemas/TimeRange', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'RequestDefinition', + 'name' => 'StoryStartTimeRange', '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', - ], + 'style' => 'json', + 'schema' => ['description' => 'The time range for the creation time of the first photo or video in the story.', '$ref' => '#/components/schemas/TimeRange', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'StoryEndTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The time range for the creation time of the last photo or video in the story.', '$ref' => '#/components/schemas/TimeRange', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + '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.', 'type' => 'string', 'required' => false, 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of entries to return. Valid values: 1 to 100. Default value: 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'CustomLabels', + 'in' => 'query', + 'schema' => ['description' => 'The custom labels in key-value pairs.', 'type' => 'string', 'required' => false, 'example' => 'key=value', 'title' => ''], + ], + [ + 'name' => 'WithEmptyStories', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return empty stories. Valid values:'."\n" + ."\n" + .'- true (The default value)'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => ['description' => 'The sort field. Valid values:'."\n" + ."\n" + .'- CreateTime: sorts by story creation time.'."\n" + ."\n" + .'- StoryName: sorts by story name.'."\n" + ."\n" + .'- StoryStartTime: sorts by story start time.'."\n" + ."\n" + .'- StoryEndTime: sorts by story end time.', 'type' => 'string', 'required' => false, 'example' => 'CreateTime', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The sort order. Valid values:'."\n" + ."\n" + .'- asc: in ascending order.'."\n" + ."\n" + .'- desc: in descending order.', 'type' => 'string', 'required' => false, 'example' => 'asc', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '图片检测结果', - 'description' => 'The matched tasks.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', '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", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2C5C1E0F-D8B8-4DA0-8127-EC32C771****'], + 'Stories' => [ + 'description' => 'The stories.', 'type' => 'array', - 'items' => [ - 'description' => 'The details of the task.'."\n", - '$ref' => '#/components/schemas/TaskInfo', - ], + 'items' => ['description' => 'The information about the story.', '$ref' => '#/components/schemas/Story', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + '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.', 'type' => 'string', 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3Qx****', 'title' => ''], ], + 'example' => '', ], ], - 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', + 'title' => 'QueryStories', + 'description' => '- Before you call this operation, make sure that you are familiar with the [billing](~~477042~~) of Intelligent Media Management (IMM).\\*\\*\\*\\*'."\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" + .'- Before you call this operation, make sure that you have called the [CreateStory](~~478193~~) or [CreateCustomizedStory](~~478196~~) operation to create a story.', + 'changeSet' => [ + ['createdAt' => '2022-02-24T06:44:23.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryStories'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:QueryStories', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2C5C1E0F-D8B8-4DA0-8127-EC32C771****\\",\\n \\"Stories\\": [\\n {\\n \\"OwnerId\\": \\"102321002****\\",\\n \\"ProjectName\\": \\"immtest\\",\\n \\"DatasetName\\": \\"dataset001\\",\\n \\"ObjectId\\": \\"id1\\",\\n \\"ObjectType\\": \\"story\\",\\n \\"UpdateTime\\": \\"2022-01-14T10:17:18.102700407+08:00\\",\\n \\"CreateTime\\": \\"2022-01-14T10:17:18.102700407+08:00\\",\\n \\"StoryName\\": \\"name1\\",\\n \\"StoryType\\": \\"PeopleMemory\\",\\n \\"StorySubType\\": \\"ImportantPerson\\",\\n \\"StoryStartTime\\": \\"2022-01-14T10:17:18.102700407+08:00\\",\\n \\"StoryEndTime\\": \\"2022-01-14T10:17:18.102700407+08:00\\",\\n \\"Files\\": [\\n {\\n \\"OwnerId\\": \\"102321002467****\\",\\n \\"ProjectName\\": \\"test-project\\",\\n \\"DatasetName\\": \\"test-dataset\\",\\n \\"ObjectType\\": \\"file\\",\\n \\"ObjectId\\": \\"75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7\\",\\n \\"UpdateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"CreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"URI\\": \\"oss://test-bucket/test-object.jpg\\",\\n \\"OSSURI\\": \\"oss://examplebucket/sampleobject.jpg\\",\\n \\"Filename\\": \\"sampleobject.jpg\\",\\n \\"MediaType\\": \\"image\\",\\n \\"ContentType\\": \\"image/jpeg\\",\\n \\"Size\\": 1000,\\n \\"FileHash\\": \\"1d9c280a7c4f67f7ef873e28449dbe17\\",\\n \\"FileModifiedTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileCreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileAccessTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"ProduceTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"LatLong\\": \\"30.134390,120.074997\\",\\n \\"Timezone\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"AddressLine\\": \\"中国浙江省杭州市余杭区文一西路969号\\",\\n \\"Country\\": \\"中国\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"District\\": \\"余杭区\\",\\n \\"Township\\": \\"文一西路\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"-\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"868a9e74-cde5-4c7a-9013-28bb984****\\",\\n \\"FigureConfidence\\": 1,\\n \\"FigureClusterId\\": \\"Cluster-dbe72fec-b84c-4ab6-885b-3678e64****\\",\\n \\"FigureClusterConfidence\\": 1,\\n \\"FigureType\\": \\"face\\",\\n \\"Age\\": 29,\\n \\"AgeSD\\": 5,\\n \\"Gender\\": \\"female\\",\\n \\"GenderConfidence\\": 1,\\n \\"Emotion\\": \\"happiness\\",\\n \\"EmotionConfidence\\": 0.70784568786621,\\n \\"FaceQuality\\": 0.960875928401947,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n },\\n \\"Mouth\\": \\"close\\",\\n \\"MouthConfidence\\": 1,\\n \\"Beard\\": \\"none\\",\\n \\"BeardConfidence\\": 1,\\n \\"Hat\\": \\"none\\",\\n \\"HatConfidence\\": 1,\\n \\"Mask\\": \\"none\\",\\n \\"MaskConfidence\\": 1,\\n \\"Glasses\\": \\"none\\",\\n \\"GlassesConfidence\\": 0.8,\\n \\"Sharpness\\": 0.7,\\n \\"Attractive\\": 0.96,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 18.385589599609375,\\n \\"Roll\\": 4.204030513763428,\\n \\"Yaw\\": 2.4945924282073975\\n }\\n }\\n ],\\n \\"FigureCount\\": 10,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"座椅\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Title\\": \\"test\\",\\n \\"ImageWidth\\": 270,\\n \\"ImageHeight\\": 500,\\n \\"EXIF\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.736\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 1080,\\n \\"VideoHeight\\": 1920,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"CodecTimeBase\\": \\"1373627/83160000\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"Width\\": 1280,\\n \\"Height\\": 720,\\n \\"HasBFrames\\": 2,\\n \\"SampleAspectRatio\\": \\"1:1\\",\\n \\"DisplayAspectRatio\\": \\"16:9\\",\\n \\"PixelFormat\\": \\"yuv420p\\",\\n \\"Level\\": 40,\\n \\"FrameRate\\": \\"25/1\\",\\n \\"AverageFrameRate\\": \\"25/1\\",\\n \\"TimeBase\\": \\"1/12800\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 22.88,\\n \\"Bitrate\\": 5407765,\\n \\"FrameCount\\": 572,\\n \\"Rotate\\": \\"90\\",\\n \\"BitDepth\\": 8,\\n \\"ColorSpace\\": \\"bt709\\",\\n \\"ColorRange\\": \\"tv\\",\\n \\"ColorTransfer\\": \\"bt709\\",\\n \\"ColorPrimaries\\": \\"bt709\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 2,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"mov_text\\",\\n \\"CodecLongName\\": \\"MOV text\\",\\n \\"CodecTagString\\": \\"tx3g\\",\\n \\"CodecTag\\": \\"0x67337874\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 71.378,\\n \\"Bitrate\\": 74,\\n \\"Content\\": \\"欢迎\\",\\n \\"Width\\": 600,\\n \\"Height\\": 30\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 1,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"TimeBase\\": \\"1/48000\\",\\n \\"StartTime\\": 0.0235,\\n \\"Duration\\": 3.690667,\\n \\"Bitrate\\": 320087,\\n \\"FrameCount\\": 173,\\n \\"Lyric\\": \\"test\\",\\n \\"SampleFormat\\": \\"fltp\\",\\n \\"SampleRate\\": 48000,\\n \\"Channels\\": 2,\\n \\"ChannelLayout\\": \\"stereo\\"\\n }\\n ],\\n \\"Artist\\": \\"Jane\\",\\n \\"AlbumArtist\\": \\"Jane\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 500,\\n \\"ImageHeight\\": 820,\\n \\"EXIF\\": \\"{\\\\\\"FileSize\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"29304\\\\\\"},\\\\\\"Format\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"jpg\\\\\\"}}\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.736\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"Jane\\",\\n \\"Performer\\": \\"Jane\\",\\n \\"Language\\": \\"eng\\",\\n \\"Album\\": \\"FirstAlbum\\",\\n \\"PageCount\\": 5,\\n \\"ETag\\": \\"\\\\\\"1D9C280A7C4F67F7EF873E28449****\\\\\\"\\",\\n \\"CacheControl\\": \\"no-cache\\",\\n \\"ContentDisposition\\": \\"attachment; filename =test.jpg\\",\\n \\"ContentEncoding\\": \\"UTF-8\\",\\n \\"ContentLanguage\\": \\"zh-CN\\",\\n \\"AccessControlAllowOrigin\\": \\"https://aliyundoc.com\\",\\n \\"AccessControlRequestMethod\\": \\"PUT\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"SM4\\",\\n \\"ServerSideEncryption\\": \\"AES256\\",\\n \\"ServerSideDataEncryption\\": \\"SM4\\",\\n \\"ServerSideEncryptionKeyId\\": \\"9468da86-3509-4f8d-a61e-6eab1eac****\\",\\n \\"OSSStorageClass\\": \\"Standard\\",\\n \\"OSSCRC64\\": \\"559890638950338001\\",\\n \\"ObjectACL\\": \\"default\\",\\n \\"ContentMd5\\": \\"HZwoCnxPZ/fvhz4oRJ2+Fw==\\",\\n \\"OSSUserMeta\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSTaggingCount\\": 2,\\n \\"OSSTagging\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSExpiration\\": \\"2120-01-01T12:00:00.000Z\\",\\n \\"OSSVersionId\\": \\"CAEQNhiBgMDJgZCA0BYiIDc4MGZjZGI2OTBjOTRmNTE5NmU5NmFhZjhjYmY0****\\",\\n \\"OSSDeleteMarker\\": \\"CAEQMhiBgIDXiaaB0BYiIGQzYmRkZGUxMTM1ZDRjOTZhNjk4YjRjMTAyZjhl****\\",\\n \\"OSSObjectType\\": \\"Normal\\",\\n \\"CustomId\\": \\"\\\\t\\\\nmember-image-id-0001\\",\\n \\"CustomLabels\\": {\\n \\"MemberName\\": \\"Tim\\",\\n \\"Enabled\\": \\"True\\",\\n \\"ItemCount\\": \\"10\\"\\n },\\n \\"StreamCount\\": 1,\\n \\"ProgramCount\\": 1,\\n \\"FormatName\\": \\"mov\\",\\n \\"FormatLongName\\": \\"QuickTime / MOV\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 13091201,\\n \\"Duration\\": 15.263,\\n \\"SemanticTypes\\": [\\n \\"content\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"text\\",\\n \\"Content\\": \\"文本片段\\",\\n \\"URL\\": \\"http://aliyun.com\\",\\n \\"TimeRange\\": [\\n 500\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"id1\\",\\n \\"ElementType\\": \\"title - 标题； image - 图片 ； table - 表格 ； narrative-text - 正文\\",\\n \\"SemanticSimilarity\\": 0.8,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"child，parent\\",\\n \\"ObjectId\\": \\"id1\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ],\\n \\"FrameTimes\\": [\\n 30\\n ],\\n \\"VideoStreamIndex\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"座椅\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"OCRTexts\\": \\"阿里云IMM\\",\\n \\"Reason\\": \\"[InternalError] The request has been failed due to some unknown error. status: 500, requestId: CC5ACFBD-BB7A-496D-A9D6-****\\",\\n \\"ObjectStatus\\": \\"Indexed\\",\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"无。\\",\\n \\"Caption\\": \\"视频中展示了两个不同场景：一个是静止的白色盘子、黑色瓶子和透明玻璃杯，另一个是手拿着标有“YEZOLU”的洗发水瓶在浴室中缓慢上移。\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"无。\\",\\n \\"Description\\": \\"图片中有一人，穿着深色西装外套，内搭白色衬衫。背景为渐变的浅蓝色至灰色。\\"\\n }\\n }\\n }\\n ],\\n \\"Cover\\": {\\n \\"OwnerId\\": \\"102321002467****\\",\\n \\"ProjectName\\": \\"test-project\\",\\n \\"DatasetName\\": \\"test-dataset\\",\\n \\"ObjectType\\": \\"file\\",\\n \\"ObjectId\\": \\"75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7\\",\\n \\"UpdateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"CreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"URI\\": \\"oss://test-bucket/test-object.jpg\\",\\n \\"OSSURI\\": \\"oss://examplebucket/sampleobject.jpg\\",\\n \\"Filename\\": \\"sampleobject.jpg\\",\\n \\"MediaType\\": \\"image\\",\\n \\"ContentType\\": \\"image/jpeg\\",\\n \\"Size\\": 1000,\\n \\"FileHash\\": \\"1d9c280a7c4f67f7ef873e28449dbe17\\",\\n \\"FileModifiedTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileCreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileAccessTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"ProduceTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"LatLong\\": \\"30.134390,120.074997\\",\\n \\"Timezone\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"AddressLine\\": \\"中国浙江省杭州市余杭区文一西路969号\\",\\n \\"Country\\": \\"中国\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"District\\": \\"余杭区\\",\\n \\"Township\\": \\"文一西路\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"-\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"868a9e74-cde5-4c7a-9013-28bb984****\\",\\n \\"FigureConfidence\\": 1,\\n \\"FigureClusterId\\": \\"Cluster-dbe72fec-b84c-4ab6-885b-3678e64****\\",\\n \\"FigureClusterConfidence\\": 1,\\n \\"FigureType\\": \\"face\\",\\n \\"Age\\": 29,\\n \\"AgeSD\\": 5,\\n \\"Gender\\": \\"female\\",\\n \\"GenderConfidence\\": 1,\\n \\"Emotion\\": \\"happiness\\",\\n \\"EmotionConfidence\\": 0.70784568786621,\\n \\"FaceQuality\\": 0.960875928401947,\\n \\"Mouth\\": \\"close\\",\\n \\"MouthConfidence\\": 1,\\n \\"Beard\\": \\"none\\",\\n \\"BeardConfidence\\": 1,\\n \\"Hat\\": \\"none\\",\\n \\"HatConfidence\\": 1,\\n \\"Mask\\": \\"none\\",\\n \\"MaskConfidence\\": 1,\\n \\"Glasses\\": \\"none\\",\\n \\"GlassesConfidence\\": 0.8,\\n \\"Sharpness\\": 0.7,\\n \\"Attractive\\": 0.96,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 18.385589599609375,\\n \\"Roll\\": 4.204030513763428,\\n \\"Yaw\\": 2.4945924282073975\\n }\\n }\\n ],\\n \\"FigureCount\\": 10,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"座椅\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Title\\": \\"test\\",\\n \\"ImageWidth\\": 270,\\n \\"ImageHeight\\": 500,\\n \\"EXIF\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.736\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877\\n }\\n ],\\n \\"VideoWidth\\": 1080,\\n \\"VideoHeight\\": 1920,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"CodecTimeBase\\": \\"1373627/83160000\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"Width\\": 1280,\\n \\"Height\\": 720,\\n \\"HasBFrames\\": 2,\\n \\"SampleAspectRatio\\": \\"1:1\\",\\n \\"DisplayAspectRatio\\": \\"16:9\\",\\n \\"PixelFormat\\": \\"yuv420p\\",\\n \\"Level\\": 40,\\n \\"FrameRate\\": \\"25/1\\",\\n \\"AverageFrameRate\\": \\"25/1\\",\\n \\"TimeBase\\": \\"1/12800\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 22.88,\\n \\"Bitrate\\": 5407765,\\n \\"FrameCount\\": 572,\\n \\"Rotate\\": \\"90\\",\\n \\"BitDepth\\": 8,\\n \\"ColorSpace\\": \\"bt709\\",\\n \\"ColorRange\\": \\"tv\\",\\n \\"ColorTransfer\\": \\"bt709\\",\\n \\"ColorPrimaries\\": \\"bt709\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 2,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"mov_text\\",\\n \\"CodecLongName\\": \\"MOV text\\",\\n \\"CodecTagString\\": \\"tx3g\\",\\n \\"CodecTag\\": \\"0x67337874\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 71.378,\\n \\"Bitrate\\": 74,\\n \\"Content\\": \\"欢迎\\",\\n \\"Width\\": 600,\\n \\"Height\\": 30\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 1,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"TimeBase\\": \\"1/48000\\",\\n \\"StartTime\\": 0.0235,\\n \\"Duration\\": 3.690667,\\n \\"Bitrate\\": 320087,\\n \\"FrameCount\\": 173,\\n \\"Lyric\\": \\"test\\",\\n \\"SampleFormat\\": \\"fltp\\",\\n \\"SampleRate\\": 48000,\\n \\"Channels\\": 2,\\n \\"ChannelLayout\\": \\"stereo\\"\\n }\\n ],\\n \\"Artist\\": \\"Jane\\",\\n \\"AlbumArtist\\": \\"Jane\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 500,\\n \\"ImageHeight\\": 820,\\n \\"EXIF\\": \\"{\\\\\\"FileSize\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"29304\\\\\\"},\\\\\\"Format\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"jpg\\\\\\"}}\\",\\n \\"CroppingSuggestions\\": [],\\n \\"OCRContents\\": []\\n }\\n ],\\n \\"Composer\\": \\"Jane\\",\\n \\"Performer\\": \\"Jane\\",\\n \\"Language\\": \\"eng\\",\\n \\"Album\\": \\"FirstAlbum\\",\\n \\"PageCount\\": 5,\\n \\"ETag\\": \\"\\\\\\"1D9C280A7C4F67F7EF873E28449****\\\\\\"\\",\\n \\"CacheControl\\": \\"no-cache\\",\\n \\"ContentDisposition\\": \\"attachment; filename =test.jpg\\",\\n \\"ContentEncoding\\": \\"UTF-8\\",\\n \\"ContentLanguage\\": \\"zh-CN\\",\\n \\"AccessControlAllowOrigin\\": \\"https://aliyundoc.com\\",\\n \\"AccessControlRequestMethod\\": \\"PUT\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"SM4\\",\\n \\"ServerSideEncryption\\": \\"AES256\\",\\n \\"ServerSideDataEncryption\\": \\"SM4\\",\\n \\"ServerSideEncryptionKeyId\\": \\"9468da86-3509-4f8d-a61e-6eab1eac****\\",\\n \\"OSSStorageClass\\": \\"Standard\\",\\n \\"OSSCRC64\\": \\"559890638950338001\\",\\n \\"ObjectACL\\": \\"default\\",\\n \\"ContentMd5\\": \\"HZwoCnxPZ/fvhz4oRJ2+Fw==\\",\\n \\"OSSUserMeta\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSTaggingCount\\": 2,\\n \\"OSSTagging\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSExpiration\\": \\"2120-01-01T12:00:00.000Z\\",\\n \\"OSSVersionId\\": \\"CAEQNhiBgMDJgZCA0BYiIDc4MGZjZGI2OTBjOTRmNTE5NmU5NmFhZjhjYmY0****\\",\\n \\"OSSDeleteMarker\\": \\"CAEQMhiBgIDXiaaB0BYiIGQzYmRkZGUxMTM1ZDRjOTZhNjk4YjRjMTAyZjhl****\\",\\n \\"OSSObjectType\\": \\"Normal\\",\\n \\"CustomId\\": \\"\\\\t\\\\nmember-image-id-0001\\",\\n \\"CustomLabels\\": {\\n \\"MemberName\\": \\"Tim\\",\\n \\"Enabled\\": \\"True\\",\\n \\"ItemCount\\": \\"10\\"\\n },\\n \\"StreamCount\\": 1,\\n \\"ProgramCount\\": 1,\\n \\"FormatName\\": \\"mov\\",\\n \\"FormatLongName\\": \\"QuickTime / MOV\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 13091201,\\n \\"Duration\\": 15.263,\\n \\"SemanticTypes\\": [\\n \\"content\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"text\\",\\n \\"Content\\": \\"文本片段\\",\\n \\"URL\\": \\"http://aliyun.com\\",\\n \\"TimeRange\\": [\\n 500\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"id1\\",\\n \\"ElementType\\": \\"title - 标题； image - 图片 ； table - 表格 ； narrative-text - 正文\\",\\n \\"SemanticSimilarity\\": 0.8,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"child，parent\\",\\n \\"ObjectId\\": \\"id1\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ],\\n \\"FrameTimes\\": [\\n 30\\n ],\\n \\"VideoStreamIndex\\": 0,\\n \\"Labels\\": []\\n }\\n ],\\n \\"OCRTexts\\": \\"阿里云IMM\\",\\n \\"Reason\\": \\"[InternalError] The request has been failed due to some unknown error. status: 500, requestId: CC5ACFBD-BB7A-496D-A9D6-****\\",\\n \\"ObjectStatus\\": \\"Indexed\\",\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"无。\\",\\n \\"Caption\\": \\"视频中展示了两个不同场景：一个是静止的白色盘子、黑色瓶子和透明玻璃杯，另一个是手拿着标有“YEZOLU”的洗发水瓶在浴室中缓慢上移。\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"无。\\",\\n \\"Description\\": \\"图片中有一人，穿着深色西装外套，内搭白色衬衫。背景为渐变的浅蓝色至灰色。\\"\\n }\\n }\\n },\\n \\"FigureClusterIds\\": [\\n \\"2cb3c51e-b406-4b0c-af1b-897d88e1****\\"\\n ],\\n \\"CustomId\\": \\"test\\",\\n \\"CustomLabels\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"AddressLine\\": \\"中国浙江省杭州市余杭区文一西路969号\\",\\n \\"Country\\": \\"中国\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"District\\": \\"余杭区\\",\\n \\"Township\\": \\"文一西路\\"\\n }\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3Qx****\\"\\n}","type":"json"}]', + ], + 'RefreshWebofficeToken' => [ + 'summary' => 'Refreshes a Weboffice access token. A Weboffice access token is valid for 30 minutes. After it expires, you can no longer access Weboffice. To continue accessing Weboffice, call this operation to refresh the Weboffice access token and obtain a new token that is also valid for 30 minutes.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -21793,154 +14432,89 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '135761', - 'abilityTreeNodes' => [ - 'FEATUREimmJ1ILHI', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '39679', + 'abilityTreeNodes' => ['FEATUREimm4TQO1Z'], ], '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', - ], + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project name. For information about how to obtain the project name, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ - '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' => 'AccessToken', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The Weboffice access token. You can obtain the token by calling the [GenerateWebofficeToken](~~478226~~) or [RefreshWebofficeToken](~~478227~~) operation.', 'type' => 'string', 'required' => true, 'example' => '99d1b8b478b641c1b3372f5bd6********'], ], [ - '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' => 'RefreshToken', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The Weboffice refresh token. You can obtain the token by calling the [GenerateWebofficeToken](~~478226~~) or [RefreshWebofficeToken](~~478227~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'a730ae0d7c6a487d87c661d199********'], ], [ - 'name' => 'Tags', - 'in' => 'formData', + 'name' => 'CredentialConfig', + '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' => '{"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', - ], + 'schema' => ['description' => '**Leave this parameter empty unless you have special requirements.**'."\n" + ."\n" + .'The China authorization configuration. This parameter is optional. For more information, see [Use chained authorization to access resources of other entities](~~465340~~).', '$ref' => '#/components/schemas/CredentialConfig', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The Weboffice access token.', '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******', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '501339F9-4B70-0CE2-AB8C-866C********'], + 'RefreshToken' => ['title' => '', 'description' => 'The Weboffice refresh token.', 'type' => 'string', 'example' => '72a52ab3702a4123ab5594671a********'], + 'AccessToken' => ['title' => '', 'description' => 'The Weboffice access token.', 'type' => 'string', 'example' => '4996466c690a4902846ce00f96********'], + 'RefreshTokenExpiredTime' => ['title' => '', 'description' => 'The expiration time of the refresh token. The refresh token expires in 1 day. Format: ISO 8601 UTC timestamp with millisecond precision.', 'type' => 'string', 'example' => '2021-09-01T12:37:28.950065359Z'], + 'AccessTokenExpiredTime' => ['title' => '', 'description' => 'The expiration time of the access token. The access token expires in 30 minutes. Format: ISO 8601 UTC timestamp with millisecond precision.', 'type' => 'string', 'example' => '2021-08-31T13:07:28.950065359Z'], ], + 'example' => '', ], ], + 500 => [], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Refresh a weboffice token', + 'description' => '**Make sure that you are familiar with the billing method and [pricing](~~477042~~) of Intelligent Media Management (IMM) before you invoke this operation.**'."\n" + .'- For billing details, refer to [WebOffice billing](~~2639703~~).'."\n" + .'- The access token expires in 30 minutes. Open the preview before the access token expires. After the token expires, previewing is no longer available.'."\n" + .'- The refresh token expires in 1 day. Invoke the refresh operation before the refresh token expires. After the token expires, it becomes invalid.'."\n" + .'- The returned expiration time is in UTC, which is 8 hours behind UTC+8.'."\n" + .'> The access token is used for actual preview session access. The refresh token simplifies the parameter settings required for refreshing tokens. You can use the refresh token to directly obtain a new token with the previously configured settings.'."\n" + .'>', + 'changeSet' => [ + ['createdAt' => '2024-04-19T09:43:55.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-08-30T08:32:40.000Z', 'description' => 'Response parameters changed'], ], - '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', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefreshWebofficeToken'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:RefreshWebofficeToken', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + ], + 'RemoveStoryFiles' => [ + 'summary' => 'Deletes files from a story.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -21949,30 +14523,47 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '135764', - 'abilityTreeNodes' => [ - 'FEATUREimmJ1ILHI', - ], + 'abilityTreeCode' => '142653', + 'abilityTreeNodes' => ['FEATUREimmPQ568C'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the project.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.'."\n", 'type' => 'string', 'required' => true, 'example' => 'immtest'], ], [ - 'name' => 'Id', + 'name' => 'DatasetName', 'in' => 'formData', + 'schema' => ['description' => 'The name of the dataset.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testdataset', 'title' => ''], + ], + [ + 'name' => 'ObjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the story.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testid', 'title' => ''], + ], + [ + 'name' => 'Files', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the trigger.[](~~479912~~)'."\n", - 'type' => 'string', + '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://test-bucket/test-object', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => 'trigger-9f72636a-0f0c-4baf-ae78-38b27b******', + 'title' => '', + 'example' => '', ], ], ], @@ -21980,32 +14571,43 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0BC1F0C9-8E99-46C6-B502-10DED******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****'], ], + 'example' => '', ], ], ], - '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', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6E93D6C9-5AC0-49F9-914D-E02678D3****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'RemoveStoryFiles', + 'changeSet' => [ + ['createdAt' => '2022-07-07T07:23:26.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveStoryFiles'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:RemoveStoryFiles', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + ], + ], + 'ResumeBatch' => [ + 'summary' => 'Resumes a batch processing task that is in the Suspended or Failed state.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -22014,31 +14616,19 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '135767', - 'abilityTreeNodes' => [ - 'FEATUREimmJ1ILHI', - ], + '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', - ], + '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' => ''], ], [ '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******', - ], + '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******', 'title' => ''], ], ], 'responses' => [ @@ -22048,120 +14638,60 @@ '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****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D2C628B8-35DF-473C-8A41-757F30******'], ], + 'example' => '', ], ], ], - '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', + '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", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeBatch'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:ResumeBatch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Batch', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/batch/*'], + ], + ], + ], ], + ], + 'ResumeTrigger' => [ + 'summary' => 'Resumes a trigger that is in the Suspended or Failed state.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '135765', - 'abilityTreeNodes' => [ - 'FEATUREimmJ1ILHI', - ], + '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', - ], + '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' => ''], ], [ '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"}', - ], + '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******', 'title' => ''], ], ], 'responses' => [ @@ -22171,34 +14701,39 @@ '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******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FEDC9B1F-30F2-4C1F-8ED2-B7860187****'], ], + 'example' => '', ], ], ], - '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', + '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", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeTrigger'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:ResumeTrigger', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Trigger', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/trigger/*'], + ], + ], + ], ], + ], + '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' => [], @@ -22206,438 +14741,620 @@ ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '135766', - 'abilityTreeNodes' => [ - 'FEATUREimmJ1ILHI', - ], + 'operationType' => 'list', + 'chargeType' => 'free', + 'abilityTreeCode' => '160046', + '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' => 'test-project', - ], + 'schema' => ['description' => 'The name of the project.[](~~478153~~)'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'DatasetName', '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******', - ], + 'schema' => ['description' => 'The name of the dataset.[](~~478160~~)'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-dataset', 'title' => ''], + ], + [ + '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', 'title' => ''], + ], + [ + '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', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response parameters.'."\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******', + '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', 'title' => '', 'example' => ''], + '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******', 'title' => ''], + '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', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C2734912-E6D5-052C-AC67-6A9FD02*****\\",\\n \\"Clusters\\": [\\n {\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\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", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchImageFigureCluster'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:SearchImageFigureCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], ], + ], + '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', - 'abilityTreeCode' => '135763', - 'abilityTreeNodes' => [ - 'FEATUREimmJ1ILHI', - ], + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '103885', + 'abilityTreeNodes' => ['FEATUREimmDN11M0'], ], 'parameters' => [ [ - 'name' => 'ProjectName', + 'name' => 'NextToken', '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', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'This parameter is no longer available.', 'type' => 'string', 'example' => 'Reserved. Not supported yet.', 'required' => false, 'title' => ''], ], [ - 'name' => 'State', + 'name' => 'MaxResults', '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', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The maximum number of entries to return. Valid values: 1 to 1000.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '20'], ], [ - 'name' => 'Sort', + 'name' => 'ProjectName', '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", - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test-project'], ], [ - 'name' => 'Order', + 'name' => 'DatasetName', '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', - ], + 'schema' => ['description' => 'The name of the dataset.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test-dataset'], ], [ - 'name' => 'TagSelector', + 'name' => 'Query', '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', - ], + 'schema' => ['description' => 'The content of the query that you input.', 'type' => 'string', 'example' => 'Scenery of Hangzhou in April 2021', 'required' => false, 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'WithFields', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n" + 'description' => '> Either this parameter or the SourceURI parameter must be specified.'."\n" ."\n" - .'If the total number of triggers is greater than the value of MaxResults, you must specify NextToken.'."\n" + .'The content of the query that you input.', + '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" - .'You do not need to specify this parameter for the first request.'."\n", - 'type' => 'string', + .'If you do not specify this parameter or set the value to null, all existing metadata fields are returned.', 'type' => 'string', 'required' => false, 'example' => '["URI", "Filename"]', 'title' => ''], 'required' => false, - 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'MaxResults', + 'name' => 'MediaTypes', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The maximum number of entries to return. Valid values: 0 to 100.'."\n" + 'description' => 'The types of the media that you want to query. Default value:'."\n" + ."\n" + .'\\["image"]', + 'type' => 'array', + 'items' => ['description' => 'The type of the medium that you want to query. Set the value to'."\n" ."\n" - .'Default value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', + .'image.', 'type' => 'string', 'required' => false, 'example' => '["image"]', 'title' => ''], 'required' => false, - 'example' => '10', + 'title' => '', + 'example' => '', ], ], + [ + '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', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Triggers' => [ - 'description' => 'The triggers.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '2C5C1E0F-D8B8-4DA0-8127-EC32C771****'], + 'Files' => [ + 'title' => '', + 'description' => 'The files.', '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******', + 'items' => ['description' => 'The file information.', '$ref' => '#/components/schemas/File', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], ], ], - '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' => [], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2C5C1E0F-D8B8-4DA0-8127-EC32C771****\\",\\n \\"Files\\": [\\n {\\n \\"OwnerId\\": \\"102321002467****\\",\\n \\"ProjectName\\": \\"test-project\\",\\n \\"DatasetName\\": \\"test-dataset\\",\\n \\"ObjectType\\": \\"file\\",\\n \\"ObjectId\\": \\"75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7\\",\\n \\"UpdateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"CreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"URI\\": \\"oss://test-bucket/test-object.jpg\\",\\n \\"OSSURI\\": \\"oss://examplebucket/sampleobject.jpg\\",\\n \\"Filename\\": \\"sampleobject.jpg\\",\\n \\"MediaType\\": \\"image\\",\\n \\"ContentType\\": \\"image/jpeg\\",\\n \\"Size\\": 1000,\\n \\"FileHash\\": \\"1d9c280a7c4f67f7ef873e28449dbe17\\",\\n \\"FileModifiedTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileCreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileAccessTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"ProduceTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"LatLong\\": \\"30.134390,120.074997\\",\\n \\"Timezone\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"AddressLine\\": \\"中国浙江省杭州市余杭区文一西路969号\\",\\n \\"Country\\": \\"中国\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"District\\": \\"余杭区\\",\\n \\"Township\\": \\"文一西路\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"-\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"868a9e74-cde5-4c7a-9013-28bb984****\\",\\n \\"FigureConfidence\\": 1,\\n \\"FigureClusterId\\": \\"Cluster-dbe72fec-b84c-4ab6-885b-3678e64****\\",\\n \\"FigureClusterConfidence\\": 1,\\n \\"FigureType\\": \\"face\\",\\n \\"Age\\": 29,\\n \\"AgeSD\\": 5,\\n \\"Gender\\": \\"female\\",\\n \\"GenderConfidence\\": 1,\\n \\"Emotion\\": \\"happiness\\",\\n \\"EmotionConfidence\\": 0.70784568786621,\\n \\"FaceQuality\\": 0.960875928401947,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n },\\n \\"Mouth\\": \\"close\\",\\n \\"MouthConfidence\\": 1,\\n \\"Beard\\": \\"none\\",\\n \\"BeardConfidence\\": 1,\\n \\"Hat\\": \\"none\\",\\n \\"HatConfidence\\": 1,\\n \\"Mask\\": \\"none\\",\\n \\"MaskConfidence\\": 1,\\n \\"Glasses\\": \\"none\\",\\n \\"GlassesConfidence\\": 0.8,\\n \\"Sharpness\\": 0.7,\\n \\"Attractive\\": 0.96,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 18.385589599609375,\\n \\"Roll\\": 4.204030513763428,\\n \\"Yaw\\": 2.4945924282073975\\n }\\n }\\n ],\\n \\"FigureCount\\": 10,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"座椅\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Title\\": \\"test\\",\\n \\"ImageWidth\\": 270,\\n \\"ImageHeight\\": 500,\\n \\"EXIF\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.736\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 1080,\\n \\"VideoHeight\\": 1920,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"CodecTimeBase\\": \\"1373627/83160000\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"Width\\": 1280,\\n \\"Height\\": 720,\\n \\"HasBFrames\\": 2,\\n \\"SampleAspectRatio\\": \\"1:1\\",\\n \\"DisplayAspectRatio\\": \\"16:9\\",\\n \\"PixelFormat\\": \\"yuv420p\\",\\n \\"Level\\": 40,\\n \\"FrameRate\\": \\"25/1\\",\\n \\"AverageFrameRate\\": \\"25/1\\",\\n \\"TimeBase\\": \\"1/12800\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 22.88,\\n \\"Bitrate\\": 5407765,\\n \\"FrameCount\\": 572,\\n \\"Rotate\\": \\"90\\",\\n \\"BitDepth\\": 8,\\n \\"ColorSpace\\": \\"bt709\\",\\n \\"ColorRange\\": \\"tv\\",\\n \\"ColorTransfer\\": \\"bt709\\",\\n \\"ColorPrimaries\\": \\"bt709\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 2,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"mov_text\\",\\n \\"CodecLongName\\": \\"MOV text\\",\\n \\"CodecTagString\\": \\"tx3g\\",\\n \\"CodecTag\\": \\"0x67337874\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 71.378,\\n \\"Bitrate\\": 74,\\n \\"Content\\": \\"欢迎\\",\\n \\"Width\\": 600,\\n \\"Height\\": 30\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 1,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"TimeBase\\": \\"1/48000\\",\\n \\"StartTime\\": 0.0235,\\n \\"Duration\\": 3.690667,\\n \\"Bitrate\\": 320087,\\n \\"FrameCount\\": 173,\\n \\"Lyric\\": \\"test\\",\\n \\"SampleFormat\\": \\"fltp\\",\\n \\"SampleRate\\": 48000,\\n \\"Channels\\": 2,\\n \\"ChannelLayout\\": \\"stereo\\"\\n }\\n ],\\n \\"Artist\\": \\"Jane\\",\\n \\"AlbumArtist\\": \\"Jane\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 500,\\n \\"ImageHeight\\": 820,\\n \\"EXIF\\": \\"{\\\\\\"FileSize\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"29304\\\\\\"},\\\\\\"Format\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"jpg\\\\\\"}}\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.736\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"Jane\\",\\n \\"Performer\\": \\"Jane\\",\\n \\"Language\\": \\"eng\\",\\n \\"Album\\": \\"FirstAlbum\\",\\n \\"PageCount\\": 5,\\n \\"ETag\\": \\"\\\\\\"1D9C280A7C4F67F7EF873E28449****\\\\\\"\\",\\n \\"CacheControl\\": \\"no-cache\\",\\n \\"ContentDisposition\\": \\"attachment; filename =test.jpg\\",\\n \\"ContentEncoding\\": \\"UTF-8\\",\\n \\"ContentLanguage\\": \\"zh-CN\\",\\n \\"AccessControlAllowOrigin\\": \\"https://aliyundoc.com\\",\\n \\"AccessControlRequestMethod\\": \\"PUT\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"SM4\\",\\n \\"ServerSideEncryption\\": \\"AES256\\",\\n \\"ServerSideDataEncryption\\": \\"SM4\\",\\n \\"ServerSideEncryptionKeyId\\": \\"9468da86-3509-4f8d-a61e-6eab1eac****\\",\\n \\"OSSStorageClass\\": \\"Standard\\",\\n \\"OSSCRC64\\": \\"559890638950338001\\",\\n \\"ObjectACL\\": \\"default\\",\\n \\"ContentMd5\\": \\"HZwoCnxPZ/fvhz4oRJ2+Fw==\\",\\n \\"OSSUserMeta\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSTaggingCount\\": 2,\\n \\"OSSTagging\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSExpiration\\": \\"2120-01-01T12:00:00.000Z\\",\\n \\"OSSVersionId\\": \\"CAEQNhiBgMDJgZCA0BYiIDc4MGZjZGI2OTBjOTRmNTE5NmU5NmFhZjhjYmY0****\\",\\n \\"OSSDeleteMarker\\": \\"CAEQMhiBgIDXiaaB0BYiIGQzYmRkZGUxMTM1ZDRjOTZhNjk4YjRjMTAyZjhl****\\",\\n \\"OSSObjectType\\": \\"Normal\\",\\n \\"CustomId\\": \\"\\\\t\\\\nmember-image-id-0001\\",\\n \\"CustomLabels\\": {\\n \\"MemberName\\": \\"Tim\\",\\n \\"Enabled\\": \\"True\\",\\n \\"ItemCount\\": \\"10\\"\\n },\\n \\"StreamCount\\": 1,\\n \\"ProgramCount\\": 1,\\n \\"FormatName\\": \\"mov\\",\\n \\"FormatLongName\\": \\"QuickTime / MOV\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 13091201,\\n \\"Duration\\": 15.263,\\n \\"SemanticTypes\\": [\\n \\"content\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"text\\",\\n \\"Content\\": \\"文本片段\\",\\n \\"URL\\": \\"http://aliyun.com\\",\\n \\"TimeRange\\": [\\n 500\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"id1\\",\\n \\"ElementType\\": \\"title - 标题； image - 图片 ； table - 表格 ； narrative-text - 正文\\",\\n \\"SemanticSimilarity\\": 0.8,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"child，parent\\",\\n \\"ObjectId\\": \\"id1\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ],\\n \\"FrameTimes\\": [\\n 30\\n ],\\n \\"VideoStreamIndex\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"座椅\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"OCRTexts\\": \\"阿里云IMM\\",\\n \\"Reason\\": \\"[InternalError] The request has been failed due to some unknown error. status: 500, requestId: CC5ACFBD-BB7A-496D-A9D6-****\\",\\n \\"ObjectStatus\\": \\"Indexed\\",\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"无。\\",\\n \\"Caption\\": \\"视频中展示了两个不同场景：一个是静止的白色盘子、黑色瓶子和透明玻璃杯，另一个是手拿着标有“YEZOLU”的洗发水瓶在浴室中缓慢上移。\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"无。\\",\\n \\"Description\\": \\"图片中有一人，穿着深色西装外套，内搭白色衬衫。背景为渐变的浅蓝色至灰色。\\"\\n }\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'SemanticQuery', + 'description' => '### 注意事项'."\n" + ."\n" + .'- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。该接口每次请求，会产生语义理解费用和查询费用两种计费项各一次。'."\n" + ."\n" + .'- 调用该接口前，请确保您已通过绑定方式（ [CreateBinding](~~478202~~) ）或者主动索引（ [IndexFileMeta](~~478166~~) 或者 [BatchIndexFileMeta](~~478167~~) ）方式将文件索引到数据集（Dataset）中。'."\n" + ."\n" + .'- 返回结果仅为示例，根据[工作流模板配置](~~466304~~)不同，获取到的文件元数据信息的类别和包含的内容均有可能与示例不同。如果有疑问，请加入钉钉群进行反馈，钉钉群号请参见[联系我们](~~84454~~)。'."\n" + ."\n" + .'### 使用限制'."\n" + ."\n" + .'- 每次查询最多返回 100 个文件信息。'."\n" + ."\n" + .'- 不支持翻页查询。'."\n" + ."\n" + .'- 自然语言理解不保证完全准确。'."\n" + ."\n" + .'- 该功能在美国（硅谷），美国（弗吉尼亚）地域下不支持。'."\n" + ."\n" + .'### 使用方式'."\n" + ."\n" + .'使用自然语言关键词对数据集内的文件进行搜索查询。目前支持理解的关键信息包括标签（Labels.LabelName）、时间（ProduceTime）和地点（Address.AddressLine）等。例如，以`2023 年杭州的风景`为条件进行查询，会被智能拆分为如下三个条件，并查找出同时满足这些条件的文件：'."\n" + ."\n" + .'- ProduceTime：2023 年 1 月 1 日零点起到 2023 年 12 月 31 日结束止'."\n" + ."\n" + .'- Address.AddressLine：包含`杭州`关键词'."\n" + ."\n" + .'- Labels.LabelName：包含`风景`标签'."\n" + ."\n" + .'配合[工作流模板配置](~~466304~~)，当模板中包含`ImageEmbeddingExtraction`算子时，该搜索请求会提供基于图片内容的搜索，即您输入的`Query`内容会同时被理解为图片内包含的内容，从而实现对图片的智能检索。', + 'changeSet' => [ + ['createdAt' => '2025-09-20T12:43:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-05T08:43:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-04T03:24:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-20T06:58:49.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-09-04T06:34:40.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-12-13T05:33:41.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-23T09:22:48.000Z', 'description' => 'OpenAPI offline'], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '135762', - 'abilityTreeNodes' => [ - 'FEATUREimmJ1ILHI', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SemanticQuery'], ], ], - 'parameters' => [ + 'ramActions' => [ [ - '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****', - ], + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:SemanticQuery', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], ], ], ], ], - '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", + 'translator' => 'manual', ], - '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', - ], + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '131090', - 'abilityTreeNodes' => [ - 'FEATUREimmTATRRB', - ], + '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' => 'formData', - 'schema' => [ - 'description' => 'The name of the project.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the project.[](~~478153~~)'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ - 'name' => 'Input', - 'in' => 'formData', + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the dataset.[](~~478160~~)'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-dataset'], + ], + [ + 'name' => 'Query', + 'in' => 'query', 'style' => 'json', - 'schema' => [ - 'description' => 'The data source configurations.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/Input', - ], + 'schema' => ['description' => 'The query conditions.'."\n", 'required' => false, '$ref' => '#/components/schemas/SimpleQuery', 'title' => '', 'example' => ''], ], [ - 'name' => 'Actions', - 'in' => 'formData', + 'name' => 'Sort', + 'in' => 'query', + 'schema' => ['title' => '', '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' => [ - 'description' => 'The templates.'."\n", + '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 template.'."\n", + 'description' => 'The structure of the aggregation.'."\n", 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the template.'."\n", + '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' => 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', + 'enumValueTitles' => ['average' => '', 'min' => '', 'max' => '', 'count' => '', 'distinct' => '', 'sum' => '', 'group' => ''], + 'example' => 'sum', ], ], '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', - ], + 'title' => '', + 'example' => '', ], 'required' => false, + 'example' => '', ], ], [ - 'name' => 'Tags', - 'in' => 'formData', + 'name' => 'WithFields', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The custom tags. You can search for or filter asynchronous tasks by custom tag.'."\n", - 'type' => 'object', + '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', 'title' => ''], 'required' => false, - 'example' => '{"key": "val"}'."\n", + 'example' => '', ], ], [ - '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', - ], + '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, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The data structure returned.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EC564A9A-BA5C-4499-A087-D9B9E76E*****', + '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' => '', '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', 'title' => '', 'example' => ''], + 'example' => '', ], - 'Id' => [ - 'description' => 'The ID of the batch processing task.'."\n", - 'type' => 'string', - 'example' => 'batch-4eb9223f-3e88-42d3-a578-3f2852******', + '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', 'title' => ''], + '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'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'TotalHits' => ['description' => 'The number of total hits.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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.', + 'changeSet' => [ + ['createdAt' => '2023-11-22T06:30:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-09-04T06:34:39.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-25T02:53:46.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-25T02:53:46.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-25T02:53:46.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-06-15T02:14:20.000Z', 'description' => 'OpenAPI offline'], ], - '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", + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SimpleQuery'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:SimpleQuery', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==\\",\\n \\"RequestId\\": \\"2C5C1E0F-D8B8-4DA0-8127-EC32C771****\\",\\n \\"Files\\": [\\n {\\n \\"OwnerId\\": \\"102321002467****\\",\\n \\"ProjectName\\": \\"test-project\\",\\n \\"DatasetName\\": \\"test-dataset\\",\\n \\"ObjectType\\": \\"file\\",\\n \\"ObjectId\\": \\"75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7\\",\\n \\"UpdateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"CreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"URI\\": \\"oss://test-bucket/test-object.jpg\\",\\n \\"OSSURI\\": \\"oss://examplebucket/sampleobject.jpg\\",\\n \\"Filename\\": \\"sampleobject.jpg\\",\\n \\"MediaType\\": \\"image\\",\\n \\"ContentType\\": \\"image/jpeg\\",\\n \\"Size\\": 1000,\\n \\"FileHash\\": \\"1d9c280a7c4f67f7ef873e28449dbe17\\",\\n \\"FileModifiedTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileCreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"FileAccessTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"ProduceTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"LatLong\\": \\"30.134390,120.074997\\",\\n \\"Timezone\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"AddressLine\\": \\"中国浙江省杭州市余杭区文一西路969号\\",\\n \\"Country\\": \\"中国\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"District\\": \\"余杭区\\",\\n \\"Township\\": \\"文一西路\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"-\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"868a9e74-cde5-4c7a-9013-28bb984****\\",\\n \\"FigureConfidence\\": 1,\\n \\"FigureClusterId\\": \\"Cluster-dbe72fec-b84c-4ab6-885b-3678e64****\\",\\n \\"FigureClusterConfidence\\": 1,\\n \\"FigureType\\": \\"face\\",\\n \\"Age\\": 29,\\n \\"AgeSD\\": 5,\\n \\"Gender\\": \\"female\\",\\n \\"GenderConfidence\\": 1,\\n \\"Emotion\\": \\"happiness\\",\\n \\"EmotionConfidence\\": 0.70784568786621,\\n \\"FaceQuality\\": 0.960875928401947,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n },\\n \\"Mouth\\": \\"close\\",\\n \\"MouthConfidence\\": 1,\\n \\"Beard\\": \\"none\\",\\n \\"BeardConfidence\\": 1,\\n \\"Hat\\": \\"none\\",\\n \\"HatConfidence\\": 1,\\n \\"Mask\\": \\"none\\",\\n \\"MaskConfidence\\": 1,\\n \\"Glasses\\": \\"none\\",\\n \\"GlassesConfidence\\": 0.8,\\n \\"Sharpness\\": 0.7,\\n \\"Attractive\\": 0.96,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 18.385589599609375,\\n \\"Roll\\": 4.204030513763428,\\n \\"Yaw\\": 2.4945924282073975\\n }\\n }\\n ],\\n \\"FigureCount\\": 10,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Title\\": \\"test\\",\\n \\"ImageWidth\\": 270,\\n \\"ImageHeight\\": 500,\\n \\"EXIF\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.736\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877,\\n \\"Boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10,\\n \\"Top\\": 30,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 10,\\n \\"Y\\": 10\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 1080,\\n \\"VideoHeight\\": 1920,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"CodecTimeBase\\": \\"1373627/83160000\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"Width\\": 1280,\\n \\"Height\\": 720,\\n \\"HasBFrames\\": 2,\\n \\"SampleAspectRatio\\": \\"1:1\\",\\n \\"DisplayAspectRatio\\": \\"16:9\\",\\n \\"PixelFormat\\": \\"yuv420p\\",\\n \\"Level\\": 40,\\n \\"FrameRate\\": \\"25/1\\",\\n \\"AverageFrameRate\\": \\"25/1\\",\\n \\"TimeBase\\": \\"1/12800\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 22.88,\\n \\"Bitrate\\": 5407765,\\n \\"FrameCount\\": 572,\\n \\"Rotate\\": \\"90\\",\\n \\"BitDepth\\": 8,\\n \\"ColorSpace\\": \\"bt709\\",\\n \\"ColorRange\\": \\"tv\\",\\n \\"ColorTransfer\\": \\"bt709\\",\\n \\"ColorPrimaries\\": \\"bt709\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 2,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"mov_text\\",\\n \\"CodecLongName\\": \\"MOV text\\",\\n \\"CodecTagString\\": \\"tx3g\\",\\n \\"CodecTag\\": \\"0x67337874\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 71.378,\\n \\"Bitrate\\": 74,\\n \\"Content\\": \\"欢迎\\",\\n \\"Width\\": 600,\\n \\"Height\\": 30\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 1,\\n \\"Language\\": \\"en\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"TimeBase\\": \\"1/48000\\",\\n \\"StartTime\\": 0.0235,\\n \\"Duration\\": 3.690667,\\n \\"Bitrate\\": 320087,\\n \\"FrameCount\\": 173,\\n \\"Lyric\\": \\"test\\",\\n \\"SampleFormat\\": \\"fltp\\",\\n \\"SampleRate\\": 48000,\\n \\"Channels\\": 2,\\n \\"ChannelLayout\\": \\"stereo\\"\\n }\\n ],\\n \\"Artist\\": \\"Jane\\",\\n \\"AlbumArtist\\": \\"Jane\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 500,\\n \\"ImageHeight\\": 820,\\n \\"EXIF\\": \\"{\\\\\\"FileSize\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"29304\\\\\\"},\\\\\\"Format\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"jpg\\\\\\"}}\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.736\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"2:3\\",\\n \\"Confidence\\": 0.742\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"zh-hans\\",\\n \\"Contents\\": \\"欢迎使用智能媒体管理\\",\\n \\"Confidence\\": 0.8254936695098877\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"Jane\\",\\n \\"Performer\\": \\"Jane\\",\\n \\"Language\\": \\"eng\\",\\n \\"Album\\": \\"FirstAlbum\\",\\n \\"PageCount\\": 5,\\n \\"ETag\\": \\"\\\\\\"1D9C280A7C4F67F7EF873E28449****\\\\\\"\\",\\n \\"CacheControl\\": \\"no-cache\\",\\n \\"ContentDisposition\\": \\"attachment; filename =test.jpg\\",\\n \\"ContentEncoding\\": \\"UTF-8\\",\\n \\"ContentLanguage\\": \\"zh-CN\\",\\n \\"AccessControlAllowOrigin\\": \\"https://aliyundoc.com\\",\\n \\"AccessControlRequestMethod\\": \\"PUT\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"SM4\\",\\n \\"ServerSideEncryption\\": \\"AES256\\",\\n \\"ServerSideDataEncryption\\": \\"SM4\\",\\n \\"ServerSideEncryptionKeyId\\": \\"9468da86-3509-4f8d-a61e-6eab1eac****\\",\\n \\"OSSStorageClass\\": \\"Standard\\",\\n \\"OSSCRC64\\": \\"559890638950338001\\",\\n \\"ObjectACL\\": \\"default\\",\\n \\"ContentMd5\\": \\"HZwoCnxPZ/fvhz4oRJ2+Fw==\\",\\n \\"OSSUserMeta\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSTaggingCount\\": 2,\\n \\"OSSTagging\\": {\\n \\"key\\": \\"val\\"\\n },\\n \\"OSSExpiration\\": \\"2120-01-01T12:00:00.000Z\\",\\n \\"OSSVersionId\\": \\"CAEQNhiBgMDJgZCA0BYiIDc4MGZjZGI2OTBjOTRmNTE5NmU5NmFhZjhjYmY0****\\",\\n \\"OSSDeleteMarker\\": \\"CAEQMhiBgIDXiaaB0BYiIGQzYmRkZGUxMTM1ZDRjOTZhNjk4YjRjMTAyZjhl****\\",\\n \\"OSSObjectType\\": \\"Normal\\",\\n \\"CustomId\\": \\"\\\\t\\\\nmember-image-id-0001\\",\\n \\"CustomLabels\\": {\\n \\"MemberName\\": \\"Tim\\",\\n \\"Enabled\\": \\"True\\",\\n \\"ItemCount\\": \\"10\\"\\n },\\n \\"StreamCount\\": 1,\\n \\"ProgramCount\\": 1,\\n \\"FormatName\\": \\"mov\\",\\n \\"FormatLongName\\": \\"QuickTime / MOV\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 13091201,\\n \\"Duration\\": 15.263,\\n \\"SemanticTypes\\": [\\n \\"content\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"text\\",\\n \\"Content\\": \\"文本片段\\",\\n \\"URL\\": \\"http://aliyun.com\\",\\n \\"TimeRange\\": [\\n 500\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"id1\\",\\n \\"ElementType\\": \\"title - 标题； image - 图片 ； table - 表格 ； narrative-text - 正文\\",\\n \\"SemanticSimilarity\\": 0.8,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"child，parent\\",\\n \\"ObjectId\\": \\"id1\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 100\\n ],\\n \\"FrameTimes\\": [\\n 30\\n ],\\n \\"VideoStreamIndex\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"zh-Hans\\",\\n \\"LabelName\\": \\"椅子\\",\\n \\"LabelLevel\\": 2,\\n \\"LabelConfidence\\": 0.95,\\n \\"ParentLabelName\\": \\"家具\\",\\n \\"CentricScore\\": 0.877,\\n \\"LabelAlias\\": \\"\\",\\n \\"Clips\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"OCRTexts\\": \\"阿里云IMM\\",\\n \\"Reason\\": \\"[InternalError] The request has been failed due to some unknown error. status: 500, requestId: CC5ACFBD-BB7A-496D-A9D6-****\\",\\n \\"ObjectStatus\\": \\"Indexed\\",\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"无。\\",\\n \\"Caption\\": \\"视频中展示了两个不同场景：一个是静止的白色盘子、黑色瓶子和透明玻璃杯，另一个是手拿着标有“YEZOLU”的洗发水瓶在浴室中缓慢上移。\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"无。\\",\\n \\"Description\\": \\"图片中有一人，穿着深色西装外套，内搭白色衬衫。背景为渐变的浅蓝色至灰色。\\"\\n }\\n }\\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":""}]', ], 'SuspendBatch' => [ 'summary' => 'Suspends a batch processing task.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -22647,30 +15364,18 @@ 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '131169', - 'abilityTreeNodes' => [ - 'FEATUREimmTATRRB', - ], + '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', - ], + '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' => ''], ], [ '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******', - ], + '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******', 'title' => ''], ], ], 'responses' => [ @@ -22680,29 +15385,39 @@ '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*****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EC564A9A-BA5C-4499-A087-D9B9E76E*****'], ], + 'example' => '', ], ], ], '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', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SuspendBatch'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:SuspendBatch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Batch', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/batch/*'], + ], + ], + ], ], + ], + 'SuspendTrigger' => [ + 'summary' => 'Suspends a running trigger.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -22711,63 +15426,61 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '131172', - 'abilityTreeNodes' => [ - 'FEATUREimmTATRRB', - ], + 'abilityTreeCode' => '135764', + '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', - ], + 'schema' => ['description' => 'The name of the project.[](~~478153~~)'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ '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******', - ], + 'schema' => ['description' => 'The ID of the trigger.[](~~479912~~)'."\n", 'type' => 'string', 'required' => true, 'example' => 'trigger-9f72636a-0f0c-4baf-ae78-38b27b******', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D2C628B8-35DF-473C-8A41-757F30******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0BC1F0C9-8E99-46C6-B502-10DED******'], ], + 'example' => '', ], ], ], - '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', + '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", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SuspendTrigger'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:SuspendTrigger', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Trigger', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/trigger/*'], + ], + ], + ], ], + ], + 'UpdateBatch' => [ + 'summary' => 'Updates information for a batch processing task, such as the data source configuration, data processing configuration, and tags.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -22780,270 +15493,230 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '131143', - 'abilityTreeNodes' => [ - 'FEATUREimmTATRRB', - ], + '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', - ], + 'schema' => ['description' => 'The project name. For more information, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ '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******', - ], + 'schema' => ['description' => 'The ID of the batch processing task. For more information, see [Create a batch processing task](~~606694~~).', 'type' => 'string', 'required' => true, 'example' => 'batch-4eb9223f-3e88-42d3-a578-3f2852******', 'title' => ''], ], [ 'name' => 'Input', 'in' => 'formData', 'style' => 'json', - 'schema' => [ - 'description' => 'The input data source.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/Input', - ], + 'schema' => ['description' => 'The data source configuration.', 'required' => false, '$ref' => '#/components/schemas/Input', 'title' => '', 'example' => ''], ], [ 'name' => 'Actions', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The processing templates.'."\n", + 'description' => 'A list of data processing templates.', 'type' => 'array', 'items' => [ - 'description' => 'The processing template.'."\n", + 'description' => 'Template information.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'doc/convert', - ], + 'Name' => ['description' => 'The template name.', 'type' => 'string', 'required' => false, 'example' => 'doc/convert', 'title' => ''], 'Parameters' => [ - 'description' => 'The template parameters.'."\n", + 'description' => 'A list of template parameters.', 'type' => 'array', - 'items' => [ - 'description' => 'The template parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pages=3', - ], + 'items' => ['description' => 'A template parameter.', 'type' => 'string', 'required' => false, 'example' => 'pages=3', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ '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"}', - ], + 'schema' => ['description' => 'Custom tags used to search for and filter asynchronous tasks.', 'type' => 'object', 'required' => false, 'example' => '{"key":"val"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CB4D73A3-BAF4-4A9D-A631-15F219AF****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB4D73A3-BAF4-4A9D-A631-15F219AF****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + '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', + 'description' => '- You can update a batch processing task only when its status is Ready or Failed. The update does not change the current status of the task.'."\n" + ."\n" + .'- After the update, an incomplete batch processing task does not automatically resume. To resume the task, call the [ResumeBatch](~~479914~~) operation.', + 'changeSet' => [ + ['createdAt' => '2023-07-05T05:47:23.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateBatch'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:UpdateBatch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Batch', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/batch/*'], + ], + ], + ], ], + ], + 'UpdateDataset' => [ + 'summary' => 'Updates the information of a dataset.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '131116', - 'abilityTreeNodes' => [ - 'FEATUREimmTATRRB', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREimmSZD9WY'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the project.[](~~478153~~)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['title' => '', 'description' => 'The project name. For information about how to obtain the project name, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ - 'name' => 'State', + 'name' => 'DatasetName', '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', - ], + 'schema' => ['title' => '', 'description' => 'The dataset name. For information about how to obtain the dataset name, see [Create a dataset](~~478160~~).', 'type' => 'string', 'required' => true, 'example' => 'test-dataset'], ], [ - 'name' => 'Sort', + 'name' => 'Description', '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', - ], + 'schema' => ['title' => '', 'description' => 'The description of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'immtest'], ], [ - 'name' => 'Order', + 'name' => 'TemplateId', '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', - ], + 'schema' => ['title' => '', 'description' => 'The workflow template ID. For more information, see [Workflow templates and operators](~~466304~~).', 'type' => 'string', 'required' => false, 'example' => 'Official:ImageManagement'], ], [ - 'name' => 'TagSelector', + 'name' => 'DatasetMaxBindCount', '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', - ], + 'schema' => ['title' => '', 'description' => 'The maximum number of bindings for each dataset. Valid values: 1 to 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], ], [ - 'name' => 'NextToken', + 'name' => 'DatasetMaxFileCount', '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==', - ], + 'schema' => ['title' => '', 'description' => 'The maximum number of files in each dataset. Valid values: 1 to 100000000.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000000'], ], [ - 'name' => 'MaxResults', + 'name' => 'DatasetMaxEntityCount', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The maximum number of metadata entities (including data files, file relationships, and clustering groups) in each dataset. The maximum value is 2^63-1.'."\n" + .'>This is a reserved parameter and is not enforced during use.', '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 maximum value is 2^63-1.'."\n" + .'>This is a reserved parameter and is not enforced during use.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000000000'], + ], + [ + 'name' => 'DatasetMaxTotalFileSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The maximum total file size in each dataset. After this limit is exceeded, no more indexes can be added. The maximum value is 2^63-1. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '90000000000000000'], + ], + [ + 'name' => 'WorkflowParameters', + 'in' => 'query', + 'style' => 'json', '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', + 'description' => 'Invalid parameter.', + 'type' => 'array', + 'items' => ['description' => 'Invalid parameter.', '$ref' => '#/components/schemas/WorkflowParameter', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, - 'example' => '10', + 'deprecated' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response struct.', '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****', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '45234D4A-A3E3-4B23-AACA-8D897514****'], + 'Dataset' => ['description' => 'The dataset.', '$ref' => '#/components/schemas/Dataset', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - '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', + 'title' => 'Update a dataset', + 'description' => '- **Before you use this operation, make sure that you fully understand the billing of Intelligent Media Management (IMM) and its [pricing](~~477042~~)**.'."\n" + ."\n" + .'- Before you update dataset information, make sure that the dataset has been created. To create a dataset, refer to the request parameter descriptions.'."\n" + .'- When you update dataset information, specify only the fields that you want to update. Fields that are not specified remain unchanged.'."\n" + .'- After a dataset is updated, the changes may take up to 5 minutes to take effect.', + 'changeSet' => [ + ['createdAt' => '2025-06-12T08:03:49.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-06-15T02:14:12.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDataset'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:UpdateDataset', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], ], + ], + 'UpdateFigureCluster' => [ + 'summary' => 'Updates information about a face cluster, such as the cluster name and labels.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -23051,102 +15724,105 @@ ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '131105', - 'abilityTreeNodes' => [ - 'FEATUREimmTATRRB', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '103839', + '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' => 'test-project', - ], + 'schema' => ['description' => 'The name of the project.[](~~478153~~)'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'DatasetName', '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******', - ], + 'schema' => ['description' => 'The name of the dataset.[](~~478160~~)'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-dataset', 'title' => ''], + ], + [ + 'name' => 'FigureCluster', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The information about the cluster.'."\n", 'required' => true, '$ref' => '#/components/schemas/FigureClusterForReq', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response parameters.'."\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****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5F74C5C9-5AC0-49F9-914D-E01589D3****'], ], + 'example' => '', ], ], ], - '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', + '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", + 'changeSet' => [ + ['createdAt' => '2024-01-22T11:04:56.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-01-09T05:44:46.000Z', 'description' => 'Response parameters changed, Response parameters changed'], + ['createdAt' => '2022-10-28T03:52:45.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFigureCluster'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:UpdateFigureCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], ], + ], + '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' => 'delete', - 'abilityTreeCode' => '131141', - 'abilityTreeNodes' => [ - 'FEATUREimmTATRRB', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '33172', + 'abilityTreeNodes' => ['FEATUREimmSZD9WY'], ], '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', - ], + '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' => ''], ], [ - '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******', - ], + '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' => ''], + ], + [ + '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', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -23156,485 +15832,2897 @@ '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******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6D53E6C9-5AC0-48F9-825F-D02678E3****'], ], + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + '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", + 'changeSet' => [ + ['createdAt' => '2023-04-23T08:06:47.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-06-15T02:14:00.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFileMeta'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:UpdateFileMeta', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6D53E6C9-5AC0-48F9-825F-D02678E3****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'UpdateLocationDateCluster' => [ + 'summary' => 'Updates a spatiotemporal cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '185053', - 'abilityTreeNodes' => [ - 'FEATUREimmKH590Y', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '157778', + 'abilityTreeNodes' => ['FEATUREimmPECUUL'], ], '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', - ], + 'schema' => ['description' => 'The name of the project.[](~~478153~~)'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'DatasetName', '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', - ], + 'schema' => ['description' => 'The name of the dataset.[](~~478160~~)'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-dataset', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'ObjectId', '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==', - ], + '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', 'title' => ''], + ], + [ + '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' => 'One-day trip in Hangzhou', 'title' => ''], + ], + [ + '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', 'title' => ''], + ], + [ + '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" + .'}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应结构体', - 'description' => 'Response structure.', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", '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', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '52B017A8-FEF5-0A61-BAEE-234A8AD8****', 'title' => ''], ], + 'example' => '', ], ], ], - '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', + '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", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLocationDateCluster'], + ], ], - 'schemes' => [ - 'https', - 'sse', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:UpdateLocationDateCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], ], + ], + 'UpdateProject' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '226491', - 'abilityTreeNodes' => [ - 'FEATUREimmDN11M0', - ], + 'abilityTreeCode' => '495', + 'abilityTreeNodes' => ['FEATUREimmKH590Y'], ], '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", - ], + 'allowEmptyValue' => false, + 'schema' => ['title' => '', 'description' => 'The project name. For information about how to obtain the project name, see [Create a project](~~478153~~).', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ - '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' => 'ServiceRole', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The service role that grants Intelligent Media Management (IMM) permissions to access other cloud resources such as Object Storage Service (OSS).'."\n" + ."\n" + .'To customize a service role, create a regular service role in the Resource Access Management (RAM) console and grant permissions to the role. For more information, see [Create a regular service role](~~116800~~) and [Grant permissions to a role](~~116147~~).', 'type' => 'string', 'required' => false, 'example' => 'AliyunIMMDefaultRole'], ], [ - 'name' => 'Files', - 'in' => 'formData', + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The project description. The description must be 1 to 256 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'immtest'], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The workflow template ID. For more information, see [Workflow templates and operators](~~466304~~).', 'type' => 'string', 'required' => false, 'example' => 'Official:ImageManagement'], + ], + [ + 'name' => 'ProjectMaxDatasetCount', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The maximum number of datasets in the project. Valid values: 1 to 1000000000.', '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.', '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.', '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" + .'>This is a reserved parameter and is not enforced during use.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000000000'], + ], + [ + 'name' => 'DatasetMaxRelationCount', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The maximum number of metadata relationships in each dataset.'."\n" + .'>This is a reserved parameter and is not enforced during use.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000000000'], + ], + [ + 'name' => 'DatasetMaxTotalFileSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The maximum total file size in each dataset. After the limit is exceeded, no more indexes can be added. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '90000000000000000'], + ], + [ + 'name' => 'Tag', + 'in' => 'query', '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.', + 'description' => 'The list of tags.', 'type' => 'array', 'items' => [ - 'description' => 'List of files involved in the Q&A', + 'description' => 'The tag information.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], + ], 'required' => false, - '$ref' => '#/components/schemas/ContextualFile', + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response struct.', '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.', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D33C3574-4093-448E-86E7-15BE2BD3****'], + 'Project' => ['description' => 'The project information. Click Project for details.', '$ref' => '#/components/schemas/Project', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'Update a project', + 'summary' => 'Updates the information of a created project.', + 'description' => '- Before updating project information, make sure the project has been created. To create a project, refer to the request parameter descriptions.'."\n" + .'- When updating project information, specify only the fields that you want to update. Fields that are not specified remain unchanged.'."\n" + .'- Project updates do not take effect immediately. Wait up to 5 minutes for the updates to take effect.', + 'changeSet' => [ + ['createdAt' => '2024-05-23T03:29:15.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-02-28T03:44:04.000Z', 'description' => 'Response parameters changed, Error codes changed'], + ['createdAt' => '2021-06-15T02:14:20.000Z', 'description' => 'OpenAPI offline'], ], - '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', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProject'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:UpdateProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D33C3574-4093-448E-86E7-15BE2BD3****\\",\\n \\"Project\\": {\\n \\"ProjectName\\": \\"immtest\\",\\n \\"ServiceRole\\": \\"AliyunIMMDefaultRole\\",\\n \\"TemplateId\\": \\"Official:ImageManagement\\",\\n \\"CreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"UpdateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"Description\\": \\"test project\\",\\n \\"ProjectQueriesPerSecond\\": 100,\\n \\"EngineConcurrency\\": 100,\\n \\"ProjectMaxDatasetCount\\": 1000000000,\\n \\"DatasetMaxBindCount\\": 10,\\n \\"DatasetMaxFileCount\\": 100000000,\\n \\"DatasetMaxEntityCount\\": 10000000000,\\n \\"DatasetMaxRelationCount\\": 100000000000,\\n \\"DatasetMaxTotalFileSize\\": 90000000000000000,\\n \\"DatasetCount\\": 5,\\n \\"FileCount\\": 10,\\n \\"TotalFileSize\\": 100000,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"TestKey\\",\\n \\"TagValue\\": \\"TestValue\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'UpdateStory' => [ + 'summary' => 'Updates the information about a story, such as the story name and cover image.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '226437', - 'abilityTreeNodes' => [ - 'FEATUREimmDN11M0', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '123272', + 'abilityTreeNodes' => ['FEATUREimmPQ568C'], ], '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', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The name of the project.'."\n", 'type' => 'string', 'required' => true, 'example' => 'immtest', 'title' => ''], ], [ 'name' => 'DatasetName', - 'in' => 'query', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the dataset.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testdata', 'title' => ''], + ], + [ + 'name' => 'ObjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the story.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testid', 'title' => ''], + ], + [ + 'name' => 'StoryName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the story.'."\n", 'type' => 'string', 'required' => false, 'example' => 'newstory', 'title' => ''], + ], + [ + 'name' => 'Cover', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The dataset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-dataset', + '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://test-bucket/test-object', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Messages', + '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"}', 'title' => ''], + ], + [ + 'name' => 'CustomId', + 'in' => 'formData', + 'schema' => ['description' => 'The custom ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ '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', + '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****', 'title' => ''], ], - 'required' => true, + 'example' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6E93D6C9-5AC0-49F9-914D-E02678D3****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'UpdateStory', + 'changeSet' => [ + ['createdAt' => '2022-07-07T07:23:00.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateStory'], + ], + ], + 'ramActions' => [ [ - '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', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:UpdateStory', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], ], ], + ], + ], + 'UpdateTrigger' => [ + 'summary' => 'Updates information about a trigger, such as the input data source, data processing settings, and tags.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SmartClusterIds', + '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', 'title' => ''], + ], + [ + '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******', 'title' => ''], + ], + [ + 'name' => 'Input', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['description' => 'The data source configurations.'."\n", 'required' => false, '$ref' => '#/components/schemas/Input', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Actions', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The IDs of clusters from which results are retrieved.'."\n", + 'description' => 'The processing templates.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', + 'description' => 'The processing template.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The template name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'doc/convert', 'title' => ''], + 'Parameters' => [ + 'description' => 'The template parameters.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The template parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'pages=3', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'example' => 'SmartCluster-01686226-be59-4391-a1ac-b7b073455de3', + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + '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"}', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + '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****', - ], - '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', - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5A022F78-B9A8-4ACC-BB6B-B35975******'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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", + 'changeSet' => [ + ['createdAt' => '2023-07-05T05:47:22.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTrigger'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:UpdateTrigger', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Trigger', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/trigger/*'], + ], + ], + ], ], - '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-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imm.cn-shenzhen.aliyuncs.com', 'endpoint' => 'imm.cn-shenzhen.aliyuncs.com', 'vpc' => 'imm-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imm.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'imm.cn-wulanchabu.aliyuncs.com', 'vpc' => 'imm-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imm.cn-beijing.aliyuncs.com', 'endpoint' => 'imm.cn-beijing.aliyuncs.com', 'vpc' => 'imm-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imm.cn-chengdu.aliyuncs.com', 'endpoint' => 'imm.cn-chengdu.aliyuncs.com', 'vpc' => 'imm-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imm.cn-qingdao.aliyuncs.com', 'endpoint' => 'imm.cn-qingdao.aliyuncs.com', 'vpc' => 'imm-vpc.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imm.cn-shanghai.aliyuncs.com', 'endpoint' => 'imm.cn-shanghai.aliyuncs.com', 'vpc' => 'imm-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imm.cn-guangzhou.aliyuncs.com', 'endpoint' => 'imm.cn-guangzhou.aliyuncs.com', 'vpc' => 'imm-vpc.cn-guangzhou.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imm.cn-hongkong.aliyuncs.com', 'endpoint' => 'imm.cn-hongkong.aliyuncs.com', 'vpc' => 'imm-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imm.ap-southeast-1.aliyuncs.com', 'endpoint' => 'imm.ap-southeast-1.aliyuncs.com', 'vpc' => 'imm-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imm.ap-southeast-2.aliyuncs.com', 'endpoint' => 'imm.ap-southeast-2.aliyuncs.com', 'vpc' => 'imm-vpc.ap-southeast-2.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imm.ap-southeast-5.aliyuncs.com', 'endpoint' => 'imm.ap-southeast-5.aliyuncs.com', 'vpc' => 'imm-vpc.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imm.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'imm.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'imm-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imm.cn-hangzhou.aliyuncs.com', 'endpoint' => 'imm.cn-hangzhou.aliyuncs.com', 'vpc' => 'imm-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'imm.us-west-1.aliyuncs.com', 'endpoint' => 'imm.us-west-1.aliyuncs.com', 'vpc' => 'imm-vpc.us-west-1.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'imm.us-east-1.aliyuncs.com', 'endpoint' => 'imm.us-east-1.aliyuncs.com', 'vpc' => 'imm-vpc.us-east-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'imm.eu-central-1.aliyuncs.com', 'endpoint' => 'imm.eu-central-1.aliyuncs.com', 'vpc' => 'imm-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'imm.eu-west-1.aliyuncs.com', 'endpoint' => 'imm.eu-west-1.aliyuncs.com', 'vpc' => 'imm-vpc.eu-west-1.aliyuncs.com'], + ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'imm.ap-south-1.aliyuncs.com', 'endpoint' => 'imm.ap-south-1.aliyuncs.com', 'vpc' => 'imm-vpc.ap-south-1.aliyuncs.com'], + ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'imm.cn-north-2-gov-1.aliyuncs.com', 'endpoint' => 'imm.cn-north-2-gov-1.aliyuncs.com', 'vpc' => 'imm-vpc.cn-north-2-gov-1.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'AccessDenied', 'message' => 'You are not authorized to operate GenerateWebofficeToken on the specified resources acs:imm:cn-shanghai:111111111111111:project/test.', 'http_code' => 403, 'description' => 'The user is not authorized to use the specified API to perform operations. Check the permissions of the account.'], + ['code' => 'AccessDenied', 'message' => 'You are not authorized to operate %s on the specified resources %s.', 'http_code' => 403, 'description' => 'Access rights error, no access rights.'], + ['code' => 'ActionNotSupported', 'message' => 'The requested action \'DetectTextAnomaly\' is not supported. Please check.', 'http_code' => 400, 'description' => 'The currently requested operation is not supported.'], + ['code' => 'ExecutionTimeout', 'message' => 'Request timed out. Please try again later.', 'http_code' => 408, 'description' => 'Request timed out.'], + ['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 500, 'description' => ''], + ['code' => 'InvalidAction.%s', 'message' => 'The specified action %s is not valid.', 'http_code' => 400, 'description' => 'The operation is illegal.'], + ['code' => 'InvalidAction.EncodeBlindWatermark', 'message' => 'The specified action EncodeBlindWatermark is not valid.', 'http_code' => 400, 'description' => 'The operation is illegal.'], + ['code' => 'InvalidAdaptiveResolutionDirection', 'message' => 'Specified parameter AdaptiveResolutionDirection is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAlign', 'message' => 'Specified parameter Align is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'BatchUpdate size exceeded, should be no more than 100.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'BatchIndex size exceeded, should be no more than 100.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'BatchGet size exceeded, should be no more than 100.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'BatchDelete size exceeded, should be no more than 100.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'AspectRatios not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'File format not supported or file size limitation exceeded.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'File does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'File corrupt.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'FigureCluster not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Empty ProjectName.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Definition should not be empty', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Definition should be yaml format', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Cover.URI is required', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Cover figure not found', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'cluster not found', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'invalid nextToken', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid LiveTranscodingTarget.TranscodeAhead. Reason: the value should be no lesser than 0.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid LiveTranscodingTarget.Speed. Reason: the value should be no lesser than 0.5.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid LiveTranscodingTarget.InitialTranscode. Reason: the value should be no lesser than 0.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid LiveTranscodingTarget.Duration. Reason: the value should be no lesser than 5.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid LiveTranscodingTarget.Duration. Reason: the value should be no greater than 30.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Index KV count exceeded, should be no more than 100.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Incorrect format of AspectRatios.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'File URI not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'File not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Target.Speed. Reason: the value should be no greater than 2.0.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Target.Segment.Format. Reason: the value should be one of [hls dash raw].', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Target.Segment.Duration. Reason: the value should be greater than 0.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Target.Container. Reason: the value is required with URI.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Target output.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Source.URI. Reason: the value is required.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Source.StartTime. Reason: the value should be no lesser than 0.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Source.Duration. Reason: the value should be no lesser than 0.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Rotate.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid parameter(s).', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'MaxFileCount must be >= MinFileCount', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Targets info.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Target.Video.Transcode.Rotation. Reason: the value should be one of [0 90 180 270].', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Target.Video.Transcode.Refs. Reason: the value should be no lesser than 0.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Target.Video.Transcode.GOPSize. Reason: the value should be no lesser than 0.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Target.Video.Transcode.CRF. Reason: the value should be no lesser than 0.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Target.Video.Transcode.BufferSize. Reason: the value should be greater than 0.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Target.Video.Transcode.Bitrate. Reason: the value should be greater than 0.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Target.Video.Transcode.BFrames. Reason: the value should be no lesser than 0.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Target.Speed. Reason: the value should be no lesser than 0.5.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'oss://imm-test-co-cn-beijing/zqh/input/Image/mao.jpg has no faces', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Order should be in [asc desc]', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'OctreeOption.PointResolution must be in [0, 1].', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'OctreeOption.OctreeResolution must be in [0, 1].', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'OctreeOption is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'ObjectId should not be empty.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'no access to the bucket', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Message: invalid token', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'MaxResults should be in [1, 100]', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'MaxResults exceeded, should be no more than 100.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'TaskType should be VideoLabelClassification.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'TargetURI should match oss uri schema.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Target.URI should match oss or pds uri schema.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Target.ManifestURI should match oss uri schema.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'StoryStartTime should be in RFC3339Nano format.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'StoryEndTime should be in RFC3339Nano format.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'SourceURI should match oss or pds uri schema.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Sources or SourceManifestURI must provide one.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Sort should be in [Name CreateTime UpdateTime]', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Sort field not supported.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'The parameter ProjectName is required but not provided.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'The parameter Name is required but not provided.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'The maximum length of AspectRatios is 5.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'The input parameter TargetURI not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'The input parameter Target.Video and Target.Subtitle should not both be empty.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'The input parameter Target.Type should be in [square diamond hexagon blur pure]', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'The input parameter Target.Boundary.ReferPos should be in [topleft topright bottomleft bottomright]', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'The input parameter SourceURI not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'The input parameter SourceSubtitle.URI should be webvtt format', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'The input parameter SourceSubtitle.URI should be the parent directory of master URI.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'WithField abc not supported.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'URIs not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'URI1 or URI2 must be assigned.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'URI not indexed', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Type should be in [sync async]', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Token should be base64 string.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Token not valid', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'The StoryStartTime must be less than StoryEndTime', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'The parameter Target.MasterURI is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Target.Video.Transcode.Resolution. Reason: the value should be "" or the value should be a resolution format({width}x{height}, width & height should be even and no greater than 4096).', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Target.Video.Transcode.PixelFormat. Reason: the value should be "" or the value should be one of [yuv420p yuv422p yuv444p yuv420p10le yuv422p10le yuv444p10le].', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Target.Video.Transcode.Codec. Reason: the value should be "" or the value should be one of [copy h264 h265].', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Target.Video.Filter.Watermarks[0].Type. Reason: the value should be "file" if URI is required.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Target.Video.Filter.Watermarks[0].ReferPos. Reason: the value should be "" or the value should be one of [topright topleft bottomright bottomleft].', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Target.Video.Filter.Delogos[0].ReferPos. Reason: the value should be "" or the value should be one of [topright topleft bottomright bottomleft].', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Target.Container. Reason: the value should be "" or the value should be one of [mp4 mkv mov asf avi mxf ts flv mp3 aac flac oga ac3 opus amr].', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Aggregation "group" with field "CustomLabels.test" is not supported yet.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'The input parameter Target.Boundary.Y is too small (min: 0, actual: \'-20\'.)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'The input parameter Target.Boundary.X is too small (min: 0, actual: \'-20\'.)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'The input parameter Target.Boundary.Width should be greater than 0, actual: \'-100\'.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'The input parameter Target.Boundary.Height should be greater than 0, actual: \'-100\'.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'The input parameter Target.BlurRadius is too small (min: 1, actual: \'-5\'.)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'The input parameter Target.BlurRadius is too small (min: 1, actual: \'0\'.)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'The input parameter Target.BlurRadius is too large (max: 50, actual: \'51\'.)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'The input parameter SourceURI \'oss://imm-test-co-cn-beijing/zqh/input/Video/not-exists.ts\' is not a valid ts file.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Order should be either "asc" or "desc".', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'Invalid Target.Video.Transcode.ScaleType. Reason: the value should be "" or the value should be one of [crop stretch fill fit].', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'The input parameter Target.Sigma is too small (min: 1, actual: \'0\'.)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument', 'message' => 'The input parameter Target.MosaicRadius is too small (min: 1, actual: \'-10\'.)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.%s', 'message' => 'The parameter %s is Invalid.', 'http_code' => 400, 'description' => 'The parameter% s is invalid.'], + ['code' => 'InvalidArgument.AccessToken', 'message' => 'The AccessToken does not exists', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.Align', 'message' => 'The parameter Align is too small (minimum: 0, actual: -1)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.CompressedFormat', 'message' => 'The parameter CompressedFormat is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.CompressedFormat', 'message' => 'The parameter CompressedFormat (abcdef) should be one of [zip]', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.Content', 'message' => 'The parameter Content is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.CreateTaskRequest.ProjectName', 'message' => 'The parameter CreateTaskRequest.ProjectName is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.DatasetMaxBindCount', 'message' => 'The parameter DatasetMaxBindCount is too small (minimum: 0, actual: -1)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.DatasetMaxEntityCount', 'message' => 'The parameter DatasetMaxEntityCount is too small (minimum: 0, actual: -1)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.DatasetMaxFileCount', 'message' => 'The parameter DatasetMaxFileCount is too small (minimum: 0, actual: -1)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.DatasetMaxRelationCount', 'message' => 'The parameter DatasetMaxRelationCount is too small (minimum: 0, actual: -1)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.DatasetMaxTotalFileSize', 'message' => 'The parameter DatasetMaxTotalFileSize is too small (minimum: 0, actual: -1)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.DatasetName', 'message' => 'The parameter DatasetName should be a name which matches regex [_a-zA-Z][-_a-zA-Z0-9]*', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.DatasetName', 'message' => 'The parameter DatasetName is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.DatasetName', 'message' => 'The length of parameter DatasetName exceeded maximum value of 128', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.DateOptions.GapDays', 'message' => 'The parameter DateOptions.GapDays is too small (minimum: 0, actual: -1)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.DateOptions.MaxDays', 'message' => 'The parameter DateOptions.MaxDays is too small (minimum: 1, actual: -1)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.DateOptions.MinDays', 'message' => 'The parameter DateOptions.MinDays is too small (minimum: 1, actual: -1)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.Direction', 'message' => 'The parameter Direction (sssss) should be one of [horizontal vertical]', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.Filename', 'message' => 'Unsupported preview file type [png]', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.Files', 'message' => 'The parameter Files is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.From', 'message' => 'The parameter From is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.ImageDPI', 'message' => 'The parameter ImageDPI (95) should be greater than or equal to 96', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.ImageDPI', 'message' => 'The parameter ImageDPI (601) should be less than or equal to 600', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.ImageDPI', 'message' => 'The parameter ImageDPI (-1) should be greater than or equal to 96', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.ImageFormat', 'message' => 'The parameter ImageFormat (xlsx) should be one of [jpg png webp]', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.ImageFormat', 'message' => 'The parameter ImageFormat (xlsx) should be one of [jpg jpeg png webp bmp jp2 tiff]', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.ListRequest.MaxResults', 'message' => 'The parameter ListRequest.MaxResults is too small (minimum: 1, actual: -1)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.LocationOptions.LocationDateClusterLevels[1]', 'message' => 'The parameter LocationOptions.LocationDateClusterLevels[1] (abc) should be one of [country province city district township]', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.Margin', 'message' => 'The parameter Margin is too small (minimum: 0, actual: -1)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.MasterURI', 'message' => 'The parameter MasterURI should start with oss://', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.MaxFileCount', 'message' => 'The parameter MaxFileCount is too small (minimum: 0, actual: -1)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.MaxResults', 'message' => 'The parameter MaxResults is too large (maximum: 200, actual: 201)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.MaxResults', 'message' => 'The parameter MaxResults is too small (minimum: 0, actual: -1)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.MaxSheetColumn', 'message' => 'The parameter MaxSheetColumn (-1) should be greater than or equal to 0', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.MaxSheetRow', 'message' => 'The parameter MaxSheetRow (-1) should be greater than or equal to 0', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.MinFileCount', 'message' => 'The parameter MinFileCount is too small (minimum: 0, actual: -1)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.ObjectId', 'message' => 'The parameter ObjectId is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.Order', 'message' => 'The parameter Order (abcdefaaaa) should be one of [asc desc]', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.Order', 'message' => 'The parameter Order (abc) should be one of [asc desc]', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.OSSBucket', 'message' => 'The parameter OSSBucket is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.Padding', 'message' => 'The parameter Padding is too small (minimum: 0, actual: -1)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.Pages', 'message' => 'The parameter must be in Printer Pages format, e.g. 1,3-5,7', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.PaperSize', 'message' => 'The parameter PaperSize (A8) should be one of [A0 A2 A4]', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.PointCloudFields', 'message' => 'The parameter PointCloudFields is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.PreviewPages', 'message' => 'The parameter PreviewPages (-4) should be greater than or equal to 0', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.ProjectMaxDatasetCount', 'message' => 'The parameter ProjectMaxDatasetCount is too small (minimum: 0, actual: -1)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.ProjectName', 'message' => 'The parameter ProjectName should be a name which matches regex [_a-zA-Z][-_a-zA-Z0-9]*', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.ProjectName', 'message' => 'The parameter ProjectName is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.ProjectName', 'message' => 'The length of parameter ProjectName exceeded maximum value of 128', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.Quality', 'message' => 'The parameter Quality is too large (maximum: 100, actual: 101)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.Quality', 'message' => 'The parameter Quality (101) should be less than or equal to 100', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.Quality', 'message' => 'The parameter Quality (-1) should be greater than or equal to 0', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.Quality', 'message' => 'The parameter Quality is too small (minimum: 0, actual: -1)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.Query', 'message' => 'The parameter Query is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.RefreshToken', 'message' => 'The RefreshToken is different from our record', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.ScalePercentage', 'message' => 'The parameter ScalePercentage (201) should be less than 200', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.ScalePercentage', 'message' => 'The parameter ScalePercentage (-1) should be greater than or equal to 20', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.ScalePercentage', 'message' => 'The parameter ScalePercentage (1) should be greater than or equal to 20', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.ScaleType', 'message' => 'The parameter ScaleType (sssss) should be one of [fit stretch]', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.Sensitivity', 'message' => 'The parameter Sensitivity is too small (minimum: 0.0, actual: -1)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.Sensitivity', 'message' => 'The parameter Sensitivity is too large (maximum: 1.0, actual: 2)', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.SheetCount', 'message' => 'The parameter SheetCount (-1) should be greater than or equal to 0', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.SheetIndex', 'message' => 'The parameter SheetIndex (-1) should be greater than or equal to 0', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.Sort', 'message' => 'The parameter Sort (abc) should be one of [CreateTime ModifyTime LocationDateClusterStartTime LocationDateClusterEndTime]', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.Sort', 'message' => 'The parameter Sort is Invalid.', 'http_code' => 400, 'description' => 'The Sort parameter is invalid.'], + ['code' => 'InvalidArgument.Sources', 'message' => 'The parameter Sources is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.SourceString', 'message' => 'The parameter SourceString is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.SourceType', 'message' => 'The parameter SourceType (jpg) should be one of [pdf doc dot wps wpt docx dotx docm dotm txt wpss lrc c cpp h asm s java asp bat bas prg cmd rtf log xml htm html pptx ppt pot potx pps ppsx dps dpt pptm potm ppsm dpss xls xlt et ett xlsx xltx csv xlsb xlsm xltm ets]', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.SourceType', 'message' => 'The parameter SourceType (aabbcc) should be one of [pdf doc dot wps wpt docx dotx docm dotm txt wpss lrc c cpp h asm s java asp bat bas prg cmd rtf log xml htm html pptx ppt pot potx pps ppsx dps dpt pptm potm ppsm dpss xls xlt et ett xlsx xltx csv xlsb xlsm xltm ets]', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.SourceURI', 'message' => 'The parameter SourceURI should start with oss://', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.SourceURI', 'message' => 'The parameter SourceURI is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.SrcUri', 'message' => 'The source URI is too large or too complex to be converted within the time limit.', 'http_code' => 400, 'description' => 'The source URI is too large or complex to complete the conversion in the given time'], + ['code' => 'InvalidArgument.StartPage', 'message' => 'The parameter StartPage (-1) should be greater than 0', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.StoryName', 'message' => 'The parameter StoryName is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.StorySubType', 'message' => 'The parameter StorySubType is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.StoryType', 'message' => 'The parameter StoryType is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.Target.URI', 'message' => 'The parameter Target.URI is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.Targets', 'message' => 'The parameter Targets is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.TargetType', 'message' => 'The parameter TargetType is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.TargetType', 'message' => 'The parameter TargetType (xlsx) should be one of [pdf jpg png txt]', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.TargetType', 'message' => 'The parameter TargetType (jpeg) should be one of [pdf jpg png txt]', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.TargetType', 'message' => 'The parameter TargetType (docx) should be one of [pdf jpg png txt]', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.TargetURI', 'message' => 'The parameter TargetURI should start with oss://', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.TargetURI', 'message' => 'The parameter TargetURI is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.TargetURIPrefix', 'message' => 'The parameter TargetURIPrefix is required without TargetURI but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.TaskId', 'message' => 'The parameter TaskId is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.To', 'message' => 'The parameter To is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.URI', 'message' => 'The parameter URI should start with oss://', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.URI', 'message' => 'The parameter URI is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgument.User', 'message' => 'The parameter User is required but not provided', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidCompressionLevel', 'message' => 'Specified parameter CompressionLevel is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidCompressMethod', 'message' => 'Specified parameter CompressMethod is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidDatasetMaxEntityCount', 'message' => 'Specified parameter DatasetMaxEntityCount is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidDoVoxelGridDownDownSampling', 'message' => 'Specified parameter DoVoxelGridDownDownSampling is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidDuration', 'message' => 'Specified parameter Duration is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidEndPage', 'message' => 'Specified parameter EndPage is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidExternalUploaded', 'message' => 'Specified parameter ExternalUploaded is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFirstPage', 'message' => 'Specified parameter FirstPage is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFitToHeight', 'message' => 'Specified parameter FitToHeight is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFitToWidth', 'message' => 'Specified parameter FitToWidth is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFloat', 'message' => 'Specified parameter Float is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFrameRate', 'message' => 'Specified parameter FrameRate is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidGapDays', 'message' => 'Specified parameter GapDays is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidHidecmb', 'message' => 'Specified parameter Hidecmb is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidHoldLineFeed', 'message' => 'Specified parameter HoldLineFeed is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImageDPI', 'message' => 'Specified parameter ImageDPI is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImageUri.NotFound', 'message' => 'The resource ImageUri cannot be found. Please check.', 'http_code' => 400, 'description' => 'Image resource link does not exist, please check.'], + ['code' => 'InvalidInitialTranscode', 'message' => 'Specified parameter InitialTranscode is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON Array parsing error, Aggregations', 'message' => 'Specified parameter JSON Array parsing error, Aggregations is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON Array parsing error, Files', 'message' => 'Specified parameter JSON Array parsing error, Files is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON Array parsing error, InitialSegments', 'message' => 'Specified parameter JSON Array parsing error, InitialSegments is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON Array parsing error, LocationDateClusterLevels', 'message' => 'Specified parameter JSON Array parsing error, LocationDateClusterLevels is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON Array parsing error, PointCloudFields', 'message' => 'Specified parameter JSON Array parsing error, PointCloudFields is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON Array parsing error, SelectedFiles', 'message' => 'Specified parameter JSON Array parsing error, SelectedFiles is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON Array parsing error, Sources', 'message' => 'Specified parameter JSON Array parsing error, Sources is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON Array parsing error, SourceSubtitles', 'message' => 'Specified parameter JSON Array parsing error, SourceSubtitles is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON Array parsing error, Targets', 'message' => 'Specified parameter JSON Array parsing error, Targets is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON Array parsing error, WithFields', 'message' => 'Specified parameter JSON Array parsing error, WithFields is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON parsing error, Address', 'message' => 'Specified parameter JSON parsing error, Address is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON parsing error, Audio', 'message' => 'Specified parameter JSON parsing error, Audio is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON parsing error, Cover', 'message' => 'Specified parameter JSON parsing error, Cover is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON parsing error, CreateTimeRange', 'message' => 'Specified parameter JSON parsing error, CreateTimeRange is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON parsing error, CustomLabels', 'message' => 'Specified parameter JSON parsing error, CustomLabels is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON parsing error, DateOptions', 'message' => 'Specified parameter JSON parsing error, DateOptions is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON parsing error, FigureCluster', 'message' => 'Specified parameter JSON parsing error, FigureCluster is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON parsing error, KdtreeOption', 'message' => 'Specified parameter JSON parsing error, KdtreeOption is not valid.', 'http_code' => 400, 'description' => 'Parameter KdtreeOption JSON parsing error, not in the correct JSON format.'], + ['code' => 'InvalidJSON parsing error, LocationDateClusterStartTimeRange', 'message' => 'Specified parameter JSON parsing error, LocationDateClusterStartTimeRange is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON parsing error, LocationOptions', 'message' => 'Specified parameter JSON parsing error, LocationOptions is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON parsing error, OctreeOption', 'message' => 'Specified parameter JSON parsing error, OctreeOption is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON parsing error, Permission', 'message' => 'Specified parameter JSON parsing error, Permission is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON parsing error, Route', 'message' => 'Specified parameter JSON parsing error, Route is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON parsing error, Segment', 'message' => 'Specified parameter JSON parsing error, Segment is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON parsing error, Source', 'message' => 'Specified parameter JSON parsing error, Source is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON parsing error, StoryEndTimeRange', 'message' => 'Specified parameter JSON parsing error, StoryEndTimeRange is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON parsing error, StoryStartTimeRange', 'message' => 'Specified parameter JSON parsing error, StoryStartTimeRange is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON parsing error, SubtitlesItem', 'message' => 'Specified parameter JSON parsing error, SubtitlesItem is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON parsing error, Tags', 'message' => 'Specified parameter JSON parsing error, Tags is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON parsing error, Target', 'message' => 'Specified parameter JSON parsing error, Target is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON parsing error, TrimPolicy', 'message' => 'Specified parameter JSON parsing error, TrimPolicy is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON parsing error, UpdateTimeRange', 'message' => 'Specified parameter JSON parsing error, UpdateTimeRange is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON parsing error, User', 'message' => 'Specified parameter JSON parsing error, User is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON parsing error, Video', 'message' => 'Specified parameter JSON parsing error, Video is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSON parsing error, Watermark', 'message' => 'Specified parameter JSON parsing error, Watermark is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidLibraryName', 'message' => 'Specified parameter LibraryName is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidLongPicture', 'message' => 'Specified parameter LongPicture is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidLongText', 'message' => 'Specified parameter LongText is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidMargin', 'message' => 'Specified parameter Margin is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidMaxBitrate', 'message' => 'Specified parameter MaxBitrate is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidMaxDays', 'message' => 'Specified parameter MaxDays is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidMaxFileCount', 'message' => 'Specified parameter MaxFileCount is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidMaxResults', 'message' => 'Specified parameter MaxResults is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidMaxSheetColumn', 'message' => 'Specified parameter MaxSheetColumn is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidMaxSheetRow', 'message' => 'Specified parameter MaxSheetRow is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidMetaLockVersion', 'message' => 'Specified parameter MetaLockVersion is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidMinDays', 'message' => 'Specified parameter MinDays is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidMinFileCount', 'message' => 'Specified parameter MinFileCount is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidPadding', 'message' => 'Specified parameter Padding is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidPaperHorizontal', 'message' => 'Specified parameter PaperHorizontal is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidParameter.%s', 'message' => 'The parameter %s is invalid.', 'http_code' => 400, 'description' => 'The parameter% s is invalid.'], + ['code' => 'InvalidPointCloudFileFormat', 'message' => 'Specified parameter PointCloudFileFormat is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidPreviewPages', 'message' => 'Specified parameter PreviewPages is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidProject.NotFound', 'message' => 'The resource Project cannot be found. Please check.', 'http_code' => 404, 'description' => 'The project does not exist.'], + ['code' => 'InvalidQuality', 'message' => 'Specified parameter Quality is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidQuantizationBits', 'message' => 'Specified parameter QuantizationBits is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidRegion', 'message' => 'The parameter Region is Invalid.', 'http_code' => 400, 'description' => 'The parameter Region is invalid. Please check whether it is correctly filled in'], + ['code' => 'InvalidScalePercentage', 'message' => 'Specified parameter ScalePercentage is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidSheetCount', 'message' => 'Specified parameter SheetCount is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidSheetIndex', 'message' => 'Specified parameter SheetIndex is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidShowComments', 'message' => 'Specified parameter ShowComments is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidSourceDuration', 'message' => 'Specified parameter SourceDuration is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidSourceStartTime', 'message' => 'Specified parameter SourceStartTime is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidSpeed', 'message' => 'Specified parameter Speed is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidStartPage', 'message' => 'Specified parameter StartPage is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidTopK', 'message' => 'Specified parameter TopK is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidTranscodeAhead', 'message' => 'Specified parameter TranscodeAhead is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidWithStatistics', 'message' => 'Specified parameter WithStatistics is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'LimitExceededError', 'message' => 'Message: input quota exceed the max value', 'http_code' => 400, 'description' => ''], + ['code' => 'MalformedPOSTRequest', 'message' => 'Invalid json string.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingAccessToken', 'message' => 'AccessToken is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingAdapterName', 'message' => 'AdapterName is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingAdapterType', 'message' => 'AdapterType is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingArgument.%s', 'message' => 'The parameter %s is Missing.', 'http_code' => 400, 'description' => 'Missing request parameter% s.'], + ['code' => 'MissingCompressMethod', 'message' => 'CompressMethod is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingContent', 'message' => 'Content is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingCover', 'message' => 'Cover is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingDatasetName', 'message' => 'DatasetName is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingDateOptions', 'message' => 'DateOptions is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingDefinition', 'message' => 'Definition is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingFigureCluster', 'message' => 'FigureCluster is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingFile', 'message' => 'File is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingFiles', 'message' => 'Files is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingFrom', 'message' => 'From is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingGapDays', 'message' => 'GapDays is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingLocationDateClusterLevels', 'message' => 'LocationDateClusterLevels is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingLocationOptions', 'message' => 'LocationOptions is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingName', 'message' => 'Name is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingObjectId', 'message' => 'ObjectId is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingOSSBucket', 'message' => 'OSSBucket is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingPointCloudFields', 'message' => 'PointCloudFields is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingProjectName', 'message' => 'ProjectName is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingQuery', 'message' => 'Query is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingRefreshToken', 'message' => 'RefreshToken is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingRoute', 'message' => 'Route is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingSources', 'message' => 'Sources is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingSourceURI', 'message' => 'SourceURI is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingStoryName', 'message' => 'StoryName is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingStorySubType', 'message' => 'StorySubType is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingStoryType', 'message' => 'StoryType is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingTarget', 'message' => 'Target is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingTargets', 'message' => 'Targets is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingTargetType', 'message' => 'TargetType is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingTargetURI', 'message' => 'TargetURI is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingTaskId', 'message' => 'TaskId is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingTaskType', 'message' => 'TaskType is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingTo', 'message' => 'To is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingType', 'message' => 'Type is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingURI', 'message' => 'URI is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingURIs', 'message' => 'URIs is mandatory for this action.', 'http_code' => 400, 'description' => ''], + ['code' => 'OSSAccessError', 'message' => 'OSS access error. Please check your permission.', 'http_code' => 400, 'description' => 'Error accessing OSS. Check the account permissions.'], + ['code' => 'QuotaExhausted.CU', 'message' => 'The resource CU has exceeded the limit.', 'http_code' => 429, 'description' => 'The API frequency of the current request exceeds the CU limit set when the Project is created.'], + ['code' => 'QuotaExhausted.ProjectCount', 'message' => 'The resource ProjectCount has exceeded the limit. Please refer to document.', 'http_code' => 400, 'description' => 'The number of project resources exceeds the limit.'], + ['code' => 'ResourceAlreadyExists', 'message' => 'The specified resource test-exist-cn-beijing-XU3BoL7PY already exists.', 'http_code' => 400, 'description' => ''], + ['code' => 'ResourceAlreadyExists', 'message' => 'The specified resource project already exists.', 'http_code' => 400, 'description' => ''], + ['code' => 'ResourceAlreadyExists', 'message' => 'The specified resource imm-test-set-f12de312-921e-11ed-8467-00163e10bd70 already exists.', 'http_code' => 400, 'description' => ''], + ['code' => 'ResourceAlreadyExists', 'message' => 'The specified resource binding already exists.', 'http_code' => 400, 'description' => ''], + ['code' => 'ResourceAlreadyExists', 'message' => 'The specified resource abcdefaaaa already exists.', 'http_code' => 400, 'description' => ''], + ['code' => 'ResourceAlreadyExists', 'message' => 'The specified resource already exists.', 'http_code' => 400, 'description' => ''], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource 123 is not found.', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource is not found.', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource imm-doc-test-regression-IiyTXhLz9 is not found.', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource imm-doc-test-regression-B6feMmuWc is not found.', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource dataset is not found.', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource Binding is not found.', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource acs:imm::1023210024677934:project/sssdsd is not found', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource acs:imm::1023210024677934:project/abcdefaaaa is not found', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource acs:imm::1023210024677934:project/abcde is not found', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource acs:imm::1023210024677934:project/aabbcc is not found', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource acs:imm::1023210024677934:project/ is not found', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource abcd is not found.', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource templateId is not found.', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource TaskId is not found.', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource sssdsd is not found.', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource project is not found.', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource OSSBucket is not found.', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource oss://imm-test-co-cn-beijing/zqh/input/Image/abcd.jpg is not found.', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource oss://imm-test-co-cn-beijing/zqh/input/FaceGroup/Single_Face/A.jpg is not found.', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource oss://abcxxx/a.pdf is not found', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource notexistsid is not found.', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource imm-doc-test-regression-R9Fj4tz3n is not found.', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource test-delete-cn-beijing-B6feMmuWc is not found.', 'http_code' => 404, 'description' => ''], + ['code' => 'StatusConflict', 'message' => 'Message: cannot delete when sub resoures exist', 'http_code' => 400, 'description' => ''], + ['code' => 'UnsupportedFile', 'message' => 'This file type is not supported, or the file size is too large.', 'http_code' => 400, 'description' => 'The file type is not supported, or the file size is too large.'], + ], + 'changeSet' => [ [ - 'regionId' => 'cn-beijing-gov-1', - 'endpoint' => 'imm-vpc.cn-beijing-gov-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ContextualAnswer'], + ], + 'createdAt' => '2025-01-02T06:37:47.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'imm.cn-beijing.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateOfficeConversionTask'], + ], + 'createdAt' => '2024-11-29T02:27:52.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'imm.cn-zhangjiakou.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateOfficeConversionTask'], + ], + 'createdAt' => '2024-10-18T06:40:05.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'imm.cn-hangzhou.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SemanticQuery'], + ], + 'createdAt' => '2024-09-05T08:41:51.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'imm.cn-shanghai.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SemanticQuery'], + ], + 'createdAt' => '2024-09-04T03:24:24.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'imm.cn-shenzhen.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateBinding'], + ['description' => 'Response parameters changed', 'api' => 'GetBinding'], + ], + 'createdAt' => '2024-09-03T10:58:49.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-north-2-gov-1', - 'endpoint' => 'imm.cn-north-2-gov-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'BatchGetFileMeta'], + ['description' => 'Request parameters changed', 'api' => 'GetFileMeta'], + ], + 'createdAt' => '2024-07-30T05:43:07.000Z', + 'description' => '', ], [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'imm.eu-west-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateProject'], + ['description' => 'Request parameters changed', 'api' => 'ListProjects'], + ['description' => 'Request parameters changed', 'api' => 'UpdateProject'], + ], + 'createdAt' => '2024-05-23T03:29:03.000Z', + 'description' => '', ], [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'imm.eu-central-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'AttachOSSBucket'], + ['description' => 'Error codes changed', 'api' => 'CreateBinding'], + ['description' => 'Error codes changed', 'api' => 'CreateImageModerationTask'], + ], + 'createdAt' => '2024-04-19T09:43:22.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'imm.cn-qingdao.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetDecodeBlindWatermarkResult'], + ], + 'createdAt' => '2024-04-19T07:25:05.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-guangzhou', - 'endpoint' => 'imm.cn-guangzhou.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'BatchIndexFileMeta'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'IndexFileMeta'], + ], + 'createdAt' => '2024-04-15T08:38:27.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'imm.cn-chengdu.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GenerateVideoPlaylist'], + ], + 'createdAt' => '2024-03-26T10:08:39.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'imm.ap-southeast-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DeleteProject'], + ], + 'createdAt' => '2024-03-01T02:19:23.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'imm.ap-southeast-5.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed, Error codes changed', 'api' => 'CreateProject'], + ['description' => 'Error codes changed', 'api' => 'DeleteProject'], + ['description' => 'Error codes changed', 'api' => 'GetProject'], + ['description' => 'Response parameters changed, Error codes changed', 'api' => 'UpdateProject'], + ], + 'createdAt' => '2024-02-28T03:43:57.000Z', + 'description' => '', ], [ - 'regionId' => 'us-east-1', - 'endpoint' => 'imm.us-east-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'UpdateFigureCluster'], + ], + 'createdAt' => '2024-01-22T11:04:51.000Z', + 'description' => '', ], [ - 'regionId' => 'us-west-1', - 'endpoint' => 'imm.us-west-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ExtractDocumentText'], + ], + 'createdAt' => '2023-12-13T05:45:35.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'imm.cn-hongkong.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SimpleQuery'], + ], + 'createdAt' => '2023-11-22T06:27:24.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-south-1', - 'endpoint' => 'imm.ap-south-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'FuzzyQuery'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SemanticQuery'], + ], + 'createdAt' => '2023-11-20T06:58:41.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-southeast-2', - 'endpoint' => 'imm.ap-southeast-2.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateFileCompressionTask'], + ], + 'createdAt' => '2023-11-20T06:17:33.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'imm.cn-wulanchabu.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'AttachOSSBucket'], + ['description' => 'Response parameters changed', 'api' => 'GetOSSBucketAttachment'], + ], + 'createdAt' => '2023-11-07T04:13:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'FuzzyQuery'], + ['description' => 'Response parameters changed', 'api' => 'SemanticQuery'], + ['description' => 'Response parameters changed', 'api' => 'SimpleQuery'], + ], + 'createdAt' => '2023-09-04T06:34:33.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GenerateWebofficeToken'], + ['description' => 'Response parameters changed', 'api' => 'RefreshWebofficeToken'], + ], + 'createdAt' => '2023-08-30T08:31:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateArchiveFileInspectionTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateFileUncompressionTask'], + ], + 'createdAt' => '2023-08-30T07:21:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateFacesSearchingTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateImageModerationTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateVideoModerationTask'], + ], + 'createdAt' => '2023-08-21T03:49:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DeleteBinding'], + ], + 'createdAt' => '2023-07-20T08:50:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateBatch'], + ['description' => 'Request parameters changed', 'api' => 'CreateTrigger'], + ], + 'createdAt' => '2023-07-05T05:36:37.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateFileCompressionTask'], + ], + 'createdAt' => '2023-05-12T08:01:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetTask'], + ['description' => 'Request parameters changed', 'api' => 'ListTasks'], + ], + 'createdAt' => '2023-05-11T10:49:37.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateMediaConvertTask'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'LiveTranscoding'], + ], + 'createdAt' => '2023-05-09T03:30:45.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'QueryFigureClusters'], + ], + 'createdAt' => '2023-04-27T10:07:04.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'BatchUpdateFileMeta'], + ['description' => 'Response parameters changed', 'api' => 'IndexFileMeta'], + ['description' => 'Request parameters changed', 'api' => 'UpdateFileMeta'], + ], + 'createdAt' => '2023-04-23T08:06:36.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GenerateVideoPlaylist'], + ], + 'createdAt' => '2023-04-04T06:11:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateArchiveFileInspectionTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateCompressPointCloudTask'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateDetectVideoLabelsTask'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateFacesSearchingTask'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateFigureClusteringTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateFigureClustersMergingTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateFileCompressionTask'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateFileUncompressionTask'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateImageModerationTask'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateImageSplicingTask'], + ], + 'createdAt' => '2023-04-03T02:35:57.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateMediaConvertTask'], + ], + 'createdAt' => '2023-04-03T02:29:54.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'BatchIndexFileMeta'], + ['description' => 'Request parameters changed', 'api' => 'IndexFileMeta'], + ], + 'createdAt' => '2023-03-27T08:54:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'BatchIndexFileMeta'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateArchiveFileInspectionTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateCompressPointCloudTask'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateFacesSearchingTask'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateFigureClusteringTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateFigureClustersMergingTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateFileCompressionTask'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateFileUncompressionTask'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateImageModerationTask'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateImageSplicingTask'], + ], + 'createdAt' => '2023-03-09T10:57:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'UpdateFigureCluster'], + ], + 'createdAt' => '2023-01-09T05:44:36.000Z', + 'description' => '修改UpdateFigureCluster。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'FuzzyQuery'], + ['description' => 'Response parameters changed', 'api' => 'SemanticQuery'], + ], + 'createdAt' => '2022-12-13T05:33:37.000Z', + 'description' => '删除冗余参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'CreateStory'], + ], + 'createdAt' => '2022-11-15T08:49:17.000Z', + 'description' => '支持时空故事', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateFileCompressionTask'], + ], + 'createdAt' => '2022-10-28T04:04:03.000Z', + 'description' => '支持在线解压功能', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetVideoPlaylist'], + ], + 'createdAt' => '2022-10-28T04:03:25.000Z', + 'description' => '边转边播 API 更新', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'QueryFigureClusters'], + ['description' => 'Response parameters changed', 'api' => 'UpdateFigureCluster'], + ], + 'createdAt' => '2022-10-28T03:53:20.000Z', + 'description' => '增强人脸聚类搜索能力', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDetectVideoLabelsTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateFigureClusteringTask'], + ], + 'createdAt' => '2022-08-16T06:50:28.000Z', + 'description' => 'mns endpoint 自动生成', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'BatchIndexFileMeta'], + ['description' => 'Request parameters changed', 'api' => 'BatchIndexFileMeta'], + ['description' => 'Request parameters changed', 'api' => 'CreateFigureClustersMergingTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateFigureClustersMergingTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateImageModerationTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateImageModerationTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateImageSplicingTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateImageSplicingTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateMediaConvertTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateMediaConvertTask'], + ], + 'createdAt' => '2022-08-16T06:48:03.000Z', + 'description' => 'mns endpoint 自动生成', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateCompressPointCloudTask'], + ], + 'createdAt' => '2022-08-16T02:32:44.000Z', + 'description' => '新增云压缩 api', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateImageSplicingTask'], + ], + 'createdAt' => '2022-07-20T03:19:28.000Z', + 'description' => '- Add more APIs.', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DetectImageBodies'], + ], + 'createdAt' => '2022-07-19T02:09:41.000Z', + 'description' => 'Add DetectImageBodies API.', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateImageSplicingTask'], + ], + 'createdAt' => '2022-07-19T02:09:27.000Z', + 'description' => 'Add CreateImageSplicingTask API.', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetMediaMeta'], + ], + 'createdAt' => '2022-07-07T07:26:18.000Z', + 'description' => '修复媒体接口相关BUG', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'AddStoryFiles'], + ['description' => 'OpenAPI offline', 'api' => 'RemoveStoryFiles'], + ['description' => 'Request parameters changed', 'api' => 'UpdateStory'], + ], + 'createdAt' => '2022-07-07T07:23:48.000Z', + 'description' => '新增添加、删除故事文件的接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DetectImageCodes'], + ], + 'createdAt' => '2022-07-07T06:44:44.000Z', + 'description' => '新增二维码检测接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ListRegions'], + ], + 'createdAt' => '2022-07-07T06:43:31.000Z', + 'description' => '新增 ListRegions 接口，返回 IMM 当前可用 Region 列表', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateOfficeConversionTask'], + ], + 'createdAt' => '2022-05-18T06:33:18.000Z', + 'description' => '文档转换新增参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDetectVideoLabelsTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateFigureClusteringTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateFigureClustersMergingTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateStory'], + ['description' => 'Response parameters changed', 'api' => 'GetTask'], + ['description' => 'Request parameters changed', 'api' => 'ListTasks'], + ], + 'createdAt' => '2022-04-26T03:38:28.000Z', + 'description' => '更新 Task 相关接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateOfficeConversionTask'], + ], + 'createdAt' => '2022-04-26T03:33:48.000Z', + 'description' => '支持文档转换 API', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'QueryStories'], + ], + 'createdAt' => '2022-04-26T03:33:25.000Z', + 'description' => '故事支持排序', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateMediaConvertTask'], + ['description' => 'OpenAPI offline', 'api' => 'GetMediaMeta'], + ], + 'createdAt' => '2022-04-26T03:30:43.000Z', + 'description' => '支持转码服务', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DetectImageCropping'], + ], + 'createdAt' => '2022-04-26T03:29:49.000Z', + 'description' => '支持 DetectImageCropping', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetWebofficeURL'], + ], + 'createdAt' => '2022-04-26T03:29:41.000Z', + 'description' => 'GetWeboffuceURL 支持缓存预览', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'AttachOSSBucket'], + ['description' => 'OpenAPI offline', 'api' => 'DetachOSSBucket'], + ['description' => 'OpenAPI offline', 'api' => 'GetOSSBucketAttachment'], + ], + 'createdAt' => '2022-04-19T03:32:43.000Z', + 'description' => '添加oss bucket和imm project绑定接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DetectImageFaces'], + ['description' => 'OpenAPI offline', 'api' => 'DetectImageScore'], + ], + 'createdAt' => '2022-04-13T03:48:24.000Z', + 'description' => '添加人脸识别接口、图片质量检测接口', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'SimpleQuery'], + ], + 'createdAt' => '2022-03-28T12:13:29.000Z', + 'description' => '修改返回类型为 Double', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SimpleQuery'], + ], + 'createdAt' => '2022-03-17T07:58:18.000Z', + 'description' => '- Support WithFields for SimpleQuery.', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'SimpleQuery'], + ], + 'createdAt' => '2022-01-25T02:56:17.000Z', + 'description' => '- Use float instead of string on SimpleQuery', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateStory'], + ], + 'createdAt' => '2021-12-31T07:39:05.000Z', + 'description' => '- 修改故事字段', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateDetectVideoLabelsTask'], + ['description' => 'OpenAPI offline', 'api' => 'GetDetectVideoLabelsResult'], + ['description' => 'OpenAPI offline', 'api' => 'GetTask'], + ['description' => 'OpenAPI offline', 'api' => 'ListTasks'], + ], + 'createdAt' => '2021-12-23T09:26:05.000Z', + 'description' => '- 新增任务 API', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'SemanticQuery'], + ], + 'createdAt' => '2021-12-23T09:23:31.000Z', + 'description' => '- 新增语义搜索 API', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DetectImageLabels'], + ], + 'createdAt' => '2021-10-20T13:22:41.000Z', + 'description' => 'Support DetectImageLabels API.', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetWebofficeURL'], + ], + 'createdAt' => '2021-10-13T09:51:44.000Z', + 'description' => '增加 referer 参数，支持 oss 防盗链', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'BatchDeleteFileMeta'], + ['description' => 'OpenAPI offline', 'api' => 'BatchGetFileMeta'], + ['description' => 'OpenAPI offline', 'api' => 'BatchIndexFileMeta'], + ['description' => 'OpenAPI offline', 'api' => 'BatchUpdateFileMeta'], + ['description' => 'OpenAPI offline', 'api' => 'CreateBinding'], + ['description' => 'OpenAPI offline', 'api' => 'CreateDataset'], + ['description' => 'OpenAPI offline', 'api' => 'CreateProject'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteDataset'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteFileMeta'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteProject'], + ], + 'createdAt' => '2021-06-15T02:15:24.000Z', + 'description' => 'IMM 2.0 API 发布。', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetectImageFaces'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMediaConvertTask'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBindings'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SimpleQuery'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteStory'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryStories'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFileCompressionTask'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetectTextAnomaly'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLocationDateClusteringTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EncodeBlindWatermark'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFigureClusters'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateStory'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBatch'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProject'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLocationDateCluster'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataset'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteProject'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDataset'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateWebofficeToken'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SuspendBatch'], + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBinding'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateVideoPlaylist'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchUpdateFileMeta'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOfficeConversionTask'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchGetFigureCluster'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProject'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateBatch'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CompareImageFaces'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTrigger'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetectImageCropping'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetStory'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDataset'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveStoryFiles'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCompressPointCloudTask'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOSSBucketAttachment'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddStoryFiles'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTriggers'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'IndexFileMeta'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomizedStory'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStory'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFacesSearchingTask'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFigureClustersMergingTask'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FuzzyQuery'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetectMediaMeta'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchIndexFileMeta'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFileMeta'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateImageToPDFTask'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProjects'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLocationDateCluster'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExtractDocumentText'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFileUncompressionTask'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFileMeta'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetectImageCars'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateImageModerationTask'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySimilarImageClusters'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachOSSBucket'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTrigger'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetectImageLabels'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTasks'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFigureCluster'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBatch'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryLocationDateClusters'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchImageFigureCluster'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetectImageCodes'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFigureCluster'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SemanticQuery'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetectImageBodies'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteBatch'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDataset'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTrigger'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetVideoLabelClassificationResult'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeTrigger'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateImageSplicingTask'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatasets'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteBinding'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTrigger'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefreshWebofficeToken'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateVideoLabelClassificationTask'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBinding'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachOSSBucket'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateVideoModerationTask'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegions'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchDeleteFileMeta'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchGetFileMeta'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFileMeta'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetectImageScore'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDecodeBlindWatermarkTask'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFigureClusteringTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SuspendTrigger'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProject'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddImageMosaic'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSimilarImageClusteringTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBatches'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateArchiveFileInspectionTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDecodeBlindWatermarkResult'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeBatch'], + ], + ], + 'ram' => [ + 'productCode' => 'IMM', + 'productName' => 'Intelligent Media Management', + 'ramCodes' => ['imm'], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'UpdateTrigger', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:UpdateTrigger', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Trigger', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/trigger/*'], + ], + ], + ], + [ + 'apiName' => 'QuerySimilarImageClusters', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:QuerySimilarImageClusters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'GetBinding', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetBinding', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'DeleteDataset', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imm:DeleteDataset', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'ListBindings', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:ListBindings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'CreateImageModerationTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateImageModerationTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'CreateBinding', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateBinding', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'GetOSSBucketAttachment', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetOSSBucketAttachment', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateArchiveFileInspectionTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateArchiveFileInspectionTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'ContextualRetrieval', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:ContextualRetrieval', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetStory', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetStory', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'CreateBatch', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateBatch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Batch', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/batch/*'], + ], + ], + ], + [ + 'apiName' => 'DetectImageLabels', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:DetectImageLabels', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'ExtractDocumentText', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:ExtractDocumentText', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'GetTask', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'ListDatasets', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:ListDatasets', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/*'], + ], + ], + ], + [ + 'apiName' => 'DetectImageCropping', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:DetectImageCropping', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'SemanticQuery', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:SemanticQuery', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'DeleteBinding', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imm:DeleteBinding', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'ListBatches', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:ListBatches', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Batch', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/batch/*'], + ], + ], + ], + [ + 'apiName' => 'EncodeBlindWatermark', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:EncodeBlindWatermark', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'DeleteStory', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imm:DeleteStory', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'IndexFileMeta', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:IndexFileMeta', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'DeleteFileMeta', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imm:DeleteFileMeta', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'FuzzyQuery', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:FuzzyQuery', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'DeleteBatch', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imm:DeleteBatch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Batch', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/batch/*'], + ], + ], + ], + [ + 'apiName' => 'CreateImageSplicingTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateImageSplicingTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'UpdateFigureCluster', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:UpdateFigureCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'QueryFigureClusters', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:QueryFigureClusters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'GetBatch', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetBatch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Batch', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/batch/*'], + ], + ], + ], + [ + 'apiName' => 'DeleteTrigger', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imm:DeleteTrigger', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Trigger', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/trigger/*'], + ], + ], + ], + [ + 'apiName' => 'ContextualAnswer', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:ContextualAnswer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'BatchGetFigureCluster', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:BatchGetFigureCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'DetectImageScore', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:DetectImageScore', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'SuspendTrigger', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:SuspendTrigger', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Trigger', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/trigger/*'], + ], + ], + ], + [ + 'apiName' => 'QueryStories', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:QueryStories', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'BatchGetFileMeta', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:BatchGetFileMeta', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'DetachOSSBucket', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imm:DetachOSSBucket', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GenerateVideoPlaylist', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:GenerateVideoPlaylist', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'SuspendBatch', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:SuspendBatch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Batch', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/batch/*'], + ], + ], + ], + [ + 'apiName' => 'DetectImageTexts', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:DetectImageTexts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'GetDecodeBlindWatermarkResult', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:GetDecodeBlindWatermarkResult', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListProjects', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:ListProjects', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/*'], + ], + ], + ], + [ + 'apiName' => 'CreateFileUncompressionTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateFileUncompressionTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'SearchImageFigureCluster', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:SearchImageFigureCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'CompareImageFaces', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:CompareImageFaces', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'ResumeBatch', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:ResumeBatch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Batch', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/batch/*'], + ], + ], + ], + [ + 'apiName' => 'DetectImageCodes', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:DetectImageCodes', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'CreateDataset', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateDataset', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'GetImageModerationResult', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetImageModerationResult', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'DetectMediaMeta', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:DetectMediaMeta', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'GetFileMeta', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetFileMeta', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'AddStoryFiles', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:AddStoryFiles', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'CreateImageToPDFTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateImageToPDFTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'GetFigureCluster', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetFigureCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'BatchUpdateFileMeta', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:BatchUpdateFileMeta', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'UpdateBatch', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:UpdateBatch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Batch', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/batch/*'], + ], + ], + ], + [ + 'apiName' => 'QueryLocationDateClusters', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:QueryLocationDateClusters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'AddImageMosaic', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:AddImageMosaic', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'CreateFacesSearchingTask', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:CreateFacesSearchingTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'CreateDecodeBlindWatermarkTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateDecodeBlindWatermarkTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'DeleteLocationDateCluster', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imm:DeleteLocationDateCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'GetProject', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'CreateOfficeConversionTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateOfficeConversionTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'CreateMediaConvertTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateMediaConvertTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'SimpleQuery', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:SimpleQuery', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'DetectTextAnomaly', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:DetectTextAnomaly', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'CreateCompressPointCloudTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateCompressPointCloudTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'CreateCustomizedStory', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateCustomizedStory', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'ResumeTrigger', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:ResumeTrigger', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Trigger', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/trigger/*'], + ], + ], + ], + [ + 'apiName' => 'RemoveStoryFiles', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:RemoveStoryFiles', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'DetectImageBodies', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:DetectImageBodies', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'UpdateProject', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:UpdateProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'GetVideoModerationResult', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetVideoModerationResult', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'CreateVideoModerationTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateVideoModerationTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'CreateHighlightTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateHighlightTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'ListTasks', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:ListTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'DetectImageCars', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:DetectImageCars', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'BatchIndexFileMeta', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:BatchIndexFileMeta', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'DeleteProject', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imm:DeleteProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'CreateTrigger', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateTrigger', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Trigger', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/trigger/*'], + ], + ], + ], + [ + 'apiName' => 'UpdateStory', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:UpdateStory', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'GetVideoLabelClassificationResult', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetVideoLabelClassificationResult', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'BatchDeleteFileMeta', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imm:BatchDeleteFileMeta', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'UpdateDataset', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:UpdateDataset', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'GetDataset', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetDataset', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'CreateProject', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'CreateSimilarImageClusteringTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateSimilarImageClusteringTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'GetTrigger', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imm:GetTrigger', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Trigger', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/trigger/*'], + ], + ], + ], + [ + 'apiName' => 'AttachOSSBucket', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:AttachOSSBucket', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'CreateFileCompressionTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateFileCompressionTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'UpdateFileMeta', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:UpdateFileMeta', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'CreateLocationDateClusteringTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateLocationDateClusteringTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'ListAttachedOSSBuckets', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:ListAttachedOSSBuckets', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'CreateFigureClusteringTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateFigureClusteringTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'CreateVideoLabelClassificationTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateVideoLabelClassificationTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'RefreshWebofficeToken', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:RefreshWebofficeToken', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'CreateFigureClustersMergingTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateFigureClustersMergingTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'GenerateWebofficeToken', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:GenerateWebofficeToken', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'ListTriggers', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'imm:ListTriggers', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Trigger', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/trigger/*'], + ], + ], + ], + [ + 'apiName' => 'CreateStory', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imm:CreateStory', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'UpdateLocationDateCluster', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'imm:UpdateLocationDateCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ], + ], + ], + [ + 'apiName' => 'DetectImageFaces', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'imm:DetectImageFaces', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IMM', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + ], + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'Trigger', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/trigger/*'], + ['validationType' => 'always', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}'], + ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}'], + ['validationType' => 'always', 'resourceType' => 'Batch', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/batch/*'], + ['validationType' => 'always', 'resourceType' => 'Dataset', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/*'], + ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:imm:{#regionId}:{#accountId}:project/*'], ], ], ]; |