Models - Create

Référence

Service:: Azure AI Services

API Version:: 2023-12-01-preview

Crée un nouveau modèle vocal.

PUT {endpoint}/customvoice/models/{id}?api-version=2023-12-01-preview

Paramètres URI

Nom Dans Obligatoire Type Description

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. Regex pattern: `^[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.

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).

path

True

string

ID de la ressource.

Regex pattern: ^[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

Nom	Obligatoire	Type	Description
Ocp-Apim-Subscription-Key	True	string	Fournissez votre clé de ressource Speech ici.
Operation-Id		string	ID du moniteur status 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 400. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`

string

Fournissez votre clé de ressource Speech ici.

Operation-Id

string

ID du moniteur status 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 400.

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

Corps de la demande

Nom	Obligatoire	Type	Description
consentId	True	string	ID de la ressource
projectId	True	string	ID de la ressource
recipe	True	Recipe	Recette pour la création de modèles. Différentes recettes ont des fonctionnalités différentes.
trainingSetId	True	string	ID de la ressource
description		string	Description du modèle
id		string	ID de la ressource
locale		string	Paramètres régionaux de ce modèle. 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.
properties		ModelProperties	Propriétés d’un modèle
status		Status	État d’une ressource.
voiceName		string	Nom de la voix

Réponses

Nom	Type	Description
201 Created	Model	Date de création Headers Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Une erreur est survenue.

Nom

Type

Description

201 Created

Model

Date de création

Headers

Operation-Id: string
Operation-Location: string

Other Status Codes

ErrorResponse

Une erreur est survenue.

Sécurité

Ocp-Apim-Subscription-Key

Fournissez votre clé de ressource Speech ici.

Type: apiKey
In: header

Exemples

Create a model

Create a multi style model

Create a model

Sample Request

HTTP

PUT {endpoint}/customvoice/models/Jessica?api-version=2023-12-01-preview



{
  "voiceName": "JessicaNeural",
  "description": "Jessica voice",
  "recipe": {
    "kind": "Default"
  },
  "projectId": "Jessica",
  "consentId": "Jessica",
  "trainingSetId": "Jessica-300"
}

Sample Response

Status code:: 201

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/1f4352df-f247-40c0-a7b1-a54d017933e1?api-version=2023-12-01-preview
Operation-Id: 1f4352df-f247-40c0-a7b1-a54d017933e1

Response Body

