建立一個新的即時字幕任務,用於即時轉錄音訊串流為文字。
介面說明
本介面目前屬於維護狀態,建議透過智慧工作流實現該能力,具體參考智慧工作流配置。
QPS 限制
本介面的單使用者 QPS 限制為 20 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理呼叫。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:CreateRtcAsrTask |
create |
*Domain
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
否 |
地域 ID。 |
cn-shanghai |
| Mode |
string |
是 |
串流模式,live 或者 rtc。live 為正常直播串流如 rtmp。 枚舉值:
|
live |
| SDKAppID |
string |
否 |
ARTC 應用 ID。 說明
當參數 Mode 取值為 rtc 時,此參數必填,否則不生效。 |
appId |
| ChannelID |
string |
否 |
房間號。 說明
參數 Mode 取值為 rtc 時,此參數必填,否則不生效。 |
channelId |
| RtcUserId |
string |
否 |
推流使用者 ID。 說明
參數 Mode 取值為 rtc 時,此參數必填,且只能填寫一個,否則不生效。 |
user1 |
| StreamURL |
string |
否 |
直播串流地址。 說明
參數 Mode 取值為 live 時,此參數必填,否則不生效。 |
rtmp://xxx |
| Language |
string |
是 |
原音訊語言,取值:
|
cn |
| CallbackURL |
string |
是 |
回呼地址。 |
http://xxx.com |
| AuthKey |
string |
否 |
校驗 AuthKey,用於生成回呼資訊的 MD5 簽名。 說明
回呼時會在請求標頭中加兩個鑑權欄位,「SIG-TIME」表示當前時間戳記,「ASR-SIG」表示 md5 鑑權欄位,「ASR-SIG」欄位的生成規則為 md5( |
abcd |
| TranslateEnabled |
boolean |
否 |
開啟翻譯。 |
true |
| TargetLanguages |
string |
否 |
目標翻譯語種,取值:
|
en |
| AutoTerminateEnabled |
boolean |
否 |
斷流最大延遲,超過則自動關閉任務。預設值:false。 |
true |
| AutoTerminateDelay |
integer |
否 |
自動斷流延時,單位秒,取值:1~10 秒。 |
5 |
| ReportInterval |
integer |
否 |
回呼上報間隔,單位毫秒,取值範圍:-1~500 毫秒。
|
5 |
回呼範例
透過使用者提供的 CallbackUrl,以 HTTP POST 請求的形式將 JSON 格式的資料放在請求體(Request Body)中回呼至指定地址。回呼參數 Content 詳細說明及回呼流程請參見:互動流程與實現,範例如下所示:
{
"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 |
|||
| Description |
string |
結果描述,為 success 時成功,有錯誤資訊則返回。 |
success |
| RequestId |
string |
閘道請求 ID。 |
7FF5417D-06E9-5A2C-9A70-581F6149E6C1 |
| RetCode |
integer |
狀態碼。返回 2000 表示成功,返回其他表示異常。 |
2000 |
| TaskId |
string |
生成的任務 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****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。