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	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например). 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	Ошибка верхнего уровня соответствует рекомендациям по 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. Содержит код ошибки обязательных свойств, сообщение и необязательные свойства целевой объект, внутреннюю ошибку (это может быть вложено).
ModelCapability	Возможности модели

BaseModel

Базовая модель

Имя	Тип	Описание
capabilities	ModelCapability[]	Возможности базовой модели
description	string
expirationDateTime	string	Метка времени, когда служба TTS перестанет обслуживать эту базовую модель. Метка времени закодирована в формате даты и времени ISO 8601 ("ГГГГ-ММ-ДДЧч:мм:ссЗ", см https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations. ).
name	string
releaseDateTime	string	Метка при выпуске базовой модели. Метка времени закодирована в формате даты и времени ISO 8601 ("ГГГГ-ММ-ДДЧч:мм:ссЗ", см https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations. ).

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".

ModelCapability

Возможности модели

Имя	Тип	Описание
PersonalVoice	string