diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/tingwu/2023-09-30/api-docs.php | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/tingwu/2023-09-30/api-docs.php')
| -rw-r--r-- | data/en_us/tingwu/2023-09-30/api-docs.php | 1991 |
1 files changed, 1008 insertions, 983 deletions
diff --git a/data/en_us/tingwu/2023-09-30/api-docs.php b/data/en_us/tingwu/2023-09-30/api-docs.php index 75bb6f2..cae2855 100644 --- a/data/en_us/tingwu/2023-09-30/api-docs.php +++ b/data/en_us/tingwu/2023-09-30/api-docs.php @@ -1,24 +1,17 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'tingwu', - 'version' => '2023-09-30', - ], + 'info' => ['style' => 'ROA', 'product' => 'tingwu', 'version' => '2023-09-30'], 'directories' => [ - 'CreateTask', 'GetTaskInfo', [ - 'id' => 187956, - 'title' => null, + 'children' => ['CreateTranscriptionPhrases', 'GetTranscriptionPhrases', 'UpdateTranscriptionPhrases', 'DeleteTranscriptionPhrases', 'ListTranscriptionPhrases'], + 'type' => 'directory', + 'title' => 'Hotwords', + ], + [ + 'children' => ['CreateTask'], + 'title' => 'Others', 'type' => 'directory', - 'children' => [ - 'CreateTranscriptionPhrases', - 'GetTranscriptionPhrases', - 'UpdateTranscriptionPhrases', - 'DeleteTranscriptionPhrases', - 'ListTranscriptionPhrases', - ], ], ], 'components' => [ @@ -26,25 +19,16 @@ ], 'apis' => [ 'CreateTask' => [ - 'summary' => '创建听悟任务', 'path' => '/openapi/tingwu/v2/tasks', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ @@ -52,38 +36,39 @@ 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeCode' => '196631', - 'abilityTreeNodes' => [ - 'FEATUREnls24C81K', - 'FEATUREnlsO1I14I', - ], + 'abilityTreeNodes' => ['FEATUREnls24C81K', 'FEATUREnlsO1I14I'], ], 'parameters' => [ [ 'name' => 'type', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The type of the task. Valid values:'."\n" + ."\n" + .'- **offline**: An offline task, such as an offline transcription.'."\n" + ."\n" + .'- **realtime**: A real-time task, such as a real-time recording.', + 'enumValueTitles' => ['offline' => 'offline', 'realtime' => 'realtime'], 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'offline' => 'offline', - 'realtime' => 'realtime', - ], 'example' => 'offline', + 'title' => '', ], ], [ 'name' => 'operation', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The operation to perform. Valid values:'."\n" + ."\n" + .'- **start**: Creates a task. This is the default value and does not typically need to be set.'."\n" + ."\n" + .'- **stop**: Stops a real-time recording task. This value is used only for real-time tasks. To end the recording, set this parameter to `stop`.', + 'enumValueTitles' => ['stop' => 'stop', 'start' => 'start'], 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'stop' => 'stop', - 'start' => 'start', - ], 'example' => 'stop', + 'required' => false, + 'title' => '', ], ], [ @@ -91,530 +76,491 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => '请求参数body', - 'description' => '', + 'title' => '', + 'description' => 'The request body parameters.', 'type' => 'object', 'properties' => [ - 'AppKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'JV1sRTisRMi****', - ], + 'AppKey' => ['description' => 'The AppKey of the project that you created in the console.', 'type' => 'string', 'required' => false, 'example' => 'JV1sRTisRMi****', 'title' => ''], 'Input' => [ - 'description' => '', + 'description' => 'The basic input parameters for creating a task. The required parameters vary based on the task type.'."\n" + ."\n" + .'- For an offline task (`type="offline"`), you must specify the `SourceLanguage` and `FileUrl` parameters.'."\n" + ."\n" + .'- For a real-time task (`type="realtime"`), you must also specify the `SourceLanguage`, `Format`, and `SampleRate` parameters.', 'type' => 'object', 'properties' => [ 'SourceLanguage' => [ - 'title' => '离线转写/实时会议使用的语言模型。'."\n" - .'cn：中文。'."\n" - .'en：英文。'."\n" - .'yue：粤语。'."\n" - .'fspk：中英文自由说。', - 'description' => '', + 'description' => 'The language model for speech transcription. The following values are supported:'."\n" + ."\n" + .'- **cn**: Chinese'."\n" + ."\n" + .'- **en**: English'."\n" + ."\n" + .'- **fspk**: Chinese-English code-switching'."\n" + ."\n" + .'- **ja**: Japanese'."\n" + ."\n" + .'- **yue**: Cantonese', + 'enumValueTitles' => ['yue' => 'Cantonese', 'fspk' => 'Chinese-English code-switching', 'en' => 'English', 'cn' => 'Chinese'], 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'yue' => 'yue', - 'fspk' => 'fspk', - 'en' => 'en', - 'cn' => 'cn', - ], + 'title' => '', 'example' => 'cn', ], - 'FileUrl' => [ - 'title' => '创建离线转写任务时，必须填写的原始音频链接，当前支持http或https形式的链接。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'http://xxx.com/zzz/1.wav', - ], - 'TaskKey' => [ - 'title' => '任务级别的自定义标识，用以区分不同任务，可选。如设置，建议为每一个任务设置不同的标识', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'task_tingwu_123', - ], + 'FileUrl' => ['description' => 'The HTTP or HTTPS URL of the source audio or video file. This parameter is required when you create an offline transcription task.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'http://xxx.com/zzz/1.wav'], + 'TaskKey' => ['description' => 'A custom identifier that you can set for the task.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'task_tingwu_123'], 'Format' => [ - 'title' => '音频流编码格式，支持PCM（无压缩的PCM文件或WAV文件）或OPUS（压缩的OPUS文件）。仅在创建实时会议时必选。', - 'description' => '', + 'description' => 'The encoding format of the audio stream data. This parameter is required when you create a real-time recording task. The following values are supported:'."\n" + ."\n" + .'- **pcm**'."\n" + ."\n" + .'- **opus**'."\n" + ."\n" + .'- **aac**'."\n" + ."\n" + .'- **speex**'."\n" + ."\n" + .'- **mp3**', + 'enumValueTitles' => ['pcm' => 'pcm', 'opus' => 'opus'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'pcm' => 'pcm', - 'opus' => 'opus', - ], + 'title' => '', 'example' => 'pcm', ], 'SampleRate' => [ - 'title' => '音频流采样率，当前支持：16000/8000两种。仅在创建实时会议时必选。', - 'description' => '', + 'description' => 'The sample rate of the audio stream data. This parameter is required when you create a real-time recording task. The supported values are 8000 and 16000.'."\n" + ."\n" + .'- **8000**: Suitable for telephony and customer service scenarios.'."\n" + ."\n" + .'- **16000**: Suitable for real-time meeting audio capture scenarios.', + 'enumValueTitles' => [8000 => '8000', 16000 => '16000'], 'type' => 'integer', 'format' => 'int32', 'required' => false, + 'enum' => ['16000', '8000'], + 'title' => '', 'example' => '16000', - 'enum' => [ - '16000', - '8000', - ], - ], - 'ProgressiveCallbacksEnabled' => [ - 'title' => '是否开启回调功能。当需要开启回调功能时，您需要在控制台配置好回调类型和地址，并在创建任务时将该参数置为true。', - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], - 'MultipleStreamsEnabled' => [ - 'title' => '是否开启多通道音频流识别。当且仅当在实时记录场景下才需考虑设置，默认为false', - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], - 'TaskId' => [ - 'title' => '您创建实时记录时返回的TaskId，通过此Id，您可以结束实时记录。该参数仅在结束实时记录时设置，其他时候请不要设置。', - 'type' => 'string', - ], - 'OutputPath' => [ - 'title' => '在控制台配置oss信息后，可以通过配置oss写入地址，将结果直接保存到自定义oss内。', - 'type' => 'string', ], + 'ProgressiveCallbacksEnabled' => ['title' => 'Specifies whether to enable the callback feature. To enable this feature, you must configure the callback type and URL in the console and set this parameter to true when creating the job.', 'description' => 'Specifies whether to enable callbacks. To receive callbacks, you must configure the callback type and URL in the console and set this parameter to `true`.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false'], + 'MultipleStreamsEnabled' => ['title' => 'Specifies whether to enable multi-channel audio stream recognition. This setting is only relevant in real-time recording scenarios and defaults to false.', 'description' => 'Specifies whether to enable multi-channel audio stream recognition. This parameter applies only to real-time recording scenarios. The default value is `false`.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false'], + 'TaskId' => ['title' => 'The TaskId returned when you create a real-time record. You can use this ID to end the real-time recording. Set this parameter only when ending a real-time record; do not set it at other times.', 'description' => 'The task ID that is returned when you create a real-time recording. This ID is required to stop the recording. Specify this parameter only when stopping a real-time recording.', 'type' => 'string', 'required' => false, 'example' => '9922c84c087044eda18659c128b56c84'], + 'OutputPath' => ['title' => 'After configuring OSS information in the console, you can specify an OSS write path to directly save results to your custom OSS bucket.', 'description' => 'After you configure OSS settings in the console, specify an OSS path to save results directly to your OSS bucket.', 'type' => 'string', 'required' => false, 'example' => ''], 'LanguageHints' => [ - 'title' => '偏好语种，仅当SourceLanguage="multilingual"时生效，限制模型的输出语种。', + 'description' => 'Preferred languages. This applies only when SourceLanguage is multilingual. It restricts the output language of the model.', + 'title' => 'Preferred languages. Takes effect only when SourceLanguage="multilingual" and restricts the output languages of the model.', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'AudioChannelMode' => [ - 'title' => '多通道音视频处理模式。', - 'type' => 'string', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', ], + 'AudioChannelMode' => ['title' => 'Multi-channel audio and video processing pattern.', 'description' => 'Multi-channel audio or video processing mode.', 'type' => 'string', 'required' => false, 'example' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'Parameters' => [ - 'description' => '', + 'description' => 'Algorithm-related parameters for customizing task processing.', 'type' => 'object', 'properties' => [ 'Transcoding' => [ - 'description' => '', + 'description' => 'Parameters for transcoding source audio/video files or audio streams.', 'type' => 'object', 'properties' => [ 'TargetAudioFormat' => [ - 'title' => '是否将原始音视频文件或音频流转成mp3格式保存，目前仅支持设置为mp3格式。在创建离线文件转写或实时会议时可选。', - 'description' => '', + 'description' => 'Specifies the target format for the transcoded audio. Set to `mp3` to transcode the source audio into MP3 format for storage. This parameter is optional for offline transcription and real-time recording tasks.', 'type' => 'string', 'required' => false, 'example' => 'mp3', - 'enum' => [ - 'mp3', - ], + 'enum' => ['mp3'], + 'title' => '', ], 'TargetVideoFormat' => [ - 'title' => '是否将原始视频文件转成mp4格式保存，目前仅支持设置为mp4格式。仅在创建离线文件转写且原始文件为视频格式时设置此参数有意义，通常无须设置。', - 'description' => '', + 'description' => 'Specifies the target format for the transcoded video. Set to `mp4` to transcode the source video into MP4 format for storage. This parameter applies only to offline transcription tasks with a video source file.', 'type' => 'string', 'required' => false, 'example' => 'mp4', - 'enum' => [ - 'mp4', - ], + 'enum' => ['mp4'], + 'title' => '', ], 'VideoThumbnailEnabled' => [ - 'title' => '是否将原始视频文件抽取视频缩略图并保存。仅在创建离线文件转写且原始文件为视频格式时设置此参数有意义，通常无须设置。', - 'description' => '', - 'type' => 'boolean', - 'required' => false, + 'description' => 'Specifies whether to extract and save video thumbnails from the source video file. This parameter applies only to offline transcription tasks with a video source file.', 'enumValueTitles' => [], - 'example' => 'false', - 'default' => 'false', - ], - 'SpectrumEnabled' => [ - 'title' => '是否将原始音视频文件或音频流生成音频波形图并保存，目前仅支持设置为mp3格式。在创建离线文件转写或实时会议时可选。', - 'description' => '', 'type' => 'boolean', 'required' => false, - 'example' => 'false', 'default' => 'false', + 'title' => '', + 'example' => 'false', ], + 'SpectrumEnabled' => ['description' => 'Specifies whether to generate and save an audio waveform from the source audio/video file or audio stream. This parameter is optional for offline transcription and real-time recording tasks.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'title' => '', 'example' => 'false'], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'Transcription' => [ - 'title' => '语音识别功能控制参数', - 'description' => '', + 'title' => '', + 'description' => 'Parameters to control the speech transcription process.', 'type' => 'object', 'properties' => [ - 'AudioEventDetectionEnabled' => [ - 'title' => '是否在语音转写过程中开启声音事件检测，开启后，会生成声音事件检测的结果，比如Music事件等。', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], - 'DiarizationEnabled' => [ - 'title' => '是否在语音转写过程中开启说话人分离功能', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'AudioEventDetectionEnabled' => ['description' => 'Specifies whether to enable sound event detection, which identifies non-speech events in the audio, such as music.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'title' => '', 'example' => 'false'], + 'DiarizationEnabled' => ['description' => 'Specifies whether to enable speaker diarization.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'title' => '', 'example' => 'false'], 'Diarization' => [ - 'description' => '', + 'description' => 'Parameters for the speaker diarization feature.', 'type' => 'object', 'properties' => [ 'SpeakerCount' => [ - 'title' => '是否开启说话人角色区分。注：只对16K及以上采样率生效。'."\n" - .'不设置：不使用说话人角色区分。'."\n" - .'0：说话人角色区分结果为不定人数。'."\n" - .'2：说话人角色区分结果为2人。', - 'description' => '', + 'description' => 'Specifies the number of speakers to identify.'."\n" + ."\n" + .'If this parameter is not set, speakers are not differentiated in the transcript.'."\n" + ."\n" + .'Set the value to `0` to identify an unknown number of speakers.'."\n" + ."\n" + .'Set the value to `2` to identify two speakers.', + 'enumValueTitles' => ['0', 2 => '2'], 'type' => 'integer', 'format' => 'int32', + 'title' => '', 'required' => false, 'example' => '2', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'OutputLevel' => [ - 'title' => '设置语音识别结果返回等级。1：识别出完整句子时返回识别结果；2：识别出中间结果及完整句子时返回识别结果', + 'title' => 'Set the speech recognition result return level. 1: Return the recognition result when a complete sentence is detected; 2: Return the recognition result when intermediate results and complete sentences are detected', + 'description' => 'Specifies the level of detail for the speech transcription results. Default value: `1`.'."\n" + ."\n" + .'- **1**: Returns results only when a complete sentence is recognized.'."\n" + ."\n" + .'- **2**: Returns both intermediate and final results as they are recognized.', + 'enumValueTitles' => [1 => 'Returns results only when a complete sentence is recognized.', 'Returns both intermediate and final results as they are recognized.'], 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', + 'example' => '2', ], 'AdditionalStreamOutputLevel' => [ - 'title' => '设置实时记录场景下活跃说话人对应的语音识别结果返回等级。1：识别出完整句子时返回识别结果；2：识别出中间结果及完整句子时返回识别结果(仅在实时记录场景下且MultipleStreamsEnabled=true时按需设置，离线转写场景无须设置)。', + 'title' => 'Set the Level at which speech recognition Results for active speakers are returned in real-time recording scenarios. 1: Return the Result when a complete sentence is detected; 2: Return the Result when intermediate results or a complete sentence are detected (applicable only in real-time recording scenarios when MultipleStreamsEnabled=true; not required for offline transcription scenarios). ', + 'description' => 'Specifies the level of detail for speech transcription results for the active speaker in a real-time recording scenario.'."\n" + ."\n" + .'- **1**: Returns results only when a complete sentence is recognized.'."\n" + ."\n" + .'- **2**: Returns both intermediate and final results as they are recognized.'."\n" + ."\n" + .'This parameter applies only to real-time recordings when `MultipleStreamsEnabled` is set to `true`.', + 'enumValueTitles' => [1 => 'Returns results only when a complete sentence is recognized.', 'Returns both intermediate and final results as they are recognized.'], 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', + 'example' => '1', ], - 'PhraseId' => [ - 'title' => '热词ID', - 'type' => 'string', - ], - 'Model' => [ - 'title' => '设置语音转写模型，提升特定领域转写效果。', - 'type' => 'string', - ], - 'RealtimeDiarizationEnabled' => [ - 'type' => 'boolean', - ], - 'ProfanityFilterEnabled' => [ - 'title' => '是否启用语音转写过程中的敏感词过滤功能，默认开启', - 'type' => 'boolean', - ], + 'PhraseId' => ['title' => 'Hotword ID', 'description' => 'The ID of the hotword list.', 'type' => 'string', 'required' => false, 'example' => 'ce9c2a34b6d847bf92a77d0a196f****'], + 'Model' => ['title' => 'Set the speech transcription model to improve transcription accuracy in specific domains. ', 'description' => 'Set the speech transcription model to improve accuracy for specific domains.', 'type' => 'string', 'required' => false, 'example' => ''], + 'RealtimeDiarizationEnabled' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'ProfanityFilterEnabled' => ['title' => 'Whether to enable the sensitive word filtering feature during speech transcription. Enabled by default.', 'description' => 'Enable sensitive word filtering during speech transcription. Enabled by default.', 'type' => 'boolean', 'required' => false, 'example' => ''], ], 'required' => false, + 'example' => '', ], 'Translation' => [ - 'title' => '语言翻译功能控制参数', - 'description' => '', + 'title' => '', + 'description' => 'Parameters to control the translation feature.', 'type' => 'object', 'properties' => [ 'TargetLanguages' => [ - 'title' => '添加待设置的目标翻译语言。 支持中文(cn)、英文(en)、日文(ja)。', - 'description' => '', + 'title' => '', + 'description' => 'The target languages for translation. This parameter is required if translation is enabled. Supported languages include Chinese, English, and Japanese.', 'type' => 'array', 'required' => false, 'items' => [ + 'description' => 'The target language for the translation. Valid values:'."\n" + ."\n" + .'- **cn**: Chinese'."\n" + ."\n" + .'- **en**: English'."\n" + ."\n" + .'- **ja**: Japanese', + 'enumValueTitles' => ['ja' => 'Japanese', 'en' => 'English', 'cn' => 'Chinese'], 'type' => 'string', + 'required' => false, + 'example' => 'en', + 'title' => '', ], + 'example' => '', ], 'OutputLevel' => [ - 'title' => '设置实时语言翻译识别结果返回等级。1：识别出完整句子时返回识别结果；2：识别出中间结果及完整句子时返回识别结果(仅在实时记录场景下按需设置，离线转写场景无须设置)。', + 'title' => 'Set the level of real-time language translation result output. 1: Return the classification result when a complete sentence is detected; 2: Return the classification result when intermediate results or a complete sentence are detected (set only as needed in real-time recording scenarios; not required for offline transcription scenarios).', + 'description' => 'Specifies the level of detail for real-time translation results. Default value: `1`.'."\n" + ."\n" + .'- **1**: Returns results only for complete sentences.'."\n" + ."\n" + .'- **2**: Returns both intermediate and final results.'."\n" + ."\n" + .'This parameter applies only to real-time recordings.', + 'enumValueTitles' => [1 => '1', '2'], 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', + 'example' => '2', ], 'AdditionalStreamOutputLevel' => [ - 'title' => '设置实时记录场景下活跃说话人对应的语言翻译识别结果返回等级。1：识别出完整句子时返回识别结果；2：识别出中间结果及完整句子时返回识别结果(仅在实时记录场景下且MultipleStreamsEnabled=true时按需设置，离线转写场景无须设置)。', + 'title' => 'Set the level for returning language translation recognition results corresponding to the active speaker in real-time recording scenarios. 1: Return the classification result when a complete sentence is detected; 2: Return the classification result when intermediate results and complete sentences are detected (only applicable in real-time recording scenarios when MultipleStreamsEnabled=true; not required in offline transcription scenarios).', + 'description' => 'Specifies the level of detail for real-time translation results for the active speaker.'."\n" + ."\n" + .'- **1**: Returns results only for complete sentences.'."\n" + ."\n" + .'- **2**: Returns both intermediate and final results.'."\n" + ."\n" + .'This parameter applies only to real-time recordings when `MultipleStreamsEnabled` is set to `true`.', + 'enumValueTitles' => [1 => 'Returns results only for complete sentences.', 'Returns both intermediate and final results.'], 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', + 'example' => '1', ], ], 'required' => false, + 'example' => '', ], - 'TranslationEnabled' => [ - 'title' => '是否将语音识别内容开启翻译功能。如需翻译，此时设置为true', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], - 'AutoChaptersEnabled' => [ - 'title' => '是否启用章节速览功能，开启后会生成章节标题和章节摘要结果。', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], - 'MeetingAssistanceEnabled' => [ - 'title' => '是否启用智能纪要功能，开启后会生成关键词、重点内容、待办等结果(依赖传入的参数类型)。', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'TranslationEnabled' => ['description' => 'Specifies whether to enable the translation feature.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'title' => '', 'example' => 'false'], + 'AutoChaptersEnabled' => ['description' => 'Specifies whether to generate a chapter summary, which includes chapter titles and summaries for each chapter.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'title' => '', 'example' => 'true'], + 'MeetingAssistanceEnabled' => ['description' => 'Specifies whether to generate intelligent minutes, which include keywords, key points, and action items.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'title' => '', 'example' => 'false'], 'MeetingAssistance' => [ - 'title' => '智能纪要功能控制参数，支持待办事项、关键词、重点内容的算法处理。 若您启用MeetingAssistanceEnabled但未通过MeetingAssistance设置算法类型，则默认都进行调用和返回。', + 'description' => 'Parameters for the intelligent minutes feature, which supports processing for action items, keywords, and key points. If `MeetingAssistanceEnabled` is set to `true` but you do not specify this object, all analysis types are enabled by default.', + 'title' => 'Control parameters for the Intelligent Meeting Summary feature, which supports algorithmic processing of to-do items, keywords, and key content. If you enable MeetingAssistanceEnabled but do not specify algorithm types via MeetingAssistance, all types will be invoked and returned by default.', 'type' => 'object', 'properties' => [ 'Types' => [ - 'title' => '开启智能纪要功能时，需传入期望的功能参数类型，支持待办(Actions)、关键信息(KeyInformation)。其中关键信息包含关键词和重点内容(关键句)', + 'minItems' => 1, + 'description' => 'The types of analysis to perform when the intelligent minutes feature is enabled. Supported values: `Actions` (action items) and `KeyInformation` (key information, including keywords and key points).', + 'title' => 'When the Intelligent Meeting Summary feature is enabled, you must specify the desired parameter types. Supported types include Actions and KeyInformation. KeyInformation includes keywords and key content (key sentences).', 'type' => 'array', 'items' => [ + 'description' => 'The type of analysis for intelligent minutes. Valid values:'."\n" + ."\n" + .'- **Actions**: Extracts action items.'."\n" + ."\n" + .'- **KeyInformation**: Extracts key information, including keywords and key points.', + 'enumValueTitles' => ['Actions' => 'action item', 'KeyInformation' => 'Key information (including keywords and key points)'], 'type' => 'string', 'required' => false, + 'example' => 'Actions', + 'title' => '', ], 'required' => false, - 'minItems' => 1, + 'example' => '', ], ], - ], - 'SummarizationEnabled' => [ - 'title' => '是否启用摘要功能，开启后会可以生成全文摘要、发言人总结等结果(依赖传入的摘要类型)。', - 'description' => '', - 'type' => 'boolean', 'required' => false, - 'example' => 'false', - 'default' => 'false', + 'example' => '', ], + 'SummarizationEnabled' => ['description' => 'Specifies whether to enable the summarization feature, which can generate results such as a full-text summary and a speaker summary.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'title' => '', 'example' => 'false'], 'Summarization' => [ - 'title' => '摘要功能控制参数', - 'description' => '', + 'title' => '', + 'description' => 'Parameters for the summarization feature.', 'type' => 'object', 'properties' => [ 'Types' => [ - 'title' => '添加待设置的大模型摘要参数，支持全文摘要(Paragraph)、发言人总结摘要(Conversational)。', - 'description' => '', + 'title' => '', + 'description' => 'The types of summaries to generate. This parameter is required when summarization is enabled. Supported types include `Paragraph` (full-text summary), `Conversational` (speaker summary), and `QuestionsAnswering` (Q\\&A summary).', 'type' => 'array', 'required' => false, - 'enumValueTitles' => [ - 'Conversational' => '', - 'QuestionsAnswering' => '', - 'Paragraph' => '', - ], + 'enumValueTitles' => ['Conversational' => 'speaker summary', 'QuestionsAnswering' => 'Q\\&A summary', 'Paragraph' => 'full-text summary'], 'example' => 'Paragraph', 'items' => [ - 'title' => '', + 'description' => 'The type of summary to generate. Valid values:'."\n" + ."\n" + .'- **Paragraph**: A full-text summary.'."\n" + ."\n" + .'- **Conversational**: A speaker summary.'."\n" + ."\n" + .'- **QuestionsAnswering**: A Q\\&A summary.', + 'enumValueTitles' => ['Conversational' => 'speaker summary', 'QuestionsAnswering' => 'Q\\&A summary', 'Paragraph' => 'full-text summary'], 'type' => 'string', + 'title' => '', + 'required' => false, + 'example' => 'Paragraph', ], ], ], 'required' => false, + 'example' => '', ], - 'PptExtractionEnabled' => [ - 'title' => '是否启用PPT抽取和PPT总结功能，开启后会对视频文件中的PPT进行画面抽取，并形成对应的总结', - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], - 'TextPolishEnabled' => [ - 'title' => '是否启用口语书面化，开启后会对音频转写结果进行润色，输出更为规范的文本结果', - 'type' => 'boolean', - 'default' => 'false', - ], - 'ServiceInspectionEnabled' => [ - 'title' => '服务质检功能开关，默认为false。', - 'type' => 'boolean', - ], + 'PptExtractionEnabled' => ['title' => 'Whether to enable PPT extraction and PPT summarization. When enabled, it extracts PPT frames from video files and generates corresponding summaries.', 'description' => 'Specifies whether to enable PPT extraction. If enabled, the service extracts slides from the video file and generates corresponding summaries. This feature applies only to offline transcription tasks with a video source file and has no effect on other task types.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false'], + 'TextPolishEnabled' => ['title' => 'Whether to enable Spoken-to-Written Text Polishing. When enabled, the audio transcription results are refined to produce more standardized text output.', 'description' => 'Specifies whether to enable the spoken-to-written conversion feature.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false'], + 'ServiceInspectionEnabled' => ['title' => 'Toggle for the service quality inspection feature. The default value is false.', 'description' => 'Enable service quality inspection. Default is false.', 'type' => 'boolean', 'required' => false, 'example' => ''], 'ServiceInspection' => [ - 'title' => '服务质检参数对象。', + 'description' => 'Service quality inspection parameters.', + 'title' => 'Service inspection parameter object. ', 'type' => 'object', 'properties' => [ - 'SceneIntroduction' => [ - 'title' => '服务质检的对话场景描述。', - 'type' => 'string', - ], - 'InspectionIntroduction' => [ - 'title' => '服务质检的检测目标和侧重点描述。', - 'type' => 'string', - ], + 'SceneIntroduction' => ['title' => 'Description of the dialogue scenario for service quality inspection. ', 'description' => 'Description of the conversation scenario for service quality inspection.', 'type' => 'string', 'required' => false, 'example' => ''], + 'InspectionIntroduction' => ['title' => 'Description of the detection target and focus of service quality inspection. ', 'description' => 'Description of the inspection goals and focus areas for service quality inspection.', 'type' => 'string', 'required' => false, 'example' => ''], 'InspectionContents' => [ - 'title' => '服务质检的质检维度列表，包含质检维度名称和定义，即需要大模型以什么样的标准判断该维度是否命中。', + 'description' => 'List of inspection dimensions for service quality inspection. Each dimension includes a name and definition, which tells the Large Language Model how to evaluate whether the dimension is met.', + 'title' => 'List of service inspection dimensions, including the name and definition of each dimension. This defines the criteria the LLM uses to determine whether a dimension is hit. ', 'type' => 'array', 'items' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'Title' => [ - 'title' => '服务质检的质检维度名称。', - 'type' => 'string', - ], - 'Content' => [ - 'title' => '服务质检的质检维度定义。', - 'type' => 'string', - ], + 'Title' => ['title' => 'The name of the dimension for service quality inspection. ', 'description' => 'Name of the inspection dimension.', 'type' => 'string', 'required' => false, 'example' => ''], + 'Content' => ['title' => 'Definition of a service inspection dimension.', 'description' => 'Definition of the inspection dimension.', 'type' => 'string', 'required' => false, 'example' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', ], - 'SpeakerMap' => [ - 'type' => 'object', - ], + 'SpeakerMap' => ['type' => 'object', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], + 'required' => false, + 'example' => '', ], - 'CustomPromptEnabled' => [ - 'title' => '是否启用自定义Prompt，开启后可以输入个性化定制Prompt。', - 'type' => 'boolean', - ], + 'CustomPromptEnabled' => ['title' => 'Whether to enable Custom Prompt. When enabled, you can input a personalized custom prompt.', 'description' => 'Specifies whether to enable the custom prompt feature.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], 'CustomPrompt' => [ - 'title' => '自定义Prompt的主要参数。', + 'description' => 'Parameters to control the custom prompt feature.', + 'title' => 'Main parameters of the Custom Prompt. ', 'type' => 'object', 'properties' => [ 'Contents' => [ - 'title' => '自定义Prompt的参数列表。', + 'description' => 'A list of custom prompt parameters.', + 'title' => 'List of parameters for the Custom Prompt. ', 'type' => 'array', 'items' => [ + 'description' => 'An object that defines a single custom prompt.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => 'Prompt的自定义名称，用于匹配输出结果。', - 'type' => 'string', - 'required' => true, - ], - 'Prompt' => [ - 'title' => 'Prompt的自定义内容。', - 'type' => 'string', - 'required' => true, - ], - 'Model' => [ - 'title' => '指定Prompt的模型。', - 'type' => 'string', - ], - 'TransType' => [ - 'title' => '指定{Transcription}标签格式。', - 'type' => 'string', - ], + 'Name' => ['title' => 'The custom name of the prompt, used to match output results.', 'description' => 'A custom name for the prompt, used to identify the corresponding output.', 'type' => 'string', 'required' => true, 'example' => 'summary-demo'], + 'Prompt' => ['title' => 'Custom content of the Prompt. ', 'description' => 'The content of the custom prompt.', 'type' => 'string', 'required' => true, 'example' => '总结一下下面的对话内容:{Transcription}'], + 'Model' => ['title' => 'The model for the Prompt. ', 'description' => 'The model to use for the prompt.', 'type' => 'string', 'required' => false, 'example' => 'tingwu-turbo'], + 'TransType' => ['title' => 'Specifies the {Transcription} tag format.', 'description' => 'Specifies the format for the `{Transcription}` tag.', 'type' => 'string', 'required' => false, 'example' => 'default'], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', ], ], + 'required' => false, + 'example' => '', ], 'ExtraParams' => [ - 'title' => '用以设置某些特殊场景或特殊配置参数，通常情况无须设置。', + 'description' => 'Extended parameters for advanced use cases. You do not typically need to configure these parameters.', + 'title' => 'Used to configure special scenarios or special configuration parameters. Typically, no configuration is needed.', 'type' => 'object', 'properties' => [ - 'NfixEnabled' => [ - 'title' => '是否启用Nfix。通常情况无须设置。', - 'type' => 'boolean', - ], - 'MaxKeywords' => [ - 'title' => '指定关键词的数量。', - 'type' => 'integer', - 'format' => 'int32', - ], - 'DomainEducationEnabled' => [ - 'type' => 'boolean', - ], - 'OcrAuxiliaryEnabled' => [ - 'type' => 'boolean', - ], - 'TranslateLlmSceneEnabled' => [ - 'type' => 'boolean', - ], - 'FullTextSummaryFormat' => [ - 'title' => '全文摘要返回格式', - 'type' => 'string', + 'NfixEnabled' => ['title' => 'Whether to enable Nfix. Typically, no configuration is needed.', 'description' => 'Specifies whether to enable nfix. You do not typically need to configure this parameter.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'MaxKeywords' => ['title' => 'The quantity of keywords to specify.', 'description' => 'Maximum number of keywords.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => ''], + 'DomainEducationEnabled' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'OcrAuxiliaryEnabled' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'TranslateLlmSceneEnabled' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'FullTextSummaryFormat' => ['title' => 'The return format of the full-text summary.', 'description' => 'Full-text summary format.', 'type' => 'string', 'required' => false, 'example' => ''], + 'TranslationHotwordMap' => [ + 'type' => 'object', + 'properties' => [ + 'bizUserId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'bizType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'example' => '', ], - 'ContentExtractionEnabled' => [ - 'type' => 'boolean', - ], + 'ContentExtractionEnabled' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], 'ContentExtraction' => [ - 'title' => '对话内容提取参数对象。', + 'description' => 'Conversation content extraction parameters.', + 'title' => 'An object containing parameters for dialogue content extraction.', 'type' => 'object', 'properties' => [ - 'SceneIntroduction' => [ - 'title' => '对话内容提取的场景描述。', - 'type' => 'string', - ], + 'SceneIntroduction' => ['title' => 'Scenario description for dialog content extraction. ', 'description' => 'Description of the conversation scenario for content extraction.', 'type' => 'string', 'required' => false, 'example' => ''], 'ExtractionContents' => [ - 'title' => '对话内容提取的提取维度列表，包含提取项的名称和定义。', + 'description' => 'List of content extraction dimensions. Each dimension includes a name and definition.', + 'title' => 'List of extraction dimensions for dialog content extraction, including the name and definition of each extraction item. ', 'type' => 'array', 'items' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'Title' => [ - 'title' => '对话内容提取的提取维度名称。', - 'type' => 'string', - ], - 'Content' => [ - 'title' => '对话内容提取的维度定义。', - 'type' => 'string', - ], - 'Identity' => [ - 'type' => 'string', - ], + 'Title' => ['title' => 'Name of the extraction dimension for dialog content extraction. ', 'description' => 'Name of the content extraction dimension.', 'type' => 'string', 'required' => false, 'example' => ''], + 'Content' => ['title' => 'Definition of the dimension for dialog content extraction. ', 'description' => 'Definition of the content extraction dimension.', 'type' => 'string', 'required' => false, 'example' => ''], + 'Identity' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', ], - 'SpeakerMap' => [ - 'type' => 'object', - ], + 'SpeakerMap' => ['type' => 'object', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], + 'required' => false, + 'example' => '', ], - 'IdentityRecognitionEnabled' => [ - 'title' => '身份识别开关。', - 'type' => 'boolean', - ], + 'IdentityRecognitionEnabled' => ['title' => 'Toggle for identity recognition.', 'description' => 'Enable identity recognition.', 'type' => 'boolean', 'required' => false, 'example' => ''], 'IdentityRecognition' => [ - 'title' => '身份识别参数对象。', + 'description' => 'Identity recognition parameters.', + 'title' => 'The parameter object for identity recognition. ', 'type' => 'object', 'properties' => [ - 'SceneIntroduction' => [ - 'title' => '身份识别的场景描述。', - 'type' => 'string', - ], + 'SceneIntroduction' => ['title' => 'Scenario Description for Identity Recognition', 'description' => 'Description of the scenario for identity recognition.', 'type' => 'string', 'required' => false, 'example' => ''], 'IdentityContents' => [ - 'title' => '身份识别的内容列表，包含身份名称和描述。', + 'description' => 'List of identities, including identity name and description.', + 'title' => 'List of identity recognition content, including identity name and description.', 'type' => 'array', 'items' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '身份名称。', - 'type' => 'string', - ], - 'Description' => [ - 'title' => '身份描述。', - 'type' => 'string', - ], + 'Name' => ['title' => 'Identity Name', 'description' => 'Identity name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'Description' => ['title' => 'Identity Description', 'description' => 'Identity description.', 'type' => 'string', 'required' => false, 'example' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', ], ], + 'required' => false, + 'example' => '', ], 'AutoChapters' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'ChapterGranularity' => [ - 'type' => 'string', - ], + 'ChapterGranularity' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'Model' => [ - 'type' => 'string', - ], - 'LlmOutputLanguage' => [ - 'type' => 'string', - ], + 'Model' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'LlmOutputLanguage' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'example' => '', ], ], ], @@ -622,288 +568,110 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '35124E1C-AE99-5D6C-A52E-BD689D8D****', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success.', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID, used for troubleshooting only.', 'type' => 'string', 'example' => '35124E1C-AE99-5D6C-A52E-BD689D8D****'], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The status message.', 'type' => 'string', 'example' => 'Success.', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'c5394c6ee0fb474899d42215a3925c7e', - ], - 'TaskKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'task_tingwu_123', - ], - 'MeetingJoinUrl' => [ - 'title' => '实时记录场景下生成的音频流推送地址，您可以在后续实时音频流识别时通过该地址进行', - 'type' => 'string', - ], - 'TaskStatus' => [ - 'title' => '任务状态', - 'type' => 'string', - ], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'c5394c6ee0fb474899d42215a3925c7e', 'title' => ''], + 'TaskKey' => ['description' => 'The custom identifier specified during task creation.', 'type' => 'string', 'example' => 'task_tingwu_123', 'title' => ''], + 'MeetingJoinUrl' => ['title' => 'Audio stream push URL generated in the real-time recording scenario. You can use this URL for subsequent real-time audio stream recognition. ', 'description' => 'The stream ingestion URL. Push audio streams to this URL for real-time transcription.', 'type' => 'string', 'example' => 'wss://tingwu-realtime-cn-beijing.aliyuncs.com/api/ws/v1?mc=****'], + 'TaskStatus' => ['title' => 'Job Status ', 'description' => 'The task status.', 'type' => 'string', 'example' => 'ONGOING'], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35124E1C-AE99-5D6C-A52E-BD689D8D****\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"Success.\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"c5394c6ee0fb474899d42215a3925c7e\\",\\n \\"TaskKey\\": \\"task_tingwu_123\\",\\n \\"MeetingJoinUrl\\": \\"wss://tingwu-realtime-cn-beijing.aliyuncs.com/api/ws/v1?mc=****\\",\\n \\"TaskStatus\\": \\"ONGOING\\"\\n }\\n}","type":"json"}]', - ], - 'GetTaskInfo' => [ - 'summary' => '查询听悟任务信息', - 'path' => '/openapi/tingwu/v2/tasks/{TaskId}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a Listen and Understand Job ', + 'summary' => 'Create offline transcription and real-time meeting tasks in Tingwu.', + 'changeSet' => [ + ['createdAt' => '2025-09-12T05:20:21.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-09-12T04:07:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-02T03:52:47.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-31T09:57:32.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-27T08:59:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-05T03:00:34.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-22T03:15:40.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-10T04:56:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-29T07:00:18.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-06-21T05:43:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-06-14T05:07:11.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-05-21T11:33:55.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-05-20T08:44:15.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-05-17T07:13:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-05-15T03:05:45.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-03-18T08:42:15.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-03-18T05:49:57.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-03-15T07:24:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-03-12T01:36:52.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-01-08T06:20:39.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-12-19T10:53:55.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-12-18T13:17:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-12-11T06:35:36.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-20T08:13:44.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-16T03:05:21.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTask'], ], ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREnls24C81K', - 'FEATUREnlsO1I14I', - ], - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'TaskId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'c5394c6ee0fb474899d42215a3925c7e', - 'title' => '创建任务时生成的TaskId', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '35124E1C-AE99-5D6C-A52E-BD689D8D****', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success.', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'c5394c6ee0fb474899d42215a3925c7e', - ], - 'TaskKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'task_tingwu_123', - 'title' => '该任务由用户自定义的TaskKey， 此处原样返回。', - ], - 'TaskStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'COMPLETE', - 'title' => '任务状态', - ], - 'OutputMp3Path' => [ - 'title' => 'mp3转换结果的url链接', - 'type' => 'string', - ], - 'OutputMp4Path' => [ - 'title' => 'mp4转换结果的url链接', - 'type' => 'string', - ], - 'OutputThumbnailPath' => [ - 'title' => '视频缩略图的url链接', - 'type' => 'string', - ], - 'OutputSpectrumPath' => [ - 'title' => '音频波形图的url链接', - 'type' => 'string', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'title' => '错误信息', - 'type' => 'string', - ], - 'Result' => [ - 'title' => '各类算法处理的结果集合。该结果以http链接的形式返回，用户可基于该链接解析原生结果。', - 'type' => 'object', - 'properties' => [ - 'Transcription' => [ - 'title' => '语音转写对应的结果url链接。', - 'type' => 'string', - ], - 'AutoChapters' => [ - 'title' => '章节速览功能对应的结果url链接。', - 'type' => 'string', - ], - 'MeetingAssistance' => [ - 'title' => '智能纪要对应的结果url链接', - 'type' => 'string', - ], - 'Summarization' => [ - 'title' => '大模型摘要对应的结果url链接。', - 'type' => 'string', - ], - 'Translation' => [ - 'title' => '文本翻译对应的结果url链接', - 'type' => 'string', - ], - 'PptExtraction' => [ - 'title' => '视频PPT抽取和总结对应的结果url链接', - 'type' => 'string', - ], - 'TextPolish' => [ - 'title' => '口语书面化对应的结果url链接', - 'type' => 'string', - ], - 'CustomPrompt' => [ - 'title' => '自定义prompt对应的结果url链接', - 'type' => 'string', - ], - 'ServiceInspection' => [ - 'title' => '服务质检对应的结果url链接', - 'type' => 'string', - ], - 'IdentityRecognition' => [ - 'type' => 'string', - ], - 'ContentExtraction' => [ - 'type' => 'string', - ], - ], - ], - ], - ], + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'tingwu:CreateTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'NlsTingwu', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35124E1C-AE99-5D6C-A52E-BD689D8D****\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"Success.\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"c5394c6ee0fb474899d42215a3925c7e\\",\\n \\"TaskKey\\": \\"task_tingwu_123\\",\\n \\"TaskStatus\\": \\"COMPLETED\\",\\n \\"OutputMp3Path\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_20231222101008.mp3?Expires=1706064016\\",\\n \\"OutputMp4Path\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_20231222101008.mp4?Expires=1706064016\\",\\n \\"OutputThumbnailPath\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_20231222101008.png?Expires=1706064016\\",\\n \\"OutputSpectrumPath\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_20231222101008.spectrum?Expires=1706064016\\",\\n \\"ErrorCode\\": \\"TSC.AudioFormat\\",\\n \\"ErrorMessage\\": \\"Audio format invalid.\\",\\n \\"Result\\": {\\n \\"Transcription\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_Transcription_20231222101008.json?Expires=1706064016\\",\\n \\"AutoChapters\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_AutoChapters_20231222101215.json?Expires=1706064016\\",\\n \\"MeetingAssistance\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_MeetingAssistance_20231222101112.json?Expires=1706064016\\",\\n \\"Summarization\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_Summarization_20231222101215.json?Expires=1706064016\\",\\n \\"Translation\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_Translation_20231222101215.json?Expires=1706064016\\",\\n \\"PptExtraction\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_PptExtraction_20231222101215.json?Expires=1706064016\\",\\n \\"TextPolish\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_TextPolish_20231222101215.json?Expires=1706064016\\",\\n \\"CustomPrompt\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_ CustomPrompt_20231222101215.json?Expires=1706064016\\",\\n \\"ServiceInspection\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_ ServiceInspection_20231222101215.json?Expires=1706064016\\",\\n \\"IdentityRecognition\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_ IdentityRecognition_20231222101215.json?Expires=1706064016\\",\\n \\"ContentExtraction\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_ ContentExtraction_20231222101215.json?Expires=1706064016\\"\\n }\\n }\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35124E1C-AE99-5D6C-A52E-BD689D8D****\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"Success.\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"c5394c6ee0fb474899d42215a3925c7e\\",\\n \\"TaskKey\\": \\"task_tingwu_123\\",\\n \\"MeetingJoinUrl\\": \\"wss://tingwu-realtime-cn-beijing.aliyuncs.com/api/ws/v1?mc=****\\",\\n \\"TaskStatus\\": \\"ONGOING\\"\\n }\\n}","type":"json"}]', ], 'CreateTranscriptionPhrases' => [ - 'summary' => '创建热词词表', + 'summary' => 'Creates a custom vocabulary of transcription phrases.', 'path' => '/openapi/tingwu/v2/resources/phrases', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => '请求参数body', - 'description' => '', + 'title' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '词表名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'fruit_phrase', - 'maxLength' => 50, - 'minLength' => 1, - ], - 'Description' => [ - 'title' => '词表描述信息。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'custom fruit phrases list', - 'maxLength' => 250, - 'minLength' => 1, - ], - 'WordWeights' => [ - 'title' => '词表里的词和对应的权重，为JSON的Map格式字符串。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '{"苹果":3,"西瓜":3}', - ], + 'Name' => ['description' => 'The name of the phrases list.', 'type' => 'string', 'required' => true, 'example' => 'fruit_phrase', 'maxLength' => 50, 'minLength' => 1, 'title' => ''], + 'Description' => ['description' => 'The description of the phrases list.', 'type' => 'string', 'example' => 'custom fruit phrases list', 'maxLength' => 250, 'minLength' => 1, 'title' => '', 'required' => false], + 'WordWeights' => ['description' => 'A JSON-formatted string that represents a map of words and their corresponding weights.', 'type' => 'string', 'required' => true, 'example' => '{"苹果":3,"西瓜":3}', 'title' => ''], ], 'required' => false, + 'example' => '', ], ], ], @@ -914,98 +682,72 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '35124E1C-AE99-5D6C-A52E-BD689D8D****', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '35124E1C-AE99-5D6C-A52E-BD689D8D****'], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'A description of the status.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Data' => [ - 'title' => '返回对象。', - 'description' => '', + 'title' => '', + 'description' => 'The returned object.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '操作是否成功。', - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCEEDED', - ], - 'PhraseId' => [ - 'title' => '词表ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'a93b91141c0f422fa114af203f8b****', - ], - 'ErrorCode' => [ - 'title' => '错误码。', - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'ErrorMessage' => [ - 'title' => '错误信息。', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'Status' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'string', 'example' => 'SUCCEEDED', 'title' => ''], + 'PhraseId' => ['description' => 'The ID of the phrases list.', 'type' => 'string', 'title' => '', 'example' => 'a93b91141c0f422fa114af203f8b****'], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'success'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35124E1C-AE99-5D6C-A52E-BD689D8D****\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Status\\": \\"SUCCEEDED\\",\\n \\"PhraseId\\": \\"a93b91141c0f422fa114af203f8b****\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"ErrorMessage\\": \\"success\\"\\n }\\n}","type":"json"}]', - ], - 'GetTranscriptionPhrases' => [ - 'summary' => '查询热词词表信息', - 'path' => '/openapi/tingwu/v2/resources/phrases/{PhraseId}', - 'methods' => [ - 'get', + 'title' => 'Create a hotword vocabulary', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'tingwu:CreateTranscriptionPhrases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'NlsTingwu', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteTranscriptionPhrases' => [ + 'summary' => 'Deletes phrase tables.', + 'path' => '/openapi/tingwu/v2/resources/phrases/{PhraseId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREnls24C81K', 'FEATUREnlsO1I14I'], ], 'parameters' => [ [ 'name' => 'PhraseId', 'in' => 'path', - 'schema' => [ - 'title' => '词表ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a93b91141c0f422fa114af203f8b****', - ], + 'schema' => ['description' => 'Phrase table ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a93b91141c0f422fa114af203f8b****'], ], ], 'responses' => [ @@ -1015,162 +757,72 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '35124E1C-AE99-5D6C-A52E-BD689D8D****', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'Status' => ['description' => 'Is the operation successful?', 'type' => 'string', 'example' => 'SUCCEEDED', 'title' => ''], + 'ErrorCode' => ['description' => 'Error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'title' => '', 'example' => 'success'], 'Data' => [ 'description' => '', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '操作是否成功。', - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCEEDED', - ], - 'ErrorCode' => [ - 'title' => '错误码。', - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'ErrorMessage' => [ - 'title' => '错误信息。', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Phrases' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'PhraseId' => [ - 'title' => '词表ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'a93b91141c0f422fa114af203f8b****', - ], - 'Name' => [ - 'title' => '词表名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'fruit_phrase', - ], - 'Description' => [ - 'title' => '词表描述信息。', - 'description' => '', - 'type' => 'string', - 'example' => 'custom fruit phrases list', - ], - 'WordWeights' => [ - 'title' => '词表里的词和对应的权重，为JSON的Map格式字符串。', - 'description' => '', - 'type' => 'string', - 'example' => '{"苹果":3,"西瓜":3}', - ], - ], - ], - ], + 'Status' => ['title' => 'Indicates whether the operation succeeded.', 'description' => 'Is the operation successful?', 'type' => 'string', 'example' => ''], + 'ErrorCode' => ['title' => 'Error code.', 'description' => 'Error code.', 'type' => 'string', 'example' => ''], + 'ErrorMessage' => ['title' => 'Error message.', 'description' => 'Error message.', 'type' => 'string', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"SUCCEEDED\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Data\\": {\\n \\"Status\\": \\"\\",\\n \\"ErrorCode\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => 'Delete a hotword phrase table', + 'changeSet' => [ + ['createdAt' => '2025-03-12T02:26:22.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35124E1C-AE99-5D6C-A52E-BD689D8D****\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Status\\": \\"SUCCEEDED\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Phrases\\": [\\n {\\n \\"PhraseId\\": \\"a93b91141c0f422fa114af203f8b****\\",\\n \\"Name\\": \\"fruit_phrase\\",\\n \\"Description\\": \\"custom fruit phrases list\\",\\n \\"WordWeights\\": \\"{\\\\\\"苹果\\\\\\":3,\\\\\\"西瓜\\\\\\":3}\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'UpdateTranscriptionPhrases' => [ - 'summary' => '更新热词词表', - 'path' => '/openapi/tingwu/v2/resources/phrases/{PhraseId}', - 'methods' => [ - 'put', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'tingwu:DeleteTranscriptionPhrases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'NlsTingwu', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetTaskInfo' => [ + 'summary' => 'Query the job status and job result. ', + 'path' => '/openapi/tingwu/v2/tasks/{TaskId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREnls24C81K', 'FEATUREnlsO1I14I'], ], 'parameters' => [ [ - 'name' => 'PhraseId', + 'name' => 'TaskId', 'in' => 'path', - 'schema' => [ - 'title' => '词表ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a93b91141c0f422fa114af203f8b****', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => '请求参数body', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '词表名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'fruit_phrase', - 'maxLength' => 50, - 'minLength' => 1, - ], - 'Description' => [ - 'title' => '词表描述信息。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'custom fruit phrases list', - 'maxLength' => 250, - 'minLength' => 1, - ], - 'WordWeights' => [ - 'title' => '词表里的词和对应的权重，为JSON的Map格式字符串。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '{"苹果":3,"西瓜":3}', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The TaskId returned when the job was created.', 'type' => 'string', 'required' => true, 'example' => 'c5394c6ee0fb474899d42215a3925c7e', 'title' => ''], ], ], 'responses' => [ @@ -1180,264 +832,637 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '35124E1C-AE99-5D6C-A52E-BD689D8D****', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID, used only for joint debugging. ', 'type' => 'string', 'example' => '35124E1C-AE99-5D6C-A52E-BD689D8D****'], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'Status description. ', 'type' => 'string', 'example' => 'Success.', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'Returned object. ', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '操作是否成功。', - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCEEDED', - ], - 'ErrorCode' => [ - 'title' => '错误码。', - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'ErrorMessage' => [ - 'title' => '错误信息。', - 'description' => '', - 'type' => 'string', - 'example' => 'success', + 'TaskId' => ['description' => 'Job ID. ', 'type' => 'string', 'example' => 'c5394c6ee0fb474899d42215a3925c7e', 'title' => ''], + 'TaskKey' => ['description' => 'The custom ID set by the user when creating the job.', 'type' => 'string', 'example' => 'task_tingwu_123', 'title' => ''], + 'TaskStatus' => ['description' => 'Task Status.'."\n" + ."\n" + .'- ONGOING: The job is in progress.'."\n" + .'- COMPLETED: The job is completed.'."\n" + .'- FAILED: The job has failed.'."\n" + .'- INVALID: The job is invalid.', 'type' => 'string', 'example' => 'COMPLETED', 'title' => ''], + 'OutputMp3Path' => ['description' => 'URL link to the MP3 conversion result ', 'title' => 'URL link to the MP3 conversion result ', 'type' => 'string', 'example' => 'http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_20231222101008.mp3?Expires=1706064016'], + 'OutputMp4Path' => ['description' => 'URL link to the MP4 conversion result ', 'title' => 'URL link to the MP4 conversion result ', 'type' => 'string', 'example' => 'http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_20231222101008.mp4?Expires=1706064016'], + 'OutputThumbnailPath' => ['description' => 'URL link to the video thumbnail ', 'title' => 'URL link to the video thumbnail ', 'type' => 'string', 'example' => 'http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_20231222101008.png?Expires=1706064016'], + 'OutputSpectrumPath' => ['description' => 'URL link to the audio waveform graph ', 'title' => 'URL link to the audio waveform graph ', 'type' => 'string', 'example' => 'http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_20231222101008.spectrum?Expires=1706064016'], + 'ErrorCode' => ['description' => 'Error code ', 'title' => 'Error code ', 'type' => 'string', 'example' => 'TSC.AudioFormat'], + 'ErrorMessage' => ['description' => 'Error message', 'title' => 'Error message', 'type' => 'string', 'example' => 'Audio format invalid.'], + 'Result' => [ + 'description' => 'A collection of results from various algorithm processing tasks. The result is returned as an HTTP link, which the user can use to parse the native result.', + 'title' => 'A collection of results from various algorithm processing tasks. The result is returned as an HTTP link, which the user can use to parse the native result.', + 'type' => 'object', + 'properties' => [ + 'Transcription' => ['description' => 'Link to the result of speech transcription.', 'title' => 'Link to the result of speech transcription.', 'type' => 'string', 'example' => 'http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_Transcription_20231222101008.json?Expires=1706064016'], + 'AutoChapters' => ['description' => 'Link to the result of the Auto Chapters feature.', 'title' => 'Link to the result of the Auto Chapters feature.', 'type' => 'string', 'example' => 'http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_AutoChapters_20231222101215.json?Expires=1706064016'], + 'MeetingAssistance' => ['description' => 'URL link to the result of Intelligent Meeting Summary', 'title' => 'URL link to the result of Intelligent Meeting Summary', 'type' => 'string', 'example' => 'http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_MeetingAssistance_20231222101112.json?Expires=1706064016'], + 'Summarization' => ['description' => 'Link to the result of LLM-based summarization.', 'title' => 'Link to the result of LLM-based summarization.', 'type' => 'string', 'example' => 'http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_Summarization_20231222101215.json?Expires=1706064016'], + 'Translation' => ['description' => 'URL link to the result of text translation', 'title' => 'URL link to the result of text translation', 'type' => 'string', 'example' => 'http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_Translation_20231222101215.json?Expires=1706064016'], + 'PptExtraction' => ['description' => 'URL link to the result of video PPT extraction and summarization', 'title' => 'Link to the result of Video PPT extraction and summary', 'type' => 'string', 'example' => 'http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_PptExtraction_20231222101215.json?Expires=1706064016'], + 'TextPolish' => ['description' => 'Link to the result of spoken-to-written text conversion', 'title' => 'Link to the result of spoken-to-written text conversion', 'type' => 'string', 'example' => 'http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_TextPolish_20231222101215.json?Expires=1706064016'], + 'CustomPrompt' => ['description' => 'Link to the result of the Custom prompt', 'title' => 'Link to the result of the Custom prompt', 'type' => 'string', 'example' => 'http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_ CustomPrompt_20231222101215.json?Expires=1706064016'], + 'ServiceInspection' => ['description' => 'Link to the result of service inspection', 'title' => 'Link to the result of service inspection', 'type' => 'string', 'example' => 'http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_ ServiceInspection_20231222101215.json?Expires=1706064016'], + 'IdentityRecognition' => ['description' => 'The URL link to the identity recognition result.', 'type' => 'string', 'example' => 'http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_ IdentityRecognition_20231222101215.json?Expires=1706064016', 'title' => ''], + 'ContentExtraction' => ['description' => 'URL link to the result of conversation content extraction', 'type' => 'string', 'example' => 'http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_ ContentExtraction_20231222101215.json?Expires=1706064016', 'title' => ''], + ], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35124E1C-AE99-5D6C-A52E-BD689D8D****\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"Success.\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"c5394c6ee0fb474899d42215a3925c7e\\",\\n \\"TaskKey\\": \\"task_tingwu_123\\",\\n \\"TaskStatus\\": \\"COMPLETED\\",\\n \\"OutputMp3Path\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_20231222101008.mp3?Expires=1706064016\\",\\n \\"OutputMp4Path\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_20231222101008.mp4?Expires=1706064016\\",\\n \\"OutputThumbnailPath\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_20231222101008.png?Expires=1706064016\\",\\n \\"OutputSpectrumPath\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_20231222101008.spectrum?Expires=1706064016\\",\\n \\"ErrorCode\\": \\"TSC.AudioFormat\\",\\n \\"ErrorMessage\\": \\"Audio format invalid.\\",\\n \\"Result\\": {\\n \\"Transcription\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_Transcription_20231222101008.json?Expires=1706064016\\",\\n \\"AutoChapters\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_AutoChapters_20231222101215.json?Expires=1706064016\\",\\n \\"MeetingAssistance\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_MeetingAssistance_20231222101112.json?Expires=1706064016\\",\\n \\"Summarization\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_Summarization_20231222101215.json?Expires=1706064016\\",\\n \\"Translation\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_Translation_20231222101215.json?Expires=1706064016\\",\\n \\"PptExtraction\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_PptExtraction_20231222101215.json?Expires=1706064016\\",\\n \\"TextPolish\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_TextPolish_20231222101215.json?Expires=1706064016\\",\\n \\"CustomPrompt\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_ CustomPrompt_20231222101215.json?Expires=1706064016\\",\\n \\"ServiceInspection\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_ ServiceInspection_20231222101215.json?Expires=1706064016\\",\\n \\"IdentityRecognition\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_ IdentityRecognition_20231222101215.json?Expires=1706064016\\",\\n \\"ContentExtraction\\": \\"http://xxxx.com/tingwu/output/1738248324/094e964bf0e04e39/094e964bf0e04e39_ ContentExtraction_20231222101215.json?Expires=1706064016\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Query Job Status and Job Result', + 'changeSet' => [ + ['createdAt' => '2025-03-31T11:45:07.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-08-15T07:34:12.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-04-12T03:48:09.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-04-10T09:30:27.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-02-23T03:11:30.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-12-25T03:37:16.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35124E1C-AE99-5D6C-A52E-BD689D8D****\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Status\\": \\"SUCCEEDED\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"ErrorMessage\\": \\"success\\"\\n }\\n}","type":"json"}]', - ], - 'DeleteTranscriptionPhrases' => [ - 'summary' => '删除词表', - 'path' => '/openapi/tingwu/v2/resources/phrases/{PhraseId}', - 'methods' => [ - 'delete', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTaskInfo'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'tingwu:GetTaskInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'NlsTingwu', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetTranscriptionPhrases' => [ + 'summary' => 'Queries information about hotword lists.', + 'path' => '/openapi/tingwu/v2/resources/phrases/{PhraseId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'high', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREnls24C81K', - 'FEATUREnlsO1I14I', - ], - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'PhraseId', 'in' => 'path', - 'schema' => [ - 'title' => '词表ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a93b91141c0f422fa114af203f8b****', - ], + 'schema' => ['description' => 'Hotword list ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a93b91141c0f422fa114af203f8b****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '操作是否成功。（暂不使用）', - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCEEDED', - ], - 'ErrorCode' => [ - 'title' => '错误码。（暂不使用）', - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'ErrorMessage' => [ - 'title' => '错误信息。（暂不使用）', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '35124E1C-AE99-5D6C-A52E-BD689D8D****'], + 'Code' => ['description' => 'Status code.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'Status message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Data' => [ + 'description' => 'Response object.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '操作是否成功。', - 'type' => 'string', - ], - 'ErrorCode' => [ - 'title' => '错误码。', - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'title' => '错误信息。', - 'type' => 'string', + 'Status' => ['description' => 'Indicates whether the operation succeeded.', 'type' => 'string', 'example' => 'SUCCEEDED', 'title' => ''], + 'ErrorCode' => ['description' => 'Error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'title' => '', 'example' => 'success'], + 'Phrases' => [ + 'description' => 'Hotword objects.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PhraseId' => ['description' => 'ID of the phrase list.', 'type' => 'string', 'title' => '', 'example' => 'a93b91141c0f422fa114af203f8b****'], + 'Name' => ['description' => 'Hotword list name.', 'type' => 'string', 'example' => 'fruit_phrase', 'title' => ''], + 'Description' => ['description' => 'Hotword list description.', 'type' => 'string', 'example' => 'custom fruit phrases list', 'title' => ''], + 'WordWeights' => ['description' => 'Words and their weights in the hotword list, formatted as a JSON map string.', 'type' => 'string', 'example' => '{"苹果":3,"西瓜":3}', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35124E1C-AE99-5D6C-A52E-BD689D8D****\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Status\\": \\"SUCCEEDED\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Phrases\\": [\\n {\\n \\"PhraseId\\": \\"a93b91141c0f422fa114af203f8b****\\",\\n \\"Name\\": \\"fruit_phrase\\",\\n \\"Description\\": \\"custom fruit phrases list\\",\\n \\"WordWeights\\": \\"{\\\\\\"苹果\\\\\\":3,\\\\\\"西瓜\\\\\\":3}\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query hot word category ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'tingwu:GetTranscriptionPhrases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'NlsTingwu', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"SUCCEEDED\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Data\\": {\\n \\"Status\\": \\"\\",\\n \\"ErrorCode\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\"\\n }\\n}","type":"json"}]', ], 'ListTranscriptionPhrases' => [ - 'summary' => '列举用户所有热词词表信息', + 'summary' => 'Lists all of a user\'s hot phrase lists.', 'path' => '/openapi/tingwu/v2/resources/phrases', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '35124E1C-AE99-5D6C-A52E-BD689D8D****', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '35124E1C-AE99-5D6C-A52E-BD689D8D****'], + 'Code' => ['description' => 'status code.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'status description.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'Response object.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '操作是否成功。', - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCEEDED', - ], - 'ErrorCode' => [ - 'title' => '错误码。', - 'description' => '', - 'type' => 'string', - 'example' => 'PHS.Exceed', - ], - 'ErrorMessage' => [ - 'title' => '错误信息。', - 'description' => '', - 'type' => 'string', - 'example' => 'The num of the phrase exceeds the upper limit.', - ], + 'Status' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'string', 'example' => 'SUCCEEDED', 'title' => ''], + 'ErrorCode' => ['description' => 'error code.', 'type' => 'string', 'title' => '', 'example' => 'PHS.Exceed'], + 'ErrorMessage' => ['description' => 'error message.', 'type' => 'string', 'title' => '', 'example' => 'The num of the phrase exceeds the upper limit.'], 'Phrases' => [ - 'description' => '', + 'description' => 'Phrase objects.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'PhraseId' => [ - 'title' => '词表ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'a93b91141c0f422fa114af203f8b****', - ], - 'Name' => [ - 'title' => '词表名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'fruit_phrase', - ], - 'Description' => [ - 'title' => '词表描述信息。', - 'description' => '', - 'type' => 'string', - 'example' => 'custom fruit phrases list', - ], + 'PhraseId' => ['description' => 'Phrase list ID.', 'type' => 'string', 'title' => '', 'example' => 'a93b91141c0f422fa114af203f8b****'], + 'Name' => ['description' => 'Phrase list name.', 'type' => 'string', 'example' => 'fruit_phrase', 'title' => ''], + 'Description' => ['description' => 'Phrase list description.', 'type' => 'string', 'example' => 'custom fruit phrases list', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35124E1C-AE99-5D6C-A52E-BD689D8D****\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Status\\": \\"SUCCEEDED\\",\\n \\"ErrorCode\\": \\"PHS.Exceed\\",\\n \\"ErrorMessage\\": \\"The num of the phrase exceeds the upper limit.\\",\\n \\"Phrases\\": [\\n {\\n \\"PhraseId\\": \\"a93b91141c0f422fa114af203f8b****\\",\\n \\"Name\\": \\"fruit_phrase\\",\\n \\"Description\\": \\"custom fruit phrases list\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'List hot word dictionaries', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'tingwu:ListTranscriptionPhrases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'NlsTingwu', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'UpdateTranscriptionPhrases' => [ + 'summary' => 'Update a hotword list.', + 'path' => '/openapi/tingwu/v2/resources/phrases/{PhraseId}', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'PhraseId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the hotword list.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a93b91141c0f422fa114af203f8b****'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the hotword list.', 'type' => 'string', 'required' => true, 'example' => 'fruit_phrase', 'maxLength' => 50, 'minLength' => 1, 'title' => ''], + 'Description' => ['description' => 'A description of the hotword list.', 'type' => 'string', 'example' => 'custom fruit phrases list', 'maxLength' => 250, 'minLength' => 1, 'title' => '', 'required' => false], + 'WordWeights' => ['description' => 'A JSON map string that defines hotwords and their weights.', 'type' => 'string', 'required' => true, 'example' => '{"苹果":3,"西瓜":3}', 'title' => ''], + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response schema', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '35124E1C-AE99-5D6C-A52E-BD689D8D****'], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The status message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Data' => [ + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Indicates whether the operation succeeded.', 'type' => 'string', 'example' => 'SUCCEEDED', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'success'], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35124E1C-AE99-5D6C-A52E-BD689D8D****\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Status\\": \\"SUCCEEDED\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"ErrorMessage\\": \\"success\\"\\n }\\n}","type":"json"}]', + 'title' => 'Update the hotword vocabulary', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'tingwu:UpdateTranscriptionPhrases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'NlsTingwu', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], ], 'endpoints' => [ + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'tingwu.cn-beijing.aliyuncs.com', 'endpoint' => 'tingwu.cn-beijing.aliyuncs.com', 'vpc' => 'tingwu-vpc.cn-beijing.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'BRK.InvalidAppKey', 'message' => 'Invalid app key.', 'http_code' => 400, 'description' => 'Invalid project app key.'], + ['code' => 'BRK.InvalidAudioBitRate', 'message' => 'Invalid audio bit rate.', 'http_code' => 400, 'description' => 'Invalid audio sample bit depth.'], + ['code' => 'BRK.InvalidAudioFormat', 'message' => 'Invalid audio format.', 'http_code' => 400, 'description' => 'Invalid audio encoding format.'], + ['code' => 'BRK.InvalidAudioPackage', 'message' => 'Invalid audio package.', 'http_code' => 400, 'description' => 'Invalid audio packaging mode.'], + ['code' => 'BRK.InvalidAudioSampleRate', 'message' => 'Invalid audio sample rate.', 'http_code' => 400, 'description' => 'Invalid audio sample rate.'], + ['code' => 'BRK.InvalidLanguage', 'message' => 'Invalid language.', 'http_code' => 400, 'description' => 'Invalid language model.'], + ['code' => 'BRK.InvalidOssBucket', 'message' => 'Invalid oss bucket.', 'http_code' => 400, 'description' => 'Invalid OSS bucket.'], + ['code' => 'BRK.InvalidOssPath', 'message' => 'Invalid oss path.', 'http_code' => 400, 'description' => 'Invalid OSS path.'], + ['code' => 'BRK.InvalidOutputEnabledSetting', 'message' => 'Invalid output enabled setting.', 'http_code' => 400, 'description' => 'Invalid result return switch settings.'], + ['code' => 'BRK.InvalidResultLevelSetting', 'message' => 'Invalid result level setting.', 'http_code' => 400, 'description' => 'Invalid result return level settings.'], + ['code' => 'BRK.InvalidRoleSplitNum', 'message' => 'Invalid roleSplitNum.', 'http_code' => 400, 'description' => 'Invalid roleSplitNum value.'], + ['code' => 'BRK.InvalidService', 'message' => 'Invalid service.', 'http_code' => 400, 'description' => 'The service has not been enabled under the account.'], + ['code' => 'BRK.InvalidTenant', 'message' => 'Invalid tenant.', 'http_code' => 400, 'description' => 'The service has not been enabled under the account, or an overdue payment exists.'], + ['code' => 'BRK.OverdueService', 'message' => 'Overdue service.', 'http_code' => 400, 'description' => 'The service has not been enabled under the account, or an overdue payment exists.'], + ['code' => 'BRK.OverdueTenant', 'message' => 'Overdue tenant.', 'http_code' => 400, 'description' => 'The service has not been enabled under the account, or an overdue payment exists.'], + ['code' => 'BRK.ServiceLinkedRoleNotExist', 'message' => 'ServiceLinkedRole AliyunServiceRoleForTingwuPaaS not exist.', 'http_code' => 400, 'description' => 'The service-linked role has not been created.'], + ['code' => 'ServerError', 'message' => 'Server error.', 'http_code' => 500, 'description' => 'A system error occurred.'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTask'], + ], + 'createdAt' => '2024-11-22T03:15:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTask'], + ], + 'createdAt' => '2024-09-10T04:56:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTaskInfo'], + ], + 'createdAt' => '2024-08-15T07:34:18.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTask'], + ], + 'createdAt' => '2024-07-29T07:00:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTask'], + ], + 'createdAt' => '2024-06-21T05:43:58.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTask'], + ], + 'createdAt' => '2024-06-14T05:07:18.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTask'], + ], + 'createdAt' => '2024-05-21T11:35:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTask'], + ], + 'createdAt' => '2024-05-20T08:44:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTask'], + ], + 'createdAt' => '2024-05-17T07:14:03.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTask'], + ], + 'createdAt' => '2024-05-15T03:05:52.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTaskInfo'], + ], + 'createdAt' => '2024-04-12T03:48:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTaskInfo'], + ], + 'createdAt' => '2024-04-10T09:30:32.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTask'], + ], + 'createdAt' => '2024-03-18T08:42:22.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateTask'], + ], + 'createdAt' => '2024-03-18T05:50:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTask'], + ], + 'createdAt' => '2024-03-15T07:24:53.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateTask'], + ], + 'createdAt' => '2024-03-12T01:36:58.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTaskInfo'], + ], + 'createdAt' => '2024-02-23T03:11:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTask'], + ], + 'createdAt' => '2024-01-08T06:20:46.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTaskInfo'], + ], + 'createdAt' => '2023-12-25T03:37:20.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTask'], + ], + 'createdAt' => '2023-12-19T10:53:59.000Z', + 'description' => '', + ], [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'tingwu.cn-beijing.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTask'], + ], + 'createdAt' => '2023-12-18T13:17:49.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTask'], + ], + 'createdAt' => '2023-12-11T06:35:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTask'], + ], + 'createdAt' => '2023-11-20T08:13:48.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTask'], + ], + 'createdAt' => '2023-11-16T03:05:26.000Z', + 'description' => '', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTaskInfo'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTask'], + ], + ], + 'ram' => [ + 'productCode' => 'NlsTingwu', + 'productName' => 'Intelligent Speech Interaction', + 'ramCodes' => ['tingwu'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'ListTranscriptionPhrases', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'tingwu:ListTranscriptionPhrases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'NlsTingwu', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetTranscriptionPhrases', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'tingwu:GetTranscriptionPhrases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'NlsTingwu', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteTranscriptionPhrases', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'tingwu:DeleteTranscriptionPhrases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'NlsTingwu', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateTranscriptionPhrases', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'tingwu:UpdateTranscriptionPhrases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'NlsTingwu', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetTaskInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'tingwu:GetTaskInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'NlsTingwu', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'tingwu:CreateTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'NlsTingwu', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateTranscriptionPhrases', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'tingwu:CreateTranscriptionPhrases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'NlsTingwu', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'resourceTypes' => [], ], ]; |