Consents - Create

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 URL de áudio fornecido.

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

Parâmetros do URI

Name Em Necessário Tipo Description

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://eastus.api.cognitive.microsoft.com).
id	path	True	string	O 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 utilizar para esta operação.

endpoint

path

True

string

Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://eastus.api.cognitive.microsoft.com).

path

True

string

O 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 utilizar para esta operação.

Cabeçalho do Pedido

Name Necessário Tipo Description

Ocp-Apim-Subscription-Key

True

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Forneça a sua chave de recurso de Voz aqui.
Operation-Id		string	ID do monitor de estado da operação. Se o cabeçalho Operation-Id corresponder a uma operação existente e o pedido não for idêntico ao pedido anterior, falhará com um Pedido Incorreto 400. Padrão Regex: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`

string

Forneça a sua chave de recurso de Voz aqui.

Operation-Id

string

ID do monitor de estado da operação. Se o cabeçalho Operation-Id corresponder a uma operação existente e o pedido não for idêntico ao pedido anterior, falhará com um Pedido Incorreto 400.

Padrão Regex: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Corpo do Pedido

Name	Necessário	Tipo	Description
companyName	True	string	Nome da empresa. Tem de corresponder ao nome da empresa no ficheiro de áudio de consentimento.
locale	True	string	A região deste consentimento. O código de região segue BCP-47. Pode encontrar a lista de região de texto para voz 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. Tem de corresponder ao nome do talento de voz no ficheiro de áudio de consentimento.
audioUrl		string	O URL acessível ao público do ficheiro de áudio de consentimento. Recomenda-se que seja um URL de blobs do Azure com SAS. Esta propriedade só está disponível a pedido.
description		string	Descrição do consentimento.
displayName		string	Nome do consentimento.
id		string	ID do recurso
properties		ConsentProperties	Propriedades de consentimento
status		Status	Estado de um recurso.

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 a sua chave de recurso de Voz aqui.

Tipo: apiKey
Em: header

Exemplos

Pedido de amostra

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 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 de 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. Isto 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 a erros 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. Isto contém o código de erro de propriedades necessárias, mensagem e destino de propriedades opcionais, erro interno (isto pode ser aninhado).
Status	Estado de um recurso.

Objeto de consentimento

Name	Tipo	Description
audioUrl	string	O URL acessível ao público do ficheiro de áudio de consentimento. Recomenda-se que seja um URL de blobs do Azure com SAS. Esta propriedade só está disponível a pedido.
companyName	string	Nome da empresa. Tem de corresponder ao nome da empresa no ficheiro 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 ("YYYY-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 quando o estado atual foi introduzido. O carimbo de data/hora é codificado como formato de data e hora ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	A região deste consentimento. O código de região segue BCP-47. Pode encontrar a lista de região de texto para voz 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	Estado de um recurso.
voiceTalentName	string	Nome do talento de voz. Tem de corresponder ao nome do talento de voz no ficheiro de áudio de consentimento.

ConsentFailureReason

Motivo da falha de criação do consentimento

Name	Tipo	Description
AudioAndScriptNotMatch	string	O consentimento do áudio não corresponde à instrução verbal. Verifique a instrução verbal.
Internal	string	Erro do Serviço de Voz Personalizado.

ConsentProperties

Propriedades de consentimento

Name	Tipo	Description
failureReason	ConsentFailureReason	Motivo da falha de 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. Isto 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 de suporte adicionais 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. Isto contém o código de erro de propriedades necessárias, mensagem e destino de propriedades opcionais, erro interno (isto 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" em caso de modelo inválido.

ErrorCode

Código de erro de nível superior

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

ErrorResponse

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

Status

Estado de um recurso.

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

Partilhar via

Consents - Create

Parâmetros do URI

Cabeçalho do Pedido

Corpo 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 - Create

Parâmetros do URI

Cabeçalho do Pedido

Corpo 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