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

Models - Get

Service:

Cognitive Services - Custom Voice

API Version:

2023-12-01-preview

获取由给定 ID 标识的模型。

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

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string	支持的认知服务终结点 (协议和主机名，例如： https://eastus.api.cognitive.microsoft.com) 。
id	path	True	string	资源的 ID。 Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
api-version	query	True	string	要用于此操作的 API 版本。

请求头

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

响应

名称	类型	说明
200 OK	Model	成功
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"
}

定义

名称	说明
Error	顶级错误遵循 Microsoft https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsAzure REST API 指南，可从 获取。 这包含一个顶级错误，其中包含错误代码、消息、详细信息、目标以及具有更多描述性详细信息的内部错误。
ErrorCode	顶级错误代码
ErrorResponse	错误响应遵循 Microsoft https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsAzure REST API 指南，可从 获取。
InnerError	内部错误遵循 Microsoft Azure REST API 指南，可在 获取 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。 这包含必需的属性错误代码、消息和可选属性目标、内部错误 (这可以嵌套) 。
Model	Model 对象
ModelFailureReason	模型训练失败原因
ModelProperties	模型属性
PresetStyleItem	食谱支持的预设样式。 语音模型可以支持这些样式，而无需设置任何样式训练。
Recipe	模型构建的配方。 不同的食谱具有不同的功能。
Status	资源的状态。

Error

顶级错误遵循 Microsoft https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsAzure REST API 指南，可从 获取。 这包含一个顶级错误，其中包含错误代码、消息、详细信息、目标以及具有更多描述性详细信息的内部错误。

名称	类型	说明
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 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsAzure REST API 指南，可从 获取。

名称	类型	说明
error	Error	顶级错误遵循 Microsoft https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsAzure REST API 指南，可从 获取。 这包含一个顶级错误，其中包含错误代码、消息、详细信息、目标以及具有更多描述性详细信息的内部错误。

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”。

Model

Model 对象

名称	类型	说明
consentId	string	资源 ID
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	引擎版本。 更新此版本可以获得最新的发音 bug 修复。
id	string	资源 ID
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	资源 ID
properties	ModelProperties	模型属性
recipe	Recipe	模型构建的配方。 不同的食谱具有不同的功能。
status	Status	资源的状态。
trainingSetId	string	资源 ID
voiceName	string	语音名称

ModelFailureReason

模型训练失败原因

名称	类型	说明
InaccessibleCustomerStorage	string
Internal	string
None	string
SpeakerVerificationFailed	string
TerminateByUser	string

ModelProperties

模型属性

名称	类型	说明
failureReason	ModelFailureReason	模型训练失败原因
presetStyles	string[]	此模型的预设样式。
styleTrainingSetIds	object	自定义样式和关联的训练集。
voiceStyles	string[]	此模型支持的所有样式。

PresetStyleItem

食谱支持的预设样式。 语音模型可以支持这些样式，而无需设置任何样式训练。

名称	类型	说明
female	string[]	女性语音模型支持的预设样式。
male	string[]	男性语音模型支持的预设样式。

Recipe

模型构建的配方。 不同的食谱具有不同的功能。

名称	类型	说明
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

资源的状态。

名称	类型	说明
Disabled	string
Disabling	string
Failed	string
NotStarted	string
Running	string
Succeeded	string