文件

語音合成

Service: https://tts.api.yating.tw/v1

讓您將文本藉由 REST API 轉換為合成語音，並且支援自然的的聲調與特定語言，接下來說明如何用 http request 來取得文字轉語音服務。

Step1：使用 /speeches/short

Step2：透過 base64 解碼 “audioContent” 並存成音檔

輸入的本文可以是純文字或是SSML(如果你想要語音內容多一點變化與彈性)。有關 SSML 支援的功能，請看這裡。

進行語音合成

在處理完所有輸入後，一般情況下，回應時間低於 60 秒。

Request

URL: https://tts.api.yating.tw/v1/speeches/short

Method: POST

Header

Name	Type	Info
*key	String
*Content-Type	String	Only “application/json”

Body

Name	Type	Info
*input	JSON	1. text: 要生成音頻的文本。如果是一般文字內容，最大文本長度為 600 個字符。如果是 ssml，則對大長度為 5000 個字符。請注意，一個中文字用 2 個字符計算，全形符號兩個字符，半形符號與空格一個字符。 2. type: 請放入 text 或是 ssml.
*voice	JSON	有關聲音的設定請看「voice 設定」
*audioConfig	JSON	有關產出的聲音格式請看「audioConfig 設定」

{
  "input":{
    "text":"這是測試",
    "type":"text"
  },
  "voice":{
    "model":"zh_en_female_2",
  },
  "audioConfig":{
    "encoding":"MP3",
    "sampleRate":"16K"
  }
}

voice 設定

variables	Type	Info
*model	string	這邊要放入你要的聲音類型，請看「聲音代碼列表」

audioConfig 設定

variables	Type	Info
*encoding	string	查看「音訊編碼」
*sampleRate	string	目前只支援 16K

Response

Body

{
  "audioContent": "//NExAARqoIIAAhEuWAAAGNmBGMY4EBcxvABAXBPmPIAF//yAuh9Tn5CEap3/o..."
}

[201] 成功，可以在`audioContext` 裡取得 base64 聲音編碼

[400] invalid request format: request 格式錯誤、你輸入的聲音編碼不存在，sampleRate不支援

{
  statusCode: 400,
  message: string[],
  error: "Bad Request"
}

[401] unauthorized: 密鑰不存在或超出限制。

[422] pipeline error: 請查看下表（管道錯誤消息）以獲取更多詳細信息。

[500] internal server error

Pipeline Error message

error message	type	Info
internal pipeline error: unknown payload [for reqId(...) segId(...)]	Internal pipeline error
internal pipeline error: inferencer unavailable	Internal pipeline error
ssml validation error: no text to synthesis	Ssml validation error	輸入一個空的 SSML
ssml validation error: parsing error at line: {line}, column: {col}: {msg}	Ssml validation error	SSML 文法錯誤
ssml validation error: context error at line: {line}, column: {col}: {msg}	Ssml validation error
encoding error: encode error for reqId(...) segId(...)	Encoding error	編碼器成功接收並處理消息，但過程中出現錯誤。
vocoding error: vocode error for reqId(...) segId(...)	Vocoding error	聲碼器成功接收並處理了 msg，但過程中出現了錯誤。
unknown error	Unknown error	未知錯誤
service busy	Service busy	系統目前忙碌，請稍後再試。

聲音代碼列表

目前支援兩種女性聲音與一種男性聲音，選擇你要的聲音並設定在 confuration 中。

聲音代碼	說明	語言
zh_en_female_1	Female1 (Yating)	Mandarin and English
zh_en_male_1	Male1 (Jiahao)	Mandarin and English
zh_en_female_2	Female2 (Yiqing)	Mandarin and English

音訊編碼

除了聲音類型，還可以選擇音頻輸出格式。目前支持 MP3 和 LINEAR16。

codec	Name	Note
LINEAR16	Linear PCM	WAV音檔編碼格式。16 位線性脈衝編碼調製 (PCM) 編碼。標頭必須包含採樣率。

限制

每個key的最大同時需求處理數：3

範例

Go: https://github.com/TaiwanAILabs-Yating/tts-sdk-go

Python: https://github.com/TaiwanAILabs-Yating/tts-sdk-python