Models - Create

Referencia

Servicio:: Azure AI Services

Versión de la API:: 2024-02-01-preview

Crea un nuevo modelo de voz.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://eastus.api.cognitive.microsoft.com).
id	path	True	string	Identificador del recurso. Patrón de Regex: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`
api-version	query	True	string	Versión de API que se usará para la operación.

endpoint

path

True

string

Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://eastus.api.cognitive.microsoft.com).

path

True

string

Identificador del recurso.

Patrón de Regex: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

api-version

query

True

string

Versión de API que se usará para la operación.

Encabezado de la solicitud

Nombre Requerido Tipo Description

Ocp-Apim-Subscription-Key

True

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Proporcione la clave de recurso de Voz aquí.
Operation-Id		string	Identificador del monitor de estado de la operación. Si el encabezado Operation-Id coincide con una operación existente y la solicitud no es idéntica a la solicitud anterior, se producirá un error con una solicitud incorrecta 400. Patrón de Regex: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`

string

Proporcione la clave de recurso de Voz aquí.

Operation-Id

string

Identificador del monitor de estado de la operación. Si el encabezado Operation-Id coincide con una operación existente y la solicitud no es idéntica a la solicitud anterior, se producirá un error con una solicitud incorrecta 400.

Patrón de Regex: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
consentId	True	string	Identificador de recurso
projectId	True	string	Identificador de recurso
recipe	True	Recipe	Receta para la creación de modelos. Las diferentes recetas tienen una funcionalidad diferente.
trainingSetId	True	string	Identificador de recurso
description		string	Descripción del modelo
id		string	Identificador de recurso
locale		string	Configuración regional de este modelo. El código de configuración regional sigue A BCP-47. Puede encontrar el texto en la lista de configuración regional de voz aquí https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
properties		ModelProperties	Propiedades de modelo
status		Status	Estado de un recurso.
voiceName		string	Nombre de voz

Respuestas

Nombre	Tipo	Description
201 Created	Model	Creado Encabezados Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Se produjo un error. Encabezados x-ms-error-code: string

Nombre

Tipo

Description

201 Created

Model

Creado

Encabezados

Operation-Id: string
Operation-Location: string

Other Status Codes

ErrorResponse

Se produjo un error.

Encabezados

x-ms-error-code: string

Seguridad

Ocp-Apim-Subscription-Key

Proporcione la clave de recurso de Voz aquí.

Tipo: apiKey
En: header

Ejemplos

Create a model

Create a multi style model

Create a model

Sample request

HTTP

PUT {endpoint}/customvoice/models/Jessica?api-version=2024-02-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=2024-02-01-preview
Operation-Id: 1f4352df-f247-40c0-a7b1-a54d017933e1

