@azure/ai-form-recognizer package

Credencial basada en clave estática que admite la actualización del valor de clave subyacente.

Un cliente para interactuar con las características de análisis del servicio Form Recognizer.

Ejemplos:

El servicio Form Recognizer y los clientes admiten dos medios de autenticación:

Azure Active Directory

import { DefaultAzureCredential } from "@azure/identity";
import { DocumentAnalysisClient } from "@azure/ai-form-recognizer";

const credential = new DefaultAzureCredential();
const client = new DocumentAnalysisClient(
  "https://<resource name>.cognitiveservices.azure.com",
  credential,
);

Clave de API (clave de suscripción)

import { AzureKeyCredential, DocumentAnalysisClient } from "@azure/ai-form-recognizer";

const credential = new AzureKeyCredential("<API key>");
const client = new DocumentAnalysisClient(
  "https://<resource name>.cognitiveservices.azure.com",
  credential,
);

Un cliente para interactuar con las características de administración de modelos del servicio Form Recognizer, como crear, leer, enumerar, eliminar y copiar modelos.

Ejemplos:

Azure Active Directory

import { DefaultAzureCredential } from "@azure/identity";
import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";

const credential = new DefaultAzureCredential();
const client = new DocumentModelAdministrationClient(
  "https://<resource name>.cognitiveservices.azure.com",
  credential,
);

Clave de API (clave de suscripción)

