通過HTTP API管理定製熱詞列表,包括建立、查詢、更新和刪除熱詞列表。
使用者指南:提升識別準確率。熱詞列表數量上限等使用限制詳見熱詞限制與計費。
介面地址
- 新加坡
- 華北2(北京)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/audio/asr/customization調用時請將{WorkspaceId}替換為真實的業務空間ID。要求標頭
參數 | 類型 | 是否必選 | 說明 |
|---|---|---|---|
Authorization | string | 是 | 鑒權令牌,格式為 |
Content-Type | string | 是 | 請求體的媒體類型,固定為 |
建立熱詞列表
請求體modelstring(必選)定製熱詞模型,固定為speech-biasing。inputobject(必選)輸入參數對象。
屬性 action string(必選)操作類型,固定為create_vocabulary。target_model string(必選)使用熱詞列表的語音辨識模型,必須與後續調用語音辨識介面時使用的模型一致。prefix string(必選)熱詞列表自訂首碼,僅允許數字和小寫字母,長度不超過10個字元。vocabulary array[object](必選)熱詞列表數組。
屬性 text string(必選)熱詞文本。熱詞文本的語言必須在所選模型的支援範圍內,不同模型支援的語言各不相同。熱詞用於提升識別的準確率,請使用實際詞語而非任一字元組合。長度限制:含非 ASCII 字元時不超過 15 個字元;純 ASCII 時空格分隔片段不超過 7 個。weight integer(必選)熱詞權重。常用值:4。取值範圍:[1, 5]。如果效果不明顯,可以適當增加權重,但權重過大可能產生負面效果,導致其他詞語識別不準確。lang string(可選)待識別音訊語言代碼。設定後,系統將對指定語種進行熱詞識別增強。如果無法提前確定語種,可不設定,模型會自動識別語種。取值範圍(因模型而異):
| 以下為新加坡地區的配置,調用時請將"{WorkspaceId}"替換為真實的業務空間ID,各地區的配置不同。新加坡地區和北京地區的API Key不同,詳情請參見擷取API Key。 |
返回體request_idstring本次調用的唯一識別碼。outputobject模型返回的資料。
屬性 vocabulary_id string建立的熱詞列表ID。object本次請求用量資訊。
屬性 count integer建立的熱詞列表數量,固定為1。 |
批量查詢熱詞列表
請求體modelstring(必選)定製熱詞模型,固定為speech-biasing。inputobject(必選)輸入參數對象。
屬性 action string(必選)操作類型,固定為list_vocabulary。prefix string(可選)熱詞列表自訂首碼,如果設定則只返回指定首碼的熱詞列表。page_index integer頁碼索引,從0開始計數。預設值:0。page_size integer每頁包含資料條數。預設值:10。 | 以下為新加坡地區的配置,調用時請將"{WorkspaceId}"替換為真實的業務空間ID,各地區的配置不同。新加坡地區和北京地區的API Key不同,詳情請參見擷取API Key。 |
返回體request_idstring本次調用的唯一識別碼。outputobject模型返回的資料。
屬性 vocabulary_list array[object]查詢到的熱詞列表。
屬性 vocabulary_id string熱詞列表ID。gmt_createstring建立時間。gmt_modifiedstring修改時間。statusstring狀態:
object本次請求用量資訊。
屬性 count integer固定為1。 |
查詢熱詞列表
請求體modelstring(必選)定製熱詞模型,固定為speech-biasing。inputobject(必選)輸入參數對象。
屬性 action string(必選)操作類型,固定為query_vocabulary。vocabulary_id string(必選)需要查詢的熱詞列表ID。 | 以下為新加坡地區的配置,調用時請將"{WorkspaceId}"替換為真實的業務空間ID,各地區的配置不同。新加坡地區和北京地區的API Key不同,詳情請參見擷取API Key。 |
返回體request_idstring本次調用的唯一識別碼。outputobject模型返回的資料。
屬性 gmt_create string建立時間。gmt_modifiedstring修改時間。statusstring狀態:
string使用熱詞列表的語音辨識模型,必須與後續調用語音辨識介面時使用的模型一致。vocabularyarray[object]查詢到的熱詞列表。
屬性 text string熱詞文本。weight integer熱詞權重。lang string待識別音頻語種。object本次請求用量資訊。
屬性 count integer固定為1。 |
更新熱詞列表
請求體modelstring(必選)定製熱詞模型,固定為speech-biasing。inputobject(必選)輸入參數對象。
屬性 action string(必選)操作類型,固定為update_vocabulary。vocabulary_id string(必選)需要更新的熱詞列表ID。vocabulary array[object](必選)新的熱詞列表,將完全替換原有內容。
屬性 text string(必選)熱詞文本。熱詞文本的語言必須在所選模型的支援範圍內,不同模型支援的語言各不相同。熱詞用於提升識別的準確率,請使用實際詞語而非任一字元組合。長度限制:含非 ASCII 字元時不超過 15 個字元;純 ASCII 時空格分隔片段不超過 7 個。weight integer(必選)熱詞權重。常用值:4。取值範圍:[1, 5]。如果效果不明顯,可以適當增加權重,但權重過大可能產生負面效果,導致其他詞語識別不準確。lang string(可選)待識別音訊語言代碼。設定後,系統將對指定語種進行熱詞識別增強。如果無法提前確定語種,可不設定,模型會自動識別語種。取值範圍(因模型而異):
| 以下為新加坡地區的配置,調用時請將"{WorkspaceId}"替換為真實的業務空間ID,各地區的配置不同。新加坡地區和北京地區的API Key不同,詳情請參見擷取API Key。 |
返回體request_idstring本次調用的唯一識別碼。outputobject模型返回的資料,固定為空白。usageobject本次請求用量資訊。
屬性 count integer更新的熱詞列表數量,固定為1。 |
刪除熱詞列表
請求體modelstring(必選)定製熱詞模型,固定為speech-biasing。inputobject(必選)輸入參數對象。
屬性 action string(必選)操作類型,固定為delete_vocabulary。vocabulary_id string(必選)需要刪除的熱詞列表ID。 | 以下為新加坡地區的配置,調用時請將"{WorkspaceId}"替換為真實的業務空間ID,各地區的配置不同。新加坡地區和北京地區的API Key不同,詳情請參見擷取API Key。 |
返回體request_idstring本次調用的唯一識別碼。outputobject模型返回的資料,固定為空白。usageobject本次請求用量資訊。
屬性 count integer刪除的熱詞列表數量,固定為1。 |