Models - Get

參考

Service:: Azure AI Services

API Version:: 2023-12-01-preview

取得由指定標識碼識別的模型。

GET {endpoint}/customvoice/models/{id}?api-version=2023-12-01-preview

URI 參數

名稱位於必要類型 Description

名稱	位於	必要	類型	Description
endpoint	path	True	string	支援的認知服務端點 (通訊協定和主機名，例如： https://eastus.api.cognitive.microsoft.com) 。
id	path	True	string	資源的標識碼。 Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`
api-version	query	True	string	用於此作業的 API 版本。

endpoint

path

True

string

支援的認知服務端點 (通訊協定和主機名，例如： https://eastus.api.cognitive.microsoft.com) 。

path

True

string

資源的標識碼。

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

api-version

query

True

string

用於此作業的 API 版本。

要求標頭

名稱	必要	類型	Description
Ocp-Apim-Subscription-Key	True	string	在這裡提供您的語音資源金鑰。

回應

名稱	類型	Description
200 OK	Model	Success
Other Status Codes	ErrorResponse	發生錯誤。

安全性

Ocp-Apim-Subscription-Key

在這裡提供您的語音資源金鑰。

Type: apiKey
In: header

範例

Get a model

Sample Request

HTTP

GET {endpoint}/customvoice/models/Jessica?api-version=2023-12-01-preview

Sample Response

Status code:: 200

{
  "id": "Jessica",
  "voiceName": "JessicaNeural",
  "description": "Jessica voice",
  "recipe": {
    "kind": "Default",
    "version": "V7.2023.03"
  },
  "projectId": "Jessica",
  "consentId": "Jessica",
  "trainingSetId": "Jessica-300",
  "locale": "en-US",
  "engineVersion": "2023.07.04.0",
  "status": "NotStarted",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

定義

名稱	Description
Error	最上層錯誤遵循可在取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors的 Microsoft Azure REST API 指導方針。這包含具有錯誤碼、訊息、詳細數據、目標和內部錯誤的最上層錯誤，其中包含更具描述性的詳細數據。
ErrorCode	最上層錯誤碼
ErrorResponse	錯誤回應遵循可在取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors的 Microsoft Azure REST API 指導方針。
InnerError	內部錯誤遵循 Microsoft Azure REST API 指導方針，可在取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。這包含必要的屬性錯誤碼、訊息和選擇性屬性目標、內部錯誤 (這可以是巢狀) 。
Model	模型物件
ModelFailureReason	模型定型失敗原因
ModelProperties	模型屬性
PresetStyleItem	配方支援的默認樣式。語音模型可以支持這些樣式，而不需要任何樣式訓練集。
Recipe	模型建置的配方。不同的配方具有不同的功能。
Status	資源的狀態。

Error

最上層錯誤遵循可在取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors的 Microsoft Azure REST API 指導方針。這包含具有錯誤碼、訊息、詳細數據、目標和內部錯誤的最上層錯誤，其中包含更具描述性的詳細數據。

名稱	類型	Description
code	ErrorCode	最上層錯誤碼
details	Error[]	關於錯誤和/或預期原則的其他支持詳細數據。
innererror	InnerError	內部錯誤遵循 Microsoft Azure REST API 指導方針，可在取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。這包含必要的屬性錯誤碼、訊息和選擇性屬性目標、內部錯誤 (這可以是巢狀) 。
message	string	最上層錯誤訊息。
target	string	錯誤的來源。例如，如果是無效的模型，它會是「模型」或「模型標識碼」。

ErrorCode

最上層錯誤碼

名稱	類型	Description
BadArgument	string
BadRequest	string
Forbidden	string
InternalServerError	string
NotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string
UnsupportedMediaType	string

ErrorResponse

錯誤回應遵循可在取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors的 Microsoft Azure REST API 指導方針。

名稱	類型	Description
error	Error	最上層錯誤遵循可在取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors的 Microsoft Azure REST API 指導方針。這包含具有錯誤碼、訊息、詳細數據、目標和內部錯誤的最上層錯誤，其中包含更具描述性的詳細數據。

InnerError

內部錯誤遵循 Microsoft Azure REST API 指導方針，可在取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。這包含必要的屬性錯誤碼、訊息和選擇性屬性目標、內部錯誤 (這可以是巢狀) 。

名稱	類型	Description
code	string	詳細的錯誤碼可協助診斷。
innererror	InnerError	內部錯誤遵循 Microsoft Azure REST API 指導方針，可在取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。這包含必要的屬性錯誤碼、訊息和選擇性屬性目標、內部錯誤 (這可以是巢狀) 。
message	string	詳細的錯誤訊息。
target	string	錯誤的來源。例如，如果是無效的模型，它會是「模型」或「模型標識碼」。

Model

模型物件

名稱	類型	Description
consentId	string	資源識別碼
createdDateTime	string	建立物件的時間戳。時間戳會編碼為 ISO 8601 日期和時間格式， (“YYYY-MM-DDThh：mm：ssZ”，請參閱 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) 。
description	string	模型描述
engineVersion	string	引擎版本。更新此版本可取得最新的發音錯誤修正。
id	string	資源識別碼
lastActionDateTime	string	輸入目前狀態時的時間戳。時間戳會編碼為 ISO 8601 日期和時間格式， (“YYYY-MM-DDThh：mm：ssZ”，請參閱 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) 。
locale	string	此模型的地區設定。地區設定程式代碼遵循 BCP-47。您可以在這裡 https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts找到文字到語音轉換的地區設定清單。
projectId	string	資源識別碼
properties	ModelProperties	模型屬性
recipe	Recipe	模型建置的配方。不同的配方具有不同的功能。
status	Status	資源的狀態。
trainingSetId	string	資源識別碼
voiceName	string	語音名稱

ModelFailureReason

模型定型失敗原因

名稱	類型	Description
InaccessibleCustomerStorage	string
Internal	string
None	string
SpeakerVerificationFailed	string
TerminateByUser	string

ModelProperties

模型屬性

名稱	類型	Description
failureReason	ModelFailureReason	模型定型失敗原因
presetStyles	string[]	此模型的預設樣式。
styleTrainingSetIds	object	自定義樣式和相關聯的定型集。
voiceStyles	string[]	此模型支援的所有樣式。

PresetStyleItem

配方支援的默認樣式。語音模型可以支持這些樣式，而不需要任何樣式訓練集。

名稱	類型	Description
female	string[]	女性語音模型支援的預設樣式。
male	string[]	男性語音模型支援的預設樣式。

Recipe

模型建置的配方。不同的配方具有不同的功能。

名稱	類型	Description
datasetLocales	string[]	定型數據集的地區設定。地區設定程式代碼遵循 BCP-47。您可以在這裡 https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts找到文字到語音轉換的地區設定清單。
description	string	配方描述
kind	string	配方種類
maxCustomStyleNum	integer	單一語音模型中支援的最大自定義樣式號碼。
minStyleUtteranceCount	integer	訓練每個自定義樣式所需的最小語句計數。
minUtteranceCount	integer	使用此配方定型語音模型所需的最小語句計數。
modelLocales	string[]	語音模型可以與此配方交談的地區設定。地區設定程式代碼遵循 BCP-47。您可以在這裡 https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts找到文字到語音轉換的地區設定清單。
presetStyles	<string, PresetStyleItem>	此配方每個地區設定所支援的預設樣式。您可以取得這些樣式，而不需要任何樣式訓練集。
version	string	配方版本

Status

資源的狀態。

名稱	類型	Description
Disabled	string
Disabling	string
Failed	string
NotStarted	string
Running	string
Succeeded	string

Share via

Models - Get

URI 參數

要求標頭

回應

安全性

Ocp-Apim-Subscription-Key

範例

Get a model

Sample Request

Sample Response

定義

Error

ErrorCode

ErrorResponse

InnerError

Model

ModelFailureReason

ModelProperties

PresetStyleItem

Recipe

Status

其他資源