summaryrefslogtreecommitdiff
path: root/data/en_us/tingwu/2022-09-30/api-docs.php
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/tingwu/2022-09-30/api-docs.php
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/tingwu/2022-09-30/api-docs.php')
-rw-r--r--data/en_us/tingwu/2022-09-30/api-docs.php1215
1 files changed, 526 insertions, 689 deletions
diff --git a/data/en_us/tingwu/2022-09-30/api-docs.php b/data/en_us/tingwu/2022-09-30/api-docs.php
index ede4249..51ab44a 100644
--- a/data/en_us/tingwu/2022-09-30/api-docs.php
+++ b/data/en_us/tingwu/2022-09-30/api-docs.php
@@ -1,56 +1,34 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'ROA',
- 'product' => 'tingwu',
- 'version' => '2022-09-30',
- ],
+ 'info' => ['style' => 'ROA', 'product' => 'tingwu', 'version' => '2022-09-30'],
'directories' => [
[
- 'id' => 172030,
- 'title' => null,
+ 'children' => ['CreateMeetingTrans', 'GetMeetingTrans', 'StopMeetingTrans'],
'type' => 'directory',
- 'children' => [
- 'CreateMeetingTrans',
- 'GetMeetingTrans',
- 'StopMeetingTrans',
- ],
+ 'title' => 'Real-time meeting transcription',
],
[
- 'id' => 172031,
- 'title' => null,
+ 'children' => ['CreateFileTrans', 'GetFileTrans'],
'type' => 'directory',
- 'children' => [
- 'CreateFileTrans',
- 'GetFileTrans',
- ],
+ 'title' => 'Meeting audio and video file transcription',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'CreateMeetingTrans' => [
- 'summary' => '创建实时会议',
- 'path' => '/openapi/meeting-trans',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateFileTrans' => [
+ 'summary' => 'Create an audio or video transcription task.',
+ 'path' => '/openapi/file-trans',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
@@ -60,42 +38,143 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'title' => '请求body。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Request body.',
'type' => 'object',
'properties' => [
- 'AppKey' => [
- 'title' => '管控台创建的项目AppKey。',
- 'description' => '',
+ 'AppKey' => ['description' => 'AppKey of the project created in the console.', 'type' => 'string', 'required' => true, 'example' => 'JV1sRTisRMi****', 'title' => ''],
+ 'TransKey' => ['description' => 'Custom task identifier. This value is returned unchanged in task queries or task completion callbacks.', 'type' => 'string', 'example' => 'trans_123', 'title' => '', 'required' => false],
+ 'AudioOssBucket' => ['description' => 'OSS bucket where the audio file to be transcribed is stored.', 'type' => 'string', 'required' => false, 'example' => 'bucket', 'title' => ''],
+ 'AudioOssPath' => ['description' => 'OSS file path of the audio to be transcribed, or a custom downloadable URL (http|https). If AudioOssBucket is not empty, provide the OSS file path (...../*.mp3). If AudioOssBucket is empty, provide a custom downloadable URL (http\\://……/*.mp3).', 'type' => 'string', 'required' => true, 'example' => 'dir1/dir2/filename'."\n"
+ .'http://……/*.mp3', 'title' => ''],
+ 'AudioLanguage' => [
+ 'description' => 'Language model used for audio transcription.'."\n"
+ .'cn: Chinese.'."\n"
+ .'en: English.'."\n"
+ .'yue: Cantonese.'."\n"
+ .'fspk: Mixed Chinese and English.',
'type' => 'string',
'required' => true,
- 'example' => 'JV1sRTisRMi****',
- ],
- 'MeetingKey' => [
- 'title' => '用户设置的会议标识，在会中查询或会后结束回调时会原样返回。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'meeting_123',
+ 'example' => 'cn',
+ 'enum' => [],
+ 'title' => '',
+ ],
+ 'AudioRoleNum' => ['description' => 'Enable speaker diarization. Note: Only effective for audio with a sample rate of 16 kHz or higher.'."\n"
+ .'Not set: Speaker diarization is disabled.'."\n"
+ .'0: Speaker diarization with an unspecified number of speakers.'."\n"
+ .'2: Speaker diarization for exactly 2 speakers.', 'type' => 'string', 'example' => '2', 'title' => '', 'required' => false],
+ 'AudioOutputEnabled' => ['description' => 'Enable MP3 audio transcoding. Default is false.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'],
+ 'AudioOutputOssBucket' => ['description' => 'OSS bucket where transcoded audio is stored when audio transcoding is enabled. Must match the OSS bucket configured for the project in the console.', 'type' => 'string', 'example' => 'bucket', 'title' => '', 'required' => false],
+ 'AudioOutputOssPath' => ['description' => 'OSS file path where transcoded audio is stored when audio transcoding is enabled. The path must start with "tingwu/".', 'type' => 'string', 'example' => 'tingwu/dir/filename', 'title' => '', 'required' => false],
+ 'VideoOutputEnabled' => ['title' => 'Indicates whether MP4 format video conversion is enabled to transform non-MP4 videos into MP4 format. Default value: false.', 'description' => 'Enable video transcoding. Default is false.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false'],
+ 'VideoOutputOssBucket' => ['title' => 'The OSS Bucket to which the converted video is written when MP4 video conversion is enabled.', 'description' => 'OSS bucket where transcoded video is stored when video transcoding is enabled. Must match the OSS bucket configured for the project in the console.', 'type' => 'string', 'example' => 'bucket', 'required' => false],
+ 'VideoOutputOssPath' => ['title' => 'When MP4 video transcoding is enabled, this specifies the OSS path to which the transcoded video is written. ', 'description' => 'OSS file path where transcoded video is stored when video transcoding is enabled. The path must start with "tingwu/".', 'type' => 'string', 'example' => 'tingwu/dir/filename'."\n", 'required' => false],
+ 'TransResultOssBucket' => ['description' => 'OSS bucket where transcription and intelligent extraction results are stored. Must match the OSS bucket configured for the project in the console.', 'type' => 'string', 'required' => true, 'example' => 'bucket', 'title' => ''],
+ 'TransResultOssPath' => ['description' => 'OSS file path where transcription and intelligent extraction results are stored. The path must start with "tingwu/".', 'type' => 'string', 'required' => true, 'example' => 'tingwu/dir/filename', 'title' => ''],
+ 'AudioSegmentsEnabled' => ['description' => 'Enable writing detected valid audio segments to output. Default is false.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'],
+ 'Tags' => ['description' => 'System extension: tags', 'type' => 'object', 'required' => false, 'title' => '', 'example' => ''],
+ 'AsrParams' => ['description' => 'Additional ASR transcription parameters, such as hotword vocabulary\\_id.', 'type' => 'object', 'required' => false, 'example' => '{'."\n"
+ .' "vocabulary_id": "e2a9a9be3128417fb4d181ebfbe8****"'."\n"
+ .'}', 'title' => ''],
+ 'LabParams' => ['description' => 'System extension: experimental transcription parameters', 'type' => 'object', 'required' => false, 'title' => '', 'example' => ''],
+ 'AbilityParams' => ['description' => 'Capability extension', 'type' => 'object', 'required' => false, 'title' => '', 'example' => ''],
+ ],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'Request ID, for debugging only.', 'type' => 'string', 'example' => '35124E1C-AE99-5D6C-A52E-BD689D8D****', 'title' => ''],
+ 'Code' => ['description' => 'Status code.', 'type' => 'string', 'example' => '0', 'title' => ''],
+ 'Message' => ['description' => 'Status message.', 'type' => 'string', 'example' => 'Success.', 'title' => ''],
+ 'Data' => [
+ 'title' => '',
+ 'description' => 'Response object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TransId' => ['description' => 'Task ID.', 'type' => 'string', 'example' => 'f7de74778d94422283534102dfc0****', 'title' => ''],
+ 'TransKey' => ['description' => 'Task identifier set by the user when creating the task.', 'type' => 'string', 'example' => 'trans_123', 'title' => ''],
+ ],
+ 'example' => '',
],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35124E1C-AE99-5D6C-A52E-BD689D8D****\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"Success.\\",\\n \\"Data\\": {\\n \\"TransId\\": \\"f7de74778d94422283534102dfc0****\\",\\n \\"TransKey\\": \\"trans_123\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Create a file transcription job ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-03T14:00:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-05-16T15:41:27.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-04-21T03:07:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-12-16T02:17:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-11-07T03:01:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-10-20T11:18:30.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2022-10-08T22:47:31.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-09-22T07:26:27.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-09-21T02:44:37.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'tingwu:CreateFileTrans',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NlsTingwu', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CreateMeetingTrans' => [
+ 'summary' => 'Create a real-time meeting. ',
+ 'path' => '/openapi/meeting-trans',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Request body. ',
+ 'type' => 'object',
+ 'properties' => [
+ 'AppKey' => ['title' => '', 'description' => 'The AppKey of the project created in the console.', 'type' => 'string', 'required' => true, 'example' => 'JV1sRTisRMi****'],
+ 'MeetingKey' => ['title' => '', 'description' => 'The meeting identity set by the User, which will be returned unchanged in queries during the meeting or in the End callback after the meeting.', 'type' => 'string', 'required' => false, 'example' => 'meeting_123'],
'AudioFormat' => [
- 'title' => '音频编码格式，PCM（无压缩的PCM文件或WAV文件）或OPUS（压缩的OPUS文件）。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Audio encoding format: PCM (uncompressed PCM or WAV file) or OPUS (compressed OPUS file). ',
'type' => 'string',
'required' => true,
'example' => 'pcm',
'enum' => [],
],
- 'AudioPackage' => [
- 'title' => '音频打包方式，基于听悟约定的Protobuf格式封装多路音频流时设置为multi。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'multi',
- ],
+ 'AudioPackage' => ['title' => '', 'description' => 'Audio packaging method. Set to "multi" when encapsulating multiple audio streams using the Protobuf format based on the Tingwu convention.', 'type' => 'string', 'required' => false, 'example' => 'multi'],
'AudioSampleRate' => [
- 'title' => '音频采样率，当前支持：16000。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Audio sampling rate. Currently supported values are 16000 and 8000 (8000 supports only single-channel Chinese audio). ',
'type' => 'integer',
'format' => 'int32',
'required' => true,
@@ -103,8 +182,8 @@
'enum' => [],
],
'AudioBitRate' => [
- 'title' => '会议上传音频采样位数，当前支持：16。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Audio bit depth for meeting uploads. Currently supported value is 16. ',
'type' => 'integer',
'format' => 'int32',
'required' => true,
@@ -112,32 +191,24 @@
'enum' => [],
],
'AudioLanguage' => [
- 'title' => '音频转写使用的语言模型。'."\n"
- .'cn：中文。'."\n"
- .'en：英文。'."\n"
- .'yue：粤语。'."\n"
- .'fspk：中英文自由说。'."\n"
- .'multi：动态语言切换。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The language model used for Audio transcription. '."\n"
+ .'cn: Chinese. '."\n"
+ .'en: English. '."\n"
+ .'yue: Cantonese. '."\n"
+ .'fspk: Free switching between Chinese and English.',
'type' => 'string',
'required' => true,
'example' => 'cn',
'enum' => [],
],
- 'RealtimeResultEnabled' => [
- 'title' => '是否开启会中实时结果返回，默认是true。',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'false',
- ],
+ 'RealtimeResultEnabled' => ['title' => '', 'description' => 'Specifies whether to enable real-time result return during the meeting. The default value is true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
'RealtimeResultLevel' => [
- 'title' => '开启会中实时结果返回时，设置识别结果返回等级，默认是1。'."\n"
- .'0：不返回识别结果。'."\n"
- .'1：识别出完整句子时返回识别结果。'."\n"
- .'2：识别出中间结果及完整句子时返回识别结果。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'When real-time result return during a meeting is enabled, this parameter sets the level of recognition result returned. The default value is 1. '."\n"
+ .'0: Do not return recognition results. '."\n"
+ .'1: Return recognition results when complete sentences are detected. '."\n"
+ .'2: Return recognition results for both intermediate and complete sentences.',
'type' => 'integer',
'format' => 'int32',
'required' => false,
@@ -146,11 +217,11 @@
'enum' => [],
],
'RealtimeActiveResultLevel' => [
- 'title' => '开启会中实时结果返回且音频打包方式为multi时，设置发言人识别结果返回等级，默认是1。'."\n"
- .'0：不返回识别结果。'."\n"
- .'1：识别出完整句子时返回识别结果。'."\n"
- .'2：识别出中间结果及完整句子时返回识别结果。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'When real-time result return during the meeting is enabled and the audio packaging method is set to multi, this parameter specifies the level of speaker identification result return. The default value is 1. '."\n"
+ .'0: Do not return Classification Result. '."\n"
+ .'1: Return Classification Result when a complete sentence is detected. '."\n"
+ .'2: Return Classification Result for both intermediate results and complete sentences.',
'type' => 'integer',
'format' => 'int32',
'required' => false,
@@ -158,133 +229,32 @@
'default' => '1',
'enum' => [],
],
- 'AudioOutputEnabled' => [
- 'title' => '是否开启mp3格式音频同步转码，默认是false。',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
- ],
- 'AudioOutputOssBucket' => [
- 'title' => '开启音频同步转码时，转码音频写入到的OSS Bucket，需要与管控台项目配置的OSS Bucket一致。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'bucket',
- ],
- 'AudioOutputOssPath' => [
- 'title' => '开启音频同步转码时，转码音频写入到的OSS文件路径，需要以"tingwu/"为前缀。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tingwu/dir/filename',
- ],
- 'MeetingResultEnabled' => [
- 'title' => '是否开启会后智能提取，默认是false。',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
- ],
- 'MeetingResultOssBucket' => [
- 'title' => '开启会后智能提取时，提取结果写入到的OSS Bucket，需要与管控台项目配置的OSS Bucket一致。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'bucket',
- ],
- 'MeetingResultOssPath' => [
- 'title' => '开启会后智能提取时，提取结果写入到的OSS文件路径，需要以"tingwu/"为前缀。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tingwu/dir/filename',
- ],
- 'DocResultEnabled' => [
- 'title' => '开启会后智能提取时，是否会中识别结果写入，默认是false。',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
- ],
- 'AudioSegmentsEnabled' => [
- 'title' => '开启会后智能提取时，是否开启有效音频片断检测结果写入，默认是false。',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
- ],
- 'TranslateResultEnabled' => [
- 'title' => '是否开启会中翻译，默认是false。',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
- ],
- 'TranslateLanguages' => [
- 'title' => '翻译目标语言集合，多个语言间用英文逗号","分隔，当前支持cn、en。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn,en',
- ],
- 'TranslateResultLevel' => [
- 'title' => '单通道识别或多通道mix流识别结果翻译等级。0：不返回翻译结果。 1：识别出完整句子时返回翻译结果。 2：识别出中间结果及完整句子时返回翻译结果。默认是1。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- 'default' => '1',
- ],
- 'TranslateActiveResultLevel' => [
- 'title' => '多通道Active流识别结果翻译等级。0：不返回翻译结果。 1：识别出完整句子时返回翻译结果。 2：识别出中间结果及完整句子时返回翻译结果。默认是1。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- 'default' => '1',
- ],
- 'RealtimeResultWordsEnabled' => [
- 'title' => '会中识别消息是否包含words信息，默认是true。',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'true',
- ],
- 'RealtimeResultMeetingInfoEnabled' => [
- 'title' => '会中识别消息结果header中是否包含MeetingKey、MeetingId，默认是false。',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'false',
- ],
- 'Tags' => [
- 'type' => 'object',
- 'required' => false,
- ],
- 'AsrParams' => [
- 'type' => 'object',
- 'required' => false,
- ],
- 'LabParams' => [
- 'type' => 'object',
- 'required' => false,
- ],
- 'AbilityParams' => [
- 'type' => 'object',
- 'required' => false,
- ],
+ 'AudioOutputEnabled' => ['title' => '', 'description' => 'Specifies whether to enable real-time transcoding to MP3 format. Default is false. ', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
+ 'AudioOutputOssBucket' => ['title' => '', 'description' => 'When audio synchronization and transcoding are enabled, the OSS Bucket to which the transcoded audio is written. This must match the OSS Bucket configured in the project settings in the console. ', 'type' => 'string', 'required' => false, 'example' => 'bucket'],
+ 'AudioOutputOssPath' => ['title' => '', 'description' => 'When audio synchronization transcoding is enabled, this parameter specifies the OSS file path to which the transcoded audio is written. The path must have the prefix "tingwu/".', 'type' => 'string', 'required' => false, 'example' => 'tingwu/dir/filename'],
+ 'MeetingResultEnabled' => ['title' => '', 'description' => 'Whether to enable Intelligent post-meeting extraction. The default value is false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
+ 'MeetingResultOssBucket' => ['title' => '', 'description' => 'The OSS Bucket to which the extraction results are written when Intelligent post-meeting extraction is enabled. It must match the OSS Bucket configured for the project in the console.', 'type' => 'string', 'required' => false, 'example' => 'bucket'],
+ 'MeetingResultOssPath' => ['title' => '', 'description' => 'The OSS File Path to which the extraction results are written when Intelligent post-meeting extraction is enabled. It must have the prefix "tingwu/".', 'type' => 'string', 'required' => false, 'example' => 'tingwu/dir/filename'],
+ 'DocResultEnabled' => ['title' => '', 'description' => 'When Intelligent Post-meeting Extraction is enabled, specifies whether in-meeting recognition results are written. Default is false. ', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
+ 'AudioSegmentsEnabled' => ['title' => '', 'description' => 'When post-meeting intelligent fetch is enabled, this parameter specifies whether to enable writing detection results of valid audio segments. The default value is false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
+ 'TranslateResultEnabled' => ['title' => '是否开启会中翻译，默认是false。', 'description' => 'Specifies whether to enable in-meeting translation. Default is false. ', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
+ 'TranslateLanguages' => ['title' => '翻译目标语言集合，多个语言间用英文逗号","分隔，当前支持cn、en。', 'description' => 'Collection of target languages for translation. Separate multiple languages with a comma (","). Currently supported languages are cn and en. ', 'type' => 'string', 'required' => false, 'example' => 'cn,en'],
+ 'TranslateResultLevel' => ['title' => '单通道识别或多通道mix流识别结果翻译等级。0：不返回翻译结果。 1：识别出完整句子时返回翻译结果。 2：识别出中间结果及完整句子时返回翻译结果。默认是1。', 'description' => 'Translation Level for single-channel detection or multi-channel mixed stream detection results. '."\n"
+ .'0: Do not return translation results. '."\n"
+ .'1: Return translation results when a complete sentence is detected. '."\n"
+ .'2: Return translation results for both intermediate results and complete sentences. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'default' => '1'],
+ 'TranslateActiveResultLevel' => ['title' => '多通道Active流识别结果翻译等级。0：不返回翻译结果。 1：识别出完整句子时返回翻译结果。 2：识别出中间结果及完整句子时返回翻译结果。默认是1。', 'description' => 'Translation Level for multi-channel Active stream recognition results. 0: Do not return translation results. 1: Return translation results when a complete sentence is recognized. 2: Return translation results for both intermediate and complete sentences. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'default' => '1'],
+ 'RealtimeResultWordsEnabled' => ['title' => '会中识别消息是否包含words信息，默认是true。', 'description' => 'Whether the in-meeting recognition message includes words information. The default value is true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
+ 'RealtimeResultMeetingInfoEnabled' => ['title' => '会中识别消息结果header中是否包含MeetingKey、MeetingId，默认是false。', 'description' => 'Specifies whether MeetingKey and MeetingId are included in the header of real-time recognition message results during the meeting. The default value is false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
+ 'Tags' => ['type' => 'object', 'required' => false, 'description' => 'System extension: tag ', 'title' => '', 'example' => ''],
+ 'AsrParams' => ['type' => 'object', 'required' => false, 'description' => 'Additional parameters for ASR transcription, such as vocabulary_id for hotwords. ', 'example' => '{'."\n"
+ .' "vocabulary_id": "e2a9a9be3128417fb4d181ebfbe8****"'."\n"
+ .'}', 'title' => ''],
+ 'LabParams' => ['type' => 'object', 'required' => false, 'description' => 'System extension: experiment transcription parameters', 'title' => '', 'example' => ''],
+ 'AbilityParams' => ['type' => 'object', 'required' => false, 'description' => 'Capability extension', 'title' => '', 'example' => ''],
],
'required' => false,
+ 'example' => '',
],
],
],
@@ -295,606 +265,473 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID，仅用于联调。',
- 'description' => '',
- 'type' => 'string',
- 'example' => '35124E1C-AE99-5D6C-A52E-BD689D8D****',
- ],
- 'Code' => [
- 'title' => '状态码。',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Message' => [
- 'title' => '状态说明。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Success.',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Request ID, for joint debugging only. ', 'type' => 'string', 'example' => '35124E1C-AE99-5D6C-A52E-BD689D8D****'],
+ 'Code' => ['title' => '', 'description' => 'Status code. ', 'type' => 'string', 'example' => '0'],
+ 'Message' => ['title' => '', 'description' => 'Status description. ', 'type' => 'string', 'example' => 'Success.'],
'Data' => [
- 'title' => '返回对象。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Returned object. ',
'type' => 'object',
'properties' => [
- 'MeetingId' => [
- 'title' => '会议ID。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'f7de74778d94422283534102dfc0****',
- ],
- 'MeetingJoinUrl' => [
- 'title' => '会议语音推流地址。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'wss://tingwu-realtime-cn-beijing.aliyuncs.com/api/ws/v1?mc=****',
- ],
- 'MeetingKey' => [
- 'title' => '用户创建会议时设置的会议标识。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'meeting_123',
- ],
+ 'MeetingId' => ['title' => '', 'description' => 'Meeting ID. ', 'type' => 'string', 'example' => 'f7de74778d94422283534102dfc0****'],
+ 'MeetingJoinUrl' => ['title' => '', 'description' => 'Audio ingest URL for the meeting. ', 'type' => 'string', 'example' => 'wss://tingwu-realtime-cn-beijing.aliyuncs.com/api/ws/v1?mc=****'],
+ 'MeetingKey' => ['title' => '', 'description' => 'Meeting identity set by the User when creating the meeting. ', 'type' => 'string', 'example' => 'meeting_123'],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35124E1C-AE99-5D6C-A52E-BD689D8D****\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"Success.\\",\\n \\"Data\\": {\\n \\"MeetingId\\": \\"f7de74778d94422283534102dfc0****\\",\\n \\"MeetingJoinUrl\\": \\"wss://tingwu-realtime-cn-beijing.aliyuncs.com/api/ws/v1?mc=****\\",\\n \\"MeetingKey\\": \\"meeting_123\\"\\n }\\n}","type":"json"}]',
- ],
- 'GetMeetingTrans' => [
- 'summary' => '查询实时会议信息',
- 'path' => '/openapi/meeting-trans/{MeetingId}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Create a real-time meeting ',
+ 'changeSet' => [
+ ['createdAt' => '2023-05-16T15:41:27.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2022-11-07T03:01:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-10-20T11:18:30.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2022-10-08T22:47:31.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2022-09-22T07:26:27.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-09-21T02:44:37.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'tingwu:CreateMeetingTrans',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NlsTingwu', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetFileTrans' => [
+ 'summary' => 'Query audio and video transcription job information.',
+ 'path' => '/openapi/file-trans/{TransId}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'MeetingId',
+ 'name' => 'TransId',
'in' => 'path',
- 'schema' => [
- 'title' => '会议ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'meeting_123',
- ],
+ 'schema' => ['title' => '', 'description' => 'Job ID.', 'type' => 'string', 'required' => true, 'example' => 'trans_123'],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID，仅用于联调。',
- 'description' => '',
- 'type' => 'string',
- 'example' => '35124E1C-AE99-5D6C-A52E-BD689D8D****',
- ],
- 'Code' => [
- 'title' => '状态码。',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Message' => [
- 'title' => '状态说明。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Success.',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Request ID, used only for joint debugging.', 'type' => 'string', 'example' => '35124E1C-AE99-5D6C-A52E-BD689D8D****'],
+ 'Code' => ['title' => '', 'description' => 'Status code.', 'type' => 'string', 'example' => '0'],
+ 'Message' => ['title' => '', 'description' => 'Status description.', 'type' => 'string', 'example' => 'Success.'],
'Data' => [
- 'title' => '返回对象。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Returned object.',
'type' => 'object',
'properties' => [
- 'MeetingId' => [
- 'title' => '会议ID。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'f7de74778d94422283534102dfc0****',
- ],
- 'MeetingStatus' => [
- 'title' => '会议状态。'."\n"
- .'NEW：新会议。'."\n"
- .'ONGOING：会议转写中。'."\n"
- .'PAUSED：会议转写暂停。'."\n"
- .'PRE_COMPLETE：会议转写结束后，进行会后智能提取。'."\n"
- .'COMPLETED：会议完成。'."\n"
- .'FAILED：会议转写结束后，会后智能提取失败。'."\n"
- .'INVALID：无效会议。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'COMPLETED',
- ],
- 'MeetingKey' => [
- 'title' => '用户创建会议时设置的会议标识。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'meeting_123',
- ],
+ 'TransId' => ['title' => '', 'description' => 'Job ID.', 'type' => 'string', 'example' => 'f7de74778d94422283534102dfc0****'],
+ 'TransStatus' => ['title' => '', 'description' => 'Job Status. '."\n"
+ .'ONGOING: The job is in progress. '."\n"
+ .'COMPLETED: The job is completed. '."\n"
+ .'FAILED: The job failed. '."\n"
+ .'INVALID: Invalid job.', 'type' => 'string', 'example' => 'ONGOING'],
+ 'TransKey' => ['title' => '', 'description' => 'The task identifier set by the User when creating the Job.', 'type' => 'string', 'example' => 'trans_123'],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35124E1C-AE99-5D6C-A52E-BD689D8D****\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"Success.\\",\\n \\"Data\\": {\\n \\"MeetingId\\": \\"f7de74778d94422283534102dfc0****\\",\\n \\"MeetingStatus\\": \\"COMPLETED\\",\\n \\"MeetingKey\\": \\"meeting_123\\"\\n }\\n}","type":"json"}]',
- ],
- 'StopMeetingTrans' => [
- 'summary' => '结束实时会议',
- 'path' => '/openapi/meeting-trans/{MeetingId}/stop',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35124E1C-AE99-5D6C-A52E-BD689D8D****\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"Success.\\",\\n \\"Data\\": {\\n \\"TransId\\": \\"f7de74778d94422283534102dfc0****\\",\\n \\"TransStatus\\": \\"ONGOING\\",\\n \\"TransKey\\": \\"trans_123\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Query file transcription job status',
+ 'changeSet' => [
+ ['createdAt' => '2022-10-20T11:18:30.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2022-10-08T22:47:31.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-09-21T02:44:37.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'tingwu:GetFileTrans',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NlsTingwu', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetMeetingTrans' => [
+ 'summary' => 'Query real-time meeting information.',
+ 'path' => '/openapi/meeting-trans/{MeetingId}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => [],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'MeetingId',
'in' => 'path',
- 'schema' => [
- 'title' => '会议ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'meeting_123',
- ],
- ],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'MeetingRoleNum' => [
- 'title' => '会后进行识别结果角色区分人数，在AudioOutputEnabled=true、MeetingResultEnabled=true且DocResultEnabled=true 时生效，默认是1。'."\n"
- .'0：按多人进行角色区分。'."\n"
- .'1：按1人进行角色区分，即不区分。'."\n"
- .'2：按2人进行角色区分。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
- 'OnlyRoleSplitResult' => [
- 'title' => '会后结果中docResult字段是否只存储角色时间戳映射信息，即不带转写文字结果，默认是false。',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
- ],
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '', 'description' => 'Meeting ID.', 'type' => 'string', 'required' => true, 'example' => 'f7de74778d94422283534102dfc0****'],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID，仅用于联调。',
- 'description' => '',
- 'type' => 'string',
- 'example' => '35124E1C-AE99-5D6C-A52E-BD689D8D****',
- ],
- 'Code' => [
- 'title' => '状态码。',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Message' => [
- 'title' => '状态说明。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Success.',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Request ID, used only for joint debugging.', 'type' => 'string', 'example' => '35124E1C-AE99-5D6C-A52E-BD689D8D****'],
+ 'Code' => ['title' => '', 'description' => 'Status code.', 'type' => 'string', 'example' => '0'],
+ 'Message' => ['title' => '', 'description' => 'Status description.', 'type' => 'string', 'example' => 'Success.'],
'Data' => [
- 'title' => '返回对象。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Returned object.',
'type' => 'object',
'properties' => [
- 'MeetingId' => [
- 'title' => '会议ID。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'f7de74778d94422283534102dfc0****',
- ],
- 'MeetingStatus' => [
- 'title' => '会议状态。'."\n"
- .'NEW：新会议。'."\n"
- .'ONGOING：会议转写中。'."\n"
- .'PAUSED：会议转写暂停。'."\n"
- .'PRE_COMPLETE：会议转写结束后，进行会后智能提取。'."\n"
- .'COMPLETED：会议完成。'."\n"
- .'FAILED：会议转写结束后，会后智能提取失败。'."\n"
- .'INVALID：无效会议。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PRE_COMPLETE',
- ],
- 'MeetingKey' => [
- 'title' => '用户创建会议时设置的会议标识。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'meeting_123',
- ],
+ 'MeetingId' => ['title' => '', 'description' => 'Meeting ID.', 'type' => 'string', 'example' => 'f7de74778d94422283534102dfc0****'],
+ 'MeetingStatus' => ['title' => '', 'description' => 'Meeting status. '."\n"
+ .'NEW: New meeting. '."\n"
+ .'ONGOING: Meeting transcription in progress. '."\n"
+ .'PAUSED: Meeting transcription paused. '."\n"
+ .'PRE_COMPLETE: Post-meeting intelligent extraction in progress after transcription ends. '."\n"
+ .'COMPLETED: Meeting completed. '."\n"
+ .'FAILED: Post-meeting intelligent extraction failed after transcription ends. '."\n"
+ .'INVALID: Invalid meeting.', 'type' => 'string', 'example' => 'COMPLETED'],
+ 'MeetingKey' => ['title' => '', 'description' => 'Meeting identity set by the User when creating the meeting.', 'type' => 'string', 'example' => 'meeting_123'],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35124E1C-AE99-5D6C-A52E-BD689D8D****\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"Success.\\",\\n \\"Data\\": {\\n \\"MeetingId\\": \\"f7de74778d94422283534102dfc0****\\",\\n \\"MeetingStatus\\": \\"PRE_COMPLETE\\",\\n \\"MeetingKey\\": \\"meeting_123\\"\\n }\\n}","type":"json"}]',
- ],
- 'CreateFileTrans' => [
- 'summary' => '创建音视频转写任务',
- 'path' => '/openapi/file-trans',
- 'methods' => [
- 'put',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35124E1C-AE99-5D6C-A52E-BD689D8D****\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"Success.\\",\\n \\"Data\\": {\\n \\"MeetingId\\": \\"f7de74778d94422283534102dfc0****\\",\\n \\"MeetingStatus\\": \\"COMPLETED\\",\\n \\"MeetingKey\\": \\"meeting_123\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Query real-time meeting status',
+ 'changeSet' => [
+ ['createdAt' => '2022-10-20T11:18:30.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2022-10-08T22:47:31.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-09-21T02:44:37.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'tingwu:GetMeetingTrans',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NlsTingwu', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'StopMeetingTrans' => [
+ 'summary' => 'End a real-time meeting.',
+ 'path' => '/openapi/meeting-trans/{MeetingId}/stop',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
+ 'name' => 'MeetingId',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'Meeting ID.', 'type' => 'string', 'required' => true, 'example' => 'meeting_123'],
+ ],
+ [
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'title' => '请求body。',
- 'description' => '',
+ 'description' => 'Request body.',
'type' => 'object',
'properties' => [
- 'AppKey' => [
- 'title' => '管控台创建的项目AppKey。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'JV1sRTisRMi****',
- ],
- 'TransKey' => [
- 'title' => '用户设置的任务标识，在任务查询或任务结束回调时会原样返回。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'trans_123',
- ],
- 'AudioOssBucket' => [
- 'title' => '需要转写音频所在的OSS Bucket。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'bucket',
- ],
- 'AudioOssPath' => [
- 'title' => '需要转写音频所在的OSS文件路径或者自定义可下载文件地址（http|https）。如果AudioOssBucket非空，则需要赋值OSS文件路径（/...../*.mp3）；如果AudioOssBucket为空，则需要赋值自定义可下载文件地址（http://……/*.mp3）。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'dir1/dir2/filename',
- ],
- 'AudioLanguage' => [
- 'title' => '音频转写使用的语言模型。'."\n"
- .'cn：中文。'."\n"
- .'en：英文。'."\n"
- .'yue：粤语。'."\n"
- .'fspk：中英文自由说。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn',
- 'enum' => [],
- ],
- 'AudioRoleNum' => [
- 'title' => '是否开启说话人角色区分。注，只对16K及以上采样率生效'."\n"
- .'不设置：不使用说话人角色区分。'."\n"
- .'0：说话人角色区分结果为不定人数。'."\n"
- .'2：说话人角色区分结果为2人。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2',
- ],
- 'AudioOutputEnabled' => [
- 'title' => '是否开启mp3格式音频转码，默认是false。',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
- ],
- 'AudioOutputOssBucket' => [
- 'title' => '开启音频转码时，转码音频写入到的OSS Bucket。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'bucket',
- ],
- 'AudioOutputOssPath' => [
- 'title' => '开启音频转码时，转码音频写入到的OSS文件路径。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tingwu/dir/filename',
- ],
- 'VideoOutputEnabled' => [
- 'title' => '是否开启mp4格式视频转换，用以将非mp4视频转成mp4格式，默认是false。',
- 'type' => 'boolean',
- 'default' => 'false',
- ],
- 'VideoOutputOssBucket' => [
- 'title' => '开启mp4视频转换时，转换后视频写入到的OSS Bucket。',
- 'type' => 'string',
- 'example' => 'bucket',
- ],
- 'VideoOutputOssPath' => [
- 'title' => '开启mp4视频转换时，转换后视频写入到的OSS 路径。',
- 'type' => 'string',
- 'example' => 'tingwu/dir/filename',
- ],
- 'TransResultOssBucket' => [
- 'title' => '识别及智能提取结果写入到的OSS Bucket。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'bucket',
- ],
- 'TransResultOssPath' => [
- 'title' => '识别及智能提取结果写入到的OSS文件路径。'."\n"
- .'示例：目录/文件名',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'tingwu/dir/filename',
- ],
- 'AudioSegmentsEnabled' => [
- 'title' => '是否开启有效音频片断检测结果写入，默认是false。',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
- ],
- 'Tags' => [
- 'type' => 'object',
- 'required' => false,
- ],
- 'AsrParams' => [
- 'type' => 'object',
- 'required' => false,
- ],
- 'LabParams' => [
- 'type' => 'object',
- 'required' => false,
- ],
- 'AbilityParams' => [
- 'type' => 'object',
- 'required' => false,
- ],
+ 'MeetingRoleNum' => ['title' => '会后进行识别结果角色区分人数，在AudioOutputEnabled=true、MeetingResultEnabled=true且DocResultEnabled=true 时生效，默认是1。'."\n"
+ .'0：按多人进行角色区分。'."\n"
+ .'1：按1人进行角色区分，即不区分。'."\n"
+ .'2：按2人进行角色区分。', 'description' => 'The number of distinct roles used to differentiate speakers in the post-meeting Classification Result. This parameter takes effect only when AudioOutputEnabled=true, MeetingResultEnabled=true, and DocResultEnabled=true. The default value is 1. '."\n"
+ .'0: Differentiate roles for multiple speakers. '."\n"
+ .'1: Treat all speech as from a single speaker (no role differentiation). '."\n"
+ .'2: Differentiate roles for two speakers.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
+ 'OnlyRoleSplitResult' => ['title' => '会后结果中docResult字段是否只存储角色时间戳映射信息，即不带转写文字结果，默认是false。', 'description' => 'Specifies whether the docResult field in the post-meeting result stores only the role-to-UNIX timestamp mapping information, without transcription text. The default value is false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID，仅用于联调。',
- 'description' => '',
- 'type' => 'string',
- 'example' => '35124E1C-AE99-5D6C-A52E-BD689D8D****',
- ],
- 'Code' => [
- 'title' => '状态码。',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Message' => [
- 'title' => '状态说明。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Success.',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Request ID, used only for joint debugging.', 'type' => 'string', 'example' => '35124E1C-AE99-5D6C-A52E-BD689D8D****'],
+ 'Code' => ['title' => '', 'description' => 'Status code.', 'type' => 'string', 'example' => '0'],
+ 'Message' => ['title' => '', 'description' => 'Status description.', 'type' => 'string', 'required' => false, 'example' => 'Success.'],
'Data' => [
- 'title' => '返回对象。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Returned object.',
'type' => 'object',
'properties' => [
- 'TransId' => [
- 'title' => '任务ID。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'f7de74778d94422283534102dfc0****',
- ],
- 'TransKey' => [
- 'title' => '用户创建任务时设置的任务标识。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'trans_123',
- ],
+ 'MeetingId' => ['title' => '', 'description' => 'Meeting ID.', 'type' => 'string', 'example' => 'f7de74778d94422283534102dfc0****'],
+ 'MeetingStatus' => ['title' => '', 'description' => 'Meeting status. '."\n"
+ .'NEW: New meeting. '."\n"
+ .'ONGOING: Meeting transcription in progress. '."\n"
+ .'PAUSED: Meeting transcription paused. '."\n"
+ .'PRE_COMPLETE: Post-meeting intelligent extraction in progress after transcription ends. '."\n"
+ .'COMPLETED: Meeting completed. '."\n"
+ .'FAILED: Post-meeting intelligent extraction failed after transcription ends. '."\n"
+ .'INVALID: Invalid meeting.', 'type' => 'string', 'example' => 'PRE_COMPLETE'],
+ 'MeetingKey' => ['title' => '', 'description' => 'Meeting identity set by the user when creating the meeting.', 'type' => 'string', 'example' => 'meeting_123'],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35124E1C-AE99-5D6C-A52E-BD689D8D****\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"Success.\\",\\n \\"Data\\": {\\n \\"TransId\\": \\"f7de74778d94422283534102dfc0****\\",\\n \\"TransKey\\": \\"trans_123\\"\\n }\\n}","type":"json"}]',
- ],
- 'GetFileTrans' => [
- 'summary' => '查询音视频转写任务信息',
- 'path' => '/openapi/file-trans/{TransId}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35124E1C-AE99-5D6C-A52E-BD689D8D****\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"Success.\\",\\n \\"Data\\": {\\n \\"MeetingId\\": \\"f7de74778d94422283534102dfc0****\\",\\n \\"MeetingStatus\\": \\"PRE_COMPLETE\\",\\n \\"MeetingKey\\": \\"meeting_123\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'End Real-Time Meeting',
+ 'changeSet' => [
+ ['createdAt' => '2022-10-20T11:18:30.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2022-10-08T22:47:31.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-09-21T02:44:37.000Z', 'description' => 'OpenAPI offline'],
],
- 'security' => [
+ 'ramActions' => [
[
- 'AK' => [],
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'tingwu:StopMeetingTrans',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NlsTingwu', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
],
- 'produces' => [
- 'application/json',
+ ],
+ ],
+ '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' => 'CreateFileTrans'],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ 'createdAt' => '2023-08-03T14:00:45.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateFileTrans'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateMeetingTrans'],
+ ],
+ 'createdAt' => '2023-05-16T15:41:32.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateFileTrans'],
+ ],
+ 'createdAt' => '2023-04-21T03:07:48.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateFileTrans'],
+ ],
+ 'createdAt' => '2022-12-16T02:19:33.000Z',
+ 'description' => '修改创建音视频文件转写参数AudioRoleNum的参数说明',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateFileTrans'],
+ ['description' => 'Request parameters changed', 'api' => 'CreateMeetingTrans'],
+ ],
+ 'createdAt' => '2022-11-07T03:03:19.000Z',
+ 'description' => '单用户接口QPS限流100。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateFileTrans'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateMeetingTrans'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetFileTrans'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetMeetingTrans'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'StopMeetingTrans'],
+ ],
+ 'createdAt' => '2022-10-20T11:18:42.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateFileTrans'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateMeetingTrans'],
+ ['description' => 'Response parameters changed', 'api' => 'GetFileTrans'],
+ ['description' => 'Response parameters changed', 'api' => 'GetMeetingTrans'],
+ ['description' => 'Response parameters changed', 'api' => 'StopMeetingTrans'],
+ ],
+ 'createdAt' => '2022-10-08T22:47:43.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateFileTrans'],
+ ['description' => 'Request parameters changed', 'api' => 'CreateMeetingTrans'],
+ ],
+ 'createdAt' => '2022-09-22T07:26:36.000Z',
+ 'description' => 'init',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'CreateFileTrans'],
+ ['description' => 'OpenAPI offline', 'api' => 'CreateMeetingTrans'],
+ ['description' => 'OpenAPI offline', 'api' => 'GetFileTrans'],
+ ['description' => 'OpenAPI offline', 'api' => 'GetMeetingTrans'],
+ ['description' => 'OpenAPI offline', 'api' => 'StopMeetingTrans'],
+ ],
+ 'createdAt' => '2022-09-21T07:55:29.000Z',
+ 'description' => 'init',
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'NlsTingwu',
+ 'productName' => 'Intelligent Speech Interaction',
+ 'ramCodes' => ['tingwu'],
+ 'ramLevel' => 'OPERATION',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'CreateMeetingTrans',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'tingwu:CreateMeetingTrans',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NlsTingwu', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetFileTrans',
+ 'description' => '',
'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'tingwu:GetFileTrans',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NlsTingwu', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'parameters' => [
- [
- 'name' => 'TransId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '任务ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'trans_123',
+ [
+ 'apiName' => 'CreateFileTrans',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'tingwu:CreateFileTrans',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NlsTingwu', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'headers' => [],
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => '请求ID，仅用于联调。',
- 'description' => '',
- 'type' => 'string',
- 'example' => '35124E1C-AE99-5D6C-A52E-BD689D8D****',
- ],
- 'Code' => [
- 'title' => '状态码。',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Message' => [
- 'title' => '状态说明。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Success.',
- ],
- 'Data' => [
- 'title' => '返回对象。',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'TransId' => [
- 'title' => '任务ID。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'f7de74778d94422283534102dfc0****',
- ],
- 'TransStatus' => [
- 'title' => '任务状态。'."\n"
- .'ONGOING：任务进行中。'."\n"
- .'COMPLETED：任务完成。'."\n"
- .'FAILED：任务失败'."\n"
- .'INVALID：无效任务。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ONGOING',
- ],
- 'TransKey' => [
- 'title' => '用户创建任务时设置的任务标识。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'trans_123',
- ],
- ],
- ],
- ],
+ [
+ 'apiName' => 'StopMeetingTrans',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'tingwu:StopMeetingTrans',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NlsTingwu', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetMeetingTrans',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'tingwu:GetMeetingTrans',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NlsTingwu', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35124E1C-AE99-5D6C-A52E-BD689D8D****\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"Success.\\",\\n \\"Data\\": {\\n \\"TransId\\": \\"f7de74778d94422283534102dfc0****\\",\\n \\"TransStatus\\": \\"ONGOING\\",\\n \\"TransKey\\": \\"trans_123\\"\\n }\\n}","type":"json"}]',
- ],
- ],
- 'endpoints' => [
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'tingwu.cn-beijing.aliyuncs.com',
],
+ 'resourceTypes' => [],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 21:33:14 +0000