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 minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identificador del recurso.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Encabezado de la solicitud

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

Respuestas

Nombre	Tipo	Description
200 OK	Model	Éxito
Other Status Codes	ErrorResponse	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

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 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 el código de error de las propiedades necesarias, el mensaje y el destino de propiedades opcionales, error interno (esto se puede anidar).
Model	Model (objeto)
ModelFailureReason	Motivo del error de entrenamiento del modelo
ModelProperties	Propiedades del 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. Diferentes recetas tienen una capacidad diferente.
Status	Estado de un recurso.

Error

Object

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 de apoyo adicionales 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 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 "modelo" o "id. de modelo" en caso de modelo no válido.

ErrorCode

Enumeración

Código de error de nivel superior

Valor	Description
BadArgument
BadRequest
Forbidden
InternalServerError
NotFound
ServiceUnavailable
TooManyRequests
Unauthorized
UnsupportedMediaType

ErrorResponse

Object

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

Object

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 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 el código de error de las propiedades necesarias, el mensaje y el 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 "modelo" o "id. de modelo" en caso de modelo no válido.

Model

Object

Model (objeto)

Nombre	Tipo	Description
consentId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identificador de recurso
createdDateTime	string (date-time)	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 minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identificador de recurso
lastActionDateTime	string (date-time)	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 minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identificador de recurso
properties	ModelProperties	Propiedades del modelo
recipe	Recipe	Receta para la creación de modelos. Diferentes recetas tienen una capacidad diferente.
status	Status	Estado de un recurso.
trainingSetId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identificador de recurso
voiceName	string minLength: 1	Nombre de voz

ModelFailureReason

Enumeración

Motivo del error de entrenamiento del modelo

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

ModelProperties

Object

Propiedades del 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

Object

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

Object

Receta para la creación de modelos. 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 (int32)	Número máximo de estilo personalizado admitido en un modelo de voz.
minStyleUtteranceCount	integer (int32)	Recuento mínimo de expresiones necesario para entrenar cada estilo personalizado.
minUtteranceCount	integer (int32)	Recuento mínimo de expresiones necesario 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

Enumeración

Estado de un recurso.

Valor	Description
Disabled
Disabling
Failed
NotStarted
Running
Succeeded