diff options
Diffstat (limited to 'data/zh_cn/imm/2017-09-06/api-docs.php')
| -rw-r--r-- | data/zh_cn/imm/2017-09-06/api-docs.php | 11977 |
1 files changed, 11977 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', + ], + ], +]; |