diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/imm | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/imm')
| -rw-r--r-- | data/zh_cn/imm/2017-09-06/api-docs.php | 11977 | ||||
| -rw-r--r-- | data/zh_cn/imm/2020-09-30/api-docs.php | 21589 |
2 files changed, 33566 insertions, 0 deletions
diff --git a/data/zh_cn/imm/2017-09-06/api-docs.php b/data/zh_cn/imm/2017-09-06/api-docs.php new file mode 100644 index 0000000..c50737c --- /dev/null +++ b/data/zh_cn/imm/2017-09-06/api-docs.php @@ -0,0 +1,11977 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'imm', + 'version' => '2017-09-06', + ], + 'directories' => [ + [ + 'id' => 100259, + 'title' => '服务操作', + 'type' => 'directory', + 'children' => [ + 'OpenImmService', + ], + ], + [ + 'id' => 100262, + 'title' => '项目操作', + 'type' => 'directory', + 'children' => [ + 'DeleteProject', + 'UpdateProject', + 'GetProject', + 'ListProjects', + 'PutProject', + ], + ], + [ + 'id' => 100308, + 'title' => '媒体集管理', + 'type' => 'directory', + 'children' => [ + 'CreateSet', + 'DeleteSet', + 'UpdateSet', + 'GetSet', + 'ListSets', + ], + ], + [ + 'id' => 100269, + 'title' => '文档管理', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 169900, + 'title' => '文档转换同步请求', + 'type' => 'directory', + 'children' => [ + 'ConvertOfficeFormat', + ], + ], + [ + 'id' => 169901, + 'title' => '文档转换异步请求', + 'type' => 'directory', + 'children' => [ + 'ListOfficeConversionTask', + 'GetOfficeConversionTask', + 'DeleteOfficeConversionTask', + 'CreateOfficeConversionTask', + ], + ], + [ + 'id' => 169902, + 'title' => '文档预览', + 'type' => 'directory', + 'children' => [ + 'RefreshWebofficeToken', + 'RefreshOfficePreviewToken', + 'GetWebofficeURL', + 'GetOfficePreviewURL', + ], + ], + ], + ], + [ + 'id' => 100279, + 'title' => '图片管理', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 169903, + 'title' => '媒体集图片管理', + 'type' => 'directory', + 'children' => [ + 'GetImage', + 'DeleteImage', + 'FindImages', + 'ListImages', + 'UpdateImage', + 'IndexImage', + ], + ], + [ + 'id' => 169904, + 'title' => '媒体集人脸处理', + 'type' => 'directory', + 'children' => [ + 'FindSimilarFaces', + 'CompareImageFaces', + ], + ], + [ + 'id' => 169905, + 'title' => '人脸聚类', + 'type' => 'directory', + 'children' => [ + 'ListFaceGroups', + 'UpdateFaceGroup', + 'CreateGroupFacesJob', + 'CreateMergeFaceGroupsJob', + ], + ], + [ + 'id' => 169906, + 'title' => '媒体集标签处理', + 'type' => 'directory', + 'children' => [ + 'ListSetTags', + ], + ], + [ + 'id' => 169907, + 'title' => '图片分析', + 'type' => 'directory', + 'children' => [ + 'GetImageQuality', + 'GetImageCroppingSuggestions', + 'DetectQRCodes', + 'DetectImageQRCodes', + 'DetectImageTags', + ], + ], + [ + 'id' => 169908, + 'title' => '人脸人体', + 'type' => 'directory', + 'children' => [ + 'DetectImageFaces', + 'DetectImageBodies', + ], + ], + [ + 'id' => 169909, + 'title' => '图片盲水印', + 'type' => 'directory', + 'children' => [ + 'EncodeBlindWatermark', + 'DecodeBlindWatermark', + ], + ], + ], + ], + [ + 'id' => 100293, + 'title' => '视频管理', + 'type' => 'directory', + 'children' => [ + 'GetMediaMeta', + [ + 'id' => 169916, + 'title' => '媒体集视频处理', + 'type' => 'directory', + 'children' => [ + 'IndexVideo', + 'ListVideos', + 'GetVideo', + 'DeleteVideo', + ], + ], + [ + 'id' => 169917, + 'title' => '视频异步任务', + 'type' => 'directory', + 'children' => [ + 'GetVideoTask', + 'ListVideoTasks', + 'DeleteVideoTask', + 'CreateVideoCompressTask', + 'CreateGrabFrameTask', + ], + ], + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'OpenImmService' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + [ + 'PrivateKey' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'D28EF0A3-36C0-406A-A8F0-A82019B329B0', + ], + 'OrderId' => [ + 'description' => '开通服务的订单号。', + 'type' => 'string', + 'example' => '20671870851****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ORDER.OPENED', + 'errorMessage' => '您已开通,请前往<a href="https://imm.console.aliyun.com/">控制台</a>使用', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D28EF0A3-36C0-406A-A8F0-A82019B329B0\\",\\n \\"OrderId\\": \\"20671870851****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>D28EF0A3-36C0-406A-A8F0-A82019B329B0</RequestId>\\n<OrderId>20671870851****</OrderId>","errorExample":""}]', + 'title' => '开通智能媒体管理服务', + 'summary' => '调用OpenImmService接口开通智能媒体管理服务。', + 'description' => '- 此接口已不再维护，建议使用[新版（2020-09-30版本）API](~~478146~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + .'- 只有华东1（杭州）和华东2（上海）地域支持使用此接口开通智能媒体管理服务。', + 'requestParamsDescription' => ' ', + ], + 'DeleteProject' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'FEDC9B1F-30F2-4C1F-8ED2-B78601870B44', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEDC9B1F-30F2-4C1F-8ED2-B78601870B44\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>FEDC9B1F-30F2-4C1F-8ED2-B78601870B44</RequestId>","errorExample":""}]', + 'title' => '删除一个项目', + 'summary' => '调用DeleteProject接口删除一个项目。', + 'description' => '- 此接口已不再维护，建议使用新版（2020-09-30版本）接口[DeleteProject](~~478157~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + .'- 删除项目时，项目为延迟删除，系统会在北京时间次日凌晨删除项目。删除后，才可以新建同名的项目，如果需要立即创建同名的项目，请使用钉钉搜索钉钉群号31690030817加入钉钉群进行反馈。'."\n" + .'- 当项目不合法、不存在或者处于删除中时，此操作仍会执行成功。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateProject' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'NewCU', + 'in' => 'query', + 'schema' => [ + 'description' => '2021.04.01以后创建的类型为内容管理的项目不需要传该参数，在此之前已创建的项目不受影响。'."\n" + ."\n" + .'当项目的计费类型为ByCU时，此参数才能修改。'."\n" + ."\n" + .'每秒能够处理的最大请求数。取值范围为0~10。该值为1表示每秒钟只能处理1个请求，该值为0表示项目不再计费。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '6', + ], + ], + [ + 'name' => 'NewServiceRole', + 'in' => 'query', + 'schema' => [ + 'description' => '服务角色，授权给IMM服务以访问其他云资源（例如OSS）的权限。'."\n" + ."\n" + .'您也可以通过RAM控制台创建授权角色。具体操作，请参见[创建普通服务角色](https://help.aliyun.com/document_detail/116800.html)。', + 'type' => 'string', + 'required' => false, + 'example' => 'immroletest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Project' => [ + 'description' => '项目名称，和请求时一致。', + 'type' => 'string', + 'example' => 'immtest', + ], + 'ModifyTime' => [ + 'description' => '项目的修改时间。', + 'type' => 'string', + 'example' => '2020-11-11T06:36:58Z', + ], + 'Type' => [ + 'description' => '项目的类型。', + 'type' => 'string', + 'example' => 'DocStarter', + ], + 'CU' => [ + 'description' => '2021.04.01以后创建的类型为内容管理的项目该字段无效。'."\n" + ."\n" + .'当项目的计费类型为ByCU时，此参数才生效。'."\n" + ."\n" + .'每秒能够处理的最大请求数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'ServiceRole' => [ + 'description' => '服务角色。'."\n" + ."\n" + .'如果请求时未修改服务角色，则返回值为创建项目时设置的服务角色；如果创建项目时未设置服务角色，则返回值为空。', + 'type' => 'string', + 'example' => 'immroletest', + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'D33C3574-4093-448E-86E7-15BE2BD36963', + ], + 'CreateTime' => [ + 'description' => '项目的创建时间。', + 'type' => 'string', + 'example' => '2020-11-10T03:50:28Z', + ], + 'RegionId' => [ + 'description' => '项目所在地域的ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Project\\": \\"immtest\\",\\n \\"ModifyTime\\": \\"2020-11-11T06:36:58Z\\",\\n \\"Type\\": \\"DocStarter\\",\\n \\"CU\\": 6,\\n \\"ServiceRole\\": \\"immroletest\\",\\n \\"RequestId\\": \\"D33C3574-4093-448E-86E7-15BE2BD36963\\",\\n \\"CreateTime\\": \\"2020-11-10T03:50:28Z\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyTime>2020-11-11T06:36:58Z</ModifyTime>\\n<Project>immtest</Project>\\n<Type>DocStarter</Type>\\n<CU>6</CU>\\n<ServiceRole>immroletest</ServiceRole>\\n<RequestId>D33C3574-4093-448E-86E7-15BE2BD36963</RequestId>\\n<CreateTime>2020-11-10T03:50:28Z</CreateTime>\\n<RegionId>cn-hangzhou</RegionId>","errorExample":""}]', + 'title' => '更新项目的CU或服务角色信息', + 'summary' => '调用UpdateProject接口更新项目的CU或服务角色信息。', + 'description' => '此接口已不再维护，建议使用新版（2020-09-30版本）接口[UpdateProject](~~478154~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### 错误码'."\n" + .'| HttpCode | 错误码 | 错误信息 | 描述 |'."\n" + .'| ---- | ---- |---- | ---- |'."\n" + .'| 400 |InvalidParameter |The resource Paramater is not valid. Please check. |未设置NewCU或者NewServiceRole。 |'."\n" + .'| 400 |InvalidProject.NotFound |The resource Project cannot be found. Please check. |指定的Project不存在。 |'."\n" + .'| 400 |InvalidProject.Deleting |The resource Project is deleting. Please check. |指定的Project正在删除中，项目会在北京时间次日凌晨删除。删除后，才可以新建同名的项目，如果需要马上创建，请使用钉钉搜索钉钉群号31690030817加入钉钉群进行反馈。|'."\n" + .'| 400 |InvalidParameter.NewCU |The input parameter NewCU is not valid. Please refer to document.|NewCU不合法，请参考NewCU参数的描述进行设置。 |', + ], + 'GetProject' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immtest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Project' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'example' => 'immtest', + ], + 'ModifyTime' => [ + 'description' => '项目的修改时间。'."\n" + ."\n" + .'创建项目后，如果未更新过项目，则项目的修改时间和项目的创建时间相同。', + 'type' => 'string', + 'example' => '2020-11-10T03:50:28Z', + ], + 'Type' => [ + 'description' => '项目的类型。', + 'type' => 'string', + 'example' => 'DocStarter', + ], + 'CU' => [ + 'description' => '此参数2021.04.01废弃。'."\n" + ."\n" + .'当BillingType设置为ByCU时，此参数才生效。'."\n" + ."\n" + .'每秒能够处理的最大请求数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ServiceRole' => [ + 'description' => '服务角色。'."\n" + ."\n" + .'如果创建项目时未指定此参数，则返回值为空。', + 'type' => 'string', + 'example' => 'AliyunIMMDefaultRole', + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '5A022F78-B9A8-4ACC-BB6B-B35975534551', + ], + 'Endpoint' => [ + 'description' => '项目所在地域的服务地址。', + 'type' => 'string', + 'example' => 'imm.cn-hangzhou.aliyuncs.com', + ], + 'CreateTime' => [ + 'description' => '项目的创建时间。', + 'type' => 'string', + 'example' => '2020-11-10T03:50:28Z', + ], + 'RegionId' => [ + 'description' => '项目所在地域的ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'BillingType' => [ + 'description' => '此参数2021.04.01废弃。'."\n" + ."\n" + .'计费类型。', + 'type' => 'string', + 'example' => 'ByCU', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Project\\": \\"immtest\\",\\n \\"ModifyTime\\": \\"2020-11-10T03:50:28Z\\",\\n \\"Type\\": \\"DocStarter\\",\\n \\"CU\\": 5,\\n \\"ServiceRole\\": \\"AliyunIMMDefaultRole\\",\\n \\"RequestId\\": \\"5A022F78-B9A8-4ACC-BB6B-B35975534551\\",\\n \\"Endpoint\\": \\"imm.cn-hangzhou.aliyuncs.com\\",\\n \\"CreateTime\\": \\"2020-11-10T03:50:28Z\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"BillingType\\": \\"ByCU\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyTime>2020-11-10T03:50:28Z</ModifyTime>\\n<Project>immtest</Project>\\n<CU>5</CU>\\n<Type>DocStarter</Type>\\n<ServiceRole>AliyunIMMDefaultRole</ServiceRole>\\n<Endpoint>imm.cn-hangzhou.aliyuncs.com</Endpoint>\\n<RequestId>5A022F78-B9A8-4ACC-BB6B-B35975534551</RequestId>\\n<CreateTime>2020-11-10T03:50:28Z</CreateTime>\\n<RegionId>cn-hangzhou</RegionId>\\n<BillingType>ByCU</BillingType>","errorExample":""}]', + 'title' => '获取项目的信息', + 'summary' => '调用GetProject接口获取项目的信息。', + 'description' => '此接口已不再维护，建议使用新版（2020-09-30版本）接口[GetProject](~~478155~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### 错误码'."\n" + .'| HttpCode | 错误码 | 错误信息 | 描述 |'."\n" + .'| ---- | ---- |---- | ---- |'."\n" + .'|400 |InvalidProject.NotFound |The resource Project cannot be found. Please check. |指定的Project不存在。 |', + ], + 'ListProjects' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Marker', + 'in' => 'query', + 'schema' => [ + 'description' => '从Marker开始按字典序返回项目信息列表。如果不设置此参数，则从头开始返回项目。', + 'type' => 'string', + 'required' => false, + 'example' => 'imm', + ], + ], + [ + 'name' => 'MaxKeys', + 'in' => 'query', + 'schema' => [ + 'description' => '返回项目的最大个数，默认值为100，取值范围为1~100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '4A7A2D0E-D8B8-4DA0-8127-EB32C6600ADE', + ], + 'Projects' => [ + 'description' => '项目信息的列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '项目的类型。', + 'type' => 'string', + 'example' => 'DocStarter', + ], + 'CU' => [ + 'description' => '此参数2021.04.01废弃。'."\n" + ."\n" + .'当BillingType设置为ByCU时，此参数才生效。'."\n" + ."\n" + .'每秒能够处理的最大请求数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'CreateTime' => [ + 'description' => '项目的创建时间。', + 'type' => 'string', + 'example' => '2020-11-10T03:50:28Z', + ], + 'ServiceRole' => [ + 'description' => '服务角色。'."\n" + ."\n" + .'如果创建项目时未指定此参数，则返回值为空。', + 'type' => 'string', + 'example' => 'AliyunIMMDefaultRole', + ], + 'Endpoint' => [ + 'description' => '项目所在地域的服务地址。', + 'type' => 'string', + 'example' => 'imm.cn-hangzhou.aliyuncs.com', + ], + 'Project' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'example' => 'immtest', + ], + 'RegionId' => [ + 'description' => '项目所在地域的ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'BillingType' => [ + 'description' => '此参数2021.04.01废弃。'."\n" + ."\n" + .'计费类型。', + 'type' => 'string', + 'example' => 'ByCU', + ], + 'ModifyTime' => [ + 'description' => '项目的修改时间。'."\n" + ."\n" + .'创建项目后，如果未更新过项目，则项目的修改时间和项目的创建时间相同。', + 'type' => 'string', + 'example' => '2020-11-10T03:50:28Z', + ], + ], + ], + ], + 'NextMarker' => [ + 'description' => '下一次列出项目信息时以此值为Marker，将未返回的结果返回。 '."\n" + ."\n" + .'当项目未全部返回时，此参数才有值。', + 'type' => 'string', + 'example' => 'immimage', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4A7A2D0E-D8B8-4DA0-8127-EB32C6600ADE\\",\\n \\"Projects\\": [\\n {\\n \\"Type\\": \\"DocStarter\\",\\n \\"CU\\": 5,\\n \\"CreateTime\\": \\"2020-11-10T03:50:28Z\\",\\n \\"ServiceRole\\": \\"AliyunIMMDefaultRole\\",\\n \\"Endpoint\\": \\"imm.cn-hangzhou.aliyuncs.com\\",\\n \\"Project\\": \\"immtest\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"BillingType\\": \\"ByCU\\",\\n \\"ModifyTime\\": \\"2020-11-10T03:50:28Z\\"\\n }\\n ],\\n \\"NextMarker\\": \\"immimage\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>4A7A2D0E-D8B8-4DA0-8127-EB32C6600ADE</RequestId>\\n<Projects>\\n <ModifyTime>2020-11-10T03:50:28Z</ModifyTime>\\n <Project>immtest</Project>\\n <Type>DocStarter</Type>\\n <CU>5</CU>\\n <ServiceRole>AliyunIMMDefaultRole</ServiceRole>\\n <Endpoint>imm.cn-hangzhou.aliyuncs.com</Endpoint>\\n <CreateTime>2020-11-10T03:50:28Z</CreateTime>\\n <RegionId>cn-hangzhou</RegionId>\\n <BillingType>ByCU</BillingType>\\n</Projects>\\n<NextMarker>immimage</NextMarker>","errorExample":""}]', + 'title' => '列出已创建的所有项目信息', + 'summary' => '调用ListProjects接口列出已创建的所有项目信息。', + 'description' => '此接口已不再维护，建议使用新版（2020-09-30版本）接口[ListProjects](~~478156~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PutProject' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。'."\n" + ."\n" + .'项目名称的长度限制为1~50字符，只能包含英文字母，数字和短横线（-），必须以英文字母开头，且不能为ALL（保留字）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'ServiceRole', + 'in' => 'query', + 'schema' => [ + 'description' => '服务角色，授权给IMM服务以访问其他云资源（例如OSS）的权限，默认值为AliyunIMMDefaultRole。'."\n" + ."\n" + .'您也可以通过RAM控制台创建授权角色。具体操作，请参见[创建普通服务角色](https://help.aliyun.com/document_detail/116800.html)。', + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunIMMDefaultRole', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Project' => [ + 'description' => '项目名称，和请求时一致。', + 'type' => 'string', + 'example' => 'immtest', + ], + 'ModifyTime' => [ + 'description' => '项目的修改时间。'."\n" + ."\n" + .'创建项目后，如果未更新过项目，则项目的修改时间和项目的创建时间相同。', + 'type' => 'string', + 'example' => '2020-11-10T03:50:28Z', + ], + 'Type' => [ + 'description' => '2021.04.01以后创建的项目类型默认为内容管理，已创建的项目不受影响。'."\n" + ."\n" + .'项目的类型，和请求时一致。', + 'type' => 'string', + 'example' => 'DocStarter', + ], + 'CU' => [ + 'description' => '2021.04.01以后创建的类型为内容管理的项目该字段无效。'."\n" + ."\n" + .'当BillingType设置为ByCU时，此参数才生效。'."\n" + ."\n" + .'每秒能够处理的最大请求数，和请求时一致。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ServiceRole' => [ + 'description' => '服务角色，和请求时一致。'."\n" + ."\n" + .'如果创建项目时未指定此参数，则返回值为空。', + 'type' => 'string', + 'example' => 'AliyunIMMDefaultRole', + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '7F7D235C-76FF-4B65-800C-8238AE3F7230', + ], + 'Endpoint' => [ + 'description' => '项目所在地域的服务地址。', + 'type' => 'string', + 'example' => 'imm.cn-hangzhou.aliyuncs.com', + ], + 'CreateTime' => [ + 'description' => '项目的创建时间。', + 'type' => 'string', + 'example' => '2020-11-10T03:50:28Z', + ], + 'RegionId' => [ + 'description' => '项目所在地域的ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'BillingType' => [ + 'description' => '2021.04.01以后创建的类型为内容管理的项目该字段无效。'."\n" + ."\n" + .'计费类型，和请求时一致。', + 'type' => 'string', + 'example' => 'ByCU', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Project\\": \\"immtest\\",\\n \\"ModifyTime\\": \\"2020-11-10T03:50:28Z\\",\\n \\"Type\\": \\"DocStarter\\",\\n \\"CU\\": 5,\\n \\"ServiceRole\\": \\"AliyunIMMDefaultRole\\",\\n \\"RequestId\\": \\"7F7D235C-76FF-4B65-800C-8238AE3F7230\\",\\n \\"Endpoint\\": \\"imm.cn-hangzhou.aliyuncs.com\\",\\n \\"CreateTime\\": \\"2020-11-10T03:50:28Z\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"BillingType\\": \\"ByCU\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyTime>2020-11-10T03:50:28Z</ModifyTime>\\n<Project>immtest</Project>\\n<Type>DocStarter</Type>\\n<CU>5</CU>\\n<ServiceRole>AliyunIMMDefaultRole</ServiceRole>\\n<Endpoint>imm.cn-hangzhou.aliyuncs.com</Endpoint>\\n<RequestId>7F7D235C-76FF-4B65-800C-8238AE3F7230</RequestId>\\n<CreateTime>2020-11-10T03:50:28Z</CreateTime>\\n<RegionId>cn-hangzhou</RegionId>\\n<BillingType>ByCU</BillingType>","errorExample":""}]', + 'title' => '创建一个项目', + 'summary' => '目前支持创建文档标准型、图片标准型和视频标准型项目，请根据需要处理的内容类型创建相应项目。', + 'description' => '- 此接口已不再维护，建议使用新版（2020-09-30版本）接口[CreateProject](~~478153~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + .'- 建议通过控制台创建项目，以便您了解和确认计费相关信息。具体操作，请参见[创建项目](~~63278~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 错误码'."\n" + .'| HttpCode | 错误码 | 错误信息 | 描述 |'."\n" + .'| ---- | ---- |---- | ---- |'."\n" + .'|400 |InvalidParameter.Project |The input parameter Project is not valid. Only (a ~ z. A ~ Z. 0 ~ 9. -) allowed and start with a letter. less than 50 chars |指定的Project名称无效。 |'."\n" + .'|400 |InvalidProject.AlreadyExist |The resource Project already exists. Please check. |指定的Project已存在。 |'."\n" + .'|400 |InvalidProject.Deleting |The resource Project is deleting. Please check. |指定的Project正在删除中，项目会在北京时间次日凌晨删除。删除后，才可以新建同名的项目，如果需要立即创建同名的项目，请使用钉钉搜索钉钉群号31690030817加入钉钉群进行反馈。|'."\n" + .'|400 |InvalidParameter.Type |The input parameter Type is not valid. Please refer to document. |Type的类型不合法，请参考Type参数的描述进行设置。 |'."\n" + .'|400 |InvalidParameter.CU |The input parameter CU is not valid. Please refer to document. |CU值不合法，请参考CU参数的描述进行设置。 |', + ], + 'CreateSet' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集的唯一标识，只能由英文、数字和短横线（-）组成。'."\n" + ."\n" + .'如果未设置此参数，则系统会自动生成。', + 'type' => 'string', + 'required' => false, + 'example' => 'set001', + ], + ], + [ + 'name' => 'SetName', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集的显示名称，支持使用中文。'."\n" + ."\n" + .'如果未设置此参数，则默认值为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'myset', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ModifyTime' => [ + 'description' => '媒体集的修改时间。'."\n" + ."\n" + .'创建媒体集后，如果未更新过媒体集，则媒体集的修改时间和媒体集的创建时间相同。', + 'type' => 'string', + 'example' => '2020-11-19T07:49:20.094Z', + ], + 'VideoCount' => [ + 'description' => '媒体集中的视频数量。'."\n" + ."\n" + .'当媒体集中存在视频时，才显示此参数。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ImageCount' => [ + 'description' => '媒体集中的图片数量。'."\n" + ."\n" + .'当媒体集中存在图片时，才显示此参数。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '6D74B3A9-5AC0-49F9-914D-E01589D363FC', + ], + 'CreateTime' => [ + 'description' => '媒体集的创建时间。', + 'type' => 'string', + 'example' => '2020-11-19T07:49:20.094Z', + ], + 'SetName' => [ + 'description' => '媒体集的显示名称。', + 'type' => 'string', + 'example' => 'myset', + ], + 'SetId' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'example' => 'set001', + ], + 'VideoLength' => [ + 'description' => '媒体集中的视频时长，单位为秒。'."\n" + ."\n" + .'当媒体集中存在视频时，才显示此参数。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'FaceCount' => [ + 'description' => '媒体集中的人脸数量。'."\n" + ."\n" + .'当媒体集中存在人脸信息时，才显示此参数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ModifyTime\\": \\"2020-11-19T07:49:20.094Z\\",\\n \\"VideoCount\\": 0,\\n \\"ImageCount\\": 0,\\n \\"RequestId\\": \\"6D74B3A9-5AC0-49F9-914D-E01589D363FC\\",\\n \\"CreateTime\\": \\"2020-11-19T07:49:20.094Z\\",\\n \\"SetName\\": \\"myset\\",\\n \\"SetId\\": \\"set001\\",\\n \\"VideoLength\\": 0,\\n \\"FaceCount\\": 0\\n}","errorExample":""},{"type":"xml","example":"<ModifyTime>2020-11-19T07:49:20.094Z</ModifyTime>\\n<RequestId>6D74B3A9-5AC0-49F9-914D-E01589D363FC</RequestId>\\n<CreateTime>2020-11-19T07:49:20.094Z</CreateTime>\\n<SetName>myset</SetName>\\n<SetId>set001</SetId>","errorExample":""}]', + 'title' => '创建媒体集', + 'summary' => '调用CreateSet接口创建媒体集。', + 'description' => '- 此接口已不再维护，建议使用新版（2020-09-30版本）接口[CreateDataset](~~478160~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + ."\n" + .'- 由于媒体集中的媒体数量有限制，因此需要使用者规划单个媒体集的使用范围。'."\n" + ."\n" + .'- 由于各个媒体集间无法联合搜索，因此推荐将互不干涉的媒体文件独立存放到不同媒体集中。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteSet' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Set-1126f303-6c5b-4ba3-863a-bac81aff8d2d', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'EC564A9A-BA5C-4499-A087-D9B9E76E7C1C', + ], + 'SetId' => [ + 'description' => '媒体集的唯一标识，和请求时一致。', + 'type' => 'string', + 'example' => 'Set-1126f303-6c5b-4ba3-863a-bac81aff8d2d', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC564A9A-BA5C-4499-A087-D9B9E76E7C1C\\",\\n \\"SetId\\": \\"Set-1126f303-6c5b-4ba3-863a-bac81aff8d2d\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EC564A9A-BA5C-4499-A087-D9B9E76E7C1C</RequestId>\\n<SetId>Set-1126f303-6c5b-4ba3-863a-bac81aff8d2d</SetId>","errorExample":""}]', + 'title' => '删除媒体集', + 'summary' => '调用DeleteSet接口删除媒体集。', + 'description' => '- 此接口已不再维护，建议使用新版（2020-09-30版本）接口[DeleteDataset](~~478164~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + ."\n" + .'- 该操作为异步操作，调用后智能媒体管理需要一定时间完成媒体集的实际删除，因此在实际删除完成前，无法创建相同SetId的媒体集。'."\n" + .'- 当媒体集不合法、不存在或者处于删除中时，此操作仍会执行成功。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateSet' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Set-e8dd5e4e-99f7-43d4-80d5-3456a5bd5077', + ], + ], + [ + 'name' => 'SetName', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集的显示名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'mysetnew', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ModifyTime' => [ + 'description' => '媒体集的修改时间。'."\n" + ."\n" + .'创建媒体集后，如果未更新过媒体集，则媒体集的修改时间和媒体集的创建时间相同。', + 'type' => 'string', + 'example' => '2020-11-19T07:49:01.975Z', + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '45234D4A-A3E3-4B23-AACA-8D897514462E', + ], + 'CreateTime' => [ + 'description' => '媒体集的创建时间。', + 'type' => 'string', + 'example' => '2020-11-19T07:49:01.975Z', + ], + 'SetName' => [ + 'description' => '媒体集的显示名称。'."\n" + ."\n" + .'如果更新媒体集时未设置此参数，则返回值为媒体集当前的显示名称。', + 'type' => 'string', + 'example' => 'mysetnew', + ], + 'SetId' => [ + 'description' => '媒体集的唯一标识，和请求时一致。', + 'type' => 'string', + 'example' => 'Set-e8dd5e4e-99f7-43d4-80d5-3456a5bd5077', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ModifyTime\\": \\"2020-11-19T07:49:01.975Z\\",\\n \\"RequestId\\": \\"45234D4A-A3E3-4B23-AACA-8D897514462E\\",\\n \\"CreateTime\\": \\"2020-11-19T07:49:01.975Z\\",\\n \\"SetName\\": \\"mysetnew\\",\\n \\"SetId\\": \\"Set-e8dd5e4e-99f7-43d4-80d5-3456a5bd5077\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyTime>2020-11-19T07:49:01.975Z</ModifyTime>\\n<RequestId>45234D4A-A3E3-4B23-AACA-8D897514462E</RequestId>\\n<CreateTime>2020-11-19T07:49:01.975Z</CreateTime>\\n<SetName>mysetnew</SetName>\\n<SetId>Set-e8dd5e4e-99f7-43d4-80d5-3456a5bd5077</SetId>","errorExample":""}]', + 'title' => '更新媒体集的显示名称', + 'summary' => '调用UpdateSet接口更新媒体集的显示名称。', + 'description' => '此接口已不再维护，建议使用新版（2020-09-30版本）接口[UpdateDataset](~~478161~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetSet' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Set-d7ffb885-88c1-4702-a71f-60cf50c221c9', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ModifyTime' => [ + 'description' => '媒体集的修改时间。'."\n" + ."\n" + .'创建媒体集后，如果未更新过媒体集，则媒体集的修改时间和媒体集的创建时间相同。', + 'type' => 'string', + 'example' => '2020-11-19T09:49:03.826Z', + ], + 'VideoCount' => [ + 'description' => "\n" + .'媒体集中的视频数量。'."\n" + ."\n" + .'当媒体集中存在视频时，此参数才有效。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ImageCount' => [ + 'description' => '媒体集中的图片数量。'."\n" + ."\n" + .'当媒体集中存在图片时，此参数才有效。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '93126E40-0296-4129-95E3-AFAC709372E5', + ], + 'CreateTime' => [ + 'description' => '媒体集的创建时间。', + 'type' => 'string', + 'example' => '2020-11-19T09:49:03.826Z', + ], + 'SetName' => [ + 'description' => '媒体集的显示名称。'."\n" + ."\n" + .'如果创建媒体集时未设置此参数，则返回值为空。', + 'type' => 'string', + 'example' => 'myimageset', + ], + 'SetId' => [ + 'description' => '媒体集的唯一标识，和请求时一致。', + 'type' => 'string', + 'example' => 'Set-d7ffb885-88c1-4702-a71f-60cf50c221c9', + ], + 'VideoLength' => [ + 'description' => '媒体集中的视频时长，单位为秒。'."\n" + ."\n" + .'当媒体集中存在视频时，此参数才有效。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'FaceCount' => [ + 'description' => '媒体集中的人脸数量。'."\n" + ."\n" + .'当媒体集中存在人脸信息时，此参数才有效。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ModifyTime\\": \\"2020-11-19T09:49:03.826Z\\",\\n \\"VideoCount\\": 0,\\n \\"ImageCount\\": 6,\\n \\"RequestId\\": \\"93126E40-0296-4129-95E3-AFAC709372E5\\",\\n \\"CreateTime\\": \\"2020-11-19T09:49:03.826Z\\",\\n \\"SetName\\": \\"myimageset\\",\\n \\"SetId\\": \\"Set-d7ffb885-88c1-4702-a71f-60cf50c221c9\\",\\n \\"VideoLength\\": 0,\\n \\"FaceCount\\": 5\\n}","errorExample":""},{"type":"xml","example":"<ModifyTime>2020-11-19T09:49:03.826Z</ModifyTime>\\n<ImageCount>6</ImageCount>\\n<RequestId>93126E40-0296-4129-95E3-AFAC709372E5</RequestId>\\n<CreateTime>2020-11-19T09:49:03.826Z</CreateTime>\\n<SetName>myimageset</SetName>\\n<SetId>Set-d7ffb885-88c1-4702-a71f-60cf50c221c9</SetId>\\n<FaceCount>5</FaceCount>","errorExample":""}]', + 'title' => '获取媒体集信息', + 'summary' => '调用GetSet接口获取媒体集信息。', + 'description' => '此接口已不再维护，建议使用新版（2020-09-30版本）接口[GetDataset(~~478162~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListSets' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'Marker', + 'in' => 'query', + 'schema' => [ + 'description' => '从Marker开始按字典序返回媒体集信息列表。如果不设置此参数，则从头开始返回媒体集。', + 'type' => 'string', + 'required' => false, + 'example' => 'Set-00', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'FEEDE356-C928-4A36-951A-6EB5A5923BEB', + ], + 'Sets' => [ + 'description' => '媒体集列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VideoCount' => [ + 'description' => '媒体集中的视频数量。'."\n" + ."\n" + .'当媒体集中存在视频时，此参数才有效。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CreateTime' => [ + 'description' => '媒体集的创建时间。', + 'type' => 'string', + 'example' => '2020-11-19T07:49:01.975Z', + ], + 'VideoLength' => [ + 'description' => '媒体集中的视频时长，单位为秒。'."\n" + ."\n" + .'当媒体集中存在视频时，此参数才有效。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SetId' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'example' => 'Set-435b5855-d100-4408-95f4-f2e901fa0694', + ], + 'ImageCount' => [ + 'description' => '媒体集中的图片数量。'."\n" + ."\n" + .'当媒体集中存在图片时，此参数才有效。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'FaceCount' => [ + 'description' => '媒体集中的人脸数量。'."\n" + ."\n" + .'当媒体集中存在人脸信息时，此参数才有效。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'SetName' => [ + 'description' => '媒体集的显示名称。'."\n" + ."\n" + .'如果创建媒体集时未设置此参数，则返回值为空。', + 'type' => 'string', + 'example' => 'mysetname', + ], + 'ModifyTime' => [ + 'description' => '媒体集的修改时间。'."\n" + ."\n" + .'创建媒体集后，如果未更新过媒体集，则媒体集的修改时间和媒体集的创建时间相同。', + 'type' => 'string', + 'example' => '2020-11-19T07:49:01.975Z', + ], + ], + ], + ], + 'NextMarker' => [ + 'description' => '下一次列出媒体集信息时以此值为Marker，将未返回的结果返回。'."\n" + ."\n" + .'当媒体集未全部返回时，此参数才有值。', + 'type' => 'string', + 'example' => 'Set-e8dd5e4e-99f7-43d4-80d5-3456a5bd5077', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEEDE356-C928-4A36-951A-6EB5A5923BEB\\",\\n \\"Sets\\": [\\n {\\n \\"VideoCount\\": 0,\\n \\"CreateTime\\": \\"2020-11-19T07:49:01.975Z\\",\\n \\"VideoLength\\": 0,\\n \\"SetId\\": \\"Set-435b5855-d100-4408-95f4-f2e901fa0694\\",\\n \\"ImageCount\\": 6,\\n \\"FaceCount\\": 5,\\n \\"SetName\\": \\"mysetname\\",\\n \\"ModifyTime\\": \\"2020-11-19T07:49:01.975Z\\"\\n }\\n ],\\n \\"NextMarker\\": \\"Set-e8dd5e4e-99f7-43d4-80d5-3456a5bd5077\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>FEEDE356-C928-4A36-951A-6EB5A5923BEB</RequestId>\\n<Sets>\\n <ModifyTime>2020-11-19T07:49:01.975Z</ModifyTime>\\n <ImageCount>6</ImageCount>\\n <CreateTime>2020-11-19T07:49:01.975Z</CreateTime>\\n <SetName>mysetname</SetName>\\n <SetId>Set-435b5855-d100-4408-95f4-f2e901fa0694</SetId>\\n <FaceCount>5</FaceCount>\\n</Sets>\\n<NextMarker>Set-e8dd5e4e-99f7-43d4-80d5-3456a5bd5077</NextMarker>","errorExample":""}]', + 'title' => '获取媒体集列表', + 'summary' => '调用ListSets接口获取媒体集列表。', + 'description' => '此接口已不再维护，建议使用新版（2020-09-30版本）接口[ListDatasets](~~478163~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ConvertOfficeFormat' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。'."\n" + .'> 您可通过智能媒体管理的控制台或调用[ListProjects](~~63905~~)接口查看项目名称。关于项目名称的更多信息，请参见[创建项目](~~63278~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immdoctest', + ], + ], + [ + 'name' => 'SrcUri', + 'in' => 'query', + 'schema' => [ + 'description' => '源数据的存储位置。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中`bucket`为和当前项目处于同一地域的OSS Bucket名称，`object`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://bucket1/object', + ], + ], + [ + 'name' => 'TgtType', + 'in' => 'query', + 'schema' => [ + 'description' => '转换输出的目标文件类型。包括如下选项：'."\n" + ."\n" + .'- vector：转换为向量格式的文件，需要使用预览引擎进行渲染后才能预览。'."\n" + ."\n" + .'- png：转换为PNG格式的图片文件。'."\n" + ."\n" + .'- jpg：转换为JPG格式的图片文件。'."\n" + ."\n" + .'- pdf：转换为PDF文件。'."\n" + ."\n" + .'- text：转换为只包含文本内容的文件，主要用于提取文件的文本内容。'."\n" + ."\n" + .'> 只有当源数据类型为演示文档和文字文档时，才支持转换为text格式。', + 'type' => 'string', + 'required' => false, + 'example' => 'vector', + ], + ], + [ + 'name' => 'TgtUri', + 'in' => 'query', + 'schema' => [ + 'description' => '转换后输出内容的目标位置，建议将TgtUri和SrcUri设置在同一个OSS Bucket中，便于权限管理。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://bucket1/converttasks/session123/', + ], + ], + [ + 'name' => 'SrcType', + 'in' => 'query', + 'schema' => [ + 'description' => '当OSS对象没有后缀名时，可以设置此参数。'."\n" + ."\n" + .'源数据的后缀类型。默认根据OSS对象的后缀名确定源数据的类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'doc', + ], + ], + [ + 'name' => 'StartPage', + 'in' => 'query', + 'schema' => [ + 'description' => '文档转换的起始页，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'EndPage', + 'in' => 'query', + 'schema' => [ + 'description' => '文档转换的结束页，默认值为200。如果需要转换所有页，设置此参数为-1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MaxSheetRow', + 'in' => 'query', + 'schema' => [ + 'description' => '表格文档转换的最大行数，默认值为1000。如果需要转换所有行，设置此参数为-1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MaxSheetCol', + 'in' => 'query', + 'schema' => [ + 'description' => '表格文档转换的最大列数，默认值为100。如果需要转换所有列，设置此参数为-1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MaxSheetCount', + 'in' => 'query', + 'schema' => [ + 'description' => '表格文档转换的最大Sheet数。如果需要转换所有Sheet，设置此参数为-1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'SheetOnePage', + 'in' => 'query', + 'schema' => [ + 'description' => '表格文档转换时，是否将所有Sheet的内容输出到一页。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ModelId', + 'in' => 'query', + 'schema' => [ + 'description' => '模型ID。此参数暂不可用。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => '文档的打开密码。如果需要转换有密码的文档，请设置此参数。', + 'type' => 'string', + 'required' => false, + 'example' => '********', + ], + ], + [ + 'name' => 'TgtFilePrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '> 当参数**TgtType**设置为`jpg`、`png`或`pdf`时，此参数才生效。'."\n" + ."\n" + .'转换后的文件名称前缀。通过设置该参数，可以自定义转换后的文件名称。命名规则如下：'."\n" + ."\n" + .'- 只能包括英文、数字、短划线（-）和下划线（_）。'."\n" + ."\n" + .'- 长度不超过256个字符。'."\n" + ."\n" + .'当参数**TgtType**设置为jpg，参数**TgtFilePrefix**和参数**TgtFileSuffix**设置不同时，目标文件的名称规则如下：'."\n" + ."\n" + .'- 当**TgtFilePrefix**和**TgtFileSuffix**均为空时，则目标文件的名称为`\\[x\\].jpg`。'."\n" + .'- 当**TgtFilePrefix**为空，**TgtFileSuffix**为`aa`时，则目标文件的名称为`\\[x\\]aa`。'."\n" + .'- 当**TgtFilePrefix**为`aa`，**TgtFileSuffix**为空时，则目标文件的名称为**aa\\[x\\]**。'."\n" + .'- 当**TgtFilePrefix**为`aa`，TgtFileSuffix为`bb`时，则目标文件名称为`aa\\[x\\]bb`。'."\n" + .'- 当**TgtFilePrefix**为`aa`，**TgtFileSuffix**为`def`时，则目标文件名称为`aa\\[x\\].jpg`。其中`def`为保留字，表示采用默认的后缀名。'."\n" + ."\n" + .'其中`\\[x\\]`表示多个目标文件，从`1`开始。如果**TgtFilePrefix**为`aa`，**TgtFileSuffix**为`bb`，且转换后的文件有3页，则所有的目标文件为`aa\\[1\\]bb`、`aa\\[2\\]bb`、`aa\\[3\\]bb`。', + 'type' => 'string', + 'required' => false, + 'example' => 'aa', + ], + ], + [ + 'name' => 'TgtFileSuffix', + 'in' => 'query', + 'schema' => [ + 'description' => '> 当参数**TgtType**设置为`jpg`、`png`或`pdf`时，此参数才生效。'."\n" + ."\n" + .'转换后的文件名称后缀。通过设置该参数，可以自定义转换后的文件名称。命名规则如下：'."\n" + ."\n" + .'- 只能包括英文、数字、短划线（-）和下划线（_）。'."\n" + ."\n" + .'- 长度不超过256个字符。'."\n" + ."\n" + .'当参数**TgtType**设置为`jpg`，参数**TgtFilePrefix**和参数**TgtFileSuffix**设置不同时，目标文件的名称规则如下：'."\n" + ."\n" + .'- 当T**gtFilePrefix**和**TgtFileSuffix**均为空时，则目标文件的名称为`\\[x\\].jpg`。'."\n" + .'- 当**TgtFilePrefix**为空，**TgtFileSuffix**为`aa`时，则目标文件的名称为`\\[x\\]aa`。'."\n" + .'- 当**TgtFilePrefix**为`aa`，**TgtFileSuffix**为空时，则目标文件的名称为`aa\\[x\\]`。'."\n" + .'- 当**TgtFilePrefix**为`aa`，**TgtFileSuffix**为`bb`时，则目标文件名称为`aa\\[x\\]bb`。'."\n" + .'- 当**TgtFilePrefix**为`aa`，**TgtFileSuffix**为`def`时，则目标文件名称为`aa\\[x\\].jpg`。 其中`def`为保留字，表示采用默认的后缀名。'."\n" + ."\n" + .'上述规则中`\\[x\\]`表示多个目标文件，从`1`开始。如果**TgtFilePrefix**为`aa`，**TgtFileSuffix**为`bb`，且转换后的文件有3页，则所有的目标文件为`aa\\[1\\]bb`、`aa\\[2\\]bb`、``aa\\[3\\]bb``。', + 'type' => 'string', + 'required' => false, + 'example' => 'bb', + ], + ], + [ + 'name' => 'TgtFilePages', + 'in' => 'query', + 'schema' => [ + 'description' => '> 当参数**TgtType**设置为`jpg`、`png`或`pdf`时，此参数才生效。'."\n" + ."\n" + .'转换后输出指定文件页数，默认输出所有页。最多指定100个页数，如果超过100页，请分多次转换进行提交。'."\n" + ."\n" + .'例如当**TgtFilePages**设置为`[1, 2, 100]`时，只会输出第`1`、`2`、`100`页到目标位置。', + 'type' => 'string', + 'required' => false, + 'example' => '[1, 2, 100]', + ], + ], + [ + 'name' => 'FitToPagesTall', + 'in' => 'query', + 'schema' => [ + 'description' => '> 当参数**TgtType**设置为`pdf`时，此参数才生效。'."\n" + ."\n" + .'表格文档转换为PDF文档时，是否将行全部输出到一页。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否。'."\n" + ."\n" + .'- true：是。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'FitToPagesWide', + 'in' => 'query', + 'schema' => [ + 'description' => '> 当参数**TgtType**设置为`pdf`时，此参数才生效。'."\n" + ."\n" + .'表格文档转换为PDF文档时，是否将列全部输出在一页。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否。'."\n" + ."\n" + .'- true：是。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'PdfVector', + 'in' => 'query', + 'schema' => [ + 'description' => '当PDF转换为VECTOR时，是否使用向量模式，取值范围如下：'."\n" + ."\n" + .'- true：使用向量模式，预览效果比较清晰，但是转换耗时较长。'."\n" + .'- false（默认）：使用图片模式，预览效果一般，但是转换耗时较短。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Hidecomments', + 'in' => 'query', + 'schema' => [ + 'description' => '当WORD、PPT转换为VECTOR、JPG、PNG时，是否隐藏批注和应用修订。取值范围如下：'."\n" + ."\n" + .'- true：隐藏批注和应用修订。'."\n" + .'- false（默认）：显示批注和修订。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageCount' => [ + 'description' => '转换成功的页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'FF3B7D81-66AE-47E0-BF69-157DCF187514', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidArgument.SrcUri', + 'errorMessage' => 'The source URI is too large or too complex to be converted within the time limit.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageCount\\": 10,\\n \\"RequestId\\": \\"FF3B7D81-66AE-47E0-BF69-157DCF187514\\"\\n}","errorExample":""},{"type":"xml","example":"<PageCount>10</PageCount>\\n<RequestId>FF3B7D81-66AE-47E0-BF69-157DCF187514</RequestId>","errorExample":""}]', + 'title' => '文档（例如OFFICE文档）格式的转换', + 'summary' => '采用同步请求方式进行文档（例如Office文档）格式的转换，执行完毕返回转换成功的页数。', + 'description' => '- 此接口已不再维护，建议使用新版（2020-09-30版本）接口[CreateOfficeConversionTask](~~478228~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + .'- 同步转换超时时间为5秒，如果转换时间大于5秒的文档转换需要使用异步接口[CreateOfficeConversionTask](https://help.aliyun.com/document_detail/72044.html)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### 错误码'."\n" + .'如果转换出错，返回的JSON示例如下：'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "RequestId": "7DA1FCD1-004C-4EB4-B039-C6BBDCEB0701",'."\n" + .' "HostId": "imm.cn-hangzhou.aliyuncs.com",'."\n" + .' "Code": "DocumentConvertFailed.NeedPassword",'."\n" + .' "Message": "The conversion has been failed, need password to open file."'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'|错误码|说明|'."\n" + .'| ---- | ---- |'."\n" + .'|OSSAccessError|OSS访问失败，请检查SrcUri或TgtUri对应OSS Bucket的路径是否存在，所在Region是否和智能媒体管理的Region一致。|'."\n" + .'|InvalidParameter.SrcType.NotSupported|不支持的文件类型，文档转换根据文件后缀名来判断文件类型，请检查文件后缀名和SrcType参数。|'."\n" + .'|DocumentConvertFailed.ExceedFileSizeLimit|文档转换默认支持的文件大小为200 MB，超过该大小的文件转换时会出现该错误。|'."\n" + .'|DocumentConvertFailed.OpenFileError|文档转换时，打开文件失败，请检查源文档后缀和内容是否匹配。|'."\n" + .'|DocumentConvertFailed.ExportFileError|文档转换时，处理文件内容失败，请检查源文档是否能够正常打开。|'."\n" + .'|DocumentConvertFailed.NeedPassword|该文档需要密码才能打开，请设置Password参数。|'."\n" + .'|ExecutionTimeout|执行超时，请检查文档大小和页数，如果确实需要转换，请使用异步接口[CreateOfficeConversionTask](https://help.aliyun.com/document_detail/72044.html)。|'."\n" + .'|InternalError|内部错误，请使用钉钉搜索钉钉群号31690030817加入钉钉群进行反馈。|'."\n" + ."\n" + .'### 相关文档'."\n" + .'- [智能媒体管理文档预览](https://help.aliyun.com/document_detail/74947.html)'."\n" + .'- [文档转换和预览架构](https://developer.aliyun.com/article/581576)'."\n" + .'- [文档转换使用介绍](https://developer.aliyun.com/article/581874)'."\n" + .'- [文档预览使用介绍](https://developer.aliyun.com/article/582083)', + ], + 'ListOfficeConversionTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'immdoctest', + ], + ], + [ + 'name' => 'Marker', + 'in' => 'query', + 'schema' => [ + 'description' => '从Marker开始按字典序返回任务信息列表。如果不设置此参数，则从头开始返回任务。', + 'type' => 'string', + 'required' => false, + 'example' => 'formatconvert-00', + ], + ], + [ + 'name' => 'MaxKeys', + 'in' => 'query', + 'schema' => [ + 'description' => '返回任务的最大个数，默认值为100，取值范围为1~100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Tasks' => [ + 'description' => '任务信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务运行状态。包括如下选项：'."\n" + ."\n" + .'- Running：任务运行中。'."\n" + .'- Finished：任务执行完成，转换成功。'."\n" + .'- Failed：任务执行完成，转换成功失败。具体失败原因请参考FaileDetail的Code内容。', + 'type' => 'string', + 'example' => 'Finished', + ], + 'Percent' => [ + 'description' => '任务进度的百分比。当前只有0和100两个结果。'."\n" + ."\n" + .'只有当转换成功时，此参数的返回值才为100，其他情况均为0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'FinishTime' => [ + 'description' => '任务的结束时间。'."\n" + ."\n" + .'当任务状态为Finished时，此参数才有值，否则返回值为空。', + 'type' => 'string', + 'example' => '2020-11-13T09:33:03.520000Z', + ], + 'CreateTime' => [ + 'description' => '任务的创建时间。', + 'type' => 'string', + 'example' => '2020-11-13T09:32:53.097000Z', + ], + 'PageCount' => [ + 'description' => '文档格式转换的页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'NotifyTopicName' => [ + 'description' => '异步反向通知的TopicName。'."\n" + ."\n" + .'如果创建任务时未设置此参数，则返回值为空。', + 'type' => 'string', + 'example' => 'topic1', + ], + 'NotifyEndpoint' => [ + 'description' => '异步反向通知的Endpoint。'."\n" + ."\n" + .'如果创建任务时未设置此参数，则返回值为空。', + 'type' => 'string', + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + ], + 'TgtUri' => [ + 'description' => '转换后输出内容的目标位置。', + 'type' => 'string', + 'example' => 'oss://bucket1/converttasks/session123/', + ], + 'TgtType' => [ + 'description' => '转换输出的目标文件类型。', + 'type' => 'string', + 'example' => 'png', + ], + 'SrcUri' => [ + 'description' => '源数据的存储位置。', + 'type' => 'string', + 'example' => 'oss://bucket1/object', + ], + 'ImageSpec' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'输出图片的边界大小，默认值为1024像素。'."\n" + ."\n" + .'当图片长宽不同时，按照最先到达边界的条件进行等比例控制。', + 'type' => 'string', + 'example' => '1024', + ], + 'ExternalID' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'任务的外部标签。', + 'type' => 'string', + 'example' => 'tasktest002', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'formatconvert-bab90254-2bfd-4ee5-a30a-bb671da7c960', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '6253B819-3B81-4578-956B-7CF7E75E39E2', + ], + 'NextMarker' => [ + 'description' => '下一次列出任务信息时以此值为Marker，将未返回的结果返回。 当任务未全部返回时，此参数才有值。', + 'type' => 'string', + 'example' => 'formatconvert-481c92f5-3033-4de3-8656-fcf07100d633', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Tasks\\": [\\n {\\n \\"Status\\": \\"Finished\\",\\n \\"Percent\\": 100,\\n \\"FinishTime\\": \\"2020-11-13T09:33:03.520000Z\\",\\n \\"CreateTime\\": \\"2020-11-13T09:32:53.097000Z\\",\\n \\"PageCount\\": 10,\\n \\"NotifyTopicName\\": \\"topic1\\",\\n \\"NotifyEndpoint\\": \\"http://1111111111.mns.cn-hangzhou.aliyuncs.com\\",\\n \\"TgtUri\\": \\"oss://bucket1/converttasks/session123/\\",\\n \\"TgtType\\": \\"png\\",\\n \\"SrcUri\\": \\"oss://bucket1/object\\",\\n \\"ImageSpec\\": \\"1024\\",\\n \\"ExternalID\\": \\"tasktest002\\",\\n \\"TaskId\\": \\"formatconvert-bab90254-2bfd-4ee5-a30a-bb671da7c960\\"\\n }\\n ],\\n \\"RequestId\\": \\"6253B819-3B81-4578-956B-7CF7E75E39E2\\",\\n \\"NextMarker\\": \\"formatconvert-481c92f5-3033-4de3-8656-fcf07100d633\\"\\n}","errorExample":""},{"type":"xml","example":"<Tasks>\\n <Status>Finished</Status>\\n <TgtType>png</TgtType>\\n <TaskId>formatconvert-bab90254-2bfd-4ee5-a30a-bb671da7c960</TaskId>\\n <Percent>100</Percent>\\n <CreateTime>2020-11-13T09:32:53.097000Z</CreateTime>\\n <NotifyEndpoint>http://1111111111.mns.cn-hangzhou.aliyuncs.com</NotifyEndpoint>\\n <TgtUri>oss://bucket1/converttasks/session123/</TgtUri>\\n <FinishTime>2020-11-13T09:33:03.520000Z</FinishTime>\\n <PageCount>10</PageCount>\\n <NotifyTopicName>topic1</NotifyTopicName>\\n <SrcUri>oss://bucket1/object</SrcUri>\\n</Tasks>\\n<RequestId>6253B819-3B81-4578-956B-7CF7E75E39E2</RequestId>\\n<NextMarker>formatconvert-481c92f5-3033-4de3-8656-fcf07100d633</NextMarker>","errorExample":""}]', + 'title' => '列出项目中已创建的文档格式转换任务', + 'summary' => '调用ListOfficeConversionTask接口列出项目中已创建的文档格式转换任务。', + 'description' => '此接口已不再维护，建议使用新版（2020-09-30版本）接口[ListTasks](~~478242~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetOfficeConversionTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'immdoctest', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。CreateOfficeConversionTask接口执行后返回的TaskId。'."\n" + ."\n" + .'异步文档格式转换任务的TaskId可以通过智能媒体管理控制台对应项目的**任务查询**页签获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'formatconvert-a1749f07-1bb7-40ff-84af-c6df064e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务运行状态。包括如下选项：'."\n" + ."\n" + .'- Running：任务运行中。'."\n" + .'- Finished：任务执行完成，转换成功。'."\n" + .'- Failed：任务执行完成，转换失败。具体失败原因请参考FaileDetail的Code内容。', + 'type' => 'string', + 'example' => 'Finished', + ], + 'FailDetail' => [ + 'description' => '任务执行对应的错误信息。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'NoError', + ], + ], + ], + 'TgtType' => [ + 'description' => '转换输出的目标文件类型。', + 'type' => 'string', + 'example' => 'png', + ], + 'TaskId' => [ + 'description' => '任务ID，和请求时一致。', + 'type' => 'string', + 'example' => 'formatconvert-a1749f07-1bb7-40ff-84af-c6df064e****', + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '0BC1F0C9-8E99-46C6-B502-10DEDCBA3E2E', + ], + 'Percent' => [ + 'description' => '任务进度的百分比。当前只有0和100两个结果。'."\n" + ."\n" + .'只有当转换成功时，此参数的返回值才为100，其他情况均为0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'CreateTime' => [ + 'description' => '任务的创建时间。', + 'type' => 'string', + 'example' => '2020-11-13T07:53:08.687000Z', + ], + 'ExternalID' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'任务的外部标签。', + 'type' => 'string', + 'example' => 'tasktest001', + ], + 'ImageSpec' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'输出图片的边界大小，默认值为1024像素。'."\n" + ."\n" + .'当图片长宽不同时，按照最先到达边界的条件进行等比例控制。', + 'type' => 'string', + 'example' => '1024', + ], + 'NotifyEndpoint' => [ + 'description' => '异步反向通知的Endpoint。'."\n" + ."\n" + .'如果创建任务时未设置此参数，则返回值为空。', + 'type' => 'string', + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + ], + 'TgtUri' => [ + 'description' => '转换后输出内容的目标位置。', + 'type' => 'string', + 'example' => 'oss://bucket1/converttasks/session123/', + ], + 'FinishTime' => [ + 'description' => '任务的结束时间。'."\n" + ."\n" + .'当任务状态为Finished时，此参数才有值，否则返回值为空。', + 'type' => 'string', + 'example' => '2020-11-13T07:53:19.103000Z', + ], + 'PageCount' => [ + 'description' => '文档格式转换的页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'NotifyTopicName' => [ + 'description' => '异步反向通知的TopicName。'."\n" + ."\n" + .'如果创建任务时未设置此参数，则返回值为空。', + 'type' => 'string', + 'example' => 'topic1', + ], + 'SrcUri' => [ + 'description' => '源数据的存储位置。', + 'type' => 'string', + 'example' => 'oss://bucket1/object', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Finished\\",\\n \\"FailDetail\\": {\\n \\"Code\\": \\"NoError\\"\\n },\\n \\"TgtType\\": \\"png\\",\\n \\"TaskId\\": \\"formatconvert-a1749f07-1bb7-40ff-84af-c6df064e****\\",\\n \\"RequestId\\": \\"0BC1F0C9-8E99-46C6-B502-10DEDCBA3E2E\\",\\n \\"Percent\\": 100,\\n \\"CreateTime\\": \\"2020-11-13T07:53:08.687000Z\\",\\n \\"ExternalID\\": \\"tasktest001\\",\\n \\"ImageSpec\\": \\"1024\\",\\n \\"NotifyEndpoint\\": \\"http://1111111111.mns.cn-hangzhou.aliyuncs.com\\",\\n \\"TgtUri\\": \\"oss://bucket1/converttasks/session123/\\",\\n \\"FinishTime\\": \\"2020-11-13T07:53:19.103000Z\\",\\n \\"PageCount\\": 10,\\n \\"NotifyTopicName\\": \\"topic1\\",\\n \\"SrcUri\\": \\"oss://bucket1/object\\"\\n}","errorExample":""},{"type":"xml","example":"<Status>Finished</Status>\\n<FailDetail>\\n <Code>NoError</Code>\\n</FailDetail>\\n<TgtType>png</TgtType>\\n<TaskId>formatconvert-a1749f07-1bb7-40ff-84af-c6df064e3438</TaskId>\\n<RequestId>0BC1F0C9-8E99-46C6-B502-10DEDCBA3E2E</RequestId>\\n<Percent>100</Percent>\\n<CreateTime>2020-11-13T07:53:08.687000Z</CreateTime>\\n<NotifyEndpoint>http://1111111111.mns.cn-hangzhou.aliyuncs.com</NotifyEndpoint>\\n<TgtUri>oss://bucket1/converttasks/session123/</TgtUri>\\n<FinishTime>2020-11-13T07:53:19.103000Z</FinishTime>\\n<PageCount>10</PageCount>\\n<NotifyTopicName>topic1</NotifyTopicName>\\n<SrcUri>oss://bucket1/object</SrcUri>","errorExample":""}]', + 'title' => '查询异步文档格式转换任务的状态信息', + 'summary' => '调用GetOfficeConversionTask接口查询异步文档格式转换任务的状态信息。', + 'description' => '此接口已不再维护，建议使用新版（2020-09-30版本）接口[GetTask](~~478241~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### 错误码'."\n" + .'|错误码|描述|'."\n" + .'|----|----|'."\n" + .'|NoError|无错误，文档转换成功。|'."\n" + .'|FailedToDownloadSrcFile|无法下载源文件，请检查OSS Bucket是否存在和OSS Bucket中的对象是否存在。|'."\n" + .'|UnsupportedSrcFile|不支持的文件类型，目前文档转换根据文件后缀名判断文件类型，请检查文件后缀名。|'."\n" + .'|ConvertTimeout|文档转换超时，目前文档转换超时时间为300秒。当文件页数较多或者表格行列多的文档可能会出现该错误，此时可以调整EndPage、MaxSheetRow、MaxSheetCol、MaxSheetCount参数转换部分文档。|'."\n" + .'|WriteTgtUriFailed|转换后的文件写入OSS失败。当OSS服务不稳定时可能出现该错误，此时建议重新提交文档转换任务。|'."\n" + .'|InvokeOSSFailed|转换后的文件写入OSS失败，请检查TgtUri对应的OSS Bucket是否存在。|'."\n" + .'|OpenFileError |转换时，文件打开失败，请检查源文档后缀和内容是否匹配。|'."\n" + .'|ExportFileError |转换时，文件内容处理失败，请检查源文档是否能够正常打开。|'."\n" + .'|ExceedFileSizeLimit|文档转换默认支持的文件大小为200 MB，超过该大小的文件转换时会出现该错误。|'."\n" + .'|NeedPassword|打开文件需要密码，请设置Password参数。 |'."\n" + .'|ConvertFailed|转换文件失败，请使用钉钉搜索钉钉群号31690030817加入钉钉群进行反馈。|'."\n" + .'|InternalError|内部错误，请使用钉钉搜索钉钉群号31690030817加入钉钉群进行反馈。|', + ], + 'DeleteOfficeConversionTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。异步[文档格式转换](https://help.aliyun.com/document_detail/72044.html)任务执行后返回的TaskId。'."\n" + ."\n" + .'异步文档格式转换任务的TaskId可以通过智能媒体管理控制台对应项目的**任务查询**页签获取。'."\n" + ."\n" + .'> 当TaskId不合法或者不存在时，此操作仍会执行成功，请确保已设置正确的TaskId。', + 'type' => 'string', + 'required' => true, + 'example' => 'formatconvert-35078200-b306-477e-ae82-aa5a73f38fbc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '37D69D8D-BAF1-44B7-A55C-D7D132B0238E', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"37D69D8D-BAF1-44B7-A55C-D7D132B0238E\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>37D69D8D-BAF1-44B7-A55C-D7D132B0238E</RequestId>","errorExample":""}]', + 'title' => '删除异步文档格式转换任务', + 'summary' => '调用DeleteOfficeConversionTask接口删除异步文档格式转换任务。', + 'description' => '此接口已不再维护，建议使用[新版（2020-09-30版本）API](~~478146~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateOfficeConversionTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immdoctest', + ], + ], + [ + 'name' => 'SrcUri', + 'in' => 'query', + 'schema' => [ + 'description' => '源数据的存储位置。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://bucket1/object', + ], + ], + [ + 'name' => 'TgtType', + 'in' => 'query', + 'schema' => [ + 'description' => '转换输出的目标文件类型。包括如下选项：'."\n" + ."\n" + .'- vector：转换为向量格式的文件，需要使用预览引擎进行渲染后才能预览。'."\n" + ."\n" + .'- png：转换为PNG格式的图片文件。'."\n" + ."\n" + .'- jpg：转换为JPG格式的图片文件。'."\n" + ."\n" + .'- pdf：转换为PDF文件。'."\n" + ."\n" + .'- text：转换为只包含文本内容的文件，主要用于提取文件的文本内容。'."\n" + ."\n" + .' > 源数据类型只支持演示文档和文字文档类型。'."\n" + .' ', + 'type' => 'string', + 'required' => false, + 'example' => 'vector', + ], + ], + [ + 'name' => 'TgtUri', + 'in' => 'query', + 'schema' => [ + 'description' => '转换后输出内容的目标位置，建议TgtUri和SrcUri在同一个OSS Bucket中，便于权限管理。 '."\n" + ."\n" + .'生成的目标文件会持久化保存，推荐设置为OSS Bucket下的/imm-format-convert-tgt/${name}路径，便于维护管理。'."\n" + ."\n" + .'您可以主动删除转换后的目标文件，如果不主动删除则会长期保留以备使用，但是会占用存储空间。如果希望自动的删除目标文件，您也可以在/imm-format-convert-tgt前缀下配置[OSS的生命周期](https://help.aliyun.com/document_detail/31904.html)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://bucket1/imm-format-convert-tgt/session123/', + ], + ], + [ + 'name' => 'NotifyTopicName', + 'in' => 'query', + 'schema' => [ + 'description' => '异步反向通知的TopicName。', + 'type' => 'string', + 'required' => false, + 'example' => 'topic1', + ], + ], + [ + 'name' => 'NotifyEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => '异步反向通知的Endpoint，文档转换状态可以通过该Endpoint异步通知给调用者。使用此功能需要先开通MNS服务，新建topic和queue，并配置订阅关系。'."\n" + ."\n" + .'> MNS服务和智能媒体管理必须处于同一地域。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + ], + ], + [ + 'name' => 'SrcType', + 'in' => 'query', + 'schema' => [ + 'description' => '当OSS对象没有后缀名时，可以设置此参数。'."\n" + ."\n" + .'源数据的后缀类型。默认根据OSS对象的后缀名确定源数据的类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'doc', + ], + ], + [ + 'name' => 'StartPage', + 'in' => 'query', + 'schema' => [ + 'description' => '文档转换的起始页，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'EndPage', + 'in' => 'query', + 'schema' => [ + 'description' => '文档转换的结束页，默认值为200。如果需要转换所有页，设置此参数为-1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MaxSheetRow', + 'in' => 'query', + 'schema' => [ + 'description' => '表格文档转换的最大行数，默认值为1000。如果需要转换所有行，设置此参数为-1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MaxSheetCol', + 'in' => 'query', + 'schema' => [ + 'description' => '表格文档转换的最大列数，默认值为100。如果需要转换所有列，设置此参数为-1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MaxSheetCount', + 'in' => 'query', + 'schema' => [ + 'description' => '表格文档转换的最大Sheet数。如果需要转换所有Sheet，设置此参数为-1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'SheetOnePage', + 'in' => 'query', + 'schema' => [ + 'description' => '当TgtType设置为pdf时，此参数才生效。'."\n" + .' '."\n" + .'表格文档转换为pdf时，是否将Sheet的所有内容输出到一页。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ModelId', + 'in' => 'query', + 'schema' => [ + 'description' => '模型ID。此参数暂不可用。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => '文档的打开密码。如果需要转换有密码的文档，请设置此参数。', + 'type' => 'string', + 'required' => false, + 'example' => '********', + ], + ], + [ + 'name' => 'TgtFilePrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '当TgtType设置为jpg、png、pdf时，此参数才生效。'."\n" + ."\n" + .'转换后的文件名称前缀，可以是英文、数字、横划线和下划线，且长度不超过256个字符。'."\n" + ."\n" + .'通过设置TgtFilePrefix和TgtFileSuffix，可以实现自定义转换后的文件名称。'."\n" + ."\n" + .'如果TgtType设置为jpg，TgtFilePrefix和TgtFileSuffix设置不同时，目标文件的名称规则如下：'."\n" + ."\n" + .'- 当TgtFilePrefix和TgtFileSuffix均为空时，则目标文件的名称为\\[x\\].jpg。'."\n" + ."\n" + .'- 当TgtFilePrefix为空，TgtFileSuffix为aa时，则目标文件的名称为\\[x\\]aa。'."\n" + ."\n" + .'- 当TgtFilePrefix为aa，TgtFileSuffix为空时，则目标文件的名称为aa\\[x\\]。'."\n" + ."\n" + .'- 当TgtFilePrefix为aa，TgtFileSuffix为bb时，则目标文件名称为aa\\[x\\]bb。'."\n" + ."\n" + .'- 当TgtFilePrefix为aa，TgtFileSuffix为def时，则目标文件名称为aa\\[x\\].jpg。'."\n" + ."\n" + .'其中\\[x\\]表示多个目标文件，从1开始。如果TgtFilePrefix为aa，TgtFileSuffix为bb，且转换后的文件有3页，则所有的目标文件为aa\\[1\\]bb、aa\\[2\\]bb、aa\\[3\\]bb。', + 'type' => 'string', + 'required' => false, + 'example' => 'aa', + ], + ], + [ + 'name' => 'TgtFileSuffix', + 'in' => 'query', + 'schema' => [ + 'description' => '当TgtType设置为jpg、png、pdf时，此参数才生效。'."\n" + ."\n" + .'转换后的文件名称后缀，可以是英文、数字、横划线和下划线，且长度不超过256个字符。其中def为保留字，表示采用默认的后缀名。'."\n" + ."\n" + .'通过设置TgtFilePrefix和TgtFileSuffix，可以实现自定义转换后的文件名称。'."\n" + ."\n" + .'如果TgtType设置为jpg，TgtFilePrefix和TgtFileSuffix设置不同时，目标文件的名称规则如下：'."\n" + ."\n" + .'- 当TgtFilePrefix和TgtFileSuffix均为空时，则目标文件的名称为\\[x\\].jpg。'."\n" + ."\n" + .'- 当TgtFilePrefix为空，TgtFileSuffix为aa时，则目标文件的名称为\\[x\\]aa。'."\n" + ."\n" + .'- 当TgtFilePrefix为aa，TgtFileSuffix为空时，则目标文件的名称为aa\\[x\\]。'."\n" + ."\n" + .'- 当TgtFilePrefix为aa，TgtFileSuffix为bb时，则目标文件名称为aa\\[x\\]bb。'."\n" + ."\n" + .'- 当TgtFilePrefix为aa，TgtFileSuffix为def时，则目标文件名称为aa\\[x\\].jpg。'."\n" + ."\n" + .'其中\\[x\\]表示多个目标文件，从1开始。如果TgtFilePrefix为aa，TgtFileSuffix为bb，且转换后的文件有3页，则所有的目标文件为aa\\[1\\]bb、aa\\[2\\]bb、aa\\[3\\]bb。', + 'type' => 'string', + 'required' => false, + 'example' => 'bb', + ], + ], + [ + 'name' => 'TgtFilePages', + 'in' => 'query', + 'schema' => [ + 'description' => '当TgtType设置为jpg、png、pdf时，此参数才生效。'."\n" + ."\n" + .'转换后输出指定文件页数，最多指定100个页数，如果超过100页，请分多次转换进行提交，默认输出所有页。例如当TgtFilePages设置为"1, 2, 100"时，只会输出第1、2、100页到目标位置。', + 'type' => 'string', + 'required' => false, + 'example' => '1, 2, 100', + ], + ], + [ + 'name' => 'FitToPagesTall', + 'in' => 'query', + 'schema' => [ + 'description' => '当TgtType设置为pdf时，此参数才生效。'."\n" + ."\n" + .'表格文档转换为pdf时，将行全部输出到一页，默认值为false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'FitToPagesWide', + 'in' => 'query', + 'schema' => [ + 'description' => '当TgtType设置为pdf时，此参数才生效。'."\n" + ."\n" + .'表格文件转pdf时，将列全部输出在一页，默认值为false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'IdempotentToken', + 'in' => 'query', + 'schema' => [ + 'description' => '><notice>该参数已下线></notice>'."\n" + .'幂等标识，建议使用UUID格式。不同请求请生成独立的幂等标识。幂等标识的有效期约为43200秒，但不建议复用同一个幂等标识。'."\n" + ."\n" + .'当传入幂等标识时，如果两次请求完全一致（包括IdempotentToken本身），则会返回相同结果，即返回相同的TaskId。该功能用于避免多次执行同样的任务，消耗额外计算资源。'."\n" + ."\n" + .'> 当出现ServiceUnavailable等HTTP状态码为5xx的异常时，IdempotentToken可能失效。此时可能会重复创建该任务。', + 'type' => 'string', + 'required' => false, + 'example' => 'd1fdd246-e187-11e8-9f32-f2801f1b9fd1', + ], + ], + [ + 'name' => 'PdfVector', + 'in' => 'query', + 'schema' => [ + 'description' => '当PDF转换为VECTOR时，是否使用向量模式，默认值为false。包括如下选项：'."\n" + ."\n" + .'- true：使用向量模式，预览效果比较清晰，但是转换耗时较长。'."\n" + ."\n" + .'- false：使用图片模式，预览效果一般，但是转换耗时较短。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Hidecomments', + 'in' => 'query', + 'schema' => [ + 'description' => '当WORD、PPT转换为VECTOR、JPG、PNG时，是否隐藏批注和应用修订，默认值为false。包括如下选项：'."\n" + ."\n" + .'- true：隐藏批注和应用修订。'."\n" + ."\n" + .'- false：显示批注和修订。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'DisplayDpi', + 'in' => 'query', + 'schema' => [ + 'description' => '当源数据类型转换为JPG、PNG时，此参数才生效。'."\n" + ."\n" + .'图片分辨率，默认值为96，单位为PPI，取值范围为96~2048。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1024', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义数据，在mns通知中原样返回。', + 'type' => 'string', + 'required' => false, + 'example' => '{"fileid": "123"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务运行状态。包括如下选项：'."\n" + ."\n" + .'- Running：任务运行中。'."\n" + .'- Finished：任务执行完成，转换成功。'."\n" + .'- Failed：任务执行完成，转换失败。', + 'type' => 'string', + 'example' => 'Running', + ], + 'TaskId' => [ + 'description' => '任务ID。'."\n" + ."\n" + .'异步文档格式转换任务的TaskId可以通过智能媒体管理控制台对应项目的任务查询页签获取。', + 'type' => 'string', + 'example' => 'formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd169b', + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'FF3B7D81-66AE-47E0-BF69-157DCF187514', + ], + 'Percent' => [ + 'description' => '任务进度的百分比。当前只有0和100两个结果。'."\n" + ."\n" + .'只有当转换成功时，此参数的返回值才为100，其他情况均为0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CreateTime' => [ + 'description' => '任务的创建时间。', + 'type' => 'string', + 'example' => '2020-11-11T06:51:17.5Z', + ], + 'TgtLoc' => [ + 'description' => '输出目标文件的位置，和请求参数中的TgtUri相同。', + 'type' => 'string', + 'example' => 'oss://bucket1/imm-format-convert-tgt/session123/', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Running\\",\\n \\"TaskId\\": \\"formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd169b\\",\\n \\"RequestId\\": \\"FF3B7D81-66AE-47E0-BF69-157DCF187514\\",\\n \\"Percent\\": 0,\\n \\"CreateTime\\": \\"2020-11-11T06:51:17.5Z\\",\\n \\"TgtLoc\\": \\"oss://bucket1/imm-format-convert-tgt/session123/\\"\\n}","errorExample":""},{"type":"xml","example":"<Status>Running</Status>\\n<TaskId>formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd169b</TaskId>\\n<RequestId>FF3B7D81-66AE-47E0-BF69-157DCF187514</RequestId>\\n<Percent>0</Percent>\\n<CreateTime>2020-11-11T06:51:17.5Z</CreateTime>\\n<TgtLoc>oss://bucket1/imm-format-convert-tgt/session123/</TgtLoc>","errorExample":""}]', + 'title' => '创建单个文档的转换任务', + 'summary' => '采用异步请求方式进行文档（例如Office文档）格式的转换，执行完成后返回TaskId。', + 'description' => '- 此接口已不再维护，建议使用新版（2020-09-30版本）接口[CreateOfficeConversionTask](~~478228~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + .'- 执行完成后，使用[GetOfficeConversionTask](https://help.aliyun.com/document_detail/72045.html)接口查询返回的TaskId，可以查看任务执行结果。任务执行信息只保存7天，请及时获取任务执行信息，您也可以使用通知机制，传入NotifyTopicName和NotifyEndpoint，及时通知任务执行信息。', + 'requestParamsDescription' => ' **MNS通知**'."\n" + .'请求参数中如果设置了NotifyTopicName和NotifyEndpoint支持[MNS事件通知](https://help.aliyun.com/document_detail/27498.html)，则智能媒体管理会为您返回异步通知，例如文档转换的页数，通知的消息格式为：'."\n" + ."\n" + .'- 转换成功消息 '."\n" + .'```'."\n" + .'{'."\n" + .' "events": ['."\n" + .' {'."\n" + .' "eventName": "FormatConvertJob:JobFinished",'."\n" + .' "eventSource": "acs:imm",'."\n" + .' "eventTime": "2020-11-11T06:51:17.35Z",'."\n" + .' "imm": {'."\n" + .' "taskId": "formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd169b",'."\n" + .' "code": "NoError",'."\n" + .' "pageCount": "32",'."\n" + .' "percent": "100"'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'```'."\n" + .'- 转换失败消息'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "events": ['."\n" + .' {'."\n" + .' "eventName": "FormatConvertJob:JobError",'."\n" + .' "eventSource": "acs:imm",'."\n" + .' "eventTime": "2020-11-11T06:51:17.35Z",'."\n" + .' "imm": {'."\n" + .' "taskId": "formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd169b",'."\n" + .' "code": "FailedToDownloadSrcFile",'."\n" + .' "pageCount": "0",'."\n" + .' "percent": "0"'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 相关文档'."\n" + ."\n" + .'- [智能媒体管理文档预览](https://help.aliyun.com/document_detail/74947.html)'."\n" + ."\n" + .'- [文档转换和预览架构](https://developer.aliyun.com/article/581576)'."\n" + ."\n" + .'- [文档转换使用介绍](https://developer.aliyun.com/article/581874)'."\n" + ."\n" + .'- [文档预览使用介绍](https://developer.aliyun.com/article/582083)', + ], + 'RefreshWebofficeToken' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immdoctest', + ], + ], + [ + 'name' => 'AccessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '访问文档预览服务器的凭证，通过GetWebofficeURL或者RefreshWebofficeToken获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '96c77f96d4c2487aba86549222********', + ], + ], + [ + 'name' => 'RefreshToken', + 'in' => 'query', + 'schema' => [ + 'description' => '凭证过期时使用RefeshToken刷新凭证，通过GetWebofficeURL或者RefreshWebofficeToken获取。', + 'type' => 'string', + 'required' => false, + 'example' => '4cdfb7fac3564268aff15360ac********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RefreshToken' => [ + 'description' => '凭证过期时使用RefeshToken刷新凭证。', + 'type' => 'string', + 'example' => 'e3f0fc87c5e24555835961e9a3********', + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '488F3004-4105-4F28-A634-26353BBF866C', + ], + 'AccessToken' => [ + 'description' => '访问文档预览服务器的凭证。', + 'type' => 'string', + 'example' => '0301d19407084bd0b9449d6ecc********', + ], + 'RefreshTokenExpiredTime' => [ + 'description' => '刷新凭证的过期时间，有效时间为1天。', + 'type' => 'string', + 'example' => '2020-12-26T09:14:42.986876757Z', + ], + 'AccessTokenExpiredTime' => [ + 'description' => '凭证的过期时间，有效时间为30分钟。', + 'type' => 'string', + 'example' => '2020-12-25T09:44:42.986876757Z', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RefreshToken\\": \\"e3f0fc87c5e24555835961e9a3********\\",\\n \\"RequestId\\": \\"488F3004-4105-4F28-A634-26353BBF866C\\",\\n \\"AccessToken\\": \\"0301d19407084bd0b9449d6ecc********\\",\\n \\"RefreshTokenExpiredTime\\": \\"2020-12-26T09:14:42.986876757Z\\",\\n \\"AccessTokenExpiredTime\\": \\"2020-12-25T09:44:42.986876757Z\\"\\n}","errorExample":""},{"type":"xml","example":"<RefreshToken>e3f0fc87c5e24555835961e9a3********</RefreshToken>\\n<RequestId>488F3004-4105-4F28-A634-26353BBF866C</RequestId>\\n<AccessToken>0301d19407084bd0b9449d6ecc********</AccessToken>\\n<RefreshTokenExpiredTime>2020-12-26T09:14:42.986876757Z</RefreshTokenExpiredTime>\\n<AccessTokenExpiredTime>2020-12-25T09:44:42.986876757Z</AccessTokenExpiredTime>","errorExample":""}]', + 'title' => '刷新Weboffice的访问凭证', + 'summary' => '调用RefreshWebofficeToken接口刷新Weboffice的访问凭证。', + 'description' => '- 此接口已不再维护，建议使用新版（2020-09-30版本）接口[RefreshWebofficeToken](~~478227~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + .'- 此API不受单用户每秒调用次数不能超过十次的限制。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RefreshOfficePreviewToken' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immdoctest', + ], + ], + [ + 'name' => 'AccessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '访问文档预览服务器的凭证，通过GetOfficePreviewURL或者RefreshOfficePreviewToken获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'f3a3ad0ae32a4c6fb90ed00218********', + ], + ], + [ + 'name' => 'RefreshToken', + 'in' => 'query', + 'schema' => [ + 'description' => '凭证过期时使用RefeshToken刷新凭证，通过GetOfficePreviewURL或者RefreshOfficePreviewToken获取。', + 'type' => 'string', + 'required' => false, + 'example' => '1eb6535cdf8a4732a7d7183891********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RefreshToken' => [ + 'description' => '凭证过期时使用RefeshToken刷新凭证。', + 'type' => 'string', + 'example' => '780ec2952b4c4173a4a2840bb2********', + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '9F9FB128-7588-4F5F-BAAB-85859D3912D3', + ], + 'AccessToken' => [ + 'description' => '访问文档预览服务器的凭证。', + 'type' => 'string', + 'example' => '35108c3afca14570b98e352efa********', + ], + 'RefreshTokenExpiredTime' => [ + 'description' => '刷新凭证的过期时间，有效时间为1天。', + 'type' => 'string', + 'example' => '2020-11-20T06:43:37.51Z', + ], + 'AccessTokenExpiredTime' => [ + 'description' => '凭证的过期时间，有效时间为30分钟。', + 'type' => 'string', + 'example' => '2020-11-19T07:13:37.51Z', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RefreshToken\\": \\"780ec2952b4c4173a4a2840bb2********\\",\\n \\"RequestId\\": \\"9F9FB128-7588-4F5F-BAAB-85859D3912D3\\",\\n \\"AccessToken\\": \\"35108c3afca14570b98e352efa********\\",\\n \\"RefreshTokenExpiredTime\\": \\"2020-11-20T06:43:37.51Z\\",\\n \\"AccessTokenExpiredTime\\": \\"2020-11-19T07:13:37.51Z\\"\\n}","errorExample":""},{"type":"xml","example":"<RefreshToken>780ec2952b4c4173a4a2840bb2********</RefreshToken>\\n<RequestId>9F9FB128-7588-4F5F-BAAB-85859D3912D3</RequestId>\\n<AccessToken>35108c3afca14570b98e352efa********</AccessToken>\\n<RefreshTokenExpiredTime>2020-11-20T06:43:37.51Z</RefreshTokenExpiredTime>\\n<AccessTokenExpiredTime>2020-11-19T07:13:37.51Z</AccessTokenExpiredTime>","errorExample":""}]', + 'title' => '刷新文档预览凭证', + 'summary' => '刷新文档预览凭证AccessToken。', + 'description' => '- 此接口已不再维护，建议使用新版（2020-09-30版本）接口[RefreshWebofficeToken](~~478227~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + .'- 此API不受单用户每秒调用次数不能超过十次的限制。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetWebofficeURL' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immdoctest', + ], + ], + [ + 'name' => 'SrcType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件的后缀类型。默认按照File.Name对应的文件后缀名确定源数据的类型。'."\n" + ."\n" + .'pdf文件仅支持预览，不支持编辑，需要将Permission字段中的Readonly设置为true。'."\n" + ."\n" + .'目前支持的文件类型有：'."\n" + ."\n\n" + .'- 表格文件：et、xls、xlt、xlsx、xlsm、xltx、xltm、csv'."\n" + ."\n" + .'- 文字文件：doc、docx、txt、dot、wps、wpt、dotx、docm、dotm、rtf'."\n" + ."\n" + .'- 演示文件：ppt、pptx、pptm、ppsx、ppsm、pps、potx、potm、dpt、dps'."\n" + ."\n" + .'- pdf文件：pdf', + 'type' => 'string', + 'required' => false, + 'example' => 'doc', + ], + ], + [ + 'name' => 'FileID', + 'in' => 'query', + 'schema' => [ + 'description' => '文件唯一标识，可以由字母和数字组成且不超过32个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mytest', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => [ + 'description' => '用户信息，以JSON格式表示。'."\n" + ."\n" + .'用户信息包括如下选项：'."\n" + ."\n" + .'每个选项的类型均为String。'."\n" + ."\n" + .'- ID（必选）：用户唯一标识，可以由字母和数字组成，且不超过15个字符。'."\n" + ."\n" + .'- Name（必选）：用户名，不超过32个字符。'."\n" + ."\n" + .'- Avatar（可选）：头像地址。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + ], + [ + 'name' => 'Permission', + 'in' => 'query', + 'schema' => [ + 'description' => '用户权限控制，以JSON格式表示。'."\n" + ."\n" + .'用户权限包括如下选项：'."\n" + ."\n" + .'每个选项的类型均为Boolean，默认值均为false，可选值为true和false。'."\n" + ."\n" + .'- Readonly（可选）：预览模式。'."\n" + ."\n" + .'- Rename（可选）：重命名文件权限，只提供消息通知功能，重命名事件会发送到轻量消息队列（原 MNS）中。'."\n" + ."\n" + .'- History（可选）：查看历史版本的权限。'."\n" + ."\n" + .'- Copy（可选）：拷贝权限。'."\n" + ."\n" + .'- Export（可选）：导出PDF权限。'."\n" + ."\n" + .'- Print（可选）：打印权限。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{"Rename": true, "Readonly": false, "History": true}', + ], + ], + [ + 'name' => 'File', + 'in' => 'query', + 'schema' => [ + 'description' => '文件信息，以JSON格式表示。'."\n" + ."\n" + .'文件信息包括如下选项：'."\n" + ."\n" + .'- Modifier（必选）：最近一次编辑文件的用户，类型为User。'."\n" + ."\n" + .'- Creator（必选）：创建文件的用户，类型为User。'."\n" + ."\n" + .'- Name（必选）：文件名称，类型为String。'."\n" + ."\n" + .'- Version（必选）：文件版本号，类型为Integer。'."\n" + ."\n" + .'- SrcUri（必选）：文件的OSS地址，类型为String。OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSSBucket名称，object为文件路径。'."\n" + ."\n" + .'- TgtUri（必选）：文件编辑后保存到的OSS地址，可以和SrcUri相同，类型为String。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"Modifier": {"Avatar": "http://example.com/?id=user1", "ID": "user1", "Name": "test-user1"}, "Name": "mytest.doc", "Creator": {"Avatar": "http://example.com/?id=user1", "ID": "user1", "Name": "test-user1"}, "SrcUri": "oss://test-bucket/mytest.doc", "Version": 3, "TgtUri": "oss://test-bucket/mytest.doc"}]', + ], + ], + [ + 'name' => 'NotifyEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => '异步反向通知的Endpoint，重命名、用户上线等事件可以通过该Endpoint异步通知给调用者。使用此功能需要先开通轻量消息队列（原 MNS）服务，新建topic和queue，并配置订阅关系。具体操作，请参见[消息服务MNS快速入门](https://help.aliyun.com/document_detail/34412.html)。'."\n" + ."\n" + .'> 轻量消息队列（原 MNS）服务和智能媒体管理必须处于同一地域，异步反向通知的Endpoint必须是内网访问地址。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'http://1111111111.mns.cn-hangzhou-internal.aliyuncs.com', + ], + ], + [ + 'name' => 'NotifyTopicName', + 'in' => 'query', + 'schema' => [ + 'description' => '异步反向通知的TopicName。', + 'type' => 'string', + 'required' => false, + 'example' => 'topic1', + ], + ], + [ + 'name' => 'Watermark', + 'in' => 'query', + 'schema' => [ + 'description' => '水印，以JSON格式表示。'."\n" + ."\n" + .'包括以下信息：'."\n" + .'- Type：水印类型。0：无水印，1：文字水印。'."\n" + .'- Rotate：文字水印的旋转度，单位为弧度。'."\n" + .'- Vertical：文字水印垂直间距，单位为px。'."\n" + .'- Value：文字水印的文字。当WatermarkType设置为1时，才能设置此参数。'."\n" + .'- FillStyle：文字水印的透明度，默认值为rgba(192,192,192,0.6)。'."\n" + .'- Horizontal：文字水印水平间距，单位为px。'."\n" + .'- Font：文字水印的字体，默认值为bold 20px Serif，即默认字体加粗，字体大小为20 px，字体格式为Serif。支持的字体格式为宋体、楷体、Serif（默认）、Arial、Georgia、Tahoma、Comic Sans MS、Times New Roman、Courier New、Verdana。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Rotate": -0.7853982, "Vertical": 100, "Value": "hatlonely", "FillStyle": "rgba(192, 192, 192, 0.6)", "Horizontal": 50, "Font": "bold 20px Serif", "Type": 1}', + ], + ], + [ + 'name' => 'Hidecmb', + 'in' => 'query', + 'schema' => [ + 'description' => '是否隐藏编辑控件。取值范围如下：'."\n" + ."\n" + .'- true（默认）：是。'."\n" + ."\n" + .'- false：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RefreshToken' => [ + 'description' => '凭证过期时使用RefeshToken刷新凭证。', + 'type' => 'string', + 'example' => '4cdfb7fac3564268aff15360ac********', + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6', + ], + 'AccessToken' => [ + 'description' => '访问文档预览服务器的凭证。', + 'type' => 'string', + 'example' => '96c77f96d4c2487aba86549222********', + ], + 'RefreshTokenExpiredTime' => [ + 'description' => '刷新凭证的过期时间，有效时间为1天。', + 'type' => 'string', + 'example' => '2020-12-26T07:13:38.322018529Z', + ], + 'WebofficeURL' => [ + 'description' => '文档协作地址。', + 'type' => 'string', + 'example' => 'https://office-cn-hangzhou.imm.aliyuncs.com/office/w/7c7bb3419a0918203026217468a8e9fe375723ae?_w_tokentype=1', + ], + 'AccessTokenExpiredTime' => [ + 'description' => '凭证的过期时间，有效时间为30分钟。', + 'type' => 'string', + 'example' => '2020-12-25T07:43:38.322018529Z', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RefreshToken\\": \\"4cdfb7fac3564268aff15360ac********\\",\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6\\",\\n \\"AccessToken\\": \\"96c77f96d4c2487aba86549222********\\",\\n \\"RefreshTokenExpiredTime\\": \\"2020-12-26T07:13:38.322018529Z\\",\\n \\"WebofficeURL\\": \\"https://office-cn-hangzhou.imm.aliyuncs.com/office/w/7c7bb3419a0918203026217468a8e9fe375723ae?_w_tokentype=1\\",\\n \\"AccessTokenExpiredTime\\": \\"2020-12-25T07:43:38.322018529Z\\"\\n}","errorExample":""},{"type":"xml","example":"<RefreshToken>4cdfb7fac3564268aff15360ac********</RefreshToken>\\n<RequestId>CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6</RequestId>\\n<AccessToken>96c77f96d4c2487aba86549222********</AccessToken>\\n<RefreshTokenExpiredTime>2020-12-26T07:13:38.322018529Z</RefreshTokenExpiredTime>\\n<WebofficeURL>https://office-cn-hangzhou.imm.aliyuncs.com/office/w/7c7bb3419a0918203026217468a8e9fe375723ae?_w_tokentype=1</WebofficeURL>\\n<AccessTokenExpiredTime>2020-12-25T07:43:38.322018529Z</AccessTokenExpiredTime>","errorExample":""}]', + 'title' => '获取Weboffice的访问凭证', + 'summary' => '获取Weboffice的访问凭证。Weboffice提供文档的在线协作功能，包括预览、编辑、协作等。', + 'description' => '- 此接口已不再维护，建议使用新版（2020-09-30版本）接口[GenerateWebofficeToken](~~478226~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + .'- 此API不受单用户每秒调用次数不能超过十次的限制。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetOfficePreviewURL' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immdoctest', + ], + ], + [ + 'name' => 'SrcUri', + 'in' => 'query', + 'schema' => [ + 'description' => '源数据的OSS地址。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://test-bucket/mytest.doc', + ], + ], + [ + 'name' => 'SrcType', + 'in' => 'query', + 'schema' => [ + 'description' => '源数据的后缀类型。默认根据OSS对象的后缀名确定源数据的类型。'."\n" + ."\n" + .'当OSS对象没有后缀名时，可以设置此参数。'."\n" + ."\n" + .'目前支持的文件类型有：'."\n" + ."\n" + .'- 表格文件：et、xls、xlt、xlsx、xlsm、xltx、xltm、csv'."\n" + ."\n" + .'- 文字文件：doc、docx、txt、dot、wps、wpt、dotx、docm、dotm、rtf'."\n" + ."\n" + .'- 演示文件：ppt、pptx、pptm、ppsx、ppsm、pps、potx、potm、dpt、dps'."\n" + ."\n" + .'- PDF格式文件：pdf', + 'type' => 'string', + 'required' => false, + 'example' => 'doc', + ], + ], + [ + 'name' => 'WatermarkType', + 'in' => 'query', + 'schema' => [ + 'description' => '水印类型。'."\n" + ."\n" + .'- 0：无水印'."\n" + .'- 1：文字水印', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'WatermarkValue', + 'in' => 'query', + 'schema' => [ + 'description' => '文字水印的文字。'."\n" + ."\n" + .'当WatermarkType设置为1时，才能设置此参数。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'imm', + ], + ], + [ + 'name' => 'WatermarkFillStyle', + 'in' => 'query', + 'schema' => [ + 'description' => '文字水印的透明度，默认值为rgba(192, 192, 192, 0.6)。', + 'type' => 'string', + 'required' => false, + 'example' => 'rgba(192, 192, 192, 0.6)', + ], + ], + [ + 'name' => 'WatermarkFont', + 'in' => 'query', + 'schema' => [ + 'description' => '文字水印的字体，默认值为bold 20px Serif。', + 'type' => 'string', + 'required' => false, + 'example' => 'bold 20px Serif', + ], + ], + [ + 'name' => 'WatermarkRotate', + 'in' => 'query', + 'schema' => [ + 'description' => '文字水印的旋转度，默认值为-0.7853982，单位为弧度。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '-0.7853982', + ], + ], + [ + 'name' => 'WatermarkHorizontal', + 'in' => 'query', + 'schema' => [ + 'description' => '文字水印水平间距，默认值为50，单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'WatermarkVertical', + 'in' => 'query', + 'schema' => [ + 'description' => '文字水印垂直间距，默认值为100，单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PreviewURL' => [ + 'description' => '文档预览地址。', + 'type' => 'string', + 'example' => 'https://office-cn-hangzhou.imm.aliyuncs.com/office/f/59db14bc9e97205734b31f9880622e043175ea4f?hidecmb=1&simple=1&_w_tokentype=1', + ], + 'RefreshToken' => [ + 'description' => '凭证过期时使用RefeshToken刷新凭证。', + 'type' => 'string', + 'example' => '1eb6535cdf8a4732a7d7183891********', + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '14580EF3-442A-4AA2-959C-1464DC255EEB', + ], + 'AccessToken' => [ + 'description' => '访问文档预览服务器的凭证。', + 'type' => 'string', + 'example' => 'f3a3ad0ae32a4c6fb90ed00218********', + ], + 'RefreshTokenExpiredTime' => [ + 'description' => '刷新凭证的过期时间，有效时间为1天。', + 'type' => 'string', + 'example' => '2020-11-20T06:16:19.069Z', + ], + 'AccessTokenExpiredTime' => [ + 'description' => '凭证的过期时间，有效时间为30分钟。', + 'type' => 'string', + 'example' => '2020-11-19T06:46:19.069Z', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PreviewURL\\": \\"https://office-cn-hangzhou.imm.aliyuncs.com/office/f/59db14bc9e97205734b31f9880622e043175ea4f?hidecmb=1&simple=1&_w_tokentype=1\\",\\n \\"RefreshToken\\": \\"1eb6535cdf8a4732a7d7183891********\\",\\n \\"RequestId\\": \\"14580EF3-442A-4AA2-959C-1464DC255EEB\\",\\n \\"AccessToken\\": \\"f3a3ad0ae32a4c6fb90ed00218********\\",\\n \\"RefreshTokenExpiredTime\\": \\"2020-11-20T06:16:19.069Z\\",\\n \\"AccessTokenExpiredTime\\": \\"2020-11-19T06:46:19.069Z\\"\\n}","errorExample":""},{"type":"xml","example":"<PreviewURL>https://office-cn-hangzhou.imm.aliyuncs.com/office/f/59db14bc9e97205734b31f9880622e043175ea4f?hidecmb=1&simple=1&_w_tokentype=1</PreviewURL>\\n<RefreshToken>1eb6535cdf8a4732a7d7183891********</RefreshToken>\\n<RequestId>14580EF3-442A-4AA2-959C-1464DC255EEB</RequestId>\\n<AccessToken>f3a3ad0ae32a4c6fb90ed00218********</AccessToken>\\n<RefreshTokenExpiredTime>2020-11-20T06:16:19.069Z</RefreshTokenExpiredTime>\\n<AccessTokenExpiredTime>2020-11-19T06:46:19.069Z</AccessTokenExpiredTime>","errorExample":""}]', + 'title' => '获取文档预览URL', + 'summary' => '获取文档预览的URL和AccessToken。', + 'description' => '- 此接口已不再维护，建议使用新版（2020-09-30版本）接口[GenerateWebofficeToken](~~478226~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + ."\n" + .'- 当前只有华东1（杭州）、华东2（上海）、华北2（北京）、华南1（深圳）、华北3（张家口）和美国地域支持此功能。'."\n" + ."\n" + .'- 此API不受单用户每秒调用次数不能超过十次的限制。'."\n" + ."\n" + .'- 关于如何使用该预览地址和AccessToken实现文档预览，请参见[快速入门](~~162639~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetImage' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'set001', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '图片的OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ImageQuality' => [ + 'description' => '图片质量分数。', + 'type' => 'object', + 'properties' => [ + 'OverallScore' => [ + 'description' => '综合质量分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7759467363357544', + ], + 'Color' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片色度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ColorScore' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片色度的分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ContrastScore' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片对比度的分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'Contrast' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片对比度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ExposureScore' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片曝光程度的分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ClarityScore' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片曝光程度的分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'Clarity' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片清晰度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'Exposure' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片曝光程度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'CompositionScore' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片构成的分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + ], + ], + 'ModifyTime' => [ + 'description' => '图片的修改时间。'."\n" + ."\n" + .'添加图片后，如果未修改过图片，则图片的修改时间和图片的创建时间相同。', + 'type' => 'string', + 'example' => '2020-11-24T10:56:52.461Z', + ], + 'Address' => [ + 'description' => '图片地理位置检测结果。'."\n" + ."\n" + .'只有图片中包含地理位置信息时，检测结果才有值。', + 'type' => 'object', + 'properties' => [ + 'Township' => [ + 'description' => '图片地理位置所在街道（或同级）。', + 'type' => 'string', + 'example' => '转塘街道', + ], + 'District' => [ + 'description' => '图片地理位置所在区（或同级）。', + 'type' => 'string', + 'example' => '西湖区', + ], + 'AddressLine' => [ + 'description' => '图片地理位置的完整地址。', + 'type' => 'string', + 'example' => '中国浙江省杭州市西湖区转塘街道石龙山西路', + ], + 'Country' => [ + 'description' => '图片地理位置所在国家或地区。', + 'type' => 'string', + 'example' => '中国', + ], + 'City' => [ + 'description' => '图片地理位置所在城市（或同级）。', + 'type' => 'string', + 'example' => '杭州市', + ], + 'Province' => [ + 'description' => '图片地理位置所在省（或同级）。', + 'type' => 'string', + 'example' => '浙江省', + ], + ], + ], + 'SourceType' => [ + 'description' => '源数据的类型。', + 'type' => 'string', + 'example' => 'image', + ], + 'SourceUri' => [ + 'description' => '图片的OSS Uri。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + 'FacesFailReason' => [ + 'description' => '人脸识别的失败原因。'."\n" + ."\n" + .'只有当人脸识别失败时，此参数才有值。', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'CroppingSuggestionStatus' => [ + 'description' => '提供裁剪建议的状态，包括如下选项：'."\n" + ."\n" + .'- NotProcessed：未处理'."\n" + .'- Processing：处理中'."\n" + .'- Success：成功'."\n" + .'- Failed：失败'."\n" + ."\n" + .'您可以根据该状态决定读取结果、等待或重试。', + 'type' => 'string', + 'example' => 'NotProcessed', + ], + 'CroppingSuggestionFailReason' => [ + 'description' => '裁剪建议提供失败的原因。'."\n" + ."\n" + .'只有当图片裁剪建议提供失败时，此参数才有值。', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'AddressFailReason' => [ + 'description' => '图片地理位置检测的失败原因。'."\n" + ."\n" + .'只有当图片地理位置检测失败时，此参数才有值。', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'RemarksA' => [ + 'description' => '标记信息。', + 'type' => 'string', + 'example' => 'remarka', + ], + 'AddressModifyTime' => [ + 'description' => '图片地理位置检测的更新时间。', + 'type' => 'string', + 'example' => '2020-11-24T10:56:52.461Z', + ], + 'RemarksB' => [ + 'description' => '标记信息。', + 'type' => 'string', + 'example' => 'remarkb', + ], + 'ImageFormat' => [ + 'description' => '图片格式。', + 'type' => 'string', + 'example' => 'jpg', + ], + 'TagsFailReason' => [ + 'description' => '标签识别的失败原因。格式为`[HTTPStatusCode ErrorCode] ErrorMessage`，例如`[400 InvalidResource] Specified resource is too large. Please check.`'."\n" + ."\n" + .'只有当标签识别失败时，此参数才有值。', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'RemarksArrayB' => [ + 'description' => '标记信息列表。', + 'type' => 'string', + 'example' => '["remarkb1","remarkb2"]', + ], + 'FacesModifyTime' => [ + 'description' => '人脸识别的更新时间。', + 'type' => 'string', + 'example' => '2020-11-24T10:56:52.461Z', + ], + 'Exif' => [ + 'description' => '图片原始EXIF信息，以JSON Object序列化后的格式存储。', + 'type' => 'string', + 'example' => '{"FileSize":{"value":"29304"},"Format":{"value":"jpg"},"ImageHeight":{"value":"417"},"ImageWidth":{"value":"500"},"ResolutionUnit":{"value":"2"},"XResolution":{"value":"96/1"},"YResolution":{"value":"96/1"}}', + ], + 'RemarksC' => [ + 'description' => '标记信息。', + 'type' => 'string', + 'example' => 'remarkc', + ], + 'RemarksD' => [ + 'description' => '标记信息。', + 'type' => 'string', + 'example' => 'remarkd', + ], + 'ImageWidth' => [ + 'description' => '图片宽度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'RemarksArrayA' => [ + 'description' => '标记信息列表。', + 'type' => 'string', + 'example' => '["remarka1","remarka2"]', + ], + 'SourcePosition' => [ + 'description' => '只有当SourceType为video时，此参数才生效。'."\n" + ."\n" + .'视频中该图片帧处于源视频的时间轴位置。格式为`00000000.010`，即%8.3f。', + 'type' => 'string', + 'example' => '00000000.010', + ], + 'Tags' => [ + 'description' => '标签识别结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagName' => [ + 'description' => '标签名称。', + 'type' => 'string', + 'example' => '脸', + ], + 'TagConfidence' => [ + 'description' => '标签置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9812195897102356', + ], + 'CentricScore' => [ + 'description' => '标签主体分数。用于提示该标签内容在图片中的主要程度，越高则说明该标签越可能为图片主体。取值范围为0~1。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'TagLevel' => [ + 'description' => '标签级别，取值范围为1~4。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ParentTagName' => [ + 'description' => '父级标签名称。', + 'type' => 'string', + 'example' => '人物', + ], + ], + ], + ], + 'Faces' => [ + 'description' => '人脸识别结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Gender' => [ + 'description' => '性别，可选项包括MALE和FEMALE。', + 'type' => 'string', + 'example' => 'MALE', + ], + 'GenderConfidence' => [ + 'description' => '性别置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'FaceId' => [ + 'description' => '人脸ID。', + 'type' => 'string', + 'example' => '59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51', + ], + 'FaceAttributes' => [ + 'description' => '人脸其他属性。', + 'type' => 'object', + 'properties' => [ + 'GlassesConfidence' => [ + 'description' => '是否戴眼镜置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Glasses' => [ + 'description' => '是否带眼镜。', + 'type' => 'string', + 'example' => 'NONE', + ], + 'Mask' => [ + 'description' => '是否带口罩。', + 'type' => 'string', + 'example' => 'NONE', + ], + 'BeardConfidence' => [ + 'description' => '是否有胡子置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'MaskConfidence' => [ + 'description' => '是否带口罩置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'FaceBoundary' => [ + 'description' => '人脸框信息。', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '顶点Y坐标，距离顶端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '191', + ], + 'Width' => [ + 'description' => '人脸框宽度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '269', + ], + 'Height' => [ + 'description' => '人脸框高度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '252', + ], + 'Left' => [ + 'description' => '顶点X坐标，距离左端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '95', + ], + ], + ], + 'HeadPose' => [ + 'description' => '头部朝向。', + 'type' => 'object', + 'properties' => [ + 'Pitch' => [ + 'description' => '人脸的俯仰角，取值范围为`-180～+180`度，可信的范围建议为`-30～+30`度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '18.385589599609375', + ], + 'Roll' => [ + 'description' => '内偏转角，取值范围为`-180～+180`度，可信的建议范围为`-45～+45`度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '4.204030513763428', + ], + 'Yaw' => [ + 'description' => '人脸的左右偏转角，取值范围为`-180～+180`度，可信的范围建议为`-80～+80`度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '2.4945924282073975', + ], + ], + ], + 'Beard' => [ + 'description' => '是否有胡子。', + 'type' => 'string', + 'example' => 'NONE', + ], + ], + ], + 'FaceQuality' => [ + 'description' => '人脸质量。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9321779608726501', + ], + 'Emotion' => [ + 'description' => '心情。', + 'type' => 'string', + 'example' => 'HAPPY', + ], + 'Age' => [ + 'description' => '年龄。', + 'type' => 'string', + 'example' => '29', + ], + 'FaceConfidence' => [ + 'description' => '人脸置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9608758687973022', + ], + 'EmotionConfidence' => [ + 'description' => '心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7079545259475708', + ], + 'Attractive' => [ + 'description' => '人脸吸引力，分数越高吸引力越强，取值范围为0~1。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.96', + ], + 'GroupId' => [ + 'description' => '人脸分组ID。如果人脸未分组，则此参数返回值为group-not-grouped。', + 'type' => 'string', + 'example' => 'group-not-grouped', + ], + 'EmotionDetails' => [ + 'description' => '七种心情对应的置信度。', + 'type' => 'object', + 'properties' => [ + 'HAPPY' => [ + 'description' => 'HAPPY心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7079545259475708', + ], + 'CALM' => [ + 'description' => 'CALM心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.2918718755245209', + ], + 'SURPRISED' => [ + 'description' => 'SURPRISED心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.00006676767952740192', + ], + 'DISGUSTED' => [ + 'description' => 'DISGUSTED心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.000033771051676012576', + ], + 'ANGRY' => [ + 'description' => 'ANGRY心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.00001282201901631197', + ], + 'SAD' => [ + 'description' => 'SAD心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.00001527295717096422', + ], + 'SCARED' => [ + 'description' => 'SCARED心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0000014976058082538657', + ], + ], + ], + ], + ], + ], + 'AddressStatus' => [ + 'description' => '图片地理位置检测的状态，包括如下选项：'."\n" + ."\n" + .'- NotProcessed：未处理'."\n" + .'- Processing：处理中'."\n" + .'- Success：成功'."\n" + .'- Failed：失败'."\n" + ."\n" + .'您可以根据该状态决定读取结果、等待或重试。', + 'type' => 'string', + 'example' => 'Success', + ], + 'FacesStatus' => [ + 'description' => '人脸识别的状态，包括如下选项：'."\n" + ."\n" + .'- NotProcessed：未处理'."\n" + .'- Processing：处理中'."\n" + .'- Success：成功'."\n" + .'- Failed：失败'."\n" + ."\n" + .'您可以根据该状态决定读取结果、等待或重试。', + 'type' => 'string', + 'example' => 'Success', + ], + 'ImageQualityModifyTime' => [ + 'description' => '图片质量打分的更新时间。', + 'type' => 'string', + 'example' => '2020-11-24T10:56:52.461Z', + ], + 'CroppingSuggestion' => [ + 'description' => '图片的裁减建议。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Score' => [ + 'description' => '该裁剪方案的美学分数，分数越高表示该方案效果越好，取值范围为0～1。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8979608535766602', + ], + 'CroppingBoundary' => [ + 'description' => '裁剪框信息。', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '顶点Y坐标，距离顶端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Width' => [ + 'description' => '裁剪框宽度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Height' => [ + 'description' => '裁剪框高度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'Left' => [ + 'description' => '顶点X坐标，距离左端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'AspectRatio' => [ + 'description' => '图片裁剪比例列表。', + 'type' => 'string', + 'example' => '2:3', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'D349D345-4744-472C-ABDC-7A29A5E04042', + ], + 'CreateTime' => [ + 'description' => '图片加入媒体集的时间。', + 'type' => 'string', + 'example' => '2020-11-24T9:56:52.461Z', + ], + 'ExternalId' => [ + 'description' => '外部ID，用于和您的应用层的ID（如果有）进行绑定。', + 'type' => 'string', + 'example' => 'externalId001', + ], + 'TagsModifyTime' => [ + 'description' => '标签识别的更新时间。当TagsStatus更改时更新。', + 'type' => 'string', + 'example' => '2020-11-24T10:56:52.461Z', + ], + 'ImageQualityFailReason' => [ + 'description' => '图片质量打分失败原因。', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'Orientation' => [ + 'description' => '图片旋转值，从EXIF信息中获取。'."\n" + ."\n" + .'如果图片EXIF信息无此信息，则返回结果中无此参数。', + 'type' => 'string', + 'example' => '{"val":"Right-top","type":3}', + ], + 'ImageUri' => [ + 'description' => '图片的OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + 'OCRStatus' => [ + 'description' => 'OCR识别的状态，包括如下选项：'."\n" + ."\n" + .'- NotProcessed：未处理'."\n" + .'- Processing：处理中'."\n" + .'- Success：成功'."\n" + .'- Failed：失败'."\n" + ."\n" + .'您可以根据该状态决定读取结果、等待或重试。', + 'type' => 'string', + 'example' => 'NotProcessed', + ], + 'OCRModifyTime' => [ + 'description' => 'OCR识别的更新时间。', + 'type' => 'string', + 'example' => '2020-11-24T10:56:52.461Z', + ], + 'ImageTime' => [ + 'description' => '图片的拍摄日期，该日期从EXIF信息中获取。'."\n" + ."\n" + .'如果图片EXIF信息无此信息，则返回结果中无此参数。', + 'type' => 'string', + 'example' => '2020-11-24T10:56:52.461Z', + ], + 'CroppingSuggestionModifyTime' => [ + 'description' => '提供最新裁剪建议的时间。', + 'type' => 'string', + 'example' => '2020-11-24T10:56:52.461Z', + ], + 'ImageHeight' => [ + 'description' => '图片高度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '861', + ], + 'ImageQualityStatus' => [ + 'description' => '图片质量打分状态，包括如下选项：'."\n" + ."\n" + .'- NotProcessed：未处理'."\n" + .'- Processing：处理中'."\n" + .'- Success：成功'."\n" + .'- Failed：失败'."\n" + ."\n" + .'您可以根据该状态决定读取结果、等待或重试。', + 'type' => 'string', + 'example' => 'Success', + ], + 'TagsStatus' => [ + 'description' => '标签识别的状态，包括如下选项：'."\n" + ."\n" + .'- NotProcessed：未处理'."\n" + .'- Processing：处理中'."\n" + .'- Success：成功'."\n" + .'- Failed：失败'."\n" + ."\n" + .'您可以根据该状态决定读取结果、等待或重试。', + 'type' => 'string', + 'example' => 'Success', + ], + 'OCRFailReason' => [ + 'description' => 'OCR识别的失败原因。', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'SetId' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'example' => 'set001', + ], + 'FileSize' => [ + 'description' => '文件大小，单位为字节。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '69732', + ], + 'Location' => [ + 'description' => '图片地理位置，从EXIF信息中获取，格式为`lat,long`，以英文逗号（,）分隔的浮点数。'."\n" + ."\n" + .'如果图片EXIF信息无此信息，则返回结果中无此参数。', + 'type' => 'string', + 'example' => '30.134390,120.074997', + ], + 'OCR' => [ + 'description' => 'OCR识别结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OCRConfidence' => [ + 'description' => '文字置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8254936695098877', + ], + 'OCRContents' => [ + 'description' => '文字内容。', + 'type' => 'string', + 'example' => '欢迎使用智能媒体管理', + ], + 'OCRBoundary' => [ + 'description' => '文字位置框信息。', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '顶点Y坐标，距离顶端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Width' => [ + 'description' => '文字位置框宽度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Height' => [ + 'description' => '文字位置框高度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Left' => [ + 'description' => '顶点X坐标，距离左端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ImageQuality\\": {\\n \\"OverallScore\\": 0.7759467363357544,\\n \\"Color\\": 0.6101377010345459,\\n \\"ColorScore\\": 0.6101377010345459,\\n \\"ContrastScore\\": 0.6101377010345459,\\n \\"Contrast\\": 0.6101377010345459,\\n \\"ExposureScore\\": 0.6101377010345459,\\n \\"ClarityScore\\": 0.6101377010345459,\\n \\"Clarity\\": 0.6101377010345459,\\n \\"Exposure\\": 0.6101377010345459,\\n \\"CompositionScore\\": 0.6101377010345459\\n },\\n \\"ModifyTime\\": \\"2020-11-24T10:56:52.461Z\\",\\n \\"Address\\": {\\n \\"Township\\": \\"转塘街道\\",\\n \\"District\\": \\"西湖区\\",\\n \\"AddressLine\\": \\"中国浙江省杭州市西湖区转塘街道石龙山西路\\",\\n \\"Country\\": \\"中国\\",\\n \\"City\\": \\"杭州市\\",\\n \\"Province\\": \\"浙江省\\"\\n },\\n \\"SourceType\\": \\"image\\",\\n \\"SourceUri\\": \\"oss://imm-test/testcases/face1.jpg\\",\\n \\"FacesFailReason\\": \\"Timeout\\",\\n \\"CroppingSuggestionStatus\\": \\"NotProcessed\\",\\n \\"CroppingSuggestionFailReason\\": \\"Timeout\\",\\n \\"AddressFailReason\\": \\"Timeout\\",\\n \\"RemarksA\\": \\"remarka\\",\\n \\"AddressModifyTime\\": \\"2020-11-24T10:56:52.461Z\\",\\n \\"RemarksB\\": \\"remarkb\\",\\n \\"ImageFormat\\": \\"jpg\\",\\n \\"TagsFailReason\\": \\"Timeout\\",\\n \\"RemarksArrayB\\": \\"[\\\\\\"remarkb1\\\\\\",\\\\\\"remarkb2\\\\\\"]\\",\\n \\"FacesModifyTime\\": \\"2020-11-24T10:56:52.461Z\\",\\n \\"Exif\\": \\"{\\\\\\"FileSize\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"29304\\\\\\"},\\\\\\"Format\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"jpg\\\\\\"},\\\\\\"ImageHeight\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"417\\\\\\"},\\\\\\"ImageWidth\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"500\\\\\\"},\\\\\\"ResolutionUnit\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2\\\\\\"},\\\\\\"XResolution\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"96/1\\\\\\"},\\\\\\"YResolution\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"96/1\\\\\\"}}\\",\\n \\"RemarksC\\": \\"remarkc\\",\\n \\"RemarksD\\": \\"remarkd\\",\\n \\"ImageWidth\\": 500,\\n \\"RemarksArrayA\\": \\"[\\\\\\"remarka1\\\\\\",\\\\\\"remarka2\\\\\\"]\\",\\n \\"SourcePosition\\": \\"00000000.010\\",\\n \\"Tags\\": [\\n {\\n \\"TagName\\": \\"脸\\",\\n \\"TagConfidence\\": 0.9812195897102356,\\n \\"CentricScore\\": 0,\\n \\"TagLevel\\": 2,\\n \\"ParentTagName\\": \\"人物\\"\\n }\\n ],\\n \\"Faces\\": [\\n {\\n \\"Gender\\": \\"MALE\\",\\n \\"GenderConfidence\\": 1,\\n \\"FaceId\\": \\"59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51\\",\\n \\"FaceAttributes\\": {\\n \\"GlassesConfidence\\": 1,\\n \\"Glasses\\": \\"NONE\\",\\n \\"Mask\\": \\"NONE\\",\\n \\"BeardConfidence\\": 1,\\n \\"MaskConfidence\\": 1,\\n \\"FaceBoundary\\": {\\n \\"Top\\": 191,\\n \\"Width\\": 269,\\n \\"Height\\": 252,\\n \\"Left\\": 95\\n },\\n \\"HeadPose\\": {\\n \\"Pitch\\": 18.385589599609375,\\n \\"Roll\\": 4.204030513763428,\\n \\"Yaw\\": 2.4945924282073975\\n },\\n \\"Beard\\": \\"NONE\\"\\n },\\n \\"FaceQuality\\": 0.9321779608726501,\\n \\"Emotion\\": \\"HAPPY\\",\\n \\"Age\\": \\"29\\",\\n \\"FaceConfidence\\": 0.9608758687973022,\\n \\"EmotionConfidence\\": 0.7079545259475708,\\n \\"Attractive\\": 0.96,\\n \\"GroupId\\": \\"group-not-grouped\\",\\n \\"EmotionDetails\\": {\\n \\"HAPPY\\": 0.7079545259475708,\\n \\"CALM\\": 0.2918718755245209,\\n \\"SURPRISED\\": 0.00006676767952740192,\\n \\"DISGUSTED\\": 0.000033771051676012576,\\n \\"ANGRY\\": 0.00001282201901631197,\\n \\"SAD\\": 0.00001527295717096422,\\n \\"SCARED\\": 0.0000014976058082538657\\n }\\n }\\n ],\\n \\"AddressStatus\\": \\"Success\\",\\n \\"FacesStatus\\": \\"Success\\",\\n \\"ImageQualityModifyTime\\": \\"2020-11-24T10:56:52.461Z\\",\\n \\"CroppingSuggestion\\": [\\n {\\n \\"Score\\": 0.8979608535766602,\\n \\"CroppingBoundary\\": {\\n \\"Top\\": 30,\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Left\\": 10\\n },\\n \\"AspectRatio\\": \\"2:3\\"\\n }\\n ],\\n \\"RequestId\\": \\"D349D345-4744-472C-ABDC-7A29A5E04042\\",\\n \\"CreateTime\\": \\"2020-11-24T9:56:52.461Z\\",\\n \\"ExternalId\\": \\"externalId001\\",\\n \\"TagsModifyTime\\": \\"2020-11-24T10:56:52.461Z\\",\\n \\"ImageQualityFailReason\\": \\"Timeout\\",\\n \\"Orientation\\": \\"{\\\\\\"val\\\\\\":\\\\\\"Right-top\\\\\\",\\\\\\"type\\\\\\":3}\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/face1.jpg\\",\\n \\"OCRStatus\\": \\"NotProcessed\\",\\n \\"OCRModifyTime\\": \\"2020-11-24T10:56:52.461Z\\",\\n \\"ImageTime\\": \\"2020-11-24T10:56:52.461Z\\",\\n \\"CroppingSuggestionModifyTime\\": \\"2020-11-24T10:56:52.461Z\\",\\n \\"ImageHeight\\": 861,\\n \\"ImageQualityStatus\\": \\"Success\\",\\n \\"TagsStatus\\": \\"Success\\",\\n \\"OCRFailReason\\": \\"Timeout\\",\\n \\"SetId\\": \\"set001\\",\\n \\"FileSize\\": 69732,\\n \\"Location\\": \\"30.134390,120.074997\\",\\n \\"OCR\\": [\\n {\\n \\"OCRConfidence\\": 0.8254936695098877,\\n \\"OCRContents\\": \\"欢迎使用智能媒体管理\\",\\n \\"OCRBoundary\\": {\\n \\"Top\\": 12,\\n \\"Width\\": 12,\\n \\"Height\\": 12,\\n \\"Left\\": 12\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ImageQuality>\\n <OverallScore>0.7759467363357544</OverallScore>\\n</ImageQuality>\\n<Address>\\n <Township>转塘街道</Township>\\n <AddressLine>浙江省杭州市西湖区转塘街道石龙山西路</AddressLine>\\n <Country>中国</Country>\\n <City>杭州市</City>\\n <District>西湖区</District>\\n <Province>浙江省</Province>\\n</Address>\\n<SourceUri>oss://imm-test/testcases/face1.jpg</SourceUri>\\n<SourceType>image</SourceType>\\n<CroppingSuggestionFailReason/>\\n<FacesFailReason/>\\n<AddressFailReason/>\\n<ImageFormat>jpg</ImageFormat>\\n<RemarksArrayB>[\\"remarkb1\\",\\"remarkb2\\"]</RemarksArrayB>\\n<Exif>{\\"FileSize\\":{\\"value\\":\\"29304\\"},\\"Format\\":{\\"value\\":\\"jpg\\"},\\"ImageHeight\\":{\\"value\\":\\"417\\"},\\"ImageWidth\\":{\\"value\\":\\"500\\"},\\"ResolutionUnit\\":{\\"value\\":\\"2\\"},\\"XResolution\\":{\\"value\\":\\"96/1\\"},\\"YResolution\\":{\\"value\\":\\"96/1\\"}}</Exif>\\n<ImageWidth>500</ImageWidth>\\n<RemarksArrayA>[\\"remarka1\\",\\"remarka2\\"]</RemarksArrayA>\\n<Faces>\\n <FaceConfidence>0.9608758687973022</FaceConfidence>\\n <FaceId>59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51</FaceId>\\n <FaceQuality>0.9321779608726501</FaceQuality>\\n <Attractive>0.96</Attractive>\\n <GenderConfidence>1</GenderConfidence>\\n <EmotionConfidence>0.7079545259475708</EmotionConfidence>\\n <Emotion>HAPPY</Emotion>\\n <Gender>FEMALE</Gender>\\n <Age>29</Age>\\n <GroupId>group-not-grouped</GroupId>\\n</Faces>\\n<Faces>\\n <EmotionDetails>\\n <CALM>0.2918718755245209</CALM>\\n <SCARED>0.0000014976058082538657</SCARED>\\n <HAPPY>0.7079545259475708</HAPPY>\\n <SURPRISED>0.00006676767952740192</SURPRISED>\\n <SAD>0.00001527295717096422</SAD>\\n <DISGUSTED>0.000033771051676012576</DISGUSTED>\\n <ANGRY>0.00001282201901631197</ANGRY>\\n </EmotionDetails>\\n <FaceAttributes>\\n <Beard>NONE</Beard>\\n <FaceBoundary>\\n <Left>95</Left>\\n <Top>191</Top>\\n <Height>252</Height>\\n <Width>269</Width>\\n </FaceBoundary>\\n <BeardConfidence>1</BeardConfidence>\\n <HeadPose>\\n <Pitch>18.385589599609375</Pitch>\\n <Roll>4.204030513763428</Roll>\\n <Yaw>2.4945924282073975</Yaw>\\n </HeadPose>\\n <MaskConfidence>1</MaskConfidence>\\n <Mask>NONE</Mask>\\n <Glasses>NONE</Glasses>\\n <GlassesConfidence>1</GlassesConfidence>\\n </FaceAttributes>\\n</Faces>\\n<Tags>\\n <TagName>脸</TagName>\\n <TagConfidence>0.9812195897102356</TagConfidence>\\n <TagLevel>2</TagLevel>\\n <ParentTagName>人物</ParentTagName>\\n</Tags>\\n<Tags>\\n <TagName>人物</TagName>\\n <TagConfidence>0.9812195897102356</TagConfidence>\\n <TagLevel>1</TagLevel>\\n</Tags>\\n<Tags>\\n <TagName>微笑</TagName>\\n <TagConfidence>0.7626392841339111</TagConfidence>\\n <TagLevel>3</TagLevel>\\n <ParentTagName>日常行为</ParentTagName>\\n</Tags>\\n<Tags>\\n <TagName>日常行为</TagName>\\n <TagConfidence>0.7626392841339111</TagConfidence>\\n <TagLevel>2</TagLevel>\\n <ParentTagName>生活</ParentTagName>\\n</Tags>\\n<Tags>\\n <TagName>生活</TagName>\\n <TagConfidence>0.7626392841339111</TagConfidence>\\n <TagLevel>1</TagLevel>\\n</Tags>\\n<AddressStatus>Success</AddressStatus>\\n<ImageQualityModifyTime>2020-11-24T10:56:52.461Z</ImageQualityModifyTime>\\n<RequestId>D349D345-4744-472C-ABDC-7A29A5E04042</RequestId>\\n<ImageQualityFailReason/>\\n<ImageUri>oss://imm-test/testcases/face1.jpg</ImageUri>\\n<ImageQualityStatus>Success</ImageQualityStatus>\\n<TagsStatus>Success</TagsStatus>\\n<ImageHeight>861</ImageHeight>\\n<SetId>set001</SetId>\\n<FileSize>69732</FileSize>\\n<ModifyTime>2020-11-24T10:56:52.461Z</ModifyTime>\\n<CroppingSuggestionStatus>NotProcessed</CroppingSuggestionStatus>\\n<RemarksA>remarka</RemarksA>\\n<AddressModifyTime>2020-11-24T10:56:52.461Z</AddressModifyTime>\\n<RemarksB>remarkb</RemarksB>\\n<TagsFailReason/>\\n<FacesModifyTime>2020-11-24T10:56:52.461Z</FacesModifyTime>\\n<RemarksC>remarkc</RemarksC>\\n<RemarksD>remarkd</RemarksD>\\n<FacesStatus>Success</FacesStatus>\\n<ExternalId>externalId001</ExternalId>\\n<TagsModifyTime>2020-11-24T10:56:52.461Z</TagsModifyTime>\\n<CreateTime>2020-11-24T10:56:52.461Z</CreateTime>\\n<OCRStatus>NotProcessed</OCRStatus>\\n<Location>30.134390,120.074997</Location>","errorExample":""}]', + 'title' => '从媒体集中获取一张图片的信息', + 'summary' => '调用GetImage接口从媒体集中获取一张图片的信息。', + 'description' => '此接口已不再维护，建议使用新版（2020-09-30版本）接口[GetFileMeta](~~478170~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteImage' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'set001', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '图片的OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '81A8F375-51D7-4523-852D-A940E37E62D0', + ], + 'SetId' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'example' => 'set001', + ], + 'ImageUri' => [ + 'description' => '图片的OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"81A8F375-51D7-4523-852D-A940E37E62D0\\",\\n \\"SetId\\": \\"set001\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/face1.jpg\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>81A8F375-51D7-4523-852D-A940E37E62D0</RequestId>\\n<ImageUri>oss://imm-test/testcases/face1.jpg</ImageUri>\\n<SetId>set001</SetId>","errorExample":""}]', + 'title' => '删除图片', + 'summary' => '删除媒体集中指定的图片。', + 'description' => '此接口已不再维护，建议使用新版（2020-09-30版本）接口[DeleteFileMeta](~~478172~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'FindImages' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'set001', + ], + ], + [ + 'name' => 'ImageSizeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '图片大小范围，使用JSON格式表示，格式为`{"MinWidth":100,"MaxWidth":3000,"MinHeight":50,"MaxHeight":5000}`。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '{"MinWidth":100,"MaxWidth":3000,"MinHeight":50,"MaxHeight":5000}', + ], + ], + [ + 'name' => 'ImageTimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '图片的时间范围，该时间从EXIF信息获取，使用JSON格式表示，格式为'."\n" + .'`{"Start":"1970-01-01T00:00:01.544Z","End":"2199-01-01T00:00:01.544Z"}`。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Start":"2020-11-10T00:00:01.544Z","End":"2020-11-25T00:00:01.544Z"}', + ], + ], + [ + 'name' => 'CreateTimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '图片加入媒体集的时间范围，使用JSON格式表示，格式为`{"Start":"1970-01-01T00:00:01.544Z","End":"2199-01-01T00:00:01.544Z"}`。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Start":"2020-11-10T00:00:01.544Z","End":"2020-11-25T00:00:01.544Z"}', + ], + ], + [ + 'name' => 'ModifyTimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '图片更新的时间范围，使用JSON格式表示，格式为'."\n" + .'`{"Start":"1970-01-01T00:00:01.544Z","End":"2199-01-01T00:00:01.544Z"}`。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Start":"2020-11-10T00:00:01.544Z","End":"2020-11-25T00:00:01.544Z"}', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '源数据的类型，包括如下选项：'."\n" + ."\n" + .'- image：图片'."\n" + .'- video：视频', + 'type' => 'string', + 'required' => false, + 'example' => 'image', + ], + ], + [ + 'name' => 'SourceUriPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '图片的OSS URI的前缀。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://imm-test/', + ], + ], + [ + 'name' => 'RemarksAPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息的前缀，用于前缀匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'remark', + ], + ], + [ + 'name' => 'RemarksBPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息的前缀，用于前缀匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'remark', + ], + ], + [ + 'name' => 'TagNames', + 'in' => 'query', + 'schema' => [ + 'description' => '标签列表，设置多个标签时，请使用JSON格式表示，此时只有同时包含所有标签的图片才会返回，格式为\\["脸","人物"\\]。', + 'type' => 'string', + 'required' => false, + 'example' => '["脸","人物"]', + ], + ], + [ + 'name' => 'OCRContentsMatch', + 'in' => 'query', + 'schema' => [ + 'description' => 'OCR识别的内容搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'myh', + ], + ], + [ + 'name' => 'AgeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '年龄范围，使用JSON格式表示，格式为`{"Start":0,"End":99}`。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Start":0,"End":99}', + ], + ], + [ + 'name' => 'Gender', + 'in' => 'query', + 'schema' => [ + 'description' => '性别，可选值为MALE和FEMALE。', + 'type' => 'string', + 'required' => false, + 'example' => 'MALE', + ], + ], + [ + 'name' => 'Emotion', + 'in' => 'query', + 'schema' => [ + 'description' => '表情，可选值为HAPPY、SAD、ANGRY、SURPRISED、SCARED、DISGUSTED和CALM。', + 'type' => 'string', + 'required' => false, + 'example' => 'HAPPY', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段，可选值为CreateTime、ModifyTime、ImageTime、FacesModifyTime、TagsModifyTime、RemarksA、RemarksB、RemarksC和RemarksD。', + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTime', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式，可选值为ASC和DESC。'."\n" + ."\n" + .'- ASC：升序'."\n" + .'- DESC：降序', + 'type' => 'string', + 'required' => false, + 'example' => 'ASC', + ], + ], + [ + 'name' => 'Marker', + 'in' => 'query', + 'schema' => [ + 'description' => '从Marker开始按字典序返回图片信息列表。如果不设置此参数，则从头开始返回图片。', + 'type' => 'string', + 'required' => false, + 'example' => 'imm', + ], + ], + [ + 'name' => 'LocationBoundary', + 'in' => 'query', + 'schema' => [ + 'description' => '地理位置范围，使用JSON格式表示，格式为`{"TopLeft":"50.2,100.1","BottomRight":"30.5,120.1"}`。'."\n" + ."\n" + .'其中TopLeft（左上）和BottomRight（右下）两个顶点的格式为`lat,long`，是以英文逗号（,）分隔的浮点数。'."\n" + ."\n" + .'> Top的值必须大于Bottom的值，Left的值必须小于Right的值。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"TopLeft":"50.2,100.1","BottomRight":"30.5,120.1"}', + ], + ], + [ + 'name' => 'RemarksCPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息的前缀，用于前缀匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'remark', + ], + ], + [ + 'name' => 'RemarksDPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息的前缀，用于前缀匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'remark', + ], + ], + [ + 'name' => 'ExternalId', + 'in' => 'query', + 'schema' => [ + 'description' => '外部ID，用于和您的应用层的ID（如果有）进行绑定。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'externalId001', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '人脸分组ID。如果人脸未分组，则此参数返回值为group-not-grouped。', + 'type' => 'string', + 'required' => false, + 'example' => 'group-not-grouped', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '返回图片的最大个数，默认值为20，取值范围为1~100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'FacesModifyTimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '人脸信息更新的时间范围，使用JSON格式表示，格式为`{"Start":"1970-01-01T00:00:01.544Z","End":"2199-01-01T00:00:01.544Z"}`。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Start":"2020-11-10T00:00:01.544Z","End":"2020-11-25T00:00:01.544Z"}', + ], + ], + [ + 'name' => 'TagsModifyTimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '标签信息更新的时间范围，使用JSON格式表示，格式为`{"Start":"1970-01-01T00:00:01.544Z","End":"2199-01-01T00:00:01.544Z"}`。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Start":"2020-11-10T00:00:01.544Z","End":"2020-11-25T00:00:01.544Z"}', + ], + ], + [ + 'name' => 'AddressLineContentsMatch', + 'in' => 'query', + 'schema' => [ + 'description' => '只有当Location有值，即带有地理信息标记的文件时，此参数才有效。'."\n" + ."\n" + .'地址搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'zhejiang', + ], + ], + [ + 'name' => 'RemarksArrayAIn', + 'in' => 'query', + 'schema' => [ + 'description' => '只有图片的标签列表中存在至少一个标签匹配查询条件，则图片就会返回。', + 'type' => 'string', + 'required' => false, + 'example' => '["remarka1","remarka2"]', + ], + ], + [ + 'name' => 'RemarksArrayBIn', + 'in' => 'query', + 'schema' => [ + 'description' => '只有图片的标签列表中存在至少一个标签匹配查询条件，则图片就会返回。', + 'type' => 'string', + 'required' => false, + 'example' => '["remarkb1","remarkb2"]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '810FE908-522F-4951-8AF8-7211890D4B2A', + ], + 'Images' => [ + 'description' => '图片信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CroppingSuggestionStatus' => [ + 'description' => '提供裁剪建议的状态，包括如下选项：'."\n" + ."\n" + .'- NotProcessed：未处理'."\n" + .'- Processing：处理中'."\n" + .'- Success：成功'."\n" + .'- Failed：失败'."\n" + ."\n" + .'您可以根据该状态决定读取结果、等待或重试。', + 'type' => 'string', + 'example' => 'NotProcessed', + ], + 'ImageQualityModifyTime' => [ + 'description' => '图片质量打分的更新时间。', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'TagsFailReason' => [ + 'description' => '标签识别的失败原因。格式为`[HTTPStatusCode ErrorCode] ErrorMessage`，例如`[400 InvalidResource] Specified resource is too large. Please check.`'."\n" + ."\n" + .'只有当标签识别失败时，此参数才有值。'."\n", + 'type' => 'string', + 'example' => 'Timeout', + ], + 'RemarksC' => [ + 'description' => '标记信息。', + 'type' => 'string', + 'example' => 'remarkc', + ], + 'CreateTime' => [ + 'description' => '图片加入媒体集的时间。', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'SourceType' => [ + 'description' => '源数据的类型。', + 'type' => 'string', + 'example' => 'image', + ], + 'FacesFailReason' => [ + 'description' => '人脸识别的失败原因。'."\n" + ."\n" + .'只有当人脸识别失败时，此参数才有值。', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'Tags' => [ + 'description' => '标签识别结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagConfidence' => [ + 'description' => '标签置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9812195897102356', + ], + 'CentricScore' => [ + 'description' => '标签主体分数。用于提示该标签内容在图片中的主要程度，越高则说明该标签越可能为图片主体。取值范围为0~1。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'TagName' => [ + 'description' => '标签名称。', + 'type' => 'string', + 'example' => '脸', + ], + 'TagLevel' => [ + 'description' => '标签级别，取值范围为1~4。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ParentTagName' => [ + 'description' => '父级标签名称。', + 'type' => 'string', + 'example' => '人物', + ], + ], + ], + ], + 'FacesModifyTime' => [ + 'description' => '人脸识别的更新时间。', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'ImageTime' => [ + 'description' => '图片的拍摄日期，该日期从EXIF信息中获取。'."\n" + ."\n" + .'如果图片EXIF信息无此信息，则返回结果中无此参数。', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'OCRModifyTime' => [ + 'description' => 'OCR识别的更新时间。', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'AddressModifyTime' => [ + 'description' => '图片地理位置检测的更新时间。', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'OCR' => [ + 'description' => 'OCR识别结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OCRConfidence' => [ + 'description' => '文字置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8254936695098877', + ], + 'OCRContents' => [ + 'description' => '文字内容。', + 'type' => 'string', + 'example' => '欢迎使用智能媒体管理', + ], + 'OCRBoundary' => [ + 'description' => '文字位置框信息。', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '顶点Y坐标，距离顶端距离。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Width' => [ + 'description' => '文字位置框宽度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Height' => [ + 'description' => '文字位置框高度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Left' => [ + 'description' => '顶点X坐标，距离左端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + ], + ], + ], + ], + ], + 'ImageQualityFailReason' => [ + 'description' => '图片质量打分的失败原因。', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'FacesStatus' => [ + 'description' => '人脸识别的状态，包括如下选项：'."\n" + ."\n" + .'- NotProcessed：未处理'."\n" + .'- Processing：处理中'."\n" + .'- Success：成功'."\n" + .'- Failed：失败'."\n" + ."\n" + .'您可以根据该状态决定读取结果、等待或重试。', + 'type' => 'string', + 'example' => 'Success', + ], + 'ImageHeight' => [ + 'description' => '图片高度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '861', + ], + 'RemarksArrayA' => [ + 'description' => '标记信息列表。', + 'type' => 'string', + 'example' => '["remarka1","remarka2"]', + ], + 'Address' => [ + 'description' => '图片地理位置检测结果。'."\n" + ."\n" + .'只有图片带有地理位置信息时，检测结果才有值。', + 'type' => 'object', + 'properties' => [ + 'Township' => [ + 'description' => '图片地理位置所在街道（或同级）。', + 'type' => 'string', + 'example' => '转塘街道', + ], + 'District' => [ + 'description' => '图片地理位置所在区（或同级）。', + 'type' => 'string', + 'example' => '西湖区', + ], + 'AddressLine' => [ + 'description' => '图片地理位置的完整地址。', + 'type' => 'string', + 'example' => '浙江省杭州市西湖区转塘街道石龙山西路', + ], + 'Country' => [ + 'description' => '图片地理位置所在国家或地区。', + 'type' => 'string', + 'example' => '中国', + ], + 'City' => [ + 'description' => '图片地理位置所在城市（或同级）。', + 'type' => 'string', + 'example' => '杭州市', + ], + 'Province' => [ + 'description' => '图片地理位置所在省（或同级）。', + 'type' => 'string', + 'example' => '浙江省', + ], + ], + ], + 'ExternalId' => [ + 'description' => '外部ID，用于和您的应用层的ID（如果有）进行绑定。', + 'type' => 'string', + 'example' => 'externalId001', + ], + 'SourceUri' => [ + 'description' => '图片OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + 'ModifyTime' => [ + 'description' => '图片的修改时间。'."\n" + ."\n" + .'添加图片后，如果未修改过图片，则图片的修改时间和图片的创建时间相同。', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'FileSize' => [ + 'description' => '文件大小，单位为字节。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '69732', + ], + 'SourcePosition' => [ + 'description' => '只有当SourceType为video时，此参数才生效。'."\n" + ."\n" + .'视频中该图片帧处于源视频的时间轴位置。格式为`00000000.010`，即%8.3f。', + 'type' => 'string', + 'example' => '00000000.010', + ], + 'Faces' => [ + 'description' => '人脸识别结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Gender' => [ + 'description' => '性别，可选项包括MALE和FEMALE。', + 'type' => 'string', + 'example' => 'FEMALE', + ], + 'FaceId' => [ + 'description' => '人脸ID。', + 'type' => 'string', + 'example' => '59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51', + ], + 'GenderConfidence' => [ + 'description' => '性别置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'FaceAttributes' => [ + 'description' => '人脸其他属性。', + 'type' => 'object', + 'properties' => [ + 'GlassesConfidence' => [ + 'description' => '是否戴眼镜置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Glasses' => [ + 'description' => '是否带眼镜。', + 'type' => 'string', + 'example' => 'NONE', + ], + 'Mask' => [ + 'description' => '是否带口罩。', + 'type' => 'string', + 'example' => 'NONE', + ], + 'BeardConfidence' => [ + 'description' => '是否有胡子置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'MaskConfidence' => [ + 'description' => '是否带口罩置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'FaceBoundary' => [ + 'description' => '人脸位置框信息。', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '顶点Y坐标，距离顶端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '152', + ], + 'Width' => [ + 'description' => '人脸位置框宽度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '139', + ], + 'Height' => [ + 'description' => '人脸位置框高度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '141', + ], + 'Left' => [ + 'description' => '顶点X坐标，距离左端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '267', + ], + ], + ], + 'HeadPose' => [ + 'description' => '头部朝向。', + 'type' => 'object', + 'properties' => [ + 'Pitch' => [ + 'description' => '人脸的俯仰角，取值范围为`-180～+180`度，可信的范围建议为`-30～+30`度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '18.385589599609375', + ], + 'Roll' => [ + 'description' => '面内偏转角，取值范围为`-180～+180`度，可信的建议范围为`-45～+45`度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '4.204030513763428', + ], + 'Yaw' => [ + 'description' => '人脸的左右偏转角，取值范围为`-180～+180`度，可信的范围建议为`-80～+80`度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '2.4945924282073975', + ], + ], + ], + 'Beard' => [ + 'description' => '是否有胡子。', + 'type' => 'string', + 'example' => 'NONE', + ], + ], + ], + 'FaceQuality' => [ + 'description' => '人脸质量。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9321779608726501', + ], + 'Emotion' => [ + 'description' => '心情。', + 'type' => 'string', + 'example' => 'HAPPY', + ], + 'Age' => [ + 'description' => '年龄。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '29', + ], + 'FaceConfidence' => [ + 'description' => '人脸置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9608758687973022', + ], + 'EmotionConfidence' => [ + 'description' => '心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7079545259475708', + ], + 'Attractive' => [ + 'description' => '人脸吸引力，分数越高吸引力越强，取值范围为0~1。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.96', + ], + 'GroupId' => [ + 'description' => '人脸分组ID。如果人脸未分组，则此参数返回值为group-not-grouped。', + 'type' => 'string', + 'example' => 'group-not-grouped', + ], + 'EmotionDetails' => [ + 'description' => '七种心情对应的置信度。', + 'type' => 'object', + 'properties' => [ + 'HAPPY' => [ + 'description' => 'HAPPY心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7079545259475708', + ], + 'SURPRISED' => [ + 'description' => 'SURPRISED心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.00006676767952740192', + ], + 'CALM' => [ + 'description' => 'CALM心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.2918718755245209', + ], + 'DISGUSTED' => [ + 'description' => 'DISGUSTED心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.000033771051676012576', + ], + 'ANGRY' => [ + 'description' => 'ANGRY心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.00001282201901631197', + ], + 'SAD' => [ + 'description' => 'SAD心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.00001527295717096422', + ], + 'SCARED' => [ + 'description' => 'SCARED心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0000014976058082538657', + ], + ], + ], + ], + ], + ], + 'ImageQualityStatus' => [ + 'description' => '图片质量打分状态，包括如下选项：'."\n" + ."\n" + .'- NotProcessed：未处理'."\n" + .'- Processing：处理中'."\n" + .'- Success：成功'."\n" + .'- Failed：失败'."\n" + ."\n" + .'您可以根据该状态决定读取结果、等待或重试。', + 'type' => 'string', + 'example' => 'Success', + ], + 'OCRFailReason' => [ + 'description' => 'OCR识别的失败原因。', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'AddressFailReason' => [ + 'description' => '图片地理位置检测的失败原因。'."\n" + ."\n" + .'只有当图片地理位置检测失败时，此参数才有值。', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'ImageQuality' => [ + 'description' => '图片质量分数。', + 'type' => 'object', + 'properties' => [ + 'OverallScore' => [ + 'description' => '综合质量分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7759467363357544', + ], + 'Color' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片色度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ColorScore' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片色度的分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ContrastScore' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片对比度的分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'Contrast' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片对比度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ExposureScore' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片曝光程度的分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ClarityScore' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片清晰度的分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'Clarity' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片清晰度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'Exposure' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片曝光程度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'CompositionScore' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片构成的分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + ], + ], + 'CroppingSuggestionModifyTime' => [ + 'description' => '提供最新裁剪建议的时间。', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'ImageFormat' => [ + 'description' => '图片格式。', + 'type' => 'string', + 'example' => 'jpg', + ], + 'ImageWidth' => [ + 'description' => '图片宽度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'RemarksArrayB' => [ + 'description' => '标记信息列表。', + 'type' => 'string', + 'example' => '["remarkb1","remarkb2"]', + ], + 'CroppingSuggestion' => [ + 'description' => '图片的裁减建议。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Score' => [ + 'description' => '该裁剪方案的美学分数，分数越高表示该方案效果越好，取值范围为0～1。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8979608535766602', + ], + 'CroppingBoundary' => [ + 'description' => '裁剪框。', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '顶点Y坐标，距离顶端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '77', + ], + 'Width' => [ + 'description' => '裁剪框宽度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'Height' => [ + 'description' => '裁剪框高度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '499', + ], + 'Left' => [ + 'description' => '顶点X坐标，距离左端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'AspectRatio' => [ + 'description' => '图片裁剪比例列表。', + 'type' => 'string', + 'example' => '1:1', + ], + ], + ], + ], + 'Orientation' => [ + 'description' => '图片旋转值，从EXIF信息中获取。'."\n" + ."\n" + .'如果图片EXIF信息无此信息，则返回结果中无此参数。'."\n", + 'type' => 'string', + 'example' => '{"val":"Right-top","type":3}', + ], + 'RemarksD' => [ + 'description' => '标记信息。', + 'type' => 'string', + 'example' => 'remarkd', + ], + 'TagsStatus' => [ + 'description' => '标签识别的状态，包括如下选项：'."\n" + ."\n" + .'- NotProcessed：未处理'."\n" + .'- Processing：处理中'."\n" + .'- Success：成功'."\n" + .'- Failed：失败'."\n" + ."\n" + .'您可以根据该状态决定读取结果、等待或重试。', + 'type' => 'string', + 'example' => 'Success', + ], + 'CroppingSuggestionFailReason' => [ + 'description' => '裁剪建议提供失败的原因。'."\n" + ."\n" + .'只有当图片裁剪建议提供失败时，此参数才有值。', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'RemarksA' => [ + 'description' => '标记信息。', + 'type' => 'string', + 'example' => 'remarka', + ], + 'ImageUri' => [ + 'description' => '图片的OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + 'TagsModifyTime' => [ + 'description' => '标签识别的更新时间。当TagsStatus更改时更新。', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'OCRStatus' => [ + 'description' => 'OCR识别的状态，包括如下选项：'."\n" + ."\n" + .'- NotProcessed：未处理'."\n" + .'- Processing：处理中'."\n" + .'- Success：成功'."\n" + .'- Failed：失败'."\n" + ."\n" + .'您可以根据该状态决定读取结果、等待或重试。', + 'type' => 'string', + 'example' => 'NotProcessed', + ], + 'AddressStatus' => [ + 'description' => '图片地理位置检测的状态，包括如下选项：'."\n" + ."\n" + .'- NotProcessed：未处理'."\n" + .'- Processing：处理中'."\n" + .'- Success：成功'."\n" + .'- Failed：失败'."\n" + ."\n" + .'您可以根据该状态决定读取结果、等待或重试。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Exif' => [ + 'description' => '图片原始EXIF信息，以JSON Object序列化后的格式存储。', + 'type' => 'string', + 'example' => '{"FileSize":{"value":"29304"},"Format":{"value":"jpg"},"ImageHeight":{"value":"417"},"ImageWidth":{"value":"500"},"ResolutionUnit":{"value":"2"},"XResolution":{"value":"96/1"},"YResolution":{"value":"96/1"}}', + ], + 'Location' => [ + 'description' => '图片地理位置，从EXIF信息中获取，格式为`lat,long`，以英文逗号（,）分隔的浮点数。'."\n" + ."\n" + .'如果图片EXIF信息无此信息，则返回结果中无此参数。', + 'type' => 'string', + 'example' => '30.134390,120.074997', + ], + 'RemarksB' => [ + 'description' => '标记信息。', + 'type' => 'string', + 'example' => 'remarkb', + ], + ], + ], + ], + 'NextMarker' => [ + 'description' => '下一次列出图片信息时以此值为Marker，将未返回的结果返回。 '."\n" + ."\n" + .'当图片未全部返回时，此参数才有值。', + 'type' => 'string', + 'example' => 'CAESBgoEIgIIABgAIswBCskBA8QAAAAxUzMxMzczNDM2MzQzOTM1MzgzNTM3MzYzMDMyMzczNDM1M2E2OTZkNmQ2OTZkNjE2NzY1M2E3MzY1NzQzMDMwMzEzYTMxMzYzMzM1NjIzOTMzMzI2MTYyMzQzNzY2NjMzNjY2NjI2MTYxMzMzMjM1MzQzOTMzMzQzNzMwMzI2NTMxNjE2MjM3MzczMTY0NjM2NDM2MzgzNjM4NjQzMjM2MzEzNzM2MzYzNjM4NjUzNTYyMzc2NjM0MzU2MjYxNjE2NTMx', + ], + 'SetId' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'example' => 'set001', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"810FE908-522F-4951-8AF8-7211890D4B2A\\",\\n \\"Images\\": [\\n {\\n \\"CroppingSuggestionStatus\\": \\"NotProcessed\\",\\n \\"ImageQualityModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"TagsFailReason\\": \\"Timeout\\",\\n \\"RemarksC\\": \\"remarkc\\",\\n \\"CreateTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"SourceType\\": \\"image\\",\\n \\"FacesFailReason\\": \\"Timeout\\",\\n \\"Tags\\": [\\n {\\n \\"TagConfidence\\": 0.9812195897102356,\\n \\"CentricScore\\": 0,\\n \\"TagName\\": \\"脸\\",\\n \\"TagLevel\\": 2,\\n \\"ParentTagName\\": \\"人物\\"\\n }\\n ],\\n \\"FacesModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"ImageTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"OCRModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"AddressModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"OCR\\": [\\n {\\n \\"OCRConfidence\\": 0.8254936695098877,\\n \\"OCRContents\\": \\"欢迎使用智能媒体管理\\",\\n \\"OCRBoundary\\": {\\n \\"Top\\": 12,\\n \\"Width\\": 12,\\n \\"Height\\": 12,\\n \\"Left\\": 12\\n }\\n }\\n ],\\n \\"ImageQualityFailReason\\": \\"Timeout\\",\\n \\"FacesStatus\\": \\"Success\\",\\n \\"ImageHeight\\": 861,\\n \\"RemarksArrayA\\": \\"[\\\\\\"remarka1\\\\\\",\\\\\\"remarka2\\\\\\"]\\",\\n \\"Address\\": {\\n \\"Township\\": \\"转塘街道\\",\\n \\"District\\": \\"西湖区\\",\\n \\"AddressLine\\": \\"浙江省杭州市西湖区转塘街道石龙山西路\\",\\n \\"Country\\": \\"中国\\",\\n \\"City\\": \\"杭州市\\",\\n \\"Province\\": \\"浙江省\\"\\n },\\n \\"ExternalId\\": \\"externalId001\\",\\n \\"SourceUri\\": \\"oss://imm-test/testcases/face1.jpg\\",\\n \\"ModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"FileSize\\": 69732,\\n \\"SourcePosition\\": \\"00000000.010\\",\\n \\"Faces\\": [\\n {\\n \\"Gender\\": \\"FEMALE\\",\\n \\"FaceId\\": \\"59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51\\",\\n \\"GenderConfidence\\": 1,\\n \\"FaceAttributes\\": {\\n \\"GlassesConfidence\\": 1,\\n \\"Glasses\\": \\"NONE\\",\\n \\"Mask\\": \\"NONE\\",\\n \\"BeardConfidence\\": 1,\\n \\"MaskConfidence\\": 1,\\n \\"FaceBoundary\\": {\\n \\"Top\\": 152,\\n \\"Width\\": 139,\\n \\"Height\\": 141,\\n \\"Left\\": 267\\n },\\n \\"HeadPose\\": {\\n \\"Pitch\\": 18.385589599609375,\\n \\"Roll\\": 4.204030513763428,\\n \\"Yaw\\": 2.4945924282073975\\n },\\n \\"Beard\\": \\"NONE\\"\\n },\\n \\"FaceQuality\\": 0.9321779608726501,\\n \\"Emotion\\": \\"HAPPY\\",\\n \\"Age\\": 29,\\n \\"FaceConfidence\\": 0.9608758687973022,\\n \\"EmotionConfidence\\": 0.7079545259475708,\\n \\"Attractive\\": 0.96,\\n \\"GroupId\\": \\"group-not-grouped\\",\\n \\"EmotionDetails\\": {\\n \\"HAPPY\\": 0.7079545259475708,\\n \\"SURPRISED\\": 0.00006676767952740192,\\n \\"CALM\\": 0.2918718755245209,\\n \\"DISGUSTED\\": 0.000033771051676012576,\\n \\"ANGRY\\": 0.00001282201901631197,\\n \\"SAD\\": 0.00001527295717096422,\\n \\"SCARED\\": 0.0000014976058082538657\\n }\\n }\\n ],\\n \\"ImageQualityStatus\\": \\"Success\\",\\n \\"OCRFailReason\\": \\"Timeout\\",\\n \\"AddressFailReason\\": \\"Timeout\\",\\n \\"ImageQuality\\": {\\n \\"OverallScore\\": 0.7759467363357544,\\n \\"Color\\": 0.6101377010345459,\\n \\"ColorScore\\": 0.6101377010345459,\\n \\"ContrastScore\\": 0.6101377010345459,\\n \\"Contrast\\": 0.6101377010345459,\\n \\"ExposureScore\\": 0.6101377010345459,\\n \\"ClarityScore\\": 0.6101377010345459,\\n \\"Clarity\\": 0.6101377010345459,\\n \\"Exposure\\": 0.6101377010345459,\\n \\"CompositionScore\\": 0.6101377010345459\\n },\\n \\"CroppingSuggestionModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"ImageFormat\\": \\"jpg\\",\\n \\"ImageWidth\\": 500,\\n \\"RemarksArrayB\\": \\"[\\\\\\"remarkb1\\\\\\",\\\\\\"remarkb2\\\\\\"]\\",\\n \\"CroppingSuggestion\\": [\\n {\\n \\"Score\\": 0.8979608535766602,\\n \\"CroppingBoundary\\": {\\n \\"Top\\": 77,\\n \\"Width\\": 500,\\n \\"Height\\": 499,\\n \\"Left\\": 0\\n },\\n \\"AspectRatio\\": \\"1:1\\"\\n }\\n ],\\n \\"Orientation\\": \\"{\\\\\\"val\\\\\\":\\\\\\"Right-top\\\\\\",\\\\\\"type\\\\\\":3}\\",\\n \\"RemarksD\\": \\"remarkd\\",\\n \\"TagsStatus\\": \\"Success\\",\\n \\"CroppingSuggestionFailReason\\": \\"Timeout\\",\\n \\"RemarksA\\": \\"remarka\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/face1.jpg\\",\\n \\"TagsModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"OCRStatus\\": \\"NotProcessed\\",\\n \\"AddressStatus\\": \\"Success\\",\\n \\"Exif\\": \\"{\\\\\\"FileSize\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"29304\\\\\\"},\\\\\\"Format\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"jpg\\\\\\"},\\\\\\"ImageHeight\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"417\\\\\\"},\\\\\\"ImageWidth\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"500\\\\\\"},\\\\\\"ResolutionUnit\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2\\\\\\"},\\\\\\"XResolution\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"96/1\\\\\\"},\\\\\\"YResolution\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"96/1\\\\\\"}}\\",\\n \\"Location\\": \\"30.134390,120.074997\\",\\n \\"RemarksB\\": \\"remarkb\\"\\n }\\n ],\\n \\"NextMarker\\": \\"CAESBgoEIgIIABgAIswBCskBA8QAAAAxUzMxMzczNDM2MzQzOTM1MzgzNTM3MzYzMDMyMzczNDM1M2E2OTZkNmQ2OTZkNjE2NzY1M2E3MzY1NzQzMDMwMzEzYTMxMzYzMzM1NjIzOTMzMzI2MTYyMzQzNzY2NjMzNjY2NjI2MTYxMzMzMjM1MzQzOTMzMzQzNzMwMzI2NTMxNjE2MjM3MzczMTY0NjM2NDM2MzgzNjM4NjQzMjM2MzEzNzM2MzYzNjM4NjUzNTYyMzc2NjM0MzU2MjYxNjE2NTMx\\",\\n \\"SetId\\": \\"set001\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>810FE908-522F-4951-8AF8-7211890D4B2A</RequestId>\\n<Images>\\n <ModifyTime>2020-11-25T10:12:59.57Z</ModifyTime>\\n <SourceUri>oss://imm-test/testcases/face1.jpg</SourceUri>\\n <SourceType>image</SourceType>\\n <CroppingSuggestionStatus>NotProcessed</CroppingSuggestionStatus>\\n <AddressFailReason/>\\n <RemarksA>remarka</RemarksA>\\n <AddressModifyTime>2020-11-25T10:12:59.57Z</AddressModifyTime>\\n <RemarksB>remarkb</RemarksB>\\n <ImageFormat>jpg</ImageFormat>\\n <RemarksArrayB>[\\"remarkb1\\",\\"remarkb2\\"]</RemarksArrayB>\\n <TagsFailReason/>\\n <Exif>{\\"FileSize\\":{\\"value\\":\\"29304\\"},\\"Format\\":{\\"value\\":\\"jpg\\"},\\"ImageHeight\\":{\\"value\\":\\"417\\"},\\"ImageWidth\\":{\\"value\\":\\"500\\"},\\"ResolutionUnit\\":{\\"value\\":\\"2\\"},\\"XResolution\\":{\\"value\\":\\"96/1\\"},\\"YResolution\\":{\\"value\\":\\"96/1\\"}}</Exif>\\n <FacesModifyTime>2020-11-25T10:12:59.57Z</FacesModifyTime>\\n <RemarksC>remarkc</RemarksC>\\n <RemarksD>remarkd</RemarksD>\\n <ImageWidth>500</ImageWidth>\\n <RemarksArrayA>[\\"remarka1\\",\\"remarka2\\"]</RemarksArrayA>\\n <AddressStatus>Success</AddressStatus>\\n <FacesStatus>Success</FacesStatus>\\n <ImageQualityModifyTime>2020-11-25T10:12:59.57Z</ImageQualityModifyTime>\\n <ExternalId>externalId001</ExternalId>\\n <TagsModifyTime>2020-11-25T10:12:59.57Z</TagsModifyTime>\\n <CreateTime>2020-11-25T10:12:59.57Z</CreateTime>\\n <ImageQualityFailReason/>\\n <ImageUri>oss://imm-test/testcases/face1.jpg</ImageUri>\\n <OCRStatus>NotProcessed</OCRStatus>\\n <CroppingSuggestionModifyTime/>\\n <ImageQualityStatus>Success</ImageQualityStatus>\\n <TagsStatus>Success</TagsStatus>\\n <ImageHeight>861</ImageHeight>\\n <Location>30.134390,120.074997</Location>\\n <FileSize>69732</FileSize>\\n</Images>\\n<Images>\\n <Faces>\\n <FaceId>59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51</FaceId>\\n <FaceConfidence>0.9608758687973022</FaceConfidence>\\n <FaceQuality>0.9321779608726501</FaceQuality>\\n <Attractive>0.96</Attractive>\\n <GenderConfidence>1</GenderConfidence>\\n <EmotionConfidence>0.7079545259475708</EmotionConfidence>\\n <Emotion>HAPPY</Emotion>\\n <Gender>MALE</Gender>\\n <Age>29</Age>\\n <GroupId>group-not-grouped</GroupId>\\n </Faces>\\n <Faces>\\n <EmotionDetails>\\n <CALM>0.2918718755245209</CALM>\\n <SCARED>0.0000014976058082538657</SCARED>\\n <HAPPY>0.7079545259475708</HAPPY>\\n <SURPRISED>0.00006676767952740192</SURPRISED>\\n <SAD>0.00001527295717096422</SAD>\\n <DISGUSTED>0.000033771051676012576</DISGUSTED>\\n <ANGRY>0.00001282201901631197</ANGRY>\\n </EmotionDetails>\\n <FaceAttributes>\\n <Beard>NONE</Beard>\\n <FaceBoundary>\\n <Left>267</Left>\\n <Top>152</Top>\\n <Height>141</Height>\\n <Width>139</Width>\\n </FaceBoundary>\\n <BeardConfidence>1</BeardConfidence>\\n <HeadPose>\\n <Pitch>18.385589599609375</Pitch>\\n <Roll>4.204030513763428</Roll>\\n <Yaw>2.4945924282073975</Yaw>\\n </HeadPose>\\n <Mask>NONE</Mask>\\n <MaskConfidence>1</MaskConfidence>\\n <Glasses>NONE</Glasses>\\n <GlassesConfidence>1</GlassesConfidence>\\n </FaceAttributes>\\n </Faces>\\n <Tags>\\n <TagConfidence>0.7254936695098877</TagConfidence>\\n <TagName>脸</TagName>\\n <TagLevel>2</TagLevel>\\n <ParentTagName>人物</ParentTagName>\\n </Tags>\\n <Tags>\\n <TagConfidence>0.7254936695098877</TagConfidence>\\n <TagName>人物</TagName>\\n <TagLevel>1</TagLevel>\\n </Tags>\\n <Tags>\\n <TagConfidence>0.6851575970649719</TagConfidence>\\n <TagName>微笑</TagName>\\n <TagLevel>3</TagLevel>\\n <ParentTagName>日常行为</ParentTagName>\\n </Tags>\\n <Tags>\\n <TagConfidence>0.6851575970649719</TagConfidence>\\n <TagName>日常行为</TagName>\\n <TagLevel>2</TagLevel>\\n <ParentTagName>生活</ParentTagName>\\n </Tags>\\n <Tags>\\n <TagConfidence>0.6851575970649719</TagConfidence>\\n <TagName>生活</TagName>\\n <TagLevel>1</TagLevel>\\n </Tags>\\n</Images>\\n<Images>\\n <ImageQuality>\\n <OverallScore>0.7759467363357544</OverallScore>\\n </ImageQuality>\\n <Address>\\n <Township>转塘街道</Township>\\n <AddressLine>杭州市西湖区转塘街道石龙山西路</AddressLine>\\n <Country>中国</Country>\\n <City>杭州市</City>\\n <District>西湖区</District>\\n <Province>浙江省</Province>\\n </Address>\\n</Images>\\n<NextMarker>CAESBgoEIgIIABgAIswBCskBA8QAAAAxUzMxMzczNDM2MzQzOTM1MzgzNTM3MzYzMDMyMzczNDM1M2E2OTZkNmQ2OTZkNjE2NzY1M2E3MzY1NzQzMDMwMzEzYTMxMzYzMzM1NjIzOTMzMzI2MTYyMzQzNzY2NjMzNjY2NjI2MTYxMzMzMjM1MzQzOTMzMzQzNzMwMzI2NTMxNjE2MjM3MzczMTY0NjM2NDM2MzgzNjM4NjQzMjM2MzEzNzM2MzYzNjM4NjUzNTYyMzc2NjM0MzU2MjYxNjE2NTMx</NextMarker>\\n<SetId>set001</SetId>","errorExample":""}]', + 'title' => '搜索媒体集中图片', + 'summary' => '调用FindImages接口根据指定条件，例如时间、地点、标签、人物特征等，搜索媒体集中图片。并可以按照给定要求进行排序。', + 'description' => '- 此接口已不再维护，建议使用新版（2020-09-30版本）[查询与统计](~~2402363~~)相关接口。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + .'- 搜索结果依赖索引的建立，返回结果与实际值可能有数秒的数据延迟。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListImages' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'set001', + ], + ], + [ + 'name' => 'CreateTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '图片创建时间的起始点，返回的图片均在此时间后加入媒体集。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2020-11-23T07:49:01.975Z', + ], + ], + [ + 'name' => 'Marker', + 'in' => 'query', + 'schema' => [ + 'description' => '从Marker开始按字典序返回图片信息列表。如果不设置此参数，则从头开始返回图片。', + 'type' => 'string', + 'required' => false, + 'example' => 'image', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '返回图片的最大数量，默认值为20，取值范围为1~100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'A9C250B8-AC5B-4570-A7FE-73448DFCEFC8', + ], + 'Images' => [ + 'description' => '图片信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CroppingSuggestionStatus' => [ + 'description' => '提供裁剪建议的状态，包括如下选项：'."\n" + ."\n" + .'- NotProcessed：未处理'."\n" + .'- Processing：处理中'."\n" + .'- Success：成功'."\n" + .'- Failed：失败'."\n" + ."\n" + .'您可以根据该状态决定读取结果、等待或重试。', + 'type' => 'string', + 'example' => 'NotProcessed', + ], + 'ImageQualityModifyTime' => [ + 'description' => '图片质量打分的更新时间。', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'TagsFailReason' => [ + 'description' => '标签识别的失败原因。格式为`[HTTPStatusCode ErrorCode] ErrorMessage`，例如`[400 InvalidResource] Specified resource is too large. Please check.`'."\n" + ."\n" + .'只有当标签识别失败时，此参数才有值。'."\n", + 'type' => 'string', + 'example' => 'Timeout', + ], + 'RemarksC' => [ + 'description' => '标记信息。', + 'type' => 'string', + 'example' => 'remarkc', + ], + 'CreateTime' => [ + 'description' => '图片加入媒体集的时间。', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'SourceType' => [ + 'description' => '源数据的类型。', + 'type' => 'string', + 'example' => 'image', + ], + 'FacesFailReason' => [ + 'description' => '人脸识别的失败原因。'."\n" + ."\n" + .'只有当人脸识别失败时，此参数才有值。', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'Tags' => [ + 'description' => '标签识别结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagConfidence' => [ + 'description' => '标签置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9812195897102356', + ], + 'CentricScore' => [ + 'description' => '标签主体分数。用于提示该标签内容在图片中的主要程度，越高则说明该标签越可能为图片主体。取值范围为0~1。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'TagName' => [ + 'description' => '标签名称。', + 'type' => 'string', + 'example' => '脸', + ], + 'TagLevel' => [ + 'description' => '标签级别，取值范围为1~4。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ParentTagName' => [ + 'description' => '父级标签名称。', + 'type' => 'string', + 'example' => '人物', + ], + ], + ], + ], + 'FacesModifyTime' => [ + 'description' => '人脸识别的更新时间。', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'ImageTime' => [ + 'description' => '图片的拍摄日期，该日期从EXIF信息中获取。'."\n" + ."\n" + .'如果图片EXIF信息无此信息，则返回结果中无此参数。', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'OCRModifyTime' => [ + 'description' => 'OCR识别的更新时间。', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'AddressModifyTime' => [ + 'description' => '图片地理位置检测的更新时间。', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'OCR' => [ + 'description' => 'OCR识别结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OCRConfidence' => [ + 'description' => '文字置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8254936695098877', + ], + 'OCRContents' => [ + 'description' => '文字内容。', + 'type' => 'string', + 'example' => '欢迎使用智能媒体管理', + ], + 'OCRBoundary' => [ + 'description' => '文字位置框信息。', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '顶点Y坐标，距离顶端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Width' => [ + 'description' => '文字位置框宽度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Height' => [ + 'description' => '文字位置框高度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Left' => [ + 'description' => '顶点X坐标，距离左端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + ], + ], + ], + ], + ], + 'ImageQualityFailReason' => [ + 'description' => '图片质量打分的失败原因。', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'FacesStatus' => [ + 'description' => '人脸识别的状态，包括如下选项：'."\n" + ."\n" + .'- NotProcessed：未处理'."\n" + .'- Processing：处理中'."\n" + .'- Success：成功'."\n" + .'- Failed：失败'."\n" + ."\n" + .'您可以根据该状态决定读取结果、等待或重试。', + 'type' => 'string', + 'example' => 'Success', + ], + 'ImageHeight' => [ + 'description' => '图片高度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '861', + ], + 'RemarksArrayA' => [ + 'description' => '标记信息列表。', + 'type' => 'string', + 'example' => '["remarka1","remarka2"]', + ], + 'Address' => [ + 'description' => '图片地理位置检测结果。'."\n" + ."\n" + .'只有图片中包含地理位置信息时，检测结果才有值。', + 'type' => 'object', + 'properties' => [ + 'Township' => [ + 'description' => '图片地理位置所在街道（或同级）。', + 'type' => 'string', + 'example' => '转塘街道', + ], + 'District' => [ + 'description' => '图片地理位置所在区（或同级）。', + 'type' => 'string', + 'example' => '西湖区', + ], + 'AddressLine' => [ + 'description' => '图片地理位置的完整地址。', + 'type' => 'string', + 'example' => '浙江省杭州市西湖区转塘街道石龙山西路', + ], + 'Country' => [ + 'description' => '图片地理位置所在国家或地区。', + 'type' => 'string', + 'example' => '中国', + ], + 'City' => [ + 'description' => '图片地理位置所在城市（或同级）。', + 'type' => 'string', + 'example' => '杭州市', + ], + 'Province' => [ + 'description' => '图片地理位置所在省（或同级）。', + 'type' => 'string', + 'example' => '浙江省', + ], + ], + ], + 'ExternalId' => [ + 'description' => '外部ID，用于和您的应用层的ID（如果有）进行绑定。', + 'type' => 'string', + 'example' => 'externalId001', + ], + 'SourceUri' => [ + 'description' => '图片OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + 'ModifyTime' => [ + 'description' => '图片的修改时间。'."\n" + ."\n" + .'添加图片后，如果未修改过图片，则图片的修改时间和图片的创建时间相同。', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'FileSize' => [ + 'description' => '文件大小，单位为字节。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '69732', + ], + 'SourcePosition' => [ + 'description' => '只有当SourceType为video时，此参数才生效。'."\n" + ."\n" + .'视频中该图片帧处于源视频的时间轴位置。格式为`00000000.010`，即%8.3f。', + 'type' => 'string', + 'example' => '00000000.010', + ], + 'Faces' => [ + 'description' => '人脸识别结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Gender' => [ + 'description' => '性别，可选项包括MALE和FEMALE。', + 'type' => 'string', + 'example' => 'MALE', + ], + 'FaceId' => [ + 'description' => '人脸ID。', + 'type' => 'string', + 'example' => '59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51', + ], + 'GenderConfidence' => [ + 'description' => '性别置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'FaceAttributes' => [ + 'description' => '人脸其他属性。', + 'type' => 'object', + 'properties' => [ + 'GlassesConfidence' => [ + 'description' => '是否戴眼镜置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Glasses' => [ + 'description' => '是否带眼镜。', + 'type' => 'string', + 'example' => 'NONE', + ], + 'Mask' => [ + 'description' => '是否带口罩。', + 'type' => 'string', + 'example' => 'NONE', + ], + 'BeardConfidence' => [ + 'description' => '是否有胡子置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'MaskConfidence' => [ + 'description' => '是否带口罩置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'FaceBoundary' => [ + 'description' => '人脸框信息。', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '顶点Y坐标，距离顶端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '191', + ], + 'Width' => [ + 'description' => '人脸框宽度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '269', + ], + 'Height' => [ + 'description' => '人脸框高度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '252', + ], + 'Left' => [ + 'description' => '顶点X坐标，距离左端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '95', + ], + ], + ], + 'HeadPose' => [ + 'description' => '头部朝向。', + 'type' => 'object', + 'properties' => [ + 'Pitch' => [ + 'description' => '人脸的俯仰角，取值范围为`-180～+180`度，可信的范围建议为`-30～+30`度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '18.385589599609375', + ], + 'Roll' => [ + 'description' => '面内偏转角，取值范围为`-180～+180`度，可信的建议范围为`-45～+45`度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '4.204030513763428', + ], + 'Yaw' => [ + 'description' => '人脸的左右偏转角，取值范围为`-180～+180`度，可信的范围建议为`-80～+80`度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '2.4945924282073975', + ], + ], + ], + 'Beard' => [ + 'description' => '是否有胡子。', + 'type' => 'string', + 'example' => 'NONE', + ], + ], + ], + 'FaceQuality' => [ + 'description' => '人脸质量。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9321779608726501', + ], + 'Emotion' => [ + 'description' => '心情。', + 'type' => 'string', + 'example' => 'HAPPY', + ], + 'Age' => [ + 'description' => '年龄。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '29', + ], + 'FaceConfidence' => [ + 'description' => '人脸置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9608758687973022', + ], + 'EmotionConfidence' => [ + 'description' => '心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7079545259475708', + ], + 'Attractive' => [ + 'description' => '人脸吸引力，分数越高吸引力越强，取值范围为0~1。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.96', + ], + 'GroupId' => [ + 'description' => '人脸分组ID。如果人脸未分组，则此参数返回值为group-not-grouped。', + 'type' => 'string', + 'example' => 'group-not-grouped', + ], + 'EmotionDetails' => [ + 'description' => '七种心情对应的置信度。', + 'type' => 'object', + 'properties' => [ + 'HAPPY' => [ + 'description' => 'HAPPY心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7079545259475708', + ], + 'SURPRISED' => [ + 'description' => 'SURPRISED心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.00006676767952740192', + ], + 'CALM' => [ + 'description' => 'CALM心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.2918718755245209', + ], + 'DISGUSTED' => [ + 'description' => 'DISGUSTED心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.000033771051676012576', + ], + 'ANGRY' => [ + 'description' => 'ANGRY心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.00001282201901631197', + ], + 'SAD' => [ + 'description' => 'SAD心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.00001527295717096422', + ], + 'SCARED' => [ + 'description' => 'SCARED心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0000014976058082538657', + ], + ], + ], + ], + ], + ], + 'ImageQualityStatus' => [ + 'description' => '图片质量打分状态，包括如下选项：'."\n" + ."\n" + .'- NotProcessed：未处理'."\n" + .'- Processing：处理中'."\n" + .'- Success：成功'."\n" + .'- Failed：失败'."\n" + ."\n" + .'您可以根据该状态决定读取结果、等待或重试。', + 'type' => 'string', + 'example' => 'Success', + ], + 'OCRFailReason' => [ + 'description' => 'OCR识别的失败原因。', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'AddressFailReason' => [ + 'description' => '图片地理位置检测的失败原因。'."\n" + ."\n" + .'只有当图片地理位置检测失败时，此参数才有值。', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'ImageQuality' => [ + 'description' => '图片质量分数。', + 'type' => 'object', + 'properties' => [ + 'OverallScore' => [ + 'description' => '综合质量分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7759467363357544', + ], + 'Color' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片色度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ColorScore' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片色度的分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ContrastScore' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片对比度的分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'Contrast' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片对比度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ExposureScore' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片曝光程度的分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ClarityScore' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片清晰度的分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'Clarity' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片清晰度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'Exposure' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片曝光程度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'CompositionScore' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片构成的分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + ], + ], + 'CroppingSuggestionModifyTime' => [ + 'description' => '提供最新裁剪建议的时间。', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'ImageFormat' => [ + 'description' => '图片格式。', + 'type' => 'string', + 'example' => 'jpg', + ], + 'ImageWidth' => [ + 'description' => '图片宽度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'RemarksArrayB' => [ + 'description' => '标记信息列表。', + 'type' => 'string', + 'example' => '["remarkb1","remarkb2"]', + ], + 'CroppingSuggestion' => [ + 'description' => '图片的裁减建议。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Score' => [ + 'description' => '该裁剪方案的美学分数，分数越高表示该方案效果越好，取值范围为0～1。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8812195897102356', + ], + 'CroppingBoundary' => [ + 'description' => '裁剪框信息。', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '顶点Y坐标，距离顶端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '70', + ], + 'Width' => [ + 'description' => '裁剪框宽度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Height' => [ + 'description' => '裁剪框高度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Left' => [ + 'description' => '顶点X坐标，距离左端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'AspectRatio' => [ + 'description' => '图片裁剪比例。', + 'type' => 'string', + 'example' => '1:1', + ], + ], + ], + ], + 'Orientation' => [ + 'description' => '图片旋转值，从EXIF信息中获取。'."\n" + ."\n" + .'如果图片EXIF信息无此信息，则返回结果中无此参数。'."\n", + 'type' => 'string', + 'example' => '{"val":"Right-top","type":3}', + ], + 'RemarksD' => [ + 'description' => '标记信息。', + 'type' => 'string', + 'example' => 'remarkd', + ], + 'TagsStatus' => [ + 'description' => '标签识别的状态，包括如下选项：'."\n" + ."\n" + .'- NotProcessed：未处理'."\n" + .'- Processing：处理中'."\n" + .'- Success：成功'."\n" + .'- Failed：失败'."\n" + ."\n" + .'您可以根据该状态决定读取结果、等待或重试。', + 'type' => 'string', + 'example' => 'Success', + ], + 'CroppingSuggestionFailReason' => [ + 'description' => '裁剪建议提供失败的原因。'."\n" + ."\n" + .'只有当图片裁剪建议提供失败时，此参数才有值。', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'RemarksA' => [ + 'description' => '标记信息列表。', + 'type' => 'string', + 'example' => 'remarka', + ], + 'ImageUri' => [ + 'description' => '图片的OSS URI。'."\n", + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + 'TagsModifyTime' => [ + 'description' => '标签识别的更新时间。当TagsStatus更改时更新。', + 'type' => 'string', + 'example' => '2020-11-25T10:12:59.57Z', + ], + 'OCRStatus' => [ + 'description' => 'OCR识别的状态，包括如下选项：'."\n" + ."\n" + .'- NotProcessed：未处理'."\n" + .'- Processing：处理中'."\n" + .'- Success：成功'."\n" + .'- Failed：失败'."\n" + ."\n" + .'您可以根据该状态决定读取结果、等待或重试。', + 'type' => 'string', + 'example' => 'NotProcessed', + ], + 'AddressStatus' => [ + 'description' => '图片地理位置检测的状态，包括如下选项：'."\n" + ."\n" + .'- NotProcessed：未处理'."\n" + .'- Processing：处理中'."\n" + .'- Success：成功'."\n" + .'- Failed：失败'."\n" + ."\n" + .'您可以根据该状态决定读取结果、等待或重试。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Exif' => [ + 'description' => '图片原始EXIF信息，以JSON Object序列化后的格式存储。', + 'type' => 'string', + 'example' => '{"FileSize":{"value":"29304"},"Format":{"value":"jpg"},"ImageHeight":{"value":"417"},"ImageWidth":{"value":"500"},"ResolutionUnit":{"value":"2"},"XResolution":{"value":"96/1"},"YResolution":{"value":"96/1"}}', + ], + 'Location' => [ + 'description' => '图片地理位置，从EXIF信息中获取，格式为`lat,long`，以英文逗号（,）分隔的浮点数。'."\n" + ."\n" + .'如果图片EXIF信息无此信息，则返回结果中无此参数。'."\n", + 'type' => 'string', + 'example' => '30.134390,120.074997', + ], + 'RemarksB' => [ + 'description' => '标记信息。', + 'type' => 'string', + 'example' => 'remarkb', + ], + ], + ], + ], + 'NextMarker' => [ + 'description' => '下一次列出图片信息时以此值为Marker，将未返回的结果返回。'."\n" + ."\n" + .'当图片未全部返回时，此参数才有值。', + 'type' => 'string', + 'example' => 'CAESEgoQCg4KCkNyZWF0ZVRpbWUQABgBItcBCgkAIUv1J88rSRYKyQEDxAAAADFTMzEzNzM0MzYzNDM5MzUzODM1MzczNjMwMzIzNzM0MzUzYTY5NmQ2ZDY5NmQ2MTY3NjUzYTczNjU3NDMwMzAzMTNhMzc2NTY1NjM2NTMyMzQzNjYyMzUzMjM3MzgzODMwMzA2MzM4NjE2NDM4NjQ2MzY2NjE2MTMxNjMzNDMxNjY2MTY0MzEzODM0NjMzOTMzNjQ2MTM2MzUzMjY2NjYzMjMzNjUzNzM1NjUzNzM3MzM2MTY0MzEzMTM2MzYzMTM4Mzk=', + ], + 'SetId' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'example' => 'set001', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A9C250B8-AC5B-4570-A7FE-73448DFCEFC8\\",\\n \\"Images\\": [\\n {\\n \\"CroppingSuggestionStatus\\": \\"NotProcessed\\",\\n \\"ImageQualityModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"TagsFailReason\\": \\"Timeout\\",\\n \\"RemarksC\\": \\"remarkc\\",\\n \\"CreateTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"SourceType\\": \\"image\\",\\n \\"FacesFailReason\\": \\"Timeout\\",\\n \\"Tags\\": [\\n {\\n \\"TagConfidence\\": 0.9812195897102356,\\n \\"CentricScore\\": 0,\\n \\"TagName\\": \\"脸\\",\\n \\"TagLevel\\": 1,\\n \\"ParentTagName\\": \\"人物\\"\\n }\\n ],\\n \\"FacesModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"ImageTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"OCRModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"AddressModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"OCR\\": [\\n {\\n \\"OCRConfidence\\": 0.8254936695098877,\\n \\"OCRContents\\": \\"欢迎使用智能媒体管理\\",\\n \\"OCRBoundary\\": {\\n \\"Top\\": 12,\\n \\"Width\\": 12,\\n \\"Height\\": 12,\\n \\"Left\\": 12\\n }\\n }\\n ],\\n \\"ImageQualityFailReason\\": \\"Timeout\\",\\n \\"FacesStatus\\": \\"Success\\",\\n \\"ImageHeight\\": 861,\\n \\"RemarksArrayA\\": \\"[\\\\\\"remarka1\\\\\\",\\\\\\"remarka2\\\\\\"]\\",\\n \\"Address\\": {\\n \\"Township\\": \\"转塘街道\\",\\n \\"District\\": \\"西湖区\\",\\n \\"AddressLine\\": \\"浙江省杭州市西湖区转塘街道石龙山西路\\",\\n \\"Country\\": \\"中国\\",\\n \\"City\\": \\"杭州市\\",\\n \\"Province\\": \\"浙江省\\"\\n },\\n \\"ExternalId\\": \\"externalId001\\",\\n \\"SourceUri\\": \\"oss://imm-test/testcases/face1.jpg\\",\\n \\"ModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"FileSize\\": 69732,\\n \\"SourcePosition\\": \\"00000000.010\\",\\n \\"Faces\\": [\\n {\\n \\"Gender\\": \\"MALE\\",\\n \\"FaceId\\": \\"59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51\\",\\n \\"GenderConfidence\\": 1,\\n \\"FaceAttributes\\": {\\n \\"GlassesConfidence\\": 1,\\n \\"Glasses\\": \\"NONE\\",\\n \\"Mask\\": \\"NONE\\",\\n \\"BeardConfidence\\": 1,\\n \\"MaskConfidence\\": 1,\\n \\"FaceBoundary\\": {\\n \\"Top\\": 191,\\n \\"Width\\": 269,\\n \\"Height\\": 252,\\n \\"Left\\": 95\\n },\\n \\"HeadPose\\": {\\n \\"Pitch\\": 18.385589599609375,\\n \\"Roll\\": 4.204030513763428,\\n \\"Yaw\\": 2.4945924282073975\\n },\\n \\"Beard\\": \\"NONE\\"\\n },\\n \\"FaceQuality\\": 0.9321779608726501,\\n \\"Emotion\\": \\"HAPPY\\",\\n \\"Age\\": 29,\\n \\"FaceConfidence\\": 0.9608758687973022,\\n \\"EmotionConfidence\\": 0.7079545259475708,\\n \\"Attractive\\": 0.96,\\n \\"GroupId\\": \\"group-not-grouped\\",\\n \\"EmotionDetails\\": {\\n \\"HAPPY\\": 0.7079545259475708,\\n \\"SURPRISED\\": 0.00006676767952740192,\\n \\"CALM\\": 0.2918718755245209,\\n \\"DISGUSTED\\": 0.000033771051676012576,\\n \\"ANGRY\\": 0.00001282201901631197,\\n \\"SAD\\": 0.00001527295717096422,\\n \\"SCARED\\": 0.0000014976058082538657\\n }\\n }\\n ],\\n \\"ImageQualityStatus\\": \\"Success\\",\\n \\"OCRFailReason\\": \\"Timeout\\",\\n \\"AddressFailReason\\": \\"Timeout\\",\\n \\"ImageQuality\\": {\\n \\"OverallScore\\": 0.7759467363357544,\\n \\"Color\\": 0.6101377010345459,\\n \\"ColorScore\\": 0.6101377010345459,\\n \\"ContrastScore\\": 0.6101377010345459,\\n \\"Contrast\\": 0.6101377010345459,\\n \\"ExposureScore\\": 0.6101377010345459,\\n \\"ClarityScore\\": 0.6101377010345459,\\n \\"Clarity\\": 0.6101377010345459,\\n \\"Exposure\\": 0.6101377010345459,\\n \\"CompositionScore\\": 0.6101377010345459\\n },\\n \\"CroppingSuggestionModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"ImageFormat\\": \\"jpg\\",\\n \\"ImageWidth\\": 500,\\n \\"RemarksArrayB\\": \\"[\\\\\\"remarkb1\\\\\\",\\\\\\"remarkb2\\\\\\"]\\",\\n \\"CroppingSuggestion\\": [\\n {\\n \\"Score\\": 0.8812195897102356,\\n \\"CroppingBoundary\\": {\\n \\"Top\\": 70,\\n \\"Width\\": 200,\\n \\"Height\\": 200,\\n \\"Left\\": 10\\n },\\n \\"AspectRatio\\": \\"1:1\\"\\n }\\n ],\\n \\"Orientation\\": \\"{\\\\\\"val\\\\\\":\\\\\\"Right-top\\\\\\",\\\\\\"type\\\\\\":3}\\",\\n \\"RemarksD\\": \\"remarkd\\",\\n \\"TagsStatus\\": \\"Success\\",\\n \\"CroppingSuggestionFailReason\\": \\"Timeout\\",\\n \\"RemarksA\\": \\"remarka\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/face1.jpg\\",\\n \\"TagsModifyTime\\": \\"2020-11-25T10:12:59.57Z\\",\\n \\"OCRStatus\\": \\"NotProcessed\\",\\n \\"AddressStatus\\": \\"Success\\",\\n \\"Exif\\": \\"{\\\\\\"FileSize\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"29304\\\\\\"},\\\\\\"Format\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"jpg\\\\\\"},\\\\\\"ImageHeight\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"417\\\\\\"},\\\\\\"ImageWidth\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"500\\\\\\"},\\\\\\"ResolutionUnit\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2\\\\\\"},\\\\\\"XResolution\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"96/1\\\\\\"},\\\\\\"YResolution\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"96/1\\\\\\"}}\\",\\n \\"Location\\": \\"30.134390,120.074997\\",\\n \\"RemarksB\\": \\"remarkb\\"\\n }\\n ],\\n \\"NextMarker\\": \\"CAESEgoQCg4KCkNyZWF0ZVRpbWUQABgBItcBCgkAIUv1J88rSRYKyQEDxAAAADFTMzEzNzM0MzYzNDM5MzUzODM1MzczNjMwMzIzNzM0MzUzYTY5NmQ2ZDY5NmQ2MTY3NjUzYTczNjU3NDMwMzAzMTNhMzc2NTY1NjM2NTMyMzQzNjYyMzUzMjM3MzgzODMwMzA2MzM4NjE2NDM4NjQ2MzY2NjE2MTMxNjMzNDMxNjY2MTY0MzEzODM0NjMzOTMzNjQ2MTM2MzUzMjY2NjYzMjMzNjUzNzM1NjUzNzM3MzM2MTY0MzEzMTM2MzYzMTM4Mzk=\\",\\n \\"SetId\\": \\"set001\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>A9C250B8-AC5B-4570-A7FE-73448DFCEFC8</RequestId>\\n<Images>\\n <ImageQuality>\\n <OverallScore>0.7759467363357544</OverallScore>\\n </ImageQuality>\\n <ModifyTime>2020-11-25T10:12:59.57Z</ModifyTime>\\n <Address>\\n <Township>转塘街道</Township>\\n <AddressLine>中国浙江省杭州市西湖区转塘街道石龙山西路</AddressLine>\\n <Country>中国</Country>\\n <City>杭州市</City>\\n <District>西湖区</District>\\n <Province>浙江省</Province>\\n </Address>\\n <SourceUri>oss://imm-test/testcases/face1.jpg</SourceUri>\\n <SourceType>image</SourceType>\\n <FacesFailReason/>\\n <CroppingSuggestionStatus>NotProcessed</CroppingSuggestionStatus>\\n <AddressFailReason/>\\n <RemarksA>remarka</RemarksA>\\n <AddressModifyTime>2020-11-25T10:12:59.57Z</AddressModifyTime>\\n <RemarksB>remarkb</RemarksB>\\n <ImageFormat>jpg</ImageFormat>\\n <RemarksArrayB>[\\"remarkb1\\",\\"remarkb2\\"]</RemarksArrayB>\\n <TagsFailReason/>\\n <Exif>{\\"FileSize\\":{\\"value\\":\\"29304\\"},\\"Format\\":{\\"value\\":\\"jpg\\"},\\"ImageHeight\\":{\\"value\\":\\"417\\"},\\"ImageWidth\\":{\\"value\\":\\"500\\"},\\"ResolutionUnit\\":{\\"value\\":\\"2\\"},\\"XResolution\\":{\\"value\\":\\"96/1\\"},\\"YResolution\\":{\\"value\\":\\"96/1\\"}}</Exif>\\n <FacesModifyTime>2020-11-25T10:12:59.57Z</FacesModifyTime>\\n <RemarksC>remarkc</RemarksC>\\n <RemarksD>remarkd</RemarksD>\\n <ImageWidth>500</ImageWidth>\\n <RemarksArrayA>[\\"remarka1\\",\\"remarka2\\"]</RemarksArrayA>\\n <Faces>\\n <FaceConfidence>0.9608758687973022</FaceConfidence>\\n <FaceId>59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51</FaceId>\\n <EmotionDetails>\\n <CALM>0.2918718755245209</CALM>\\n <SCARED>0.0000014976058082538657</SCARED>\\n <HAPPY>0.7079545259475708</HAPPY>\\n <SAD>0.00001527295717096422</SAD>\\n <SURPRISED>0.00006676767952740192</SURPRISED>\\n <ANGRY>0.00001282201901631197</ANGRY>\\n <DISGUSTED>0.000033771051676012576</DISGUSTED>\\n </EmotionDetails>\\n <Attractive>0.96</Attractive>\\n <FaceQuality>0.9321779608726501</FaceQuality>\\n <FaceAttributes>\\n <Beard>NONE</Beard>\\n <FaceBoundary>\\n <Left>95</Left>\\n <Top>191</Top>\\n <Height>252</Height>\\n <Width>269</Width>\\n </FaceBoundary>\\n <BeardConfidence>1</BeardConfidence>\\n <HeadPose>\\n <Pitch>18.385589599609375</Pitch>\\n <Roll>4.204030513763428</Roll>\\n <Yaw>2.4945924282073975</Yaw>\\n </HeadPose>\\n <Glasses>NONE</Glasses>\\n <MaskConfidence>1</MaskConfidence>\\n <Mask>NONE</Mask>\\n <GlassesConfidence>1</GlassesConfidence>\\n </FaceAttributes>\\n <GenderConfidence>1</GenderConfidence>\\n <EmotionConfidence>0.7079545259475708</EmotionConfidence>\\n <Gender>FEMALE</Gender>\\n <Emotion>HAPPY</Emotion>\\n <Age>29</Age>\\n <GroupId>group-not-grouped</GroupId>\\n </Faces>\\n <Tags>\\n <TagConfidence>0.9812195897102356</TagConfidence>\\n <TagName>脸</TagName>\\n <TagLevel>2</TagLevel>\\n <ParentTagName>人物</ParentTagName>\\n </Tags>\\n <Tags>\\n <TagConfidence>0.9812195897102356</TagConfidence>\\n <TagName>人物</TagName>\\n <TagLevel>1</TagLevel>\\n </Tags>\\n <Tags>\\n <TagConfidence>0.7626392841339111</TagConfidence>\\n <TagName>微笑</TagName>\\n <TagLevel>3</TagLevel>\\n <ParentTagName>日常行为</ParentTagName>\\n </Tags>\\n <Tags>\\n <TagConfidence>0.7626392841339111</TagConfidence>\\n <TagName>日常行为</TagName>\\n <TagLevel>2</TagLevel>\\n <ParentTagName>生活</ParentTagName>\\n </Tags>\\n <Tags>\\n <TagConfidence>0.7626392841339111</TagConfidence>\\n <TagName>生活</TagName>\\n <TagLevel>1</TagLevel>\\n </Tags>\\n <AddressStatus>Success</AddressStatus>\\n <FacesStatus>Success</FacesStatus>\\n <ImageQualityModifyTime>2020-11-25T10:12:59.57Z</ImageQualityModifyTime>\\n <ExternalId>externalId001</ExternalId>\\n <TagsModifyTime>2020-11-25T10:12:59.57Z</TagsModifyTime>\\n <CreateTime>2020-11-25T10:12:59.57Z</CreateTime>\\n <ImageQualityFailReason/>\\n <Orientation/>\\n <ImageUri>oss://imm-test/testcases/face1.jpg</ImageUri>\\n <OCRStatus>NotProcessed</OCRStatus>\\n <OCRModifyTime/>\\n <CroppingSuggestionModifyTime/>\\n <ImageQualityStatus>Success</ImageQualityStatus>\\n <TagsStatus>Success</TagsStatus>\\n <ImageHeight>861</ImageHeight>\\n <OCRFailReason/>\\n <Location>30.134390,120.074997</Location>\\n <FileSize>69732</FileSize>\\n</Images>\\n<NextMarker>CAESEgoQCg4KCkNyZWF0ZVRpbWUQABgBItcBCgkAIUv1J88rSRYKyQEDxAAAADFTMzEzNzM0MzYzNDM5MzUzODM1MzczNjMwMzIzNzM0MzUzYTY5NmQ2ZDY5NmQ2MTY3NjUzYTczNjU3NDMwMzAzMTNhMzc2NTY1NjM2NTMyMzQzNjYyMzUzMjM3MzgzODMwMzA2MzM4NjE2NDM4NjQ2MzY2NjE2MTMxNjMzNDMxNjY2MTY0MzEzODM0NjMzOTMzNjQ2MTM2MzUzMjY2NjYzMjMzNjUzNzM1NjUzNzM3MzM2MTY0MzEzMTM2MzYzMTM4Mzk=</NextMarker>\\n<SetId>set001</SetId>","errorExample":""}]', + 'title' => '获取媒体集中的图片列表', + 'summary' => '获取媒体集中的图片列表，返回结果以图片加入媒体集的时间升序排序。', + 'description' => '此接口已不再维护，建议使用新版（2020-09-30版本）[查询与统计](~~2402363~~)相关接口。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateImage' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ser001', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '图片的OSS Uri。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + ], + [ + 'name' => 'RemarksA', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息，为使用者预留的筛选参数，用于记录所需要的信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'remarksa1', + ], + ], + [ + 'name' => 'RemarksB', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息，为使用者预留的筛选参数，用于记录所需要的信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'remarksb1', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '源数据的类型，包括如下选项：'."\n" + ."\n" + .'- image：源数据类型为图片。'."\n" + .'- video：源数据类型为视频。', + 'type' => 'string', + 'required' => false, + 'example' => 'image', + ], + ], + [ + 'name' => 'SourceUri', + 'in' => 'query', + 'schema' => [ + 'description' => '图片的OSS Uri。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + ], + [ + 'name' => 'SourcePosition', + 'in' => 'query', + 'schema' => [ + 'description' => '图片的存储位置。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://imm-test/testcases/', + ], + ], + [ + 'name' => 'RemarksC', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息，为使用者预留的筛选参数，用于记录所需要的信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'remarksc1', + ], + ], + [ + 'name' => 'RemarksD', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息，为使用者预留的筛选参数，用于记录所需要的信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'remarksd1', + ], + ], + [ + 'name' => 'ExternalId', + 'in' => 'query', + 'schema' => [ + 'description' => '外部ID，用于和您的应用层的ID（如果有）进行绑定。', + 'type' => 'string', + 'required' => false, + 'example' => 'externalId002', + ], + ], + [ + 'name' => 'RemarksArrayA', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息列表。', + 'type' => 'string', + 'required' => false, + 'example' => '["remarka11","remarka12"]', + ], + ], + [ + 'name' => 'RemarksArrayB', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息列表。', + 'type' => 'string', + 'required' => false, + 'example' => '["remarkb11","remarkb12"]', + ], + ], + [ + 'name' => 'Faces', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '人脸识别结果列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FaceId' => [ + 'description' => '人脸ID。', + 'type' => 'string', + 'required' => false, + 'example' => '59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51', + ], + 'GroupId' => [ + 'description' => '人脸分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'Group-e3908e18-6eb9-4453-aacb-26620281870c', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RemarksArrayB' => [ + 'description' => '标记信息列表。'."\n" + ."\n" + .'如果更新图片时未设置此参数，则返回值为图片加入媒体集时设置的标记信息列表。', + 'type' => 'string', + 'example' => '["remarkb11","remarkb12"]', + ], + 'ModifyTime' => [ + 'description' => '图片的修改时间。', + 'type' => 'string', + 'example' => '2020-11-25T10:56:52.461Z', + ], + 'RemarksC' => [ + 'description' => '标记信息。'."\n" + ."\n" + .'如果更新图片时未设置此参数，则返回值为图片加入媒体集时设置的标记信息。', + 'type' => 'string', + 'example' => 'remarksc1', + ], + 'RemarksD' => [ + 'description' => '标记信息。'."\n" + ."\n" + .'如果更新图片时未设置此参数，则返回值为图片加入媒体集时设置的标记信息。', + 'type' => 'string', + 'example' => 'remarksd1', + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '7A25A44E-5E7D-4F0C-95C5-BA5BD96B7890', + ], + 'CreateTime' => [ + 'description' => '图片加入媒体集的时间。'."\n", + 'type' => 'string', + 'example' => '2020-11-24T10:56:52.461Z', + ], + 'ExternalId' => [ + 'description' => '外部ID，用于和您的应用层的ID（如果有）进行绑定。', + 'type' => 'string', + 'example' => 'externalId002', + ], + 'RemarksArrayA' => [ + 'description' => '标记信息列表。'."\n" + ."\n" + .'如果更新图片时未设置此参数，则返回值为图片加入媒体集时设置的标记信息列表。', + 'type' => 'string', + 'example' => '["remarka11","remarka12"]', + ], + 'RemarksA' => [ + 'description' => '标记信息。'."\n" + ."\n" + .'如果更新图片时未设置此参数，则返回值为图片加入媒体集时设置的标记信息。', + 'type' => 'string', + 'example' => 'remarksa1', + ], + 'ImageUri' => [ + 'description' => '图片的OSS Uri。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + 'SetId' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'example' => 'set001', + ], + 'RemarksB' => [ + 'description' => '标记信息。'."\n" + ."\n" + .'如果更新图片时未设置此参数，则返回值为图片加入媒体集时设置的标记信息。', + 'type' => 'string', + 'example' => 'remarksb1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RemarksArrayB\\": \\"[\\\\\\"remarkb11\\\\\\",\\\\\\"remarkb12\\\\\\"]\\",\\n \\"ModifyTime\\": \\"2020-11-25T10:56:52.461Z\\",\\n \\"RemarksC\\": \\"remarksc1\\",\\n \\"RemarksD\\": \\"remarksd1\\",\\n \\"RequestId\\": \\"7A25A44E-5E7D-4F0C-95C5-BA5BD96B7890\\",\\n \\"CreateTime\\": \\"2020-11-24T10:56:52.461Z\\",\\n \\"ExternalId\\": \\"externalId002\\",\\n \\"RemarksArrayA\\": \\"[\\\\\\"remarka11\\\\\\",\\\\\\"remarka12\\\\\\"]\\",\\n \\"RemarksA\\": \\"remarksa1\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/face1.jpg\\",\\n \\"SetId\\": \\"set001\\",\\n \\"RemarksB\\": \\"remarksb1\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyTime>2020-11-25T10:56:52.461Z</ModifyTime>\\n<RequestId>7A25A44E-5E7D-4F0C-95C5-BA5BD96B7890</RequestId>\\n<ExternalId>externalId002</ExternalId>\\n<CreateTime>2020-11-24T10:56:52.461Z</CreateTime>\\n<RemarksA>remarksa1</RemarksA>\\n<ImageUri>oss://imm-test/testcases/face1.jpg</ImageUri>\\n<RemarksB>remarksb1</RemarksB>\\n<RemarksArrayB>[\\"remarkb11\\",\\"remarkb12\\"]</RemarksArrayB>\\n<RemarksC>remarksc1</RemarksC>\\n<RemarksD>remarksd1</RemarksD>\\n<RemarksArrayA>[\\"remarka11\\",\\"remarka12\\"]</RemarksArrayA>\\n<SetId>set001</SetId>","errorExample":""}]', + 'title' => '更新媒体集中用户自定义的图片信息', + 'summary' => '调用UpdateImage接口更新媒体集中用户自定义的图片信息。', + 'description' => '此接口已不再维护，建议使用新版（2020-09-30版本）接口[UpdateFileMeta](~~478168~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'IndexImage' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'set001', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '图片的OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + ], + [ + 'name' => 'RemarksA', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息，为使用者预留的筛选参数，用于记录所需要的信息。'."\n" + ."\n" + .'在搜索等场景下，您可以以前缀匹配的方式将设置的值作为搜索条件，样例场景如下：'."\n" + .'- 作为客户端权限字段存入，例如AdminGroup/AdminUserA/，即可使用前缀过滤用户权限。'."\n" + .'- 作为客户端的相对路径存入，例如nas://path/to/file。', + 'type' => 'string', + 'required' => false, + 'example' => 'AdminGroup/AdminUserA/', + ], + ], + [ + 'name' => 'RemarksB', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息，为使用者预留的筛选参数，用于记录所需要的信息。'."\n" + ."\n\n" + .'在搜索等场景下，您可以以前缀匹配的方式将设置的值作为搜索条件，样例场景如下：'."\n" + .'- 作为客户端权限字段存入，例如AdminGroup/AdminUserA/，即可使用前缀过滤用户权限。'."\n" + .'- 作为客户端的相对路径存入，例如nas://path/to/file。', + 'type' => 'string', + 'required' => false, + 'example' => 'nas://path/to/file', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '源数据的类型，包括如下选项：'."\n" + ."\n" + .'- image：源数据类型为图片。'."\n" + .'- video：源数据类型为视频。', + 'type' => 'string', + 'required' => false, + 'example' => 'image', + ], + ], + [ + 'name' => 'SourceUri', + 'in' => 'query', + 'schema' => [ + 'description' => '图片的OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + ], + [ + 'name' => 'SourcePosition', + 'in' => 'query', + 'schema' => [ + 'description' => '只有当SourceType为video时，此参数才生效。'."\n" + ."\n" + .'视频中该图片帧处于源视频的时间轴位置。格式为`"00000000.010"`，即%8.3f。', + 'type' => 'string', + 'required' => false, + 'example' => '00000000.010', + ], + ], + [ + 'name' => 'RemarksC', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息，为使用者预留的筛选参数，用于记录所需要的信息。'."\n" + ."\n" + .'在搜索等场景下，您可以以前缀匹配的方式将设置的值作为搜索条件，样例场景如下：'."\n" + .'- 作为客户端权限字段存入，例如AdminGroup/AdminUserA/，即可使用前缀过滤用户权限。'."\n" + .'- 作为客户端的相对路径存入，例如nas://path/to/file。', + 'type' => 'string', + 'required' => false, + 'example' => 'remarkc', + ], + ], + [ + 'name' => 'RemarksD', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息，为使用者预留的筛选参数，用于记录所需要的信息。'."\n" + ."\n" + .'在搜索等场景下，您可以以前缀匹配的方式将设置的值作为搜索条件，样例场景如下：'."\n" + .'- 作为客户端权限字段存入，例如AdminGroup/AdminUserA/，即可使用前缀过滤用户权限。'."\n" + .'- 作为客户端的相对路径存入，例如nas://path/to/file。', + 'type' => 'string', + 'required' => false, + 'example' => 'remarkd', + ], + ], + [ + 'name' => 'ExternalId', + 'in' => 'query', + 'schema' => [ + 'description' => '外部ID，用于和您的应用层的ID（如果有）进行绑定。', + 'type' => 'string', + 'required' => false, + 'example' => 'externalId001', + ], + ], + [ + 'name' => 'NotifyEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => '异步反向通知的Endpoint，图片处理结果可以通过该Endpoint异步通知给调用者。使用此功能需要先开通轻量消息队列（原 MNS）服务，新建topic和queue，并配置订阅关系。具体操作，请参见[轻量消息队列（原 MNS）快速入门概述](https://help.aliyun.com/document_detail/34412.html)。'."\n" + ."\n" + .'> 轻量消息队列（原 MNS）服务和智能媒体管理必须处于同一地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + ], + ], + [ + 'name' => 'NotifyTopicName', + 'in' => 'query', + 'schema' => [ + 'description' => '异步反向通知的TopicName。', + 'type' => 'string', + 'required' => false, + 'example' => 'topic2', + ], + ], + [ + 'name' => 'RemarksArrayA', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息列表，格式为数组。', + 'type' => 'string', + 'required' => false, + 'example' => '["remarka1","remarka2"]', + ], + ], + [ + 'name' => 'RemarksArrayB', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息列表，格式为数组。', + 'type' => 'string', + 'required' => false, + 'example' => '["remarkb1","remarkb2"]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RemarksArrayB' => [ + 'description' => '标记信息列表。'."\n" + ."\n" + .'如果请求时未设置此参数，则返回值为空。', + 'type' => 'string', + 'example' => '["remarkb1","remarkb2"]', + ], + 'ModifyTime' => [ + 'description' => '图片的修改时间。'."\n" + ."\n" + .'添加图片后，如果未修改过图片，则图片的修改时间和图片的创建时间相同。', + 'type' => 'string', + 'example' => '2020-11-24T10:56:52.461Z', + ], + 'RemarksC' => [ + 'description' => '标记信息。'."\n" + ."\n" + .'如果请求时未设置此参数，则返回值为空。', + 'type' => 'string', + 'example' => 'remarkc', + ], + 'RemarksD' => [ + 'description' => '标记信息。'."\n" + ."\n" + .'如果请求时未设置此参数，则返回值为空。', + 'type' => 'string', + 'example' => 'remarkd', + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '144A2D4C-12D5-46D6-BEC9-9AAEE1F10C25', + ], + 'CreateTime' => [ + 'description' => '图片加入媒体集的时间。'."\n", + 'type' => 'string', + 'example' => '2020-11-24T10:56:52.461Z', + ], + 'ExternalId' => [ + 'description' => '外部ID，用于和您的应用层的ID（如果有）进行绑定。'."\n" + ."\n" + .'如果请求时未设置此参数，则返回值为空。', + 'type' => 'string', + 'example' => 'externalId001', + ], + 'RemarksArrayA' => [ + 'description' => '标记信息列表。'."\n" + ."\n" + .'如果请求时未设置此参数，则返回值为空。', + 'type' => 'string', + 'example' => '["remarka1","remarka2"]', + ], + 'RemarksA' => [ + 'description' => '标记信息。'."\n" + ."\n" + .'如果请求时未设置此参数，则返回值为空。', + 'type' => 'string', + 'example' => 'AdminGroup/AdminUserA/', + ], + 'ImageUri' => [ + 'description' => '图片的OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + 'SetId' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'example' => 'set001', + ], + 'RemarksB' => [ + 'description' => '标记信息。'."\n" + ."\n" + .'如果请求时未设置此参数，则返回值为空。', + 'type' => 'string', + 'example' => 'nas://path/to/file', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RemarksArrayB\\": \\"[\\\\\\"remarkb1\\\\\\",\\\\\\"remarkb2\\\\\\"]\\",\\n \\"ModifyTime\\": \\"2020-11-24T10:56:52.461Z\\",\\n \\"RemarksC\\": \\"remarkc\\",\\n \\"RemarksD\\": \\"remarkd\\",\\n \\"RequestId\\": \\"144A2D4C-12D5-46D6-BEC9-9AAEE1F10C25\\",\\n \\"CreateTime\\": \\"2020-11-24T10:56:52.461Z\\",\\n \\"ExternalId\\": \\"externalId001\\",\\n \\"RemarksArrayA\\": \\"[\\\\\\"remarka1\\\\\\",\\\\\\"remarka2\\\\\\"]\\",\\n \\"RemarksA\\": \\"AdminGroup/AdminUserA/\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/face1.jpg\\",\\n \\"SetId\\": \\"set001\\",\\n \\"RemarksB\\": \\"nas://path/to/file\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyTime>2020-11-24T10:56:52.461Z</ModifyTime>\\n<RequestId>144A2D4C-12D5-46D6-BEC9-9AAEE1F10C25</RequestId>\\n<ExternalId>externalId001</ExternalId>\\n<CreateTime>2020-11-24T10:56:52.461Z</CreateTime>\\n<RemarksA>AdminGroup/AdminUserA/</RemarksA>\\n<ImageUri>oss://imm-test/testcases/face1.jpg</ImageUri>\\n<RemarksB>nas://path/to/file</RemarksB>\\n<RemarksArrayB>[\\"remarkb1\\",\\"remarkb2\\"]</RemarksArrayB>\\n<RemarksC>remarkc</RemarksC>\\n<RemarksD>remarkd</RemarksD>\\n<RemarksArrayA>[\\"remarka1\\",\\"remarka2\\"]</RemarksArrayA>\\n<SetId>set001</SetId>","errorExample":""}]', + 'title' => '将图片加入媒体集', + 'summary' => '将图片加入媒体集，并进行AI检测。', + 'description' => '- 此接口已不再维护，建议使用新版（2020-09-30版本）接口[IndexFileMeta](~~478166~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + .'- IndexImage对图片的处理为异步方式，您可以通过GetImage接口获取通过各个引擎处理该图片的结果，该结果通常能在数秒内完成。'."\n" + .'- ImageUri作为图片的唯一标识，不能重复。如果ImageUri指向的OSS路径中的图片未变化，可以重复调用IndexImage接口重试处理图片失败的引擎。'."\n" + .'- 引擎包括**标签识别**和**人脸检测识别**。', + 'requestParamsDescription' => '### 轻量消息队列（原 MNS）通知'."\n" + ."\n" + .'请求参数中如果设置了NotifyTopicName和NotifyEndpoint支持[轻量消息队列（原 MNS）事件通知](https://help.aliyun.com/document_detail/27498.html)，则智能媒体管理会为您返回异步通知。通知的消息格式为：'."\n" + .'```'."\n" + .'{'."\n" + .' "eventName": "IndexImageTask",'."\n" + .' "eventSource": "acs:imm",'."\n" + .' "eventTime": "2019-09-03T02:20:50.529Z",'."\n" + .' "eventVersion": "1.0",'."\n" + .' "imm": {'."\n" + .' "ImageUri": "oss://imm-test/testcases/test.jpg",'."\n" + .' "Project": "PhotoTest",'."\n" + .' "RequestId": "4D3950B2-AB3D-4F06-BDF0-271022DA552C",'."\n" + .' "SetId": "test-set",'."\n" + .' "Success": "true"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + .'轻量消息队列（原 MNS）通知返回参数说明请参见下表。'."\n" + .'| 名称 | 类型 | 描述 |'."\n" + .'| ---- | ---- | ---- |'."\n" + .'|eventName|String|任务类型，返回为固定值IndexImageTask。|'."\n" + .'|imm.ImageUri|String|源数据的OSS URI。|'."\n" + .'|imm.SetId|String|媒体集的唯一标识。|'."\n" + .'|imm.Project|String|项目名称。|'."\n" + .'|imm.RequestId|String|当次请求的Request ID。|'."\n" + .'|imm.Success|String|执行是否成功。取值为true或false。|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'FindSimilarFaces' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'set001', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '图片的OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + ], + [ + 'name' => 'FaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集中已存在的人脸ID。', + 'type' => 'string', + 'required' => false, + 'example' => '59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '返回最相似图片的最大个数，默认值为10，取值范围为1~100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'MinSimilarity', + 'in' => 'query', + 'schema' => [ + 'description' => '过滤返回结果中相似度低于该值的图片。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.8', + ], + ], + [ + 'name' => 'ResponseFormat', + 'in' => 'query', + 'schema' => [ + 'description' => '返回值的格式版本，不设置此参数则返回值的格式为旧版本，推荐设置此参数为v2。', + 'type' => 'string', + 'required' => false, + 'example' => 'v2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '31A201C4-6824-4A8F-81FE-E0659FDDF1D7', + ], + 'Faces' => [ + 'description' => '人脸信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FaceId' => [ + 'description' => '人脸ID。', + 'type' => 'string', + 'example' => '59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51', + ], + 'ImageUri' => [ + 'description' => '图片的OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + 'ExternalId' => [ + 'description' => '外部ID，用于和您的应用层的ID（如果有）进行绑定。'."\n" + ."\n" + .'如果图片加入媒体集时未设置此参数，则返回值为空。', + 'type' => 'string', + 'example' => 'external001', + ], + 'FaceAttributes' => [ + 'description' => '人脸属性。', + 'type' => 'object', + 'properties' => [ + 'FaceBoundary' => [ + 'description' => '人脸位置框。', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '顶点Y坐标，距离顶端距离。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '191', + ], + 'Width' => [ + 'description' => '人脸位置框宽度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '269', + ], + 'Height' => [ + 'description' => '人脸位置框高度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '252', + ], + 'Left' => [ + 'description' => '顶点X坐标，距离左端距离。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '95', + ], + ], + ], + ], + ], + 'Similarity' => [ + 'description' => '人脸相似度，该值越大则人脸相似度越高，取值范围为0～1。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8609305739402771', + ], + 'SimilarFaces' => [ + 'description' => '相似人脸信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FaceId' => [ + 'description' => '相似人脸ID。', + 'type' => 'string', + 'example' => '98ae3c032337161f997a92f8ab9ac9624113368b9e4f93f6143d54a16e51b623', + ], + 'ImageUri' => [ + 'description' => '图片的OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/face3.jpg', + ], + 'ExternalId' => [ + 'description' => '外部ID，用于和您的应用层的ID（如果有）进行绑定。'."\n" + ."\n" + .'如果图片加入媒体集时未设置此参数，则返回值为空。', + 'type' => 'string', + 'example' => 'external003', + ], + 'FaceAttributes' => [ + 'description' => '相似人脸属性。', + 'type' => 'object', + 'properties' => [ + 'FaceBoundary' => [ + 'description' => '人脸位置框。', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '顶点Y坐标，距离顶端距离。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '152', + ], + 'Width' => [ + 'description' => '人脸位置框宽度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '139', + ], + 'Height' => [ + 'description' => '人脸位置框高度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '141', + ], + 'Left' => [ + 'description' => '顶点X坐标，距离左端距离。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '267', + ], + ], + ], + ], + ], + 'Similarity' => [ + 'description' => '人脸相似度，该值越大则人脸相似度越高，取值范围为0～1。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8609305739402771', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"31A201C4-6824-4A8F-81FE-E0659FDDF1D7\\",\\n \\"Faces\\": [\\n {\\n \\"FaceId\\": \\"59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/face1.jpg\\",\\n \\"ExternalId\\": \\"external001\\",\\n \\"FaceAttributes\\": {\\n \\"FaceBoundary\\": {\\n \\"Top\\": 191,\\n \\"Width\\": 269,\\n \\"Height\\": 252,\\n \\"Left\\": 95\\n }\\n },\\n \\"Similarity\\": 0.860930573940277,\\n \\"SimilarFaces\\": [\\n {\\n \\"FaceId\\": \\"98ae3c032337161f997a92f8ab9ac9624113368b9e4f93f6143d54a16e51b623\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/face3.jpg\\",\\n \\"ExternalId\\": \\"external003\\",\\n \\"FaceAttributes\\": {\\n \\"FaceBoundary\\": {\\n \\"Top\\": 152,\\n \\"Width\\": 139,\\n \\"Height\\": 141,\\n \\"Left\\": 267\\n }\\n },\\n \\"Similarity\\": 0.860930573940277\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>31A201C4-6824-4A8F-81FE-E0659FDDF1D7</RequestId>\\n<Faces>\\n <FaceId>59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51</FaceId>\\n <FaceAttributes>\\n <FaceBoundary>\\n <Left>95</Left>\\n <Top>191</Top>\\n <Height>252</Height>\\n <Width>269</Width>\\n </FaceBoundary>\\n </FaceAttributes>\\n <Similarity>0.9999998807907104</Similarity>\\n <ExternalId/>\\n <ImageUri>oss://imm-test/testcases/face1.jpg</ImageUri>\\n</Faces>\\n<Faces>\\n <FaceId>98ae3c032337161f997a92f8ab9ac9624113368b9e4f93f6143d54a16e51b623</FaceId>\\n <FaceAttributes>\\n <FaceBoundary>\\n <Left>267</Left>\\n <Top>152</Top>\\n <Height>141</Height>\\n <Width>139</Width>\\n </FaceBoundary>\\n </FaceAttributes>\\n <Similarity>0.6609989404678345</Similarity>\\n <ExternalId/>\\n <ImageUri>oss://imm-test/testcases/face3.jpg.jpg</ImageUri>\\n</Faces>","errorExample":""}]', + 'title' => '查找和指定人脸相似的人脸', + 'summary' => '从媒体集中搜索与指定图片或人脸ID最相似的前N张图片，并返回相应人脸ID及边界框，返回结果按照相似度降序排列。', + 'description' => '- 此接口已不再维护，建议使用新版（2020-09-30版本）接口[CreateFacesSearchingTask](~~478186~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + .'- 您可以使用如下两种方式从媒体集中搜索与人脸最相似的前N张图片。'."\n" + ."\n" + .' - 通过传入媒体集中人脸ID进行搜索，具体步骤如下：'."\n" + ."\n" + .' > 返回值中Faces的首个元素一定是传入的FaceId，系统不会对结果进行过滤。'."\n" + ."\n" + .' 1. 调用CreateSet接口创建媒体集。 '."\n" + .' 2. 调用IndexImage接口将图片索引到媒体集。'."\n" + .' 3. 调用ListImages或GetImage接口获取需要进行搜索的人脸ID。'."\n" + .' 4. 使用媒体集中的人脸ID，将人脸ID作为输入值，从媒体集中搜索与人脸ID对应人脸最相似的前N张图片。'."\n" + ."\n" + .' - 通过传入图片的OSS URI进行搜索，具体步骤如下：'."\n" + ."\n" + .' > 当传入的ImageUri在媒体集中存在时，则返回值中Faces的首个元素一定是传入的ImageUri内的同一个人脸，系统不会对结果进行过滤。'."\n" + ."\n" + .' 1. 将图片上传到OSS。'."\n" + .' 2. 使用图片的OSS URI，将图片中的人脸作为输入值，从媒体集中搜索与图片中人脸最相似的前N张图片。'."\n" + ."\n\n" + ."\n" + .'- 当两个人脸的相似度Similarity>0.8时，两个人脸基本可以判断为同一人物。'."\n" + ."\n" + .'- 搜索结果依赖索引的建立，返回结果与实际值可能有数秒的数据延迟。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CompareImageFaces' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'set001', + ], + ], + [ + 'name' => 'ImageUriA', + 'in' => 'query', + 'schema' => [ + 'description' => '图片的OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。'."\n" + ."\n\n" + .'通过两张图片的OSS URI进行人脸相似度比较时，必须设置此参数。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + ], + [ + 'name' => 'ImageUriB', + 'in' => 'query', + 'schema' => [ + 'description' => '图片的OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。'."\n" + ."\n\n" + .'通过两张图片的OSS URI进行人脸相似度比较时，必须设置此参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://imm-test/testcases/face2.jpg', + ], + ], + [ + 'name' => 'FaceIdA', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集中已存在的人脸ID。'."\n" + ."\n" + .'通过媒体集中的两个人脸ID进行人脸相似度比较时，必须设置此参数。', + 'type' => 'string', + 'required' => false, + 'example' => '59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a040****', + ], + ], + [ + 'name' => 'FaceIdB', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集中已存在的人脸ID。'."\n" + ."\n" + .'通过媒体集中的两个人脸ID进行人脸相似度比较时，必须设置此参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'b4a15b4f1618cdfa45a812974cfc160570052487ca1053e20bfdc12917e2****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'F73AC982-2B9E-4ECD-AED5-F8331C5A1988', + ], + 'Similarity' => [ + 'description' => '人脸相似度，该值越大则人脸相似度越高，取值范围为0～1。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8848152756690983', + ], + 'SetId' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'example' => 'set001', + ], + 'FaceA' => [ + 'description' => '人脸信息。', + 'type' => 'object', + 'properties' => [ + 'FaceId' => [ + 'description' => '人脸ID。', + 'type' => 'string', + 'example' => '59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a040****', + ], + 'FaceAttributes' => [ + 'description' => '人脸属性。', + 'type' => 'object', + 'properties' => [ + 'FaceBoundary' => [ + 'description' => '人脸位置框。', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '顶点Y坐标，距离顶端距离。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '191', + ], + 'Width' => [ + 'description' => '人脸位置框宽度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '269', + ], + 'Height' => [ + 'description' => '人脸位置框高度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '252', + ], + 'Left' => [ + 'description' => '顶点X坐标，距离左端距离。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '95', + ], + ], + ], + ], + ], + ], + ], + 'FaceB' => [ + 'description' => '人脸信息。', + 'type' => 'object', + 'properties' => [ + 'FaceId' => [ + 'description' => '人脸ID。', + 'type' => 'string', + 'example' => 'b4a15b4f1618cdfa45a812974cfc160570052487ca1053e20bfdc12917e2****', + ], + 'FaceAttributes' => [ + 'description' => '人脸属性。', + 'type' => 'object', + 'properties' => [ + 'FaceBoundary' => [ + 'description' => '人脸位置框。', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '顶点Y坐标，距离顶端距离。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '72', + ], + 'Width' => [ + 'description' => '人脸位置框宽度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '83', + ], + 'Height' => [ + 'description' => '人脸位置框高度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '89', + ], + 'Left' => [ + 'description' => '顶点X坐标，距离左端距离。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '249', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F73AC982-2B9E-4ECD-AED5-F8331C5A1988\\",\\n \\"Similarity\\": 0.8848152756690983,\\n \\"SetId\\": \\"set001\\",\\n \\"FaceA\\": {\\n \\"FaceId\\": \\"59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a040****\\",\\n \\"FaceAttributes\\": {\\n \\"FaceBoundary\\": {\\n \\"Top\\": 191,\\n \\"Width\\": 269,\\n \\"Height\\": 252,\\n \\"Left\\": 95\\n }\\n }\\n },\\n \\"FaceB\\": {\\n \\"FaceId\\": \\"b4a15b4f1618cdfa45a812974cfc160570052487ca1053e20bfdc12917e2****\\",\\n \\"FaceAttributes\\": {\\n \\"FaceBoundary\\": {\\n \\"Top\\": 72,\\n \\"Width\\": 83,\\n \\"Height\\": 89,\\n \\"Left\\": 249\\n }\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<CompareImageFacesResponse>\\n <Similarity>0.8848152756690983</Similarity>\\n <RequestId>F73AC982-2B9E-4ECD-AED5-F8331C5A1988</RequestId>\\n <SetId>set001</SetId>\\n <FaceA>\\n <FaceId>59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a040****</FaceId>\\n <FaceAttributes>\\n <FaceBoundary>\\n <Left>95</Left>\\n <Top>191</Top>\\n <Height>252</Height>\\n <Width>269</Width>\\n </FaceBoundary>\\n </FaceAttributes>\\n </FaceA>\\n <FaceB>\\n <FaceId>b4a15b4f1618cdfa45a812974cfc160570052487ca1053e20bfdc12917e2****</FaceId>\\n <FaceAttributes>\\n <FaceBoundary>\\n <Left>249</Left>\\n <Top>72</Top>\\n <Height>89</Height>\\n <Width>83</Width>\\n </FaceBoundary>\\n </FaceAttributes>\\n </FaceB>\\n</CompareImageFacesResponse>","errorExample":""}]', + 'title' => '比较两个人脸的相似度', + 'summary' => '调用CompareImageFaces接口比较两个人脸的相似度。', + 'description' => '- 此接口已不再维护，建议使用新版（2020-09-30版本）接口[CompareImageFaces](~~478218~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + .'- 您可以使用如下两种方式比较两个人脸的相似度。'."\n" + ."\n" + .' - 通过传入媒体集中的两个人脸ID进行比较，具体步骤如下：'."\n" + ."\n" + .' 1. 调用CreateSet接口创建媒体集。 '."\n" + .' 2. 调用IndexImage接口将图片索引到媒体集。'."\n" + .' 3. 调用ListImages或GetImage接口获取需要进行搜索的人脸ID。'."\n" + .' 4. 使用媒体集中的人脸ID，将人脸ID作为输入值，比较两个人脸的相似度。'."\n" + .' - 通过传入两张图片的OSS URI进行比较，具体步骤如下：'."\n" + ."\n" + .' 1. 将两张图片上传到OSS。'."\n" + .' 2. 使用图片的OSS URI，将图片中的人脸作为输入值，比较两个人脸的相似度。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListFaceGroups' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'set001', + ], + ], + [ + 'name' => 'Marker', + 'in' => 'query', + 'schema' => [ + 'description' => '从Marker开始按字典序返回人脸分组信息列表。如果不设置此参数，则从头开始返回人脸分组信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'CAESEQoPCg0KCUZhY2VDb3VudBABGAEirQEKCQAFAAAAAAAAAAqfAQOaAAAAMVMzMTM3MzQzNjM0MzkzNTM4MzUzNzM2MzAzMjM3MzQzNTNhNjk2ZDZkNjk2ZDYxNjc2NTNhNzM2NTc0NzQ2NTczNzQuUzQ3NzI2Zjc1NzAyZDM0Mzg2NjY0NjQzNDYyNjQyZDM2MzI2MzMzMmQzNDY0NjE2MTJkNjE2NDM5MzgyZDYxNjUzNjYxMzQzMTM3MzM2MTMxMzMzMA==', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '返回人脸分组的最大个数，默认值为20，取值范围为1~100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式，默认值为DESC。'."\n" + ."\n" + .'- ASC：升序'."\n" + .'- DESC：降序', + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段，默认值为FaceCount。'."\n" + ."\n" + .'- CreateTime：人脸分组的创建时间。'."\n" + .'- ModifyTime：人脸分组的修改时间。'."\n" + .'- FaceCount：人脸分组中的人脸数量。', + 'type' => 'string', + 'required' => false, + 'example' => 'FaceCount', + ], + ], + [ + 'name' => 'RemarksAQuery', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息查询条件，包括如下四种查询方式，可根据实际选择其中若干项条件进行查询。'."\n" + ."\n" + .'- PREFIX：前缀匹配。'."\n" + .'- NOT-PREFIX：非前缀匹配。'."\n" + .'- IN：全字匹配，必须完全符合IN中指定的任意一个字符串。'."\n" + .'- NOT-IN：全字匹配，必须不符合NOT-IN中指定的任意一个字符串。', + 'type' => 'string', + 'required' => false, + 'example' => ' {"PREFIX": "start-with-this","NOT-PREFIX": "not-start-with-this","IN": ["ONE","OF","THIS"],"NOT-IN": ["NONE","FROM","THOSE"]}', + ], + ], + [ + 'name' => 'RemarksBQuery', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息查询条件，包括如下四种查询方式，可根据实际选择其中若干项条件进行查询。'."\n" + ."\n" + .'- PREFIX：前缀匹配。'."\n" + .'- NOT-PREFIX：非前缀匹配。'."\n" + .'- IN：全字匹配，必须完全符合IN中指定的任意一个字符串。'."\n" + .'- NOT-IN：全字匹配，必须不符合NOT-IN中指定的任意一个字符串。', + 'type' => 'string', + 'required' => false, + 'example' => ' {"PREFIX": "start-with-this","NOT-PREFIX": "not-start-with-this","IN": ["ONE","OF","THIS"],"NOT-IN": ["NONE","FROM","THOSE"]}', + ], + ], + [ + 'name' => 'RemarksCQuery', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息查询条件，包括如下四种查询方式，可根据实际选择其中若干项条件进行查询。'."\n" + ."\n" + .'- PREFIX：前缀匹配。'."\n" + .'- NOT-PREFIX：非前缀匹配。'."\n" + .'- IN：全字匹配，必须完全符合IN中指定的任意一个字符串。'."\n" + .'- NOT-IN：全字匹配，必须不符合NOT-IN中指定的任意一个字符串。', + 'type' => 'string', + 'required' => false, + 'example' => ' {"PREFIX": "start-with-this","NOT-PREFIX": "not-start-with-this","IN": ["ONE","OF","THIS"],"NOT-IN": ["NONE","FROM","THOSE"]}', + ], + ], + [ + 'name' => 'RemarksDQuery', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息查询条件，包括如下四种查询方式，可根据实际选择其中若干项条件进行查询。'."\n" + ."\n" + .'- PREFIX：前缀匹配。'."\n" + .'- NOT-PREFIX：非前缀匹配。'."\n" + .'- IN：全字匹配，必须完全符合IN中指定的任意一个字符串。'."\n" + .'- NOT-IN：全字匹配，必须不符合NOT-IN中指定的任意一个字符串。', + 'type' => 'string', + 'required' => false, + 'example' => ' {"PREFIX": "start-with-this","NOT-PREFIX": "not-start-with-this","IN": ["ONE","OF","THIS"],"NOT-IN": ["NONE","FROM","THOSE"]}', + ], + ], + [ + 'name' => 'RemarksArrayAQuery', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息查询条件，包括如下四种查询方式，可根据实际选择其中若干项条件进行查询。'."\n" + ."\n" + .'- PREFIX：前缀匹配。'."\n" + .'- NOT-PREFIX：非前缀匹配。'."\n" + .'- IN：全字匹配，必须完全符合IN中指定的任意一个字符串。'."\n" + .'- NOT-IN：全字匹配，必须不符合NOT-IN中指定的任意一个字符串。', + 'type' => 'string', + 'required' => false, + 'example' => ' {"PREFIX": "start-with-this","NOT-PREFIX": "not-start-with-this","IN": ["ONE","OF","THIS"],"NOT-IN": ["NONE","FROM","THOSE"]}', + ], + ], + [ + 'name' => 'RemarksArrayBQuery', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息查询条件，包括如下四种查询方式，可根据实际选择其中若干项条件进行查询。'."\n" + ."\n" + .'- PREFIX：前缀匹配。'."\n" + .'- NOT-PREFIX：非前缀匹配。'."\n" + .'- IN：全字匹配，必须完全符合IN中指定的任意一个字符串。'."\n" + .'- NOT-IN：全字匹配，必须不符合NOT-IN中指定的任意一个字符串。', + 'type' => 'string', + 'required' => false, + 'example' => ' {"PREFIX": "start-with-this","NOT-PREFIX": "not-start-with-this","IN": ["ONE","OF","THIS"],"NOT-IN": ["NONE","FROM","THOSE"]}', + ], + ], + [ + 'name' => 'ExternalId', + 'in' => 'query', + 'schema' => [ + 'description' => '外部ID，用于和您的应用层的ID（如果有）进行绑定。查询类型为精确匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'externalId001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '6CD6F064-6999-4B64-B057-5FBD09E48C46', + ], + 'NextMarker' => [ + 'description' => '下一次列出人脸分组信息时以此值为Marker，将未返回的结果返回。 '."\n" + ."\n" + .'当人脸分组未全部返回时，此参数才有值。', + 'type' => 'string', + 'example' => 'CAESEQoPCg0KCUZhY2VDb3VudBABGAEirQEKCQAFAAAAAAAAAAqfAQOaAAAAMVMzMTM3MzQzNjM0MzkzNTM4MzUzNzM2MzAzMjM3MzQzNTNhNjk2ZDZkNjk2ZDYxNjc2NTNhNzM2NTc0NzQ2NTczNzQuUzQ3NzI2Zjc1NzAyZDM0Mzg2NjY0NjQzNDYyNjQyZDM2MzI2MzMzMmQzNDY0NjE2MTJkNjE2NDM5MzgyZDYxNjUzNjYxMzQzMTM3MzM2MTMxMzMzMA==', + ], + 'FaceGroups' => [ + 'description' => '人脸分组信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Gender' => [ + 'description' => '人脸的性别。', + 'type' => 'string', + 'example' => 'MALE', + ], + 'CreateTime' => [ + 'description' => '人脸分组的创建时间。', + 'type' => 'string', + 'example' => '2021-01-11T02:18:26.174Z', + ], + 'RemarksC' => [ + 'description' => '人脸分组的标记信息，为使用者预留的筛选参数，用于记录所需要的信息。', + 'type' => 'string', + 'example' => '浙江省杭州市', + ], + 'GroupCoverFace' => [ + 'description' => '人脸分组封面图信息。', + 'type' => 'object', + 'properties' => [ + 'FaceId' => [ + 'description' => '人脸分组封面图的FaceId，可以使用媒体集图片处理相关接口（例如GetImage、ListImages等）获得该FaceId。'."\n" + ."\n" + .'FaceId必须为同一分组 （即GroupId相同）中的人脸ID。', + 'type' => 'string', + 'example' => 'b30a7a36997ce986965680fed90c397fc70a533af511346f819976c6a138c594', + ], + 'ImageUri' => [ + 'description' => '图片的OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/face1.jpg', + ], + 'FaceBoundary' => [ + 'description' => '人脸位置框信息。', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '顶点Y坐标，距离顶端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '49', + ], + 'Width' => [ + 'description' => '人脸位置框宽度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '46', + ], + 'Height' => [ + 'description' => '人脸位置框高度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '45', + ], + 'Left' => [ + 'description' => '顶点X坐标，距离左端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + ], + ], + 'ExternalId' => [ + 'description' => '外部ID，用于和您的应用层的ID（如果有）进行绑定。', + 'type' => 'string', + 'example' => '61e24632982b3e7598f74d4a95a2706cb11b3408#61e2463254140e7b68044db1aeca52771ae6bdb3', + ], + 'ImageHeight' => [ + 'description' => '图片高度。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '374', + ], + 'ImageWidth' => [ + 'description' => '图片宽度。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '739', + ], + ], + ], + 'FaceCount' => [ + 'description' => '人脸分组中的人脸数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RemarksArrayB' => [ + 'description' => '标记信息列表，格式为数组。', + 'type' => 'string', + 'example' => '["remarksb1","remarksb2"]', + ], + 'RemarksD' => [ + 'description' => '人脸分组的标记信息，为使用者预留的筛选参数，用于记录所需要的信息。', + 'type' => 'string', + 'example' => '浙江省杭州市', + ], + 'MaxAge' => [ + 'description' => '人脸分组中人脸的最大年龄。', + 'type' => 'number', + 'format' => 'float', + 'example' => '28', + ], + 'GroupId' => [ + 'description' => '人脸分组的唯一标识。', + 'type' => 'string', + 'example' => 'Group-48fdd4bd-62c3-4daa-ad98-ae6a4173a130', + ], + 'GroupName' => [ + 'description' => '人脸分组名称。', + 'type' => 'string', + 'example' => 'facegrouptest', + ], + 'RemarksA' => [ + 'description' => '人脸分组的标记信息，为使用者预留的筛选参数，用于记录所需要的信息。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/', + ], + 'AverageAge' => [ + 'description' => '人脸分组中人脸的平均年龄。', + 'type' => 'number', + 'format' => 'float', + 'example' => '26.4', + ], + 'RemarksArrayA' => [ + 'description' => '标记信息列表，格式为数组。', + 'type' => 'string', + 'example' => '["remarksa1","remarksa2"]', + ], + 'MinAge' => [ + 'description' => '人脸分组中人脸的最小年龄。', + 'type' => 'number', + 'format' => 'float', + 'example' => '23', + ], + 'ImageCount' => [ + 'description' => '人脸分组中的图片数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ExternalId' => [ + 'description' => '外部ID，用于和您的应用层的ID（如果有）进行绑定。', + 'type' => 'string', + 'example' => 'externalIdtest', + ], + 'RemarksB' => [ + 'description' => '人脸分组的标记信息，为使用者预留的筛选参数，用于记录所需要的信息。', + 'type' => 'string', + 'example' => 'face1.jpg', + ], + 'ModifyTime' => [ + 'description' => '人脸分组的修改时间。', + 'type' => 'string', + 'example' => '2021-01-11T02:18:26.174Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6CD6F064-6999-4B64-B057-5FBD09E48C46\\",\\n \\"NextMarker\\": \\"CAESEQoPCg0KCUZhY2VDb3VudBABGAEirQEKCQAFAAAAAAAAAAqfAQOaAAAAMVMzMTM3MzQzNjM0MzkzNTM4MzUzNzM2MzAzMjM3MzQzNTNhNjk2ZDZkNjk2ZDYxNjc2NTNhNzM2NTc0NzQ2NTczNzQuUzQ3NzI2Zjc1NzAyZDM0Mzg2NjY0NjQzNDYyNjQyZDM2MzI2MzMzMmQzNDY0NjE2MTJkNjE2NDM5MzgyZDYxNjUzNjYxMzQzMTM3MzM2MTMxMzMzMA==\\",\\n \\"FaceGroups\\": [\\n {\\n \\"Gender\\": \\"MALE\\",\\n \\"CreateTime\\": \\"2021-01-11T02:18:26.174Z\\",\\n \\"RemarksC\\": \\"浙江省杭州市\\",\\n \\"GroupCoverFace\\": {\\n \\"FaceId\\": \\"b30a7a36997ce986965680fed90c397fc70a533af511346f819976c6a138c594\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/face1.jpg\\",\\n \\"FaceBoundary\\": {\\n \\"Top\\": 49,\\n \\"Width\\": 46,\\n \\"Height\\": 45,\\n \\"Left\\": 80\\n },\\n \\"ExternalId\\": \\"61e24632982b3e7598f74d4a95a2706cb11b3408#61e2463254140e7b68044db1aeca52771ae6bdb3\\",\\n \\"ImageHeight\\": 374,\\n \\"ImageWidth\\": 739\\n },\\n \\"FaceCount\\": 5,\\n \\"RemarksArrayB\\": \\"[\\\\\\"remarksb1\\\\\\",\\\\\\"remarksb2\\\\\\"]\\",\\n \\"RemarksD\\": \\"浙江省杭州市\\",\\n \\"MaxAge\\": 28,\\n \\"GroupId\\": \\"Group-48fdd4bd-62c3-4daa-ad98-ae6a4173a130\\",\\n \\"GroupName\\": \\"facegrouptest\\",\\n \\"RemarksA\\": \\"oss://imm-test/testcases/\\",\\n \\"AverageAge\\": 26.4,\\n \\"RemarksArrayA\\": \\"[\\\\\\"remarksa1\\\\\\",\\\\\\"remarksa2\\\\\\"]\\",\\n \\"MinAge\\": 23,\\n \\"ImageCount\\": 5,\\n \\"ExternalId\\": \\"externalIdtest\\",\\n \\"RemarksB\\": \\"face1.jpg\\",\\n \\"ModifyTime\\": \\"2021-01-11T02:18:26.174Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>6CD6F064-6999-4B64-B057-5FBD09E48C46</RequestId>\\n<NextMarker>CAESEQoPCg0KCUZhY2VDb3VudBABGAEirQEKCQAFAAAAAAAAAAqfAQOaAAAAMVMzMTM3MzQzNjM0MzkzNTM4MzUzNzM2MzAzMjM3MzQzNTNhNjk2ZDZkNjk2ZDYxNjc2NTNhNzM2NTc0NzQ2NTczNzQuUzQ3NzI2Zjc1NzAyZDM0Mzg2NjY0NjQzNDYyNjQyZDM2MzI2MzMzMmQzNDY0NjE2MTJkNjE2NDM5MzgyZDYxNjUzNjYxMzQzMTM3MzM2MTMxMzMzMA==</NextMarker>\\n<FaceGroups>\\n <GroupName>facegrouptest</GroupName>\\n <GroupCoverFace>\\n <FaceId>b30a7a36997ce986965680fed90c397fc70a533af511346f819976c6a138c594</FaceId>\\n <FaceBoundary>\\n <Left>80</Left>\\n <Top>49</Top>\\n <Height>45</Height>\\n <Width>46</Width>\\n </FaceBoundary>\\n <ImageUri>oss://imm-test/testcases/face1.jpg</ImageUri>\\n </GroupCoverFace>\\n <ModifyTime>2021-01-11T02:18:26.174Z</ModifyTime>\\n <ExternalId>externalIdtest</ExternalId>\\n <CreateTime>2021-01-11T02:18:26.174Z</CreateTime>\\n <MaxAge>28</MaxAge>\\n <Gender>MALE</Gender>\\n <AverageAge>26.4</AverageAge>\\n <RemarksA>oss://imm-test/testcases/</RemarksA>\\n <RemarksB>face1.jpg</RemarksB>\\n <GroupId>Group-48fdd4bd-62c3-4daa-ad98-ae6a4173a130</GroupId>\\n <RemarksArrayB>[\\"remarksb1\\",\\"remarksb2\\"]</RemarksArrayB>\\n <MinAge>23</MinAge>\\n <ImageCount>5</ImageCount>\\n <RemarksC>浙江省杭州市</RemarksC>\\n <RemarksD>浙江省杭州市</RemarksD>\\n <RemarksArrayA>[\\"remarksa1\\",\\"remarksa2\\"]</RemarksArrayA>\\n <FaceCount>5</FaceCount>\\n</FaceGroups>","errorExample":""}]', + 'title' => '获取一个媒体集中的人脸分组列表', + 'summary' => '调用ListFaceGroups接口获取一个媒体集中的人脸分组列表。', + 'description' => '- 此接口已不再维护，建议使用新版（2020-09-30版本）接口[QueryFigureClusters](~~478183~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + ."\n" + .'- 如果需要根据标记信息等查询人脸分组，必须已调用[UpdateFaceGroup](~~110316~~)接口为人脸分组配置相应信息。'."\n" + ."\n" + .'> 接口公测中，如有任何使用问题，请使用钉钉搜索钉钉群号31690030817加入钉钉群进行反馈。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateFaceGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'set001', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '人脸分组的唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '人脸分组名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'mygroup', + ], + ], + [ + 'name' => 'GroupCoverFaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '人脸分组封面图的FaceId，可以使用媒体集图片处理相关接口（例如GetImage、ListImages等）获得该FaceId。'."\n" + ."\n" + .'FaceId必须为同一分组 （即GroupId相同）中的人脸ID。', + 'type' => 'string', + 'required' => false, + 'example' => '8ba3460c1dcaa81f53b56e30c69d46693db215cf19aa19265f979913c24c8ef1', + ], + ], + [ + 'name' => 'RemarksA', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息，为使用者预留的筛选参数，用于记录所需要的信息。'."\n" + ."\n" + .'在搜索等场景下，您可以以前缀匹配的方式将设置的值作为搜索条件，样例场景如下：'."\n" + ."\n" + .'- 作为客户端权限字段存入，例如AdminGroup/AdminUserA/，即可使用前缀过滤用户权限。'."\n" + .'- 作为客户端的相对路径存入，例如nas://path/to/file。', + 'type' => 'string', + 'required' => false, + 'example' => 'remarksa11', + ], + ], + [ + 'name' => 'RemarksB', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息，为使用者预留的筛选参数，用于记录所需要的信息。'."\n" + ."\n" + .'在搜索等场景下，您可以以前缀匹配的方式将设置的值作为搜索条件，样例场景如下：'."\n" + ."\n" + .'- 作为客户端权限字段存入，例如AdminGroup/AdminUserA/，即可使用前缀过滤用户权限。'."\n" + .'- 作为客户端的相对路径存入，例如nas://path/to/file。', + 'type' => 'string', + 'required' => false, + 'example' => 'remarksb11', + ], + ], + [ + 'name' => 'RemarksC', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息，为使用者预留的筛选参数，用于记录所需要的信息。'."\n" + ."\n" + .'在搜索等场景下，您可以以前缀匹配的方式将设置的值作为搜索条件，样例场景如下：'."\n" + ."\n" + .'- 作为客户端权限字段存入，例如AdminGroup/AdminUserA/，即可使用前缀过滤用户权限。'."\n" + .'- 作为客户端的相对路径存入，例如nas://path/to/file。', + 'type' => 'string', + 'required' => false, + 'example' => 'remarksc11', + ], + ], + [ + 'name' => 'RemarksD', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息，为使用者预留的筛选参数，用于记录所需要的信息。'."\n" + ."\n" + .'在搜索等场景下，您可以以前缀匹配的方式将设置的值作为搜索条件，样例场景如下：'."\n" + ."\n" + .'- 作为客户端权限字段存入，例如AdminGroup/AdminUserA/，即可使用前缀过滤用户权限。'."\n" + .'- 作为客户端的相对路径存入，例如nas://path/to/file。', + 'type' => 'string', + 'required' => false, + 'example' => 'remarksd11', + ], + ], + [ + 'name' => 'RemarksArrayA', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息列表，格式为数组。', + 'type' => 'string', + 'required' => false, + 'example' => '["remarka11","remarka12"]', + ], + ], + [ + 'name' => 'RemarksArrayB', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息列表，格式为数组。', + 'type' => 'string', + 'required' => false, + 'example' => '["remarkb11","remarkb12"]', + ], + ], + [ + 'name' => 'ExternalId', + 'in' => 'query', + 'schema' => [ + 'description' => '外部ID，用于和您的应用层的ID（如果有）进行绑定。', + 'type' => 'string', + 'required' => false, + 'example' => 'externalIdtest', + ], + ], + [ + 'name' => 'ResetItems', + 'in' => 'query', + 'schema' => [ + 'description' => '可以将对应字段设置为空值，格式为数组。'."\n" + ."\n" + .'数组内可用值有：'."\n" + .'- GroupName'."\n" + .'- RemarksA'."\n" + .'- RemarksB'."\n" + .'- RemarksC'."\n" + .'- RemarksD'."\n" + .'- RemarksArrayA'."\n" + .'- RemarksArrayB'."\n" + .'- ExternalId', + 'type' => 'string', + 'required' => false, + 'example' => '["GroupName"]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'A1104C7E-AA5E-4D5F-8A00-6BFD608103D2', + ], + 'SetId' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'example' => 'set001', + ], + 'GroupId' => [ + 'description' => '人脸分组的唯一标识。', + 'type' => 'string', + 'example' => 'Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A1104C7E-AA5E-4D5F-8A00-6BFD608103D2\\",\\n \\"SetId\\": \\"set001\\",\\n \\"GroupId\\": \\"Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>A1104C7E-AA5E-4D5F-8A00-6BFD608103D2</RequestId>\\n<SetId>set001</SetId>\\n<GroupId>Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09</GroupId>","errorExample":""}]', + 'title' => '更新媒体集中人脸分组', + 'summary' => '更新媒体集中人脸分组的名称、封面图、标签等信息。', + 'description' => '此接口已不再维护，建议使用新版（2020-09-30版本）接口[UpdateFigureCluster](~~478184~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + .'> 接口公测中，如有任何使用问题，请使用钉钉搜索钉钉群号31690030817加入钉钉群进行反馈。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateGroupFacesJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'set001', + ], + ], + [ + 'name' => 'NotifyTopicName', + 'in' => 'query', + 'schema' => [ + 'description' => '异步反向通知的TopicName。', + 'type' => 'string', + 'required' => false, + 'example' => 'topic1', + ], + ], + [ + 'name' => 'NotifyEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => '异步反向通知的Endpoint，文档转换状态可以通过该Endpoint异步通知给调用者。使用此功能需要先开通轻量消息队列（原 MNS）服务，新建topic和queue，并配置订阅关系。具体操作，请参见[轻量消息队列（原 MNS）快速入门](https://help.aliyun.com/document_detail/34412.html)。'."\n" + ."\n" + .'>轻量消息队列（原 MNS）服务和智能媒体管理必须处于同一地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'JobType' => [ + 'description' => '任务类型，返回值固定为GroupImageFacesJob。', + 'type' => 'string', + 'example' => 'GroupImageFacesJob', + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'BCF7B6EC-F97D-4594-866C-B421B82B24FE', + ], + 'SetId' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'example' => 'set001', + ], + 'JobId' => [ + 'description' => '人脸聚类任务的唯一标识。', + 'type' => 'string', + 'example' => 'GroupImageFacesJob-fb9586a7-f91d-46b9-8e70-b669892cf34d', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"JobType\\": \\"GroupImageFacesJob\\",\\n \\"RequestId\\": \\"BCF7B6EC-F97D-4594-866C-B421B82B24FE\\",\\n \\"SetId\\": \\"set001\\",\\n \\"JobId\\": \\"GroupImageFacesJob-fb9586a7-f91d-46b9-8e70-b669892cf34d\\"\\n}","errorExample":""},{"type":"xml","example":"<JobType>GroupImageFacesJob</JobType>\\n<RequestId>BCF7B6EC-F97D-4594-866C-B421B82B24FE</RequestId>\\n<SetId>set001</SetId>\\n<JobId>GroupImageFacesJob-fb9586a7-f91d-46b9-8e70-b669892cf34d</JobId>","errorExample":""}]', + 'title' => '人脸聚类', + 'summary' => '按照人物将人脸分组。', + 'description' => '- 此接口已不再维护，建议使用新版（2020-09-30版本）接口[CreateFigureClusteringTask](~~478180~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + ."\n" + .'- 人脸聚类任务执行完成后，使用ListFaceGroups接口查看已有分组列表，并可以使用FindImages接口根据GroupId搜索该组的人脸图片。'."\n" + ."\n" + .'- 人脸分组的GroupId以`Group-{UUID-v4}`格式命名，即Group-后接一个UUIDv4格式的字符串。人脸的分组包括如下保留的特殊分组命名：'."\n" + ."\n" + .' - group-none：该人脸暂无合适的分组，后续在媒体集中新增图片后进行人脸聚类操作时，该人脸可能被分入组中。'."\n" + ."\n" + .' - group-not-grouped：该人脸暂未进行过聚类操作，即在媒体集中新增图片后，未进行人脸聚类。'."\n" + ."\n" + .' - group-none-by-user：由用户手动操作，记录该人脸无合适的分组，后续在媒体集中新增图片后进行人脸聚类操作时，该人脸仍不会被分组。'."\n" + ."\n\n" + .'- 人脸聚类功能只对在2019年03月12日之后使用IndexImage接口将图片索引到媒体集中的图片有效。历史图片如需使用此功能，请从媒体集中删除并重新索引。'."\n" + ."\n" + .'- 该接口为增量聚类。调用该接口时，系统只会对媒体集中新增和未分组的图片进行分类，不会修改已分类人脸的分组。'."\n" + ."\n" + .'- 每个聚类任务的最长执行时间为2分钟，单次最多能处理5100张图片中的人脸。如果媒体集中添加的图片个数超过限制数量，则需要多次调用该接口。'."\n" + .'- 同一时间一个媒体集中只能进行一个聚类任务（包括CreateMergeFaceGroupsJob和CreateGroupFacesJob），因此调用该接口时，请确保上一次调用已执行完成。您可以使用通知机制，传入NotifyTopicName和NotifyEndpoint，及时获取任务执行结果的通知。'."\n" + ."\n" + .'- 如果一个分组已形成，则该分组不会合并到其他分组。', + 'requestParamsDescription' => '### 轻量消息队列（原 MNS）通知'."\n" + .'请求参数中如果设置了NotifyTopicName和NotifyEndpoint支持轻量消息队列（原 MNS）事件通知，则智能媒体管理会为您返回异步通知。通知的消息格式为：'."\n" + .'```'."\n" + .'{'."\n" + .' "events": ['."\n" + .' {'."\n" + .' "eventName": "GroupImageFacesJob",'."\n" + .' "eventSource": "acs:imm",'."\n" + .' "eventTime": "2019-02-20T11:06:25.264Z",'."\n" + .' "eventVersion": "1.0",'."\n" + .' "imm": {'."\n" + .' "ErrorCode": "",'."\n" + .' "JobId": "GroupImageFacesJob-fb9586a7-f91d-46b9-8e70-b669892cf34d",'."\n" + .' "NewGroupCount": "1",'."\n" + .' "SetId": "set001",'."\n" + .' "Success": "true",'."\n" + .' "UpdateFaceCount": "10",'."\n" + .' "UpdateGroupCount": "1"'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'```'."\n" + .'轻量消息队列（原 MNS）通知的返回参数说明请参见下表。'."\n" + .'|名称|类型|描述|'."\n" + .'|----|----|----|'."\n" + .'|eventName|String|任务类型，返回值固定为GroupImageFacesJob。|'."\n" + .'|imm.JobId|String|人脸聚类任务的唯一标识。|'."\n" + .'|imm.SetId|String|媒体集的唯一标识。|'."\n" + .'|imm.NewGroupCount|String|新增人脸分组数量。|'."\n" + .'|imm.UpdateFaceCount|String|更新人脸分组的人脸数量，包括新增图片和原有未分组图片中被分组的人脸。|'."\n" + .'|imm.UpdateGroupCount|String|更新的人脸分组数量。|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateMergeFaceGroupsJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'set001', + ], + ], + [ + 'name' => 'NotifyTopicName', + 'in' => 'query', + 'schema' => [ + 'description' => '异步反向通知的TopicName。', + 'type' => 'string', + 'required' => false, + 'example' => 'topic1', + ], + ], + [ + 'name' => 'NotifyEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => '异步反向通知的Endpoint，文档转换状态可以通过该Endpoint异步通知给调用者。使用此功能需要先开通轻量消息队列（原 MNS）服务，新建topic和queue，并配置订阅关系。具体操作，请参见[轻量消息队列（原 MNS）快速入门](https://help.aliyun.com/document_detail/34412.html)。'."\n" + ."\n" + .'> 轻量消息队列（原 MNS）服务和智能媒体管理必须处于同一地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + ], + ], + [ + 'name' => 'GroupIdFrom', + 'in' => 'query', + 'schema' => [ + 'description' => '待合并的分组的GroupId，该分组中的人脸将被合并到GroupIdTo对应分组中。', + 'type' => 'string', + 'required' => false, + 'example' => 'Group-c1f55987-360b-4640-9e2c-f5c29f930a3b', + ], + ], + [ + 'name' => 'GroupIdTo', + 'in' => 'query', + 'schema' => [ + 'description' => '待合并的分组的GroupId，该分组中将加入GroupIdFrom对应分组中的人脸。', + 'type' => 'string', + 'required' => false, + 'example' => 'Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09', + ], + ], + [ + 'name' => 'CustomMessage', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息，在通知时回原样返回。最长1024个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回字段', + 'type' => 'object', + 'properties' => [ + 'GroupIdFrom' => [ + 'description' => '待合并的分组的GroupId，该分组中的人脸将被合并到GroupIdTo对应分组中。', + 'type' => 'string', + 'example' => 'Group-c1f55987-360b-4640-9e2c-f5c29f930a3b', + ], + 'JobType' => [ + 'description' => '任务类型，返回值固定为MergeFaceGroupsJob。', + 'type' => 'string', + 'example' => 'MergeFaceGroupsJob', + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '3FF344BF-87A9-4AC3-A3DE-9E1FAED7D1FE', + ], + 'SetId' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'example' => 'set001', + ], + 'GroupIdTo' => [ + 'description' => '待合并的分组的GroupId，该分组中将加入GroupIdFrom对应分组中的人脸。', + 'type' => 'string', + 'example' => 'Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09', + ], + 'JobId' => [ + 'description' => '合并人脸分组任务的唯一标识。', + 'type' => 'string', + 'example' => 'MergeFaceGroupsJob-055995ef-9c5e-4db4-a99a-0900d1e31d26', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"GroupIdFrom\\": \\"Group-c1f55987-360b-4640-9e2c-f5c29f930a3b\\",\\n \\"JobType\\": \\"MergeFaceGroupsJob\\",\\n \\"RequestId\\": \\"3FF344BF-87A9-4AC3-A3DE-9E1FAED7D1FE\\",\\n \\"SetId\\": \\"set001\\",\\n \\"GroupIdTo\\": \\"Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09\\",\\n \\"JobId\\": \\"MergeFaceGroupsJob-055995ef-9c5e-4db4-a99a-0900d1e31d26\\"\\n}","errorExample":""},{"type":"xml","example":"<GroupIdFrom>Group-c1f55987-360b-4640-9e2c-f5c29f930a3b</GroupIdFrom>\\n<JobType>MergeFaceGroupsJob</JobType>\\n<RequestId>3FF344BF-87A9-4AC3-A3DE-9E1FAED7D1FE</RequestId>\\n<SetId>set001</SetId>\\n<GroupIdTo>Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09</GroupIdTo>\\n<JobId>MergeFaceGroupsJob-055995ef-9c5e-4db4-a99a-0900d1e31d26</JobId>","errorExample":""}]', + 'title' => '合并媒体集中的两个人脸分组', + 'summary' => '调用CreateMergeFaceGroupsJob接口合并媒体集中的两个人脸分组。', + 'description' => '- 此接口已不再维护，建议使用新版（2020-09-30版本）接口[CreateFigureClustersMergingTask](~~478181~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + ."\n" + .'- 同一时间一个媒体集中只能进行一个聚类任务（包括CreateMergeFaceGroupsJob和CreateGroupFacesJob），因此调用对应接口时，请确保上一次调用已执行完成。您可以使用通知机制，传入NotifyTopicName和NotifyEndpoint，及时获取任务执行结果的通知。具体操作，请参见[轻量消息队列（原 MNS）快速入门](https://help.aliyun.com/document_detail/34412.html)。'."\n" + ."\n" + .'- 每个合并人脸分组任务的最长执行时间为3分钟。'."\n" + ."\n" + .'> 接口公测中，如有任何使用问题，请使用钉钉搜索钉钉群号31690030817加入钉钉群进行反馈。', + 'requestParamsDescription' => '### 轻量消息队列（原 MNS）通知'."\n" + .'请求参数中如果设置了NotifyTopicName和NotifyEndpoint支持轻量消息队列（原 MNS）事件通知，则智能媒体管理会为您返回异步通知。通知的消息格式为：'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "events": ['."\n" + .' {'."\n" + .' "eventName": "MergeFaceGroupsJob",'."\n" + .' "eventSource": "acs:imm",'."\n" + .' "eventTime": "2019-02-20T11:06:25.264Z",'."\n" + .' "eventVersion": "1.0",'."\n" + .' "imm": {'."\n" + .' "ErrorCode": "",'."\n" + .' "JobId": "MergeFaceGroupsJob-73a65fd7-cabd-4e19-a110-a159d113c6b6",'."\n" + .' "SetId": "set001",'."\n" + .' "Success": "true",'."\n" + .' "UpdateFaceCount": "10",'."\n" + .' "CustomMessage": "abc",'."\n" + .' "GroupIdFrom": "Group-c1f55987-360b-4640-9e2c-f5c29f930a3b",'."\n" + .' "GroupIdTo": "Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09"'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'轻量消息队列（原 MNS）通知的返回参数说明请参见下表。'."\n" + .'|名称|类型|描述|'."\n" + .'|----|----|----|'."\n" + .'|eventName|String|任务类型，返回值固定为MergeFaceGroupsJob。|'."\n" + .'|imm.JobId|String|合并人脸分组任务的唯一标识。|'."\n" + .'|imm.SetId|String|媒体集的唯一标识。|'."\n" + .'|imm.UpdateFaceCount|String|更新人脸分组的人脸数量，包括新增图片和原有未分组图片中被分组的人脸。|'."\n" + .'|imm.CustomMessage|String|用户自定义信息。|'."\n" + .'|imm.GroupIdFrom|String|待合并的分组的GroupId，该分组中的人脸将被合并到GroupIdTo对应分组中。|'."\n" + .'|imm.GroupIdTo|String|待合并的分组的GroupId，该分组中将加入GroupIdFrom对应分组中的人脸。|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListSetTags' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'set001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'DC5CF0A7-7A3A-43D0-888C-AC275EA4A6F9', + ], + 'SetId' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'example' => 'set001', + ], + 'Tags' => [ + 'description' => '搜索到的图片标签信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagName' => [ + 'description' => '标签名称。', + 'type' => 'string', + 'example' => '人物', + ], + 'TagCount' => [ + 'description' => '标签出现次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TagLevel' => [ + 'description' => '标签级别，取值范围为1~4。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DC5CF0A7-7A3A-43D0-888C-AC275EA4A6F9\\",\\n \\"SetId\\": \\"set001\\",\\n \\"Tags\\": [\\n {\\n \\"TagName\\": \\"人物\\",\\n \\"TagCount\\": 5,\\n \\"TagLevel\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>DC5CF0A7-7A3A-43D0-888C-AC275EA4A6F9</RequestId>\\n<SetId>set001</SetId>\\n<Tags>\\n <TagCount>5</TagCount>\\n <TagName>人物</TagName>\\n <TagLevel>1</TagLevel>\\n</Tags>\\n<Tags>\\n <TagCount>5</TagCount>\\n <TagName>脸</TagName>\\n <TagLevel>2</TagLevel>\\n</Tags>","errorExample":""}]', + 'title' => '统计媒体集内标签', + 'summary' => '获取媒体集中Top 100的标签信息列表，返回结果按标签出现次数降序排列。', + 'description' => '此接口已不再维护，您可以使用新版（2020-09-30版本）接口[SimpleQuery](~~478175~~)统计数据集中的标签。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetImageQuality' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '图片的OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/qualitytest.jpg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ImageQuality' => [ + 'description' => '图片质量。', + 'type' => 'object', + 'properties' => [ + 'OverallScore' => [ + 'description' => '图片综合质量分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7759467363357544', + ], + 'Color' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片色度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ColorScore' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片色度的分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ContrastScore' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片对比度的分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'Contrast' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片对比度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ExposureScore' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片曝光程度的分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'ClarityScore' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片清晰度的分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'Clarity' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片清晰度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'Exposure' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片曝光程度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + 'CompositionScore' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'图片构成的分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6101377010345459', + ], + ], + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '7F89F18C-40BF-4E1C-95C4-324FF00BFAE8', + ], + 'ImageUri' => [ + 'description' => '图片的OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/qualitytest.jpg', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ImageQuality\\": {\\n \\"OverallScore\\": 0.7759467363357544,\\n \\"Color\\": 0.6101377010345459,\\n \\"ColorScore\\": 0.6101377010345459,\\n \\"ContrastScore\\": 0.6101377010345459,\\n \\"Contrast\\": 0.6101377010345459,\\n \\"ExposureScore\\": 0.6101377010345459,\\n \\"ClarityScore\\": 0.6101377010345459,\\n \\"Clarity\\": 0.6101377010345459,\\n \\"Exposure\\": 0.6101377010345459,\\n \\"CompositionScore\\": 0.6101377010345459\\n },\\n \\"RequestId\\": \\"7F89F18C-40BF-4E1C-95C4-324FF00BFAE8\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/qualitytest.jpg\\"\\n}","errorExample":""},{"type":"xml","example":"<ImageQuality>\\n <OverallScore>0.7759467363357544</OverallScore>\\n</ImageQuality>\\n<RequestId>7F89F18C-40BF-4E1C-95C4-324FF00BFAE8</RequestId>\\n<ImageUri>oss://imm-test/testcases/qualitytest.jpg</ImageUri>","errorExample":""}]', + 'title' => '获取图片综合质量分数', + 'summary' => '获取图片质量分数。', + 'description' => '- 此接口已不再维护，建议使用新版（2020-09-30版本）接口[DetectImageScore](~~478211~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + ."\n" + .'- 此接口不依赖媒体集。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetImageCroppingSuggestions' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '图片的OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/imagecroppingtest.jpg', + ], + ], + [ + 'name' => 'AspectRatios', + 'in' => 'query', + 'schema' => [ + 'description' => '裁剪比例列表，仅支持整数比例。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '["1:1","2:3"]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'EA153782-13A5-44EE-835A-90A14FC51352', + ], + 'ImageUri' => [ + 'description' => '图片的OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/imagecroppingtest.jpg', + ], + 'CroppingSuggestions' => [ + 'description' => '图片的裁剪建议。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Score' => [ + 'description' => '该裁剪方案的美学分数，分数越高表示该方案效果越好，取值范围为0～1。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6979608535766602', + ], + 'CroppingBoundary' => [ + 'description' => '裁剪框信息。', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '顶点Y坐标，距离顶端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '77', + ], + 'Width' => [ + 'description' => '裁剪框宽度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'Height' => [ + 'description' => '裁剪框高度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'Left' => [ + 'description' => '顶点X坐标，距离左端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'AspectRatio' => [ + 'description' => '图片裁剪比例。', + 'type' => 'string', + 'example' => '1:1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EA153782-13A5-44EE-835A-90A14FC51352\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/imagecroppingtest.jpg\\",\\n \\"CroppingSuggestions\\": [\\n {\\n \\"Score\\": 0.6979608535766602,\\n \\"CroppingBoundary\\": {\\n \\"Top\\": 77,\\n \\"Width\\": 500,\\n \\"Height\\": 500,\\n \\"Left\\": 0\\n },\\n \\"AspectRatio\\": \\"1:1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EA153782-13A5-44EE-835A-90A14FC51352</RequestId>\\n<ImageUri>oss://imm-test/testcases/imagecroppingtest.jpg</ImageUri>\\n<CroppingSuggestions>\\n <AspectRatio>1:1</AspectRatio>\\n <Score>0.6979608535766602</Score>\\n <CroppingBoundary>\\n <Left>0</Left>\\n <Top>77</Top>\\n <Height>500</Height>\\n <Width>500</Width>\\n </CroppingBoundary>\\n</CroppingSuggestions>\\n<CroppingSuggestions>\\n <AspectRatio>2:3</AspectRatio>\\n <Score>0.781792938709259</Score>\\n <CroppingBoundary>\\n <Left>0</Left>\\n <Top>77</Top>\\n <Height>750</Height>\\n <Width>500</Width>\\n </CroppingBoundary>\\n</CroppingSuggestions>","errorExample":""}]', + 'title' => '获取图片裁剪建议（裁剪框位置）', + 'summary' => '获取图片裁剪建议。', + 'description' => '- 此接口已不再维护，建议使用新版（2020-09-30版本）接口[DetectImageCropping](~~478214~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + ."\n" + .'- 此接口不依赖媒体集。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DetectQRCodes' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'SrcUris', + 'in' => 'query', + 'schema' => [ + 'description' => '图片的OSS URI，以JSON格式的字符串表示。当前仅支持1张图片。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'example' => '[“oss://imm-test/testcases/QRcodetest.jpg”]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SuccessDetails' => [ + 'description' => '成功项目列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SrcUri' => [ + 'description' => '图片的OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/QRcodetest.jpg', + ], + 'QRCodes' => [ + 'description' => '识别出的二维码信息。'."\n" + ."\n" + .'目前最多只能返回一个二维码。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'QRCodesRectangle' => [ + 'description' => '二维码位置框信息。', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '顶点Y坐标，距离顶端距离。单位为px。', + 'type' => 'string', + 'example' => '295', + ], + 'Width' => [ + 'description' => '二维码位置框宽度。单位为px。', + 'type' => 'string', + 'example' => '741', + ], + 'Height' => [ + 'description' => '二维码位置框高度。单位为px。', + 'type' => 'string', + 'example' => '706', + ], + 'Left' => [ + 'description' => '顶点X坐标，距离左端距离。单位为px。', + 'type' => 'string', + 'example' => '460', + ], + ], + ], + 'Content' => [ + 'description' => '二维码内容。', + 'type' => 'string', + 'example' => 'https://www.aliyun.com/product/imm', + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'E6A558B8-87C1-45BE-90B9-26049B0BAB01', + ], + 'FailDetails' => [ + 'description' => '失败项目列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The resource SrcUris is not valid. Please check.', + ], + 'SrcUri' => [ + 'description' => '图片的OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/QRcodetest.jpg', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'InvalidSrcUris', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"SuccessDetails\\": [\\n {\\n \\"SrcUri\\": \\"oss://imm-test/testcases/QRcodetest.jpg\\",\\n \\"QRCodes\\": [\\n {\\n \\"QRCodesRectangle\\": {\\n \\"Top\\": \\"295\\",\\n \\"Width\\": \\"741\\",\\n \\"Height\\": \\"706\\",\\n \\"Left\\": \\"460\\"\\n },\\n \\"Content\\": \\"https://www.aliyun.com/product/imm\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"E6A558B8-87C1-45BE-90B9-26049B0BAB01\\",\\n \\"FailDetails\\": [\\n {\\n \\"ErrorMessage\\": \\"The resource SrcUris is not valid. Please check.\\",\\n \\"SrcUri\\": \\"oss://imm-test/testcases/QRcodetest.jpg\\",\\n \\"ErrorCode\\": \\"InvalidSrcUris\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<SuccessDetails>\\n <SrcUri>oss://imm-test/testcases/QRcodetest.jpg</SrcUri>\\n <QRCodes>\\n <QRCodesRectangle>\\n <Left>460</Left>\\n <Top>295</Top>\\n <Height>706</Height>\\n <Width>741</Width>\\n </QRCodesRectangle>\\n <Content>https://www.aliyun.com/product/imm</Content>\\n </QRCodes>\\n</SuccessDetails>\\n<RequestId>E6A558B8-87C1-45BE-90B9-26049B0BAB01</RequestId>","errorExample":""}]', + 'title' => '二维码检测', + 'summary' => '二维码检测，建议换用DetectImageQRCodes。', + 'description' => '此接口已不再维护，建议使用新版（2020-09-30版本）接口[DetectImageCodes](~~478212~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### 错误码'."\n" + .'|HTTP状态码|错误码|错误信息|描述|'."\n" + .'|----|----|----|----|'."\n" + .'|400|InvalidSrcUris|The resource SrcUris is not valid. Please check.|图片资源无效、文件格式错误或文件不存在。|'."\n" + .'|400|InvalidParameter.SrcUris.NotSupported|The input parameter SrcUris is not supported. Support valid OSS uri in same region.|SrcUri文件路径错误，需要使用正确的OSS格式的路径。|', + ], + 'DetectImageQRCodes' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '图片的OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/QRcodetest.jpg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '52D33EAE-88B2-4ADE-A5DB-18BD426617A5', + ], + 'ImageUri' => [ + 'description' => '图片的OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/QRcodetest.jpg', + ], + 'QRCodes' => [ + 'description' => '识别出的二维码信息。'."\n" + ."\n" + .'目前最多只能返回一个二维码。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '二维码内容。', + 'type' => 'string', + 'example' => 'https://www.aliyun.com/product/imm', + ], + 'QRCodeBoundary' => [ + 'description' => '二维码位置框。', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '顶点Y坐标，距离顶端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '295', + ], + 'Width' => [ + 'description' => '二维码位置框宽度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '741', + ], + 'Height' => [ + 'description' => '二维码位置框高度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '706', + ], + 'Left' => [ + 'description' => '顶点X坐标，距离左端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '460', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"52D33EAE-88B2-4ADE-A5DB-18BD426617A5\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/QRcodetest.jpg\\",\\n \\"QRCodes\\": [\\n {\\n \\"Content\\": \\"https://www.aliyun.com/product/imm\\",\\n \\"QRCodeBoundary\\": {\\n \\"Top\\": 295,\\n \\"Width\\": 741,\\n \\"Height\\": 706,\\n \\"Left\\": 460\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>52D33EAE-88B2-4ADE-A5DB-18BD426617A5</RequestId>\\n<ImageUri>oss://imm-test/testcases/QRcodetest.jpg</ImageUri>\\n<QRCodes>\\n <Content>https://www.aliyun.com/product/imm</Content>\\n <QRCodeBoundary>\\n <Left>460</Left>\\n <Top>295</Top>\\n <Height>706</Height>\\n <Width>741</Width>\\n </QRCodeBoundary>\\n</QRCodes>","errorExample":""}]', + 'title' => '检测图片中二维码', + 'summary' => '检测图片中二维码的位置和内容。', + 'description' => '- 此接口已不再维护，建议使用新版（2020-09-30版本）接口[DetectImageCodes](~~478212~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + ."\n" + .'- 此接口不依赖媒体集。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DetectImageTags' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '图片的OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/facetest.jpg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '91AC8C98-0F36-49D2-8290-742E24DF1F69', + ], + 'ImageUri' => [ + 'description' => '图片的OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/facetest.jpg', + ], + 'Tags' => [ + 'description' => '标签识别结果列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParentTagEnName' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'父级标签英文名称。', + 'type' => 'string', + 'example' => 'person', + ], + 'TagName' => [ + 'description' => '标签名称。', + 'type' => 'string', + 'example' => '脸', + ], + 'TagConfidence' => [ + 'description' => '标签置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9897482395172119', + ], + 'CentricScore' => [ + 'description' => '标签主体分数。用于提示该标签内容在图片中的主要程度，越高则说明该标签越可能为图片主体。取值范围为0~1。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'TagEnName' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'标签英文名称。', + 'type' => 'string', + 'example' => 'face', + ], + 'TagLevel' => [ + 'description' => '标签级别，取值范围为1~4。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ParentTagName' => [ + 'description' => '父级标签名称。', + 'type' => 'string', + 'example' => '人物', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"91AC8C98-0F36-49D2-8290-742E24DF1F69\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/facetest.jpg\\",\\n \\"Tags\\": [\\n {\\n \\"ParentTagEnName\\": \\"person\\",\\n \\"TagName\\": \\"脸\\",\\n \\"TagConfidence\\": 0.9897482395172119,\\n \\"CentricScore\\": 0,\\n \\"TagEnName\\": \\"face\\",\\n \\"TagLevel\\": 2,\\n \\"ParentTagName\\": \\"人物\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>91AC8C98-0F36-49D2-8290-742E24DF1F69</RequestId>\\n<ImageUri>oss://imm-test/testcases/facetest.jpg</ImageUri>\\n<Tags>\\n <TagName>脸</TagName>\\n <TagConfidence>0.9897482395172119</TagConfidence>\\n <TagLevel>2</TagLevel>\\n <ParentTagName>人物</ParentTagName>\\n</Tags>\\n<Tags>\\n <TagName>人物</TagName>\\n <TagConfidence>0.9897482395172119</TagConfidence>\\n <TagLevel>1</TagLevel>\\n</Tags>","errorExample":""}]', + 'title' => '检测图片中的标签场景', + 'summary' => '检测图片中的标签信息。', + 'description' => '- 此接口已不再维护，建议使用新版（2020-09-30版本）接口[DetectImageLabels](~~478210~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + ."\n" + .'- 此接口不依赖媒体集。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DetectImageFaces' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '图片的OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/facetest.jpg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'D2C628B8-35DF-473C-8A41-757F30202ADC', + ], + 'ImageUri' => [ + 'description' => '图片的OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/facetest.png', + ], + 'Faces' => [ + 'description' => '人脸识别结果列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AttractiveConfidence' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'人脸吸引力置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9321795701980591', + ], + 'Gender' => [ + 'description' => '性别，可选项包括MALE和FEMALE。', + 'type' => 'string', + 'example' => 'FEMALE', + ], + 'GenderConfidence' => [ + 'description' => '性别置信度。取值范围为\\[0,1]，数值越大表示结果越可靠。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'FaceId' => [ + 'description' => '人脸ID。', + 'type' => 'string', + 'example' => '59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51', + ], + 'FaceAttributes' => [ + 'description' => '人脸其他属性。', + 'type' => 'object', + 'properties' => [ + 'GlassesConfidence' => [ + 'description' => '是否戴眼镜置信度。取值范围为\\[0,1]，数值越大表示结果越可靠。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Glasses' => [ + 'description' => '是否带眼镜。', + 'type' => 'string', + 'example' => 'NONE', + ], + 'Mask' => [ + 'description' => '是否带口罩。', + 'type' => 'string', + 'example' => 'NONE', + ], + 'BeardConfidence' => [ + 'description' => '是否有胡子置信度。取值范围为\\[0,1]，数值越大表示结果越可靠。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'MaskConfidence' => [ + 'description' => '是否带口罩置信度。取值范围为\\[0,1]，数值越大表示结果越可靠。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'FaceBoundary' => [ + 'description' => '人脸框。', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '顶点Y坐标，距离顶端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '191', + ], + 'Width' => [ + 'description' => '人脸框宽度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '269', + ], + 'Height' => [ + 'description' => '人脸框高度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '252', + ], + 'Left' => [ + 'description' => '顶点X坐标，距离左端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '95', + ], + ], + ], + 'HeadPose' => [ + 'description' => '头部朝向。', + 'type' => 'object', + 'properties' => [ + 'Pitch' => [ + 'description' => '人脸的俯仰角，取值范围为`-180～+180`度。'."\n" + ."\n" + .'可信的范围建议为`-30～+30`度，即在该范围内的结果比较可靠。', + 'type' => 'number', + 'format' => 'float', + 'example' => '18.38559913635254', + ], + 'Roll' => [ + 'description' => '内偏转角，即头部扭转角，取值范围为`-180～+180`度。'."\n" + ."\n" + .'可信的建议范围为`-45～+45`度，即在该范围内的结果比较可靠。', + 'type' => 'number', + 'format' => 'float', + 'example' => '4.204077243804932', + ], + 'Yaw' => [ + 'description' => '人脸的左右偏转角，取值范围为`-180～+180`度。'."\n" + ."\n" + .'可信的范围建议为`-80～+80`度，即在该范围内的结果比较可靠。', + 'type' => 'number', + 'format' => 'float', + 'example' => '2.49458646774292', + ], + ], + ], + 'Beard' => [ + 'description' => '是否有胡子。', + 'type' => 'string', + 'example' => 'NONE', + ], + ], + ], + 'FaceQuality' => [ + 'description' => '人脸质量。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9321795701980591', + ], + 'Emotion' => [ + 'description' => '心情。', + 'type' => 'string', + 'example' => 'HAPPY', + ], + 'Age' => [ + 'description' => '年龄。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '29', + ], + 'FaceConfidence' => [ + 'description' => '人脸置信度。取值范围为\\[0,1]，数值越大表示结果越可靠。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.960875928401947', + ], + 'EmotionConfidence' => [ + 'description' => '心情置信度。取值范围为\\[0,1]，数值越大表示结果越可靠。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7078456878662109', + ], + 'Attractive' => [ + 'description' => '人脸吸引力，取值范围为\\[0,1]，分数越高吸引力越强。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.96', + ], + 'AgeConfidence' => [ + 'description' => '当前版本不支持此参数。'."\n" + ."\n" + .'年龄置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9321795701980591', + ], + 'EmotionDetails' => [ + 'description' => '七种心情对应的置信度。取值范围为\\[0,1]，数值越大表示结果越可靠。', + 'type' => 'object', + 'properties' => [ + 'HAPPY' => [ + 'description' => 'HAPPY心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7078456878662109', + ], + 'CALM' => [ + 'description' => 'CALM心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.2919808030128479', + ], + 'SURPRISED' => [ + 'description' => 'SURPRISED心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.00006672900053672493', + ], + 'DISGUSTED' => [ + 'description' => 'DISGUSTED心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.00003373104118509218', + ], + 'ANGRY' => [ + 'description' => 'ANGRY心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.000012824941222788766', + ], + 'SAD' => [ + 'description' => 'SAD心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.00001525594689155696', + ], + 'SCARED' => [ + 'description' => 'SCARED心情置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0000014968593404773856', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D2C628B8-35DF-473C-8A41-757F30202ADC\\",\\n \\"ImageUri\\": \\"oss://imm-test/testcases/facetest.png\\",\\n \\"Faces\\": [\\n {\\n \\"AttractiveConfidence\\": 0.9321795701980591,\\n \\"Gender\\": \\"FEMALE\\",\\n \\"GenderConfidence\\": 1,\\n \\"FaceId\\": \\"59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51\\",\\n \\"FaceAttributes\\": {\\n \\"GlassesConfidence\\": 1,\\n \\"Glasses\\": \\"NONE\\",\\n \\"Mask\\": \\"NONE\\",\\n \\"BeardConfidence\\": 1,\\n \\"MaskConfidence\\": 1,\\n \\"FaceBoundary\\": {\\n \\"Top\\": 191,\\n \\"Width\\": 269,\\n \\"Height\\": 252,\\n \\"Left\\": 95\\n },\\n \\"HeadPose\\": {\\n \\"Pitch\\": 18.38559913635254,\\n \\"Roll\\": 4.204077243804932,\\n \\"Yaw\\": 2.49458646774292\\n },\\n \\"Beard\\": \\"NONE\\"\\n },\\n \\"FaceQuality\\": 0.9321795701980591,\\n \\"Emotion\\": \\"HAPPY\\",\\n \\"Age\\": 29,\\n \\"FaceConfidence\\": 0.960875928401947,\\n \\"EmotionConfidence\\": 0.7078456878662109,\\n \\"Attractive\\": 0.96,\\n \\"AgeConfidence\\": 0.9321795701980591,\\n \\"EmotionDetails\\": {\\n \\"HAPPY\\": 0.7078456878662109,\\n \\"CALM\\": 0.2919808030128479,\\n \\"SURPRISED\\": 0.00006672900053672493,\\n \\"DISGUSTED\\": 0.00003373104118509218,\\n \\"ANGRY\\": 0.000012824941222788766,\\n \\"SAD\\": 0.00001525594689155696,\\n \\"SCARED\\": 0.0000014968593404773856\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>D2C628B8-35DF-473C-8A41-757F30202ADC</RequestId>\\n<ImageUri>oss://imm-test/testcases/facetest.png</ImageUri>\\n<Faces>\\n <FaceConfidence>0.960875928401947</FaceConfidence>\\n <FaceId>59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51</FaceId>\\n <FaceQuality>0.9321795701980591</FaceQuality>\\n <Attractive>0.96</Attractive>\\n <GenderConfidence>1</GenderConfidence>\\n <EmotionConfidence>0.7078456878662109</EmotionConfidence>\\n <Emotion>HAPPY</Emotion>\\n <Gender>FEMALE</Gender>\\n <Age>29</Age>\\n</Faces>\\n<Faces>\\n <EmotionDetails>\\n <CALM>0.2919808030128479</CALM>\\n <SCARED>0.0000014968593404773856</SCARED>\\n <HAPPY>0.7078456878662109</HAPPY>\\n <SURPRISED>0.00006672900053672493</SURPRISED>\\n <SAD>0.00001525594689155696</SAD>\\n <DISGUSTED>0.00003373104118509218</DISGUSTED>\\n <ANGRY>0.000012824941222788766</ANGRY>\\n </EmotionDetails>\\n <FaceAttributes>\\n <Beard>NONE</Beard>\\n <FaceBoundary>\\n <Left>95</Left>\\n <Top>191</Top>\\n <Height>252</Height>\\n <Width>269</Width>\\n </FaceBoundary>\\n <BeardConfidence>1</BeardConfidence>\\n <HeadPose>\\n <Pitch>18.38559913635254</Pitch>\\n <Roll>4.204077243804932</Roll>\\n <Yaw>2.49458646774292</Yaw>\\n </HeadPose>\\n <MaskConfidence>1</MaskConfidence>\\n <Mask>NONE</Mask>\\n <Glasses>NONE</Glasses>\\n <GlassesConfidence>1</GlassesConfidence>\\n </FaceAttributes>\\n</Faces>","errorExample":""}]', + 'title' => '检测图片中的人脸及人脸信息', + 'summary' => '调用DetectImageFaces接口检测图片中的人脸及人脸信息。', + 'description' => '- 此接口已不再维护，建议使用新版（2020-09-30版本）接口[DetectImageFaces](~~478213~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + ."\n" + .'- 此接口不依赖媒体集。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DetectImageBodies' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '图片的OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/bodytest.jpg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '8AE4DA72-07F7-4BBC-8ECD-CBE8877BAD06', + ], + 'Bodies' => [ + 'description' => '人体信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BodyConfidence' => [ + 'description' => '人体置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9966312050819397', + ], + 'BodyBoundary' => [ + 'description' => '人体位置框。', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => '顶点Y坐标，距离顶端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '65', + ], + 'Width' => [ + 'description' => '人体位置框宽度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '372', + ], + 'Height' => [ + 'description' => '人体位置框高度。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '560', + ], + 'Left' => [ + 'description' => '顶点X坐标，距离左端距离。单位为px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '51', + ], + ], + ], + ], + ], + ], + 'ImageUri' => [ + 'description' => '图片的OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/bodytest.jpg', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8AE4DA72-07F7-4BBC-8ECD-CBE8877BAD06\\",\\n \\"Bodies\\": [\\n {\\n \\"BodyConfidence\\": 0.9966312050819397,\\n \\"BodyBoundary\\": {\\n \\"Top\\": 65,\\n \\"Width\\": 372,\\n \\"Height\\": 560,\\n \\"Left\\": 51\\n }\\n }\\n ],\\n \\"ImageUri\\": \\"oss://imm-test/testcases/bodytest.jpg\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>8AE4DA72-07F7-4BBC-8ECD-CBE8877BAD06</RequestId>\\n<Bodies>\\n <BodyConfidence>0.9966312050819397</BodyConfidence>\\n <BodyBoundary>\\n <Left>51</Left>\\n <Top>65</Top>\\n <Height>560</Height>\\n <Width>372</Width>\\n </BodyBoundary>\\n</Bodies>\\n<ImageUri>oss://imm-test/testcases/bodytest.jpg</ImageUri>","errorExample":""}]', + 'title' => '检测图片中的人体', + 'summary' => '检测图片中的人体信息。', + 'description' => '- 此接口已不再维护，建议使用新版（2020-09-30版本）接口[DetectImageBodies](~~478219~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + ."\n" + .'- 此接口不依赖媒体集。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'EncodeBlindWatermark' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '待添加盲水印图片的OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/watermarktestbefore.jpg', + ], + ], + [ + 'name' => 'WatermarkUri', + 'in' => 'query', + 'schema' => [ + 'description' => '水印图片的OSS地址。OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一地域的OSS Bucket名称，object为文件路径。'."\n" + .'> - 水印图片的大小建议不要超过2000 px。'."\n" + .'> - 参数WatermarkUri和参数Content必须至少设置一个。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'oss://imm-test/testcases/test.jpg', + ], + ], + [ + 'name' => 'TargetUri', + 'in' => 'query', + 'schema' => [ + 'description' => '添加盲水印后图片保存到的OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/watermarktestafter.jpg', + ], + ], + [ + 'name' => 'ImageQuality', + 'in' => 'query', + 'schema' => [ + 'description' => '输出图片的质量，默认值为90，取值范围为70~100。'."\n" + ."\n" + .'质量越高，图片尺寸越大，水印解析质量越高。', + 'type' => 'string', + 'required' => false, + 'example' => '90', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => '作为水印的文字内容，最多100字节。'."\n" + ."\n" + .'WatermarkUri参数和Content参数必须至少设置一个。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '阿里云版权所有', + ], + ], + [ + 'name' => 'TargetImageType', + 'in' => 'query', + 'schema' => [ + 'description' => '加水印后图片的存储格式，默认值为jpg，可选值包括jpg和png。', + 'type' => 'string', + 'required' => false, + 'example' => 'jpg', + ], + ], + [ + 'name' => 'Model', + 'in' => 'query', + 'schema' => [ + 'description' => '水印算法模型，默认值为FFT，可选值包括FFT、FFT\\_FULL、DWT和DWT\\_IBG，推荐您使用DWT\\_IBG。'."\n" + ."\n" + .'不同算法模型的区别请参见算法模型。', + 'type' => 'string', + 'required' => false, + 'example' => 'DWT_IBG', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '8E0DD64B-28C6-4653-8FF7-93E4C234BCF0', + ], + 'Content' => [ + 'description' => '只有当请求中设置了Content参数时，才有显示此参数。'."\n" + ."\n" + .'作为水印的文字内容。', + 'type' => 'string', + 'example' => '阿里云版权所有', + ], + 'TargetUri' => [ + 'description' => '添加水印后图片保存到的OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/watermarktestafter.jpg', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8E0DD64B-28C6-4653-8FF7-93E4C234BCF0\\",\\n \\"Content\\": \\"阿里云版权所有\\",\\n \\"TargetUri\\": \\"oss://imm-test/testcases/watermarktestafter.jpg\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>8E0DD64B-28C6-4653-8FF7-93E4C234BCF0</RequestId>\\n<Content>阿里云版权所有</Content>\\n<TargetUri>oss://imm-test/testcases/watermarktestafter.jpg</TargetUri>","errorExample":""}]', + 'title' => '添加图片盲水印', + 'summary' => '在图片中不能直接看到该水印，但可以通过DecodeBlindWatermark恢复图中隐藏的水印。', + 'description' => '- 此接口已不再维护，建议使用[新版（2020-09-30版本）API](~~478146~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + ."\n" + .'- 此接口不依赖媒体集。'."\n" + .'- 智能媒体管理支持将图片、文字作为盲水印添加到图片中。'."\n" + .'- 当添加盲水印的图片经过变换后，例如压缩、缩放等，图片的水印可能难以解析。'."\n" + .'- 对同一张图片，添加盲水印和解析盲水印时必须使用同一种算法，否则图片的水印无法进行解析。', + 'requestParamsDescription' => '# 算法模型'."\n" + .'|模型名称|解码是否需要原图|抗攻击能力|计算速度|限制|'."\n" + .'|----|----|----|----|----|'."\n" + .'|FFT|Y|较弱|一般|对色彩不够丰富的图片（例如线框图），添加盲水印后，图片可能会泛黄。|'."\n" + .'|FFT_FULL|Y|一般|慢|图片比FFT泛黄的概率小，但是速度会降低。|'."\n" + .'|DWT|N|较好|快|任意大小水印都可以用，但是有效水印信息为64 px×64 px的二值图。<br>无论输入何种水印图，该算法都会先变换水印图为64 px×64 px的二值图，所以当输入彩色水印或者非常大的水印时会存在信息损失。<br>被添加水印的图片大小不能过小，且较短边长需大于128像素。|'."\n" + .'|DWT_IBG|N|较好|快|DWT的优化方案，对纯色背景图片影响更小，对非纯色背景图片清晰度更高。|'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DecodeBlindWatermark' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immimagetest', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '已加盲水印图片的OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/watermarktestafter.jpg', + ], + ], + [ + 'name' => 'OriginalImageUri', + 'in' => 'query', + 'schema' => [ + 'description' => '添加盲水印前图片的OSS URI。'."\n" + ."\n" + .'对于DWT和DWT_IBG算法模型无需设置此参数。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/watermarktestbefore.jpg', + ], + ], + [ + 'name' => 'TargetUri', + 'in' => 'query', + 'schema' => [ + 'description' => '解析盲水印后图片保存到的OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/decodewatermarktest.jpg', + ], + ], + [ + 'name' => 'ImageQuality', + 'in' => 'query', + 'schema' => [ + 'description' => '输出图片的质量，默认值为90，取值范围为70~100。'."\n" + ."\n" + .'质量越高，图片尺寸越大，水印解析质量越高。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'example' => '90', + ], + ], + [ + 'name' => 'Model', + 'in' => 'query', + 'schema' => [ + 'description' => '水印算法模型，默认值为FFT，可选值包括FFT、FFT\\_FULL、DWT和DWT\\_IBG。'."\n" + ."\n" + .'关于不同算法模型的区别，请参见[EncodeBlindWatermark](https://help.aliyun.com/document_detail/138800.html)中的算法模型。'."\n" + ."\n" + .'> 对同一张图片，添加盲水印和解析盲水印时必须使用同一种算法，否则图片的水印无法进行解析。', + 'type' => 'string', + 'required' => false, + 'example' => 'DWT_IBG', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '3B2ED30A-5C90-40D7-903B-8C31C7DBA3C6', + ], + 'TargetUri' => [ + 'description' => '解析出的水印图片的OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/decodewatermarktest.jpg', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3B2ED30A-5C90-40D7-903B-8C31C7DBA3C6\\",\\n \\"TargetUri\\": \\"oss://imm-test/testcases/decodewatermarktest.jpg\\"\\n}","errorExample":""},{"type":"xml","example":"\\n<RequestId>3B2ED30A-5C90-40D7-903B-8C31C7DBA3C6</RequestId>\\n<TargetUri>oss://imm-test/testcases/decodewatermarktest.jpg</TargetUri>\\n","errorExample":""}]', + 'title' => '解析图片盲水印', + 'summary' => '解析由IMM添加的盲水印。', + 'description' => '- 此接口已不再维护，建议使用[新版（2020-09-30版本）API](~~478146~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + .'- 此接口不依赖媒体集。'."\n" + ."\n" + .'- 当添加盲水印的图片经过变换后，例如压缩、缩放等，图片的水印可能难以解析。'."\n" + .'- 对同一张图片，添加盲水印和解析盲水印时必须使用同一种算法，否则图片的水印无法进行解析。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetMediaMeta' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immvideotest', + ], + ], + [ + 'name' => 'MediaUri', + 'in' => 'query', + 'schema' => [ + 'description' => '视频的OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'MediaUri' => [ + 'description' => '视频的OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '2213B1A9-EB3D-4666-84E0-24980BCC4649', + ], + 'MediaMeta' => [ + 'description' => '多媒体信息。', + 'type' => 'object', + 'properties' => [ + 'MediaFormat' => [ + 'description' => '媒体格式信息。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '视频的创建时间。', + 'type' => 'string', + 'example' => '2020-10-25T09:16:09.000000Z', + ], + 'NumberPrograms' => [ + 'description' => '场景梳理。当前版本不支持此参数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'NumberStreams' => [ + 'description' => '媒体流数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Tag' => [ + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '标签创建时间。', + 'type' => 'string', + 'example' => '2020-10-25T09:16:09.000000Z', + ], + 'Album' => [ + 'description' => '专辑。当前版本不支持此参数。', + 'type' => 'string', + 'example' => 'unable', + ], + 'AlbumArtist' => [ + 'description' => '演唱者。当前版本不支持此参数。', + 'type' => 'string', + 'example' => 'unable', + ], + 'Performer' => [ + 'description' => '演奏者。当前版本不支持此参数。', + 'type' => 'string', + 'example' => 'unable', + ], + 'Composer' => [ + 'description' => '作曲家。当前版本不支持此参数。', + 'type' => 'string', + 'example' => 'unable', + ], + 'Artist' => [ + 'description' => '艺术家。当前版本不支持此参数。', + 'type' => 'string', + 'example' => 'unable', + ], + 'Title' => [ + 'description' => '名称。当前版本不支持此参数。', + 'type' => 'string', + 'example' => 'unable', + ], + 'Language' => [ + 'description' => '语言。当前版本不支持此参数。', + 'type' => 'string', + 'example' => 'unable', + ], + ], + ], + 'Bitrate' => [ + 'description' => '视频的码率，单位为比特每秒（bit/s）。', + 'type' => 'string', + 'example' => '13164131', + ], + 'StartTime' => [ + 'description' => '视频的首帧时间。', + 'type' => 'string', + 'example' => '0.000000', + ], + 'Size' => [ + 'description' => '视频文件大小，单位为字节。', + 'type' => 'string', + 'example' => '25115517', + ], + 'Address' => [ + 'description' => '视频地理位置检测结果。'."\n" + ."\n" + .'只有视频中包含地理位置信息时，检测结果才有值。', + 'type' => 'object', + 'properties' => [ + 'Township' => [ + 'description' => '视频地理位置所在街道（或同级）。', + 'type' => 'string', + 'example' => '转塘街道', + ], + 'District' => [ + 'description' => '视频地理位置所在区（或同级）。', + 'type' => 'string', + 'example' => '西湖区', + ], + 'AddressLine' => [ + 'description' => '视频地理位置的完整地址。', + 'type' => 'string', + 'example' => '中国浙江省杭州市西湖区转塘街道石龙山西路', + ], + 'Country' => [ + 'description' => '视频地理位置所在国家或地区。', + 'type' => 'string', + 'example' => '中国', + ], + 'City' => [ + 'description' => '视频地理位置所在城市（或同级）。', + 'type' => 'string', + 'example' => '杭州市', + ], + 'Province' => [ + 'description' => '视频地理位置所在省（或同级）。', + 'type' => 'string', + 'example' => '浙江省', + ], + ], + ], + 'FormatLongName' => [ + 'description' => '格式名称的全称。', + 'type' => 'string', + 'example' => 'QuickTime / MOV', + ], + 'Duration' => [ + 'description' => '视频的总时长。', + 'type' => 'string', + 'example' => '15.263000', + ], + 'FormatName' => [ + 'description' => '格式名称。', + 'type' => 'string', + 'example' => 'mov,mp4,m4a,3gp,3g2,mj2', + ], + 'Location' => [ + 'description' => '视频地理位置，从EXIF信息中获取，格式为lat,long，以英文逗号（,）分隔的浮点数。'."\n" + ."\n" + .'如果视频EXIF信息无此信息，则返回结果中无此参数。', + 'type' => 'string', + 'example' => '30.134390,120.074997', + ], + ], + ], + 'MediaStreams' => [ + 'description' => '媒体流信息。', + 'type' => 'object', + 'properties' => [ + 'VideoStreams' => [ + 'description' => '视频流信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'description' => '视频流索引号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CodecLongName' => [ + 'description' => '编码器名称的全称。', + 'type' => 'string', + 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', + ], + 'Height' => [ + 'description' => '视频画面高度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1920', + ], + 'SampleAspectRatio' => [ + 'description' => '采样率。', + 'type' => 'string', + 'example' => '1:1', + ], + 'AverageFrameRate' => [ + 'description' => '平均帧率。', + 'type' => 'string', + 'example' => '41580000/1373627', + ], + 'Bitrate' => [ + 'description' => '码率，单位为比特每秒（bit/s）。', + 'type' => 'string', + 'example' => '13091201', + ], + 'Rotate' => [ + 'description' => '视频画面旋转角度。', + 'type' => 'string', + 'example' => '90', + ], + 'CodecTagString' => [ + 'description' => '编码器标识描述信息。', + 'type' => 'string', + 'example' => 'avc1', + ], + 'Language' => [ + 'description' => '视频中使用的语言。', + 'type' => 'string', + 'example' => 'eng', + ], + 'HasBFrames' => [ + 'description' => '记录帧缓存大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'FrameRrate' => [ + 'description' => '真实基础帧率。', + 'type' => 'string', + 'example' => '90000/1', + ], + 'Profile' => [ + 'description' => 'Profile配置。', + 'type' => 'string', + 'example' => 'Baseline', + ], + 'StartTime' => [ + 'description' => '首帧时间。', + 'type' => 'string', + 'example' => '0.000000', + ], + 'Frames' => [ + 'description' => '帧数。', + 'type' => 'string', + 'example' => '462', + ], + 'CodecName' => [ + 'description' => '编码器名称。', + 'type' => 'string', + 'example' => 'h264', + ], + 'Width' => [ + 'description' => '视频画面宽度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1080', + ], + 'Duration' => [ + 'description' => '视频总时长，单位为秒。', + 'type' => 'string', + 'example' => '15.262522', + ], + 'DisplayAspectRatio' => [ + 'description' => '视频画面显示时的宽高比例。', + 'type' => 'string', + 'example' => '9:16', + ], + 'CodecTag' => [ + 'description' => '编码器标识。', + 'type' => 'string', + 'example' => '0x31637661', + ], + 'CodecTimeBase' => [ + 'description' => '编码器每帧时长。', + 'type' => 'string', + 'example' => '1373627/83160000', + ], + 'TimeBase' => [ + 'description' => '每帧时长。', + 'type' => 'string', + 'example' => '1/90000', + ], + 'Level' => [ + 'description' => '级别，可用于限制整体参数比率。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'PixelFormat' => [ + 'description' => '视频的存储格式。', + 'type' => 'string', + 'example' => 'yuv420p', + ], + ], + ], + ], + 'AudioStreams' => [ + 'description' => '音频流信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'description' => '音频流索引号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SampleRate' => [ + 'description' => '采样率。', + 'type' => 'string', + 'example' => '44100', + ], + 'ChannelLayout' => [ + 'description' => '声道设计。', + 'type' => 'string', + 'example' => 'mono', + ], + 'CodecLongName' => [ + 'description' => '编码器名称的全称。', + 'type' => 'string', + 'example' => 'AAC (Advanced Audio Coding)', + ], + 'Channels' => [ + 'description' => '声道数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Bitrate' => [ + 'description' => '码率，单位为比特每秒（bit/s）。', + 'type' => 'string', + 'example' => '64003', + ], + 'CodecTagString' => [ + 'description' => '编码器标识描述信息。', + 'type' => 'string', + 'example' => 'mp4a', + ], + 'Language' => [ + 'description' => '音频语言。', + 'type' => 'string', + 'example' => 'eng', + ], + 'StartTime' => [ + 'description' => '首帧时间。', + 'type' => 'string', + 'example' => '0.000000', + ], + 'SampleFormat' => [ + 'description' => '采样格式。', + 'type' => 'string', + 'example' => 'fltp', + ], + 'Frames' => [ + 'description' => '帧数。', + 'type' => 'string', + 'example' => '656', + ], + 'CodecName' => [ + 'description' => '编码器名称。', + 'type' => 'string', + 'example' => 'aac', + ], + 'Duration' => [ + 'description' => '音频总时长。', + 'type' => 'string', + 'example' => '15.256803', + ], + 'CodecTag' => [ + 'description' => '编码器标识。', + 'type' => 'string', + 'example' => '0x6134706d', + ], + 'CodecTimeBase' => [ + 'description' => '编码器每帧时长。', + 'type' => 'string', + 'example' => '1/44100', + ], + 'TimeBase' => [ + 'description' => '每帧时长。', + 'type' => 'string', + 'example' => '1/44100', + ], + ], + ], + ], + 'SubtitleStreams' => [ + 'description' => '字幕流信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'description' => '字幕流索引号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Language' => [ + 'description' => '字幕语言。', + 'type' => 'string', + 'example' => 'eng', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"MediaUri\\": \\"oss://imm-test/testcases/video.mp4\\",\\n \\"RequestId\\": \\"2213B1A9-EB3D-4666-84E0-24980BCC4649\\",\\n \\"MediaMeta\\": {\\n \\"MediaFormat\\": {\\n \\"CreationTime\\": \\"2020-10-25T09:16:09.000000Z\\",\\n \\"NumberPrograms\\": 2,\\n \\"NumberStreams\\": 2,\\n \\"Tag\\": {\\n \\"CreationTime\\": \\"2020-10-25T09:16:09.000000Z\\",\\n \\"Album\\": \\"unable\\",\\n \\"AlbumArtist\\": \\"unable\\",\\n \\"Performer\\": \\"unable\\",\\n \\"Composer\\": \\"unable\\",\\n \\"Artist\\": \\"unable\\",\\n \\"Title\\": \\"unable\\",\\n \\"Language\\": \\"unable\\"\\n },\\n \\"Bitrate\\": \\"13164131\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"Size\\": \\"25115517\\",\\n \\"Address\\": {\\n \\"Township\\": \\"转塘街道\\",\\n \\"District\\": \\"西湖区\\",\\n \\"AddressLine\\": \\"中国浙江省杭州市西湖区转塘街道石龙山西路\\",\\n \\"Country\\": \\"中国\\",\\n \\"City\\": \\"杭州市\\",\\n \\"Province\\": \\"浙江省\\"\\n },\\n \\"FormatLongName\\": \\"QuickTime / MOV\\",\\n \\"Duration\\": \\"15.263000\\",\\n \\"FormatName\\": \\"mov,mp4,m4a,3gp,3g2,mj2\\",\\n \\"Location\\": \\"30.134390,120.074997\\"\\n },\\n \\"MediaStreams\\": {\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Height\\": 1920,\\n \\"SampleAspectRatio\\": \\"1:1\\",\\n \\"AverageFrameRate\\": \\"41580000/1373627\\",\\n \\"Bitrate\\": \\"13091201\\",\\n \\"Rotate\\": \\"90\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"Language\\": \\"eng\\",\\n \\"HasBFrames\\": 2,\\n \\"FrameRrate\\": \\"90000/1\\",\\n \\"Profile\\": \\"Baseline\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"Frames\\": \\"462\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"Width\\": 1080,\\n \\"Duration\\": \\"15.262522\\",\\n \\"DisplayAspectRatio\\": \\"9:16\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"CodecTimeBase\\": \\"1373627/83160000\\",\\n \\"TimeBase\\": \\"1/90000\\",\\n \\"Level\\": 40,\\n \\"PixelFormat\\": \\"yuv420p\\"\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 1,\\n \\"SampleRate\\": \\"44100\\",\\n \\"ChannelLayout\\": \\"mono\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"Channels\\": 1,\\n \\"Bitrate\\": \\"64003\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"Language\\": \\"eng\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"SampleFormat\\": \\"fltp\\",\\n \\"Frames\\": \\"656\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"Duration\\": \\"15.256803\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"TimeBase\\": \\"1/44100\\"\\n }\\n ],\\n \\"SubtitleStreams\\": [\\n {\\n \\"Index\\": 2,\\n \\"Language\\": \\"eng\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<MediaUri>oss://imm-test/testcases/video.mp4</MediaUri>\\n<RequestId>2213B1A9-EB3D-4666-84E0-24980BCC4649</RequestId>\\n<MediaMeta>\\n <MediaFormat>\\n <Address>\\n <Township>转塘街道</Township>\\n <AddressLine>中国浙江省杭州市西湖区转塘街道石龙山西路</AddressLine>\\n <Country>中国</Country>\\n <City>杭州市</City>\\n <District>西湖区</District>\\n <Province>浙江省</Province>\\n </Address>\\n <Size>25115517</Size>\\n <NumberStreams>2</NumberStreams>\\n <FormatLongName>QuickTime / MOV</FormatLongName>\\n <CreationTime>2020-10-25T09:16:09.000000Z</CreationTime>\\n <StartTime>0</StartTime>\\n <FormatName>mov,mp4,m4a,3gp,3g2,mj2</FormatName>\\n <Duration>15.263</Duration>\\n <Bitrate>13164131</Bitrate>\\n <Location>30.134390,120.074997</Location>\\n <NumberPrograms/>\\n </MediaFormat>\\n <MediaStreams>\\n <VideoStreams>\\n <CodecTag>0x31637661</CodecTag>\\n <Frames>462</Frames>\\n <CodecTimeBase>1373627/83160000</CodecTimeBase>\\n <Rotate>90</Rotate>\\n <SampleAspectRatio>1:1</SampleAspectRatio>\\n <StartTime>0</StartTime>\\n <Duration>15.262522</Duration>\\n <Index>0</Index>\\n <Bitrate>13091201</Bitrate>\\n <CodecName>h264</CodecName>\\n <Profile>Baseline</Profile>\\n <DisplayAspectRatio>9:16</DisplayAspectRatio>\\n <HasBFrames>2</HasBFrames>\\n <CodecTagString>avc1</CodecTagString>\\n <AverageFrameRate>41580000/1373627</AverageFrameRate>\\n <Language>eng</Language>\\n <CodecLongName>H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10</CodecLongName>\\n <Level>40</Level>\\n <PixelFormat>yuv420p</PixelFormat>\\n <Height>1920</Height>\\n <FrameRrate>90000/1</FrameRrate>\\n <Width>1080</Width>\\n <TimeBase>1/90000</TimeBase>\\n </VideoStreams>\\n <SubtitleStreams>\\n <Language>eng</Language>\\n <Index>2</Index>\\n </SubtitleStreams>\\n <AudioStreams>\\n <CodecTag>0x31637661</CodecTag>\\n <Frames>656</Frames>\\n <CodecTimeBase>1/44100</CodecTimeBase>\\n <ChannelLayout>mono</ChannelLayout>\\n <StartTime>0</StartTime>\\n <Duration>15.256803</Duration>\\n <Index>1</Index>\\n <Bitrate>64003</Bitrate>\\n <CodecName>aac</CodecName>\\n <Channels>1</Channels>\\n <SampleFormat>fltp</SampleFormat>\\n <CodecTagString>mp4a</CodecTagString>\\n <SampleRate>44100</SampleRate>\\n <Language>eng</Language>\\n <CodecLongName>AAC (Advanced Audio Coding)</CodecLongName>\\n <TimeBase>1/44100</TimeBase>\\n </AudioStreams>\\n </MediaStreams>\\n</MediaMeta>","errorExample":""}]', + 'title' => '获取多媒体文件信息', + 'summary' => '获取多媒体文件信息，如编码、码率、分辨率、流信息等。', + 'description' => '此接口已不再维护，建议使用新版（2020-09-30版本）接口[DetectMediaMeta](~~478222~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'IndexVideo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immvideotest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'videotest', + ], + ], + [ + 'name' => 'VideoUri', + 'in' => 'query', + 'schema' => [ + 'description' => '视频的OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + ], + [ + 'name' => 'RemarksA', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息，为使用者预留的筛选参数，用于记录所需要的信息。'."\n" + ."\n" + .'在搜索等场景下，您可以以前缀匹配的方式将设置的值作为搜索条件，样例场景如下：'."\n" + ."\n" + .'- 作为客户端权限字段存入，例如AdminGroup/AdminUserA/，即可使用前缀过滤用户权限。'."\n" + .'- 作为客户端的相对路径存入，例如nas://path/to/file。', + 'type' => 'string', + 'required' => false, + 'example' => 'AdminGroup/AdminUserA/', + ], + ], + [ + 'name' => 'RemarksB', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息，为使用者预留的筛选参数，用于记录所需要的信息。'."\n" + ."\n" + .'在搜索等场景下，您可以以前缀匹配的方式将设置的值作为搜索条件，样例场景如下：'."\n" + ."\n" + .'- 作为客户端权限字段存入，例如AdminGroup/AdminUserA/，即可使用前缀过滤用户权限。'."\n" + .'- 作为客户端的相对路径存入，例如nas://path/to/file。', + 'type' => 'string', + 'required' => false, + 'example' => 'nas://path/to/file', + ], + ], + [ + 'name' => 'TgtUri', + 'in' => 'query', + 'schema' => [ + 'description' => '存储数据的OSS地址。不支持此参数。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://imm-test/testcases', + ], + ], + [ + 'name' => 'RemarksC', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息，为使用者预留的筛选参数，用于记录所需要的信息。'."\n" + ."\n" + .'在搜索等场景下，您可以以前缀匹配的方式将设置的值作为搜索条件，样例场景如下：'."\n" + ."\n" + .'- 作为客户端权限字段存入，例如AdminGroup/AdminUserA/，即可使用前缀过滤用户权限。'."\n" + .'- 作为客户端的相对路径存入，例如nas://path/to/file。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'remarkc', + ], + ], + [ + 'name' => 'RemarksD', + 'in' => 'query', + 'schema' => [ + 'description' => '标记信息，为使用者预留的筛选参数，用于记录所需要的信息。'."\n" + ."\n" + .'在搜索等场景下，您可以以前缀匹配的方式将设置的值作为搜索条件，样例场景如下：'."\n" + ."\n" + .'- 作为客户端权限字段存入，例如AdminGroup/AdminUserA/，即可使用前缀过滤用户权限。'."\n" + .'- 作为客户端的相对路径存入，例如nas://path/to/file。', + 'type' => 'string', + 'required' => false, + 'example' => 'remarkd', + ], + ], + [ + 'name' => 'ExternalId', + 'in' => 'query', + 'schema' => [ + 'description' => '外部ID，用于和您的应用层的ID（如果有）进行绑定。', + 'type' => 'string', + 'required' => false, + 'example' => 'externalId001', + ], + ], + [ + 'name' => 'NotifyTopicName', + 'in' => 'query', + 'schema' => [ + 'description' => '异步反向通知的TopicName。', + 'type' => 'string', + 'required' => false, + 'example' => 'topic2', + ], + ], + [ + 'name' => 'NotifyEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => '异步反向通知的Endpoint，视频处理结果可以通过该Endpoint异步通知给调用者。使用此功能需要先开通轻量消息队列（原 MNS）服务，新建topic和queue，并配置订阅关系。具体操作，请参见[轻量消息队列（原 MNS）快速入门概述](https://help.aliyun.com/document_detail/34412.html)。'."\n" + ."\n" + .'> 轻量消息队列（原 MNS）服务和智能媒体管理必须处于同一地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ModifyTime' => [ + 'description' => '视频的修改时间。'."\n" + ."\n" + .'添加视频后，如果未修改过视频，则视频的修改时间和视频加入媒体集的时间相同。', + 'type' => 'string', + 'example' => '2021-01-21T07:40:41.683Z', + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '896ABAD1-C452-4BED-B5E0-302955F8BAB5', + ], + 'CreateTime' => [ + 'description' => '视频加入媒体集的时间。', + 'type' => 'string', + 'example' => '2021-01-21T07:40:41.683Z', + ], + 'ExternalId' => [ + 'description' => '外部ID，用于和您的应用层的ID（如果有）进行绑定。', + 'type' => 'string', + 'example' => 'externalId001', + ], + 'VideoUri' => [ + 'description' => '视频的OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + 'RemarksA' => [ + 'description' => '标记信息。'."\n" + ."\n" + .'如果请求时未设置此参数，则返回值为空。', + 'type' => 'string', + 'example' => 'AdminGroup/AdminUserA/', + ], + 'RemarksB' => [ + 'description' => '标记信息。'."\n" + ."\n" + .'如果请求时未设置此参数，则返回值为空。', + 'type' => 'string', + 'example' => 'nas://path/to/file', + ], + 'RemarksC' => [ + 'description' => '标记信息。'."\n" + ."\n" + .'如果请求时未设置此参数，则返回值为空。', + 'type' => 'string', + 'example' => 'remarkc', + ], + 'RemarksD' => [ + 'description' => '标记信息。'."\n" + ."\n" + .'如果请求时未设置此参数，则返回值为空。', + 'type' => 'string', + 'example' => 'remarkd', + ], + 'SetId' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'example' => 'videoset', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ModifyTime\\": \\"2021-01-21T07:40:41.683Z\\",\\n \\"RequestId\\": \\"896ABAD1-C452-4BED-B5E0-302955F8BAB5\\",\\n \\"CreateTime\\": \\"2021-01-21T07:40:41.683Z\\",\\n \\"ExternalId\\": \\"externalId001\\",\\n \\"VideoUri\\": \\"oss://imm-test/testcases/video.mp4\\",\\n \\"RemarksA\\": \\"AdminGroup/AdminUserA/\\",\\n \\"RemarksB\\": \\"nas://path/to/file\\",\\n \\"RemarksC\\": \\"remarkc\\",\\n \\"RemarksD\\": \\"remarkd\\",\\n \\"SetId\\": \\"videoset\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyTime>2021-01-21T07:40:41.683Z</ModifyTime>\\n<RemarksC>remarkc</RemarksC>\\n<RemarksD>remarkd</RemarksD>\\n<RequestId>896ABAD1-C452-4BED-B5E0-302955F8BAB5</RequestId>\\n<ExternalId>externalId001</ExternalId>\\n<CreateTime>2021-01-21T07:40:41.683Z</CreateTime>\\n<VideoUri>oss://imm-test/testcases/video.mp4</VideoUri>\\n<RemarksA>AdminGroup/AdminUserA/</RemarksA>\\n<SetId>videoset</SetId>\\n<RemarksB>nas://path/to/file</RemarksB>","errorExample":""}]', + 'title' => '对视频进行自动截帧、分组、识别操作', + 'summary' => '调用IndexVideo接口将视频添加到媒体集中，并对视频进行自动截帧、分组、识别等操作。', + 'description' => '此接口已不再维护，建议使用新版（2020-09-30版本）接口[IndexFileMeta](~~478166~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListVideos' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immvideotest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'videotest', + ], + ], + [ + 'name' => 'CreateTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '视频创建时间的起始点，返回的视频均在此时间后加入媒体集。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2021-01-21T06:40:41.683Z', + ], + ], + [ + 'name' => 'Marker', + 'in' => 'query', + 'schema' => [ + 'description' => '从Marker开始按字典序返回视频信息列表。如果不设置此参数，则从头开始返回视频信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'CAESEgoQCg4KCkNyZWF0ZVRpbWUQABgBItcBCgkAIUv1J88rSRYKyQEDxAAAADFTMzEzNzM0MzYzNDM5MzUzODM1MzczNjMwMzIzNzM0MzUzYTY5NmQ2ZDY5NmQ2MTY3NjUzYTczNjU3NDMwMzAzMTNhMzc2NTY1NjM2NTMyMzQzNjYyMzUzMjM3MzgzODMwMzA2MzM4NjE2NDM4NjQ2MzY2NjE2MTMxNjMzNDMxNjY2MTY0MzEzODM0NjMzOTMzNjQ2MTM2MzUzMjY2NjYzMjMzNjUzNzM1NjUzNzM3MzM2MTY0MzEzMTM2MzYzMTM4Mzk=', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'B1469D0A-862A-405E-B81B-37760516627D', + ], + 'NextMarker' => [ + 'description' => '下一次列出视频信息时以此值为Marker，将未返回的结果返回。 '."\n" + ."\n" + .'当视频信息未全部返回时，此参数才有值。', + 'type' => 'string', + 'example' => 'CAESEgoQCg4KCkNyZWF0ZVRpbWUQABgBItcBCgkAIUv1J88rSRYKyQEDxAAAADFTMzEzNzM0MzYzNDM5MzUzODM1MzczNjMwMzIzNzM0MzUzYTY5NmQ2ZDY5NmQ2MTY3NjUzYTczNjU3NDMwMzAzMTNhMzc2NTY1NjM2NTMyMzQzNjYyMzUzMjM3MzgzODMwMzA2MzM4NjE2NDM4NjQ2MzY2NjE2MTMxNjMzNDMxNjY2MTY0MzEzODM0NjMzOTMzNjQ2MTM2MzUzMjY2NjYzMjMzNjUzNzM1NjUzNzM3MzM2MTY0MzEzMTM2MzYzMTM4Mzk=', + ], + 'SetId' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'example' => 'videoset', + ], + 'Videos' => [ + 'description' => '视频信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => '视频加入媒体集的时间。', + 'type' => 'string', + 'example' => '2021-01-21T07:40:41.683Z', + ], + 'RemarksC' => [ + 'description' => '标记信息。', + 'type' => 'string', + 'example' => 'remarkc', + ], + 'VideoTagsFailReason' => [ + 'description' => '视频标签处理的失败原因。', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'SourceType' => [ + 'description' => '源数据的类型。', + 'type' => 'string', + 'example' => 'video', + ], + 'VideoDuration' => [ + 'description' => '视频时长，单位为秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '15.263', + ], + 'VideoTags' => [ + 'description' => '视频标签处理结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagName' => [ + 'description' => '标签名称。', + 'type' => 'string', + 'example' => '大型超市', + ], + 'TagConfidence' => [ + 'description' => '标签置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8933850526809692', + ], + 'TagLevel' => [ + 'description' => '标签级别，取值范围为1~4。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ParentTagName' => [ + 'description' => '父级标签名称。', + 'type' => 'string', + 'example' => '内部场景', + ], + ], + ], + ], + 'ProcessModifyTime' => [ + 'description' => '视频处理的更新时间。', + 'type' => 'string', + 'example' => '2021-01-21T07:40:53.955Z', + ], + 'VideoFrames' => [ + 'description' => '帧数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '462', + ], + 'VideoTagsStatus' => [ + 'description' => '视频标签处理的状态，包括如下选项：'."\n" + ."\n" + .'- NotProcessed：未处理'."\n" + .'- Processing：处理中'."\n" + .'- Success：成功'."\n" + .'- Failed ：失败'."\n" + ."\n" + .'您可以根据该状态决定读取结果、等待或重试。', + 'type' => 'string', + 'example' => 'Success', + ], + 'ExternalId' => [ + 'description' => '外部ID，用于和您的应用层的ID（如果有）进行绑定。', + 'type' => 'string', + 'example' => 'externalId001', + ], + 'SourceUri' => [ + 'description' => '视频的OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + 'FileSize' => [ + 'description' => '文件大小，单位为字节。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '25115517', + ], + 'ModifyTime' => [ + 'description' => '视频的修改时间。'."\n" + ."\n" + .'添加视频到媒体集后，如果未修改过视频，则视频的修改时间和视频加入媒体集的时间相同。', + 'type' => 'string', + 'example' => '2021-01-21T07:40:41.683Z', + ], + 'SourcePosition' => [ + 'description' => '视频中该图片帧处于源视频的时间轴位置。格式为00000000.010，即%8.3f。', + 'type' => 'string', + 'example' => '00000000.010', + ], + 'VideoWidth' => [ + 'description' => '视频画面的宽度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1080', + ], + 'VideoFormat' => [ + 'description' => '视频格式。', + 'type' => 'string', + 'example' => 'mov,mp4,m4a,3gp,3g2,mj2', + ], + 'VideoHeight' => [ + 'description' => '视频画面的高度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1920', + ], + 'RemarksD' => [ + 'description' => '标记信息。', + 'type' => 'string', + 'example' => 'remarkd', + ], + 'VideoUri' => [ + 'description' => '视频的OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + 'ProcessFailReason' => [ + 'description' => '视频处理的失败原因。', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'VideoTagsModifyTime' => [ + 'description' => '视频标签处理的更新时间。当VideoTagsStatus更改时更新。', + 'type' => 'string', + 'example' => '2021-01-21T07:40:53.95Z', + ], + 'RemarksA' => [ + 'description' => '标记信息。', + 'type' => 'string', + 'example' => 'AdminGroup/AdminUserA/', + ], + 'ProcessStatus' => [ + 'description' => '视频处理的状态。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RemarksB' => [ + 'description' => '标记信息。', + 'type' => 'string', + 'example' => 'nas://path/to/file', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B1469D0A-862A-405E-B81B-37760516627D\\",\\n \\"NextMarker\\": \\"CAESEgoQCg4KCkNyZWF0ZVRpbWUQABgBItcBCgkAIUv1J88rSRYKyQEDxAAAADFTMzEzNzM0MzYzNDM5MzUzODM1MzczNjMwMzIzNzM0MzUzYTY5NmQ2ZDY5NmQ2MTY3NjUzYTczNjU3NDMwMzAzMTNhMzc2NTY1NjM2NTMyMzQzNjYyMzUzMjM3MzgzODMwMzA2MzM4NjE2NDM4NjQ2MzY2NjE2MTMxNjMzNDMxNjY2MTY0MzEzODM0NjMzOTMzNjQ2MTM2MzUzMjY2NjYzMjMzNjUzNzM1NjUzNzM3MzM2MTY0MzEzMTM2MzYzMTM4Mzk=\\",\\n \\"SetId\\": \\"videoset\\",\\n \\"Videos\\": [\\n {\\n \\"CreateTime\\": \\"2021-01-21T07:40:41.683Z\\",\\n \\"RemarksC\\": \\"remarkc\\",\\n \\"VideoTagsFailReason\\": \\"Timeout\\",\\n \\"SourceType\\": \\"video\\",\\n \\"VideoDuration\\": 15.263,\\n \\"VideoTags\\": [\\n {\\n \\"TagName\\": \\"大型超市\\",\\n \\"TagConfidence\\": 0.8933850526809692,\\n \\"TagLevel\\": 2,\\n \\"ParentTagName\\": \\"内部场景\\"\\n }\\n ],\\n \\"ProcessModifyTime\\": \\"2021-01-21T07:40:53.955Z\\",\\n \\"VideoFrames\\": 462,\\n \\"VideoTagsStatus\\": \\"Success\\",\\n \\"ExternalId\\": \\"externalId001\\",\\n \\"SourceUri\\": \\"oss://imm-test/testcases/video.mp4\\",\\n \\"FileSize\\": 25115517,\\n \\"ModifyTime\\": \\"2021-01-21T07:40:41.683Z\\",\\n \\"SourcePosition\\": \\"00000000.010\\",\\n \\"VideoWidth\\": 1080,\\n \\"VideoFormat\\": \\"mov,mp4,m4a,3gp,3g2,mj2\\",\\n \\"VideoHeight\\": 1920,\\n \\"RemarksD\\": \\"remarkd\\",\\n \\"VideoUri\\": \\"oss://imm-test/testcases/video.mp4\\",\\n \\"ProcessFailReason\\": \\"Timeout\\",\\n \\"VideoTagsModifyTime\\": \\"2021-01-21T07:40:53.95Z\\",\\n \\"RemarksA\\": \\"AdminGroup/AdminUserA/\\",\\n \\"ProcessStatus\\": \\"Success\\",\\n \\"RemarksB\\": \\"nas://path/to/file\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>B1469D0A-862A-405E-B81B-37760516627D</RequestId>\\n<NextMarker/>\\n<SetId>videoset</SetId>\\n<Videos>\\n <ModifyTime>2021-01-21T07:40:41.683Z</ModifyTime>\\n <ProcessStatus>Success</ProcessStatus>\\n <VideoWidth>1080</VideoWidth>\\n <SourceUri>oss://imm-test/testcases/video.mp4</SourceUri>\\n <SourceType>video</SourceType>\\n <RemarksA>AdminGroup/AdminUserA/</RemarksA>\\n <RemarksB>nas://path/to/file</RemarksB>\\n <RemarksC>remarkc</RemarksC>\\n <RemarksD>remarkd</RemarksD>\\n <VideoHeight>1920</VideoHeight>\\n <VideoTagsFailReason>Timeout</VideoTagsFailReason>\\n <VideoTagsModifyTime>2021-01-21T07:40:53.95Z</VideoTagsModifyTime>\\n <VideoFrames>462</VideoFrames>\\n <ProcessModifyTime>2021-01-21T07:40:53.955Z</ProcessModifyTime>\\n <ProcessFailReason>Timeout</ProcessFailReason>\\n <ExternalId>externalId001</ExternalId>\\n <CreateTime>2021-01-21T07:40:41.683Z</CreateTime>\\n <VideoUri>oss://imm-test/testcases/video.mp4</VideoUri>\\n <VideoFormat>mov,mp4,m4a,3gp,3g2,mj2</VideoFormat>\\n <VideoDuration>15.263</VideoDuration>\\n <VideoTagsStatus>Success</VideoTagsStatus>\\n <FileSize>25115517</FileSize>\\n <VideoTags>\\n <TagName>内部场景</TagName>\\n <TagConfidence>0.9230213165283203</TagConfidence>\\n <TagLevel>1</TagLevel>\\n </VideoTags>\\n <VideoTags>\\n <TagName>大型超市</TagName>\\n <TagConfidence>0.8933850526809692</TagConfidence>\\n <TagLevel>2</TagLevel>\\n <ParentTagName>内部场景</ParentTagName>\\n </VideoTags>\\n</Videos>","errorExample":""}]', + 'title' => '获取多个视频的信息', + 'summary' => '调用ListVideos接口获取媒体集中的视频信息列表，返回结果以视频加入媒体集的时间升序排序。', + 'description' => '此接口已不再维护，建议使用新版（2020-09-30版本）[查询与统计](~~2402363~~)相关接口。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetVideo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immvideotest', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'videoset', + ], + ], + [ + 'name' => 'VideoUri', + 'in' => 'query', + 'schema' => [ + 'description' => '视频的OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ModifyTime' => [ + 'description' => '视频的修改时间。'."\n" + ."\n" + .'添加视频到媒体集后，如果未修改过视频，则视频的修改时间和视频加入媒体集的时间相同。', + 'type' => 'string', + 'example' => '2021-01-21T07:40:41.683Z', + ], + 'ProcessStatus' => [ + 'description' => '视频处理的状态。', + 'type' => 'string', + 'example' => 'Success', + ], + 'VideoWidth' => [ + 'description' => '视频画面的宽度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1080', + ], + 'SourceType' => [ + 'description' => '源数据的类型。', + 'type' => 'string', + 'example' => 'video', + ], + 'SourceUri' => [ + 'description' => '视频的OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + 'VideoInfo' => [ + 'description' => '视频信息。', + 'type' => 'string', + 'example' => '{"MediaStreams":{"VideoStreams":[{"Index":0,"Language":"eng","CodecName":"h264","CodecLongName":"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10","Profile":"Baseline","CodecTimeBase":"1373627/83160000","CodecTagString":"avc1","CodecTag":"0x31637661","Width":1080,"Height":1920,"SampleAspectRatio":"1:1","DisplayAspectRatio":"9:16","PixelFormat":"yuv420p","Level":40,"FrameRrate":"90000/1","AverageFrameRate":"41580000/1373627","TimeBase":"1/90000","StartTime":"0.000000","Duration":"15.262522","Bitrate":"13091201","Frames":"462"}],"AudioStreams":[],"SubtitleStreams":[]},"MediaFormat":{"NumberStreams":2,"FormatName":"mov,mp4,m4a,3gp,3g2,mj2","FormatLongName":"QuickTime / MOV","Size":"25115517","Duration":"15.263000","StartTime":"0.000000","Bitrate":"13164131","CreationTime":"2020-10-25T09:16:09.000000Z","Address":{},"Tag":{}}}', + ], + 'VideoFrameTagsModifyTime' => [ + 'description' => '视频帧标签识别的更新时间。', + 'type' => 'string', + 'example' => '1970-01-01T00:00:00Z', + ], + 'RemarksA' => [ + 'description' => '标记信息。', + 'type' => 'string', + 'example' => 'AdminGroup/AdminUserA/', + ], + 'VideoFacesFailReason' => [ + 'description' => '视频人脸识别的失败原因。', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'RemarksB' => [ + 'description' => '标记信息。', + 'type' => 'string', + 'example' => 'nas://path/to/file', + ], + 'VideoFacesStatus' => [ + 'description' => '视频人脸识别的状态。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RemarksC' => [ + 'description' => '标记信息。', + 'type' => 'string', + 'example' => 'remarkc', + ], + 'VideoOCRModifyTime' => [ + 'description' => 'OCR识别的更新时间。', + 'type' => 'string', + 'example' => '1970-01-01T00:00:00Z', + ], + 'RemarksD' => [ + 'description' => '标记信息。', + 'type' => 'string', + 'example' => 'remarkd', + ], + 'VideoHeight' => [ + 'description' => '视频画面的高度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1920', + ], + 'SourcePosition' => [ + 'description' => '视频中该图片帧处于源视频的时间轴位置。格式为00000000.010，即%8.3f。', + 'type' => 'string', + 'example' => '00000000.010', + ], + 'VideoOCRFailReason' => [ + 'description' => 'OCR识别的失败原因。', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'VideoFrameTagsStatus' => [ + 'description' => '视频帧标签识别的状态。', + 'type' => 'string', + 'example' => 'Success', + ], + 'VideoTagsFailReason' => [ + 'description' => '视频标签处理的失败原因。', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'VideoTagsModifyTime' => [ + 'description' => '视频标签处理的更新时间。当VideoTagsStatus更改时更新。', + 'type' => 'string', + 'example' => '2021-01-21T07:40:53.95Z', + ], + 'VideoOCRStatus' => [ + 'description' => 'OCR识别的状态。', + 'type' => 'string', + 'example' => 'Success', + ], + 'VideoFrames' => [ + 'description' => '帧数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '462', + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '5FC2B195-B43E-45ED-9BEC-169358550193', + ], + 'ProcessModifyTime' => [ + 'description' => '视频处理的更新时间。', + 'type' => 'string', + 'example' => '2021-01-21T07:40:53.955Z', + ], + 'VideoSTTModifyTime' => [ + 'description' => '语音转文字的更新时间。', + 'type' => 'string', + 'example' => '2021-01-21T07:40:53.95Z', + ], + 'ProcessFailReason' => [ + 'description' => '视频处理的失败原因。', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'CreateTime' => [ + 'description' => '视频加入媒体集的时间。', + 'type' => 'string', + 'example' => '2021-01-21T07:40:41.683Z', + ], + 'ExternalId' => [ + 'description' => '外部ID，用于和您的应用层的 ID （如果有）进行绑定。', + 'type' => 'string', + 'example' => 'externalId001', + ], + 'VideoSTTFailReason' => [ + 'description' => '语音转文字的失败原因。', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'VideoUri' => [ + 'description' => '视频的OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + 'VideoFrameTagsFailReason' => [ + 'description' => '视频帧标签识别的失败原因。', + 'type' => 'string', + 'example' => 'Timeout', + ], + 'VideoFormat' => [ + 'description' => '视频格式。', + 'type' => 'string', + 'example' => 'mov,mp4,m4a,3gp,3g2,mj2', + ], + 'VideoSTTStatus' => [ + 'description' => '语音转文字的状态。', + 'type' => 'string', + 'example' => 'Success', + ], + 'VideoFacesModifyTime' => [ + 'description' => '视频人脸识别的更新时间。', + 'type' => 'string', + 'example' => '1970-01-01T00:00:00Z', + ], + 'VideoTags' => [ + 'description' => '视频标签处理结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagName' => [ + 'description' => '标签名称。', + 'type' => 'string', + 'example' => '大型超市', + ], + 'TagConfidence' => [ + 'description' => '标签置信度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8933850526809692', + ], + 'TagLevel' => [ + 'description' => '标签级别，取值范围为1~4。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ParentTagName' => [ + 'description' => '父级标签名称。', + 'type' => 'string', + 'example' => '内部场景', + ], + ], + ], + ], + 'VideoDuration' => [ + 'description' => '视频时长，单位为秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '15.263', + ], + 'SetId' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'example' => 'videoset', + ], + 'VideoTagsStatus' => [ + 'description' => '视频标签处理的状态，包括如下选项：'."\n" + ."\n" + .'- NotProcessed：未处理'."\n" + .'- Processing：处理中'."\n" + .'- Success：成功'."\n" + .'- Failed ：失败'."\n" + ."\n" + .'您可以根据该状态决定读取结果、等待或重试。', + 'type' => 'string', + 'example' => 'Success', + ], + 'FileSize' => [ + 'description' => '文件大小，单位为字节。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '25115517', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ModifyTime\\": \\"2021-01-21T07:40:41.683Z\\",\\n \\"ProcessStatus\\": \\"Success\\",\\n \\"VideoWidth\\": 1080,\\n \\"SourceType\\": \\"video\\",\\n \\"SourceUri\\": \\"oss://imm-test/testcases/video.mp4\\",\\n \\"VideoInfo\\": \\"{\\\\\\"MediaStreams\\\\\\":{\\\\\\"VideoStreams\\\\\\":[{\\\\\\"Index\\\\\\":0,\\\\\\"Language\\\\\\":\\\\\\"eng\\\\\\",\\\\\\"CodecName\\\\\\":\\\\\\"h264\\\\\\",\\\\\\"CodecLongName\\\\\\":\\\\\\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\\\\\",\\\\\\"Profile\\\\\\":\\\\\\"Baseline\\\\\\",\\\\\\"CodecTimeBase\\\\\\":\\\\\\"1373627/83160000\\\\\\",\\\\\\"CodecTagString\\\\\\":\\\\\\"avc1\\\\\\",\\\\\\"CodecTag\\\\\\":\\\\\\"0x31637661\\\\\\",\\\\\\"Width\\\\\\":1080,\\\\\\"Height\\\\\\":1920,\\\\\\"SampleAspectRatio\\\\\\":\\\\\\"1:1\\\\\\",\\\\\\"DisplayAspectRatio\\\\\\":\\\\\\"9:16\\\\\\",\\\\\\"PixelFormat\\\\\\":\\\\\\"yuv420p\\\\\\",\\\\\\"Level\\\\\\":40,\\\\\\"FrameRrate\\\\\\":\\\\\\"90000/1\\\\\\",\\\\\\"AverageFrameRate\\\\\\":\\\\\\"41580000/1373627\\\\\\",\\\\\\"TimeBase\\\\\\":\\\\\\"1/90000\\\\\\",\\\\\\"StartTime\\\\\\":\\\\\\"0.000000\\\\\\",\\\\\\"Duration\\\\\\":\\\\\\"15.262522\\\\\\",\\\\\\"Bitrate\\\\\\":\\\\\\"13091201\\\\\\",\\\\\\"Frames\\\\\\":\\\\\\"462\\\\\\"}],\\\\\\"AudioStreams\\\\\\":[],\\\\\\"SubtitleStreams\\\\\\":[]},\\\\\\"MediaFormat\\\\\\":{\\\\\\"NumberStreams\\\\\\":2,\\\\\\"FormatName\\\\\\":\\\\\\"mov,mp4,m4a,3gp,3g2,mj2\\\\\\",\\\\\\"FormatLongName\\\\\\":\\\\\\"QuickTime / MOV\\\\\\",\\\\\\"Size\\\\\\":\\\\\\"25115517\\\\\\",\\\\\\"Duration\\\\\\":\\\\\\"15.263000\\\\\\",\\\\\\"StartTime\\\\\\":\\\\\\"0.000000\\\\\\",\\\\\\"Bitrate\\\\\\":\\\\\\"13164131\\\\\\",\\\\\\"CreationTime\\\\\\":\\\\\\"2020-10-25T09:16:09.000000Z\\\\\\",\\\\\\"Address\\\\\\":{},\\\\\\"Tag\\\\\\":{}}}\\",\\n \\"VideoFrameTagsModifyTime\\": \\"1970-01-01T00:00:00Z\\",\\n \\"RemarksA\\": \\"AdminGroup/AdminUserA/\\",\\n \\"VideoFacesFailReason\\": \\"Timeout\\",\\n \\"RemarksB\\": \\"nas://path/to/file\\",\\n \\"VideoFacesStatus\\": \\"Success\\",\\n \\"RemarksC\\": \\"remarkc\\",\\n \\"VideoOCRModifyTime\\": \\"1970-01-01T00:00:00Z\\",\\n \\"RemarksD\\": \\"remarkd\\",\\n \\"VideoHeight\\": 1920,\\n \\"SourcePosition\\": \\"00000000.010\\",\\n \\"VideoOCRFailReason\\": \\"Timeout\\",\\n \\"VideoFrameTagsStatus\\": \\"Success\\",\\n \\"VideoTagsFailReason\\": \\"Timeout\\",\\n \\"VideoTagsModifyTime\\": \\"2021-01-21T07:40:53.95Z\\",\\n \\"VideoOCRStatus\\": \\"Success\\",\\n \\"VideoFrames\\": 462,\\n \\"RequestId\\": \\"5FC2B195-B43E-45ED-9BEC-169358550193\\",\\n \\"ProcessModifyTime\\": \\"2021-01-21T07:40:53.955Z\\",\\n \\"VideoSTTModifyTime\\": \\"2021-01-21T07:40:53.95Z\\",\\n \\"ProcessFailReason\\": \\"Timeout\\",\\n \\"CreateTime\\": \\"2021-01-21T07:40:41.683Z\\",\\n \\"ExternalId\\": \\"externalId001\\",\\n \\"VideoSTTFailReason\\": \\"Timeout\\",\\n \\"VideoUri\\": \\"oss://imm-test/testcases/video.mp4\\",\\n \\"VideoFrameTagsFailReason\\": \\"Timeout\\",\\n \\"VideoFormat\\": \\"mov,mp4,m4a,3gp,3g2,mj2\\",\\n \\"VideoSTTStatus\\": \\"Success\\",\\n \\"VideoFacesModifyTime\\": \\"1970-01-01T00:00:00Z\\",\\n \\"VideoTags\\": [\\n {\\n \\"TagName\\": \\"大型超市\\",\\n \\"TagConfidence\\": 0.8933850526809692,\\n \\"TagLevel\\": 2,\\n \\"ParentTagName\\": \\"内部场景\\"\\n }\\n ],\\n \\"VideoDuration\\": 15.263,\\n \\"SetId\\": \\"videoset\\",\\n \\"VideoTagsStatus\\": \\"Success\\",\\n \\"FileSize\\": 25115517\\n}","errorExample":""},{"type":"xml","example":"<ModifyTime>2021-01-21T07:40:41.683Z</ModifyTime>\\n<ProcessStatus>Success</ProcessStatus>\\n<VideoWidth>1080</VideoWidth>\\n<SourceUri>oss://imm-test/testcases/video.mp4</SourceUri>\\n<SourceType>video</SourceType>\\n<VideoInfo>{\\"MediaStreams\\":{\\"VideoStreams\\":[{\\"Index\\":0,\\"Language\\":\\"eng\\",\\"CodecName\\":\\"h264\\",\\"CodecLongName\\":\\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\"Profile\\":\\"Baseline\\",\\"CodecTimeBase\\":\\"1373627/83160000\\",\\"CodecTagString\\":\\"avc1\\",\\"CodecTag\\":\\"0x31637661\\",\\"Width\\":1080,\\"Height\\":1920,\\"SampleAspectRatio\\":\\"1:1\\",\\"DisplayAspectRatio\\":\\"9:16\\",\\"PixelFormat\\":\\"yuv420p\\",\\"Level\\":40,\\"FrameRrate\\":\\"90000/1\\",\\"AverageFrameRate\\":\\"41580000/1373627\\",\\"TimeBase\\":\\"1/90000\\",\\"StartTime\\":\\"0.000000\\",\\"Duration\\":\\"15.262522\\",\\"Bitrate\\":\\"13091201\\",\\"Frames\\":\\"462\\"}],\\"AudioStreams\\":[{\\"Index\\":1,\\"CodecName\\":\\"aac\\",\\"CodecLongName\\":\\"AAC (Advanced Audio Coding)\\",\\"CodecTimeBase\\":\\"1/44100\\",\\"CodecTagString\\":\\"mp4a\\",\\"CodecTag\\":\\"0x6134706d\\",\\"SampleFormat\\":\\"fltp\\",\\"SampleRate\\":\\"44100\\",\\"Channels\\":1,\\"ChannelLayout\\":\\"mono\\",\\"TimeBase\\":\\"1/44100\\",\\"StartTime\\":\\"0.000000\\",\\"Duration\\":\\"15.256803\\",\\"Bitrate\\":\\"64003\\",\\"Frames\\":\\"656\\",\\"Language\\":\\"eng\\"}],\\"SubtitleStreams\\":[]},\\"MediaFormat\\":{\\"NumberStreams\\":2,\\"FormatName\\":\\"mov,mp4,m4a,3gp,3g2,mj2\\",\\"FormatLongName\\":\\"QuickTime / MOV\\",\\"Size\\":\\"25115517\\",\\"Duration\\":\\"15.263000\\",\\"StartTime\\":\\"0.000000\\",\\"Bitrate\\":\\"13164131\\",\\"CreationTime\\":\\"2020-10-25T09:16:09.000000Z\\",\\"Address\\":{},\\"Tag\\":{\\"CreationTime\\":\\"2020-10-25T09:16:09.000000Z\\"}}}</VideoInfo>\\n<VideoFrameTagsModifyTime>1970-01-01T00:00:00Z</VideoFrameTagsModifyTime>\\n<RemarksA>AdminGroup/AdminUserA/</RemarksA>\\n<RemarksB>nas://path/to/file</RemarksB>\\n<VideoFacesStatus>Success</VideoFacesStatus>\\n<VideoOCRModifyTime>1970-01-01T00:00:00Z</VideoOCRModifyTime>\\n<RemarksC>remarkc</RemarksC>\\n<RemarksD>remarkd</RemarksD>\\n<VideoHeight>1920</VideoHeight>\\n<SourcePosition>0.01</SourcePosition>\\n<VideoFrameTagsStatus>Success</VideoFrameTagsStatus>\\n<VideoTagsModifyTime>2021-01-21T07:40:53.95Z</VideoTagsModifyTime>\\n<VideoOCRStatus>Success</VideoOCRStatus>\\n<VideoFrames>462</VideoFrames>\\n<RequestId>5FC2B195-B43E-45ED-9BEC-169358550193</RequestId>\\n<VideoSTTModifyTime>2021-01-21T07:40:53.95Z</VideoSTTModifyTime>\\n<ProcessModifyTime>2021-01-21T07:40:53.955Z</ProcessModifyTime>\\n<ExternalId>externalId001</ExternalId>\\n<CreateTime>2021-01-21T07:40:41.683Z</CreateTime>\\n<VideoUri>oss://imm-test/testcases/video.mp4</VideoUri>\\n<VideoFormat>mp4</VideoFormat>\\n<VideoSTTStatus>Success</VideoSTTStatus>\\n<VideoFacesModifyTime>1970-01-01T00:00:00Z</VideoFacesModifyTime>\\n<VideoTags>\\n <TagName>内部场景</TagName>\\n <TagConfidence>0.9230213165283203</TagConfidence>\\n <TagLevel>1</TagLevel>\\n</VideoTags>\\n<VideoTags>\\n <TagName>大型超市</TagName>\\n <TagConfidence>0.8933850526809692</TagConfidence>\\n <TagLevel>2</TagLevel>\\n <ParentTagName>内部场景</ParentTagName>\\n</VideoTags>\\n<VideoDuration>15.263</VideoDuration>\\n<SetId>videoset</SetId>\\n<VideoTagsStatus>Success</VideoTagsStatus>\\n<FileSize>25115517</FileSize>","errorExample":""}]', + 'title' => '获取一个视频的信息', + 'summary' => '调用GetVideo获取媒体集中一个视频的信息。', + 'description' => '此接口已不再维护，建议使用新版（2020-09-30版本）接口[GetFileMeta](~~478170~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteVideo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'videoset', + ], + ], + [ + 'name' => 'VideoUri', + 'in' => 'query', + 'schema' => [ + 'description' => '视频的OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + ], + [ + 'name' => 'Resources', + 'in' => 'query', + 'schema' => [ + 'description' => '是否删除该视频的相关资源，例如frames等。可选值包括true和false。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => true, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '7A740EB3-23C6-4002-98D8-F4183328D40C', + ], + 'VideoUri' => [ + 'description' => '视频的OSS URI。', + 'type' => 'string', + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + 'SetId' => [ + 'description' => '媒体集的唯一标识。', + 'type' => 'string', + 'example' => 'videoset', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7A740EB3-23C6-4002-98D8-F4183328D40C\\",\\n \\"VideoUri\\": \\"oss://imm-test/testcases/video.mp4\\",\\n \\"SetId\\": \\"videoset\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteVideoResponse>\\n <RequestId>7A740EB3-23C6-4002-98D8-F4183328D40C</RequestId>\\n <VideoUri>oss://imm-test/testcases/video.mp4</VideoUri>\\n <SetId>videoset</SetId>\\n</DeleteVideoResponse>","errorExample":""}]', + 'title' => '删除一个视频的信息', + 'summary' => '调用DeleteVideo接口删除媒体集中的一个视频的信息。', + 'description' => '此接口已不再维护，建议使用新版（2020-09-30版本）接口[DeleteFileMeta](~~478172~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetVideoTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immvideotest', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务的类型，包含如下选项：'."\n" + ."\n" + .'- CompressVideoTask：视频压缩任务。'."\n" + ."\n" + .'- GrabFrameTask：视频截帧任务。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CompressVideoTask', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。设置的任务ID必须与任务类型相对应。'."\n" + ."\n" + .'此参数为调用[CreateVideoCompressTask](https://help.aliyun.com/document_detail/144048.html)或[CreateGrabFrameTask](https://help.aliyun.com/document_detail/199047.html)接口后返回的Task ID。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CompressVideoTask-c091c3f5-e6a5-46ce-a0f2-454bd779', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务运行状态。包括如下选项：'."\n" + ."\n" + .'- Running：任务运行中。'."\n" + .'- Finished：任务执行完成，视频处理成功。'."\n" + .'- Failed：任务执行完成，视频处理失败。具体失败原因请参考ErrorMessage内容。', + 'type' => 'string', + 'example' => 'Finished', + ], + 'Progress' => [ + 'description' => '任务进度的百分比。当前只有0和100两个结果。'."\n" + ."\n" + .'只有当转换成功时，此参数的返回值才为100，其他情况均为0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'NotifyEndpoint' => [ + 'description' => '异步反向通知的Endpoint。'."\n" + ."\n" + .'如果创建任务时未设置此参数，则返回值为空。', + 'type' => 'string', + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + ], + 'Parameters' => [ + 'description' => '创建任务的参数，以JSON格式表示。', + 'type' => 'string', + 'example' => '{'."\n" + .' "EndTime": "",'."\n" + .' "GrabType": "time",'."\n" + .' "Interval": "1",'."\n" + .' "RequestId": "B8982C37-E03A-47CD-A715-D83D128D9FEB",'."\n" + .' "SrcUri": "oss://imm-test/testcases/video.mp4",'."\n" + .' "StartTime": "",'."\n" + .' "TaskType": "CompressVideoTask",'."\n" + .' "TgtUri": "oss://imm-test/testcases"'."\n" + .'}', + ], + 'TaskId' => [ + 'description' => '任务ID，和请求时一致。', + 'type' => 'string', + 'example' => 'CompressVideoTask-c091c3f5-e6a5-46ce-a0f2-454bd779', + ], + 'EndTime' => [ + 'description' => '任务的结束时间。'."\n" + ."\n" + .'当任务状态为Finished时，此参数才有值，否则返回值为空。', + 'type' => 'string', + 'example' => '2021-01-28T03:24:25.915048Z', + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'C7593402-F428-47B1-80B2-F94B6859F119', + ], + 'TaskType' => [ + 'description' => '任务的类型，和请求时一致。', + 'type' => 'string', + 'example' => 'CompressVideoTask', + ], + 'StartTime' => [ + 'description' => '任务执行的开始时间。', + 'type' => 'string', + 'example' => '2021-01-28T03:24:23.726372Z', + ], + 'NotifyTopicName' => [ + 'description' => '异步反向通知的TopicName。'."\n" + ."\n" + .'如果创建任务时未设置此参数，则返回值为空。', + 'type' => 'string', + 'example' => 'topic1', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n" + ."\n" + .'当任务状态为Finished时，此参数的值固定为Success。当任务状态为Failed时，请参考此参数的值处理问题。', + 'type' => 'string', + 'example' => 'Invalid Argument:VideoUri', + ], + 'Result' => [ + 'description' => '任务处理的结果。'."\n" + ."\n" + .'不同的任务类型会有不同的返回信息，请以实际为准。', + 'type' => 'string', + 'example' => '{"Key":"{\\"TgtUri\\":\\"oss://imm-test/testcases\\",\\"ImgsUri\\":\\"oss://imm-test/testcases/imgs\\",\\"AudioUri\\":\\"oss://imm-test/testcases/audio\\",\\"ProcessLength\\":\\"10\\",\\"ResultUri\\":\\"oss://imm-test/testcases/result/result.txt\\"}"}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Finished\\",\\n \\"Progress\\": 100,\\n \\"NotifyEndpoint\\": \\"http://1111111111.mns.cn-hangzhou.aliyuncs.com\\",\\n \\"Parameters\\": \\"{\\\\n \\\\\\"EndTime\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"GrabType\\\\\\": \\\\\\"time\\\\\\",\\\\n \\\\\\"Interval\\\\\\": \\\\\\"1\\\\\\",\\\\n \\\\\\"RequestId\\\\\\": \\\\\\"B8982C37-E03A-47CD-A715-D83D128D9FEB\\\\\\",\\\\n \\\\\\"SrcUri\\\\\\": \\\\\\"oss://imm-test/testcases/video.mp4\\\\\\",\\\\n \\\\\\"StartTime\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"TaskType\\\\\\": \\\\\\"CompressVideoTask\\\\\\",\\\\n \\\\\\"TgtUri\\\\\\": \\\\\\"oss://imm-test/testcases\\\\\\"\\\\n}\\",\\n \\"TaskId\\": \\"CompressVideoTask-c091c3f5-e6a5-46ce-a0f2-454bd779\\",\\n \\"EndTime\\": \\"2021-01-28T03:24:25.915048Z\\",\\n \\"RequestId\\": \\"C7593402-F428-47B1-80B2-F94B6859F119\\",\\n \\"TaskType\\": \\"CompressVideoTask\\",\\n \\"StartTime\\": \\"2021-01-28T03:24:23.726372Z\\",\\n \\"NotifyTopicName\\": \\"topic1\\",\\n \\"ErrorMessage\\": \\"Invalid Argument:VideoUri\\",\\n \\"Result\\": \\"{\\\\\\"Key\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"TgtUri\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss://imm-test/testcases\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ImgsUri\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss://imm-test/testcases/imgs\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AudioUri\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss://imm-test/testcases/audio\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ProcessLength\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"10\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ResultUri\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss://imm-test/testcases/result/result.txt\\\\\\\\\\\\\\"}\\\\\\"}\\"\\n}","errorExample":""},{"type":"xml","example":"<Status>Finished</Status>\\n<Progress>100</Progress>\\n<Parameters>{\\"EndTime\\":\\"\\",\\"GrabType\\":\\"time\\",\\"Interval\\":\\"1\\",\\"RequestId\\":\\"B8982C37-E03A-47CD-A715-D83D128D9FEB\\",\\"SrcUri\\":\\"oss://imm-test/testcases/video.mp4\\",\\"StartTime\\":\\"\\",\\"TaskType\\":\\"VideoAnalyseTask\\",\\"TgtUri\\":\\"oss://imm-test/testcases\\"}</Parameters>\\n<TaskId>VideoAnalyseTask-c091c3f5-e6a5-46ce-a0f2-454bd779</TaskId>\\n<EndTime>2021-01-28T03:24:25.915048Z</EndTime>\\n<RequestId>C7593402-F428-47B1-80B2-F94B6859F119</RequestId>\\n<StartTime>2021-01-28T03:24:23.726372Z</StartTime>\\n<Result>{\\"Key\\":\\"{\\\\\\"TgtUri\\\\\\":\\\\\\"oss://imm-test/testcases\\\\\\",\\\\\\"ImgsUri\\\\\\":\\\\\\"oss://imm-test/testcases/imgs\\\\\\",\\\\\\"AudioUri\\\\\\":\\\\\\"oss://imm-test/testcases/audio\\\\\\",\\\\\\"ProcessLength\\\\\\":\\\\\\"10\\\\\\",\\\\\\"ResultUri\\\\\\":\\\\\\"oss://imm-test/testcases/result/result.txt\\\\\\"}\\"}</Result>\\n<NotifyEndpoint>http://1111111111.mns.cn-hangzhou.aliyuncs.com</NotifyEndpoint>\\n<TaskType>VideoAnalyseTask</TaskType>\\n<NotifyTopicName>topic1</NotifyTopicName>\\n<ErrorMessage>Success</ErrorMessage>","errorExample":""}]', + 'title' => '查询视频类任务', + 'summary' => '调用GetVideoTask接口查询视频任务的执行状态和结果。', + 'description' => '此接口已不再维护，建议使用新版（2020-09-30版本）接口[GetTask](~~478241~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListVideoTasks' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immvideotest', + ], + ], + [ + 'name' => 'Marker', + 'in' => 'query', + 'schema' => [ + 'description' => '从Marker开始按字典序返回视频任务信息列表。如果不设置此参数，则从头开始返回视频任务。'."\n" + ."\n" + .'此参数的值和返回结果中的NextMarker一致，用于继续读取未全部返回的音频信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'VideoAnalyseTask-4b5c5b94-ba39-4008-9342-30abe341792b', + ], + ], + [ + 'name' => 'MaxKeys', + 'in' => 'query', + 'schema' => [ + 'description' => '返回视频任务的最大个数，默认值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务的类型，包含如下选项：'."\n" + ."\n" + .'- CompressVideoTask：视频压缩任务。'."\n" + .'- VideoAnalyseTask：视频分析任务。'."\n" + .'- GrabFrameTask：视频截帧任务。', + 'type' => 'string', + 'required' => false, + 'example' => 'VideoAnalyseTask', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Tasks' => [ + 'description' => '视频任务信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '任务的结束时间。'."\n" + ."\n" + .'当任务状态为Finished时，此参数才有值，否则返回值为空。', + 'type' => 'string', + 'example' => '2021-01-28T03:24:25.915048Z', + ], + 'Status' => [ + 'description' => '任务运行状态。包括如下选项：'."\n" + ."\n" + .'- Running：任务运行中。'."\n" + .'- Finished：任务执行完成，视频处理成功。'."\n" + .'- Failed：任务执行完成，视频处理失败。具体失败原因请参考ErrorMessage内容。', + 'type' => 'string', + 'example' => 'Finished', + ], + 'StartTime' => [ + 'description' => '任务开始执行的时间。', + 'type' => 'string', + 'example' => '2021-01-28T03:24:23.726372Z', + ], + 'TaskType' => [ + 'description' => '任务的类型，和请求时一致。', + 'type' => 'string', + 'example' => 'VideoAnalyseTask', + ], + 'Progress' => [ + 'description' => '任务进度的百分比。当前只有0和100两个结果。'."\n" + ."\n" + .'只有当转换成功时，此参数的返回值才为100，其他情况均为0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'NotifyEndpoint' => [ + 'description' => '异步反向通知的Endpoint。'."\n" + ."\n" + .'如果创建任务时未设置此参数，则返回值为空。', + 'type' => 'string', + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n" + ."\n" + .'当任务状态为Finished时，此参数的值固定为Success。当任务状态为Failed时，请参考此参数的值处理问题。', + 'type' => 'string', + 'example' => 'Invalid Argument:VideoUri', + ], + 'Parameters' => [ + 'description' => '创建任务的参数，以JSON格式表示。'."\n" + ."\n" + .'不同的任务类型会有不同的返回信息，请以实际为准。', + 'type' => 'string', + 'example' => '{"EndTime":"","GrabType":"time","Interval":"1","RequestId":"B8982C37-E03A-47CD-A715-D83D128D9FEB","SrcUri":"oss://imm-test/testcases/video.mp4","StartTime":"","TaskType":"VideoAnalyseTask","TgtUri":"oss://imm-test/testcases"}', + ], + 'Result' => [ + 'description' => '任务处理的结果。'."\n" + ."\n" + .'不同的任务类型会有不同的返回信息，请以实际为准。', + 'type' => 'string', + 'example' => '{"Key":"{\\"TgtUri\\":\\"oss://imm-test/testcases\\",\\"ImgsUri\\":\\"oss://imm-test/testcases/imgs\\",\\"AudioUri\\":\\"oss://imm-test/testcases/audio\\",\\"ProcessLength\\":\\"10\\",\\"ResultUri\\":\\"oss://imm-test/testcases/result/result.txt\\"}"}', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'VideoAnalyseTask-8d7a4a32-f445-47fd-bdff-397a87651879', + ], + 'NotifyTopicName' => [ + 'description' => '异步反向通知的TopicName。'."\n" + ."\n" + .'如果创建任务时未设置此参数，则返回值为空。', + 'type' => 'string', + 'example' => 'topic1', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'B70908A5-02B8-4CEC-A660-2A8A10ADE862', + ], + 'NextMarker' => [ + 'description' => '下一次列出视频任务信息时以此值为Marker，将未返回的结果返回。 '."\n" + ."\n" + .'当视频任务未全部返回时，此参数才有值。', + 'type' => 'string', + 'example' => 'VideoAnalyseTask-4b5c5b94-ba39-4008-9342-30abe341792b', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Tasks\\": [\\n {\\n \\"EndTime\\": \\"2021-01-28T03:24:25.915048Z\\",\\n \\"Status\\": \\"Finished\\",\\n \\"StartTime\\": \\"2021-01-28T03:24:23.726372Z\\",\\n \\"TaskType\\": \\"VideoAnalyseTask\\",\\n \\"Progress\\": 100,\\n \\"NotifyEndpoint\\": \\"http://1111111111.mns.cn-hangzhou.aliyuncs.com\\",\\n \\"ErrorMessage\\": \\"Invalid Argument:VideoUri\\",\\n \\"Parameters\\": \\"{\\\\\\"EndTime\\\\\\":\\\\\\"\\\\\\",\\\\\\"GrabType\\\\\\":\\\\\\"time\\\\\\",\\\\\\"Interval\\\\\\":\\\\\\"1\\\\\\",\\\\\\"RequestId\\\\\\":\\\\\\"B8982C37-E03A-47CD-A715-D83D128D9FEB\\\\\\",\\\\\\"SrcUri\\\\\\":\\\\\\"oss://imm-test/testcases/video.mp4\\\\\\",\\\\\\"StartTime\\\\\\":\\\\\\"\\\\\\",\\\\\\"TaskType\\\\\\":\\\\\\"VideoAnalyseTask\\\\\\",\\\\\\"TgtUri\\\\\\":\\\\\\"oss://imm-test/testcases\\\\\\"}\\",\\n \\"Result\\": \\"{\\\\\\"Key\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"TgtUri\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss://imm-test/testcases\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ImgsUri\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss://imm-test/testcases/imgs\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AudioUri\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss://imm-test/testcases/audio\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ProcessLength\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"10\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ResultUri\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss://imm-test/testcases/result/result.txt\\\\\\\\\\\\\\"}\\\\\\"}\\",\\n \\"TaskId\\": \\"VideoAnalyseTask-8d7a4a32-f445-47fd-bdff-397a87651879\\",\\n \\"NotifyTopicName\\": \\"topic1\\"\\n }\\n ],\\n \\"RequestId\\": \\"B70908A5-02B8-4CEC-A660-2A8A10ADE862\\",\\n \\"NextMarker\\": \\"VideoAnalyseTask-4b5c5b94-ba39-4008-9342-30abe341792b\\"\\n}","errorExample":""},{"type":"xml","example":"<Tasks>\\n <Status>Finished</Status>\\n <Progress>100</Progress>\\n <NotifyEndpoint>http://1111111111.mns.cn-hangzhou.aliyuncs.com</NotifyEndpoint>\\n <Parameters>{\\"EndTime\\":\\"\\",\\"GrabType\\":\\"time\\",\\"Interval\\":\\"1\\",\\"RequestId\\":\\"B8982C37-E03A-47CD-A715-D83D128D9FEB\\",\\"SrcUri\\":\\"oss://imm-test/testcases/video.mp4\\",\\"StartTime\\":\\"\\",\\"TaskType\\":\\"VideoAnalyseTask\\",\\"TgtUri\\":\\"oss://imm-test/testcases\\"}</Parameters>\\n <TaskId>VideoAnalyseTask-8d7a4a32-f445-47fd-bdff-397a87651879</TaskId>\\n <EndTime>2021-01-28T03:24:25.915048Z</EndTime>\\n <TaskType>VideoAnalyseTask</TaskType>\\n <StartTime>2021-01-28T03:24:23.726372Z</StartTime>\\n <NotifyTopicName>topic1</NotifyTopicName>\\n <ErrorMessage>Success</ErrorMessage>\\n <Result>{\\"Key\\":\\"{\\\\\\"TgtUri\\\\\\":\\\\\\"oss://imm-test/testcases\\\\\\",\\\\\\"ImgsUri\\\\\\":\\\\\\"oss://imm-test/testcases/imgs\\\\\\",\\\\\\"AudioUri\\\\\\":\\\\\\"oss://imm-test/testcases/audio\\\\\\",\\\\\\"ProcessLength\\\\\\":\\\\\\"10\\\\\\",\\\\\\"ResultUri\\\\\\":\\\\\\"oss://imm-test/testcases/result/result.txt\\\\\\"}\\"}</Result>\\n</Tasks>\\n<RequestId>B70908A5-02B8-4CEC-A660-2A8A10ADE862</RequestId>\\n<NextMarker>VideoAnalyseTask-4b5c5b94-ba39-4008-9342-30abe341792b</NextMarker>","errorExample":""}]', + 'title' => '列出视频类异步任务', + 'summary' => '调用ListVideoTasks接口列出视频任务信息。', + 'description' => '此接口已不再维护，建议使用新版（2020-09-30版本）接口[ListTasks](~~478242~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteVideoTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immvideotest', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务的类型，包含如下选项：'."\n" + ."\n" + .'- CompressVideoTask：视频压缩任务。'."\n" + ."\n" + .'- VideoAnalyseTask：视频分析任务。'."\n" + ."\n" + .'- GrabFrameTask：视频截帧任务。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'VideoAnalyseTask', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'VideoAnalyseTask-d9ee284f-857b-4d64-a73d-88fffe59f354', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '02CDECFE-4234-4734-9D4A-F1BB8D3C3374', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"02CDECFE-4234-4734-9D4A-F1BB8D3C3374\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>02CDECFE-4234-4734-9D4A-F1BB8D3C3374</RequestId>","errorExample":""}]', + 'title' => '删除视频异步任务', + 'summary' => '调用DeleteVideoTask接口删除一个视频任务。', + 'description' => '此接口已不再维护，建议使用[新版（2020-09-30版本）API](~~478146~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateVideoCompressTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immvideotest', + ], + ], + [ + 'name' => 'VideoUri', + 'in' => 'query', + 'schema' => [ + 'description' => '视频的OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中`bucket`为和当前项目处于同一地域的OSS Bucket名称，`object`为文件路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + ], + [ + 'name' => 'NotifyTopicName', + 'in' => 'query', + 'schema' => [ + 'description' => '异步反向通知的TopicName。', + 'type' => 'string', + 'required' => false, + 'example' => 'topic1', + ], + ], + [ + 'name' => 'NotifyEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => '异步反向通知的Endpoint，任务执行状态可以通过该Endpoint异步通知给调用者。使用此功能需要先开通轻量消息队列（原 MNS）服务，新建topic和queue，并配置订阅关系。具体操作，请参见[轻量消息队列（原 MNS）快速入门](https://help.aliyun.com/document_detail/34412.html)。'."\n" + ."\n" + .'>轻量消息队列（原 MNS）服务和智能媒体管理必须处于同一地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://1111111111.mns.cn-beijing.aliyuncs.com', + ], + ], + [ + 'name' => 'TargetList', + 'in' => 'query', + 'schema' => [ + 'description' => '压缩后的视频列表。支持对同一视频同时压缩多份不同格式结果。更多信息，请参见TargetList参数说明。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '[{"AudioBitrate":"64k","VideoBitrate":"128k","TargetUri":"oss://imm-test/testcases/example.m3u8"}]', + ], + ], + [ + 'name' => 'CustomMessage', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义的信息。在轻量消息队列（原 MNS）通知任务执行状态时，内容会原样返回。', + 'type' => 'string', + 'required' => false, + 'example' => 'CompressTaskTest', + ], + ], + [ + 'name' => 'TargetSegment', + 'in' => 'query', + 'schema' => [ + 'description' => '分段转码。当前版本不支持此参数。', + 'type' => 'string', + 'required' => false, + 'example' => '[]', + ], + ], + [ + 'name' => 'TargetSubtitle', + 'in' => 'query', + 'schema' => [ + 'description' => '提取视频中的字幕。更多信息，请参见**TargetSubtitle参数说明**表格。', + 'type' => 'string', + 'required' => false, + 'example' => '{"ExtractFormat":ass,"SubtitleUri":"oss://imm-test/testcases","ExtractType":[]}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'CompressVideoTask-c09b0943-ed79-4983-8dbe-7a882574****', + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'CB4D73A3-BAF4-4A9D-A631-15F219AF****', + ], + 'TaskType' => [ + 'description' => '任务的类型，返回值固定为CompressVideoTask。', + 'type' => 'string', + 'example' => 'CompressVideoTask', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"CompressVideoTask-c09b0943-ed79-4983-8dbe-7a882574****\\",\\n \\"RequestId\\": \\"CB4D73A3-BAF4-4A9D-A631-15F219AF****\\",\\n \\"TaskType\\": \\"CompressVideoTask\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateVideoCompressTaskResponse>\\n <TaskId>CompressVideoTask-c09b0943-ed79-4983-8dbe-7a882574****</TaskId>\\n <RequestId>CB4D73A3-BAF4-4A9D-A631-15F219AF****</RequestId>\\n <TaskType>CompressVideoTask</TaskType>\\n</CreateVideoCompressTaskResponse>","errorExample":""}]', + 'title' => '创建一个视频压缩存储的任务', + 'summary' => '调用CreateVideoCompressTask接口创建一个视频压缩存储任务，执行完成后返回TaskId。', + 'description' => '此接口已不再维护，建议使用新版（2020-09-30版本）接口[CreateMediaConvertTask](~~478221~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。', + 'requestParamsDescription' => 'TargetList参数说明'."\n" + .'|名称|类型|是否必选|示例值|描述|'."\n" + .'|----|----|----|----|----|'."\n" + .'|TargetUri|String|是|oss://imm-test/testcases/example.m3u8|输出文件的OSS URI。<br>OSS地址规则为`oss://bucket/object`，其中`bucket`为和当前项目处于同一地域的OSS Bucket名称，`object`为文件路径。|'."\n" + .'|AudioBitrate|String|否|128k|音频码率，单位为比特每秒（bit/s）。可选值包括64k、128k、192k、256k和320k。|'."\n" + .'|AllowIncreaseAudioBitrate|Boolean|否|false|是否允许输出文件比特率高于原视频比特率。取值范围如下：<br>- true（默认）：是。<br>- false：否。|'."\n" + .'|AudioQuality|Integer|否|1|音频质量，仅当音频格式为mp3和aac时才有效。AudioQuality参数和AudioBitrate参数只能存在一个。<br>- 当音频格式为mp3时，取值范围为0~9，值越小质量越高。<br>- 当音频格式为aac时，取值范围为10-500，值越大质量越高。|'."\n" + .'|AudioSampleRate|Integer|否|44100|音频采样频率，单位为赫兹（Hz）。常用采样频率包括8000、12050、22050、44100等。如果不设置此参数，则保持原有采样频率。|'."\n" + .'|AllowIncreaseAudioSampleRate|Boolean|否|false|是否允许输出文件帧率高于原视频。取值范围如下：<br>- true（默认）：是。<br>- false：否。|'."\n" + .'|VideoFrameRate|Integer|否|25|视频帧率，不设置则保持原值。|'."\n" + .'|AllowIncreaseVideoFrameRate|Boolean|否|false|是否允许输出文件帧率高于原视频。取值范围如下：<br>- true（默认）：是。<br>- false：否。|'."\n" + .'|VideoBitrate|String|否|1500k|视频比特率，单位为比特每秒（bit/s）。常用视频比特率包括128k、1.25m、5m等。|'."\n" + .'|AllowIncreaseVideoBitrate|Boolean|否|false|是否允许输出文件比特率高于原视频。取值范围如下：<br>- true（默认）：是。<br>- false：否。|'."\n" + .'|VideoCodec|String|否|lib×264|视频编码方案，可选值包括lib×264、libvpx、libtheora、libxvid和copy。|'."\n" + .'|PixelFormat|String|否|yuv420p|像素格式，指定图像中每个像素的颜色数据的格式。可选值包括yuv420p、yuv422p、yuvj422p、yuv444p、yuvj444p、yuv420p10le、yuv422p10le、yuv444p10le。|'."\n" + .'|AudioCodec|String|否|libfdk_aac|音频编码方案，可选值包括libmp3lame、libvorbis、libfdk_aac、opus和copy。|'."\n" + .'|SeekStartTime|Integer|否|1|指定视频截取的开始时间，单位为秒。|'."\n" + .'|Duration|Integer|否|15|指定视频截取的长度，单位为秒。|'."\n" + .'|VideoResolution|String|否|640x480|指定视频分辨率，格式为宽x高。例如640x480。|'."\n" + .'|AllowIncreaseVideoResolution|Boolean|否|false|是否允许输出文件分辨率高于原视频。取值范围如下：<br>- true（默认）：是。<br>- false：否。|'."\n" + .'|AdaptVideoResolutionDirection|Boolean|否|false|自适应分辨率方向。取值范围如下：<br>- true（默认）：是。<br>- false：否。|'."\n" + .'|VideoRotation|Integer|否|90|指定顺时针旋转的度数，可选值包括90、180和270，默认为自动旋转。|'."\n" + .'|DisableAudio|Boolean|否|false|是否禁用音频流。<br>- true：是。<br>- false（默认）：否。|'."\n" + .'|DisableVideo|Boolean|否|true|是否禁用视频流。<br>- true：是。<br>- false（默认）：否。|'."\n" + .'|VideoProfile|String|否|baseline|设置视频的profile等级，可选值包括baseline、main和high。|'."\n" + .'|AudioChannel|Integer|否|2|声道数。取值范围如下：<br>- 1：单声道。<br>- 2：立体声。|'."\n" + .'|HLSTime|String|否|10|HLS格式的切片大小，单位为秒。当输出文件为m3u8格式时，必须设置此参数。|'."\n" + .'|HLSIniTime|int64|否|10|视频段开始时间，单位为秒。|'."\n" + .'|Watermarks|String|否|[{"Type":Text,"DX":0,"Content":example,"FontSize":16,"FileUri":"oss://imm-test/testcases/水印.PNG"}]|水印列表。更多信息，请参见水印列表参数说明。|'."\n" + .'|VideoCRF|Integer|否|20|指定恒定质量模式。<br>当视频编码器为lib×264时才有效。取值范围为0~51，数值越大画质越差，建议取值[18,28]。|'."\n" + .'|VideoMaxBitrate|String|否|1000k|动态码率下限定最大码率，例如1000k。该参数需要和VideCRF参数一起使用才有效。使用该参数时，必须指定VideoBufferSize参数。|'."\n" + .'|Speed|Float|否|1.0|加速或减速，范围[0.5,2]。|'."\n" + .'|ScaleType|String|否|STRETCH|缩放方式，取值范围如下：<br>- CROP：缩放并裁剪。<br>- STRETCH（默认）：拉伸以填满。<br>- FILL：缩放并保留黑边。<br>- FIT：缩放并不保留黑边。|'."\n" + .'|Delogos|String|否|[{"Dx":0,"Dy":0,"ReferPos":TopLeft}]|对视频上某矩形部分进行模糊，用于去除Logo、台标等。|'."\n" + .'|SubTitles|String|否|[{"FileUri":"oss://imm-test/testcases/example.ass"}]|添加字幕。包括如下选项：<br>- FileUri（可选）：字母文件的OSS URI。支持SRT、ASS等格式。类型为String。<br>- Lang（可选）：语言。请参考ISO-639-2语言定义。类型为String。|'."\n" + .'|Encryption|Boolean|否|false|是否对视频加密，当前只支持每个target加密。<br>- true：是。<br>- false（默认）：否。|'."\n" + .'|SegmentDuration|int64|否|15|目标视频段时长。单位为秒。|'."\n" + ."\n" + .'TargetSubtitle参数说明'."\n" + .'|名称|类型|是否必选|示例值|描述|'."\n" + .'|----|----|----|----|----|'."\n" + .'|ExtractFormat|String|是|ass|提取出字幕的格式，支持srt、ass、vtt三种格式。|'."\n" + .'|SubtitleUri|String|是|oss://imm-test/testcases|输出文件夹的OSS URI。<br>- 如果提取字幕的方式为流序号提取，则输出格式为：Fileprefix值Index字幕流序号.字幕格式。<br>- 如果提取字幕的方式为language的KEY值，则输出格式为：Fileprefix值KEY值该KEY值下视频的序号.字幕格式。|'."\n" + .'|Extractype|String|否|[]|提取字幕的方式。提取方式有如下三种形式：<br>- []（默认）：提取所有字幕，按照KEY值得输出方式输出。<br>- 数字：提取对应字幕流序号的字幕。<br>- language的KEY值：提取对应视频中，KEY值得字幕流。|'."\n" + .'|FilePrefix|String|否|media-a|输出文件的文件名前缀。默认为空。|'."\n" + ."\n" + .'Delogos参数说明'."\n" + .'|名称|类型|是否必选|示例值|描述|'."\n" + .'|----|----|----|----|----|'."\n" + .'|Dx|Float|否|0|默认值为0。值有两种形式：<br>- 整数型代表偏移像素，单位px，取值范围为[1,4096]。<br>- 小数型代表垂直偏移量与输出分辨率高的比率，取值范围为(0,1)。|'."\n" + .'|Dy|Float|否|0|默认值为0。值有两种形式：<br>- 整数型代表偏移像素，单位px，取值范围为[1,4096]。<br>- 小数型代表垂直偏移量与输出分辨率高的比率，取值范围为(0,1)。|'."\n" + .'|Width|Float|否|2|去除Logo宽度。值有两种形式：<br>- 整数型代表去除Logo宽度的像素值，单位px，取值范围为\\(1,4096]。<br>- 小数型代表相对输出视频分辨率宽度的比率，取值范围为(0,1)。|'."\n" + .'|Height|Float|否|2|去除Logo高度。值有两种形式：<br>- 整数型代表去除Logo高度的像素值，单位px，取值范围为\\(1,4096]。<br>- 小数型代表相对输出视频分辨率高度的比率，取值范围为(0,1)。|'."\n" + .'|Star|Integer|否|0|去除Logo开始时间，默认值为0，0表示从头开始，单位为秒。|'."\n" + .'|Duration|Integer|否|0|去除Logo持续时间，默认值为0，0表示持续到视频结束，单位为秒。|'."\n" + .'|ReferPos|String|否|TopLeft|去除Logo的位置。取值范围为TipRight、TopLeft、BottomRight和BottomLeft，默认值为TopLeft。|'."\n" + ."\n" + .'Watermarks参数说明'."\n" + .'|名称|类型|是否必选|示例值|描述|'."\n" + .'|----|----|----|----|----|'."\n" + .'|Type|String|是|Text|类型包括Text和File。Text为文字水印。File为png、mov水印。|'."\n" + .'|Dx|Float|否|0|默认值为0。值有两种形式：<br>- 整数型代表偏移像素，单位px，取值范围为[1,4096]。<br>- 小数型代表垂直偏移量与输出分辨率高的比率，取值范围为(0,1)。|'."\n" + .'|Dy|Float|否|0|默认值为0。值有两种形式：<br>- 整数型代表偏移像素，单位px，取值范围为[1,4096]。<br>- 小数型代表垂直偏移量与输出分辨率高的比率，取值范围为(0,1)。|'."\n" + .'|Stat|Integer|否|0|水印开始时间，默认值为0，0表示从头开始，单位为秒。|'."\n" + .'|Duration|Integer|否|0|去水印持续时间，默认值为0，表示持续到视频结束，单位为秒。|'."\n" + .'|ReferPos|String|否|TopLeft|水印的位置。取值范围包括TopRight、TopLeft、BottomRight和BottomLeft，默认值为TopLeft。|'."\n" + .'|Content|String|是|example|文字水印内容。当设置Type为Text时有效。|'."\n" + .'|FontName|String|否|SourceHanSans-Regular|字体名称。当设置Type为Text时有效。支持的字体列表如下：<br>- SourceHanSans-Regular<br>- SourceHanSans-Bold<br>- SourceHanSerif-Regular<br>- SourceHanSerif-Bold|'."\n" + .'|FontSize|Integer|否|16|字体大小。默认值为16。范围为(4,120)。当设置Type为Text时有效。|'."\n" + .'|FontColor|String|否|#000000|字体颜色。#RRGGBB格式。默认值为#000000。当设置Type为Text时有效。|'."\n" + .'|FontApha|Float|否|1.0|字体透明度。取值范围为(0,1)，默认值为1.0。当设置Type为Text时有效。|'."\n" + .'|BorderWidth|Integer|否|1|描边宽度。默认值为0，取值范围为[0,4096]。当设置Type为Text时有效。|'."\n" + .'|BorderColor|String|否|#000000|描边颜色。#RRGGBB格式。默认值为#000000。当设置Type为Text时有效。|'."\n" + .'|FileUri|String|是|oss://imm-test/testcases/水印.PNG|水印文件的OSS URI。支持PNG和MOV格式。当设置Type为Text时有效。|'."\n" + .'|Width|Float|否|2|水印图片宽度，值有两种形式：<br>- 整数型代表去除Logo宽度的像素值，单位为px，取值范围为\\(1,4096]。<br>- 小数型代表相对输出视频分辨率宽度的比率，取值范围为(0,1)。|'."\n" + .'|Height|Float|否|2|水印图片高度，值有两种形式：<br>- 整数型代表去除Logo高度的像素值，单位为px，取值范围为\\(1,4096]。<br>- 小数型代表相对输出视频分辨率高度的比率，取值范围为(0,1)。|'."\n" + ."\n" + .'水印宽度和高度参数设置说明：'."\n" + ."\n" + .'- 宽度和高度均未设置时，水印宽度取输出视频分辨率宽度的0.12倍，水印高度按水印原图宽高比例等比缩放。'."\n" + ."\n" + .'- 宽度或高度只设置一边，另一边未设置时，则另一边按水印原图宽高比等比缩放。'."\n" + ."\n" + .'- 宽度和高度两边均设置时，按实际设置值设置水印图片。'."\n" + ."\n" + .'水印位置说明：'."\n" + .''."\n" + .'<props="china">只发布国内站</props>', + 'extraInfo' => '### 订阅消息返回示例'."\n" + ."\n\n" + .'返回参数的说明请参见下表。'."\n" + ."\n" + .'|名称|类型|描述|'."\n" + .'|----|----|-----|'."\n" + .'|eventName|String|任务类型，返回值固定为CompressVideoTask。|'."\n" + .'|imm.TaskId|String|任务ID。|'."\n" + .'|imm.Duration|String|总视频时长。|'."\n" + .'|imm.CompressDuration|String|总压缩时长。|'."\n" + .'|imm.CustomMessage|String|用户自定义信息。|'."\n" + .'|imm.Results|JSON String|视频转码结果。当返回结果中的Success为true时，表示该转码子任务成功，否则转码子任务失败。|'."\n" + .'|imm.Success|String|任务总体是否成功，当返回结果为空时，表示成功；不为空时，表示失败。'."\n" + ."\n" + .'轻量消息队列（原 MNS）返回的消息格式如下：'."\n" + ."\n\n" + .'```'."\n" + .'{'."\n" + .' "events": ['."\n" + .' {'."\n" + .' "eventName": "CompressVideoTask",'."\n" + .' "eventSource": "acs:imm",'."\n" + .' "eventTime": "2019-02-20T11:06:25.264Z",'."\n" + .' "eventVersion": "1.0",'."\n" + .' "imm": {'."\n" + .' "ErrorCode": "",'."\n" + .' "JobId": "CompressVideoTask-9bab56e8-e596-421a-b1f5-9ad1ab875fe4",'."\n" + .' "SourceDuration": "140",'."\n" + .' "CompressDuration": "70",'."\n" + .' "CustomMessage": "",'."\n" + .' "Results": "[{\\"TargetUri\\":\\"oss://imm-test/testcases/example.m3u8\\",\\"Success\\":\\"true\\",\\"TargetDuration\\": 140, \\"TargetResolution\\":\\"640x480\\"},{\\"TargetUri\\":\\"oss://imm-test/testcases/example.m3u8\\",\\"Success\\":\\"false\\",\\"Reason\\":\\"Invalid Parameters\\"}]"'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'```', + ], + 'CreateGrabFrameTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'immvideotest', + ], + ], + [ + 'name' => 'VideoUri', + 'in' => 'query', + 'schema' => [ + 'description' => '视频的OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://imm-test/testcases/video.mp4', + ], + ], + [ + 'name' => 'NotifyTopicName', + 'in' => 'query', + 'schema' => [ + 'description' => '异步反向通知的TopicName。', + 'type' => 'string', + 'required' => false, + 'example' => 'topic1', + ], + ], + [ + 'name' => 'NotifyEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => '异步反向通知的Endpoint，任务执行状态可以通过该Endpoint异步通知给调用者。使用此功能需要先开通轻量消息队列（原 MNS）服务，新建topic和queue，并配置订阅关系。具体操作，请参见[轻量消息队列（原 MNS）快速入门](https://help.aliyun.com/document_detail/34412.html)。'."\n" + ."\n" + .'> 轻量消息队列（原 MNS）服务和智能媒体管理必须处于同一地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + ], + ], + [ + 'name' => 'TargetList', + 'in' => 'query', + 'schema' => [ + 'description' => '输出截帧列表。支持对同一视频同时输出多种结果。'."\n" + ."\n" + .'截帧列表包括如下选项：'."\n" + ."\n" + .'- TargetUri（必选）：输出文件的OSS URI，类型为String。'."\n" + ."\n" + .' 支持自定义文件名例如pre{002}suf.jpg，则输出图片文件的名称为pre002suf.jpg、pre003suf.jpg等。'."\n" + ."\n" + .' 如果TotalNumber为1，则直接使用该名称。'."\n" + ."\n" + .' OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。'."\n" + ."\n" + .'- GrabType（必选）：截帧类型，类型为String。目前支持sprite（雪碧图）和interval（间隔截帧）。'."\n" + ."\n" + .'- Interval（可选）：截帧间隔，支持按时长的百分比设置， 如果该值小于0.01则按0.01处理，类型为String。'."\n" + ."\n" + .' 当截取视频中的多个帧时，必须设置此参数；如果截取视频中单个帧时，可以不设置此参数。'."\n" + ."\n" + .'- TotalNumber（可选）：截帧数量，类型为Integer。'."\n" + ."\n" + .' 如果视频的有效时长不足，则按照有效时长截帧。'."\n" + ."\n" + .'- SkipBegin（可选）：跳过开始时间，支持按时长的百分比设置，类型为String。'."\n" + ."\n" + .'- SkipEnd（可选）：跳过结束时间，支持按时长的百分比设置，类型为String。'."\n" + ."\n" + .'- Width（可选）：截帧宽度，支持按百分比设置，类型为String。'."\n" + ."\n" + .'- Height（可选）：截帧高度，支持按百分比设置，类型为String。'."\n" + ."\n" + .'- SpriteRow（可选）：雪碧图中小图的行数，取值范围为1~20，类型为Integer。'."\n" + ."\n" + .' 当截取雪碧图时，必须设置此参数。截取雪碧图时会优先填写满行，行数不足时为黑色背景。'."\n" + ."\n" + .'- SpriteColumn（可选）：雪碧图中小图的列数，取值范围为1~20，类型为Integer。'."\n" + ."\n" + .' 当截取雪碧图时，必须设置此参数。截取雪碧图时会优先填写满行，行数不足时为黑色背景。'."\n" + ."\n" + .'- SpritePad（可选）：雪碧图中小图间的间隔，默认值为2，取值范围为1~50，类型为Integer。'."\n" + ."\n" + .'- SpriteMargin（可选）：雪碧图边缘间隔，默认值为2，取值范围为1~100，类型为Integer。'."\n" + ."\n" + .'- ScaleType（可选）：缩放方式，默认值为STRETCH，类型为String。可选值如下：'."\n" + ."\n" + .' - CROP：缩放并裁剪。'."\n" + .' - STRETCH：拉伸以填满。'."\n" + .' - FILL：缩放并保留黑边。'."\n" + .' - FIT：缩放并不保留黑边。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"GrabType":"interval","GrabNumber":"1","TargetUri":"oss://imm-test/testcases/grabframeimage.jpg"}]', + ], + ], + [ + 'name' => 'CustomMessage', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义的信息。在轻量消息队列（原 MNS）通知任务执行状态时，内容会原样返回。', + 'type' => 'string', + 'required' => false, + 'example' => 'GrabFrameTest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'GrabFrameTask-ffcdec0c-73ba-451a-bec4-a9fe3f4cd765', + ], + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '10AFFE69-73BA-47C2-8A85-029AA9DA72A3', + ], + 'TaskType' => [ + 'description' => '任务的类型，返回值固定为GrabFrameTask。', + 'type' => 'string', + 'example' => 'GrabFrameTask', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"GrabFrameTask-ffcdec0c-73ba-451a-bec4-a9fe3f4cd765\\",\\n \\"RequestId\\": \\"10AFFE69-73BA-47C2-8A85-029AA9DA72A3\\",\\n \\"TaskType\\": \\"GrabFrameTask\\"\\n}","errorExample":""},{"type":"xml","example":"<TaskId>GrabFrameTask-ffcdec0c-73ba-451a-bec4-a9fe3f4cd765</TaskId>\\n<RequestId>10AFFE69-73BA-47C2-8A85-029AA9DA72A3</RequestId>\\n<TaskType>GrabFrameTask</TaskType>","errorExample":""}]', + 'title' => '创建一个视频截帧任务', + 'summary' => '调用CreateGrabFrameTask接口创建一个视频截帧任务，执行完成后返回TaskId。', + 'description' => '- 此接口已不再维护，建议使用新版（2020-09-30版本）接口[CreateMediaConvertTask](~~478221~~)。关于新版与旧版API的对比，请参见[新旧版本使用指引](~~470337~~)中的**新版与旧版API对应关系说明**章节。'."\n" + ."\n" + .'- 执行完成后，使用[GetVideoTask](~~101035~~)接口查询返回的TaskId，可以查看任务执行结果。您也可以使用通知机制，传入NotifyTopicName和NotifyEndpoint，及时通知任务执行信息。'."\n" + .'- 使用视频截帧时，输出的图片按照一张一秒计费。', + 'requestParamsDescription' => '#轻量消息队列（原 MNS）通知'."\n" + ."\n" + .'请求参数中如果设置了NotifyTopicName和NotifyEndpoint支持[轻量消息队列（原 MNS）事件通知](https://help.aliyun.com/document_detail/27498.html)，则智能媒体管理会为您返回异步通知。通知的消息格式为： '."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "events": ['."\n" + .' {'."\n" + .' "eventName": "GrabFrameTask",'."\n" + .' "eventSource": "acs:imm",'."\n" + .' "eventTime": "2019-09-30T14:14:51.901Z",'."\n" + .' "eventVersion": "1.0",'."\n" + .' "imm": {'."\n" + .' "CustomMessage": "hello",'."\n" + .' "ErrorCode": "",'."\n" + .' "GrabDuration": "1",'."\n" + .' "JobId": "GrabFrameTask-2c21f159-dfe1-4cb3-ba5d-5db0c422ac2a",'."\n" + .' "Results": "[{\\"Success\\":\\"true\\",\\"GrabType\\":\\"interval\\",\\"GrabNumber\\":\\"1\\",\\"FinalNumber\\":\\"1\\",\\"TargetPrefix\\":\\"oss://imm-test/testcases/",\\"TargetList\\":[\\"grabframeimage.jpg\\"],\\"Reason\\":\\"\\"}]",'."\n" + .' "SourceCodec": "h264",'."\n" + .' "SourceDuration": "182.58",'."\n" + .' "SourceResolution": "1280x720",'."\n" + .' "TaskId": "GrabFrameTask-2c21f159-dfe1-4cb3-ba5d-5db0c422ac2a",'."\n" + .' "VideoUri": "oss://imm-test/testcases/video.mp4"'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'```'."\n" + .'轻量消息队列（原 MNS）通知返回参数说明请参见下表。'."\n" + ."\n" + .'| 参数| 类型| 描述|'."\n" + .'| ----------------- | ----------- | --------------------------------------- |'."\n" + .'| eventName| String | 任务类型，返回值固定为GrabFrameTask。 |'."\n" + .'| imm.TaskId| String | 任务唯一ID。|'."\n" + .'| imm.Duration | String | 视频总时长。|'."\n" + .'| imm.GrabDuration | String | 截帧处理时长。|'."\n" + .'| imm.CustomMessage | String | 用户自定义信息，返回内容和创建任务时设置的内容一致。|'."\n" + .'| imm.Results | String | 视频转码结果Result数组，以JSON格式表示。|'."\n" + ."\n" + .'Result包括的选项请参见下表。'."\n" + .'|参数|类型|描述|'."\n" + .'| ----------------- | ----------- | ------------- |'."\n" + .'|Success|String|任务执行是否成功。|'."\n" + .'|GrabType|String|截帧模式。|'."\n" + .'|GrabNumber|String|截帧数量，一张按一秒计费。|'."\n" + .'|FinalNumber|String|最终输出的数量，例如雪碧图的张数。|'."\n" + .'|TargetPrefix|String|输出图片的前缀。|'."\n" + .'|TargetList|[]String|输出图片的数组，如果图片较多时，直接输出设置的值。|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-beijing-gov-1', + 'endpoint' => 'imm-vpc.cn-beijing-gov-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'imm.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'imm.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'imm.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'imm.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'imm.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'imm.cn-north-2-gov-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'imm.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'imm.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'imm.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'imm.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'imm.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'imm.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'imm.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'imm.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'imm.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'imm.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'imm.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'imm.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'imm.cn-wulanchabu.aliyuncs.com', + ], + ], +]; diff --git a/data/zh_cn/imm/2020-09-30/api-docs.php b/data/zh_cn/imm/2020-09-30/api-docs.php new file mode 100644 index 0000000..5a668c5 --- /dev/null +++ b/data/zh_cn/imm/2020-09-30/api-docs.php @@ -0,0 +1,21589 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'imm', + 'version' => '2020-09-30', + ], + 'directories' => [ + [ + 'id' => 178523, + 'title' => '服务地域', + 'type' => 'directory', + 'children' => [ + 'ListRegions', + ], + ], + [ + 'id' => 178609, + 'title' => '项目管理', + 'type' => 'directory', + 'children' => [ + 'CreateProject', + 'UpdateProject', + 'GetProject', + 'ListProjects', + 'DeleteProject', + ], + ], + [ + 'id' => 178610, + 'title' => '元数据管理', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 178611, + 'title' => '数据集管理', + 'type' => 'directory', + 'children' => [ + 'CreateDataset', + 'UpdateDataset', + 'GetDataset', + 'ListDatasets', + 'DeleteDataset', + ], + ], + [ + 'id' => 178612, + 'title' => '元数据索引', + 'type' => 'directory', + 'children' => [ + 'IndexFileMeta', + 'BatchIndexFileMeta', + 'UpdateFileMeta', + 'BatchUpdateFileMeta', + 'GetFileMeta', + 'BatchGetFileMeta', + 'DeleteFileMeta', + 'BatchDeleteFileMeta', + ], + ], + [ + 'id' => 178699, + 'title' => '查询与统计', + 'type' => 'directory', + 'children' => [ + 'SimpleQuery', + 'SemanticQuery', + 'FuzzyQuery', + ], + ], + [ + 'id' => 178700, + 'title' => '智能管理', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 178701, + 'title' => '人脸聚类', + 'type' => 'directory', + 'children' => [ + 'CreateFigureClusteringTask', + 'CreateFigureClustersMergingTask', + 'GetFigureCluster', + 'QueryFigureClusters', + 'BatchGetFigureCluster', + 'UpdateFigureCluster', + 'SearchImageFigureCluster', + 'CreateFacesSearchingTask', + ], + ], + [ + 'id' => 178702, + 'title' => '时空聚类', + 'type' => 'directory', + 'children' => [ + 'CreateLocationDateClusteringTask', + 'QueryLocationDateClusters', + 'UpdateLocationDateCluster', + 'DeleteLocationDateCluster', + ], + ], + [ + 'id' => 178703, + 'title' => '故事', + 'type' => 'directory', + 'children' => [ + 'CreateStory', + 'QueryStories', + 'GetStory', + 'CreateCustomizedStory', + 'UpdateStory', + 'AddStoryFiles', + 'RemoveStoryFiles', + 'DeleteStory', + ], + ], + [ + 'id' => 181692, + 'title' => '图片聚类', + 'type' => 'directory', + 'children' => [ + 'CreateSimilarImageClusteringTask', + 'QuerySimilarImageClusters', + ], + ], + ], + ], + [ + 'id' => 178704, + 'title' => '数据绑定', + 'type' => 'directory', + 'children' => [ + 'CreateBinding', + 'GetBinding', + 'ListBindings', + 'DeleteBinding', + 'AttachOSSBucket', + 'DetachOSSBucket', + 'GetOSSBucketAttachment', + ], + ], + ], + ], + [ + 'id' => 178705, + 'title' => '图片处理', + 'type' => 'directory', + 'children' => [ + 'EncodeBlindWatermark', + 'CreateDecodeBlindWatermarkTask', + 'GetDecodeBlindWatermarkResult', + 'DetectImageLabels', + 'DetectImageScore', + 'DetectImageCodes', + 'DetectImageFaces', + 'DetectImageCropping', + 'AddImageMosaic', + 'CreateImageToPDFTask', + 'CreateImageSplicingTask', + 'CompareImageFaces', + 'DetectImageBodies', + 'DetectImageCars', + 'DetectImageTexts', + ], + ], + [ + 'id' => 178706, + 'title' => '媒体处理', + 'type' => 'directory', + 'children' => [ + 'CreateMediaConvertTask', + 'DetectMediaMeta', + 'CreateVideoLabelClassificationTask', + 'GetVideoLabelClassificationResult', + 'GenerateVideoPlaylist', + ], + ], + [ + 'id' => 178707, + 'title' => '文档处理', + 'type' => 'directory', + 'children' => [ + 'GenerateWebofficeToken', + 'RefreshWebofficeToken', + 'CreateOfficeConversionTask', + 'ExtractDocumentText', + ], + ], + [ + 'id' => 178708, + 'title' => '文件处理', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 178709, + 'title' => '压缩解压', + 'type' => 'directory', + 'children' => [ + 'CreateFileCompressionTask', + 'CreateArchiveFileInspectionTask', + 'CreateFileUncompressionTask', + ], + ], + [ + 'id' => 178710, + 'title' => '点云压缩', + 'type' => 'directory', + 'children' => [ + 'CreateCompressPointCloudTask', + ], + ], + ], + ], + [ + 'id' => 178711, + 'title' => '内容安全', + 'type' => 'directory', + 'children' => [ + 'DetectTextAnomaly', + 'CreateImageModerationTask', + 'CreateVideoModerationTask', + 'GetImageModerationResult', + 'GetVideoModerationResult', + ], + ], + [ + 'id' => 178712, + 'title' => '任务管理', + 'type' => 'directory', + 'children' => [ + 'GetTask', + 'ListTasks', + [ + 'id' => 178931, + 'title' => '触发器', + 'type' => 'directory', + 'children' => [ + 'CreateTrigger', + 'SuspendTrigger', + 'ResumeTrigger', + 'UpdateTrigger', + 'GetTrigger', + 'ListTriggers', + 'DeleteTrigger', + ], + ], + [ + 'id' => 180710, + 'title' => '批处理', + 'type' => 'directory', + 'children' => [ + 'CreateBatch', + 'SuspendBatch', + 'ResumeBatch', + 'UpdateBatch', + 'ListBatches', + 'GetBatch', + 'DeleteBatch', + ], + ], + ], + ], + [ + 'id' => 371156, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'ListAttachedOSSBuckets', + 'ContextualAnswer', + 'ContextualRetrieval', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'Address' => [ + 'title' => 'A short description of struct', + 'description' => '地址信息。', + 'type' => 'object', + 'properties' => [ + 'Language' => [ + 'title' => 'Language', + 'description' => '语言，格式为BCP 47。', + 'type' => 'string', + 'example' => 'zh-Hans', + ], + 'AddressLine' => [ + 'title' => 'AddressLine', + 'description' => '完整地址。', + 'type' => 'string', + 'example' => '中国浙江省杭州市余杭区文一西路969号', + ], + 'Country' => [ + 'title' => 'Country', + 'description' => '国家或地区。', + 'type' => 'string', + 'example' => '中国', + ], + 'Province' => [ + 'title' => 'Province', + 'description' => '省。', + 'type' => 'string', + 'example' => '浙江省', + ], + 'City' => [ + 'title' => 'City', + 'description' => '城市。', + 'type' => 'string', + 'example' => '杭州市', + ], + 'District' => [ + 'title' => 'District', + 'description' => '区。', + 'type' => 'string', + 'example' => '余杭区', + ], + 'Township' => [ + 'title' => 'Township', + 'description' => '街道。', + 'type' => 'string', + 'example' => '文一西路', + ], + ], + ], + 'AddressForStory' => [ + 'title' => 'A short description of struct', + 'description' => '用于故事的地址对象。', + 'type' => 'object', + 'properties' => [ + 'Country' => [ + 'title' => '国家', + 'description' => '国家。', + 'type' => 'string', + 'example' => '中国', + ], + 'Province' => [ + 'title' => '省', + 'description' => '省。', + 'type' => 'string', + 'example' => '浙江省', + ], + 'City' => [ + 'title' => '城市', + 'description' => '城市。', + 'type' => 'string', + 'example' => '杭州市', + ], + 'District' => [ + 'title' => '地区', + 'description' => '地区。', + 'type' => 'string', + 'example' => '滨江区', + ], + 'Township' => [ + 'title' => '乡镇', + 'description' => '乡镇。', + 'type' => 'string', + 'example' => '长河街道', + ], + ], + ], + 'AlgorithmDefinition' => [ + 'title' => '算法定义结构体', + 'description' => '算法定义结构体', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'title' => '描述信息', + 'description' => '描述信息', + 'type' => 'string', + 'example' => 'test', + ], + 'OwnerId' => [ + 'title' => '阿里云账号ID', + 'description' => '阿里云账号ID', + 'type' => 'string', + 'example' => 'user1', + ], + 'ProjectName' => [ + 'title' => '项目名称', + 'description' => '项目名称', + 'type' => 'string', + 'example' => 'traningtest', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2023-05-31T10:19:40.572325888+08:00', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2023-05-31T10:19:40.572325888+08:00', + ], + 'TrainingSpecification' => [ + 'title' => '模型训练参数', + 'description' => '模型训练参数', + '$ref' => '#/components/schemas/TrainingSpecification', + ], + 'AlgorithmDefinitionId' => [ + 'title' => '算法定义ID', + 'description' => '算法定义ID', + 'type' => 'string', + 'example' => '8fc6e718-8d19-495f-a510-bcee3c598588', + ], + 'Name' => [ + 'title' => '算法名称', + 'description' => '算法名称', + 'type' => 'string', + 'example' => 'algoName', + ], + 'CustomLabels' => [ + 'title' => '自定义标签', + 'description' => '自定义标签', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '可选项，文件自定义标签列表。储存您业务自定义的键名、键值对信息，用于在查询时可以据此为筛选项进行检索，详情请见[字段和操作符的支持列表](~~2743991~~)。', + 'type' => 'string', + 'example' => '{'."\n" + .' "MemberName": "Tim",'."\n" + .' "Enabled": "True",'."\n" + .' "ItemCount": "10"'."\n" + .'}', + ], + ], + ], + ], + ], + 'Answer' => [ + 'title' => '大模型生成的答案', + 'description' => 'AI助手二期，大模型生成的答案', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'title' => '回答内容', + 'description' => '回答内容', + 'type' => 'string', + 'example' => '你好', + ], + 'References' => [ + 'title' => '回答内容的来源，即参考文件', + 'description' => '回答内容的来源，即参考文件', + 'type' => 'array', + 'items' => [ + 'description' => 'AI 机器人问答 API 中，回答内容对应的参考文献', + '$ref' => '#/components/schemas/ReferenceFile', + ], + ], + ], + ], + 'App' => [ + 'title' => 'App', + 'description' => 'App', + 'type' => 'object', + 'properties' => [ + 'AppDescription' => [ + 'title' => 'AppDescription', + 'description' => '应用描述信息', + 'type' => 'string', + 'example' => '中国最大的电商购物商城', + ], + 'AppId' => [ + 'title' => 'AppId', + 'description' => '应用ID', + 'type' => 'string', + 'example' => '1234567890', + ], + 'PackageName' => [ + 'title' => 'PackageName', + 'description' => 'PackageName', + 'type' => 'string', + 'example' => 'ThisIsAPackageName', + ], + 'AppType' => [ + 'title' => 'AppType', + 'description' => '应用类型，0表示安卓，1表示IOS', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'EnglishName' => [ + 'title' => 'EnglishName', + 'description' => '应用英文名称', + 'type' => 'string', + 'example' => 'Taobao', + ], + 'AppName' => [ + 'title' => 'AppName', + 'description' => '应用名称', + 'type' => 'string', + 'example' => '淘宝', + ], + 'AppRegion' => [ + 'title' => 'AppRegion', + 'description' => '应用使用地区，0表示国内，1表示国外', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'OwnerId' => [ + 'title' => 'OwnerId', + 'description' => '客户ID', + 'type' => 'string', + 'example' => '1023210024677934', + ], + 'AppKey' => [ + 'title' => 'AppKey', + 'description' => '创建应用时返回的Key', + 'type' => 'string', + 'example' => 'ryBOBW0Z6NnQ3fV9', + ], + ], + ], + 'AssumeRoleChain' => [ + 'title' => '链式授权', + 'description' => '扮演角色链式授权对象。', + 'type' => 'object', + 'properties' => [ + 'Policy' => [ + 'title' => '当前用户 policy', + 'description' => '授权策略。', + 'type' => 'string', + 'example' => '{'."\n" + .' "Statement": ['."\n" + .' {'."\n" + .' "Action": "oss:*",'."\n" + .' "Effect": "Allow",'."\n" + .' "Resource": "*"'."\n" + .' }'."\n" + .' ],'."\n" + .' "Version": "1"'."\n" + .'}', + ], + 'Chain' => [ + 'title' => '链式授权节点', + 'description' => '授权链路列表。', + 'type' => 'array', + 'items' => [ + 'description' => '链式授权节点。', + '$ref' => '#/components/schemas/AssumeRoleChainNode', + ], + ], + ], + ], + 'AssumeRoleChainNode' => [ + 'title' => '链式授权节点', + 'description' => '链式授权节点对象。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '账号类型，普通账号填 user，服务账号填 service', + 'description' => '账号类型，可选值如下。'."\n" + ."\n" + .'- user：阿里云账号。'."\n" + .'- service：阿里云服务。', + 'type' => 'string', + 'required' => true, + 'example' => 'user', + ], + 'OwnerId' => [ + 'title' => '账号id', + 'description' => '账号UID。', + 'type' => 'string', + 'required' => true, + 'example' => '10232100********', + ], + 'Role' => [ + 'title' => '授权角色名', + 'description' => '授权角色。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-role', + ], + ], + ], + 'AudioStream' => [ + 'title' => 'A short description of struct', + 'description' => '音频流信息。', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => 'Index', + 'description' => '音频流索引号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Language' => [ + 'title' => 'Language', + 'description' => '音频流中使用的语言，格式为BCP 47', + 'type' => 'string', + 'example' => 'en', + ], + 'CodecName' => [ + 'title' => 'CodecName', + 'description' => '编码器名称。', + 'type' => 'string', + 'example' => 'aac', + ], + 'CodecLongName' => [ + 'title' => 'CodecLongName', + 'description' => '编码器名称的全称。', + 'type' => 'string', + 'example' => 'AAC (Advanced Audio Coding)', + ], + 'CodecTimeBase' => [ + 'title' => 'CodecTimeBase', + 'description' => '编码器时间基准。', + 'type' => 'string', + 'example' => '1/44100', + ], + 'CodecTagString' => [ + 'title' => 'CodecTagString', + 'description' => '编码器标识描述信息。', + 'type' => 'string', + 'example' => 'mp4a', + ], + 'CodecTag' => [ + 'title' => 'CodecTag', + 'description' => '编码器标识。', + 'type' => 'string', + 'example' => '0x6134706d', + ], + 'TimeBase' => [ + 'title' => 'TimeBase', + 'description' => '时间基准。', + 'type' => 'string', + 'example' => '1/48000', + ], + 'StartTime' => [ + 'title' => 'StartTime', + 'description' => '音频流起始时间，单位为秒（s）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0235', + ], + 'Duration' => [ + 'title' => 'Duration', + 'description' => '音频流持续时长，单位为秒（s）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '3.690667', + ], + 'Bitrate' => [ + 'title' => 'Bitrate', + 'description' => '码率，单位为比特每秒（bit/s）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '320087', + ], + 'FrameCount' => [ + 'title' => 'FrameCount', + 'description' => '帧数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '173', + ], + 'Lyric' => [ + 'title' => 'Lyric', + 'description' => '歌词。', + 'type' => 'string', + 'example' => 'test', + ], + 'SampleFormat' => [ + 'title' => 'SampleFormat', + 'description' => '采样格式。', + 'type' => 'string', + 'example' => 'fltp', + ], + 'SampleRate' => [ + 'title' => 'SampleRate', + 'description' => '采样率，单位为赫兹（Hz）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '48000', + ], + 'Channels' => [ + 'title' => 'Channels', + 'description' => '声道数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'ChannelLayout' => [ + 'title' => 'ChannelLayout', + 'description' => '声道排布形式。', + 'type' => 'string', + 'example' => 'stereo', + ], + ], + ], + 'Binding' => [ + 'title' => 'A short description of struct', + 'description' => '绑定信息。', + 'type' => 'object', + 'properties' => [ + 'ProjectName' => [ + 'title' => 'ProjectName', + 'description' => '项目名称。', + 'type' => 'string', + 'example' => 'immtest', + ], + 'DatasetName' => [ + 'title' => 'DatasetName', + 'description' => '数据集名称。', + 'type' => 'string', + 'example' => 'dataset001', + ], + 'URI' => [ + 'title' => 'URI', + 'description' => '数据集绑定的对象存储（OSS） Bucket URI。'."\n" + ."\n" + .'对象存储（OSS） Bucket URI的格式为`oss://${bucketname}`，其中`bucketname`为和当前项目处于同一地域的OSS Bucket名称。', + 'type' => 'string', + 'example' => 'oss://examplebucket', + ], + 'State' => [ + 'title' => 'State', + 'description' => '数据集和OSS Bucket绑定关系的状态。取值范围如下：'."\n" + ."\n" + .'- Ready：绑定关系创建后准备中。'."\n" + .'- Stopped：绑定关系已暂停。'."\n" + .'- Running：绑定关系运行中。'."\n" + .'- Retrying：绑定关系创建后重试中。'."\n" + .'- Failed：绑定关系创建失败。'."\n" + .'- Deleted：绑定关系已删除。', + 'type' => 'string', + 'example' => 'Running', + ], + 'Phase' => [ + 'title' => 'Phase', + 'description' => '扫描类型。取值范围如下：'."\n" + ."\n" + .'- FullScanning：全量扫描中。'."\n" + .'- IncrementalScanning：增量扫描中。', + 'type' => 'string', + 'example' => 'FullScanning', + ], + 'CreateTime' => [ + 'title' => 'CreateTime', + 'description' => '数据集和OSS Bucket绑定关系创建时间的时间戳，格式为RFC3339Nano。', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + ], + 'UpdateTime' => [ + 'title' => 'UpdateTime', + 'description' => '数据集和OSS Bucket的绑定关系修改时间的时间戳，格式为RFC3339Nano。'."\n" + ."\n" + .'>创建绑定关系后，如果未暂停或者未重启过绑定关系，则绑定关系修改时间的时间戳和绑定关系创建时间的时间戳相同。', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + ], + 'Reason' => [ + 'title' => 'Reason', + 'description' => 'Reason', + 'type' => 'string', + 'example' => '暂停使用', + ], + ], + ], + 'Body' => [ + 'title' => 'A short description of struct', + 'description' => '人体信息对象。', + 'type' => 'object', + 'properties' => [ + 'Confidence' => [ + 'title' => 'Confidence', + 'description' => '人体置信度，置信度越高越可信，大于 0.8 比较可信。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.82', + ], + 'Boundary' => [ + 'title' => 'Boundary', + 'description' => '人体边界对象。', + '$ref' => '#/components/schemas/Boundary', + ], + ], + ], + 'Boundary' => [ + 'title' => 'A short description of struct', + 'description' => '边界信息。', + 'type' => 'object', + 'properties' => [ + 'Width' => [ + 'title' => 'Width', + 'description' => '宽度，单位为像素（px）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Height' => [ + 'title' => 'Height', + 'description' => '高度，单位为像素（px）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300', + ], + 'Left' => [ + 'title' => 'Left', + 'description' => '顶点X坐标距离左端距离，单位为像素（px）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Top' => [ + 'title' => 'Top', + 'description' => '顶点Y坐标距离顶端距离，单位为像素（px）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'Polygon' => [ + 'title' => '多边形的坐标列表', + 'description' => '使用若干个点围成的闭合多边形范围，当Boundary描述的是多边形框而非矩形框时有效。'."\n" + ."\n" + .'><notice>该字段与Width / Height / Left / Top 四个参数组成的矩形范围参数只会出现一种。即当前 Boundary 描述只可能是一个矩形框或多边形框的一种，具体种类和当前框内容的形态本身一致。></notice>', + 'type' => 'array', + 'items' => [ + 'description' => '使用若干个点围成的闭合多边形范围信息。', + '$ref' => '#/components/schemas/PointInt64', + ], + ], + ], + ], + 'Car' => [ + 'title' => 'A short description of struct', + 'description' => '车辆信息对象。', + 'type' => 'object', + 'properties' => [ + 'LicensePlates' => [ + 'title' => '车牌', + 'description' => '车牌列表。', + 'type' => 'array', + 'items' => [ + 'description' => '车牌详细信息。', + '$ref' => '#/components/schemas/LicensePlate', + ], + ], + 'CarType' => [ + 'title' => '车辆类型', + 'description' => '车辆类型，取值范围如下：'."\n" + ."\n" + .'- car：汽车'."\n" + ."\n" + .'- bus：公共汽车'."\n" + ."\n" + .'- truck：卡车'."\n" + ."\n" + .'- van：火车', + 'type' => 'string', + 'example' => 'van', + ], + 'CarTypeConfidence' => [ + 'title' => '车辆类型置信度', + 'description' => '车辆类型置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.516', + ], + 'CarColor' => [ + 'title' => '车辆颜色', + 'description' => '车辆颜色。取值范围如下：'."\n" + ."\n" + .'- white：白色'."\n" + ."\n" + .'- grey：灰色'."\n" + ."\n" + .'- yellow：黄色'."\n" + ."\n" + .'- red：红色'."\n" + ."\n" + .'- green：绿色'."\n" + ."\n" + .'- blue：蓝色'."\n" + ."\n" + .'- black：黑色'."\n" + ."\n" + .'- purple：紫色'."\n" + ."\n" + .'- brown：棕色', + 'type' => 'string', + 'example' => 'white', + ], + 'CarColorConfidence' => [ + 'title' => '车辆颜色置信度', + 'description' => '车辆颜色置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.604', + ], + 'Boundary' => [ + 'title' => '车辆裁剪框', + 'description' => '车辆裁剪框。', + '$ref' => '#/components/schemas/Boundary', + ], + 'Confidence' => [ + 'title' => '车辆置信度', + 'description' => '车辆置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.999', + ], + ], + ], + 'ClusterForReq' => [ + 'title' => 'A short description of struct', + 'description' => '聚类分组信息对象。', + 'type' => 'object', + 'properties' => [ + 'ObjectId' => [ + 'title' => 'ObjectId', + 'description' => '分组对象Id。', + 'type' => 'string', + 'example' => 'Cluster-99b1c333-86dc-45da-8c6****', + ], + 'CustomId' => [ + 'title' => 'CustomId', + 'description' => '自定义Id。', + 'type' => 'string', + 'example' => 'abc', + ], + 'CustomLabels' => [ + 'title' => 'CustomLabels', + 'description' => '自定义标签。', + 'type' => 'object', + 'example' => '{"Bucket": "examplebucket"}', + ], + 'Name' => [ + 'title' => 'Name', + 'description' => '分组名称。', + 'type' => 'string', + 'example' => 'abc', + ], + 'Cover' => [ + 'title' => 'Cover', + 'description' => '封面信息对象。', + 'type' => 'object', + 'properties' => [ + 'Figures' => [ + 'title' => 'Figures', + 'description' => '人物列表。', + 'type' => 'array', + 'items' => [ + 'description' => '人物对象。', + 'type' => 'object', + 'properties' => [ + 'FigureId' => [ + 'title' => 'FigureId', + 'description' => '人物对象Id。', + 'type' => 'string', + 'example' => '2cb3c51e-b406-4b0c-af1b-897d88e1****', + ], + ], + ], + ], + ], + ], + ], + ], + 'Codes' => [ + 'title' => 'A short description of struct', + 'description' => '码信息。', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'title' => 'Content', + 'description' => '码内容。', + 'type' => 'string', + 'example' => 'https://www.example.com', + ], + 'Confidence' => [ + 'title' => 'Confidence', + 'description' => '码置信度，置信度越高越可信，大于0.8比较可信。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9', + ], + 'Boundary' => [ + 'title' => 'Boundary', + 'description' => '码边界信息。', + '$ref' => '#/components/schemas/Boundary', + ], + 'Type' => [ + 'title' => 'Type', + 'description' => '码类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'qrcode' => '二维码', + 'barcode' => '条码', + ], + 'example' => 'qrcode', + ], + ], + ], + 'ContextualFile' => [ + 'title' => 'A short description of struct', + 'description' => '文件', + 'type' => 'object', + 'properties' => [ + 'OwnerId' => [ + 'title' => 'OwnerId', + 'description' => '用户ID', + 'type' => 'string', + 'example' => '1482910009923706', + ], + 'ProjectName' => [ + 'title' => 'ProjectName', + 'description' => '项目名称', + 'type' => 'string', + 'example' => 'test-project', + ], + 'DatasetName' => [ + 'title' => 'DatasetName', + 'description' => '数据集名称', + 'type' => 'string', + 'example' => 'test-dataset', + ], + 'ObjectId' => [ + 'title' => 'ObjectId', + 'description' => '对应File存在于Dataset中的标识符。', + 'type' => 'string', + 'example' => '0939d7ed-73fa-4009-bbe6-fbbe07b92b2e', + ], + 'URI' => [ + 'title' => 'URI', + 'description' => '文件URI。'."\n" + .'OSS地址规则为oss://${bucketname}/${objectname}，其中${bucketname}为和当前项目处于同一地域的OSS Bucket名称，${objectname}为文件路径。'."\n" + .'PDS地址规则为pds://domains/${domain}/drives/${drive}/files/${file}/revisions/${revision}。', + 'type' => 'string', + 'example' => 'oss://test-bucket', + ], + 'OSSURI' => [ + 'title' => 'OSSURI', + 'description' => 'OSS文件的URI路径。仅在URI为PDS地址时使用。', + 'type' => 'string', + 'example' => 'oss://test-bucket/test-object.jpg', + ], + 'MediaType' => [ + 'title' => 'MediaType', + 'description' => '当前File的媒体类型', + 'type' => 'string', + 'enumValueTitles' => [ + 'image' => 'image', + 'other' => 'other', + 'document' => 'document', + 'archive' => 'archive', + 'audio' => 'audio', + 'video' => 'video', + ], + 'example' => 'document', + ], + 'ContentType' => [ + 'title' => 'ContentType', + 'description' => '文件内容类型（MIME Type）。', + 'type' => 'string', + 'example' => 'text/x-imm-faq', + ], + 'Elements' => [ + 'title' => 'Elements', + 'description' => 'Elements', + 'type' => 'array', + 'items' => [ + 'description' => '文档分析生成的文档元素信息。', + '$ref' => '#/components/schemas/Element', + ], + ], + ], + ], + 'ContextualMessage' => [ + 'title' => '对话消息列表', + 'description' => 'AI 助手二期中，多轮对话中的消息', + 'type' => 'object', + 'properties' => [ + 'Role' => [ + 'title' => '对话角色', + 'description' => '对话角色', + 'type' => 'string', + 'example' => 'user', + ], + 'Content' => [ + 'title' => '消息内容', + 'description' => '消息内容', + 'type' => 'string', + 'example' => '你好', + ], + 'Files' => [ + 'title' => '对话中的文件列表', + 'description' => '对话中的文件列表', + 'type' => 'array', + 'items' => [ + 'description' => '文件信息的结构体。', + '$ref' => '#/components/schemas/ContextualFile', + ], + ], + ], + ], + 'CredentialConfig' => [ + 'title' => '链式授权配置', + 'description' => '链式授权配置对象，一般留空即可。'."\n" + .'> 假设当前使用A账号调用IMM接口处理B账号中的OSS数据。'."\n" + .'ServiceRole参数应配置A账号中的角色，Chain参数应设置B账号准备好的角色，通过上述配置完成后，就可以使用A账号调用IMM接口处理B账号中的OSS数据。', + 'type' => 'object', + 'properties' => [ + 'ServiceRole' => [ + 'title' => '服务角色', + 'description' => '服务角色，调用IMM接口的账号需要创建的一个角色，必须包含 `sts:AssumeRole` 权限，可以通过RAM控制台进行配置。', + 'type' => 'string', + 'example' => 'AliyunSTSAssumeForIMMServiceRole', + ], + 'Policy' => [ + 'title' => '权限策略', + 'description' => 'ServiceRole参数的角色所需配置的权限策略，例如允许访问OSS。可选', + 'type' => 'string', + 'example' => '{"Statement": [{"Action": "oss:*","Effect": "Allow","Resource": "*"}],"Version": "1"}', + ], + 'Chain' => [ + 'title' => '授权链', + 'description' => '需要传递授权的链列表，数组中的所有角色都需要赋予访问 `sts:AssumeRole` 权限。'."\n" + .'只有数组中的最后一个角色需要额外配置需要真正访问的其他权限，比如OSS的读写权限，可以通过RAM控制台进行授权操作。', + 'type' => 'array', + 'items' => [ + 'description' => '授权链对象。', + 'type' => 'object', + 'properties' => [ + 'AssumeRoleFor' => [ + 'title' => '授权对象', + 'description' => '提供授权的账号ID。', + 'type' => 'string', + 'example' => '10232100246xxxxx', + ], + 'Role' => [ + 'title' => '授权角色', + 'description' => '允许扮演的RAM角色。', + 'type' => 'string', + 'example' => 'AliyunOSSRole', + ], + 'RoleType' => [ + 'title' => '授权方类型', + 'description' => '角色类型，可选值如下。'."\n" + .'- user：阿里云账号。'."\n" + .'- service：阿里云服务。', + 'type' => 'string', + 'example' => 'user', + ], + ], + ], + ], + ], + ], + 'CroppingSuggestion' => [ + 'title' => 'A short description of struct', + 'description' => '裁剪建议。', + 'type' => 'object', + 'properties' => [ + 'AspectRatio' => [ + 'title' => 'AspectRatio', + 'description' => '图片裁剪比例。', + 'type' => 'string', + 'example' => '2:3', + ], + 'Confidence' => [ + 'title' => 'Confidence', + 'description' => '置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.742', + ], + 'Boundary' => [ + 'title' => 'Boundary', + 'description' => '裁剪边界信息。', + '$ref' => '#/components/schemas/Boundary', + ], + ], + ], + 'CustomParams' => [ + 'title' => '模型训练自定义参数信息', + 'description' => '模型训练自定义参数信息', + 'type' => 'object', + 'properties' => [ + 'Properties' => [ + 'title' => '属性列表', + 'description' => '属性列表', + 'type' => 'array', + 'items' => [ + 'description' => '属性信息。', + '$ref' => '#/components/schemas/Property', + ], + ], + 'Name' => [ + 'title' => '参数名称', + 'description' => '参数名称', + 'type' => 'string', + 'example' => 'Normalize', + ], + ], + ], + 'CustomPrompt' => [ + 'title' => 'AI助手自定义Prompt', + 'type' => 'object', + 'properties' => [ + 'RoleDefinition' => [ + 'title' => 'AI助手角色定义', + 'type' => 'string', + ], + ], + ], + 'DataIngestion' => [ + 'title' => 'A short description of struct', + 'description' => '一个数据接入实例。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '数据接入唯一标识', + 'description' => '数据接入唯一标识。', + 'type' => 'string', + 'example' => 'trigger-9f72636a-0f0c-4baf-ae78-38b27bfe****', + ], + 'Input' => [ + 'title' => '数据源信息', + 'description' => '数据源信息。', + '$ref' => '#/components/schemas/Input', + ], + 'Actions' => [ + 'title' => '运行模板', + 'description' => '处理模板列表。', + 'type' => 'array', + 'items' => [ + 'description' => '模版信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '动作名称', + 'description' => '模板名称。', + 'type' => 'string', + 'example' => 'doc/convert', + ], + 'Parameters' => [ + 'title' => '动作参数', + 'description' => '模板参数。', + 'type' => 'array', + 'items' => [ + 'description' => '模版参数。', + 'type' => 'string', + 'example' => 'pages=3', + ], + ], + 'FastFailPolicy' => [ + 'title' => '数据处理快速失败的策略配置', + 'description' => '数据处理快速失败的策略配置', + '$ref' => '#/components/schemas/FastFailPolicy', + ], + ], + ], + ], + 'Notification' => [ + 'title' => '通知地址', + 'description' => '任务完成通知。', + 'type' => 'object', + 'properties' => [ + 'Endpoint' => [ + 'title' => 'MNS 地址', + 'description' => 'MNS地址。', + 'type' => 'string', + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + ], + 'Topic' => [ + 'title' => 'MNS 主题', + 'description' => 'MNS主题。', + 'type' => 'string', + 'example' => 'topic1', + ], + 'MNS' => [ + 'title' => 'MNS', + 'description' => 'MNS', + '$ref' => '#/components/schemas/MNS', + ], + 'RocketMQ' => [ + 'title' => 'RocketMQ', + 'description' => 'RocketMQ', + '$ref' => '#/components/schemas/RocketMQ', + ], + ], + ], + 'Statistic' => [ + 'title' => '统计信息', + 'description' => '统计信息。', + 'type' => 'object', + 'properties' => [ + 'SubmitSuccess' => [ + 'title' => '提交成功个数', + 'description' => '提交成功个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'SubmitFailure' => [ + 'title' => '提交失败个数', + 'description' => '提交失败个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'SkipFiles' => [ + 'title' => '跳过文件个数', + 'description' => '跳过文件个数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'State' => [ + 'title' => '任务执行状态', + 'description' => '批处理任务状态：'."\n" + ."\n" + .'- Ready：任务就绪，刚创建的任务处于Ready状态。'."\n" + .'- Running：正在执行，正常执行的任务状态。'."\n" + .'- Failed：任务失败，任务执行出错，且无法自动恢复。'."\n" + .'- Suspended：任务暂停。'."\n" + .'- Succeeded：任务执行完成。', + 'type' => 'string', + 'example' => 'Succeeded', + ], + 'Marker' => [ + 'title' => '任务执行进度', + 'description' => '任务执行位置。', + 'type' => 'string', + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****', + ], + 'CreateTime' => [ + 'title' => '任务创建时间', + 'description' => '任务创建时间。', + 'type' => 'string', + 'example' => '2020-11-10T03:50:28Z', + ], + 'UpdateTime' => [ + 'title' => '任务更新时间', + 'description' => '任务更新时间。', + 'type' => 'string', + 'example' => '2021-12-18T07:40:29Z', + ], + 'Tags' => [ + 'title' => '标签', + 'description' => '任务标签。', + 'type' => 'object', + ], + 'Error' => [ + 'title' => '错误信息', + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'api returns error: SDKError: StatusCode: 404 Code: ResourceNotFound', + ], + 'Phase' => [ + 'title' => '扫描阶段', + 'description' => '扫描阶段', + 'type' => 'string', + 'example' => 'IncrementalScanning', + ], + 'ServiceRole' => [ + 'title' => '服务授权角色', + 'description' => '服务授权角色', + 'type' => 'string', + 'example' => 'AliyunIMMBatchTriggerRole', + ], + ], + ], + 'Dataset' => [ + 'title' => '媒体集结构体', + 'description' => '数据集信息。', + 'type' => 'object', + 'properties' => [ + 'ProjectName' => [ + 'title' => '项目名称', + 'description' => '项目名称。', + 'type' => 'string', + 'example' => 'immtest', + ], + 'DatasetName' => [ + 'title' => '媒体集名称', + 'description' => '数据集名称。', + 'type' => 'string', + 'example' => 'dataset001', + ], + 'TemplateId' => [ + 'title' => '模板Id', + 'description' => '工作流模板ID。', + 'type' => 'string', + 'example' => 'Official:ImageManagement', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '数据集创建时间的时间戳，格式为RFC3339Nano。', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'description' => '数据集修改时间的时间戳，格式为RFC3339Nano。'."\n" + ."\n" + .'>创建数据集后，如果未更新过数据集，则数据集修改时间的时间戳和数据集创建时间的时间戳相同。', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + ], + 'Description' => [ + 'title' => '描述', + 'description' => '数据集描述信息。', + 'type' => 'string', + 'example' => '测试数据集', + ], + 'DatasetMaxBindCount' => [ + 'title' => '媒体集最大绑定数', + 'description' => '每个数据集绑定的最大个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'DatasetMaxFileCount' => [ + 'title' => '媒体集最多文件数量', + 'description' => '数据集中文件的最大个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000000', + ], + 'DatasetMaxEntityCount' => [ + 'title' => '媒体集最多实体数量', + 'description' => '数据集中元数据实体的最大个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000000000', + ], + 'DatasetMaxRelationCount' => [ + 'title' => '媒体集最多关系数量', + 'description' => '数据集中元数据关系的最大个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000000000', + ], + 'DatasetMaxTotalFileSize' => [ + 'title' => '媒体集最大文件总大小', + 'description' => '数据集中文件总大小的最大值，单位为字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '90000000000000000', + ], + 'BindCount' => [ + 'title' => '媒体集当前绑定数', + 'description' => '数据集当前绑定的OSS Bucket数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'FileCount' => [ + 'title' => '媒体集当前文件数', + 'description' => '数据集当前文件数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalFileSize' => [ + 'title' => '媒体集当前文件总大小', + 'description' => '数据集中文件总大小，单位为字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000', + ], + 'WorkflowParameters' => [ + 'title' => '自定义参数', + 'description' => '自定义参数。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义参数结构体。', + '$ref' => '#/components/schemas/WorkflowParameter', + ], + ], + ], + ], + 'DatasetTaskStatus' => [ + 'title' => 'A short description of struct', + 'description' => 'Dataset 任务状态', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '任务状态', + 'description' => '任务状态', + 'type' => 'string', + 'example' => 'Succeeded', + ], + 'LastSucceededTime' => [ + 'title' => '上一次完成时间', + 'description' => '上一次完成时间', + 'type' => 'string', + 'example' => '2024-06-29T14:50:13.011643661+08:00', + ], + 'StartTime' => [ + 'title' => '任务开始时间', + 'description' => '任务开始时间', + 'type' => 'string', + 'example' => '2024-06-29T14:50:13.011643661+08:00', + ], + ], + ], + 'DocumentParseKeywordOption' => [ + 'type' => 'object', + 'properties' => [ + 'Extract' => [ + 'title' => '是否提取', + 'type' => 'boolean', + ], + 'Count' => [ + 'title' => '关键词数量', + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'DocumentParseNarratorOption' => [ + 'type' => 'object', + 'properties' => [ + 'Narrate' => [ + 'title' => '文章导读', + 'type' => 'boolean', + ], + ], + ], + 'DocumentParseOption' => [ + 'type' => 'object', + 'properties' => [ + 'Narrator' => [ + '$ref' => '#/components/schemas/DocumentParseNarratorOption', + ], + 'Summary' => [ + '$ref' => '#/components/schemas/DocumentParseSummaryOption', + ], + 'Question' => [ + '$ref' => '#/components/schemas/DocumentParseQuestionOption', + ], + 'Keyword' => [ + '$ref' => '#/components/schemas/DocumentParseKeywordOption', + ], + ], + ], + 'DocumentParseQuestionOption' => [ + 'type' => 'object', + 'properties' => [ + 'Extract' => [ + 'title' => '是否提取', + 'type' => 'boolean', + ], + 'Count' => [ + 'title' => '问题数量', + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'DocumentParseSummaryOption' => [ + 'type' => 'object', + 'properties' => [ + 'Summarize' => [ + 'title' => '文章总结', + 'type' => 'boolean', + ], + 'ChapterSummarize' => [ + 'title' => '文档分章节总结', + 'type' => 'boolean', + ], + ], + ], + 'Element' => [ + 'title' => 'A short description of struct', + 'description' => '文档分析生成的文档元素信息。', + 'type' => 'object', + 'properties' => [ + 'ElementContents' => [ + 'title' => '元素内容列表', + 'description' => '元素内容列表。', + 'type' => 'array', + 'items' => [ + 'description' => '元素内容信息。', + '$ref' => '#/components/schemas/ElementContent', + ], + ], + 'ObjectId' => [ + 'title' => '文档片段的唯一ID', + 'description' => '文档片段的唯一ID', + 'type' => 'string', + 'example' => 'id1', + ], + 'ElementType' => [ + 'title' => '文档片段的类型', + 'description' => '文档片段的类型', + 'type' => 'string', + 'example' => 'title - 标题； image - 图片 ； table - 表格 ； narrative-text - 正文', + ], + 'SemanticSimilarity' => [ + 'title' => '当前文件和语义匹配的相似度', + 'description' => '当前文件和语义匹配的相似度', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8', + ], + 'ElementRelations' => [ + 'title' => '当前文档片段和其他文档片段的关系', + 'description' => '当前文档片段和其他文档片段的关系', + 'type' => 'array', + 'items' => [ + 'description' => '当前文档片段和其他文档片段的关系结构体', + '$ref' => '#/components/schemas/ElementRelation', + ], + ], + ], + ], + 'ElementContent' => [ + 'title' => 'A short description of struct', + 'description' => '文档分析生成的元素的内容信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '元素内容的类型', + 'description' => '元素内容的类型。'."\n" + ."\n" + .'可选值如下：'."\n" + ."\n" + .'- text：文本。'."\n" + .'- image：图片。'."\n" + .'- link：链接。', + 'type' => 'string', + 'example' => 'text', + ], + 'Content' => [ + 'title' => '元素内容正文', + 'description' => '元素的内容。'."\n" + ."\n" + .'当元素内容类型为图片或链接时表示其占位符文本。', + 'type' => 'string', + 'example' => '文本片段', + ], + 'URL' => [ + 'title' => '元素内容的链接', + 'description' => '元素内容的链接。当元素内容类型为图片或链接时有效。', + 'type' => 'string', + 'example' => 'http://aliyun.com', + ], + 'TimeRange' => [ + 'title' => '持续的时间范围，数组长度固定为2，分别代表开始时间和结束时间，单位为毫秒。', + 'description' => '持续的时间范围，数组长度固定为2，分别代表开始时间和结束时间，单位为毫秒。', + 'type' => 'array', + 'items' => [ + 'description' => '时间范围对象。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '500', + ], + ], + ], + ], + 'ElementRelation' => [ + 'title' => 'A short description of struct', + 'description' => '当前文档片段和其他文档片段的关系', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '类型', + 'description' => '类型', + 'type' => 'string', + 'example' => 'child，parent', + ], + 'ObjectId' => [ + 'title' => '文档片段的ID', + 'description' => '文档片段的ID', + 'type' => 'string', + 'example' => 'id1', + ], + ], + ], + 'FastFailPolicy' => [ + 'title' => '快速失败策略结构体', + 'description' => '快速失败策略结构体', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'title' => '失败执行策略', + 'description' => '快速失败执行策略，批处理或触发器中根据该策略配置可以选择遇到错误停止运行或继续运行。', + 'type' => 'string', + 'enumValueTitles' => [ + 'abort' => '遇到错误停止运行', + 'ignore' => '忽略错误继续执行', + ], + 'example' => 'abort', + ], + ], + ], + 'Figure' => [ + 'title' => 'A short description of struct', + 'description' => '人物信息。', + 'type' => 'object', + 'properties' => [ + 'FigureId' => [ + 'title' => 'FigureId', + 'description' => '人物对象ID。', + 'type' => 'string', + 'example' => '868a9e74-cde5-4c7a-9013-28bb984****', + ], + 'FigureConfidence' => [ + 'title' => 'FigureConfidence', + 'description' => '人物对象置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'FigureClusterId' => [ + 'title' => 'FigureClusterId', + 'description' => '人物聚类ID。包括如下保留的特殊聚类ID命名：'."\n" + ."\n" + .'- figure-cluster-id-independent：该人脸暂无合适的分组，后续在数据集中新增图片后进行人脸聚类操作时，该人脸可能被分入组中。'."\n" + ."\n" + .'- figure-cluster-id-unavailable：该人脸暂未进行过聚类操作，即在数据集中新增图片后，未进行人脸聚类。', + 'type' => 'string', + 'example' => 'Cluster-dbe72fec-b84c-4ab6-885b-3678e64****', + ], + 'FigureClusterConfidence' => [ + 'title' => 'FigureClusterConfidence', + 'description' => '聚类置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'FigureType' => [ + 'title' => 'FigureType', + 'description' => '人物类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'face' => '人脸', + ], + 'example' => 'face', + ], + 'Age' => [ + 'title' => 'Age', + 'description' => '年龄。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '29', + ], + 'AgeSD' => [ + 'title' => 'AgeSD', + 'description' => '年龄标准差。', + 'type' => 'number', + 'format' => 'float', + 'example' => '5', + ], + 'Gender' => [ + 'title' => 'Gender', + 'description' => '性别。', + 'type' => 'string', + 'enumValueTitles' => [ + 'female' => '女性', + 'male' => '男性', + ], + 'example' => 'female', + ], + 'GenderConfidence' => [ + 'title' => 'GenderConfidence', + 'description' => '性别置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Emotion' => [ + 'title' => 'Emotion', + 'description' => '心情。', + 'type' => 'string', + 'enumValueTitles' => [ + 'happiness' => '开心', + 'none' => '无', + ], + 'example' => 'happiness', + ], + 'EmotionConfidence' => [ + 'title' => 'EmotionConfidence', + 'description' => '心情置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.707845687866210', + ], + 'FaceQuality' => [ + 'title' => 'FaceQuality', + 'description' => '人脸质量，评价图像质量是否适合人脸识别，分数越高质量越好，取值范围为0~1。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.960875928401947', + ], + 'Boundary' => [ + 'title' => 'Boundary', + 'description' => '人脸边界信息。', + '$ref' => '#/components/schemas/Boundary', + ], + 'Mouth' => [ + 'title' => 'Mouth', + 'description' => '是否张口。', + 'type' => 'string', + 'enumValueTitles' => [ + 'close' => '否', + 'open' => '是', + ], + 'example' => 'close', + ], + 'MouthConfidence' => [ + 'title' => 'MouthConfidence', + 'description' => '是否张口置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Beard' => [ + 'title' => 'Beard', + 'description' => '是否有胡子。', + 'type' => 'string', + 'enumValueTitles' => [ + 'beard' => '是', + 'none' => '否', + ], + 'example' => 'none', + ], + 'BeardConfidence' => [ + 'title' => 'BeardConfidence', + 'description' => '是否有胡子置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Hat' => [ + 'title' => 'Hat', + 'description' => '是否有帽子。', + 'type' => 'string', + 'enumValueTitles' => [ + 'hat' => '是', + 'none' => '否', + ], + 'example' => 'none', + ], + 'HatConfidence' => [ + 'title' => 'HatConfidence', + 'description' => '是否戴帽子置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Mask' => [ + 'title' => 'Mask', + 'description' => '是否带口罩。', + 'type' => 'string', + 'enumValueTitles' => [ + 'none' => '否', + 'mask' => '是', + ], + 'example' => 'none', + ], + 'MaskConfidence' => [ + 'title' => 'MaskConfidence', + 'description' => '是否带口罩置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Glasses' => [ + 'title' => 'Glasses', + 'description' => '是否戴眼镜。', + 'type' => 'string', + 'enumValueTitles' => [ + 'glasses' => '戴眼镜', + 'sunglasses' => '戴太阳镜', + 'none' => '否', + ], + 'example' => 'none', + ], + 'GlassesConfidence' => [ + 'title' => 'GlassesConfidence', + 'description' => '是否戴眼镜置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8', + ], + 'Sharpness' => [ + 'title' => 'Sharpness', + 'description' => '清晰度，分数越高人脸越清晰，取值范围为0~1。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.7', + ], + 'Attractive' => [ + 'title' => 'Attractive', + 'description' => '人脸吸引力，分数越高吸引力越强，取值范围为0~1。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.96', + ], + 'HeadPose' => [ + 'description' => '头部朝向信息。', + '$ref' => '#/components/schemas/HeadPose', + ], + ], + ], + 'FigureCluster' => [ + 'title' => 'A short description of struct', + 'description' => '聚类分组信息对象。', + 'type' => 'object', + 'properties' => [ + 'OwnerId' => [ + 'title' => 'OwnerId', + 'description' => '所属用户Id。', + 'type' => 'string', + 'example' => '102321002****', + ], + 'ProjectName' => [ + 'title' => 'ProjectName', + 'description' => '项目名称。', + 'type' => 'string', + 'example' => 'immtest', + ], + 'DatasetName' => [ + 'title' => 'DatasetName', + 'description' => '数据集名称。', + 'type' => 'string', + 'example' => 'dataset001', + ], + 'ObjectType' => [ + 'title' => 'ObjectType', + 'description' => '分组对象的类型。', + 'type' => 'string', + 'example' => 'figure-cluster', + ], + 'ObjectId' => [ + 'title' => 'ObjectId', + 'description' => '分组对象Id。', + 'type' => 'string', + 'example' => 'Cluster-ae6e3472-999e-410b-b54e-cd5dba****', + ], + 'UpdateTime' => [ + 'title' => 'UpdateTime', + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2022-01-14T10:10:52.83948013+08:00', + ], + 'CreateTime' => [ + 'title' => 'CreateTime', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-01-14T10:10:52.83948013+08:00', + ], + 'Name' => [ + 'title' => 'Name', + 'description' => '分组名称。', + 'type' => 'string', + 'example' => 'abc', + ], + 'Gender' => [ + 'title' => 'Gender', + 'description' => '性别。', + 'type' => 'string', + 'example' => 'female', + ], + 'FaceCount' => [ + 'title' => 'FaceCount', + 'description' => '人脸数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'ImageCount' => [ + 'title' => 'ImageCount', + 'description' => '图片数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'VideoCount' => [ + 'title' => 'VideoCount', + 'description' => '视频数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'AverageAge' => [ + 'title' => 'AverageAge', + 'description' => '平均年龄。', + 'type' => 'number', + 'format' => 'float', + 'example' => '26', + ], + 'MinAge' => [ + 'title' => 'MinAge', + 'description' => '最小年龄。', + 'type' => 'number', + 'format' => 'float', + 'example' => '12', + ], + 'MaxAge' => [ + 'title' => 'MaxAge', + 'description' => '最大年龄。', + 'type' => 'number', + 'format' => 'float', + 'example' => '44', + ], + 'Cover' => [ + 'title' => 'Cover', + 'description' => '封面信息。', + '$ref' => '#/components/schemas/File', + ], + 'CustomId' => [ + 'title' => 'CustomId', + 'description' => '自定义ID。', + 'type' => 'string', + 'example' => 'abc', + ], + 'CustomLabels' => [ + 'title' => 'CustomLabels', + 'description' => '自定义标签，用于根据标签搜索分组。', + 'type' => 'object', + 'example' => '{"Bucket": "examplebucket"}', + ], + 'MetaLockVersion' => [ + 'title' => 'MetaLockVersion', + 'description' => '元数据锁版本。'."\n" + .'在对分组进行更新时，传入当前数据的 MetaLockVersion（通常通过 Get/List 接口获得），服务端将校验 MetaLockVersion 字段的值是否和传入值一致，并仅当一致时才实际进行更新。用于在并发场景避免更新发生冲突。初始值为0，每次成功更新后自动加1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'FigureClusterForReq' => [ + 'title' => 'A short description of struct', + 'description' => '用于更新聚类分组信息的对象。', + 'type' => 'object', + 'properties' => [ + 'ObjectId' => [ + 'title' => 'ObjectId', + 'description' => '分组的对象ID。', + 'type' => 'string', + 'example' => 'Cluster-99b1c333-86dc-45da-8c6****', + ], + 'Name' => [ + 'title' => 'Name', + 'description' => '分组名称。', + 'type' => 'string', + 'example' => 'abc', + ], + 'Cover' => [ + 'title' => 'Cover', + 'description' => '封面。', + 'type' => 'object', + 'properties' => [ + 'Figures' => [ + 'title' => 'Figures', + 'description' => '人物列表。', + 'type' => 'array', + 'items' => [ + 'description' => '人物对象。', + 'type' => 'object', + 'properties' => [ + 'FigureId' => [ + 'title' => 'FigureId', + 'description' => '人物对象Id。', + 'type' => 'string', + 'example' => '2cb3c51e-b406-4b0c-af1b-897d88e1****', + ], + ], + ], + ], + ], + ], + 'CustomId' => [ + 'title' => 'CustomId', + 'description' => '自定义ID。', + 'type' => 'string', + 'example' => 'abc', + ], + 'CustomLabels' => [ + 'title' => 'CustomLabels', + 'description' => '自定义标签，用于根据标签搜索分组。', + 'type' => 'object', + 'example' => '{"Bucket": "examplebucket"}', + ], + 'MetaLockVersion' => [ + 'title' => 'MetaLockVersion', + 'description' => '元数据锁版本。在分组进行更新时，传入当前数据的 MetaLockVersion（通常通过 Get/List 接口获得），服务端将校验 MetaLockVersion 字段的值是否和传入值一致，并仅当一致时才实际进行更新。用于在并发场景避免更新发生冲突。初始值为0，每次成功更新后自动加1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + 'File' => [ + 'title' => 'A short description of struct', + 'description' => '文件元数据信息。', + 'type' => 'object', + 'properties' => [ + 'OwnerId' => [ + 'title' => 'OwnerId', + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'example' => '102321002467****', + ], + 'ProjectName' => [ + 'title' => 'ProjectName', + 'description' => '项目名称，见[创建项目](~~478153~~)。', + 'type' => 'string', + 'example' => 'test-project', + ], + 'DatasetName' => [ + 'title' => 'DatasetName', + 'description' => '数据集名称，见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'example' => 'test-dataset', + ], + 'ObjectType' => [ + 'title' => 'ObjectType', + 'description' => '对象类型，固定取值为**file**。', + 'type' => 'string', + 'example' => 'file', + ], + 'ObjectId' => [ + 'title' => 'ObjectId', + 'description' => '对象唯一ID。', + 'type' => 'string', + 'example' => '75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7', + ], + 'UpdateTime' => [ + 'title' => 'UpdateTime', + 'description' => '元数据修改时间的时间戳， 格式为RFC3339Nano。', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + ], + 'CreateTime' => [ + 'title' => 'CreateTime', + 'description' => '元数据创建时间的时间戳， 格式为RFC3339Nano。', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + ], + 'URI' => [ + 'title' => 'URI', + 'description' => '文件地址。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一地域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。'."\n" + ."\n" + .'PDS地址规则为pds://domains/${domain}/drives/${drive}/files/${file}/revisions/${revision}。', + 'type' => 'string', + 'example' => 'oss://test-bucket/test-object.jpg', + ], + 'OSSURI' => [ + 'title' => 'OSSURI', + 'description' => 'OSS文件的URI路径。仅在URI为PDS地址时使用。', + 'type' => 'string', + 'example' => 'oss://examplebucket/sampleobject.jpg', + ], + 'Filename' => [ + 'title' => 'Filename', + 'description' => '文件名称。对于OSS文件则为其ObjectKey。', + 'type' => 'string', + 'example' => 'sampleobject.jpg', + ], + 'MediaType' => [ + 'title' => 'MediaType', + 'description' => '文件媒体类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'image' => '图片', + 'other' => '其他', + 'document' => '文档', + 'archive' => '压缩包', + 'audio' => '音频', + 'video' => '视频', + ], + 'example' => 'image', + ], + 'ContentType' => [ + 'title' => 'ContentType', + 'description' => '文件内容类型（MIME Type）。', + 'type' => 'string', + 'example' => 'image/jpeg', + ], + 'Size' => [ + 'title' => 'Size', + 'description' => '文件大小，单位为字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'FileHash' => [ + 'title' => 'FileHash', + 'description' => '文件哈希值。', + 'type' => 'string', + 'example' => '1d9c280a7c4f67f7ef873e28449dbe17', + ], + 'FileModifiedTime' => [ + 'title' => 'FileModifiedTime', + 'description' => '文件最近一次修改时间的时间戳， 格式为RFC3339Nano。', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + ], + 'FileCreateTime' => [ + 'title' => 'FileCreateTime', + 'description' => '文件创建时间的时间戳，格式为RFC3339Nano。', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + ], + 'FileAccessTime' => [ + 'title' => 'FileAccessTime', + 'description' => '文件访问时间的时间戳，格式为RFC3339Nano。', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + ], + 'ProduceTime' => [ + 'title' => 'ProduceTime', + 'description' => '照片拍摄时间。', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + ], + 'LatLong' => [ + 'title' => 'LatLong', + 'description' => 'GPS经纬度信息。', + 'type' => 'string', + 'example' => '30.134390,120.074997', + ], + 'Timezone' => [ + 'title' => 'Timezone', + 'description' => '时区。'."\n" + .'> 暂时不支持。', + 'type' => 'string', + 'example' => '""', + ], + 'Addresses' => [ + 'title' => 'Addresses', + 'description' => '地址信息。', + 'type' => 'array', + 'items' => [ + 'description' => '地址信息。', + '$ref' => '#/components/schemas/Address', + ], + ], + 'TravelClusterId' => [ + 'title' => 'TravelClusterId', + 'description' => '预留参数。'."\n" + .'> 暂时不支持。', + 'type' => 'string', + 'example' => '-', + ], + 'Orientation' => [ + 'title' => 'Orientation', + 'description' => '图片旋转值，从EXIF信息中获取。'."\n" + ."\n" + .'如果图片EXIF信息无此信息，则返回结果中无此参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Figures' => [ + 'title' => 'Figures', + 'description' => '人物列表。通过AI模型自动检测。', + 'type' => 'array', + 'items' => [ + 'description' => '人物信息。', + '$ref' => '#/components/schemas/Figure', + ], + ], + 'FigureCount' => [ + 'title' => 'FigureCount', + 'description' => '人物数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Labels' => [ + 'title' => 'Labels', + 'description' => '文件标签信息列表。通过AI模型自动检测。', + 'type' => 'array', + 'items' => [ + 'description' => '文件标签信息。', + '$ref' => '#/components/schemas/Label', + ], + ], + 'Title' => [ + 'title' => 'Title', + 'description' => '文件标题。', + 'type' => 'string', + 'example' => 'test', + ], + 'ImageWidth' => [ + 'title' => 'ImageWidth', + 'description' => '图片宽度，单位为像素（px）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '270', + ], + 'ImageHeight' => [ + 'title' => 'ImageHeight', + 'description' => '图片高度，单位为像素（px）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '500', + ], + 'EXIF' => [ + 'title' => 'EXIF', + 'description' => '图片原始EXIF信息，以JSON Object序列化后的格式存储。参考[OSS获取图片信息](~~44975~~)。', + 'type' => 'string', + 'example' => '{"Compression":{"value":"6"},"DateTime":{"value":"2020:08:19 17:11:11"}}', + ], + 'ImageScore' => [ + 'description' => '图片评分信息。通过AI模型自动检测。', + '$ref' => '#/components/schemas/ImageScore', + ], + 'CroppingSuggestions' => [ + 'title' => 'CroppingSuggestions', + 'description' => '图片的裁剪建议。'."\n" + .'> 暂时不支持。', + 'type' => 'array', + 'items' => [ + 'description' => '图片的剪裁建议。', + '$ref' => '#/components/schemas/CroppingSuggestion', + ], + ], + 'OCRContents' => [ + 'title' => 'OCRContents', + 'description' => 'OCR识别结果。'."\n" + .'> 暂时不支持。', + 'type' => 'array', + 'items' => [ + 'description' => 'OCR识别结果。', + '$ref' => '#/components/schemas/OCRContents', + ], + ], + 'VideoWidth' => [ + 'title' => 'VideoWidth', + 'description' => '视频画面宽度，单位为像素（px）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1080', + ], + 'VideoHeight' => [ + 'title' => 'VideoHeight', + 'description' => '视频画面高度，单位为像素（px）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1920', + ], + 'VideoStreams' => [ + 'title' => 'VideoStreams', + 'description' => '视频流列表。', + 'type' => 'array', + 'items' => [ + 'description' => '视频流。', + '$ref' => '#/components/schemas/VideoStream', + ], + ], + 'Subtitles' => [ + 'title' => 'Subtitles', + 'description' => '字幕流列表。', + 'type' => 'array', + 'items' => [ + 'description' => '字幕流。', + '$ref' => '#/components/schemas/SubtitleStream', + ], + ], + 'AudioStreams' => [ + 'title' => 'AudioStreams', + 'description' => '音频流列表。', + 'type' => 'array', + 'items' => [ + 'description' => '音频流。', + '$ref' => '#/components/schemas/AudioStream', + ], + ], + 'Artist' => [ + 'title' => 'Artist', + 'description' => '艺术家。', + 'type' => 'string', + 'example' => 'Jane', + ], + 'AlbumArtist' => [ + 'title' => 'AlbumArtist', + 'description' => '演唱者。', + 'type' => 'string', + 'example' => 'Jane', + ], + 'AudioCovers' => [ + 'title' => 'AudioCovers', + 'description' => '音频封面。', + 'type' => 'array', + 'items' => [ + 'description' => '音频封面。', + '$ref' => '#/components/schemas/Image', + ], + ], + 'Composer' => [ + 'title' => 'Composer', + 'description' => '作曲家。', + 'type' => 'string', + 'example' => 'Jane', + ], + 'Performer' => [ + 'title' => 'Performer', + 'description' => '演奏者。', + 'type' => 'string', + 'example' => 'Jane', + ], + 'Language' => [ + 'title' => 'Language', + 'description' => '语言，格式为BCP 47。', + 'type' => 'string', + 'example' => 'eng', + ], + 'Album' => [ + 'title' => 'Album', + 'description' => '专辑。', + 'type' => 'string', + 'example' => 'FirstAlbum', + ], + 'PageCount' => [ + 'title' => 'PageCount', + 'description' => '页数。'."\n" + .'> 暂时不支持。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'ETag' => [ + 'title' => 'ETag', + 'description' => 'Object生成时会创建相应的ETag ，ETag用于标识一个Object的内容。', + 'type' => 'string', + 'example' => '"1D9C280A7C4F67F7EF873E28449****"', + ], + 'CacheControl' => [ + 'title' => 'CacheControl', + 'description' => '指定Object被下载时网页的缓存行为。'."\n" + ."\n" + .'该字段需要设置OSS Object HTTP属性Cache-Control，详情请参见[管理文件元信息](~~31859~~)。', + 'type' => 'string', + 'example' => 'no-cache', + ], + 'ContentDisposition' => [ + 'title' => 'ContentDisposition', + 'description' => '指定Object被下载时的名称。'."\n" + ."\n" + .'该字段需要设置OSS Object HTTP属性Content-Disposition，详情请参见[管理文件元信息](~~31859~~)。', + 'type' => 'string', + 'example' => 'attachment; filename =test.jpg', + ], + 'ContentEncoding' => [ + 'title' => 'ContentEncoding', + 'description' => '指定该Object被下载时的内容编码格式。'."\n" + ."\n" + .'该字段需要设置OSS Object HTTP属性Content-Encoding，详情请参见[管理文件元信息](~~31859~~)。', + 'type' => 'string', + 'example' => 'UTF-8', + ], + 'ContentLanguage' => [ + 'title' => 'ContentLanguage', + 'description' => 'Object内容使用的语言。'."\n" + ."\n" + .'该字段需要设置OSS Object HTTP属性Content-Language，详情请参见[管理文件元信息](~~31859~~)。', + 'type' => 'string', + 'example' => 'zh-CN', + ], + 'AccessControlAllowOrigin' => [ + 'title' => 'AccessControlAllowOrigin', + 'description' => '允许的跨域请求的来源。', + 'type' => 'string', + 'example' => 'https://aliyundoc.com', + ], + 'AccessControlRequestMethod' => [ + 'title' => 'AccessControlRequestMethod', + 'description' => '在实际请求中会用到的方法。', + 'type' => 'string', + 'example' => 'PUT', + ], + 'ServerSideEncryptionCustomerAlgorithm' => [ + 'title' => 'ServerSideEncryptionCustomerAlgorithm', + 'description' => '用户在服务端自定义加密文件时使用的加密编码算法。', + 'type' => 'string', + 'example' => 'SM4', + ], + 'ServerSideEncryption' => [ + 'title' => 'ServerSideEncryption', + 'description' => '服务器端加密方式。'."\n" + ."\n" + .'该字段需要设置OSS Bucket服务端加密，详情请参见[服务端加密](~~31871~~)。', + 'type' => 'string', + 'example' => 'AES256', + ], + 'ServerSideDataEncryption' => [ + 'title' => 'ServerSideDataEncryption', + 'description' => 'Object的加密算法。'."\n" + ."\n" + .'该字段需要设置OSS Bucket服务端加密，详情请参见[服务端加密](~~31871~~)。', + 'type' => 'string', + 'example' => 'SM4', + ], + 'ServerSideEncryptionKeyId' => [ + 'title' => 'ServerSideEncryptionKeyId', + 'description' => '表示KMS托管的用户主密钥。'."\n" + ."\n" + .'该字段需要设置OSS Bucket服务端加密，详情请参见[服务端加密](~~31871~~)。', + 'type' => 'string', + 'example' => '9468da86-3509-4f8d-a61e-6eab1eac****', + ], + 'OSSStorageClass' => [ + 'title' => 'OSSStorageClass', + 'description' => 'OSS存储空间类型。', + 'type' => 'string', + 'example' => 'Standard', + ], + 'OSSCRC64' => [ + 'title' => 'OSSCRC64', + 'description' => 'CRC64值。', + 'type' => 'string', + 'example' => '559890638950338001', + ], + 'ObjectACL' => [ + 'title' => 'ObjectACL', + 'description' => 'OSS对象ACL。', + 'type' => 'string', + 'example' => 'default', + ], + 'ContentMd5' => [ + 'title' => 'ContentMd5', + 'description' => 'MD5值。', + 'type' => 'string', + 'example' => 'HZwoCnxPZ/fvhz4oRJ2+Fw==', + ], + 'OSSUserMeta' => [ + 'title' => 'OSSUserMeta', + 'description' => 'OSS自定义元数据。'."\n" + ."\n" + .'该字段需要设置OSS Object自定义元数据，详情请参见[管理文件元信息](~~31859~~)。', + 'type' => 'object', + 'example' => '{"key": "val"}', + ], + 'OSSTaggingCount' => [ + 'title' => 'OSSTaggingCount', + 'description' => 'OSS对象标签数量。'."\n" + ."\n" + .'该字段需要设置OSS Object对象标签，详情请参见[对象标签](~~106678~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'OSSTagging' => [ + 'title' => 'OSSTagging', + 'description' => 'OSS对象标签。'."\n" + ."\n" + .'详情请参见[对象标签](~~106678~~)。', + 'type' => 'object', + 'example' => '{"key": "val"}', + ], + 'OSSExpiration' => [ + 'title' => 'OSSExpiration', + 'description' => 'OSS过期时间。'."\n" + ."\n" + .'该字段需要设置OSS Object HTTP属性Expires，详情请参见[管理文件元信息](~~31859~~)。', + 'type' => 'string', + 'example' => '2120-01-01T12:00:00.000Z', + ], + 'OSSVersionId' => [ + 'title' => 'OSSVersionId', + 'description' => 'OSS文件版本。'."\n" + ."\n" + .'该字段需要开启OSS Bucket版本控制，详情请参见[版本控制介绍](~~109695~~)。', + 'type' => 'string', + 'example' => 'CAEQNhiBgMDJgZCA0BYiIDc4MGZjZGI2OTBjOTRmNTE5NmU5NmFhZjhjYmY0****', + ], + 'OSSDeleteMarker' => [ + 'title' => 'OSSDeleteMarker', + 'description' => 'OSS删除标记。', + 'type' => 'string', + 'example' => 'CAEQMhiBgIDXiaaB0BYiIGQzYmRkZGUxMTM1ZDRjOTZhNjk4YjRjMTAyZjhl****', + ], + 'OSSObjectType' => [ + 'title' => 'OSSObjectType', + 'description' => 'OSS Object类型。一般为`Normal`。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'CustomId' => [ + 'title' => 'CustomId', + 'description' => '该文件的自定义ID。该文件索引到数据集后，作为该行元数据的属性存储，用于和您的业务系统进行关联、对应。您可以根据业务需求传入该值，例如将某个URI关联到您系统内的某个ID。推荐传入全局唯一的值。', + 'type' => 'string', + 'example' => ' '."\n" + .'member-image-id-0001', + ], + 'CustomLabels' => [ + 'title' => 'CustomLabels', + 'description' => '可选项，文件自定义标签列表。储存您业务自定义的键名、键值对信息，用于在查询时可以据此为筛选项进行检索。', + 'type' => 'object', + 'example' => '{'."\n" + .' "MemberName": "Tim",'."\n" + .' "Enabled": "True",'."\n" + .' "ItemCount": "10"'."\n" + .'}', + ], + 'StreamCount' => [ + 'title' => 'StreamCount', + 'description' => ' 媒体容器中媒体流的数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ProgramCount' => [ + 'title' => 'ProgramCount', + 'description' => '媒体容器中节目数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'FormatName' => [ + 'title' => 'FormatName', + 'description' => '媒体格式名称。', + 'type' => 'string', + 'example' => 'mov', + ], + 'FormatLongName' => [ + 'title' => 'FormatLongName', + 'description' => '媒体格式名称的全称。', + 'type' => 'string', + 'example' => 'QuickTime / MOV', + ], + 'StartTime' => [ + 'title' => 'StartTime', + 'description' => '首帧时间。单位秒。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.000000', + ], + 'Bitrate' => [ + 'title' => 'Bitrate', + 'description' => '码率，单位为比特每秒（bit/s）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '13091201', + ], + 'Duration' => [ + 'title' => 'Duration', + 'description' => '视频的总时长。单位秒。', + 'type' => 'number', + 'format' => 'double', + 'example' => '15.263000', + ], + 'SemanticTypes' => [ + 'title' => 'SemanticTypes', + 'description' => '在使用 SemanticQuery API 进行语义搜索时，当前文件被搜索出来的原因列表。', + 'type' => 'array', + 'items' => [ + 'description' => '在使用 SemanticQuery API 进行语义搜索时，当前文件被搜索出来的原因。'."\n" + ."\n" + .'可选值如下：'."\n" + .'- content：文档语义内容、图片上的内容相符。'."\n" + .'- text：文档的文字字符串、图片上的文字相符。'."\n" + .'- datetime：文件的创作时间相符。'."\n" + .'- address：文件的创作地点相符。'."\n" + .'- figure：文件中包含的人物名称相符。'."\n" + .'><notice>可选值可能随着算法演进而增加。></notice>', + 'type' => 'string', + 'example' => 'content', + ], + ], + 'Elements' => [ + 'title' => 'Elements', + 'description' => '在使用 SemanticQuery API 进行语义搜索时，和当前搜索内容匹配的文档片段元素列表。', + 'type' => 'array', + 'items' => [ + 'description' => '和当前搜索内容匹配的文档片段元素信息。', + '$ref' => '#/components/schemas/Element', + ], + ], + 'SceneElements' => [ + 'title' => 'SceneElements', + 'description' => '视频片段元素列表。使用AI大模型对视频进行分析后，抽取出来的若干场景片段元素。', + 'type' => 'array', + 'items' => [ + 'description' => '视频片段元素信息。', + '$ref' => '#/components/schemas/SceneElement', + ], + ], + 'OCRTexts' => [ + 'title' => 'OCRTexts', + 'description' => '图片中检测到的文本。', + 'type' => 'string', + 'example' => '阿里云IMM', + ], + 'Reason' => [ + 'title' => 'Reason', + 'description' => '文件运行索引失败的原因。', + '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' => '文件索引状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Failed' => '文件执行索引构建失败。', + 'Indexed' => '文件执行索引构建完成。', + 'Pending' => '文件已经提交索引任务，准备进入索引构建。', + 'Deleting' => '文件处于删除中，此时该文件进入清理阶段，此阶段用户无法对文件进行写操作，如IndexFileMeta、UpdateFileMeta会返回409', + 'Indexing' => '文件执行索引构建任务过程中。', + ], + 'example' => 'Indexed', + ], + 'Insights' => [ + 'description' => '文件的摘要与描述。'."\n" + .'> 暂时不支持。', + '$ref' => '#/components/schemas/Insights', + ], + ], + ], + 'FileSmartCluster' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'SmartClusterId' => [ + 'title' => 'SmartClusterId', + 'description' => 'SmartClusterId', + 'type' => 'string', + 'example' => 'SmartCluster-12cd1645-deae-4b5e-9434-613747b75f6d', + ], + 'Similarity' => [ + 'title' => 'Similarity', + 'description' => 'Similarity', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9', + ], + ], + ], + 'FunctionCall' => [ + 'title' => 'AI助手可调用函数的定义', + 'description' => 'AI 助手可调用的function 的定义', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '函数名称', + 'description' => '函数名称', + 'type' => 'string', + 'required' => true, + 'example' => 'search_file', + ], + 'Arguments' => [ + 'title' => '由LLM识别的实参列表', + 'description' => '由LLM识别的实参列表', + 'type' => 'string', + 'example' => '{'."\n" + .' "type": "object",'."\n" + .' "name": {'."\n" + .' "type": "string", '."\n" + .' "description": "需要检索的文件的文件名。可以为空 null"'."\n" + .' }, '."\n" + .' "required": ['."\n" + .' "category"'."\n" + .' ]'."\n" + .'}', + ], + ], + ], + 'HeadPose' => [ + 'title' => 'A short description of struct', + 'description' => '头部朝向信息。', + 'type' => 'object', + 'properties' => [ + 'Pitch' => [ + 'title' => 'Pitch', + 'description' => '人脸的俯仰角，取值范围为-180度～180度，可信的范围建议为-30度～30度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '18.385589599609375', + ], + 'Roll' => [ + 'title' => 'Roll', + 'description' => '内偏转角，取值范围为-180度～180度，可信的建议范围为-45度～45度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '4.204030513763428', + ], + 'Yaw' => [ + 'title' => 'Yaw', + 'description' => '人脸的左右偏转角，取值范围为-180度～180度，可信的范围建议为-80度～80 度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '2.4945924282073975', + ], + ], + ], + 'Hyperparameters' => [ + 'title' => '模型训练运行超参数信息', + 'description' => '模型训练运行超参数信息', + 'type' => 'object', + 'properties' => [ + 'BatchSize' => [ + 'title' => '训练BatchSize', + 'description' => '训练BatchSize', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + ], + 'InputSize' => [ + 'title' => '图像大小, 数组内宽和高', + 'description' => '图像大小, 数组内宽和高', + 'type' => 'array', + 'items' => [ + 'description' => '图像大小, 数组内宽和高', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '640', + ], + 'required' => true, + ], + 'Schedule' => [ + 'description' => '学习率变化策略', + '$ref' => '#/components/schemas/Schedule', + ], + 'MaxEpoch' => [ + 'title' => '总的训练迭代epoch轮数', + 'description' => '总的训练迭代epoch轮数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Evaluator' => [ + 'description' => '模型训练自定义参数信息', + 'required' => true, + '$ref' => '#/components/schemas/CustomParams', + ], + 'DataLoaderWorkers' => [ + 'title' => '读取训练数据线程数', + 'description' => '读取训练数据线程数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'Optimization' => [ + 'description' => '优化算法信息', + '$ref' => '#/components/schemas/Optimization', + ], + 'BackupInterval' => [ + 'title' => '保存模型配置频率，1表示每过一遍训练数据保存一次', + 'description' => '保存模型配置频率，1表示每过一遍训练数据保存一次', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + 'Image' => [ + 'title' => 'A short description of struct', + 'description' => '图片信息对象。', + 'type' => 'object', + 'properties' => [ + 'ImageWidth' => [ + 'title' => 'ImageWidth', + 'description' => '图片宽度，单位为像素（px）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '500', + ], + 'ImageHeight' => [ + 'title' => 'ImageHeight', + 'description' => '图片高度，单位为像素（px）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '820', + ], + 'EXIF' => [ + 'title' => 'EXIF', + 'description' => '图片原始EXIF信息，以JSON Object序列化后的格式存储。参考[OSS获取图片信息](~~44975~~)。', + 'type' => 'string', + 'example' => '{"FileSize":{"value":"29304"},"Format":{"value":"jpg"}}', + ], + 'ImageScore' => [ + 'description' => '图片评分信息。', + '$ref' => '#/components/schemas/ImageScore', + ], + 'CroppingSuggestions' => [ + 'title' => 'CroppingSuggestions', + 'description' => '图片的裁减建议列表。预留参数，暂不提供。', + 'type' => 'array', + 'items' => [ + 'description' => '图片的裁减建议。', + '$ref' => '#/components/schemas/CroppingSuggestion', + ], + ], + 'OCRContents' => [ + 'title' => 'OCRContents', + 'description' => 'OCR识别结果列表。预留参数，暂不提供。', + 'type' => 'array', + 'items' => [ + 'description' => 'OCR识别结果。', + '$ref' => '#/components/schemas/OCRContents', + ], + ], + ], + ], + 'ImageInsight' => [ + 'description' => '图片摘要与描述。', + 'type' => 'object', + 'properties' => [ + 'Caption' => [ + 'description' => '图片摘要。'."\n" + ."\n" + .'> 暂时不支持。', + 'type' => 'string', + 'example' => '无。', + ], + 'Description' => [ + 'description' => '图片描述。', + 'type' => 'string', + 'example' => '图片中有一人，穿着深色西装外套，内搭白色衬衫。背景为渐变的浅蓝色至灰色。', + ], + ], + ], + 'ImageScore' => [ + 'title' => 'A short description of struct', + 'description' => '图片评分信息。', + 'type' => 'object', + 'properties' => [ + 'OverallQualityScore' => [ + 'title' => 'OverallQualityScore', + 'description' => '图片整体质量评分。该评分为AI自动评估，主要以主观美学为准，受到构图、亮度、对比度、色彩、清晰度等多方面因素影响。'."\n" + ."\n" + .'范围0-1，越高则质量越好。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.736', + ], + ], + ], + 'ImageURL' => [ + 'type' => 'object', + 'properties' => [ + 'URL' => [ + 'type' => 'string', + ], + 'Thumbnail' => [ + 'type' => 'string', + ], + ], + ], + 'Input' => [ + 'title' => 'A short description of struct', + 'description' => '数据接入的输入配置对象。', + 'type' => 'object', + 'properties' => [ + 'OSS' => [ + 'description' => '对象存储OSS数据源', + '$ref' => '#/components/schemas/InputOSS', + ], + ], + ], + 'InputFile' => [ + 'title' => 'A short description of struct', + 'description' => '用于建立索引（如[IndexFileMeta](~~478166~~)）或更新索引（如[UpdateFileMeta](~~478168~~)）时的文件信息。', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'title' => 'URI', + 'description' => '必填项，本次请求进行索引、进行元数据更新的文件对象地址。支持OSS和PDS的URI地址。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。'."\n" + ."\n" + .'PDS地址规则为`pds://domains/${domain}/drives/${drive}/files/${file}/revisions/${revision}`。'."\n" + ."\n" + .'><notice>不支持`HTTP`开头的地址></notice>', + 'type' => 'string', + 'example' => 'oss://test-bucket/test-object', + ], + 'CustomId' => [ + 'title' => 'CustomId', + 'description' => '可选项，该文件的自定义ID。该文件索引到数据集后，作为该行元数据的属性存储，用于和您的业务系统进行关联、对应。您可以根据业务需求传入该值，例如将某个URI关联到您系统内的某个ID。推荐传入全局唯一的值。'."\n" + ."\n" + .'在查询时，该字段支持前缀查询和排序，详情请见[字段和操作符的支持列表](~~2743991~~)。', + 'type' => 'string', + 'example' => 'member-image-id-0001', + ], + 'CustomLabels' => [ + 'title' => 'CustomLabels', + 'description' => '可选项，文件自定义标签列表。储存您业务自定义的键名、键值对信息，用于在查询时可以据此为筛选项进行检索，详情请见[字段和操作符的支持列表](~~2743991~~)。', + 'type' => 'object', + 'example' => '{'."\n" + .' "MemberName": "Tim",'."\n" + .' "Enabled": "True",'."\n" + .' "ItemCount": "10"'."\n" + .'}', + ], + 'FileHash' => [ + 'title' => 'FileHash', + 'description' => '可选项，一般留空，文件哈希值。仅URI为PDS地址时需要传入。', + 'type' => 'string', + 'example' => '1d9c280a7c4f67f7ef873e28449dbe17', + ], + 'OSSURI' => [ + 'title' => 'OSSURI', + 'description' => '可选项，一般留空，OSS文件的路径。仅URI为PDS地址时可选传入。', + 'type' => 'string', + 'example' => 'oss://test-bucket/test-object.jpg', + ], + 'MediaType' => [ + 'title' => 'MediaType', + 'description' => '可选项，一般留空。文件媒体类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'image' => '图片', + 'other' => '其他', + 'document' => '文档', + 'archive' => '压缩包', + 'video' => '视频', + 'audio' => '音频', + ], + 'example' => 'image', + ], + 'ContentType' => [ + 'title' => 'ContentType', + 'description' => '可选项，一般留空。文件内容类型（MIME Type）。', + 'type' => 'string', + 'example' => 'image/jpeg', + ], + 'Figures' => [ + 'title' => 'Figures', + 'description' => '可选项。需要更新的人物列表。用于将某个人物移除出人物分组，或修改人物分组。请参考[人脸聚类](~~477175~~)能力。'."\n" + .'><notice>仅对UpdateFileMeta/BatchUpdateFileMeta接口生效。></notice>', + 'type' => 'array', + 'items' => [ + 'description' => '人物信息对象。', + 'type' => 'object', + 'properties' => [ + 'FigureId' => [ + 'title' => 'FigureId', + 'description' => '人物对象ID。', + 'type' => 'string', + 'example' => '2cb3c51e-b406-4b0c-af1b-897d88e1****', + ], + 'FigureClusterId' => [ + 'title' => 'FigureClusterId', + 'description' => '人物聚类ID。包括如下保留的特殊聚类ID命名：'."\n" + ."\n" + .'- figure-cluster-id-independent：该人脸暂无合适的分组，后续在数据集中新增图片后进行人脸聚类操作时，该人脸可能被分入组中。'."\n" + ."\n" + .'- figure-cluster-id-unavailable：该人脸暂未进行过聚类操作，即在数据集中新增图片后，未进行人脸聚类。', + 'type' => 'string', + 'example' => 'Cluster-dbe72fec-b84c-4ab6-885b-3678e64****'."\n", + ], + 'FigureType' => [ + 'title' => 'FigureType', + 'description' => '人物类型。目前填入固定值`face`。', + 'type' => 'string', + 'enumValueTitles' => [ + 'face' => 'face', + ], + 'example' => 'face', + ], + ], + ], + ], + 'LatLong' => [ + 'title' => 'LatLong', + 'description' => 'GPS 经纬度信息。', + 'type' => 'string', + 'example' => '30.134390,120.074997', + ], + 'ProduceTime' => [ + 'title' => 'ProduceTime', + 'description' => '照片拍摄时间。', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + ], + 'Title' => [ + 'title' => 'Title', + 'description' => '文件标题。', + 'type' => 'string', + 'example' => 'test', + ], + 'Artist' => [ + 'title' => 'Artist', + 'description' => '艺术家。', + 'type' => 'string', + 'example' => 'Jane', + ], + 'AlbumArtist' => [ + 'title' => 'AlbumArtist', + 'description' => '演唱者。', + 'type' => 'string', + 'example' => 'Jane', + ], + 'Composer' => [ + 'title' => 'Composer', + 'description' => '作曲家。', + 'type' => 'string', + 'example' => 'Jane', + ], + 'Performer' => [ + 'title' => 'Performer', + 'description' => '演奏者。', + 'type' => 'string', + 'example' => 'Jane', + ], + 'Album' => [ + 'title' => 'Album', + 'description' => '专辑。', + 'type' => 'string', + 'example' => 'FirstAlbum', + ], + 'Labels' => [ + 'title' => 'Labels', + 'description' => '智能标签列表。'."\n" + .'><notice>仅对UpdateFileMeta/BatchUpdateFileMeta接口生效。></notice>', + 'type' => 'array', + 'items' => [ + 'description' => '智能标签对象。', + '$ref' => '#/components/schemas/Label', + ], + ], + 'Addresses' => [ + 'title' => 'Addresses', + 'description' => '地址信息列表。'."\n" + .'><notice>仅对UpdateFileMeta/BatchUpdateFileMeta接口生效。></notice>', + 'type' => 'array', + 'items' => [ + 'description' => '地址信息。', + '$ref' => '#/components/schemas/Address', + ], + ], + ], + ], + 'InputOSS' => [ + 'title' => 'A short description of struct', + 'description' => '数据接入的OSS输入配置对象。', + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'title' => 'OSS Bucket 名字', + 'description' => 'OSS Bucket名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-bucket', + ], + 'Prefix' => [ + 'title' => '对象 Key 的前缀', + 'description' => '对象Key的前缀。', + 'type' => 'string', + 'example' => 'test-object', + ], + 'MatchExpressions' => [ + 'title' => '过滤表达式', + 'description' => '过滤表达式。', + 'type' => 'array', + 'items' => [ + 'description' => '匹配模式。', + 'type' => 'string', + 'example' => 'key prefix (abc)', + ], + ], + ], + ], + 'Insights' => [ + 'description' => '文件的摘要与描述。', + 'type' => 'object', + 'properties' => [ + 'Video' => [ + 'description' => '视频摘要与描述信息。', + '$ref' => '#/components/schemas/VideoInsight', + ], + 'Image' => [ + 'description' => '图片摘要与描述信息。', + '$ref' => '#/components/schemas/ImageInsight', + ], + ], + ], + 'KdtreeOption' => [ + 'title' => 'KdtreeOption', + 'description' => 'Kdtree选项对象。', + 'type' => 'object', + 'properties' => [ + 'CompressionLevel' => [ + 'title' => 'CompressionLevel', + 'description' => '压缩级别，取值范围：0~10，值越大细节效果越好，压缩率越高。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10', + 'minimum' => '0', + 'example' => '5', + ], + 'QuantizationBits' => [ + 'title' => 'QuantizationBits', + 'description' => '量化位数，取值范围：0~31，越大细节保留越多，0表示不做顶点压缩。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '31', + 'minimum' => '0', + 'example' => '10', + ], + 'LibraryName' => [ + 'title' => 'LibraryName', + 'description' => '目前kdtree只支持“draco”，默认值是“draco”。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'draco', + 'default' => 'draco', + 'enum' => [ + 'draco', + ], + ], + ], + ], + 'KeyValuePair' => [ + 'title' => 'A short description of struct', + 'description' => '键值对信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '键', + 'description' => '键。', + 'type' => 'string', + 'example' => 'bucket', + ], + 'Value' => [ + 'title' => '值', + 'description' => '值。', + 'type' => 'string', + 'example' => 'testbucket', + ], + ], + ], + 'Label' => [ + 'title' => 'A short description of struct', + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'Language' => [ + 'title' => 'Language', + 'description' => '标签语言，格式为BCP 47。', + 'type' => 'string', + 'example' => 'zh-Hans', + ], + 'LabelName' => [ + 'title' => 'LabelName', + 'description' => '标签名称。', + 'type' => 'string', + 'example' => '椅子', + ], + 'LabelLevel' => [ + 'title' => 'LabelLevel', + 'description' => '标签等级，当前标签等级可以取1、2、3，分别表示该标签为第一、二、三级标签。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'LabelConfidence' => [ + 'title' => 'LabelConfidence', + 'description' => '标签置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.95', + ], + 'ParentLabelName' => [ + 'title' => 'ParentLabelName', + 'description' => '父级标签名称。', + 'type' => 'string', + 'example' => '家具', + ], + 'CentricScore' => [ + 'title' => 'CentricScore', + 'description' => '标签的中心值分数，指该标签在图片中是否为主体，取值范围为0~1，数值越高表示该标签为图片主体的置信度越高。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.877', + ], + ], + ], + 'LicensePlate' => [ + 'title' => 'A short description of struct', + 'description' => '车牌。', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'title' => '车牌号', + 'description' => '车牌号。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => '鲁A8***8', + ], + 'Boundary' => [ + 'title' => '车牌裁剪框', + 'description' => '车牌裁剪框。', + '$ref' => '#/components/schemas/Boundary', + ], + 'Confidence' => [ + 'title' => '置信度', + 'description' => '置信度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.789', + ], + ], + ], + 'LocationDateCluster' => [ + 'title' => '时空聚类对象', + 'description' => '时空聚类对象。', + 'type' => 'object', + 'properties' => [ + 'Title' => [ + 'title' => '标题', + 'description' => '用户自定义的标题。', + 'type' => 'string', + 'example' => '杭州一日游', + ], + 'LocationDateClusterLevel' => [ + 'title' => '级别', + 'description' => '分组的行政级别。', + 'type' => 'string', + 'enumValueTitles' => [ + 'country' => '国家或地区', + 'province' => '省', + 'city' => '市', + 'district' => '区', + 'township' => '街道', + ], + 'example' => 'province', + ], + 'LocationDateClusterStartTime' => [ + 'title' => '开始时间', + 'description' => '分组起始时间。', + 'type' => 'string', + 'example' => '2022-05-01T00:00:00+08:00', + ], + 'LocationDateClusterEndTime' => [ + 'title' => '结束时间', + 'description' => '分组结束时间。', + 'type' => 'string', + 'example' => '2022-05-02T23:59:59.999999999+08:00', + ], + 'Addresses' => [ + 'title' => '地址', + 'description' => '分组地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '地址对象。', + '$ref' => '#/components/schemas/Address', + ], + ], + 'ObjectId' => [ + 'title' => '唯一ID', + 'description' => '分组ID。', + 'type' => 'string', + 'example' => 'location-date-cluster-14f48cb3-079d-4595-80c4-5735284b****', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'description' => '分组更新时间。', + 'type' => 'string', + 'example' => '2022-11-16T13:15:05.65746784+08:00', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '分组创建时间。', + 'type' => 'string', + 'example' => '2022-11-16T13:14:34.882523669+08:00', + ], + 'CustomId' => [ + 'title' => '自定义ID', + 'description' => '自定义ID。', + 'type' => 'string', + 'example' => 'user-01', + ], + 'CustomLabels' => [ + 'title' => '自定义标签', + 'description' => '自定义标签。', + 'type' => 'object', + 'example' => '{'."\n" + .' "User": "Jane"'."\n" + .'}', + ], + ], + ], + 'MNS' => [ + 'title' => 'A short description of struct', + 'description' => '轻量消息队列（原 MNS）消息通知参数。', + 'type' => 'object', + 'properties' => [ + 'TopicName' => [ + 'title' => 'TopicName', + 'description' => '轻量消息队列SMQ（原 MNS）主题名称。可登录[轻量消息队列SMQ（原MNS）控制台](https://mns.console.aliyun.com/),在左侧导航栏中点击当前地域下主题列表中获取。如果需使用轻量消息队列（原 MNS）做消息通知，该参数必填。', + 'type' => 'string', + 'example' => 'topic1', + ], + ], + ], + 'Message' => [ + 'title' => '智能助手消息', + 'description' => '智能助手消息', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '时间', + 'description' => '时间', + 'type' => 'string', + 'example' => '2022-01-14T10:10:52.83948013+08:00', + ], + 'Regenerate' => [ + 'title' => '是否为重新生成的答案', + 'description' => '是否为重新生成的答案', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Score' => [ + 'title' => '打分', + 'description' => '打分', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.99', + ], + 'AssistantType' => [ + 'title' => '助手类型', + 'description' => '助手类型', + 'type' => 'string', + 'example' => 'doc/translate', + ], + 'DatasetName' => [ + 'title' => '问答引用的数据集', + 'description' => '问答引用的数据集', + 'type' => 'string', + 'example' => 'test-dataset', + ], + 'SourceURI' => [ + 'title' => '问答来源文件地址', + 'description' => '问答来源文件地址', + 'type' => 'string', + 'example' => 'oss://test-bucket/sample.docx', + ], + 'Topic' => [ + 'title' => '问题主题', + 'description' => '问题主题', + 'type' => 'string', + 'example' => '根据 AssistantType 不同具体含义不同。', + ], + 'Content' => [ + 'title' => '问题内容', + 'description' => '问题内容', + 'type' => 'string', + 'example' => '你好，哪个公园距离我最近？', + ], + 'Language' => [ + 'title' => '回答语言', + 'description' => '回答语言', + 'type' => 'string', + 'example' => 'zh-Hans', + ], + 'Tone' => [ + 'title' => '回答语气', + 'description' => '回答语气', + 'type' => 'string', + 'example' => 'professional', + ], + 'Reply' => [ + 'title' => '回答', + 'description' => '回答', + 'type' => 'string', + 'example' => '你好，我是你的助手', + ], + 'Suggestion' => [ + 'title' => '合规检测结果', + 'description' => '合规检查结果，可选值：'."\n" + .'pass'."\n" + .'block', + 'type' => 'string', + 'example' => 'pass', + ], + ], + ], + 'MetaData' => [ + 'title' => '模型基本信息', + 'description' => '模型基本信息', + 'type' => 'object', + 'properties' => [ + 'Identifier' => [ + 'title' => '模型类别标识', + 'description' => '模型类别标识', + 'type' => 'string', + 'example' => 'detection', + ], + 'Version' => [ + 'title' => '模型版本', + 'description' => '模型版本', + 'type' => 'string', + 'example' => 'v1', + ], + 'Provider' => [ + 'title' => '模型提供者', + 'description' => '模型提供者', + 'type' => 'string', + 'example' => 'imm', + ], + ], + ], + 'ModelSpecification' => [ + 'title' => '模型详细规格信息', + 'description' => '模型详细规格信息', + 'type' => 'object', + 'properties' => [ + 'MetaData' => [ + 'description' => '模型基本信息', + 'required' => true, + '$ref' => '#/components/schemas/MetaData', + ], + 'Spec' => [ + 'description' => '模型规格信息', + 'required' => true, + '$ref' => '#/components/schemas/Spec', + ], + ], + ], + 'Notification' => [ + 'description' => '消息通知对象，支持多种消息中间件，消息格式详情请见[异步通知消息格式](~~2743997~~)，请选择其中一种方式接收消息，使用方式如下所示：'."\n" + .'- 在与智能媒体管理相同的地域下开通并接入[事件总线EventBridge](~~161886~~)服务，及时获取任务信息通知。更多信息，请参见[智能媒体管理IMM事件](~~205730~~)。'."\n" + .'- 在与智能媒体管理相同的地域下开通[MNS](~~27412~~)服务，并配置订阅关系。'."\n" + .'- 在与智能媒体管理相同的地域下开通[RocketMQ](~~29530~~)服务，并创建RocketMQ 4.0实例、Topic、Group。'."\n" + .'><notice>Notification不支持自定义回调地址。></notice>', + 'type' => 'object', + 'properties' => [ + 'MNS' => [ + 'title' => 'MNS', + 'description' => 'MNS通知参数对象。', + '$ref' => '#/components/schemas/MNS', + ], + 'RocketMQ' => [ + 'title' => 'RocketMQ', + 'description' => 'RocketMQ通知参数对象。', + '$ref' => '#/components/schemas/RocketMQ', + ], + 'ExtendedMessageURI' => [ + 'title' => 'ExtendedMessageURI', + 'description' => '使用OSS文件接受任务消息通知。提供该文件地址后，任务执行的具体信息会以JSON结构写入到该文件中。一般情况下，您只需要通过[事件总线EventBridge](~~161886~~)服务、[MNS](~~27412~~)服务或[RocketMQ](~~29530~~)服务接受消息通知，但部分任务执行的信息会比较大（例如压缩包文件预览、解压任务），您可以通过提供该文件获取具体的任务执行结果。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一地域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。'."\n" + ."\n\n" + .'><notice>该文件并不作为消息通知的方式，仅作为接受任务执行具体信息的载体。任务的状态信息会通过消息通知的方式发送，该文件仅包含任务执行的具体信息。 '."\n" + .'></notice>', + 'type' => 'string', + 'example' => 'oss://test-bucket/test-object.json', + ], + ], + ], + 'OCRContents' => [ + 'title' => 'A short description of struct', + 'description' => 'OCR内容。', + 'type' => 'object', + 'properties' => [ + 'Language' => [ + 'title' => 'Language', + 'description' => '语言，格式为BCP 47。当前版本不支持此参数。', + 'type' => 'string', + 'example' => 'zh-hans', + ], + 'Contents' => [ + 'title' => 'Contents', + 'description' => '文字内容。', + 'type' => 'string', + 'example' => '欢迎使用智能媒体管理', + ], + 'Confidence' => [ + 'title' => 'Confidence', + 'description' => '文字置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8254936695098877', + ], + 'Boundary' => [ + 'title' => 'Boundary', + 'description' => '边界。', + '$ref' => '#/components/schemas/Boundary', + ], + ], + ], + 'OctreeOption' => [ + 'title' => 'OctreeOption', + 'description' => 'Octree选项对象。', + 'type' => 'object', + 'properties' => [ + 'PointResolution' => [ + 'title' => 'PointResolution', + 'description' => '点云分辨率，该变量决定了点的坐标在编码时可以精确的程度，默认值为 0.01。', + 'type' => 'number', + 'format' => 'double', + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.01', + 'default' => '0.01', + ], + 'OctreeResolution' => [ + 'title' => 'OctreeResolution', + 'description' => '划分八叉树时最小块，即voxel的边长，默认值为 0.01。', + 'type' => 'number', + 'format' => 'double', + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.01', + 'default' => '0.01', + ], + 'DoVoxelGridDownDownSampling' => [ + 'title' => 'DoVoxelGridDownDownSampling', + 'description' => '是否对点云文件进行下采样，可选值如下：'."\n" + ."\n" + .'- true：对点云文件进行下采样,，以体素的中心点的坐标来代替整个体素内的点的坐标,，而颜色则以体素内所有点的颜色的均值为代表，此时PointResolution不会生效。'."\n" + .'- false： 则进行细节编码，即编码一个体素内的具体坐标与颜色，实现方式是计算体素内每个点到体素左下角的偏移量，并通过整除PointResolution来得到整数坐标，而颜色则需编码体素内每个点的颜色相对于平均值的残差。', + 'type' => 'boolean', + 'example' => 'false', + 'default' => 'false', + ], + 'LibraryName' => [ + 'title' => 'LibraryName', + 'description' => '目前octree只支持“pcl”，默认值为“pcl”。', + 'type' => 'string', + 'example' => 'pcl', + 'default' => 'pcl', + 'enum' => [ + 'pcl', + ], + ], + ], + ], + 'Optimization' => [ + 'title' => '优化算法信息', + 'description' => '优化算法信息', + 'type' => 'object', + 'properties' => [ + 'LearningRate' => [ + 'title' => '初始学习率', + 'description' => '初始学习率', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.01', + ], + 'Optimizer' => [ + 'title' => '优化方法', + 'description' => '优化方法', + 'type' => 'string', + 'example' => 'SGD', + ], + ], + ], + 'PointInt64' => [ + 'title' => '点坐标', + 'description' => '点坐标信息。', + 'type' => 'object', + 'properties' => [ + 'X' => [ + 'title' => '横坐标X', + 'description' => '顶点X坐标距离左端距离，单位为像素（px）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Y' => [ + 'title' => '纵坐标Y', + 'description' => '顶点Y坐标距离顶端距离，单位为像素（px）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + 'Project' => [ + 'title' => '项目结构体', + 'description' => '项目信息。', + 'type' => 'object', + 'properties' => [ + 'ProjectName' => [ + 'title' => '项目名称', + 'description' => '项目名称。', + 'type' => 'string', + 'example' => 'immtest', + ], + 'ServiceRole' => [ + 'title' => '服务角色', + 'description' => '服务角色。', + 'type' => 'string', + 'example' => 'AliyunIMMDefaultRole', + ], + 'TemplateId' => [ + 'title' => '模板Id', + 'description' => '工作流模板Id。', + 'type' => 'string', + 'example' => 'Official:ImageManagement', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '项目创建时间的时间戳，格式为RFC3339Nano。', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'description' => '项目修改时间的时间戳，格式为RFC3339Nano。'."\n" + ."\n" + .'>创建项目后，如果未更新过项目，则项目修改时间的时间戳和项目创建时间的时间戳相同。', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + ], + 'Description' => [ + 'title' => '描述', + 'description' => '项目描述信息。', + 'type' => 'string', + 'example' => '测试项目', + ], + 'ProjectQueriesPerSecond' => [ + 'title' => '项目QPS', + 'description' => '项目每秒能处理请求的最大个数，即每秒钟允许调用该项目所属各API的个数，默认值为100。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'EngineConcurrency' => [ + 'title' => '项目最大并发数', + 'description' => '项目每秒能处理任务的最大个数。即该项目所有算子在同一时间可以并行运行的个数，默认值为100。'."\n" + ."\n" + .'- 同步任务：同时运行的数量超过该限制时，会导致任务执行时间延长，直至超时。'."\n" + ."\n" + .'- 异步任务：同时运行的数量超过该限制时，会导致任务排队一段时间，任务完成时间延后。当排队时间也超过限制（一般数十分钟）后，该任务返回失败。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'ProjectMaxDatasetCount' => [ + 'title' => '项目最多媒体集数量', + 'description' => '项目中数据集的最大个数，取值范围为1~1000000000，默认值为1000000000。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000000000', + ], + 'DatasetMaxBindCount' => [ + 'title' => '项目最多绑定数', + 'description' => '每个数据集绑定的最大个数，取值范围为1~10，默认值为10。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'DatasetMaxFileCount' => [ + 'title' => '项目最多文件数', + 'description' => '每个数据集中文件的最大个数，取值范围为1~100000000，默认值为100000000。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000000', + ], + 'DatasetMaxEntityCount' => [ + 'title' => '项目最多实体数', + 'description' => '每个数据集中元数据实体的最大个数，默认值为10000000000。'."\n" + ."\n" + .'> 当前该字段仅为预留，使用中并不做实际限制。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000000000', + ], + 'DatasetMaxRelationCount' => [ + 'title' => '项目最多关系数', + 'description' => '每个数据集中元数据关系的最大个数，默认值为100000000000。'."\n" + ."\n" + .'> 当前该字段仅为预留，使用中并不做实际限制。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000000000', + ], + 'DatasetMaxTotalFileSize' => [ + 'title' => '项目最大文件总大小', + 'description' => '每个数据集中文件总大小的最大值，超过限制后无法再添加索引。默认值为90000000000000000，单位为字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '90000000000000000', + ], + 'DatasetCount' => [ + 'title' => '项目当前媒体集数', + 'description' => '项目当前数据集数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'FileCount' => [ + 'title' => '项目当前文件数', + 'description' => '项目当前文件数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalFileSize' => [ + 'title' => '项目当前文件总大小', + 'description' => '项目当前文件总大小，单位为字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000', + ], + 'Tags' => [ + 'title' => '标签', + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'title' => 'TagKey', + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'TestKey', + ], + 'TagValue' => [ + 'title' => 'TagValue', + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'TestValue', + ], + ], + ], + ], + ], + ], + 'Property' => [ + 'title' => '属性信息', + 'description' => '属性信息', + 'type' => 'object', + 'properties' => [ + 'ItemsType' => [ + 'title' => '如果字段ValueType类型是array, 则需要指定内部的子项类型，枚举值有: float 、integer、string', + 'description' => '如果字段ValueType类型是array, 则需要指定内部的子项类型，枚举值有: float、integer、string。', + 'type' => 'string', + 'example' => 'float', + ], + 'ValueType' => [ + 'title' => '属性类型, 枚举值有：float、integer、string、array', + 'description' => '属性类型, 枚举值有：float、integer、string、array。', + 'type' => 'string', + 'example' => 'array', + ], + 'Value' => [ + 'title' => '属性值', + 'description' => '属性值', + 'type' => 'string', + 'example' => '[40, 80, 160, 320]', + ], + 'Name' => [ + 'title' => '属性名称', + 'description' => '属性名称', + 'type' => 'string', + 'example' => 'channels', + ], + ], + ], + 'ReferenceFile' => [ + 'title' => 'A short description of struct', + 'description' => 'AI 机器人问答API中，回答内容对应的参考文献', + 'type' => 'object', + 'properties' => [ + 'ProjectName' => [ + 'title' => '项目名称', + 'description' => '项目名称', + 'type' => 'string', + 'example' => 'test-project', + ], + 'DatasetName' => [ + 'title' => '数据集名称', + 'description' => '数据集名称', + 'type' => 'string', + 'example' => 'test-dataset', + ], + 'ObjectId' => [ + 'title' => '文件的唯一ID', + 'description' => '文件的唯一ID', + 'type' => 'string', + 'example' => '75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7', + ], + 'URI' => [ + 'title' => '文件URI', + 'description' => '文件URI', + 'type' => 'string', + 'example' => 'oss://test-bucket/test-object.jpg', + ], + ], + ], + 'RegionType' => [ + 'title' => 'RegionType', + 'description' => '地域对象。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'title' => 'RegionId', + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'LocalName' => [ + 'title' => 'LocalName', + 'description' => '地域名称。', + 'type' => 'string', + 'example' => '华北2（北京）', + ], + ], + ], + 'Resource' => [ + 'title' => '执行资源配置信息', + 'description' => '执行资源配置信息', + 'type' => 'object', + 'properties' => [ + 'ECSInstance' => [ + 'title' => 'ECS实例', + 'description' => 'ECS实例', + 'type' => 'string', + 'example' => 'ecs.gn5i-c2g1.large', + ], + 'CPU' => [ + 'title' => 'CPU核心数 范围4~96', + 'description' => 'CPU核心数范围4~96', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'GPUNum' => [ + 'title' => 'GPU个数', + 'description' => 'GPU个数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Name' => [ + 'title' => '展示文案', + 'description' => '展示文案', + 'type' => 'string', + 'example' => 'ecs.gn5i-c2g1.large-2vCPU-8GB-1*NVIDIA_P4', + ], + 'RAM' => [ + 'title' => '内存大小（单位G）30~736', + 'description' => '内存大小（单位G）30~736', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8', + ], + 'GPUModel' => [ + 'title' => 'GPU型号', + 'description' => 'GPU型号', + 'type' => 'string', + 'example' => 'NVIDIA_P4', + ], + ], + ], + 'RocketMQ' => [ + 'title' => 'A short description of struct', + 'description' => 'RocketMQ消息通知参数。', + 'type' => 'object', + 'properties' => [ + 'TopicName' => [ + 'title' => 'TopicName', + 'description' => 'RocketMQ Topic名称。如果需使用RocketMQ做消息通知，该参数必填。', + 'type' => 'string', + 'example' => 'topic1', + ], + 'InstanceId' => [ + 'title' => 'InstanceId', + 'description' => 'RocketMQ实例Id。如果需使用RocketMQ做消息通知，该参数必填。', + 'type' => 'string', + 'example' => 'MQ_INST_11111111111_BYcNy2Nc', + ], + ], + ], + 'Row' => [ + 'title' => 'A short description of struct', + 'description' => '单个文件信息。', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'title' => 'URI', + 'description' => 'OSS文件的存储位置。'."\n" + ."\n" + .'OSS地址规则为`oss://${bucketname}/${objectname}`，其中`bucketname`为和当前项目处于同一地域的OSS Bucket名称，`objectname`为文件路径。', + 'type' => 'string', + 'example' => 'oss://examplebucket/exampleobject.jpg', + ], + 'CustomLabels' => [ + 'title' => 'CustomLabels', + 'description' => '自定义标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签键值对。', + '$ref' => '#/components/schemas/KeyValuePair', + ], + ], + ], + ], + 'Runtime' => [ + 'title' => '模型训练运行时信息', + 'description' => '模型训练运行时信息', + 'type' => 'object', + 'properties' => [ + 'Hyperparameters' => [ + 'description' => '模型训练运行超参数信息', + 'required' => true, + '$ref' => '#/components/schemas/Hyperparameters', + ], + 'Resource' => [ + 'description' => '执行资源配置信息', + 'required' => true, + '$ref' => '#/components/schemas/Resource', + ], + ], + ], + 'SceneElement' => [ + 'title' => '视频场景元素', + 'description' => '视频场景元素。', + 'type' => 'object', + 'properties' => [ + 'TimeRange' => [ + 'title' => '视频元素的时间范围，数组长度固定为2，分别代表开始时间和结束时间，单位为毫秒。', + 'description' => '视频元素的时间范围，数组长度固定为2，分别代表开始时间和结束时间，单位为毫秒。', + 'type' => 'array', + 'items' => [ + 'description' => '视频元素的时间范围。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + 'FrameTimes' => [ + 'title' => '当前视频元素内，和检索内容匹配的若干个帧的时间，单位为毫秒。', + 'description' => '当前视频元素内，和检索内容匹配的若干个帧的时间，单位为毫秒。', + 'type' => 'array', + 'items' => [ + 'description' => '当前视频元素内，和检索内容匹配的若干个帧的时间，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + ], + 'VideoStreamIndex' => [ + 'description' => '当前视频场景元素所属的视频流编号，对应视频流数组（[VideoStreams](https://help.aliyun.com/zh/imm/developer-reference/api-imm-2020-09-30-detectmediameta?spm=a2c4g.11186623.0.0.463e600fIDdM8r#api-detail-40)）的下标。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'Schedule' => [ + 'title' => '学习率变化策略', + 'description' => '学习率变化策略', + 'type' => 'object', + 'properties' => [ + 'Gamma' => [ + 'title' => 'lr衰减率,仅当选择StepLR策略时生效', + 'description' => 'lr衰减率,仅当选择StepLR策略时生效', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.97', + ], + 'StepSize' => [ + 'title' => 'lr衰减间隔的epoch数量,仅当选择StepLR策略时生效', + 'description' => 'lr衰减间隔的epoch数量,仅当选择StepLR策略时生效', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'LRScheduler' => [ + 'title' => '学习率调整策略', + 'description' => '学习率调整策略', + 'type' => 'string', + 'example' => 'StepLR', + ], + ], + ], + 'SimilarImage' => [ + 'title' => 'A short description of struct', + 'description' => '相似图片。', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'title' => '图片URI', + 'description' => '图片URI。', + 'type' => 'string', + 'example' => 'oss://test-bucket/test-object', + ], + 'ImageScore' => [ + 'title' => '美学分数', + 'description' => '美学分数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.709', + ], + ], + ], + 'SimilarImageCluster' => [ + 'title' => 'A short description of struct', + 'description' => '相似图片分类信息。', + 'type' => 'object', + 'properties' => [ + 'ObjectId' => [ + 'title' => '唯一ID', + 'description' => '相似图片分类ID。', + 'type' => 'string', + 'example' => 'SimilarImageCluster-748a041e-4ebc-4487-9e74-9c89b1****', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2023-02-08T09:42:34.354969088+08:00', + ], + 'CreateTime' => [ + 'title' => '结束时间', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2023-02-08T09:42:34.354969088+08:00', + ], + 'CustomLabels' => [ + 'title' => '自定义标签', + 'description' => '自定义标签。', + 'type' => 'object', + ], + 'Files' => [ + 'title' => '相似图片文件', + 'description' => '相似图片文件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '相似图片。', + '$ref' => '#/components/schemas/SimilarImage', + ], + ], + ], + ], + 'SimpleQuery' => [ + 'title' => 'SimpleQuery 简单查询所用到的查询结构体', + 'description' => 'SimpleQuery查询参数条件，可自嵌套。', + 'type' => 'object', + 'properties' => [ + 'Field' => [ + 'title' => '需要查询的字段名', + 'description' => '必填。字段名称。关于支持的字段，请参见[字段和操作符的支持列表](~~2743991~~)。', + 'type' => 'string', + 'example' => 'Size', + ], + 'Value' => [ + 'title' => '需要查询的字段值', + 'description' => '查询的字段值。当Operations为逻辑运算符（and、or、not或nested）时，该字段无效。', + 'type' => 'string', + 'example' => '10', + ], + 'Operation' => [ + 'title' => '运算符', + 'description' => '必填。操作运算符。', + 'type' => 'string', + 'enumValueTitles' => [ + 'exist' => '存在性查询', + 'not' => '逻辑非', + 'or' => '逻辑或', + 'prefix' => '前缀查询', + 'and' => '逻辑与', + 'lt' => '小于', + 'match-phrase' => '字符串匹配查询', + 'gte' => '大于等于', + 'eq' => '等于', + 'lte' => '小于等于', + 'gt' => '大于', + 'nested' => '字段为数组时，其中同一对象内逻辑条件查询', + ], + 'example' => 'and', + ], + 'SubQueries' => [ + 'title' => '由 SimpleQuery 结构体组成的子查询数组', + 'description' => '子查询的结构体。'."\n" + ."\n" + .'只有当Operations为逻辑运算符（and、or、not或nested）时，才能设置子查询条件。'."\n" + ."\n" + .'在逻辑运算符为and/or/not时，其SubQueries内描述的所有条件需符合父级设置的and/or/not逻辑关系。'."\n" + ."\n" + .'在逻辑运算符为nested时，其父级的Field必须为一个数组类的字段（如：Labels）。子查询条件SimpleQuery组的Operation必须为and/or/not中的一个或多个，其Field必须为父级Field的子属性。'."\n" + ."\n" + .'请参考[SimpleQuery - 简单查询](~~478175~~)查看使用用例。', + 'type' => 'array', + 'items' => [ + 'description' => '子查询条件。', + '$ref' => '#/components/schemas/SimpleQuery', + ], + ], + ], + ], + 'SmartCluster' => [ + 'title' => 'A short description of struct', + 'description' => '智能分组', + 'type' => 'object', + 'properties' => [ + 'OwnerId' => [ + 'title' => '用户id', + 'description' => '用户id', + 'type' => 'string', + 'example' => '1023210024677934', + ], + 'ProjectName' => [ + 'title' => '项目名称', + 'description' => '项目名称', + 'type' => 'string', + 'example' => 'MyProject', + ], + 'DatasetName' => [ + 'title' => '数据集名称', + 'description' => '数据集名称', + 'type' => 'string', + 'example' => 'MyDataset', + ], + 'ObjectType' => [ + 'title' => '分组类型', + 'description' => '分组类型', + 'type' => 'string', + 'example' => 'smart-cluster', + ], + 'ObjectId' => [ + 'title' => '智能分组ID', + 'description' => '智能分组ID', + 'type' => 'string', + 'example' => 'SmartCluster-12cd1645-deae-4b5e-9434-613747b75f6d', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-01-14T10:17:18.102700407+08:00', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2022-01-14T10:17:18.102700407+08:00', + ], + 'Name' => [ + 'title' => '分组名称', + 'description' => '分组名称', + 'type' => 'string', + 'example' => 'MySmartCluster1', + ], + 'Description' => [ + 'title' => '分组的描述', + 'description' => '分组的描述', + 'type' => 'string', + 'example' => '这是一个智能分组的描述示例，它用于展示记录的格式。', + ], + 'ObjectStatus' => [ + 'title' => '分组状态', + 'description' => '分组状态', + 'type' => 'string', + 'example' => 'Succeeded', + ], + 'Rule' => [ + 'title' => '分组规则', + 'description' => '分组规则', + '$ref' => '#/components/schemas/SmartClusterRule', + ], + ], + ], + 'SmartClusterRule' => [ + 'title' => 'A short description of struct', + 'description' => '智能分组规则', + 'type' => 'object', + 'properties' => [ + 'Keywords' => [ + 'title' => '关键词', + 'description' => '关键词', + 'type' => 'array', + 'items' => [ + 'description' => '关键字', + 'type' => 'string', + 'example' => '机器学习', + ], + ], + 'Sensitivity' => [ + 'title' => '敏感度', + 'description' => '敏感度', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + ], + ], + 'Spec' => [ + 'title' => '模型规格信息', + 'description' => '模型规格信息', + 'type' => 'object', + 'properties' => [ + 'Backbone' => [ + 'description' => '模型训练自定义参数信息', + '$ref' => '#/components/schemas/CustomParams', + ], + 'ClassNum' => [ + 'title' => '最后一层输出的类别数量', + 'description' => '最后一层输出的类别数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Head' => [ + 'description' => '模型训练自定义参数信息', + '$ref' => '#/components/schemas/CustomParams', + ], + 'Loss' => [ + 'description' => '模型训练自定义参数信息', + '$ref' => '#/components/schemas/CustomParams', + ], + 'InputChannel' => [ + 'title' => '3', + 'description' => '3', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'Name' => [ + 'title' => '模型名称，根绝模型类别，可选择名称不同', + 'description' => '模型名称，根绝模型类别，可选择名称不同', + 'type' => 'string', + 'required' => true, + 'example' => 'ClsResNet', + ], + 'Neck' => [ + 'description' => '模型训练自定义参数信息', + '$ref' => '#/components/schemas/CustomParams', + ], + 'NumLandmarks' => [ + 'title' => '人脸标定点，一般为5, 当做人脸检测时才需要', + 'description' => '人脸标定点，一般为5, 当做人脸检测时才需要', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'PretrainedPath' => [ + 'title' => '预训练模型地址', + 'description' => '预训练模型地址', + 'type' => 'string', + 'example' => 'oss://bucket/abc/xxx.json', + ], + ], + ], + 'Story' => [ + 'title' => 'A short description of struct', + 'description' => '故事信息。', + 'type' => 'object', + 'properties' => [ + 'OwnerId' => [ + 'title' => 'OwnerId', + 'description' => '故事所属用户Id。', + 'type' => 'string', + 'example' => '102321002****', + ], + 'ProjectName' => [ + 'title' => 'ProjectName', + 'description' => '项目名称。', + 'type' => 'string', + 'example' => 'immtest', + ], + 'DatasetName' => [ + 'title' => 'DatasetName', + 'description' => '数据集名称。', + 'type' => 'string', + 'example' => 'dataset001', + ], + 'ObjectId' => [ + 'title' => 'ObjectId', + 'description' => '故事对象ID。', + 'type' => 'string', + 'example' => 'id1', + ], + 'ObjectType' => [ + 'title' => 'ObjectType', + 'description' => '故事对象类型。', + 'type' => 'string', + 'example' => 'story', + ], + 'UpdateTime' => [ + 'title' => 'UpdateTime', + 'description' => '故事更新时间。', + 'type' => 'string', + 'example' => '2022-01-14T10:17:18.102700407+08:00', + ], + 'CreateTime' => [ + 'title' => 'CreateTime', + 'description' => '故事创建时间。', + 'type' => 'string', + 'example' => '2022-01-14T10:17:18.102700407+08:00', + ], + 'StoryName' => [ + 'title' => 'StoryName', + 'description' => '故事名称。', + 'type' => 'string', + 'example' => 'name1', + ], + 'StoryType' => [ + 'title' => 'StoryType', + 'description' => '故事类型。', + 'type' => 'string', + 'example' => 'PeopleMemory', + ], + 'StorySubType' => [ + 'title' => 'StorySubType', + 'description' => '故事子类型。', + 'type' => 'string', + 'example' => 'ImportantPerson', + ], + 'StoryStartTime' => [ + 'title' => 'StoryStartTime', + 'description' => '故事开始时间。', + 'type' => 'string', + 'example' => '2022-01-14T10:17:18.102700407+08:00', + ], + 'StoryEndTime' => [ + 'title' => 'StoryEndTime', + 'description' => '故事结束时间。', + 'type' => 'string', + 'example' => '2022-01-14T10:17:18.102700407+08:00', + ], + 'Files' => [ + 'title' => 'Files', + 'description' => '故事中包含的文件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '故事文件信息。', + '$ref' => '#/components/schemas/File', + ], + ], + 'Cover' => [ + 'description' => '故事封面。', + '$ref' => '#/components/schemas/File', + ], + 'FigureClusterIds' => [ + 'title' => 'FigureClusterIds', + 'description' => '人物聚类Id列表。', + 'type' => 'array', + 'items' => [ + 'description' => '聚类Id。', + 'type' => 'string', + 'example' => '2cb3c51e-b406-4b0c-af1b-897d88e1****', + ], + ], + 'CustomId' => [ + 'title' => 'CustomId', + 'description' => '自定义Id。', + 'type' => 'string', + 'example' => 'test', + ], + 'CustomLabels' => [ + 'title' => 'CustomLabels', + 'description' => '自定义标签。', + 'type' => 'object', + 'required' => false, + 'example' => '{"key": "val"}', + ], + 'Addresses' => [ + 'title' => 'Addresses', + 'description' => '地址信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '地址信息。', + '$ref' => '#/components/schemas/Address', + ], + ], + ], + ], + 'StreamOptions' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'IncrementalOutput' => [ + 'title' => '是否增量输出', + 'type' => 'boolean', + ], + 'NeedReturnFinalResult' => [ + 'title' => '增量返回的情况下，在AI助手完成全部回答后，最后是否需要再返回一次全量的结果作为兜底', + 'type' => 'boolean', + ], + ], + ], + 'SubtitleStream' => [ + 'title' => 'A short description of struct', + 'description' => '字幕流信息。', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => 'Index', + 'description' => '字幕流索引号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Language' => [ + 'title' => 'Language', + 'description' => '字幕语言，格式为BCP 47。', + 'type' => 'string', + 'example' => 'en', + ], + 'CodecName' => [ + 'title' => 'CodecName', + 'description' => '编码器名称。', + 'type' => 'string', + 'example' => 'mov_text', + ], + 'CodecLongName' => [ + 'title' => 'CodecLongName', + 'description' => '编码器名称的全称。', + 'type' => 'string', + 'example' => 'MOV text', + ], + 'CodecTagString' => [ + 'title' => 'CodecTagString', + 'description' => '编码器标识描述信息。', + 'type' => 'string', + 'example' => 'tx3g', + ], + 'CodecTag' => [ + 'title' => 'CodecTag', + 'description' => '编码器标识。', + 'type' => 'string', + 'example' => '0x67337874', + ], + 'StartTime' => [ + 'title' => 'StartTime', + 'description' => '字幕流起始时间，单位为秒（s）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.000000', + ], + 'Duration' => [ + 'title' => 'Duration', + 'description' => '字幕流持续时长，单位为秒（s）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '71.378', + ], + 'Bitrate' => [ + 'title' => 'Bitrate', + 'description' => '码率，单位为比特每秒（bit/s）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '74', + ], + 'Content' => [ + 'title' => 'Content', + 'description' => '字幕内容。', + 'type' => 'string', + 'example' => '欢迎', + ], + 'Width' => [ + 'title' => 'Width', + 'description' => '字幕的宽度，单位为像素（px）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '600', + ], + 'Height' => [ + 'title' => 'Height', + 'description' => '字幕的高度，单位为像素（px）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + ], + ], + 'TargetAudio' => [ + 'title' => 'Audio Struct', + 'description' => '音频处理参数配置。', + 'type' => 'object', + 'properties' => [ + 'DisableAudio' => [ + 'title' => 'DisableAudio', + 'description' => '是否禁用音频处理，取值范围如下：'."\n" + ."\n" + .'- true：禁用，输出文件中将不包含音频流。'."\n" + .'- false（默认）：不禁用。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Stream' => [ + 'title' => 'Stream', + 'description' => '需要处理的源文件音频流索引号列表。空值（默认）表示处理索引号最小的音频流（第一路音频流），索引号大于100表示处理所有音频流。'."\n" + ."\n" + .'- 示例：`[0,1]`处理索引号为0和1的音频流；`[1]`处理索引号为1的音频流；`[101]`处理所有音频流。'."\n" + ."\n" + .'> 只处理索引号存在的音频流，索引号对应的音频流不存在时将忽略该索引号。', + 'type' => 'array', + 'items' => [ + 'description' => '需要处理的音频流索引号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + 'TranscodeAudio' => [ + 'title' => 'TranscodeAudio', + 'description' => '音频转码参数，空值表示禁用音频处理，输出文件中将不包含音频流。'."\n" + ."\n" + .'> 不推荐通过将该参数设为空值来禁用音频处理。', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'title' => 'Codec', + 'description' => '音频编码方式。取值范围如下：'."\n" + ."\n" + .'- API为CreateMediaConvert时：copy（默认），mp3，vorbis，aac，flac，ac3，opus，amr。'."\n" + .'- API为GenerateVideoPlaylist时：aac（默认）。'."\n" + ."\n" + .'> 当该参数为copy时，表示将需要处理的音频流直接拷贝到输出文件，此时**TranscodeAudio**下的其余参数无效。copy不可用于音频拼接，通常应用于转封装场景。', + 'type' => 'string', + 'example' => 'aac', + ], + 'BitrateOption' => [ + 'title' => 'BitrateOption', + 'description' => '音频码率选项。取值范围如下：'."\n" + ."\n" + .'- fixed：始终使用设置的目标音频码率。'."\n" + .'- adaptive：源音频码率小于设置的目标音频码率时使用源音频码率。'."\n" + .'- fall：源音频码率小于设置的目标音频码率时返回失败。'."\n" + ."\n" + .'默认值：'."\n" + .'- API为CreateMediaConvert时，默认值为fixed。'."\n" + .'- API为GenerateVideoPlaylist时，默认值为adaptive。'."\n" + ."\n" + .'> 该参数需要与参数**Bitrate**一同设置。', + 'type' => 'string', + 'example' => 'fixed', + ], + 'Bitrate' => [ + 'title' => 'Bitrate', + 'description' => '音频码率，与参数**Quality**互斥，单位为比特每秒（bps）。取值范围：1000~10000000。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '64000', + ], + 'Quality' => [ + 'title' => 'Quality', + 'description' => '音频质量，与参数**Bitrate**互斥，取值范围：0～100（值越大质量越高）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'SampleRateOption' => [ + 'title' => 'SampleRateOption', + 'description' => '音频采样率。取值范围如下：'."\n" + ."\n" + .'- fixed：始终使用设置的目标音频采样率。'."\n" + .'- adaptive：源音频采样率小于设置的目标音频采样率时使用源音频采样率。'."\n" + .'- fall：源音频采样率小于设置的目标音频采样率时返回失败。'."\n" + ."\n" + .'默认值：'."\n" + .'- API为CreateMediaConvert时，默认值为fixed。'."\n" + .'- API为GenerateVideoPlaylist时，默认值为adaptive。'."\n" + ."\n" + .'> 该参数需要与参数**SampleRate**一同设置。', + 'type' => 'string', + 'example' => 'fixed', + ], + 'SampleRate' => [ + 'title' => 'SampleRate', + 'description' => '音频采样率。单位为赫兹（Hz）。默认保持源音频的采样频率，取值范围：8000、12025、12000，16000、22050、24000，32000、44100、48000、64000、88200和96000。'."\n" + ."\n" + .'> 不同格式支持的采样率有所不同，mp3仅支持48kHz及以下；opus支持8kHz、12kHz、16kHz、24kHz与48kHz；ac3支持32kHz、44.1kHz与48kHz；amr仅支持8kHz与16kHz。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12050', + ], + 'Channel' => [ + 'title' => 'Channel', + 'description' => '声道数。默认保持源音频的声道数。取值范围：[1,8]。'."\n" + ."\n" + .'> 不同格式支持的声道数有所不同，mp3仅支持单、双声道；ac3最大支持6声道（5.1）；amr仅支持单声道。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'BitsPerSample' => [ + 'title' => 'BitsPerSample', + 'description' => '音频采样位深，取值为16或24。'."\n" + .'><notice>该参数仅在**Codec**为flac时有效。></notice>', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + ], + ], + 'FilterAudio' => [ + 'title' => 'FilterAudio', + 'description' => '音频处理参数，参数**TranscodeAudio**为空时或**TranscodeAudio.Codec**为copy时，本参数无效。'."\n" + ."\n" + .'>API为GenerateVideoPlaylist时不支持设置此参数。', + 'type' => 'object', + 'properties' => [ + 'Mixing' => [ + 'title' => 'Mixing', + 'description' => '是否将所有音轨混合为单轨。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否。'."\n" + ."\n" + .'- true：是。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'TargetImage' => [ + 'title' => 'Image Struct', + 'description' => '截帧、雪碧图或动图目标图片信息。', + 'type' => 'object', + 'properties' => [ + 'Sprites' => [ + 'title' => 'Sprites', + 'description' => '雪碧图处理列表。', + 'type' => 'array', + 'items' => [ + 'description' => '雪碧图处理详细信息。', + 'type' => 'object', + 'properties' => [ + 'ScaleType' => [ + 'title' => 'ScaleType', + 'description' => '缩放方式。取值范围如下：'."\n" + ."\n" + .'- stretch（默认）：拉伸以填满。'."\n" + ."\n" + .'- crop：缩放并裁剪。'."\n" + ."\n" + .'- fill：缩放并保留黑边。'."\n" + ."\n" + .'- fit：缩放并不保留黑边。', + 'type' => 'string', + 'example' => 'crop', + ], + 'Mode' => [ + 'description' => '雪碧图子图截帧模式，取值范围如下：'."\n" + .'- interval（默认）：固定时间间隔模式，截帧间隔由Interval参数决定。'."\n" + .'- keyframe：关键帧模式，仅截取源视频中的IDR帧，此时Interval参数无效。'."\n" + .'- average：平均模式，根据Number参数按均匀时间间隔截帧，此时Interval参数无效。'."\n" + .'- dhash：dhash模式，根据Number参数设置，在固定时间间隔截帧的基础上截取视频帧内容变化超过Threshold参数的Top Number帧。'."\n" + .' > 当Number参数为0时，则截取所有视频帧内容变化超过Threshold参数的帧。', + 'type' => 'string', + 'example' => 'interval', + ], + 'StartTime' => [ + 'title' => 'StartTime', + 'description' => '视频截帧的开始时间，单位为秒（s）。默认值为0，表示从视频起始时间开始。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'TileHeight' => [ + 'title' => 'TileHeight', + 'description' => '每列包含的图片数量，默认值为6。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'URI' => [ + 'title' => 'URI', + 'description' => '保存雪碧图的OSS地址。'."\n" + ."\n" + .'地址规则为oss://bucket/object，其中bucket为和当前项目处于同一地域的OSS Bucket名称，object为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/sprites', + ], + 'ScaleWidth' => [ + 'title' => 'ScaleWidth', + 'description' => '单张图片的宽度，默认值为1，取值为整数或小数时的不同含义如下：'."\n" + ."\n" + .'- 整数：像素值，单位为像素（px），取值范围为(1,4096)。'."\n" + ."\n" + .'- 小数：表示相对输出视频分辨率宽度的比率，取值范围为(0,1]。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1280', + ], + 'Pad' => [ + 'title' => 'Pad', + 'description' => '小图之间的间隔，默认值为2。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Format' => [ + 'title' => 'Format', + 'description' => '雪碧图的格式。取值范围如下：'."\n" + ."\n" + .'- jpg'."\n" + ."\n" + .'- png', + 'type' => 'string', + 'required' => true, + 'example' => 'jpg'."\n", + ], + 'Number' => [ + 'title' => 'Number', + 'description' => '小图数量。默认值为0，表示截取到视频结束位置。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ScaleHeight' => [ + 'title' => 'ScaleHeight', + 'description' => '单张图片的高度，默认值为1，取值为整数或小数时的不同含义如下：'."\n" + ."\n" + .'- 整数：像素值，单位为像素（px），取值范围为(1,4096)。'."\n" + ."\n" + .'- 小数：表示相对输出视频分辨率高度的比率，取值范围为(0,1]。', + 'type' => 'number', + 'format' => 'float', + 'example' => '960', + ], + 'TileWidth' => [ + 'title' => 'TileWidth', + 'description' => '每行包含的图片数量，默认值为6。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'Interval' => [ + 'title' => 'Interval', + 'description' => '视频截帧的时间间隔，单位为秒（s）。', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '1', + ], + 'Margin' => [ + 'title' => 'Margin', + 'description' => '小图和雪碧图边缘的间隔，默认值为2。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Threshold' => [ + 'description' => '截帧阈值，值越大截帧数量越少，取值范围为 0~100，默认值为 0。'."\n" + .'> - 仅在使用dhash截帧模式时有效。'."\n" + .'> - dhash模式对阈值较为敏感，推荐该参数设置不大于25，并根据具体场景调整。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + 'Animations' => [ + 'title' => 'Animations', + 'description' => '动图处理列表。', + 'type' => 'array', + 'items' => [ + 'description' => '动图处理详细信息。', + 'type' => 'object', + 'properties' => [ + 'FrameRate' => [ + 'title' => 'FrameRate', + 'description' => '动图帧率。可以配合Interval实现加减速。', + 'type' => 'number', + 'format' => 'double', + 'example' => '25', + ], + 'Format' => [ + 'title' => 'Format', + 'description' => '输出动图格式。取值范围如下：'."\n" + ."\n" + .'- gif'."\n" + .'- webp', + 'type' => 'string', + 'required' => true, + 'example' => 'gif', + ], + 'Number' => [ + 'title' => 'Number', + 'description' => '抽帧数量。0表示到末尾，默认0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'ScaleType' => [ + 'title' => 'ScaleType', + 'description' => '缩放方式。取值范围如下：'."\n" + ."\n" + .'- stretch（默认）：拉伸以填满。'."\n" + ."\n" + .'- crop：缩放并裁剪。'."\n" + ."\n" + .'- fill：缩放并保留黑边。'."\n" + ."\n" + .'- fit：缩放并不保留黑边。', + 'type' => 'string', + 'example' => 'crop', + ], + 'StartTime' => [ + 'title' => 'StartTime', + 'description' => '动图抽帧起始时间，单位秒。默认0。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'Height' => [ + 'title' => 'Height', + 'description' => '动图高度。默认保持原高度。取值为整数或小数时的不同含义如下：'."\n" + ."\n\n" + .'- 整数：代表像素值，单位为px，取值范围为[1,4096]。'."\n" + .'- 小数：代表相对输出图片分辨率高度的比率，取值范围为(0,1)', + 'type' => 'number', + 'format' => 'double', + 'example' => '960', + ], + 'URI' => [ + 'title' => 'URI', + 'description' => '保存动图的OSS地址。'."\n" + ."\n" + .'地址规则为oss://bucket/object，其中bucket为和当前项目处于同一地域的OSS Bucket名称，object为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/animations', + ], + 'Width' => [ + 'title' => 'Width', + 'description' => '动图宽度。默认保持原宽度。取值为整数或小数时的不同含义如下：'."\n" + ."\n" + .'- 整数：代表像素值，单位为px，取值范围为[1,4096]。'."\n" + .'- 小数：代表相对输出图片分辨率宽度的比率，取值范围为(0,1)', + 'type' => 'number', + 'format' => 'double', + 'example' => '1280', + ], + 'Interval' => [ + 'title' => 'Interval', + 'description' => '抽帧间隔，单位为秒。', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0.5', + ], + ], + ], + ], + 'Snapshots' => [ + 'title' => 'Snapshots', + 'description' => '截帧处理列表。', + 'type' => 'array', + 'items' => [ + 'description' => '截帧处理详细信息。', + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'title' => 'Format', + 'description' => '截帧的格式。取值范围如下：'."\n" + ."\n" + .'- jpg'."\n" + ."\n" + .'- png', + 'type' => 'string', + 'required' => true, + 'example' => 'jpg', + ], + 'Number' => [ + 'title' => 'Number', + 'description' => '截帧数量。默认值为0，表示截取到视频结束位置。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ScaleType' => [ + 'title' => 'ScaleType', + 'description' => '缩放方式。取值范围如下：'."\n" + ."\n" + .'- stretch（默认）：拉伸以填满。'."\n" + ."\n" + .'- crop：缩放并裁剪。'."\n" + ."\n" + .'- fill：缩放并保留黑边。'."\n" + ."\n" + .'- fit：缩放并不保留黑边。', + 'type' => 'string', + 'example' => 'crop', + ], + 'Mode' => [ + 'description' => '雪碧图子图截帧模式，取值范围如下：'."\n" + .'- interval（默认）：固定时间间隔模式，截帧间隔由Interval参数决定。'."\n" + .'- keyframe：关键帧模式，只截取源视频中的IDR帧，此时Interval参数无效。'."\n" + .'- average：平均模式，根据Number参数按均匀时间间隔截帧，此时Interval参数无效。'."\n" + .'- dhash：dhash模式，根据Number参数设置，在固定时间间隔截帧的基础上截取视频帧内容变化超过Threshold参数的Top Number帧。'."\n" + .' > 当Number参数为0时，则截取所有视频帧内容变化超过Threshold参数的帧。', + 'type' => 'string', + 'example' => 'interval', + ], + 'StartTime' => [ + 'title' => 'StartTime', + 'description' => '视频截帧的开始时间，单位为秒（s）。默认值为0，表示从视频起始时间开始。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'Height' => [ + 'title' => 'Height', + 'description' => '图片高度，默认保持源视频高度。取值为整数或小数时的不同含义如下：'."\n" + ."\n" + .'- 整数：像素值，单位为像素（px），取值范围为[1,4096]。'."\n" + ."\n" + .'- 小数：表示相对输出图片分辨率高度的比率，取值范围为(0,1)。', + 'type' => 'number', + 'format' => 'double', + 'example' => '960', + ], + 'URI' => [ + 'title' => 'URI', + 'description' => '保存截帧的OSS地址。'."\n" + ."\n" + .'地址规则为oss://bucket/object，其中bucket为和当前项目处于同一地域的OSS Bucket名称，object为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/snapshots', + ], + 'Width' => [ + 'title' => 'Width', + 'description' => '图片宽度，默认保持源视频宽度。取值为整数或小数时的不同含义如下：'."\n" + ."\n" + .'- 整数：像素值，单位为像素（px），取值范围为[1,4096]。'."\n" + ."\n" + .'- 小数：表示相对输出图片分辨率宽度的比率，取值范围为(0,1)。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1280', + ], + 'Interval' => [ + 'title' => 'Interval', + 'description' => '视频截帧的时间间隔，单位为秒（s）。', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0.5', + ], + 'Threshold' => [ + 'description' => '截帧阈值，值越大截帧数量越少，取值范围为 0~100，默认值为 0。'."\n" + .'> - 仅在使用dhash截帧模式时有效。'."\n" + .'> - dhash模式对阈值较为敏感，推荐该参数设置不大于25，并根据具体场景调整。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + 'TargetSubtitle' => [ + 'title' => 'Subtitle Struct', + 'description' => '字幕处理参数配置。', + 'type' => 'object', + 'properties' => [ + 'DisableSubtitle' => [ + 'title' => 'DisableSubtitle', + 'description' => '是否禁用字幕处理，取值范围如下：'."\n" + ."\n" + .'- true：禁用，输出文件中将不包含字幕。'."\n" + .'- false（默认）：不禁用。'."\n" + ."\n" + .'> API为GenerateVideoPlaylist时，如果生成字幕，该字段为必现且必须填为false。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Stream' => [ + 'title' => 'Stream', + 'description' => '需要处理的源文件字幕流索引号列表。空值（默认）或者索引号大于100 表示处理所有字幕流。'."\n" + ."\n" + .'- 示例：`[0,1]`处理索引号为0和1的字幕流；`[1]`处理索引号为1的字幕流；`[101]`处理所有字幕流。'."\n" + ."\n" + .'> 只处理索引号存在的字幕流，索引号对应的字幕流不存在时将忽略该索引号。', + 'type' => 'array', + 'items' => [ + 'description' => '需要转换的字幕流索引号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + 'ExtractSubtitle' => [ + 'title' => 'ExtractSubtitle', + 'description' => '字幕提取配置。'."\n" + .'> API为GenerateVideoPlaylist时，不支持该字段配置。', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'title' => 'URI', + 'description' => '保存提取字幕的OSS地址前缀。'."\n" + .'地址规则为oss://bucket/object，其中bucket为和当前项目处于同一地域的OSS Bucket名称，object为包含文件扩展名的文件完整路径。'."\n" + .'- 示例：URI为oss://examplebucket/outputSubtitle，则将产生多个OSS地址为oss://examplebucket/outputSubitile_${index}.${ext}文件，其中${ext}为字幕文件的拓展名，${index}为生成的从0开始编号的与源视频字幕流对应的字幕文件序号。', + 'type' => 'string', + 'example' => 'oss://test-bucket/extractsubtitle', + ], + 'Format' => [ + 'title' => 'Format', + 'description' => '字幕提取的输出格式。取值范围如下：'."\n" + ."\n" + .'- ass'."\n" + .'- srt'."\n" + .'- webvtt', + 'type' => 'string', + 'example' => 'webvtt', + ], + ], + ], + ], + ], + 'TargetVideo' => [ + 'title' => 'Video Struct', + 'description' => '视频处理参数配置。', + 'type' => 'object', + 'properties' => [ + 'DisableVideo' => [ + 'title' => 'DisableVideo', + 'description' => '是否禁用视频流生成，取值范围如下：'."\n" + ."\n" + .'- true：禁用，输出文件中将不包含视频流。'."\n" + .'- false（默认）：不禁用。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Stream' => [ + 'title' => 'Stream', + 'description' => '需要处理的源文件视频流索引号列表。空值（默认）表示处理索引号最小的视频流（第一路视频流），索引号大于100表示处理所有视频流。'."\n" + ."\n" + .'- 示例：`[0,1]`处理索引号为0和1的视频流；`[1]`处理索引号为1的视频流；`[101]`处理所有视频流。'."\n" + ."\n" + .'> 只处理索引号存在的视频流，索引号对应的视频流不存在时将忽略该索引号。', + 'type' => 'array', + 'items' => [ + 'description' => '需要处理的视频流索引号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + 'TranscodeVideo' => [ + 'title' => 'TranscodeVideo', + 'description' => '视频转码参数，空值表示禁用视频处理，输出文件中将不包含视频流。'."\n" + ."\n" + .'> 不推荐通过将该参数设为空值来禁用视频处理。', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'title' => 'Codec', + 'description' => '视频编码格式。取值范围如下：'."\n" + ."\n" + .'- API为CreateMediaConvert时：copy（默认），h264，h265，vp9。'."\n" + .'<warning>当该参数为copy时，表示将需要处理的视频流直接拷贝到输出文件，此时**TranscodeVideo**下的其余参数无效。copy不可用于视频拼接，通常应用于转封装场景。></warning>'."\n" + .'- API为GenerateVideoPlaylist时：h264（默认），h265。', + 'type' => 'string', + 'example' => 'h264', + ], + 'PixelFormat' => [ + 'title' => 'PixelFormat', + 'description' => '像素格式，默认与源视频一致。取值范围如下：'."\n" + ."\n" + .'- yuv420p'."\n" + .'- yuv422p'."\n" + .'- yuv444p'."\n" + .'- yuv420p10le'."\n" + .'- yuv422p10le'."\n" + .'- yuv444p10le'."\n" + .'- yuva420p'."\n" + ."\n" + .'> yuva420p仅在API为CreateMediaConvert时可用，且参数**Codec**必须为vp9。', + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'FrameRateOption' => [ + 'title' => 'FrameRateOption', + 'description' => '帧率选项。取值范围如下：'."\n" + ."\n" + .'- fixed：始终使用设置的目标视频帧率。'."\n" + .'- adaptive：源视频帧率小于设置的目标视频帧率时使用源视频帧率。'."\n" + .'- fall：源视频帧率小于设置的目标视频帧率时返回失败。'."\n" + ."\n" + .'默认值：'."\n" + .'- 当API为CreateMediaConvert时，默认值为fixed。'."\n" + .'- 当API为GenerateVideoPlaylist时，默认值为adaptive。'."\n" + ."\n" + .'> 该参数需要与参数**FrameRate**一同设置。', + 'type' => 'string', + 'example' => 'fixed', + ], + 'FrameRate' => [ + 'title' => 'FrameRate', + 'description' => '视频帧率，默认与源视频一致。', + 'type' => 'number', + 'format' => 'float', + 'example' => '25', + ], + 'ResolutionOption' => [ + 'title' => 'ResolutionOption', + 'description' => '分辨率选项。取值范围如下：'."\n" + ."\n" + .'- fixed：始终使用设置的目标视频分辨率。'."\n" + .'- adaptive：源视频分辨率面积小于设置的目标视频分辨率面积时使用源视频分辨率。'."\n" + .'- fall：源视频分辨率面积小于设置的目标视频分辨率面积时返回失败。'."\n" + ."\n" + .'默认值：'."\n" + .'- 当API为CreateMediaConvert时，默认值为fixed。'."\n" + .'- 当API为GenerateVideoPlaylist时，默认值为adaptive。'."\n" + ."\n" + .'> 该参数需要与参数**Resolution**一同设置。', + 'type' => 'string', + 'example' => 'fixed', + ], + 'Resolution' => [ + 'title' => 'Resolution', + 'description' => '输出视频的分辨率，格式为`宽x高`，默认与源视频播放分辨率一致。支持同时配置宽高或单独配置宽或高，也可配合参数**AdaptiveResolutionDirection**同时配置长短边或单独配置长边或短边，单边取值范围为（0,4096]。'."\n" + ."\n" + .'- 示例1：若**AdaptiveResolutionDirection**为false，`1280x720`表示设置宽为1280，高为720；`1280x`表示设置宽为1280，高与源视频一致；`x720`表示设置高为720，宽与源视频一致。'."\n" + .'- 示例2：若**AdaptiveResolutionDirection**为true，`1280x720`表示设置长边为1280，短边为720；`1280x`表示设置长边为1280，短边与源视频一致；`x720`表示设置短边为720，长边与源视频一致。'."\n" + ."\n" + .'> 若源视频存在旋转信息，宽高、长短边的判断以旋转后的情况为准，即以播放分辨率为准。', + 'type' => 'string', + 'example' => '640x480', + ], + 'AdaptiveResolutionDirection' => [ + 'title' => 'AdaptiveResolutionDirection', + 'description' => '是否开启长短边自适应。取值范围如下：'."\n" + ."\n" + .'- true（默认）：是，此时参数**Resolution**的格式为`长边×短边`。'."\n" + .'- false：否，此时参数**Resolution**的格式为`宽×高`。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ScaleType' => [ + 'title' => 'ScaleType', + 'description' => '缩放模式。取值范围如下：'."\n" + ."\n" + .'- stretch（默认）：固定宽高或长短边，强制缩放，拉伸以填满空白部分。'."\n" + .'- crop：等比缩放，缩放为延伸出指定宽高或长短边的矩形框外的最小分辨率，然后将超出的部分进行居中裁剪。'."\n" + .'- fill：等比缩放，缩放为指定宽高或长短边的矩形内的最大分辨率，然后使用黑色居中填充空白部分。'."\n" + .'- fit：等比缩放，缩放为指定宽高或长短边的矩形内的最大分辨率。'."\n" + ."\n" + .'> 该参数需要与参数**Resolution**一同设置。', + 'type' => 'string', + 'example' => 'crop', + ], + 'Rotation' => [ + 'title' => 'Rotation', + 'description' => '视频顺时针旋转的度数。取值范围如下：'."\n" + ."\n" + .'- 0（默认）'."\n" + .'- 90'."\n" + .'- 180'."\n" + .'- 270', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + 'BitrateOption' => [ + 'title' => 'BitrateOption', + 'description' => '视频码率选项。取值范围如下：'."\n" + ."\n" + .'- fixed：始终使用设置的目标视频码率。'."\n" + .'- adaptive：源视频码率小于设置的目标视频码率时使用源视频码率。'."\n" + .'- fall：源视频码率小于设置的目标视频码率时返回失败。'."\n" + ."\n" + .'默认值：'."\n" + .'- API为CreateMediaConvert时，默认值为fixed。'."\n" + .'- API为GenerateVideoPlaylist时，默认值为adaptive。'."\n" + ."\n" + .'> 该参数需要与参数**Bitrate**一同设置。', + 'type' => 'string', + 'example' => 'fixed', + ], + 'Bitrate' => [ + 'title' => 'Bitrate', + 'description' => '视频流码率，单位为比特每秒（bit/s），'."\n" + ."\n" + .'> 该参数与**CRF**互斥，若该参数与参数**CRF**都为空值则按照参数**CRF**为23进行编码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '128000', + ], + 'GOPSize' => [ + 'title' => 'GOPSize', + 'description' => '关键帧间隔帧数，默认值为150。'."\n" + ."\n" + .'> API为GenerateVideoPlaylist 时不支持该参数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'CRF' => [ + 'title' => 'CRF', + 'description' => '指定恒定质量模式。与参数**Bitrate**互斥，取值范围为[0,51]，数值越大画质越差，建议取值范围为[18,38]。', + 'type' => 'number', + 'format' => 'float', + 'example' => '18', + ], + 'BufferSize' => [ + 'title' => 'BufferSize', + 'description' => '动态码率下解码缓存大小，单位为比特每秒（bps）。'."\n" + ."\n" + .'> 该参数需要与参数**CRF**一起使用才有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4000000', + ], + 'MaxBitrate' => [ + 'title' => 'MaxBitrate', + 'description' => '动态码率下限定最大码率。使用该参数时，必须指定参数BufferSize。'."\n" + ."\n" + .'> 该参数需要与参数**CRF**一起使用才有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '128000', + ], + 'BFrames' => [ + 'title' => 'BFrames', + 'description' => '连续B帧的数量，默认值为3。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Refs' => [ + 'title' => 'Refs', + 'description' => '参考帧的数量，默认值为2。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'VideoSlim' => [ + 'description' => '启用轻码高清模式，设置值如下：'."\n" + ."\n" + .'0：默认值，表示关闭。'."\n" + ."\n" + .'1：表示使用轻码高清模式转码。'."\n" + .'> 为获得最佳效果，轻码高清推荐使用官方推荐Bitrate或CRF参数进行视频转码编码。'."\n" + .'>'."\n" + .'><notice>轻码高清仅支持h.264/h.265格式，仅支持yuv420p，8bit位深，不支持多路目标视频转码输出以及视频拼接。详情参考轻码高清产品介绍:[https://help.aliyun.com/zh/imm/user-guide/video-slim](url)', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'FilterVideo' => [ + 'title' => 'FilterVideo', + 'description' => '视频处理参数，参数**TranscodeVideo**为空时或**TranscodeVideo.Codec**为copy时，本参数无效。'."\n" + ."\n" + .'>API为GenerateVideoPlaylist时不支持设置此参数。', + 'type' => 'object', + 'properties' => [ + 'Watermarks' => [ + 'title' => 'Watermarks', + 'description' => '视频水印列表。', + 'type' => 'array', + 'items' => [ + 'description' => '视频水印信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => 'Type', + 'description' => '水印类型。取值范围如下：'."\n" + ."\n" + .'- text（默认）：文字水印。'."\n" + .'- file：图片或动图水印。', + 'type' => 'string', + 'example' => 'text', + ], + 'Dx' => [ + 'title' => 'Dx', + 'description' => '取值为整数或小数时不同含义如下：'."\n" + ."\n" + .'- 0（默认）：偏移像素和水平偏移量与输出分辨率高的比率都为0。'."\n" + .'- 整数：表示偏移像素，单位为像素（px），取值范围为[1,4096]。'."\n" + .'- 小数：表示水平偏移量与输出分辨率高的比率，取值范围为(0,1)。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'Dy' => [ + 'title' => 'Dy', + 'description' => '取值为整数或小数时的不同含义如下：'."\n" + ."\n" + .'- 0（默认）：表示偏移像素和垂直偏移量与输出分辨率高的比率都为0。'."\n" + ."\n" + .'- 整数：表示偏移像素，单位为像素（px），取值范围为[1,4096]。'."\n" + ."\n" + .'- 小数：表示垂直偏移量与输出分辨率高的比率，取值范围为(0,1)。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'StartTime' => [ + 'title' => 'StartTime', + 'description' => '添加水印的开始时间，单位为秒（s），默认从视频起始时间开始。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'Duration' => [ + 'title' => 'Duration', + 'description' => '添加水印持续的时间，单位为秒（s），默认值持续到视频结束。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'ReferPos' => [ + 'title' => 'ReferPos', + 'description' => '添加水印的基准位置。取值范围如下：'."\n" + ."\n" + .'- topleft（默认）：左上角'."\n" + .'- topright：右上角'."\n" + .'- bottomright：右下角'."\n" + .'- bottomleft：左下角', + 'type' => 'string', + 'example' => 'topleft', + ], + 'Content' => [ + 'title' => 'Content', + 'description' => '文字水印的内容，默认值为空。'."\n" + ."\n" + .'><notice> 当参数`Type`取值为`text`时此参数生效。></notice>', + 'type' => 'string', + 'example' => 'example', + ], + 'FontName' => [ + 'title' => 'FontName', + 'description' => '文字水印的字体名称。取值范围如下：'."\n" + ."\n" + .'- SourceHanSans-Regular（默认）'."\n" + .'- SourceHanSans-Bold'."\n" + .'- SourceHanSerif-Regular'."\n" + .'- SourceHanSerif-Bold'."\n" + ."\n" + .'><notice> 当参数`Type`取值为`text`时此参数生效。></notice>', + 'type' => 'string', + 'example' => 'SourceHanSans-Bold', + ], + 'FontSize' => [ + 'title' => 'FontSize', + 'description' => '文字水印的字体大小，默认值为16。取值为整数，取值范围为(4,120)。'."\n" + ."\n" + .'><notice> 当参数`Type`取值为`text`时此参数生效。></notice>', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '18', + ], + 'FontColor' => [ + 'title' => 'FontColor', + 'description' => '水印文字的字体颜色。格式为#RRGGBB，默认值为#000000。也支持输入“red”、"green"等值。'."\n" + ."\n" + .'><notice> 当参数`Type`取值为`text`时此参数生效。></notice>', + 'type' => 'string', + 'example' => 'red', + ], + 'FontApha' => [ + 'title' => 'FontApha', + 'description' => '文字水印的字体透明度。取值范围为(0,1]，默认值为1，表示完全不透明。'."\n" + ."\n" + .'><notice> 当参数`Type`取值为`text`时此参数生效。></notice>', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8', + ], + 'BorderWidth' => [ + 'title' => 'BorderWidth', + 'description' => '文字水印的描边宽度，单位为像素（px）。取值只能为整数，取值范围为[0,4096]，默认值为0。'."\n" + ."\n" + .'><notice> 当参数`Type`取值为`text`时此参数生效。></notice>', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'BorderColor' => [ + 'title' => 'BorderColor', + 'description' => '水印文字的描边颜色。格式为#RRGGBB，默认值为#000000。也支持输入“red”、"green"等值。'."\n" + ."\n" + .'><notice> 当参数`Type`取值为`text`时此参数生效。></notice>', + 'type' => 'string', + 'example' => 'red', + ], + 'URI' => [ + 'title' => 'URI', + 'description' => '水印文件的OSS地址，支持的格式为PNG和MOV。'."\n" + ."\n" + .'OSS地址规则为`oss://<bucket>/<object>`，其中`<bucket>`为和当前项目处于同一地域的OSS Bucket名称，`<object>`为包含文件扩展名的文件完整路径。'."\n" + ."\n" + .'><notice> 当参数`Type`取值为`file`时此参数生效。></notice>', + 'type' => 'string', + 'example' => 'oss://test-bucket/watermark.jpg', + ], + 'Width' => [ + 'title' => 'Width', + 'description' => '水印图片的宽度，默认值为原水印图片的宽度。取值为整数或小数时的不同含义如下：'."\n" + ."\n" + .'- 整数：表示去除Logo宽度的像素值，单位为像素（px），取值范围为[1,4096]。'."\n" + .'- 小数：表示相对输出视频分辨率宽度的比率，取值范围为(0,1)。', + 'type' => 'number', + 'format' => 'float', + 'example' => '80', + ], + 'Height' => [ + 'title' => 'Height', + 'description' => '水印图片的高度，默认值为原水印图片的高度。取值为整数或小数时的不同含义如下：'."\n" + ."\n" + .'- 整数：表示去除Logo高度的像素值，单位为像素（px），取值范围为[1,4096]。'."\n" + .'- 小数：表示相对输出视频分辨率高度的比率，取值范围为(0,1)。', + 'type' => 'number', + 'format' => 'float', + 'example' => '40', + ], + ], + ], + ], + 'Delogos' => [ + 'title' => 'Delogos', + 'description' => '对视频上某矩形部分进行模糊处理，用于去除Logo、台标等。', + 'type' => 'array', + 'items' => [ + 'description' => '视频模糊处理参数。', + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'title' => 'StartTime', + 'description' => '添加马赛克的开始时间，单位为秒（s）。默认为从视频起始时间开始。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'Duration' => [ + 'title' => 'Duration', + 'description' => '添加马赛克的持续时间，单位为秒（s），默认值持续到视频结束。', + 'type' => 'number', + 'format' => 'double', + 'example' => '15', + ], + 'Dx' => [ + 'title' => 'Dx', + 'description' => '取值为整数或小数时的不同含义如下：'."\n" + ."\n" + .'- 0（默认）：偏移像素和水平偏移量与输出分辨率高的比率都为0。'."\n" + .'- 整数：表示偏移像素，单位为像素（px），取值范围为[1,4096]。'."\n" + .'- 小数：表示水平偏移量与输出分辨率高的比率，取值范围为(0,1)。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'Dy' => [ + 'title' => 'Dy', + 'description' => '默认值为0。取值为整数或小数时的不同含义如下：'."\n" + ."\n" + .'- 0（默认）：偏移像素和垂直偏移量与输出分辨率高的比率都为0。'."\n" + .'- 整数：表示偏移像素，单位为像素（px），取值范围为[1,4096]。'."\n" + .'- 小数：表示垂直偏移量与输出分辨率高的比率，取值范围为(0,1)。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'Width' => [ + 'title' => 'Width', + 'description' => '马赛克的宽度，默认值为小数型的1.0，即占满输出视频宽度，取值为整数或小数时的不同含义如下：'."\n" + ."\n" + .'- 整数：像素值，单位为像素（px），取值范围为[1,4096]。'."\n" + .'- 小数：表示相对输出视频分辨率宽度的比率，取值范围为(0,1)。', + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'Height' => [ + 'title' => 'Height', + 'description' => '马赛克的高度，默认值为小数型的1.0，即占满输出视频高度，取值为整数或小数时的不同含义如下：'."\n" + ."\n" + .'- 整数：像素值，单位为像素（px），取值范围为[1,4096]。'."\n" + .'- 小数：表示相对输出视频分辨率高度的比率，取值范围为(0,1)。', + 'type' => 'number', + 'format' => 'float', + 'example' => '40', + ], + 'ReferPos' => [ + 'title' => 'ReferPos', + 'description' => '添加马赛克的基准位置。取值范围如下：'."\n" + ."\n" + .'- topleft（默认）：左上角'."\n" + .'- topright：右上角'."\n" + .'- bottomright：右下角'."\n" + .'- bottomleft：左下角', + 'type' => 'string', + 'example' => 'topleft', + ], + ], + ], + ], + 'Speed' => [ + 'description' => '视频倍速播放设置，取值范围为[0.5,1.0]，默认值为 1.0。'."\n" + ."\n" + .'> - 转码后媒体文件与源媒体文件默认播放速度的比值，非倍速转码。'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'- 仅适用于CreateMediaConvertTask API。'."\n" + ."\n" + .'></notice>', + 'type' => 'number', + 'format' => 'float', + 'example' => '1.0', + ], + 'Desensitization' => [ + 'description' => '视频脱敏配置。'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'- 仅适用于CreateMediaConvertTask API。'."\n" + ."\n" + .'></notice>', + 'type' => 'object', + 'properties' => [ + 'Face' => [ + 'description' => '人脸脱敏配置。', + 'type' => 'object', + 'properties' => [ + 'Confidence' => [ + 'description' => '人脸置信阈值，用于设置人脸识别的置信度下限。若识别到的人脸置信值小于该阈值，则不会对人脸进行脱敏。'."\n" + .'- 取值范围：0.0 ~ 1.0。'."\n" + .'- 默认值：0.0（表示不进行置信度过滤）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.4', + ], + 'MinSize' => [ + 'description' => '最小人脸尺寸阈值，用于设置需要脱敏人脸的最小尺寸。若识别到的人脸宽度或高度小于该阈值，则不会对人脸进行脱敏。 单位为像素，默认值为 0，表示不对人脸尺寸进行限制。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0.4', + ], + ], + ], + 'LicensePlate' => [ + 'description' => '车牌脱敏配置。', + 'type' => 'object', + 'properties' => [ + 'Confidence' => [ + 'description' => '车牌置信阈值，用于设置车牌识别的置信度下限。若识别到的车牌置信值小于该阈值，则不会对车牌进行脱敏。'."\n" + .'- 取值范围：0.0 ~ 1.0。'."\n" + .'- 默认值：0.0（表示不进行置信度过滤）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.4', + ], + 'MinSize' => [ + 'description' => '最小车牌尺寸阈值，用于设置需要脱敏车牌的最小尺寸。若识别到的车牌宽度或高度小于该阈值，则不会对车牌进行脱敏。 单位为像素，默认值为 0，表示不对车牌尺寸进行限制。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0.4', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'TaskInfo' => [ + 'title' => '任务信息', + 'description' => '任务信息对象。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '任务状态', + 'description' => '任务运行状态。包括如下选项：'."\n" + ."\n" + .'- Running：任务运行中。'."\n" + ."\n" + .'- Succeeded：任务执行成功。'."\n" + ."\n" + .'- Failed：任务执行失败。', + 'type' => 'string', + 'example' => 'Running', + ], + 'Code' => [ + 'title' => '错误码', + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'ResourceNotFound', + ], + 'Message' => [ + 'title' => '错误消息', + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'The specified resource project is not found.', + ], + 'StartTime' => [ + 'title' => '任务开始时间', + 'description' => '任务开始时间。', + 'type' => 'string', + 'example' => '2021-12-24T03:01:41.662060377Z', + ], + 'EndTime' => [ + 'title' => '任务结束时间', + 'description' => '任务结束时间。', + 'type' => 'string', + 'example' => '2021-12-24T03:01:49.480109219Z', + ], + 'UserData' => [ + 'title' => '用户自定义信息', + 'description' => '用户自定义信息。', + 'type' => 'string', + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => '任务类型。', + 'type' => 'string', + 'example' => 'VideoLabelClassification', + ], + 'TaskId' => [ + 'title' => '任务唯一ID', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'c2b277b9-0d30-4882-ad6d-ad661382****', + ], + 'Tags' => [ + 'title' => '标签', + 'description' => '任务标签信息，用于根据标签搜索任务。', + 'type' => 'object', + ], + 'TaskRequestDefinition' => [ + 'title' => 'task信息', + 'description' => '格式为JSON字符串，内容参考各类数据处理异步任务的请求参数定义。', + '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' => [ + 'title' => '任务进度', + 'description' => '任务进度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'TimeRange' => [ + 'title' => 'A short description of struct', + 'description' => '时间范围对象。', + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'title' => 'start time', + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2016-12-31T00:00:00+08:00', + ], + 'End' => [ + 'title' => 'end time', + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2016-12-31T00:00:00+08:00', + ], + ], + ], + 'ToolCall' => [ + 'title' => '工具', + 'description' => 'AI 助手可调用的工具', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '工具类型', + 'description' => '工具类型', + 'type' => 'string', + 'example' => 'function', + ], + 'Function' => [ + 'description' => 'AI 助手可调用的function 的定义', + '$ref' => '#/components/schemas/FunctionCall', + ], + ], + ], + 'TrainingSpecification' => [ + 'title' => 'x', + 'description' => 'x', + 'type' => 'object', + 'properties' => [ + 'ValidationSourceURI' => [ + 'title' => '评估数据集地址，和ValidationSplit参数2选1', + 'description' => '评估数据集地址，和ValidationSplit参数2选1', + 'type' => 'string', + 'example' => 'oss://imm-alg-dataset-bj/cifar10/test_index.json', + ], + 'Runtime' => [ + 'description' => '模型训练运行时信息', + 'required' => true, + '$ref' => '#/components/schemas/Runtime', + ], + 'Endpoint' => [ + 'title' => '数据集存储endpoint', + 'description' => '数据集存储endpoint', + 'type' => 'string', + 'required' => true, + 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', + ], + 'ModelSpecification' => [ + 'description' => '模型详细规格信息', + 'required' => true, + '$ref' => '#/components/schemas/ModelSpecification', + ], + 'DatasetName' => [ + 'title' => '数据集名称', + 'description' => '数据集名称', + 'type' => 'string', + 'example' => 'test-dataset', + ], + 'SourceURI' => [ + 'title' => '数据集地址', + 'description' => '数据集地址', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://imm-alg-dataset-bj/cifar10/test_index.json', + ], + 'Transforms' => [ + 'title' => '数据集本地预处理参数', + 'description' => '数据集本地预处理参数', + 'type' => 'array', + 'items' => [ + 'description' => '模型训练自定义参数信息', + '$ref' => '#/components/schemas/CustomParams', + ], + ], + 'ValidationSplit' => [ + 'title' => '切分训练数据集比例作为评估数据集，和ValidationSourceURI参数2选1', + 'description' => '切分训练数据集比例作为评估数据集，和ValidationSourceURI参数2选1', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.95', + ], + 'TargetURI' => [ + 'title' => '模型数据存储路径，当前只支持oss', + 'description' => '模型数据存储路径，当前只支持oss', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://imm-alg-dataset-bj/model_training_test/', + ], + ], + ], + 'TrimPolicy' => [ + 'title' => '文档转换表格瘦身参数', + 'description' => '文档转换表格瘦身参数对象。', + 'type' => 'object', + 'properties' => [ + 'DisableDeleteEmptyCell' => [ + 'title' => '禁止删除所有空单元格', + 'description' => '禁止删除所有空单元格，可选值如下。'."\n" + ."\n" + .'- true：禁止删除'."\n" + .'- false：允许删除。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DisableDeleteRepeatedStyle' => [ + 'title' => '禁止删除所有重复样式', + 'description' => '禁止删除所有重复样式，可选值如下。'."\n" + ."\n" + .'- true：禁止删除'."\n" + .'- false：允许删除。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DisableDeleteUnusedShape' => [ + 'title' => '禁止删除没有使用的Shape', + 'description' => '禁止删除没有使用的Shape，可选值如下。'."\n" + ."\n" + .'- true：禁止删除'."\n" + .'- false：允许删除。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DisableDeleteUnusedPicture' => [ + 'title' => '禁止删除未使用的单元格图片', + 'description' => '禁止删除未使用的单元格图片，可选值如下。'."\n" + ."\n" + .'- true：禁止删除'."\n" + .'- false：允许删除。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'VideoInsight' => [ + 'description' => '视频摘要与描述。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '视频描述。'."\n" + ."\n" + .'> 暂时不支持。', + 'type' => 'string', + 'example' => '无。', + ], + 'Caption' => [ + 'description' => '视频摘要。', + 'type' => 'string', + 'example' => '视频中展示了两个不同场景：一个是静止的白色盘子、黑色瓶子和透明玻璃杯，另一个是手拿着标有“YEZOLU”的洗发水瓶在浴室中缓慢上移。', + ], + ], + ], + 'VideoStream' => [ + 'title' => 'A short description of struct', + 'description' => '视频流信息。', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => 'Index', + 'description' => '视频流索引号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Language' => [ + 'title' => 'Language', + 'description' => '视频流中使用的语言，格式为BCP 47。', + 'type' => 'string', + 'example' => 'en', + ], + 'CodecName' => [ + 'title' => 'CodecName', + 'description' => '编码器名称。', + 'type' => 'string', + 'example' => 'h264', + ], + 'CodecLongName' => [ + 'title' => 'CodecLongName', + 'description' => '编码器名称的全称。', + 'type' => 'string', + 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', + ], + 'Profile' => [ + 'title' => 'Profile', + 'description' => '档次。', + 'type' => 'string', + 'example' => 'High', + ], + 'CodecTimeBase' => [ + 'title' => 'CodecTimeBase', + 'description' => '编码器时间基准。', + 'type' => 'string', + 'example' => '1373627/83160000', + ], + 'CodecTagString' => [ + 'title' => 'CodecTagString', + 'description' => '编码器标识描述信息。', + 'type' => 'string', + 'example' => 'avc1', + ], + 'CodecTag' => [ + 'title' => 'CodecTag', + 'description' => '编码器标识。', + 'type' => 'string', + 'example' => '0x31637661', + ], + 'Width' => [ + 'title' => 'Width', + 'description' => '视频流画面宽度，单位为像素（px）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1280', + ], + 'Height' => [ + 'title' => 'Height', + 'description' => '视频流画面高度，单位为像素（px）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '720', + ], + 'HasBFrames' => [ + 'title' => 'HasBFrames', + 'description' => '视频流中是否存在B帧。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'SampleAspectRatio' => [ + 'title' => 'SampleAspectRatio', + 'description' => '视频流采样比例。', + 'type' => 'string', + 'example' => '1:1', + ], + 'DisplayAspectRatio' => [ + 'title' => 'DisplayAspectRatio', + 'description' => '视频流显示比例。', + 'type' => 'string', + 'example' => '16:9', + ], + 'PixelFormat' => [ + 'title' => 'PixelFormat', + 'description' => '视频流像素格式。', + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Level' => [ + 'title' => 'Level', + 'description' => '等级。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '40', + ], + 'FrameRate' => [ + 'title' => 'FrameRate', + 'description' => '视频流帧率。', + 'type' => 'string', + 'example' => '25/1', + ], + 'AverageFrameRate' => [ + 'title' => 'AverageFrameRate', + 'description' => '视频流平均帧率。', + 'type' => 'string', + 'example' => '25/1', + ], + 'TimeBase' => [ + 'title' => 'TimeBase', + 'description' => '时间基准。', + 'type' => 'string', + 'example' => '1/12800', + ], + 'StartTime' => [ + 'title' => 'StartTime', + 'description' => '视频流起始时间，单位为秒（s）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.000000', + ], + 'Duration' => [ + 'title' => 'Duration', + 'description' => '视频流持续时长，单位为秒（s）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '22.88', + ], + 'Bitrate' => [ + 'title' => 'Bitrate', + 'description' => '码率，单位为比特每秒（bit/s）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5407765', + ], + 'FrameCount' => [ + 'title' => 'FrameCount', + 'description' => '帧数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '572', + ], + 'Rotate' => [ + 'title' => 'Rotate', + 'description' => '视频流画面旋转角度。', + 'type' => 'string', + 'example' => '90', + ], + 'BitDepth' => [ + 'title' => 'BitDepth', + 'description' => '像素位宽。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8', + ], + 'ColorSpace' => [ + 'title' => 'ColorSpace', + 'description' => '色彩空间。', + 'type' => 'string', + 'example' => 'bt709', + ], + 'ColorRange' => [ + 'title' => 'ColorRange', + 'description' => '色彩范围。', + 'type' => 'string', + 'example' => 'tv', + ], + 'ColorTransfer' => [ + 'title' => 'ColorTransfer', + 'description' => '色彩转换函数。', + 'type' => 'string', + 'example' => 'bt709', + ], + 'ColorPrimaries' => [ + 'title' => 'ColorPrimaries', + 'description' => '原色。', + 'type' => 'string', + 'example' => 'bt709', + ], + ], + ], + 'WebofficePermission' => [ + 'title' => 'Weboffice 用户权限', + 'description' => 'WebOffice用户权限信息。', + 'type' => 'object', + 'properties' => [ + 'Rename' => [ + 'title' => '重命名', + 'description' => '是否有重命名文件权限。取值范围如下：'."\n" + ."\n" + .'- true：是。'."\n" + ."\n" + .'- false：否。'."\n" + ."\n" + .'>只提供消息通知功能，重命名事件会发送到MNS中。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Readonly' => [ + 'title' => '只读模式', + 'description' => '是否文件为预览模式。取值范围如下：'."\n" + ."\n" + .'- true：是，文件为预览模式。'."\n" + ."\n" + .'- false：否，文件为编辑模式。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'History' => [ + 'title' => '查看历史版本', + 'description' => '是否有查看历史版本权限。取值范围如下：'."\n" + ."\n" + .'- true：是。'."\n" + ."\n" + .'- false：否。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Print' => [ + 'title' => '打印', + 'description' => '是否有打印权限。取值范围如下：'."\n" + ."\n" + .'- true：是。'."\n" + ."\n" + .'- false：否。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Export' => [ + 'title' => '导出', + 'description' => '是否有导出PDF权限。取值范围如下：'."\n" + ."\n" + .'- true：是，同时需要将Print权限设置为true才可导出。'."\n" + ."\n" + .'- false：否。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Copy' => [ + 'title' => '拷贝', + 'description' => '是否有拷贝权限。取值范围如下：'."\n" + ."\n" + .'- true：是。'."\n" + ."\n" + .'- false：否。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'WebofficeUser' => [ + 'title' => 'Weboffice 用户', + 'description' => 'Weboffice用户信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'Id', + 'description' => '用户Id。该字段为自定义，可以传入业务相关的用户Id，用户信息在WebOffice页面会进行展示。由字母和数字组成，不超过15个字符。', + 'type' => 'string', + 'example' => 'user1', + ], + 'Name' => [ + 'title' => '名字', + 'description' => '用户名。该字段为自定义，可以传入业务相关的用户名，用户信息在WebOffice页面会进行展示。命名规则如下：'."\n" + ."\n" + .'- 只能包含数字、大小写字母、短划线（-）、下划线（_）、加号（+）、正斜线（/）、等于号（=）和at（@）。'."\n" + ."\n" + .'- 不能超过32个字符。', + 'type' => 'string', + 'example' => 'test-user1', + ], + 'Avatar' => [ + 'title' => '头像', + 'description' => '用户头像URL地址。该字段为自定义，可以传入业务相关的用户头像URL地址，用户信息在WebOffice页面会进行展示。', + 'type' => 'string', + 'example' => 'http://example.com/?id=user1', + ], + ], + ], + 'WebofficeWatermark' => [ + 'title' => 'Weboffice 水印', + 'description' => 'WebOffice水印信息对象。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '水印类型，目前仅支持文字水印，0: 无水印；1: 文字水印', + 'description' => '水印类型。取值范围如下：'."\n" + ."\n" + .'- 0：无水印。'."\n" + ."\n" + .'- 1：文字水印。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Value' => [ + 'title' => '水印文字', + 'description' => '文字水印的文字。'."\n" + .'>当Type取值为1时，才能设置此参数。', + 'type' => 'string', + 'example' => 'example', + ], + 'Rotate' => [ + 'title' => '旋转角度', + 'description' => '文字水印的旋转度，单位为弧度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '-0.7853982', + ], + 'Vertical' => [ + 'title' => '垂直间距', + 'description' => '文字水印垂直间距，单位为像素（px）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Horizontal' => [ + 'title' => '水平间距', + 'description' => '文字水印水平间距，单位为像素（px）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'Font' => [ + 'title' => '字体样式', + 'description' => '文字水印的字体信息。', + 'type' => 'string', + 'example' => 'bold 20px Serif', + ], + 'FillStyle' => [ + 'title' => '字体颜色', + 'description' => '文字水印的颜色和透明度。', + 'type' => 'string', + 'example' => 'rgba(192, 192, 192, 0.6)', + ], + ], + ], + 'WorkflowParameter' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'apis' => [ + 'ListRegions' => [ + 'summary' => '查询支持IMM服务的Region列表信息，包括Region和对应语言的描述信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'abilityTreeCode' => '143479', + 'abilityTreeNodes' => [ + 'FEATUREimmKH590Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。取值范围如下：'."\n" + .'- zh-CN ：中文'."\n" + .'- en-US ：英文'."\n" + .'- ja ：日语', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => '接口请求ID。', + 'type' => 'string', + 'example' => '7F7D235C-76FF-4B65-800C-8238AE3F****', + ], + 'Regions' => [ + 'description' => 'Region列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Region结构信息。', + 'enumValueTitles' => [], + '$ref' => '#/components/schemas/RegionType', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F7D235C-76FF-4B65-800C-8238AE3F****\\",\\n \\"Regions\\": [\\n {\\n \\"RegionId\\": \\"\\",\\n \\"LocalName\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询支持IMM服务的Region列表', + ], + 'CreateProject' => [ + 'summary' => '创建一个项目（Project）。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '436', + 'abilityTreeNodes' => [ + 'FEATUREimmKH590Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称。命名规则如下：'."\n" + ."\n" + .'- 长度为1~128字符。'."\n" + ."\n" + .'- 只能包含英文字母，数字，短划线（-）和下划线（_）。'."\n" + ."\n" + .'- 必须以英文字母或下划线（_）开头。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '项目描述信息。长度为1~256个英文或中文字符，默认值为空。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'immtest', + ], + ], + [ + 'name' => 'ServiceRole', + 'in' => 'query', + 'schema' => [ + 'description' => '服务角色，授权给IMM服务以访问其他云资源（例如OSS）的权限，默认值为`AliyunIMMDefaultRole`。'."\n" + ."\n" + .'如果要自定义服务角色，您可以通过RAM控制台创建普通服务角色并为角色授权。具体操作，请参见[为角色授权](~~477258~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunIMMDefaultRole', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作流模板ID，默认值为空。更多信息，请参见[工作流模板与算子](~~466304~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Official:ImageManagement', + ], + ], + [ + 'name' => 'ProjectMaxDatasetCount', + 'in' => 'query', + 'schema' => [ + 'description' => '项目中数据集的最大个数。取值范围为1~1000000000，默认值为1000000000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000000000', + ], + ], + [ + 'name' => 'DatasetMaxBindCount', + 'in' => 'query', + 'schema' => [ + 'description' => '每个数据集绑定的最大个数。取值范围为1~10，默认值为10。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'DatasetMaxFileCount', + 'in' => 'query', + 'schema' => [ + 'description' => '每个数据集中文件的最大个数。取值范围为1~100000000，默认值为10000000000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000000', + ], + ], + [ + 'name' => 'DatasetMaxEntityCount', + 'in' => 'query', + 'schema' => [ + 'description' => '每个数据集中元数据实体的最大个数，默认值为10000000000。'."\n" + .'>当前该配置仅为预留，使用中并不做实际限制。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000000000', + ], + ], + [ + 'name' => 'DatasetMaxRelationCount', + 'in' => 'query', + 'schema' => [ + 'description' => '每个数据集中元数据关系的最大个数，默认值为100000000000。'."\n" + .'>当前该配置仅为预留，使用中并不做实际限制。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000000000', + ], + ], + [ + 'name' => 'DatasetMaxTotalFileSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每个数据集中文件总大小的最大值，超过限制后无法再添加索引。单位为字节，默认值为90000000000000000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '90000000000000000', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签列表', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签值', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '本次请求的唯一 ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7F7D235C-76FF-4B65-800C-8238AE3F****', + ], + 'Project' => [ + 'description' => '项目信息。详细内容请单击Project查看。', + '$ref' => '#/components/schemas/Project', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7F7D235C-76FF-4B65-800C-8238AE3F****\\",\\n \\"Project\\": {\\n \\"ProjectName\\": \\"\\",\\n \\"ServiceRole\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"ProjectQueriesPerSecond\\": 0,\\n \\"EngineConcurrency\\": 0,\\n \\"ProjectMaxDatasetCount\\": 0,\\n \\"DatasetMaxBindCount\\": 0,\\n \\"DatasetMaxFileCount\\": 0,\\n \\"DatasetMaxEntityCount\\": 0,\\n \\"DatasetMaxRelationCount\\": 0,\\n \\"DatasetMaxTotalFileSize\\": 0,\\n \\"DatasetCount\\": 0,\\n \\"FileCount\\": 0,\\n \\"TotalFileSize\\": 0,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"\\",\\n \\"TagValue\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '创建项目', + 'description' => '* 项目名称在同一个Region下唯一。'."\n" + .'* 创建的项目个数存在限制，默认最多创建100个项目，扩容请填写工单或使用钉钉搜索钉钉群号88490020073加入钉钉群进行申请。'."\n" + .'* 创建项目后，您可以继续创建智能媒体管理的其他资源：'."\n" + .' + [创建数据集](~~478160~~)'."\n" + .' + [创建触发器](~~479912~~)'."\n" + .' + [创建批处理任务](~~606694~~)'."\n" + .' + [创建绑定任务](~~478202~~)', + ], + 'UpdateProject' => [ + 'summary' => '更新一个已创建项目（Project）的信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '495', + 'abilityTreeNodes' => [ + 'FEATUREimmKH590Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'ServiceRole', + 'in' => 'query', + 'schema' => [ + 'title' => '服务角色', + 'description' => '服务角色，授权给IMM服务以访问其他云资源（例如OSS）的权限。'."\n" + ."\n" + .'如果要自定义服务角色，您可以通过RAM控制台创建普通服务角色并为角色授权。具体操作，请分别参见[创建普通服务角色](~~116800~~)和[为角色授权](~~116147~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunIMMDefaultRole', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '项目描述', + 'description' => '项目描述信息。长度为1~256个英文或中文字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板Id', + 'description' => '工作流模板ID。更多信息，请参见[工作流模板与算子](~~466304~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Official:ImageManagement', + ], + ], + [ + 'name' => 'ProjectMaxDatasetCount', + 'in' => 'query', + 'schema' => [ + 'title' => '项目最多媒体集数', + 'description' => '项目中数据集的最大个数。取值范围为1~1000000000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000000000', + ], + ], + [ + 'name' => 'DatasetMaxBindCount', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最多绑定数', + 'description' => '每个数据集绑定的最大个数。取值范围为1~10。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'DatasetMaxFileCount', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最多文件数', + 'description' => '每个数据集中文件的最大个数。取值范围为1~100000000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000000', + ], + ], + [ + 'name' => 'DatasetMaxEntityCount', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最多实体数', + 'description' => '每个数据集中元数据实体的最大个数。'."\n" + .'>预留参数，使用中并不做实际限制。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000000000', + ], + ], + [ + 'name' => 'DatasetMaxRelationCount', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最多关系数', + 'description' => '每个数据集中元数据关系的最大个数。'."\n" + .'>预留参数，使用中并不做实际限制。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000000000', + ], + ], + [ + 'name' => 'DatasetMaxTotalFileSize', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最大文件总大小', + 'description' => '每个数据集中文件总大小的最大值，超过限制后无法再添加索引。单位为字节。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '90000000000000000', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签列表', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签值', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D33C3574-4093-448E-86E7-15BE2BD3****', + ], + 'Project' => [ + 'description' => '项目信息。详细内容请单击Project查看。', + '$ref' => '#/components/schemas/Project', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D33C3574-4093-448E-86E7-15BE2BD3****\\",\\n \\"Project\\": {\\n \\"ProjectName\\": \\"\\",\\n \\"ServiceRole\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"ProjectQueriesPerSecond\\": 0,\\n \\"EngineConcurrency\\": 0,\\n \\"ProjectMaxDatasetCount\\": 0,\\n \\"DatasetMaxBindCount\\": 0,\\n \\"DatasetMaxFileCount\\": 0,\\n \\"DatasetMaxEntityCount\\": 0,\\n \\"DatasetMaxRelationCount\\": 0,\\n \\"DatasetMaxTotalFileSize\\": 0,\\n \\"DatasetCount\\": 0,\\n \\"FileCount\\": 0,\\n \\"TotalFileSize\\": 0,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"\\",\\n \\"TagValue\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '更新项目', + 'description' => '- 更新项目信息时，确保项目已经创建成功，创建项目请参考请求参数描述。'."\n" + .'- 更新项目信息时，只需填充需要更新的字段，未填充的字段不会变更。'."\n" + .'- 项目更新成功不会立即生效，需要等待至多5分钟的时间。', + ], + 'GetProject' => [ + 'summary' => '查询指定项目（Project）的信息，包含基础信息，数据集（Dataset）和文件相关的统计信息等。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '450', + 'abilityTreeNodes' => [ + 'FEATUREimmKH590Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称。获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'WithStatistics', + 'in' => 'query', + 'schema' => [ + 'title' => '是否获取详细信息', + 'description' => '是否需要进行文件统计。默认值false，不需要进行文档统计。'."\n" + ."\n" + .'- 需要进行文件统计。返回Project结构体中的FileCount和TotalFileSize真实有效。'."\n" + ."\n" + .'- 不需要进行文件统计。返回Project结构体中的FileCount和TotalFileSize可能不正确也可能都为0。'."\n" + ."\n" + .'><notice>仅支持统计在2025.12.20之前创建的Dataset的文件。></notice>', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5A022F78-B9A8-4ACC-BB6B-B3597553', + ], + 'Project' => [ + 'description' => '项目信息。', + '$ref' => '#/components/schemas/Project', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5A022F78-B9A8-4ACC-BB6B-B3597553\\",\\n \\"Project\\": {\\n \\"ProjectName\\": \\"\\",\\n \\"ServiceRole\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"ProjectQueriesPerSecond\\": 0,\\n \\"EngineConcurrency\\": 0,\\n \\"ProjectMaxDatasetCount\\": 0,\\n \\"DatasetMaxBindCount\\": 0,\\n \\"DatasetMaxFileCount\\": 0,\\n \\"DatasetMaxEntityCount\\": 0,\\n \\"DatasetMaxRelationCount\\": 0,\\n \\"DatasetMaxTotalFileSize\\": 0,\\n \\"DatasetCount\\": 0,\\n \\"FileCount\\": 0,\\n \\"TotalFileSize\\": 0,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"\\",\\n \\"TagValue\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '查询项目信息', + 'description' => '查询项目信息支持实时获取文件统计信息，通过参数配置开启，详情请见请求参数一栏。'."\n" + .'><notice>仅支持统计在2025.12.20之前创建的Dataset的文件。></notice>', + ], + 'ListProjects' => [ + 'summary' => '查询所有项目（Project）的信息，包含基础信息，数据集（Dataset）和文件相关的统计信息等。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '763', + 'abilityTreeNodes' => [ + 'FEATUREimmKH590Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '返回结果的最大个数', + 'description' => '返回项目的最大个数，取值范围为0~200。不设置此参数或者设置为0时，则默认值为100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '当总结果个数大于MaxResults时，用于翻页的token', + 'description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值。从NextToken开始按字典序返回项目信息列表。第一次调用此接口时，设置为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDAx', + ], + ], + [ + 'name' => 'Prefix', + 'in' => 'query', + 'schema' => [ + 'title' => '列出包含某前缀的project', + 'description' => '列出指定前缀的项目，长度限制为0~128字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签列表', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签值', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'title' => '当总结果个数大于MaxResults时，用于翻页的token', + 'description' => '当预期返回的项目总数大于设置的MaxResults时，将作为查询后续页的凭证。只有当项目未全部返回时，此参数才有值。', + 'type' => 'string', + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDAx', + ], + 'Projects' => [ + 'title' => '由ProjectItem组成的数组', + 'description' => '由Project组成的数组格式，返回Project的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '项目信息。', + '$ref' => '#/components/schemas/Project', + ], + ], + 'RequestId' => [ + 'title' => '本次请求的唯一 ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4A7A2D0E-D8B8-4DA0-8127-EB32C660', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"MTIzNDU2Nzg6aW1tdGVzdDAx\\",\\n \\"Projects\\": [\\n {\\n \\"ProjectName\\": \\"\\",\\n \\"ServiceRole\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"ProjectQueriesPerSecond\\": 0,\\n \\"EngineConcurrency\\": 0,\\n \\"ProjectMaxDatasetCount\\": 0,\\n \\"DatasetMaxBindCount\\": 0,\\n \\"DatasetMaxFileCount\\": 0,\\n \\"DatasetMaxEntityCount\\": 0,\\n \\"DatasetMaxRelationCount\\": 0,\\n \\"DatasetMaxTotalFileSize\\": 0,\\n \\"DatasetCount\\": 0,\\n \\"FileCount\\": 0,\\n \\"TotalFileSize\\": 0,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"\\",\\n \\"TagValue\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"4A7A2D0E-D8B8-4DA0-8127-EB32C660\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '查询所有项目信息', + 'description' => '支持分页查看返回数据：分页查询首页时，仅需设置MaxResults以限制返回信息的条目数，返回结果中的NextToken将作为查询后续页的凭证。查询后续页时，将NextToken参数设置为上一次返回结果中获取到的NextToken作为查询凭证，并设置MaxResults限制返回条目数。', + ], + 'DeleteProject' => [ + 'summary' => '删除指定项目（Project）。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称。获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '本次请求的唯一 ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FEDC9B1F-30F2-4C1F-8ED2-B7860187****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'StatusConflict', + 'errorMessage' => 'Message: cannot delete when sub resoures exist', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEDC9B1F-30F2-4C1F-8ED2-B7860187****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '删除项目', + 'description' => '- 删除项目前，请确保已删除该项目中的所有资源：数据集（Dataset），绑定关系（Binding），批处理任务（Batch），触发器（Trigger）等。分别参考：[删除数据集](~~478164~~)，[删除批处理任务](~~479918~~)，[删除触发器](~~479915~~)。'."\n" + ."\n" + .'- 项目删除后，项目所使用的资源都被回收，相关数据全部丢失且不可恢复。', + ], + 'CreateDataset' => [ + 'summary' => '创建一个数据集（Dataset）。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'title' => '数据集名称', + 'description' => '数据集名称，同一个Project下唯一。命名规则如下：'."\n" + .'- 长度为1~128字符。'."\n" + .'- 只能包含英文字母，数字，短划线（-）和下划线（_）。'."\n" + .'- 必须以英文字母和下划线（_）开头。', + 'type' => 'string', + 'required' => true, + 'example' => 'dataset001', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '对数据集的描述', + 'description' => '数据集描述信息。长度为1~256个英文或中文字符，默认值为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板Id', + 'description' => '工作流模板ID。更多信息，请参见[工作流模板与算子](~~466304~~)，默认值为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'Official:ImageManagement', + ], + ], + [ + 'name' => 'DatasetMaxBindCount', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最多帮定数', + 'description' => '每个数据集绑定的最大个数。取值范围为1~10，默认值为10。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'DatasetMaxFileCount', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最多文件数', + 'description' => '每个数据集中文件的最大个数。取值范围为1~100000000，默认值为100000000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000000', + ], + ], + [ + 'name' => 'DatasetMaxEntityCount', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最多实体数', + 'description' => '每个数据集中元数据实体的最大个数。默认值为10000000000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000000000', + ], + ], + [ + 'name' => 'DatasetMaxRelationCount', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最多关系数', + 'description' => '每个数据集中元数据关系的最大个数。默认值为100000000000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000000000', + ], + ], + [ + 'name' => 'DatasetMaxTotalFileSize', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最大文件总大小', + 'description' => '每个数据集中文件总大小的最大值，超过限制后无法再添加索引。默认值为90000000000000000，单位为字节。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '90000000000000000', + ], + ], + [ + 'name' => 'WorkflowParameters', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '无效参数。', + 'type' => 'array', + 'items' => [ + 'description' => '无效参数。', + 'required' => false, + '$ref' => '#/components/schemas/WorkflowParameter', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6D74B3A9-5AC0-49F9-914D-E01589D3****', + ], + 'Dataset' => [ + 'description' => '数据集信息。', + '$ref' => '#/components/schemas/Dataset', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6D74B3A9-5AC0-49F9-914D-E01589D3****\\",\\n \\"Dataset\\": {\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"DatasetMaxBindCount\\": 0,\\n \\"DatasetMaxFileCount\\": 0,\\n \\"DatasetMaxEntityCount\\": 0,\\n \\"DatasetMaxRelationCount\\": 0,\\n \\"DatasetMaxTotalFileSize\\": 0,\\n \\"BindCount\\": 0,\\n \\"FileCount\\": 0,\\n \\"TotalFileSize\\": 0,\\n \\"ClusterType\\": \\"\\",\\n \\"SmartClusterTaskStatus\\": {\\n \\"Status\\": \\"Succeeded\\",\\n \\"LastSucceededTime\\": \\"2024-06-29T14:50:13.011643661+08:00\\",\\n \\"StartTime\\": \\"2024-06-29T14:50:13.011643661+08:00\\"\\n },\\n \\"WorkflowParameters\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '创建数据集', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + .'- 数据集名称在同一个项目中唯一。'."\n" + .'- 创建的数据集个数存在限制，该个数限制可以通过[GetProjcet](~~478155~~)查询。'."\n" + .'- 创建数据集后，您可以通过[IndexFileMeta](~~478166~~)建立文件元信息索引，实现多元化的[数据检索与统计](~~478175~~)和智能管理。', + ], + 'UpdateDataset' => [ + 'summary' => '更新一个数据集（Dataset）的信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集名称', + 'description' => '数据集名称, 获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '描述', + 'description' => '数据集描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板Id', + 'description' => '工作流模板ID。更多信息，请参见[工作流模板与算子](~~466304~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Official:ImageManagement', + ], + ], + [ + 'name' => 'DatasetMaxBindCount', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最多绑定数', + 'description' => '每个数据集绑定的最大个数。取值范围为1~10。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'DatasetMaxFileCount', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最多文件数', + 'description' => '每个数据集中文件的最大个数。取值范围为1~100000000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000000', + ], + ], + [ + 'name' => 'DatasetMaxEntityCount', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最多实体数', + 'description' => '每个数据集中元数据实体（包括数据文件、文件关系、聚类分组等）的最大个数，最大取值为2^63-1。'."\n" + .'>预留参数，使用中并不做实际限制。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000000000', + ], + ], + [ + 'name' => 'DatasetMaxRelationCount', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最多关系数', + 'description' => '每个数据集中元数据关系的最大个数，最大取值为2^63-1。'."\n" + .'>预留参数，使用中并不做实际限制。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000000000', + ], + ], + [ + 'name' => 'DatasetMaxTotalFileSize', + 'in' => 'query', + 'schema' => [ + 'title' => '媒体集最大文件总大小', + 'description' => '每个数据集中文件总大小的最大值，超过限制后无法再添加索引，最大取值为2^63-1，单位为字节。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '90000000000000000', + ], + ], + [ + 'name' => 'WorkflowParameters', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '无效参数。', + 'type' => 'array', + 'items' => [ + 'description' => '无效参数。', + 'required' => false, + '$ref' => '#/components/schemas/WorkflowParameter', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '45234D4A-A3E3-4B23-AACA-8D897514****', + ], + 'Dataset' => [ + 'description' => '数据集。', + '$ref' => '#/components/schemas/Dataset', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"45234D4A-A3E3-4B23-AACA-8D897514****\\",\\n \\"Dataset\\": {\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"DatasetMaxBindCount\\": 0,\\n \\"DatasetMaxFileCount\\": 0,\\n \\"DatasetMaxEntityCount\\": 0,\\n \\"DatasetMaxRelationCount\\": 0,\\n \\"DatasetMaxTotalFileSize\\": 0,\\n \\"BindCount\\": 0,\\n \\"FileCount\\": 0,\\n \\"TotalFileSize\\": 0,\\n \\"ClusterType\\": \\"\\",\\n \\"SmartClusterTaskStatus\\": {\\n \\"Status\\": \\"Succeeded\\",\\n \\"LastSucceededTime\\": \\"2024-06-29T14:50:13.011643661+08:00\\",\\n \\"StartTime\\": \\"2024-06-29T14:50:13.011643661+08:00\\"\\n },\\n \\"WorkflowParameters\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '更新数据集', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + ."\n" + .'- 更新数据集信息时，确保数据集已经创建成功，创建数据集请参考请求参数描述。'."\n" + .'- 更新数据集信息时，只需填充需要更新的字段，未填充的字段不会变更。'."\n" + .'- 数据集更新成功不会立即生效，需要等待至多5分钟的时间。', + ], + 'GetDataset' => [ + 'summary' => '查询一个数据集的信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称, 获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'dataset001', + ], + ], + [ + 'name' => 'WithStatistics', + 'in' => 'query', + 'schema' => [ + 'description' => '是否需要进行文件统计。默认值false，不需要进行文档统计。'."\n" + ."\n" + .'- 需要进行文件统计。返回Dataset结构体中的FileCount和TotalFileSize真实有效。'."\n" + ."\n" + .'- 不需要进行文件统计。返回Dataset结构体中的FileCount和TotalFileSize可能不正确也可能都为0。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6D74B3A9-5AC0-49F9-914D-E01589D3****', + ], + 'Dataset' => [ + 'description' => '数据集。', + '$ref' => '#/components/schemas/Dataset', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6D74B3A9-5AC0-49F9-914D-E01589D3****\\",\\n \\"Dataset\\": {\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"DatasetMaxBindCount\\": 0,\\n \\"DatasetMaxFileCount\\": 0,\\n \\"DatasetMaxEntityCount\\": 0,\\n \\"DatasetMaxRelationCount\\": 0,\\n \\"DatasetMaxTotalFileSize\\": 0,\\n \\"BindCount\\": 0,\\n \\"FileCount\\": 0,\\n \\"TotalFileSize\\": 0,\\n \\"ClusterType\\": \\"\\",\\n \\"SmartClusterTaskStatus\\": {\\n \\"Status\\": \\"Succeeded\\",\\n \\"LastSucceededTime\\": \\"2024-06-29T14:50:13.011643661+08:00\\",\\n \\"StartTime\\": \\"2024-06-29T14:50:13.011643661+08:00\\"\\n },\\n \\"WorkflowParameters\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '查询数据集信息', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + ."\n" + .'- 查询数据集信息支持实时获取文件统计信息，通过参数配置开启，详情请见请求参数一栏。', + ], + 'ListDatasets' => [ + 'summary' => '获取数据集列表，支持通过数据集名称前缀查询列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '返回最大个数', + 'description' => '返回数据集的最大个数，取值范围为0~200。'."\n" + ."\n" + .'不设置此参数或者设置为0时，则默认值为100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '当总结果个数大于MaxResults时，用于翻页的token', + 'description' => '翻页标记。'."\n" + ."\n" + .'当文件总数大于设置的MaxResults时，用于翻页的Token。从NextToken开始按字典序返回文件信息列表。'."\n" + ."\n" + .'> 在一次查询中首次调用此接口时，将此值设置为空。', + 'type' => 'string', + 'required' => false, + 'example' => '12345678:immtest:dataset002', + ], + ], + [ + 'name' => 'Prefix', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称前缀。', + 'type' => 'string', + 'required' => false, + 'example' => 'dataset', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回结构体', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FEEDE356-C928-4A36-951A-6EB5A592****', + ], + 'NextToken' => [ + 'description' => '翻页标记。当任务列表总数大于设置的MaxResults时，用于翻页的Token。符合条件的任务列表未全部返回时，此参数才有值。'."\n" + ."\n" + .'下一次列出任务列表时将此值作为NextToken传入，将后续的任务列表返回。', + 'type' => 'string', + 'example' => '12345678:immtest:dataset002', + ], + 'Datasets' => [ + 'title' => 'Datasets', + 'description' => '数据集信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据集。'."\n" + ."\n" + .'> - ListDatasets接口不支持文件统计功能，返回的 Dataset 结构体中的 FileCount 和TotalFileSize 字段值可能不准确，也可能为0。如需获取准确的文件统计信息，请使用<props="china">[GetDataset-查询数据集信息](https://help.aliyun.com/zh/imm/developer-reference/api-imm-2020-09-30-getdataset)。</props>'."\n" + .'<props="intl">[GetDataset-查询数据集信息](https://www.alibabacloud.com/help/zh/imm/developer-reference/api-imm-2020-09-30-getdataset)。</props>', + '$ref' => '#/components/schemas/Dataset', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEEDE356-C928-4A36-951A-6EB5A592****\\",\\n \\"NextToken\\": \\"12345678:immtest:dataset002\\",\\n \\"Datasets\\": [\\n {\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"DatasetMaxBindCount\\": 0,\\n \\"DatasetMaxFileCount\\": 0,\\n \\"DatasetMaxEntityCount\\": 0,\\n \\"DatasetMaxRelationCount\\": 0,\\n \\"DatasetMaxTotalFileSize\\": 0,\\n \\"BindCount\\": 0,\\n \\"FileCount\\": 0,\\n \\"TotalFileSize\\": 0,\\n \\"ClusterType\\": \\"\\",\\n \\"SmartClusterTaskStatus\\": {\\n \\"Status\\": \\"Succeeded\\",\\n \\"LastSucceededTime\\": \\"2024-06-29T14:50:13.011643661+08:00\\",\\n \\"StartTime\\": \\"2024-06-29T14:50:13.011643661+08:00\\"\\n },\\n \\"WorkflowParameters\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '列出数据集', + ], + 'DeleteDataset' => [ + 'summary' => '删除一个数据集（Dataset）。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称，获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'dataset001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EC564B8B-BA5C-4499-B196-D9B9E76E****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC564B8B-BA5C-4499-B196-D9B9E76E****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '删除数据集', + 'description' => '- 删除数据集前，请确保已删除数据集中所有已建立的索引文件，删除索引文件的方法可参见[DeleteFileMeta](~~478172~~)、[BatchDeleteFileMeta](~~478173~~)。'."\n" + .'- 删除[数据集](~~478160~~)前，请确保已解绑数据集和OSS Bucket的绑定关系，解除绑定的方法可参见[DeleteBinding](~~478205~~)。即使设置[DeleteBinding](~~478205~~)的请求参数``Cleanup``为``true``时仍不会删除手动添加的索引文件，此时仍需使用[DeleteFileMeta](~~478172~~)、[BatchDeleteFileMeta](~~478173~~)手动删除索引文件，自动建立与手动建立索引文件的区别可参见[建立元数据索引](~~478166~~)。', + ], + 'IndexFileMeta' => [ + 'summary' => '对输入的文件进行数据处理如标签识别、人脸检测、地点检测等。将提取的文件元信息建立索引，支持用户在一个数据集内多样化的数据检索。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '32774', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称, 获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'File', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '需要索引的文件，格式为JSON。请参考结构体定义。', + 'required' => true, + '$ref' => '#/components/schemas/InputFile', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息，在异步消息通知中会返回，方便您在系统内对消息通知进行关联处理。最大长度为 2048 字节。', + 'type' => 'string', + 'required' => false, + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '消息通知配置，详细内容请点击Notification查看，异步通知消息格式请参见[异步通知消息格式](~~2743997~~)元数据索引一栏。', + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****', + ], + 'EventId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '30F-1D8FxFzDXKJH9YQdve4CjR****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'asynchronous', + 'callback' => 'imm::2020-09-30::GetFileMeta', + 'callbackInterval' => 10000, + 'maxCallbackTimes' => 3, + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6E93D6C9-5AC0-49F9-914D-E02678D3****\\",\\n \\"EventId\\": \\"30F-1D8FxFzDXKJH9YQdve4CjR****\\"\\n}","type":"json"}]', + 'title' => '文件元信息建立索引', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + .'- 文件元信息建立索引数据处理支持列表请参见[工作流模板与算子](~~466304~~)。'."\n" + .'- 文件元信息建立索引有文件总数量和文件总大小限制，请参考[使用限制说明](~~475569~~)中数据集限制部分, 关于数据集创建请参考参数说明。'."\n" + .'- 文件元信息建立索引支持地域列表请参考[使用限制说明](~~475569~~)中各地域支持的功能，数据集与索引部分。'."\n" + .'- 文件元信息建立索引后，您可以通过[简单查询](~~478175~~)进行数据检索，其他检索能力请见[查询与统计](~~2402363~~)，还可以通过[创建人脸聚类](~~478180~~)产生人脸分组，其他聚类能力请见[智能管理](~~2402365~~)。'."\n" + ."\n" + .'> '."\n" + .'> - 该接口为异步操作，在您提交请求后，需要一定时间对您提交的文件进行处理，处理完成后才会将元数据存储到数据集内。该过程视[工作流模板与算子](~~466304~~)不同、文件内容不同，需要数秒到数分钟甚至更久。您可以通过[消息订阅](~~603317~~)能力接收任务完成通知。', + ], + 'BatchIndexFileMeta' => [ + 'summary' => '批量索引文件元信息。对输入的文件进行数据处理如标签识别、人脸检测、地点检测等，并将文件元信息索引到数据集内，支持多样化的数据检索。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '33174', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称, 获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'Files', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'OSS文件列表。以JSON格式的数组表示，最大支持100个。', + 'type' => 'array', + 'items' => [ + 'description' => 'OSS文件的结构体。', + 'required' => false, + '$ref' => '#/components/schemas/InputFile', + ], + 'required' => true, + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息，必须填写 Notification 参数传入 MNS 配置时才能生效，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为 2048 字节。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "id": "test-id",'."\n" + .' "name": "test-name"'."\n" + .'}', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '消息通知配置，详细内容请点击Notification查看，异步通知消息格式请参见[异步通知消息格式](~~2743997~~)元数据索引一栏。', + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8F93E6D9-5AC0-49F9-914D-E02678A3****', + ], + 'EventId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '387-1DAPFFZplUZhuCuhnB6I9H****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'asynchronous', + 'callback' => 'imm::2020-09-30::BatchGetFileMeta', + 'callbackInterval' => 10000, + 'maxCallbackTimes' => 3, + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8F93E6D9-5AC0-49F9-914D-E02678A3****\\",\\n \\"EventId\\": \\"387-1DAPFFZplUZhuCuhnB6I9H****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '批量文件元信息建立索引', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + .'- 数据处理支持列表请参见[工作流定义](~~466304~~)。'."\n" + .'- 索引文件有文件总数量和文件总大小限制，请参考[使用限制说明](~~475569~~)中数据集限制部分, 关于数据集创建请参考参数说明。'."\n" + .'- 索引文件支持地域列表请参考[使用限制说明](~~475569~~)中各地域支持的功能，数据集与索引部分。', + ], + 'UpdateFileMeta' => [ + 'summary' => '更新数据集内已索引的文件的部分元数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '33172', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称，获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'File', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '需要更新元数据的文件及要更新的信息，格式为JSON。', + 'required' => true, + '$ref' => '#/components/schemas/InputFile', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6D53E6C9-5AC0-48F9-825F-D02678E3****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6D53E6C9-5AC0-48F9-825F-D02678E3****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '更新文件元数据', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + .'- 并非所有的元数据都允许您自定义更新。当前您可以更新其CustomLabels、CustomId、Figures人脸信息等字段，具体请参考请求参数一节。', + ], + 'BatchUpdateFileMeta' => [ + 'summary' => '更新批量数据集内已索引的文件的部分元数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '33177', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称，获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'Files', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '需要更新的元数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '需要更新元数据的文件及要更新的信息，格式为JSON。', + 'required' => false, + '$ref' => '#/components/schemas/InputFile', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F5BF215E-3237-0852-B9C6-F233D44A****', + ], + 'Files' => [ + 'description' => '本次更新的文件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文件对象。', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => '文件地址。', + 'type' => 'string', + 'example' => 'oss://examplebucket/example.jpg', + ], + 'Success' => [ + 'description' => '更新是否成功。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + 'Message' => [ + 'description' => '当参数Success返回false时，返回的错误信息。', + 'type' => 'string', + 'example' => '*error.OpError : InvalidArgument | Index KV count exceeded, should be no more than 100.', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F5BF215E-3237-0852-B9C6-F233D44A****\\",\\n \\"Files\\": [\\n {\\n \\"URI\\": \\"oss://examplebucket/example.jpg\\",\\n \\"Success\\": false,\\n \\"Message\\": \\"*error.OpError : InvalidArgument | Index KV count exceeded, should be no more than 100.\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '批量更新文件元信息', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + .'- 并非所有的元数据都允许您自定义更新。当前您可以更新其CustomLabels、CustomId、Figures人脸信息等字段，具体请参考请求参数一节。', + ], + 'GetFileMeta' => [ + 'summary' => '获取数据集内已完成索引的文件的元数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '32848', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称，获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'URI', + 'in' => 'query', + 'schema' => [ + 'description' => '文件的URI，需确保该文件已经**完成索引**。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。'."\n" + ."\n" + .'PDS地址规则为pds://domains/${domain}/drives/${drive}/files/${file}/revisions/${revision}。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'oss://test-bucket/test-object', + ], + ], + [ + 'name' => 'WithFields', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '仅返回特定字段的值，而不是全部已有的元信息字段。可用于降低返回的结构体大小。'."\n" + ."\n" + .'不填或留空则返回所有字段。', + 'type' => 'array', + 'items' => [ + 'description' => '仅返回特定字段的值，而不是全部已有的元信息字段，不填或留空则返回所有字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'Size', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7F84C6D9-5AC0-49F9-914D-F02678E3****', + ], + 'Files' => [ + 'title' => 'File list.', + 'description' => '文件元数据。', + 'type' => 'array', + 'items' => [ + 'description' => '文件元数据的结构体。实际返回的数据可能并不包含该结构体的所有属性，这和您索引该文件时选用的[工作流模板配置](~~466304~~)以及文件本身的内容有关。', + '$ref' => '#/components/schemas/File', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7F84C6D9-5AC0-49F9-914D-F02678E3****\\",\\n \\"Files\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '获取文件元数据', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + ."\n" + .'- 调用该接口前，请确保您已通过绑定方式（[CreateBinding](~~478202~~)）或者主动索引（[IndexFileMeta](~~478166~~)或者[BatchIndexFileMeta](~~478167~~)）方式将文件索引到数据集（Dataset）中。'."\n" + ."\n" + .'- 返回结果仅为示例，根据[工作流模板配置](~~466304~~)不同，获取到的文件元数据信息的类别和包含的内容均有可能与示例不同。如果有疑问，请加入钉钉群进行反馈，钉钉群号请参见[联系我们](~~84454~~)。', + ], + 'BatchGetFileMeta' => [ + 'summary' => '批量获取数据集内已完成索引的文件的元数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '33178', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称，获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'URIs', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '文件的URI列表，最大支持100个。', + 'type' => 'array', + 'items' => [ + 'description' => '文件的URI。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。'."\n" + ."\n" + .'PDS地址规则为pds://domains/${domain}/drives/${drive}/files/${file}/revisions/${revision}。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object', + ], + 'required' => true, + ], + ], + [ + 'name' => 'WithFields', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '需要返回的字段列表，填写后仅返回特定字段的值，而不是全部已有的元信息字段。可用于降低返回的结构体大小。'."\n" + ."\n" + .'不填或留空则返回所有字段。', + 'type' => 'array', + 'items' => [ + 'description' => '字段名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'URI', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7F84C6D9-5AC0-49F9-914D-F02678E3****', + ], + 'Files' => [ + 'description' => '文件元数据。', + 'type' => 'array', + 'items' => [ + 'description' => '文件元数据的结构体。实际返回的数据可能并不包含该结构体的所有属性，这和您索引该文件时选用的[工作流模板配置](~~466304~~)以及文件本身的内容有关。', + '$ref' => '#/components/schemas/File', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7F84C6D9-5AC0-49F9-914D-F02678E3****\\",\\n \\"Files\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '批量获取文件元数据', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + ."\n" + .'- 调用该接口前，请确保您已通过绑定方式（[CreateBinding](~~478202~~)）或者主动索引（[IndexFileMeta](~~478166~~)或者[BatchIndexFileMeta](~~478167~~)）方式将文件索引到数据集（Dataset）中。'."\n" + ."\n" + .'- 返回结果仅为示例，根据[工作流模板配置](~~466304~~)不同，获取到的文件元数据信息的类别和包含的内容均有可能与示例不同。如果有疑问，请加入钉钉群进行反馈，钉钉群号请参见[联系我们](~~84454~~)。', + ], + 'DeleteFileMeta' => [ + 'summary' => '从数据集内删除文件的元信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '33169', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称，获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-datset', + ], + ], + [ + 'name' => 'URI', + 'in' => 'query', + 'schema' => [ + 'description' => '文件的URI。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。'."\n" + ."\n" + .'PDS地址规则为pds://domains/${domain}/drives/${drive}/files/${file}/revisions/${revision}。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-object', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7F82D6C9-5AC0-49F9-914D-F02678F3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7F82D6C9-5AC0-49F9-914D-F02678F3****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '删除文件元信息', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + .'- 无论该文件的元信息是否在数据集内存在，均会返回删除成功。'."\n" + ."\n" + .'> - 删除数据集内的元数据**不会**导致您存储在OSS/PDS上的文件被删除。如您同时需要删除文件本身，请使用OSS/PDS提供的接口进行操作。'."\n" + .'- 删除文件元数据时，对应的人脸聚类分组信息、故事等（如有）会对应发生变化，时空聚类不会发生变化。', + ], + 'BatchDeleteFileMeta' => [ + 'summary' => '批量从数据集内删除文件的元信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '33176', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称，获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'URIs', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'OSS文件列表，最大支持100个。', + 'type' => 'array', + 'items' => [ + 'description' => '文件的URI。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。'."\n" + ."\n" + .'PDS地址规则为pds://domains/${domain}/drives/${drive}/files/${file}/revisions/${revision}。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3A82F6C9-5AC0-38F9-914F-F02623B3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3A82F6C9-5AC0-38F9-914F-F02623B3****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '批量删除文件元信息', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + .'- 无论该文件的元信息是否在数据集内存在，均会返回删除成功。'."\n" + ."\n" + .'> - 删除数据集内的元数据**不会**导致您存储在OSS/PDS上的文件被删除。如您同时需要删除文件本身，请使用OSS/PDS提供的接口进行操作。'."\n" + .'- 删除文件元数据时，对应的人脸聚类分组信息、故事等（如有）会对应发生变化，时空聚类不会发生变化。', + ], + 'SimpleQuery' => [ + 'summary' => '查询和统计数据集内文件，支持逻辑关系表达方式。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '4489', + 'abilityTreeNodes' => [ + 'FEATUREimmDN11M0', + ], + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '标记当前开始读取的位置，置空表示从头开始', + 'description' => '当文件总数大于设置的MaxResults时，用于翻页的token。'."\n" + ."\n" + .'从NextToken开始按字典序返回文件信息列表。'."\n" + ."\n" + .'第一次调用此接口时，设置为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '本次读取的最大数据记录数量', + 'description' => '- 不传Aggregations参数查询文件时，表示返回文件的最大个数，取值范围为0~100。'."\n" + ."\n" + .'- 传Aggregations参数进行聚合统计时，表示返回分组的最大个数，取值范围为0~2000。'."\n" + ."\n" + .'- 不设置此参数或者设置为0时，则默认值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'title' => 'Dataset 名称', + 'description' => '数据集名称，获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'Query', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '简单查询条件。请点击左侧链接查看详情。', + 'required' => false, + '$ref' => '#/components/schemas/SimpleQuery', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方式，默认 DESC', + 'description' => '排序字段列表。请参考[字段和操作符的支持列表](~~2743991~~)。'."\n" + .'> - 多个排序字段可使用半角逗号（,）分隔，例如：Size,Filename。'."\n" + .'> - 最多可设置5个排序字段。'."\n" + .'> - 排序字段顺序即为排序优先级顺序。', + 'type' => 'string', + 'required' => false, + 'example' => 'Size,Filename', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段', + 'description' => '排序字段的排序方式。取值如下：'."\n" + ."\n" + .'- asc：升序'."\n" + ."\n" + .'- desc（默认）：降序'."\n" + .'>- 多个排序方式可使用半角逗号（,）分隔，例如：asc,desc。'."\n" + .'> - 排序方式不可多于排序字段，即参数Order的元素数量需小于等于参数Sort的元素数量。例如Sort取值为Size,Filename时，Order可取值为"asc,desc"。'."\n" + .'> - 排序方式少于排序字段时，未排序的字段默认取值desc。例如Sort取值为Size,Filename，Order取值为asc时，Filename默认排序方式为desc，即降序排列。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc,desc', + ], + ], + [ + 'name' => 'Aggregations', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '聚合字段', + 'description' => '聚合字段信息列表。'."\n" + .'><notice>当您使用聚合查询时，仅返回聚合结果，不再返回匹配到的元信息列表。></notice>', + 'type' => 'array', + 'items' => [ + 'description' => '聚合字段信息的结构体。', + 'type' => 'object', + 'properties' => [ + 'Field' => [ + 'title' => '聚合字段的字段名', + 'description' => '字段名称。关于支持的字段，请参见[字段和操作符的支持列表](~~2743991~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Size', + ], + 'Operation' => [ + 'title' => '聚合字段的聚合操作符', + 'description' => '聚合字段的操作符。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'average' => '平均数', + 'min' => '最小值', + 'max' => '最大值', + 'count' => '计数', + 'distinct' => '去重计数', + 'sum' => '求和', + 'group' => '分组计数，按照分组计数结果从高到低排序', + ], + 'example' => 'sum', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'WithFields', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '仅返回哪些字段', + 'description' => '仅返回特定字段的值，而不是全部已有的元信息字段。可用于降低返回的结构体大小。'."\n" + ."\n" + .'不填或留空则返回所有字段。', + 'type' => 'array', + 'items' => [ + 'description' => '需要返回字段的字段名。支持[File](~~478261~~)中列举支持的字段名。', + 'type' => 'string', + 'required' => false, + 'example' => 'Filename', + ], + 'required' => false, + ], + ], + [ + 'name' => 'WithoutTotalHits', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '是否返回命中记录总数'."\n" + .'- true 不返回TotalHits字段'."\n" + .'- false 返回TotalHits字段', + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'description' => '当文件总数大于设置的MaxResults时，用于翻页的token。'."\n" + ."\n" + .'下一次列出文件信息时以此值为NextToken，将未返回的结果返回。'."\n" + ."\n" + .'当文件未全部返回时，此参数才有值。', + 'type' => 'string', + 'required' => true, + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', + ], + 'RequestId' => [ + 'title' => '本次请求的唯一 Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2C5C1E0F-D8B8-4DA0-8127-EC32C771****', + ], + 'Files' => [ + 'title' => '文件列表', + 'description' => '文件信息列表。仅在请求的Aggregations为空时返回。', + 'type' => 'array', + 'items' => [ + 'description' => '文件信息的结构体。', + '$ref' => '#/components/schemas/File', + ], + ], + 'Aggregations' => [ + 'title' => '聚合字段的字段名', + 'description' => '聚合字段信息列表。仅在请求的Aggregations不为空时返回。', + 'type' => 'array', + 'items' => [ + 'description' => '聚合字段信息结构体。', + 'type' => 'object', + 'properties' => [ + 'Field' => [ + 'title' => '聚合字段名', + 'description' => '聚合字段名称。', + 'type' => 'string', + 'example' => 'Size', + ], + 'Operation' => [ + 'title' => '聚合字段的聚合操作符', + 'description' => '聚合字段的聚合操作符。', + 'type' => 'string', + 'example' => 'sum', + ], + 'Value' => [ + 'description' => '聚合的统计结果。', + 'type' => 'number', + 'format' => 'double', + 'example' => '200', + ], + 'Groups' => [ + 'title' => '分组聚合的结果', + 'description' => '分组聚合的结果列表。仅在请求的Aggregations中存在group类型的Operation时才会返回。', + 'type' => 'array', + 'items' => [ + 'description' => '分组聚合的结果。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'title' => '分组聚合的值', + 'description' => '分组聚合的值。', + 'type' => 'string', + 'example' => '100', + ], + 'Count' => [ + 'title' => '分组聚合的计数', + 'description' => '分组聚合的总个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + 'TotalHits' => [ + 'description' => '命中的记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==\\",\\n \\"RequestId\\": \\"2C5C1E0F-D8B8-4DA0-8127-EC32C771****\\",\\n \\"Files\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ],\\n \\"Aggregations\\": [\\n {\\n \\"Field\\": \\"Size\\",\\n \\"Operation\\": \\"sum\\",\\n \\"Value\\": 200,\\n \\"Groups\\": [\\n {\\n \\"Value\\": \\"100\\",\\n \\"Count\\": 5\\n }\\n ]\\n }\\n ],\\n \\"TotalHits\\": 10\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '简单查询', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + ."\n" + .'- 调用该接口前，请确保您已通过绑定方式（[CreateBinding](~~478202~~)）或者主动索引（[IndexFileMeta](~~478166~~)或者[BatchIndexFileMeta](~~478167~~)）方式将文件索引到数据集（Dataset）中。'."\n" + ."\n" + .'- 返回结果仅为示例，根据[工作流模板配置](~~466304~~)不同，获取到的文件元数据信息的类别和包含的内容均有可能与示例不同。如果有疑问，请加入钉钉群进行反馈，钉钉群号请参见[联系我们](~~84454~~)。'."\n" + ."\n" + .'**使用限制**'."\n" + ."\n" + .'- 每次查询最多返回100个文件信息。'."\n" + ."\n" + .'- 每次查询最多返回2000条聚合统计信息。'."\n" + ."\n" + .'- 子查询条件最大支持设置100个。'."\n" + ."\n" + .'- 子查询嵌套深度最多支持5层。'."\n" + ."\n" + .'**查询条件示例**'."\n" + .'- 如果要搜索JPEG格式的图片且图片尺寸大于1000像素，则Query填写示例如下：'."\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" + .'- 如果要搜索`oss://examplebucket/path/`中所有包含`电视`或`音响`标签的文件且该文件的大小大于10 MB，则Query填写示例如下：'."\n" + ."\n" + .'> 这里`电视`和`音响`是同一个文件的不同标签，在`Labels`字段中以两个独立对象的方式存在，请注意和下一个例子的区别。'."\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": "电视",'."\n" + .' "Operation": "eq"'."\n" + .' },'."\n" + .' {'."\n" + .' "Field": "Labels.LabelName",'."\n" + .' "Value": "音响",'."\n" + .' "Operation": "eq"'."\n" + .' }'."\n" + .' ],'."\n" + .' "Operation": "or"'."\n" + .' }'."\n" + .' ],'."\n" + .' "Operation": "and"'."\n" + .'}'."\n" + .' '."\n" + .'```'."\n" + .'- 如果要排除人脸信息中有一个36岁以上的男性的文件，则Query填写示例如下：'."\n" + ."\n" + .'> 和上一个例子不同的是，这里要求某一个人脸同时满足36岁以上、男性两个条件，这和一张图片中有多个人脸，其中某个是男性，而其中另一个是36岁以上这个需求是不同的。在该请求中，需要使用`nested`查询实现条件在同一个元素内同时满足的限制。'."\n" + ."\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" + ."\n" + .'- 如果要搜索JPEG格式的图片且图片存在自定义标签和系统标签，则Query填写示例如下：'."\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" + ."\n" + .'结合以上搜索条件，您还可以通过聚合操作实现不同数据的统计和分析，例如计算符合搜索条件的所有文件的大小总和、数量、平均值或者最值，统计所有符合搜索条件图片的尺寸分布情况。', + ], + 'SemanticQuery' => [ + 'summary' => '通过输入自然语言，对数据集内的元数据进行基于语义的查询搜索。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '103885', + 'abilityTreeNodes' => [ + 'FEATUREimmDN11M0', + ], + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '标记当前开始读取的位置，置空表示从头开始', + 'description' => '目前不再提供该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '预留，暂不支持', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '本次读取的最大数据记录数量', + 'description' => '本次读取的最大数据记录数量。范围(0,100]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'title' => 'Dataset 名称', + 'description' => '数据集名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'Query', + 'in' => 'query', + 'schema' => [ + 'title' => '需要搜索的内容，使用自然语言描述', + 'description' => '><notice>该参数与 SourceURI 参数必须有一个为非空值。></notice>'."\n" + .'需要进行语义搜索的内容。', + 'type' => 'string', + 'required' => false, + 'example' => '2021年4月杭州的风景', + ], + ], + [ + 'name' => 'WithFields', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '仅返回特定字段的值，而不是全部已有的元信息字段。可用于降低返回的结构体大小。'."\n" + ."\n" + .'不填或留空则返回所有字段。', + 'type' => 'array', + 'items' => [ + 'description' => '仅返回特定字段的值，而不是全部已有的元信息字段。可用于降低返回的结构体大小。'."\n" + ."\n" + .'不填或留空则返回所有字段。', + 'type' => 'string', + 'required' => false, + 'example' => '["URI", "Filename"]', + ], + 'required' => false, + ], + ], + [ + 'name' => 'MediaTypes', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '搜索的媒体类型。如留空则默认值为：'."\n" + ."\n" + .'["image"]', + 'type' => 'array', + 'items' => [ + 'description' => '枚举值，当前仅支持：'."\n" + ."\n" + .'image', + 'type' => 'string', + 'required' => false, + 'example' => '["image"]', + ], + 'required' => false, + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => '><notice>该参数与 Query 参数必须有一个为非空值。该参数目前仅在指定搜索类型为图片且数据集配置了以图搜图相关工作流模板时有效。></notice>'."\n" + .'用于检索的源数据的存储地址，存储地址支持 OSS 的 URI 地址。'."\n" + ."\n" + .'OSS 地址规则为 oss://${Bucket}/${Object}，其中${Bucket}为和当前项目处于同一区域(Region)的 OSS Bucket 名称，${Object}为包含文件扩展名的文件完整路径。'."\n" + ."\n" + .'如您需要配置对应工作流模板，欢迎[联系我们](~~84454~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '本次请求的唯一 Id', + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '2C5C1E0F-D8B8-4DA0-8127-EC32C771****', + ], + 'Files' => [ + 'title' => '文件列表', + 'description' => '文件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文件信息。', + '$ref' => '#/components/schemas/File', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2C5C1E0F-D8B8-4DA0-8127-EC32C771****\\",\\n \\"Files\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '自然语言查询', + '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`内容会同时被理解为图片内包含的内容，从而实现对图片的智能检索。', + ], + 'FuzzyQuery' => [ + 'summary' => '查询已提取的文件元数据（包含文件名、标签、路径、自定义标签等字段），只要文件元数据中有一个字段的值匹配指定字符串，该文件的元数据就会被返回。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '8960', + 'abilityTreeNodes' => [ + 'FEATUREimmDN11M0', + ], + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '标记当前开始读取的位置，置空表示从头开始', + 'description' => '当文件总数大于设置的MaxResults时，用于翻页的Token。'."\n" + ."\n" + .'从NextToken开始按字典序返回文件信息列表。'."\n" + ."\n" + .'第一次调用此接口时，设置为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '本次读取的最大数据记录数量', + 'description' => '返回文件的最大个数，取值范围为0~200。'."\n" + ."\n" + .'不设置此参数或者将此参数设置为0时，默认值为100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'title' => 'Dataset 名称', + 'description' => '数据集名称，获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'Query', + 'in' => 'query', + 'schema' => [ + 'title' => '用于搜索的字符串', + 'description' => '用于查询的字符串。不超过1MB。', + 'type' => 'string', + 'required' => true, + 'example' => '阿里云', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段列表。请参考[字段和操作符的支持列表](~~2743991~~)。'."\n" + ."\n" + .'- 多个排序字段可使用半角逗号（,）分隔，例如`Size,Filename`。'."\n" + ."\n" + .'- 最多可设置5个排序字段。'."\n" + ."\n" + .'- 排序字段顺序即为排序优先级顺序。', + 'type' => 'string', + 'required' => false, + 'example' => 'Size,Filename', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段的排序方式。可取值如下：'."\n" + ."\n" + .'- asc：升序'."\n" + ."\n" + .'- desc（默认）：降序'."\n" + ."\n" + .'> - 多个排序方式可使用半角逗号（,）分隔，例如：asc,desc。'."\n" + .'> - 排序方式不可多于排序字段，即参数Order的元素数量需小于等于参数Sort的元素数量。例如Sort取值为Size,Filename时，Order可取值desc或asc。'."\n" + .'> - 排序方式少于排序字段时，未排序的字段默认取值asc。例如Sort取值为Size,Filename，Order取值为asc时，Filename默认排序方式为asc，即升序排列。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc,desc', + ], + ], + [ + 'name' => 'WithFields', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '仅返回特定字段的值，而不是全部已有的元信息字段。可用于降低返回的结构体大小。'."\n" + ."\n" + .'不填或留空则返回所有字段。', + 'type' => 'array', + 'items' => [ + 'description' => '仅返回特定字段的值，而不是全部已有的元信息字段。可用于降低返回的结构体大小。'."\n" + ."\n" + .'不填或留空则返回所有字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'Filename', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'description' => '当文件总数大于设置的MaxResults时，用于翻页的Token。'."\n" + ."\n" + .'下一次列出文件信息时以此值为NextToken，将未返回的结果返回。'."\n" + ."\n" + .'当文件未全部返回时，此参数才有值。', + 'type' => 'string', + 'required' => true, + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', + ], + 'RequestId' => [ + 'title' => '本次请求的唯一 Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****', + ], + 'Files' => [ + 'description' => '文件信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文件信息。', + '$ref' => '#/components/schemas/File', + ], + ], + 'TotalHits' => [ + 'description' => '命中的记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==\\",\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\",\\n \\"Files\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ],\\n \\"TotalHits\\": 10\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '模糊查询', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + ."\n" + .'- 调用该接口前，请确保您已通过绑定方式（[CreateBinding](~~478202~~)）或者主动索引（[IndexFileMeta](~~478166~~)或者[BatchIndexFileMeta](~~478167~~)）方式将文件索引到数据集（Dataset）中。'."\n" + ."\n" + .'- 返回结果仅为示例，根据[工作流模板配置](~~466304~~)不同，获取到的文件元数据信息的类别和包含的内容均有可能与示例不同。如果有疑问，请加入钉钉群进行反馈，钉钉群号请参见[联系我们](~~84454~~)。'."\n" + ."\n" + .'- 参与搜索的字段请参考[字段和操作符的支持列表](~~2743991~~)。', + ], + 'CreateFigureClusteringTask' => [ + 'summary' => '创建一个人物人脸聚类任务，通过智能算法，可以在您已索引到数据集的图片中，将属于不同人物的人脸进行聚类分组。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '116906', + 'abilityTreeNodes' => [ + 'FEATUREimm3DNGQD', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称，获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'dataset001', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为2048字节。', + 'type' => 'string', + 'required' => false, + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义标签，用于对异步任务进行搜索、过滤。', + 'type' => 'object', + 'required' => false, + 'example' => '{"test": "val1"}', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '消息通知配置，详细内容请单击 Notification 查看，异步通知消息格式请参见[异步通知消息格式](~~2743997~~)。', + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '人脸聚类任务信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'formatconvert-00bec802-073a-4b61-ba3b-39bc****', + ], + 'EventId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\",\\n \\"TaskId\\": \\"formatconvert-00bec802-073a-4b61-ba3b-39bc****\\",\\n \\"EventId\\": \\"0ED-1Bz8z71k5TtsUejT4UJ16****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '创建人物人脸聚类任务', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)。**'."\n" + .'><notice>异步任务不保证时效。></notice>'."\n" + .'- 调用该接口前，请确保您已通过绑定方式（[CreateBinding](~~CreateBinding~~)）或者主动索引（[IndexFileMeta](~~IndexFileMeta~~)或者[BatchIndexFileMeta](~~BatchIndexFileMeta~~)）方式将文件索引到数据集（[CreateDataset](~~CreateDataset~~)）中。'."\n" + ."\n" + .'- 每次调用该接口，会增量对数据集（[CreateDataset](~~CreateDataset~~)）内的文件进行处理。您可以根据新增文件情况，定期调用该接口对新文件进行处理。'."\n" + ."\n" + .'- 聚类完成后，您可以通过[GetFigureCluster](~~GetFigureCluster~~)或者[BatchGetFigureCluster](~~BatchGetFigureCluster~~)接口获取特定的分组信息，也可通过[QueryFigureClusters](~~QueryFigureClusters~~)查询和列出数据集下的分组。'."\n" + ."\n" + .'- 从数据集中删除文件，会导致人脸聚类发生变化。当一个聚类中所有人脸所在的图片都被删除时，该聚类分组就会被删除。'."\n" + ."\n" + .'- 该接口为异步接口，获取任务开始执行后，任务信息只保存7天，超过7天则无法再获取。调用[GetTask](~~GetTask~~)或[ListTasks](~~ListTasks~~)接口获取返回的TaskId，查看任务信息。也可以通过设置[Notification](~~2743997~~)消息通知参数，通过消息通知获取任务信息。', + ], + 'CreateFigureClustersMergingTask' => [ + 'summary' => '将两个或两个以上人物聚类分组合并为一个人物聚类分组', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '117038', + 'abilityTreeNodes' => [ + 'FEATUREimm3DNGQD', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称, 获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'dataset001', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'title' => '源cluster', + 'description' => '源聚类分组ID，From和Froms至少有一个有值，并且不允许同时有值。', + 'type' => 'string', + 'required' => false, + 'example' => 'Cluster-2ab85905-23ba-4632-b2d8-1c21cfe****', + ], + ], + [ + 'name' => 'To', + 'in' => 'query', + 'schema' => [ + 'title' => '目的cluster', + 'description' => '目的聚类分组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'Cluster-4a3a71c1-c092-4788-8826-2f65d17****', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为2048字节。', + 'type' => 'string', + 'required' => false, + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义标签，用于对异步任务进行搜索、过滤。', + 'type' => 'object', + 'required' => false, + 'example' => '{"key":"val"}', + ], + ], + [ + 'name' => 'Froms', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '源聚类分组ID列表，From和Froms至少有一个有值，并且不允许同时有值。长度不超过100。', + 'type' => 'array', + 'items' => [ + 'description' => '单个源聚类分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'Cluster-2ab85905-23ba-4632-b2d8-1c21cfe****'."\n", + ], + 'required' => false, + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '消息通知配置，详细内容请单击Notification查看，异步通知消息格式请参见[异步通知消息格式](~~2743997~~)。', + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FF****', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '92376fbb-171f-4259-913f-705f7ee0****', + ], + 'EventId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16E****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FF****\\",\\n \\"TaskId\\": \\"92376fbb-171f-4259-913f-705f7ee0****\\",\\n \\"EventId\\": \\"0ED-1Bz8z71k5TtsUejT4UJ16E****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '合并人物聚类', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)。**'."\n" + .'- 调用该接口前，请确保您已通过创建人物人脸聚类任务（[CreateFigureClusteringTask](~~478180~~)）将数据集中的所有人脸都进行过聚类。'."\n" + .'- 将无关的分组进行合并，合并后会影响目标分组的特征值，导致创建人物人脸聚类任务对增量数据可能出现分组不准确的情况。'."\n" + .'- 该接口为异步接口，获取任务开始执行后，任务信息只保存7天，超过7天则无法再获取。调用[GetTask](~~478241~~)或[ListTasks](~~478242~~)接口获取返回的`TaskId`，查看任务信息。也可以通过设置[Notification](~~2743997~~)消息通知参数，通过消息通知获取任务信息。', + ], + 'GetFigureCluster' => [ + 'summary' => '获取人脸分组的基本信息，包括创建时间、照片数量、分组封面等信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '103841', + 'abilityTreeNodes' => [ + 'FEATUREimm3DNGQD', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[CreateProject](~~CreateProject~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称，获取方式请参见[CreateDataset](~~CreateDataset~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'dataset001', + ], + ], + [ + 'name' => 'ObjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '聚类分组的对象ID。获取方式请参见[QueryFigureClusters](~~QueryFigureClusters~~)返回的人脸分组信息。', + 'type' => 'string', + 'required' => true, + 'example' => 'Cluster-1f2e1a2c-d5ee-4bc5-84f6-fef94ea****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '5F74C5C9-5AC0-49F9-914D-E01589D3****', + ], + 'FigureCluster' => [ + 'description' => '该聚类分组的具体信息。', + '$ref' => '#/components/schemas/FigureCluster', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5F74C5C9-5AC0-49F9-914D-E01589D3****\\",\\n \\"FigureCluster\\": {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Gender\\": \\"\\",\\n \\"FaceCount\\": 0,\\n \\"ImageCount\\": 0,\\n \\"VideoCount\\": 0,\\n \\"AverageAge\\": 0,\\n \\"MinAge\\": 0,\\n \\"MaxAge\\": 0,\\n \\"Cover\\": {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n },\\n \\"BaseImages\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"CroppingSuggestions\\": [],\\n \\"OCRContents\\": []\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ],\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '获取人物人脸的聚类信息', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)。**'."\n" + ."\n" + .'- 调用该接口前，请确保您已通过创建人脸聚类任务（[CreateFigureClusteringTask](~~CreateFigureClusteringTask~~)）将数据集（[CreateDataset](~~CreateDataset~~)）中所有人脸进行分组。', + ], + 'QueryFigureClusters' => [ + 'summary' => '根据条件查询人物聚类及其信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '117066', + 'abilityTreeNodes' => [ + 'FEATUREimm3DNGQD', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称，获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段', + 'description' => '排序字段。默认为空，表示按照分组ID排序。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ImageCount' => '照片数量', + 'VideoCount' => '视频数量', + 'ProjectName' => '项目名称', + 'DatasetName' => '数据集名称', + 'CreateTime' => '分组创建时间', + 'UpdateTime' => '分组更新时间', + 'Gender' => '性别', + 'FaceCount' => '人脸数量', + 'Name' => '分组名称', + ], + 'example' => 'ImageCount', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '升降序', + 'description' => '排序方式。默认为asc。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => '升序排序', + 'desc' => '降序排序', + ], + 'example' => 'asc', + ], + ], + [ + 'name' => 'CustomLabels', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义标签查询条件。', + 'type' => 'string', + 'required' => false, + 'example' => 'key=value', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '本次读取的最大数据记录数量，取值范围为0~100。'."\n" + .'不设置此参数或者设置为0时，则默认值为100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '不填该参数，或者置为None，表示从头开始。', + 'type' => 'string', + 'required' => false, + 'example' => 'CAESEgoQCg4KCkltYWdlQ291bnQQARgBIr0ECgkABAAAAAAAAAAKrwQDKgIAADFTMzEzMDMyMzMzMjMxMzAzMDMyMzQzNjM3MzczOTMzMzQzYTY5NmQ2ZDJkNjk2ZDYxNjc2NTJkNzQ2NTczNzQyZDY4N2E2NDY1NzYyZDMyMzUzMjM0MzIzOTMzMzczMTJkMzY1NDZhNzk3MzU2Njk3MjM0M2E2OTZkNmQyZDc0NjU3Mzc0MmQ3MzY1NzQyZDYzMzYzNjY0MzY2NjYxMzQyZDM1MzMzODM3MmQzMTMxNjU2NjJkNjI2NTM5MzYyZDM5MzgzMDMzMzk2MjMwMzE2NDYzNjMzMjNhNjY2OTY3NzU3MjY1MmQ2MzZjNzU3Mzc0NjU3MjNhNDM2Yzc1NzM3NDY1NzIyZDYxNjUzOTY0MzQzMzMxNjEyZDM3MzQ2NTY2MmQzNDM5Mzc2MjJkMzg2MjMxMzUyZDM0MzUzOTM1MzYzNzYxMzQ2NDM2MzE2Ni5TMzEzMDMyMzMzMjMxMzAzMDMyMzQzNjM3MzczOTMzMzQzYTY5NmQ2ZDJkNjk2ZDYxNjc2NTJkNzQ2NTczNzQyZDY4N2E2NDY1NzYyZDMyMzUzMjM0MzIzOTMzMzczMTJkMzY1NDZhNzk3MzU2Njk3MjM0M2E2OTZkNmQyZDc0NjU3Mzc0MmQ3MzY1NzQyZDYzMzYzNjY0MzY2NjYxMzQyZDM1MzMzODM3MmQzMTMxNjU2NjJkNjI2NTM5MzYyZDM5MzgzMDMzMzk2MjMwMzE2NDYzNjM*****', + ], + ], + [ + 'name' => 'CreateTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '人脸聚类分组生成的时间范围。', + 'required' => false, + '$ref' => '#/components/schemas/TimeRange', + ], + ], + [ + 'name' => 'UpdateTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '人脸聚类分组更新的时间范围。', + 'required' => false, + '$ref' => '#/components/schemas/TimeRange', + ], + ], + [ + 'name' => 'WithTotalCount', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回当前查询条件下的所有人脸分组的数量。默认为false，表示不返回分组的数量。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FFF****', + ], + 'NextToken' => [ + 'description' => '翻页标记。', + 'type' => 'string', + 'example' => 'CAESEgoQCg4KCkltYWdlQ291bnQQARgBIr0ECgkABAAAAAAAAAAKrwQDKgIAADFTMzEzMDMyMzMzMjMxMzAzMDMyMzQzNjM3MzczOTMzMzQzYTY5NmQ2ZDJkNjk2ZDYxNjc2NTJkNzQ2NTczNzQyZDY4N2E2NDY1NzYyZDMyMzUzMjM0MzIzOTMzMzczMTJkMzY1NDZhNzk3MzU2Njk3MjM0M2E2OTZkNmQyZDc0NjU3Mzc0MmQ3MzY1NzQyZDYzMzYzNjY0MzY2NjYxMzQyZDM1MzMzODM3MmQzMTMxNjU2NjJkNjI2NTM5MzYyZDM5MzgzMDMzMzk2MjMwMzE2NDYzNjMzMjNhNjY2OTY3NzU3MjY1MmQ2MzZjNzU3Mzc0NjU3MjNhNDM2Yzc1NzM3NDY1NzIyZDYxNjUzOTY0MzQzMzMxNjEyZDM3MzQ2NTY2MmQzNDM5Mzc2MjJkMzg2MjMxMzUyZDM0MzUzOTM1MzYzNzYxMzQ2NDM2MzE2Ni5TMzEzMDMyMzMzMjMxMzAzMDMyMzQzNjM3MzczOTMzMzQzYTY5NmQ2ZDJkNjk2ZDYxNjc2NTJkNzQ2NTczNzQyZDY4N2E2NDY1NzYyZDMyMzUzMjM0MzIzOTMzMzczMTJkMzY1NDZhNzk3MzU2Njk3MjM0M2E2OTZkNmQyZDc0NjU3Mzc0MmQ3MzY1NzQyZDYzMzYzNjY0MzY2NjYxMzQyZDM1MzMzODM3MmQzMTMxNjU2NjJkNjI2NTM5MzYyZDM5MzgzMDMzMzk2MjMwMzE2NDYzNjM*****', + ], + 'FigureClusters' => [ + 'description' => '该聚类分组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '该聚类分组具体信息。', + '$ref' => '#/components/schemas/FigureCluster', + ], + ], + 'TotalCount' => [ + 'description' => '当前查询条件下的所有人脸分组数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FFF****\\",\\n \\"NextToken\\": \\"CAESEgoQCg4KCkltYWdlQ291bnQQARgBIr0ECgkABAAAAAAAAAAKrwQDKgIAADFTMzEzMDMyMzMzMjMxMzAzMDMyMzQzNjM3MzczOTMzMzQzYTY5NmQ2ZDJkNjk2ZDYxNjc2NTJkNzQ2NTczNzQyZDY4N2E2NDY1NzYyZDMyMzUzMjM0MzIzOTMzMzczMTJkMzY1NDZhNzk3MzU2Njk3MjM0M2E2OTZkNmQyZDc0NjU3Mzc0MmQ3MzY1NzQyZDYzMzYzNjY0MzY2NjYxMzQyZDM1MzMzODM3MmQzMTMxNjU2NjJkNjI2NTM5MzYyZDM5MzgzMDMzMzk2MjMwMzE2NDYzNjMzMjNhNjY2OTY3NzU3MjY1MmQ2MzZjNzU3Mzc0NjU3MjNhNDM2Yzc1NzM3NDY1NzIyZDYxNjUzOTY0MzQzMzMxNjEyZDM3MzQ2NTY2MmQzNDM5Mzc2MjJkMzg2MjMxMzUyZDM0MzUzOTM1MzYzNzYxMzQ2NDM2MzE2Ni5TMzEzMDMyMzMzMjMxMzAzMDMyMzQzNjM3MzczOTMzMzQzYTY5NmQ2ZDJkNjk2ZDYxNjc2NTJkNzQ2NTczNzQyZDY4N2E2NDY1NzYyZDMyMzUzMjM0MzIzOTMzMzczMTJkMzY1NDZhNzk3MzU2Njk3MjM0M2E2OTZkNmQyZDc0NjU3Mzc0MmQ3MzY1NzQyZDYzMzYzNjY0MzY2NjYxMzQyZDM1MzMzODM3MmQzMTMxNjU2NjJkNjI2NTM5MzYyZDM5MzgzMDMzMzk2MjMwMzE2NDYzNjM*****\\",\\n \\"FigureClusters\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Gender\\": \\"\\",\\n \\"FaceCount\\": 0,\\n \\"ImageCount\\": 0,\\n \\"VideoCount\\": 0,\\n \\"AverageAge\\": 0,\\n \\"MinAge\\": 0,\\n \\"MaxAge\\": 0,\\n \\"Cover\\": {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n },\\n \\"BaseImages\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"CroppingSuggestions\\": [],\\n \\"OCRContents\\": []\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ],\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ],\\n \\"TotalCount\\": 100\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '查询人物聚类', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)。**'."\n" + ."\n" + .'- 调用该接口前，请确保您已通过创建人脸聚类任务（[CreateFigureClusteringTask](~~CreateFigureClusteringTask~~)）将数据集（[CreateDataset](~~CreateDataset~~)）中所有人脸进行分组。', + ], + 'BatchGetFigureCluster' => [ + 'summary' => '批量获取人物聚类及其信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '166908', + 'abilityTreeNodes' => [ + 'FEATUREimm3DNGQD', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'ObjectIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '分组对象ID数组。', + 'type' => 'array', + 'items' => [ + 'description' => '分组对象ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'Cluster-99b1c333-86dc-45da-8c6****', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FFF****', + ], + 'FigureClusters' => [ + 'description' => '该聚类分组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '该聚类分组具体信息。', + '$ref' => '#/components/schemas/FigureCluster', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FFF****\\",\\n \\"FigureClusters\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Gender\\": \\"\\",\\n \\"FaceCount\\": 0,\\n \\"ImageCount\\": 0,\\n \\"VideoCount\\": 0,\\n \\"AverageAge\\": 0,\\n \\"MinAge\\": 0,\\n \\"MaxAge\\": 0,\\n \\"Cover\\": {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n },\\n \\"BaseImages\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"CroppingSuggestions\\": [],\\n \\"OCRContents\\": []\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ],\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量获取人脸聚类', + ], + 'UpdateFigureCluster' => [ + 'summary' => '更新一个人脸聚类分组的信息，可以更新分组的名称、标签等信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '103839', + 'abilityTreeNodes' => [ + 'FEATUREimm3DNGQD', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称，获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'FigureCluster', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '该聚类分组具体信息。', + 'required' => true, + '$ref' => '#/components/schemas/FigureClusterForReq', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '5F74C5C9-5AC0-49F9-914D-E01589D3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5F74C5C9-5AC0-49F9-914D-E01589D3****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '更新人物聚类', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)。**'."\n" + ."\n" + .'- 调用该接口前，请确保您已通过创建人物人脸聚类任务（[CreateFigureClusteringTask](~~478180~~)）将数据集中的所有人脸都进行过聚类。'."\n" + ."\n" + .'- 当前仅支持修改分组的封面、名称、标签信息。'."\n" + ."\n" + .'- 更新完成后，您可以通过[GetFigureCluster](~~478182~~)或者[BatchGetFigureCluster](~~2248450~~)接口获取更新后的分组信息。', + ], + 'SearchImageFigureCluster' => [ + 'summary' => '查询指定图片中所有人脸所在的人物聚类列表，每个人物聚类中包含人脸框，相似度等信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'chargeType' => 'free', + 'abilityTreeCode' => '160046', + 'abilityTreeNodes' => [ + 'FEATUREimm3DNGQD', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称，获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => '图片的OSS地址。'."\n" + ."\n" + .'OSS地址规则为`oss://${Bucket}/${Object}`，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**如无特殊需求，请保持留空即可。**'."\n" + ."\n" + .'链式授权配置，非必填。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C2734912-E6D5-052C-AC67-6A9FD02*****', + ], + 'Clusters' => [ + 'description' => '搜索出的人脸分组数组。', + 'type' => 'array', + 'items' => [ + 'description' => '人脸分组信息。', + 'type' => 'object', + 'properties' => [ + 'Boundary' => [ + 'description' => '人脸框信息。', + '$ref' => '#/components/schemas/Boundary', + ], + 'ClusterId' => [ + 'description' => '和该人脸框中的人脸相似的人脸分组ID。', + 'type' => 'string', + 'example' => 'Cluster-ca730577-06b1-42c7-a25b-8f2c7******', + ], + 'Similarity' => [ + 'description' => '人脸和挑选出的人脸分组的相似度，该值越大则相似度越高，取值范围为0～1。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.87413794', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C2734912-E6D5-052C-AC67-6A9FD02*****\\",\\n \\"Clusters\\": [\\n {\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"ClusterId\\": \\"Cluster-ca730577-06b1-42c7-a25b-8f2c7******\\",\\n \\"Similarity\\": 0.87413794\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '查询图片人脸所属聚类', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~88317~~)。**'."\n" + .'- 调用该接口前，请确保您已通过创建人物人脸聚类任务（[CreateFigureClusteringTask](~~478180~~)）将数据集中的所有人脸都进行过聚类。', + ], + 'CreateFacesSearchingTask' => [ + 'summary' => '从媒体集中搜索与指定图片或人脸ID最相似的前N张图片，并返回相应人脸ID及边界框。返回结果按照相似度降序排列。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '160409', + 'abilityTreeNodes' => [ + 'FEATUREimmQ9NXNO', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称, 获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为2048字节。', + 'type' => 'string', + 'required' => false, + 'example' => '{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"}', + ], + ], + [ + 'name' => 'Sources', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '图片列表。', + 'type' => 'array', + 'items' => [ + 'description' => '图片对象。', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => '图片的OSS地址。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'MaxResult', + 'in' => 'query', + 'schema' => [ + 'description' => '最相似的N个人脸，取值范围为0~100，默认值为5。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '消息通知配置，详细内容请单击Notification查看，异步通知消息格式请参见[异步通知消息格式](~~2743997~~)。', + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B1E79399-05F7-06D8-95FE-EBE17BA*****', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'CreateFacesSearchingTask-00bec802-073a-4b61-ba*****', + ], + 'EventId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B1E79399-05F7-06D8-95FE-EBE17BA*****\\",\\n \\"TaskId\\": \\"CreateFacesSearchingTask-00bec802-073a-4b61-ba*****\\",\\n \\"EventId\\": \\"0ED-1Bz8z71k5TtsUejT4UJ16****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '创建相似人脸图片检索任务', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + .'><notice>异步任务不保证时效。></notice>'."\n" + .'- 对于每一个输入的图片，只会选取图片中人脸框范围最大的人脸进行人脸搜索。'."\n" + .'- 该接口为异步接口，获取任务开始执行后，任务信息只保存7天，超过7天则无法再获取。调用[GetTask](~~478241~~)或[ListTasks](~~478242~~)接口获取返回的`TaskId`，查看任务信息。也可以通过设置[Notification](~~2743997~~)消息通知参数，通过消息通知获取任务信息。', + ], + 'CreateLocationDateClusteringTask' => [ + 'summary' => '时空聚类功能。可以将您已索引到数据集内的图片、视频等携带了拍摄时间、拍摄地点信息等文件，按照时间、地理位置进行分类。这些分类可以理解为用户的一次旅行所拍摄的内容（它们时间接近、地点接近），也可以理解为用户在不同生活、工作地的拍摄内容。通过获取、分析这些分类所在地点、所经历的时间范围，可以为用户提供媒体文件归类、精选、生成照片视频故事等能力。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '157768', + 'abilityTreeNodes' => [ + 'FEATUREimmPECUUL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称，获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为2048字节。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-data', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义标签，用于对异步任务进行搜索、过滤。', + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "User": "Jane"'."\n" + .'}', + ], + ], + [ + 'name' => 'DateOptions', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '日期聚类设置。'."\n" + .'><notice>调整该设置对您数据集`Dataset`内已有的时空聚类也会产生影响。></notice>', + 'type' => 'object', + 'properties' => [ + 'GapDays' => [ + 'description' => '单个时空分组中，最大允许间隔的天数，取值范围为0~99999。'."\n" + ."\n" + .'例如，用户3月4-5日和3月7日均有照片，但3月6日未产生照片。但我们推测其3月4-7日均应归属于同一次旅行，则将该字段设置为`1天`，即允许3月6日这类`1天`的间隔前后被归类为同一次时空聚类中。'."\n" + ."\n" + .'推荐设置为0-3。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + 'MinDays' => [ + 'description' => '单个时空分组中，最少包含的天数，取值范围为1~99999。少于该天数的聚类不会被检测和存储。'."\n" + ."\n" + .'例如，不希望产生的分组中包含1日游，则该参数设置为2。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + 'MaxDays' => [ + 'description' => '单个时空分组中，最多包含的天数，取值范围为1~99999。多于该天数的聚类不会被检测和存储。'."\n" + ."\n" + .'例如，用户在某地连续超过15天都产生了照片，则可能该地是定居地，而不是旅行，希望时空聚类中不包括这段时间和地点，则将该参数设置为15。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '15', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'LocationOptions', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '位置聚类设置。'."\n" + .'><notice>调整该设置对您数据集`Dataset`内已有的时空聚类也会产生影响。></notice>', + 'type' => 'object', + 'properties' => [ + 'LocationDateClusterLevels' => [ + 'description' => '分组的行政级别列表。可多选。'."\n" + ."\n" + .'例如用户上传了3月3日-3月5日在杭州的照片，3月6日-3月8日在嘉兴的照片。且该参数填写了`["city", "province"]`，则生成的时空聚类包括：'."\n" + ."\n" + .'- 3月3日-3月5日，杭州'."\n" + .'- 3月6日-3月8日，嘉兴'."\n" + .'- 3月3日-3月8日，浙江', + 'type' => 'array', + 'items' => [ + 'description' => '分组的行政级别。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'country' => '国家或地区', + 'province' => '省', + 'city' => '市', + 'district' => '区', + 'township' => '街道', + ], + 'example' => 'province', + 'enum' => [], + ], + 'required' => true, + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '消息通知配置，详细内容请单击Notification查看，异步通知消息格式请参见[异步通知消息格式](~~2743997~~)。', + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '时空聚类任务信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'B121940C-9794-4EE3-8D6E-F8EC525F****', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'LocationDateClustering-c10dce07-1de7-4da7-abee-1a3aba7****', + ], + 'EventId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '25B-1W2ChgujA3Q8MbBY6mSp2mh****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B121940C-9794-4EE3-8D6E-F8EC525F****\\",\\n \\"TaskId\\": \\"LocationDateClustering-c10dce07-1de7-4da7-abee-1a3aba7****\\",\\n \\"EventId\\": \\"25B-1W2ChgujA3Q8MbBY6mSp2mh****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '创建时空聚类任务', + 'description' => '* **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + .'><notice>异步任务不保证时效。></notice>'."\n" + ."\n" + .'* 调用该接口前，请确保您已通过绑定方式（[CreateBinding](~~478202~~)）或者主动索引（[IndexFileMeta](~~478166~~)或者[BatchIndexFileMeta](~~478167~~)）方式将文件索引到数据集（Dataset）中。'."\n" + .'* 每次调用该接口，会**增量**对数据集`Dataset`内的文件进行处理。您可以根据新增文件情况，定期调用该接口对新文件进行处理。'."\n" + .'* 聚类完成后，您可以通过[QueryLocationDateClusters](~~478189~~)接口获取聚类结果。'."\n" + .'* 从数据集中删除文件，不会导致时空聚类发生变化。如果需要删除已有的时空聚类，需要调用[DeleteLocationDateCluster](~~478191~~)接口。 '."\n" + .'* 该接口为异步接口，获取任务开始执行后，任务信息只保存7天，超过7天则无法再获取。调用[GetTask](~~GetTask~~)或[ListTasks](~~ListTasks~~)接口获取返回的`TaskId`，查看任务信息。也可以通过设置[Notification](~~2743997~~)消息通知参数，通过消息通知获取任务信息。', + ], + 'QueryLocationDateClusters' => [ + 'summary' => '查询时空聚类列表信息，支持多种条件，详情请参考请求参数。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '157769', + 'abilityTreeNodes' => [ + 'FEATUREimmPECUUL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称，获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'ObjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的分组ID。如果您需要获得某个特定时空聚类分组的信息，则传入该参数。否则留空，通过其他参数查询符合匹配条件的分组。', + 'type' => 'string', + 'required' => false, + 'example' => 'location-date-cluster-71dd4f32-9597-4085-a2ab-3a7b0fd0aff9', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => '时空聚类的标题，精确匹配。', + 'type' => 'string', + 'required' => false, + 'example' => '杭州', + ], + ], + [ + 'name' => 'Address', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '地址信息。', + 'required' => false, + '$ref' => '#/components/schemas/Address', + ], + ], + [ + 'name' => 'LocationDateClusterLevels', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '要查询的时空聚类分组的行政级别。', + 'type' => 'array', + 'items' => [ + 'description' => '分组行政级别。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'country' => '国家或地区', + ' province' => '省', + ' district' => '区', + ' city' => '市', + 'township' => '街道', + ], + 'example' => 'province', + ], + 'required' => false, + ], + ], + [ + 'name' => 'LocationDateClusterStartTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '分组起始时间的范围。', + 'required' => false, + '$ref' => '#/components/schemas/TimeRange', + ], + ], + [ + 'name' => 'LocationDateClusterEndTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '分组结束时间的范围。', + 'required' => false, + '$ref' => '#/components/schemas/TimeRange', + ], + ], + [ + 'name' => 'CreateTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '时空聚类分组生成的时间范围。', + 'required' => false, + '$ref' => '#/components/schemas/TimeRange', + ], + ], + [ + 'name' => 'UpdateTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '时空聚类分组更新的时间范围。', + 'required' => false, + '$ref' => '#/components/schemas/TimeRange', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '翻页标记。', + 'type' => 'string', + 'required' => false, + 'example' => 'MzQNjmY2MzYxNhNjk2ZNjEu****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示数量，取值范围为\\[1,100]，默认值为20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CustomLabels', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义标签查询条件。', + 'type' => 'string', + 'required' => false, + 'example' => 'key=value', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'LocationDateClusterEndTime' => '时空聚类分组的结束时间', + 'CreateTime' => '时空聚类分组的创建时间', + 'UpdateTime' => '时空聚类分组的更新时间', + 'LocationDateClusterStartTime' => '【默认】时空聚类分组的开始时间', + ], + 'example' => 'LocationDateClusterStartTime', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '排序顺序。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => '【默认】升序', + 'desc' => '降序', + ], + 'example' => 'asc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7055FCF7-4D7B-098E-BD4D-DD2932B0****', + ], + 'LocationDateClusters' => [ + 'description' => '时空分组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '时空聚类信息。', + '$ref' => '#/components/schemas/LocationDateCluster', + ], + ], + 'NextToken' => [ + 'description' => '翻页标记。', + 'type' => 'string', + 'example' => 'MzQNjmY2MzYxNhNjk2ZNjEu****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7055FCF7-4D7B-098E-BD4D-DD2932B0****\\",\\n \\"LocationDateClusters\\": [\\n {\\n \\"Title\\": \\"\\",\\n \\"LocationDateClusterLevel\\": \\"\\",\\n \\"LocationDateClusterStartTime\\": \\"\\",\\n \\"LocationDateClusterEndTime\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"NextToken\\": \\"MzQNjmY2MzYxNhNjk2ZNjEu****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '查询时空聚类', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + ."\n" + .'- 调用该接口前，请先通过[CreateLocationDateClusteringTask](~~478188~~)接口进行时空聚类。', + ], + 'UpdateLocationDateCluster' => [ + 'summary' => '更新一个时空聚类的信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '157778', + 'abilityTreeNodes' => [ + 'FEATUREimmPECUUL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称，获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'ObjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要更新的分组的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'location-date-cluster-71dd4f32-9597-4085-a2ab-3a7b0fd0aff9', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => '分组的标题。您可以为该分组设定一个标题，供展示和搜索。最大1024字节。', + 'type' => 'string', + 'required' => false, + 'example' => '杭州一日游', + ], + ], + [ + 'name' => 'CustomId', + 'in' => 'query', + 'schema' => [ + 'description' => '该文件的自定义ID。该文件索引到数据集后，作为该行元数据的属性存储，用于和您的业务系统进行关联、对应。您可以根据业务需求传入该值，例如将某个URI关联到您系统内的某个ID。推荐传入全局唯一的值。最大1024字节。', + 'type' => 'string', + 'required' => false, + 'example' => 'member-id-0001', + ], + ], + [ + 'name' => 'CustomLabels', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '文件自定义标签列表。储存您业务自定义的键名、键值对信息，用于在查询时可以据此为筛选项进行检索。最多100组。', + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "UserScore": "5"'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '52B017A8-FEF5-0A61-BAEE-234A8AD8****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"52B017A8-FEF5-0A61-BAEE-234A8AD8****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '更新时空聚类', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + ."\n" + .'- 调用该接口前，请先通过[CreateLocationDateClusteringTask](~~478188~~)接口进行时空聚类。', + ], + 'DeleteLocationDateCluster' => [ + 'summary' => '删除一个时空聚类。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '158363', + 'abilityTreeNodes' => [ + 'FEATUREimmPECUUL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称，获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'ObjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '需要删除的分组的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'location-date-cluster-71dd4f32-9597-4085-a2ab-3a7b0fd0aff9', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B121940C-9794-4EE3-8D6E-F8EC525F****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B121940C-9794-4EE3-8D6E-F8EC525F****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '删除时空聚类分组', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + ."\n" + .'- 调用该接口前，请先通过[CreateLocationDateClusteringTask](~~478188~~)接口进行时空聚类。'."\n" + ."\n" + .'- 无论删除的时空聚类分组ID是否存在，均会返回删除成功。', + ], + 'CreateStory' => [ + 'summary' => '创建一个故事', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '103261', + 'abilityTreeNodes' => [ + 'FEATUREimmPQ568C', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目名称。获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据集名称。获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'ObjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '故事对象ID。该参数不是必填参数。如果为空，IMM会为生成的故事创建一个ID，该ID是故事的唯一标识符，可用于对该故事的查询、更新等操作。ID也可由用户生成，生成之后通过该参数传入，IMM可记录下用户传入的ID作为该故事的唯一标识。如果传入已存在的ID，则会更新该ID对应的故事。', + 'type' => 'string', + 'required' => false, + 'example' => 'id1', + ], + ], + [ + 'name' => 'StoryType', + 'in' => 'formData', + 'schema' => [ + 'description' => '故事类型，指定需要生成相册故事的类型。具体类型描述和可取值请参见[故事类型和子类型](~~2743998~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'PeopleMemory', + ], + ], + [ + 'name' => 'StorySubType', + 'in' => 'formData', + 'schema' => [ + 'description' => '故事子类型，指定需要生成的相册故事的子类型，具体类型描述和可取值请参见[故事类型和子类型](~~2743998~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Solo', + ], + ], + [ + 'name' => 'StoryStartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '待创建故事的照片集合的开始时间。与StoryEndTime共同组成时间区间，IMM会根据该时间区间来筛选候选照片生成故事。该参数是一个RFC3339时间格式的字符串。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-12-30T16:00:00Z', + ], + ], + [ + 'name' => 'StoryEndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '待创建故事的照片集合的结束时间。与StoryStartTime共同组成时间区间，IMM会根据该时间区间来筛选候选照片生成故事。该参数是一个RFC3339时间格式的字符串。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-12-30T16:00:00Z', + ], + ], + [ + 'name' => 'StoryName', + 'in' => 'formData', + 'schema' => [ + 'description' => '故事名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'name1', + ], + ], + [ + 'name' => 'MinFileCount', + 'in' => 'formData', + 'schema' => [ + 'description' => '生成的故事中包含的照片文件最小个数，实际生成的故事照片数量会在MinFileCount和MaxFileCount之间。该参数取值为大于1的整数，若待生成故事的候选照片集中的可用照片张数小于该参数，则会返回空故事。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MaxFileCount', + 'in' => 'formData', + 'schema' => [ + 'description' => '生成的故事中包含的照片文件最大个数，生成的故事照片数量会在MinFileCount和MaxFileCount之间。该参数取值范围为大于MinFileCount的整数。（为保证故事生成的效果，算法内部会将最大数量限制在1500，当MaxFileCount大于1500时，该参数没有效果）', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'NotifyTopicName', + 'in' => 'formData', + 'schema' => [ + 'description' => '异步反向通知的TopicName。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-topic', + ], + ], + [ + 'name' => 'CustomLabels', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义标签。该标签标记了用户对该故事自定义的信息，可作检索使用。', + 'type' => 'object', + 'required' => false, + 'example' => '{"Bucket": "examplebucket"}', + ], + ], + [ + 'name' => 'CustomId', + 'in' => 'formData', + 'schema' => [ + 'description' => '自定义ID。用户自定义的生成故事的标识（可与ObjectID不相同），可供用户后期对故事进行检索、排序等。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Address', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '待生成故事的地址信息。IMM会根据该参数标识出的地址位置信息，筛选拍摄地符合该地址信息的照片生成故事，该参数在故事类型为旅行故事（TravelMemory）时生效。'."\n" + ."\n" + .'> 根据相关规定，无法在中国香港、中国澳门、中国台湾及海外提供将中国内地的GPS信息解析为地址的能力。'."\n" + .'>', + 'required' => false, + '$ref' => '#/components/schemas/AddressForStory', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '此参数提供一种标签机制，可在以下场景中使用：'."\n" + ."\n" + .'- 设置自定义数据，这些数据会在MNS消息中返回。'."\n" + ."\n" + .'- 作为搜索条件搜索任务。'."\n" + ."\n" + .'- 作为变量在TargetURI中使用。', + 'type' => 'object', + 'required' => false, + 'example' => '{"key":"val"}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为2048字节。', + 'type' => 'string', + 'required' => false, + 'example' => '{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"}', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '消息通知配置，详细内容请单击Notification查看，异步通知消息格式请参见[异步通知消息格式](~~2743997~~)。', + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'CreateStory-4ef6ff43-edf3-4612-9cc4-0c7f9e19****', + ], + 'EventId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '392-1CqzvESGTEeNZ2OWFbRKIM****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\",\\n \\"TaskId\\": \\"CreateStory-4ef6ff43-edf3-4612-9cc4-0c7f9e19****\\",\\n \\"EventId\\": \\"392-1CqzvESGTEeNZ2OWFbRKIM****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '创建故事', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)。**'."\n" + .'- 调用该接口前，请确保您已通过绑定方式（[CreateBinding](~~478202~~)）或者主动索引（[IndexFileMeta](~~478166~~)或者[BatchIndexFileMeta](~~478167~~)）方式将文件索引到数据集（Dataset）中。'."\n" + .'- 该接口为异步接口，任务开始执行后，任务信息只保存7天，超过7天则无法再获取。调用[GetTask](~~478241~~)或者[ListTasks](~~478242~~)接口获取返回的TaskId，查看任务信息。也可以通过设置[Notification](~~2743997~~)消息通知参数，通过消息通知获取任务信息。', + ], + 'QueryStories' => [ + 'summary' => '根据条件查询故事及其信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '102513', + 'abilityTreeNodes' => [ + 'FEATUREimmPQ568C', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称。获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'ObjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '故事对象ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'id1', + ], + ], + [ + 'name' => 'StoryName', + 'in' => 'query', + 'schema' => [ + 'description' => '故事名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'name1', + ], + ], + [ + 'name' => 'StoryType', + 'in' => 'query', + 'schema' => [ + 'description' => '故事类型。可取值请参见[故事类型和子类型](~~2743998~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'TimeMemory', + ], + ], + [ + 'name' => 'StorySubType', + 'in' => 'query', + 'schema' => [ + 'description' => '故事子类型。可取值请参见[故事类型和子类型](~~2743998~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'SeasonHighlights', + ], + ], + [ + 'name' => 'FigureClusterIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '人物聚类的ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '人物聚类的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'Cluster-773d9c7e-3fd4-480c-a24b-30a82****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'CreateTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '创建故事时间范围。', + 'required' => false, + '$ref' => '#/components/schemas/TimeRange', + ], + ], + [ + 'name' => 'StoryStartTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '创建故事照片或视频的开始时间范围。', + 'required' => false, + '$ref' => '#/components/schemas/TimeRange', + ], + ], + [ + 'name' => 'StoryEndTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '创建故事照片或视频的结束时间范围。', + 'required' => false, + '$ref' => '#/components/schemas/TimeRange', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '在查询结果过多需要翻页时使用，标记当前开始读取的位置，置空表示从头开始；翻页读取时，则需传入上次调用该接口返回的NextToken值。', + 'type' => 'string', + 'required' => false, + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '本次读取的最大数据记录数量。取值范围为[1,100]。默认值为100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CustomLabels', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义标签键值对。查询满足此标签对的故事。', + 'type' => 'string', + 'required' => false, + 'example' => 'key=value', + ], + ], + [ + 'name' => 'WithEmptyStories', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回空故事。取值范围如下：'."\n" + ."\n" + .'- true（默认）：返回空故事。'."\n" + ."\n" + .'- false：不返会空故事。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段，取值范围如下：'."\n" + ."\n" + .'- CreateTime：按故事创建时间排序。'."\n" + ."\n" + .'- StoryName：按故事名称排序。'."\n" + ."\n" + .'- StoryStartTime：按故事开始时间排序'."\n" + ."\n" + .'- StoryEndTime：按故事结束时间排序。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTime', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式。取值范围如下：'."\n" + ."\n" + .'- asc：升序。'."\n" + ."\n" + .'- desc：降序。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '2C5C1E0F-D8B8-4DA0-8127-EC32C771****', + ], + 'Stories' => [ + 'description' => '查询的故事列表。', + 'type' => 'array', + 'items' => [ + 'description' => '故事详细信息。', + '$ref' => '#/components/schemas/Story', + ], + ], + 'NextToken' => [ + 'description' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕。', + 'type' => 'string', + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3Qx****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2C5C1E0F-D8B8-4DA0-8127-EC32C771****\\",\\n \\"Stories\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"StoryName\\": \\"\\",\\n \\"StoryType\\": \\"\\",\\n \\"StorySubType\\": \\"\\",\\n \\"StoryStartTime\\": \\"\\",\\n \\"StoryEndTime\\": \\"\\",\\n \\"Files\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ],\\n \\"Cover\\": {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"CroppingSuggestions\\": [],\\n \\"OCRContents\\": []\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n },\\n \\"FigureClusterIds\\": [\\n \\"\\"\\n ],\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3Qx****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '查询故事', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)。**'."\n" + .'- 调用该接口前，请确保您已通过绑定方式（[CreateBinding](~~478202~~)）或者主动索引（[IndexFileMeta](~~478166~~)或者[BatchIndexFileMeta](~~478167~~)）方式将文件索引到数据集（Dataset）中。'."\n" + .'- 调用该接口前，请确保已经使用[创建故事](~~478193~~)或者[创建自定义故事](~~478196~~)接口生成过相册故事。', + ], + 'GetStory' => [ + 'summary' => '获取一个故事的信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '102496', + 'abilityTreeNodes' => [ + 'FEATUREimmPQ568C', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称。获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'ObjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要获取信息的故事对象ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'id1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****', + ], + 'Story' => [ + 'description' => '故事详细信息。', + '$ref' => '#/components/schemas/Story', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\",\\n \\"Story\\": {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"StoryName\\": \\"\\",\\n \\"StoryType\\": \\"\\",\\n \\"StorySubType\\": \\"\\",\\n \\"StoryStartTime\\": \\"\\",\\n \\"StoryEndTime\\": \\"\\",\\n \\"Files\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ],\\n \\"Cover\\": {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"CroppingSuggestions\\": [],\\n \\"OCRContents\\": []\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n },\\n \\"FigureClusterIds\\": [\\n \\"\\"\\n ],\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '获取故事信息', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)。**'."\n" + .'- 调用该接口前，请确保您已通过绑定方式（[CreateBinding](~~478202~~)）或者主动索引（[IndexFileMeta](~~478166~~)或者[BatchIndexFileMeta](~~478167~~)）方式将文件索引到数据集（Dataset）中。'."\n" + .'- 调用该接口前，请确保已经使用[创建故事](~~478193~~)或者[创建自定义故事](~~478196~~)接口生成过相册故事。', + ], + 'CreateCustomizedStory' => [ + 'summary' => '使用选择的图片和视频创建一个故事。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '156038', + 'abilityTreeNodes' => [ + 'FEATUREimmPQ568C', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目名称。获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据集名称。获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'dataset001', + ], + ], + [ + 'name' => 'StoryType', + 'in' => 'formData', + 'schema' => [ + 'description' => '故事类型，指定需要生成相册故事的类型。具体类型描述和可取值请参见[故事类型和子类型](~~2743998~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'PeopleMemory', + ], + ], + [ + 'name' => 'StorySubType', + 'in' => 'formData', + 'schema' => [ + 'description' => '故事子类型，指定需要生成的相册故事的子类型，具体类型描述和可取值请参见[故事类型和子类型](~~2743998~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'Solo', + ], + ], + [ + 'name' => 'StoryName', + 'in' => 'formData', + 'schema' => [ + 'description' => '故事名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'name1', + ], + ], + [ + 'name' => 'Cover', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '故事封面。用户可以指定一个图片作为自定义故事的封面。', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => '故事封面图片的地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-object.jpg', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'Files', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义故事的文件列表，每个自定义故事最多支持100个文件。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => '故事文件列表地址。', + '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" + .']', + ], + ], + 'required' => true, + ], + 'required' => true, + ], + ], + [ + 'name' => 'CustomLabels', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义标签。该标签标记了用户对该故事自定义的信息，可作检索使用。', + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "MyStoryLabel": "HolidayStory"'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC91D091-D49F-0ACD-95D5-F0621045****', + ], + 'ObjectId' => [ + 'description' => '对象ID。', + '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' => '创建自定义故事', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)。**'."\n" + .'- 调用该接口前，请确保您已通过绑定方式（[CreateBinding](~~478202~~)）或者主动索引（[IndexFileMeta](~~478166~~)或者[BatchIndexFileMeta](~~478167~~)）方式将文件索引到数据集（Dataset）中。', + ], + 'UpdateStory' => [ + 'summary' => '更新故事信息，例如重命名，修改封面等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '123272', + 'abilityTreeNodes' => [ + 'FEATUREimmPQ568C', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据集名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testdata', + ], + ], + [ + 'name' => 'ObjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '故事ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'StoryName', + 'in' => 'formData', + 'schema' => [ + 'description' => '故事名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'newstory', + ], + ], + [ + 'name' => 'Cover', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '封面图片。', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => '图片文件的存储位置。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'CustomLabels', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义标签，最多支持100个。', + 'type' => 'object', + 'required' => false, + 'example' => '{"key": "value"}', + ], + ], + [ + 'name' => 'CustomId', + 'in' => 'formData', + 'schema' => [ + 'description' => '自定义ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6E93D6C9-5AC0-49F9-914D-E02678D3****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '更新故事', + ], + 'AddStoryFiles' => [ + 'summary' => '向故事中添加文件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '142648', + 'abilityTreeNodes' => [ + 'FEATUREimmPQ568C', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据集名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'ObjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '故事ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'Files', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '要添加的文件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文件信息。', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => '文件的存储位置。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****', + ], + 'Files' => [ + 'description' => '添加的文件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文件信息。', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => '文件地址。'."\n" + ."\n" + .'地址规则为`oss://{bucketname}/{objectname}`，其中`bucketname`为和当前项目处于同一地域的OSS Bucket名称，`objectname`为包含文件名称的文件路径。', + 'type' => 'string', + 'example' => 'oss://test-bucket/test-object', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'ResourceNotFound', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource %s is not found.', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6E93D6C9-5AC0-49F9-914D-E02678D3****\\",\\n \\"Files\\": [\\n {\\n \\"URI\\": \\"oss://test-bucket/test-object\\",\\n \\"ErrorCode\\": \\"ResourceNotFound\\",\\n \\"ErrorMessage\\": \\"The specified resource %s is not found.\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '添加故事文件', + ], + 'RemoveStoryFiles' => [ + 'summary' => '从故事中删除文件。', + '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' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据集名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testdataset', + ], + ], + [ + 'name' => 'ObjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '故事ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'testid', + ], + ], + [ + 'name' => 'Files', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '需要删除的文件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文件信息。', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => '文件的存储位置。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6E93D6C9-5AC0-49F9-914D-E02678D3****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '从故事中删除文件', + ], + 'DeleteStory' => [ + 'summary' => '删除故事。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '102497', + 'abilityTreeNodes' => [ + 'FEATUREimmPQ568C', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称。获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'ObjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要删除的故事对象ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'id1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '删除故事', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)。**'."\n" + .'- 调用该接口前，请确保您已通过绑定方式（[CreateBinding](~~478202~~)）或者主动索引（[IndexFileMeta](~~478166~~)或者[BatchIndexFileMeta](~~478167~~)）方式将文件索引到数据集（Dataset）中。'."\n" + .'- 调用该接口前，请确保已经使用[创建故事](~~478193~~)或者[创建自定义故事](~~478196~~)接口生成过相册故事。', + ], + 'CreateSimilarImageClusteringTask' => [ + 'summary' => '相似图片聚类功能，可以将您已索引到数据集内的图片按照相似度生成聚类，用于图片去重、选优等场景。例如可以通过该功能筛选相册中连拍的图片。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '161810', + 'abilityTreeNodes' => [ + 'FEATUREimm8BY6HG', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称，获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息，在异步消息通知中会为您返回，方便您系统内对消息通知进行关联处理。最大长度为2048字节。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-data', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义标签，用于对异步任务进行搜索、过滤。', + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "User": "Jane"'."\n" + .'}', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '消息通知配置，详细内容请单击Notification查看，异步通知消息格式请参见[异步通知消息格式](~~2743997~~)。', + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '相似图片聚类任务信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'SimilarImageClustering-48d0a0f3-8459-47f4-b8af-ff49c64****', + ], + 'EventId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '3BF-1UhtFyrua71eOkFlqYq23Co****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\",\\n \\"TaskId\\": \\"SimilarImageClustering-48d0a0f3-8459-47f4-b8af-ff49c64****\\",\\n \\"EventId\\": \\"3BF-1UhtFyrua71eOkFlqYq23Co****\\"\\n}","type":"json"}]', + 'title' => '创建相似图片聚类任务', + 'description' => '* **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + .'><notice>异步任务不保证时效。></notice>'."\n" + .'* 调用该接口前，请确保您已通过绑定方式（[CreateBinding](~~478202~~)）或者主动索引（[IndexFileMeta](~~478166~~)或者[BatchIndexFileMeta](~~478167~~)）方式将文件索引到数据集（Dataset）中。'."\n" + ."\n" + .'* 每次调用该接口，会**增量**对数据集`Dataset`内的文件进行处理。您可以根据新增文件情况，定期调用该接口对新文件进行处理。'."\n" + ."\n" + .'* 聚类完成后，您可以通过[QuerySimilarImageClusters](~~611304~~)接口获取聚类结果。'."\n" + ."\n" + .'* 每组相似图片聚类限制图片数量不低于2张。从数据集（Dataset）中删除文件，会导致相似图片聚类发生变化。当您从数据集（Dataset）中删除图片导致聚类中图片数小于2张时，该聚类会自动删除。'."\n" + ."\n" + .'* 该接口为异步接口，获取任务开始执行后，任务信息只保存7天，超过7天则无法再获取。调用[GetTask](~~478241~~)或[ListTasks](~~478242~~)接口获取返回的`TaskId`，查看任务信息。也可以通过设置[Notification](~~2743997~~)消息通知参数，通过消息通知获取任务信息。', + ], + 'QuerySimilarImageClusters' => [ + 'summary' => '查询相似图片聚类列表信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '161811', + 'abilityTreeNodes' => [ + 'FEATUREimm8BY6HG', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称，获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '翻页标记。'."\n" + ."\n" + .'当文件总数大于设置的MaxResults时，用于翻页的Token。从NextToken开始按字典序返回文件信息列表。'."\n" + ."\n" + .'> 在一次查询中首次调用此接口时，将此值设置为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'CAESEgoQCg4KClVwZGF0ZVRpbWUQARgBIs8ECgkAAJLUwUCAQ****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '返回聚类列表中最大任务数量。取值范围为（0，100 ]，默认值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CustomLabels', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义标签，用于根据标签过滤任务。', + 'type' => 'string', + 'required' => false, + 'example' => '{"key": "val"}', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段，可选值如下：'."\n" + ."\n" + .'- CreateTime：分类的创建时间。'."\n" + ."\n" + .'- UpdateTime：分类的更新时间（默认）。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'UpdateTime', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式。取值范围如下：'."\n" + ."\n" + .'- asc：升序。'."\n" + .'- desc：降序（默认）。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FFF****'."\n", + ], + 'SimilarImageClusters' => [ + 'description' => '相似图片分类列表。', + 'type' => 'array', + 'items' => [ + 'description' => '相似图片分类具体信息。', + '$ref' => '#/components/schemas/SimilarImageCluster', + ], + ], + 'NextToken' => [ + 'description' => '翻页标记。当聚类列表总数大于设置的MaxResults时，用于翻页的Token。符合条件的聚类列表未全部返回时，此参数才有值。'."\n" + ."\n" + .'下一次查询聚类时将此值作为NextToken传入，将后续的聚类列表返回。', + 'type' => 'string', + 'example' => 'CAESEgoQCg4KClVwZGF0ZVRpbWUQARgBIs8ECgkAAJLUwUCAQ****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FFF****\\\\n\\",\\n \\"SimilarImageClusters\\": [\\n {\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Files\\": [\\n {\\n \\"URI\\": \\"\\",\\n \\"ImageScore\\": 0\\n }\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"CAESEgoQCg4KClVwZGF0ZVRpbWUQARgBIs8ECgkAAJLUwUCAQ****\\"\\n}","type":"json"}]', + 'title' => '查询相似图片聚类', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + ."\n" + .'- 调用该接口前，请先通过[CreateSimilarImageClusteringTask](~~611302~~)接口对数据集中的图片进行相似图片聚类。', + ], + 'CreateBinding' => [ + 'summary' => '创建数据集（Dataset）和对象存储（OSS）Bucket的绑定关系，自动同步全量和增量文件并为其索引。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '18909', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称，获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'URI', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集绑定的对象存储（OSS） Bucket URI。'."\n" + ."\n" + .'对象存储（OSS） Bucket URI 的格式为oss://${Bucket}，其中`${Bucket}`为和当前项目处于同一地域的 OSS Bucket 名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5F74C5C9-5AC0-49F9-914D-E01589D3****', + ], + 'Binding' => [ + 'description' => '绑定信息。', + '$ref' => '#/components/schemas/Binding', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5F74C5C9-5AC0-49F9-914D-E01589D3****\\",\\n \\"Binding\\": {\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"State\\": \\"\\",\\n \\"Phase\\": \\"\\",\\n \\"Detail\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"Filters\\": [\\n \\"\\"\\n ],\\n \\"ServiceRole\\": \\"\\",\\n \\"Notification\\": {\\n \\"MNS\\": {\\n \\"TopicName\\": \\"\\"\\n },\\n \\"WithFields\\": [\\n \\"\\"\\n ]\\n },\\n \\"WorkflowParameters\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '创建绑定任务', + 'description' => '**请确保在使用该接口前，已充分了解 IMM 产品的收费方式和[价格](~~2743997~~)。**'."\n" + .'><notice>异步任务不保证时效。></notice>'."\n" + .'在创建绑定关系前，请确保已经创建对应的项目和数据集。'."\n" + ."\n" + .'* [创建项目](~~478153~~)'."\n" + .'* [创建数据集](~~478160~~)'."\n" + ."\n" + .'> 数据绑定将使用创建项目或数据集时所指定的[工作流模板](~~466304~~)对文件进行处理。'."\n" + ."\n\n" + .'绑定关系创建后，智能媒体管理（IMM）会先对对象存储 （OSS） Bucket中的已有数据进行全量扫描，并抽取文件元数据信息进行索引。完成后，继续对 OSS中新增的文件进行准实时的增量追踪扫描、抽取以及索引。通过此方式为文件建立索引后，您可以使用文件查询API（例如[SimpleQuery](~~478175~~)）对文件进行查询、管理和统计。', + ], + 'GetBinding' => [ + 'summary' => '查询指定的数据集和对象存储（OSS）Bucket绑定关系详情。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '33029', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称，获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'URI', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集绑定的对象存储（OSS） Bucket URI。'."\n" + ."\n" + .'对象存储（OSS） Bucket URI 的格式为oss://${Bucket}，其中`${Bucket}`为和当前项目处于同一地域的 OSS Bucket 名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'AEFCD467-C928-4A36-951A-6EB5A592****', + ], + 'Binding' => [ + 'description' => '绑定关系信息。', + '$ref' => '#/components/schemas/Binding', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AEFCD467-C928-4A36-951A-6EB5A592****\\",\\n \\"Binding\\": {\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"State\\": \\"\\",\\n \\"Phase\\": \\"\\",\\n \\"Detail\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"Filters\\": [\\n \\"\\"\\n ],\\n \\"ServiceRole\\": \\"\\",\\n \\"Notification\\": {\\n \\"MNS\\": {\\n \\"TopicName\\": \\"\\"\\n },\\n \\"WithFields\\": [\\n \\"\\"\\n ]\\n },\\n \\"WorkflowParameters\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '查询绑定关系信息', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)。**'."\n" + .'- 请确保已经通过[CreateBinding](~~478202~~)接口创建对应的绑定关系。', + ], + 'ListBindings' => [ + 'summary' => '查询数据集和对象存储（OSS）Bucket绑定关系列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10879', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称，获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '- 返回绑定关系的最大个数，取值范围为0~200。'."\n" + .'- 不设置此参数或者设置为0时，则默认值为100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '- 当绑定关系总数大于设置的MaxResults时，用于翻页的token。'."\n" + .'- 从NextToken开始按字典序返回绑定关系信息列表。'."\n" + .'- 第一次调用此接口时，设置为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'immtest:dataset001:examplebucket01', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EFDFD356-C928-4A36-951A-6EB5A592****', + ], + 'NextToken' => [ + 'description' => '- 当绑定关系总数大于设置的MaxResults时，用于翻页的token。'."\n" + .'- 下一次列出绑定关系信息时以此值为NextToken，将未返回的结果返回。'."\n" + .'- 当绑定关系未全部返回时，此参数才有值。', + 'type' => 'string', + 'example' => 'immtest:dataset001:examplebucket01', + ], + 'Bindings' => [ + 'description' => '数据集和OSS Bucket绑定关系信息的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据集和OSS Bucket绑定关系信息的结构体。', + '$ref' => '#/components/schemas/Binding', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EFDFD356-C928-4A36-951A-6EB5A592****\\",\\n \\"NextToken\\": \\"immtest:dataset001:examplebucket01\\",\\n \\"Bindings\\": [\\n {\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"State\\": \\"\\",\\n \\"Phase\\": \\"\\",\\n \\"Detail\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"Filters\\": [\\n \\"\\"\\n ],\\n \\"ServiceRole\\": \\"\\",\\n \\"Notification\\": {\\n \\"MNS\\": {\\n \\"TopicName\\": \\"\\"\\n },\\n \\"WithFields\\": [\\n \\"\\"\\n ]\\n },\\n \\"WorkflowParameters\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '查询绑定关系列表', + 'description' => '**请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)。**', + ], + 'DeleteBinding' => [ + 'summary' => '删除数据集和对象存储（OSS）Bucket绑定任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '38133', + 'abilityTreeNodes' => [ + 'FEATUREimmSZD9WY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集名称，获取方式请参见[创建数据集](~~478160~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'URI', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集绑定的对象存储（OSS） Bucket URI。'."\n" + ."\n" + .'对象存储（OSS） Bucket URI 的格式为oss://${Bucket}，其中`${Bucket}`为和当前项目处于同一地域的 OSS Bucket 名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ACDFE467-C817-4B36-951A-6EB5A592****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ACDFE467-C817-4B36-951A-6EB5A592****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '删除绑定任务', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)。**'."\n" + .'- 删除绑定关系会导致OSS Bucket新增的变更不会同步到数据集，请谨慎操作。', + ], + 'AttachOSSBucket' => [ + 'summary' => '将OSS Bucket与IMM Project绑定，可以通过OSS x-oss-process方式使用IMM的数据处理能力。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '135038', + 'abilityTreeNodes' => [ + 'FEATUREimmKH590Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，创建方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'OSSBucket', + 'in' => 'query', + 'schema' => [ + 'description' => '和当前项目处于同一地域(Region)的OSS Bucket名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '绑定的描述信息。长度为1~128个字符，默认值为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-attachment', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5F74C5C9-5AC0-49F9-914D-E01589D3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5F74C5C9-5AC0-49F9-914D-E01589D3****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '绑定对象存储桶', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)。**'."\n" + .'- 该接口是通过OSS x-oss-process方式使用IMM数据处理能力的前置条件，详见[x-oss-process使用指南](~~2391270~~)。'."\n" + .'- 调用该接口前，请确保当前Region已经存在可用的项目（Project），详见[项目管理](~~478152~~)。', + ], + 'DetachOSSBucket' => [ + 'summary' => '解除项目与OSS Bucket的绑定关系。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '135041', + 'abilityTreeNodes' => [ + 'FEATUREimmKH590Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'OSSBucket', + 'in' => 'query', + 'schema' => [ + 'description' => '需要解绑的OSS Bucket名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5F74C5C9-5AC0-49F9-914D-E01589D3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5F74C5C9-5AC0-49F9-914D-E01589D3****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '解绑对象存储桶', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~88317~~)。**'."\n" + .'- 调用该接口前，请确保已经调用[绑定对象存储桶](~~478206~~)将项目和OSS Bucket进行过绑定。', + ], + 'GetOSSBucketAttachment' => [ + 'summary' => '获取同一地域下与指定OSS Bucket绑定的项目的项目名称。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '135040', + 'abilityTreeNodes' => [ + 'FEATUREimmKH590Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'OSSBucket', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS Bucket名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5F74C5C9-5AC0-49F9-914D-E01589D3****', + ], + 'ProjectName' => [ + 'description' => '绑定的项目名称。', + 'type' => 'string', + 'example' => 'immtest', + ], + 'Description' => [ + 'description' => '数据集描述。', + 'type' => 'string', + 'example' => '"数据集"', + ], + 'CreateTime' => [ + 'description' => '数据集的创建时间。', + 'type' => 'string', + 'example' => '""2023-12-19T17:29:34.790931971+08:00"', + ], + 'UpdateTime' => [ + 'description' => '数据集更新时间。', + 'type' => 'string', + 'example' => '"2023-12-19T17:29:34.790931971+08:00"', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5F74C5C9-5AC0-49F9-914D-E01589D3****\\",\\n \\"ProjectName\\": \\"immtest\\",\\n \\"Description\\": \\"\\\\\\"数据集\\\\\\"\\",\\n \\"CreateTime\\": \\"\\\\\\"\\\\\\"2023-12-19T17:29:34.790931971+08:00\\\\\\"\\",\\n \\"UpdateTime\\": \\"\\\\\\"2023-12-19T17:29:34.790931971+08:00\\\\\\"\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '获取对象存储桶绑定信息', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)。**'."\n" + .'- 调用该接口前，请确保已经调用[绑定对象存储桶](~~478206~~)将项目和OSS Bucket进行过绑定。', + ], + 'EncodeBlindWatermark' => [ + 'summary' => '将特定的文本信息嵌入到图片中，而这些信息在视觉观察下是不可见的。由于这些水印在视觉上是隐蔽的，它们不会影响图片的美观性或原始信息的传递，但可以通过 CreateDecodeBlindWatermarkTask 接口提取出来。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '199817', + 'abilityTreeNodes' => [ + 'FEATUREimmSCVT08', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => '图片的OSS URI。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。'."\n" + ."\n" + .'支持图片格式：jpg, png, bmp, tiff, webp'."\n" + ."\n" + .'图片大小限制：长宽最小80px ，最大10000px', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-object.jpg', + ], + ], + [ + 'name' => 'TargetURI', + 'in' => 'query', + 'schema' => [ + 'description' => '输出图片存储的OSS地址。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。'."\n" + ."\n" + .'> '."\n" + .'> - 输出图片格式与输入相同', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/target-object.jpg', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => '作为水印的文字内容，最多256个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '阿里云版权所有', + ], + ], + [ + 'name' => 'StrengthLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '水印添加强度，强度越高，加水印后的图像抵抗攻击性能越强，但引起的失真越明显，默认值为low，可取值为[low, medium, high]。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'high' => 'high', + 'low' => 'low', + 'medium' => 'medium', + ], + 'example' => 'low', + ], + ], + [ + 'name' => 'ImageQuality', + 'in' => 'query', + 'schema' => [ + 'description' => '仅输入图片格式为jpg时生效。'."\n" + ."\n" + .'携带水印信息的输出图片的存储质量，默认值为90，取值范围为70~100。'."\n" + .'质量越高，图片尺寸越大，水印解析质量越高。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '90', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '8E0DD64B-28C6-4653-8FF7-93E4C234BCF0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8E0DD64B-28C6-4653-8FF7-93E4C234BCF0\\"\\n}","type":"json"}]', + 'title' => '添加图片盲水印', + 'description' => '- 请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和价格。'."\n" + ."\n" + .'- 请确保已在智能媒体管理上正确创建了项目（ Project ），创建方式请参见[创建项目](~~478153~~)。'."\n" + ."\n" + .'- 当前仅支持将文字作为盲水印添加到图片中。'."\n" + ."\n" + .'- 输出图片格式与输入图片相同。'."\n" + ."\n" + .'- 当添加盲水印的图片经过一定程度的攻击后，例如压缩、缩放、裁剪、色彩变换等，仍然可以提取出水印内容。'."\n" + ."\n" + .'- 不支持纯黑、纯白的图片，以及分辨率过低（<200px *200px，非严格参数）的图片', + ], + 'CreateDecodeBlindWatermarkTask' => [ + 'summary' => '提取盲水印', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '200063', + 'abilityTreeNodes' => [ + 'FEATUREimmSCVT08', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。'."\n" + .'><notice>项目名称需要与添加盲水印（[EncodeBlindWatermark](~~2743655~~)）时相同，否则无法提取></notice>', + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => '图片的OSS地址。'."\n" + ."\n" + .'OSS地址规则为`oss://<bucket>/<object>`，其中`<bucket>`为和当前项目处于同一地域的OSS Bucket名称，`<object>`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://target/sampleobject.jpg', + ], + ], + [ + 'name' => 'StrengthLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '水印提取等级，用于控制提取精度。等级越高，处理耗时越长，但提取效果越好。可取值如下：'."\n" + .'- low。'."\n" + .'- medium。'."\n" + .'- high。', + 'type' => 'string', + 'required' => false, + 'example' => 'low', + ], + ], + [ + 'name' => 'WatermarkType', + 'in' => 'query', + 'schema' => [ + 'description' => '嵌入的水印类型，可选值：text'."\n" + ."\n" + .'（图片水印类型暂不支持，因此当前只能为text）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'text' => 'text', + ], + 'example' => 'text', + ], + ], + [ + 'name' => 'TargetURI', + 'in' => 'query', + 'schema' => [ + 'description' => '旧版盲水印DecodeBlindWatermark接口中的参数，解析盲水印后图片保存到的 OSS URI。'."\n" + ."\n" + .'OSS地址规则为`oss://<bucket>/<object>`，其中`<bucket>`为和当前项目处于同一地域的OSS Bucket名称，`<object>`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://target/targetobject.jpg', + ], + ], + [ + 'name' => 'ImageQuality', + 'in' => 'query', + 'schema' => [ + 'description' => '旧版盲水印DecodeBlindWatermark接口中的参数，输出图片的质量，默认值为90，取值范围为70~100。'."\n" + ."\n" + .'质量越高，图片尺寸越大，水印解析质量越高', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '90', + ], + ], + [ + 'name' => 'Model', + 'in' => 'query', + 'schema' => [ + 'description' => '旧版盲水印DecodeBlindWatermark接口中的参数，水印算法模型，可选值包括FFT、FFT_FULL、DWT和DWT_IBG，其中默认参数为 FFT。'."\n" + ."\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' => '旧版盲水印DecodeBlindWatermark接口中的参数，添加盲水印前图片的OSS URI。'."\n" + ."\n" + .'当Model参数为DWT和DWT_IBG时无需设置此参数。'."\n" + ."\n" + .'OSS地址规则为`oss://<bucket>/<object>`，其中`<bucket>`为和当前项目处于同一地域的OSS Bucket名称，`<object>`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://imm-test/testcases/watermarktestbefore.jpg', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '消息通知配置，详细内容请单击 Notification 查看，异步通知消息格式请参见[异步通知消息格式](~~2743997~~)。', + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '4A7A2D0E-D8B8-4DA0-8127-EB32C6600ADE', + ], + 'EventId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '27C-1jyAP5qQI7RoI8lFFwvMrWtl0ft', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'DecodeBlindWatermark-78ac8f3b-59e0-45a6-9b67-32168c3f22b9', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4A7A2D0E-D8B8-4DA0-8127-EB32C6600ADE\\",\\n \\"EventId\\": \\"27C-1jyAP5qQI7RoI8lFFwvMrWtl0ft\\",\\n \\"TaskId\\": \\"DecodeBlindWatermark-78ac8f3b-59e0-45a6-9b67-32168c3f22b9\\"\\n}","type":"json"}]', + 'title' => '创建解析盲水印任务', + 'description' => '- 请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和价格。'."\n" + .'><notice>异步任务不保证时效。></notice>'."\n" + .'- 请确保已在智能媒体管理上正确创建了项目（ Project ），创建方式请参见[创建项目](~~478153~~)。'."\n" + ."\n" + .'- 请确保提取盲水印时使用的服务地域、项目与添加盲水印（[EncodeBlindWatermark](~~2743655~~)）时相同，否则无法提取。'."\n" + ."\n" + .'- 当添加盲水印的图片经过一定程度的攻击后，例如压缩、缩放、裁剪、色彩变换等，仍然可以提取出水印内容。'."\n" + ."\n" + .'- 此接口兼容旧版的盲水印功能，部分接口参数为旧版DecodeBlindWatermark接口的参数。'."\n" + ."\n" + .'- 该接口为异步接口，获取任务开始执行后，任务信息只保存 7 天，超过 7 天则无法再获取。调用 [GetTask](~~478241~~) 或 [ListTasks](~~478242~~) 接口获取返回的TaskId，查看任务信息。也可以通过设置 [Notification](~~2743997~~) 消息通知参数，通过消息通知获取任务信息。', + ], + 'GetDecodeBlindWatermarkResult' => [ + 'summary' => '获取解析图片盲水印任务的结果。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'abilityTreeCode' => '204408', + 'abilityTreeNodes' => [ + 'FEATUREimmSCVT08', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'DecodeBlindWatermark' => 'DecodeBlindWatermark', + ], + 'example' => 'DecodeBlindWatermark', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务 ID，获取方式请参见创建提取图片盲水印任务的返回参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'DecodeBlindWatermark-c09b0943-ed79-4983-8dbe-7a882574****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '提取水印结果', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '当次请求的 Request ID。', + 'type' => 'string', + 'example' => '93126E40-0296-4129-95E3-AFAC709372E5', + ], + 'ProjectName' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'example' => 'test-project', + ], + 'EventId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '2C2-1I0EG57VR37J4rQ8oKG6C9*****', + ], + 'Status' => [ + 'description' => '任务运行状态。', + 'type' => 'string', + 'example' => 'Succeeded', + ], + 'Code' => [ + 'description' => '任务错误码。', + 'type' => 'string', + 'example' => 'ResourceNotFound', + ], + 'Message' => [ + 'description' => '任务错误消息。', + 'type' => 'string', + 'example' => 'The specified resource project is not found.', + ], + 'StartTime' => [ + 'description' => '任务开始时间。', + 'type' => 'string', + 'example' => '2024-03-03T09:44:31.029Z', + ], + 'EndTime' => [ + 'description' => '任务结束时间。', + 'type' => 'string', + 'example' => '2024-03-03T09:45:56.87Z', + ], + 'UserData' => [ + 'description' => '用户自定义信息。', + 'type' => 'string', + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + 'TaskType' => [ + 'description' => '任务类型。', + 'type' => 'string', + 'example' => 'DecodeBlindWatermark', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'DecodeBlindWatermark-c09b0943-ed79-4983-8dbe-7a882574****', + ], + 'Content' => [ + 'description' => '水印内容', + 'type' => 'string', + 'example' => '阿里云版权所有', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"93126E40-0296-4129-95E3-AFAC709372E5\\",\\n \\"ProjectName\\": \\"test-project\\",\\n \\"EventId\\": \\"2C2-1I0EG57VR37J4rQ8oKG6C9*****\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"Code\\": \\"ResourceNotFound\\",\\n \\"Message\\": \\"The specified resource project is not found.\\",\\n \\"StartTime\\": \\"2024-03-03T09:44:31.029Z\\",\\n \\"EndTime\\": \\"2024-03-03T09:45:56.87Z\\",\\n \\"UserData\\": \\"{\\\\\\"ID\\\\\\": \\\\\\"user1\\\\\\",\\\\\\"Name\\\\\\": \\\\\\"test-user1\\\\\\",\\\\\\"Avatar\\\\\\": \\\\\\"http://example.com?id=user1\\\\\\"}\\",\\n \\"TaskType\\": \\"DecodeBlindWatermark\\",\\n \\"TaskId\\": \\"DecodeBlindWatermark-c09b0943-ed79-4983-8dbe-7a882574****\\",\\n \\"Content\\": \\"阿里云版权所有\\"\\n}","type":"json"}]', + 'title' => '获取解析盲水印任务结果', + 'description' => '- 在调用该接口前，请确保已在智能媒体管理上正确创建了项目（ Project ），创建方式请参见[创建项目](~~478153~~)。'."\n" + .'- 在调用该接口前，请确认已创建提取图片盲水印任务，并获取该任务的`TaskId`。', + ], + 'DetectImageLabels' => [ + 'summary' => '检测图片中的场景、物体和事件标签信息。场景信息包括：自然景观、生活场景、灾难场景等大类；事件信息包括：才艺、办公、表演、生产等大类；物体信息包括：餐具、电子产品、家具、交通工具等大类。图片标签检测目前支持的标签种类包含三十多个分类、数千个标签。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '82228', + 'abilityTreeNodes' => [ + 'FEATUREimmELX4L2', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'title' => 'SourceURI', + 'description' => '图片的OSS URI。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-object.jpg', + ], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => [ + 'title' => 'Threshold', + 'description' => '标签置信度过滤阈值，返回结果不包含置信度小于该设定阈值的标签。取值范围为0~1。如果不配置，则使用算法内部的默认值。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.7', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**如无特殊需求，请保持留空即可。**'."\n" + ."\n" + .'链式授权配置，非必填。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片检测结果', + 'description' => '图片检测结果。', + 'type' => 'object', + 'properties' => [ + 'Labels' => [ + 'title' => '内容标签列表', + 'description' => '内容标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '内容标签识别结果列表。', + '$ref' => '#/components/schemas/Label', + ], + ], + 'RequestId' => [ + 'title' => '请求唯一ID', + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '91AC8C98-0F36-49D2-8290-742E24DF1F69', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"RequestId\\": \\"91AC8C98-0F36-49D2-8290-742E24DF1F69\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '检测图片中的标签信息', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + .'- 请确保已在智能媒体管理上正确创建了项目（[Project](~~478273~~)），创建方式请参见[创建项目](~~478153~~)。'."\n" + .'- 该接口的功能说明请参看[图片标签检测](~~477179~~)。'."\n" + .'- 该接口支持的输入图片见[图片限制](~~475569~~)。', + ], + 'DetectImageScore' => [ + 'summary' => '以主观美学为准评估图片的视觉质量，同时考虑构图、亮度、对比度、色彩、清晰度等多方面因素的影响。该功能返回一个范围为0-1的图片质量得分，得分越高则表示图片的视觉质量越高。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '129324', + 'abilityTreeNodes' => [ + 'FEATUREimmEAXWFI', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~477051~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => '源图片的OSS地址。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域（Region）的OSS Bucket 名称，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://examplebucket/sampleobject.jpg', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**如无特殊需求，请保持留空即可。**'."\n" + ."\n" + .'链式授权配置，非必填。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '图片质量的评估结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****', + ], + 'ImageScore' => [ + 'description' => '图片的分数。', + 'type' => 'object', + 'properties' => [ + 'OverallQualityScore' => [ + 'description' => '图片视觉质量的综合得分。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6E93D6C9-5AC0-49F9-914D-E02678D3****\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0.6\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '获取图片分数', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~88317~~)。**'."\n" + .'- 调用该接口前，请确保当前Region已经存在可用的项目（[Project](~~478273~~)），详见[项目管理](~~478152~~)。'."\n" + .'- 该功能支持的输入图片详见[图片限制](~~475569~~)。', + ], + 'DetectImageCodes' => [ + 'summary' => '识别指定图像中的条码和二维码。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '142280', + 'abilityTreeNodes' => [ + 'FEATUREimmSL7X1M', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'title' => 'SourceURI', + 'description' => '文件的存储位置。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-object.jpg', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**如无特殊需求，请保持留空即可。**'."\n" + ."\n" + .'链式授权配置，非必填。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片二维码检测结果', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'Codes' => [ + 'title' => '二维码检测结果', + 'description' => '二维码/条码信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '二维码/条码详细信息。', + '$ref' => '#/components/schemas/Codes', + ], + 'required' => true, + 'minItems' => 0, + ], + 'RequestId' => [ + 'title' => '请求唯一ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Codes\\": [\\n {\\n \\"Content\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"RequestId\\": \\"6E93D6C9-5AC0-49F9-914D-E02678D3****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '图片二维码检测', + 'description' => '- 该接口支持的输入图片编码格式见[图片限制](~~475569~~)。', + ], + 'DetectImageFaces' => [ + 'summary' => '检测指定图像中的人脸边界信息、属性信息、质量信息。边界信息（Boundary）包括：顶点Y坐标距离顶端距离（Top）、顶点X坐标距离左端距离（Left）、高度（Height）、宽度（Width）；属性信息包括：年龄（Age）、年龄标准差（AgeSD）、性别（Gender）、心情（Emotion）、是否张口（Mouth）、是否有胡子（Beard）、是否有帽子（Hat）、是否带口罩（Mask）、是否戴眼镜（Glasses）、头部朝向（HeadPose）、人脸吸引力（Attractive）及上述各属性的置信度；质量信息包括：人脸质量分（FaceQuality）、人脸清晰度（Sharpness）。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '129323', + 'abilityTreeNodes' => [ + 'FEATUREimmU4U2B0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => '文件的OSS存储地址。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object.jpg', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**如无特殊需求，请保持留空即可。**'."\n" + ."\n" + .'链式授权配置，非必填。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****', + ], + 'Faces' => [ + 'description' => '图片人脸信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '人脸详细信息。', + '$ref' => '#/components/schemas/Figure', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6E93D6C9-5AC0-49F9-914D-E02678D3****\\",\\n \\"Faces\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '通过AI模型能力检测图片中的人脸以及人脸信息', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + .'- 该接口支持的输入图片编码格式请参见[图片限制](~~475569~~)。', + ], + 'DetectImageCropping' => [ + 'summary' => '通过AI模型能力在给定的目标图片比例下检测出视觉效果较好的裁剪框区域。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '133405', + 'abilityTreeNodes' => [ + 'FEATUREimm1NT5J6', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'title' => 'SourceURI', + 'description' => '图片的OSS地址。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://imm-test/testcases/facetest.jpg', + ], + ], + [ + 'name' => 'AspectRatios', + 'in' => 'query', + 'schema' => [ + 'description' => '裁剪比例列表。最多可设置5个比例，单个裁剪比例要求如下。'."\n" + ."\n" + .'- 比例必须为整数比例，取值范围为（0，20）。'."\n" + ."\n" + .'- 比例范围必须控制在\\[0.5，2]之间。'."\n" + ."\n" + .'- 不填写此参数时，默认按照`["auto"]`处理。'."\n" + ."\n" + .'> 以下情况会出现报错提示：<br>-设置的比例大于5个。<br>-传入的列表为空。<br>-比例不为整数，例如`4.1:3`。<br>-比例范围小于0.5或大于2。', + 'type' => 'string', + 'required' => false, + 'example' => '["1:1"]', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**如无特殊需求，请保持留空即可。**'."\n" + ."\n" + .'链式授权配置，非必填。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片裁剪结果', + 'description' => '图片裁剪结果。', + 'type' => 'object', + 'properties' => [ + 'Croppings' => [ + 'title' => '图片裁剪结果', + 'description' => '图片裁剪数组信息。', + 'type' => 'array', + 'items' => [ + 'description' => '图片的裁剪详细信息。', + '$ref' => '#/components/schemas/CroppingSuggestion', + ], + ], + 'RequestId' => [ + 'title' => '请求唯一ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '91AC8C98-0F36-49D2-8290-742E24D*****', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Croppings\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"RequestId\\": \\"91AC8C98-0F36-49D2-8290-742E24D*****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '通过AI模型能力在给定的目标图片比例下检测出视觉效果较好的裁剪框区域', + ], + 'AddImageMosaic' => [ + 'summary' => '在一张图片的一个或多个特定区域内添加多种形状的马赛克、高斯模糊或纯色块，并将填充后的图片保存到指定的OSS文件对象地址。该功能主要用于隐私保护。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '147967', + 'abilityTreeNodes' => [ + 'FEATUREimmQT4435', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => '源图片的OSS地址。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。'."\n" + ."\n" + .'支持的图片格式：jpg，png，tiff，jp2，bmp。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://examplebucket/sampleobject.jpg', + ], + ], + [ + 'name' => 'TargetURI', + 'in' => 'query', + 'schema' => [ + 'description' => '输出图片存储的OSS地址。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://examplebucket/outputImage.jpg', + ], + ], + [ + 'name' => 'ImageFormat', + 'in' => 'query', + 'schema' => [ + 'description' => '图片保存时的编码格式。可取值为jpg、png、webp，默认与输入图片编码格式相同。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'jpg' => 'jpg', + 'png' => 'png', + 'webp' => 'webp', + ], + 'example' => 'jpg', + ], + ], + [ + 'name' => 'Quality', + 'in' => 'query', + 'schema' => [ + 'description' => '输出图片的压缩质量，仅限jpg和webp图片格式。设置范围为0~100，默认为80。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'Targets', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '处理框及操作类别参数数组。', + 'type' => 'array', + 'items' => [ + 'description' => '处理框及操作类别参数。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '添加的马赛克类型。可取值如下：'."\n" + .'- square：方形的马赛克'."\n" + .'- diamond：菱形的马赛克'."\n" + .'- hexagon：正六边形的马赛克'."\n" + .'- blur：高斯模糊'."\n" + .'- pure：纯色块', + 'type' => 'string', + 'required' => true, + 'example' => 'square', + ], + 'Boundary' => [ + 'description' => '处理框位置信息。', + 'type' => 'object', + 'properties' => [ + 'ReferPos' => [ + 'description' => '处理框在图片上的基准位置。可取值如下：'."\n" + .'- topright：右上方'."\n" + .'- topleft（默认）：左上方'."\n" + .'- bottomright：右下方'."\n" + .'- bottomleft：左下方', + 'type' => 'string', + 'required' => false, + 'example' => 'topleft', + ], + 'X' => [ + 'description' => '处理框相较于基准点的水平偏移，不同取值的含义如下：'."\n" + .'- 取值为大于等于0的整数：表示距离基准位置的横向距离，单位为px。'."\n" + .'- 取值为小数：表示横向距离像素值与图片整体宽度的比值，取值范围为\\[0,1)。', + 'type' => 'number', + 'format' => 'float', + 'required' => true, + 'example' => '0', + ], + 'Y' => [ + 'description' => '处理框相较于基准点的垂直偏移，不同取值的含义如下：'."\n" + .'- 取值为大于等于0的整数：表示距离基准位置的纵向距离，单位为px。'."\n" + .'- 取值为小数：表示纵向距离像素值与图片整体高度的比值，取值范围为\\[0,1)。', + 'type' => 'number', + 'format' => 'float', + 'required' => true, + 'example' => '0', + ], + 'Height' => [ + 'description' => '处理框的高，不同取值的含义如下：'."\n" + .'- 取值为大于等于0的整数：表示处理框高度，单位为px。'."\n" + .'- 取值为小数：表示框纵向长度像素值与图片整体高度的比值，取值范围为\\[0,1)。', + 'type' => 'number', + 'format' => 'float', + 'required' => true, + 'example' => '200', + ], + 'Width' => [ + 'description' => '处理框的宽，不同取值的含义如下：'."\n" + .'- 取值为大于等于0的整数：表示处理框宽度，单位为px。'."\n" + .'- 取值为小数：表示框横向长度像素值与图片整体宽度的比值，取值范围为\\[0,1)。', + 'type' => 'number', + 'format' => 'float', + 'required' => true, + 'example' => '200', + ], + ], + 'required' => true, + ], + 'MosaicRadius' => [ + 'description' => '马赛克小块的半径大小。默认值为5，单位为px。'."\n" + .'> 该参数对于添加高斯模糊与纯色块不生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + 'BlurRadius' => [ + 'description' => '高斯模糊的模糊半径，取值范围为1~50，默认值为3，单位为px。'."\n" + .'> 该参数仅在添加高斯模糊时生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'Sigma' => [ + 'description' => '高斯模糊的标准差，取值必须大于0，默认值为5。'."\n" + ."\n" + .'> 该参数仅在添加高斯模糊时生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + 'Color' => [ + 'description' => '纯色块的颜色，支持`#FFFFFF`形式与预设的`red`、`white`等关键字。默认值为#FFFFFF，即白色。'."\n" + .'> 该参数仅在添加纯色块时生效。', + 'type' => 'string', + 'required' => false, + 'example' => '#FFFFFF', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**如无特殊需求，请保持留空即可。**'."\n" + ."\n" + .'链式授权配置，非必填。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FF*****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FF*****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '添加图片马赛克', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~88317~~)。**'."\n" + .'- 调用该接口前，请确保当前Region已经存在可用的项目（Project），详见[项目管理](~~478152~~)。'."\n" + .'- 该接口支持的输入图片编码格式为jpg与png，单边长不超过30000像素，总像素不超过2.5亿像素。', + ], + 'CreateImageToPDFTask' => [ + 'summary' => '将多张图片转换为单个PDF文件，并保存到指定的OSS文件对象地址', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '147624', + 'abilityTreeNodes' => [ + 'FEATUREimmEPY4NE', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Sources', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '输入图片列表，转换顺序为输入列表URI的顺序。', + 'type' => 'array', + 'items' => [ + 'description' => '输入图片信息。', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => '源图片的OSS地址。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。'."\n" + ."\n" + .'支持的图片格式：jpg、jp2、png、tiff、webp、bmp、svg。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://examplebucket/sampleobject.jpg', + ], + 'Rotate' => [ + 'description' => '图片旋转角度。可取值如下：'."\n" + ."\n" + .'- 0（默认）'."\n" + .'- 90'."\n" + .'- 180'."\n" + .'- 270', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '90', + ], + ], + 'required' => false, + ], + 'required' => true, + 'minItems' => 1, + ], + ], + [ + 'name' => 'TargetURI', + 'in' => 'query', + 'schema' => [ + 'description' => '输出PDF存储的OSS地址。'."\n" + ."\n" + .'OSS地址规则为oss://${bucketname}/${objectname}，其中${bucketname}为和当前项目处于同一地域的OSS Bucket名称，${objectname}为包含文件名称的文件路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://examplebucket/outputDocument.pdf', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为2048字节。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-data', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**如无特殊需求，请保持留空即可。**'."\n" + ."\n" + .'链式授权配置。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义标签，用于对异步任务进行搜索、过滤。', + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "User": "Jane"'."\n" + .'}', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '消息通知配置，详细内容请单击Notification查看，异步通知消息格式请参见[异步通知消息格式](~~2743997~~)。', + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EC564A9A-BA5C-4499-A087-D9B9E76E*****', + ], + 'EventId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16Es*****', + ], + 'TaskId' => [ + 'description' => '任务ID。', + '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' => '创建图片转PDF任务', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~88317~~)。**'."\n" + .'- 调用该接口前，请确保当前Region已经存在可用的项目（Project），详见[项目管理](~~478152~~)。'."\n" + .'- 该接口最大支持输入100张图片。'."\n" + .'- 该接口为异步接口，获取任务开始执行后，任务信息只保存7天，超过7天则无法再获取。调用[GetTask](~~478241~~)或[ListTasks](~~478242~~)接口获取返回的`TaskId`，查看任务信息。也可以通过设置[Notification](~~2743997~~)消息通知参数，通过消息通知获取任务信息。', + ], + 'CreateImageSplicingTask' => [ + 'summary' => '将多张图片按设定的规则拼接成一张图片，并保存到指定的OSS文件对象地址', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '144838', + 'abilityTreeNodes' => [ + 'FEATUREimm4NW8UR', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Sources', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '输入图片列表，拼接顺序为输入列表URI顺序。', + 'type' => 'array', + 'items' => [ + 'description' => '输入图片信息。', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => '源图片的OSS地址。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。'."\n" + ."\n" + .'支持的图片格式：jpg、png。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://examplebucket/sampleobject.jpg', + ], + 'Rotate' => [ + 'description' => '图片旋转角度。可取值如下：'."\n" + ."\n" + .'- 0（默认）'."\n" + .'- 90'."\n" + .'- 180'."\n" + .'- 270', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '90', + ], + ], + 'required' => false, + ], + 'required' => true, + 'minItems' => 1, + ], + ], + [ + 'name' => 'TargetURI', + 'in' => 'query', + 'schema' => [ + 'description' => '输出图片存储的OSS地址。'."\n" + ."\n" + .'OSS地址规则为oss://${bucketname}/${objectname}，其中${bucketname}为和当前项目处于同一地域的OSS Bucket名称，${objectname}为包含文件名称的文件路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://examplebucket/outputImage.jpg', + ], + ], + [ + 'name' => 'ImageFormat', + 'in' => 'query', + 'schema' => [ + 'description' => '输出图片的压缩格式。可取值如下：'."\n" + ."\n" + .'- jpg（默认）'."\n" + .'- png'."\n" + .'- webp', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'jpg' => 'jpg', + 'png' => 'png', + 'webp' => 'webp', + ], + 'example' => 'jpg', + ], + ], + [ + 'name' => 'Quality', + 'in' => 'query', + 'schema' => [ + 'description' => '输出图片压缩质量，仅对jpg和webp图片格式生效。取值范围为0~100，默认值为80。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '图片拼接方法。可取值如下：'."\n" + ."\n" + .'- vertical（默认）：垂直方向拓展，所有被拼接图片需要对齐宽度。'."\n" + .'- horizontal：水平方向拓展，所有被拼接图片需要对齐高度。', + 'type' => 'string', + 'required' => false, + 'example' => 'vertical', + ], + ], + [ + 'name' => 'ScaleType', + 'in' => 'query', + 'schema' => [ + 'description' => '被拼接图片在对齐宽度或高度时的缩放方式。可取值如下：'."\n" + ."\n" + .'- fit（默认）：缩放并不保留黑边（仅等比缩放）。'."\n" + .'- stretch：拉伸以填满。', + 'type' => 'string', + 'required' => false, + 'example' => 'stretch', + ], + ], + [ + 'name' => 'Align', + 'in' => 'query', + 'schema' => [ + 'description' => '被拼接图片宽或高需要对齐的像素值。取值范围为1~4096。'."\n" + ."\n" + .'- 当参数**Direction**取值为`vertical`时，此参数表示对齐宽度的像素值。'."\n" + .'- 当参数**Direction**取值为`horizontal`时，此参数表示对齐高度的像素值。'."\n" + ."\n" + .'> 若不填写此参数（默认），则默认与拼接的第一张图片的宽或高一致。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '192', + ], + ], + [ + 'name' => 'Padding', + 'in' => 'query', + 'schema' => [ + 'description' => '拼接后图片中子图的间隔，默认值为0，单位为px。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Margin', + 'in' => 'query', + 'schema' => [ + 'description' => '拼接后图片的空白边缘，默认值为0，单位为px。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'BackgroundColor', + 'in' => 'query', + 'schema' => [ + 'description' => '参数`Padding`与`Margin`对应区域的填充颜色，支持`#FFFFFF`形式与预设的`red`、`alpha`等关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'red', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为2048字节。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-data', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '链式授权配置。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义标签，用于对异步任务进行搜索、过滤。', + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "User": "Jane"'."\n" + .'}', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '消息通知配置，详细内容请单击Notification查看，异步通知消息格式请参见[异步通知消息格式](~~2743997~~)。', + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '图片拼接结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '94D6F994-E298-037E-8E8B-0090F27*****', + ], + 'EventId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '10C-1R6p7Km0H5Ieg38LKXTIvw*****', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'ImageSplicing-537cc157-7645-444a-a631-c8db4d02*****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"94D6F994-E298-037E-8E8B-0090F27*****\\",\\n \\"EventId\\": \\"10C-1R6p7Km0H5Ieg38LKXTIvw*****\\",\\n \\"TaskId\\": \\"ImageSplicing-537cc157-7645-444a-a631-c8db4d02*****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '创建图片拼接任务', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~88317~~)。**'."\n" + .'- 调用该接口前，请确保当前Region已经存在可用的项目（Project），详见[项目管理](~~478152~~)。'."\n" + .'- 该接口最大支持拼接10张图片，每张图片的单边长不能超过32876像素，总像素不能超过10亿像素。'."\n" + .'- 该接口为异步接口，获取任务开始执行后，任务信息只保存7天，超过7天则无法再获取。调用[GetTask](~~478241~~)或[ListTasks](~~478242~~)接口获取返回的`TaskId`，查看任务信息。也可以通过设置[Notification](~~2743997~~)消息通知参数，通过消息通知获取任务信息。', + ], + 'CompareImageFaces' => [ + 'summary' => '比较两张图片中最大的人脸的相似度。最大的人脸指的是图片经人脸检测后，所有人脸框中面积最大的。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '160091', + 'abilityTreeNodes' => [ + 'FEATUREimmE6F82K', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**如无特殊需求，请保持留空即可。**'."\n" + ."\n" + .'链式授权配置，非必填。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '对比的两张图片地址。', + 'type' => 'object', + 'properties' => [ + 'URI1' => [ + 'description' => '图片的OSS地址。'."\n" + ."\n" + .'地址规则为`oss://<bucket>/<object>`，其中`<bucket>`为和当前项目处于同一地域的OSS Bucket名称，`<object>`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object1', + ], + 'URI2' => [ + 'description' => '图片的OSS地址。'."\n" + ."\n" + .'地址规则为`oss://<bucket>/<object>`，其中`<bucket>`为和当前项目处于同一地域的OSS Bucket名称，`<object>`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object2', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'F73AC982-2B9E-4ECD-AED5-F8331C5******', + ], + 'Similarity' => [ + 'description' => '人脸相似度，该值越大则人脸相似度越高，取值范围为0～1。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8848152756690983', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F73AC982-2B9E-4ECD-AED5-F8331C5******\\",\\n \\"Similarity\\": 0.8848152756690983\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '图片人脸相似度比对', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~88317~~)。**'."\n" + .'- 对于输入的图片，只会选取图片中人脸框范围最大的人脸进行人脸比较。人脸框检测结果与[DetectImageFaces](~~478213~~)一致。', + ], + 'DetectImageBodies' => [ + 'summary' => '检测图片中的人体信息，包含置信度，人体边框等信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '143909', + 'abilityTreeNodes' => [ + 'FEATUREimm0QJK19', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'title' => 'SourceURI', + 'description' => '文件的OSS存储地址。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object.jpg', + ], + ], + [ + 'name' => 'Sensitivity', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '灵敏度。取值范围为0~1，默认值为0.6。灵敏度值越大，检测出的内容越多。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.6', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**如无特殊需求，请保持留空即可。**'."\n" + ."\n" + .'链式授权配置，非必填。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片裁剪结果', + 'description' => '图片检测结果。', + 'type' => 'object', + 'properties' => [ + 'Bodies' => [ + 'title' => '图片裁剪结果', + 'description' => '人体信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '人体详细信息。', + '$ref' => '#/components/schemas/Body', + ], + ], + 'RequestId' => [ + 'title' => '请求唯一ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '501339F9-4B70-0CE2-AB8C-866C********', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Bodies\\": [\\n {\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"RequestId\\": \\"501339F9-4B70-0CE2-AB8C-866C********\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '检测图片中的人体', + 'description' => '- 在调用该接口前，请确保已在智能媒体管理上正确创建了项目（Project），获取方式请参见[创建项目](~~478153~~)。'."\n" + .'- 该接口支持的输入图片编码格式请参见[图片限制](~~475569~~)。', + ], + 'DetectImageCars' => [ + 'summary' => '检测指定图像中的车辆边界信息、车辆属性信息、车牌信息。车辆属性信息包括：车辆颜色（CarColor）、车辆类型（CarType）；车牌信息包括：车牌识别内容（Content）、车牌框信息（Boundary）。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '172472', + 'abilityTreeNodes' => [ + 'FEATUREimmIT7OSY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'title' => 'SourceURI', + 'description' => '文件的OSS存储地址。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-object.jpg', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**如无特殊需求，请保持留空即可。**'."\n" + ."\n" + .'链式授权配置，非必填。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片二维码检测结果', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'Cars' => [ + 'title' => '二维码检测结果', + 'description' => '车辆信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '车辆详细信息。', + '$ref' => '#/components/schemas/Car', + ], + 'required' => true, + 'minItems' => 0, + ], + 'RequestId' => [ + 'title' => '请求唯一ID', + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'A8745209-DD0E-027E-8ABA-085E0C******', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Cars\\": [\\n {\\n \\"LicensePlates\\": [\\n {\\n \\"Content\\": \\"川A0123\\",\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"CarType\\": \\"\\",\\n \\"CarTypeConfidence\\": 0,\\n \\"CarColor\\": \\"\\",\\n \\"CarColorConfidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"RequestId\\": \\"A8745209-DD0E-027E-8ABA-085E0C******\\"\\n}","type":"json"}]', + 'title' => '检测图片中的车辆信息', + 'description' => '- 该接口支持的输入图片编码格式请参见[图片限制](~~475569~~)。', + ], + 'DetectImageTexts' => [ + 'summary' => '图片文本识别，将图片上的文字内容智能识别成为可编辑的文本。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '207351', + 'abilityTreeNodes' => [ + 'FEATUREimmYZZZWM', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'title' => 'SourceURI', + 'description' => '文件的存储位置。'."\n" + ."\n" + .'OSS 地址规则为 oss://${Bucket}/${Object}，其中${Bucket}为和当前项目处于同一区域(Region)的 OSS Bucket 名称，${Object}为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-object.jpg', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**如无特殊需求，请保持留空即可。**'."\n" + ."\n" + .'链式授权配置，非必填。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片二维码检测结果', + 'description' => '图片文本识别结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求唯一ID', + 'description' => '请求唯一ID。', + 'type' => 'string', + 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****', + ], + 'OCRTexts' => [ + 'title' => 'OCR文本全文，由OCRContents拼接而成。', + 'description' => 'OCR文本全文，由OCRContents拼接而成。', + 'type' => 'string', + 'example' => '智能媒体管理。', + ], + 'OCRContents' => [ + 'title' => 'OCR文本片段列表', + 'description' => 'OCR文本片段列表。', + 'type' => 'array', + 'items' => [ + 'description' => '识别出来的图片中的文字块列表，每个元素包含一个文字块的内容、位置等信息。', + '$ref' => '#/components/schemas/OCRContents', + ], + ], + ], + ], + ], + 500 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\",\\n \\"OCRTexts\\": \\"智能媒体管理。\\",\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '图片文本识别', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + .'- 图片大小不超过20M。'."\n" + .'- 图片最短边不小于20px，最长边不超过30,000px。'."\n" + .'- 图片的纵横比小于1:2。'."\n" + .'- 图片文字不建议小于15px*15px（如果小于，则识别率较低）。', + ], + 'CreateMediaConvertTask' => [ + 'summary' => '创建一个异步的媒体转码任务。提供媒体转码、媒体拼接、视频截帧、视频转动图等相关音视频媒体文件处理能力。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '132611', + 'abilityTreeNodes' => [ + 'FEATUREimmCUOMK0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Sources', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '媒体文件列表。若列表元素大于1个则表示开启Concat（拼接）功能，Concat顺序为输入视频文件URI的顺序。', + 'type' => 'array', + 'items' => [ + 'description' => '源媒体文件。', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => 'OSS地址规则为`oss://${Bucket}/${Object}`，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object', + ], + 'StartTime' => [ + 'description' => '媒体转码开始时间，单位为秒。取值范围如下：'."\n" + .'- 0（默认）：从媒体起始时间开始转码。'."\n" + .'- n（大于0）：从媒体起始时间n秒后开始转码。', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0', + ], + 'Duration' => [ + 'description' => '媒体转码时长。单位为秒，默认值为0，表示到视频结束时间。', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0', + ], + 'Subtitles' => [ + 'description' => '添加字幕列表，默认为空。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '字幕信息。', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => 'OSS地址规则为`oss://${Bucket}/${Object}`，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。'."\n" + .'支持的字幕格式为：srt，vtt，mov_text，ass，dvd_sub，pgs。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object'."\n", + ], + 'TimeOffset' => [ + 'description' => '字幕延迟时间，单位为秒，默认为0。', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '10.5', + ], + 'Language' => [ + 'description' => '字幕语言，参考标准为ISO 639-2，默认为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'eng', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Attached' => [ + 'description' => '将当前源媒体文件作为同步播放的音频流或视频流添加到输出媒体文件中，默认值为false。'."\n" + ."\n" + .'> - AlignmentIndex参数指向Source的Attached参数不能为true。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'AlignMode' => [ + 'description' => '添加音视频流的对齐策略，取值范围如下：'."\n" + .'- false（默认）：不对齐。'."\n" + .'- loop：循环音频、视频内容以对齐。'."\n" + .'- pad：通过填充静音帧、黑帧视频对齐。'."\n" + .'> - 仅当Attached参数为true时有效。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + 'DisableVideo' => [ + 'description' => '是否禁用该源媒体文件中的视频，取值范围如下：'."\n" + ."\n" + .'- true：禁用。'."\n" + .'- false（默认）：不禁用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'DisableAudio' => [ + 'description' => '是否禁用该源媒体文件中的音频，取值范围如下：'."\n" + ."\n" + .'- true：禁用。'."\n" + .'- false（默认）：不禁用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Targets', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '媒体处理任务列表，支持配置多任务。', + 'type' => 'array', + 'items' => [ + 'description' => 'Targets数组元素的详细信息。', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => '媒体转码输出文件的OSS地址。'."\n" + ."\n" + .'OSS地址规则为`oss://${Bucket}/${Object}`，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。'."\n" + .'- 当**URI**存在拓展名时转码输出的媒体文件OSS地址均为**URI**，若输出文件为多个会存在覆盖的情况。'."\n" + .'- 当**URI**不存在拓展名时转码输出的媒体文件OSS地址由**URI**、**Container**与**Segment**参数共同决定，例如**URI**为`oss://examplebucket/outputVideo`：'."\n" + .' - 当**Container**为`mp4`，**Segment**为空时，生成媒体文件的OSS地址为`oss://examplebucket/outputVideo.mp4`。'."\n" + .' - 当**Container**为`ts`，**Segment**中**Format**为`hls`时，将产生OSS地址为`oss://examplebucket/outputVideo.m3u8`的m3u8文件以及多个拥有`oss://examplebucket/outputVideo`前缀的ts文件。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-target-object.mp4', + ], + 'Container' => [ + 'description' => '媒体容器类型。可选容器类型如下：'."\n" + .'- 音视频容器：mp4、mkv、mov、asf、avi、mxf、ts、flv'."\n" + .'- 音频容器：mp3、aac、flac、oga、ac3、opus'."\n" + .'><notice>Container与URI参数需要同时设置。若只进行字幕提取，截帧，截雪碧图或媒体转动图，则需要将Container与URI同时设为空值，此时设置的Segment，Video，Audio和Speed等参数无意义。', + 'type' => 'string', + 'required' => false, + 'example' => 'mp4', + ], + 'Speed' => [ + 'description' => '媒体倍速播放设置，取值范围为\\[0.5,1.0]，默认为1.0。'."\n" + .'> 转码后媒体文件与源媒体文件默认播放速度的比值，非倍速转码。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '1.0', + ], + 'Segment' => [ + 'description' => '媒体切片设置，默认不进行切片。', + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'description' => '媒体切片方式。取值范围如下：'."\n" + .'- hls'."\n" + .'- dash', + 'type' => 'string', + 'required' => false, + 'example' => 'hls', + ], + 'Duration' => [ + 'description' => '切片长度。单位为秒。', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '30', + ], + 'StartNumber' => [ + 'description' => '起始序号，仅支持hls，默认为0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + 'required' => false, + ], + 'Video' => [ + 'description' => '视频处理参数配置。'."\n" + .'><notice>当Video为空值时，会将第一路视频流（若存在）直接拷贝到输出文件。', + 'required' => false, + '$ref' => '#/components/schemas/TargetVideo', + ], + 'Audio' => [ + 'description' => '音频处理参数配置。'."\n" + .'><notice>当Audio为空值时，会将第一路音频流（若存在）直接拷贝到输出文件。', + 'required' => false, + '$ref' => '#/components/schemas/TargetAudio', + ], + 'Subtitle' => [ + 'description' => '字幕处理参数配置。'."\n" + .'><notice>当Subtitle为空值时，会将第一路字幕流（若存在）直接拷贝到输出文件。', + 'required' => false, + '$ref' => '#/components/schemas/TargetSubtitle', + ], + 'Image' => [ + 'description' => '截帧，截雪碧图，媒体转动图参数配置。', + 'required' => false, + '$ref' => '#/components/schemas/TargetImage', + ], + 'StripMetadata' => [ + 'description' => '去除媒体文件metadata，如`title`、`album`等，默认为false。', + 'type' => 'boolean', + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为2048字节。', + 'type' => 'string', + 'required' => false, + 'example' => '{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"}', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义标签，用于对异步任务进行搜索、过滤。', + 'type' => 'object', + 'required' => false, + 'example' => '{"test":"val1"}', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**如无特殊需求，请保持留空即可。**'."\n" + ."\n" + .'链式授权配置。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '消息通知配置，详细内容请单击Notification查看，异步通知消息格式请参见[异步通知消息格式](~~2743997~~)。', + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + [ + 'name' => 'AlignmentIndex', + 'in' => 'query', + 'schema' => [ + 'description' => '在进行媒体拼接时，主媒体文件（提供`Video`、`Audio`中默认转码参数，包括分辨率、帧率等）在拼接列表中的序号，默认为0（对齐拼接列表中第一个媒体文件）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6', + ], + 'EventId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16Es****', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'MediaConvert-adb1ee28-c4c9-42a7-9f54-3b8eadcb****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6\\",\\n \\"EventId\\": \\"0ED-1Bz8z71k5TtsUejT4UJ16Es****\\",\\n \\"TaskId\\": \\"MediaConvert-adb1ee28-c4c9-42a7-9f54-3b8eadcb****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '创建媒体转码任务', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~88317~~)。**'."\n" + .'- 调用该接口前，请确保当前Region已经存在可用的项目（Project），详见[项目管理](~~478152~~)。'."\n" + .'><notice>异步任务不保证时效。></notice>'."\n" + .'- 使用该接口进行媒体转码时，默认只处理一路视频/音频/字幕流，同时支持配置处理的视频/音频/字幕流数量。'."\n" + .'- 使用该接口进行媒体拼接时，最大支持的媒体数量为11个，此时配置的转码、截帧等参数将作用于拼接后媒体数据。'."\n" + .'- 该接口为异步接口，获取任务开始执行后，任务信息只保存7天，超过7天则无法再获取。调用[GetTask](~~478241~~)或[ListTasks](~~478242~~)接口获取返回的`TaskId`，查看任务信息。也可以通过设置[Notification](~~2743997~~)消息通知参数，通过消息通知获取任务信息。', + ], + 'DetectMediaMeta' => [ + 'summary' => '获取媒体文件元信息，包括媒体格式信息和媒体流信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '161491', + 'abilityTreeNodes' => [ + 'FEATUREimmGWMCEO', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体文件的OSS地址。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://examplebucket/sampleobject.mp4', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**如无特殊需求，请保持留空即可。**'."\n" + ."\n" + .'链式授权配置，非必填。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2213B1A9-EB3D-4666-84E0-24980BC*****', + ], + 'Language' => [ + 'description' => '视频中使用的语言，参考标准为ISO 639-2。', + 'type' => 'string', + 'example' => 'eng', + ], + 'Title' => [ + 'description' => '媒体文件标题。', + 'type' => 'string', + 'example' => 'test', + ], + 'VideoStreams' => [ + 'description' => '视频流数组。', + 'type' => 'array', + 'items' => [ + 'description' => '视频流信息。', + '$ref' => '#/components/schemas/VideoStream', + ], + ], + 'AudioStreams' => [ + 'description' => '音频流数组。', + 'type' => 'array', + 'items' => [ + 'description' => '音频流信息。', + '$ref' => '#/components/schemas/AudioStream', + ], + ], + 'Subtitles' => [ + 'description' => '字幕流数组。', + 'type' => 'array', + 'items' => [ + 'description' => '字幕流信息。', + '$ref' => '#/components/schemas/SubtitleStream', + ], + ], + 'StreamCount' => [ + 'description' => '媒体流数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'ProgramCount' => [ + 'description' => '节目数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'FormatName' => [ + 'description' => '格式名称。', + 'type' => 'string', + 'example' => 'mov,mp4,m4a,3gp,3g2,mj2', + ], + 'FormatLongName' => [ + 'description' => '格式名称的全称。', + 'type' => 'string', + 'example' => 'QuickTime / MOV', + ], + 'Size' => [ + 'description' => '媒体文件大小，单位为字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '25115517', + ], + 'StartTime' => [ + 'description' => '媒体的起始播放时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.000000', + ], + 'Bitrate' => [ + 'description' => '媒体文件的码率，单位为比特每秒（bit/s）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '13164131', + ], + 'Artist' => [ + 'description' => '艺术家。', + 'type' => 'string', + 'example' => 'unable', + ], + 'AlbumArtist' => [ + 'description' => '演唱者。', + 'type' => 'string', + 'example' => 'unable', + ], + 'Composer' => [ + 'description' => '作曲家。', + 'type' => 'string', + 'example' => 'unable', + ], + 'Performer' => [ + 'description' => '演奏者。', + 'type' => 'string', + 'example' => 'unable', + ], + 'Album' => [ + 'description' => '专辑。', + 'type' => 'string', + 'example' => 'unable', + ], + 'Duration' => [ + 'description' => '视频的总时长，单位为秒（s）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '15.263000', + ], + 'ProduceTime' => [ + 'description' => '视频拍摄时间，参考标准为RFC3339Nano。', + 'type' => 'string', + 'example' => '2022-04-24T02:39:57Z', + ], + 'LatLong' => [ + 'description' => '中心地理坐标点，是一个经纬度值。'."\n" + .'格式为纬度,经度，纬度在前，经度在后，且纬度范围为\\[-90,+90]，经度范围为\\[-180,+180]。例如35.8,-45.91。', + 'type' => 'string', + 'example' => '+120.029003,+30.283095', + ], + 'VideoWidth' => [ + 'description' => '媒体文件中视频画面的宽度，单位为像素（px）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1080', + ], + 'VideoHeight' => [ + 'description' => '媒体文件中视频画面的高度，单位为像素（px）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1920', + ], + 'Addresses' => [ + 'description' => '视频地理位置检测结果。'."\n" + ."\n" + .'只有视频中包含地理位置信息时，此参数才有值。', + 'type' => 'array', + 'items' => [ + 'description' => '位置详细信息。', + '$ref' => '#/components/schemas/Address', + ], + ], + ], + ], + ], + ], + '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' => '获取媒体文件元信息', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~88317~~)。**'."\n" + .'- 调用该接口前，请确保当前Region已经存在可用的项目（Project），详见[项目管理](~~478152~~)。', + ], + 'CreateVideoLabelClassificationTask' => [ + 'summary' => '检测视频内容的场景、物体和事件标签信息。场景信息包括：自然景观、生活场景、灾难场景等大类；事件信息包括：才艺、办公、表演、生产等大类；物体信息包括：餐具、电子产品、家具、交通工具等大类；视频标签检测目前支持的标签种类包含三十多个分类、数千个标签。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '157766', + 'abilityTreeNodes' => [ + 'FEATUREimmQZSDER', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'title' => 'SourceURI', + 'description' => '视频的OSS URI。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://bucket1/object.mp4', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => 'UserData', + 'description' => '用户自定义信息，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为2048字节。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "ID": "testuid",'."\n" + .' "Name": "test-user",'."\n" + .' "Avatar": "http://test.com/testuid"'."\n" + .'}', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义标签，用于对异步任务进行搜索、过滤。', + 'type' => 'object', + 'required' => false, + 'example' => '{"test":"val1"}', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**如无特殊需求，请保持留空即可。**'."\n" + ."\n" + .'链式授权配置，非必填。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '消息通知配置，详细内容请单击Notification查看，异步通知消息格式请参见[异步通知消息格式](~~2743997~~)。', + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片检测结果', + 'description' => '创建视频标签检测任务的响应结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求唯一Id', + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6', + ], + 'EventId' => [ + 'title' => '事件Id', + 'description' => '当次任务的Event ID。可使用[事件总线EventBridge](https://www.aliyun.com/product/aliware/eventbridge)服务查询该ID获取任务信息通知。', + 'type' => 'string', + 'example' => '03F-1Qt1Yn5RZZ0Zh3ZdYlDblv7****', + ], + 'TaskId' => [ + 'title' => '任务唯一ID', + 'description' => '当次任务的Task ID。可使用[GetTask](~~GetTask~~)接口查看任务信息或[GetVideoLabelClassificationResult](~~478224~~)接口获取视频标签检测任务的结果。', + 'type' => 'string', + 'example' => 'VideoLabelClassification-2f157087-91df-4fda-8c3e-232407ec*****', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6\\",\\n \\"EventId\\": \\"03F-1Qt1Yn5RZZ0Zh3ZdYlDblv7****\\",\\n \\"TaskId\\": \\"VideoLabelClassification-2f157087-91df-4fda-8c3e-232407ec*****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '创建视频标签检测任务', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~2747104~~)**。'."\n" + .'- 在调用该接口前，请确保已在智能媒体管理上正确创建了项目，创建方式请参见[创建项目](~~478153~~)。'."\n" + .'><notice>异步任务不保证时效。></notice>'."\n" + .'- 该接口的功能说明参见[视频标签检测](~~477189~~)。'."\n" + .'- 该接口支持MP4、MPEG-TS、MKV、MOV、AVI、FLV、M3U8等多种视频格式。'."\n" + .'- 该接口为异步接口，获取任务开始执行后，任务信息只保存7天，超过7天则无法再获取。调用[GetTask](~~478241~~)或[ListTasks](~~478242~~)接口获取返回的`TaskId`，查看任务信息。也可以通过设置[Notification](~~2743997~~)消息通知参数，通过消息通知获取任务信息。', + ], + 'GetVideoLabelClassificationResult' => [ + 'summary' => '获取视频标签检测任务的结果。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '157767', + 'abilityTreeNodes' => [ + 'FEATUREimmQZSDER', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'title' => 'TaskType', + 'description' => '任务类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'VideoLabelClassification', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => 'TaskId', + 'description' => '任务ID，获取方式请参见[创建视频标签检测任务](~~478223~~)的返回参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'VideoLabelClassification-2f157087-91df-4fda-8c3e-232407ec****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片检测结果', + 'description' => '视频标签检测结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求唯一Id', + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '7F84C6D9-5AC0-49F9-914D-F02678E3****', + ], + 'ProjectName' => [ + 'title' => '项目名称', + 'description' => '项目名称。', + 'type' => 'string', + 'example' => 'immtest', + ], + 'EventId' => [ + 'title' => '事件Id', + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '2F6-1Bz99Xi93EnRpNEyLudILJm****', + ], + 'Status' => [ + 'title' => '任务运行状态', + 'description' => '任务运行状态。', + 'type' => 'string', + 'example' => 'Succeeded', + ], + 'Code' => [ + 'title' => '任务错误码', + 'description' => '任务错误码。', + 'type' => 'string', + 'example' => 'ResourceNotFound', + ], + 'Message' => [ + 'title' => '任务错误消息', + 'description' => '任务错误消息。', + 'type' => 'string', + 'example' => 'The specified resource project is not found.', + ], + 'StartTime' => [ + 'title' => '任务开始时间', + 'description' => '任务开始时间。', + 'type' => 'string', + 'example' => '2021-12-24T03:00:38.892462383Z', + ], + 'EndTime' => [ + 'title' => '任务结束时间', + 'description' => '任务结束时间。', + 'type' => 'string', + 'example' => '2021-12-24T03:00:42.134971294Z', + ], + 'UserData' => [ + 'title' => '用户自定义信息', + 'description' => '用户自定义信息。', + 'type' => 'string', + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => '任务类型。', + 'type' => 'string', + 'example' => 'VideoLabelClassification', + ], + 'TaskId' => [ + 'title' => '任务唯一ID', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'VideoLabelClassification-2f157087-91df-4fda-8c3e-232407ec****', + ], + 'Labels' => [ + 'title' => '标签列表', + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + '$ref' => '#/components/schemas/Label', + ], + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7F84C6D9-5AC0-49F9-914D-F02678E3****\\",\\n \\"ProjectName\\": \\"immtest\\",\\n \\"EventId\\": \\"2F6-1Bz99Xi93EnRpNEyLudILJm****\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"Code\\": \\"ResourceNotFound\\",\\n \\"Message\\": \\"The specified resource project is not found.\\",\\n \\"StartTime\\": \\"2021-12-24T03:00:38.892462383Z\\",\\n \\"EndTime\\": \\"2021-12-24T03:00:42.134971294Z\\",\\n \\"UserData\\": \\"{\\\\\\"ID\\\\\\": \\\\\\"user1\\\\\\",\\\\\\"Name\\\\\\": \\\\\\"test-user1\\\\\\",\\\\\\"Avatar\\\\\\": \\\\\\"http://example.com?id=user1\\\\\\"}\\",\\n \\"TaskType\\": \\"VideoLabelClassification\\",\\n \\"TaskId\\": \\"VideoLabelClassification-2f157087-91df-4fda-8c3e-232407ec****\\",\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '获取视频标签检测任务', + 'description' => '- 在调用该接口前，请确保已在智能媒体管理上正确创建了项目（[Project](~~478273~~)），创建方式请参见[创建项目](~~478153~~)。'."\n" + .'- 在调用该接口前，请确认已创建[视频标签检测任务](~~478223~~)，并获取该任务的`TaskId`。', + ], + 'GenerateVideoPlaylist' => [ + 'summary' => '创建边转边播播放列表能够将视频文件生成m3u8文件，生成播放列表后即时播放，并根据播放进度实施按需转码，相比离线转码能极大减少了转码等待时间并大幅度降低了转码和存储开销。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '161492', + 'abilityTreeNodes' => [ + 'FEATUREimmCUOMK0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息，在异步消息通知中会返回，方便您在系统内对消息通知进行关联处理。最大长度为 2048 字节。', + 'type' => 'string', + 'required' => false, + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => '视频的OSS地址。'."\n" + ."\n" + .'OSS 地址规则为oss://${Bucket}/${Object}，其中${Bucket}为和当前项目处于同一区域(Region)的 OSS Bucket 名称，${Object}为包含文件扩展名的文件完整路径。'."\n" + .'> 只支持OSS标准存储Bucket。'."\n" + .'> 不支持设置了防盗链白名单访问bucket。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-source-object/video.mp4', + ], + ], + [ + 'name' => 'SourceStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '生成播放列表的起始时间点，单位为秒（s）。取值范围如下：'."\n" + ."\n" + .'- 0（默认）或不填表示从源视频起始时间点开始。'."\n" + ."\n" + .'- 大于0表示从源视频所设置的时间点开始。'."\n" + ."\n" + .'>通过与参数**SourceDuration**一同设置可以对源视频的部分内容生成播放列表。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'SourceDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '生成播放列表的持续时间。单位为秒（s），取值范围如下：'."\n" + ."\n" + .'- 0（默认）或不填表示持续到源视频结尾。'."\n" + ."\n" + .'- 大于0表示从生成播放列表的起始时间点持续所设置的时长。'."\n" + ."\n" + .'> 当设定参数所对应的时间点超过源视频结尾时按默认值处理。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'SourceSubtitles', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '添加字幕列表，默认为空。最大支持2个。', + 'type' => 'array', + 'items' => [ + 'description' => '字幕信息。', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => '被嵌入字幕的OSS地址。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中${Bucket}为和当前项目处于同一区域(Region)的OSS Bucket名称，${Object}为文件的完整路径。'."\n" + .'> 参数**MasterURI**必须不为空，并且被嵌入字幕的OSS地址`oss://${Bucket}/${Object}`必须处于参数**MasterURI**所在目录或它的子目录。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-object/subtitle/eng.vtt', + ], + 'Language' => [ + 'description' => '字幕语言，参考标准为 ISO 639-2，默认为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'eng', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'MasterURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'Master Playlist的OSS地址。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中${Bucket}为和当前项目处于同一区域(Region)的OSS Bucket名称，${Object}为带".m3u8"后缀名的文件完整路径。'."\n" + .'> 如果Playlist有字幕输入或有多Target输出，MasterURI为必填，并且字幕URI或Target URI必须处于MasterURI所在目录或子目录。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object/master.m3u8', + ], + ], + [ + 'name' => 'Targets', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '边转边播播放列表数组，数组长度最大为6。每个Target对应至多一个视频Media Playlist和一个或多个字幕Media Playlist'."\n" + .'> 如果配置了大于一个Target，参数**MasterURI**必须不为空。', + 'type' => 'array', + 'items' => [ + 'description' => '边转边播任务详细信息。', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => '边转边播输出文件的OSS地址前缀，输出文件包括m3u8文件和ts文件。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中${Bucket}为和当前项目处于同一地域的OSS Bucket名称，${Object}为不包含文件扩展名的文件完整路径前缀。'."\n" + ."\n" + .'- 示例：URI为oss://test-bucket/test-object/output-video，则将产生一个oss://test-bucket/test-object/output-video.m3u8文件以及多个oss://test-bucket/test-object/output-video-${token}-${index}.ts文件，其中${token}为根据转码参数生成的唯一字符串，在API返回结果中包含了${token}参数。${index}为生成的从0开始编号的ts文件序号。'."\n" + ."\n" + .'> 如果参数**MasterURI**不为空，URI地址必须处于参数**MasterURI**所在目录或它的子目录。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object/output-video', + ], + 'Video' => [ + 'description' => '视频处理参数配置，空值（默认）表示禁用视频处理，输出ts文件中将不包含视频流。'."\n" + .'> 同一Target内的Video和Subtitle字段互斥。如果设置了Video字段会忽略Subtile字段。', + 'required' => false, + '$ref' => '#/components/schemas/TargetVideo', + ], + 'Audio' => [ + 'description' => '音频处理参数配置，空值（默认）表示禁用音频处理，输出ts文件中将不包含音频流。'."\n" + .'> 同一Target内的Audio和Subtitle字段互斥。如果设置了Audio字段会忽略Subtile字段。Audio和Video可以同时设置，Audio表示输出视频中的音频信息。也可以只设置Audio，只生成音频信息。', + 'required' => false, + '$ref' => '#/components/schemas/TargetAudio', + ], + 'Subtitle' => [ + 'description' => '字幕处理参数配置。'."\n" + .'> 同一Target内的Subtile和Video或Audio字段互斥，只有单独设置Subtile才能生成字幕。', + 'required' => false, + '$ref' => '#/components/schemas/TargetSubtitle', + ], + 'TranscodeAhead' => [ + 'description' => '触发边转边播时向前转码的ts文件数量。默认向前转码2分钟时长的视频。'."\n" + ."\n" + .'- 示例：**Duraiton**为10，则**TranscodeAhead**默认为12。您可以指定该参数控制异步向前转码的数量，取值范围为[10,30]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '12', + ], + 'Duration' => [ + 'description' => '单个ts文件的播放时长。单位为秒（s），默认为10，取值范围为[5,15]。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '10', + ], + 'InitialTranscode' => [ + 'description' => '初始转码时长，单位为秒（s），默认值为30。'."\n" + ."\n" + .'- 当所设置的时长为0时，不预转。'."\n" + .'- 当所设置的时长小于0或超过源视频长度时，将初始转码整段视频。'."\n" + .'- 当所设置的时长位于ts文件中间时，将持续转码到ts文件结束位置。'."\n" + ."\n" + .'> 该参数主要用于加快视频初次播放的等待时间，提升播放体验。若您需要替换传统VOD业务场景则可尝试初始转码整段视频。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '30', + ], + 'InitialSegments' => [ + 'description' => '初始转码ts文件时长数组，数组长度最大为6，默认为空，与参数**Duration**独立。', + 'type' => 'array', + 'items' => [ + 'description' => '初始转码ts文件时长，取值范围为[1,**Duration**]，'."\n" + ."\n" + .'- 示例：初始转码ts时长数组为`[2, 2, 4, 4, 8, 8]`，则序号为0的ts时长为2，序号为1的ts时长为2，序号为2的ts时长为4，序号为3的ts时长为4，序号为4的ts时长为8，序号为5的ts时长为8。'."\n" + .'> 自定义更小的初始转码ts文件时长可以让视频加载更加流畅。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '[2, 2, 4, 4, 8, 8]', + ], + 'required' => false, + ], + 'Tags' => [ + 'description' => '为生成的ts文件添加OSS对象[标签](~~106678~~)。可以使用OSS标签来控制OSS文件的生命周期。'."\n" + .'> 当前标签值与上一级中定义的Tags取并集作为当前Target的标签值。如有同名，取当前值。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{\\"key1\\":\\"value1\\"}', + 'description' => '标签值。', + ], + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '为生成的ts文件添加OSS对象[标签](~~106678~~)。可以使用标签来控制OSS文件的生命周期。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '标签值。', + 'example' => '{"key1": "value1", "key2": "value2"}', + ], + 'example' => '{"key1": "value1", "key2": "value2"}', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**如无特殊需求，请保持留空即可。**'."\n" + ."\n" + .'链式授权配置，非必填。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '消息通知配置，详细内容请单击Notification查看，异步通知消息格式请参见[异步通知消息格式](~~2743997~~)。', + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + [ + 'name' => 'OverwritePolicy', + 'in' => 'query', + 'schema' => [ + 'description' => '当Media Playlist存在时的覆盖策略，取值范围：'."\n" + ."\n" + .'- overwrite（默认）：覆盖已经存在的Media Playlist。'."\n" + .'- skip-existing：跳过生成，保留已经存在的Media Playlist。', + 'type' => 'string', + 'required' => false, + 'example' => 'overwrite', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FFF*****', + ], + 'Duration' => [ + 'description' => '输出视频总时长。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1082', + ], + 'Token' => [ + 'description' => 'Master Playlist的Token。', + 'type' => 'string', + 'example' => '92376fbb-171f-4259-913f-705f7ee0****', + ], + 'MasterURI' => [ + 'description' => 'Master Playlist的OSS地址。', + 'type' => 'string', + 'example' => 'oss://test-bucket/test-object/master.m3u8', + ], + 'VideoPlaylist' => [ + 'description' => '视频Media Playlist文件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '视频Media Playlist文件信息。', + 'type' => 'object', + 'properties' => [ + 'Token' => [ + 'description' => '视频Media Playlist生成的Token。可以使用该参数组装成ts文件生成的地址。'."\n" + .'> 根据返回的Token值，可以拼接出转码生成的ts地址。拼接格式为：oss://${Bucket}/${Object}-${Token}-${Index}.ts，其中oss://${Bucket}/${Object}为输入参数的Target URI地址，${Token}为返回的参数，${Index}为ts的序号。', + 'type' => 'string', + 'example' => 'affe0c6042f09722fec95a21b8b******', + ], + 'URI' => [ + 'description' => '视频Media Playlist的OSS地址。', + 'type' => 'string', + 'example' => 'oss://test-bucket/test-object/output-video.m3u8', + ], + 'Resolution' => [ + 'description' => '视频分辨率。', + 'type' => 'string', + 'example' => '640x480', + ], + 'FrameRate' => [ + 'description' => '视频帧率。', + 'type' => 'string', + 'example' => '25/1', + ], + ], + ], + ], + 'AudioPlaylist' => [ + 'description' => '音频Media Playlist文件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '音频Media Playlist文件信息。', + 'type' => 'object', + 'properties' => [ + 'Token' => [ + 'description' => '音频Media Playlist生成的Token。可以使用该参数组装成ts文件生成的地址。', + 'type' => 'string', + 'example' => 'affe0c6042f09722fec95a21b8b******', + ], + 'URI' => [ + 'description' => '音频Media Playlist的OSS地址。', + 'type' => 'string', + 'example' => 'oss://test-bucket/test-object/output-audio.m3u8', + ], + 'Channels' => [ + 'description' => '音频声道数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'SubtitlePlaylist' => [ + 'description' => '字幕Media Playlist文件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '字幕Media Playlist文件信息。', + 'type' => 'object', + 'properties' => [ + 'Token' => [ + 'description' => '字幕Media Playlist生成的Token。可以使用该参数组装成字幕文件生成的地址。'."\n" + .'> 根据返回的Token值，可以拼接出转码生成的字幕文件地址。拼接格式为：oss://${Bucket}/${Object}-${Token}_${Index}.ts，其中oss://${Bucket}/${Object}为输入参数的Subtitle URI地址，${Token}为返回的参数，${Index}为字幕的序号。', + 'type' => 'string', + 'example' => 'affe0c6042f09722fec95a21b8b******', + ], + 'URI' => [ + 'description' => '字幕Media Playlist的OSS地址。', + 'type' => 'string', + 'example' => 'oss://test-bucket/test-object/output-subtitle.m3u8', + ], + 'Language' => [ + 'description' => '字幕流的语言。'."\n" + .'> 语言来源于SourceURI源视频的字幕流信息。如果源视频不存在语言信息，返回空值。', + 'type' => 'string', + 'example' => 'eng', + ], + 'Index' => [ + 'description' => '字幕流编号，从0开始。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '生成边转边播播放列表', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~88317~~)。**'."\n" + .'- 调用该接口前，请确保当前Region已经存在可用的项目（Project），详见[项目管理](~~478152~~)。'."\n" + .'- 使用该接口时，默认只处理一路视频/音频/字幕流，同时支持配置处理的视频/音频/字幕流数量。'."\n" + .'<notice>Targets下面的Video、Audio、Subtitle参数不能同时为空，为空时则表示禁用该处理，例如：Video为空表示禁用视频处理，输出 ts 文件中将不包含视频流。></notice>'."\n" + .'- 该接口限制原视频的时长最小为0.x秒，根据输出帧率不同会有一些差异。'."\n" + .'- 该接口同时能支持生成Media playlist和Master playlist，请注意文档参数说明。'."\n" + .'- 该接口为同步接口。播放或预转时才会触发同步或异步转码。可以通过设置[Notification](~~2743997~~)消息通知参数，通过消息通知获取转码任务结果。'."\n" + .'- 该接口的功能说明参见[边转边播](~~477192~~)。'."\n" + .'- OSS的数据处理能力也提供了生成播放列表功能，但只提供生成Media Playlist且参数进行了简化。详情参见OSS数据处理能力[生成播放列表](~~2709281~~)。', + ], + 'GenerateWebofficeToken' => [ + 'summary' => '获取文档预览编辑凭证', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '161499', + 'abilityTreeNodes' => [ + 'FEATUREimm4TQO1Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'title' => '预览编辑地址', + 'description' => '待预览或编辑文档的OSS地址。'."\n" + ."\n" + .'OSS地址规则为`oss://${Bucket}/${Object}`，其中`Bucket`为和当前项目处于同一地域的OSS Bucket名称，`Object`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-object.docx', + ], + ], + [ + 'name' => 'Filename', + 'in' => 'query', + 'schema' => [ + 'title' => '文件名，必须带文件名后缀，默认是 SourceUri 的最后一级', + 'description' => '文件名称，必须包含文件扩展名。默认为参数**SourceURI**的最后一级。'."\n" + ."\n" + .'支持的文件扩展名（其中PDF只支持预览）：'."\n" + ."\n" + .'- 文字文档（Word）：doc、docx、txt、dot、wps、wpt、dotx、docm、dotm、rtf'."\n" + .'- 演示文档（PPT）：ppt、pptx、pptm、ppsx、ppsm、pps、potx、potm、dpt、dps'."\n" + .'- 表格文档（Excel）：et、xls、xlt、xlsx、xlsm、xltx、xltm、csv'."\n" + .'- PDF 文档：pdf', + 'type' => 'string', + 'required' => false, + 'example' => 'test-Object.pptx', + ], + ], + [ + 'name' => 'CachePreview', + 'in' => 'query', + 'schema' => [ + 'title' => '缓存预览标识', + 'description' => '缓存预览标识：'."\n" + ."\n" + .'- true：开启后，文档预览时将不再更新协同编辑内容，适用于仅预览的场景。'."\n" + .'- false：关闭时，默认采用协同预览，及预览时候可以同步更新协同编辑内容。'."\n" + ."\n" + .'><notice>缓存预览和非缓存预览的单价不同，详情请查看计费项说明。'."\n" + .'</notice>><notice>缓存预览时不支持文档内容搜索，不支持打印。</notice>'."\n" + .'<notice>缓存预览暂不支持更新缓存内容。</notice>', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true、false', + ], + ], + [ + 'name' => 'Referer', + 'in' => 'query', + 'schema' => [ + 'title' => 'oss 防盗链 referer', + 'description' => 'OSS防盗链。IMM需要从OSS中获取源文件，如果OSS进行了防盗链设置，IMM需要将对应的头部传给OSS才能获取源文件。'."\n" + .'> 如果访问文档所在的Bucket设置了Referer，请设置此参数。', + 'type' => 'string', + 'required' => false, + 'example' => '*', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => '用户自定义数据，在消息通知中返回', + 'description' => '用户自定义信息，必须填写Notification参数传入MNS配置时才能生效，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为2048字节。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "id": "test-id",'."\n" + .' "name": "test-name"'."\n" + .'}', + ], + ], + [ + 'name' => 'PreviewPages', + 'in' => 'query', + 'schema' => [ + 'title' => '预览前几页', + 'description' => '限制只能预览前几页，默认不限制。最大不能超过5000', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'title' => '文件密码', + 'description' => '文档的打开密码。'."\n" + .'>如果需要预览或编辑有密码的文档，请设置此参数。', + 'type' => 'string', + 'required' => false, + 'example' => '123456', + ], + ], + [ + 'name' => 'ExternalUploaded', + 'in' => 'query', + 'schema' => [ + 'title' => '是否支持外部上传', + 'description' => 'OSS上传同名文件是否是预期行为。可取值如下：'."\n" + ."\n" + .'- true：OSS上传同名文件是预期行为，上传的文档将覆盖原文档生成新版本。在设置为 true 后，仍需先关闭当前正在编辑的文档，然后等待约5分钟后重新打开，才能加载新的文档。仅当文档处于关闭状态时上传才有效，文档处于打开状态时，新的保存会覆盖掉上传的文件。'."\n" + .'- false（默认）：OSS上传同名文件不是预期行为，该接口会返回错误。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'NotifyTopicName', + 'in' => 'query', + 'schema' => [ + 'title' => 'mns 消息通知 topic', + 'description' => '支持将一些事件以 MNS 消息的方式通知给客户。该参数为 MNS 异步消息通知的 topic。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-topic', + ], + ], + [ + 'name' => 'Hidecmb', + 'in' => 'query', + 'schema' => [ + 'title' => '隐藏工具栏，预览模式下使用', + 'description' => '是否隐藏工具栏，文档预览模式下支持设置此参数。可取值如下：'."\n" + ."\n" + .'- false（默认）：不隐藏工具栏。'."\n" + ."\n" + .'- true：隐藏工具栏。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Permission', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '权限', + 'description' => '用户权限信息，以JSON格式表示。'."\n" + ."\n" + .'用户权限包括如下选项：'."\n" + ."\n" + .'每个选项的类型均为Boolean，默认值均为false，可选值为true和false。'."\n" + ."\n" + .'- Readonly（可选）：预览模式。'."\n" + ."\n" + .'- Rename（可选）：重命名文件权限，只提供消息通知功能，重命名事件会发送到MNS中。'."\n" + ."\n" + .'- History（可选）：查看历史版本的权限。'."\n" + ."\n" + .'- Copy（可选）：拷贝权限。'."\n" + ."\n" + .'- Export（可选）：导出PDF权限。'."\n" + ."\n" + .'- Print（可选）：打印权限。'."\n" + ."\n\n" + .'>PDF仅支持预览功能，因此必须将” Readonly“参数设置为true。'."\n" + .'>'."\n" + ."\n" + .'>PDF文件不支持导出。'."\n" + .'> '."\n" + ."\n" + .'> 若要使用多版本功能，必须先在OSS中开通多版本功能，然后将 ”History“参数设置为true。'."\n" + .'>'."\n" + .'><notice>缓存预览时不支持打印。></notice>'."\n" + .'><notice>编辑模式可以查看历史版本，预览模式不支持查看历史版本。></notice>', + 'required' => false, + '$ref' => '#/components/schemas/WebofficePermission', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '用户', + 'description' => '用户信息。可传入业务侧的用户信息，WebOffice 页面将显示该信息。'."\n" + ."\n" + .'系统通过 User.Id 区分不同用户，User.Name 仅用于前端展示。如果未传入 User.Id，后端将自动生成一个随机 ID。不同 ID 的用户视为不同主体，无法互相修改或删除评论。'."\n" + ."\n" + .'默认格式为：Unknown_随机字符串。若未传入User.Id，用户信息将默认显示为 "Unknown"。', + 'required' => false, + '$ref' => '#/components/schemas/WebofficeUser', + ], + ], + [ + 'name' => 'Watermark', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '水印', + 'description' => '水印信息。该水印在前端生成，并没有写入到源文档中，同一个文档传入不同的参数会得到不同的水印。', + 'required' => false, + '$ref' => '#/components/schemas/WebofficeWatermark', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**如无特殊需求，请保持留空即可。**'."\n" + ."\n" + .'链式授权配置，非必填。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Notification 消息通知配置，目前仅支持MNS，异步通知消息格式请参考[WebOffice消息通知格式](~~2743999~~)。'."\n" + ."\n" + .'> 文件保存和文件重命名时会有消息通知。', + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '文档转换任务', + 'description' => 'Weboffice 访问凭证。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1759315A-CB33-0A75-A72B-62D7********', + ], + 'WebofficeURL' => [ + 'title' => '预览编辑地址', + 'description' => 'Weboffice 入口 URL。在线预览或者编辑文档。'."\n" + .'> 无法通过浏览器直接打开，需要配合Weboffice JS-SDK，和访问凭证（AccessToken）一起才可以预览或编辑文档。更多信息，请参见[快速入门](~~468066~~)。', + 'type' => 'string', + 'example' => 'https://office-cn-shanghai.imm.aliyuncs.com/office/s/dd221b2cdb44fb66e9070d1d70a8b9bbb6d6fff7?_w_tokentype=1', + ], + 'AccessToken' => [ + 'title' => 'access token', + 'description' => 'Weboffice 访问凭证。', + 'type' => 'string', + 'example' => '2d73dd5d87524c5e8a194c3eb5********', + ], + 'RefreshToken' => [ + 'title' => 'refresh token', + 'description' => 'Weboffice 刷新凭证。', + 'type' => 'string', + 'example' => 'e374995ec532432bb678074d36********', + ], + 'AccessTokenExpiredTime' => [ + 'title' => 'access token 过期时间', + 'description' => '访问凭证的过期时间。过期时间30分钟。', + 'type' => 'string', + 'example' => '2021-08-30T13:13:11.347146982Z', + ], + 'RefreshTokenExpiredTime' => [ + 'title' => 'refresh token 过期时间', + 'description' => '刷新凭证的过期时间。过期时间 1 天。', + 'type' => 'string', + 'example' => '2021-08-31T12:43:11.347146982Z', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1759315A-CB33-0A75-A72B-62D7********\\",\\n \\"WebofficeURL\\": \\"https://office-cn-shanghai.imm.aliyuncs.com/office/s/dd221b2cdb44fb66e9070d1d70a8b9bbb6d6fff7?_w_tokentype=1\\",\\n \\"AccessToken\\": \\"2d73dd5d87524c5e8a194c3eb5********\\",\\n \\"RefreshToken\\": \\"e374995ec532432bb678074d36********\\",\\n \\"AccessTokenExpiredTime\\": \\"2021-08-30T13:13:11.347146982Z\\",\\n \\"RefreshTokenExpiredTime\\": \\"2021-08-31T12:43:11.347146982Z\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '获取Weboffice凭证', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + ."\n" + .'- 访问凭证过期时间为30分钟，刷新凭证过期时间为1天。'."\n" + .'- 返回的过期时间为UTC时间，和北京时间有8小时的时差。'."\n" + .'- 支持的输入文件格式：'."\n" + .' - 文字文档（Word）：doc、docx、txt、dot、wps、wpt、dotx、docm、dotm、rtf。'."\n" + .' - 演示文档（PPT）：ppt、pptx、pptm、ppsx、ppsm、pps、potx、potm、dpt、dps。'."\n" + .' - 表格文档（Excel）：et、xls、xlt、xlsx、xlsm、xltx、xltm、csv'."\n" + .' - PDF 文档：pdf。'."\n" + .'- 支持最大的文件200MB。'."\n" + .'- 支持最大的文档页数 5000 页。'."\n" + .'- 2023-12-01之前创建的项目，按照文档打开次数计费。当前按照API接口调用次数计费。如需切换成新的计费模式，创建新的项目即可，但需要注意，一次API调用只能给一个用户使用，若重复使用，则只有最后一个用户可以正常访问，其余用户的访问权限将被回收。'."\n" + ."\n" + .'- 在与智能媒体管理相同的地域下开通MNS服务，创建主题和队列，并配置订阅关系，可以通过NotifyTopicName参数传入MNS主题名称来接收文件保存的消息通知。关于MNS SDK的更多信息，请参见[接收和删除消息](~~32449~~)。'."\n" + .'文件保存消息通知Message字段JSON格式示例请参考[WebOffice消息通知格式](~~2743999~~)。'."\n" + ."\n" + .'> 若要使用多版本功能，必须先在OSS中开通多版本功能，然后将 ”History“参数设置为true。'."\n" + .'>', + 'requestParamsDescription' => '#### 典型场景举例'."\n" + ."\n" + .'对于如下示例的参数结构，对一些经典的场景示例说明：'."\n" + .'##### 预览只读文件（如果是预览pdf文件，必须这样设置）'."\n" + ."\n" + .'文档预览模式，文档只能预览不可编辑规则：'."\n" + ."\n" + .'```json'."\n" + .' {'."\n" + .' "ProjectName" : "test-project",'."\n" + .' "SourceURI" : "oss://test-bucket/test-object.pdf",'."\n" + .' "Filename" : "test-object.docx",'."\n" + .' "PreviewPages" : "5",'."\n" + .' "Permission" : "{\'Readonly\':\'true\'}"'."\n" + .'}'."\n" + ."\n" + .'```'."\n" + .'##### 预览文件后缀为大写的文件'."\n" + ."\n" + .'预览文件后缀为大写的文件，需要设置Filename参数后缀为小写：'."\n" + ."\n" + .'```json'."\n" + .' {'."\n" + .' "ProjectName" : "test-project",'."\n" + .' "SourceURI" : "oss://test-bucket/test-object.DOCX",'."\n" + .' "Filename" : "test-object.docx",'."\n" + .' "PreviewPages" : "5",'."\n" + .' "Permission" : "{\'Readonly\':\'true\'}"'."\n" + .'}'."\n" + ."\n" + .'```'."\n" + .'##### 对指定文档只预览前5页'."\n" + ."\n" + .'文档一共10页，只显示前5页规则：'."\n" + ."\n" + .'```json'."\n" + .' {'."\n" + .' "ProjectName" : "test-project",'."\n" + .' "SourceURI" : "oss://test-bucket/test-object.docx",'."\n" + .' "Filename" : "test-object.docx",'."\n" + .' "PreviewPages" : "5",'."\n" + .' "Permission" : "{\'Readonly\':\'true\'}"'."\n" + .'}'."\n" + ."\n" + .'```'."\n" + .'##### 对指定文档预览添加密码'."\n" + ."\n" + .'文档预览时设置密码，或者源文件设置了密码预览时直接打开不需要密码规则：'."\n" + ."\n" + .'```json'."\n" + .' {'."\n" + .' "ProjectName" : "test-project",'."\n" + .' "SourceURI" : "oss://test-bucket/test-object.docx",'."\n" + .' "Filename" : "test-object.docx",'."\n" + .' "Password" : "123456",'."\n" + .' "Permission" : "{\'Readonly\':\'true\'}"'."\n" + .'}'."\n" + .'```'."\n" + .'##### 对指定的文档预览添加水印'."\n" + ."\n" + .'文档预览时添加水印规则：'."\n" + ."\n" + .'```json'."\n" + .' {'."\n" + .' "ProjectName" : "test-project",'."\n" + .' "SourceURI" : "oss://test-bucket/test-object.docx",'."\n" + .' "Filename" : "test-object.docx",'."\n" + .' "Watermark" : "{\'Type\':\'1\',\'Value\':\'水印值\',\'Font\':\'bold 20px Serif\'}",'."\n" + .' "Permission" : "{\'Readonly\':\'true\'}"'."\n" + .'}'."\n" + .'```'."\n" + .'##### 对指定的文档预览时隐藏工具栏'."\n" + ."\n" + .'文档预览时隐藏工具栏规则：'."\n" + ."\n" + .'```json'."\n" + .' {'."\n" + .' "ProjectName" : "test-project",'."\n" + .' "SourceURI" : "oss://test-bucket/test-object.docx",'."\n" + .' "Filename" : "test-object.docx",'."\n" + .' "Hidecmb" : "true",'."\n" + .' "Permission" : "{\'Readonly\':\'true\'}"'."\n" + .'}'."\n" + .'```'."\n" + .'##### 对指定的文档进行在线编辑，查看历史版本，拷贝，打印，导出PDF权限'."\n" + ."\n" + .'文档在线编辑，查看历史版本，拷贝，打印，导出PDF权限规则：'."\n" + ."\n" + .'```json'."\n" + .' {'."\n" + .' "ProjectName" : "test-project",'."\n" + .' "SourceURI" : "oss://test-bucket/test-object.docx",'."\n" + .' "Filename" : "test-object.docx",'."\n" + .' "Permission" : "{\'Readonly\':\'false\',\'History\':\'true\',\'Copy\':\'true\',\'Print\':\'true\',\'Export\':\'true\'}"'."\n" + .'}'."\n" + .'```', + 'responseParamsDescription' => '**常见错误**'."\n" + ."\n" + .'ProjectName对应的项目未找到，请到新版本IMM控制台检查地域下该项目是否存在。'."\n" + .'```'."\n" + .'{'."\n" + .' "Code": "ResourceNotFound",'."\n" + .' "Message": "The specified resource acs:imm::xxx:project/xxx is not found"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'User参数是必填参数，请检查该参数是否填写。'."\n" + .'```'."\n" + .'{'."\n" + .' "Code": "InvalidArgument.User",'."\n" + .' "Message": "The parameter User is required but not provided"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'User参数不正确，请检查该参数值是否是正确的JSON格式。'."\n" + .'```'."\n" + .'{'."\n" + .' "Code": "InvalidJSON parsing error, User",'."\n" + .' "Message": "Specified parameter JSON parsing error, User is not valid."'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'Permission参数不正确，请检查该参数值是否是正确的JSON格式。'."\n" + .'```'."\n" + .'{'."\n" + .' "Code": "InvalidJSON parsing error, Permission",'."\n" + .' "Message": "Specified parameter JSON parsing error, Permission is not valid."'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'Watermark参数不正确，请检查该参数值是否是正确的JSON格式。'."\n" + .'```'."\n" + .'{'."\n" + .' "Code": "InvalidJSON parsing error, Watermark",'."\n" + .' "Message": "Specified parameter JSON parsing error, Watermark is not valid."'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'PreviewPages参数格式不正确，请检查PreviewPages参数值。'."\n" + .'``` '."\n" + .'{'."\n" + .' "Code": "InvalidPreviewPages",'."\n" + .' "Message": "Specified parameter PreviewPages is not valid."'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'SourceURI对应的OSS文件不存在，请检查Bucket下该文件是否存在。'."\n" + .'```'."\n" + .'{'."\n" + .' "Code": "ResourceNotFound",'."\n" + .' "Message": "The specified resource oss://xx is not found"'."\n" + .'}'."\n" + .'```', + 'extraInfo' => '### 相关文档 '."\n" + .' - 关于OSS多版本的介绍，请参见[OSS版本控制概述](~~109695~~)。'."\n" + .' - 关于OSS防盗链的介绍，请参见[使用防盗链策略避免非法流量盗用](~~31869~~)。', + ], + 'RefreshWebofficeToken' => [ + 'summary' => '刷新Weboffice访问凭证。Weboffice访问凭证有效期是30分钟，过期会失效，无法继续访问Weboffice。如果要继续访问Weboffice，可以使用这个接口刷新Weboffice访问凭证，即获取一个新的凭证，新的凭证过期时间也是30分钟。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '39679', + 'abilityTreeNodes' => [ + 'FEATUREimm4TQO1Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'AccessToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'access token', + 'description' => 'Weboffice 访问凭证。通过[GenerateWebofficeToken](~~478226~~)接口或者[RefreshWebofficeToken](~~478227~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => '99d1b8b478b641c1b3372f5bd6********', + ], + ], + [ + 'name' => 'RefreshToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'refresh token', + 'description' => 'Weboffice 刷新凭证。通过[GenerateWebofficeToken](~~478226~~)接口或者[RefreshWebofficeToken](~~478227~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'a730ae0d7c6a487d87c661d199********', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**如无特殊需求，请保持留空即可。**'."\n" + ."\n" + .'链式授权配置，非必填。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '文档转换任务', + 'description' => 'Weboffice 访问凭证', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '501339F9-4B70-0CE2-AB8C-866C********', + ], + 'RefreshToken' => [ + 'title' => 'refresh token', + 'description' => 'Weboffice 刷新凭证。', + 'type' => 'string', + 'example' => '72a52ab3702a4123ab5594671a********', + ], + 'AccessToken' => [ + 'title' => 'access token', + 'description' => 'Weboffice 访问凭证。', + 'type' => 'string', + 'example' => '4996466c690a4902846ce00f96********', + ], + 'RefreshTokenExpiredTime' => [ + 'title' => 'refresh token 过期时间', + 'description' => '刷新凭证的过期时间。过期时间 1 天。', + 'type' => 'string', + 'example' => '2021-09-01T12:37:28.950065359Z', + ], + 'AccessTokenExpiredTime' => [ + 'title' => 'access token 过期时间', + 'description' => '访问凭证的过期时间。过期时间30分钟。', + 'type' => 'string', + 'example' => '2021-08-31T13:07:28.950065359Z', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"501339F9-4B70-0CE2-AB8C-866C********\\",\\n \\"RefreshToken\\": \\"72a52ab3702a4123ab5594671a********\\",\\n \\"AccessToken\\": \\"4996466c690a4902846ce00f96********\\",\\n \\"RefreshTokenExpiredTime\\": \\"2021-09-01T12:37:28.950065359Z\\",\\n \\"AccessTokenExpiredTime\\": \\"2021-08-31T13:07:28.950065359Z\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '刷新Weboffice凭证', + 'description' => '**请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + .'- 计费详情可以参考[WebOffie计费说明](~~2639703~~)。'."\n" + .'- 访问凭证过期时间为 30 分钟，需在访问凭证过期之前打开预览，过期后将无法预览。'."\n" + .'- 刷新凭证过期时间为 1 天，需在刷新凭证过期之前调用刷新接口，过期后该凭证将会失效。'."\n" + .'- 返回的过期时间为 UTC 时间，和北京时间有 8 小时的时差。'."\n" + .'> 访问凭证是用来进行实际预览会话访问的，刷新凭证是用来减少用户刷新凭证的参数设置，可以使用刷新凭证直接获取之前配置的新凭证。'."\n" + .'>', + ], + 'CreateOfficeConversionTask' => [ + 'summary' => '创建文档转换任务，支持文档格式转换，将存储在对象存储中的文档（Word、PPT、Excel、PDF）转成图片，文本，或者PDF。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '129600', + 'abilityTreeNodes' => [ + 'FEATUREimmV2RAAA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'title' => '文档转换输入文件地址', + 'description' => '源数据的存储地址。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object', + ], + ], + [ + 'name' => 'Sources', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '输入图片列表，转换顺序为输入列表 URI 的顺序。(**该参数尚未正式上线，不推荐使用**)', + 'type' => 'array', + 'items' => [ + 'description' => '输入图片信息。', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => '源图片的 OSS 地址。'."\n" + ."\n" + .'OSS 地址规则为 oss://${Bucket}/${Object}，其中${Bucket}为和当前项目处于同一区域(Region)的 OSS Bucket 名称，${Object}为包含文件扩展名的文件完整路径。'."\n" + ."\n" + .'支持的图片格式：jpg、jp2、png、tiff、webp、bmp、svg。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://examplebucket/sampleobject.jpg', + ], + 'Rotate' => [ + 'description' => '图片旋转角度。可取值如下：'."\n" + ."\n" + .'- 0（默认）'."\n" + .'- 90'."\n" + .'- 180'."\n" + .'- 270', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '90', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => 'oss://imm-test/test.pptx', + ], + ], + [ + 'name' => 'TargetURI', + 'in' => 'query', + 'schema' => [ + 'title' => '文档转换输出地址模式', + 'description' => '文档转换输出地址模板。'."\n" + ."\n" + .'地址规则为`oss://{bucket}/{tags.custom}/{dirname}/{barename}.{autoext}`。更多信息，请参见[TargetURI模板](~~465762~~)。'."\n" + ."\n" + .'> 和 TargetURIPrefix 二者至少需要填一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://examplebucket/outputDocument.pdf', + ], + ], + [ + 'name' => 'TargetURIPrefix', + 'in' => 'query', + 'schema' => [ + 'title' => '文档转换输出文件地址前缀', + 'description' => '文档转换后输出文件的存储地址前缀。'."\n" + ."\n" + .'规则为 `oss://${Bucket}/${Prefix}/`，其中`${Bucket}`为和当前项目处于同一区域(Region)的 OSS Bucket 名称，`${Prefix}`为输出文件的存储地址前缀。'."\n" + .'> 和 TargetURI 二者至少需要填一个。'."\n" + .'>', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://examplebucket/outputprefix/', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '输入文件格式，默认使用文件名后缀小写格式', + 'description' => '源数据的后缀类型。默认根据OSS对象的后缀名确定源数据的类型。当OSS对象没有后缀名时，可以设置此参数，可选值如下。'."\n" + ."\n" + .'- 文字文档（Word）：doc、docx、wps、wpss、docm、dotm、dot、dotx'."\n" + ."\n" + .'- 演示文档（PPT）：pptx、ppt、pot、potx、pps、ppsx、dps、dpt、pptm、potm、ppsm、dpss'."\n" + ."\n" + .'- 表格文档（Excel）：xls、xlt、et、ett、xlsx、xltx、csv、xlsb、xlsm、xltm、ets'."\n" + ."\n" + .'- PDF文档：pdf', + 'type' => 'string', + 'required' => false, + 'example' => 'doc', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'title' => '输出文件格式', + 'description' => '转换输出的目标文件类型。包括如下选项：'."\n" + ."\n" + .'- png：转换为PNG格式的图片文件。'."\n" + .'- jpg：转换为JPG格式的图片文件。'."\n" + .'- pdf：转换为PDF文件。'."\n" + .'- txt：转换为只包含文本内容的文件，主要用于提取文件的文本内容。源数据类型只支持演示文档、文字文档和表格文档。表格文档转换结果生成一个txt文件，sheet相关的变量设置不生效。', + 'type' => 'string', + 'required' => true, + 'example' => 'png', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => '用户自定义数据，在消息通知中返回', + 'description' => '用户自定义信息，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为2048字节。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "id": "test-id",'."\n" + .' "name": "test-name"'."\n" + .'}', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '用户自定义标签', + 'description' => '自定义标签信息，字典格式。用于搜索任务。', + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "key": "value"'."\n" + .'}', + ], + ], + [ + 'name' => 'StartPage', + 'in' => 'query', + 'schema' => [ + 'title' => '转换起始页，从 1 开始，包含起始页，默认从第一页开始转换，表格转图片时需要指定 SheetIndex 才有效', + 'description' => '文档转换的起始页，默认值为1。'."\n" + .'>- 如果源文件为表格文档需要指定工作表页码。'."\n" + .'>- 只有转换图片时生效，转换pdf和txt时 不生效。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'EndPage', + 'in' => 'query', + 'schema' => [ + 'title' => '转换终止页，包含终止页，默认转换到最后一页，表格转图片时需要指定 SheetIndex 才有效', + 'description' => '文档转换的结束页，默认值为-1，表示从起始页开始转换到最后一页。'."\n" + .'>- 如果源文件为表格文档需要指定工作表页码（SheetIndex）。'."\n" + .'>- 如果页码太多，建议分批转换，否则可能会导致转换超时。'."\n" + .'>- 只有转换图片时生效，转换pdf和txt时不生效。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'title' => '文档密码', + 'description' => '文档的打开密码。如果需要转换有密码的文档，请设置此参数。', + 'type' => 'string', + 'required' => false, + 'example' => '123456', + ], + ], + [ + 'name' => 'ScalePercentage', + 'in' => 'query', + 'schema' => [ + 'title' => '缩放参数，允许范围 20~200，100代表不缩放，小于100表示缩小，大于100表示放大，默认不缩放', + 'description' => '文档缩放比例，取值范围为20~199，默认值为100，表示不缩放。'."\n" + .'> 小于100表示缩小，大于100表示放大。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'Quality', + 'in' => 'query', + 'schema' => [ + 'title' => '质量参数，范围是0-100，越大质量越好，默认系统自动选择适合的分辨率', + 'description' => '转换文件的质量，取值范围为0（质量最差，性能最好）~100（质量最好，性能最差）。默认情况下，系统会根据文档内容，在质量和性能中权衡，设置合适的值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'Pages', + 'in' => 'query', + 'schema' => [ + 'title' => '指定转换页码，优先级高于 StartPage/EndPage，格式：多个页码用 “," 拼接，连续页码用 "-" 连接，样例参考: 1,2-4,7', + 'description' => '指定转换页码。优先级高于参数StartPage和参数EndPage。格式如下：'."\n" + ."\n" + .'- 多个页码用半角逗号（,）隔开，例如1,2。'."\n" + ."\n" + .'- 连续页码用短划线（-）连接，例如1,2-4,7。', + 'type' => 'string', + 'required' => false, + 'example' => '1,2-4,7', + ], + ], + [ + 'name' => 'MaxSheetRow', + 'in' => 'query', + 'schema' => [ + 'title' => '表格转图片的最大行数，在 LongPicture 为 true 时生效，默认转所有行', + 'description' => '表格文档转换为图片的最大行数，默认转换所有行。'."\n" + .'>当参数**LongPicture**取值为`true`时，此参数生效。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MaxSheetColumn', + 'in' => 'query', + 'schema' => [ + 'title' => '表格转图片的最大列数，在 LongPicture 为 true 时生效，默认转所有列', + 'description' => '表格文档转换为图片的最大列数，默认转换所有列。'."\n" + .'>当参数**LongPicture**取值为`true`时，此参数生效。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SheetCount', + 'in' => 'query', + 'schema' => [ + 'title' => '表格转图片参数，指定转换表格中的 sheet 数量，默认转换所有 sheet', + 'description' => '表格文档中转换为图片的工作表（sheet）的数量，默认转换所有工作表。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SheetIndex', + 'in' => 'query', + 'schema' => [ + 'title' => '表格转图片参数，指定转换哪一个 sheet，从 1 开始，默认从起始页开始转', + 'description' => '表格文档中转换为图片的工作表（sheet）的页码，取值范围为1~最后一个sheet页。默认转换起始页为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FitToWidth', + 'in' => 'query', + 'schema' => [ + 'title' => '表格转图片参数，是否将所有列输出到一张图片，默认为否', + 'description' => '表格文档转换为图片或者PDF文件时，是否将所有列输出到一张图片或者PDF页面。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否。输出成多张图片，多张PDF页面。'."\n" + ."\n" + .'- true：是。输出成一张图片，一张PDF页面。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'FitToHeight', + 'in' => 'query', + 'schema' => [ + 'title' => '表格转图片参数，是否将所有行输出到一张图片，默认为否', + 'description' => '表格文档转换为图片或者PDF文件时，是否将所有行输出到一张图片或者PDF页面。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否。输出成多张图片，多张PDF页面。'."\n" + ."\n" + .'- true：是。输出成一张图片，一张PDF页面。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'FirstPage', + 'in' => 'query', + 'schema' => [ + 'title' => '表格转图片参数，是否只返回表格的第一张图片，默认为否', + 'description' => '表格文档转换为图片时，是否只返回转换结果的第一张图片（图片包含的行数和列数为自动切割的结果）。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否。返回所有图片。'."\n" + ."\n" + .'- true：是。只返回第一张图片（提取缩略图）。'."\n" + ."\n" + .'>仅当参数**LongPicture**取值为`true`时，此参数生效。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'PaperSize', + 'in' => 'query', + 'schema' => [ + 'title' => '表格转图片纸张大小，支持 A4/A2/A0，默认A4，配合 FitToHeight 或 FitToWidth 一起使用才有效', + 'description' => '表格文档转换为图片时的纸张大小（输出图片可以类比为在纸张上面打印）。取值范围如下：'."\n" + ."\n" + .'- A0'."\n" + ."\n" + .'- A2'."\n" + ."\n" + .'- A4（默认）'."\n" + ."\n" + .'> 需配合参数**FitToHeight**和参数**FitToWidth**一起使用，此参数才能生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'A4', + ], + ], + [ + 'name' => 'PaperHorizontal', + 'in' => 'query', + 'schema' => [ + 'title' => '表格转图片纸张是否水平放置，默认为否', + 'description' => '表格文档转换为图片时纸张是否水平放置（输出图片可以类比为在纸张上面打印）。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否。垂直放置。'."\n" + ."\n" + .'- true：是。水平放置。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'TrimPolicy', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '表格瘦身', + 'description' => '表格文档转换的瘦身策略。比如表格中有很多没有内容的行列，在没有瘦身策略的情况下，可能会输出很多空白。', + 'required' => false, + '$ref' => '#/components/schemas/TrimPolicy', + ], + ], + [ + 'name' => 'ShowComments', + 'in' => 'query', + 'schema' => [ + 'title' => '文字转图片，是否显示批注，目前只支持文字转图片时携带批注，默认不显示批注', + 'description' => '文字文档转换为图片时，是否显示批注。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否。不显示批注。'."\n" + ."\n" + .'- true：是。显示批注。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'LongPicture', + 'in' => 'query', + 'schema' => [ + 'title' => '转图片时是否转换成一张长图，最多支持将 20 页合成一张长图，超过可能报错，默认为不转成长图', + 'description' => '文档转换为图片时是否转换为一张长图。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否。转换成多张图。'."\n" + ."\n" + .'- true：是。转换成一张长图。'."\n" + ."\n" + .'> 最多支持将20页文档合成一张长图，超过该页数的转换任务可能会报错。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ImageDPI', + 'in' => 'query', + 'schema' => [ + 'title' => '输出图片 DPI，允许范围 96-600，默认 96', + 'description' => '输出图片DPI，取值范围为96~600，默认值为96。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '96', + ], + ], + [ + 'name' => 'LongText', + 'in' => 'query', + 'schema' => [ + 'title' => '转文本时是否转换成长文本，默认每页是个独立的文本', + 'description' => '文档转换为文本时是否转换为长文本文件。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否。每页文档转换为独立的文本文件。'."\n" + ."\n" + .'- true：是。所有内容都放到一个文本文件中。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'HoldLineFeed', + 'in' => 'query', + 'schema' => [ + 'title' => '转文本时是否保留文档中的换行符，默认不保留', + 'description' => '文档转换为文本时是否保留文档中的换行符。取值范围如下：'."\n" + ."\n" + .'- false（默认）：否。不保留换行符。'."\n" + ."\n" + .'- true：是。保留换行符。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**如无特殊需求，请保持留空即可。**'."\n" + ."\n" + .'链式授权配置，非必填。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '消息通知配置，详细内容请单击Notification查看，异步通知消息格式请参见[异步通知消息格式](~~2743997~~)。', + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '文档转换任务', + 'description' => '异步任务响应。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FF3B7D81-66AE-47E0-BF69-157DCF18*****', + ], + 'TaskId' => [ + 'title' => '任务 id', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd*****', + ], + 'EventId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '2C2-1I0EG57VR37J4rQ8oKG6C9*****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FF3B7D81-66AE-47E0-BF69-157DCF18*****\\",\\n \\"TaskId\\": \\"formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd*****\\",\\n \\"EventId\\": \\"2C2-1I0EG57VR37J4rQ8oKG6C9*****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '创建文档转换任务', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**'."\n" + .'><notice>异步任务不保证时效。></notice>'."\n" + .'- 支持的输入文件格式：'."\n" + .' - 文字文档（Word）：doc、docx、wps、wpss、docm、dotm、dot、dotx。'."\n" + .' - 演示文档（PPT）：pptx、ppt、pot、potx、pps、ppsx、dps、dpt、pptm、potm、ppsm、dpss。'."\n" + .' - 表格文档（Excel）：xls、xlt、et、ett、xlsx、xltx、csv、xlsb、xlsm、xltm、ets。'."\n" + .' - PDF 文档：pdf。'."\n" + .'- 支持的输出文件格式：'."\n" + .' - 图片：png、jpg。'."\n" + .' - 文本：txt。'."\n" + .' - PDF：pdf。'."\n" + .'- 单文件大小限制200MB以内，上限无法调整。'."\n" + .'- 如果文件比较大或者文件内容本身比较复杂，可能会导致转换超时。'."\n" + .'- 单用户每秒请求数限制为50。'."\n" + ."\n" + .'- 任务开始执行后，任务信息只保存7天，超过7天则无法再获取。您可以通过以下几种方式及时获取任务信息：'."\n" + .' - 调用[GetTask](~~478241~~)或[ListTasks](~~478242~~)接口获取返回的`TaskId`，查看任务信息。'."\n" + .' - 在与智能媒体管理相同的地域下开通MNS服务，并配置订阅关系，及时获取任务信息通知，异步通知消息格式请参见[异步通知消息格式](~~2743997~~)。关于MNS SDK的更多信息，请参见[接收和删除消息](~~32449~~)。'."\n" + .' - 在与智能媒体管理相同的地域下开通RocketMQ服务，并创建RocketMQ 4.0实例、Topic、Group，及时获取任务信息通知，异步通知消息格式请参见[异步通知消息格式](~~2743997~~)。关于RocketMQ使用的更多信息，请参见[快速使用HTTP协议的SDK收发普通消息](~~169009~~)。'."\n" + .' - 在与智能媒体管理相同的地域下开通并接入[事件总线EventBridge](https://www.aliyun.com/product/aliware/eventbridge)服务，及时获取任务信息通知。更多信息，请参见[智能媒体管理IMM事件](~~205730~~)。', + ], + 'ExtractDocumentText' => [ + 'summary' => '提取文档文件正文中的文本。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '173181', + 'abilityTreeNodes' => [ + 'FEATUREimmMBRC1J', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~477051~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'title' => '文档转换输入文件地址', + 'description' => '源数据的存储地址。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。'."\n" + .'><notice>当前仅支持http协议地址。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-object', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '输入文件格式，默认使用文件名后缀小写格式', + 'description' => '源数据的后缀类型。默认根据输入对象的后缀名确定源数据的类型。当输入对象没有后缀名时，可以设置此参数，可选值如下。'."\n" + ."\n" + .'- 文字文档（Word）：doc、docx、wps、wpss、docm、dotm、dot、dotx、html'."\n" + .'- 演示文档（PPT）：pptx、ppt、pot、potx、pps、ppsx、dps、dpt、pptm、potm、ppsm、dpss'."\n" + .'- 表格文档（Excel）：xls、xlt、et、ett、xlsx、xltx、csv、xlsb、xlsm、xltm、ets'."\n" + .'- PDF文档：pdf', + 'type' => 'string', + 'required' => false, + 'example' => 'docx', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '授权配置', + 'description' => '**如无特殊需求，请保持留空即可。**'."\n" + ."\n" + .'链式授权配置，非必填。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片裁剪结果', + 'description' => '响应体结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求唯一ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '94D6F994-E298-037E-8E8B-0090F27*****', + ], + 'DocumentText' => [ + 'title' => '文档的文本正文内容', + 'description' => '文档的文本正文内容。', + 'type' => 'string', + 'example' => '测试内容。', + ], + ], + ], + ], + 500 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94D6F994-E298-037E-8E8B-0090F27*****\\",\\n \\"DocumentText\\": \\"测试内容。\\"\\n}","type":"json"}]', + 'title' => '文档正文提取', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~88317~~)。**'."\n" + ."\n" + .'- 调用该接口前，请确保当前Region已经存在可用的项目（[Project](~~478273~~)），详见[项目管理](~~478152~~)。'."\n" + ."\n" + .'- 支持常见的Word、Excel、PPT、PDF、TXT文档。'."\n" + ."\n" + .'- 文件大小最大不超过200 MB。提取后的纯文本文件大小不超过2 MB（约合60万中文字）。'."\n" + ."\n" + .'><notice>当文档格式较为复杂，或正文量过大时，可能出现超时错误。在此类场景建议使用 [CreateOfficeConversionTask](478228) 接口，并将输出格式指定为 txt 来实现类似功能。></notice>', + ], + 'CreateFileCompressionTask' => [ + 'summary' => '打包下载API', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '156182', + 'abilityTreeNodes' => [ + 'FEATUREimmSETH07', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Sources', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '待打包的文件列表和打包规则描述。'."\n" + ."\n\n" + .'> 与参数SourceManifestURI二选一，Sources支持最多100条打包规则。'."\n" + .'><warning>超长100条打包规则请使用参数SourceManifestURI。></warning>', + 'type' => 'array', + 'items' => [ + 'description' => '待打包的文件的OSS地址和对应的打包规则描述。', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => '待打包的目录或文件的OSS地址。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}` 说明如下：'."\n" + ."\n" + .'- 打包目录时，`${Object}`为目录名称。'."\n" + ."\n" + .'- 打包文件时，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object', + ], + 'Alias' => [ + 'description' => '重定向待压缩文件在压缩包中的文件路径或重命名文件。'."\n" + ."\n" + .'- 不填写该参数。保留源目录结构进行压缩，例如源文件地址为`oss://test-bucket/test-dir/test-object.doc`，则压缩包中文件路径为`/test-dir/test-object.doc`。'."\n" + ."\n" + .'- 重命名文件。重命名压缩包中的文件名称，例如源文件地址为`oss://test-bucket/test-object.jpg`，指定参数为`/test-rename-object.jpg`，则压缩包中文件名称为`test-rename-object.jpg`。'."\n" + ."\n" + .'- 重新指定源文件在压缩包中的文件路径。例如源目录地址为`oss://test-bucket/test-dir/`，指定参数为`/new-dir/`，则源目录下所有文件都会被压缩到路径`/new-dir/`中。'."\n" + ."\n" + .'- 指定为`/`，去除源目录结构。所有文件将直接放置在压缩包的根目录下，而不保留原有的目录结构。'."\n" + .'- 同时指定路径和文件名。按照重新指定的路径和文件名重命名。例如，指定参数为`/new-dir/alias.doc`，则会将文件重命名为`alias.doc`并放置在压缩包的`/new-dir/`路径下。'."\n" + ."\n" + .'>- 请避免在重命名过程中出现重名文件的情况，出现此情况时压缩包内的重名文件可能无法解压（取决于您使用的解压程序）。'."\n" + .'>- 格式要求：必须以`/`开头，例如`/new-dir/alias.doc`。', + 'type' => 'string', + 'required' => false, + 'example' => '/new-dir/', + ], + 'Mode' => [ + 'description' => '指定打包规则的匹配模式，包括`prefix`（表示前缀模式）和`fullname`（表示精准匹配），默认为`prefix`。'."\n" + ."\n" + .'+ `prefix`：前缀模式，解析该条打包规则时，前缀模式匹配所有符合规则的文件。'."\n" + .'+ `fullname`：精准匹配，按照规则精准匹配文件，只会匹配到一个文件。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'prefix' => 'prefix', + 'fullname' => 'fullname', + ], + 'example' => 'fullname', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**如无特殊需求，请保持留空即可。**'."\n" + ."\n" + .'链式授权配置，非必填。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'SourceManifestURI', + 'in' => 'query', + 'schema' => [ + 'description' => '文件清单存储的地址。文件清单将Sources结构以JSON格式存储在OSS上，适用于打包文件较多的情况。'."\n" + ."\n" + .'> 与参数`Sources`二选一，其中`URI`参数必填，`Alias`参数选填。SourceManifestURI支持最多80000条打包规则。'."\n" + .'><warning>将内容保存到OSS上时，该参数需要传递OSS文件地址。</warning>'."\n" + ."\n" + .'该文件内部结构示例：'."\n" + .'```'."\n" + .'[{"URI":"oss://<bucket>/<object>", "Alias":"/new-dir/new-name"}]'."\n" + .'```', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-object.json', + ], + ], + [ + 'name' => 'TargetURI', + 'in' => 'query', + 'schema' => [ + 'description' => '输出文件的OSS地址。压缩文件将以该路径中的文件名称命名，例如`name.zip`。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-target-object.zip', + ], + ], + [ + 'name' => 'CompressedFormat', + 'in' => 'query', + 'schema' => [ + 'description' => '文件打包压缩类型。'."\n" + ."\n" + .'> 目前仅支持zip格式。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'zip', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息，在异步消息通知中会为您返回，方便您系统内对消息通知进行关联处理。最大长度为2048字节。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-data', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '消息通知配置，详细内容请单击Notification查看，异步通知消息格式请参见[异步通知消息格式](~~2743997~~)。'."\n" + .'> 智能媒体管理目前接口调用回调不支持指定回调地址，建议您使用MNS。'."\n" + .'>', + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EC564A9A-BA5C-4499-A087-D9B9E76E*****', + ], + 'EventId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16Es*****', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'FileCompression-3579a380-6f7a-4a9d-b9d2-65996*****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC564A9A-BA5C-4499-A087-D9B9E76E*****\\",\\n \\"EventId\\": \\"0ED-1Bz8z71k5TtsUejT4UJ16Es*****\\",\\n \\"TaskId\\": \\"FileCompression-3579a380-6f7a-4a9d-b9d2-65996*****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '创建文件压缩任务', + 'description' => '> 接口公测中，如有任何使用问题，请加入钉钉群进行反馈，钉钉群号请参见[联系我们](~~84454~~)。'."\n" + ."\n" + .'> 该接口目前支持打包，不支持压缩，后续会增加压缩功能。'."\n" + .'* **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + .'><notice>异步任务不保证时效。></notice>'."\n" + .'* 文件数量限制：最多支持打包8万个文件。'."\n" + ."\n" + .'* 文件大小限制：打包前所有文件大小不超过200 GB。'."\n" + ."\n" + .'* 该功能支持OSS上的标准存储类型文件，如需要打包其他类型文件，请先[转化文件的存储类型](~~90090~~)。'."\n" + ."\n" + .'* 该接口为异步接口，获取任务开始执行后，任务信息只保存7天，超过7天则无法再获取。调用[GetTask](~~478241~~)或[ListTasks](~~478242~~)接口获取返回的`TaskId`，查看任务信息。也可以通过设置[Notification](~~2743997~~)消息通知参数，通过消息通知获取任务信息。', + 'requestParamsDescription' => '#### 典型场景中打包规则举例'."\n" + ."\n" + .'对于如下示例的文件结构，对一些经典的场景示例说明：'."\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" + .'##### 对指定文件夹进行打包'."\n" + ."\n" + .'打包`test-dir1`下的所有文件打包到指定目录`test-dir`中，打包规则：'."\n" + ."\n" + .'```json'."\n" + .'['."\n" + .' {'."\n" + .' "URI" : "oss://bucket/test-dir1/",'."\n" + .' "Alias" : "/test-dir/"'."\n" + .' }'."\n" + .']'."\n" + .'```'."\n" + ."\n" + .'生成的压缩包结构为：'."\n" + ."\n" + .'```'."\n" + .'.'."\n" + .'└── test-dir'."\n" + .' ├── file1.txt'."\n" + .' ├── file2.doc'."\n" + .' ├── file3.png'."\n" + .' └── my-file.json'."\n" + .'```'."\n" + ."\n" + .'##### 对指定前缀进行打包'."\n" + ."\n" + .'打包前缀为`test-dir1/file`下的所有文件打包到指定目录`test-dir`中，打包规则：'."\n" + ."\n" + .'```json'."\n" + .'['."\n" + .' {'."\n" + .' "URI" : "oss://bucket/test-dir1/file",'."\n" + .' "Alias" : "/test-dir/"'."\n" + .' }'."\n" + .']'."\n" + .'```'."\n" + ."\n" + .'生成的压缩包结构为：'."\n" + ."\n" + .'```'."\n" + .'.'."\n" + .'└── test-dir'."\n" + .' ├── file1.txt'."\n" + .' ├── file2.doc'."\n" + .' └── file3.png'."\n" + .'```'."\n" + ."\n" + .'注意，如果使用前缀模式进行打包，会将同名的文件夹/文件同时打包进压缩包，例如：'."\n" + ."\n" + .'```json'."\n" + .'['."\n" + .' {'."\n" + .' "URI" : "oss://bucket/test-dir2/AAA",'."\n" + .' "Alias" : "/AAA/"'."\n" + .' }'."\n" + .']'."\n" + .'```'."\n" + ."\n" + .'生成的压缩包结构为：'."\n" + ."\n" + .'```'."\n" + .'.'."\n" + .'└── AAA'."\n" + .' ├── AAA'."\n" + .' └── file.txt'."\n" + .'```'."\n" + ."\n" + .'##### 对指定的文件进行打包'."\n" + ."\n" + .'如果不想使用前缀模式，可以通过设置`mode`参数准确的打包指定的文件：'."\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" + .'生成的压缩包结构为：'."\n" + ."\n" + .'```'."\n" + .'.'."\n" + .'├── AAA'."\n" + .'└── test-dir1'."\n" + .'```', + ], + 'CreateArchiveFileInspectionTask' => [ + 'summary' => '创建压缩包预览解析任务支持获取压缩包内的文件列表信息，该功能无需解压压缩包，就可以获取压缩包内的文件列表信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '157951', + 'abilityTreeNodes' => [ + 'FEATUREimm2Z44LQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**如无特殊需求，请保持留空即可。**'."\n" + ."\n" + .'链式授权配置，非必填。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => '文件压缩密码。文件压缩时如果加密压缩时，查看压缩包内信息需要提供压缩密码。', + 'type' => 'string', + 'required' => false, + 'example' => '123456', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息，在异步消息通知中会为您返回，方便您系统内对消息通知进行关联处理。最大长度为2048字节。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-data', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => '压缩文件存放的位置。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://bucket/test-object.zip', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '消息通知配置，详细内容请单击Notification查看，异步通知消息格式请参见[异步通知消息格式](~~2743997~~)。'."\n" + ."\n" + .'> 智能媒体管理目前接口调用回调不支持指定回调地址，建议您使用MNS。'."\n" + .'>', + 'deprecated' => false, + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EC564A9A-BA5C-4499-A087-D9B9E76E*****', + ], + 'EventId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16Es*****', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'ArchiveFileInspection-8475218e-d86e-4c66-b3cf-50e74d6c****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC564A9A-BA5C-4499-A087-D9B9E76E*****\\",\\n \\"EventId\\": \\"0ED-1Bz8z71k5TtsUejT4UJ16Es*****\\",\\n \\"TaskId\\": \\"ArchiveFileInspection-8475218e-d86e-4c66-b3cf-50e74d6c****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '创建压缩包预览解析任务', + 'description' => '> 接口公测中，如有任何使用问题，请加入钉钉群进行反馈，钉钉群号请参见[联系我们](~~84454~~)。'."\n" + .'* **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + .'><notice>异步任务不保证时效。></notice>'."\n" + .'* 文件数量限制：最多支持包含8万个文件的压缩包。'."\n" + ."\n" + .'* 文件大小限制：zip和rar格式最多支持200 GB，7z格式最多支持50 GB。'."\n" + ."\n" + .'* 该接口为异步接口，获取任务开始执行后，任务信息只保存7天，超过7天则无法再获取。调用[GetTask](~~478241~~)或[ListTasks](~~478242~~)接口获取返回的`TaskId`，查看任务信息。也可以通过设置[Notification](~~2743997~~)消息通知参数，通过消息通知获取任务信息。', + 'requestParamsDescription' => '* 创建压缩包预览解析任务请设置`Notification`中的`ExtendedMessageURI`参数，用于获取压缩包内文件列表信息。生成的打包文件列表信息如下所示：'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "Password" : "压缩包的密码",'."\n" + .' "IsEncryption": "true/false, 压缩包是否加密",'."\n" + .' "ArchiveFiles": ['."\n" + .' {'."\n" + .' "PathName": "文件相对于压缩包的路径，例如./test-dir/test.txt",'."\n" + .' "Reason": "如果预览失败，该文件预览失败的原因",'."\n" + .' "IsFolder": "true/false，该文件是否是文件夹",'."\n" + .' "PackedSize": "压缩包内文件大小",'."\n" + .' "UnPackedSize": "解压后文件大小",'."\n" + .' "FileAccessTime": "文件时间信息",'."\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" + .'```', + ], + 'CreateFileUncompressionTask' => [ + 'summary' => '创建解压缩任务可以将您压缩包内的指定文件解压缩到特定位置，也可以将压缩包完整解压，目前支持的压缩格式包括Zip、RAR和7z。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '157566', + 'abilityTreeNodes' => [ + 'FEATUREimm2Z44LQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => ' test-project', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**如无特殊需求，请保持留空即可。**'."\n" + ."\n" + .'链式授权配置，非必填。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => '压缩包加密的密码。', + 'type' => 'string', + 'required' => false, + 'example' => '123456', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息，在异步消息通知中会为您返回，方便您系统内对消息通知进行关联处理。最大长度为2048字节。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-data', + ], + ], + [ + 'name' => 'SelectedFiles', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '需要解压的文件列表，该参数为空时表示解压整个压缩包。默认为空。', + 'type' => 'array', + 'items' => [ + 'description' => '需要解压的文件名，相对压缩包根目录的路径值。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-dir/test.jpg', + ], + 'required' => false, + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => '压缩文件存放的OSS地址。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-object.zip', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '消息通知配置，详细内容请单击Notification查看，异步通知消息格式请参见[异步通知消息格式](~~2743997~~)。'."\n" + ."\n" + .'> 智能媒体管理目前接口调用回调不支持指定回调地址，建议您使用MNS。'."\n" + .'>', + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + [ + 'name' => 'TargetURI', + 'in' => 'query', + 'schema' => [ + 'description' => '解压文件的目标OSS地址。被选中的文件或压缩包会解压到该地址下。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket/test-dir/', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EC564A9A-BA5C-4499-A087-D9B9E76E*****', + ], + 'EventId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '0ED-1Bz8z71k5TtsUejT4UJ16Es*****', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'FileUncompression-16ab5dd6-af02-480e-9ed7-a8d51b1*****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC564A9A-BA5C-4499-A087-D9B9E76E*****\\",\\n \\"EventId\\": \\"0ED-1Bz8z71k5TtsUejT4UJ16Es*****\\",\\n \\"TaskId\\": \\"FileUncompression-16ab5dd6-af02-480e-9ed7-a8d51b1*****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '创建解压缩任务', + 'description' => '> 接口公测中，如有任何使用问题，请加入钉钉群进行反馈，钉钉群号请参见[联系我们](~~84454~~)。'."\n" + .'* **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + .'<notice>异步任务不保证时效。></notice>'."\n" + .'* 文件数量限制：最多支持包含8万个文件的压缩包。'."\n" + ."\n" + .'* 文件大小限制：zip和rar格式最多支持200 GB，7z格式最多支持50 GB。'."\n" + ."\n" + .'* 文件解压缩任务的处理方式为流式解压，在处理的过程中边解压边输出文件。如果在解压过程中有部分文件损坏导致解压操作中止，已解压生成的文件不会被删除。'."\n" + ."\n" + .'* 该接口为异步接口，获取任务开始执行后，任务信息只保存7天，超过7天则无法再获取。调用[GetTask](~~478241~~)或[ListTasks](~~478242~~)接口获取返回的`TaskId`，查看任务信息。也可以通过设置[Notification](~~2743997~~)消息通知参数，通过消息通知获取任务信息。', + 'requestParamsDescription' => '创建解压缩任务请如果需要获取具体解压信息，请设置`Notification`中的`ExtendedMessageURI`参数。该文件中包含的信息结构如下所示：'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "Password" : "压缩包的密码",'."\n" + .' "IsEncryption": "true/false, 压缩包是否加密",'."\n" + .' "ArchiveFiles": ['."\n" + .' {'."\n" + .' "URI": "解压后的文件地址，例oss://test-bucket/test-dir/test.txt",'."\n" + .' "PathName": "文件相对于压缩包的路径，例如./test.txt",'."\n" + .' "Reason": "如果预览失败，该文件预览失败的原因",'."\n" + .' "IsFolder": "true/false，该文件是否是文件夹",'."\n" + .' "PackedSize": "压缩包内文件大小",'."\n" + .' "UnPackedSize": "解压后文件大小",'."\n" + .' "FileAccessTime": "文件时间信息",'."\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" + .'```', + ], + 'CreateCompressPointCloudTask' => [ + 'summary' => '点云压缩功能可以将OSS中的点云数据进行压缩处理。减少网络数据传输。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '145992', + 'abilityTreeNodes' => [ + 'FEATUREimm0H0W4Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '点云文件的OSS地址。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test/src/test.pcd', + ], + ], + [ + 'name' => 'TargetURI', + 'in' => 'query', + 'schema' => [ + 'description' => '压缩后输出文件的OSS地址。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test/tgt', + ], + ], + [ + 'name' => 'PointCloudFileFormat', + 'in' => 'query', + 'schema' => [ + 'description' => '点云文件格式。当前只支持PCD格式，默认值为pcd。', + 'type' => 'string', + 'required' => false, + 'example' => 'pcd', + 'default' => 'pcd', + 'enum' => [ + 'pcd', + ], + ], + ], + [ + 'name' => 'CompressMethod', + 'in' => 'query', + 'schema' => [ + 'description' => '压缩算法名称。取值如下：'."\n" + ."\n" + .'- octree：八叉树'."\n" + ."\n" + .'- kdtree：K-d树', + 'type' => 'string', + 'required' => true, + 'example' => 'octree', + 'enum' => [ + 'octree', + 'kdtree', + ], + ], + ], + [ + 'name' => 'PointCloudFields', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'json', + 'schema' => [ + 'description' => '参与压缩的PCD属性字段以及压缩顺序，压缩完成后以此顺序进行解压数据。'."\n" + ."\n" + .'- 若采用PCL库Octree压缩，则支持\\["xyz"]'."\n" + ."\n" + .'- 若采用Draco库Kdtree压缩，则支持\\["xyz"]或者\\["xyz", "intensity"]', + 'type' => 'array', + 'items' => [ + 'description' => '参与压缩的PCD属性字段值。可选参数为：'."\n" + ."\n" + .'- xyz'."\n" + ."\n" + .'- intensity', + 'type' => 'string', + 'required' => false, + 'example' => '["xyz"]', + ], + 'required' => true, + ], + ], + [ + 'name' => 'KdtreeOption', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Kdtree压缩参数。', + 'required' => false, + '$ref' => '#/components/schemas/KdtreeOption', + ], + ], + [ + 'name' => 'OctreeOption', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Octree压缩参数。', + 'required' => false, + '$ref' => '#/components/schemas/OctreeOption', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息，在异步消息通知中会为您返回，方便您系统内对消息通知进行关联处理。最大长度为2048字节。', + 'type' => 'string', + 'required' => false, + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义标签，用于对异步任务进行搜索、过滤。', + 'type' => 'object', + 'required' => false, + 'example' => '{"LabelKey": "Value"}', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '**如无特殊需求，请保持留空即可。**'."\n" + ."\n" + .'链式授权配置，非必填。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '消息通知配置，详细内容请单击Notification查看，异步通知消息格式请参见[异步通知消息格式](~~2743997~~)。'."\n" + ."\n" + .'> 智能媒体管理目前接口调用回调不支持指定回调地址，建议您使用MNS。'."\n" + .'>', + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CA995EFD-083D-4F40-BE8A-BDF75FFF****', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'PointCloudCompress-badda57d-a3ab-4e6d-938f-49b77ce****', + ], + 'EventId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '0B7-1LR4Wcue1aBhk2xT85MfL*****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CA995EFD-083D-4F40-BE8A-BDF75FFF****\\",\\n \\"TaskId\\": \\"PointCloudCompress-badda57d-a3ab-4e6d-938f-49b77ce****\\",\\n \\"EventId\\": \\"0B7-1LR4Wcue1aBhk2xT85MfL*****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '创建点云压缩任务', + 'description' => '* **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + .'<notice>异步任务不保证时效。></notice>'."\n" + .'* 文件格式限制：当前仅支持PCD格式的点云文件。'."\n" + ."\n" + .'* 该接口为异步接口，获取任务开始执行后，任务信息只保存7天，超过7天则无法再获取。调用[GetTask](~~478241~~)或[ListTasks](~~478242~~)接口获取返回的`TaskId`，查看任务信息。也可以通过设置[Notification](~~2743997~~)消息通知参数，通过消息通知获取任务信息。>', + ], + 'DetectTextAnomaly' => [ + 'summary' => '检测指定文本内容中是否包含色情、广告、灌水、涉政、辱骂等违规信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '130698', + 'abilityTreeNodes' => [ + 'FEATUREimmUCA5MV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => '待检测文本，最长10,000个字符（包含标点），只支持检测中文文本。', + 'type' => 'string', + 'required' => true, + 'example' => 'content', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '91AC8C98-0F36-49D2-8290-742E24DF*****', + ], + 'Suggestion' => [ + 'description' => '文本内容是否合规。返回值如下：'."\n" + ."\n" + .'- pass：合规。'."\n" + ."\n" + .'- block：不合规。'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'pass' => '合规', + 'block' => '不合规', + ], + 'example' => 'pass', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"91AC8C98-0F36-49D2-8290-742E24DF*****\\",\\n \\"Suggestion\\": \\"pass\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '文本合规检测', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。'."\n" + .'> 文本合规检测只支持识别中文。', + ], + 'CreateImageModerationTask' => [ + 'summary' => '检测图片内容是否合规，包括色情内容、暴恐涉政、不良场景、logo、图文违规这几种检测场景。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '130695', + 'abilityTreeNodes' => [ + 'FEATUREimmRIZXZT', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息，在异步消息通知中会为您返回，方便您系统内对消息通知进行关联处理。最大长度为2048字节。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-data', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => '图片的OSS地址。'."\n" + ."\n" + .'OSS地址规则为`oss://<Bucket>/<Object>`，其中`<Bucket>`为和当前项目处于同一地域(Region)的OSS Bucket名称，`<Object>`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-object', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义标签，用于对异步任务进行搜索、过滤。', + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "User": "Jane"'."\n" + .'}', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '链式授权配置，非必填。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Scenes', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '图片检测场景。', + 'type' => 'array', + 'items' => [ + 'description' => '指定图片检测场景，取值如下：'."\n" + .'- porn：智能鉴黄。'."\n" + .' '."\n" + .'- terrorism：暴恐涉政。'."\n" + .' '."\n" + .'- live：不良场景。'."\n" + .' '."\n" + .'- logo：logo。'."\n" + .' '."\n" + .'- ad：图文违规。'."\n" + .'> 如果不指定检测场景，则默认进行`porn`、`terrorism`、`ad`三个场景检测。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ad' => '图文违规', + 'terrorism' => '暴恐涉政', + 'logo' => '包含logo', + 'live' => '不良场景', + 'porn' => '鉴黄', + ], + 'example' => 'porn', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '截帧频率，GIF图、长图检测专用。默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'MaxFrames', + 'in' => 'query', + 'schema' => [ + 'description' => '最大截帧数量，GIF图、长图检测专用，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '消息通知配置，详细内容请单击Notification查看，异步通知消息格式请参见[异步通知消息格式](~~2743997~~)。', + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'ImageModeration-179ef4f8-d583-4f0c-a293-7c0889c*****', + ], + 'EventId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '2E6-1I0FGn0zFnl5AflRfhzClma*****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\",\\n \\"TaskId\\": \\"ImageModeration-179ef4f8-d583-4f0c-a293-7c0889c*****\\",\\n \\"EventId\\": \\"2E6-1I0FGn0zFnl5AflRfhzClma*****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '创建图片合规检测任务', + 'description' => '* **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)。**'."\n" + .'<notice>异步任务不保证时效。></notice>'."\n" + .'* 图片要求：'."\n" + .' - 图片链接支持以下协议：HTTP和HTTPS。'."\n" + .' - 图片支持以下格式：PNG、JPG、JPEG、BMP、GIF、WEBP。'."\n" + .' - 图片大小限制为20 MB以内（适用于同步和异步调用），高度或者宽度不能超过30,000像素（px），且图像总像素不超过2.5亿（px）。其中，GIF格式的图片，图像总像素不超过4,194,304（px），高度或者宽度不能超过30,000像素（px）。'."\n" + .' - 图片下载时间限制为3秒内，如果下载时间超过3秒，返回下载超时。'."\n" + .' - 图片像素建议不低于256*256（px），像素过低可能会影响识别效果。'."\n" + .' - 图片检测接口的响应时间依赖图片的下载时间。请保证被检测图片所在的存储服务稳定可靠，建议您使用阿里云OSS存储或者CDN缓存等。'."\n" + .'* 该接口为异步接口，获取任务开始执行后，任务信息只保存7天，超过7天则无法再获取。调用[GetTask](~~478241~~)或[ListTasks](~~478242~~)接口获取返回的`TaskId`，查看任务信息。也可以通过设置[Notification](~~2743997~~)消息通知参数，通过消息通知获取任务信息。'."\n" + .'> 检测结果通过异步消息通知返回，异步消息通知Suggestion字段取值范围：'."\n" + .'> - pass：通过，未检测到不合规内容。'."\n" + .'> - block：检测到不合规内容，Categories字段为不合规分类，分类详情请参见内容安全检测结果。'."\n" + .'> - review：需要人工二次审核，人工审核完成后会再发一条异步消息通知告知人工审核结果。>', + ], + 'CreateVideoModerationTask' => [ + 'summary' => '检测视频中的风险或违规内容。具体包括以下场景：视频智能鉴黄、视频暴恐涉政、视频图文违规、视频不良场景、视频logo。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '130694', + 'abilityTreeNodes' => [ + 'FEATUREimmO3TV2W', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为2048字节。', + 'type' => 'string', + 'required' => false, + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + ], + [ + 'name' => 'SourceURI', + 'in' => 'query', + 'schema' => [ + 'description' => '视频的OSS地址。'."\n" + ."\n" + .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/test-object', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义标签信息，用于搜索任务。', + 'type' => 'object', + 'required' => false, + 'example' => '{"test": "val1"}', + ], + ], + [ + 'name' => 'CredentialConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '链式授权配置，非必填。更多信息，请参见[使用链式授权访问其他实体资源](~~465340~~)。', + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + ], + [ + 'name' => 'Scenes', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '视频检测场景。', + 'type' => 'array', + 'items' => [ + 'description' => '指定视频检测场景。取值如下：'."\n" + ."\n" + .'- porn：视频智能鉴黄。'."\n" + ."\n" + .'- terrorism：视频暴恐涉政。'."\n" + ."\n" + .'- live：视频不良场景。'."\n" + ."\n" + .'- logo：视频logo。'."\n" + ."\n" + .'- ad：视频图文违规。'."\n" + ."\n" + .'> 如果不指定视频检测场景，则默认进行`porn`、`terrorism`、`ad`三个场景检测。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ad' => '视频图文违规', + 'terrorism' => '视频暴恐涉政', + 'logo' => '视频logo', + 'live' => '视频不良场景', + 'porn' => '视频智能鉴黄', + ], + 'example' => 'porn', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '视频截帧间隔，单位为秒。取值范围为1~600，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MaxFrames', + 'in' => 'query', + 'schema' => [ + 'description' => '系统对本次检测的视频进行截帧的张数上限。取值范围为5~3600，默认值为200。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '消息通知配置，详细内容请单击Notification查看，异步通知消息格式请参见[异步通知消息格式](~~2743997~~)元数据索引一栏。', + 'required' => false, + '$ref' => '#/components/schemas/Notification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '1B3D5E0A-D8B8-4DA0-8127-ED32C851****', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'VideoModeration-9442a216-4691-4a48-846d-76daccaf*****', + ], + 'EventId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '2E6-1I0FGn0zFnl5AflRfhzClma*****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1B3D5E0A-D8B8-4DA0-8127-ED32C851****\\",\\n \\"TaskId\\": \\"VideoModeration-9442a216-4691-4a48-846d-76daccaf*****\\",\\n \\"EventId\\": \\"2E6-1I0FGn0zFnl5AflRfhzClma*****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '创建视频合规检测任务', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~88317~~)。**'."\n" + .'<notice>异步任务不保证时效。></notice>'."\n" + .'- 检测结果通过异步消息通知返回。异步消息通知Suggestion字段取值范围：'."\n" + .' - pass：通过，未检测到不合规内容。'."\n" + .' - block：检测到不合规内容，Categories字段为不合规分类，分类详情请参见[内容安全检测结果](~~2743995~~)。'."\n" + .' - review：需要人工二次审核，人工审核完成后会再发一条异步消息通知告知人工审核结果。'."\n" + .'- 视频截帧要求：'."\n" + .' - 视频帧链接支持以下协议：HTTP和HTTPS。'."\n" + .' - 视频帧支持以下格式：PNG、JPG、JPEG、BMP、GIF、WEBP。'."\n" + .' - 视频帧大小限制为10 MB以内。'."\n" + .' - 视频帧像素建议不低于256*256（px），像素过低可能会影响识别效果。'."\n" + .' - 视频检测接口的响应时间依赖视频帧的下载时间。请保证被检测视频帧所在的存储服务稳定可靠，建议您使用阿里云OSS存储或者CDN缓存等。'."\n" + .'- 该接口为异步接口，获取任务开始执行后，任务信息只保存7天，超过7天则无法再获取。调用[GetTask](~~478241~~)或[ListTasks](~~478242~~)接口获取返回的`TaskId`，查看任务信息。也可以通过设置[Notification](~~2743997~~)消息通知参数，通过消息通知获取任务信息。>', + ], + 'GetImageModerationResult' => [ + 'summary' => '获取图片合规检测任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '173754', + 'abilityTreeNodes' => [ + 'FEATUREimmRIZXZT', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'title' => 'TaskType', + 'description' => '任务类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'ImageModeration', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => 'TaskId', + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ImageModeration-ff207203-3f93-4645-a041-7b8f0f******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片检测结果', + 'description' => '图片检测结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求唯一Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E6A120B1-BEB3-0F63-A7C2-0783B6******', + ], + 'ProjectName' => [ + 'title' => '项目名称', + 'description' => '项目名称。', + 'type' => 'string', + 'example' => 'test-project', + ], + 'EventId' => [ + 'title' => '事件Id', + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '1B6-1XBMX3BixLMILvXVGtlkr******', + ], + 'Status' => [ + 'title' => '任务运行状态', + 'description' => '任务运行状态。取值范围如下：'."\n" + ."\n" + .'- Running：任务运行中。'."\n" + .'- Succeeded：任务执行完成，成功。'."\n" + .'- Failed：任务执行完成，失败。', + 'type' => 'string', + 'example' => 'Succeeded', + ], + 'Code' => [ + 'title' => '任务错误码', + 'description' => '任务错误码。', + 'type' => 'string', + 'example' => 'ResourceNotFound', + ], + 'Message' => [ + 'title' => '任务错误消息', + 'description' => '任务错误消息。', + 'type' => 'string', + 'example' => 'The specified resource TaskId is not found.', + ], + 'StartTime' => [ + 'title' => '任务开始时间', + 'description' => '任务开始时间。', + 'type' => 'string', + 'example' => '2023-04-03T09:44:31.029Z', + ], + 'EndTime' => [ + 'title' => '任务结束时间', + 'description' => '任务结束时间。', + 'type' => 'string', + 'example' => '2023-04-03T09:44:32Z', + ], + 'UserData' => [ + 'title' => '用户自定义信息', + 'description' => '用户自定义信息。', + 'type' => 'string', + 'example' => '{'."\n" + .' "fileId": "123"'."\n" + .'}', + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => '任务类型。', + 'type' => 'string', + 'example' => 'ImageModeration', + ], + 'TaskId' => [ + 'title' => '任务唯一ID', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'ImageModeration-ff207203-3f93-4645-a041-7b8f0f******', + ], + 'ModerationResult' => [ + 'description' => '合规检测结果。', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => 'OSS文件的存储位置。'."\n" + .'存储位置的地址规则为oss://${bucketname}/${objectname}，其中bucketname为和当前项目处于同一地域的OSS Bucket名称，objectname为文件路径。'."\n", + 'type' => 'string', + 'example' => 'oss://test-bucket/test-object', + ], + 'Suggestion' => [ + 'description' => '建议您执行的操作，取值包括：'."\n" + ."\n" + .'- pass：图片正常，无需进行其余操作。'."\n" + ."\n" + .'- review：检测结果不确定，需要进行人工审核。'."\n" + ."\n" + .'- block：图片违规，建议执行进一步操作（如直接删除或做限制处理）。', + 'type' => 'string', + 'example' => 'block', + ], + 'Categories' => [ + 'description' => '类⽬列表。', + 'type' => 'array', + 'items' => [ + 'description' => '类目。', + 'type' => 'string', + 'example' => 'porn', + ], + ], + 'Frames' => [ + 'description' => '视频、动图检测帧相关信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '检测的总帧数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'BlockFrames' => [ + 'description' => '违规的帧。', + 'type' => 'array', + 'items' => [ + 'description' => '违规的帧信息。', + 'type' => 'object', + 'properties' => [ + 'Rate' => [ + 'description' => '违规的置信度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '30', + ], + 'Offset' => [ + 'description' => '帧的偏移量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Label' => [ + 'description' => '违规的标签。', + 'type' => 'string', + 'example' => '{'."\n" + .' "test": "val"'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 500 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6A120B1-BEB3-0F63-A7C2-0783B6******\\",\\n \\"ProjectName\\": \\"test-project\\",\\n \\"EventId\\": \\"1B6-1XBMX3BixLMILvXVGtlkr******\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"Code\\": \\"ResourceNotFound\\",\\n \\"Message\\": \\"The specified resource TaskId is not found.\\",\\n \\"StartTime\\": \\"2023-04-03T09:44:31.029Z\\",\\n \\"EndTime\\": \\"2023-04-03T09:44:32Z\\",\\n \\"UserData\\": \\"{\\\\n \\\\\\"fileId\\\\\\": \\\\\\"123\\\\\\"\\\\n}\\",\\n \\"TaskType\\": \\"ImageModeration\\",\\n \\"TaskId\\": \\"ImageModeration-ff207203-3f93-4645-a041-7b8f0f******\\",\\n \\"ModerationResult\\": {\\n \\"URI\\": \\"oss://test-bucket/test-object\\",\\n \\"Suggestion\\": \\"block\\",\\n \\"Categories\\": [\\n \\"porn\\"\\n ],\\n \\"Frames\\": {\\n \\"TotalCount\\": 30,\\n \\"BlockFrames\\": [\\n {\\n \\"Rate\\": 30,\\n \\"Offset\\": 2,\\n \\"Label\\": \\"{\\\\n \\\\\\"test\\\\\\": \\\\\\"val\\\\\\"\\\\n}\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => '获取图片合规检测任务', + ], + 'GetVideoModerationResult' => [ + 'summary' => '获取视频合规检测任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '173750', + 'abilityTreeNodes' => [ + 'FEATUREimmO3TV2W', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'title' => 'TaskType', + 'description' => '任务类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'VideoModeration', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => 'TaskId', + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'VideoModeration-d0f0df1d-531d-4ab4-b353-e7f475******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片检测结果', + 'description' => '视频检测结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求唯一Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'VideoModeration-d0f0df1d-531d-4ab4-b353-e7f475******', + ], + 'ProjectName' => [ + 'title' => '项目名称', + 'description' => '项目名称。', + 'type' => 'string', + 'example' => 'test-project', + ], + 'EventId' => [ + 'title' => '事件Id', + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '05C-1XBQvsG2Tn5kBx2dUWo43******', + ], + 'Status' => [ + 'title' => '任务运行状态', + 'description' => '任务运行状态。取值范围如下：'."\n" + ."\n" + .'- Running：任务运行中。'."\n" + .'- Succeeded：任务执行成功。'."\n" + .'- Failed：任务执行失败。', + 'type' => 'string', + 'example' => 'Succeeded', + ], + 'Code' => [ + 'title' => '任务错误码', + 'description' => '任务错误码。', + 'type' => 'string', + 'example' => 'ResourceNotFound', + ], + 'Message' => [ + 'title' => '任务错误消息', + 'description' => '任务错误消息。', + 'type' => 'string', + 'example' => 'The specified resource TaskId is not found.', + ], + 'StartTime' => [ + 'title' => '任务开始时间', + 'description' => '任务开始时间。', + 'type' => 'string', + 'example' => '2023-04-03T10:20:41.432Z', + ], + 'EndTime' => [ + 'title' => '任务结束时间', + 'description' => '任务结束时间。', + 'type' => 'string', + 'example' => '2023-04-03T10:20:56.87Z', + ], + 'UserData' => [ + 'title' => '用户自定义信息', + 'description' => '用户自定义信息。', + 'type' => 'string', + 'example' => '{'."\n" + .' "id": "test-id",'."\n" + .' "name": "test-name"'."\n" + .'}', + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => '任务类型。', + 'type' => 'string', + 'example' => 'VideoModeration', + ], + 'TaskId' => [ + 'title' => '任务唯一ID', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'VideoModeration-d0f0df1d-531d-4ab4-b353-e7f4750******', + ], + 'ModerationResult' => [ + 'description' => '合规检测详情。', + 'type' => 'object', + 'properties' => [ + 'URI' => [ + 'description' => '文件URI。'."\n" + .'OSS文件的存储地址。地址规则为`oss://${bucketname}/${objectname}`，其中`bucketname`为和当前项目处于同一地域的OSS Bucket名称，`objectname`为文件路径。', + 'type' => 'string', + 'example' => 'oss://test-bucket/test-object', + ], + 'Suggestion' => [ + 'description' => '审核结果建议。取值：'."\n" + ."\n" + .'- **block**：违规。'."\n" + .'- **review**：疑似。'."\n" + .'- **pass**：通过。', + 'type' => 'string', + 'example' => 'block', + ], + 'Categories' => [ + 'description' => '类⽬列表。', + 'type' => 'array', + 'items' => [ + 'description' => '类目信息。', + 'type' => 'string', + 'example' => 'porn', + ], + ], + 'Frames' => [ + 'description' => '视频、动图检测帧相关信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '检测的总帧数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'BlockFrames' => [ + 'description' => '违规的帧。', + 'type' => 'array', + 'items' => [ + 'description' => '违规的帧信息。', + 'type' => 'object', + 'properties' => [ + 'Rate' => [ + 'description' => '违规的置信度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '10', + ], + 'Offset' => [ + 'description' => '帧的偏移量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Label' => [ + 'description' => '违规的标签。', + 'type' => 'string', + 'example' => '{"teat":"val"}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 500 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"VideoModeration-d0f0df1d-531d-4ab4-b353-e7f475******\\",\\n \\"ProjectName\\": \\"test-project\\",\\n \\"EventId\\": \\"05C-1XBQvsG2Tn5kBx2dUWo43******\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"Code\\": \\"ResourceNotFound\\",\\n \\"Message\\": \\"The specified resource TaskId is not found.\\",\\n \\"StartTime\\": \\"2023-04-03T10:20:41.432Z\\",\\n \\"EndTime\\": \\"2023-04-03T10:20:56.87Z\\",\\n \\"UserData\\": \\"{\\\\n \\\\\\"id\\\\\\": \\\\\\"test-id\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"test-name\\\\\\"\\\\n}\\",\\n \\"TaskType\\": \\"VideoModeration\\",\\n \\"TaskId\\": \\"VideoModeration-d0f0df1d-531d-4ab4-b353-e7f4750******\\",\\n \\"ModerationResult\\": {\\n \\"URI\\": \\"oss://test-bucket/test-object\\",\\n \\"Suggestion\\": \\"block\\",\\n \\"Categories\\": [\\n \\"porn\\"\\n ],\\n \\"Frames\\": {\\n \\"TotalCount\\": 12,\\n \\"BlockFrames\\": [\\n {\\n \\"Rate\\": 10,\\n \\"Offset\\": 1,\\n \\"Label\\": \\"{\\\\\\"teat\\\\\\":\\\\\\"val\\\\\\"}\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => '获取视频合规检测任务', + ], + 'GetTask' => [ + 'summary' => '该接口用于主动查询指定的异步任务信息。IMM支持多种异步数据处理能力，每种能力有各自创建任务的接口，例如创建人物人脸聚类任务CreateFigureClusteringTask、创建文件压缩任务CreateFileCompressionTask等。本接口为通用接口，可以通过任务ID和类型来查询异步任务的详细信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '106466', + 'abilityTreeNodes' => [ + 'FEATUREimmTGV2Z7', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'immtest', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'title' => 'TaskType', + 'description' => '任务的类型。取值范围请参见[任务类型列表](~~2743993~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'FileCompression', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => 'TaskId', + 'description' => '需要查询的任务ID，该值在创建任务时作为返回参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'FileCompression-2f157087-91df-4fda-8c3e-232407ec*****', + ], + ], + [ + 'name' => 'RequestDefinition', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回创建任务的原始请求参数，取值如下：'."\n" + .'- true。'."\n" + .'- false(默认值)。'."\n" + ."\n" + .'当前该参数仅对部分任务类型生效，支持的任务类型如下：'."\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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片检测结果', + 'description' => '查询到指定任务的详细信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求唯一Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2C5C1E0F-D8B8-4DA0-8127-EC32C771****', + ], + 'ProjectName' => [ + 'title' => '项目名称', + 'description' => '项目名称。', + 'type' => 'string', + 'example' => 'test-project', + ], + 'EventId' => [ + 'title' => '事件Id', + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '2F6-1Bz99Xi93EnRpNEyLudILJm****', + ], + 'Status' => [ + 'title' => '任务运行状态', + 'description' => '任务运行状态。取值范围如下：'."\n" + ."\n" + .'- Running：任务运行中。'."\n" + ."\n" + .'- Succeeded：任务执行完成，成功。'."\n" + ."\n" + .'- Failed：任务执行完成，失败。', + 'type' => 'string', + 'example' => 'Running', + ], + 'Code' => [ + 'title' => '任务错误码', + 'description' => '任务错误码。', + 'type' => 'string', + 'example' => 'ResourceNotFound', + ], + 'Message' => [ + 'title' => '任务错误消息', + 'description' => '任务错误消息。', + 'type' => 'string', + 'example' => 'The specified resource project is not found.', + ], + 'StartTime' => [ + 'title' => '任务开始时间', + 'description' => '任务开始时间。', + 'type' => 'string', + 'example' => '2021-12-24T03:01:41.662060377Z', + ], + 'EndTime' => [ + 'title' => '任务结束时间', + 'description' => '任务结束时间。', + 'type' => 'string', + 'example' => '2021-12-24T03:01:49.480109219Z', + ], + 'UserData' => [ + 'title' => '用户自定义信息', + 'description' => '用户自定义信息。', + 'type' => 'string', + 'example' => '{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}', + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => '任务的类型。取值范围请参见[任务类型列表](~~2743993~~)。', + 'type' => 'string', + 'example' => 'FileCompression', + ], + 'TaskId' => [ + 'title' => '任务唯一ID', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'c2b277b9-0d30-4882-ad6d-ad661382****', + ], + 'Tags' => [ + 'description' => '任务标签。用户在创建任务时传入的“Tag”标签。', + 'type' => 'object', + 'example' => '{"test": "val1"}', + ], + 'TaskRequestDefinition' => [ + 'description' => '创建任务的初始请求参数。', + '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' => '任务进度。取值范围为0~100，单位为百分比（%）。'."\n" + ."\n" + .'> - 目前GetTask接口暂不支持该参数。'."\n" + .'> - 该参数仅在任务运行状态`State`为`Running`时有意义。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2C5C1E0F-D8B8-4DA0-8127-EC32C771****\\",\\n \\"ProjectName\\": \\"test-project\\",\\n \\"EventId\\": \\"2F6-1Bz99Xi93EnRpNEyLudILJm****\\",\\n \\"Status\\": \\"Running\\",\\n \\"Code\\": \\"ResourceNotFound\\",\\n \\"Message\\": \\"The specified resource project is not found.\\",\\n \\"StartTime\\": \\"2021-12-24T03:01:41.662060377Z\\",\\n \\"EndTime\\": \\"2021-12-24T03:01:49.480109219Z\\",\\n \\"UserData\\": \\"{\\\\\\"ID\\\\\\": \\\\\\"user1\\\\\\",\\\\\\"Name\\\\\\": \\\\\\"test-user1\\\\\\",\\\\\\"Avatar\\\\\\": \\\\\\"http://example.com?id=user1\\\\\\"}\\",\\n \\"TaskType\\": \\"FileCompression\\",\\n \\"TaskId\\": \\"c2b277b9-0d30-4882-ad6d-ad661382****\\",\\n \\"Tags\\": {\\n \\"test\\": \\"val1\\"\\n },\\n \\"TaskRequestDefinition\\": \\"{\\\\n\\\\t\\\\\\"ProjectName\\\\\\":\\\\\\"test-project\\\\\\",\\\\n\\\\t\\\\\\"CompressedFormat\\\\\\":\\\\\\"zip\\\\\\",\\\\n\\\\t\\\\\\"TargetURI\\\\\\":\\\\\\"oss://test-bucket/output/test.zip\\\\\\",\\\\n\\\\t\\\\\\"Sources\\\\\\":[{\\\\\\"URI\\\\\\":\\\\\\"oss://test-bucket/input/test.jpg\\\\\\"}]\\\\n}\\",\\n \\"Progress\\": 100\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '获取任务信息', + 'description' => '**请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。', + ], + 'ListTasks' => [ + 'summary' => '该接口提供通过多种条件查询任务列表的功能。通过该接口可以查询指定时间范围内的任务、或者通过创建任务时指定的Tag搜索任务等。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '106467', + 'abilityTreeNodes' => [ + 'FEATUREimmTGV2Z7', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'TaskTypes', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '查询的任务类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务类型。取值范围请参见[任务类型列表](~~2743993~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '["OfficeConversion","VideoLabelClassification"]', + ], + 'required' => false, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'NextToken', + 'description' => '翻页标记。'."\n" + ."\n" + .'当文件总数大于设置的MaxResults时，用于翻页的Token。从NextToken开始按字典序返回文件信息列表。'."\n" + ."\n" + .'> 在一次查询中首次调用此接口时，将此值设置为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'title' => 'MaxResults', + 'description' => '返回结果列表中最大任务数量。取值范围为（0，100 ]，默认值为100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TagSelector', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义任务标签。在创建任务时如果指定了“Tag”参数，可以通过此参数进行搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'test=val1', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => '返回的任务信息列表排序规则。取值范围如下：'."\n" + ."\n" + .'- TaskId（默认）：任务ID。'."\n" + ."\n" + .'- StartTime：任务开始时间。'."\n" + ."\n" + .'- EndTime：任务结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => 'TaskId', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式。取值范围如下：'."\n" + ."\n" + .'- asc（默认）：升序'."\n" + ."\n" + .'- desc：降序', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => '升序', + 'desc' => '降序', + ], + 'example' => 'asc', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务运行状态。取值范围如下：'."\n" + ."\n" + .'- Running：任务运行中。'."\n" + ."\n" + .'- Succeeded：任务执行完成，成功。'."\n" + ."\n" + .'- Failed：任务执行完成，失败。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Succeeded' => '任务执行完成，成功', + 'Failed' => '任务执行完成，失败', + 'Running' => '任务运行中', + ], + 'example' => 'Succeeded', + ], + ], + [ + 'name' => 'StartTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '任务开始的时间范围。可筛选某段时间内开始执行的任务。', + 'required' => false, + '$ref' => '#/components/schemas/TimeRange', + ], + ], + [ + 'name' => 'EndTimeRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '任务结束的时间范围。可筛选某段时间内结束执行的任务。', + 'required' => false, + '$ref' => '#/components/schemas/TimeRange', + ], + ], + [ + 'name' => 'RequestDefinition', + 'in' => 'query', + 'schema' => [ + 'description' => '是否需要返回创建任务的初始请求参数，默认值为False。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '图片检测结果', + 'description' => '符合条件的任务列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求唯一Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9847E7D0-A9A3-0053-84C6-BA16FFFA726E', + ], + 'ProjectName' => [ + 'title' => '项目名称', + 'description' => '项目名称。', + 'type' => 'string', + 'example' => 'immtest', + ], + 'NextToken' => [ + 'title' => '翻页标记', + 'description' => '翻页标记。当任务列表总数大于设置的MaxResults时，用于翻页的Token。符合条件的任务列表未全部返回时，此参数才有值。'."\n" + ."\n" + .'下一次列出任务列表时将此值作为NextToken传入，将后续的任务列表返回。', + 'type' => 'string', + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', + ], + 'MaxResults' => [ + 'title' => '最大结果数量', + 'description' => '本次返回的任务列表长度。', + 'type' => 'string', + 'example' => '1', + ], + 'Tasks' => [ + 'title' => '任务信息', + 'description' => '任务信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务的详细信息。', + '$ref' => '#/components/schemas/TaskInfo', + ], + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9847E7D0-A9A3-0053-84C6-BA16FFFA726E\\",\\n \\"ProjectName\\": \\"immtest\\",\\n \\"NextToken\\": \\"MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==\\",\\n \\"MaxResults\\": \\"1\\",\\n \\"Tasks\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"UserData\\": \\"\\",\\n \\"TaskType\\": \\"\\",\\n \\"TaskId\\": \\"\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"TaskRequestDefinition\\": \\"\\",\\n \\"Progress\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '查询任务列表', + 'description' => '**请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~477042~~)**。', + ], + 'CreateTrigger' => [ + 'summary' => '创建触发器任务，可通过OSS等事件源触发IMM数据处理，支持选择多种数据处理模板，对图片、视频、文档等媒体文件执行相应的处理。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '135761', + 'abilityTreeNodes' => [ + 'FEATUREimmJ1ILHI', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Input', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '输入的数据源配置。', + 'required' => true, + '$ref' => '#/components/schemas/Input', + ], + ], + [ + 'name' => 'Actions', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '处理模板列表。', + 'type' => 'array', + 'items' => [ + 'description' => '模版信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '模板名字。', + 'type' => 'string', + 'required' => true, + 'example' => 'doc/convert', + ], + 'Parameters' => [ + 'description' => '模板参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '模版参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'pages=3', + ], + 'required' => false, + ], + 'FastFailPolicy' => [ + 'description' => '快速失败执行策略配置。', + 'required' => false, + '$ref' => '#/components/schemas/FastFailPolicy', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Notification', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '消息通知对象，支持多种消息中间件，消息格式详情请见异步通知消息格式，请选择其中一种方式接收消息，使用方式如下所示：'."\n" + ."\n" + .'在与智能媒体管理相同的地域下开通并接入事件总线EventBridge服务，及时获取任务信息通知。更多信息，请参见智能媒体管理IMM事件。 在与智能媒体管理相同的地域下开通MNS服务，并配置订阅关系。', + 'type' => 'object', + 'properties' => [ + 'MNS' => [ + 'description' => 'MNS通知参数对象。', + 'required' => false, + '$ref' => '#/components/schemas/MNS', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义标签，用于对异步任务进行搜索、过滤。', + 'type' => 'object', + 'required' => false, + 'example' => '{"key":"val"}', + ], + ], + [ + 'name' => 'ServiceRole', + 'in' => 'formData', + 'schema' => [ + 'description' => '服务角色，授权给IMM服务以访问其他云资源（例如OSS）的权限，默认值为AliyunIMMBatchTriggerRole。'."\n" + ."\n" + .'如果要自定义服务角色，您可以通过RAM控制台创建普通服务角色并为角色授权。具体操作，请分别参见[创建普通服务角色](~~116800~~)和[为角色授权](~~116147~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'AliyunIMMBatchTriggerRole', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID。', + 'type' => 'string', + 'example' => 'EC564A9A-BA5C-4499-A087-D9B9E76E*****', + ], + 'Id' => [ + 'description' => '数据接入ID。', + 'type' => 'string', + 'example' => 'trigger-9f72636a-0f0c-4baf-ae78-38b27b******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EC564A9A-BA5C-4499-A087-D9B9E76E*****\\",\\n \\"Id\\": \\"trigger-9f72636a-0f0c-4baf-ae78-38b27b******\\"\\n}","type":"json"}]', + 'title' => '创建触发器', + 'description' => '创建触发器任务，如果需要通过[对象存储数据处理方式](~~99372~~)进行数据处理，请确保已经完成了[绑定对象存储桶](~~478206~~)的操作。', + ], + 'SuspendTrigger' => [ + 'summary' => '将一个 Running（正在执行）状态的触发器暂停。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '135764', + 'abilityTreeNodes' => [ + 'FEATUREimmJ1ILHI', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据接入ID，获取方式请参见[创建触发器](~~479912~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'trigger-9f72636a-0f0c-4baf-ae78-38b27b******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0BC1F0C9-8E99-46C6-B502-10DED******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0BC1F0C9-8E99-46C6-B502-10DED******\\"\\n}","type":"json"}]', + 'title' => '暂停触发器', + 'description' => '任务状态 Running（正在执行）时，可以暂停任务。如果想继续执行，需要调用[ResumeTrigger](~~479919~~)接口。', + ], + 'ResumeTrigger' => [ + 'summary' => '将一个Suspended（暂停）或Failed（失败）状态的触发器恢复。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '135767', + 'abilityTreeNodes' => [ + 'FEATUREimmJ1ILHI', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据接入ID，获取方式请参见[创建触发器](~~479912~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'trigger-9f72636a-0f0c-4baf-ae78-38b27b******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FEDC9B1F-30F2-4C1F-8ED2-B7860187****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FEDC9B1F-30F2-4C1F-8ED2-B7860187****\\"\\n}","type":"json"}]', + 'title' => '恢复触发器', + 'description' => '只有Suspended（暂停），Failed（失败）状态的触发器可以恢复，恢复后继续执行未完成的任务。', + ], + 'UpdateTrigger' => [ + 'summary' => '更新触发器信息，如输入的数据源配置、数据处理的配置、触发器标签等信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '135765', + 'abilityTreeNodes' => [ + 'FEATUREimmJ1ILHI', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据接入ID，获取方式请参见[创建触发器](~~479912~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'trigger-9f72636a-0f0c-4baf-ae78-38b27b******', + ], + ], + [ + 'name' => 'Input', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '输入的数据源配置。', + 'required' => false, + '$ref' => '#/components/schemas/Input', + ], + ], + [ + 'name' => 'Actions', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '处理模板列表。', + 'type' => 'array', + 'items' => [ + 'description' => '模版信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '模版名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'doc/convert', + ], + 'Parameters' => [ + 'description' => '模版参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '模版参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'pages=3', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义标签，用于对异步任务进行搜索、过滤。', + 'type' => 'object', + 'required' => false, + 'example' => '{"test": "val1"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5A022F78-B9A8-4ACC-BB6B-B35975******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A022F78-B9A8-4ACC-BB6B-B35975******\\"\\n}","type":"json"}]', + 'title' => '更新触发器', + 'description' => '- 只有Ready（就绪）和Failed（失败）状态的触发器任务可以更新，更新不会改变任务状态。'."\n" + .'- 更新完成后，之前未完成的触发器任务不再执行，您可以调用[ResumeTrigger](~~479916~~)接口恢复此触发器任务的执行。', + ], + 'GetTrigger' => [ + 'summary' => '获取触发器信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '135766', + 'abilityTreeNodes' => [ + 'FEATUREimmJ1ILHI', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '数据接入ID，获取方式请参见[创建触发器](~~479912~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'trigger-9f72636a-0f0c-4baf-ae78-38b27b******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Trigger' => [ + 'description' => '数据接入信息。', + '$ref' => '#/components/schemas/DataIngestion', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4A7A2D0E-D8B8-4DA0-8127-EB32C6******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Trigger\\": {\\n \\"Id\\": \\"\\",\\n \\"Input\\": {\\n \\"OSS\\": {\\n \\"Bucket\\": \\"\\",\\n \\"Prefix\\": \\"\\",\\n \\"MatchExpressions\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Actions\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": [\\n \\"\\"\\n ],\\n \\"FastFailPolicy\\": {\\n \\"Action\\": \\"abort\\"\\n }\\n }\\n ],\\n \\"Notification\\": {\\n \\"Endpoint\\": \\"\\",\\n \\"Topic\\": \\"\\",\\n \\"MNS\\": {\\n \\"TopicName\\": \\"\\",\\n \\"Endpoint\\": \\"\\"\\n },\\n \\"RocketMQ\\": {\\n \\"Endpoint\\": \\"\\",\\n \\"TopicName\\": \\"\\",\\n \\"InstanceId\\": \\"\\"\\n }\\n },\\n \\"Statistic\\": {\\n \\"SubmitSuccess\\": 0,\\n \\"SubmitFailure\\": 0,\\n \\"SkipFiles\\": 0\\n },\\n \\"State\\": \\"\\",\\n \\"Marker\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Error\\": \\"\\",\\n \\"Phase\\": \\"IncrementalScanning\\",\\n \\"ServiceRole\\": \\"AliyunIMMBatchTriggerRole\\"\\n },\\n \\"RequestId\\": \\"4A7A2D0E-D8B8-4DA0-8127-EB32C6******\\"\\n}","type":"json"}]', + 'title' => '获取触发器信息', + ], + 'ListTriggers' => [ + 'summary' => '查询触发器任务列表，支持排序，支持按照任务标签，任务状态等条件查询。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '135763', + 'abilityTreeNodes' => [ + 'FEATUREimmJ1ILHI', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态：'."\n" + ."\n" + .'- Ready：任务就绪，刚创建的任务处于Ready状态。'."\n" + .'- Running：正在执行，正常执行的任务状态。'."\n" + .'- Failed：任务失败，任务执行出错，且无法自动恢复。'."\n" + .'- Suspended：任务暂停。'."\n" + .'- Succeeded：任务执行完成。', + 'type' => 'string', + 'required' => false, + 'example' => 'Succeeded', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段，取值范围如下：'."\n" + ."\n" + .'- CreateTime：按任务创建时间排序。'."\n" + ."\n" + .'- UpdateTime：按任务更新时间排序。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-11-11T06:51:17.5Z'."\n", + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式，默认值为DESC。'."\n" + ."\n" + .'- ASC：升序'."\n" + .'- DESC：降序', + 'type' => 'string', + 'required' => false, + 'example' => 'ASC', + ], + ], + [ + 'name' => 'TagSelector', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义任务标签。在创建任务时如果指定了“Tags”参数，可以通过此参数进行搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'test=val1', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '翻页标记。'."\n" + ."\n" + .'当文件总数大于设置的MaxResults时，用于翻页的Token。从NextToken开始按字典序返回文件信息列表。'."\n" + ."\n" + .'第一次调用此接口时，设置为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '返回文件的最大个数，取值范围为0~100。'."\n" + ."\n" + .'不设置此参数或者设置为0时，则默认值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Triggers' => [ + 'description' => '触发器列表', + 'type' => 'array', + 'items' => [ + 'description' => '任务信息。', + '$ref' => '#/components/schemas/DataIngestion', + ], + ], + 'NextToken' => [ + 'description' => '翻页标记。'."\n" + ."\n" + .'当文件总数大于设置的MaxResults时，用于翻页的Token。从NextToken开始按字典序返回文件信息列表。'."\n" + ."\n" + .'第一次调用此接口时，设置为空。', + 'type' => 'string', + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F480BFAF-E778-5079-93AD-1E4631******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Triggers\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Input\\": {\\n \\"OSS\\": {\\n \\"Bucket\\": \\"\\",\\n \\"Prefix\\": \\"\\",\\n \\"MatchExpressions\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Actions\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": [\\n \\"\\"\\n ],\\n \\"FastFailPolicy\\": {\\n \\"Action\\": \\"abort\\"\\n }\\n }\\n ],\\n \\"Notification\\": {\\n \\"Endpoint\\": \\"\\",\\n \\"Topic\\": \\"\\",\\n \\"MNS\\": {\\n \\"TopicName\\": \\"\\",\\n \\"Endpoint\\": \\"\\"\\n },\\n \\"RocketMQ\\": {\\n \\"Endpoint\\": \\"\\",\\n \\"TopicName\\": \\"\\",\\n \\"InstanceId\\": \\"\\"\\n }\\n },\\n \\"Statistic\\": {\\n \\"SubmitSuccess\\": 0,\\n \\"SubmitFailure\\": 0,\\n \\"SkipFiles\\": 0\\n },\\n \\"State\\": \\"\\",\\n \\"Marker\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Error\\": \\"\\",\\n \\"Phase\\": \\"IncrementalScanning\\",\\n \\"ServiceRole\\": \\"AliyunIMMBatchTriggerRole\\"\\n }\\n ],\\n \\"NextToken\\": \\"MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==\\",\\n \\"RequestId\\": \\"F480BFAF-E778-5079-93AD-1E4631******\\"\\n}","type":"json"}]', + 'title' => '查询触发器列表', + ], + 'DeleteTrigger' => [ + 'summary' => '删除指定的触发器。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '135762', + 'abilityTreeNodes' => [ + 'FEATUREimmJ1ILHI', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '数据接入ID，获取方式请参见[创建触发器](~~479912~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'trigger-9f72636a-0f0c-4baf-ae78-38b27b******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FEDC9B1F-30F2-4C1F-8ED2-B7860187****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FEDC9B1F-30F2-4C1F-8ED2-B7860187****\\"\\n}","type":"json"}]', + 'title' => '删除触发器', + 'description' => '当任务状态处于Ready（就绪），Failed（失败），Suspended（暂停），Succeeded（完成）时可以删除，正在Running（执行）的任务不能删除。', + ], + 'CreateBatch' => [ + 'summary' => '创建一个批处理任务。指定存储内已存在的若干文件，对其批量执行指定操作，如转码、格式转换等。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '131090', + 'abilityTreeNodes' => [ + 'FEATUREimmTATRRB', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Input', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '输入的数据源配置。', + 'required' => true, + '$ref' => '#/components/schemas/Input', + ], + ], + [ + 'name' => 'Actions', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '处理模板列表。', + 'type' => 'array', + 'items' => [ + 'description' => '处理模板。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '模板名字。', + 'type' => 'string', + 'required' => true, + 'example' => 'doc/convert', + ], + 'Parameters' => [ + 'description' => '模板参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '模板参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'pages=3', + ], + 'required' => false, + ], + 'FastFailPolicy' => [ + 'description' => '快速失败执行策略配置。', + 'required' => false, + '$ref' => '#/components/schemas/FastFailPolicy', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Notification', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '消息通知对象，支持多种消息中间件，消息格式详情请见异步通知消息格式，请选择其中一种方式接收消息，使用方式如下所示：'."\n" + ."\n" + .'在与智能媒体管理相同的地域下开通并接入事件总线EventBridge服务，及时获取任务信息通知。更多信息，请参见智能媒体管理IMM事件。'."\n" + .'在与智能媒体管理相同的地域下开通MNS服务，并配置订阅关系。', + 'type' => 'object', + 'properties' => [ + 'MNS' => [ + 'description' => 'MNS通知参数对象。', + 'required' => false, + '$ref' => '#/components/schemas/MNS', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义标签，用于对异步任务进行搜索、过滤。', + 'type' => 'object', + 'required' => false, + 'example' => '{"key": "val"}'."\n", + ], + ], + [ + 'name' => 'ServiceRole', + 'in' => 'formData', + 'schema' => [ + 'description' => '服务角色，授权给IMM服务以访问其他云资源（例如OSS）的权限，默认值为AliyunIMMBatchTriggerRole。'."\n" + ."\n" + .'如果要自定义服务角色，您可以通过RAM控制台创建普通服务角色并为角色授权。具体操作，请分别参见[创建普通服务角色](~~116800~~)和[为角色授权](~~116147~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'AliyunIMMBatchTriggerRole', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EC564A9A-BA5C-4499-A087-D9B9E76E*****', + ], + 'Id' => [ + 'description' => '批处理任务ID。', + 'type' => 'string', + 'example' => 'batch-4eb9223f-3e88-42d3-a578-3f2852******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EC564A9A-BA5C-4499-A087-D9B9E76E*****\\",\\n \\"Id\\": \\"batch-4eb9223f-3e88-42d3-a578-3f2852******\\"\\n}","type":"json"}]', + 'title' => '创建批处理任务', + 'description' => '创建批处理任务，如果需要通过[对象存储数据处理方式](~~99372~~)进行数据处理，请确保已经完成了[绑定对象存储桶](~~478206~~)的操作。', + ], + 'SuspendBatch' => [ + 'summary' => '将一个 Running（正在执行）的批处理任务暂停。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '131169', + 'abilityTreeNodes' => [ + 'FEATUREimmTATRRB', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '批处理任务ID，获取方式请参见[创建批处理](~~606694~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'batch-4eb9223f-3e88-42d3-a578-3f2852******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EC564A9A-BA5C-4499-A087-D9B9E76E*****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EC564A9A-BA5C-4499-A087-D9B9E76E*****\\"\\n}","type":"json"}]', + 'title' => '暂停批处理任务', + 'description' => '任务状态 Running（正在执行）时，可以暂停任务。如果想继续执行，需要调用[ResumeBatch](~~479914~~)接口。', + ], + 'ResumeBatch' => [ + 'summary' => '将一个Suspend（暂停）或Failed（失败）的批处理任务恢复。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '131172', + 'abilityTreeNodes' => [ + 'FEATUREimmTATRRB', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '批处理任务ID，获取方式请参见[创建批处理](~~606694~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'batch-4eb9223f-3e88-42d3-a578-3f2852******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D2C628B8-35DF-473C-8A41-757F30******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D2C628B8-35DF-473C-8A41-757F30******\\"\\n}","type":"json"}]', + 'title' => '恢复批处理任务', + 'description' => '只有Suspended（暂停），Failed（失败）状态的批处理任务可以恢复，恢复后继续执行未完成的任务。', + ], + 'UpdateBatch' => [ + 'summary' => '更新批处理任务信息。如输入的数据源配置、数据处理的配置、批处理任务标签等信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '131143', + 'abilityTreeNodes' => [ + 'FEATUREimmTATRRB', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '批处理任务ID，获取方式请参见[创建批处理](~~606694~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'batch-4eb9223f-3e88-42d3-a578-3f2852******', + ], + ], + [ + 'name' => 'Input', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '输入的数据源配置。', + 'required' => false, + '$ref' => '#/components/schemas/Input', + ], + ], + [ + 'name' => 'Actions', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '处理模板列表。', + 'type' => 'array', + 'items' => [ + 'description' => '模板信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'doc/convert', + ], + 'Parameters' => [ + 'description' => '模版参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '模版参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'pages=3', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义标签，用于对异步任务进行搜索、过滤。', + 'type' => 'object', + 'required' => false, + 'example' => '{"key":"val"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CB4D73A3-BAF4-4A9D-A631-15F219AF****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB4D73A3-BAF4-4A9D-A631-15F219AF****\\"\\n}","type":"json"}]', + 'title' => '更新批处理任务', + 'description' => '- 更新批处理任务时，当批处理任务状态处于Ready（就绪）或Failed（失败）时可以更新，更新时不会改变当前的任务状态。'."\n" + .'- 更新完成后，之前未完成的批处理任务不会继续自动执行，您可以调用[ResumeBatch](~~479914~~)接口恢复此批处理任务的执行。', + ], + 'ListBatches' => [ + 'summary' => '查询批处理任务列表，支持排序，支持按照任务标签，任务状态等条件查询。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '131116', + 'abilityTreeNodes' => [ + 'FEATUREimmTATRRB', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '批处理任务状态：'."\n" + ."\n" + .'- Ready：任务就绪，刚创建的任务处于Ready状态。'."\n" + .'- Running：正在执行，正常执行的任务状态。'."\n" + .'- Failed：任务失败，任务执行出错，且无法自动恢复。'."\n" + .'- Suspended：任务暂停。'."\n" + .'- Succeeded：任务执行完成。', + 'type' => 'string', + 'required' => false, + 'example' => 'Succeed', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段，取值范围如下：'."\n" + ."\n" + .'- CreateTime：按任务创建时间排序。'."\n" + ."\n" + .'- UpdateTime：按任务更新时间排序。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-11-11T06:51:17.5Z', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式。取值范围如下：'."\n" + ."\n" + .'- ASC（默认）：升序'."\n" + ."\n" + .'- DES：降序', + 'type' => 'string', + 'required' => false, + 'example' => 'ASC', + ], + ], + [ + 'name' => 'TagSelector', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义任务标签。在创建任务时如果指定了“Tags”参数，可以通过此参数进行搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'test=val1', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '翻页标记。'."\n" + ."\n" + .'当文件总数大于设置的MaxResults时，用于翻页的Token。从NextToken开始按字典序返回文件信息列表。'."\n" + ."\n" + .'第一次调用此接口时，设置为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '返回文件的最大个数，取值范围为0~100。'."\n" + ."\n" + .'不设置此参数或者设置为0时，则默认值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Batches' => [ + 'description' => '批处理任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '批处理任务信息。', + '$ref' => '#/components/schemas/DataIngestion', + ], + ], + 'NextToken' => [ + 'description' => '翻页标记。'."\n" + ."\n" + .'当文件总数大于设置的MaxResults时，用于翻页的Token。从NextToken开始按字典序返回文件信息列表。'."\n" + ."\n" + .'第一次调用此接口时，设置为空。', + 'type' => 'string', + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FEDC9B1F-30F2-4C1F-8ED2-B7860187****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Batches\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Input\\": {\\n \\"OSS\\": {\\n \\"Bucket\\": \\"\\",\\n \\"Prefix\\": \\"\\",\\n \\"MatchExpressions\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Actions\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": [\\n \\"\\"\\n ],\\n \\"FastFailPolicy\\": {\\n \\"Action\\": \\"abort\\"\\n }\\n }\\n ],\\n \\"Notification\\": {\\n \\"Endpoint\\": \\"\\",\\n \\"Topic\\": \\"\\",\\n \\"MNS\\": {\\n \\"TopicName\\": \\"\\",\\n \\"Endpoint\\": \\"\\"\\n },\\n \\"RocketMQ\\": {\\n \\"Endpoint\\": \\"\\",\\n \\"TopicName\\": \\"\\",\\n \\"InstanceId\\": \\"\\"\\n }\\n },\\n \\"Statistic\\": {\\n \\"SubmitSuccess\\": 0,\\n \\"SubmitFailure\\": 0,\\n \\"SkipFiles\\": 0\\n },\\n \\"State\\": \\"\\",\\n \\"Marker\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Error\\": \\"\\",\\n \\"Phase\\": \\"IncrementalScanning\\",\\n \\"ServiceRole\\": \\"AliyunIMMBatchTriggerRole\\"\\n }\\n ],\\n \\"NextToken\\": \\"MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****\\",\\n \\"RequestId\\": \\"FEDC9B1F-30F2-4C1F-8ED2-B7860187****\\"\\n}","type":"json"}]', + 'title' => '查询批处理任务列表', + ], + 'GetBatch' => [ + 'summary' => '获取批处理任务信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '131105', + 'abilityTreeNodes' => [ + 'FEATUREimmTATRRB', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '批处理任务ID，获取方式请参见[创建批处理](~~606694~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'batch-4eb9223f-3e88-42d3-a578-3f2852******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Batch' => [ + 'description' => '批处理任务信息。', + '$ref' => '#/components/schemas/DataIngestion', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Batch\\": {\\n \\"Id\\": \\"\\",\\n \\"Input\\": {\\n \\"OSS\\": {\\n \\"Bucket\\": \\"\\",\\n \\"Prefix\\": \\"\\",\\n \\"MatchExpressions\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Actions\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": [\\n \\"\\"\\n ],\\n \\"FastFailPolicy\\": {\\n \\"Action\\": \\"abort\\"\\n }\\n }\\n ],\\n \\"Notification\\": {\\n \\"Endpoint\\": \\"\\",\\n \\"Topic\\": \\"\\",\\n \\"MNS\\": {\\n \\"TopicName\\": \\"\\",\\n \\"Endpoint\\": \\"\\"\\n },\\n \\"RocketMQ\\": {\\n \\"Endpoint\\": \\"\\",\\n \\"TopicName\\": \\"\\",\\n \\"InstanceId\\": \\"\\"\\n }\\n },\\n \\"Statistic\\": {\\n \\"SubmitSuccess\\": 0,\\n \\"SubmitFailure\\": 0,\\n \\"SkipFiles\\": 0\\n },\\n \\"State\\": \\"\\",\\n \\"Marker\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Error\\": \\"\\",\\n \\"Phase\\": \\"IncrementalScanning\\",\\n \\"ServiceRole\\": \\"AliyunIMMBatchTriggerRole\\"\\n },\\n \\"RequestId\\": \\"6E93D6C9-5AC0-49F9-914D-E02678D3****\\"\\n}","type":"json"}]', + 'title' => '获取批处理任务信息', + ], + 'DeleteBatch' => [ + 'summary' => '删除指定的一个批处理任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '131141', + 'abilityTreeNodes' => [ + 'FEATUREimmTATRRB', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '批处理任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'batch-4eb9223f-3e88-42d3-a578-3f2852******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '91AC8C98-0F36-49D2-8290-742E24******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"91AC8C98-0F36-49D2-8290-742E24******\\"\\n}","type":"json"}]', + 'title' => '删除批处理任务', + 'description' => '- 删除批处理任务时，当任务状态处于Ready（就绪），Failed（失败），Suspended（暂停），Succeeded（完成）时可以删除，其他运行中的状态禁止删除。'."\n" + .'- 删除批处理任务时，可以先通过[GetBatch](~~479922~~)查询批处理任务状态，确保能够顺利删除任务。', + ], + 'ListAttachedOSSBuckets' => [ + 'summary' => '查询项目（Project）所绑定的所有OSS Bucket信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '185053', + 'abilityTreeNodes' => [ + 'FEATUREimmKH590Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => '项目名称', + 'description' => '项目名称，获取方式请参见[创建项目](~~478153~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '返回结果列表中最大任务数量。取值范围为（0，200]，默认值为100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '翻页标记。'."\n" + ."\n" + .'当文件总数大于设置的MaxResults时，用于翻页的Token。从NextToken开始按字典序返回文件信息列表。'."\n" + ."\n" + .'> 在一次查询中首次调用此接口时，将此值设置为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结构体', + 'description' => '响应结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9847E7D0-A9A3-0053-84C6-BA16FF******', + ], + 'NextToken' => [ + 'description' => '翻页标记。当任务列表总数大于设置的MaxResults时，用于翻页的Token。符合条件的任务列表未全部返回时，此参数才有值。'."\n" + ."\n" + .'下一次列出任务列表时将此值作为NextToken传入，将后续的任务列表返回。', + 'type' => 'string', + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==', + ], + 'AttachedOSSBuckets' => [ + 'description' => '绑定的OSS Bucket列表。', + 'type' => 'array', + 'items' => [ + 'description' => '绑定关系信息。', + 'type' => 'object', + 'properties' => [ + 'OwnerId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '1023***********', + ], + 'ProjectName' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'example' => 'test-project', + ], + 'OSSBucket' => [ + 'description' => 'OSS Bucket名称。', + 'type' => 'string', + 'example' => 'test-bucket', + ], + 'CreateTime' => [ + 'description' => '项目创建时间的时间戳，格式为RFC3339Nano。', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + ], + 'UpdateTime' => [ + 'description' => '项目修改时间的时间戳，格式为RFC3339Nano。', + 'type' => 'string', + 'example' => '2021-06-29T14:50:13.011643661+08:00', + ], + 'Description' => [ + 'description' => '描述', + 'type' => 'string', + 'example' => 'test bucket', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9847E7D0-A9A3-0053-84C6-BA16FF******\\",\\n \\"NextToken\\": \\"MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==\\",\\n \\"AttachedOSSBuckets\\": [\\n {\\n \\"OwnerId\\": \\"1023***********\\",\\n \\"ProjectName\\": \\"test-project\\",\\n \\"OSSBucket\\": \\"test-bucket\\",\\n \\"CreateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"UpdateTime\\": \\"2021-06-29T14:50:13.011643661+08:00\\",\\n \\"Description\\": \\"test bucket\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '列举OSS Bucket绑定关系', + 'description' => '- **请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](~~88317~~)。**'."\n" + .'- 请确保已经调用[绑定对象存储桶](～～478206～～)将OSS Bucket绑定到项目上。', + ], + 'ContextualAnswer' => [ + 'summary' => 'AI助手的问答API，用于生成对话中的问答内容，能够根据上下文提供相关的回答。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'sse', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226491', + 'abilityTreeNodes' => [ + 'FEATUREimmDN11M0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '项目名称，获取方式请参见[创建项目](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' => '是 对话历史以及工具调用历史。最新的消息在最尾（index为n-1），最旧的消息在最头（index为0）。'."\n" + .'限制必须是user-assistant成对的形式，条数为2*n+1条，并且最新的提问的长度不超过1000个字符长度。'."\n" + .'历史对话长度限制在100以内。', + 'type' => 'array', + 'items' => [ + 'description' => '会话消息的列表', + 'required' => false, + '$ref' => '#/components/schemas/ContextualMessage', + ], + 'required' => true, + ], + ], + [ + 'name' => 'Files', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '当前问答涉及到的文件内容，推荐使用 ContextualRetrieval 接口的返回作为入参。', + 'type' => 'array', + 'items' => [ + 'description' => '问答涉及的文件列表', + 'required' => false, + '$ref' => '#/components/schemas/ContextualFile', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '22F081FB-90D7-525A-BFE4-D28DC906A28F', + ], + 'Answer' => [ + 'description' => '大模型回答的内容。', + '$ref' => '#/components/schemas/Answer', + ], + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'ResourceNotFound', + ], + 'Message' => [ + 'description' => '错误消息', + 'type' => 'string', + 'example' => 'The specified resource project is not found.', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22F081FB-90D7-525A-BFE4-D28DC906A28F\\",\\n \\"Answer\\": {\\n \\"Content\\": \\"你好\\",\\n \\"References\\": [\\n {\\n \\"ProjectName\\": \\"test-project\\",\\n \\"DatasetName\\": \\"test-dataset\\",\\n \\"ObjectId\\": \\"75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7\\",\\n \\"URI\\": \\"oss://test-bucket/test-object.jpg\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"ResourceNotFound\\",\\n \\"Message\\": \\"The specified resource project is not found.\\"\\n}","type":"json"}]', + 'title' => 'AI 助手中的问答API', + 'description' => '### 注意事项'."\n" + ."\n" + .'- 请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](https://help.aliyun.com/zh/imm/product-overview/billable-items?spm=openapi-amp.newDocPublishment.0.0.1ecd281fi27Zgk)。'."\n" + ."\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" + .'- 返回结果仅为示例，根据[工作流模板配置](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个汉字。', + ], + 'ContextualRetrieval' => [ + 'summary' => '检索API专为多轮对话场景设计，能够处理包含对话历史的消息输入，精准检索语义相近文档。通过深度解析上下文信息，该接口确保检索结果与当前对话内容高度相关，适用于复杂交互环境，为多轮对话提供一致且高效的信息检索服务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226437', + 'abilityTreeNodes' => [ + 'FEATUREimmDN11M0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '项目名称，获取方式请参见[创建项目](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' => '用于检索的 Dataset 数据集。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dataset', + ], + ], + [ + 'name' => 'Messages', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '对话历史以及工具调用历史。最新的消息在最尾（index为n-1），最旧的消息在最头（index为0）。'."\n" + .'限制必须是user-assistant成对的形式，条数为2*n+1条，并且最新的提问的长度不超过1000个字符长度。'."\n" + .'历史对话长度限制在100以内。', + 'type' => 'array', + 'items' => [ + 'description' => '会话消息的列表', + 'required' => false, + '$ref' => '#/components/schemas/ContextualMessage', + ], + 'required' => true, + ], + ], + [ + 'name' => 'RecallOnly', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只开启召回过程（Embedding搜索），如果该配置为true，意味着拿到的数据返回没有经过Rerank，可以支持用户自定义Rerank过程。'."\n" + .'默认为false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'SmartClusterIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '智能分组ID的列表，用于在特定智能分组内检索文件。', + 'type' => 'array', + 'items' => [ + 'description' => '智能分组ID', + 'type' => 'string', + 'required' => false, + 'example' => 'SmartCluster-01686226-be59-4391-a1ac-b7b073455de3', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => '6E93D6C9-5AC0-49F9-914D-E02678D3****', + ], + 'Results' => [ + 'description' => '返回的被检索到的文件列表，文档相关结构内容会包含在File.Elements内。', + 'type' => 'array', + 'items' => [ + 'description' => '检索结果中的文件信息', + '$ref' => '#/components/schemas/File', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6E93D6C9-5AC0-49F9-914D-E02678D3****\\",\\n \\"Results\\": [\\n {\\n \\"OwnerId\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"ObjectType\\": \\"\\",\\n \\"ObjectId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"URI\\": \\"\\",\\n \\"OSSURI\\": \\"\\",\\n \\"Filename\\": \\"\\",\\n \\"MediaType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"Size\\": 0,\\n \\"FileHash\\": \\"\\",\\n \\"FileModifiedTime\\": \\"\\",\\n \\"FileCreateTime\\": \\"\\",\\n \\"FileAccessTime\\": \\"\\",\\n \\"ProduceTime\\": \\"\\",\\n \\"LatLong\\": \\"\\",\\n \\"Timezone\\": \\"\\",\\n \\"Addresses\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"AddressLine\\": \\"\\",\\n \\"Country\\": \\"\\",\\n \\"Province\\": \\"\\",\\n \\"City\\": \\"\\",\\n \\"District\\": \\"\\",\\n \\"Township\\": \\"\\"\\n }\\n ],\\n \\"TravelClusterId\\": \\"\\",\\n \\"Orientation\\": 0,\\n \\"Figures\\": [\\n {\\n \\"FigureId\\": \\"\\",\\n \\"FigureConfidence\\": 0,\\n \\"FigureClusterId\\": \\"\\",\\n \\"FigureClusterConfidence\\": 0,\\n \\"FigureType\\": \\"\\",\\n \\"Age\\": 0,\\n \\"AgeSD\\": 0,\\n \\"Gender\\": \\"\\",\\n \\"GenderConfidence\\": 0,\\n \\"Emotion\\": \\"\\",\\n \\"EmotionConfidence\\": 0,\\n \\"FaceQuality\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n },\\n \\"Mouth\\": \\"\\",\\n \\"MouthConfidence\\": 0,\\n \\"Beard\\": \\"\\",\\n \\"BeardConfidence\\": 0,\\n \\"Hat\\": \\"\\",\\n \\"HatConfidence\\": 0,\\n \\"Mask\\": \\"\\",\\n \\"MaskConfidence\\": 0,\\n \\"Glasses\\": \\"\\",\\n \\"GlassesConfidence\\": 0,\\n \\"Sharpness\\": 0,\\n \\"Attractive\\": 0,\\n \\"HeadPose\\": {\\n \\"Pitch\\": 0,\\n \\"Roll\\": 0,\\n \\"Yaw\\": 0\\n }\\n }\\n ],\\n \\"FigureCount\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"LabelName\\": \\"\\",\\n \\"LabelLevel\\": 0,\\n \\"LabelConfidence\\": 0,\\n \\"ParentLabelName\\": \\"\\",\\n \\"CentricScore\\": 0\\n }\\n ],\\n \\"Title\\": \\"\\",\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Boundary\\": {\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"Left\\": 0,\\n \\"Top\\": 0,\\n \\"Polygon\\": [\\n {\\n \\"X\\": 0,\\n \\"Y\\": 0\\n }\\n ]\\n }\\n }\\n ],\\n \\"VideoWidth\\": 0,\\n \\"VideoHeight\\": 0,\\n \\"VideoStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"HasBFrames\\": 0,\\n \\"SampleAspectRatio\\": \\"\\",\\n \\"DisplayAspectRatio\\": \\"\\",\\n \\"PixelFormat\\": \\"\\",\\n \\"Level\\": 0,\\n \\"FrameRate\\": \\"\\",\\n \\"AverageFrameRate\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Rotate\\": \\"\\",\\n \\"BitDepth\\": 0,\\n \\"ColorSpace\\": \\"\\",\\n \\"ColorRange\\": \\"\\",\\n \\"ColorTransfer\\": \\"\\",\\n \\"ColorPrimaries\\": \\"\\"\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0\\n }\\n ],\\n \\"AudioStreams\\": [\\n {\\n \\"Index\\": 0,\\n \\"Language\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"TimeBase\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Duration\\": 0,\\n \\"Bitrate\\": 0,\\n \\"FrameCount\\": 0,\\n \\"Lyric\\": \\"\\",\\n \\"SampleFormat\\": \\"\\",\\n \\"SampleRate\\": 0,\\n \\"Channels\\": 0,\\n \\"ChannelLayout\\": \\"\\"\\n }\\n ],\\n \\"Artist\\": \\"\\",\\n \\"AlbumArtist\\": \\"\\",\\n \\"AudioCovers\\": [\\n {\\n \\"ImageWidth\\": 0,\\n \\"ImageHeight\\": 0,\\n \\"EXIF\\": \\"\\",\\n \\"ImageScore\\": {\\n \\"OverallQualityScore\\": 0\\n },\\n \\"CroppingSuggestions\\": [\\n {\\n \\"AspectRatio\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ],\\n \\"OCRContents\\": [\\n {\\n \\"Language\\": \\"\\",\\n \\"Contents\\": \\"\\",\\n \\"Confidence\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Composer\\": \\"\\",\\n \\"Performer\\": \\"\\",\\n \\"Language\\": \\"\\",\\n \\"Album\\": \\"\\",\\n \\"PageCount\\": 0,\\n \\"ETag\\": \\"\\",\\n \\"CacheControl\\": \\"\\",\\n \\"ContentDisposition\\": \\"\\",\\n \\"ContentEncoding\\": \\"\\",\\n \\"ContentLanguage\\": \\"\\",\\n \\"AccessControlAllowOrigin\\": \\"\\",\\n \\"AccessControlRequestMethod\\": \\"\\",\\n \\"ServerSideEncryptionCustomerAlgorithm\\": \\"\\",\\n \\"ServerSideEncryption\\": \\"\\",\\n \\"ServerSideDataEncryption\\": \\"\\",\\n \\"ServerSideEncryptionKeyId\\": \\"\\",\\n \\"OSSStorageClass\\": \\"\\",\\n \\"OSSCRC64\\": \\"\\",\\n \\"ObjectACL\\": \\"\\",\\n \\"ContentMd5\\": \\"\\",\\n \\"OSSUserMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSTaggingCount\\": 0,\\n \\"OSSTagging\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OSSExpiration\\": \\"\\",\\n \\"OSSVersionId\\": \\"\\",\\n \\"OSSDeleteMarker\\": \\"\\",\\n \\"OSSObjectType\\": \\"\\",\\n \\"CustomId\\": \\"\\",\\n \\"CustomLabels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"StreamCount\\": 0,\\n \\"ProgramCount\\": 0,\\n \\"FormatName\\": \\"\\",\\n \\"FormatLongName\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"Bitrate\\": 0,\\n \\"Duration\\": 0,\\n \\"SemanticSimilarity\\": 0,\\n \\"SemanticTypes\\": [\\n \\"\\"\\n ],\\n \\"Elements\\": [\\n {\\n \\"ElementContents\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"URL\\": \\"\\",\\n \\"TimeRange\\": [\\n 0\\n ]\\n }\\n ],\\n \\"ObjectId\\": \\"\\",\\n \\"ElementType\\": \\"\\",\\n \\"SemanticSimilarity\\": 0,\\n \\"ElementRelations\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ObjectId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SceneElements\\": [\\n {\\n \\"TimeRange\\": [\\n 0\\n ],\\n \\"FrameTimes\\": [\\n 0\\n ],\\n \\"VideoStreamIndex\\": 0\\n }\\n ],\\n \\"OCRTexts\\": \\"\\",\\n \\"FileStatus\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"SmartClusters\\": [\\n {\\n \\"SmartClusterId\\": \\"\\",\\n \\"Similarity\\": 0\\n }\\n ],\\n \\"ObjectStatus\\": \\"\\",\\n \\"SequenceNumber\\": 0,\\n \\"ClusterStatus\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"ClusterModifications\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"Insights\\": {\\n \\"Video\\": {\\n \\"Description\\": \\"\\",\\n \\"Caption\\": \\"\\"\\n },\\n \\"Image\\": {\\n \\"Caption\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n },\\n \\"MetaLockVersion\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'AI助手中的检索API', + 'description' => '### 注意事项'."\n" + ."\n" + .'- 请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和[价格](https://help.aliyun.com/zh/imm/product-overview/billable-items?spm=openapi-amp.newDocPublishment.0.0.1ecd281fi27Zgk)。'."\n" + ."\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" + .'- 返回结果仅为示例，根据[工作流模板配置](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个汉字。', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-beijing-gov-1', + 'endpoint' => 'imm-vpc.cn-beijing-gov-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'imm.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'imm.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'imm.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'imm.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'imm.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'imm.cn-north-2-gov-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'imm.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'imm.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'imm.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'imm.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'imm.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'imm.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'imm.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'imm.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'imm.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'imm.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'imm.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'imm.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'imm.cn-wulanchabu.aliyuncs.com', + ], + ], +]; |