Personal Voices - Create

Ссылка

Служба:: Azure AI Services

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

Создает новый личный голос со звуковыми файлами в Хранилище BLOB-объектов Azure.

PUT {endpoint}/customvoice/personalvoices/{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

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

string

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

Operation-Id

string

Идентификатор монитора состояния для операции. Если заголовок Operation-Id соответствует существующей операции и запрос не идентичен предыдущему запросу, он завершится ошибкой с ошибкой 400 Bad Request.

Шаблон регулярного выражения: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Текст запроса

Имя	Обязательно	Тип	Описание
consentId	True	string	Идентификатор ресурса
projectId	True	string	Идентификатор ресурса
audios		AzureBlobContentSource	Содержимое хранилища BLOB-объектов Azure. В приведенных ниже примерах он представляет файлы https://contoso.blob.core.windows.net/voicecontainer/jessica/*.wav
description		string	Описание личного голоса
displayName		string	Отображаемое имя личного голоса
id		string	Идентификатор ресурса
status		Status	Состояние ресурса.

Ответы

Имя	Тип	Описание
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

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



{
  "projectId": "PersonalVoice",
  "consentId": "Jessica",
  "audios": {
    "containerUrl": "https://contoso.blob.core.windows.net/voicecontainer?mySasToken",
    "prefix": "jessica/",
    "extensions": [
      ".wav"
    ]
  }
}

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

Код состояния:: 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

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

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

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

ModelFailureReason

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

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

PersonalVoice

Личный объект голоса

Имя	Тип	Описание
audios	AzureBlobContentSource	Содержимое хранилища BLOB-объектов Azure. В приведенных ниже примерах он представляет файлы https://contoso.blob.core.windows.net/voicecontainer/jessica/*.wav
consentId	string	Идентификатор ресурса
createdDateTime	string	Метка времени создания объекта. Метка времени закодирована в формате даты и времени ISO 8601 ("ГГГГ-ММ-ДДЧЧч:мм:ссЗ", см https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations. ).
description	string	Описание личного голоса
displayName	string	Отображаемое имя личного голоса
id	string	Идентификатор ресурса
lastActionDateTime	string	Метка времени ввода текущего состояния. Метка времени закодирована в формате даты и времени ISO 8601 ("ГГГГ-ММ-ДДЧЧч:мм:ссЗ", см https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations. ).
projectId	string	Идентификатор ресурса
properties	PersonalVoiceProperties	Свойства личного голоса
speakerProfileId	string	Идентификатор профиля персонального голосового диктора. Заполните это свойство в SSML.
status	Status	Состояние ресурса.

PersonalVoiceProperties

Свойства личного голоса

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

Status

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

Имя	Тип	Описание
Disabled	string
Disabling	string
Failed	string
NotStarted	string
Running	string
Succeeded	string

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

Personal Voices - Create

Параметры URI

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

Текст запроса

Ответы

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

Ocp-Apim-Subscription-Key

Примеры

Create a personal voice

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

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

Определения

AzureBlobContentSource

Error

ErrorCode

ErrorResponse

InnerError

ModelFailureReason

PersonalVoice

PersonalVoiceProperties

Status

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