Models - Create

Servicio:

Azure AI Services

Versión de la API:

2023-04-01-preview

Permite comenzar a entrenar un modelo personalizado.

Códigos de estado devueltos:

• 201: Operación completada correctamente.
• 400: La solicitud tenía un formato incorrecto.
• 409: Ya existe un modelo con el nombre especificado.

PUT /models/{name}?api-version=2023-04-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
name	path	True	string	Nombre que se puede usar para identificar de forma única el modelo una vez creado. Patrón de Regex: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
api-version	query	True	string	Versión de API solicitada.

Cuerpo de la solicitud

Media Types: "application/json-patch+json"

Nombre	Requerido	Tipo	Description
trainingParameters	True	TrainingParameters	Parámetros para especificar cómo una ejecución de entrenamiento entrena un modelo personalizado.
createdDateTime		string	Solo lectura. Fecha y hora en que se creó por primera vez la ejecución de entrenamiento, en UTC.
error		ErrorResponseDetails	Información de error.
evaluationParameters		ModelEvaluationParameters	Parámetros para especificar cómo se evalúa un modelo.
modelPerformance		ModelPerformance	Métricas de rendimiento para un modelo entrenado personalizado.
name		string	Solo lectura. Nombre que se usa para identificar de forma única la ejecución de entrenamiento.
status		ModelState	Solo lectura. Estado actual de la ejecución de entrenamiento.
updatedDateTime		string	Solo lectura. Fecha y hora en que se actualizó por última vez la ejecución de entrenamiento, en UTC.

Respuestas

Nombre	Tipo	Description
201 Created	Model	Creado
Other Status Codes	ErrorResponse	Error Encabezados x-ms-error-code: string

Ejemplos

Models_Create

Solicitud de ejemplo

HTTP

PUT /models/model_name?api-version=2023-04-01-preview

{
  "trainingParameters": {
    "timeBudgetInHours": 100,
    "trainingDatasetName": "my_dataset_name"
  }
}

Respuesta de muestra

status code:

201

{
  "name": "model_name",
  "createdDateTime": "2023-01-13T20:46:21.210Z",
  "updatedDateTime": "2023-01-13T20:46:21.210Z",
  "status": "notStarted",
  "trainingParameters": {
    "timeBudgetInHours": 100,
    "trainingDatasetName": "my_dataset_name"
  }
}

Definiciones

Nombre	Description
ErrorResponse	Respuesta devuelta cuando se produce un error.
ErrorResponseDetails	Información de error.
ErrorResponseInnerError	Error detallado.
Model	Describe una ejecución de entrenamiento para entrenar un modelo personalizado.
ModelEvaluationParameters	Parámetros para especificar cómo se evalúa un modelo.
ModelKind	Tipo de modelo.
ModelPerformance	Métricas de rendimiento para un modelo entrenado personalizado.
ModelState	Solo lectura. Estado actual de la ejecución de entrenamiento.
ModelTagPerformance	Métricas de rendimiento para cada etiqueta reconocida por un modelo entrenado personalizado.
TrainingParameters	Parámetros para especificar cómo una ejecución de entrenamiento entrena un modelo personalizado.

ErrorResponse

Respuesta devuelta cuando se produce un error.

Nombre	Tipo	Description
error	ErrorResponseDetails	Información de error.

ErrorResponseDetails

Información de error.

Nombre	Tipo	Description
code	string	Código de error.
details	ErrorResponseDetails[]	Lista de errores detallados.
innererror	ErrorResponseInnerError	Error detallado.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponseInnerError

Error detallado.

Nombre	Tipo	Description
code	string	Código de error.
innererror	ErrorResponseInnerError	Error detallado.
message	string	Mensaje de error.

Model

Describe una ejecución de entrenamiento para entrenar un modelo personalizado.

Nombre	Tipo	Description
createdDateTime	string	Solo lectura. Fecha y hora en que se creó por primera vez la ejecución de entrenamiento, en UTC.
error	ErrorResponseDetails	Información de error.
evaluationParameters	ModelEvaluationParameters	Parámetros para especificar cómo se evalúa un modelo.
modelPerformance	ModelPerformance	Métricas de rendimiento para un modelo entrenado personalizado.
name	string	Solo lectura. Nombre que se usa para identificar de forma única la ejecución de entrenamiento.
status	ModelState	Solo lectura. Estado actual de la ejecución de entrenamiento.
trainingCostInMinutes	integer	Solo lectura. Costo real de entrenamiento consumido, en minutos. Presente solo si el entrenamiento se ejecuta como completado.
trainingParameters	TrainingParameters	Parámetros para especificar cómo una ejecución de entrenamiento entrena un modelo personalizado.
updatedDateTime	string	Solo lectura. Fecha y hora en que se actualizó por última vez la ejecución de entrenamiento, en UTC.

ModelEvaluationParameters

Parámetros para especificar cómo se evalúa un modelo.

Nombre	Tipo	Description
testDatasetName	string	Nombre del conjunto de datos usado para las pruebas.

ModelKind

Tipo de modelo.

Nombre	Tipo	Description
Generic-Classifier	string
Generic-Detector	string
Product-Recognizer	string

ModelPerformance

Métricas de rendimiento para un modelo entrenado personalizado.

Nombre	Tipo	Description
accuracyTop1	number	Solo lectura. Para los modelos de clasificación multiclase. Proporción de muestras de prueba en las que la clase de verdad básica coincide con la clase predicha.
accuracyTop5	number	Solo lectura. Para los modelos de clasificación multiclase. La proporción de muestras de prueba en las que la clase de verdad básica se encuentra en las cinco clases de predicción principales.
averagePrecision	number	Solo lectura. Una medida del rendimiento del modelo, resume la precisión y la recuperación en distintos umbrales de confianza.
calibrationECE	number	Solo lectura. Para los modelos de clasificación multiclase. Error de calibración esperado.
meanAveragePrecision30	number	Solo lectura. Para los modelos de detección de objetos. Precisión media media en un umbral del 30 %.
meanAveragePrecision50	number	Solo lectura. Para los modelos de detección de objetos. Precisión media media en un umbral del 50 %.
meanAveragePrecision75	number	Solo lectura. Para los modelos de detección de objetos. Precisión media media en un umbral del 75 %.
tagPerformance	<string,  ModelTagPerformance>	Solo lectura. Métricas de rendimiento para cada etiqueta reconocida por el modelo.

ModelState

Solo lectura. Estado actual de la ejecución de entrenamiento.

Nombre	Tipo	Description
cancelled	string
cancelling	string
failed	string
notStarted	string
succeeded	string
training	string

ModelTagPerformance

Métricas de rendimiento para cada etiqueta reconocida por un modelo entrenado personalizado.

Nombre	Tipo	Description
accuracy	number	Solo lectura. Para modelos multiclase. Precisión de la etiqueta.
averagePrecision50	number	Solo lectura. Para los modelos de detección de objetos. Precisión media en un umbral del 50 %.

TrainingParameters

Parámetros para especificar cómo una ejecución de entrenamiento entrena un modelo personalizado.

Nombre	Tipo	Description
modelKind	ModelKind	Tipo de modelo.
timeBudgetInHours	integer	Presupuesto de tiempo para el entrenamiento, en horas. El valor mínimo permitido es 1 y el valor máximo permitido es 336 horas para GenericClassifier, 1344 horas para GenericDetector. Esta es la cantidad máxima de tiempo de proceso que se gastará para entrenar el modelo.
trainingDatasetName	string	Nombre del conjunto de datos usado para el entrenamiento.