Models - Get

Servicio:

Azure AI Services

Versión de la API:

2024-02-01-preview

Obtiene el modelo identificado por el identificador especificado.

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

Parámetros de identificador URI

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.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Proporcione la clave del recurso de voz aquí.

Respuestas

Nombre	Tipo	Description
200 OK	Model	Correcto
Other Status Codes	ErrorResponse	Se produjo un error. Encabezados x-ms-error-code: string

Seguridad

Ocp-Apim-Subscription-Key

Proporcione la clave del recurso de voz aquí.

Tipo: apiKey
En: header

Ejemplos

Get a model

Solicitud de ejemplo

HTTP

GET {endpoint}/customvoice/models/Jessica?api-version=2024-02-01-preview

Respuesta de muestra

status code:

200

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

Definiciones

Nombre	Description
Error	El error de nivel superior se rige por 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 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 el código de error de las propiedades necesarias, el mensaje y el destino de las propiedades opcionales, error interno (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 capacidad diferente.
Status	Estado de un recurso.

Error

El error de nivel superior se rige por 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 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 el código de error de las propiedades necesarias, el mensaje y el destino de las propiedades opcionales, error interno (se puede anidar).
message	string	Mensaje de error de nivel superior.
target	string	Origen del error. Por ejemplo, sería "model" o "model id" 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 se rige por 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 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 el código de error de las propiedades necesarias, el mensaje y el destino de las propiedades opcionales, error interno (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 el código de error de las propiedades necesarias, el mensaje y el destino de las propiedades opcionales, error interno (se puede anidar).
message	string	Mensaje de error detallado.
target	string	Origen del error. Por ejemplo, sería "model" o "model id" 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. Actualizar 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 cuando 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 capacidad 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 ahora no se puede acceder al almacenamiento. Consulte el documento.
Internal	string	Error del servicio de voz personalizado.
SpeakerVerificationFailed	string	El consentimiento y el audio de entrenamiento no son 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 capacidad 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 admitidos por 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