创建音视频转写任务。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| tingwu:CreateFileTrans | Write |
|
| 无 |
请求语法
PUT /openapi/file-trans
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| body | object | 否 | 请求 body。 | |
| AppKey | string | 是 | 管控台创建的项目 AppKey。 | JV1sRTisRMi**** |
| TransKey | string | 否 | 用户设置的任务标识，在任务查询或任务结束回调时会原样返回。 | trans_123 |
| AudioOssBucket | string | 否 | 需要转写音频所在的 OSS Bucket。 | bucket |
| AudioOssPath | string | 是 | 需要转写音频所在的 OSS 文件路径或者自定义可下载文件地址（http|https）。如果 AudioOssBucket 非空，则需要赋值 OSS 文件路径（...../.mp3）；如果 AudioOssBucket 为空，则需要赋值自定义可下载文件地址（http://……/.mp3）。 | dir1/dir2/filename http://……/*.mp3 |
| AudioLanguage | string | 是 | 音频转写使用的语言模型。 cn：中文。 en：英文。 yue：粤语。 fspk：中英文自由说。 | cn |
| AudioRoleNum | string | 否 | 是否开启说话人角色区分。注，只对 16K 及以上采样率生效。 不设置：不使用说话人角色区分。 0：说话人角色区分结果为不定人数。 2：说话人角色区分结果为 2 人。 | 2 |
| AudioOutputEnabled | boolean | 否 | 是否开启 mp3 格式音频转码，默认是 false。 | false |
| AudioOutputOssBucket | string | 否 | 开启音频转码时，转码音频写入到的 OSS Bucket，需要与管控台项目配置的 OSS Bucket 一致。 | bucket |
| AudioOutputOssPath | string | 否 | 开启音频转码时，转码音频写入到的 OSS 文件路径，需要以"tingwu/"为前缀。 | tingwu/dir/filename |
| VideoOutputEnabled | boolean | 否 | 是否开启视频转码，默认是 false。 | false |
| VideoOutputOssBucket | string | 否 | 开启视频转码时，转码视频写入到的 OSS Bucket，需要与管控台项目配置的 OSS Bucket 一致。 | bucket |
| VideoOutputOssPath | string | 否 | 开启视频转码时，转码视频写入到的 OSS 文件路径，需要以"tingwu/"为前缀。 | tingwu/dir/filename |
| TransResultOssBucket | string | 是 | 识别及智能提取结果写入到的 OSS Bucket，需要与管控台项目配置的 OSS Bucket 一致。 | bucket |
| TransResultOssPath | string | 是 | 识别及智能提取结果写入到的 OSS 文件路径，需要以"tingwu/"为前缀。 | tingwu/dir/filename |
| AudioSegmentsEnabled | boolean | 否 | 是否开启有效音频片断检测结果写入，默认是 false。 | false |
| Tags | object | 否 | 系统扩展：标签 | |
| AsrParams | object | 否 | ASR 转写的额外参数，如热词 vocabulary_id | { "vocabulary_id": "e2a9a9be3128417fb4d181ebfbe8****" } |
| LabParams | object | 否 | 系统扩展：实验转写参数 | |
| AbilityParams | object | 否 | 能力扩展 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "35124E1C-AE99-5D6C-A52E-BD689D8D****",
"Code": "0",
"Message": "Success.",
"Data": {
"TransId": "f7de74778d94422283534102dfc0****",
"TransKey": "trans_123"
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||
|---|---|---|---|---|
| 2023-08-03 | API 内部配置变更，不影响调用 | 看变更集 | ||
| ||||
| 2023-05-16 | API 内部配置变更，不影响调用 | 看变更集 | ||
| ||||
| 2023-04-21 | API 内部配置变更，不影响调用 | 看变更集 | ||
|