import { AzureKeyCredential, DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";

const credential = new AzureKeyCredential("<API key>");
const client = new DocumentModelAdministrationClient(
  "https://<resource name>.cognitiveservices.azure.com",
  credential,
);

Valor del campo de dirección.

Opciones para la operación de análisis de documentos.

Resultado de una operación de análisis. El modelo utilizado para realizar el análisis puede determinar el tipo del documento.

Los campos comunes de todos los tipos de tipo AnalyzeResult, como LayoutResult, ReadResult y GeneralDocumentResult.

Objeto de documento extraído.

AnalyzedDocument es una instancia de uno de los tipos de documento dentro de un modelo. Sus campos corresponden al esquema de campo del tipo de documento.

Origen de datos de entrenamiento definido por un contenedor de blobs de Azure y una lista de archivos JSONL dentro del contenedor.

Lista de archivos en Azure Blob Storage.

Origen de datos de entrenamiento definido por un contenedor de blobs de Azure.

Contenido de Azure Blob Storage.

Opciones para la operación de compilación del clasificador de documentos.

Opciones para la operación de compilación del modelo.

Opciones para la operación de redacción del modelo.

Opciones para la operación del modelo de copia.

Polígono delimitador en una página específica de la entrada.

Información del tipo de documento clasificador.

Opciones para la operación de clasificación de documentos.

Opciones comunes a todas las operaciones que definen nuevos modelos, como beginBuildDocumentModel, beginComposeDocumentModely getCopyAuthorization.

Autorización para copiar un modelo de documento en el recurso de destino y modelId especificados.

Opciones para la operación de creación de modelos.

Valor del campo moneda.

Detalles relacionados con los modelos de documentos personalizados.

Opciones para la eliminación de modelos.

Campo de documento que describe una dirección física estructurada.

Opciones configurables para DocumentAnalysisClient.

El estado de una operación de análisis, que finalmente generará el tipo de resultado que corresponde al modelo.

Un elemento de anotación visual en el documento, como una marca de verificación o una cruz.

DocumentField que consta de una matriz de campos anidados. Todos los campos de la matriz tendrán el mismo tipo.

Código de barras extraído.

DocumentField que tiene un valor booleano.

Objeto que representa la ubicación y el contenido de un título de tabla.

Obtiene el objeto de respuesta Operation.

Información del clasificador de documentos.

Conjunto de orígenes usados para crear un clasificador de documentos. Se trata de una asignación de nombres de tipo de documento a orígenes que se usarán para entrenar el modelo para clasificar documentos del tipo de origen correspondiente.

Estado de una operación de creación de modelos.

DocumentField que tiene un valor que indica un país o región, representado como una cadena.

DocumentField que describe una cantidad de una moneda determinada.

DocumentField que tiene un valor Date.

Campos que son comunes a todas las variantes de DocumentField.

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

Objeto que representa la ubicación y el contenido de una nota al pie de tabla.

Fórmula extraída.

DocumentField que tiene un valor entero.

Objeto que representa la clave de campo o el valor de un par clave-valor.

Objeto que representa un campo de formulario con una etiqueta de campo (clave) y un valor de campo distintos (puede estar vacío).

Objeto que representa el idioma detectado para un intervalo de texto determinado.

Objeto de línea de contenido que consta de una secuencia adyacente de elementos de contenido, como palabras y marcas de selección.

Especificación de modelo conocida que admite la extracción de documentos estructurados.

Consulte el método beginAnalyzeDocument de documentAnalysisClient, que admite el consumo de estos objetos DocumentModel en lugar de cadenas de identificador de modelo para proporcionar tipos de resultados más seguros.

Opciones configurables para DocumentModelAdministrationClient.

Obtiene el objeto de respuesta Operation.

Obtiene el objeto de respuesta Operation.

Obtiene el objeto de respuesta Operation.

Información del modelo de documento.

Estado de una operación de creación de modelos.

Resumen del modelo de documento.

DocumentField que tiene un valor numérico.

DocumentField que consta de varias propiedades con nombre que tienen sus propios valores documentField.

Elementos de contenido y diseño extraídos de una página de la entrada.

Un objeto de párrafo que consta de líneas contiguas generalmente con alineación y espaciado comunes.

DocumentField que tiene un valor de número de teléfono, representado como una cadena.

Objeto de marca de selección que representa casillas, botones de radio y otros elementos que indican una selección.

DocumentField que tiene un valor que indica un estado de marca de selección (por ejemplo, una casilla o un botón de radio), representado como una cadena.

DocumentField que indica el estado de una firma, representada como una cadena.

Región contigua de la propiedad de contenido concatenada, especificada como desplazamiento y longitud.

DocumentField que tiene un valor de cadena.

Objeto que representa estilos de texto observados.

Objeto table que consta de celdas de tabla organizadas en un diseño rectangular.

Objeto que representa la ubicación y el contenido de una celda de tabla.

DocumentField que tiene un valor de hora, representado como una cadena.

Información de tipo de documento.

Campo simple que tiene un valor primitivo, como una cadena, un número, etc.

Objeto de palabra que consta de una secuencia contigua de caracteres. Para idiomas no delimitados por espacios, como chino, japonés y coreano, cada carácter se representa como su propia palabra.

Información de error.

Opciones para el método de autorización get copy.

Opciones para recuperar información del modelo.

Opciones para recuperar un estado de operación.

Opciones para recuperar información de recursos de Form Recognizer.

Los elementos de documento simples, como palabras, marcas de selección y líneas, están limitados por el polígono.

Error detallado.

Opciones para enumerar modelos.

Opciones para enumerar las operaciones.

Conjunto de campos comunes a todas las operaciones de administración.

Obtiene el objeto de respuesta Operation.

Información de la operación.

Representa un punto usado para definir polígonos delimitador. La unidad es "píxel" o "pulgada" (vea LengthUnit).

Opciones para operaciones de larga duración (sondeos) en los clientes de Form Recognizer.

Cuota usada, límite y siguiente restablecimiento de fecha y hora.

Información general sobre el recurso actual.

Una operación de larga duración (sondeo) que realiza un seguimiento del estado de una operación de análisis, generando finalmente el tipo de resultado que corresponde al modelo.

Define valores para AnalyzeResultOperationStatus.

Define valores para DocumentBarcodeKind.
KnownDocumentBarcodeKind se puede usar indistintamente con DocumentBarcodeKind, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

QRCode: código QR, tal como se define en ISO/IEC 18004:2015.
PDF417: PDF417, tal como se define en ISO 15438.
UPCA: Código de producto universal de 12 dígitos GS1.
UPCE: Código de producto universal de 6 dígitos GS1.
Code39: código de barras 39, tal como se define en ISO/IEC 16388:2007.
Código 128: código de barras 128, tal como se define en ISO/IEC 15417:2007.
EAN8: número de artículo internacional de 8 dígitos del GS1 (número de artículo europeo).
EAN13: número de artículo internacional de 13 dígitos del GS1 (número de artículo europeo).
DataBar: código de barras de barra de datos GS1.
Code93: código de barras 93, tal como se define en ANSI/AIM BC5-1995.
codabar: código de barras codabar, tal como se define en ANSI/AIM BC3-1995.
DataBarExpanded: código de barras expandido de barra de datos GS1.
ITF: Intercalado 2 de 5 códigos de barras, tal como se define en ANSI/AIM BC2-1995.
MicroQRCode: código QR micro, tal como se define en ISO/IEC 23941:2022.
de los orígenes: código primitivo, tal como se define en ISO/IEC 24778:2008.
DataMatrix: código de matriz de datos, tal como se define en ISO/IEC 16022:2006.
MaxiCode: MaxiCode, tal como se define en ISO/IEC 16023:2000.

Define valores para DocumentBuildMode.
KnownDocumentBuildMode se puede usar indistintamente con DocumentBuildMode, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

plantilla: documentos de destino con plantillas visuales similares.
neuronal: compatibilidad con documentos con diversas plantillas visuales.

Una operación de larga duración (sondeo) que realiza un seguimiento del estado de una operación de creación de clasificador personalizada, lo que finalmente genera un DocumentClassifierDetails.

Origen de contenido que se puede usar para crear un clasificador de documentos.

Uno de:

• BlobSource
• BlobFileListSource

Campo extraído. La propiedad kind identifica (discrimina) el tipo del DocumentField.

Define valores para DocumentFieldType.
KnownDocumentFieldType se puede usar indistintamente con DocumentFieldType, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

cadena: texto sin formato.
fecha: fecha, normalizada con el formato ISO 8601 (AAAA-MM-DD).
hora: hora, normalizada a formato ISO 8601 (hh:mm:ss).
phoneNumber: número de teléfono, normalizado a formato E.164 (+{CountryCode}{SubscriberNumber}).
número: número de punto flotante, normalizado a punto flotante de precisión doble.
entero: número entero, normalizado a entero de 64 bits con signo.
selecciónMark: ¿Está seleccionado el campo?
paísRegión: país o región, normalizado a formato alfa-3166-1 ISO (por ejemplo, EE. UU.).
firma: ¿Está presente la firma?
matriz: lista de subcampos del mismo tipo.
objeto: lista con nombre de subcampos de tipos potencialmente diferentes.
moneda: importe de moneda con símbolo de moneda opcional y unidad.
dirección: dirección analizada.
booleano: valor booleano, normalizado en true o false.

Define valores para DocumentFormulaKind.
KnownDocumentFormulaKind se puede usar indistintamente con DocumentFormulaKind, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

en línea: una fórmula insertada dentro del contenido de un párrafo.
mostrar: una fórmula en modo de visualización que ocupa toda una línea.

Modos de compilación de modelos admitidos. El modo de compilación del modelo selecciona el motor que usa el servicio para entrenar el modelo en función de los datos de entrenamiento etiquetados.

Las opciones son:

• "neuronal", que produce la máxima calidad del modelo que es capaz de extraer datos de clases de documentos que tienen la misma estructura de datos, pero diseños diferentes (por ejemplo, formularios fiscales W2, que pueden variar de la empresa a la empresa, pero siempre contienen la misma información).
• "template", que requiere que todos los documentos tengan el mismo diseño fijo (plantilla).

Consulte el siguiente vínculo para obtener más información: https://aka.ms/azsdk/formrecognizer/buildmode

Una operación de larga duración (sondeo) que realiza un seguimiento del estado de una operación de creación de modelos, produciendo finalmente un DocumentModelDetails.

Origen de contenido que se puede usar para crear un modelo de documento.

Uno de:

• BlobSource
• BlobFileListSource

Define valores para DocumentSignatureType.
KnownDocumentSignatureType se puede usar indistintamente con DocumentSignatureType, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

firmado: se detecta una firma.
sin firmar: no se detecta ninguna firma.

Define valores para DocumentTableCellKind.
KnownDocumentTableCellKind se puede usar indistintamente con DocumentTableCellKind, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

contenido: contiene el contenido o los datos principales.
rowHeader: describe el contenido de la fila.
columnHeader: describe el contenido de la columna.
stubHead: describe los encabezados de fila, normalmente ubicados en la esquina superior izquierda de una tabla.
descripción: describe el contenido de (partes de) la tabla.

Define valores para FontStyle.
KnownFontStyle se puede usar indistintamente con FontStyle, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

normal: los caracteres se representan normalmente.
cursiva: los caracteres se inclinan visualmente hacia la derecha.

Define valores para FontWeight.
KnownFontWeight se puede usar indistintamente con FontWeight, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

normal: los caracteres se representan normalmente.
negrita: los caracteres se representan con trazos más gruesos.

Funcionalidades de complemento (características) que se pueden habilitar para la solicitud.

Para obtener más información sobre las características disponibles en Form Recognizer, consulte la documentación del servicio:

https://aka.ms/azsdk/formrecognizer/features

Entrada de solicitud que se puede cargar como datos binarios en el servicio Form Recognizer. Form Recognizer trata string entradas como direcciones URL, por lo que enviar una cadena como una entrada de binaria, convierta primero la cadena en uno de los siguientes tipos de entrada.

Define los valores de LengthUnit.
KnownLengthUnit se puede usar indistintamente con LengthUnit, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

píxeles: unidad de longitud para los archivos de imagen.
pulgada: unidad de longitud para archivos PDF.

Detalles sobre cualquiera de los distintos tipos de operaciones de administración de Form Recognizer.

Define valores para OperationKind.
KnownOperationKind se puede usar indistintamente con OperationKind, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

documentModelBuild: cree un nuevo modelo de documento personalizado.
documentModelCompose: cree un nuevo modelo de documento personalizado a partir de modelos existentes.
documentModelCopyTo: copie un modelo de documento existente en un recurso, región o suscripción diferente.
documentClassifierBuild: cree un nuevo modelo de clasificador personalizado.

Define valores para OperationStatus.

Define valores para ParagraphRole.
knownParagraphRole se puede usar indistintamente con ParagraphRole, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

pageHeader: texto situado cerca del borde superior de la página.
pageFooter: texto cerca del borde inferior de la página.
pageNumber: número de página.
título: título de nivel superior que describe todo el documento.
secciónHeading: sub encabezado que describe una sección del documento.
nota al pie: una nota que normalmente se coloca después del contenido principal de una página.
formulaBlock: un bloque de fórmulas, a menudo con alineación compartida.

Define valores para SelectionMarkState.
KnownSelectionMarkState se puede usar indistintamente con SelectionMarkState, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

seleccionado: la marca de selección está seleccionada, a menudo indicada por una marca check ✓ o cross X dentro de la marca de selección.
no seleccionado: no se selecciona la marca de selección.

Tipos de índice de cadena válidos admitidos por el servicio Form Recognizer y los clientes del SDK.

Valores conocidos de DocumentBarcodeKind que acepta el servicio.

Valores conocidos de DocumentBuildMode que acepta el servicio.

Los valores conocidos de DocumentFieldType que acepta el servicio.

Valores conocidos de documentFormulaKind que acepta el servicio.

Valores conocidos de DocumentSignatureType que acepta el servicio.

Valores conocidos de DocumentTableCellKind que acepta el servicio.

Valores conocidos de FontStyle que acepta el servicio.

Valores conocidos de FontWeight que acepta el servicio.

Define las audiencias en la nube conocidas para Form Recognizer.

Para autenticarse con Entra Id (mediante un TokenCredential) en un entorno de Sovereign Cloud , proporcione el valor adecuado a continuación como opción audience al crear un DocumentAnalysisClient archivo o DocumentModelAdministrationClient.

El valor predeterminado es adecuado para los recursos de Form Recognizer creados en la nube pública de Azure, por lo que este valor solo es necesario para usar Form Recognizer en un entorno de nube diferente.

Valores conocidos de LengthUnit que acepta el servicio.

Valores conocidos de OperationKind que acepta el servicio.

Valores conocidos de ParagraphRole que acepta el servicio.

Valores conocidos de SelectionMarkState que acepta el servicio.