Models - Get

Служба:: Azure AI Services

Версия API:: 2026-01-01

Получает модель, идентифицированную по заданному идентификатору.

GET {endpoint}/customvoice/models/{id}?api-version=2026-01-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например: https://eastus.api.cognitive.microsoft.com).
id	path	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор ресурса
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	Model	Запрос выполнен успешно.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Непредвиденное сообщение об ошибке. Заголовки x-ms-error-code: string

Имя

Тип

Описание

200 OK

Model

Запрос выполнен успешно.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Непредвиденное сообщение об ошибке.

Заголовки

x-ms-error-code: string

Безопасность

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
https://cognitiveservices.azure.com/.default

Примеры

Get a model

Образец запроса

HTTP

GET {endpoint}/customvoice/models/Jessica?api-version=2026-01-01

Пример ответа

Код состояния:: 200

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

Определения

Имя	Описание
Azure.Core.Foundations.Error	Объект ошибки.
Azure.Core.Foundations.ErrorResponse	Ответ, содержащий сведения об ошибке.
Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения об ошибке. Согласно Azure рекомендациям REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.
Model	Объект Model
ModelFailureReason	Причина неудачи обучения модели
ModelProperties	Свойства модели
PresetStyleItem	Заранее заданные стили, поддерживаемые рецептом. Голосовая модель может поддерживать эти стили без какого-либо набора обучения стилю.
Recipe	Рецепт построения моделей. Разные рецепты имеют разные возможности.
Status	Статус ресурса.

Azure.Core.Foundations.Error

Объект

Объект ошибки.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
details	Azure.Core.Foundations.Error[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror	Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Читаемое пользователем представление ошибки.
target	string	Целевой объект ошибки.

Azure.Core.Foundations.ErrorResponse

Объект

Ответ, содержащий сведения об ошибке.

Имя	Тип	Описание
error	Azure.Core.Foundations.Error	Объект ошибки.

Azure.Core.Foundations.InnerError

Объект

Объект, содержащий более конкретные сведения об ошибке. Согласно Azure рекомендациям REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
innererror	Azure.Core.Foundations.InnerError	Внутренняя ошибка.

Model

Объект

Объект Model

Имя	Тип	Описание
consentId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор ресурса
createdDateTime	string (date-time)	Временная метка, когда объект был создан. Метка времени кодируется в формате даты и времени 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 minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор ресурса
lastActionDateTime	string (date-time)	Отметка времени ввода текущего статуса. Метка времени кодируется в формате даты и времени 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 minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор ресурса
properties	ModelProperties	Свойства модели
recipe	Recipe	Рецепт построения моделей. Разные рецепты имеют разные возможности.
status	Status	Статус ресурса.
trainingSetId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор ресурса
voiceName	string minLength: 1	Имя голоса

ModelFailureReason

Перечисление

Причина неудачи обучения модели

Значение	Описание
InaccessibleCustomerStorage	Клиент использует аккаунт Bring Your Own Storage in Speech Account. Но сейчас хранилище недоступно. Пожалуйста, проверьте врача.
SpeakerVerificationFailed	Аудиозапись согласия и обучения не с одного и того же динамика.
TerminateByUser	Клиент отменил обучение модели.
Internal	Ошибка пользовательского голосового сервиса.
DataNotReady	Обучающие данные не готовы к обучению моделей.
DataNotEnough	Обучающих данных недостаточно для обучения моделей.

ModelProperties

Объект

Свойства модели

Имя	Тип	Описание
failedTrainingsets	string[]	ID провалившихся тренировочных наборов.
failureReason	ModelFailureReason	Причина неудачи обучения модели
presetStyles	string[]	Заранее установленные стили этой модели.
secondaryLocales	string[]	Вторичные локации, которые эта модель может использовать. Код локации соответствует BCP-47.
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 (int32)	Максимальный кастомный номер стиля, поддерживаемый в одной голосовой модели.
minDurationInSeconds	number (double)	Минимальная длительность звука в секундах, необходимая для обучения голосовой модели по этому рецепту.
minStyleUtteranceCount	integer (int32)	Минимальное количество высказываний, необходимое для обучения каждого индивидуального стиля.
minUtteranceCount	integer (int32)	Минимальное количество высказываний, необходимое для обучения голосовой модели по этому рецепту.
modelLocales	string[]	Место, где голосовая модель может общаться с этим рецептом. Код локации соответствует BCP-47. Вы можете найти список местоположения для превращения текста в речь здесь https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
presetStyles	<string, PresetStyleItem>	Заданные стили, поддерживаемые этим рецептом в зависимости от региона. Эти стили можно получить без какого-либо набора для обучения стилю.
version	string	Версия рецепта

Status

Перечисление

Статус ресурса.

Значение	Описание
NotStarted	Не начато
Running	Бег
Succeeded	Succeeded
Failed	Неудача
Disabling	Отключение
Disabled	Disabled