Custom Models - Get

Referencia

Servicio:: Azure AI Services

Versión de la API:: 2.1

Obtiene información detallada sobre un modelo personalizado.

GET {endpoint}/formrecognizer/v2.1/custom/models/{modelId}

Con parámetros opcionales:

GET {endpoint}/formrecognizer/v2.1/custom/models/{modelId}?includeKeys={includeKeys}

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).
modelId	path	True	string uuid	Identificador del modelo.
includeKeys	query		boolean	Incluya la lista de claves extraídas en la información del modelo.

Encabezado de la solicitud

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

Respuestas

Nombre	Tipo	Description
200 OK	Model	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 custom model

Solicitud de ejemplo

HTTP

GET {endpoint}/formrecognizer/v2.1/custom/models/f973e3c1-1148-43bb-bea8-49d0603ab3a8

Respuesta de muestra

status code:: 200

{
  "modelInfo": {
    "modelId": "f973e3c1-1148-43bb-bea8-49d0603ab3a8",
    "modelName": "my composed model",
    "status": "ready",
    "createdDateTime": "2019-05-01T10:53:21Z",
    "lastUpdatedDateTime": "2019-05-01T10:53:23Z",
    "attributes": {
      "isComposed": true
    }
  },
  "keys": {
    "clusters": {
      "0": [
        "Invoice",
        "123112313"
      ],
      "1": [
        "Please remit payment to:",
        "Microsoft"
      ]
    }
  },
  "trainResult": {
    "trainingDocuments": [],
    "fields": [],
    "averageModelAccuracy": 0,
    "errors": []
  },
  "composedTrainResults": [
    {
      "modelId": "4afb20d6-3ed0-4cde-ba40-dbd6207268dd",
      "trainingDocuments": [],
      "fields": [],
      "averageModelAccuracy": 0,
      "errors": []
    },
    {
      "modelId": "6f841356-aa32-42c9-a739-2182c47b79c9",
      "trainingDocuments": [],
      "fields": [],
      "averageModelAccuracy": 0,
      "errors": []
    }
  ]
}

Definiciones

Nombre	Description
Attributes	Atributos de modelo opcionales.
ErrorInformation
ErrorResponse
FormFieldsReport	Informe para un campo de entrenamiento de modelo personalizado.
KeysResult	Claves extraídas por el modelo personalizado.
Model	Respuesta a la operación obtener modelo personalizado.
ModelInfo	Información básica del modelo personalizado.
ModelStatus	Estado del modelo.
TrainingDocumentInfo	Informe de un documento de entrenamiento de modelo personalizado.
TrainResult	Resultado de entrenamiento del modelo personalizado.
TrainStatus	Estado de la operación de entrenamiento.

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

FormFieldsReport

Informe para un campo de entrenamiento de modelo personalizado.

Nombre	Tipo	Description
accuracy	number	Precisión estimada de extracción para este campo.
fieldName	string	Nombre del campo de entrenamiento.

KeysResult

Claves extraídas por el modelo personalizado.

Nombre	Tipo	Description
clusters	object	ClusterIds de asignación de objetos a una lista de claves.

Model

Respuesta a la operación obtener modelo personalizado.

Nombre	Tipo	Description
composedTrainResults	TrainResult[]	Resultado de entrenamiento para el modelo compuesto.
keys	KeysResult	Claves extraídas por el modelo personalizado.
modelInfo	ModelInfo	Información básica del modelo personalizado.
trainResult	TrainResult	Resultado de entrenamiento para el modelo personalizado.

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.

ModelStatus

Estado del modelo.

Nombre	Tipo	Description
creating	string
invalid	string
ready	string

TrainingDocumentInfo

Informe de un documento de entrenamiento de modelo personalizado.

Nombre	Tipo	Description
documentName	string	Nombre del documento de entrenamiento.
errors	ErrorInformation[]	Lista de errores.
pages	integer	Número total de páginas entrenadas.
status	TrainStatus	Estado de la operación de entrenamiento.

TrainResult

Resultado de entrenamiento del modelo personalizado.

Nombre	Tipo	Description
averageModelAccuracy	number	Precisión media.
errors	ErrorInformation[]	Errores devueltos durante la operación de entrenamiento.
fields	FormFieldsReport[]	Lista de campos usados para entrenar el modelo y el error de operación de entrenamiento notificado por cada uno.
modelId	string	Identificador del modelo.
trainingDocuments	TrainingDocumentInfo[]	Lista de los documentos usados para entrenar el modelo y los errores notificados en cada documento.

TrainStatus

Estado de la operación de entrenamiento.

Nombre	Tipo	Description
failed	string
partiallySucceeded	string
succeeded	string

Compartir a través de