Document Models - Get Model

Referencia

Servicio:: Azure AI Services

Versión de la API:: 2024-11-30

Obtiene información detallada del modelo de documento.

GET {endpoint}/documentintelligence/documentModels/{modelId}?api-version=2024-11-30

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (uri)	Punto de conexión del servicio De inteligencia de documentos.
modelId	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Nombre único del modelo de documento.
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
x-ms-client-request-id		string (uuid)	Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	DocumentModelDetails	La solicitud se ha realizado correctamente. Encabezados x-ms-client-request-id: string
Other Status Codes	DocumentIntelligenceErrorResponse	Una respuesta de error inesperada.

Nombre

Tipo

Description

200 OK

DocumentModelDetails

La solicitud se ha realizado correctamente.

Encabezados

x-ms-client-request-id: string

Other Status Codes

DocumentIntelligenceErrorResponse

Una respuesta de error inesperada.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/token

Ámbitos

Nombre	Description
https://cognitiveservices.azure.com/.default

Ejemplos

Get Custom Document Model

Get Prebuilt Document Model

Get Custom Document Model

Solicitud de ejemplo

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel?api-version=2024-11-30

Respuesta de muestra

status code:: 200

{
  "modelId": "myCustomModel",
  "description": "Custom model description",
  "createdDateTime": "2021-09-24T12:54:35Z",
  "expirationDateTime": "2023-01-01T00:00:00Z",
  "apiVersion": "2024-11-30",
  "docTypes": {
    "myForm": {
      "fieldSchema": {
        "Name": {
          "type": "string"
        },
        "Date": {
          "type": "date"
        },
        "Amount": {
          "type": "number"
        }
      },
      "buildMode": "template",
      "fieldConfidence": {
        "Name": 0.9,
        "Date": 0.95,
        "Amount": 0.93
      }
    }
  },
  "tags": {
    "createdBy": "myUserId"
  }
}

Get Prebuilt Document Model

Solicitud de ejemplo

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice?api-version=2024-11-30

Respuesta de muestra

status code:: 200

{
  "modelId": "prebuilt-invoice",
  "description": "Prebuilt model to extract key information from English invoices, including customer, vendor, invoice ID, due date, total, and more.",
  "createdDateTime": "2021-07-30T00:00:00Z",
  "apiVersion": "2024-11-30",
  "docTypes": {
    "prebuilt:invoice": {
      "fieldSchema": {
        "CustomerName": {
          "type": "string"
        },
        "CustomerId": {
          "type": "string"
        },
        "PurchaseOrder": {
          "type": "string"
        },
        "InvoiceId": {
          "type": "string"
        },
        "InvoiceDate": {
          "type": "date"
        },
        "DueDate": {
          "type": "date"
        },
        "VendorName": {
          "type": "string"
        },
        "VendorAddress": {
          "type": "string"
        },
        "VendorAddressRecipient": {
          "type": "string"
        },
        "CustomerAddress": {
          "type": "string"
        },
        "CustomerAddressRecipient": {
          "type": "string"
        },
        "BillingAddress": {
          "type": "string"
        },
        "BillingAddressRecipient": {
          "type": "string"
        },
        "ShippingAddress": {
          "type": "string"
        },
        "ShippingAddressRecipient": {
          "type": "string"
        },
        "SubTotal": {
          "type": "number"
        },
        "TotalTax": {
          "type": "number"
        },
        "InvoiceTotal": {
          "type": "number"
        },
        "AmountDue": {
          "type": "number"
        },
        "PreviousUnpaidBalance": {
          "type": "number"
        },
        "RemittanceAddress": {
          "type": "string"
        },
        "RemittanceAddressRecipient": {
          "type": "string"
        },
        "ServiceAddress": {
          "type": "string"
        },
        "ServiceAddressRecipient": {
          "type": "string"
        },
        "ServiceStartDate": {
          "type": "date"
        },
        "ServiceEndDate": {
          "type": "date"
        },
        "Items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "Amount": {
                "type": "number"
              },
              "Date": {
                "type": "date"
              },
              "Description": {
                "type": "string"
              },
              "Quantity": {
                "type": "number"
              },
              "ProductCode": {
                "type": "string"
              },
              "Tax": {
                "type": "number"
              },
              "Unit": {
                "type": "string"
              },
              "UnitPrice": {
                "type": "number"
              }
            }
          }
        }
      }
    }
  },
  "tags": {}
}

