共用方式為


Base Models - List

取得基底模型的清單。

GET {endpoint}/customvoice/basemodels?api-version=2024-02-01-preview

URI 參數

名稱 位於 必要 類型 Description
endpoint
path True

string

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

api-version
query True

string

用於此作業的 API 版本。

要求標頭

名稱 必要 類型 Description
Ocp-Apim-Subscription-Key True

string

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

回應

名稱 類型 Description
200 OK

BaseModel[]

Success

Other Status Codes

ErrorResponse

發生錯誤。

標題

x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

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

類型: apiKey
位於: header

範例

Get base models

範例要求

GET {endpoint}/customvoice/basemodels?api-version=2024-02-01-preview

範例回覆

{
  "value": [
    {
      "name": "PhoenixV2Neural",
      "description": "Phonenix V2 base model",
      "releaseDateTime": "2023-12-01T00:00:00.000Z",
      "capabilities": [
        "PersonalVoice"
      ]
    }
  ]
}

定義

名稱 Description
BaseModel

基底模型

Error

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

ErrorCode

最上層錯誤碼

ErrorResponse

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

InnerError

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

ModelCapability

模型功能

BaseModel

基底模型

名稱 類型 Description
capabilities

ModelCapability[]

基底模型的功能

description

string

expirationDateTime

string

TTS 服務停止提供此基底模型的時間戳。 時間戳會編碼為 ISO 8601 日期和時間格式, (“YYYY-MM-DDThh:mm:ssZ”,請參閱 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) 。

name

string

releaseDateTime

string

發行基底模型時的戳記。 時間戳會編碼為 ISO 8601 日期和時間格式, (“YYYY-MM-DDThh:mm:ssZ”,請參閱 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) 。

Error

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

名稱 類型 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

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

名稱 類型 Description
error

Error

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

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

錯誤的來源。 例如,如果是無效的模型,它會是「模型」或「模型標識碼」。

ModelCapability

模型功能

名稱 類型 Description
PersonalVoice

string