你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Base Models - List

服务:

Azure AI Services

API 版本:

2024-02-01-preview

获取基本模型的列表。

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

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string	支持的认知服务终结点 (协议和主机名，例如： https://eastus.api.cognitive.microsoft.com) 。
api-version	query	True	string	要用于此操作的 API 版本。

请求头

名称	必需	类型	说明
Ocp-Apim-Subscription-Key	True	string	在此处提供语音资源密钥。

响应

名称	类型	说明
200 OK	BaseModel[]	成功
Other Status Codes	ErrorResponse	出现了错误。 标头 x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

在此处提供语音资源密钥。

类型: apiKey
在: header

示例

Get base models

示例请求

HTTP

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

示例响应

状态代码:

200

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

定义

名称	说明
BaseModel	基本模型
Error	顶级错误遵循 Microsoft Azure REST API 指南，请参阅 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。 这包含一个顶级错误，其中包含错误代码、消息、详细信息、目标以及具有更多描述性详细信息的内部错误。
ErrorCode	顶级错误代码
ErrorResponse	错误响应遵循 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。 这包含必需的属性错误代码、消息和可选属性目标、内部错误 (可以嵌套) 。
ModelCapability	模型功能

BaseModel

基本模型

名称	类型	说明
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。 这包含一个顶级错误，其中包含错误代码、消息、详细信息、目标以及具有更多描述性详细信息的内部错误。

名称	类型	说明
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	错误的源。 例如，如果模型无效，则为“model”或“model id”。

ErrorCode

顶级错误代码

名称	类型	说明
BadArgument	string
BadRequest	string
Forbidden	string
InternalServerError	string
NotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string
UnsupportedMediaType	string

ErrorResponse

错误响应遵循 Microsoft Azure REST API 指南，请参阅 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。

名称	类型	说明
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。 这包含必需的属性错误代码、消息和可选属性目标、内部错误 (可以嵌套) 。

名称	类型	说明
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”或“model id”。

ModelCapability

模型功能

名称	类型	说明
PersonalVoice	string