diff options
Diffstat (limited to 'data/en_us/videorecog/2020-03-20')
| -rw-r--r-- | data/en_us/videorecog/2020-03-20/api-docs.php | 1900 |
1 files changed, 1082 insertions, 818 deletions
diff --git a/data/en_us/videorecog/2020-03-20/api-docs.php b/data/en_us/videorecog/2020-03-20/api-docs.php index ff18cd2..f6af63a 100644 --- a/data/en_us/videorecog/2020-03-20/api-docs.php +++ b/data/en_us/videorecog/2020-03-20/api-docs.php @@ -1,38 +1,25 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'videorecog', - 'version' => '2020-03-20', - ], + 'info' => ['style' => 'RPC', 'product' => 'videorecog', 'version' => '2020-03-20'], 'directories' => [ [ - 'id' => 205286, - 'title' => null, + 'children' => ['GenerateVideoCover', 'DetectVideoShot', 'RecognizeVideoCastCrewList', 'SplitVideoParts', 'EvaluateVideoQuality'], + 'type' => 'directory', + 'title' => 'Video understanding', + ], + [ + 'children' => ['GetAsyncJobResult'], + 'title' => 'Others', 'type' => 'directory', - 'children' => [ - 'GenerateVideoCover', - 'DetectVideoShot', - 'UnderstandVideoContent', - 'RecognizeVideoCastCrewList', - 'SplitVideoParts', - 'EvaluateVideoQuality', - 'GetAsyncJobResult', - ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'GenerateVideoCover' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DetectVideoShot' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -45,108 +32,374 @@ [ 'name' => 'VideoUrl', 'in' => 'formData', + 'schema' => ['description' => 'The URL of the video. We recommend that you use an Object Storage Service (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' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videorecog/DetectVideoShot/DetectVideoShot2.mp4', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0033B795-09C7-4EB9-A33C-EBA325192B0D', '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' => [ + 'ShotFrameIds' => [ + 'description' => '1', + 'type' => 'array', + 'items' => ['description' => 'The frame number of the split point.', 'type' => 'integer', 'format' => 'int32', 'example' => '[0, 109, 185, 251, 341, 393, 468, 629, 715, 762, 1272, 1304, 1331, 1351, 1379, 1414, 1431, 1456, 1504, 1709, 1838, 1893, 1975, 2239, 2364, 2425, 2469, 2532, 2607, 2665, 2737, 2864, 2944, 2979, 2995]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Message' => ['description' => 'The message returned after the asynchronous task is submitted.', 'type' => 'string', 'example' => '该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。', 'title' => ''], + ], 'description' => '', - 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videorecog/videorecog/videorecog1.mp4', - 'isFileTransferUrl' => true, - 'required' => true, - 'type' => 'string', + '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\\": \\"0033B795-09C7-4EB9-A33C-EBA325192B0D\\",\\n \\"Data\\": {\\n \\"ShotFrameIds\\": [\\n 0\\n ]\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","type":"json"}]', + 'title' => 'Video shot detection', + 'summary' => 'Parses video shots by splitting an input video at shot boundaries and returns the split points.', + 'description' => '## Description'."\n" + .'The video shot detection feature splits an input video at shot boundaries and returns the split points.'."\n" + ."\n" + .'> - You can join [online consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) to get help from online support.'."\n" + .'- You can try this feature for free on the China site (Chinese). Click [China site (Chinese)](https://vision.aliyun.com/experience/detail?&tagName=videorecog&children=DetectVideoShot) to try this feature or purchase it online.'."\n" + .'- To access Alibaba Cloud Vision Intelligence Open Platform visual AI APIs, use the APIs, or consult about issues, 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 **China site (Chinese)** in the upper-right corner, and follow the on-screen instructions to create an account.'."\n" + .'2. Activate the service: Make sure that you have activated the [video understanding service](https://vision.aliyun.com/videorecog). If you have not activated the service, [activate it now](https://common-buy.aliyun.com/?commodityCode=viapi_videorecog_public_cn#/open).'."\n" + .'3. Create an AccessKey pair: Make sure that you have [created an AccessKey pair](~~175144~~). If you are using an AccessKey pair of a RAM user, 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/videorecog/2020-03-20/DetectVideoShot?lang=JAVA&sdkStyle=dara¶ms=%7B%22VideoUrl%22%3A%22http%3A%2F%2Fviapi-test.oss-cn-shanghai.aliyuncs.com%2Fviapi-3.0domepic%2Fvideorecog%2FDetectVideoShot%2FDetectVideoShot1.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 and integration steps: '."\n" + .'- Select the SDK language that you want to use from [SDK overview](~~145033~~).'."\n" + .'- Find the SDK package for the video understanding (videorecog) 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 and best practices: For sample code in common programming languages and examples of processing results, see [Video shot detection sample code](~~465560~~). For sample code for querying asynchronous task results in common programming languages, see [Query asynchronous task results 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 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, RMVB, FLV, or TS.'."\n" + .'- Video size: up to 1 GB.'."\n" + .'- Video resolution: up to 1080p.'."\n" + .'- The URL cannot contain Chinese characters.'."\n" + ."\n" + .'## Billing description'."\n" + .'For information about the billable methods and pricing of video shot parse, see [Billing overview](~~202485~~).'."\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 DetectVideoShot 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.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '## Query results'."\n" + .'This is an asynchronous operation that does not return actual results. Call the GetAsyncJobResult operation with the returned RequestId to obtain the actual results. For more information, see [GetAsyncJobResult](~~607824~~).'."\n" + ."\n" + .'## SDK reference'."\n" + .'We recommend that you use an SDK to call the video shot detection feature under the video understanding category of Alibaba Cloud Vision AI. The SDK supports multiple programming languages. When calling the operation, select the SDK package for the video understanding (videorecog) AI category. The SDK supports local files and arbitrary URLs for file parameters. For more information, see [SDK overview](~~145033~~).'."\n" + ."\n" + .'## Sample code and best practices'."\n" + .'For sample code in common programming languages and examples of processing results, see [Video shot detection sample code](~~465560~~). For sample code for querying asynchronous task results in common programming languages, see [Query asynchronous task results sample code](~~607974~~).', + 'extraInfo' => '## Error codes'."\n" + .'For error codes of video shot detection, see [Common error codes](~~159312~~).'."\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 feature are valid for 1 hour and are automatically deleted by the system after 24 hours.', + 'changeSet' => [ + ['createdAt' => '2022-10-17T02:07:20.000Z', 'description' => 'Response parameters changed'], + ], + 'ramActions' => [ [ - 'name' => 'IsGif', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'false', - 'required' => true, - 'type' => 'boolean', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videorecog:DetectVideoShot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + ], + 'EvaluateVideoQuality' => [ + 'summary' => 'This topic describes the syntax and provides examples of the EvaluateVideoQuality operation in the video understanding (videorecog) category.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'VideoUrl', + 'in' => 'formData', + '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://public-vigen-video.oss-cn-shanghai.aliyuncs.com/Common/xxx/dont_delete/decaption/123.mp4', 'title' => ''], + ], + [ + 'name' => 'Mode', + 'in' => 'formData', + 'schema' => ['description' => 'The quality assessment mode. Valid values:'."\n" + .'- general (default): basic quality assessment.'."\n" + .'- vqa_plus: basic quality assessment and defect quality assessment.', 'type' => 'string', 'required' => false, 'example' => 'vqa_plus', 'title' => ''], + ], + ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '5B95B724-C5B9-4F77-A743-0CA4EA95CC82', - 'type' => 'string', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1d33e538-c949-4fcd-83f6-4d57e4b31527'], 'Data' => [ - 'description' => '', + 'description' => 'The returned data.'."\n" + .'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' => [ - 'Outputs' => [ - 'description' => '', - 'items' => [ - 'properties' => [ - 'ImageURL' => [ - 'description' => '', - 'example' => 'http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-cover/2020-05-11-07/pic_lOyxGGAqQYSANGxP.mp4_202_544_960_c9f88b2a5f75e17c093d1a65f5edff4d_beautified.png?Expires=1589185385&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=PAalKsfeZC4UQzYDTU%2F3D1G7Xt****', - 'type' => 'string', - ], - 'Confidence' => [ - 'description' => '', - 'example' => '6.1819260887924425', - 'format' => 'float', - 'type' => 'number', - ], - ], - 'type' => 'object', + 'JsonUrl' => ['description' => 'The detailed quality assessment report (JSON file).'."\n" + ."\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-damo-eas-cn-shanghai.oss-cn-shanghai.aliyuncs.com/eas-video-quality-assessment/2023-01-13-10/31%3A08-cVeN9ZQlzIPfGqsa.json?Expires=1673578869&OSSAccessKeyId=LTAI****************&Signature=AiSsOsZ7rYfhf9w3Mxn%2Fq4GKKy****', 'title' => ''], + 'PdfUrl' => ['description' => 'The comprehensive quality assessment report (PDF file).'."\n" + ."\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-damo-eas-cn-shanghai.oss-cn-shanghai.aliyuncs.com/eas-video-quality-assessment/2023-01-13-10/31%3A08-cVeN9ZQlzIPfGqsa.pdf?Expires=1673578869&OSSAccessKeyId=LTAI****************&Signature=xULlZzVuhoYWAXRbp9A4EzzZcS****', 'title' => ''], + 'VideoQualityInfo' => [ + 'description' => 'The video quality details.', + 'type' => 'object', + 'properties' => [ + 'CompressiveStrength' => ['description' => 'The compression level.', 'type' => 'number', 'format' => 'float', 'example' => '0.25', 'title' => ''], + 'NoiseIntensity' => ['description' => 'The noise level.', 'type' => 'number', 'format' => 'float', 'example' => '0.01', 'title' => ''], + 'Blurriness' => ['description' => 'The blurriness level.', 'type' => 'number', 'format' => 'float', 'example' => '0.15', 'title' => ''], + 'ColorContrast' => ['description' => 'The color contrast.', 'type' => 'number', 'format' => 'float', 'example' => '0.55', 'title' => ''], + 'ColorSaturation' => ['description' => 'The color saturation.', 'type' => 'number', 'format' => 'float', 'example' => '0.17', 'title' => ''], + 'Luminance' => ['description' => 'The luminance.', 'type' => 'number', 'format' => 'float', 'example' => '0.51', 'title' => ''], + 'Colorfulness' => ['description' => 'The colorfulness.', 'type' => 'number', 'format' => 'float', 'example' => '0.48', 'title' => ''], + 'MosScore' => ['description' => 'The subjective quality score.', 'type' => 'number', 'format' => 'float', 'example' => '0.7048', 'title' => ''], ], - 'type' => 'array', + 'title' => '', + 'example' => '', ], ], - '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', + '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.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1d33e538-c949-4fcd-83f6-4d57e4b31527\\",\\n \\"Data\\": {\\n \\"JsonUrl\\": \\"http://vibktprfx-prod-prod-damo-eas-cn-shanghai.oss-cn-shanghai.aliyuncs.com/eas-video-quality-assessment/2023-01-13-10/31%3A08-cVeN9ZQlzIPfGqsa.json?Expires=1673578869&OSSAccessKeyId=LTAI****************&Signature=AiSsOsZ7rYfhf9w3Mxn%2Fq4GKKy****\\",\\n \\"PdfUrl\\": \\"http://vibktprfx-prod-prod-damo-eas-cn-shanghai.oss-cn-shanghai.aliyuncs.com/eas-video-quality-assessment/2023-01-13-10/31%3A08-cVeN9ZQlzIPfGqsa.pdf?Expires=1673578869&OSSAccessKeyId=LTAI****************&Signature=xULlZzVuhoYWAXRbp9A4EzzZcS****\\",\\n \\"VideoQualityInfo\\": {\\n \\"CompressiveStrength\\": 0.25,\\n \\"NoiseIntensity\\": 0.01,\\n \\"Blurriness\\": 0.15,\\n \\"ColorContrast\\": 0.55,\\n \\"ColorSaturation\\": 0.17,\\n \\"Luminance\\": 0.51,\\n \\"Colorfulness\\": 0.48,\\n \\"MosScore\\": 0.7048\\n }\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","type":"json"}]', + 'title' => 'Video quality assessment', + 'description' => '## Feature description'."\n" + .'Video quality assessment evaluates the visual quality of input videos, including general video quality and defective video quality. General video quality includes subjective quality score, objective quality score (clarity, dot noise, compression noise), and color quality score (saturation, richness, contrast, and brightness evaluation). Defective video quality includes interlace detection, scratch detection, and abnormal frame detection (frozen frames, flickering, and black or corrupted screens).'."\n" + .'For typical examples of this feature, see the following table:'."\n" + .''."\n" + ."\n" + .'> - You can visit [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) to get 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=videorecog&children=EvaluateVideoQuality) to experience this feature or purchase it online.'."\n" + .'- For questions about API integration, API usage, or other inquiries regarding the Alibaba Cloud Visual Intelligence Open Platform, join the DingTalk group (23109592) to contact us.'."\n" + ."\n" + .'## Common scenarios'."\n" + .'- Video quality assessment: A standardized video assessment toolset that includes various no-reference metric sub-tools. It can serve quality monitoring in different business scenarios such as video transcoding, live streaming, and enhancement.'."\n" + .'- UGC quality review: Quality control for user-generated content uploads. It detects the visual quality of UGC content and filters out videos with overall low quality or significant visual issues.'."\n" + ."\n" + .'## Features'."\n" + .'- Video quality assessment: Covers various subjective and objective general video quality metrics, providing comprehensive and systematic quality assessment services.'."\n" + .'- Video quality monitoring: Covers quality monitoring for various technical defects that may appear in videos, ensuring video service quality.'."\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 understanding service](https://vision.aliyun.com/videorecog). If you have not activated the service, [activate it now](https://common-buy.aliyun.com/?commodityCode=viapi_videorecog_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/videorecog/2020-03-20/EvaluateVideoQuality?lang=JAVA&useCommon=true) 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 the SDK package for the video understanding (videorecog) 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 languages for this feature, see [Video quality assessment sample code](~~608851~~). For sample code in common languages for querying asynchronous task results, see [Query asynchronous task result 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" + .'- Video format: MP4.'."\n" + .'- Video size: Up to 1 GB.'."\n" + .'- Video resolution: Up to 1080P, which means the long side does not exceed 1920 pixels and the short side does not exceed 1080 pixels.'."\n" + .'- The URL cannot contain Chinese characters.'."\n" + ."\n" + .'## Billing description'."\n" + .'For the billable methods and pricing of video quality assessment, see [Billing overview](~~202485~~).'."\n" + ."\n" + .'> The debugging operation below is a paid operation.'."\n" + ."\n" + .'## Procedure'."\n" + .'This feature is asynchronous and requires two steps.'."\n" + .'Step 1: Call the EvaluateVideoQuality 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.', + 'responseParamsDescription' => '## Query results'."\n" + .'This operation is asynchronous and 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" + .'We recommend that you use an SDK to call the video quality assessment feature under the video understanding category of Alibaba Cloud Visual AI. SDKs are available in multiple programming languages. When making a call, select the SDK package for the video understanding (videorecog) AI category. The SDK supports both local files and arbitrary URLs as file parameters. For more information, see [SDK overview](~~145033~~).'."\n" + ."\n" + .'## Sample code'."\n" + .'For sample code in common languages for this feature, see [Video quality assessment sample code](~~608851~~). For sample code in common languages for querying asynchronous task results, see [Query asynchronous task result sample code](~~607974~~).'."\n" + ."\n" + .'## Score analysis for video quality assessment'."\n" + .'The algorithm returns two fields: **JsonUrl** and **PdfUrl**. **PdfUrl** is the comprehensive quality assessment report in PDF format for the video. **JsonUrl** is the detailed quality assessment report in JSON format, which includes sampled frame sequences and per-shot/per-frame scores for each quality metric, facilitating detailed analysis and handling of video quality issues.'."\n" + ."\n" + .'## JsonUrl file parameter example'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "fps": 25.0,'."\n" + .' "frame_num": 252,'."\n" + .' "duration": 10.08,'."\n" + .' "task_id": "2",'."\n" + .' "input_w": 640,'."\n" + .' "input_h": 480,'."\n" + .' "vqa_degradation_info": [{'."\n" + .' "noise_degree": 0.01,'."\n" + .' "blur_degree": 0.15,'."\n" + .' "comp_degree": 0.24,'."\n" + .' "clip": [0, 251],'."\n" + .' "duration": ["00:00:00", "00:00:10"]'."\n" + .' }],'."\n" + .' "vqa_mos_info": ['."\n" + .' [{'."\n" + .' "frame idx": 36,'."\n" + .' "image mos": 0.693'."\n" + .' }, {'."\n" + .' "frame idx": 72,'."\n" + .' "image mos": 0.696'."\n" + .' }, {'."\n" + .' "frame idx": 108,'."\n" + .' "image mos": 0.707'."\n" + .' }, {'."\n" + .' "frame idx": 144,'."\n" + .' "image mos": 0.702'."\n" + .' }, {'."\n" + .' "frame idx": 180,'."\n" + .' "image mos": 0.736'."\n" + .' }]'."\n" + .' ],'."\n" + .' "vqa_color_quality_analysis_info": [{'."\n" + .' "contrast_score": 0.55,'."\n" + .' "luma_score": 0.49,'."\n" + .' "color_saturation_score": 0.17,'."\n" + .' "colorfulness_score": 0.45,'."\n" + .' "clip": [36, 180],'."\n" + .' "duration": ["00:00:01", "00:00:07"]'."\n" + .' }],'."\n" + .' "vqa_damaged_frame_info": {'."\n" + .' "frame_list": [],'."\n" + .' "confidence": 0.0'."\n" + .' },'."\n" + .' "vqa_interlace_frame_info": {'."\n" + .' "frame_list": [],'."\n" + .' "confidence": 0.0'."\n" + .' },'."\n" + .' "vqa_freeze_frame_info": {'."\n" + .' "frame_list": [],'."\n" + .' "confidence": 0.0'."\n" + .' },'."\n" + .' "vqa_flicker_frame_info": {'."\n" + .' "frame_list": [],'."\n" + .' "confidence": 0.0'."\n" + .' },'."\n" + .' "vqa_scratch_frame_info": {'."\n" + .' "frame_list": [104],'."\n" + .' "confidence": 0.012'."\n" + .' }'."\n" + .'}'."\n" + .'```.'."\n" + ."\n" + .'## JsonUrl file parameter description'."\n" + .'.'."\n" + ."\n" + .'## Video quality assessment parameter value description'."\n" + .'.', + 'extraInfo' => '## Error codes'."\n" + .'For error codes of video quality assessment, see [Common error codes](~~159312~~).'."\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' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videorecog:EvaluateVideoQuality', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5B95B724-C5B9-4F77-A743-0CA4EA95CC82\\",\\n \\"Data\\": {\\n \\"Outputs\\": [\\n {\\n \\"ImageURL\\": \\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-cover/2020-05-11-07/pic_lOyxGGAqQYSANGxP.mp4_202_544_960_c9f88b2a5f75e17c093d1a65f5edff4d_beautified.png?Expires=1589185385&OSSAccessKeyId=LTAI****************&Signature=PAalKsfeZC4UQzYDTU%2F3D1G7Xt****\\",\\n \\"Confidence\\": 6.1819260887924425\\n }\\n ]\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","errorExample":""},{"type":"xml","example":"<GenerateVideoCoverResponse>\\n <RequestId>5B95B724-C5B9-4F77-A743-0CA4EA95CC82</RequestId>\\n <Message>该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。</Message>\\n</GenerateVideoCoverResponse>","errorExample":""}]', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', ], - 'DetectVideoShot' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GenerateVideoCover' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -159,209 +412,251 @@ [ 'name' => 'VideoUrl', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videorecog/DetectVideoShot/DetectVideoShot2.mp4', - 'isFileTransferUrl' => true, - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The URL of the video. We recommend that you use an Object Storage Service (OSS) link in the Shanghai region. If the file is stored locally or the OSS link is in a region 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/videorecog/videorecog/videorecog1.mp4', 'title' => ''], + ], + [ + 'name' => 'IsGif', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to output the cover in GIF format. A value of true indicates that the cover is output in GIF format. A value of false indicates that the cover is output as a regular image.', 'type' => 'boolean', 'required' => true, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '0033B795-09C7-4EB9-A33C-EBA325192B0D', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5B95B724-C5B9-4F77-A743-0CA4EA95CC82', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The returned result data.'."\n" + .'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' => [ - 'ShotFrameIds' => [ - 'description' => '1', + 'Outputs' => [ + 'description' => 'The list of returned information. Each element is a cover image. Multiple cover images may be returned. This information is returned when the task succeeds.', + 'type' => 'array', 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ImageURL' => ['description' => 'The URL of the output cover image.'."\n" + .'> This URL is a temporary address that is valid for 30 minutes. After it expires, the URL is no longer accessible.', 'type' => 'string', 'example' => 'http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-cover/2020-05-11-07/pic_lOyxGGAqQYSANGxP.mp4_202_544_960_c9f88b2a5f75e17c093d1a65f5edff4d_beautified.png?Expires=1589185385&OSSAccessKeyId=LTAI****************&Signature=PAalKsfeZC4UQzYDTU%2F3D1G7Xt****', 'title' => ''], + 'Confidence' => ['description' => 'The confidence score. A higher value indicates higher reliability.', 'type' => 'number', 'format' => 'float', 'example' => '6.1819260887924425', 'title' => ''], + ], 'description' => '', - 'example' => '[0, 109, 185, 251, 341, 393, 468, 629, 715, 762, 1272, 1304, 1331, 1351, 1379, 1414, 1431, 1456, 1504, 1709, 1838, 1893, 1975, 2239, 2364, 2425, 2469, 2532, 2607, 2665, 2737, 2864, 2944, 2979, 2995]', - 'format' => 'int32', - 'type' => 'integer', + 'title' => '', + 'example' => '', ], - 'type' => 'array', + 'title' => '', + 'example' => '', ], ], - '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' => '', ], ], ], '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0033B795-09C7-4EB9-A33C-EBA325192B0D\\",\\n \\"Data\\": {\\n \\"ShotFrameIds\\": [\\n 0\\n ]\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","errorExample":""},{"type":"xml","example":"<DetectVideoShotResponse>\\n <RequestId>0033B795-09C7-4EB9-A33C-EBA325192B0D</RequestId>\\n <Message>该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。</Message>\\n</DetectVideoShotResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5B95B724-C5B9-4F77-A743-0CA4EA95CC82\\",\\n \\"Data\\": {\\n \\"Outputs\\": [\\n {\\n \\"ImageURL\\": \\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-cover/2020-05-11-07/pic_lOyxGGAqQYSANGxP.mp4_202_544_960_c9f88b2a5f75e17c093d1a65f5edff4d_beautified.png?Expires=1589185385&OSSAccessKeyId=LTAI****************&Signature=PAalKsfeZC4UQzYDTU%2F3D1G7Xt****\\",\\n \\"Confidence\\": 6.1819260887924425\\n }\\n ]\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","type":"json"}]', + 'title' => 'Video cover', + 'summary' => 'This topic describes the syntax and provides examples of the GenerateVideoCover operation for generating video covers.', + 'description' => '## Feature description'."\n" + .'The video cover feature detects the input video and outputs multiple video covers.'."\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?b&tagName=videorecog&children=GenerateVideoCover) to experience this feature or purchase it online.'."\n" + .'- For questions about Alibaba Cloud Vision Intelligence Open Platform visual AI API integration and 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 the [Video Understanding service](https://vision.aliyun.com/videorecog). If you have not activated the service, [activate it now](https://common-buy.aliyun.com/?commodityCode=viapi_videorecog_public_cn#/open).'."\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/videorecog/2020-03-20/GenerateVideoCover?lang=JAVA&sdkStyle=dara¶ms=%7B%22VideoUrl%22%3A%22http%3A%2F%2Fviapi-test.oss-cn-shanghai.aliyuncs.com%2Fviapi-3.0domepic%2Fvideorecog%2Fvideorecog%2Fvideorecog1.mp4%22%2C%22IsGif%22%3Afalse%7D&tab=DEMO) to debug this feature online, view complete sample code and SDK dependency information, or download the complete project.'."\n" + ."\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 Understanding (videorecog) 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 for this feature in common languages, see [Sample code for querying asynchronous task results](~~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 format: MP4, RMVB, FLV, or TS.'."\n" + .'- Video size: up to 1 GB.'."\n" + .'- Video resolution: up to 1080p.'."\n" + .'- The URL cannot contain Chinese characters.'."\n" + ."\n" + .'## Billing description'."\n" + .'For the billable methods and pricing of the video cover feature, see [Billing overview](~~202485~~).'."\n" + .'> The debugging operation below is a paid operation.'."\n" + ."\n" + .'## Call procedure'."\n" + .'This feature is asynchronous and requires two steps to call.'."\n" + .'Step 1: Call the GenerateVideoCover 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 and then query again.', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - ], - 'UnderstandVideoContent' => [ - 'summary' => '视频内容理解', - 'methods' => [ - 'post', + 'responseParamsDescription' => '## Query results'."\n" + .'This operation is asynchronous and 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" + .'To use the video cover feature under the Alibaba Cloud Vision AI Video Understanding category, we recommend that you use the SDK. The SDK supports multiple programming languages. When making calls, select the SDK package for the Video Understanding (videorecog) AI category. File parameters can be passed as local files or 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 for this feature in common languages, see [Sample code for querying asynchronous task results](~~607974~~).', + 'extraInfo' => '## Error codes'."\n" + .'For error codes of the video cover feature, see [Common error codes](~~159312~~).'."\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:07:20.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videorecog:GenerateVideoCover', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetAsyncJobResult' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'VideoURL', + 'name' => 'JobId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videorecog/UnderstandVideoContent/UnderstandVideoContent1.mp4', - 'isFileTransferUrl' => true, - 'required' => true, - 'title' => 'A short description of struct', - 'type' => 'string', - ], + 'schema' => ['description' => 'The RequestId returned by the asynchronous operation. You can use this value to query the actual result of the asynchronous operation.', 'type' => 'string', 'required' => true, 'example' => 'B6590005-5E7C-4A25-8F97-4479888D8271', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'description' => '1', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '71EC3F13-F0CA-4558-AC7F-A351106F59F2', - 'title' => 'Id of the request', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0E448D84-1736-1BCD-BEA5-866C413515A1', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The returned data.', + 'type' => 'object', 'properties' => [ - 'TagInfo' => [ - 'description' => '', - 'type' => 'object', - ], - 'VideoInfo' => [ - 'description' => '', - 'properties' => [ - 'Width' => [ - 'description' => '', - 'example' => '720', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Height' => [ - 'description' => '', - 'example' => '1280', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Duration' => [ - 'description' => '', - 'example' => '43380', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Fps' => [ - 'description' => '', - 'example' => '25.0', - 'format' => 'float', - 'type' => 'number', - ], - ], - 'type' => 'object', - ], + 'Status' => ['description' => 'The status of the asynchronous task. Valid values:'."\n" + ."\n" + .'- QUEUING: The task is queuing.'."\n" + .'- PROCESSING: The task is being processed.'."\n" + .'- PROCESS_SUCCESS: The task was processed.'."\n" + .'- PROCESS_FAILED: The task failed to be processed.'."\n" + .'- TIMEOUT_FAILED: The task timed out.'."\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' => '"{\\"jsonUrl\\":\\"http://vibktprfx-prod-prod-damo-eas-cn-shanghai.oss-cn-shanghai.aliyuncs.com/eas-video-quality-assessment/2023-01-11-16/01%3A52-crxCR763VXTeY0bP.json?Expires=1673425915&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=iW07EIZaqaiMNoF3RJZwsLVxOx****\\",\\"pdfUrl\\":\\"http://vibktprfx-prod-prod-damo-eas-cn-shanghai.oss-cn-shanghai.aliyuncs.com/eas-video-quality-assessment/2023-01-11-16/01%3A52-crxCR763VXTeY0bP.pdf?Expires=1673425916&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=BvZ3ayeTTxaR65ZvQ2%2FoE8W8Lr****\\"}"', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code of the asynchronous task.', 'type' => 'string', 'example' => 'InvalidParameter', 'title' => ''], + 'JobId' => ['description' => 'The asynchronous task ID.', 'type' => 'string', 'example' => 'A421D5F0-4F73-19F5-8D92-D509FAD281D2', 'title' => ''], ], - 'type' => 'object', - ], - 'Message' => [ - 'description' => '', + 'title' => '', 'example' => '', - 'type' => 'string', ], ], - 'title' => 'Schema of Response', - 'type' => 'object', + '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\\": \\"0E448D84-1736-1BCD-BEA5-866C413515A1\\",\\n \\"Data\\": {\\n \\"Status\\": \\"PROCESS_SUCCESS\\",\\n \\"ErrorMessage\\": \\"paramsIllegal\\",\\n \\"Result\\": \\"\\\\\\"{\\\\\\\\\\\\\\"jsonUrl\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"http://vibktprfx-prod-prod-damo-eas-cn-shanghai.oss-cn-shanghai.aliyuncs.com/eas-video-quality-assessment/2023-01-11-16/01%3A52-crxCR763VXTeY0bP.json?Expires=1673425915&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=iW07EIZaqaiMNoF3RJZwsLVxOx****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pdfUrl\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"http://vibktprfx-prod-prod-damo-eas-cn-shanghai.oss-cn-shanghai.aliyuncs.com/eas-video-quality-assessment/2023-01-11-16/01%3A52-crxCR763VXTeY0bP.pdf?Expires=1673425916&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=BvZ3ayeTTxaR65ZvQ2%2FoE8W8Lr****\\\\\\\\\\\\\\"}\\\\\\"\\",\\n \\"ErrorCode\\": \\"InvalidParameter\\",\\n \\"JobId\\": \\"A421D5F0-4F73-19F5-8D92-D509FAD281D2\\"\\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" + .'For asynchronous operations, the response returned after you invoke an API operation is not 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, download the files to a local server or store them in Object Storage Service (OSS) promptly. For more information about OSS operations, see [Upload objects](~~31886~~).'."\n" + .'> - To learn more about accessing Alibaba Cloud Vision Intelligence Open Platform visual AI API operations, using the operations, or consulting on related issues, join the DingTalk group (23109592) to contact us.'."\n" + ."\n" + .'## Endpoint'."\n" + .'| Region | Region ID | Public endpoint | HTTPS supported |'."\n" + .'| ------ | ------ | ------ | ------ |'."\n" + .'| China (Shanghai) | cn-shanghai | viapi.cn-shanghai.aliyuncs.com | Yes |.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '## SDK reference'."\n" + .'We recommend that you use the SDK to call Alibaba Cloud Vision AI operations. The SDK supports multiple programming languages and allows you to pass local files or URLs as file parameters. For more information, see [SDK overview](~~145033~~).', + 'extraInfo' => '## Error codes'."\n" + .'For error codes related to querying asynchronous task results, see [Common error codes](~~606865~~).'."\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 deleted by the system after 24 hours.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'viapi-videorecog:GetAsyncJobResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"71EC3F13-F0CA-4558-AC7F-A351106F59F2\\",\\n \\"Data\\": {\\n \\"TagInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"VideoInfo\\": {\\n \\"Width\\": 720,\\n \\"Height\\": 1280,\\n \\"Duration\\": 43380,\\n \\"Fps\\": 25\\n }\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","errorExample":""},{"type":"xml","example":"<UnderstandVideoContentResponse>\\n <RequestId>71EC3F13-F0CA-4558-AC7F-A351106F59F2</RequestId>\\n <Message>该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。</Message>\\n</UnderstandVideoContentResponse>","errorExample":""}]', ], 'RecognizeVideoCastCrewList' => [ - 'summary' => '视频OCR', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Describes the syntax and provides examples of the video OCR operation RecognizeVideoCastCrewList.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -373,34 +668,30 @@ [ 'name' => 'VideoUrl', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'https://shanghai.oss-cn-shanghai.aliyuncs.com/download/xxxx.mp4', - 'isFileTransferUrl' => true, - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The URL of the video. We recommend that you use an Object Storage Service (OSS) URL in the China (Shanghai) region. If the file is stored locally or the OSS URL is in a region other than China (Shanghai), see [File URL processing](~~155645~~).', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'https://shanghai.oss-cn-shanghai.aliyuncs.com/download/xxxx.mp4', 'title' => ''], ], [ 'name' => 'Params', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The parameters that control the output of scenario results.', + 'type' => 'array', 'items' => [ + 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => '', - 'example' => 'cast', - 'required' => false, - 'type' => 'string', - ], + 'Type' => ['description' => 'The type of video information extraction. Valid values:'."\n" + .'- subtitles: subtitle extraction.'."\n" + .'- cast: cast and crew list extraction.', 'type' => 'string', 'required' => false, 'example' => 'cast', 'title' => ''], ], 'required' => false, - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, - 'type' => 'array', + 'title' => '', + 'example' => '', ], ], ], @@ -408,345 +699,329 @@ 200 => [ 'headers' => [], 'schema' => [ + 'title' => '', 'description' => 'Schema of Response', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE5B1A95-064F-1C5E-A6FE-FEE0D734A632', - 'title' => 'Id of the request', - 'type' => 'string', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE5B1A95-064F-1C5E-A6FE-FEE0D734A632'], 'Data' => [ - 'description' => '', + 'description' => 'The returned data.'."\n" + .'After the asynchronous task is executed successfully, call the [GetAsyncJobResult](~~607824~~) operation and perform JSON deserialization on the Result field to obtain this data.', + 'type' => 'object', 'properties' => [ 'OcrResults' => [ - 'description' => '', + 'description' => 'The text recognition results at 3 frames per second.', + 'type' => 'array', 'items' => [ + 'type' => 'object', 'properties' => [ 'DetailInfo' => [ - 'description' => '', + 'description' => 'The detailed content.', + 'type' => 'array', 'items' => [ + 'type' => 'object', 'properties' => [ 'Boxes' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '[452,27,505,46]', - 'format' => 'int32', - 'type' => 'integer', - ], + 'description' => 'The coordinates of the text bounding rectangle in the order of \\[xmin,ymin,xmax,ymax].', 'type' => 'array', + 'items' => ['description' => 'The coordinates of the text bounding rectangle in the order of \\[xmin,ymin,xmax,ymax].', 'type' => 'integer', 'format' => 'int32', 'example' => '[452,27,505,46]', 'title' => ''], + 'title' => '', + 'example' => '', ], 'CharProbs' => [ - 'description' => '', + 'description' => 'The recognition confidence for each individual character in the text. Value range: 0 to 1.0.', + 'type' => 'array', 'items' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '0.9405716061592102', - 'format' => 'float', - 'type' => 'number', - ], + 'description' => 'The recognition confidence for each individual character in the text. Value range: 0 to 1.0.', 'type' => 'array', + 'items' => ['description' => '文本单个字符对应识别置信度，取值范围0~1.0。', 'type' => 'number', 'format' => 'float', 'example' => '0.9405716061592102', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'type' => 'array', - ], - 'FrameIndex' => [ - 'description' => '', - 'example' => '17', - 'format' => 'int64', - 'type' => 'integer', + 'title' => '', + 'example' => '', ], + 'FrameIndex' => ['description' => 'The video frame sequence number.', 'type' => 'integer', 'format' => 'int64', 'example' => '17', 'title' => ''], 'Position' => [ - 'description' => '', + 'description' => 'The point coordinates of the text bounding rectangle \\[top-left, top-right, bottom-right, bottom-left].', + 'type' => 'array', 'items' => [ + 'type' => 'object', 'properties' => [ - 'X' => [ - 'description' => '', - 'example' => '266', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Y' => [ - 'description' => '', - 'example' => '440', - 'format' => 'int64', - 'type' => 'integer', - ], + 'X' => ['description' => 'The horizontal coordinate, corresponding to the video width. Unit: pixels.', 'type' => 'integer', 'format' => 'int64', 'example' => '266', 'title' => ''], + 'Y' => ['description' => 'The vertical coordinate, corresponding to the video height. Unit: pixels.', 'type' => 'integer', 'format' => 'int64', 'example' => '440', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'type' => 'array', - ], - 'Score' => [ - 'description' => '', - 'example' => '92.07685702563117', - 'format' => 'float', - 'type' => 'number', - ], - 'TextProb' => [ - 'description' => '', - 'example' => '0.9207685702563116', - 'format' => 'float', - 'type' => 'number', - ], - 'TimeStamp' => [ - 'description' => '', - 'example' => '0.28', - 'format' => 'float', - 'type' => 'number', - ], - 'TrackId' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Text' => [ - 'description' => '', + 'title' => '', 'example' => '', - 'type' => 'string', ], + 'Score' => ['description' => 'The confidence score of the text recognition result. Value range: 0 to 100.'."\n" + ."\n" + .'> Score = 100 × TextProb.', 'type' => 'number', 'format' => 'float', 'example' => '92.07685702563117', 'title' => ''], + 'TextProb' => ['description' => 'The confidence score of the text recognition result. Value range: 0 to 1.0.', 'type' => 'number', 'format' => 'float', 'example' => '0.9207685702563116', 'title' => ''], + 'TimeStamp' => ['description' => 'The timestamp of the video frame. Unit: seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0.28', 'title' => ''], + 'TrackId' => ['description' => 'The tracking assignment ID sequence number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Text' => ['description' => 'The text recognition result.', 'type' => 'string', 'example' => '总策划', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'type' => 'array', - ], - 'EndTime' => [ - 'description' => '', - 'example' => '0.28', - 'format' => 'float', - 'type' => 'number', - ], - 'StartTime' => [ - 'description' => '', - 'example' => '0.28', - 'format' => 'float', - 'type' => 'number', + 'title' => '', + 'example' => '', ], + 'EndTime' => ['description' => 'The end timestamp of the video frame. Unit: seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0.28', 'title' => ''], + 'StartTime' => ['description' => 'The start timestamp of the video frame. Unit: seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0.28', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'type' => 'array', + 'title' => '', + 'example' => '', ], 'VideoOcrResults' => [ - 'description' => '', + 'description' => 'The text recognition results at the video clip level.', + 'type' => 'array', 'items' => [ + 'type' => 'object', 'properties' => [ 'DetailInfo' => [ - 'description' => '', + 'description' => 'The detailed content.', + 'type' => 'array', 'items' => [ + 'type' => 'object', 'properties' => [ 'Boxes' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '[266,440,314,476]', - 'format' => 'int64', - 'type' => 'integer', - ], + 'description' => 'The coordinates of the text bounding rectangle in the order of \\[xmin,ymin,xmax,ymax].', 'type' => 'array', + 'items' => ['description' => 'The coordinates of the text bounding rectangle in the order of \\[xmin,ymin,xmax,ymax].', 'type' => 'integer', 'format' => 'int64', 'example' => '[266,440,314,476]', 'title' => ''], + 'title' => '', + 'example' => '', ], 'Position' => [ - 'description' => '', + 'description' => 'The point coordinates of the text bounding rectangle \\[top-left, top-right, bottom-right, bottom-left].', + 'type' => 'array', 'items' => [ + 'type' => 'object', 'properties' => [ - 'X' => [ - 'description' => '', - 'example' => '269', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Y' => [ - 'description' => '', - 'example' => '423', - 'format' => 'int64', - 'type' => 'integer', - ], + 'X' => ['description' => 'The horizontal coordinate, corresponding to the video width. Unit: pixels.', 'type' => 'integer', 'format' => 'int64', 'example' => '269', 'title' => ''], + 'Y' => ['description' => 'The vertical coordinate, corresponding to the video height. Unit: pixels.', 'type' => 'integer', 'format' => 'int64', 'example' => '423', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'type' => 'array', - ], - 'Score' => [ - 'description' => '', - 'example' => '92.07685702563117', - 'format' => 'float', - 'type' => 'number', - ], - 'Text' => [ - 'description' => '', + 'title' => '', 'example' => '', - 'type' => 'string', - ], - 'TextType' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int64', - 'type' => 'integer', ], + 'Score' => ['description' => 'The confidence score of the text recognition result. Value range: 0 to 100.', 'type' => 'number', 'format' => 'float', 'example' => '92.07685702563117', 'title' => ''], + 'Text' => ['description' => 'The text recognition result.', 'type' => 'string', 'example' => '总顾问', 'title' => ''], + 'TextType' => ['description' => 'The text type. Valid values:'."\n" + ."\n" + .'- 0: regular subtitle'."\n" + .'- 1: scrolling subtitle'."\n" + .'- 2: static identifier subtitle.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'type' => 'array', - ], - 'EndTime' => [ - 'description' => '', - 'example' => '0.92', - 'format' => 'float', - 'type' => 'number', - ], - 'StartTime' => [ - 'description' => '', - 'example' => '0.92', - 'format' => 'float', - 'type' => 'number', + 'title' => '', + 'example' => '', ], + 'EndTime' => ['description' => 'The end timestamp of the video frame. Unit: seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0.92', 'title' => ''], + 'StartTime' => ['description' => 'The start timestamp of the video frame. Unit: seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0.92', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'type' => 'array', + 'title' => '', + 'example' => '', ], 'SubtitlesResults' => [ - 'description' => '', + 'description' => 'The subtitle recognition results.', + 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The subtitle recognition results.', + 'type' => 'object', 'properties' => [ 'SubtitlesAllResults' => [ - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '[]', - 'description' => '', - ], - 'description' => '', + 'description' => 'The complete Chinese and English subtitle recognition results.', 'type' => 'object', + 'additionalProperties' => ['description' => '字幕识别中英文全部识别结果。', 'type' => 'string', 'example' => '[]', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'SubtitlesAllResultsUrl' => [ - 'description' => '', - 'example' => 'url', - 'type' => 'string', - ], + 'SubtitlesAllResultsUrl' => ['description' => 'The download URL of the standard SRT format file for Chinese and English subtitle recognition results.', 'type' => 'string', 'example' => 'url', 'title' => ''], 'SubtitlesChineseResults' => [ - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => '', - ], - 'description' => '', + 'description' => 'The Chinese subtitle recognition results.', 'type' => 'object', + 'additionalProperties' => ['description' => '字幕识别中文识别结果。', 'type' => 'string', 'example' => '你好', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'SubtitlesChineseResultsUrl' => [ - 'description' => '', - 'example' => 'url1', - 'type' => 'string', - ], - 'SubtitlesEnglishResults' => [ - 'description' => '', - 'example' => 'hello', - 'type' => 'object', - ], - 'SubtitlesEnglishResultsUrl' => [ - 'description' => '', - 'example' => 'url2', - 'type' => 'string', - ], + 'SubtitlesChineseResultsUrl' => ['description' => 'The download URL of the standard SRT format file for Chinese subtitle recognition results.', 'type' => 'string', 'example' => 'url1', 'title' => ''], + 'SubtitlesEnglishResults' => ['description' => 'The English subtitle recognition results.', 'type' => 'object', 'example' => 'hello', 'title' => ''], + 'SubtitlesEnglishResultsUrl' => ['description' => 'The download URL of the standard SRT format file for English subtitle recognition results.', 'type' => 'string', 'example' => 'url2', 'title' => ''], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], - 'type' => 'array', + 'title' => '', + 'example' => '', ], 'CastResults' => [ - 'description' => '', + 'description' => 'The cast and crew list recognition results.', + 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The cast and crew list recognition results.', + 'type' => 'object', 'properties' => [ 'DetailInfo' => [ - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'cast', - ], - 'description' => '', + 'description' => 'The detailed content.', 'type' => 'object', + 'additionalProperties' => ['description' => '详细内容。', 'type' => 'string', 'example' => 'cast', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'EndTime' => [ - 'description' => '', - 'example' => '0.6', - 'format' => 'float', - 'type' => 'number', - ], - 'StartTime' => [ - 'description' => '', - 'example' => '0.6', - 'format' => 'float', - 'type' => 'number', - ], + 'EndTime' => ['description' => 'The end timestamp of the video frame. Unit: seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0.6', 'title' => ''], + 'StartTime' => ['description' => 'The end timestamp of the video frame. Unit: seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0.6', 'title' => ''], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], - 'type' => 'array', - ], - 'OcrResultsUrl' => [ - 'description' => '', - 'example' => 'http://vibktprfx-prod-prod-media-ai-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-ocr/1665475907_bGHMygKsFw.json?Expires=1665477707&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=6KQb9OXQldsg30w%2FNurHwAbjiJs%3D', - 'type' => 'string', - ], - 'OcrVideoResultsUrl' => [ - 'description' => '', - 'example' => 'http://vibktprfx-prod-prod-media-ai-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-ocr/1665475907_VSRvetTHon.json?Expires=1665477707&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=wfQviVVSyVRLPVlHDKXi6cTefHY%3D', - 'type' => 'string', + 'title' => '', + 'example' => '', ], + 'OcrResultsUrl' => ['description' => 'The detailed and complete content of OcrResults, which contains the recognition results at 3 frames per second.'."\n" + .'> This field is deprecated and returns an empty value.', 'type' => 'string', 'example' => 'http://vibktprfx-prod-prod-media-ai-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-ocr/1665475907_bGHMygKsFw.json?Expires=1665477707&OSSAccessKeyId=LTAI****************&Signature=6KQb9OXQldsg30w%2FNurHwAbjiJs%3D', 'title' => ''], + 'OcrVideoResultsUrl' => ['description' => 'The detailed and complete content of OcrVideoResults.'."\n" + .'> This field is deprecated and returns an empty value.', 'type' => 'string', 'example' => 'http://vibktprfx-prod-prod-media-ai-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-ocr/1665475907_VSRvetTHon.json?Expires=1665477707&OSSAccessKeyId=LTAI****************&Signature=wfQviVVSyVRLPVlHDKXi6cTefHY%3D', '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' => 'Schema of Response', - 'type' => 'object', + '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\\": \\"EE5B1A95-064F-1C5E-A6FE-FEE0D734A632\\",\\n \\"Data\\": {\\n \\"OcrResults\\": [\\n {\\n \\"DetailInfo\\": [\\n {\\n \\"Boxes\\": [\\n 0\\n ],\\n \\"CharProbs\\": [\\n [\\n 0.9405716061592102\\n ]\\n ],\\n \\"FrameIndex\\": 17,\\n \\"Position\\": [\\n {\\n \\"X\\": 266,\\n \\"Y\\": 440\\n }\\n ],\\n \\"Score\\": 92.07685702563117,\\n \\"TextProb\\": 0.9207685702563116,\\n \\"TimeStamp\\": 0.28,\\n \\"TrackId\\": 1,\\n \\"Text\\": \\"总策划\\"\\n }\\n ],\\n \\"EndTime\\": 0.28,\\n \\"StartTime\\": 0.28\\n }\\n ],\\n \\"VideoOcrResults\\": [\\n {\\n \\"DetailInfo\\": [\\n {\\n \\"Boxes\\": [\\n 0\\n ],\\n \\"Position\\": [\\n {\\n \\"X\\": 269,\\n \\"Y\\": 423\\n }\\n ],\\n \\"Score\\": 92.07685702563117,\\n \\"Text\\": \\"总顾问\\",\\n \\"TextType\\": 0\\n }\\n ],\\n \\"EndTime\\": 0.92,\\n \\"StartTime\\": 0.92\\n }\\n ],\\n \\"SubtitlesResults\\": [\\n {\\n \\"SubtitlesAllResults\\": {\\n \\"key\\": \\"[]\\"\\n },\\n \\"SubtitlesAllResultsUrl\\": \\"url\\",\\n \\"SubtitlesChineseResults\\": {\\n \\"key\\": \\"你好\\"\\n },\\n \\"SubtitlesChineseResultsUrl\\": \\"url1\\",\\n \\"SubtitlesEnglishResults\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SubtitlesEnglishResultsUrl\\": \\"url2\\"\\n }\\n ],\\n \\"CastResults\\": [\\n {\\n \\"DetailInfo\\": {\\n \\"key\\": \\"cast\\"\\n },\\n \\"EndTime\\": 0.6,\\n \\"StartTime\\": 0.6\\n }\\n ],\\n \\"OcrResultsUrl\\": \\"http://vibktprfx-prod-prod-media-ai-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-ocr/1665475907_bGHMygKsFw.json?Expires=1665477707&OSSAccessKeyId=LTAI****************&Signature=6KQb9OXQldsg30w%2FNurHwAbjiJs%3D\\",\\n \\"OcrVideoResultsUrl\\": \\"http://vibktprfx-prod-prod-media-ai-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-ocr/1665475907_VSRvetTHon.json?Expires=1665477707&OSSAccessKeyId=LTAI****************&Signature=wfQviVVSyVRLPVlHDKXi6cTefHY%3D\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","type":"json"}]', + 'title' => 'Video OCR', + 'description' => '## Feature description'."\n" + .'The video OCR feature recognizes text in videos across various scenarios, including news, movies, TV series, entertainment, and sports. It supports recognition of Chinese and English text, traditional and simplified Chinese characters, and scoreboards. The feature handles multiple text types such as regular subtitles, static subtitles, scrolling subtitles, partial natural scene text, vertical text, and artistic text.'."\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=videorecog&children=RecognizeVideoCastCrewList) 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" + .'- Movie and TV subtitle recognition: Recognizes dubbing subtitles in long-form videos such as movies and TV series, including UNIX timestamps and corresponding text content. This enables use cases such as external subtitle generation and sensitive content review.'."\n" + .'- Cast and crew list recognition: Recognizes cast and crew information from end-credit scrolling subtitles in movies and TV series. This is useful for video information verification and sensitive person lookup.'."\n" + .'- Sports text recognition: Recognizes text content in sports event scenarios, including scores and advertisement text. This enables use cases such as game status analysis and advertisement monitoring.'."\n" + ."\n" + .'## Advantages'."\n" + ."\n" + .'- Wide video type coverage: Supports various video types.'."\n" + .'- Multiple text type support: Supports regular subtitles, static subtitles, scrolling subtitles, partial natural scene text, vertical text, and artistic text.'."\n" + .'- High recognition accuracy: Delivers high recognition accuracy for low-resolution and complex scenarios.'."\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 that you have activated the [Video Understanding service](https://vision.aliyun.com/videorecog). If you have not activated the service, [activate it now](https://common-buy.aliyun.com/?commodityCode=viapi_videorecog_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, 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/videorecog/2020-03-20/RecognizeVideoCastCrewList?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 the SDK package for the Video Understanding (videorecog) 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 languages for this feature, see [Video OCR sample code](~~477832~~). For sample code to query asynchronous task results in common languages, see [Query asynchronous task result 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 formats: AVI, FLV, MKV, MPG, MP4, TS, MOV, and MXF.'."\n" + .'- Encoding formats: MPEG-2, MPEG-4, H.264, and H.265/HEVC.'."\n" + .'- Video size: up to 10 GB.'."\n" + .'- Video resolution: 240P or higher.'."\n" + .'- The URL cannot contain Chinese characters.'."\n" + .'- The recommended video length is 30 minutes or less. Longer videos may cause processing timeout errors.'."\n" + ."\n" + .'## Billable methods'."\n" + .'For information about the billable methods and pricing of video OCR, see [Billing overview](~~202485~~).'."\n" + ."\n" + .'> The debugging operation below is a paid operation.'."\n" + ."\n" + .'## Call procedure'."\n" + .'This is an asynchronous operation that requires two steps.'."\n" + .'Step 1: Call the RecognizeVideoCastCrewList 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 and then query again.', + '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](~~607824~~).'."\n" + ."\n" + .'## SDK reference'."\n" + .'For the video OCR feature under the Alibaba Cloud Vision AI Video Understanding category, we recommend using the SDK. The SDK supports multiple programming languages. Select the SDK package for the Video Understanding (videorecog) AI category. File parameters support both 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 common languages for this feature, see [Video OCR sample code](~~477832~~). 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 OCR, see [Common error codes](~~159312~~).'."\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:07:20.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-10-12T01:52:43.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-29T08:01:40.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-27T09:42:20.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-06-28T06:39:56.000Z', 'description' => 'OpenAPI offline'], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videorecog:RecognizeVideoCastCrewList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE5B1A95-064F-1C5E-A6FE-FEE0D734A632\\",\\n \\"Data\\": {\\n \\"OcrResults\\": [\\n {\\n \\"DetailInfo\\": [\\n {\\n \\"Boxes\\": [\\n 0\\n ],\\n \\"CharProbs\\": [\\n [\\n 0.9405716061592102\\n ]\\n ],\\n \\"FrameIndex\\": 17,\\n \\"Position\\": [\\n {\\n \\"X\\": 266,\\n \\"Y\\": 440\\n }\\n ],\\n \\"Score\\": 92.07685702563117,\\n \\"TextProb\\": 0.9207685702563116,\\n \\"TimeStamp\\": 0.28,\\n \\"TrackId\\": 1,\\n \\"Text\\": \\"总策划\\"\\n }\\n ],\\n \\"EndTime\\": 0.28,\\n \\"StartTime\\": 0.28\\n }\\n ],\\n \\"VideoOcrResults\\": [\\n {\\n \\"DetailInfo\\": [\\n {\\n \\"Boxes\\": [\\n 0\\n ],\\n \\"Position\\": [\\n {\\n \\"X\\": 269,\\n \\"Y\\": 423\\n }\\n ],\\n \\"Score\\": 92.07685702563117,\\n \\"Text\\": \\"总顾问\\",\\n \\"TextType\\": 0\\n }\\n ],\\n \\"EndTime\\": 0.92,\\n \\"StartTime\\": 0.92\\n }\\n ],\\n \\"SubtitlesResults\\": [\\n {\\n \\"SubtitlesAllResults\\": {\\n \\"key\\": \\"[]\\"\\n },\\n \\"SubtitlesAllResultsUrl\\": \\"url\\",\\n \\"SubtitlesChineseResults\\": {\\n \\"key\\": \\"你好\\"\\n },\\n \\"SubtitlesChineseResultsUrl\\": \\"url1\\",\\n \\"SubtitlesEnglishResults\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SubtitlesEnglishResultsUrl\\": \\"url2\\"\\n }\\n ],\\n \\"CastResults\\": [\\n {\\n \\"DetailInfo\\": {\\n \\"key\\": \\"cast\\"\\n },\\n \\"EndTime\\": 0.6,\\n \\"StartTime\\": 0.6\\n }\\n ],\\n \\"OcrResultsUrl\\": \\"http://vibktprfx-prod-prod-media-ai-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-ocr/1665475907_bGHMygKsFw.json?Expires=1665477707&OSSAccessKeyId=LTAI****************&Signature=6KQb9OXQldsg30w%2FNurHwAbjiJs%3D\\",\\n \\"OcrVideoResultsUrl\\": \\"http://vibktprfx-prod-prod-media-ai-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-ocr/1665475907_VSRvetTHon.json?Expires=1665477707&OSSAccessKeyId=LTAI****************&Signature=wfQviVVSyVRLPVlHDKXi6cTefHY%3D\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","errorExample":""},{"type":"xml","example":"<RecognizeVideoCastCrewListResponse>\\n <RequestId>EE5B1A95-064F-1C5E-A6FE-FEE0D734A632</RequestId>\\n <Data>\\n <OcrResults>\\n <DetailInfo>\\n <CharProbs>\\n <0>0.9405716</0>\\n </CharProbs>\\n <FrameIndex>17</FrameIndex>\\n <Position>\\n <X>266</X>\\n <Y>440</Y>\\n </Position>\\n <Score>92.07686</Score>\\n <TextProb>0.92076856</TextProb>\\n <TimeStamp>0.28</TimeStamp>\\n <TrackId>1</TrackId>\\n <Text>总策划</Text>\\n </DetailInfo>\\n <EndTime>0.28</EndTime>\\n <StartTime>0.28</StartTime>\\n </OcrResults>\\n <VideoOcrResults>\\n <DetailInfo>\\n <Position>\\n <X>269</X>\\n <Y>423</Y>\\n </Position>\\n <Score>92.07686</Score>\\n <Text>总顾问</Text>\\n <TextType>0</TextType>\\n </DetailInfo>\\n <EndTime>0.92</EndTime>\\n <StartTime>0.92</StartTime>\\n </VideoOcrResults>\\n <SubtitlesResults>\\n <SubtitlesAllResults>\\n <key>[]</key>\\n </SubtitlesAllResults>\\n <SubtitlesAllResultsUrl>url</SubtitlesAllResultsUrl>\\n <SubtitlesChineseResults>\\n <key>你好</key>\\n </SubtitlesChineseResults>\\n <SubtitlesChineseResultsUrl>url1</SubtitlesChineseResultsUrl>\\n <SubtitlesEnglishResultsUrl>url2</SubtitlesEnglishResultsUrl>\\n </SubtitlesResults>\\n <CastResults>\\n <DetailInfo>\\n <key>cast</key>\\n </DetailInfo>\\n <EndTime>0.6</EndTime>\\n <StartTime>0.6</StartTime>\\n </CastResults>\\n <OcrResultsUrl>http://vibktprfx-prod-prod-media-ai-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-ocr/1665475907_bGHMygKsFw.json?Expires=1665477707&OSSAccessKeyId=LTAI****************&Signature=6KQb9OXQldsg30w%2FNurHwAbjiJs%3D</OcrResultsUrl>\\n <OcrVideoResultsUrl>http://vibktprfx-prod-prod-media-ai-cn-shanghai.oss-cn-shanghai.aliyuncs.com/video-ocr/1665475907_VSRvetTHon.json?Expires=1665477707&OSSAccessKeyId=LTAI****************&Signature=wfQviVVSyVRLPVlHDKXi6cTefHY%3D</OcrVideoResultsUrl>\\n </Data>\\n <Message>该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。</Message>\\n</RecognizeVideoCastCrewListResponse>","errorExample":""}]', ], 'SplitVideoParts' => [ - 'summary' => '视频拆条', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'This topic describes the syntax and provides examples of the SplitVideoParts operation for video splitting.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -758,419 +1033,408 @@ [ 'name' => 'VideoUrl', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'https://viapi-test.oss-cn-shanghai.aliyuncs.com/test-team/ocr/xxxx.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 the OSS URL is not in 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-team/ocr/xxxx.mp4', 'title' => ''], ], [ 'name' => 'Template', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The splitting template. Currently, only the `live` template is supported.', 'type' => 'string', 'required' => false, 'example' => 'live', 'title' => ''], ], [ 'name' => 'MinTime', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['description' => 'The minimum length of a split segment, in seconds. Configure this parameter based on your business requirements, or leave it empty.'."\n" + .'> This parameter takes effect only on the SplitVideoPartResults (topic-based splitting) results and does not affect the Elements (shot transition-based) results.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'MaxTime', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['description' => 'The maximum length of a split segment, in seconds. Configure this parameter based on your business requirements, or leave it empty.'."\n" + .'> This parameter takes effect only on the SplitVideoPartResults (topic-based splitting) results and does not affect the Elements (shot transition-based) results.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', 'description' => 'Schema of Response', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'A00A3C17-61D5-1489-860D-B709F83A7C40', - 'title' => 'Id of the request', - 'type' => 'string', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A00A3C17-61D5-1489-860D-B709F83A7C40'], 'Data' => [ - 'description' => '', + 'description' => 'The returned 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.', + 'type' => 'object', 'properties' => [ 'Elements' => [ + 'description' => 'The splitting results based on the video shot transition dimension.', + 'type' => 'array', 'items' => [ + 'description' => 'The splitting results based on the video shot transition dimension.', + 'type' => 'object', 'properties' => [ - 'BeginTime' => [ - 'description' => '', - 'example' => '10.06', - 'format' => 'float', - 'type' => 'number', - ], - 'EndTime' => [ - 'description' => '', - 'example' => '17.3', - 'format' => 'float', - 'type' => 'number', - ], - 'Index' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'type' => 'integer', - ], + 'BeginTime' => ['description' => 'The start time of the segment. Unit: seconds.', 'type' => 'number', 'format' => 'float', 'example' => '10.06', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the segment. Unit: seconds.', 'type' => 'number', 'format' => 'float', 'example' => '17.3', 'title' => ''], + 'Index' => ['description' => 'The sequence number of the segment.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], - 'type' => 'array', + 'title' => '', + 'example' => '', ], 'SplitVideoPartResults' => [ + 'description' => 'The splitting results based on the video topic dimension.', 'type' => 'array', 'items' => [ + 'description' => 'The video splitting results.', 'type' => 'object', 'properties' => [ - 'BeginTime' => [ - 'type' => 'number', - 'format' => 'float', - ], - 'EndTime' => [ - 'type' => 'number', - 'format' => 'float', - ], - 'Theme' => [ - 'type' => 'string', - ], - 'Type' => [ - 'type' => 'string', - ], - 'By' => [ - 'type' => 'string', - ], + 'BeginTime' => ['description' => 'The start time of the split segment.', 'type' => 'number', 'format' => 'float', 'example' => '0.33', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the split segment.', 'type' => 'number', 'format' => 'float', 'example' => '6.3', 'title' => ''], + 'Theme' => ['description' => 'The topic of the split segment.', 'type' => 'string', 'example' => 'you like to do my work in the world.', 'title' => ''], + 'Type' => ['description' => 'The type of the split segment. For e-commerce live streaming scenarios, only the default value `Live streaming` is returned.', 'type' => 'string', 'example' => '直播', 'title' => ''], + 'By' => ['description' => 'The algorithm used for splitting.', 'type' => 'string', 'example' => 'multimodal', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - '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' => 'Schema of Response', - 'type' => 'object', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A00A3C17-61D5-1489-860D-B709F83A7C40\\",\\n \\"Data\\": {\\n \\"Elements\\": [\\n {\\n \\"BeginTime\\": 10.06,\\n \\"EndTime\\": 17.3,\\n \\"Index\\": 1\\n }\\n ],\\n \\"SplitVideoPartResults\\": [\\n {\\n \\"BeginTime\\": 0.33,\\n \\"EndTime\\": 6.3,\\n \\"Theme\\": \\"you like to do my work in the world.\\",\\n \\"Type\\": \\"直播\\",\\n \\"By\\": \\"multimodal\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","errorExample":""},{"type":"xml","example":"<SplitVideoPartsResponse>\\n <RequestId>A00A3C17-61D5-1489-860D-B709F83A7C40</RequestId>\\n <Message>该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。</Message>\\n</SplitVideoPartsResponse>","errorExample":""}]', - ], - 'EvaluateVideoQuality' => [ - 'summary' => '视频质量评估', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A00A3C17-61D5-1489-860D-B709F83A7C40\\",\\n \\"Data\\": {\\n \\"Elements\\": [\\n {\\n \\"BeginTime\\": 10.06,\\n \\"EndTime\\": 17.3,\\n \\"Index\\": 1\\n }\\n ],\\n \\"SplitVideoPartResults\\": [\\n {\\n \\"BeginTime\\": 0.33,\\n \\"EndTime\\": 6.3,\\n \\"Theme\\": \\"you like to do my work in the world.\\",\\n \\"Type\\": \\"直播\\",\\n \\"By\\": \\"multimodal\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","type":"json"}]', + 'title' => 'Video splitting', + 'description' => '## Feature description'."\n" + .'The video splitting feature analyzes and understands videos across multiple dimensions, splits videos into multiple segments, and returns the boundary timestamps of each segment (without returning the actual video segments). It also generates summary descriptions for each segment. The splitting dimensions include shots and topics.'."\n" + ."\n" + .'> - You can join [online consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) to get 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?spm=a2cvz.27764832.J_7524944390.8.5f1250b5aWPQQw&tagName=videorecog&children=SplitVideoParts) to experience this feature and make online purchases.'."\n" + .'- To connect to, use, or consult about the visual AI APIs on the Alibaba Cloud Vision Intelligence Open Platform, join the DingTalk group (23109592) to contact us.'."\n" + ."\n" + .'## Common scenarios'."\n" + .'Film and media content production: Supports intelligent information analysis and segment splitting for film and media videos. This feature is active for scenarios such as full-segment splitting and distribution of long videos, quick-editing material generation, and video clip production.'."\n" + ."\n" + .'## Advantages'."\n" + ."\n" + .'- Multi-dimensional information extraction: Supports information extraction across multiple dimensions and splits videos into segments based on the extracted information.'."\n" + .'- Fine-grained splitting: Supports second-level or frame-level splitting of materials.'."\n" + .'- Segment summary: Generates summary descriptions for split segments.'."\n" + ."\n" + .'## Getting started'."\n" + .'1. Create an Alibaba Cloud account: Go to the [Alibaba Cloud official website](https://www.aliyun.com). In the upper-right corner, click **Register Now** and follow the instructions to create an account.'."\n" + .'2. Activate the service: Make sure that you have activated the [Video Understanding service](https://vision.aliyun.com/videorecog). If you have not activated the service, [activate it now](https://common-buy.aliyun.com/?commodityCode=viapi_videorecog_public_cn#/open).'."\n" + .'3. Create an AccessKey pair: Make sure that you have [created an AccessKey pair](~~175144~~). If you are using an AccessKey pair of a RAM user, 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/videorecog/2020-03-20/SplitVideoParts?lang=JAVA) 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 that you want to use from [SDK overview](~~145033~~).'."\n" + .'- Find the SDK package for the Video Understanding (videorecog) category in the corresponding SDK documentation and install it.'."\n" + .'- Modify the sample code provided in the documentation as needed and invoke the operation.'."\n" + ."\n" + .'6. Sample code: For sample code in common programming languages for this feature, see [Video splitting sample code](~~2261132~~). For sample code in common programming languages for querying asynchronous task results, see [Query asynchronous task result 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" + .'- Video format: AVI, FLV, MKV, MPG, MP4, TS, MOV, or MXF.'."\n" + .'- Video size: Less than 4 GB.'."\n" + .'- Video duration: Up to 3 hours.'."\n" + .'- Video resolution: Greater than or equal to 240P and less than or equal to 1440P.'."\n" + .'- The URL cannot contain Chinese characters.'."\n" + ."\n" + .'## Billable methods'."\n" + .'For information about the billable methods and pricing of video splitting, see [Billing overview](~~202485~~).'."\n" + ."\n" + .'> The debugging operation below is a paid operation.'."\n" + ."\n" + .'## Call steps'."\n" + .'This is an asynchronous operation that requires two steps.'."\n" + .'Step 1: Call the SplitVideoParts 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 then query again.', + 'responseParamsDescription' => '## Query results'."\n" + .'This is an asynchronous operation that does not return actual results. Call the GetAsyncJobResult operation with the returned RequestId to obtain the actual results. For more information, see [GetAsyncJobResult](~~607824~~).'."\n" + ."\n" + .'## SDK reference'."\n" + .'To use the video splitting feature under the Visual AI Video Understanding category, we recommend that you use the SDK. Multiple programming languages are supported. Select the SDK package for the Video Understanding (videorecog) 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 [Video splitting sample code](~~2261132~~). For sample code in common programming languages for querying asynchronous task results, see [Query asynchronous task results sample code](~~607974~~).', + 'extraInfo' => '## Error codes'."\n" + .'For error codes of the video splitting feature, see [Common error codes](~~159312~~).'."\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' => '2023-03-14T02:32:18.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-10-17T02:07:20.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-05-13T02:14:26.000Z', 'description' => 'OpenAPI offline'], ], - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'VideoUrl', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'http://public-vigen-video.oss-cn-shanghai.aliyuncs.com/Common/xxx/dont_delete/decaption/123.mp4', - 'isFileTransferUrl' => true, - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'Mode', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'vqa_plus', - 'required' => false, - 'type' => 'string', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'description' => 'Schema of Response', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '1d33e538-c949-4fcd-83f6-4d57e4b31527', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'properties' => [ - 'JsonUrl' => [ - 'description' => '', - 'example' => 'http://vibktprfx-prod-prod-damo-eas-cn-shanghai.oss-cn-shanghai.aliyuncs.com/eas-video-quality-assessment/2023-01-13-10/31%3A08-cVeN9ZQlzIPfGqsa.json?Expires=1673578869&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=AiSsOsZ7rYfhf9w3Mxn%2Fq4GKKy****', - 'type' => 'string', - ], - 'PdfUrl' => [ - 'description' => '', - 'example' => 'http://vibktprfx-prod-prod-damo-eas-cn-shanghai.oss-cn-shanghai.aliyuncs.com/eas-video-quality-assessment/2023-01-13-10/31%3A08-cVeN9ZQlzIPfGqsa.pdf?Expires=1673578869&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=xULlZzVuhoYWAXRbp9A4EzzZcS****', - 'type' => 'string', - ], - 'VideoQualityInfo' => [ - 'description' => '', - 'properties' => [ - 'CompressiveStrength' => [ - 'description' => '', - 'example' => '0.25', - 'format' => 'float', - 'type' => 'number', - ], - 'NoiseIntensity' => [ - 'description' => '', - 'example' => '0.01', - 'format' => 'float', - 'type' => 'number', - ], - 'Blurriness' => [ - 'description' => '', - 'example' => '0.15', - 'format' => 'float', - 'type' => 'number', - ], - 'ColorContrast' => [ - 'description' => '', - 'example' => '0.55', - 'format' => 'float', - 'type' => 'number', - ], - 'ColorSaturation' => [ - 'description' => '', - 'example' => '0.17', - 'format' => 'float', - 'type' => 'number', - ], - 'Luminance' => [ - 'description' => '', - 'example' => '0.51', - 'format' => 'float', - 'type' => 'number', - ], - 'Colorfulness' => [ - 'description' => '', - 'example' => '0.48', - 'format' => 'float', - 'type' => 'number', - ], - 'MosScore' => [ - 'description' => '', - 'example' => '0.7048', - 'format' => 'float', - 'type' => 'number', - ], - ], - 'type' => 'object', - ], - ], - 'type' => 'object', - ], - 'Message' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videorecog:SplitVideoParts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'title' => 'Schema of Response', - '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.', - ], - ], + ], + ], + 'endpoints' => [ + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'videorecog.cn-shanghai.aliyuncs.com', 'endpoint' => 'videorecog.cn-shanghai.aliyuncs.com', 'vpc' => 'videorecog-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' => 403, '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' => 403, '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_videorecog_public_cn#/open', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidApi.OutOfService', 'message' => '产品未开通，请开通产品：https://common-buy.aliyun.com/?commodityCode=viapi_videorecog_public_cn#/open', 'http_code' => 421, 'description' => ''], + ['code' => 'InvalidFile.Category', 'message' => 'Invalid file category.', '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' => '图片下载超时，请检查链接是否可访问和本地网络情况', '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' => 'Invalid format.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidParameter.NotFound', 'message' => 'Invalid parameter value.', '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' => 403, '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' => 'The timestamp has expired. Please update the timestamp', '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' => 'Request parameters changed, Response parameters changed', 'api' => 'SplitVideoParts'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'createdAt' => '2023-03-24T08:22:54.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'RecognizeVideoCastCrewList'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1d33e538-c949-4fcd-83f6-4d57e4b31527\\",\\n \\"Data\\": {\\n \\"JsonUrl\\": \\"http://vibktprfx-prod-prod-damo-eas-cn-shanghai.oss-cn-shanghai.aliyuncs.com/eas-video-quality-assessment/2023-01-13-10/31%3A08-cVeN9ZQlzIPfGqsa.json?Expires=1673578869&OSSAccessKeyId=LTAI****************&Signature=AiSsOsZ7rYfhf9w3Mxn%2Fq4GKKy****\\",\\n \\"PdfUrl\\": \\"http://vibktprfx-prod-prod-damo-eas-cn-shanghai.oss-cn-shanghai.aliyuncs.com/eas-video-quality-assessment/2023-01-13-10/31%3A08-cVeN9ZQlzIPfGqsa.pdf?Expires=1673578869&OSSAccessKeyId=LTAI****************&Signature=xULlZzVuhoYWAXRbp9A4EzzZcS****\\",\\n \\"VideoQualityInfo\\": {\\n \\"CompressiveStrength\\": 0.25,\\n \\"NoiseIntensity\\": 0.01,\\n \\"Blurriness\\": 0.15,\\n \\"ColorContrast\\": 0.55,\\n \\"ColorSaturation\\": 0.17,\\n \\"Luminance\\": 0.51,\\n \\"Colorfulness\\": 0.48,\\n \\"MosScore\\": 0.7048\\n }\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","errorExample":""},{"type":"xml","example":"<EvaluateVideoQualityResponse>\\n <RequestId>1d33e538-c949-4fcd-83f6-4d57e4b31527</RequestId>\\n <Message>该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。</Message>\\n</EvaluateVideoQualityResponse>","errorExample":""}]', + 'createdAt' => '2022-10-17T02:12:05.000Z', + 'description' => '首次发布上线', ], - 'GetAsyncJobResult' => [ - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DetectVideoShot'], + ['description' => 'Response parameters changed', 'api' => 'GenerateVideoCover'], + ['description' => 'Response parameters changed', 'api' => 'RecognizeVideoCastCrewList'], + ['description' => 'Response parameters changed', 'api' => 'SplitVideoParts'], + ['description' => 'Response parameters changed', 'api' => 'UnderstandVideoContent'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2022-10-17T02:07:32.000Z', + 'description' => '修改异步任务Message为可见', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'RecognizeVideoCastCrewList'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-10-12T01:52:52.000Z', + 'description' => '新增出参参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'RecognizeVideoCastCrewList'], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + 'createdAt' => '2022-09-29T08:01:47.000Z', + 'description' => '多url参数支持本地文件上传', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'RecognizeVideoCastCrewList'], + ], + 'createdAt' => '2022-09-27T09:42:25.000Z', + 'description' => '修改obj为可见', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'SplitVideoParts'], + ], + 'createdAt' => '2022-05-13T03:10:01.000Z', + 'description' => '首次发布', + ], + ], + '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' => 'GetAsyncJobResult', + 'description' => '', 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'viapi-videorecog:GetAsyncJobResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'JobId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'E75FE679-0303-4DD1-8252-1143B4FA8A27', - 'required' => true, - 'type' => 'string', + [ + 'apiName' => 'SplitVideoParts', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videorecog:SplitVideoParts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '1', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'A1F44EC4-118D-4A03-B213-F908F36F7DAA', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'example' => 'PROCESS_SUCCESS', - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'description' => '', - 'example' => 'paramsIllegal', - 'type' => 'string', - ], - 'Result' => [ - 'description' => '', - 'example' => '{\\"Outputs\\":[{\\"ImageURL\\":\\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-cover/2020-03-25-11/pic_4t7zW6R6SUGn4DLF.mp4_2375_1920_1080_96ce5a96b5b16628cd778c035b68356d_beautified.png?Expires=1585136160&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=MDd7BqbivlLRd16MTKbPFQHV3u****\\",\\"Confidence\\":8.426481079120514},{\\"ImageURL\\":\\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-cover/2020-03-25-11/pic_4t7zW6R6SUGn4DLF.mp4_2996_1920_1080_d5df0556bf420242c84fe6f7a45d01e1_beautified.png?Expires=1585136160&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=htaW5G%2BpqPBW%2BEMTe01ckVoGsQ****\\",\\"Confidence\\":6.225726566341124}]}', - 'type' => 'string', - ], - 'ErrorCode' => [ - 'description' => '', - 'example' => 'InvalidParameter', - 'type' => 'string', - ], - 'JobId' => [ - 'description' => '', - 'example' => '7DFDA846-178B-4ADB-B69A-62C641214D81', - 'type' => 'string', - ], - ], - 'type' => 'object', - ], - ], - 'type' => 'object', + [ + 'apiName' => 'EvaluateVideoQuality', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videorecog:EvaluateVideoQuality', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'The parameter is invalid. Please check again.', + [ + 'apiName' => 'GenerateVideoCover', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videorecog:GenerateVideoCover', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'AuthFailed', - 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.', + ], + [ + 'apiName' => 'DetectVideoShot', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videorecog:DetectVideoShot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 408 => [ - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'The request has timed out.', + ], + [ + 'apiName' => 'UnderstandVideoContent', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videorecog:UnderstandVideoContent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'The service is unavailable.', + ], + [ + 'apiName' => 'RecognizeVideoCastCrewList', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videorecog:RecognizeVideoCastCrewList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0E448D84-1736-1BCD-BEA5-866C413515A1\\",\\n \\"Data\\": {\\n \\"Status\\": \\"PROCESS_SUCCESS\\",\\n \\"ErrorMessage\\": \\"paramsIllegal\\",\\n \\"Result\\": \\"\\\\\\"{\\\\\\\\\\\\\\"jsonUrl\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"http://vibktprfx-prod-prod-damo-eas-cn-shanghai.oss-cn-shanghai.aliyuncs.com/eas-video-quality-assessment/2023-01-11-16/01%3A52-crxCR763VXTeY0bP.json?Expires=1673425915&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=iW07EIZaqaiMNoF3RJZwsLVxOx****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pdfUrl\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"http://vibktprfx-prod-prod-damo-eas-cn-shanghai.oss-cn-shanghai.aliyuncs.com/eas-video-quality-assessment/2023-01-11-16/01%3A52-crxCR763VXTeY0bP.pdf?Expires=1673425916&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=BvZ3ayeTTxaR65ZvQ2%2FoE8W8Lr****\\\\\\\\\\\\\\"}\\\\\\"\\",\\n \\"ErrorCode\\": \\"InvalidParameter\\",\\n \\"JobId\\": \\"A421D5F0-4F73-19F5-8D92-D509FAD281D2\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetAsyncJobResultResponse>\\n <RequestId>0E448D84-1736-1BCD-BEA5-866C413515A1</RequestId>\\n <Data>\\n <Status>PROCESS_SUCCESS</Status>\\n <JobId>A421D5F0-4F73-19F5-8D92-D509FAD281D2</JobId>\\n <Result>{\\"jsonUrl\\":\\"http://vibktprfx-prod-prod-damo-eas-cn-shanghai.oss-cn-shanghai.aliyuncs.com/eas-video-quality-assessment/2023-01-11-16/01%3A52-crxCR763VXTeY0bP.json?Expires=1673425915&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=iW07EIZaqaiMNoF3RJZwsLVxOx****\\",\\"pdfUrl\\":\\"http://vibktprfx-prod-prod-damo-eas-cn-shanghai.oss-cn-shanghai.aliyuncs.com/eas-video-quality-assessment/2023-01-11-16/01%3A52-crxCR763VXTeY0bP.pdf?Expires=1673425916&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=BvZ3ayeTTxaR65ZvQ2%2FoE8W8Lr****\\"}</Result>\\n </Data>\\n</GetAsyncJobResultResponse>","errorExample":""}]', - 'requestParamsDescription' => ' ', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'videorecog.cn-shanghai.aliyuncs.com', ], + 'resourceTypes' => [], ], ]; |