Custom Models - Get Summary

Servicio:

Azure AI Services

Versión de la API:

2.1

Obtiene información sobre todos los modelos personalizados

GET {endpoint}/formrecognizer/v2.1/custom/models?op=summary

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://westus2.api.cognitive.microsoft.com).
op	query	True	string	Especifique si se va a devolver un resumen o una lista completa de modelos.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Respuestas

Nombre	Tipo	Description
200 OK	Models	Correcto
Other Status Codes	ErrorResponse	Entidad de respuesta que acompaña a respuestas no correctas que contienen detalles adicionales sobre el error.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

Ejemplos

Get models summary

Solicitud de ejemplo

HTTP

GET {endpoint}/formrecognizer/v2.1/custom/models?op=summary

Respuesta de muestra

status code:

200

{
  "summary": {
    "count": 5,
    "limit": 5000,
    "lastUpdatedDateTime": "2019-05-01T10:53:21Z"
  }
}

Definiciones

Nombre	Description
Attributes	Atributos de modelo opcionales.
ErrorInformation
ErrorResponse
ModelInfo	Información básica del modelo personalizado.
Models	Respuesta a la operación de lista de modelos personalizados.
ModelStatus	Estado del modelo.
Summary	Resumen de todos los modelos personalizados entrenados.

Attributes

Atributos de modelo opcionales.

Nombre	Tipo	Valor predeterminado	Description
isComposed	boolean	False	¿Este modelo está compuesto? (valor predeterminado: false).

ErrorInformation

Nombre	Tipo	Description
code	string
message	string

ErrorResponse

Nombre	Tipo	Description
error	ErrorInformation

ModelInfo

Información básica del modelo personalizado.

Nombre	Tipo	Description
attributes	Attributes	Atributos de modelo opcionales.
createdDateTime	string	Fecha y hora (UTC) cuando se creó el modelo.
lastUpdatedDateTime	string	Fecha y hora (UTC) cuando se actualizó por última vez el estado.
modelId	string	Identificador del modelo.
modelName	string	Nombre de modelo definido por el usuario opcional (longitud máxima: 1024).
status	ModelStatus	Estado del modelo.

Models

Respuesta a la operación de lista de modelos personalizados.

Nombre	Tipo	Description
modelList	ModelInfo[]	Colección de modelos personalizados entrenados.
nextLink	string	Vínculo a la página siguiente de modelos personalizados.
summary	Summary	Resumen de todos los modelos personalizados entrenados.

ModelStatus

Estado del modelo.

Nombre	Tipo	Description
creating	string
invalid	string
ready	string

Summary

Resumen de todos los modelos personalizados entrenados.

Nombre	Tipo	Description
count	integer	Recuento actual de modelos personalizados entrenados.
lastUpdatedDateTime	string	Fecha y hora (UTC) cuando se actualizó por última vez el resumen.
limit	integer	Número máximo de modelos que se pueden entrenar para esta cuenta.