Personal Voices - Post

Ссылка

Служба:: Azure AI Services

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

Создает личный голос с аудиофайлами в клиенте.

POST {endpoint}/customvoice/personalvoices/{id}?api-version=2024-02-01-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
projectId	formData	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор проекта.
audioData	formData		file	Звуковые файлы.
description	formData		string	Необязательное описание этой модели.
displayName	formData		string	Отображаемое имя этой модели.
properties	formData		string	свойства.
endpoint	path	True	string	Поддерживаемые конечные точки 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, используемая для этой операции.

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

Media Types: "multipart/form-data"

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string	Укажите здесь ключ ресурса службы "Речь".
Operation-Id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор монитора состояния для операции. Если заголовок Operation-Id соответствует существующей операции, и запрос не идентичен предыдущему запросу, он завершится ошибкой с 400 недопустимым запросом.

Ответы

Имя	Тип	Описание
201 Created	PersonalVoice	Созданный Заголовки Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Произошла ошибка. Заголовки x-ms-error-code: string

Имя

Тип

Описание

201 Created

PersonalVoice

Созданный

Заголовки

Operation-Id: string
Operation-Location: string

Other Status Codes

ErrorResponse

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

Заголовки

x-ms-error-code: string

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

Ocp-Apim-Subscription-Key

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

Тип: apiKey
В: header

Примеры

Create a personal voice

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

HTTP

POST {endpoint}/customvoice/personalvoices/Jessica-PersonalVoice?api-version=2024-02-01-preview

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

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

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/1321a2c0-9be4-471d-83bb-bc3be4f96a6f?api-version=2024-02-01-preview
Operation-Id: 1321a2c0-9be4-471d-83bb-bc3be4f96a6f

{
  "id": "Jessica-PersonalVoice",
  "speakerProfileId": "3059912f-a3dc-49e3-bdd0-02e449df1fe3",
  "projectId": "PersonalVoice",
  "consentId": "Jessica",
  "status": "NotStarted",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

Определения

Имя	Описание
AzureBlobContentSource	Содержимое хранилища BLOB-объектов Azure. В приведенных ниже примерах он представляет файлы https://contoso.blob.core.windows.net/voicecontainer/jessica/*.wav
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. Это содержит код ошибки обязательных свойств, сообщение и необязательные свойства, внутреннюю ошибку (это можно вложить).
ModelFailureReason	Причина сбоя обучения модели
PersonalVoice	Личный объект голосовой связи
PersonalVoiceProperties	Личные свойства голоса
Status	Состояние ресурса.

AzureBlobContentSource

Object

Содержимое хранилища BLOB-объектов Azure. В приведенных ниже примерах он представляет файлы https://contoso.blob.core.windows.net/voicecontainer/jessica/*.wav

Имя	Тип	Описание
containerUrl	string (url)	URL-адрес контейнера хранилища BLOB-объектов Azure с SAS. Требуются разрешения на чтение и список.
extensions	string[]	Расширения имени файла.
prefix	string	Префикс имени BLOB-объекта.

Error

Object

Ошибка верхнего уровня следует рекомендациям по 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	Источник ошибки. Например, это будет "модель" или "идентификатор модели" в случае недопустимой модели.

ErrorCode

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

Код ошибки верхнего уровня

Значение	Описание
BadArgument
BadRequest
Forbidden
InternalServerError
NotFound
ServiceUnavailable
TooManyRequests
Unauthorized
UnsupportedMediaType

ErrorResponse

Object

Ответ на ошибку следует рекомендациям по 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

Object

Внутренняя ошибка соответствует рекомендациям ПО 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	Источник ошибки. Например, это будет "модель" или "идентификатор модели" в случае недопустимой модели.

ModelFailureReason

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

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

Значение	Описание
InaccessibleCustomerStorage	Клиент использует собственное хранилище в учетной записи службы "Речь". Но сейчас хранилище недоступно. Проверьте документации.
Internal	Ошибка пользовательской голосовой службы.
SpeakerVerificationFailed	Согласие и обучающий звук не совпадают с тем же динамиком.
TerminateByUser	Обучение модели, отмененное клиентом.

PersonalVoice

Object

Личный объект голосовой связи

Имя	Тип	Описание
audios	AzureBlobContentSource	Содержимое хранилища BLOB-объектов Azure. В приведенных ниже примерах он представляет файлы https://contoso.blob.core.windows.net/voicecontainer/jessica/*.wav
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 ("ГГГГ-ММ-DDThh:мм:ssZ", см. https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Личное описание голоса
displayName	string minLength: 1	Отображаемое имя личного голоса
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 ("ГГГГ-ММ-DDThh:мм:ssZ", см. https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
projectId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор ресурса
properties	PersonalVoiceProperties	Личные свойства голоса
speakerProfileId	string (uuid)	Идентификатор профиля личных голосовых динамиков. Заполните это свойство в SSML.
status	Status	Состояние ресурса.

PersonalVoiceProperties

Object

Личные свойства голоса

Имя	Тип	Описание
failureReason	ModelFailureReason	Причина сбоя обучения модели

Status

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

Состояние ресурса.

Значение	Описание
Disabled
Disabling
Failed
NotStarted
Running
Succeeded

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

Personal Voices - Post

Параметры URI

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

Ответы

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

Ocp-Apim-Subscription-Key

Примеры

Create a personal voice

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

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

Определения

AzureBlobContentSource

Error

ErrorCode

ErrorResponse

InnerError

ModelFailureReason

PersonalVoice

PersonalVoiceProperties

Status

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