{
  "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=2024-02-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=2024-02-01-preview
Operation-Id: a01a127a-c204-4e46-a8c1-fab01559b05b

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

Definiciones

Nombre	Description
Error	El error de nivel superior sigue las directrices de la API REST de Microsoft Azure que están disponibles en https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene un error de nivel superior con código de error, mensaje, detalles, destino y un error interno con detalles más descriptivos.
ErrorCode	Código de error de nivel superior
ErrorResponse	La respuesta de error sigue las directrices de la API REST de Microsoft Azure que está disponible en https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	El error interno sigue las directrices de la API REST de Microsoft Azure que está disponible en https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene código de error de propiedades necesarias, mensaje y destino de propiedades opcionales, error interno (esto se puede anidar).
Model	Objeto Model.
ModelFailureReason	Motivo del error de entrenamiento del modelo
ModelProperties	Propiedades de modelo
PresetStyleItem	Estilos preestablecidos admitidos por la receta. El modelo de voz puede admitir estos estilos sin ningún conjunto de entrenamiento de estilo.
Recipe	Receta para la creación de modelos. Las diferentes recetas tienen una funcionalidad diferente.
Status	Estado de un recurso.

Error

El error de nivel superior sigue las directrices de la API REST de Microsoft Azure que están disponibles en https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene un error de nivel superior con código de error, mensaje, detalles, destino y un error interno con detalles más descriptivos.

Nombre	Tipo	Description
code	ErrorCode	Código de error de nivel superior
details	Error[]	Detalles adicionales de apoyo relacionados con el error o las directivas esperadas.
innererror	InnerError	El error interno sigue las directrices de la API REST de Microsoft Azure que está disponible en https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene código de error de propiedades necesarias, mensaje y destino de propiedades opcionales, error interno (esto se puede anidar).
message	string	Mensaje de error de nivel superior.
target	string	Origen del error. Por ejemplo, sería "model" o "id. de modelo" en caso de modelo no válido.

ErrorCode

Código de error de nivel superior

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

ErrorResponse

La respuesta de error sigue las directrices de la API REST de Microsoft Azure que está disponible en https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nombre	Tipo	Description
error	Error	El error de nivel superior sigue las directrices de la API REST de Microsoft Azure que están disponibles en https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene un error de nivel superior con código de error, mensaje, detalles, destino y un error interno con detalles más descriptivos.

InnerError

El error interno sigue las directrices de la API REST de Microsoft Azure que está disponible en https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene código de error de propiedades necesarias, mensaje y destino de propiedades opcionales, error interno (esto se puede anidar).

Nombre	Tipo	Description
code	string	Código de error detallado para ayudar al diagnóstico.
innererror	InnerError	El error interno sigue las directrices de la API REST de Microsoft Azure que está disponible en https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene código de error de propiedades necesarias, mensaje y destino de propiedades opcionales, error interno (esto se puede anidar).
message	string	Mensaje de error detallado.
target	string	Origen del error. Por ejemplo, sería "model" o "id. de modelo" en caso de modelo no válido.

Model

Objeto Model.

Nombre	Tipo	Description
consentId	string	Identificador de recurso
createdDateTime	string	Marca de tiempo cuando se creó el objeto. La marca de tiempo se codifica como formato de fecha y hora ISO 8601 ("AAAA-MM-DDThh:mm:ssZ", vea https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Descripción del modelo
engineVersion	string	Versión del motor. La actualización de esta versión puede obtener la corrección de errores de pronunciación más reciente.
id	string	Identificador de recurso
lastActionDateTime	string	Marca de tiempo en la que se especificó el estado actual. La marca de tiempo se codifica como formato de fecha y hora ISO 8601 ("AAAA-MM-DDThh:mm:ssZ", vea https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	Configuración regional de este modelo. El código de configuración regional sigue A BCP-47. Puede encontrar el texto en la lista de configuración regional de voz aquí https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string	Identificador de recurso
properties	ModelProperties	Propiedades de modelo
recipe	Recipe	Receta para la creación de modelos. Las diferentes recetas tienen una funcionalidad diferente.
status	Status	Estado de un recurso.
trainingSetId	string	Identificador de recurso
voiceName	string	Nombre de voz

ModelFailureReason

Motivo del error de entrenamiento del modelo

Nombre	Tipo	Description
InaccessibleCustomerStorage	string	El cliente usa Bring Your Own Storage en la cuenta de Voz. Pero el almacenamiento no es accesible ahora. Consulte el documento.
Internal	string	Error del servicio de voz personalizado.
SpeakerVerificationFailed	string	El consentimiento y el audio de entrenamiento no proceden del mismo altavoz.
TerminateByUser	string	El cliente canceló el entrenamiento del modelo.

ModelProperties

Propiedades de modelo

Nombre	Tipo	Description
failureReason	ModelFailureReason	Motivo del error de entrenamiento del modelo
presetStyles	string[]	Estilos preestablecidos de este modelo.
styleTrainingSetIds	object	Estilos personalizados y conjuntos de entrenamiento asociados.
voiceStyles	string[]	Todos los estilos admitidos por este modelo.

PresetStyleItem

Estilos preestablecidos admitidos por la receta. El modelo de voz puede admitir estos estilos sin ningún conjunto de entrenamiento de estilo.

Nombre	Tipo	Description
female	string[]	Estilos preestablecidos admitidos en el modelo de voz femenina.
male	string[]	Estilos preestablecidos admitidos en el modelo de voz masculina.

Recipe

Receta para la creación de modelos. Las diferentes recetas tienen una funcionalidad diferente.

Nombre	Tipo	Description
datasetLocales	string[]	Configuración regional del conjunto de datos de entrenamiento. El código de configuración regional sigue A BCP-47. Puede encontrar el texto en la lista de configuración regional de voz aquí https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
description	string	Descripción de la receta
kind	string	Tipo de receta
maxCustomStyleNum	integer	Número máximo de estilo personalizado admitido en un modelo de voz.
minStyleUtteranceCount	integer	Recuento mínimo de expresiones necesaria para entrenar cada estilo personalizado.
minUtteranceCount	integer	Recuento mínimo de expresiones necesaria para entrenar un modelo de voz con esta receta.
modelLocales	string[]	Configuración regional que un modelo de voz puede hablar con esta receta. El código de configuración regional sigue A BCP-47. Puede encontrar el texto en la lista de configuración regional de voz aquí https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
presetStyles	<string, PresetStyleItem>	Estilos preestablecidos compatibles con esta receta por configuración regional. Puede obtener estos estilos sin ningún conjunto de entrenamiento de estilo.
version	string	Versión de receta

Status

Estado de un recurso.

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

Compartir a través de

Models - Create

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

Ocp-Apim-Subscription-Key

Ejemplos

Create a model

Sample request

Sample response

Create a multi style model

Sample request

Sample response

Definiciones

Error

ErrorCode

ErrorResponse

InnerError

Model

ModelFailureReason

ModelProperties

PresetStyleItem

Recipe

Status

Recursos adicionales