Consents - Post

  • Riferimento
Servizio:
Azure AI Services
Versione API:
2024-02-01-preview

Crea un nuovo consenso per i talenti vocali con il file audio fornito.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
audiodata
 formData True

file

File audio contenente i dati audio.
companyName
 formData True

string

Nome della società.
locale
 formData True

string

Impostazioni locali di questo consenso. Il codice delle impostazioni locali segue BCP-47. È possibile trovare l'elenco delle impostazioni locali per la voce qui https://video2.skills-academy.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId
 formData True

string

ID del progetto.

Criterio di espressione regolare: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
voiceTalentName
 formData True

string

Il nome del talento vocale.
description
 formData

string

Descrizione facoltativa del consenso.
displayName
 formData

string

Nome visualizzato di questo consenso.
properties
 formData

string

properties.
endpoint
 path True

string

Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://eastus.api.cognitive.microsoft.com).
id
 path True

string

ID della risorsa.

Criterio di espressione regolare: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
api-version
 query True

string

Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Media Types: "multipart/form-data"

Nome Necessario Tipo Descrizione
Ocp-Apim-Subscription-Key True

string

Specificare qui la chiave della risorsa Voce.
Operation-Id

string

ID del monitoraggio dello stato per l'operazione. Se l'intestazione Operation-Id corrisponde a un'operazione esistente e la richiesta non è identica alla richiesta precedente, avrà esito negativo con una richiesta non valida 400.

Criterio di espressione regolare: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Risposte

Nome Tipo Descrizione
201 Created

Consent

Data di creazione

Intestazioni

  • Operation-Id: string
  • Operation-Location: string
Other Status Codes

ErrorResponse

Si è verificato un errore.

Intestazioni

x-ms-error-code: string

Sicurezza

Ocp-Apim-Subscription-Key

Specificare qui la chiave della risorsa Voce.

Tipo: apiKey
In: header

Esempio

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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"
}

Definizioni

Nome Descrizione
Consent

Oggetto Consent
ConsentFailureReason

Motivo dell'errore di creazione del consenso
ConsentProperties

Proprietà di consenso
Error

L'errore di primo livello segue le linee guida per le API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene un errore di primo livello con codice di errore, messaggio, dettagli, destinazione e errore interno con dettagli più descrittivi.
ErrorCode

Codice di errore di primo livello
ErrorResponse

Risposta agli errori segue le linee guida per l'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError

L'errore interno segue le linee guida per l'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene il codice di errore delle proprietà richieste, il messaggio e la destinazione delle proprietà facoltative, l'errore interno(può essere annidato).
Status

Stato di una risorsa.

Oggetto Consent

Nome Tipo Descrizione
audioUrl

string

URL accessibile pubblico del file audio di consenso. È consigliabile essere un URL BLOB di Azure con firma di accesso condiviso. Questa proprietà è disponibile solo nella richiesta.
companyName

string

Nome della società. Deve corrispondere al nome della società nel file audio di consenso.
createdDateTime

string

Timestamp al momento della creazione dell'oggetto. Il timestamp viene codificato come formato di data e ora ISO 8601 ("AAAAA-MM-DDThh:mm:ssZ", vedere https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)
description

string

Descrizione del consenso.
displayName

string

Nome del consenso.
id

string

ID risorsa
lastActionDateTime

string

Timestamp quando è stato immesso lo stato corrente. Il timestamp viene codificato come formato di data e ora ISO 8601 ("AAAAA-MM-DDThh:mm:ssZ", vedere https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale

string

Impostazioni locali di questo consenso. Il codice delle impostazioni locali segue BCP-47. È possibile trovare l'elenco delle impostazioni locali per la voce qui https://video2.skills-academy.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId

string

ID risorsa
properties

ConsentProperties

Proprietà di consenso
status

Status

Stato di una risorsa.
voiceTalentName

string

Nome del talento vocale. Deve corrispondere al nome del talento vocale nel file audio di consenso.

ConsentFailureReason

Motivo dell'errore di creazione del consenso

Nome Tipo Descrizione
AudioAndScriptNotMatch

string

Mancata corrispondenza dell'audio del consenso con l'istruzione verbale. Controllare l'istruzione verbale.
Internal

string

Errore del servizio vocale personalizzato.

ConsentProperties

Proprietà di consenso

Nome Tipo Descrizione
failureReason

ConsentFailureReason

Motivo dell'errore di creazione del consenso

Error

L'errore di primo livello segue le linee guida per le API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene un errore di primo livello con codice di errore, messaggio, dettagli, destinazione e errore interno con dettagli più descrittivi.

Nome Tipo Descrizione
code

ErrorCode

Codice di errore di primo livello
details

Error[]

Dettagli aggiuntivi di supporto relativi all'errore e/o ai criteri previsti.
innererror

InnerError

L'errore interno segue le linee guida per l'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene il codice di errore delle proprietà richieste, il messaggio e la destinazione delle proprietà facoltative, l'errore interno(può essere annidato).
message

string

Messaggio di errore di primo livello.
target

string

Indica l'origine dell'errore. Ad esempio, sarebbe "modello" o "id modello" nel caso di modello non valido.

ErrorCode

Codice di errore di primo livello

Nome Tipo Descrizione
BadArgument

string

BadRequest

string

Forbidden

string

InternalServerError

string

NotFound

string

ServiceUnavailable

string

TooManyRequests

string

Unauthorized

string

UnsupportedMediaType

string

ErrorResponse

Risposta agli errori segue le linee guida per l'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nome Tipo Descrizione
error

Error

L'errore di primo livello segue le linee guida per le API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene un errore di primo livello con codice di errore, messaggio, dettagli, destinazione e errore interno con dettagli più descrittivi.

InnerError

L'errore interno segue le linee guida per l'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene il codice di errore delle proprietà richieste, il messaggio e la destinazione delle proprietà facoltative, l'errore interno(può essere annidato).

Nome Tipo Descrizione
code

string

Codice di errore dettagliato per facilitare la diagnostica.
innererror

InnerError

L'errore interno segue le linee guida per l'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene il codice di errore delle proprietà richieste, il messaggio e la destinazione delle proprietà facoltative, l'errore interno(può essere annidato).
message

string

Messaggio di errore dettagliato.
target

string

Indica l'origine dell'errore. Ad esempio, sarebbe "modello" o "id modello" nel caso di modello non valido.

Status

Stato di una risorsa.

Nome Tipo Descrizione
Disabled

string

Disabling

string

Failed

string

NotStarted

string

Running

string

Succeeded

string