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 minLength: 3 maxLength: 64 pattern: ^[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 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	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	Состояние ресурса.

Object

Объект Consent

Имя	Тип	Описание
audioUrl	string (uri)	Общедоступный URL-адрес аудиофайла согласия. Рекомендуется быть URL-адресом BLOB-объектов Azure с SAS. Это свойство доступно только в запросе.
companyName	string minLength: 1	Название компании. Должен соответствовать имени компании в звуковом файле согласия.
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).
locale	string	Языковой стандарт этого согласия. Код языкового стандарта следует BCP-47. Здесь можно найти текст для языкового стандарта речи https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор ресурса
properties	ConsentProperties	Свойства согласия
status	Status	Состояние ресурса.
voiceTalentName	string minLength: 1	Имя таланта голоса. Должно соответствовать имени таланта голоса в звуковом файле согласия.

ConsentFailureReason

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

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

Значение	Описание
AudioAndScriptNotMatch	Несоответствие звука согласия с словесным заявлением. Проверьте словесной инструкции.
Internal	Ошибка пользовательской голосовой службы.

ConsentProperties

Object

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

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

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

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

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

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

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

Status

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

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

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

Consents - Post

Параметры URI

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

Ответы

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

Ocp-Apim-Subscription-Key

Примеры

Create a consent

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

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

Определения

Consent

ConsentFailureReason

ConsentProperties

Error

ErrorCode

ErrorResponse

InnerError

Status