summaryrefslogtreecommitdiff
path: root/data/zh_cn/nls-filetrans/2018-08-17/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/zh_cn/nls-filetrans/2018-08-17/api-docs.php
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/nls-filetrans/2018-08-17/api-docs.php')
-rw-r--r--data/zh_cn/nls-filetrans/2018-08-17/api-docs.php397
1 files changed, 161 insertions, 236 deletions
diff --git a/data/zh_cn/nls-filetrans/2018-08-17/api-docs.php b/data/zh_cn/nls-filetrans/2018-08-17/api-docs.php
index 2046823..de9b517 100644
--- a/data/zh_cn/nls-filetrans/2018-08-17/api-docs.php
+++ b/data/zh_cn/nls-filetrans/2018-08-17/api-docs.php
@@ -1,107 +1,22 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'nls-filetrans',
- 'version' => '2018-08-17',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'nls-filetrans', 'version' => '2018-08-17'],
'directories' => [
[
- 'id' => 208121,
- 'title' => '其它',
+ 'children' => ['SubmitTask', 'GetTaskResult'],
'type' => 'directory',
- 'children' => [
- 'SubmitTask',
- 'GetTaskResult',
- ],
+ 'title' => '其它',
+ 'id' => 434448,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'SubmitTask' => [
- 'summary' => '提交文件到调度系统,生成对应的任务',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- [
- 'BearerToken' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREnls90XY1V',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'Task',
- 'in' => 'query',
- 'schema' => [
- 'description' => '任务信息。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{\\"app_key\\":\\"kOxdqg6xwqvRg8zc\\",\\"file_link\\":\\"https://xxxx-cn.oss-cn-chengdu.aliyuncs.com/2025/5/20/16257504630/xxxxxx.m4a\\"}',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'description' => '任务id。',
- 'type' => 'string',
- 'example' => '45b9130064944a7086a51e30671exxxxx',
- ],
- 'RequestId' => [
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '9347BDEF-069C-5A8F-8024-XXXXXXXXXX',
- ],
- 'StatusText' => [
- 'description' => '任务状态text。',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'StatusCode' => [
- 'description' => '状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '21050000',
- ],
- ],
- ],
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"45b9130064944a7086a51e30671exxxxx\\",\\n \\"RequestId\\": \\"9347BDEF-069C-5A8F-8024-XXXXXXXXXX\\",\\n \\"StatusText\\": \\"SUCCESS\\",\\n \\"StatusCode\\": 21050000\\n}","type":"json"}]',
- 'title' => '提交任务',
- ],
'GetTaskResult' => [
'summary' => '获取任务结果。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -113,21 +28,13 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREnls90XY1V',
- ],
+ 'abilityTreeNodes' => ['FEATUREnls90XY1V'],
],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
- 'schema' => [
- 'description' => '任务ID,仅支持传单个ID,和SubmitTask返回TaskId一致。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '6391f5f7669642d5992f1f23ecxxxxxx',
- ],
+ 'schema' => ['description' => '任务ID,仅支持传单个ID,和SubmitTask返回TaskId一致。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '6391f5f7669642d5992f1f23ecxxxxxx'],
],
],
'responses' => [
@@ -135,39 +42,12 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => '任务id。',
- 'type' => 'string',
- 'example' => '4321c5c1c9834384b9d3d6a10bxxxxxx',
- ],
- 'RequestId' => [
- 'description' => '唯一请求识别码。',
- 'type' => 'string',
- 'example' => 'CA4939D7-5D7B-5B74-AD17-XXXXXXXXXXXX',
- ],
- 'StatusText' => [
- 'description' => '任务状态标签。',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'BizDuration' => [
- 'description' => '识别的音频文件总时长,单位:毫秒。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '267500',
- ],
- 'SolveTime' => [
- 'description' => '任务获取转换成功的时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12345',
- ],
- 'StatusCode' => [
- 'description' => '状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '21050000',
- ],
+ 'TaskId' => ['description' => '任务id。', 'type' => 'string', 'example' => '4321c5c1c9834384b9d3d6a10bxxxxxx'],
+ 'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => 'CA4939D7-5D7B-5B74-AD17-XXXXXXXXXXXX'],
+ 'StatusText' => ['description' => '任务状态标签。', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'BizDuration' => ['description' => '识别的音频文件总时长,单位:毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '267500'],
+ 'SolveTime' => ['description' => '任务获取转换成功的时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'],
+ 'StatusCode' => ['description' => '状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '21050000'],
'Result' => [
'description' => '任务处理的结果。不同的任务类型会有不同的返回信息,请以实际为准。',
'type' => 'object',
@@ -178,30 +58,12 @@
'items' => [
'type' => 'object',
'properties' => [
- 'EndTime' => [
- 'description' => '字结束时间戳,单位毫秒。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '610',
- ],
- 'Word' => [
- 'description' => '文本内容。',
- 'type' => 'string',
- 'example' => '化学',
- ],
- 'BeginTime' => [
- 'description' => '字开始时间戳,单位毫秒。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1180',
- ],
- 'ChannelId' => [
- 'description' => '声道id。第一声道为0,第二声道为1,依此类推。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
+ 'EndTime' => ['description' => '字结束时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '610'],
+ 'Word' => ['description' => '文本内容。', 'type' => 'string', 'example' => '化学'],
+ 'BeginTime' => ['description' => '字开始时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '1180'],
+ 'ChannelId' => ['description' => '声道id。第一声道为0,第二声道为1,依此类推。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
+ 'description' => '',
],
],
'Paragraphs' => [
@@ -210,30 +72,12 @@
'items' => [
'type' => 'object',
'properties' => [
- 'EndTime' => [
- 'description' => '本句结束时间戳,单位毫秒。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '9800',
- ],
- 'BeginTime' => [
- 'description' => '本句开始时间戳,单位毫秒。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '610',
- ],
- 'ChannelId' => [
- 'description' => '声道id。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Text' => [
- 'description' => '段落文本',
- 'type' => 'string',
- 'example' => '化学是一门中学基础学科。从初二开始学习,属于理科功课。',
- ],
+ 'EndTime' => ['description' => '本句结束时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '9800'],
+ 'BeginTime' => ['description' => '本句开始时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '610'],
+ 'ChannelId' => ['description' => '声道id。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Text' => ['description' => '段落文本', 'type' => 'string', 'example' => '化学是一门中学基础学科。从初二开始学习,属于理科功课。'],
],
+ 'description' => '',
],
],
'Sentences' => [
@@ -242,80 +86,161 @@
'items' => [
'type' => 'object',
'properties' => [
- 'EndTime' => [
- 'description' => '本句结束时间戳,单位毫秒。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4300',
- ],
- 'BeginTime' => [
- 'description' => '本句开始时间戳,单位毫秒。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '610',
- ],
- 'ChannelId' => [
- 'description' => '声道id',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'EmotionValue' => [
- 'description' => '情绪能量值。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '7.0',
- ],
- 'Text' => [
- 'description' => '转写内容。',
- 'type' => 'string',
- 'example' => '化学是一门中学基础学科。',
- ],
- 'SpeechRate' => [
- 'description' => '语速',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '98',
- ],
- 'SpeakerId' => [
- 'description' => '语话人id。当前是声道id+1',
- 'type' => 'string',
- ],
- 'SilenceDuration' => [
- 'description' => '句前的静音时长',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'EndTime' => ['description' => '本句结束时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '4300'],
+ 'BeginTime' => ['description' => '本句开始时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '610'],
+ 'ChannelId' => ['description' => '声道id', 'type' => 'integer', 'format' => 'int32'],
+ 'EmotionValue' => ['description' => '情绪能量值。', 'type' => 'number', 'format' => 'float', 'example' => '7.0'],
+ 'Text' => ['description' => '转写内容。', 'type' => 'string', 'example' => '化学是一门中学基础学科。'],
+ 'SpeechRate' => ['description' => '语速', 'type' => 'integer', 'format' => 'int32', 'example' => '98'],
+ 'SpeakerId' => ['description' => '语话人id。当前是声道id+1', 'type' => 'string'],
+ 'SilenceDuration' => ['description' => '句前的静音时长', 'type' => 'integer', 'format' => 'int32'],
],
+ 'description' => '',
],
],
],
],
- 'RequestTime' => [
- 'description' => '请求时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1735956700661',
- ],
+ 'RequestTime' => ['description' => '请求时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1735956700661'],
],
+ 'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"4321c5c1c9834384b9d3d6a10bxxxxxx\\",\\n \\"RequestId\\": \\"CA4939D7-5D7B-5B74-AD17-XXXXXXXXXXXX\\",\\n \\"StatusText\\": \\"SUCCESS\\",\\n \\"BizDuration\\": 267500,\\n \\"SolveTime\\": 12345,\\n \\"StatusCode\\": 21050000,\\n \\"Result\\": {\\n \\"Words\\": [\\n {\\n \\"EndTime\\": 610,\\n \\"Word\\": \\"化学\\",\\n \\"BeginTime\\": 1180,\\n \\"ChannelId\\": 0\\n }\\n ],\\n \\"Paragraphs\\": [\\n {\\n \\"EndTime\\": 9800,\\n \\"BeginTime\\": 610,\\n \\"ChannelId\\": 0,\\n \\"Text\\": \\"化学是一门中学基础学科。从初二开始学习,属于理科功课。\\"\\n }\\n ],\\n \\"Sentences\\": [\\n {\\n \\"EndTime\\": 4300,\\n \\"BeginTime\\": 610,\\n \\"ChannelId\\": 0,\\n \\"EmotionValue\\": 7,\\n \\"Text\\": \\"化学是一门中学基础学科。\\",\\n \\"SpeechRate\\": 98,\\n \\"SpeakerId\\": \\"\\",\\n \\"SilenceDuration\\": 0\\n }\\n ]\\n },\\n \\"RequestTime\\": 1735956700661\\n}","type":"json"}]',
'title' => '查询任务结果',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'nls:GetTaskResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NLS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'SubmitTask' => [
+ 'summary' => '提交文件到调度系统,生成对应的任务',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREnls90XY1V'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Task',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务信息。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{\\"app_key\\":\\"kOxdqg6xwqvRg8zc\\",\\"file_link\\":\\"https://xxxx-cn.oss-cn-chengdu.aliyuncs.com/2025/5/20/16257504630/xxxxxx.m4a\\"}'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['description' => '任务id。', 'type' => 'string', 'example' => '45b9130064944a7086a51e30671exxxxx'],
+ 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '9347BDEF-069C-5A8F-8024-XXXXXXXXXX'],
+ 'StatusText' => ['description' => '任务状态text。', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'StatusCode' => ['description' => '状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '21050000'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"45b9130064944a7086a51e30671exxxxx\\",\\n \\"RequestId\\": \\"9347BDEF-069C-5A8F-8024-XXXXXXXXXX\\",\\n \\"StatusText\\": \\"SUCCESS\\",\\n \\"StatusCode\\": 21050000\\n}","type":"json"}]',
+ 'title' => '提交任务',
+ 'changeSet' => [
+ ['createdAt' => '2021-05-19T12:36:23.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'nls:SubmitTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NLS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
],
'endpoints' => [
+ ['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'nls-filetrans.cn-beijing.aliyuncs.com', 'endpoint' => 'nls-filetrans.cn-beijing.aliyuncs.com', 'vpc' => 'filetrans-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'nls-filetrans.cn-shanghai.aliyuncs.com', 'endpoint' => 'nls-filetrans.cn-shanghai.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen', 'regionName' => '华南1(深圳)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'nls-filetrans.cn-shenzhen.aliyuncs.com', 'endpoint' => 'nls-filetrans.cn-shenzhen.aliyuncs.com', 'vpc' => 'filetrans-vpc.cn-shenzhen.aliyuncs.com'],
+ ],
+ 'errorCodes' => [],
+ 'changeSet' => [
[
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'nls-filetrans.cn-beijing.aliyuncs.com',
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'GetTaskResult'],
+ ],
+ 'createdAt' => '2022-04-21T08:47:46.000Z',
+ 'description' => '增加request_time字段',
],
[
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'nls-filetrans.cn-shanghai.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'GetTaskResult'],
+ ['description' => 'OpenAPI 下线', 'api' => 'SubmitTask'],
+ ],
+ 'createdAt' => '2021-05-19T12:36:46.000Z',
+ 'description' => '完成',
],
- [
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'nls-filetrans.cn-shenzhen.aliyuncs.com',
+ ],
+ 'ram' => [
+ 'productCode' => 'NLS',
+ 'productName' => '智能语音交互',
+ 'ramCodes' => ['nls'],
+ 'ramLevel' => '操作级',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'GetTaskResult',
+ 'description' => '查询任务结果',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'nls:GetTaskResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NLS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitTask',
+ 'description' => '提交任务',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'nls:SubmitTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NLS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'resourceTypes' => [],
],
];