Consents - Post

Referência

Serviço:: Azure AI Services

Versão da API:: 2024-02-01-preview

Cria um novo consentimento de talento de voz com o arquivo de áudio fornecido.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
audiodata	formData	True	file	Um arquivo de áudio contendo os dados de áudio.
companyName	formData	True	string	O nome da empresa.
locale	formData	True	string	A localidade deste consentimento. O código de localidade segue o BCP-47. Você pode encontrar a lista de localidades de texto para fala aqui 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]$	O ID do projeto.
voiceTalentName	formData	True	string	O nome do talento da voz.
description	formData		string	Descrição facultativa do presente consentimento.
displayName	formData		string	O nome para exibição deste consentimento.
properties	formData		string	propriedades.
endpoint	path	True	string	Pontos de extremidade de Serviços Cognitivos suportados (protocolo e nome do host, por exemplo: 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]$	A ID do recurso.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho do Pedido

Media Types: "multipart/form-data"

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Forneça sua chave de recurso de fala aqui.
Operation-Id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID do monitor de status da operação. Se o cabeçalho Operation-Id corresponder a uma operação existente e a solicitação não for idêntica à solicitação anterior, ela falhará com uma solicitação incorreta de 400.

Respostas

Name	Tipo	Description
201 Created	Consent	Criado Cabeçalhos Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Ocorreu um erro. Cabeçalhos x-ms-error-code: string

Name

Tipo

Description

201 Created

Consent

Criado

Cabeçalhos

Operation-Id: string
Operation-Location: string

Other Status Codes

ErrorResponse

Ocorreu um erro.

Cabeçalhos

x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

Forneça sua chave de recurso de fala aqui.

Tipo: apiKey
Em: header

Exemplos

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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"
}

Definições

Name	Description
Consent	Objeto de consentimento
ConsentFailureReason	Motivo da falha na criação do consentimento
ConsentProperties	Propriedades de consentimento
Error	O erro de nível superior segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Este contém um erro de nível superior com código de erro, mensagem, detalhes, destino e um erro interno com detalhes mais descritivos.
ErrorCode	Código de erro de nível superior
ErrorResponse	A resposta de erro segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	O erro interno segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Isso contém código de erro de propriedades necessárias, mensagem e destino de propriedades opcionais, erro interno (isso pode ser aninhado).
Status	Status de um recurso.

Object

Objeto de consentimento

Name	Tipo	Description
audioUrl	string (uri)	O URL acessível ao público do arquivo de áudio de consentimento. É recomendável ser uma URL de blob do Azure com SAS. Esta propriedade só está disponível mediante pedido.
companyName	string minLength: 1	Nome da empresa. Deve corresponder ao nome da empresa no arquivo de áudio de consentimento.
createdDateTime	string (date-time)	O carimbo de data/hora quando o objeto foi criado. O carimbo de data/hora é codificado como formato de data e hora ISO 8601 ("AAAA-MM-DDThh:mm:ssZ", ver https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)
description	string	Descrição do consentimento.
displayName	string minLength: 1	Nome do consentimento.
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID do recurso
lastActionDateTime	string (date-time)	O carimbo de data/hora quando o status atual foi inserido. O carimbo de data/hora é codificado como formato de data e hora ISO 8601 ("AAAA-MM-DDThh:mm:ssZ", ver https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	A localidade deste consentimento. O código de localidade segue o BCP-47. Você pode encontrar a lista de localidades de texto para fala aqui 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]$	ID do recurso
properties	ConsentProperties	Propriedades de consentimento
status	Status	Status de um recurso.
voiceTalentName	string minLength: 1	Nome do talento de voz. Deve corresponder ao nome do talento de voz no arquivo de áudio de consentimento.

ConsentFailureReason

Enumeração

Motivo da falha na criação do consentimento

Valor	Description
AudioAndScriptNotMatch	O áudio de consentimento não corresponde à declaração verbal. Por favor, verifique declaração verbal.
Internal	Erro do Serviço de Voz Personalizado.

ConsentProperties

Object

Propriedades de consentimento

Name	Tipo	Description
failureReason	ConsentFailureReason	Motivo da falha na criação do consentimento

Error

Object

O erro de nível superior segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Este contém um erro de nível superior com código de erro, mensagem, detalhes, destino e um erro interno com detalhes mais descritivos.

Name	Tipo	Description
code	ErrorCode	Código de erro de nível superior
details	Error[]	Detalhes adicionais de suporte sobre o erro e/ou políticas esperadas.
innererror	InnerError	O erro interno segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Isso contém código de erro de propriedades necessárias, mensagem e destino de propriedades opcionais, erro interno (isso pode ser aninhado).
message	string	Mensagem de erro de nível superior.
target	string	A origem do erro. Por exemplo, seria "modelo" ou "id do modelo" no caso de modelo inválido.

ErrorCode

Enumeração

Código de erro de nível superior

Valor	Description
BadArgument
BadRequest
Forbidden
InternalServerError
NotFound
ServiceUnavailable
TooManyRequests
Unauthorized
UnsupportedMediaType

ErrorResponse

Object

A resposta de erro segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Tipo	Description
error	Error	O erro de nível superior segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Este contém um erro de nível superior com código de erro, mensagem, detalhes, destino e um erro interno com detalhes mais descritivos.

InnerError

Object

O erro interno segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Isso contém código de erro de propriedades necessárias, mensagem e destino de propriedades opcionais, erro interno (isso pode ser aninhado).

Name	Tipo	Description
code	string	Código de erro detalhado para ajudar no diagnóstico.
innererror	InnerError	O erro interno segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Isso contém código de erro de propriedades necessárias, mensagem e destino de propriedades opcionais, erro interno (isso pode ser aninhado).
message	string	Mensagem de erro detalhada.
target	string	A origem do erro. Por exemplo, seria "modelo" ou "id do modelo" no caso de modelo inválido.

Status

Enumeração

Status de um recurso.

Valor	Description
Disabled
Disabling
Failed
NotStarted
Running
Succeeded

Partilhar via

Consents - Post

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

Exemplos

Pedido de amostra

Resposta da amostra

Definições

ConsentFailureReason

ConsentProperties

Error

ErrorCode

ErrorResponse

InnerError

Status

Recursos adicionais

Partilhar via

Consents - Post

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

Exemplos

Create a consent

Pedido de amostra

Resposta da amostra

Definições

Consent

ConsentFailureReason

ConsentProperties

Error

ErrorCode

ErrorResponse

InnerError

Status

Recursos adicionais