diff options
Diffstat (limited to 'data/en_us/videoenhan/2020-03-20/api-docs.php')
| -rw-r--r-- | data/en_us/videoenhan/2020-03-20/api-docs.php | 3749 |
1 files changed, 2464 insertions, 1285 deletions
diff --git a/data/en_us/videoenhan/2020-03-20/api-docs.php b/data/en_us/videoenhan/2020-03-20/api-docs.php index 5120770..99a8173 100644 --- a/data/en_us/videoenhan/2020-03-20/api-docs.php +++ b/data/en_us/videoenhan/2020-03-20/api-docs.php @@ -1,75 +1,214 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'videoenhan', - 'version' => '2020-03-20', - ], + 'info' => ['style' => 'RPC', 'product' => 'videoenhan', 'version' => '2020-03-20'], 'directories' => [ [ - 'id' => 69030, - 'title' => null, + 'children' => ['AdjustVideoColor'], 'type' => 'directory', - 'children' => [ - 'AdjustVideoColor', - ], + 'title' => 'Rendering intent', ], [ - 'id' => 69033, - 'title' => null, + 'children' => ['ChangeVideoSize', 'EnhanceVideoQuality', 'GenerateVideo', 'InterpolateVideoFrame', 'MergeVideoFace', 'SuperResolveVideo'], 'type' => 'directory', - 'children' => [ - 'ChangeVideoSize', - 'EnhanceVideoQuality', - 'GenerateVideo', - 'InterpolateVideoFrame', - 'MergeVideoFace', - 'SuperResolveVideo', - ], + 'title' => 'Other capabilities', ], [ - 'id' => 69041, - 'title' => null, + 'children' => ['EraseVideoLogo', 'EraseVideoSubtitles'], 'type' => 'directory', - 'children' => [ - 'EraseVideoLogo', - 'EraseVideoSubtitles', - ], + 'title' => 'Erase', ], [ - 'id' => 69044, - 'title' => null, + 'children' => ['GetAsyncJobResult'], 'type' => 'directory', - 'children' => [ - 'GetAsyncJobResult', - ], + 'title' => 'Result', ], [ - 'id' => 156246, - 'title' => null, + 'children' => ['AddFaceVideoTemplate', 'DeleteFaceVideoTemplate', 'MergeVideoModelFace', 'QueryFaceVideoTemplate', 'GenerateHumanAnimeStyleVideo', 'EnhancePortraitVideo'], 'type' => 'directory', - 'children' => [ - 'AddFaceVideoTemplate', - 'DeleteFaceVideoTemplate', - 'MergeVideoModelFace', - 'QueryFaceVideoTemplate', - 'GenerateHumanAnimeStyleVideo', - 'EnhancePortraitVideo', - ], + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'AdjustVideoColor' => [ - 'methods' => [ - 'post', + 'AddFaceVideoTemplate' => [ + 'summary' => 'This topic describes the syntax and examples of the AddFaceVideoTemplate operation for adding a video face fusion template.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'VideoURL', + 'in' => 'formData', + 'schema' => ['description' => 'The URL of the video template. Only OSS URLs in the China (Shanghai) region are supported. For information about how to generate a URL, see [File URL processing](~~155645~~).', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'http://invi-label.oss-cn-shanghai.aliyuncs.com/labl/temp/faceswap/test_for_api/xxxx.mp4', 'title' => ''], + ], + [ + 'name' => 'VideoScene', + 'in' => 'formData', + 'schema' => ['description' => 'The video face swap scenario. Valid values:'."\n" + .'- single (default): single-person video face swap.'."\n" + .'- multi: multi-person video face swap.'."\n" + ."\n" + .'> - If the input video contains a single person, you can leave the VideoScene parameter empty or set it to `single`.'."\n" + .'- If the input video contains multiple persons, set VideoScene to `multi`. You can then use the template face swap operation to perform one-to-one face fusion for multiple persons.'."\n" + .'- If the input video contains multiple persons but you want to replace only a specific person ID, add the template as a multi-person video scenario by setting VideoScene to `multi`. You can then use the template face swap operation to specify the person you want to fuse.', 'type' => 'string', 'required' => false, 'example' => 'single', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F61182AE-515B-5B0A-A877-1C9AE908FF15'], + 'Message' => ['description' => 'The message returned after the asynchronous task is submitted.', 'type' => 'string', 'example' => '该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。', 'title' => ''], + 'Date' => [ + 'description' => 'The returned result data. After the asynchronous task is executed successfully, invoke the [GetAsyncJobResult](~~159423~~) operation and perform JSON deserialization on the Result field to obtain this data.', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '6cd509ea-54fa-4730-8e9d-c94cadcda048', 'title' => ''], + 'FaceInfos' => [ + 'description' => 'The face IDs and cropped face images returned when multiple faces exist in the input video.', + 'type' => 'array', + 'items' => [ + 'description' => 'The face IDs and cropped face images returned when multiple faces exist in the input video.', + 'type' => 'object', + 'properties' => [ + 'TemplateFaceID' => ['description' => 'The sub-template ID corresponding to the face.', 'type' => 'string', 'example' => '7d1a2498-0f9a-42d8-bae8-c7e478188106_0', 'title' => ''], + 'TemplateFaceURL' => ['description' => 'The face image corresponding to the sub-template ID of the face.', 'type' => 'string', 'example' => 'http://vibktprfx-prod-prod-aic-gd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-face-fusion/template/xhtest_7d1a2498-0f9a-42d8-bae8-c7e478188106/xhtest_7d1a2498-0f9a-42d8-bae8-c7e478188106_0.png?Expires=1686040781&OSSAccessKeyId=LTAI****************&Signature=WVYTf%2F3knRuUPXSVGVz%2FZi3Miu****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TransResult' => ['description' => 'The face position transformation matrix file for video frames, used to help you verify face swap information.', 'type' => 'string', 'example' => 'http://vibktprfx-prod-prod-aic-gd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-face-fusion/template/1952059581270833_308f1611-7de8-4f16-9175-f1e997caadf6-V1/1952059581270833_308f1611-7de8-4f16-9175-f1e997caadf6-V1_trans.npy?Expires=1717055504&OSSAccessKeyId=LTAI****************&Signature=zg784H1bv5hwaKPvAywp8p5Hla****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F61182AE-515B-5B0A-A877-1C9AE908FF15\\",\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\",\\n \\"Date\\": {\\n \\"TemplateId\\": \\"6cd509ea-54fa-4730-8e9d-c94cadcda048\\",\\n \\"FaceInfos\\": [\\n {\\n \\"TemplateFaceID\\": \\"7d1a2498-0f9a-42d8-bae8-c7e478188106_0\\",\\n \\"TemplateFaceURL\\": \\"http://vibktprfx-prod-prod-aic-gd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-face-fusion/template/xhtest_7d1a2498-0f9a-42d8-bae8-c7e478188106/xhtest_7d1a2498-0f9a-42d8-bae8-c7e478188106_0.png?Expires=1686040781&OSSAccessKeyId=LTAI****************&Signature=WVYTf%2F3knRuUPXSVGVz%2FZi3Miu****\\"\\n }\\n ],\\n \\"TransResult\\": \\"http://vibktprfx-prod-prod-aic-gd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-face-fusion/template/1952059581270833_308f1611-7de8-4f16-9175-f1e997caadf6-V1/1952059581270833_308f1611-7de8-4f16-9175-f1e997caadf6-V1_trans.npy?Expires=1717055504&OSSAccessKeyId=LTAI****************&Signature=zg784H1bv5hwaKPvAywp8p5Hla****\\"\\n }\\n}","type":"json"}]', + 'title' => 'Add a video face fusion template', + 'description' => '## Feature description'."\n" + .'The video face fusion template addition feature allows you to use a video that contains faces and has passed content moderation as a template for the video face fusion feature.'."\n" + ."\n" + .'> - You can visit [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) for online assistance.'."\n" + .'- To learn more about Alibaba Cloud Vision Intelligence Open Platform visual AI API integration, API usage, or other inquiries, join the DingTalk group (23109592) to contact us.'."\n" + ."\n" + .'## Integration guide'."\n" + .'1. Register an Alibaba Cloud account: Go to the [Alibaba Cloud official website](https://www.aliyun.com), click **Register Now** in the upper-right corner, and follow the instructions to complete account registration.'."\n" + .'2. Activate the service: Make sure you have activated the [Video Production service](https://vision.aliyun.com/videoenhan). If you have not activated the service, [activate it now](https://common-buy.aliyun.com/?commodityCode=viapi_videoenhan_public_cn#/open).'."\n" + .'><notice>'."\n" + .'This feature is available only to users who have completed verify your identity - Enterprise account. For more information about real-name verification, see [Real-name verification](https://help.aliyun.com/document_detail/428525.html).'."\n" + .'></notice>'."\n" + ."\n" + .'3. Create an AccessKey pair: Make sure you have [created an AccessKey pair](~~175144~~). If you are using a RAM user AccessKey, grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see [RAM authorization](~~145025~~).'."\n" + .'4. Online debugging (optional): You can use [OpenAPI Explorer](https://next.api.aliyun.com/api/videoenhan/2020-03-20/AddFaceVideoTemplate?lang=JAVA) to debug the feature online, view complete sample code and SDK dependency information, or download the complete project.'."\n" + .'5. Development integration steps: '."\n" + .'- Select the SDK language you want to use from the [SDK overview](~~145033~~).'."\n" + .'- Find the SDK package for the Video Production (videoenhan) AI category in the corresponding SDK documentation and install it.'."\n" + .'- Modify the sample code provided in the References as needed and invoke it.'."\n" + ."\n" + .'6. Sample code: For sample code in commonly used languages, see [Video face fusion template increase sample code](~~602556~~).'."\n" + ."\n" + .'7. Direct client invocation: Common client invocation methods for this feature include the following.'."\n" + .'- [Direct invocation from web frontend](~~467779~~)'."\n" + .'- [Direct invocation from mini programs](~~467780~~)'."\n" + .'- [Direct invocation from Android](~~467781~~)'."\n" + .'- [Direct invocation from iOS](~~467782~~).'."\n" + ."\n" + .'## Input limits'."\n" + ."\n" + .'- Video formats: MP4, AVI, MKV, MOV, FLV, TS, and MPG.'."\n" + .'- Video resolution: greater than or equal to 320 × 320 pixels and less than or equal to 1920 × 1920 pixels.'."\n" + .'- Video size: no greater than 120 MB.'."\n" + .'- The URL cannot contain Chinese characters.'."\n" + .'- A single user can upload a maximum of 3,000 video templates.'."\n" + .'- When adding a multi-face video, the number of person IDs in a single video cannot exceed 6. If more than 6 face IDs are detected, the 6 most frequently appearing faces are returned.'."\n" + .'- Only videos with a static (constant) frame rate are supported. Videos with a dynamic (variable) frame rate are not supported.'."\n" + ."\n" + .'## Response description'."\n" + .'- During the template addition process, the system automatically performs content moderation checks for pornographic and politically sensitive content. If the video does not comply with the standards, it cannot be added.'."\n" + .'- If multiple face IDs appear in a multi-person video, the system sorts and returns them by the duration of each face\'s appearance.'."\n" + ."\n" + .'## Video frame quality recommendations'."\n" + .'- Ensure that faces in the image are clear. The face size in the image should be greater than 64 × 64 pixels, and the face area should not exceed 2/3 of the total image area.'."\n" + .'- Ensure that the facial features are complete and not significantly occluded. The face fusion algorithm supports faces turned at certain angles, and achieves better results when the angle does not exceed 30 degrees.'."\n" + .'- For multi-face video scenarios, the system automatically identifies different person IDs throughout the video. Avoid excessive head rotation or significant occlusion in the video. Otherwise, the number of identified person IDs may be inaccurate.'."\n" + ."\n" + .'Recommended image examples:'."\n" + .'![](https://static-aliyun-doc.oss-cn-hangzhou.aliyuncs.com/file-manage-files/zh-CN/20221114/jris/MergeImageFacetuijian.png" width="300)'."\n" + .'![](https://static-aliyun-doc.oss-cn-hangzhou.aliyuncs.com/file-manage-files/zh-CN/20230609/otnv/MergeVideoModelFacetuijian.png" width="300)'."\n" + ."\n" + .'Not recommended image examples:'."\n" + .'![](https://static-aliyun-doc.oss-cn-hangzhou.aliyuncs.com/file-manage-files/zh-CN/20221114/rkbx/MergeImageFacebutuijian.png" width="300)'."\n" + .'![](https://static-aliyun-doc.oss-cn-hangzhou.aliyuncs.com/file-manage-files/zh-CN/20230609/jcgb/MergeVideoModelFacebutuijian.png" width="300).'."\n" + ."\n" + .'## Call procedure'."\n" + .'This is an asynchronous operation that requires two steps.'."\n" + .'Step 1: Call the AddFaceVideoTemplate operation to submit a task. After the request succeeds, a task ID is returned.'."\n" + .'Step 2: Call the [GetAsyncJobResult](~~159423~~) operation to query the result based on the task ID. If the task is still being processed, wait a moment before querying again. Do not submit duplicate tasks while the same task is still being processed.'."\n" + ."\n" + .'## Billing description'."\n" + .'The video face fusion template addition feature is free of charge.', + 'responseParamsDescription' => '## Query results'."\n" + .'This is an asynchronous operation that does not return actual results immediately. Call the GetAsyncJobResult operation with the returned RequestId to obtain the actual results. For more information, see [GetAsyncJobResult](~~159423~~).'."\n" + ."\n" + .'## SDK reference'."\n" + .'To use the video face fusion template addition feature under the Alibaba Cloud Vision AI Video Production category, use the SDK. Multiple programming languages are supported. Select the SDK package for the Video Production (videoenhan) AI category. File parameters support local files and arbitrary URLs when called through the SDK. For more information, see [SDK overview](~~145033~~).'."\n" + ."\n" + .'## Sample code'."\n" + .'For sample code in commonly used languages, see [Video face fusion template addition sample code](~~602556~~).', + 'extraInfo' => '## Error codes'."\n" + .'For error codes of the video face fusion template addition feature, see [Common error codes](~~159313~~).'."\n" + ."\n" + .'## Security notice'."\n" + .'- Ensure that the uploaded images or files comply with applicable laws and regulations.'."\n" + .'- Temporary files uploaded through the debugging console are valid for 1 hour and are automatically deleted by the system after 24 hours.', + 'changeSet' => [ + ['createdAt' => '2024-05-30T09:21:48.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-06-09T02:22:45.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-12-02T02:35:23.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-10-17T02:05:12.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-04-09T08:28:59.000Z', 'description' => 'OpenAPI offline'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:AddFaceVideoTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddFaceVideoTemplate'], + ], ], + ], + 'AdjustVideoColor' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -82,97 +221,141 @@ [ 'name' => 'VideoUrl', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoenhan/AdjustVideoColor/AdjustVideoColor1.mp4', - 'isFileTransferUrl' => true, - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The URL of the video. We recommend that you use an OSS URL in the Shanghai region. If the file is stored locally or in an OSS bucket outside the Shanghai region, see [File URL processing](~~155645~~).', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoenhan/AdjustVideoColor/AdjustVideoColor1.mp4', 'title' => ''], ], [ 'name' => 'VideoBitrate', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '20', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The bitrate of the output video. Unit: Mbit/s. Default value: 20. Valid values: 8 to 200.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'VideoCodec', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'h264', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The encoding format of the output video. Valid values: h264, hevc, and prores. Default value: h264.', 'type' => 'string', 'required' => false, 'example' => 'h264', 'title' => ''], ], [ 'name' => 'VideoFormat', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'mp4', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The format of the output video. Valid values: mp4 and mov. Default value: mp4.', 'type' => 'string', 'required' => false, 'example' => 'mp4', 'title' => ''], ], [ 'name' => 'Mode', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'LogC', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The color correction mode. Default value: LogC. For more information, see the color correction mode description.', 'type' => 'string', 'required' => false, 'example' => 'LogC', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'C4EB5E0B-0718-42CC-9B2C-1FB149256874', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C4EB5E0B-0718-42CC-9B2C-1FB149256874', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The returned data. After the asynchronous task is executed successfully, invoke the [GetAsyncJobResult](~~607824~~) operation and perform JSON deserialization on the Result field to obtain this data.', + 'type' => 'object', 'properties' => [ - 'VideoUrl' => [ - 'description' => '', - 'example' => 'http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-recolor/2021-01-21-07/46%3A05-test.mov?Expires=1611216966&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=icKn5gEQ6rNlSHmCi2zAf2tC0L****', - 'type' => 'string', - ], + 'VideoUrl' => ['description' => 'The URL of the color-corrected video.'."\n" + .'> This URL is a temporary URL that is valid for 30 minutes. After it expires, the URL is no longer accessible. To save the file for a longer period or permanently, access the URL within 30 minutes and download the file to your own OSS bucket or other storage.', 'type' => 'string', 'example' => 'http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-recolor/2021-01-21-07/46%3A05-test.mov?Expires=1611216966&OSSAccessKeyId=LTAI****************&Signature=icKn5gEQ6rNlSHmCi2zAf2tC0L****', 'title' => ''], ], - 'type' => 'object', - ], - 'Message' => [ - 'description' => '', + 'title' => '', 'example' => '', - 'type' => 'string', ], + 'Message' => ['description' => 'The message returned after the asynchronous task is submitted.', 'type' => 'string', 'example' => '该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C4EB5E0B-0718-42CC-9B2C-1FB149256874\\",\\n \\"Data\\": {\\n \\"VideoUrl\\": \\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-recolor/2021-01-21-07/46%3A05-test.mov?Expires=1611216966&OSSAccessKeyId=LTAI****************&Signature=icKn5gEQ6rNlSHmCi2zAf2tC0L****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","type":"json"}]', + 'title' => 'Video color correction', + 'summary' => 'This topic describes the syntax and provides examples of the video color correction operation AdjustVideoColor.', + 'description' => '## Description'."\n" + .'The video color correction feature adjusts the color of input videos. It can perform correlated color correction based on the similarity between videos.'."\n" + ."\n" + .'> - You can join [online consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) to get help from our support team.'."\n" + .'- You can try the full product experience on the Visual Intelligence Open Platform for free. Click [Try Now](https://vision.aliyun.com/experience/detail?&tagName=videoenhan&children=AdjustVideoColor) to try this feature or purchase it online.'."\n" + .'- For questions about Alibaba Cloud Visual Intelligence Open Platform API integration, usage, or consultation, join the DingTalk group (23109592) to contact us.'."\n" + ."\n" + .'## Getting started'."\n" + .'1. Create an Alibaba Cloud account: Go to the [Alibaba Cloud official website](https://www.aliyun.com), click **Register Now** in the upper-right corner, and follow the instructions to complete the registration.'."\n" + .'2. Activate the service: Make sure you have activated the [Video Production service](https://vision.aliyun.com/videoenhan). If you have not activated the service, [activate it now](https://common-buy.aliyun.com/?commodityCode=viapi_videoenhan_public_cn#/open).'."\n" + .'3. Create an AccessKey pair: Make sure you have [created an AccessKey pair](~~175144~~). If you are using a RAM user AccessKey, grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see [RAM authorization](~~145025~~).'."\n" + .'4. Online debugging (optional): You can use [OpenAPI Explorer](https://next.api.aliyun.com/api/videoenhan/2020-03-20/AdjustVideoColor?lang=JAVA&sdkStyle=dara¶ms=%7B%22VideoUrl%22%3A%22http%3A%2F%2Fviapi-test.oss-cn-shanghai.aliyuncs.com%2Fviapi-3.0domepic%2Fvideoenhan%2FAdjustVideoColor%2FAdjustVideoColor1.mp4%22%2C%22Mode%22%3A%22LogC%22%7D&tab=DEMO) to debug this feature online, view complete sample code and SDK dependency information, or download the complete project.'."\n" + .'5. Development integration steps:'."\n" + .'- Select the SDK language you want to use from the [SDK overview](~~145033~~).'."\n" + .'- Find the SDK package for the Video Production (videoenhan) AI category in the corresponding SDK documentation and install it.'."\n" + .' - Modify the sample code provided in the References as needed and invoke it.'."\n" + ."\n" + .'6. Sample code: For sample code that queries asynchronous task results in common languages, see [Sample code for querying asynchronous task results](~~607974~~).'."\n" + ."\n" + .'7. Direct client calls: Common client invocation methods for this feature include the following.'."\n" + .'- [Direct call from web frontend](~~467779~~)'."\n" + .'- [Direct call from mini programs](~~467780~~)'."\n" + .'- [Direct call from Android](~~467781~~)'."\n" + .'- [Direct call from iOS](~~467782~~).'."\n" + ."\n" + .'## Input limits'."\n" + ."\n" + .'- Video format: MP4, AVI, MKV, MOV, FLV, TS, MPG, or MXF.'."\n" + .'- Video size: up to 1 GB.'."\n" + .'- Video resolution: greater than 360 × 360 pixels and less than 3840 × 2160 pixels. If the resolution exceeds this range, the system automatically scales the original video.'."\n" + .'- The URL cannot contain Chinese characters.'."\n" + ."\n" + .'## Billing'."\n" + .'For the billable methods and pricing of video color correction, see [Billing overview](~~202487~~).'."\n" + ."\n" + .'> The debugging operation below is a paid operation.'."\n" + ."\n" + .'## Procedure'."\n" + .'This is an asynchronous operation that requires two steps.'."\n" + .'Step 1: Call the AdjustVideoColor operation to submit a task. If the request is successful, a task ID is returned.'."\n" + .'Step 2: Call the [GetAsyncJobResult](~~607824~~) operation to query the result based on the task ID. If the task is still being processed, wait a moment and try again. Do not submit duplicate tasks while the same task is still being processed.', + 'requestParamsDescription' => 'The color correction modes are as follows.'."\n" + .'| Mode identifier | Name | Description |'."\n" + .'| -------- | -------- | --------------------------------- |'."\n" + .'| LogC | Log color correction | The input is a low-contrast log video, typically 10-bit. |'."\n" + .'| Rec709 | Standard color correction | The input is a standard video, typically 8-bit. |.', + 'responseParamsDescription' => '## Query results'."\n" + .'This is an asynchronous operation that does not return the actual result. Call the GetAsyncJobResult operation with the returned RequestId to obtain the actual result. For more information, see [GetAsyncJobResult](~~607824~~).'."\n" + ."\n" + .'## SDK reference'."\n" + .'We recommend that you use the SDK to call the video color correction feature under the Visual AI Video Production category. Multiple programming languages are supported. When making the call, select the SDK package for the Video Production (videoenhan) AI category. File parameters support local files and arbitrary URLs through the SDK. For more information, see [SDK overview](~~145033~~).'."\n" + ."\n" + .'## Sample code'."\n" + .'For sample code that queries asynchronous task results in common languages, see [Sample code for querying asynchronous task results](~~607974~~).', + 'extraInfo' => '## Error codes'."\n" + .'For more information, see [Common error codes](~~159313~~).'."\n" + ."\n" + .'## Security notice'."\n" + .'- Make sure that the uploaded images or files comply with applicable laws and regulations.'."\n" + .'- Temporary files uploaded through the debugging experience are valid for 1 hour and are automatically deleted by the system after 24 hours.', + 'changeSet' => [ + ['createdAt' => '2022-10-17T02:05:11.000Z', 'description' => 'Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:AdjustVideoColor', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'type' => 'object', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C4EB5E0B-0718-42CC-9B2C-1FB149256874\\",\\n \\"Data\\": {\\n \\"VideoUrl\\": \\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-recolor/2021-01-21-07/46%3A05-test.mov?Expires=1611216966&OSSAccessKeyId=LTAI****************&Signature=icKn5gEQ6rNlSHmCi2zAf2tC0L****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","errorExample":""},{"type":"xml","example":"<AdjustVideoColorResponse>\\n <RequestId>C4EB5E0B-0718-42CC-9B2C-1FB149256874</RequestId>\\n <Message>该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。</Message>\\n</AdjustVideoColorResponse>","errorExample":""}]', - 'responseParamsDescription' => ' ', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AdjustVideoColor'], + ], + ], ], 'ChangeVideoSize' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -180,360 +363,415 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'VideoUrl', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoenhan/ChangeVideoSize/ChangeVideoSize1.mp4', - 'isFileTransferUrl' => true, - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The video URL. We recommend using an OSS link in the Shanghai region. For files stored locally or OSS links in regions other than Shanghai, see [File URL Processing](~~155645~~).', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoenhan/ChangeVideoSize/ChangeVideoSize1.mp4', 'title' => ''], ], [ 'name' => 'Width', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '600', - 'format' => 'int32', - 'maximum' => '2160', - 'minimum' => '32', - 'required' => true, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The width of the output video, in pixels. Valid values: 32 to 2160.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '2160', 'minimum' => '32', 'example' => '600', 'title' => ''], ], [ 'name' => 'Height', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '1000', - 'format' => 'int32', - 'maximum' => '2160', - 'minimum' => '32', - 'required' => true, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The height of the output video, in pixels. Valid values: 32 to 2160.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '2160', 'minimum' => '32', 'example' => '1000', 'title' => ''], ], [ 'name' => 'CropType', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'smart', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The crop type. Valid values: smart, fill, and cut. The specific meanings are as follows.'."\n" + ."\n" + .'- `smart` (Smart Crop): Intelligently determines whether to fill or crop based on the subject position, or partially fill and partially crop.'."\n" + ."\n" + .'- `fill` (Fill): Adjusts the aspect ratio based on the longest edge. The excess area is filled with a blurred background or color, or stretched.'."\n" + ."\n" + .'- `cut` (Crop): Adjusts the aspect ratio based on the shortest edge. The excess area is cropped.', 'type' => 'string', 'required' => false, 'example' => 'smart', 'title' => ''], ], [ 'name' => 'FillType', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'image', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The fill type. Valid values: image, color, and stretch. The specific meanings are as follows.'."\n" + ."\n" + .'- image: Fills with the content of a middle frame from the video, with blur processing applied before filling.'."\n" + ."\n" + .'- color: Specifies the fill color as an RGB value array, for example, red `[255,0,0]`.'."\n" + ."\n" + .'- stretch: Fills by stretching. If the aspect ratio adjustment is large, it will cause severe image distortion, so this option is not recommended.'."\n" + .' '."\n", 'type' => 'string', 'required' => false, 'example' => 'image', 'title' => ''], ], [ 'name' => 'Tightness', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '0.5', - 'format' => 'float', - 'maximum' => '1', - 'minimum' => '0', - 'required' => false, - 'type' => 'number', - 'default' => '0.6', - ], + 'schema' => ['description' => 'The tightness of the crop box. Valid values: 0 to 1. A larger value results in more content being cropped. Default value: 0.6.', 'type' => 'number', 'format' => 'float', 'required' => false, 'maximum' => '1', 'minimum' => '0', 'default' => '0.6', 'example' => '0.5', 'title' => ''], ], [ 'name' => 'R', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int32', - 'maximum' => '255', - 'minimum' => '0', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Required when FillType is set to `color`. Specifies the R value in the RGB color.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '0', 'title' => ''], ], [ 'name' => 'G', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int32', - 'maximum' => '255', - 'minimum' => '0', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Required when FillType is set to `color`. Specifies the G value in the RGB color.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '0', 'title' => ''], ], [ 'name' => 'B', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int32', - 'maximum' => '255', - 'minimum' => '0', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Required when FillType is set to `color`. Specifies the B value in the RGB color.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '255', 'minimum' => '0', 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'C00C5A32-9F54-44F0-9778-0968DD9BF22A', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C00C5A32-9F54-44F0-9778-0968DD9BF22A', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The returned data. This data is obtained by calling the [GetAsyncJobResult](~~607824~~) API after the asynchronous task is executed successfully, and then deserializing the Result field from JSON.', + 'type' => 'object', 'properties' => [ - 'VideoCoverUrl' => [ - 'description' => '', - 'example' => 'http://vibktprfx-prod-prod-aic-vd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-crop/2020-07-24-20/ZTZslWcU.jpg?Expires=1595597077&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=5cq1NNBEzS64U7RTXRBGlo7WPy****', - 'type' => 'string', - ], - 'VideoUrl' => [ - 'description' => '', - 'example' => 'http://vibktprfx-prod-prod-aic-vd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-crop/2020-07-24-20/ZTZslWcU.mp4?Expires=1595597077&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=ZyvD9AXCT2IUFkVJngQdbXMwX6****', - 'type' => 'string', - ], + 'VideoCoverUrl' => ['description' => 'The output video cover URL.'."\n" + .'> This URL is a temporary address, valid for 30 minutes. After expiration, it will be inaccessible. If you need to save the file for a long time or permanently, please access the URL within 30 minutes, download the file, and transfer it to your own OSS or other storage space.', 'type' => 'string', 'example' => 'http://vibktprfx-prod-prod-aic-vd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-crop/2020-07-24-20/ZTZslWcU.jpg?Expires=1595597077&OSSAccessKeyId=LTAI****************&Signature=5cq1NNBEzS64U7RTXRBGlo7WPy****', 'title' => ''], + 'VideoUrl' => ['description' => 'The output video URL.'."\n" + .'> This URL is a temporary address, valid for 30 minutes. After expiration, it will be inaccessible. If you need to save the file for a long time or permanently, please access the URL within 30 minutes, download the file, and transfer it to your own OSS or other storage space.', 'type' => 'string', 'example' => 'http://vibktprfx-prod-prod-aic-vd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-crop/2020-07-24-20/ZTZslWcU.mp4?Expires=1595597077&OSSAccessKeyId=LTAI****************&Signature=ZyvD9AXCT2IUFkVJngQdbXMwX6****', 'title' => ''], ], - 'type' => 'object', - ], - 'Message' => [ - 'description' => '', + 'title' => '', 'example' => '', - 'type' => 'string', ], + 'Message' => ['description' => 'The prompt message returned after submitting the asynchronous task.', 'type' => 'string', 'example' => '该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'The parameter is invalid. Please check again.', - ], + ['errorCode' => 'ParameterError', 'errorMessage' => 'The parameter is invalid. Please check again.', 'description' => 'The parameter is invalid. Please check again.'], ], 403 => [ - [ - 'errorCode' => 'AuthFailed', - 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.', - ], + ['errorCode' => 'AuthFailed', 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.', 'description' => 'An error occurred while performing authorization. Please check your RAM configuration.'], ], 408 => [ - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'The request has timed out.', - ], + ['errorCode' => 'Timeout', 'errorMessage' => 'The request has timed out.', 'description' => 'The request has timed out.'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'The service is unavailable.', + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The service is unavailable.', 'description' => 'The service is unavailable.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C00C5A32-9F54-44F0-9778-0968DD9BF22A\\",\\n \\"Data\\": {\\n \\"VideoCoverUrl\\": \\"http://vibktprfx-prod-prod-aic-vd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-crop/2020-07-24-20/ZTZslWcU.jpg?Expires=1595597077&OSSAccessKeyId=LTAI****************&Signature=5cq1NNBEzS64U7RTXRBGlo7WPy****\\",\\n \\"VideoUrl\\": \\"http://vibktprfx-prod-prod-aic-vd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-crop/2020-07-24-20/ZTZslWcU.mp4?Expires=1595597077&OSSAccessKeyId=LTAI****************&Signature=ZyvD9AXCT2IUFkVJngQdbXMwX6****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","type":"json"}]', + 'title' => 'Change Video Size', + 'summary' => 'This topic describes the syntax and examples of ChangeVideoSize for changing video size.', + 'description' => '## Feature Description'."\n" + .'The Change Video Size capability can intelligently crop and fill input videos to output videos at any resolution.'."\n" + ."\n" + .'> - You can visit [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) to get online human assistance.'."\n" + .'- This capability has a complete free product experience available on the Visual Intelligence Open Platform. You can click [Try Now](https://vision.aliyun.com/experience/detail?&tagName=videoenhan&children=ChangeVideoSize) for a more intuitive trial and online purchase.'."\n" + .'- For Alibaba Cloud Visual Intelligence Open Platform visual AI capability API access, interface usage, or consultation, please join the Alibaba Cloud Visual Intelligence Open Platform consultation group via DingTalk group (23109592) to contact us.'."\n" + ."\n" + .'## Access Guide'."\n" + .'1. Register an Alibaba Cloud account: Go to the [Alibaba Cloud official website](https://www.aliyun.com), click **Register Now** in the upper-right corner, and follow the prompts to complete the registration.'."\n" + .'2. Activate the service: Make sure you have activated [Video Production Service](https://vision.aliyun.com/videoenhan). If the service is not activated, please [Activate Now](https://common-buy.aliyun.com/?commodityCode=viapi_videoenhan_public_cn#/open).'."\n" + .'3. Create an AccessKey: Make sure you have [created an AccessKey](~~175144~~). If you are using a RAM user AccessKey, you need to grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see [RAM Authorization](~~145025~~).'."\n" + .'4. Online debugging (optional): You can use [OpenAPI Explorer](https://next.api.aliyun.com/api/videoenhan/2020-03-20/ChangeVideoSize?lang=JAVA&sdkStyle=dara¶ms=%7B%22VideoUrl%22%3A%22http%3A%2F%2Fviapi-test.oss-cn-shanghai.aliyuncs.com%2Fviapi-3.0domepic%2Fvideoenhan%2FChangeVideoSize%2FChangeVideoSize1.mp4%22%2C%22Height%22%3A1000%2C%22Width%22%3A600%7D&tab=DEMO) to debug the capability online, view complete sample code and SDK dependency information, or download the complete project.'."\n" + .'5. Development access steps: '."\n" + .'- Select the SDK language you want to use in [SDK Overview](~~145033~~).'."\n" + .'- Find the SDK package with the AI category of Video Production (videoenhan) in the corresponding SDK documentation and install it.'."\n" + .'- Refer to the sample code provided in the documentation and make appropriate modifications before calling.'."\n" + ."\n" + .'6. Sample code: For sample code for querying asynchronous task results in commonly used languages for this capability, see [Query Asynchronous Task Result Sample Code](~~607974~~).'."\n" + ."\n" + .'7. Client direct call: The commonly used client calling methods for this capability include the following.'."\n" + .'- [Direct Call from Web Frontend](~~467779~~)'."\n" + .'- [Direct Call in Mini Program Scenarios](~~467780~~)'."\n" + .'- [Direct Call from Android](~~467781~~)'."\n" + .'- [Direct Call from iOS](~~467782~~)'."\n" + ."\n" + .'## Input Limitations'."\n" + ."\n" + .'- Video formats: MP4, AVI, MOV, FLV.'."\n" + .'- Video size: No more than 1 GB.'."\n" + .'- Video duration: Must be less than 2 hours. Content exceeding this limit will be truncated.'."\n" + .'- The URL must not contain Chinese characters.'."\n" + ."\n" + .'## Billing Description'."\n" + .'For information about the billing method and pricing of Change Video Size, see [Billing Overview](~~202487~~).'."\n" + ."\n" + .'> The debugging API below is a paid API.'."\n" + ."\n" + .'## Calling Steps'."\n" + .'This capability is asynchronous and requires two steps to call.'."\n" + .'Step 1: Call the ChangeVideoSize API to submit a task. After a successful request, you will receive a task ID.'."\n" + .'Step 2: Call the [GetAsyncJobResult](~~607824~~) API to query results based on the task ID. If the task is still being processed, wait for a while before querying again. When the same task has not been processed yet, it is recommended not to submit the task again.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '## Query Results'."\n" + .'This API is asynchronous and does not return the actual request result. You need to call the GetAsyncJobResult API using the returned RequestId to obtain the actual request result. For more information, see [GetAsyncJobResult](~~607824~~).'."\n" + ."\n" + .'## SDK Reference'."\n" + .'For the Change Video Size capability under the Alibaba Cloud Visual AI Video Production category, we recommend using SDK calls. Multiple programming languages are supported. When calling, select the SDK package with the AI category of Video Production (videoenhan). File parameters support local files and arbitrary URLs through SDK calls. For more information, see [SDK Overview](~~145033~~).'."\n" + ."\n" + .'## Sample Code'."\n" + .'For sample code for querying asynchronous task results in commonly used languages for this capability, see [Query Asynchronous Task Result Sample Code](~~607974~~).', + 'extraInfo' => '## Error Codes'."\n" + .'For error codes related to Change Video Size, see [Common Error Codes](~~159313~~).'."\n" + ."\n" + .'## Security Statement'."\n" + .'- Please ensure that the source of uploaded images or files complies with applicable laws and regulations.'."\n" + .'- Temporary files uploaded through the trial debugging are valid for 1 hour and will be automatically cleaned up and deleted by the system after 24 hours.', + 'changeSet' => [ + ['createdAt' => '2022-10-17T02:05:11.000Z', 'description' => 'Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:ChangeVideoSize', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C00C5A32-9F54-44F0-9778-0968DD9BF22A\\",\\n \\"Data\\": {\\n \\"VideoCoverUrl\\": \\"http://vibktprfx-prod-prod-aic-vd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-crop/2020-07-24-20/ZTZslWcU.jpg?Expires=1595597077&OSSAccessKeyId=LTAI****************&Signature=5cq1NNBEzS64U7RTXRBGlo7WPy****\\",\\n \\"VideoUrl\\": \\"http://vibktprfx-prod-prod-aic-vd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-crop/2020-07-24-20/ZTZslWcU.mp4?Expires=1595597077&OSSAccessKeyId=LTAI****************&Signature=ZyvD9AXCT2IUFkVJngQdbXMwX6****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","errorExample":""},{"type":"xml","example":"<ChangeVideoSizeResponse>\\n <RequestId>C00C5A32-9F54-44F0-9778-0968DD9BF22A</RequestId>\\n <Message>该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。</Message>\\n</ChangeVideoSizeResponse>","errorExample":""}]', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - ], - 'EnhanceVideoQuality' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeVideoSize'], + ], ], + ], + 'DeleteFaceVideoTemplate' => [ + 'summary' => 'This topic describes the syntax and examples of the DeleteFaceVideoTemplate operation for deleting a video face fusion template.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'VideoURL', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'https://invi-label.oss-cn-shanghai.aliyuncs.com/label/temp/faceswap/test_for_api/xxxx.mp4', - 'isFileTransferUrl' => true, - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'OutPutWidth', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int32', - 'maximum' => '7680', - 'minimum' => '180', - 'required' => false, - 'type' => 'integer', - ], - ], - [ - 'name' => 'OutPutHeight', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int32', - 'maximum' => '4320', - 'minimum' => '180', - 'required' => false, - 'type' => 'integer', - ], - ], - [ - 'name' => 'FrameRate', + 'name' => 'TemplateId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '50', - 'format' => 'int32', - 'maximum' => '120', - 'minimum' => '1', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The ID of the template to delete.', 'type' => 'string', 'required' => true, 'example' => '3bf2418c-7adf-4002-a9d6-2f7cf1889c0d', 'title' => ''], ], - [ - 'name' => 'HDRFormat', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'example' => 'PQ', - 'required' => false, - 'type' => 'string', - 'default' => 'PQ', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2337D184-CD63-57B5-96A2-B60AABCB7B58'], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2337D184-CD63-57B5-96A2-B60AABCB7B58\\"\\n}","type":"json"}]', + 'title' => 'Delete a video face fusion template', + 'description' => '## Description'."\n" + .'The video face fusion template deletion feature allows you to delete template videos that you have previously added.'."\n" + ."\n" + .'> - You can visit [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) to get online help.'."\n" + .'- To consult about Alibaba Cloud Vision AI capabilities, API integration, or interface usage, join the DingTalk group (23109592) to contact us.'."\n" + ."\n" + .'## Integration guide'."\n" + .'1. Register an Alibaba Cloud account: Go to the [Alibaba Cloud official website](https://www.aliyun.com), click **Register Now** in the upper-right corner, and follow the instructions to complete account registration.'."\n" + .'2. Activate the service: Make sure you have activated [Video Production](https://vision.aliyun.com/videoenhan). If you have not activated the service, [activate it now](https://common-buy.aliyun.com/?commodityCode=viapi_videoenhan_public_cn#/open).'."\n" + .'><notice>'."\n" + .'This feature is available only to users who have completed verify your identity - Enterprise account. For more information about real-name verification, see [Real-name verification](https://help.aliyun.com/document_detail/428525.html).'."\n" + .'></notice>'."\n" + ."\n" + .'3. Create an AccessKey pair: Make sure you have [created an AccessKey pair](~~175144~~). If you are using a RAM user AccessKey pair, grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see [RAM authorization](~~145025~~).'."\n" + .'4. Online debugging (optional): You can use [OpenAPI Explorer](https://next.api.aliyun.com/api/videoenhan/2020-03-20/DeleteFaceVideoTemplate?lang=JAVA) to debug this operation online, view complete sample code and SDK dependency information, or download the complete project.'."\n" + .'5. Before you begin: You must have created a TemplateId by using the video face fusion template increase (AddFaceVideoTemplate) operation.'."\n" + .'6. Development integration steps: '."\n" + .'- Select the SDK language you want to use from the [SDK overview](~~145033~~).'."\n" + .'- Find and install the SDK package for the Video Production (videoenhan) category in the corresponding SDK documentation.'."\n" + .'- Modify the sample code provided in the References as needed and invoke the operation.'."\n" + ."\n" + .'7. Sample code: For sample code in commonly used languages, see [Sample code for deleting a video face fusion template](~~602697~~).'."\n" + ."\n" + .'8. Direct client calls: Common client call methods for this feature include the following:'."\n" + .'- [Direct call from web frontend](~~467779~~)'."\n" + .'- [Direct call from mini programs](~~467780~~)'."\n" + .'- [Direct call from Android](~~467781~~)'."\n" + .'- [Direct call from iOS](~~467782~~).', + 'responseParamsDescription' => '## SDK reference'."\n" + .'To use the video face fusion template deletion feature under the Alibaba Cloud Vision AI Video Production category, we recommend that you call the operation by using an SDK. SDKs for multiple programming languages are supported. Select the SDK package for the Video Production (videoenhan) category. File parameters support local files and arbitrary URLs when called through the SDK. For more information, see [SDK overview](~~145033~~).'."\n" + ."\n" + .'## Sample code'."\n" + .'For sample code in commonly used languages, see [Sample code for deleting a video face fusion template](~~602697~~).', + 'extraInfo' => '## Error codes'."\n" + .'For error codes of the video face fusion template deletion feature, see [Common error codes](~~159313~~).'."\n" + ."\n" + .'## Security notice'."\n" + .'- Ensure that the uploaded images or files comply with applicable laws and regulations.'."\n" + .'- Temporary files uploaded through the debugging experience are valid for 1 hour and are automatically deleted by the system after 24 hours.', + 'changeSet' => [ + ['createdAt' => '2022-12-02T02:35:23.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-04-09T08:28:59.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFaceVideoTemplate'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:DeleteFaceVideoTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'EnhancePortraitVideo' => [ + 'summary' => 'This topic describes the syntax and provides examples of the EnhancePortraitVideo operation in the video production (videoenhan) category.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MaxIlluminance', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '600', - 'format' => 'int32', - 'maximum' => '1000', - 'minimum' => '500', - 'required' => false, - 'type' => 'integer', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'Bitrate', + 'name' => 'VideoUrl', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '20', - 'format' => 'int32', - 'maximum' => '200', - 'minimum' => '8', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The URL of the input video. We recommend that you use an OSS URL in the Shanghai region. If the file is stored locally or the OSS URL is not in the Shanghai region, see [File URL processing](~~155645~~).', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'https://viapi-test.oss-cn-shanghai.aliyuncs.com/test-team/xxx/shang/video/SD%289516100%29.mp4', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '881F39DC-C107-4817-A6D5-000BE833CC2A', - 'type' => 'string', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'd21a2afa-4d52-4bca-803b-e65028146603'], 'Data' => [ - 'description' => '', + 'description' => 'The returned data. After the asynchronous task is executed, invoke the [GetAsyncJobResult](~~607824~~) operation and perform JSON deserialization on the Result field to obtain this data.', + 'type' => 'object', 'properties' => [ - 'VideoURL' => [ - 'description' => '', - 'example' => 'http://vibktprfx-prod-prod-aic-vd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/uhd-enhance/20-11-20/Wwzf9z75GO5XdisS_20-11-20-07-13-48.mp4?Expires=1605858272&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=vvY0D%2Bl5eEzp%2BD7mPOWz0zMU7v****', - 'type' => 'string', - ], + 'VideoUrl' => ['description' => 'The URL of the processed video.'."\n" + .'> This URL is a temporary URL that is valid for 30 minutes. After it expires, the URL is no longer accessible. To save the file for a longer period or permanently, access the URL within 30 minutes and download the file to your own OSS bucket or other storage.', 'type' => 'string', 'example' => 'http://vibktprfx-prod-prod-xstream-cn-shanghai.oss-cn-shanghai.aliyuncs.com/xstream-framework/upload_result_video_2023-02-10_09.45.55.mp4?Expires=1675995564&OSSAccessKeyId=LTAI****************&Signature=aIXTeM4IU4nARjy3SNA3YGhhqj****', 'title' => ''], ], - 'type' => 'object', - ], - 'Message' => [ - 'description' => '', + 'title' => '', 'example' => '', - 'type' => 'string', ], + 'Message' => ['description' => 'The message returned after the asynchronous task is submitted.', 'type' => 'string', 'example' => '该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"d21a2afa-4d52-4bca-803b-e65028146603\\",\\n \\"Data\\": {\\n \\"VideoUrl\\": \\"http://vibktprfx-prod-prod-xstream-cn-shanghai.oss-cn-shanghai.aliyuncs.com/xstream-framework/upload_result_video_2023-02-10_09.45.55.mp4?Expires=1675995564&OSSAccessKeyId=LTAI****************&Signature=aIXTeM4IU4nARjy3SNA3YGhhqj****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","type":"json"}]', + 'title' => 'Video portrait enhancement', + 'description' => '## Feature description'."\n" + .'The video portrait enhancement feature is based on the GPEN portrait enhancement model. It improves the clarity of faces in videos, significantly enhancing facial details and texture. Meanwhile, through a face quality assessment algorithm and dynamic adjustment of the relaxation coefficient, the enhanced faces remain natural and realistic.'."\n" + ."\n" + .'>- You can visit [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) for online assistance.'."\n" + .'- You can try this feature for free on the Vision Intelligence Open Platform. Click [Try Now](https://vision.aliyun.com/experience/detail?tagName=videoenhan&children=EnhancePortraitVideo) to experience this feature or purchase it online.'."\n" + .'- To learn more about how to use the visual intelligence service API or to consult with us, join the Alibaba Cloud Vision Intelligence Open Platform DingTalk group (23109592).'."\n" + ."\n" + .'## Common scenarios'."\n" + ."\n" + .'- Face enhancement and restoration in old videos.'."\n" + .'- Clarity improvement of captured footage and ultra-HD video production.'."\n" + ."\n" + .'## Benefits'."\n" + ."\n" + .'- Significantly improves facial clarity: Enhances faces through deep learning, significantly increasing facial details and texture.'."\n" + .'- Maintains natural and stable faces: Keeps enhanced faces natural and realistic through a face quality assessment algorithm and dynamic adjustment of the relaxation coefficient.'."\n" + ."\n" + .'## Getting started'."\n" + .'1. Register an Alibaba Cloud account: Go to the [Alibaba Cloud official website](https://www.aliyun.com), click **Register Now** in the upper-right corner, and follow the instructions to complete account registration.'."\n" + .'2. Activate the service: Make sure you have activated the [video production service](https://vision.aliyun.com/videoenhan). If you have not activated the service, [activate it now](https://common-buy.aliyun.com/?commodityCode=viapi_videoenhan_public_cn#/open).'."\n" + .'3. Create an AccessKey pair: Make sure you have [created an AccessKey pair](~~175144~~). If you are using a RAM user AccessKey pair, grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see [RAM authorization](~~145025~~).'."\n" + .'4. Online debugging (optional): You can use [OpenAPI Explorer](https://next.api.aliyun.com/api/videoenhan/2020-03-20/EnhancePortraitVideo?lang=JAVA) to debug this feature online, view complete sample code and SDK dependency information, or download the complete project.'."\n" + .'5. Development and integration steps: '."\n" + .'- Select the SDK language you want to use from the [SDK overview](~~145033~~).'."\n" + .'- Find and install the SDK package for the video production (videoenhan) AI category in the corresponding SDK documentation.'."\n" + .'- Modify the sample code provided in the References as needed and invoke the operation.'."\n" + ."\n" + .'6. Sample code: For sample code in common programming languages, see [Video portrait enhancement sample code](~~613162~~). For sample code for querying asynchronous task results in common programming languages, see [Query asynchronous task result sample code](~~607974~~).'."\n" + ."\n" + .'7. Direct client invocations: Common client invocation methods for this feature include the following.'."\n" + .'- [Direct invocation from web frontend](~~467779~~)'."\n" + .'- [Direct invocation from mini programs](~~467780~~)'."\n" + .'- [Direct invocation from Android](~~467781~~)'."\n" + .'- [Direct invocation from iOS](~~467782~~).'."\n" + ."\n" + .'## Input limits'."\n" + ."\n" + .'- Video formats: MP4, AVI, MKV, MOV, FLV, TS, MPG, and MXF.'."\n" + .'- Video size: up to 1 GB.'."\n" + .'- Video resolution: less than 1920 × 1080 pixels.'."\n" + .'- The URL cannot contain Chinese characters.'."\n" + ."\n" + .'## Call procedure'."\n" + .'This is an asynchronous operation that requires two steps.'."\n" + .'Step 1: Call the EnhancePortraitVideo operation to submit a task. If the request is successful, a task ID is returned.'."\n" + .'Step 2: Call the [GetAsyncJobResult](~~607824~~) operation to query the result based on the task ID. If the task is still being processed, wait a moment and try again. Do not submit duplicate tasks while the same task is still being processed.'."\n" + ."\n" + .'## Billing description'."\n" + .'The video portrait enhancement feature is currently in public preview and can be called for free.', + 'responseParamsDescription' => '## Query results'."\n" + .'This is an asynchronous operation that does not return the actual result immediately. Call the GetAsyncJobResult operation with the returned RequestId to obtain the actual result. For more information, see [GetAsyncJobResult](~~607824~~).'."\n" + ."\n" + .'## SDK reference'."\n" + .'To use the video portrait enhancement feature in the video production category of Alibaba Cloud Vision AI, we recommend that you use the SDK. The SDK supports multiple programming languages. Select the SDK package for the video production (videoenhan) AI category. The SDK supports both local files and URLs as file parameters. For more information, see [SDK overview](~~145033~~).'."\n" + ."\n" + .'## Sample code'."\n" + .'For sample code in common programming languages, see [Video portrait enhancement sample code](~~613162~~). For sample code for querying asynchronous task results in common programming languages, see [Query asynchronous task result sample code](~~607974~~).', + 'extraInfo' => '## Error codes'."\n" + .'For error codes of the video portrait enhancement feature, see [Common error codes](~~159313~~).'."\n" + ."\n" + .'## Security notice'."\n" + .'- Make sure that the uploaded images or files comply with applicable laws and regulations.'."\n" + .'- Temporary files uploaded through the debugging experience are valid for 1 hour and are automatically deleted by the system after 24 hours.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:EnhancePortraitVideo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'type' => 'object', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'The parameter is invalid. Please check again.', - ], - ], - 403 => [ - [ - 'errorCode' => 'AuthFailed', - 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.', - ], - ], - 408 => [ - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'The request has timed out.', - ], - ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'The service is unavailable.', - ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnhancePortraitVideo'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"881F39DC-C107-4817-A6D5-000BE833CC2A\\",\\n \\"Data\\": {\\n \\"VideoURL\\": \\"http://vibktprfx-prod-prod-aic-vd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/uhd-enhance/20-11-20/Wwzf9z75GO5XdisS_20-11-20-07-13-48.mp4?Expires=1605858272&OSSAccessKeyId=LTAI****************&Signature=vvY0D%2Bl5eEzp%2BD7mPOWz0zMU7v****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","errorExample":""},{"type":"xml","example":"<EnhanceVideoQualityResponse>\\n <RequestId>881F39DC-C107-4817-A6D5-000BE833CC2A</RequestId>\\n <Message>该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。</Message>\\n</EnhanceVideoQualityResponse>","errorExample":""}]', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', ], - 'GenerateVideo' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'EnhanceVideoQuality' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -544,195 +782,181 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Scene', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'costume', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'Width', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '640', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], - ], - [ - 'name' => 'Height', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '640', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], - ], - [ - 'name' => 'Style', + 'name' => 'VideoURL', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'fast', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The URL of the input video. We recommend that you use an OSS link in the China (Shanghai) region. If the file is stored locally or the OSS link is not in the China (Shanghai) region, see [File URL processing](~~155645~~).', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'https://invi-label.oss-cn-shanghai.aliyuncs.com/label/temp/faceswap/test_for_api/xxxx.mp4', 'title' => ''], ], [ - 'name' => 'Duration', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '10', - 'format' => 'float', - 'required' => false, - 'type' => 'number', - ], - ], - [ - 'name' => 'DurationAdaption', + 'name' => 'OutPutWidth', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => false, - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The width of the output video. Default value: twice the width of the input video. Unit: px. Valid values: `[180,7680]`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '7680', 'minimum' => '180', 'example' => '2560', 'title' => ''], ], [ - 'name' => 'TransitionStyle', + 'name' => 'OutPutHeight', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'brush', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The height of the output video. Default value: twice the height of the input video. Unit: px. Valid values: `[180,4320]`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '4320', 'minimum' => '180', 'example' => '1920', 'title' => ''], ], [ - 'name' => 'SmartEffect', + 'name' => 'FrameRate', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => false, - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The frame rate of the output video. Default value: 50 fps. Valid values: `[1,120]`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '120', 'minimum' => '1', 'example' => '50', 'title' => ''], ], [ - 'name' => 'PuzzleEffect', + 'name' => 'HDRFormat', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => false, - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The HDR format of the output video. Only PQ and HLG are supported. Default value: PQ.', 'type' => 'string', 'required' => false, 'default' => 'PQ', 'example' => 'PQ', 'title' => ''], ], [ - 'name' => 'Mute', + 'name' => 'MaxIlluminance', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => false, - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The maximum luminance of the output video. Unit: nit.'."\n" + ."\n" + .'- In **PQ** mode, this parameter is fixed at 600 nit and the input value is ignored.'."\n" + .'- In **HLG** mode, valid values of this parameter range from 500 nit to 1000 nit. Default value: 1000 nit.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '500', 'example' => '600', 'title' => ''], ], [ - 'name' => 'FileList', + 'name' => 'Bitrate', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '1', - 'items' => [ - 'description' => '1', - 'properties' => [ - 'Type' => [ - 'description' => '', - 'example' => 'video', - 'required' => true, - 'type' => 'string', - ], - 'FileUrl' => [ - 'description' => '', - 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoenhan/GenerateVideo/1-video1.mp4', - 'required' => true, - 'type' => 'string', - 'isFileTransferUrl' => true, - ], - 'FileName' => [ - 'description' => '', - 'example' => '1-video1.mp4', - 'required' => true, - 'type' => 'string', - ], - ], - 'required' => false, - 'type' => 'object', - ], - 'maxItems' => 300, - 'required' => true, - 'type' => 'array', - ], + 'schema' => ['description' => 'The bitrate of the output video. Unit: MB. Default value: 20 MB. Valid values: `[8,200]`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '8', 'example' => '20', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '1', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '7CB9B663-3EF8-4C9C-A464-FDA2B5F1E3A4', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '881F39DC-C107-4817-A6D5-000BE833CC2A', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The returned result data. You can obtain this data by calling the [GetAsyncJobResult](~~607824~~) operation after the asynchronous task is complete, and then deserializing the Result field from JSON.', + 'type' => 'object', 'properties' => [ - 'VideoCoverUrl' => [ - 'description' => '', - 'example' => 'http://vibktprfx-prod-prod-aic-vd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-gen/2021-05-07-15/B9MGfwxu.mp4?Expires=1620372653&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=F9flL1n5GPYaae0dLl%2F8D%2Bn4j6****', - 'type' => 'string', - ], - 'VideoUrl' => [ - 'description' => '', - 'example' => 'http://vibktprfx-prod-prod-aic-vd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-gen/2021-05-07-15/B9MGfwxu.jpg?Expires=1620372653&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=djBvGvdJu8bd%2FC%2BVHdg1d57U%2Bu****', - 'type' => 'string', - ], + 'VideoURL' => ['description' => 'The URL of the processed video.'."\n" + .'> This URL is a temporary URL and is valid for 30 minutes. After the URL expires, you can no longer access it. To store the file for an extended period, download the file within 30 minutes and save it to your OSS bucket or other storage.', 'type' => 'string', 'example' => 'http://vibktprfx-prod-prod-aic-vd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/uhd-enhance/20-11-20/Wwzf9z75GO5XdisS_20-11-20-07-13-48.mp4?Expires=1605858272&OSSAccessKeyId=LTAI****************&Signature=vvY0D%2Bl5eEzp%2BD7mPOWz0zMU7v****', 'title' => ''], ], - 'type' => 'object', - ], - 'Message' => [ - 'description' => '', + 'title' => '', 'example' => '', - 'type' => 'string', ], + 'Message' => ['description' => 'The message returned after the asynchronous task is submitted.', 'type' => 'string', 'example' => '该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7CB9B663-3EF8-4C9C-A464-FDA2B5F1E3A4\\",\\n \\"Data\\": {\\n \\"VideoCoverUrl\\": \\"http://vibktprfx-prod-prod-aic-vd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-gen/2021-05-07-15/B9MGfwxu.mp4?Expires=1620372653&OSSAccessKeyId=LTAI****************&Signature=F9flL1n5GPYaae0dLl%2F8D%2Bn4j6****\\",\\n \\"VideoUrl\\": \\"http://vibktprfx-prod-prod-aic-vd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-gen/2021-05-07-15/B9MGfwxu.jpg?Expires=1620372653&OSSAccessKeyId=LTAI****************&Signature=djBvGvdJu8bd%2FC%2BVHdg1d57U%2Bu****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","errorExample":""},{"type":"xml","example":"<GenerateVideoResponse>\\n <RequestId>7CB9B663-3EF8-4C9C-A464-FDA2B5F1E3A4</RequestId>\\n <Message>该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。</Message>\\n</GenerateVideoResponse>","errorExample":""}]', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterError', 'errorMessage' => 'The parameter is invalid. Please check again.', 'description' => 'The parameter is invalid. Please check again.'], + ], + 403 => [ + ['errorCode' => 'AuthFailed', 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.', 'description' => 'An error occurred while performing authorization. Please check your RAM configuration.'], + ], + 408 => [ + ['errorCode' => 'Timeout', 'errorMessage' => 'The request has timed out.', 'description' => 'The request has timed out.'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The service is unavailable.', 'description' => 'The service is unavailable.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"881F39DC-C107-4817-A6D5-000BE833CC2A\\",\\n \\"Data\\": {\\n \\"VideoURL\\": \\"http://vibktprfx-prod-prod-aic-vd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/uhd-enhance/20-11-20/Wwzf9z75GO5XdisS_20-11-20-07-13-48.mp4?Expires=1605858272&OSSAccessKeyId=LTAI****************&Signature=vvY0D%2Bl5eEzp%2BD7mPOWz0zMU7v****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","type":"json"}]', + 'title' => 'Comprehensive video enhancement', + 'summary' => 'This topic describes the syntax and examples of the comprehensive video enhancement feature EnhanceVideoQuality.', + 'description' => '## Feature description'."\n" + .'The comprehensive video enhancement feature uses AI deep learning algorithms to perform frame interpolation, super-resolution (SR), and SDR-to-HDR comprehensive enhancement processing on input SDR videos.'."\n" + ."\n" + .'>- The generated video is in standard HDR format. Play it on a compatible HDR device.'."\n" + .'- You can access [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) to get online assistance.'."\n" + .'- For questions about Alibaba Cloud Visual Intelligence Open Platform visual AI capability API integration, API usage, or consultation, search for DingTalk group (23109592) and join the Alibaba Cloud Visual Intelligence Open Platform consultation group to contact us.'."\n" + ."\n" + .'## Use cases'."\n" + ."\n" + .'- HD video playback systems: For non-HD, non-UHD, and SDR video sources, comprehensive video enhancement can convert them into HD, UHD, HDR, and higher frame rate videos, providing viewers with a better viewing experience.'."\n" + .'- Home video enhancement: Due to the limitations of earlier recording devices, precious home videos were saved at lower resolutions, resulting in poor viewing quality on current HD devices. Comprehensive video enhancement can provide a higher-definition viewing experience suitable for current playback technologies.'."\n" + ."\n" + .'## Key advantages'."\n" + ."\n" + .'- Realistic detail rendering: Accurately infers the details of light and shadow changes in the image, providing you with a true HDR experience.'."\n" + .'- Smoother visuals: Infers the motion changes between frames of the original video and adds more frames to make the visuals smoother.'."\n" + .'- Higher resolution: Enhances the image resolution while optimizing image details, textures, and sharpness, and suppressing block noise and compression noise.'."\n" + ."\n" + .'## Integration guide'."\n" + .'1. Register an Alibaba Cloud account: Go to the [Alibaba Cloud official website](https://www.aliyun.com), click **Sign Up** in the upper-right corner, and follow the instructions to complete registration.'."\n" + .'2. Activate the service: Make sure you have activated the [Video Production service](https://vision.aliyun.com/videoenhan). If you have not activated the service, [activate it now](https://common-buy.aliyun.com/?commodityCode=viapi_videoenhan_public_cn#/open).'."\n" + .'3. Create an AccessKey: Make sure you have [created an AccessKey](~~175144~~). If you are using a RAM user AccessKey, you need to grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see [RAM authorization](~~145025~~).'."\n" + .'4. Online debugging (optional): You can use [OpenAPI Explorer](https://next.api.aliyun.com/api/videoenhan/2020-03-20/EnhanceVideoQuality?lang=JAVA) to debug the feature online, view complete sample code and SDK dependency information, or download the complete project.'."\n" + .'5. Development integration steps:'."\n" + .' '."\n" + .' - Select the SDK language you want to use from the [SDK overview](~~145033~~).'."\n" + ."\n" + .' - Find and install the SDK package for the AI category of Video Production (videoenhan) in the SDK documentation for the corresponding language.'."\n" + ."\n" + .' - Modify the sample code provided in the documentation as needed and make the call.'."\n" + ."\n" + .'6. Sample code: For sample code of this feature in commonly used languages, see [Comprehensive video enhancement sample code](~~602942~~). For sample code for querying asynchronous task results in commonly used languages, see [Query asynchronous task results sample code](~~607974~~).'."\n" + ."\n" + .'7. Client-side direct calls: The commonly used client-side call methods for this feature include the following.'."\n" + .'- [Direct call from web frontend](~~467779~~)'."\n" + .'- [Direct call from mini programs](~~467780~~)'."\n" + .'- [Direct call from Android](~~467781~~)'."\n" + .'- [Direct call from iOS](~~467782~~)'."\n" + ."\n" + .'## Input limits'."\n" + ."\n" + .'- Video types: MP4, AVI, MKV, MOV, FLV, TS, MPG, and MXF.'."\n" + .'- Video size: Up to 1 GB.'."\n" + .'- Video duration: Up to 10 minutes.'."\n" + .'- Video resolution: The input video resolution must be greater than 360 × 360 pixels and less than 1920 × 1080 pixels. The output width and height must not be less than half of the original dimensions and not greater than 4 times the original dimensions.'."\n" + .'- The URL cannot contain Chinese characters.'."\n" + ."\n" + .'## Billing description'."\n" + .'For information about the billing method and pricing of comprehensive video enhancement, see [Billing overview](~~202487~~).'."\n" + ."\n" + .'> The debugging API below is a paid API.'."\n" + ."\n" + .'## Call steps'."\n" + .'This feature is an asynchronous feature that requires two steps to call.'."\n" + .'Step 1: Call the EnhanceVideoQuality operation to submit a task. After the request succeeds, you receive a task ID.'."\n" + .'Step 2: Call the [GetAsyncJobResult](~~607824~~) operation to query results. Query the task execution status and results based on the task ID. If the task is still being processed, wait for a while before querying again. Do not submit the same task repeatedly while it is still being processed.', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - ], - 'InterpolateVideoFrame' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseParamsDescription' => '## Query results'."\n" + .'This operation is an asynchronous operation and does not return the actual request result. You need to call the GetAsyncJobResult operation with the returned RequestId to obtain the actual request result. For more information, see [GetAsyncJobResult](~~607824~~).'."\n" + ."\n" + .'## SDK reference'."\n" + .'We recommend that you use an SDK to call the comprehensive video enhancement feature under the Video Production category of Alibaba Cloud Visual AI. Multiple programming languages are supported. When making the call, select the SDK package for the AI category of Video Production (videoenhan). File parameters support local files and arbitrary URLs when called through the SDK. For more information, see [SDK overview](~~145033~~).'."\n" + ."\n" + .'## Sample code'."\n" + .'For sample code of this feature in commonly used languages, see [Comprehensive video enhancement sample code](~~602942~~). For sample code for querying asynchronous task results in commonly used languages, see [Query asynchronous task results sample code](~~607974~~).', + 'extraInfo' => '## Error codes'."\n" + .'For error codes of comprehensive video enhancement, see [Common error codes](~~159313~~).'."\n" + ."\n" + .'## Security notice'."\n" + .'- Make sure that the uploaded images or files comply with the relevant laws and regulations.'."\n" + .'- Temporary files uploaded through the debugging experience are valid for 1 hour and will be automatically cleaned up and deleted by the system after 24 hours.'."\n", + 'changeSet' => [ + ['createdAt' => '2022-10-17T02:05:11.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnhanceVideoQuality'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:EnhanceVideoQuality', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'EraseVideoLogo' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -743,112 +967,146 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'VideoURL', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoenhan/InterpolateVideoFrame/InterpolateVideoFrame3.mp4', - 'isFileTransferUrl' => true, - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'FrameRate', + 'name' => 'VideoUrl', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '70', - 'format' => 'int32', - 'maximum' => '120', - 'minimum' => '1', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The URL of the video. We recommend that you use an OSS URL in the Shanghai region. If the file is stored locally or in an OSS bucket outside the Shanghai region, see [File URL processing](~~155645~~).', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoenhan/EraseVideoLogo/EraseVideoLogo1.mp4', 'title' => ''], ], [ - 'name' => 'Bitrate', + 'name' => 'Boxes', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'example' => '30', - 'format' => 'int32', - 'maximum' => '200', - 'minimum' => '8', + 'description' => 'The position information of the logo region.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'W' => ['description' => 'The ratio of the logo region width to the video width. Valid values: 0 to 1.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '1.0', 'title' => ''], + 'H' => ['description' => 'The ratio of the logo region height to the video height. Valid values: 0 to 1.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '1.0', 'title' => ''], + 'Y' => ['description' => 'The ratio of the y-coordinate of the upper-left corner of the logo region to the video height. Valid values: 0 to 1.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.0', 'title' => ''], + 'X' => ['description' => 'The ratio of the x-coordinate of the upper-left corner of the logo region to the video width. Valid values: 0 to 1.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.0', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'type' => 'integer', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '7EF85B5B-FB44-4C3E-9B8F-08C6CD912CEB', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '95532F36-98FC-4DCD-815C-282BB26D2DA1', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The returned result data. After the asynchronous task executes successfully, call the [GetAsyncJobResult](~~607824~~) operation and perform JSON deserialization on the Result field to obtain this data.', + 'type' => 'object', 'properties' => [ - 'VideoURL' => [ - 'description' => '', - 'example' => 'http://vibktprfx-prod-prod-aic-vd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-interp/20-12-22/mRsPNVunG7717nne_20-12-22-07-29-51.mp4?Expires=1608624020&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=NFjSLll8E7E1tkuLPFyTpr6ULi****', - 'type' => 'string', - ], + 'VideoUrl' => ['description' => 'The URL of the processed output video.'."\n" + .'> This URL is a temporary URL that is valid for 30 minutes. After it expires, the URL is no longer accessible. To save the file for a longer period or permanently, access the URL within 30 minutes and download the file to your own OSS bucket or other storage.', 'type' => 'string', 'example' => 'http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-delogo/2020-03-20-11/53%3A56-DGNUGG7AcRlAylhr.mp4?Expires=1584707036&OSSAccessKeyId=LTAI****************&Signature=7CvsX7X1rSU%2B%2FDxnw484lb3LCD****', 'title' => ''], ], - 'type' => 'object', - ], - 'Message' => [ - 'description' => '', + 'title' => '', 'example' => '', - 'type' => 'string', ], + 'Message' => ['description' => 'The message returned after the asynchronous task is submitted.', 'type' => 'string', 'example' => '该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"95532F36-98FC-4DCD-815C-282BB26D2DA1\\",\\n \\"Data\\": {\\n \\"VideoUrl\\": \\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-delogo/2020-03-20-11/53%3A56-DGNUGG7AcRlAylhr.mp4?Expires=1584707036&OSSAccessKeyId=LTAI****************&Signature=7CvsX7X1rSU%2B%2FDxnw484lb3LCD****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","type":"json"}]', + 'title' => 'Video logo erasure', + 'summary' => 'Describes the syntax and provides examples of the EraseVideoLogo operation for video logo erasure.', + 'description' => '## Feature description'."\n" + .'The video logo erasure feature removes common logos from videos, such as TV channel logos and Internet platform logos.'."\n" + ."\n" + .'> - You can visit [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) to get online help.'."\n" + .'- You can try this feature for free on the Vision Intelligence Open Platform. Click [Try Now](https://vision.aliyun.com/experience/detail?&tagName=videoenhan&children=EraseVideoLogo) to experience this feature or purchase it online.'."\n" + .'- For questions about Alibaba Cloud Vision Intelligence Open Platform API integration or usage, join the DingTalk group (23109592) to contact us.'."\n" + ."\n" + .'## Integration guide'."\n" + .'1. Register an Alibaba Cloud account: Go to the [Alibaba Cloud official website](https://www.aliyun.com), click **Register Now** in the upper-right corner, and follow the instructions to complete registration.'."\n" + .'2. Activate the service: Make sure you have activated the [Video Production service](https://vision.aliyun.com/videoenhan). If you have not activated the service, [activate it now](https://common-buy.aliyun.com/?commodityCode=viapi_videoenhan_public_cn#/open).'."\n" + .'3. Create an AccessKey pair: Make sure you have [created an AccessKey pair](~~175144~~). If you are using a RAM user AccessKey, grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see [RAM authorization](~~145025~~).'."\n" + .'4. Online debugging (optional): You can use [OpenAPI Explorer](https://next.api.aliyun.com/api/videoenhan/2020-03-20/EraseVideoLogo?lang=JAVA&sdkStyle=dara¶ms=%7B%22VideoUrl%22%3A%22http%3A%2F%2Fviapi-test.oss-cn-shanghai.aliyuncs.com%2Fviapi-3.0domepic%2Fvideoenhan%2FEraseVideoLogo%2FEraseVideoLogo1.mp4%22%7D&tab=DEMO) to debug this feature online, view complete sample code and SDK dependency information, or download the complete project.'."\n" + .'5. Development integration steps:'."\n" + .'- Select the SDK language you want to use from the [SDK overview](~~145033~~).'."\n" + .'- Find and install the SDK package for the Video Production (videoenhan) category in the corresponding SDK documentation.'."\n" + .'- Modify the sample code provided in the References as needed and invoke it.'."\n" + ."\n" + .'6. Sample code: For sample code in common programming languages, see [EraseVideoLogo sample code](~~477825~~). For sample code to query asynchronous task results in common programming languages, see [GetAsyncJobResult sample code](~~607974~~).'."\n" + ."\n" + .'7. Direct client invocation: Common client-side invocation methods for this feature include the following.'."\n" + .'- [Direct invocation from web frontend](~~467779~~)'."\n" + .'- [Direct invocation from mini programs](~~467780~~)'."\n" + .'- [Direct invocation from Android](~~467781~~)'."\n" + .'- [Direct invocation from iOS](~~467782~~).'."\n" + ."\n" + .'## Input limits'."\n" + ."\n" + .'- Video format: MP4.'."\n" + .'- Video size: up to 1 GB.'."\n" + .'- Video resolution: up to 1080p.'."\n" + .'- The URL cannot contain Chinese characters.'."\n" + .'- A maximum of 2 logo erasure regions can be specified at a time. If more than 2 regions are specified, the extra regions are ignored.'."\n" + ."\n" + .'## Billing description'."\n" + .'For the billable methods and pricing of video flag erasure, see [Billing overview](~~202487~~).'."\n" + ."\n" + .'> The debugging API below is a paid API.'."\n" + ."\n" + .'## Calling procedure'."\n" + .'This is an asynchronous operation that requires two steps.'."\n" + .'Step 1: Call the EraseVideoLogo operation to submit a task. If the request is successful, a task ID is returned.'."\n" + .'Step 2: Call the [GetAsyncJobResult](~~607824~~) operation to query the result based on the task ID. If the task is still being processed, wait a moment and try again. Do not submit the same task repeatedly while it is still being processed.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '## Query results'."\n" + .'This is an asynchronous operation that does not return the actual result immediately. Call the GetAsyncJobResult operation with the returned RequestId to obtain the actual result. For more information, see [GetAsyncJobResult](~~607824~~).'."\n" + ."\n" + .'## SDK reference'."\n" + .'To use the video logo erasure feature under the Alibaba Cloud Vision AI Video Production category, use the SDK. Multiple programming languages are supported. When making the call, select the SDK package for the Video Production (videoenhan) category. File parameters support both local files and URLs when called through the SDK. For more information, see [SDK overview](~~145033~~).'."\n" + ."\n" + .'## Sample code'."\n" + .'For sample code in common programming languages, see [EraseVideoLogo sample code](~~477825~~). For sample code to query asynchronous task results in common programming languages, see [GetAsyncJobResult sample code](~~607974~~).', + 'extraInfo' => '## Error codes'."\n" + .'For more information, see [Common error codes](~~159313~~).'."\n" + ."\n" + .'## Security notice'."\n" + .'- Make sure that the uploaded images or files comply with applicable laws and regulations.'."\n" + .'- Temporary files uploaded through the debugging console are valid for 1 hour and are automatically deleted by the system after 24 hours.', + 'changeSet' => [ + ['createdAt' => '2022-10-17T02:05:11.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EraseVideoLogo'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:EraseVideoLogo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'type' => 'object', - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'The parameter is invalid. Please check again.', - ], - ], - 403 => [ - [ - 'errorCode' => 'AuthFailed', - 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.', - ], - ], - 408 => [ - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'The request has timed out.', - ], - ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'The service is unavailable.', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7EF85B5B-FB44-4C3E-9B8F-08C6CD912CEB\\",\\n \\"Data\\": {\\n \\"VideoURL\\": \\"http://vibktprfx-prod-prod-aic-vd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-interp/20-12-22/mRsPNVunG7717nne_20-12-22-07-29-51.mp4?Expires=1608624020&OSSAccessKeyId=LTAI****************&Signature=NFjSLll8E7E1tkuLPFyTpr6ULi****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","errorExample":""},{"type":"xml","example":"<InterpolateVideoFrameResponse>\\n <RequestId>7EF85B5B-FB44-4C3E-9B8F-08C6CD912CEB</RequestId>\\n <Message>该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。</Message>\\n</InterpolateVideoFrameResponse>","errorExample":""}]', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', ], - 'MergeVideoFace' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'EraseVideoSubtitles' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -859,195 +1117,286 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'VideoURL', + 'name' => 'VideoUrl', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoenhan/MergeVideoFace/MergeVideoFace1.mp4', - 'isFileTransferUrl' => true, - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The URL of the video. We recommend that you use an OSS URL in the Shanghai region. If the file is stored locally or in an OSS bucket outside the Shanghai region, see [File URL processing](~~155645~~).', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoenhan/EraseVideoSubtitles/EraseVideoSubtitles1.mp4', 'title' => ''], ], [ - 'name' => 'ReferenceURL', + 'name' => 'BX', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoenhan/MergeVideoFace/MergeVideoFace-pic1.png', - 'isFileTransferUrl' => true, - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The x-coordinate of the upper-left corner of the subtitle region divided by the video width. Valid values: 0 to 1.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'AddWatermark', + 'name' => 'BY', 'in' => 'formData', - 'schema' => [ - 'type' => 'boolean', - 'default' => 'true', - ], + 'schema' => ['description' => 'The y-coordinate of the upper-left corner of the subtitle region divided by the video height. Valid values: 0 to 1.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.75', 'title' => ''], ], [ - 'name' => 'Enhance', + 'name' => 'BW', 'in' => 'formData', - 'schema' => [ - 'type' => 'boolean', - 'default' => 'false', - ], + 'schema' => ['description' => 'The width of the subtitle region divided by the video width. Valid values: 0 to 1.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'WatermarkType', + 'name' => 'BH', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'default' => 'EN', - ], + 'schema' => ['description' => 'The height of the subtitle region divided by the video height. Valid values: 0 to 1.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.25', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '1', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'DEF90E76-B62D-45EF-8835-CA3C83842B18', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CCB082BF-A6B1-4C28-9E49-562EEE7DE639', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The returned result data. After the asynchronous task is executed successfully, call the [GetAsyncJobResult](~~607824~~) operation and perform JSON deserialization on the Result field to obtain this data as a sequence.', + 'type' => 'object', 'properties' => [ - 'VideoURL' => [ - 'description' => '', - 'example' => 'http://vibktprfx-prod-prod-aic-gd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-face-fusion/A657011C-82B4-4705-A5DB-69B18B7CE89D.mp4?Expires=1606378308&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=Hl3cq5XedTGCscOSr0OGVxAS2o****', - 'type' => 'string', - ], + 'VideoUrl' => ['description' => 'The URL of the processed output video.'."\n" + .'> This URL is a temporary URL that is valid for 30 minutes. After it expires, the URL is no longer accessible. To save the file for a longer period or permanently, access the URL within 30 minutes and download the file to your own OSS bucket or other storage.', 'type' => 'string', 'example' => 'http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-desubtitle/2021-04-13-10/41%3A57-TcFd6Zug7gXwbeqs.mp4?Expires=1618312317&OSSAccessKeyId=LTAI****************&Signature=LZnGSQ8019%2Br5rcR4vKOaaT2UE****', 'title' => ''], ], - 'type' => 'object', - ], - 'Message' => [ - 'description' => '', + 'title' => '', 'example' => '', - 'type' => 'string', ], + 'Message' => ['description' => 'The message returned after the asynchronous task is submitted.', 'type' => 'string', 'example' => '该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CCB082BF-A6B1-4C28-9E49-562EEE7DE639\\",\\n \\"Data\\": {\\n \\"VideoUrl\\": \\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-desubtitle/2021-04-13-10/41%3A57-TcFd6Zug7gXwbeqs.mp4?Expires=1618312317&OSSAccessKeyId=LTAI****************&Signature=LZnGSQ8019%2Br5rcR4vKOaaT2UE****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","type":"json"}]', + 'title' => 'Erase video subtitles', + 'summary' => 'This topic describes the syntax and examples of the EraseVideoSubtitles operation.', + 'description' => '## Feature description'."\n" + .'The video subtitle erasure feature can erase text regions that appear throughout the entire video, such as white subtitles at the bottom of movies and TV shows. If the subtitle font in the video is large, the erasure quality may decrease. For cover frames, the video subtitle erasure feature detects erasure regions by extracting frames from the entire video. If subtitles on a cover frame appear for less than 1 second, the subtitle region is ignored.'."\n" + .'> - You can visit [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) for online assistance.'."\n" + .'- You can try this feature for free on the Vision Intelligence Open Platform. Click [Try Now](https://vision.aliyun.com/experience/detail?&tagName=videoenhan&children=EraseVideoSubtitles) to experience this feature or purchase it online.'."\n" + .'- For questions about Alibaba Cloud Vision Intelligence Open Platform visual AI API integration or usage, join the DingTalk group (23109592) to contact us.'."\n" + ."\n" + .'## Integration guide'."\n" + .'1. Register an Alibaba Cloud account: Go to the [Alibaba Cloud official website](https://www.aliyun.com), click **Sign Up** in the upper-right corner, and follow the instructions to complete registration.'."\n" + .'2. Activate the service: Make sure you have activated the [Video Production service](https://vision.aliyun.com/videoenhan). If you have not activated the service, [activate it now](https://common-buy.aliyun.com/?commodityCode=viapi_videoenhan_public_cn#/open).'."\n" + .'3. Create an AccessKey pair: Make sure you have [created an AccessKey pair](~~175144~~). If you are using a RAM user AccessKey, grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see [RAM authorization](~~145025~~).'."\n" + .'4. Online debugging (optional): You can use [OpenAPI Explorer](https://next.api.aliyun.com/api/videoenhan/2020-03-20/EraseVideoSubtitles?lang=JAVA&sdkStyle=dara¶ms=%7B%22VideoUrl%22%3A%22http%3A%2F%2Fviapi-test.oss-cn-shanghai.aliyuncs.com%2Fviapi-3.0domepic%2Fvideoenhan%2FEraseVideoSubtitles%2FEraseVideoSubtitles1.mp4%22%7D&tab=DEMO) to debug this feature online, view complete sample code and SDK dependency information, or download the complete project.'."\n" + .'5. Development integration steps:'."\n" + .'- Select the SDK language you want to use from the [SDK overview](~~145033~~).'."\n" + .'- Find and install the SDK package for the Video Production (videoenhan) AI category in the corresponding SDK documentation.'."\n" + .'- Modify the sample code provided in the References as needed and invoke the node.'."\n" + ."\n" + .'6. Sample code: For sample code in common programming languages, see [EraseVideoSubtitles sample code](~~602965~~). For sample code to query asynchronous task results in common programming languages, see [GetAsyncJobResult sample code](~~607974~~).'."\n" + ."\n" + .'7. Direct client calls: Common client call methods for this feature include the following.'."\n" + .'- [Direct call from web frontend](~~467779~~)'."\n" + .'- [Direct call from mini programs](~~467780~~)'."\n" + .'- [Direct call from Android](~~467781~~)'."\n" + .'- [Direct call from iOS](~~467782~~).'."\n" + ."\n" + .'## Input limits'."\n" + ."\n" + .'- Video format: MP4.'."\n" + .'- Video size: up to 1 GB.'."\n" + .'- Video resolution: up to 1080p.'."\n" + .'- The URL cannot contain Chinese characters.'."\n" + .'- Standard Chinese and English subtitles are supported, such as solid-color movie subtitles. Complex decorative font subtitles or subtitles with very thin strokes are not supported.'."\n" + ."\n" + .'## Billing description'."\n" + .'For the billable methods and pricing of video subtitle erasure, see [Billing overview](~~202487~~).'."\n" + ."\n" + .'> The debugging API below is a paid API.'."\n" + ."\n" + .'## Call procedure'."\n" + .'This is an asynchronous operation that requires two steps.'."\n" + .'Step 1: Call the EraseVideoSubtitles operation to submit a task. After the request succeeds, a task ID is returned.'."\n" + .'Step 2: Call the [GetAsyncJobResult](~~607824~~) operation to query the result based on the task ID. If the task is still being processed, wait a moment before querying again. Do not resubmit a task while the same task is still being processed.', + 'requestParamsDescription' => ' > The bx, by, bw, and bh parameters define a subtitle region. Only subtitles within this region are erased. The default region is the bottom area of the video: `(bx=0, by=0.75, bw=1, bh=0.25)`.', + 'responseParamsDescription' => '## Query results'."\n" + .'This is an asynchronous operation that does not return the actual result immediately. Call the GetAsyncJobResult operation with the returned RequestId to obtain the actual result. For more information, see [GetAsyncJobResult](~~607824~~).'."\n" + ."\n" + .'## SDK reference'."\n" + .'For the video subtitle erasure feature under the Alibaba Cloud Vision AI Video Production category, we recommend using the SDK. Multiple programming languages are supported. When making calls, select the SDK package for the Video Production (videoenhan) AI category. File parameters support both local files and arbitrary URLs through the SDK. For more information, see [SDK overview](~~145033~~).'."\n" + ."\n" + .'## Sample code'."\n" + .'For sample code in common programming languages, see [EraseVideoSubtitles sample code](~~602965~~). For sample code to query asynchronous task results in common programming languages, see [GetAsyncJobResult sample code](~~607974~~).', + 'extraInfo' => '## Error codes'."\n" + .'For error codes of video subtitle erasure, see [Common error codes](~~159313~~).'."\n" + ."\n" + .'## Security notice'."\n" + .'- Make sure that the uploaded images or files comply with applicable laws and regulations.'."\n" + .'- Temporary files uploaded through the debugging experience are valid for 1 hour and are automatically deleted by the system after 24 hours.', + 'changeSet' => [ + ['createdAt' => '2022-10-17T02:05:11.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EraseVideoSubtitles'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:EraseVideoSubtitles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'type' => 'object', - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'The parameter is invalid. Please check again.', - ], - ], - 403 => [ - [ - 'errorCode' => 'AuthFailed', - 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.', - ], - ], - 408 => [ - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'The request has timed out.', - ], - ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'The service is unavailable.', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DEF90E76-B62D-45EF-8835-CA3C83842B18\\",\\n \\"Data\\": {\\n \\"VideoURL\\": \\"http://vibktprfx-prod-prod-aic-gd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-face-fusion/A657011C-82B4-4705-A5DB-69B18B7CE89D.mp4?Expires=1606378308&OSSAccessKeyId=LTAI****************&Signature=Hl3cq5XedTGCscOSr0OGVxAS2o****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","errorExample":""},{"type":"xml","example":"<MergeVideoFaceResponse>\\n <RequestId>DEF90E76-B62D-45EF-8835-CA3C83842B18</RequestId>\\n <Message>该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。</Message>\\n</MergeVideoFaceResponse>","errorExample":""}]', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', ], - 'SuperResolveVideo' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GenerateHumanAnimeStyleVideo' => [ + 'summary' => 'This topic describes the syntax and provides examples of the GenerateHumanAnimeStyleVideo operation in the video production (videoenhan) category.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'VideoUrl', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoenhan/SuperResolveVideo/SuperResolveVideo2.mp4', - 'isFileTransferUrl' => true, - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The URL of the video. We recommend that you use an OSS URL in the China (Shanghai) region. If the file is stored locally or in an OSS bucket outside the China (Shanghai) region, see [File URL processing](~~155645~~).', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'https://viapi-test.oss-cn-shanghai.aliyuncs.com/test/xxx/eas/EvaluateVideoQuality/123.mp4', 'title' => ''], ], [ - 'name' => 'BitRate', + 'name' => 'CartoonStyle', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '5', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The cartoon style. Valid values:'."\n" + ."\n" + .'- anime: anime style'."\n" + .'- 3d: 3D effect'."\n" + .'- handdrawn: hand-drawn style'."\n" + .'- sketch: pencil sketch'."\n" + .'- artstyle: art effect.', 'type' => 'string', 'required' => true, 'example' => 'anime', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '186AC396-0EEC-46F1-AAA1-BF3585227427', - 'type' => 'string', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'd21a2afa-4d52-4bca-803b-e65028146603'], 'Data' => [ - 'description' => '', + 'description' => 'The returned result data. After the asynchronous task executes successfully, invoke the [GetAsyncJobResult](~~607824~~) operation and perform JSON deserialization on the Result field to obtain this data.', + 'type' => 'object', 'properties' => [ - 'VideoUrl' => [ - 'description' => '', - 'example' => 'http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-super-resolution/2020-03-20-12/12%3A11-UlLVELFzIy5EAyEh.mp4?Expires=1584708132&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=0V8yKrCVybC4KIPtRuGKJDJaQT****', - 'type' => 'string', - ], + 'VideoUrl' => ['description' => 'The URL of the processed output video.'."\n" + .'> This URL is a temporary address that is valid for 30 minutes. After it expires, the URL becomes inaccessible. To save the file for a longer period or permanently, access the URL within 30 minutes and download the file to your own OSS bucket or other storage.', 'type' => 'string', 'example' => 'http://vibktprfx-prod-prod-xstream-cn-shanghai.oss-cn-shanghai.aliyuncs.com/xstream-framework/upload_result_video_2023-02-10_09.45.55.mp4?Expires=1675995564&OSSAccessKeyId=LTAI****************&Signature=aIXTeM4IU4nARjy3SNA3YGhhqj****', 'title' => ''], ], - 'type' => 'object', - ], - 'Message' => [ - 'description' => '', + 'title' => '', 'example' => '', - 'type' => 'string', ], + 'Message' => ['description' => 'The message returned after the asynchronous task is submitted.', 'type' => 'string', 'example' => '该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"d21a2afa-4d52-4bca-803b-e65028146603\\",\\n \\"Data\\": {\\n \\"VideoUrl\\": \\"http://vibktprfx-prod-prod-xstream-cn-shanghai.oss-cn-shanghai.aliyuncs.com/xstream-framework/upload_result_video_2023-02-10_09.45.55.mp4?Expires=1675995564&OSSAccessKeyId=LTAI****************&Signature=aIXTeM4IU4nARjy3SNA3YGhhqj****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","type":"json"}]', + 'title' => 'Video portrait cartoonization', + 'description' => '## Feature description'."\n" + .'Converts portrait videos into cartoon-style videos and returns the stylized video results. Supported styles include anime, 3D (3d), hand-drawn (handdrawn), sketch, and art style (artstyle).'."\n" + .'The following figure shows an example of this operation:'."\n" + .'![](https://static-aliyun-doc.oss-cn-hangzhou.aliyuncs.com/file-manage-files/zh-CN/20230221/symy/GenerateHumanAnimeStyleVideo.png" width="600)'."\n" + ."\n" + .'> - You can go to [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) for help.'."\n" + .'- You can try this feature for free on the Vision Intelligence Open Platform. Click [Try Now](https://vision.aliyun.com/experience/detail?tagName=videoenhan&children=GenerateHumanAnimeStyleVideo) to experience this feature or purchase it online.'."\n" + .'- For questions about API access, usage, or consultation regarding Alibaba Cloud Vision Intelligence Open Platform, join the DingTalk group (23109592) to contact us.'."\n" + ."\n" + .'## Common scenarios'."\n" + .'- Fun video processing: Upload a portrait video to generate an exclusive anime-style avatar, creating a cute atmosphere. This can be used for interactive promotions, fun photo albums, and other scenarios.'."\n" + .'- Privacy protection: To protect the privacy of individuals in images, cartoonize the characters to prevent identification of the original person. Compared to mosaic and other processing methods, this approach is more entertaining, more acceptable to users, and improves user experience.'."\n" + ."\n" + .'## Advantages'."\n" + .'- High-fidelity content: Based on deep learning algorithms, the feature effectively preserves details such as facial expressions, accessories, and backgrounds from the original image.'."\n" + .'- Multiple style options: Provides multiple style options with different effects, enabling differentiated production results to meet various scenario and data requirements.'."\n" + .'- Full-body cartoonization: Fine-grained style transformation of the entire image. Compared to face-only cartoonization, this avoids awkward scenarios such as mismatched expressions.'."\n" + .'- Multi-person mode: Supports couple photos, family photos, and group photos.'."\n" + ."\n" + .'## Getting started'."\n" + .'1. Create an Alibaba Cloud account: Go to the [Alibaba Cloud official website](https://www.aliyun.com), click **Sign Up** in the upper-right corner, and follow the instructions to create an account.'."\n" + .'2. Activate the service: Make sure you have activated the [Video Production service](https://vision.aliyun.com/videoenhan). If you have not activated the service, [activate it now](https://common-buy.aliyun.com/?commodityCode=viapi_videoenhan_public_cn#/open).'."\n" + .'3. Create an AccessKey pair: Make sure you have [created an AccessKey pair](~~175144~~). If you are using a RAM user AccessKey, grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see [RAM authorization](~~145025~~).'."\n" + .'4. Online debugging (optional): You can use [OpenAPI Explorer](https://next.api.aliyun.com/api/videoenhan/2020-03-20/GenerateHumanAnimeStyleVideo?lang=JAVA&useCommon=true) to debug this operation online, view complete sample code and SDK dependency information, or download the complete project.'."\n" + .'5. Development and integration steps:'."\n" + .'- Select the SDK language you want to use from the [SDK overview](~~145033~~).'."\n" + .'- Find the SDK package for the video production (videoenhan) AI category in the corresponding SDK documentation and install it.'."\n" + .'- Modify the sample code provided in the documentation as needed and invoke it.'."\n" + ."\n" + .'6. Sample code: For sample code in common languages for this feature, see [Video portrait cartoonization sample code](~~608844~~). For sample code to query asynchronous task results in common languages, see [Query asynchronous task result sample code](~~607974~~).'."\n" + ."\n" + .'7. Direct client invocations: Common client invocation methods for this feature include the following:'."\n" + .'- [Direct invocation from web frontend](~~467779~~)'."\n" + .'- [Direct invocation from mini programs](~~467780~~)'."\n" + .'- [Direct invocation from Android](~~467781~~)'."\n" + .'- [Direct invocation from iOS](~~467782~~).'."\n" + ."\n" + .'References: See the documentation links above for more information.'."\n" + ."\n" + .'## Input limits'."\n" + .'- Supported video formats: MP4, AVI, MKV, FLV, MOV, MPG, TS, and MXF.'."\n" + .'- The recommended input video resolution is no more than 1920 × 1080 pixels.'."\n" + .'- The video size cannot exceed 1 GB.'."\n" + .'- The URL cannot contain Chinese characters.'."\n" + .'- The number of people in a video frame cannot exceed 5. More than 5 people may affect the output quality.'."\n" + ."\n" + .'## Billing description'."\n" + .'The response of this operation does not contain billing information. Video portrait cartoonization is billed based on the **output duration** of the video. The minimum billing unit is one second. Durations less than one second are billed as one second. For details about billable methods and pricing, see [Billing overview](~~202487~~).'."\n" + ."\n" + .'> - The debugging operation below is a paid operation.'."\n" + .'- This feature is asynchronous. Failed invocations are not billed. Querying results by RequestId is not billed.'."\n" + ."\n" + .'## Procedure'."\n" + .'This feature is asynchronous and requires two steps.'."\n" + .'Step 1: Call the GenerateHumanAnimeStyleVideo operation to submit a task. If the request is successful, a task ID is returned.'."\n" + .'Step 2: Call the [GetAsyncJobResult](~~607824~~) operation to query the result based on the task ID. If the task is still being processed, wait a moment before querying again. Do not submit duplicate tasks while the same task is still being processed.', + 'responseParamsDescription' => '## Query results'."\n" + .'This is an asynchronous operation that does not return the actual result. You must call the GetAsyncJobResult operation with the returned RequestId to obtain the actual result. For more information, see [GetAsyncJobResult](~~607824~~).'."\n" + ."\n" + .'## SDK reference'."\n" + .'For the video portrait cartoonization feature under the Alibaba Cloud Vision AI video production category, we recommend that you use the SDK. The SDK supports multiple programming languages. When calling the SDK, select the SDK package for the video production (videoenhan) AI category. File parameters can be passed as local files or any URL through the SDK. For more information, see [SDK overview](~~145033~~).'."\n" + ."\n" + .'## Sample code'."\n" + .'For sample code in common languages for this feature, see [Video portrait cartoonization sample code](~~608844~~). For sample code to query asynchronous task results in common languages, see [Query asynchronous task result sample code](~~607974~~).', + 'extraInfo' => '## Error codes'."\n" + .'For error codes of video portrait cartoonization, see [Common error codes](~~159313~~).'."\n" + ."\n" + .'## Security notice'."\n" + .'- Make sure that the uploaded images or files comply with applicable laws and regulations.'."\n" + .'- Temporary files uploaded through the debugging experience are valid for 1 hour and are automatically deleted by the system after 24 hours.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateHumanAnimeStyleVideo'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:GenerateHumanAnimeStyleVideo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'type' => 'object', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"186AC396-0EEC-46F1-AAA1-BF3585227427\\",\\n \\"Data\\": {\\n \\"VideoUrl\\": \\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-super-resolution/2020-03-20-12/12%3A11-UlLVELFzIy5EAyEh.mp4?Expires=1584708132&OSSAccessKeyId=LTAI****************&Signature=0V8yKrCVybC4KIPtRuGKJDJaQT****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","errorExample":""},{"type":"xml","example":"<SuperResolveVideoResponse>\\n <RequestId>186AC396-0EEC-46F1-AAA1-BF3585227427</RequestId>\\n <Message>该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。</Message>\\n</SuperResolveVideoResponse>","errorExample":""}]', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', ], - 'EraseVideoLogo' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GenerateVideo' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1058,211 +1407,226 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'VideoUrl', + 'name' => 'Scene', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoenhan/EraseVideoLogo/EraseVideoLogo1.mp4', - 'isFileTransferUrl' => true, - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The scene type for video generation. Valid values:'."\n" + ."\n" + .'- costume: costume scene (default)'."\n" + .'- general: general scene'."\n" + .'- keeporder: forces video scene composition in the order of input materials.', 'type' => 'string', 'required' => false, 'example' => 'costume', 'title' => ''], ], [ - 'name' => 'Boxes', + 'name' => 'Width', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'items' => [ - 'properties' => [ - 'W' => [ - 'description' => '', - 'example' => '1.0', - 'format' => 'float', - 'required' => false, - 'type' => 'number', - ], - 'H' => [ - 'description' => '', - 'example' => '1.0', - 'format' => 'float', - 'required' => false, - 'type' => 'number', - ], - 'Y' => [ - 'description' => '', - 'example' => '0.0', - 'format' => 'float', - 'required' => false, - 'type' => 'number', - ], - 'X' => [ - 'description' => '', - 'example' => '0.0', - 'format' => 'float', - 'required' => false, - 'type' => 'number', - ], - ], - 'required' => false, - 'type' => 'object', - ], - 'maxItems' => 100, - 'required' => false, - 'type' => 'array', - ], + 'schema' => ['description' => 'The width of the output video. Valid values: 32 to 2160.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '640', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '95532F36-98FC-4DCD-815C-282BB26D2DA1', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'properties' => [ - 'VideoUrl' => [ - 'description' => '', - 'example' => 'http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-delogo/2020-03-20-11/53%3A56-DGNUGG7AcRlAylhr.mp4?Expires=1584707036&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=7CvsX7X1rSU%2B%2FDxnw484lb3LCD****', - 'type' => 'string', - ], - ], - 'type' => 'object', - ], - 'Message' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - ], - 'type' => 'object', - ], + [ + 'name' => 'Height', + 'in' => 'formData', + 'schema' => ['description' => 'The height of the output video. Valid values: 32 to 2160. If neither width nor height is specified, the output resolution is 750 × 750. If only one is specified, the output aspect ratio is 1:1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '640', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"95532F36-98FC-4DCD-815C-282BB26D2DA1\\",\\n \\"Data\\": {\\n \\"VideoUrl\\": \\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-delogo/2020-03-20-11/53%3A56-DGNUGG7AcRlAylhr.mp4?Expires=1584707036&OSSAccessKeyId=LTAI****************&Signature=7CvsX7X1rSU%2B%2FDxnw484lb3LCD****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","errorExample":""},{"type":"xml","example":"<EraseVideoLogoResponse>\\n <RequestId>95532F36-98FC-4DCD-815C-282BB26D2DA1</RequestId>\\n <Message>该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。</Message>\\n</EraseVideoLogoResponse>","errorExample":""}]', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - ], - 'EraseVideoSubtitles' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Style', + 'in' => 'formData', + 'schema' => ['description' => 'The pace of the output video. Valid values: normal, fast, and slow. Default value: normal.', 'type' => 'string', 'required' => false, 'example' => 'fast', 'title' => ''], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'VideoUrl', + 'name' => 'Duration', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoenhan/EraseVideoSubtitles/EraseVideoSubtitles1.mp4', - 'isFileTransferUrl' => true, - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The duration of the output video. Unit: seconds. Default value: 20.'."\n" + .'The minimum output video duration is 5 seconds, and the maximum is 60 seconds.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'BX', + 'name' => 'DurationAdaption', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '0', - 'format' => 'float', - 'required' => false, - 'type' => 'number', - ], + 'schema' => ['description' => 'Specifies whether to enable adaptive output video duration. Valid values: true and false. If this parameter is set to true, the Duration parameter does not take effect.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'BY', + 'name' => 'TransitionStyle', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '0.75', - 'format' => 'float', - 'required' => false, - 'type' => 'number', - ], + 'schema' => ['description' => 'The shot transition style. A total of 15 styles are available. If this parameter is not specified, a random style is selected based on Style.'."\n" + .'The following shot transition styles are supported: basic (none), slow (soothing), fast (dynamic), normal (natural), ink (ink wash), glitch (mechanical glitch), shift (switch), mosaic (mosaic), shutter (venetian blind), zoom (zoom), mask (mask), brush (brush), wind (wind dance), and smog (smoke).', 'type' => 'string', 'required' => false, 'example' => 'brush', 'title' => ''], ], [ - 'name' => 'BW', + 'name' => 'SmartEffect', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'float', - 'required' => false, - 'type' => 'number', - ], + 'schema' => ['description' => 'Specifies whether to add intelligent effects. Default value: true. Audio-visual synchronization and static-to-dynamic effects are currently supported.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'BH', + 'name' => 'PuzzleEffect', 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable dynamic collage effects, which display multiple video and image materials through collage in a single shot. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Mute', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to mute the generated video. Default value: false.'."\n" + ."\n" + .'> If no audio material is provided or the video material has no sound, the generated video has no music.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'FileList', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'example' => '0.25', - 'format' => 'float', - 'required' => false, - 'type' => 'number', + 'description' => '1.', + 'type' => 'array', + 'items' => [ + 'description' => '1', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the input file. Valid values: video, audio, and image.'."\n" + .'You can input multiple types of materials at the same time (video+image+audio, video+image, video+audio, or image+audio).', 'type' => 'string', 'required' => true, 'example' => 'video', 'title' => ''], + 'FileUrl' => ['description' => 'The URL of the input file. We recommend that you use an OSS URL in the China (Shanghai) region. If the file is stored locally or in an OSS bucket outside the China (Shanghai) region, see [File URL processing](~~155645~~).'."\n" + .'Input limits:'."\n" + .'- Image format: JPG or PNG.'."\n" + .'- Image size: Each image must be greater than 30 KB and less than 100 MB.'."\n" + .'- Audio format: MP3.'."\n" + .'- Video format: MP4, AVI, MKV, or MOV.'."\n" + .'- Video size: Up to 1 GB.'."\n" + .'- A maximum of 5 video materials are supported, and the total duration cannot exceed 3 minutes. Excess content is automatically truncated and discarded (the first 3 minutes are retained in the order of input videos). A maximum of 40 image materials and 1 audio material are supported.'."\n" + .'- The URL cannot contain Chinese characters.', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoenhan/GenerateVideo/1-video1.mp4', 'title' => ''], + 'FileName' => ['description' => 'The name of the input file. For video and audio files in MP4 or MP3 format, the file extension can be omitted. For other formats, the file extension is required.', 'type' => 'string', 'required' => true, 'example' => '1-video1.mp4', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 300, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '1', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'CCB082BF-A6B1-4C28-9E49-562EEE7DE639', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7CB9B663-3EF8-4C9C-A464-FDA2B5F1E3A4', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The returned data.'."\n" + .'After the asynchronous task is executed successfully, invoke the [GetAsyncJobResult](~~607824~~) operation and perform JSON deserialization on the Result field to obtain this data.', + 'type' => 'object', 'properties' => [ - 'VideoUrl' => [ - 'description' => '', - 'example' => 'http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-desubtitle/2021-04-13-10/41%3A57-TcFd6Zug7gXwbeqs.mp4?Expires=1618312317&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=LZnGSQ8019%2Br5rcR4vKOaaT2UE****', - 'type' => 'string', - ], + 'VideoCoverUrl' => ['description' => 'The URL of the output video cover image.'."\n" + .'> This URL is a temporary URL that is valid for 30 minutes. After it expires, the URL is no longer accessible. To store the file for a longer period or permanently, access the URL within 30 minutes and download the file to your own OSS bucket or other storage.', 'type' => 'string', 'example' => 'http://vibktprfx-prod-prod-aic-vd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-gen/2021-05-07-15/B9MGfwxu.mp4?Expires=1620372653&OSSAccessKeyId=LTAI****************&Signature=F9flL1n5GPYaae0dLl%2F8D%2Bn4j6****', 'title' => ''], + 'VideoUrl' => ['description' => 'The URL of the output video.'."\n" + .'> This URL is a temporary URL that is valid for 30 minutes. After it expires, the URL is no longer accessible. To store the file for a longer period or permanently, access the URL within 30 minutes and download the file to your own OSS bucket or other storage.', 'type' => 'string', 'example' => 'http://vibktprfx-prod-prod-aic-vd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-gen/2021-05-07-15/B9MGfwxu.jpg?Expires=1620372653&OSSAccessKeyId=LTAI****************&Signature=djBvGvdJu8bd%2FC%2BVHdg1d57U%2Bu****', 'title' => ''], ], - 'type' => 'object', - ], - 'Message' => [ - 'description' => '', + 'title' => '', 'example' => '', - 'type' => 'string', ], + 'Message' => ['description' => 'The message returned after the asynchronous task is submitted.', 'type' => 'string', 'example' => '该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7CB9B663-3EF8-4C9C-A464-FDA2B5F1E3A4\\",\\n \\"Data\\": {\\n \\"VideoCoverUrl\\": \\"http://vibktprfx-prod-prod-aic-vd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-gen/2021-05-07-15/B9MGfwxu.mp4?Expires=1620372653&OSSAccessKeyId=LTAI****************&Signature=F9flL1n5GPYaae0dLl%2F8D%2Bn4j6****\\",\\n \\"VideoUrl\\": \\"http://vibktprfx-prod-prod-aic-vd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-gen/2021-05-07-15/B9MGfwxu.jpg?Expires=1620372653&OSSAccessKeyId=LTAI****************&Signature=djBvGvdJu8bd%2FC%2BVHdg1d57U%2Bu****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","type":"json"}]', + 'title' => 'General video generation', + 'summary' => 'This topic describes the syntax and provides examples of the GenerateVideo operation for general video generation.', + 'description' => '## Feature description'."\n" + .'The general video generation feature intelligently generates marketing short videos based on input source videos. It supports mixed processing of images, videos, audio, and other materials, and supports overlay effects such as transition effects. You can select the costume scene (default) or general scene as the scene type for input videos. The feature analyzes people and objects in the video and generates a storyline to organize the order of materials. You can also configure input parameters to force video scene composition in the order of input materials.'."\n" + ."\n" + .'The general video generation feature includes the following functions:'."\n" + .'- Input file types: Supports one or more of video, audio, and image.'."\n" + .'- Output video pace: You can select normal, fast, or slow. Default value: normal.'."\n" + .'- Shot transition style: A total of 15 styles are available. If no style is specified, a random style is selected based on Style. The following shot transition styles are supported: basic (none), slow (soothing), fast (dynamic), normal (natural), ink (ink wash), glitch (mechanical glitch), shift (switch), mosaic (mosaic), shutter (venetian blind), zoom (zoom), mask (mask), brush (brush), wind (wind dance), and smog (smoke).'."\n" + .'- Intelligent effects: Audio-visual synchronization and static-to-dynamic effects are currently supported and added by default.'."\n" + .'- Dynamic collage effects: Supports displaying multiple video and image materials through collage in a single shot. Not added by default.'."\n" + ."\n" + .'> - You can access [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) for online assistance.'."\n" + .'- You can try this feature for free on the Vision Intelligence Open Platform. Click [Try Now](https://vision.aliyun.com/experience/detail?&tagName=videoenhan&children=GenerateVideo) to try this feature or purchase it online.'."\n" + .'- To learn more about API integration, usage, or consultation for Alibaba Cloud Vision Intelligence Open Platform visual AI capabilities, join the DingTalk group (23109592) to contact us.'."\n" + ."\n" + .'## Common scenarios'."\n" + .'- Information feed ad production: Batch generate advertising videos based on provided materials for low-cost distribution.'."\n" + .'- Short video reprocessing: Create new video materials based on provided video content and image materials.'."\n" + ."\n" + .'## Benefits'."\n" + .'- Fully automated production: Configure parameters based on business requirements to automatically produce videos.'."\n" + .'- Rich features: Supports multiple material inputs and transition effects for a wider range of business scenarios.'."\n" + ."\n" + .'## Getting started'."\n" + .'1. Create an Alibaba Cloud account: Go to the [Alibaba Cloud official website](https://www.aliyun.com), click **Sign Up** in the upper-right corner, and follow the instructions to create an account.'."\n" + .'2. Activate the service: Make sure that you have activated the [Video Production service](https://vision.aliyun.com/videoenhan). If you have not activated the service, [activate it now](https://common-buy.aliyun.com/?commodityCode=viapi_videoenhan_public_cn#/open).'."\n" + .'3. Create an AccessKey pair: Make sure that you have [created an AccessKey pair](~~175144~~). If you are using a RAM user AccessKey pair, grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see [RAM authorization](~~145025~~).'."\n" + .'4. Online debugging (optional): You can use [OpenAPI Explorer](https://next.api.aliyun.com/api/videoenhan/2020-03-20/GenerateVideo?lang=JAVA&sdkStyle=dara¶ms=%7B%22FileList%22%3A%5B%7B%22FileUrl%22%3A%22http%3A%2F%2Fviapi-test.oss-cn-shanghai.aliyuncs.com%2Fviapi-3.0domepic%2Fvideoenhan%2FGenerateVideo%2F1-video1.mp4%22%2C%22Type%22%3A%22video%22%2C%22FileName%22%3A%221-video1%22%7D%2C%7B%22FileUrl%22%3A%22http%3A%2F%2Fviapi-test.oss-cn-shanghai.aliyuncs.com%2Fviapi-3.0domepic%2Fvideoenhan%2FGenerateVideo%2F1-video2.mp4%22%2C%22Type%22%3A%22video%22%2C%22FileName%22%3A%221-video2%22%7D%2C%7B%22FileUrl%22%3A%22http%3A%2F%2Fviapi-test.oss-cn-shanghai.aliyuncs.com%2Fviapi-3.0domepic%2Fvideoenhan%2FGenerateVideo%2F1-pic1.jpg%22%2C%22Type%22%3A%22image%22%2C%22FileName%22%3A%221-pic1%22%7D%2C%7B%22FileUrl%22%3A%22http%3A%2F%2Fviapi-test.oss-cn-shanghai.aliyuncs.com%2Fviapi-3.0domepic%2Fvideoenhan%2FGenerateVideo%2F1-pic2.jpg%22%2C%22Type%22%3A%22image%22%2C%22FileName%22%3A%221-pic2%22%7D%2C%7B%22FileUrl%22%3A%22http%3A%2F%2Fviapi-test.oss-cn-shanghai.aliyuncs.com%2Fviapi-3.0domepic%2Fvideoenhan%2FGenerateVideo%2F1-pic3.jpg%22%2C%22Type%22%3A%22image%22%2C%22FileName%22%3A%221-pic3%22%7D%2C%7B%22FileUrl%22%3A%22http%3A%2F%2Fviapi-test.oss-cn-shanghai.aliyuncs.com%2Fviapi-3.0domepic%2Fvideoenhan%2FGenerateVideo%2F1-pic4.jpg%22%2C%22Type%22%3A%22image%22%2C%22FileName%22%3A%221-pic4%22%7D%2C%7B%22FileUrl%22%3A%22http%3A%2F%2Fviapi-test.oss-cn-shanghai.aliyuncs.com%2Fviapi-3.0domepic%2Fvideoenhan%2FGenerateVideo%2FI%2520Dunno-Grapes_spinningmerkaba.mp3%22%2C%22Type%22%3A%22audio%22%2C%22FileName%22%3A%22I%2520Dunno-Grapes_spinningmerkaba%22%7D%5D%7D&tab=DEMO) to debug the feature online, view complete sample code and SDK dependency information, or download the complete project.'."\n" + .'5. Development and integration steps: '."\n" + .' - Select the SDK language you want to use from the [SDK overview](~~145033~~).'."\n" + .' - Find the SDK package for the Video Production (videoenhan) AI category in the corresponding SDK documentation and install it.'."\n" + .' - Modify the sample code provided in the References as needed and invoke the operation.'."\n" + ."\n" + .'6. Sample code: For sample code in common programming languages for this feature, see [GenerateVideo sample code](~~478975~~). For sample code in common programming languages for querying asynchronous task results, see [GetAsyncJobResult sample code](~~607974~~).'."\n" + ."\n" + .'7. Direct client invocations: Common client invocation methods for this feature include the following.'."\n" + .'- [Direct call from web frontend](~~467779~~)'."\n" + .'- [Direct call from mini programs](~~467780~~)'."\n" + .'- [Direct call from Android](~~467781~~)'."\n" + .'- [Direct call from iOS](~~467782~~).'."\n" + ."\n" + .'## Input limits'."\n" + ."\n" + .'- Image format: JPG or PNG.'."\n" + .'- Image size: Each image must be greater than 30 KB and less than 100 MB.'."\n" + .'- Audio format: MP3.'."\n" + .'- Video format: MP4, AVI, MKV, or MOV.'."\n" + .'- Video size: Up to 1 GB.'."\n" + .'- A maximum of 5 video materials are supported, and the total duration cannot exceed 3 minutes. Excess content is automatically truncated and discarded (the first 3 minutes are retained in the order of input videos). A maximum of 40 image materials and 1 audio material are supported.'."\n" + .'- The URL cannot contain Chinese characters.'."\n" + ."\n" + .'## Billable methods'."\n" + .'For information about the billable methods and pricing of general video generation, see [Billing overview](~~202487~~).'."\n" + .'> The following debugging operation is a paid operation.'."\n" + ."\n" + .'## Procedure'."\n" + .'This feature is asynchronous and requires two steps.'."\n" + .'In the first step, call the GenerateVideo operation to submit a task. If the request is successful, a task ID is returned.'."\n" + .'In the second step, call the [GetAsyncJobResult](~~607824~~) operation to query the result based on the task ID. If the task is still being processed, wait a moment and query again. Do not submit duplicate tasks while the same task is still being processed.', + 'responseParamsDescription' => '## Query results'."\n" + .'Invoke the GetAsyncJobResult operation by using the returned RequestId to obtain the actual request result. For more information, see [GetAsyncJobResult](~~607824~~). The Result field is a JSON serialize string of the returned task result. For descriptions of the fields in the JSON, see the Data parameter in the response elements.'."\n" + ."\n" + .'## SDK reference'."\n" + .'The SDK is recommended for invoking the general video generation feature under the Vision AI Video Production category. The SDK supports multiple programming languages. When invoking the operation, select the SDK package for the Video Production (videoenhan) AI category. The SDK supports local files and arbitrary URLs for file parameters. For more information, see [SDK overview](~~145033~~).'."\n" + ."\n" + .'## Sample code'."\n" + .'For sample code in common programming languages for this feature, see [GenerateVideo sample code](~~478975~~). For sample code in common programming languages for querying asynchronous task results, see [GetAsyncJobResult sample code](~~607974~~).', + 'extraInfo' => '## Error codes'."\n" + .'For more information, see [Common error codes](~~159313~~).'."\n" + ."\n" + .'## Security notice'."\n" + .'- Make sure that the uploaded images or files comply with applicable laws and regulations.'."\n" + .'- Temporary files uploaded through the debugging console are valid for 1 hour and are automatically deleted by the system after 24 hours.', + 'changeSet' => [ + ['createdAt' => '2022-11-10T08:55:40.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-10-17T02:05:11.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateVideo'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:GenerateVideo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'type' => 'object', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CCB082BF-A6B1-4C28-9E49-562EEE7DE639\\",\\n \\"Data\\": {\\n \\"VideoUrl\\": \\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-desubtitle/2021-04-13-10/41%3A57-TcFd6Zug7gXwbeqs.mp4?Expires=1618312317&OSSAccessKeyId=LTAI****************&Signature=LZnGSQ8019%2Br5rcR4vKOaaT2UE****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","errorExample":""},{"type":"xml","example":"<EraseVideoSubtitlesResponse>\\n <RequestId>CCB082BF-A6B1-4C28-9E49-562EEE7DE639</RequestId>\\n <Message>该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。</Message>\\n</EraseVideoSubtitlesResponse>","errorExample":""}]', - 'responseParamsDescription' => ' ', ], 'GetAsyncJobResult' => [ - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1270,80 +1634,102 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'E75FE679-0303-4DD1-8252-1143B4FA8A27', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The RequestId returned by the asynchronous operation. You can use this parameter to query the actual result of the asynchronous operation.', 'type' => 'string', 'required' => true, 'example' => 'E75FE679-0303-4DD1-8252-1143B4FA8A27', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '1', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '43A0AEB6-45F4-4138-8E89-E1A5D63200E3', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '43A0AEB6-45F4-4138-8E89-E1A5D63200E3', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The returned data.', + 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'example' => 'PROCESS_SUCCESS', - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'description' => '', - 'example' => 'paramsIllegal', - 'type' => 'string', - ], - 'Result' => [ - 'description' => '', - 'example' => '{\\"VideoUrl\\":\\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-super-resolution/2020-03-26-02/55%3A59-XFLsuEKpPxleHl4n.mp4?Expires=1585193159&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=OqsxMwAKsFVjPO%2Brgw%2BpXHIm6v****\\"}', - 'type' => 'string', - ], - 'ErrorCode' => [ - 'description' => '', - 'example' => 'InvalidParameter', - 'type' => 'string', - ], - 'JobId' => [ - 'description' => '', - 'example' => '49E2CC28-ED1D-4CC5-854D-7D0AE2B20976', - 'type' => 'string', - ], + 'Status' => ['description' => 'The status of the asynchronous task. Valid values:'."\n" + ."\n" + .'- QUEUING: The task is queuing.'."\n" + ."\n" + .'- PROCESSING: The task is being processed.'."\n" + ."\n" + .'- PROCESS_SUCCESS: The task was processed.'."\n" + ."\n" + .'- PROCESS_FAILED: The task failed to be processed.'."\n" + ."\n" + .'- TIMEOUT_FAILED: The task timed out.'."\n" + ."\n" + .'- LIMIT_RETRY_FAILED: The maximum number of retries was exceeded.', 'type' => 'string', 'example' => 'PROCESS_SUCCESS', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message of the asynchronous task.', 'type' => 'string', 'example' => 'paramsIllegal', 'title' => ''], + 'Result' => ['description' => 'The actual result of the asynchronous task.', 'type' => 'string', 'example' => '{\\"VideoUrl\\":\\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-super-resolution/2020-03-26-02/55%3A59-XFLsuEKpPxleHl4n.mp4?Expires=1585193159&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=OqsxMwAKsFVjPO%2Brgw%2BpXHIm6v****\\"}', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code of the asynchronous task.', 'type' => 'string', 'example' => 'InvalidParameter', 'title' => ''], + 'JobId' => ['description' => 'The ID of the asynchronous task.', 'type' => 'string', 'example' => '49E2CC28-ED1D-4CC5-854D-7D0AE2B20976', 'title' => ''], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"43A0AEB6-45F4-4138-8E89-E1A5D63200E3\\",\\n \\"Data\\": {\\n \\"Status\\": \\"PROCESS_SUCCESS\\",\\n \\"ErrorMessage\\": \\"paramsIllegal\\",\\n \\"Result\\": \\"{\\\\\\\\\\\\\\"VideoUrl\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-super-resolution/2020-03-26-02/55%3A59-XFLsuEKpPxleHl4n.mp4?Expires=1585193159&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=OqsxMwAKsFVjPO%2Brgw%2BpXHIm6v****\\\\\\\\\\\\\\"}\\",\\n \\"ErrorCode\\": \\"InvalidParameter\\",\\n \\"JobId\\": \\"49E2CC28-ED1D-4CC5-854D-7D0AE2B20976\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>43A0AEB6-45F4-4138-8E89-E1A5D63200E3</RequestId>\\n<Data>\\n <Status>PROCESS_SUCCESS</Status>\\n <JobId>186AC396-0EEC-46F1-AAA1-BF3585227427</JobId>\\n <Result>{\\"VideoUrl\\":\\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-super-resolution/2020-03-26-02/55%3A59-XFLsuEKpPxleHl4n.mp4?Expires=1585193159&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=OqsxMwAKsFVjPO%2Brgw%2BpXHIm6v****\\"}</Result>\\n</Data>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"43A0AEB6-45F4-4138-8E89-E1A5D63200E3\\",\\n \\"Data\\": {\\n \\"Status\\": \\"PROCESS_SUCCESS\\",\\n \\"ErrorMessage\\": \\"paramsIllegal\\",\\n \\"Result\\": \\"{\\\\\\\\\\\\\\"VideoUrl\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-super-resolution/2020-03-26-02/55%3A59-XFLsuEKpPxleHl4n.mp4?Expires=1585193159&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=OqsxMwAKsFVjPO%2Brgw%2BpXHIm6v****\\\\\\\\\\\\\\"}\\",\\n \\"ErrorCode\\": \\"InvalidParameter\\",\\n \\"JobId\\": \\"49E2CC28-ED1D-4CC5-854D-7D0AE2B20976\\"\\n }\\n}","type":"json"}]', + 'title' => 'Query asynchronous task results', + 'summary' => 'This topic describes the syntax and examples of the GetAsyncJobResult operation for querying asynchronous task results.', + 'description' => '## Feature description'."\n" + .'After you invoke an asynchronous API operation, the response does not contain the actual result. Save the RequestId from the response, and then invoke GetAsyncJobResult to obtain the actual result.'."\n" + ."\n" + .'> - Files generated by asynchronous tasks expire after 30 minutes. To retain them for long-term use, promptly download the files to a local server or store them in Object Storage Service (OSS). For more information about OSS operations, see [Upload files](~~31886~~).'."\n" + .'> - To learn more about the Alibaba Cloud Vision AI platform, including API integration, operation usage, or technical consultation, join the DingTalk group (23109592) to contact us.'."\n" + ."\n\n" + .'All operations in the video production category are asynchronous. You must invoke GetAsyncJobResult to obtain the actual results.', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - ], - 'AddFaceVideoTemplate' => [ - 'summary' => '视频人脸融合模板增加', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseParamsDescription' => '## SDK reference'."\n" + .'We recommend that you use an SDK to call Alibaba Cloud Vision AI operations. SDKs are available for multiple programming languages. You can use an SDK to pass local files or URLs as file parameters. For more information, see [SDK overview](~~145033~~).', + 'extraInfo' => '## Deserialize the Result field'."\n" + .'The following example shows the deserialized Result field.'."\n" + .'```'."\n" + .'{'."\n" + .' "VideoUrl": "http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-super-resolution/2020-03-26-02/55%3A59-XFLsuEKpPxleHl4n.mp4?Expires=1585193159&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=OqsxMwAKsFVjPO%2Brgw%2BpXHIm6v****"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'## Error codes'."\n" + .'For error codes of querying asynchronous task results, see [Common error codes](~~159313~~).'."\n" + ."\n" + .'## Security notice'."\n" + .'- Make sure that the images or files you upload comply with applicable laws and regulations.'."\n" + .'- Temporary files uploaded through the debugging console are valid for 1 hour and are automatically cleaned up and deleted by the system after 24 hours.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAsyncJobResult'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:GetAsyncJobResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'InterpolateVideoFrame' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1351,146 +1737,371 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'VideoURL', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'http://invi-label.oss-cn-shanghai.aliyuncs.com/labl/temp/faceswap/test_for_api/xxxx.mp4', - 'isFileTransferUrl' => true, - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The URL of the input video. We recommend that you use an OSS URL in the Shanghai region. If the file is stored locally or in an OSS bucket outside the Shanghai region, see [File URL processing](~~155645~~).', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoenhan/InterpolateVideoFrame/InterpolateVideoFrame3.mp4', 'title' => ''], ], [ - 'name' => 'VideoScene', + 'name' => 'FrameRate', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The frame rate of the output video. Default value: 50. Valid values: `[1,120]`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '120', 'minimum' => '1', 'example' => '70', 'title' => ''], + ], + [ + 'name' => 'Bitrate', + 'in' => 'formData', + 'schema' => ['description' => 'The bitrate of the output video. Unit: Mbit/s. Default value: 20. Valid values: `[8,200]`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '8', 'example' => '30', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'F61182AE-515B-5B0A-A877-1C9AE908FF15', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'Date' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7EF85B5B-FB44-4C3E-9B8F-08C6CD912CEB', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data. After the asynchronous task is executed successfully, invoke the [GetAsyncJobResult](~~607824~~) operation and perform JSON deserialization on the Result field to obtain this data.', + 'type' => 'object', 'properties' => [ - 'TemplateId' => [ - 'description' => '', - 'example' => '6cd509ea-54fa-4730-8e9d-c94cadcda048', - 'type' => 'string', - ], - 'FaceInfos' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TemplateFaceID' => [ - 'type' => 'string', - ], - 'TemplateFaceURL' => [ - 'type' => 'string', - ], - ], - ], - ], - 'TransResult' => [ - 'type' => 'string', - ], + 'VideoURL' => ['description' => 'The URL of the output video.'."\n" + .'> This URL is a temporary URL that is valid for 30 minutes. After it expires, the URL is no longer accessible. To store the file for an extended period or permanently, access the URL within 30 minutes and download the file to your own OSS bucket or other storage.', 'type' => 'string', 'example' => 'http://vibktprfx-prod-prod-aic-vd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-interp/20-12-22/mRsPNVunG7717nne_20-12-22-07-29-51.mp4?Expires=1608624020&OSSAccessKeyId=LTAI****************&Signature=NFjSLll8E7E1tkuLPFyTpr6ULi****', 'title' => ''], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'The message returned after the asynchronous task is submitted.', 'type' => 'string', 'example' => '该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。', 'title' => ''], ], - 'title' => 'Schema of Response', - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F61182AE-515B-5B0A-A877-1C9AE908FF15\\",\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\",\\n \\"Date\\": {\\n \\"TemplateId\\": \\"6cd509ea-54fa-4730-8e9d-c94cadcda048\\",\\n \\"FaceInfos\\": [\\n {\\n \\"TemplateFaceID\\": \\"7d1a2498-0f9a-42d8-bae8-c7e478188106_0\\",\\n \\"TemplateFaceURL\\": \\"http://vibktprfx-prod-prod-aic-gd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-face-fusion/template/xhtest_7d1a2498-0f9a-42d8-bae8-c7e478188106/xhtest_7d1a2498-0f9a-42d8-bae8-c7e478188106_0.png?Expires=1686040781&OSSAccessKeyId=LTAI****************&Signature=WVYTf%2F3knRuUPXSVGVz%2FZi3Miu****\\"\\n }\\n ],\\n \\"TransResult\\": \\"http://vibktprfx-prod-prod-aic-gd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-face-fusion/template/1952059581270833_308f1611-7de8-4f16-9175-f1e997caadf6-V1/1952059581270833_308f1611-7de8-4f16-9175-f1e997caadf6-V1_trans.npy?Expires=1717055504&OSSAccessKeyId=LTAI****************&Signature=zg784H1bv5hwaKPvAywp8p5Hla****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<AddFaceVideoTemplateResponse>\\n <RequestId>F61182AE-515B-5B0A-A877-1C9AE908FF15</RequestId>\\n <Message>该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。</Message>\\n</AddFaceVideoTemplateResponse>","errorExample":""}]', - ], - 'DeleteFaceVideoTemplate' => [ - 'summary' => '视频人脸融合模板删除', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterError', 'errorMessage' => 'The parameter is invalid. Please check again.', 'description' => 'The parameter is invalid. Please check again.'], + ], + 403 => [ + ['errorCode' => 'AuthFailed', 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.', 'description' => 'An error occurred while performing authorization. Please check your RAM configuration.'], + ], + 408 => [ + ['errorCode' => 'Timeout', 'errorMessage' => 'The request has timed out.', 'description' => 'The request has timed out.'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The service is unavailable.', 'description' => 'The service is unavailable.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7EF85B5B-FB44-4C3E-9B8F-08C6CD912CEB\\",\\n \\"Data\\": {\\n \\"VideoURL\\": \\"http://vibktprfx-prod-prod-aic-vd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-interp/20-12-22/mRsPNVunG7717nne_20-12-22-07-29-51.mp4?Expires=1608624020&OSSAccessKeyId=LTAI****************&Signature=NFjSLll8E7E1tkuLPFyTpr6ULi****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","type":"json"}]', + 'title' => 'Video frame interpolation', + 'summary' => 'This topic describes the syntax and provides examples of the InterpolateVideoFrame feature for video frame interpolation.', + 'description' => '## Feature description'."\n" + .'The video frame interpolation feature uses deep learning-based frame rate upconversion to synthesize video frames at arbitrary timestamps through an interpolation network. This optimizes and resolves video quality issues such as stuttering and jittering.'."\n" + ."\n" + .'> - You can visit [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) for online assistance.'."\n" + .'- You can try this feature for free on the Vision Intelligence Open Platform. Click [Try Now](https://vision.aliyun.com/experience/detail?&tagName=videoenhan&children=InterpolateVideoFrame) to experience this feature or purchase it online.'."\n" + .'- For questions about Alibaba Cloud Vision Intelligence Open Platform visual AI API integration or usage, join the DingTalk group (23109592) to contact us.'."\n" + ."\n" + .'## Common scenarios'."\n" + ."\n" + .'- High frame rate video production: Video platforms can use this technology to convert low frame rate videos to high frame rate videos, delivering a smoother viewing experience.'."\n" + .'- Slow-motion video production: Interpolate frames in a standard frame rate video (such as 25 fps), and then play it at the normal frame rate to produce a slow-motion video.'."\n" + ."\n" + .'## Advantages'."\n" + .'Based on deep learning algorithms, this feature infers the positions of objects in intermediate frames, making the interpolated video smoother without jittering or stuttering artifacts.'."\n" + ."\n" + .'## Integration guide'."\n" + .'1. Register an Alibaba Cloud account: Go to the [Alibaba Cloud official website](https://www.aliyun.com), click **Register Now** in the upper-right corner, and follow the instructions to complete registration.'."\n" + .'2. Activate the service: Make sure you have activated the [Video Production service](https://vision.aliyun.com/videoenhan). If you have not activated the service, [activate it now](https://common-buy.aliyun.com/?commodityCode=viapi_videoenhan_public_cn#/open).'."\n" + .'3. Create an AccessKey pair: Make sure you have [created an AccessKey pair](~~175144~~). If you are using a RAM user AccessKey, grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see [RAM authorization](~~145025~~).'."\n" + .'4. Online debugging (optional): You can use [OpenAPI Explorer](https://next.api.aliyun.com/api/videoenhan/2020-03-20/InterpolateVideoFrame?lang=JAVA&sdkStyle=dara¶ms=%7B%22VideoURL%22%3A%22http%3A%2F%2Fviapi-test.oss-cn-shanghai.aliyuncs.com%2Fviapi-3.0domepic%2Fvideoenhan%2FInterpolateVideoFrame%2FInterpolateVideoFrame1.mp4%22%7D&tab=DEMO) to debug this feature online, view complete sample code and SDK dependency information, or download the complete project.'."\n" + .'5. Development integration steps:'."\n" + .'- Select the SDK language you want to use from the [SDK overview](~~145033~~).'."\n" + .'- Find the SDK package for the Video Production (videoenhan) AI category in the corresponding SDK documentation and install it.'."\n" + .' - Modify the sample code provided in the References as needed and invoke the operation.'."\n" + ."\n" + .'6. Sample code: For sample code that queries asynchronous task results for this feature in common programming languages, see [Sample code for querying asynchronous task results](~~607974~~).'."\n" + ."\n" + .'7. Direct client invocation: Common client-side invocation methods for this feature include the following.'."\n" + .'- [Direct invocation from web frontend](~~467779~~)'."\n" + .'- [Direct invocation from mini programs](~~467780~~)'."\n" + .'- [Direct invocation from Android](~~467781~~)'."\n" + .'- [Direct invocation from iOS](~~467782~~).'."\n" + ."\n" + .'## Input limits'."\n" + ."\n" + .'- Video formats: MP4, AVI, MKV, MOV, FLV, TS, MPG, and MXF.'."\n" + .'- Video size: up to 1 GB.'."\n" + .'- Video resolution: at least 360 × 360 pixels and at most 1920 × 1080 pixels.'."\n" + .'- The URL cannot contain Chinese characters.'."\n" + ."\n" + .'## Billing description'."\n" + .'For information about the billable methods and pricing of video frame interpolation, see [Billing overview](~~202487~~).'."\n" + ."\n" + .'> The debugging API below is a paid API.'."\n" + ."\n" + .'## Calling procedure'."\n" + .'This feature is asynchronous and requires two steps.'."\n" + .'Step 1: Call the InterpolateVideoFrame operation to submit a task. If the request is successful, a task ID is returned.'."\n" + .'Step 2: Call the [GetAsyncJobResult](~~607824~~) operation to query the result based on the task ID. If the task is still being processed, wait a moment and try again. Do not submit duplicate tasks while the same task is still being processed.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '## Query results'."\n" + .'This is an asynchronous operation that does not return the actual result. Call the GetAsyncJobResult operation with the returned RequestId to obtain the actual result. For more information, see [GetAsyncJobResult](~~607974~~).'."\n" + ."\n" + .'## SDK reference'."\n" + .'To use the video frame interpolation feature under the Alibaba Cloud Vision AI Video Production category, we recommend that you use the SDK. Multiple programming languages are supported. When calling the API, select the SDK package for the Video Production (videoenhan) AI category. The SDK supports local files and arbitrary URLs for file parameters. For more information, see [SDK overview](~~145033~~).'."\n" + ."\n" + .'# Sample code'."\n" + .'For sample code that queries asynchronous task results for this feature in common programming languages, see [Sample code for querying asynchronous task results](~~607974~~).', + 'extraInfo' => '## Error codes'."\n" + .'For error codes of video frame interpolation, see [Common error codes](~~159313~~).'."\n" + ."\n" + .'## Security notice'."\n" + .'- Make sure that the uploaded images or files comply with applicable laws and regulations.'."\n" + .'- Temporary files uploaded through the debugging console are valid for 1 hour and are automatically deleted by the system after 24 hours.', + 'changeSet' => [ + ['createdAt' => '2022-10-17T02:05:12.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InterpolateVideoFrame'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:InterpolateVideoFrame', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'MergeVideoFace' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'VideoURL', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '3bf2418c-7adf-4002-a9d6-2f7cf1889c0d', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The URL of the input video. We recommend that you use an OSS URL in the China (Shanghai) region. If the file is stored locally or in an OSS bucket outside the China (Shanghai) region, see [File URL processing](~~155645~~).', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoenhan/MergeVideoFace/MergeVideoFace1.mp4', 'title' => ''], + ], + [ + 'name' => 'ReferenceURL', + 'in' => 'formData', + 'schema' => ['description' => 'The URL of the reference face image for replacement. We recommend that you use an OSS URL in the China (Shanghai) region. If the file is stored locally or in an OSS bucket outside the China (Shanghai) region, see [File URL processing](~~155645~~).'."\n" + .'Input limits:'."\n" + .'- Image formats: JPEG, JPG, and PNG.'."\n" + .'- Image resolution: at least 128 × 128 pixels and at most 4000 × 4000 pixels.'."\n" + .'- Image size: up to 20 MB.'."\n" + .'- The URL cannot contain Chinese characters.', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoenhan/MergeVideoFace/MergeVideoFace-pic1.png', 'title' => ''], + ], + [ + 'name' => 'AddWatermark', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to add a watermark. Valid values:'."\n" + ."\n" + .'- True (default): Add a watermark.'."\n" + .'- False: Do not add a watermark.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'True', 'title' => ''], + ], + [ + 'name' => 'Enhance', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable face beautification enhancement. Valid values:'."\n" + ."\n" + .'- False (default): Disable face beautification enhancement.'."\n" + .'- True: Enable face beautification enhancement.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'False', 'title' => ''], + ], + [ + 'name' => 'WatermarkType', + 'in' => 'formData', + 'schema' => ['description' => 'The watermark type. Valid values:'."\n" + ."\n" + .'- EN (default): English watermark.'."\n" + .'- CN: Chinese watermark.', 'type' => 'string', 'default' => 'EN', 'required' => false, 'example' => 'EN', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'description' => '1', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '2337D184-CD63-57B5-96A2-B60AABCB7B58', - 'title' => 'Id of the request', - 'type' => 'string', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DEF90E76-B62D-45EF-8835-CA3C83842B18', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.'."\n" + .'After the asynchronous task is executed successfully, invoke the [GetAsyncJobResult](~~607824~~) operation and perform JSON deserialization on the Result field to obtain this data.', + 'type' => 'object', + 'properties' => [ + 'VideoURL' => ['description' => 'The URL of the processed video.'."\n" + .'> This URL is a temporary address that is valid for 30 minutes. After it expires, the URL becomes inaccessible. To retain the file for a longer period or permanently, access the URL within 30 minutes and download the file to your own OSS bucket or other storage.', 'type' => 'string', 'example' => 'http://vibktprfx-prod-prod-aic-gd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-face-fusion/A657011C-82B4-4705-A5DB-69B18B7CE89D.mp4?Expires=1606378308&OSSAccessKeyId=LTAI****************&Signature=Hl3cq5XedTGCscOSr0OGVxAS2o****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'The message returned after the asynchronous task is submitted.', 'type' => 'string', 'example' => '该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterError', 'errorMessage' => 'The parameter is invalid. Please check again.', 'description' => 'The parameter is invalid. Please check again.'], + ], + 403 => [ + ['errorCode' => 'AuthFailed', 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.', 'description' => 'An error occurred while performing authorization. Please check your RAM configuration.'], + ], + 408 => [ + ['errorCode' => 'Timeout', 'errorMessage' => 'The request has timed out.', 'description' => 'The request has timed out.'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The service is unavailable.', 'description' => 'The service is unavailable.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DEF90E76-B62D-45EF-8835-CA3C83842B18\\",\\n \\"Data\\": {\\n \\"VideoURL\\": \\"http://vibktprfx-prod-prod-aic-gd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-face-fusion/A657011C-82B4-4705-A5DB-69B18B7CE89D.mp4?Expires=1606378308&OSSAccessKeyId=LTAI****************&Signature=Hl3cq5XedTGCscOSr0OGVxAS2o****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","type":"json"}]', + 'title' => 'Video face fusion', + 'summary' => 'Describes the syntax and provides examples of the MergeVideoFace operation for video face fusion.', + 'description' => '## Feature description'."\n" + .'With user authorization, the general video face fusion feature can detect the largest face in a video and merge it with the facial features of another person to achieve a face-swapping visual effect.'."\n" + .'General video face fusion requires only one face image and one video as input to merge the face from the image into the video.'."\n" + .'Applicable scenarios:'."\n" + .'- Each synthesis is completed independently, without a common template.'."\n" + .'- Only videos that contain a single face are supported.'."\n" + ."\n" + .'For multi-person scenarios or a fixed number of video templates, see [Template-based video face fusion](~~467950~~) (MergeVideoModelFace).'."\n" + .'To ensure the safety and legality of generated content, do not use images or videos of public figures or those containing sensitive information for fusion. Additionally, a **Generated by AI** watermark is added to the lower-left corner of the synthesized result, as shown in the following figure.'."\n" + .''."\n" + ."\n" + .'> - You can visit [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) for online assistance.'."\n" + .'- You can try this feature for free on the Visual Intelligence Open Platform. Click [Try Now](https://vision.aliyun.com/experience/detail?&tagName=videoenhan&children=MergeVideoFace) to experience this feature or purchase it online.'."\n" + .'- For questions about API access, usage, or consultation regarding the Alibaba Cloud Visual Intelligence Open Platform, join the DingTalk group (23109592) to contact us.'."\n" + ."\n" + .'## Common scenarios'."\n" + .'- Film and television post-production: When an actor needs to be replaced during post-production for certain reasons, video face fusion technology can process previously shot footage to make it appear as if a new actor is performing, saving the production team significant reshooting costs.'."\n" + .'- Entertainment short video creation: Users can merge their own face with the face of a person in a legally authorized video to generate entertaining videos.'."\n" + ."\n" + .'## Features'."\n" + .'- High fidelity with low visual inconsistency: The fused face retains the visual identity features of the replacement face while blending seamlessly into the original face.'."\n" + .'- Expression and skin tone consistency: The fused face preserves the facial expressions and skin tone consistency of the original face to the greatest extent.'."\n" + .'- Support for complex face angles: Template faces tilted at certain angles are supported, and the fusion results remain realistic and stable.'."\n" + ."\n" + .'## Getting started'."\n" + .'1. Create an Alibaba Cloud account: Go to the [Alibaba Cloud official website](https://www.aliyun.com), click **Register Now** in the upper-right corner, and follow the instructions to complete account registration.'."\n" + .'2. Activate the feature: Make sure that you have activated the [Video Production service](https://vision.aliyun.com/videoenhan). If you have not activated the service, [activate it now](https://common-buy.aliyun.com/?commodityCode=viapi_videoenhan_public_cn#/open).'."\n" + ."\n" + .'><notice>Users who activated this feature on or after July 17, 2024 can directly invoke the operation without committing an application.'."\n" + .'Users who activated this service before July 17, 2024 can join the DingTalk group (23109592) to contact us and be added to the whitelist.'."\n" + .'></notice>'."\n" + ."\n\n" + .'3. Create an AccessKey pair: Make sure that you have [created an AccessKey pair](~~175144~~). If you are using a RAM user AccessKey, grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see [RAM authorization](~~145025~~).'."\n" + .'4. Online debugging (optional): You can use [OpenAPI Explorer](https://next.api.aliyun.com/api/videoenhan/2020-03-20/MergeVideoFace?lang=JAVA&sdkStyle=dara¶ms=%7B%22VideoURL%22%3A%22http%3A%2F%2Fviapi-test.oss-cn-shanghai.aliyuncs.com%2Fviapi-3.0domepic%2Fvideoenhan%2FMergeVideoFace%2FMergeVideoFace1.mp4%22%2C%22ReferenceURL%22%3A%22http%3A%2F%2Fviapi-test.oss-cn-shanghai.aliyuncs.com%2Fviapi-3.0domepic%2Fvideoenhan%2FMergeVideoFace%2FMergeVideoFace-pic1.png%22%2C%22PostURL%22%3A%22%20%22%7D&tab=DEMO) to debug the feature online, view complete sample code and SDK dependency information, or download the complete project.'."\n" + .'5. Development and integration steps:'."\n" + .'- Select the SDK language you want to use from the [SDK overview](~~145033~~).'."\n" + .'- Find the SDK package for the Video Production (videoenhan) AI category in the corresponding SDK documentation and install it.'."\n" + .'- Modify the sample code provided in the References as needed and invoke the operation.'."\n" + ."\n" + .'6. Sample code: For sample code in common programming languages, see [Video face fusion sample code](~~602481~~). For sample code to query asynchronous task results in common programming languages, see [Query asynchronous task result sample code](~~607974~~).'."\n" + ."\n" + .'7. Direct client invocations: Common client invocation methods for this platform include the following:'."\n" + .'- [Direct call from web frontend](~~467779~~)'."\n" + .'- [Direct call from mini programs](~~467780~~)'."\n" + .'- [Direct call from Android](~~467781~~)'."\n" + .'- [Direct call from iOS](~~467782~~).'."\n" + ."\n" + .'## Input limits'."\n" + .'- Video formats: MP4, AVI, MKV, MOV, FLV, TS, and MPG.'."\n" + .'- Video resolution: greater than 360 × 360 pixels and less than 1920 × 1920 pixels.'."\n" + .'- Video size: up to 120 MB.'."\n" + .'- Image formats: JPEG, JPG, and PNG.'."\n" + .'- Image resolution: at least 128 × 128 pixels and at most 4000 × 4000 pixels.'."\n" + .'- Image size: up to 20 MB.'."\n" + .'- The URL cannot contain Chinese characters.'."\n" + .'- Only videos with a static (constant) frame rate are supported. Videos with a dynamic (variable) frame rate are not supported.'."\n" + .'- The video duration must not exceed 300 seconds. For videos longer than 300 seconds, call the [Template-based video face fusion](~~467950~~) operation.'."\n" + ."\n" + .'## Image quality recommendations'."\n" + ."\n" + .'- Ensure that the face in the image is clear. The face size in the image should be greater than 64 × 64 pixels, and the face area should not exceed 2/3 of the total image area.'."\n" + .'- Ensure that the facial features are complete and not significantly occluded. The face fusion algorithm supports faces tilted at certain angles, and better results are achieved when the tilt angle does not exceed 30 degrees.'."\n" + .'- The image for face fusion should contain only one face. If multiple faces are present, the largest face in the image is selected by default for fusion.'."\n" + ."\n" + .'Recommended image examples:'."\n" + .''."\n" + ."\n" + .'Not recommended image examples:'."\n" + .'.'."\n" + ."\n" + .'## Call procedure'."\n" + .'This feature is asynchronous and requires two steps.'."\n" + .'Step 1: Call the MergeVideoFace operation to submit a task. After the request succeeds, a task ID is returned.'."\n" + .'Step 2: Call the [GetAsyncJobResult](~~607824~~) operation to query the result based on the task ID. If the task is still being processed, wait a moment before querying again. Do not resubmit a task while the same task is still being processed.'."\n" + ."\n" + .'## Billable methods'."\n" + .'For the billable methods and pricing of general video face fusion, see [Billing overview](~~202487~~).'."\n" + ."\n" + .'> The debugging operation below is a paid operation. For a free trial, go to the [Experience Center](https://vision.aliyun.com/experience/detail?&tagName=videoenhan&children=MergeVideoFace).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '## Query results'."\n" + .'This is an asynchronous operation that does not return the actual result immediately. Call the GetAsyncJobResult operation with the returned RequestId to obtain the actual result. For more information, see [GetAsyncJobResult](~~607824~~).'."\n" + ."\n" + .'## SDK reference'."\n" + .'For the general video face fusion feature under the Visual AI Video Production category, we recommend that you use the SDK. Multiple programming languages are supported. When calling the operation, select the SDK package for the Video Production (videoenhan) AI category. File parameters can be passed as local files or URLs through the SDK. For more information, see [SDK overview](~~145033~~).'."\n" + ."\n" + .'## Sample code'."\n" + .'For sample code in common programming languages, see [General video face fusion sample code](~~602481~~). For sample code to query asynchronous task results in common programming languages, see [Query asynchronous task result sample code](~~607974~~).', + 'extraInfo' => '## Error codes'."\n" + .'For error codes of video face fusion, see [Common error codes](~~159313~~).'."\n" + ."\n" + .'## Security notice'."\n" + .'- Ensure that the uploaded images or files comply with applicable laws and regulations.'."\n" + .'- Temporary files uploaded through the debugging experience are valid for 1 hour and are automatically deleted by the system after 24 hours.', + 'changeSet' => [ + ['createdAt' => '2023-10-10T06:49:10.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-31T07:56:43.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-10T01:59:08.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-16T05:19:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-30T06:48:45.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-10-17T02:05:11.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-29T07:59:27.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MergeVideoFace'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:MergeVideoFace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'title' => 'Schema of Response', - 'type' => 'object', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2337D184-CD63-57B5-96A2-B60AABCB7B58\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteFaceVideoTemplateResponse>\\n <RequestId>2337D184-CD63-57B5-96A2-B60AABCB7B58</RequestId>\\n</DeleteFaceVideoTemplateResponse>","errorExample":""}]', ], 'MergeVideoModelFace' => [ - 'summary' => '视频模板融合换脸', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'This document describes the syntax and examples of template video face fusion MergeVideoModelFace.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1502,116 +2113,231 @@ [ 'name' => 'TemplateId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '3bf2418c-7adf-4002-a9d6-2f7cf1889c0d', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The template ID of the video face template.', 'type' => 'string', 'required' => true, 'example' => '3bf2418c-7adf-4002-a9d6-2f7cf1889c0d', 'title' => ''], ], [ 'name' => 'FaceImageURL', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'https://invi-label.oss-cn-shanghai.aliyuncs.com/label/temp/faceswap/ref/ref.jpg', - 'isFileTransferUrl' => true, - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The URL of the reference face image for replacement (cannot be empty when TemplateId is for a single face). **FaceImageURL** is only used for single-person video scenarios, and there is no need to input the **MergeInfos** field.'."\n" + .'Currently, only OSS links in the Shanghai region are supported. For how to generate a URL, see [File URL Processing](~~155645~~).'."\n" + ."\n" + .'Input limits:'."\n" + .'- Image format: JPEG, JPG, PNG.'."\n" + .'- Image resolution: Greater than or equal to 128×128 pixels, less than or equal to 4000×4000 pixels.'."\n" + .'- Image size: No larger than 20 MB.'."\n" + .'- The URL cannot contain Chinese characters.', 'type' => 'string', 'required' => false, 'isFileTransferUrl' => true, 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoenhan/MergeVideoFace/MergeVideoFace-xxxx.png', 'title' => ''], ], [ 'name' => 'AddWatermark', 'in' => 'formData', - 'schema' => [ - 'type' => 'boolean', - 'default' => 'true', - ], + 'schema' => ['description' => 'Specifies whether to add a watermark. Valid values:'."\n" + ."\n" + .'- True (default): Add a watermark.'."\n" + .'- False: Do not add a watermark.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'True', 'title' => ''], ], [ 'name' => 'Enhance', 'in' => 'formData', - 'schema' => [ - 'type' => 'boolean', - 'default' => 'false', - ], + 'schema' => ['description' => 'Specifies whether to enable face beauty enhancement. Valid values:'."\n" + ."\n" + .'- False (default): Disable face beauty enhancement.'."\n" + .'- True: Enable face beauty enhancement.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'True', 'title' => ''], ], [ 'name' => 'WatermarkType', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'default' => 'EN', - ], + 'schema' => ['description' => 'The watermark type. Valid values:'."\n" + ."\n" + .'- EN (default): English watermark.'."\n" + .'- CN: Chinese watermark.', 'type' => 'string', 'default' => 'EN', 'required' => false, 'example' => 'EN', 'title' => ''], ], [ 'name' => 'MergeInfos', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ + 'description' => 'The merge parameters, including the face information of the template video and the user face images to be merged (cannot be empty when TemplateId is for multiple faces).'."\n" + ."\n" + .'> - **MergeInfos** is only used for multi-person video scenarios. Make sure that the **VideoScene** parameter was set to `multi` when the user added the template. The **TemplateFaceID** values passed in must correspond one-to-one with the **TemplateFaceID** values in the **FaceInfos** returned when the template was added.'."\n" + .'- If both **FaceImageURL** and **MergeInfos** are passed in, the one used depends on whether the **TemplateId** is for a single or multiple faces. The other input parameter is filtered out.', 'type' => 'array', 'items' => [ + 'description' => 'The merge parameters, including the face information of the template video and the user face images to be merged (cannot be empty when TemplateId is for multiple faces).'."\n" + ."\n" + .'> - **MergeInfos** is only used for multi-person video scenarios. Make sure that the **VideoScene** parameter was set to `multi` when the user added the template. The **TemplateFaceID** values passed in must correspond one-to-one with the **TemplateFaceID** values in the **FaceInfos** returned when the template was added.'."\n" + .'- If both **FaceImageURL** and **MergeInfos** are passed in, the one used depends on whether the **TemplateId** is for a single or multiple faces. The other input parameter is filtered out.', 'type' => 'object', 'properties' => [ - 'TemplateFaceID' => [ - 'type' => 'string', - ], - 'TemplateFaceURL' => [ - 'type' => 'string', - ], - 'ImageURL' => [ - 'type' => 'string', - ], + 'TemplateFaceID' => ['description' => 'The sub-ID of a specific face in the multi-face template. You need to obtain this from the [AddFaceVideoTemplate](~~468904~~) API first (when passing in multiple TemplateFaceID values, they cannot be duplicated).'."\n" + ."\n" + .'> When both **TemplateFaceID** and **TemplateFaceURL** are passed in, **TemplateFaceID** takes priority.', 'type' => 'string', 'required' => false, 'example' => 'f913c614-d542-42ba-b173-07db2058c207_0', 'title' => ''], + 'TemplateFaceURL' => ['description' => 'The image URL of a specific face in the multi-face template. This allows users to use third-party detection modules to extract frames for face recognition and obtain the corresponding face images.', 'type' => 'string', 'required' => false, 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-/videoenhan/MergeVideoModelFace/xxx.jpg', 'title' => ''], + 'ImageURL' => ['description' => 'The image URL of the face to be replaced. Currently, only OSS links in the Shanghai region are supported. For how to generate a URL, see [File URL Processing](~~155645~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/test-team/MergeVideoModelFace/xxx.jpg', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', 'description' => 'Schema of Response', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '334F180F-3B50-51CB-B4CB-9A86A542D3BC', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '334F180F-3B50-51CB-B4CB-9A86A542D3BC'], + 'Message' => ['description' => 'The prompt message returned after submitting the asynchronous task.', 'type' => 'string', 'example' => '该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The returned result data content. This data needs to be obtained by calling the [GetAsyncJobResult](~~159423~~) API after the asynchronous task is successfully executed, and then JSON-deserializing its Result field.', + 'type' => 'object', 'properties' => [ - 'VideoURL' => [ - 'description' => '', - 'example' => 'http://vibktprfx-prod-prod-aic-gd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-face-fusion/334F180F-3B50-51CB-B4CB-9A86A542D3BC-5716-20210906-074905.mp4?Expires=1630916420&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=OEtNqVYxXRwkyO4BrsYVJ8q5bx****', - 'type' => 'string', - ], + 'VideoURL' => ['description' => 'The URL of the processed video.'."\n" + .'> This URL is a temporary address, valid for 30 minutes. It will be inaccessible after expiration. If you need to save the file for a long time or permanently, access the URL within 30 minutes and download the file to your own OSS or other storage space.', 'type' => 'string', 'example' => 'http://vibktprfx-prod-prod-aic-gd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-face-fusion/334F180F-3B50-51CB-B4CB-9A86A542D3BC-5716-20210906-074905.mp4?Expires=1630916420&OSSAccessKeyId=LTAI****************&Signature=OEtNqVYxXRwkyO4BrsYVJ8q5bx****', 'title' => ''], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], ], - 'title' => 'Schema of Response', - 'type' => 'object', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"334F180F-3B50-51CB-B4CB-9A86A542D3BC\\",\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\",\\n \\"Data\\": {\\n \\"VideoURL\\": \\"http://vibktprfx-prod-prod-aic-gd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-face-fusion/334F180F-3B50-51CB-B4CB-9A86A542D3BC-5716-20210906-074905.mp4?Expires=1630916420&OSSAccessKeyId=LTAI****************&Signature=OEtNqVYxXRwkyO4BrsYVJ8q5bx****\\"\\n }\\n}","type":"json"}]', + 'title' => 'Template Video Face Fusion', + 'description' => '## Feature Description'."\n" + .'With user authorization, video face fusion can precisely locate faces in videos and perform facial fusion between the target face photo uploaded by the user and another person\'s face, achieving a face-swapping visual effect.'."\n" + .'Template video face fusion is based on templates pre-uploaded and created by users. By inputting a face image to be merged, the image face is fused into the specified template video. This method requires creating the template video (AddFaceVideoTemplate) in advance, and its processing efficiency is higher than the general video face fusion method.'."\n" + .'Applicable scenarios:'."\n" + .'- Scenarios with a fixed number of template videos for fusion.'."\n" + .'- Supports both single-face and multi-face scenarios in videos, with support for face selection and multi-face fusion.'."\n" + ."\n" + .'To ensure the safety and legality of generated content, do not use images or videos of public figures or those involving sensitive information for fusion. Additionally, this service will add a **Generated by AI** watermark in the lower-left corner of the synthesized result, as shown in the image below.'."\n" + .''."\n" + ."\n" + .'> - You can visit [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) to get online human assistance.'."\n" + .'- For API access, interface usage, or consultation on Alibaba Cloud Visual Intelligence Open Platform visual AI capabilities, please join the Alibaba Cloud Visual Intelligence Open Platform consultation group through DingTalk group (23109592) to contact us.'."\n" + ."\n" + .'## Application Scenarios'."\n" + .'- Film and television post-production: During post-production, when actors need to be replaced for certain reasons, video face fusion technology can be used to process previously shot footage, making the characters in the earlier video footage appear to be performed by new actors, saving producers significant reshooting costs.'."\n" + .'- Entertainment short video production: Users can fuse their own faces with the faces of characters in authorized and legal videos to generate entertaining videos.'."\n" + .'- Virtual try-on production: In try-on scenarios such as wedding photography, ethnic clothing, Hanfu, and makeup simulation, video face fusion technology is used for virtual clothing try-on.'."\n" + .'- E-commerce digital human live streaming: In e-commerce live streaming scenarios, face swapping with influencer face IDs enables digital human live streaming and virtual human face swapping.'."\n" + ."\n" + .'## Key Advantages'."\n" + .'- High-fidelity, low-incongruity effect: The fused face retains the visual characteristics of the replacement face\'s identity information while blending naturally into the replaced face without any sense of incongruity.'."\n" + .'- Expression and skin tone consistency: The fused face maximally preserves the facial expressions and skin tone consistency of the replaced person.'."\n" + .'- Support for complex face angles: Supports template faces tilted at certain angles, with realistic and stable fusion results.'."\n" + .'- Support for multi-face specified swapping: Supports videos containing multiple faces, with each face specified to be fused with different user faces, applicable in multi-person interactive scenarios such as family portraits, wedding photography, and multi-character creation.'."\n" + ."\n" + .'## Access Guide'."\n" + .'1. Register an Alibaba Cloud account: Go to the [Alibaba Cloud official website](https://www.aliyun.com), click **Register Now** in the upper-right corner, and follow the prompts to complete account registration.'."\n" + .'2. Activate the service: Make sure you have activated the [Video Production service](https://vision.aliyun.com/videoenhan). If you have not activated the service, please [activate it now](https://common-buy.aliyun.com/?commodityCode=viapi_videoenhan_public_cn#/open). This capability is only available for enterprise-verified users. For real-name verification instructions, see [Real-name Verification](https://help.aliyun.com/document_detail/428525.html).'."\n" + ."\n" + .'><notice>Users who activated this capability on or after July 17, 2024 can call it directly without submitting an application.'."\n" + .'Users who activated this service before July 17, 2024, if they need to call it, can join the Alibaba Cloud Visual Intelligence Open Platform consultation group through DingTalk group (23109592) to contact us for whitelist addition.'."\n" + .'></notice>'."\n" + ."\n\n" + .'3. Create an AccessKey: Make sure you have [created an AccessKey](~~175144~~). If you are using a RAM user AccessKey, you need to grant the AliyunVIAPIFullAccess permission to the RAM user. For details, see [RAM Authorization](~~145025~~).'."\n" + .'4. Online debugging (optional): You can debug the capability online through [OpenAPI Explorer](https://next.api.aliyun.com/api/videoenhan/2020-03-20/MergeVideoModelFace?lang=JAVA), view complete sample code and SDK dependency information, or download the complete project.'."\n" + .'5. Prerequisites: First, add a video template through the [AddFaceVideoTemplate](~~468904~~) API to obtain a template ID (TemplateId), then use the template ID corresponding to the uploaded video and the face image to be merged to make a request.'."\n" + .'6. Development access steps: '."\n" + .'- Select the SDK language you want to use in the [SDK Overview](~~145033~~).'."\n" + .'- Find and install the SDK package under the AI category of Video Production (videoenhan) in the corresponding language SDK documentation.'."\n" + .'- Refer to the sample code provided in the documentation, make appropriate modifications, and then call the API.'."\n" + ."\n" + .'7. Sample code: For sample code in commonly used languages for this capability, see [Template Video Face Fusion Sample Code](~~602484~~).'."\n" + .'8. Direct client-side calls: The commonly used client-side calling methods for this capability include the following.'."\n" + .'- [Direct Web Frontend Call](~~467779~~)'."\n" + .'- [Direct Call in Mini Program Scenarios](~~467780~~)'."\n" + .'- [Direct Android Call](~~467781~~)'."\n" + .'- [Direct iOS Call](~~467782~~)'."\n" + ."\n" + .'## Input Limits'."\n" + .'- Image format: JPEG, JPG, PNG.'."\n" + .'- Image resolution: Greater than or equal to 128×128 pixels, less than or equal to 4000×4000 pixels.'."\n" + .'- Image size: No larger than 20 MB.'."\n" + .'- The URL cannot contain Chinese characters.'."\n" + ."\n" + .'## Input Parameter Description'."\n" + .'**MergeInfos** refers to the merge parameters, including the face information of the template video and the user face images to be merged (cannot be empty when **TemplateId** is for multiple faces).'."\n" + .'- **MergeInfos** is only used for multi-person video scenarios. Make sure that the **VideoScene** parameter was set to `multi` when the user added the template. The **TemplateFaceID** values passed in must correspond one-to-one with the **TemplateFaceID** values in the **FaceInfos** returned when the template was added.'."\n" + .'- If both **FaceImageURL** and **MergeInfos** are passed in, the one used depends on whether the **TemplateId** is for a single or multiple faces. The other input parameter is filtered out.'."\n" + ."\n" + .'## Image Quality Recommendations'."\n" + .'- Ensure that the face in the image is clear. The recommended face size in the image should be greater than 64×64 pixels, and the face area should not exceed 2/3 of the total image area.'."\n" + .'- It is recommended that the facial features in the image have complete contours without obvious occlusion. The face fusion algorithm supports faces tilted at certain angles, and better results can be achieved when the tilt angle does not exceed 30 degrees.'."\n" + .'- For multi-face video scenarios, the system will automatically identify different person IDs throughout the entire video. It is recommended that characters in the video avoid excessive head rotation and obvious occlusion; otherwise, the number of identified person IDs may be inaccurate.'."\n" + ."\n" + .'Recommended image examples:'."\n" + .''."\n" + .''."\n" + ."\n" + .'Not recommended image examples:'."\n" + .''."\n" + .''."\n" + ."\n" + .'## Calling Steps'."\n" + .'This capability is asynchronous and requires a two-step calling process.'."\n" + .'Step 1: Call the MergeVideoModelFace API to submit a task. After a successful request, you will receive a task ID.'."\n" + .'Step 2: Call the [GetAsyncJobResult](~~159423~~) API to query results. Query the task execution status and results based on the task ID. If the task is still being processed, wait for a while before querying again. When the same task has not been completed, it is recommended not to resubmit the task.'."\n" + ."\n" + .'## Billing Description'."\n" + .'For information about the billing method and pricing of template video face fusion, see [Billing Overview](~~202487~~).'."\n" + ."\n" + .'> The debugging interface below is a paid interface.', + 'responseParamsDescription' => '## Query Results'."\n" + .'This is an asynchronous API that does not return the actual request results. You need to call the GetAsyncJobResult API using the returned RequestId to obtain the actual request results. For details, see [GetAsyncJobResult](~~159423~~).'."\n" + ."\n" + .'## SDK Reference'."\n" + .'It is recommended to use the SDK to call the template video face fusion capability under the Alibaba Cloud Visual AI Video Production category. Multiple programming languages are supported. When calling, select the SDK package under the AI category of Video Production (videoenhan). File parameters can support local files and any URL through SDK calls. For details, see [SDK Overview](~~145033~~).'."\n" + ."\n" + .'## Sample Code'."\n" + .'For sample code in commonly used languages for this capability, see [Template Video Face Fusion Sample Code](~~602484~~).', + 'extraInfo' => '## Error Codes'."\n" + .'For error codes related to template video face fusion, see [Common Error Codes](~~159313~~).'."\n" + ."\n" + .'## Security Notice'."\n" + .'- Please ensure that the uploaded images or files comply with applicable laws and regulations.'."\n" + .'- Temporary files uploaded through the trial debugging have a validity period of 1 hour and will be automatically cleaned up and deleted by the system after 24 hours.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-10-10T06:49:10.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-09-14T08:47:49.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-10T01:59:08.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-06-09T02:22:45.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-02T02:35:23.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-10-17T02:05:12.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-04-09T08:28:59.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MergeVideoModelFace'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:MergeVideoModelFace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"334F180F-3B50-51CB-B4CB-9A86A542D3BC\\",\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\",\\n \\"Data\\": {\\n \\"VideoURL\\": \\"http://vibktprfx-prod-prod-aic-gd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-face-fusion/334F180F-3B50-51CB-B4CB-9A86A542D3BC-5716-20210906-074905.mp4?Expires=1630916420&OSSAccessKeyId=LTAI****************&Signature=OEtNqVYxXRwkyO4BrsYVJ8q5bx****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<MergeVideoModelFaceResponse>\\n <RequestId>334F180F-3B50-51CB-B4CB-9A86A542D3BC</RequestId>\\n <Message>该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。</Message>\\n</MergeVideoModelFaceResponse>","errorExample":""}]', ], 'QueryFaceVideoTemplate' => [ - 'summary' => '视频人脸融合模板查询', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'This topic describes the syntax and examples of the QueryFaceVideoTemplate operation for querying video face fusion templates.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1619,275 +2345,728 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '3bf2418c-7adf-4002-a9d6-2f7cf1889c0d', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The ID of the template to query. If TemplateId is not specified, the template list of the user is returned. If TemplateId is specified, only the corresponding result is returned.', 'type' => 'string', 'required' => false, 'example' => '3bf2418c-7adf-4002-a9d6-2f7cf1889c0d', 'title' => ''], ], [ 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'maximum' => '5000', - 'minimum' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The page number. Default value: 1. Valid values: 1 to 5000.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '5000', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'maximum' => '500', - 'minimum' => '1', - 'example' => '100', - 'default' => '100', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 100. Valid values: 1 to 500.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '500', 'minimum' => '1', 'example' => '100', 'default' => '100', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', 'description' => 'Schema of Response', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'A06E3D21-890D-500B-97DA-D8B99D2DDDC4', - 'title' => 'Id of the request', - 'type' => 'string', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A06E3D21-890D-500B-97DA-D8B99D2DDDC4'], 'Data' => [ - 'description' => '', + 'description' => 'The returned data.', + 'type' => 'object', 'properties' => [ - 'Total' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'Total' => ['description' => 'The total number of available templates under the current account.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], 'Elements' => [ - 'description' => '', + 'description' => 'The template list.', + 'type' => 'array', 'items' => [ 'description' => '1', + 'type' => 'object', 'properties' => [ - 'CreateTime' => [ - 'description' => '', - 'example' => '2021-09-06 15:17:19', - 'type' => 'string', - ], - 'UpdateTime' => [ - 'description' => '', - 'example' => '2021-09-06 15:18:15', - 'type' => 'string', - ], - 'UserId' => [ - 'description' => '', - 'example' => 'zhangsan', - 'type' => 'string', - ], - 'TemplateId' => [ - 'description' => '', - 'example' => '3bf2418c-7adf-4002-a9d6-2f7cf1889c0d', - 'type' => 'string', - ], - 'TemplateURL' => [ - 'description' => '', - 'example' => 'http://vibktprfx-prod-prod-aic-gd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/image-face-fusion/OriginUrl/user/2021-09-06/e4d6ecf6-8dc8-4dac-acb5-56a737ccbc06?Expires=1630914551&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=kBcLm66y7%2FZ3eIMgwXJg1zNP7k****', - 'type' => 'string', - ], + 'CreateTime' => ['description' => 'The time when the template was created.', 'type' => 'string', 'example' => '2021-09-06 15:17:19', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the template was updated.', 'type' => 'string', 'example' => '2021-09-06 15:18:15', 'title' => ''], + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => 'zhangsan', 'title' => ''], + 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '3bf2418c-7adf-4002-a9d6-2f7cf1889c0d', 'title' => ''], + 'TemplateURL' => ['description' => 'The URL of the video face template that was specified when the template was added.'."\n" + .'> This URL is a temporary address that is valid for 30 minutes. After it expires, the URL becomes inaccessible. To save the file for a longer period or permanently, access the URL within 30 minutes and download the file to your own OSS bucket or other storage.', 'type' => 'string', 'example' => 'http://vibktprfx-prod-prod-aic-gd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/image-face-fusion/OriginUrl/user/2021-09-06/e4d6ecf6-8dc8-4dac-acb5-56a737ccbc06?Expires=1630914551&OSSAccessKeyId=LTAI****************&Signature=kBcLm66y7%2FZ3eIMgwXJg1zNP7k****', 'title' => ''], 'FaceInfos' => [ + 'description' => 'The face ID and position information for each face when the input video contains multiple faces.'."\n" + ."\n" + .'> FaceInfos is returned only when the multi-person video face swap scenario is selected during template creation (the **VideoScene** parameter must be set to `multi`).', 'type' => 'array', 'items' => [ + 'description' => 'The face ID and position information for each face when the input video contains multiple faces.'."\n" + ."\n" + .'> FaceInfos is returned only when the multi-person video face swap scenario is selected during template creation (the **VideoScene** parameter must be set to `multi`).', 'type' => 'object', 'properties' => [ - 'TemplateFaceID' => [ - 'type' => 'string', - ], - 'TemplateFaceURL' => [ - 'type' => 'string', - ], + 'TemplateFaceID' => ['description' => 'The sub-template ID corresponding to the face.', 'type' => 'string', 'example' => '7d1a2498-0f9a-42d8-bae8-c7e478188106_0', 'title' => ''], + 'TemplateFaceURL' => ['description' => 'The face image corresponding to the sub-template ID of the face.', 'type' => 'string', 'example' => 'http://vibktprfx-prod-prod-aic-gd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-face-fusion/template/xhtest_7d1a2498-0f9a-42d8-bae8-c7e478188106/xhtest_7d1a2498-0f9a-42d8-bae8-c7e478188106_0.png?Expires=1686040781&OSSAccessKeyId=LTAI****************&Signature=WVYTf%2F3knRuUPXSVGVz%2FZi3Miu****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], - 'type' => 'array', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], ], - 'title' => 'Schema of Response', - 'type' => 'object', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A06E3D21-890D-500B-97DA-D8B99D2DDDC4\\",\\n \\"Data\\": {\\n \\"Total\\": 20,\\n \\"Elements\\": [\\n {\\n \\"CreateTime\\": \\"2021-09-06 15:17:19\\",\\n \\"UpdateTime\\": \\"2021-09-06 15:18:15\\",\\n \\"UserId\\": \\"zhangsan\\",\\n \\"TemplateId\\": \\"3bf2418c-7adf-4002-a9d6-2f7cf1889c0d\\",\\n \\"TemplateURL\\": \\"http://vibktprfx-prod-prod-aic-gd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/image-face-fusion/OriginUrl/user/2021-09-06/e4d6ecf6-8dc8-4dac-acb5-56a737ccbc06?Expires=1630914551&OSSAccessKeyId=LTAI****************&Signature=kBcLm66y7%2FZ3eIMgwXJg1zNP7k****\\",\\n \\"FaceInfos\\": [\\n {\\n \\"TemplateFaceID\\": \\"7d1a2498-0f9a-42d8-bae8-c7e478188106_0\\",\\n \\"TemplateFaceURL\\": \\"http://vibktprfx-prod-prod-aic-gd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-face-fusion/template/xhtest_7d1a2498-0f9a-42d8-bae8-c7e478188106/xhtest_7d1a2498-0f9a-42d8-bae8-c7e478188106_0.png?Expires=1686040781&OSSAccessKeyId=LTAI****************&Signature=WVYTf%2F3knRuUPXSVGVz%2FZi3Miu****\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query video face fusion templates', + 'description' => '## Feature description'."\n" + .'The video face fusion template query feature allows you to query video face templates that you have added.'."\n" + ."\n" + .'> - You can go to [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) for online assistance.'."\n" + .'- To access Alibaba Cloud Vision Intelligence Open Platform visual AI APIs, use the interfaces, or consult on issues, join the Alibaba Cloud Vision Intelligence Open Platform consultation DingTalk group (23109592) to contact us.'."\n" + ."\n" + .'## Integration guide'."\n" + .'1. Register an Alibaba Cloud account: Go to the [Alibaba Cloud official website](https://www.aliyun.com), click **Register Now** in the upper-right corner, and follow the instructions to complete account registration.'."\n" + .'2. Activate the service: Make sure you have activated the [Video Production service](https://vision.aliyun.com/videoenhan). If you have not activated the service, [activate it now](https://common-buy.aliyun.com/?commodityCode=viapi_videoenhan_public_cn#/open).'."\n" + .'><notice>'."\n" + .'This feature is available only to users who have completed verify your identity - Enterprise account. For more information about real-name verification, see [Real-name verification](https://help.aliyun.com/document_detail/428525.html).'."\n" + .'></notice>'."\n" + ."\n" + .'3. Create an AccessKey: Make sure you have [created an AccessKey](~~175144~~). If you are using a RAM user AccessKey, grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see [RAM authorization](~~145025~~).'."\n" + .'4. Online debugging (optional): You can use [OpenAPI Explorer](https://next.api.aliyun.com/api/videoenhan/2020-03-20/QueryFaceVideoTemplate?lang=JAVA) to debug the feature online, view complete sample code and SDK dependency information, or download the complete project.'."\n" + .'5. Prerequisites: A TemplateId has been created by using the [AddFaceVideoTemplate](~~468904~~) operation to increase a video face fusion template.'."\n" + ."\n" + .'6. Development integration steps: '."\n" + .'- Select the SDK language you want to use from the [SDK overview](~~145033~~).'."\n" + .'- Find and install the SDK package for the Video Production (videoenhan) category in the corresponding SDK documentation.'."\n" + .'- Modify the sample code provided in the References as needed and invoke the operation.'."\n" + ."\n" + .'7. Sample code: For sample code in commonly used languages, see [QueryFaceVideoTemplate sample code](~~602562~~).'."\n" + ."\n" + .'8. Direct client calls: Common client call methods for this feature include the following.'."\n" + .'- [Direct call from web frontend](~~467779~~)'."\n" + .'- [Direct call from mini programs](~~467780~~)'."\n" + .'- [Direct call from Android](~~467781~~)'."\n" + .'- [Direct call from iOS](~~467782~~).'."\n" + ."\n" + .'## Billing description'."\n" + .'The video face fusion template query feature is free of charge.', + 'responseParamsDescription' => '## SDK reference'."\n" + .'To use the video face fusion template query feature under the Video Production category of Alibaba Cloud Vision AI, use the SDK. Multiple programming languages are supported. When calling the operation, select the SDK package for the Video Production (videoenhan) category. File parameters support local files and arbitrary URLs through the SDK. For more information, see [SDK overview](~~145033~~).'."\n" + ."\n" + .'## Sample code'."\n" + .'For sample code in commonly used languages, see [QueryFaceVideoTemplate sample code](~~602562~~).', + 'extraInfo' => '## Error codes'."\n" + .'For error codes of the video face fusion template query feature, see [Common error codes](~~159313~~).'."\n" + ."\n" + .'## Security notice'."\n" + .'- Make sure that the uploaded images or files comply with applicable laws and regulations.'."\n" + .'- Temporary files uploaded through the debugging console are valid for 1 hour and are automatically deleted by the system after 24 hours.', + 'changeSet' => [ + ['createdAt' => '2024-03-13T06:44:46.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-06-09T02:22:45.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-12-02T02:35:23.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-27T09:41:06.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-04-09T08:28:59.000Z', 'description' => 'OpenAPI offline'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:QueryFaceVideoTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A06E3D21-890D-500B-97DA-D8B99D2DDDC4\\",\\n \\"Data\\": {\\n \\"Total\\": 20,\\n \\"Elements\\": [\\n {\\n \\"CreateTime\\": \\"2021-09-06 15:17:19\\",\\n \\"UpdateTime\\": \\"2021-09-06 15:18:15\\",\\n \\"UserId\\": \\"zhangsan\\",\\n \\"TemplateId\\": \\"3bf2418c-7adf-4002-a9d6-2f7cf1889c0d\\",\\n \\"TemplateURL\\": \\"http://vibktprfx-prod-prod-aic-gd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/image-face-fusion/OriginUrl/user/2021-09-06/e4d6ecf6-8dc8-4dac-acb5-56a737ccbc06?Expires=1630914551&OSSAccessKeyId=LTAI****************&Signature=kBcLm66y7%2FZ3eIMgwXJg1zNP7k****\\",\\n \\"FaceInfos\\": [\\n {\\n \\"TemplateFaceID\\": \\"7d1a2498-0f9a-42d8-bae8-c7e478188106_0\\",\\n \\"TemplateFaceURL\\": \\"http://vibktprfx-prod-prod-aic-gd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-face-fusion/template/xhtest_7d1a2498-0f9a-42d8-bae8-c7e478188106/xhtest_7d1a2498-0f9a-42d8-bae8-c7e478188106_0.png?Expires=1686040781&OSSAccessKeyId=LTAI****************&Signature=WVYTf%2F3knRuUPXSVGVz%2FZi3Miu****\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryFaceVideoTemplateResponse>\\n <RequestId>A06E3D21-890D-500B-97DA-D8B99D2DDDC4</RequestId>\\n <Data>\\n <Total>20</Total>\\n <Elements>\\n <CreateTime>2021-09-06 15:17:19</CreateTime>\\n <UpdateTime>2021-09-06 15:18:15</UpdateTime>\\n <UserId>zhangsan</UserId>\\n <TemplateId>3bf2418c-7adf-4002-a9d6-2f7cf1889c0d</TemplateId>\\n <TemplateURL>http://vibktprfx-prod-prod-aic-gd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/image-face-fusion/OriginUrl/user/2021-09-06/e4d6ecf6-8dc8-4dac-acb5-56a737ccbc06?Expires=1630914551&OSSAccessKeyId=LTAI****************&Signature=kBcLm66y7%2FZ3eIMgwXJg1zNP7k****</TemplateURL>\\n <FaceInfos>\\n <TemplateFaceID>7d1a2498-0f9a-42d8-bae8-c7e478188106_0</TemplateFaceID>\\n <TemplateFaceURL>http://vibktprfx-prod-prod-aic-gd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-face-fusion/template/xhtest_7d1a2498-0f9a-42d8-bae8-c7e478188106/xhtest_7d1a2498-0f9a-42d8-bae8-c7e478188106_0.png?Expires=1686040781&OSSAccessKeyId=LTAI****************&Signature=WVYTf%2F3knRuUPXSVGVz%2FZi3Miu****</TemplateFaceURL>\\n </FaceInfos>\\n </Elements>\\n </Data>\\n</QueryFaceVideoTemplateResponse>","errorExample":""}]', - ], - 'GenerateHumanAnimeStyleVideo' => [ - 'summary' => '视频人像卡通化', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceVideoTemplate'], + ], ], + ], + 'SuperResolveVideo' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'VideoUrl', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'https://viapi-test.oss-cn-shanghai.aliyuncs.com/test/xxx/eas/EvaluateVideoQuality/123.mp4', - 'isFileTransferUrl' => true, - ], + 'schema' => ['description' => 'The URL of the input video. Use an OSS URL in the China (Shanghai) region. For files stored locally or in other regions, see [File URL processing](~~155645~~).', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoenhan/SuperResolveVideo/SuperResolveVideo2.mp4', 'title' => ''], ], [ - 'name' => 'CartoonStyle', + 'name' => 'BitRate', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'anime', - ], + 'schema' => ['description' => 'The encoding rate of the output video. Unit: Mbit/s. Default value: 10. Valid values: 1 to 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'd21a2afa-4d52-4bca-803b-e65028146603', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '186AC396-0EEC-46F1-AAA1-BF3585227427', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The returned data. After the asynchronous node is executed, invoke the [GetAsyncJobResult](~~607824~~) operation and deserialize the Result field from JSON to obtain this data.', 'type' => 'object', 'properties' => [ - 'VideoUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://vibktprfx-prod-prod-xstream-cn-shanghai.oss-cn-shanghai.aliyuncs.com/xstream-framework/upload_result_video_2023-02-10_09.45.55.mp4?Expires=1675995564&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSR****&Signature=aIXTeM4IU4nARjy3SNA3YGhhqj****', - ], + 'VideoUrl' => ['description' => 'The URL of the output processed video.'."\n" + .'> This URL is a temporary URL that is valid for 30 minutes. After the URL expires, it can no longer be accessed. To store the file for a longer period or permanently, access the URL within 30 minutes and download the file to your own OSS bucket or other storage.', 'type' => 'string', 'example' => 'http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-super-resolution/2020-03-20-12/12%3A11-UlLVELFzIy5EAyEh.mp4?Expires=1584708132&OSSAccessKeyId=LTAI****************&Signature=0V8yKrCVybC4KIPtRuGKJDJaQT****', 'title' => ''], ], - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', 'example' => '', ], + 'Message' => ['description' => 'The message returned after the asynchronous node is committed.', 'type' => 'string', 'example' => '该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"186AC396-0EEC-46F1-AAA1-BF3585227427\\",\\n \\"Data\\": {\\n \\"VideoUrl\\": \\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-super-resolution/2020-03-20-12/12%3A11-UlLVELFzIy5EAyEh.mp4?Expires=1584708132&OSSAccessKeyId=LTAI****************&Signature=0V8yKrCVybC4KIPtRuGKJDJaQT****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","type":"json"}]', + 'title' => 'Video ultra HD', + 'summary' => 'Performs video super-resolution on a video.', + 'description' => '## Description'."\n" + .'The Video Ultra HD (super-resolution) feature upscales an input video to 2× its original size and enhances the output video quality based on detail inference. The output video uses H.264 encoding and is in MP4 format.'."\n" + ."\n" + .'> - You can visit [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) for online assistance.'."\n" + .'- You can try this feature for free on the Vision Intelligence Open Platform. Click [Try Now](https://vision.aliyun.com/experience/detail?&tagName=videoenhan&children=SuperResolveVideo) to experience this feature or purchase it online.'."\n" + .'- For questions about API integration or usage of Alibaba Cloud Vision Intelligence Open Platform, join the DingTalk group (23109592) to contact us.'."\n" + ."\n" + .'## Common scenarios'."\n" + ."\n" + .'- Old video restoration: The deep learning-based video super-resolution algorithm can enhance and convert low-resolution videos into high-resolution videos.'."\n" + .'- Online video playback: Transmit low-resolution videos under low-bandwidth conditions, and then use the video super-resolution algorithm to revert the videos to high resolution at the playback depth.'."\n" + ."\n" + .'## Features'."\n" + ."\n" + .'- Based on deep learning algorithms, the inferred video details are more realistic.'."\n" + .'- Outputs at 2× the original video size for a greater resolution enhancement.'."\n" + ."\n" + .'## Getting started'."\n" + .'1. Create an Alibaba Cloud account: Go to the [Alibaba Cloud official website](https://www.aliyun.com) and click **Sign Up** in the upper-right corner. Follow the on-screen instructions to complete the account registration.'."\n" + .'2. Activate the feature: Make sure you have activated [Video Production](https://vision.aliyun.com/videoenhan). If you have not activated the service, [activate it now](https://common-buy.aliyun.com/?commodityCode=viapi_videoenhan_public_cn#/open).'."\n" + .'3. Create an AccessKey: Make sure you have [created an AccessKey](~~175144~~). If you are using a RAM user AccessKey, grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see [RAM authorization](~~145025~~).'."\n" + .'4. Debug online (optional): You can use [OpenAPI Explorer](https://next.api.aliyun.com/api/videoenhan/2020-03-20/SuperResolveVideo?lang=JAVA&sdkStyle=dara¶ms=%7B%22VideoUrl%22%3A%22http%3A%2F%2Fviapi-test.oss-cn-shanghai.aliyuncs.com%2Fviapi-3.0domepic%2Fvideoenhan%2FSuperResolveVideo%2FSuperResolveVideo1.mp4%22%2C%22BitRate%22%3A5%7D&tab=DEMO) to debug this feature online, view complete sample code and SDK dependency information, or download the complete project.'."\n" + .'5. Development steps:'."\n" + .'- Select the SDK language you want to use from the [Overview](~~145033~~).'."\n" + .'- Find the SDK package for the video production (videoenhan) category in the corresponding SDK documentation and install it.'."\n" + .'- Modify the sample code provided in the references and invoke it as needed.'."\n" + ."\n" + .'6. Sample code: For sample code in common programming languages for this feature, see [Video super-resolution sample code](~~602945~~). For sample code for querying asynchronous node results in common programming languages, see [Query asynchronous node result sample code](~~607974~~).'."\n" + ."\n" + .'7. Direct invocation from clients: Common client invocation methods for this feature include the following.'."\n" + .'- [Direct invocation from a frontend web application](~~467779~~)'."\n" + .'- [Direct invocation from a mini program](~~467780~~)'."\n" + .'- [Direct invocation from Android](~~467781~~)'."\n" + .'- [Direct invocation from iOS](~~467782~~)'."\n" + ."\n" + .'## Input limits'."\n" + ."\n" + .'- Video format: MP4, AVI, MKV, MOV, FLV, TS, MPG, MXF.'."\n" + .'- Video size: up to 1 GB.'."\n" + .'- Video resolution: greater than 360 × 360 pixels and less than 1920 × 1080 pixels.'."\n" + .'- The URL cannot contain Chinese characters.'."\n" + ."\n" + .'## Billing description'."\n" + .'For information about the billable methods and pricing of video super-resolution, see [Billing overview](~~202487~~).'."\n" + ."\n" + .'> The following debug operation is a paid operation.'."\n" + ."\n" + .'## Invocation steps'."\n" + .'This feature is an asynchronous feature that requires two steps to invoke.'."\n" + .'Step 1: Call the SuperResolveVideo operation to commit a node. If the request is successful, a node ID is returned.'."\n" + .'Step 2: Call the [GetAsyncJobResult](~~607824~~) operation to query the node result. Use the node ID to query the execute status and result of the node. If the node is still being processed, wait a moment and then query again. Do not commit duplicate nodes while the same node is still being processed.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '## Query results'."\n" + .'This operation is an asynchronous operation and does not return actual results. You must invoke the GetAsyncJobResult operation by using the returned RequestId to obtain the actual results. For more information, see [GetAsyncJobResult](~~607824~~).'."\n" + ."\n" + .'## SDK reference'."\n" + .'Use an SDK to invoke the video super-resolution feature under the visual AI video production category. The SDK supports multiple programming languages. When invoking the SDK, select the SDK package for the video production (videoenhan) category. File parameters support local files and URLs of any type when invoked through the SDK. For more information, see [Overview](~~145033~~).'."\n" + ."\n" + .'## Sample code'."\n" + .'For sample code in common programming languages for this feature, see [Video super-resolution sample code](~~602945~~). For sample code for querying asynchronous node results in common programming languages, see [Query asynchronous node result sample code](~~607974~~).', + 'extraInfo' => '## Error codes'."\n" + .'For more information, see [Common error codes](~~159313~~).'."\n" + ."\n" + .'## Security notice'."\n" + .'- Make sure that the uploaded images or files comply with applicable laws and regulations.'."\n" + .'- Temporary files uploaded through the debug feature are valid for 1 hour and are automatically deleted by the system after 24 hours.', + 'changeSet' => [ + ['createdAt' => '2022-10-17T02:05:11.000Z', 'description' => 'Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:SuperResolveVideo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SuperResolveVideo'], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"d21a2afa-4d52-4bca-803b-e65028146603\\",\\n \\"Data\\": {\\n \\"VideoUrl\\": \\"http://vibktprfx-prod-prod-xstream-cn-shanghai.oss-cn-shanghai.aliyuncs.com/xstream-framework/upload_result_video_2023-02-10_09.45.55.mp4?Expires=1675995564&OSSAccessKeyId=LTAI****************&Signature=aIXTeM4IU4nARjy3SNA3YGhhqj****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","errorExample":""},{"type":"xml","example":"<GenerateHumanAnimeStyleVideoResponse>\\n <RequestId>d21a2afa-4d52-4bca-803b-e65028146603</RequestId>\\n <Message>该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。</Message>\\n</GenerateHumanAnimeStyleVideoResponse>","errorExample":""}]', ], - 'EnhancePortraitVideo' => [ - 'summary' => '视频人像增强', - 'methods' => [ - 'post', + ], + 'endpoints' => [ + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'videoenhan.cn-shanghai.aliyuncs.com', 'endpoint' => 'videoenhan.cn-shanghai.aliyuncs.com', 'vpc' => 'videoenhan-vpc.cn-shanghai.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'AuthFailed', 'message' => 'An error occurred while performing authorization. Please check your RAM configuration.', 'http_code' => 403, 'description' => 'An error occurred while performing authorization. Please check your RAM configuration.'], + ['code' => 'ClientError.IllegalArgument', 'message' => '请检查参数，如参数值所代表的数据库是否存在', 'http_code' => 400, 'description' => ''], + ['code' => 'EntityNotExist.Role', 'message' => '没有Ram权限，请联系主账号给你添加AliyunVIAPIFullAccess权限，操作流程可参考https://help.aliyun.com/document_detail/145025.htm', 'http_code' => 400, 'description' => ''], + ['code' => 'IllegalUrlParameter', 'message' => 'Url不合法，请检查url能否正常打开', 'http_code' => 400, 'description' => ''], + ['code' => 'InternalError', 'message' => 'An error occurred to the algorithm service.', 'http_code' => 500, 'description' => ''], + ['code' => 'InternalError.Algo', 'message' => 'An algorithm error occurred.', 'http_code' => 500, 'description' => ''], + ['code' => 'InternalError.Busy', 'message' => 'Server busy.', 'http_code' => 500, 'description' => ''], + ['code' => 'InternalError.Decode', 'message' => 'Failed to decode the image.', 'http_code' => 500, 'description' => ''], + ['code' => 'InternalError.Env', 'message' => 'Failed to initilize the environment.', 'http_code' => 500, 'description' => ''], + ['code' => 'InternalError.Model', 'message' => 'Failed to load the model.', 'http_code' => 500, 'description' => ''], + ['code' => 'InternalError.Process', 'message' => 'An error occurred during inference.', 'http_code' => 500, 'description' => ''], + ['code' => 'InternalError.Remote', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 500, 'description' => ''], + ['code' => 'InternalError.Server', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 500, 'description' => ''], + ['code' => 'InternalError.Timeout', 'message' => '算法服务报错，请稍后重试', 'http_code' => 500, 'description' => ''], + ['code' => 'InternalServerError', 'message' => 'A server error occurred while processing your request.', 'http_code' => 500, 'description' => ''], + ['code' => 'InvalidAccessKeyId.Inactive', 'message' => 'AccessKeyId非法，请检查AccessKeyId是否被禁用，或者AccessKeyId和AccessKeySecret是否填写正确。', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAccessKeyId.NotFound', 'message' => 'AccessKeyId未找到，请检查AccessKeyId和AccessKeySecret是否填写正确。', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAccessKeySecret', 'message' => 'AccessKeyId或AccessKeySecret填写错误，请检查AccessKeyId和AccessKeySecret是否填写正确。', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAction.NotFound', 'message' => '能力未找到，请检查类目与能力是否匹配，检查访问域名与能力是否匹配，关于访问域名可参考：https://help.aliyun.com/document_detail/143103.htm。SDK接入请参考：https://help.aliyun.com/document_detail/145033.html，选择合适编程语言根据实例代码作相关修改进行接入。', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidApi.ForbiddenInvoke', 'message' => '调用受限，请检查您调用的能力是否为受限能力，受限能力需要在控制台https://vision.console.aliyun.com/找到相应能力申请经过审批之后才能调用。如非上述情况，请检查账号是否欠费', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidApi.NotPurchase', 'message' => '产品未开通，请开通产品：https://common-buy.aliyun.com/?commodityCode=viapi_videoenhan_public_cn#/open', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidApi.OutOfService', 'message' => '产品未开通，请开通产品：https://common-buy.aliyun.com/?commodityCode=viapi_videoenhan_public_cn#/open', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFile.Category', 'message' => 'The file content category does not meet requirements.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFile.Content', 'message' => 'The content format of the image or video is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFile.Decode', 'message' => 'Failed to decode the file.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFile.Download', 'message' => 'Failed to download the file.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFile.Region', 'message' => 'The URL format of the file is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFile.Resolution', 'message' => 'The resolution of the image or video is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFile.Type', 'message' => 'The file type of the image or video is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFile.Unsafe', 'message' => 'Risky file URL.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFile.URL', 'message' => 'The URL format of the file is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImage.Content', 'message' => '请参考算法文档检查图片内容，更换包含符合算法要求的', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImage.Decode', 'message' => '请检查图片是否能够正常打开', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImage.Download', 'message' => '图片无法下载，请检查链接是否可访问和本地网络情况 - 非上海OSS图片链接请参考：https://help.aliyun.com/document_detail/155645.html', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImage.NotFoundFace', 'message' => '图像中没找到人脸，请检查您的图像中是否包含人脸或人脸太小', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImage.REGION', 'message' => '图片链接地域不对，非上海OSS图片链接请参考：https://help.aliyun.com/document_detail/155645.html', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImage.Resolution', 'message' => '文件分辨率超出限制，请检查文件分辨率和内容，修改文件分辨率后重试', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImage.Timeout', 'message' => '图片下载超时，请检查链接是否可访问和本地网络情况 - 非上海OSS图片链接请参考：https://help.aliyun.com/document_detail/155645.html。请检查OSS链接是否过期等。', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImage.Type', 'message' => '图片类型错误，请检查图片类型 - 请参考算法API文档，使用算法支持的图片类型', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImage.URL', 'message' => '图片链接非法，请检查图片链接是否可访问 - 非上海OSS图片链接请参考：https://help.aliyun.com/document_detail/155645.html', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImageType', 'message' => 'Invalid image type.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidParameter', 'message' => 'Invalid parameter value.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidParameter.BadRequest', 'message' => 'The request parameter or the data has an error.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidParameter.Format', 'message' => 'The entry format is incorrect.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidParameter.NotFound', 'message' => '参数错误，请根据算法API文档和报错Message检查参数值。是否参数值前后多了空格或者其他特殊字符等。', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidParameter.TooLarge', 'message' => '参数错误，文件大小超出限制，请参考算法API文档调整文件大小', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidRamRole', 'message' => '没有Ram权限，请联系主账号给你添加AliyunVIAPIFullAccess权限，操作流程可参考https://help.aliyun.com/document_detail/145025.htm', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidResult', 'message' => '参数错误，请参考文档检查参数值，检查文件内容。请检查是否图片内容不完整或者太模糊等。', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidSide', 'message' => 'Specified parameter Side is not valid. 请参考文档填写正确的Side参数', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidTimeStamp.Expired', 'message' => '时间戳过期，请更新时间戳', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidVersion', 'message' => 'Specified parameter Version is not valid', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingAccessKeyId', 'message' => 'AccessKeyId未填写，请检查AccessKeyId和AccessKeySecret是否填写正确。', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingFileURL', 'message' => 'FileURL is required for this operation.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingImageURL', 'message' => 'ImageURL is required for this operation.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingLimit', 'message' => 'Limit is required for this operation', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingParameter', 'message' => 'A required parameter is not specified.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingTasks', 'message' => 'Tasks is required for this operation.', 'http_code' => 400, 'description' => ''], + ['code' => 'ParameterError', 'message' => 'The parameter is invalid. Please check again.', 'http_code' => 400, 'description' => 'The parameter is invalid. Please check again.'], + ['code' => 'ServiceUnavailable', 'message' => 'The service is unavailable.', 'http_code' => 503, 'description' => 'The service is unavailable.'], + ['code' => 'SignatureDoesNotMatch', 'message' => '签名不正确，请重新计算签名。关于签名可参考文档：https://help.aliyun.com/document_detail/144904.html', 'http_code' => 400, 'description' => ''], + ['code' => 'SignatureNonceUsed', 'message' => '签名已经被使用过，请重新计算签名。关于签名可参考文档：https://help.aliyun.com/document_detail/144904.html', 'http_code' => 400, 'description' => ''], + ['code' => 'Throttling', 'message' => 'The request was denied due to QPS limits.', 'http_code' => 400, 'description' => ''], + ['code' => 'Throttling.User', 'message' => 'The request was denied due to QPS limits.', 'http_code' => 400, 'description' => ''], + ['code' => 'Timeout', 'message' => 'The request has timed out.', 'http_code' => 408, 'description' => 'The request has timed out.'], + ['code' => 'Unauthorized', 'message' => '没有Ram权限，请联系主账号给你添加AliyunVIAPIFullAccess权限，操作流程可参考https://help.aliyun.com/document_detail/145025.htm', 'http_code' => 400, 'description' => ''], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'AddFaceVideoTemplate'], + ], + 'createdAt' => '2024-05-30T09:21:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'QueryFaceVideoTemplate'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2024-03-13T06:44:54.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'MergeVideoFace'], + ['description' => 'Request parameters changed', 'api' => 'MergeVideoModelFace'], ], - 'security' => [ - [ - 'AK' => [], + 'createdAt' => '2023-10-10T06:49:17.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'MergeVideoModelFace'], + ], + 'createdAt' => '2023-09-14T08:47:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'MergeVideoFace'], + ], + 'createdAt' => '2023-08-31T07:56:49.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'MergeVideoFace'], + ['description' => 'Request parameters changed', 'api' => 'MergeVideoModelFace'], + ], + 'createdAt' => '2023-08-10T01:59:14.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'AddFaceVideoTemplate'], + ['description' => 'Request parameters changed', 'api' => 'MergeVideoModelFace'], + ['description' => 'Response parameters changed', 'api' => 'QueryFaceVideoTemplate'], + ], + 'createdAt' => '2023-06-09T02:22:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'MergeVideoFace'], + ], + 'createdAt' => '2022-12-16T05:19:16.000Z', + 'description' => '修改入参为不可见', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'AddFaceVideoTemplate'], + ['description' => 'Request parameters changed', 'api' => 'DeleteFaceVideoTemplate'], + ['description' => 'Request parameters changed', 'api' => 'MergeVideoModelFace'], + ['description' => 'Request parameters changed', 'api' => 'QueryFaceVideoTemplate'], + ], + 'createdAt' => '2022-12-02T02:35:38.000Z', + 'description' => '设置userId为不可见', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'MergeVideoFace'], + ], + 'createdAt' => '2022-11-30T06:49:39.000Z', + 'description' => '更改入参PostURL为非必选', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GenerateVideo'], + ], + 'createdAt' => '2022-11-10T08:56:57.000Z', + 'description' => 'url支持本地多文件上传', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'AbstractEcommerceVideo'], + ['description' => 'Response parameters changed', 'api' => 'AbstractFilmVideo'], + ['description' => 'Response parameters changed', 'api' => 'AddFaceVideoTemplate'], + ['description' => 'Response parameters changed', 'api' => 'AdjustVideoColor'], + ['description' => 'Response parameters changed', 'api' => 'ChangeVideoSize'], + ['description' => 'Response parameters changed', 'api' => 'ConvertHdrVideo'], + ['description' => 'Response parameters changed', 'api' => 'EnhanceVideoQuality'], + ['description' => 'Response parameters changed', 'api' => 'EraseVideoLogo'], + ['description' => 'Response parameters changed', 'api' => 'EraseVideoSubtitles'], + ['description' => 'Response parameters changed', 'api' => 'GenerateVideo'], + ], + 'createdAt' => '2022-10-17T02:05:25.000Z', + 'description' => '修改异步任务Message为可见', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'MergeVideoFace'], + ], + 'createdAt' => '2022-09-29T07:59:33.000Z', + 'description' => '多url参数支持本地文件上传', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'QueryFaceVideoTemplate'], + ], + 'createdAt' => '2022-09-27T09:41:12.000Z', + 'description' => '修改obj为可见', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'AddFaceVideoTemplate'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteFaceVideoTemplate'], + ['description' => 'OpenAPI offline', 'api' => 'MergeVideoModelFace'], + ['description' => 'OpenAPI offline', 'api' => 'QueryFaceVideoTemplate'], + ], + 'createdAt' => '2021-04-12T02:24:15.000Z', + 'description' => '第一次发布', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnhanceVideoQuality'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateHumanAnimeStyleVideo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InterpolateVideoFrame'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EraseVideoLogo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AdjustVideoColor'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeVideoSize'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SuperResolveVideo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAsyncJobResult'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddFaceVideoTemplate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateVideo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceVideoTemplate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFaceVideoTemplate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnhancePortraitVideo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EraseVideoSubtitles'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MergeVideoModelFace'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MergeVideoFace'], + ], + ], + 'ram' => [ + 'productCode' => 'VisualIntelligenceAPI', + 'productName' => 'Visual Intelligence API', + 'ramCodes' => ['viapi-imageseg', 'viapi-imageaudit', 'viapi-ocr', 'viapi-objectdet', 'viapi-imageenhan', 'viapi-videorecog', 'viapi-imageprocess', 'viapi', 'viapi-ekyc', 'viapi-imgsearch', 'viapi-goodstech', 'viapi-facebody', 'viapi-threedvision', 'viapi-videoenhan', 'viapi-imagerecog', 'viapi-videoseg', 'viapi-regen', 'viapi-aigen'], + 'ramLevel' => 'SERVICE', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'AddFaceVideoTemplate', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:AddFaceVideoTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'MergeVideoFace', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:MergeVideoFace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'EnhancePortraitVideo', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:EnhancePortraitVideo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SuperResolveVideo', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:SuperResolveVideo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GenerateHumanAnimeStyleVideo', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:GenerateHumanAnimeStyleVideo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'InterpolateVideoFrame', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:InterpolateVideoFrame', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AdjustVideoColor', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:AdjustVideoColor', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'EnhanceVideoQuality', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:EnhanceVideoQuality', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteFaceVideoTemplate', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:DeleteFaceVideoTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'VideoUrl', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'https://viapi-test.oss-cn-shanghai.aliyuncs.com/test-team/xxx/shang/video/SD%289516100%29.mp4', - 'isFileTransferUrl' => true, + [ + 'apiName' => 'GetAsyncJobResult', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:GetAsyncJobResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'd21a2afa-4d52-4bca-803b-e65028146603', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'VideoUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://vibktprfx-prod-prod-xstream-cn-shanghai.oss-cn-shanghai.aliyuncs.com/xstream-framework/upload_result_video_2023-02-10_09.45.55.mp4?Expires=1675995564&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=aIXTeM4IU4nARjy3SNA3YGhhqj****', - ], - ], - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], + [ + 'apiName' => 'EraseVideoLogo', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:EraseVideoLogo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'QueryFaceVideoTemplate', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:QueryFaceVideoTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'MergeVideoModelFace', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:MergeVideoModelFace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ChangeVideoSize', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:ChangeVideoSize', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'EraseVideoSubtitles', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:EraseVideoSubtitles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GenerateVideo', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videoenhan:GenerateVideo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"d21a2afa-4d52-4bca-803b-e65028146603\\",\\n \\"Data\\": {\\n \\"VideoUrl\\": \\"http://vibktprfx-prod-prod-xstream-cn-shanghai.oss-cn-shanghai.aliyuncs.com/xstream-framework/upload_result_video_2023-02-10_09.45.55.mp4?Expires=1675995564&OSSAccessKeyId=LTAI****************&Signature=aIXTeM4IU4nARjy3SNA3YGhhqj****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","errorExample":""},{"type":"xml","example":"<EnhancePortraitVideoResponse>\\n <RequestId>d21a2afa-4d52-4bca-803b-e65028146603</RequestId>\\n <Message>该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。</Message>\\n</EnhancePortraitVideoResponse>","errorExample":""}]', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'videoenhan.cn-shanghai.aliyuncs.com', ], + 'resourceTypes' => [], ], ]; |