文档

CreateFileTrans - 创建文件转写任务

更新时间:
一键部署

创建音视频转写任务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
tingwu:CreateFileTransWrite
  • 全部资源
    acs:tingwu::{#accountId}:*

请求语法

PUT /openapi/file-trans

请求参数

名称类型必填描述示例值
bodyobject

请求 body。

AppKeystring

管控台创建的项目 AppKey。

JV1sRTisRMi****
TransKeystring

用户设置的任务标识,在任务查询或任务结束回调时会原样返回。

trans_123
AudioOssBucketstring

需要转写音频所在的 OSS Bucket。

bucket
AudioOssPathstring

需要转写音频所在的 OSS 文件路径或者自定义可下载文件地址(http|https)。如果 AudioOssBucket 非空,则需要赋值 OSS 文件路径(...../.mp3);如果 AudioOssBucket 为空,则需要赋值自定义可下载文件地址(http://……/.mp3)。

dir1/dir2/filename http://……/*.mp3
AudioLanguagestring

音频转写使用的语言模型。 cn:中文。 en:英文。 yue:粤语。 fspk:中英文自由说。

cn
AudioRoleNumstring

是否开启说话人角色区分。注,只对 16K 及以上采样率生效。 不设置:不使用说话人角色区分。 0:说话人角色区分结果为不定人数。 2:说话人角色区分结果为 2 人。

2
AudioOutputEnabledboolean

是否开启 mp3 格式音频转码,默认是 false。

false
AudioOutputOssBucketstring

开启音频转码时,转码音频写入到的 OSS Bucket,需要与管控台项目配置的 OSS Bucket 一致。

bucket
AudioOutputOssPathstring

开启音频转码时,转码音频写入到的 OSS 文件路径,需要以"tingwu/"为前缀。

tingwu/dir/filename
VideoOutputEnabledboolean

是否开启视频转码,默认是 false。

false
VideoOutputOssBucketstring

开启视频转码时,转码视频写入到的 OSS Bucket,需要与管控台项目配置的 OSS Bucket 一致。

bucket
VideoOutputOssPathstring

开启视频转码时,转码视频写入到的 OSS 文件路径,需要以"tingwu/"为前缀。

tingwu/dir/filename
TransResultOssBucketstring

识别及智能提取结果写入到的 OSS Bucket,需要与管控台项目配置的 OSS Bucket 一致。

bucket
TransResultOssPathstring

识别及智能提取结果写入到的 OSS 文件路径,需要以"tingwu/"为前缀。

tingwu/dir/filename
AudioSegmentsEnabledboolean

是否开启有效音频片断检测结果写入,默认是 false。

false
Tagsobject

系统扩展:标签

AsrParamsobject

ASR 转写的额外参数,如热词 vocabulary_id

{ "vocabulary_id": "e2a9a9be3128417fb4d181ebfbe8****" }
LabParamsobject

系统扩展:实验转写参数

AbilityParamsobject

能力扩展

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID,仅用于联调。

35124E1C-AE99-5D6C-A52E-BD689D8D****
Codestring

状态码。

0
Messagestring

状态说明。

Success.
Dataobject

返回对象。

TransIdstring

任务 ID。

f7de74778d94422283534102dfc0****
TransKeystring

用户创建任务时设置的任务标识。

trans_123

示例

正常返回示例

JSON格式

{
  "RequestId": "35124E1C-AE99-5D6C-A52E-BD689D8D****",
  "Code": "0",
  "Message": "Success.",
  "Data": {
    "TransId": "f7de74778d94422283534102dfc0****",
    "TransKey": "trans_123"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-08-03API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-05-16API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-04-21API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (0)
文档反馈