path: root/data/en_us/eduinterpreting/2024-08-28/api-docs.php

<?php return [
    'version' => '1.0',
    'info' => [
        'style' => 'RPC',
        'product' => 'EduInterpreting',
        'version' => '2024-08-28',
    ],
    'directories' => [
        'RecognizeAudio',
        'SubmitEvaluationTask',
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'RecognizeAudio' => [
            'summary' => '英语口译语音文件识别成英文内容',
            'methods' => [
                'post',
            ],
            'schemes' => [
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'write',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'create',
                'riskType' => 'none',
                'chargeType' => 'paid',
                'abilityTreeNodes' => [
                    'FEATUREeduplatformS8LARQ',
                ],
                'tenantRelevance' => 'publicInformation',
            ],
            'parameters' => [
                [
                    'name' => 'AudioFileUrl',
                    'in' => 'formData',
                    'schema' => [
                        'title' => '公网读取的音频文件url',
                        'description' => '',
                        'type' => 'string',
                        'required' => true,
                        'example' => 'http://xx.com/abc.mp3',
                    ],
                ],
                [
                    'name' => 'OuterBizId',
                    'in' => 'formData',
                    'schema' => [
                        'title' => '调用方定义的对本次调用的唯一业务id, 回调时将带上该字段数据和评测结果一并返回, 调用方需要保证该id全局唯一, 且可定位到自身的asr任务. 同时该字段用于幂等控制',
                        'description' => '',
                        'type' => 'string',
                        'required' => true,
                        'example' => '433c1361-0f6e-48fc-ad51',
                    ],
                ],
                [
                    'name' => 'CallbackUrl',
                    'in' => 'formData',
                    'schema' => [
                        'title' => 'asr结果的回调地址. 调用方需按照"ASR任务回调接口的模版"的数据结构准备好回调接口',
                        'description' => '',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'https://abc.edu.org.cn/en/callback'."\n",
                    ],
                ],
                [
                    'name' => 'EnableCallBack',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'type' => 'boolean',
                        'required' => true,
                        'example' => 'true',
                    ],
                ],
                [
                    'name' => 'Language',
                    'in' => 'formData',
                    'schema' => [
                        'title' => 'ZH:中文'."\n"
                            .'EN:英文',
                        'type' => 'string',
                        'example' => 'ZH',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => 'AsrResultPopDTO',
                        'description' => 'AsrResultPopDTO',
                        'type' => 'object',
                        'properties' => [
                            'ItemList' => [
                                'description' => '',
                                'type' => 'array',
                                'items' => [
                                    'type' => 'object',
                                    'properties' => [
                                        'BeginTime' => [
                                            'description' => '',
                                            'type' => 'string',
                                            'example' => '0',
                                        ],
                                        'EndTime' => [
                                            'description' => '',
                                            'type' => 'string',
                                            'example' => '1230',
                                        ],
                                        'Text' => [
                                            'description' => '',
                                            'type' => 'string',
                                            'example' => 'How are you',
                                        ],
                                    ],
                                ],
                            ],
                            'RequestId' => [
                                'description' => '',
                                'type' => 'string',
                                'example' => '38CD0881-BC7B-5ADB-A3EB-FF813927D09A',
                            ],
                            'TaskId' => [
                                'description' => '',
                                'type' => 'string',
                                'example' => '3ab5c082-2c0e-4f39-b12f-057dd5e373ff',
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                400 => [
                    [
                        'errorCode' => 'Audio.DecodeError',
                        'errorMessage' => 'Audio decoding error.',
                    ],
                    [
                        'errorCode' => 'Audio.DownloadError',
                        'errorMessage' => 'The audio file url failed to download. check that the file address is valid.',
                    ],
                    [
                        'errorCode' => 'Audio.FormatInvalid',
                        'errorMessage' => 'Audio decoding error. Currently, only wav and mp3 are supported.',
                    ],
                    [
                        'errorCode' => 'Audio.InvalidSampleRate',
                        'errorMessage' => 'Illegal audio sampling rate. Speech Recognition only supports audio with 8000 Hz and 16000 Hz sampling rate formats.',
                    ],
                    [
                        'errorCode' => 'Param.Invalid',
                        'errorMessage' => 'The specified parameter is not valid.',
                    ],
                    [
                        'errorCode' => 'Task.TimeOut',
                        'errorMessage' => 'Task execution exceeds 50s.Task timeout.',
                    ],
                ],
                403 => [
                    [
                        'errorCode' => 'ThrottlingRateQuota',
                        'errorMessage' => 'Algorithm service resource exceeds the quota limit.',
                    ],
                ],
                500 => [
                    [
                        'errorCode' => 'InternalError',
                        'errorMessage' => 'The request processing has failed due to some unknown error.',
                    ],
                ],
                503 => [
                    [
                        'errorCode' => 'ServiceUnavailable',
                        'errorMessage' => 'The request has failed due to a temporary failure of the server.',
                    ],
                ],
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"ItemList\\": [\\n    {\\n      \\"BeginTime\\": \\"0\\",\\n      \\"EndTime\\": \\"1230\\",\\n      \\"Text\\": \\"How are you\\"\\n    }\\n  ],\\n  \\"RequestId\\": \\"38CD0881-BC7B-5ADB-A3EB-FF813927D09A\\",\\n  \\"TaskId\\": \\"3ab5c082-2c0e-4f39-b12f-057dd5e373ff\\"\\n}","type":"json"}]',
        ],
        'SubmitEvaluationTask' => [
            'summary' => '口译评测任务',
            'methods' => [
                'post',
            ],
            'schemes' => [
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'write',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'create',
                'riskType' => 'none',
                'chargeType' => 'free',
                'autoTest' => true,
                'tenantRelevance' => 'publicInformation',
            ],
            'parameters' => [
                [
                    'name' => 'Type',
                    'in' => 'formData',
                    'schema' => [
                        'title' => '评测类型: EN_TO_ZH-英转中 ZH_TO_EN-中转英',
                        'description' => '',
                        'type' => 'string',
                        'required' => true,
                        'example' => 'EN_TO_ZH',
                    ],
                ],
                [
                    'name' => 'SuggestedAnswer',
                    'in' => 'formData',
                    'schema' => [
                        'title' => '标准答案',
                        'description' => '',
                        'type' => 'string',
                        'required' => true,
                        'example' => '',
                    ],
                ],
                [
                    'name' => 'Text',
                    'in' => 'formData',
                    'schema' => [
                        'title' => '待评测的回答文本',
                        'description' => '',
                        'type' => 'string',
                        'required' => true,
                        'example' => '',
                    ],
                ],
                [
                    'name' => 'MaterialText',
                    'in' => 'formData',
                    'schema' => [
                        'title' => '素材文本'."\n",
                        'description' => '',
                        'type' => 'string',
                        'required' => true,
                        'example' => 'As flame of fire we gather, as skyful of stars we scatter.'."\n",
                    ],
                ],
                [
                    'name' => 'OuterBizId',
                    'in' => 'formData',
                    'schema' => [
                        'title' => '调用方定义的对本次调用的唯一业务id, 回调时将带上该字段数据和评测结果一并返回, 调用方需要保证该id全局唯一, 且可定位到自身的评测任务.同时该字段用于幂等控制.',
                        'description' => '',
                        'type' => 'string',
                        'required' => true,
                        'example' => '433c1361-0f6e-48fc-ad51'."\n",
                    ],
                ],
                [
                    'name' => 'AudioUrl',
                    'in' => 'formData',
                    'schema' => [
                        'title' => '待评测的音频文件',
                        'description' => '',
                        'type' => 'string',
                        'required' => true,
                        'example' => 'http://xx.com/abc.mp3'."\n",
                    ],
                ],
                [
                    'name' => 'CallbackUrl',
                    'in' => 'formData',
                    'schema' => [
                        'title' => '评测结果的回调地址. 由于评测时间较长, 待完成评测后会将结果通知到该接口, 调用方需按照"评测任务回调接口的模版"的数据结构准备好回调接口',
                        'description' => '',
                        'type' => 'string',
                        'required' => true,
                        'example' => 'https://abc.edu.org.cn/en/callback'."\n",
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => 'PopEvaluationTaskResultDTO',
                        'description' => 'PopEvaluationTaskResultDTO',
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => [
                                'description' => '',
                                'type' => 'string',
                                'example' => 'BA3BB7D0-E098-5F0C-AF25-0BEFAEE7D1F0',
                            ],
                            'TaskId' => [
                                'description' => '',
                                'type' => 'string',
                                'example' => '8fb75c55-98b5-4b82-ae67-5dbb9a0646cc',
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                400 => [
                    [
                        'errorCode' => 'Param.Invalid',
                        'errorMessage' => 'The specified parameter is not valid.',
                    ],
                ],
                403 => [
                    [
                        'errorCode' => 'ThrottlingRateQuota',
                        'errorMessage' => 'Algorithm service resource exceeds the quota limit.',
                    ],
                ],
                500 => [
                    [
                        'errorCode' => 'InternalError',
                        'errorMessage' => 'The request processing has failed due to some unknown error.',
                    ],
                ],
                503 => [
                    [
                        'errorCode' => 'ServiceUnavailable',
                        'errorMessage' => 'The request has failed due to a temporary failure of the server.',
                    ],
                ],
            ],
            'staticInfo' => [
                'returnType' => 'synchronous',
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"RequestId\\": \\"BA3BB7D0-E098-5F0C-AF25-0BEFAEE7D1F0\\",\\n  \\"TaskId\\": \\"8fb75c55-98b5-4b82-ae67-5dbb9a0646cc\\"\\n}","type":"json"}]',
        ],
    ],
    'endpoints' => [
        [
            'regionId' => 'public',
            'endpoint' => 'eduinterpreting.aliyuncs.com',
        ],
    ],
];