Consents - Create

Serviço:

Azure AI Services

Versão da API:

2024-02-01-preview

Cria um novo consentimento de talento de voz com a URL de áudio fornecida.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://eastus.api.cognitive.microsoft.com).
id	path	True	string	A ID do recurso. Padrão Regex: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
api-version	query	True	string	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Forneça a chave de recurso de Fala aqui.
Operation-Id		string	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 400 Incorreta. Padrão Regex: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
companyName	True	string	Nome da empresa. Deve corresponder ao nome da empresa no arquivo de áudio de consentimento.
locale	True	string	A localidade deste consentimento. O código de localidade segue BCP-47. Você pode encontrar a lista de localidades de texto em fala aqui https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	True	string	ID do recurso
voiceTalentName	True	string	Nome do talento de voz. Deve corresponder ao nome do talento de voz no arquivo de áudio de consentimento.
audioUrl		string	A URL acessível ao público do arquivo de áudio de consentimento. É recomendável ser uma URL de blob do Azure com SAS. Essa propriedade só está disponível na solicitação.
description		string	Descrição do consentimento.
displayName		string	Nome do consentimento.
id		string	ID do recurso
properties		ConsentProperties	Propriedades de consentimento
status		Status	Status de um recurso.

Respostas

Nome	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 a chave de recurso de Fala aqui.

Tipo: apiKey
Em: header

Exemplos

Create a consent

Solicitação de exemplo

HTTP

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



{
  "description": "Consent for Jessica voice",
  "projectId": "Jessica",
  "voiceTalentName": "Jessica Smith",
  "companyName": "Contoso",
  "audioUrl": "https://contoso.blob.core.windows.net/public/jessica-consent.wav?mySasToken",
  "locale": "en-US"
}

Resposta de exemplo

Código de status:

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

Nome	Description
Consent	Objeto consent
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. Isso 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 o código de erro das propriedades necessárias, a mensagem e o destino das propriedades opcionais, o erro interno (isso pode ser aninhado).
Status	Status de um recurso.

Consent

Objeto consent

Nome	Tipo	Description
audioUrl	string	A URL acessível ao público do arquivo de áudio de consentimento. É recomendável ser uma URL de blob do Azure com SAS. Essa propriedade só está disponível na solicitação.
companyName	string	Nome da empresa. Deve corresponder ao nome da empresa no arquivo de áudio de consentimento.
createdDateTime	string	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", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)
description	string	Descrição do consentimento.
displayName	string	Nome do consentimento.
id	string	ID do recurso
lastActionDateTime	string	O carimbo de data/hora em que o status atual foi inserido. O carimbo de data/hora é codificado como formato de data e hora ISO 8601 ("AAAA-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	A localidade deste consentimento. O código de localidade segue BCP-47. Você pode encontrar a lista de localidades de texto em fala aqui https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string	ID do recurso
properties	ConsentProperties	Propriedades de consentimento
status	Status	Status de um recurso.
voiceTalentName	string	Nome do talento de voz. Deve corresponder ao nome do talento de voz no arquivo de áudio de consentimento.

ConsentFailureReason

Motivo da falha na criação do consentimento

Nome	Tipo	Description
AudioAndScriptNotMatch	string	A incompatibilidade de áudio de consentimento com a instrução verbal. Verifique a declaração verbal.
Internal	string	Erro do Serviço de Voz Personalizado.

ConsentProperties

Propriedades de consentimento

Nome	Tipo	Description
failureReason	ConsentFailureReason	Motivo da falha na criação do 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. Isso contém um erro de nível superior com código de erro, mensagem, detalhes, destino e um erro interno com detalhes mais descritivos.

Nome	Tipo	Description
code	ErrorCode	Código de erro de nível superior
details	Error[]	Detalhes adicionais de suporte sobre o erro e/ou as 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 o código de erro das propriedades necessárias, a mensagem e o destino das propriedades opcionais, o erro interno (isso pode ser aninhado).
message	string	Mensagem de erro de nível superior.
target	string	A origem do erro. Por exemplo, seria "model" ou "model id" no caso de modelo inválido.

ErrorCode

Código de erro de nível superior

Nome	Tipo	Description
BadArgument	string
BadRequest	string
Forbidden	string
InternalServerError	string
NotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string
UnsupportedMediaType	string

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.

Nome	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. Isso 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

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 o código de erro das propriedades necessárias, a mensagem e o destino das propriedades opcionais, o erro interno (isso pode ser aninhado).

Nome	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 o código de erro das propriedades necessárias, a mensagem e o destino das propriedades opcionais, o erro interno (isso pode ser aninhado).
message	string	Mensagem de erro detalhada.
target	string	A origem do erro. Por exemplo, seria "model" ou "model id" no caso de modelo inválido.

Status

Status de um recurso.

Nome	Tipo	Description
Disabled	string
Disabling	string
Failed	string
NotStarted	string
Running	string
Succeeded	string