Documentation
文件

語音轉文字-客製化模型

Service: asr.api.yating.tw/v1
您可以藉由客製化模型來提高語音識別的準確性。
例如，客製化語言模型可以提高醫學、法律、信息技術等領域的語音識別準確性。通過使用語言模型定制，並輸入指定領域的文章段落、語料庫和單詞，就可以擴展和定制基本模型的詞彙表以包含特定領域的術語。
該服務通常可以在幾分鐘內訓練任何自定義模型。創建自定義模型所需的時間和精力取決於您為模型提供的數據。創建語言模型後，您可以在串流或 Restful 情境下使用。
請注意，如果你在同一個帳號內擁有兩把金鑰，並且這兩把都各自建立了客製化語言模型，那這些語言模型可以讓這兩把金鑰共同使用，但是如果你用其中一把金鑰查詢客製化語言模型時，就只能看到這把金鑰之前建立過的模型。

創建自定義語言模式

語料庫是在上下文中使用領域術語的純文本文檔。您可以通過提供 txt 語料庫文件 URL 來生成自定義語言模型。幾分鐘後，您應該能夠獲得個性化的語言模型 ID。
創建自定義模型後，您可以將其用於語音識別請求。假設為轉錄傳遞的音頻包含在定制模型的語料庫中定義的領域特定詞和定制詞。在這種情況下，請求結果反映了模型的增強詞彙。對於語音識別請求，您一次只能使用一個模型，並且該模型只能由生成它的用戶使用。
有兩種訓練數據，文本和單詞。您應該將段落文本和句子放在文本文件中，將短語和單詞放在 word 文件中。正確格式化並將其保存在一個或多個文本文件中。確保文件總大小小於 5 MB，並且每個文本文件：
它是純文本格式（不是 Microsoft Word 文檔、逗號分隔值文件或 PDF 等文件）。
它以 UTF-8 編碼。
不包含任何格式字符，例如 HTML 標記。
每個 txt 檔案大小需小於 1MB。
Request
URL: /models/languages
Method: POST
Body
Name
Type
Info
*textUrls
string[]
Txt file urls.
您提供的文本以換行符號作為切分點，適合用來存放期待辨識出的句子，將每個句子作為高頻出現的常用語，紀錄在model內，當出現時能加以識別
*wordUrls
string[]
word file urls.
您提供的文本以空白符號及換行符號作為切分點，適合用來存放期待辨識出的單字，將每個單字作為高頻出現的常用語，紀錄在model內，當出現時能加以識別
*model
string 
目前僅支援 asr-zh-en-std

** This custom language model is only compatible with the model you put in here.
*description
string 
{
   "textUrls": [
       "Your_txt_file_url"
   ],
   "wordUrls": [
   ],
   "model": "asr-zh-en-std"
   "description": "description"
}
Response 
{
   "uid": "uid",
   "model": "asr-zh-en-std",
   "description": "description",
   "textUrls": "Your_txt_file_url",
   "wordUrls": "",
   "path": "",
   "taskId": "",
   "status": "completed",
   "createdAt": "2022-11-16T10:35:12.296Z",
   "updatedAt": "2022-11-16T10:42:54.000Z"
}
接著，您可以使用下一個 API，輸入 id 以查詢模型狀態。 僅當狀態完成時，您才能在 asr 中使用此客製化語言模型。

查詢多個模型訓練進度

“狀態”鍵將從“待處理”變為“處理中”，最後變為“完成”。 如果出現問題，就會進入“錯誤”。 您可以發出 GET 請求，如下所示，以檢查轉錄狀態的更新。
您必須重複 GET 請求，直到您的狀態為“完成”或“錯誤”。 一旦狀態鍵顯示為“已完成”，您就可以
進行下一步，取得音檔結果。
Request
URL: /models/languages?page=1&perPage=10&status=pending
Method: GET
Header
Name
Type
Info
Authorization
String
Bearer {key}
Query parameter
Name
Info
page
number
perPage
number
status
pending, ongoing, completed, error. if no value, get all list
Response 
{
   "page":1,
   "perPage":10,
   "total":2,
   "nextPage":null,
   "data":[
      {
         "uid":"uid",
         "model":"asr-zh-en-std",
         "description":"description",
         "textUrls":"Your_txt_file_url",
         "wordUrls":"",
         "path":"",
         "taskId":"",
         "status":"completed",
         "createdAt":"2022-11-16T10:35:12.296Z",
         "updatedAt":"2022-11-16T10:42:54.000Z"
      }
   ]
}

查詢一個模型訓練進度

Request
URL: /v1/models/languages/{uid}
Method: GET
Header
Name
Type
Info
Authorization
String
Bearer {key}
Query parameter
Name
Info
uid
string, uid.
Response 
{
         "uid":"uid",
         "model":"asr-zh-en-std",
         "description":"description",
         "textUrls":"Your_txt_file_url",
         "wordUrls":"",
         "path":"",
         "taskId":"",
         "status":"completed",
         "createdAt":"2022-11-16T10:35:12.296Z",
         "updatedAt":"2022-11-16T10:42:54.000Z"
      }

刪除客製化語言模型

Request
URL: /models/languages/{id}
Method: DELETE
Response 
{
   "statusCode": 400,
   "message": "Language Model Not Found"
}