Consents - Create

Service:

Azure AI Services

Version d'API:

2024-02-01-preview

Crée un nouveau consentement de talent vocal avec l’URL audio fournie.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://eastus.api.cognitive.microsoft.com).
id	path	True	string	ID de la ressource. Modèle d’expression régulière: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

En-tête de la demande

Nom	Obligatoire	Type	Description
Ocp-Apim-Subscription-Key	True	string	Fournissez votre clé de ressource Speech ici.
Operation-Id		string	ID du moniteur d’état de l’opération. Si l’en-tête Operation-Id correspond à une opération existante et que la demande n’est pas identique à la demande précédente, elle échoue avec une requête incorrecte de 400. Modèle d’expression régulière: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Corps de la demande

Nom	Obligatoire	Type	Description
companyName	True	string	Nom de la société Doit correspondre au nom de l’entreprise dans le fichier audio de consentement.
locale	True	string	Paramètres régionaux de ce consentement. Le code de paramètres régionaux suit BCP-47. Vous trouverez la liste des paramètres régionaux de synthèse vocale ici https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	True	string	ID de la ressource
voiceTalentName	True	string	Nom du talent vocal. Doit correspondre au nom du talent vocal dans le fichier audio de consentement.
audioUrl		string	URL accessible au public du fichier audio de consentement. Il est recommandé d’être une URL d’objet blob Azure avec SAP. Cette propriété n’est disponible que dans la demande.
description		string	Description du consentement.
displayName		string	Nom du consentement.
id		string	ID de la ressource
properties		ConsentProperties	Propriétés de consentement
status		Status	État d’une ressource.

Réponses

Nom	Type	Description
201 Created	Consent	Date de création En-têtes Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Une erreur est survenue. En-têtes x-ms-error-code: string

Sécurité

Ocp-Apim-Subscription-Key

Fournissez votre clé de ressource Speech ici.

Type: apiKey
Dans: header

Exemples

Create a consent

Exemple de requête

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"
}

Exemple de réponse

Code d’état:

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"
}

Définitions

Nom	Description
Consent	Objet consentement
ConsentFailureReason	Raison de l’échec de la création du consentement
ConsentProperties	Propriétés de consentement
Error	L’erreur de niveau supérieur suit les instructions de l’API REST Microsoft Azure qui sont disponibles à l’adresse https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Il contient une erreur de niveau supérieur avec le code d’erreur, le message, les détails, la cible et une erreur interne avec des détails plus descriptifs.
ErrorCode	Code d’erreur de niveau supérieur
ErrorResponse	La réponse d’erreur suit les instructions de l’API REST Microsoft Azure qui sont disponibles à l’adresse https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	L’erreur interne suit les instructions de l’API REST Microsoft Azure qui sont disponibles à l’adresse https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Il contient le code d’erreur des propriétés requises, le message et les propriétés facultatives cible, erreur interne (cela peut être imbriqué).
Status	État d’une ressource.

Consent

Objet consentement

Nom	Type	Description
audioUrl	string	URL accessible au public du fichier audio de consentement. Il est recommandé d’être une URL d’objet blob Azure avec SAP. Cette propriété n’est disponible que dans la demande.
companyName	string	Nom de la société Doit correspondre au nom de l’entreprise dans le fichier audio de consentement.
createdDateTime	string	Horodatage lors de la création de l’objet. L’horodatage est encodé au format de date et d’heure ISO 8601 (« AAAA-MM-JJThh :mm :ssZ », voir https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)
description	string	Description du consentement.
displayName	string	Nom du consentement.
id	string	ID de la ressource
lastActionDateTime	string	Horodatage lorsque l’état actuel a été entré. L’horodatage est encodé au format de date et d’heure ISO 8601 (« AAAA-MM-JJThh :mm :ssZ », voir https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	Paramètres régionaux de ce consentement. Le code de paramètres régionaux suit BCP-47. Vous trouverez la liste des paramètres régionaux de synthèse vocale ici https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string	ID de la ressource
properties	ConsentProperties	Propriétés de consentement
status	Status	État d’une ressource.
voiceTalentName	string	Nom du talent vocal. Doit correspondre au nom du talent vocal dans le fichier audio de consentement.

ConsentFailureReason

Raison de l’échec de la création du consentement

Nom	Type	Description
AudioAndScriptNotMatch	string	Incompatibilité audio de consentement avec l’instruction verbale. Vérifiez l’instruction verbale.
Internal	string	Erreur du service vocal personnalisé.

ConsentProperties

Propriétés de consentement

Nom	Type	Description
failureReason	ConsentFailureReason	Raison de l’échec de la création du consentement

Error

L’erreur de niveau supérieur suit les instructions de l’API REST Microsoft Azure qui sont disponibles à l’adresse https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Il contient une erreur de niveau supérieur avec le code d’erreur, le message, les détails, la cible et une erreur interne avec des détails plus descriptifs.

Nom	Type	Description
code	ErrorCode	Code d’erreur de niveau supérieur
details	Error[]	Détails supplémentaires concernant l’erreur et/ou les stratégies attendues.
innererror	InnerError	L’erreur interne suit les instructions de l’API REST Microsoft Azure qui sont disponibles à l’adresse https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Il contient le code d’erreur des propriétés requises, le message et les propriétés facultatives cible, erreur interne (cela peut être imbriqué).
message	string	Message d’erreur de niveau supérieur.
target	string	Source de l’erreur. Par exemple, il s’agirait de « modèle » ou « id de modèle » en cas de modèle non valide.

ErrorCode

Code d’erreur de niveau supérieur

Nom	Type	Description
BadArgument	string
BadRequest	string
Forbidden	string
InternalServerError	string
NotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string
UnsupportedMediaType	string

ErrorResponse

La réponse d’erreur suit les instructions de l’API REST Microsoft Azure qui sont disponibles à l’adresse https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nom	Type	Description
error	Error	L’erreur de niveau supérieur suit les instructions de l’API REST Microsoft Azure qui sont disponibles à l’adresse https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Il contient une erreur de niveau supérieur avec le code d’erreur, le message, les détails, la cible et une erreur interne avec des détails plus descriptifs.

InnerError

L’erreur interne suit les instructions de l’API REST Microsoft Azure qui sont disponibles à l’adresse https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Il contient le code d’erreur des propriétés requises, le message et les propriétés facultatives cible, erreur interne (cela peut être imbriqué).

Nom	Type	Description
code	string	Code d’erreur détaillé pour faciliter le diagnostic.
innererror	InnerError	L’erreur interne suit les instructions de l’API REST Microsoft Azure qui sont disponibles à l’adresse https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Il contient le code d’erreur des propriétés requises, le message et les propriétés facultatives cible, erreur interne (cela peut être imbriqué).
message	string	Message d’erreur détaillé.
target	string	Source de l’erreur. Par exemple, il s’agirait de « modèle » ou « id de modèle » en cas de modèle non valide.

Status

État d’une ressource.

Nom	Type	Description
Disabled	string
Disabling	string
Failed	string
NotStarted	string
Running	string
Succeeded	string