Definiciones

Nombre	Description
AzureBlobContentSource	Contenido de Azure Blob Storage.
AzureBlobFileListContentSource	Lista de archivos en Azure Blob Storage.
DocumentAnalysisFeature	Características de análisis de documentos que se van a habilitar.
DocumentBuildMode	Modo de compilación del modelo de documento personalizado.
DocumentFieldSchema	Descripción del esquema semántico de campo mediante una sintaxis de estilo de esquema JSON.
DocumentFieldType	Tipo de datos semántico del valor de campo.
DocumentIntelligenceError	Objeto de error.
DocumentIntelligenceErrorResponse	Objeto de respuesta de error.
DocumentIntelligenceInnerError	Objeto que contiene información más específica sobre el error.
DocumentIntelligenceWarning	Objeto de error.
DocumentModelDetails	Información del modelo de documento.
DocumentTypeDetails	Información de tipo de documento.
SplitMode	Comportamiento de división de archivos.

AzureBlobContentSource

Object

Contenido de Azure Blob Storage.

Nombre	Tipo	Description
containerUrl	string (uri)	Dirección URL del contenedor de Azure Blob Storage.
prefix	string	Prefijo de nombre de blob.

AzureBlobFileListContentSource

Object

Lista de archivos en Azure Blob Storage.

Nombre	Tipo	Description
containerUrl	string (uri)	Dirección URL del contenedor de Azure Blob Storage.
fileList	string	Ruta de acceso a un archivo JSONL dentro del contenedor que especifica un subconjunto de documentos.

DocumentAnalysisFeature

Enumeración

Características de análisis de documentos que se van a habilitar.

Valor	Description
barcodes	Habilite la detección de códigos de barras en el documento.
formulas	Habilite la detección de expresiones matemáticas en el documento.
keyValuePairs	Habilite la detección de pares de valores de clave general (campos de formulario) en el documento.
languages	Habilite la detección del idioma de contenido de texto.
ocrHighResolution	Realice OCR en una resolución más alta para controlar documentos con impresión fina.
queryFields	Habilite la extracción de campos adicionales a través del parámetro de consulta QueryFields.
styleFont	Habilite el reconocimiento de varios estilos de fuente.

DocumentBuildMode

Enumeración

Modo de compilación del modelo de documento personalizado.

Valor	Description
neural	Compatibilidad con documentos con diversas plantillas visuales.
template	Documentos de destino con plantillas visuales similares.

DocumentFieldSchema

Object

Descripción del esquema semántico de campo mediante una sintaxis de estilo de esquema JSON.

Nombre	Tipo	Description
description	string maxLength: 4096	Descripción del campo.
example	string	Contenido de campo de ejemplo.
items	DocumentFieldSchema	Esquema de tipo de campo de cada elemento de matriz.
properties	<string, DocumentFieldSchema>	Subcampos con nombre del campo de objeto.
type	DocumentFieldType	Tipo de datos semántico del valor de campo.

DocumentFieldType

Enumeración

Tipo de datos semántico del valor de campo.

Valor	Description
address	Dirección analizada.
array	Lista de subcampos del mismo tipo.
boolean	Valor booleano, normalizado en true o false.
countryRegion	País o región, normalizado con el formato ISO 3166-1 alfa-3 (por ejemplo, EE. UU.).
currency	Importe de moneda con símbolo de moneda opcional y unidad.
date	Fecha, normalizada con formato ISO 8601 (AAAA-MM-DD).
integer	Número entero, normalizado a entero de 64 bits con signo.
number	Número de punto flotante, normalizado a punto flotante de precisión doble.
object	Lista con nombre de subcampos de tipos potencialmente diferentes.
phoneNumber	Número de teléfono, normalizado en formato E.164 (+{CountryCode}{SubscriberNumber}).
selectionGroup	Matriz de valores de cadena seleccionados.
selectionMark	¿Está seleccionado el campo?
signature	¿Está presente la firma?
string	Texto sin formato.
time	Hora, normalizada a formato ISO 8601 (hh:mm:ss).