{
  "id": "Jessica",
  "voiceName": "JessicaNeural",
  "description": "Jessica voice",
  "recipe": {
    "kind": "Default",
    "version": "V7.2023.03"
  },
  "projectId": "Jessica",
  "consentId": "Jessica",
  "trainingSetId": "Jessica-300",
  "locale": "en-US",
  "engineVersion": "2023.07.04.0",
  "status": "NotStarted",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

Create a multi style model

Sample Request

HTTP

PUT {endpoint}/customvoice/models/JessicaMultiStyle?api-version=2023-12-01-preview



{
  "voiceName": "JessicaMultiStyleNeural",
  "description": "Jessica multi style voice",
  "recipe": {
    "kind": "MultiStyle"
  },
  "projectId": "Jessica",
  "consentId": "Jessica",
  "trainingSetId": "Jessica-300",
  "locale": "en-US",
  "properties": {
    "presetStyles": [
      "cheerful",
      "sad"
    ],
    "styleTrainingSetIds": {
      "happy": "JessicaHappy-300",
      "myStyle2": "JessicaStyle2"
    }
  }
}

Sample Response

Status code:: 201

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/a01a127a-c204-4e46-a8c1-fab01559b05b?api-version=2023-12-01-preview
Operation-Id: a01a127a-c204-4e46-a8c1-fab01559b05b

Response Body

{
  "id": "JessicaMultiStyle",
  "voiceName": "JessicaMultiStyleNeural",
  "description": "Jessica multi style voice",
  "recipe": {
    "kind": "MultiStyle",
    "version": "V3.2023.06"
  },
  "projectId": "Jessica",
  "consentId": "Jessica",
  "trainingSetId": "Jessica-300",
  "locale": "en-US",
  "engineVersion": "2023.07.04.0",
  "properties": {
    "presetStyles": [
      "cheerful",
      "sad"
    ],
    "styleTrainingSetIds": {
      "happy": "JessicaHappy-300",
      "myStyle2": "JessicaStyle2"
    },
    "voiceStyles": [
      "cheerful",
      "sad",
      "happy",
      "myStyle2"
    ]
  },
  "status": "NotStarted",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

Définitions

Nom	Description
Error	L’erreur de niveau supérieur suit les instructions relatives à l’API REST Microsoft Azure, 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, 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 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, l’erreur interne (cela peut être imbriqué).
Model	Objet Model
ModelFailureReason	Raison de l’échec de l’entraînement du modèle
ModelProperties	Propriétés d’un modèle
PresetStyleItem	Styles prédéfinis pris en charge par la recette. Le modèle vocal peut prendre en charge ces styles sans aucun jeu d’entraînement de style.
Recipe	Recette pour la création de modèles. Différentes recettes ont des fonctionnalités différentes.
Status	État d’une ressource.

Error

L’erreur de niveau supérieur suit les instructions relatives à l’API REST Microsoft Azure, 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 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, l’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 « model » ou de « model ID » 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, 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 relatives à l’API REST Microsoft Azure, 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 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, l’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 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, l’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 « model » ou de « model ID » en cas de modèle non valide.

Model

Objet Model

Nom	Type	Description
consentId	string	ID de la ressource
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 modèle
engineVersion	string	Version du moteur. Mettre à jour cette version peut obtenir la dernière correction de bogue de prononciation.
id	string	ID de la ressource
lastActionDateTime	string	Horodatage lorsque le status 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 modèle. 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	ModelProperties	Propriétés d’un modèle
recipe	Recipe	Recette pour la création de modèles. Différentes recettes ont des fonctionnalités différentes.
status	Status	État d’une ressource.
trainingSetId	string	ID de la ressource
voiceName	string	Nom de la voix

ModelFailureReason

Raison de l’échec de l’entraînement du modèle

Nom	Type	Description
InaccessibleCustomerStorage	string
Internal	string
None	string
SpeakerVerificationFailed	string
TerminateByUser	string

ModelProperties

Propriétés d’un modèle

Nom	Type	Description
failureReason	ModelFailureReason	Raison de l’échec de l’entraînement du modèle
presetStyles	string[]	Styles prédéfinis de ce modèle.
styleTrainingSetIds	object	Styles personnalisés et jeux d’entraînement associés.
voiceStyles	string[]	Tous les styles pris en charge par ce modèle.

PresetStyleItem

Styles prédéfinis pris en charge par la recette. Le modèle vocal peut prendre en charge ces styles sans aucun jeu d’entraînement de style.

Nom	Type	Description
female	string[]	Styles prédéfinis pris en charge sur le modèle vocal féminin.
male	string[]	Styles prédéfinis pris en charge sur le modèle vocal masculin.

Recipe

Recette pour la création de modèles. Différentes recettes ont des fonctionnalités différentes.

Nom	Type	Description
datasetLocales	string[]	Paramètres régionaux du jeu de données d’apprentissage. 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.
description	string	Description de la recette
kind	string	Type de recette
maxCustomStyleNum	integer	Nombre maximal de styles personnalisés pris en charge dans un modèle vocal.
minStyleUtteranceCount	integer	Nombre minimal d’énoncés requis pour effectuer l’apprentissage de chaque style personnalisé.
minUtteranceCount	integer	Nombre minimal d’énoncés requis pour entraîner un modèle vocal avec cette recette.
modelLocales	string[]	Paramètres régionaux qu’un modèle vocal peut parler avec cette recette. 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.
presetStyles	<string, PresetStyleItem>	Styles prédéfinis pris en charge par cette recette par paramètres régionaux. Vous pouvez obtenir ces styles sans aucun jeu d’entraînement de style.
version	string	Version de la recette

Status

État d’une ressource.

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

Share via

Models - Create

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

Ocp-Apim-Subscription-Key

Exemples

Create a model

Sample Request

Sample Response

Create a multi style model

Sample Request

Sample Response

Définitions

Error

ErrorCode

ErrorResponse

InnerError

Model

ModelFailureReason

ModelProperties

PresetStyleItem

Recipe

Status

Ressources supplémentaires