Models - Get

Ссылка

Служба:: Azure AI Services

Версия API:: 2024-02-01-preview

Возвращает модель, определяемую заданным идентификатором.

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

Параметры URI

Имя В Обязательно Тип Описание

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

endpoint

path

True

string

Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например : https://eastus.api.cognitive.microsoft.com).

path

True

string

Идентификатор ресурса.

Шаблон регулярного выражения: ^[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	Произошла ошибка. Заголовки x-ms-error-code: string

Имя

Тип

Описание

200 OK

Model

Успешное завершение

Other Status Codes

ErrorResponse

Произошла ошибка.

Заголовки

x-ms-error-code: string

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

Ocp-Apim-Subscription-Key

Укажите здесь ключ ресурса службы "Речь".

Тип: apiKey
В: header

Примеры

Get a model

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

HTTP

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

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

Код состояния:: 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	Ошибка верхнего уровня соответствует рекомендациям по REST API Microsoft Azure, которые доступны по адресу https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Он содержит ошибку верхнего уровня с кодом ошибки, сообщением, сведениями, целевым объектом и внутренней ошибкой с более подробными сведениями.
ErrorCode	Код ошибки верхнего уровня
ErrorResponse	Ответ об ошибке соответствует рекомендациям по REST API Microsoft Azure, которые доступны по адресу https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	Внутренняя ошибка соответствует рекомендациям по REST API Microsoft Azure, которые доступны по адресу https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Содержит код ошибки обязательных свойств, сообщение и необязательные свойства целевой объект, внутреннюю ошибку (это может быть вложено).
Model	Объект Model
ModelFailureReason	Причина сбоя обучения модели
ModelProperties	Свойства модели
PresetStyleItem	Предустановленные стили, поддерживаемые рецептом. Голосовая модель может поддерживать эти стили без каких-либо наборов для обучения стилей.
Recipe	Рецепт создания модели. Разные рецепты имеют разные возможности.
Status	Состояние ресурса.

Error

Ошибка верхнего уровня соответствует рекомендациям по REST API Microsoft Azure, которые доступны по адресу https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Он содержит ошибку верхнего уровня с кодом ошибки, сообщением, сведениями, целевым объектом и внутренней ошибкой с более подробными сведениями.

Имя	Тип	Описание
code	ErrorCode	Код ошибки верхнего уровня
details	Error[]	Дополнительные сведения об ошибке и (или) ожидаемых политиках.
innererror	InnerError	Внутренняя ошибка соответствует рекомендациям по REST API Microsoft Azure, которые доступны по адресу 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

Ответ об ошибке соответствует рекомендациям по REST API Microsoft Azure, которые доступны по адресу https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Имя	Тип	Описание
error	Error	Ошибка верхнего уровня соответствует рекомендациям по REST API Microsoft Azure, которые доступны по адресу https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Он содержит ошибку верхнего уровня с кодом ошибки, сообщением, сведениями, целевым объектом и внутренней ошибкой с более подробными сведениями.

InnerError

Внутренняя ошибка соответствует рекомендациям по REST API Microsoft Azure, которые доступны по адресу https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Содержит код ошибки обязательных свойств, сообщение и необязательные свойства целевой объект, внутреннюю ошибку (это может быть вложено).

Имя	Тип	Описание
code	string	Подробный код ошибки для диагностики.
innererror	InnerError	Внутренняя ошибка соответствует рекомендациям по REST API Microsoft Azure, которые доступны по адресу https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Содержит код ошибки обязательных свойств, сообщение и необязательные свойства целевой объект, внутреннюю ошибку (это может быть вложено).
message	string	Подробное сообщение об ошибке.
target	string	Источник ошибки. Например, в случае недопустимой модели это будет "model" или "model id".

Model

Объект Model

Имя	Тип	Описание
consentId	string	Идентификатор ресурса
createdDateTime	string	Метка времени создания объекта. Метка времени закодирована в формате даты и времени ISO 8601 ("ГГГГ-ММ-ДДЧЧч:мм:ссЗ", см https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations. ).
description	string	Описание модели
engineVersion	string	Версия обработчика. Обновление этой версии может получить последние исправления ошибок произношения.
id	string	Идентификатор ресурса
lastActionDateTime	string	Метка времени ввода текущего состояния. Метка времени закодирована в формате даты и времени ISO 8601 ("ГГГГ-ММ-ДДЧЧч:мм:ссЗ", см 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

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

Имя	Тип	Описание
InaccessibleCustomerStorage	string	Клиент использует использование собственного хранилища в учетной записи службы "Речь". Но хранилище сейчас недоступно. Ознакомьтесь с документацией.
Internal	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

Поделиться через

Models - Get

Параметры URI

Заголовок запроса

Ответы

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

Ocp-Apim-Subscription-Key

Примеры

Get a model

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

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

Определения

Error

ErrorCode

ErrorResponse

InnerError

Model

ModelFailureReason

ModelProperties

PresetStyleItem

Recipe

Status

Дополнительные ресурсы