CreateRtcAsrTask - 创建实时语音转文字或翻译

创建一个新的实时字幕任务,用于实时转录音频流为文本。

接口说明

本接口用于创建一个新的实时字幕任务,用于实时转录音频流为文本。

QPS 限制

本接口的单用户 QPS 限制为 20 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

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

授权信息

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

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

请求参数

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

流模式,live 或者 rtc。live 为正常直播流如 rtmp。

live
SDKAppIDstring

ARTC 应用 ID。

说明 当参数 Mode 取值为 rtc 时,此参数必填,否则不生效。
appId
ChannelIDstring

房间号。

说明 参数 Mode 取值为 rtc 时,此参数必填,否则不生效。
channelId
RtcUserIdstring

推流用户 ID。

说明 参数 Mode 取值为 rtc 时,此参数必填,且只能填写一个,否则不生效。
user1
StreamURLstring

直播流地址。

说明 参数 Mode 取值为 live 时,此参数必填,否则不生效。
rtmp://xxx
Languagestring

原音频语言,取值:

  • 日语:ja。
  • 粤语:yue。
  • 中英文自由说:fspk。
  • 英文:en。
  • 中文:cn。
cn
CallbackURLstring

回调地址。

http://xxx.com
AuthKeystring

校验 AuthKey,用于生成回调信息的 MD5 签名。

说明 回调时会在请求头中加两个鉴权字段,"SIG-TIME"表示当前时间戳,"ASR-SIG"表示 md5 鉴权字段,"ASR-SIG"字段的生成规则为 md5(${SIG-TIME}/${callbackurl}/${authKey})
abcd
TranslateEnabledboolean

开启翻译。

true
TargetLanguagesstring

目标翻译语种,取值:

  • 中文:cn。
  • 英文:en。
  • 日文:ja。
en
AutoTerminateEnabledboolean

断流最大延迟,超过则自动关闭任务。默认值:false。

true
AutoTerminateDelaylong

自动断流延时,单位秒,取值:1~10 秒。

5
ReportIntervallong

回调上报间隔,单位毫秒,取值范围:-1~500 毫秒。

  • -1:不接受中间结果,只接受整句回调。
  • 0 或不设置:实时上报回调结果。
  • <=500 毫秒:周期性间隔上报回调结果。
5

回调示例

通过用户传入的 CallbackUrl,回调用户的内容,详细内容可参考:交互流程与实现,示例如下所示:

{
    "task_id": "asr-cf8c70d7-3b8d-496c-98f8-4785******",
    "sdk_app_id": "",
    "channel_id": "",
    "rtc_user_id": "",
    "callback_time_stamp": 1723433155645,
    "language": "cn",
    "content": "{\"header\":{\"nls_task_id\":\"af95c5cc332549f689f3153bc9******\",\"task_key\":\"tl_2977564_17234*****\",\"namespace\":\"SpeechTranscriber\",\"name\":\"TranscriptionResultChanged\",\"task_id\":\"413937911b874146b5796******\",\"message_id\":\"abfc9e9994e748a38499e1******\",\"status_text\":\"Success.\",\"status\":20000000},\"payload\":{\"result\":\"在这里与各位相聚\",\"confidence\":0.0,\"words\":[{\"startTime\":0,\"text\":\"在这\",\"endTime\":510},{\"startTime\":510,\"text\":\"里与\",\"endTime\":1020},{\"startTime\":1020,\"text\":\"各位\",\"endTime\":1530},{\"startTime\":1530,\"text\":\"相聚\",\"endTime\":2040}],\"index\":0,\"time\":2040,\"fixed_result\":\"\",\"unfixed_result\":\"\",\"status\":0}}"
  }

返回参数

名称类型描述示例值
object
Descriptionstring

结果描述,为 success 时成功,有错误信息则返回。

success
RequestIdstring

网关请求 ID。

7FF5417D-06E9-5A2C-9A70-581F6149E6C1
RetCodelong

状态码。返回 2000 表示成功,返回其他表示异常。

2000
TaskIdstring

生成的任务 ID。

asr-a6ac15e0-9118-4b4c-9e64-306163a0****

示例

正常返回示例

JSON格式

{
  "Description": "success",
  "RequestId": "7FF5417D-06E9-5A2C-9A70-581F6149E6C1",
  "RetCode": 2000,
  "TaskId": "asr-a6ac15e0-9118-4b4c-9e64-306163a0****"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-08-12OpenAPI 入参发生变更查看变更详情