diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/tingwu | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/tingwu')
| -rw-r--r-- | data/en_us/tingwu/2022-09-30/api-docs.php | 900 | ||||
| -rw-r--r-- | data/en_us/tingwu/2023-09-30/api-docs.php | 1443 |
2 files changed, 2343 insertions, 0 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 new file mode 100644 index 0000000..ede4249 --- /dev/null +++ b/data/en_us/tingwu/2022-09-30/api-docs.php @@ -0,0 +1,900 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'tingwu', + 'version' => '2022-09-30', + ], + 'directories' => [ + [ + 'id' => 172030, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateMeetingTrans', + 'GetMeetingTrans', + 'StopMeetingTrans', + ], + ], + [ + 'id' => 172031, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateFileTrans', + 'GetFileTrans', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateMeetingTrans' => [ + 'summary' => '创建实时会议', + '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' => '请求body。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AppKey' => [ + 'title' => '管控台创建的项目AppKey。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'JV1sRTisRMi****', + ], + 'MeetingKey' => [ + 'title' => '用户设置的会议标识，在会中查询或会后结束回调时会原样返回。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'meeting_123', + ], + 'AudioFormat' => [ + 'title' => '音频编码格式，PCM（无压缩的PCM文件或WAV文件）或OPUS（压缩的OPUS文件）。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pcm', + 'enum' => [], + ], + 'AudioPackage' => [ + 'title' => '音频打包方式，基于听悟约定的Protobuf格式封装多路音频流时设置为multi。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'multi', + ], + 'AudioSampleRate' => [ + 'title' => '音频采样率，当前支持：16000。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '16000', + 'enum' => [], + ], + 'AudioBitRate' => [ + 'title' => '会议上传音频采样位数，当前支持：16。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '16', + 'enum' => [], + ], + 'AudioLanguage' => [ + 'title' => '音频转写使用的语言模型。'."\n" + .'cn：中文。'."\n" + .'en：英文。'."\n" + .'yue：粤语。'."\n" + .'fspk：中英文自由说。'."\n" + .'multi：动态语言切换。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn', + 'enum' => [], + ], + 'RealtimeResultEnabled' => [ + 'title' => '是否开启会中实时结果返回，默认是true。', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + 'RealtimeResultLevel' => [ + 'title' => '开启会中实时结果返回时，设置识别结果返回等级，默认是1。'."\n" + .'0：不返回识别结果。'."\n" + .'1：识别出完整句子时返回识别结果。'."\n" + .'2：识别出中间结果及完整句子时返回识别结果。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'default' => '1', + 'enum' => [], + ], + 'RealtimeActiveResultLevel' => [ + 'title' => '开启会中实时结果返回且音频打包方式为multi时，设置发言人识别结果返回等级，默认是1。'."\n" + .'0：不返回识别结果。'."\n" + .'1：识别出完整句子时返回识别结果。'."\n" + .'2：识别出中间结果及完整句子时返回识别结果。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + '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, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'MeetingId', + 'in' => 'path', + 'schema' => [ + 'title' => '会议ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'meeting_123', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + '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, + ], + ], + ], + '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.', + ], + 'Data' => [ + 'title' => '返回对象。', + 'description' => '', + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + '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' => '请求body。', + 'description' => '', + '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, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + '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****', + ], + 'TransKey' => [ + 'title' => '用户创建任务时设置的任务标识。', + 'description' => '', + 'type' => 'string', + 'example' => 'trans_123', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TransId', + 'in' => 'path', + 'schema' => [ + 'title' => '任务ID。', + 'description' => '', + '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.', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], +]; diff --git a/data/en_us/tingwu/2023-09-30/api-docs.php b/data/en_us/tingwu/2023-09-30/api-docs.php new file mode 100644 index 0000000..75bb6f2 --- /dev/null +++ b/data/en_us/tingwu/2023-09-30/api-docs.php @@ -0,0 +1,1443 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'tingwu', + 'version' => '2023-09-30', + ], + 'directories' => [ + 'CreateTask', + 'GetTaskInfo', + [ + 'id' => 187956, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateTranscriptionPhrases', + 'GetTranscriptionPhrases', + 'UpdateTranscriptionPhrases', + 'DeleteTranscriptionPhrases', + 'ListTranscriptionPhrases', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateTask' => [ + 'summary' => '创建听悟任务', + 'path' => '/openapi/tingwu/v2/tasks', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '196631', + 'abilityTreeNodes' => [ + 'FEATUREnls24C81K', + 'FEATUREnlsO1I14I', + ], + ], + 'parameters' => [ + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'offline' => 'offline', + 'realtime' => 'realtime', + ], + 'example' => 'offline', + ], + ], + [ + 'name' => 'operation', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'stop' => 'stop', + 'start' => 'start', + ], + 'example' => 'stop', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '请求参数body', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AppKey' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'JV1sRTisRMi****', + ], + 'Input' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SourceLanguage' => [ + 'title' => '离线转写/实时会议使用的语言模型。'."\n" + .'cn：中文。'."\n" + .'en：英文。'."\n" + .'yue：粤语。'."\n" + .'fspk：中英文自由说。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'yue' => 'yue', + 'fspk' => 'fspk', + 'en' => 'en', + 'cn' => 'cn', + ], + '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', + ], + 'Format' => [ + 'title' => '音频流编码格式，支持PCM（无压缩的PCM文件或WAV文件）或OPUS（压缩的OPUS文件）。仅在创建实时会议时必选。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'pcm' => 'pcm', + 'opus' => 'opus', + ], + 'example' => 'pcm', + ], + 'SampleRate' => [ + 'title' => '音频流采样率，当前支持：16000/8000两种。仅在创建实时会议时必选。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + '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', + ], + 'LanguageHints' => [ + 'title' => '偏好语种，仅当SourceLanguage="multilingual"时生效，限制模型的输出语种。', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'AudioChannelMode' => [ + 'title' => '多通道音视频处理模式。', + 'type' => 'string', + ], + ], + 'required' => false, + ], + 'Parameters' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Transcoding' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TargetAudioFormat' => [ + 'title' => '是否将原始音视频文件或音频流转成mp3格式保存，目前仅支持设置为mp3格式。在创建离线文件转写或实时会议时可选。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mp3', + 'enum' => [ + 'mp3', + ], + ], + 'TargetVideoFormat' => [ + 'title' => '是否将原始视频文件转成mp4格式保存，目前仅支持设置为mp4格式。仅在创建离线文件转写且原始文件为视频格式时设置此参数有意义，通常无须设置。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mp4', + 'enum' => [ + 'mp4', + ], + ], + 'VideoThumbnailEnabled' => [ + 'title' => '是否将原始视频文件抽取视频缩略图并保存。仅在创建离线文件转写且原始文件为视频格式时设置此参数有意义，通常无须设置。', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'false', + 'default' => 'false', + ], + 'SpectrumEnabled' => [ + 'title' => '是否将原始音视频文件或音频流生成音频波形图并保存，目前仅支持设置为mp3格式。在创建离线文件转写或实时会议时可选。', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + 'required' => false, + ], + 'Transcription' => [ + 'title' => '语音识别功能控制参数', + 'description' => '', + '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', + ], + 'Diarization' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SpeakerCount' => [ + 'title' => '是否开启说话人角色区分。注：只对16K及以上采样率生效。'."\n" + .'不设置：不使用说话人角色区分。'."\n" + .'0：说话人角色区分结果为不定人数。'."\n" + .'2：说话人角色区分结果为2人。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + 'required' => false, + ], + 'OutputLevel' => [ + 'title' => '设置语音识别结果返回等级。1：识别出完整句子时返回识别结果；2：识别出中间结果及完整句子时返回识别结果', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'default' => '1', + ], + 'AdditionalStreamOutputLevel' => [ + 'title' => '设置实时记录场景下活跃说话人对应的语音识别结果返回等级。1：识别出完整句子时返回识别结果；2：识别出中间结果及完整句子时返回识别结果(仅在实时记录场景下且MultipleStreamsEnabled=true时按需设置，离线转写场景无须设置)。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'default' => '1', + ], + 'PhraseId' => [ + 'title' => '热词ID', + 'type' => 'string', + ], + 'Model' => [ + 'title' => '设置语音转写模型，提升特定领域转写效果。', + 'type' => 'string', + ], + 'RealtimeDiarizationEnabled' => [ + 'type' => 'boolean', + ], + 'ProfanityFilterEnabled' => [ + 'title' => '是否启用语音转写过程中的敏感词过滤功能，默认开启', + 'type' => 'boolean', + ], + ], + 'required' => false, + ], + 'Translation' => [ + 'title' => '语言翻译功能控制参数', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TargetLanguages' => [ + 'title' => '添加待设置的目标翻译语言。 支持中文(cn)、英文(en)、日文(ja)。', + 'description' => '', + 'type' => 'array', + 'required' => false, + 'items' => [ + 'type' => 'string', + ], + ], + 'OutputLevel' => [ + 'title' => '设置实时语言翻译识别结果返回等级。1：识别出完整句子时返回识别结果；2：识别出中间结果及完整句子时返回识别结果(仅在实时记录场景下按需设置，离线转写场景无须设置)。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'default' => '1', + ], + 'AdditionalStreamOutputLevel' => [ + 'title' => '设置实时记录场景下活跃说话人对应的语言翻译识别结果返回等级。1：识别出完整句子时返回识别结果；2：识别出中间结果及完整句子时返回识别结果(仅在实时记录场景下且MultipleStreamsEnabled=true时按需设置，离线转写场景无须设置)。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'default' => '1', + ], + ], + 'required' => false, + ], + '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', + ], + 'MeetingAssistance' => [ + 'title' => '智能纪要功能控制参数，支持待办事项、关键词、重点内容的算法处理。 若您启用MeetingAssistanceEnabled但未通过MeetingAssistance设置算法类型，则默认都进行调用和返回。', + 'type' => 'object', + 'properties' => [ + 'Types' => [ + 'title' => '开启智能纪要功能时，需传入期望的功能参数类型，支持待办(Actions)、关键信息(KeyInformation)。其中关键信息包含关键词和重点内容(关键句)', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + 'minItems' => 1, + ], + ], + ], + 'SummarizationEnabled' => [ + 'title' => '是否启用摘要功能，开启后会可以生成全文摘要、发言人总结等结果(依赖传入的摘要类型)。', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + 'Summarization' => [ + 'title' => '摘要功能控制参数', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Types' => [ + 'title' => '添加待设置的大模型摘要参数，支持全文摘要(Paragraph)、发言人总结摘要(Conversational)。', + 'description' => '', + 'type' => 'array', + 'required' => false, + 'enumValueTitles' => [ + 'Conversational' => '', + 'QuestionsAnswering' => '', + 'Paragraph' => '', + ], + 'example' => 'Paragraph', + 'items' => [ + 'title' => '', + 'type' => 'string', + ], + ], + ], + 'required' => false, + ], + 'PptExtractionEnabled' => [ + 'title' => '是否启用PPT抽取和PPT总结功能，开启后会对视频文件中的PPT进行画面抽取，并形成对应的总结', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + 'TextPolishEnabled' => [ + 'title' => '是否启用口语书面化，开启后会对音频转写结果进行润色，输出更为规范的文本结果', + 'type' => 'boolean', + 'default' => 'false', + ], + 'ServiceInspectionEnabled' => [ + 'title' => '服务质检功能开关，默认为false。', + 'type' => 'boolean', + ], + 'ServiceInspection' => [ + 'title' => '服务质检参数对象。', + 'type' => 'object', + 'properties' => [ + 'SceneIntroduction' => [ + 'title' => '服务质检的对话场景描述。', + 'type' => 'string', + ], + 'InspectionIntroduction' => [ + 'title' => '服务质检的检测目标和侧重点描述。', + 'type' => 'string', + ], + 'InspectionContents' => [ + 'title' => '服务质检的质检维度列表，包含质检维度名称和定义，即需要大模型以什么样的标准判断该维度是否命中。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Title' => [ + 'title' => '服务质检的质检维度名称。', + 'type' => 'string', + ], + 'Content' => [ + 'title' => '服务质检的质检维度定义。', + 'type' => 'string', + ], + ], + ], + ], + 'SpeakerMap' => [ + 'type' => 'object', + ], + ], + ], + 'CustomPromptEnabled' => [ + 'title' => '是否启用自定义Prompt，开启后可以输入个性化定制Prompt。', + 'type' => 'boolean', + ], + 'CustomPrompt' => [ + 'title' => '自定义Prompt的主要参数。', + 'type' => 'object', + 'properties' => [ + 'Contents' => [ + 'title' => '自定义Prompt的参数列表。', + 'type' => 'array', + 'items' => [ + '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', + ], + ], + ], + ], + ], + ], + 'ExtraParams' => [ + 'title' => '用以设置某些特殊场景或特殊配置参数，通常情况无须设置。', + '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', + ], + ], + ], + 'ContentExtractionEnabled' => [ + 'type' => 'boolean', + ], + 'ContentExtraction' => [ + 'title' => '对话内容提取参数对象。', + 'type' => 'object', + 'properties' => [ + 'SceneIntroduction' => [ + 'title' => '对话内容提取的场景描述。', + 'type' => 'string', + ], + 'ExtractionContents' => [ + 'title' => '对话内容提取的提取维度列表，包含提取项的名称和定义。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Title' => [ + 'title' => '对话内容提取的提取维度名称。', + 'type' => 'string', + ], + 'Content' => [ + 'title' => '对话内容提取的维度定义。', + 'type' => 'string', + ], + 'Identity' => [ + 'type' => 'string', + ], + ], + ], + ], + 'SpeakerMap' => [ + 'type' => 'object', + ], + ], + ], + 'IdentityRecognitionEnabled' => [ + 'title' => '身份识别开关。', + 'type' => 'boolean', + ], + 'IdentityRecognition' => [ + 'title' => '身份识别参数对象。', + 'type' => 'object', + 'properties' => [ + 'SceneIntroduction' => [ + 'title' => '身份识别的场景描述。', + 'type' => 'string', + ], + 'IdentityContents' => [ + 'title' => '身份识别的内容列表，包含身份名称和描述。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '身份名称。', + 'type' => 'string', + ], + 'Description' => [ + 'title' => '身份描述。', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'AutoChapters' => [ + 'type' => 'object', + 'properties' => [ + 'ChapterGranularity' => [ + 'type' => 'string', + ], + ], + ], + 'Model' => [ + 'type' => 'string', + ], + 'LlmOutputLanguage' => [ + 'type' => 'string', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + 'MeetingJoinUrl' => [ + 'title' => '实时记录场景下生成的音频流推送地址，您可以在后续实时音频流识别时通过该地址进行', + 'type' => 'string', + ], + 'TaskStatus' => [ + 'title' => '任务状态', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREnls24C81K', + 'FEATUREnlsO1I14I', + ], + ], + 'parameters' => [ + [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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"}]', + ], + 'CreateTranscriptionPhrases' => [ + 'summary' => '创建热词词表', + 'path' => '/openapi/tingwu/v2/resources/phrases', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + 'Data' => [ + 'title' => '返回对象。', + 'description' => '', + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'PhraseId', + 'in' => 'path', + 'schema' => [ + 'title' => '词表ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'a93b91141c0f422fa114af203f8b****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + '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}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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"}]', + ], + 'UpdateTranscriptionPhrases' => [ + 'summary' => '更新热词词表', + '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' => [ + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + '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"}]', + ], + 'DeleteTranscriptionPhrases' => [ + 'summary' => '删除词表', + 'path' => '/openapi/tingwu/v2/resources/phrases/{PhraseId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '操作是否成功。（暂不使用）', + 'description' => '', + 'type' => 'string', + 'example' => 'SUCCEEDED', + ], + 'ErrorCode' => [ + 'title' => '错误码。（暂不使用）', + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'ErrorMessage' => [ + 'title' => '错误信息。（暂不使用）', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '操作是否成功。', + 'type' => 'string', + ], + 'ErrorCode' => [ + 'title' => '错误码。', + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'title' => '错误信息。', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + '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"}]', + ], + 'ListTranscriptionPhrases' => [ + 'summary' => '列举用户所有热词词表信息', + 'path' => '/openapi/tingwu/v2/resources/phrases', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + 'Data' => [ + 'description' => '', + '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.', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'tingwu.cn-beijing.aliyuncs.com', + ], + ], +]; |