Document Models - Get Model

Referencia

Service:: Azure AI Services

API Version:: 2024-02-29-preview

Obtiene información detallada del modelo de documento.

GET {endpoint}/documentintelligence/documentModels/{modelId}?api-version=2024-02-29-preview

Parámetros de identificador URI

Nombre En Requerido Tipo Description

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Punto de conexión del servicio Document Intelligence.
modelId	path	True	string	Nombre único del modelo de documento. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$`
api-version	query	True	string	Versión de API que se usará para la operación.

endpoint

path

True

string

Punto de conexión del servicio Document Intelligence.

modelId

path

True

string

Nombre único del modelo de documento.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$

api-version

query

True

string

Versión de API que se usará para la operación.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string uuid	Un 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. Headers x-ms-client-request-id: string
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Nombre

Tipo

Description

200 OK

DocumentModelDetails

La solicitud se ha realizado correctamente.

Headers

x-ms-client-request-id: string

Other Status Codes

ErrorResponse

Una respuesta de error inesperada.

Seguridad

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

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

Ejemplos

Get Custom Document Model

Get Prebuilt Document Model

Get Custom Document Model

Sample Request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel?api-version=2024-02-29-preview

Sample Response

Status code:: 200

{
  "modelId": "myCustomModel",
  "description": "Custom model description",
  "createdDateTime": "2021-09-24T12:54:35Z",
  "expirationDateTime": "2023-01-01T00:00:00Z",
  "apiVersion": "2024-02-29-preview",
  "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

Sample Request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice?api-version=2024-02-29-preview

Sample Response

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-02-29-preview",
  "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	Azure Blob Storage contenido.
AzureBlobFileListContentSource	Lista de archivos en Azure Blob Storage.
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 del campo.
DocumentModelDetails	Información del modelo de documento.
DocumentTypeDetails	Información de tipo de documento.
Error	Objeto de error.
ErrorResponse	Objeto de respuesta de error.
InnerError	Objeto que contiene información más específica sobre el error.
Warning	Objeto de error.

AzureBlobContentSource

Azure Blob Storage contenido.

Nombre	Tipo	Description
containerUrl	string	Azure Blob Storage dirección URL del contenedor.
prefix	string	Prefijo de nombre de blob.

AzureBlobFileListContentSource

Lista de archivos en Azure Blob Storage.

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

DocumentBuildMode

Modo de compilación del modelo de documento personalizado.

Nombre	Tipo	Description
neural	string	Compatibilidad con documentos con diversas plantillas visuales.
template	string	Destinos de documentos con plantillas visuales similares.

DocumentFieldSchema

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

Nombre	Tipo	Description
description	string	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 del campo.

DocumentFieldType

Tipo de datos semántico del valor del campo.

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

DocumentModelDetails

Información del modelo de documento.

Nombre	Tipo	Description
apiVersion	string	Versión de API usada para crear este modelo de documento.
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage lista de archivos que especifican los datos de entrenamiento. Debe especificarse azureBlobSource o azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage ubicación que contiene los datos de entrenamiento. Debe especificarse azureBlobSource o azureBlobFileListSource.
buildMode	DocumentBuildMode	Modo de compilación del modelo de documento personalizado.
createdDateTime	string	Fecha y hora (UTC) cuando se creó el modelo de documento.
description	string	Descripción del modelo de documento.
docTypes	<string, DocumentTypeDetails>	Tipos de documentos admitidos.
expirationDateTime	string	Fecha y hora (UTC) cuando expire el modelo de documento.
modelId	string	Nombre único del modelo de documento.
tags	object	Lista de atributos de etiqueta clave-valor asociados al modelo de documento.
warnings	Warning[]	Lista de advertencias detectadas al compilar el modelo.

DocumentTypeDetails

Información de tipo de documento.

Nombre	Tipo	Description
buildMode	DocumentBuildMode	Modo de compilación del modelo de documento personalizado.
description	string	Descripción del modelo de documento.
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.

Error

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	InnerError	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.

ErrorResponse

Objeto de respuesta de error.

Nombre	Tipo	Description
error	Error	Información de error.

InnerError

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	InnerError	Error interno.
message	string	Representación legible del error.

Warning

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.

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

Scopes

Ejemplos

Get Custom Document Model

Sample Request

Sample Response

Get Prebuilt Document Model

Sample Request

Sample Response

Definiciones

AzureBlobContentSource

AzureBlobFileListContentSource

DocumentBuildMode

DocumentFieldSchema

DocumentFieldType

DocumentModelDetails

DocumentTypeDetails

Error

ErrorResponse

InnerError

Warning

Recursos adicionales