更新实时转录翻译任务
更新时间不可用
更新实时转录翻译任务配置。
https://api.agora.io/api/speech-to-text/v1/projects/{appid}/agents/{agentId}/update通过 join 方法开始转写任务后,你可以发起 update 请求更新转写任务配置。
调用该方法更新转写语言、翻译语言、订阅用户等配置不会重置空闲超时计时器,也不会重置任务最长运行时长计时器。上述计时器的起点固定为任务创建完成时刻。
鉴权
sequenceIdinteger已废弃。update 请求的序列号。取值需要大于或等于 0。请确保后一次 update 请求的序列号大于前一次 update 请求的序列号。序列号可以确保声网服务器按照你指定的最新配置来更新转写任务。
updateMaskstring已废弃。指定的更新配置项。如果需要更新多个字段的配置,则需要以逗号作为间隔符。例如:updateMask=languages,rtcConfig.subscribeAudioUids,translateConfig.enable,translateConfig.languages,uidLanguagesConfig。
languagesarray<string>实时转录翻译需要识别的语种,最多支持 4 种语言。 可参考支持识别的语言进行设置。
keywordsarray<string>热词列表。用于提升转写时对特定词汇的识别准确率。最多支持 500 个词。
配置指定用户 ID 的转写语种。最多支持 5 个配置项。
注意
如果你在调用 join 时设置了该字段,现在需要不指定任何用户,则将该字段设为 [](空数组)。
uidstring必选,需要进行转写的用户 ID。最多允许为 5 个 uid 配置 uid 维度的语种识别。
languagesarray<string>必选,需要识别的转录语种。每个 uid 最多支持设置 4 种语言。 可参考支持的语言进行设置。
订阅配置。
subscribeAudioUidsarray<string>用户 ID。如果你需要指定订阅某些用户的音频流,可以设置该字段。
如果需要订阅所有用户的音频流,则 subscribeAudioUids 填 ["all"]。
数组长度不得超过 32。
字幕翻译配置。如果你在调用 join 时启用了翻译功能,如需关闭该功能,可将 enable 设为 false。
如果你未启用翻译功能,可将 enable 设为 true 并设置 languages 来开启翻译功能。
enableboolean是否把转写后的文字进行翻译:
true:翻译。false:不翻译。
响应
如果返回的状态码为 200,表示请求成功。
响应 Body
agent_idstring服务的 ID。
create_tsinteger服务创建时的 Unix 时间戳(秒)。
statusstring服务的状态:
STARTING:服务开始启动。RUNNING:服务进行中。STOPPING:服务退出中。STOPPED:服务退出成功。RECOVERING:服务恢复中。FAILED:服务退出失败。
请求示例
curl --request POST \
--url "https://api.agora.io/api/speech-to-text/v1/projects/:appid/agents/:agentId/update?sequenceId=0&updateMask=string" \
--header 'Authorization: Basic <credentials>' \
--header 'Content-Type: application/json'响应示例
{
"agent_id": "1NT29X11GQSxxxxx80BEIN56XF",
"create_ts": 1735035893,
"status": "RUNNING"
}