DocumentIntelligenceError

Object

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	DocumentIntelligenceError[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	DocumentIntelligenceInnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

DocumentIntelligenceErrorResponse

Object

Objeto de respuesta de error.

Nombre	Tipo	Description
error	DocumentIntelligenceError	Información de error.

DocumentIntelligenceInnerError

Object

Objeto que contiene información más específica sobre el error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
innererror	DocumentIntelligenceInnerError	Error interno.
message	string	Representación legible del error.

DocumentIntelligenceWarning

Object

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de advertencia.
message	string	Representación legible de la advertencia.
target	string	Destino del error.

DocumentModelDetails

Object

Información del modelo de documento.

Nombre	Tipo	Valor predeterminado	Description
apiVersion	string		Versión de API que se usa para crear este modelo de documento.
azureBlobFileListSource	AzureBlobFileListContentSource		Lista de archivos de Azure Blob Storage que especifica los datos de entrenamiento. Se debe especificar azureBlobSource o azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource		Ubicación de Azure Blob Storage que contiene los datos de entrenamiento. Se debe especificar azureBlobSource o azureBlobFileListSource.
buildMode	DocumentBuildMode		Modo de compilación del modelo de documento personalizado.
classifierId	string		Para los modelos compuestos, el clasificador personalizado para dividir y clasificar el archivo de entrada.
createdDateTime	string (date-time)		Fecha y hora (UTC) cuando se creó el modelo de documento.
description	string maxLength: 4096		Descripción del modelo de documento.
docTypes	<string, DocumentTypeDetails>		Tipos de documento admitidos.
expirationDateTime	string (date-time)		Fecha y hora (UTC) cuando expire el modelo de documento.
modelId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Nombre único del modelo de documento.
modifiedDateTime	string (date-time)		Fecha y hora (UTC) cuando se modificó por última vez el modelo de documento.
split	SplitMode	none	Para los modelos compuestos, el comportamiento de división de archivos.
tags	object		Lista de atributos de etiqueta clave-valor asociados al modelo de documento.
trainingHours	number (float)		Número de horas de GPU equivalentes de V100 consumidas para el entrenamiento del modelo.
warnings	DocumentIntelligenceWarning[]		Lista de advertencias encontradas al compilar el modelo.

DocumentTypeDetails

Object

Información de tipo de documento.

Nombre	Tipo	Description
buildMode	DocumentBuildMode	Modo de compilación del modelo de documento personalizado.
confidenceThreshold	number (float)	Realice un análisis solo si la confianza de docType está por encima del umbral.
description	string maxLength: 4096	Descripción del modelo de documento.
features	DocumentAnalysisFeature[]	Lista de características de análisis opcionales.
fieldConfidence	object	Confianza estimada para cada campo.
fieldSchema	<string, DocumentFieldSchema>	Descripción del esquema semántico del documento mediante una sintaxis de estilo de esquema JSON.
maxDocumentsToAnalyze	integer (int32)	Número máximo de documentos del tipo especificado que se va a analizar. Default=all.
modelId	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Modelo de documento que se va a usar para analizar documentos con el tipo especificado.
queryFields	string[]	Lista de campos adicionales que se van a extraer. Ex. "NumberOfGuests,StoreNumber"

SplitMode

Enumeración

Comportamiento de división de archivos.

Valor	Description
auto	Dividir automáticamente el archivo en documentos.
none	Trate todo el archivo como un único documento.
perPage	Trate cada página del archivo como un documento independiente.

Compartir a través de

Document Models - Get Model

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

Ocp-Apim-Subscription-Key

OAuth2Auth

Ámbitos

Ejemplos

Get Custom Document Model

Solicitud de ejemplo

Respuesta de muestra

Get Prebuilt Document Model

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AzureBlobContentSource

AzureBlobFileListContentSource

DocumentAnalysisFeature

DocumentBuildMode

DocumentFieldSchema

DocumentFieldType

DocumentIntelligenceError

DocumentIntelligenceErrorResponse

DocumentIntelligenceInnerError

DocumentIntelligenceWarning

DocumentModelDetails

DocumentTypeDetails

SplitMode