Consents - Post

Ссылка

Служба:: Azure AI Services

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

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
audiodata	formData	True	file	Звуковой файл, содержащий звуковые данные.
companyName	formData	True	string	Название компании.
locale	formData	True	string	Языковой стандарт этого согласия. Код языкового стандарта следует за BCP-47. Список языковых стандартов текста для речи можно найти здесь https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	formData	True	string	Идентификатор проекта. Шаблон регулярного выражения: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`
voiceTalentName	formData	True	string	Имя озвучивания таланта.
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	Идентификатор ресурса. Шаблон регулярного выражения: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`
api-version	query	True	string	Версия API, используемая для данной операции.

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

Media Types: "multipart/form-data"

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

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]$

Ответы

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

Имя

Тип

Описание

201 Created

Consent

Создание

Заголовки

Operation-Id: string
Operation-Location: string

Other Status Codes

ErrorResponse

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

Заголовки

x-ms-error-code: string

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

Ocp-Apim-Subscription-Key

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

Тип: apiKey
В: header

Примеры

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

HTTP

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

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

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

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/070f7986-ef17-41d0-ba2b-907f0f28e314?api-version=2024-02-01-preview
Operation-Id: 070f7986-ef17-41d0-ba2b-907f0f28e314

{
  "id": "Jessica",
  "description": "Consent for Jessica voice",
  "projectId": "Jessica",
  "voiceTalentName": "Jessica Smith",
  "companyName": "Contoso",
  "locale": "en-US",
  "status": "NotStarted",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

Определения

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

Объект Consent

Имя	Тип	Описание
audioUrl	string	Общедоступный URL-адрес звукового файла согласия. Рекомендуется использовать URL-адрес большого двоичного объекта Azure с SAS. Это свойство доступно только в запросе.
companyName	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. ).
locale	string	Языковой стандарт этого согласия. Код языкового стандарта следует за BCP-47. Список языковых стандартов текста для речи можно найти здесь https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string	Идентификатор ресурса
properties	ConsentProperties	Свойства согласия
status	Status	Состояние ресурса.
voiceTalentName	string	Имя актера для голоса. Должно соответствовать имени актера голоса в звуковом файле согласия.

ConsentFailureReason

Причина сбоя при создании согласия

Имя	Тип	Описание
AudioAndScriptNotMatch	string	Аудиосогласие согласия несовпадение с устной формулировкой. Проверьте словесное высказывание.
Internal	string	Ошибка пользовательской службы голосовой связи.

ConsentProperties

Свойства согласия

Имя	Тип	Описание
failureReason	ConsentFailureReason	Причина сбоя при создании согласия

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

Status

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

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

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

Consents - Post

Параметры URI

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

Ответы

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

Ocp-Apim-Subscription-Key

Примеры

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

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

Определения

ConsentFailureReason

ConsentProperties

Error

ErrorCode

ErrorResponse

InnerError

Status

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

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

Consents - Post

Параметры URI

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

Ответы

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

Ocp-Apim-Subscription-Key

Примеры

Create a consent

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

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

Определения

Consent

ConsentFailureReason

ConsentProperties

Error

ErrorCode

ErrorResponse

InnerError

Status

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