Document Models - Compose Model

Servicio:

Azure AI Services

Versión de la API:

2024-07-31-preview

Crea un nuevo modelo de documento a partir de los tipos de documento de los modelos de documento existentes.

POST {endpoint}/documentintelligence/documentModels:compose?api-version=2024-07-31-preview

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.
api-version	query	True	string	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
classifierId	True	string	Clasificador personalizado para dividir y clasificar el archivo de entrada.
docTypes	True	<string,  DocumentTypeDetails>	La asignación de diccionarios admite docTypes a los modelos de documento correspondientes.
modelId	True	string	Nombre único del modelo de documento.
description		string	Descripción del modelo de documento.
split		SplitMode	Comportamiento de división de archivos.
tags		object	Lista de atributos de etiqueta clave-valor asociados al modelo de documento.

Respuestas

Nombre	Tipo	Description
202 Accepted		La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado. Encabezados Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	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

Compose Document Model

Solicitud de ejemplo

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:compose?api-version=2024-07-31-preview

{
  "modelId": "composedModel",
  "description": "Composed model description",
  "classifierId": "customClassifier",
  "docTypes": {
    "formA": {
      "modelId": "model1"
    },
    "formB": {
      "modelId": "model2"
    }
  }
}

Respuesta de muestra

status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-07-31-preview

Definiciones

Nombre	Description
ComposeDocumentModelRequest	Cuerpo de la solicitud para crear un modelo de documento compuesto a partir de modelos de documentos de componentes.
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.
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.
SplitMode	Comportamiento de división de archivos.

ComposeDocumentModelRequest

Cuerpo de la solicitud para crear un modelo de documento compuesto a partir de modelos de documentos de componentes.

Nombre	Tipo	Valor predeterminado	Description
classifierId	string		Clasificador personalizado para dividir y clasificar el archivo de entrada.
description	string		Descripción del modelo de documento.
docTypes	<string,  DocumentTypeDetails>		La asignación de diccionarios admite docTypes a los modelos de documento correspondientes.
modelId	string		Nombre único del modelo de documento.
split	SplitMode	none	Comportamiento de división de archivos.
tags	object		Lista de atributos de etiqueta clave-valor asociados al modelo de documento.

DocumentAnalysisFeature

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

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

DocumentBuildMode

Modo de compilación del modelo de documento personalizado.

Nombre	Tipo	Description
generative	string	Habilite documentos de todos los tipos mediante técnicas de ia generativa.
neural	string	Compatibilidad con documentos con diversas plantillas visuales.
template	string	Documentos de destino 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 de campo.

DocumentFieldType

Tipo de datos semántico del valor de 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 con el formato ISO 3166-1 alfa-3 (por ejemplo, EE. UU.).
currency	string	Importe de moneda con símbolo de moneda opcional y unidad.
date	string	Fecha, normalizada con formato ISO 8601 (AAAA-MM-DD).
integer	string	Número entero, normalizado a entero de 64 bits con signo.
number	string	Número de punto flotante, normalizado a punto flotante de precisión doble.
object	string	Lista con nombre de subcampos de tipos potencialmente diferentes.
phoneNumber	string	Número de teléfono, normalizado en 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	Hora, normalizada a formato ISO 8601 (hh:mm:ss).

DocumentTypeDetails

Información de tipo de documento.

Nombre	Tipo	Description
buildMode	DocumentBuildMode	Modo de compilación del modelo de documento personalizado.
confidenceThreshold	number	Realice un análisis solo si la confianza de docType está por encima del umbral.
description	string	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	Número máximo de documentos del tipo especificado que se va a analizar. Default=all.
modelId	string	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"

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.

SplitMode

Comportamiento de división de archivos.

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