@azure/ai-form-recognizer package

Clases

AzureKeyCredential	Una credencial basada en clave estática que admite la actualización del valor de clave subyacente.
DocumentAnalysisClient	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 { DocumentAnalysisClient } from "@azure/ai-form-recognizer"; import { DefaultAzureCredential } from "@azure/identity"; const endpoint = "https://<resource name>.cognitiveservices.azure.com"; const credential = new DefaultAzureCredential(); const client = new DocumentAnalysisClient(endpoint, credential); Clave de API (clave de suscripción) import { DocumentAnalysisClient, AzureKeyCredential } from "@azure/ai-form-recognizer"; const endpoint = "https://<resource name>.cognitiveservices.azure.com"; const credential = new AzureKeyCredential("<api key>"); const client = new DocumentAnalysisClient(endpoint, credential);
DocumentModelAdministrationClient	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 { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer"; import { DefaultAzureCredential } from "@azure/identity"; const endpoint = "https://<resource name>.cognitiveservices.azure.com"; const credential = new DefaultAzureCredential(); const client = new DocumentModelAdministrationClient(endpoint, credential); Clave de API (clave de suscripción) import { DocumentModelAdministrationClient, AzureKeyCredential } from "@azure/ai-form-recognizer"; const endpoint = "https://<resource name>.cognitiveservices.azure.com"; const credential = new AzureKeyCredential("<api key>"); const client = new DocumentModelAdministrationClient(endpoint, credential);

Interfaces

AddressValue	Valor de campo de dirección.
AnalyzeDocumentOptions	Opciones para la operación de análisis de documentos.
AnalyzeResult	Resultado de una operación de análisis. El tipo del documento puede determinarse por el modelo utilizado para realizar el análisis.
AnalyzeResultCommon	Los campos comunes de todos los tipos similares a AnalyzeResult, como LayoutResult, ReadResult y GeneralDocumentResult.
AnalyzedDocument	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.
AzureBlobFileListSource	Un origen de datos de entrenamiento definido por un contenedor de blobs de Azure y una lista de archivos JSONL dentro del contenedor.
AzureBlobFileListSourceDetails	Lista de archivos en Azure Blob Storage.
AzureBlobSource	Un origen de datos de entrenamiento definido por un contenedor de blobs de Azure.
AzureBlobSourceDetails	Azure Blob Storage contenido.
BeginBuildDocumentClassifierOptions	Opciones para la operación de compilación del clasificador de documentos.
BeginBuildDocumentModelOptions	Opciones para la operación de compilación del modelo.
BeginComposeDocumentModelOptions	Opciones para la operación de redacción del modelo.
BeginCopyModelOptions	Opciones para la operación de copia del modelo.
BoundingRegion	Polígono delimitador en una página específica de la entrada.
ClassifierDocumentTypeDetails	Información del tipo de documento clasificador.
ClassifyDocumentOptions	Opciones para la operación de clasificación de documentos.
CommonModelCreationOptions	Opciones comunes a todas las operaciones que definen nuevos modelos, como beginBuildDocumentModel, beginComposeDocumentModely getCopyAuthorization.
CopyAuthorization	Autorización para copiar un modelo de documento en el recurso de destino y modelId especificados.
CreateDocumentModelOptions	Opciones para la operación de creación de modelos.
CurrencyValue	Valor del campo moneda.
CustomDocumentModelsDetails	Detalles relacionados con los modelos de documentos personalizados.
DeleteDocumentModelOptions	Opciones para la eliminación del modelo.
DocumentAddressField	Campo de documento que describe una dirección física estructurada.
DocumentAnalysisClientOptions	Opciones configurables para DocumentAnalysisClient.
DocumentAnalysisPollOperationState	Estado de una operación de análisis, que finalmente generará el tipo de resultado que corresponde al modelo.
DocumentAnnotation	Un elemento de anotación visual en el documento, como una marca de verificación o una cruz.
DocumentArrayField	Un DocumentField que consta de una matriz de campos anidados. Todos los campos de la matriz tendrán el mismo tipo.
DocumentBarcode	Código de barras extraído.
DocumentBooleanField	Un documentField que tiene un valor booleano.
DocumentCaption	Objeto que representa la ubicación y el contenido de una tabla subtítulo.
DocumentClassifierBuildOperationDetails	Obtiene el objeto de respuesta Operation.
DocumentClassifierDetails	Información del clasificador de documentos.
DocumentClassifierDocumentTypeSources	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.
DocumentClassifierOperationState	Estado de una operación de creación de modelos.
DocumentCountryRegionField	Un DocumentField que tiene un valor que indica un país o región, representado como una cadena.
DocumentCurrencyField	DocumentField que describe una cantidad de una moneda determinada.
DocumentDateField	Un DocumentField que tiene un valor Date.
DocumentFieldCommon	Campos que son comunes a todas las variantes de DocumentField.
DocumentFieldSchema	Descripción del esquema semántico de campo mediante una sintaxis de estilo de esquema JSON.
DocumentFootnote	Objeto que representa la ubicación y el contenido de una nota al pie de una tabla.
DocumentFormula	Fórmula extraída.
DocumentIntegerField	Un DocumentField que tiene un valor entero.
DocumentKeyValueElement	Objeto que representa la clave de campo o el valor en un par clave-valor.
DocumentKeyValuePair	Objeto que representa un campo de formulario con una etiqueta de campo (clave) y un valor de campo distintos (puede estar vacío).
DocumentLanguage	Objeto que representa el idioma detectado para un intervalo de texto determinado.
DocumentLine	Objeto de línea de contenido que consta de una secuencia adyacente de elementos de contenido, como palabras y marcas de selección.
DocumentModel	Especificación de modelo conocida que admite la extracción de documentos estructurados. Vea el beginAnalyzeDocument método de DocumentAnalysisClient, que admite el consumo de estos DocumentModel objetos en lugar de cadenas de identificador de modelo para proporcionar tipos de resultado más seguros.
DocumentModelAdministrationClientOptions	Opciones configurables para DocumentModelAdministrationClient.
DocumentModelBuildOperationDetails	Obtiene el objeto de respuesta Operation.
DocumentModelComposeOperationDetails	Obtiene el objeto de respuesta Operation.
DocumentModelCopyToOperationDetails	Obtiene el objeto de respuesta Operation.
DocumentModelDetails	Información del modelo de documento.
DocumentModelOperationState	Estado de una operación de creación de modelos.
DocumentModelSummary	Resumen del modelo de documento.
DocumentNumberField	Un DocumentField que tiene un valor numérico.
DocumentObjectField	Un DocumentField que consta de varias propiedades con nombre que tienen sus propios valores de DocumentField.
DocumentPage	Elementos de contenido y diseño extraídos de una página de la entrada.
DocumentParagraph	Un objeto de párrafo que consta de líneas contiguas generalmente con alineación y espaciado comunes.
DocumentPhoneNumberField	Un DocumentField que tiene un valor de número de teléfono, representado como una cadena.
DocumentSelectionMark	Objeto de marca de selección que representa casillas, botones de radio y otros elementos que indican una selección.
DocumentSelectionMarkField	Un 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.
DocumentSignatureField	Un DocumentField que indica el estado de una firma, representado como una cadena.
DocumentSpan	Región contigua de la propiedad de contenido concatenada, especificada como desplazamiento y longitud.
DocumentStringField	Un DocumentField que tiene un valor de cadena.
DocumentStyle	Objeto que representa estilos de texto observados.
DocumentTable	Objeto de tabla que consta de celdas de tabla organizadas en un diseño rectangular.
DocumentTableCell	Objeto que representa la ubicación y el contenido de una celda de tabla.
DocumentTimeField	Un documentField que tiene un valor de hora, representado como una cadena.
DocumentTypeDetails	Información de tipo de documento.
DocumentValueField	Un campo simple que tiene un valor primitivo, como una cadena, un número, etc.
DocumentWord	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.
ErrorModel	Información de error.
GetCopyAuthorizationOptions	Opciones para el método de autorización get copy.
GetModelOptions	Opciones para recuperar información del modelo.
GetOperationOptions	Opciones para recuperar un estado de operación.
GetResourceDetailsOptions	Opciones para recuperar Form Recognizer información de recursos.
HasBoundingPolygon	Los elementos de documento simples, como palabras, marcas de selección y líneas, están limitados por el polígono.
InnerError	Error detallado.
ListModelsOptions	Opciones para enumerar modelos.
ListOperationsOptions	Opciones para enumerar las operaciones.
ModelAdministrationOperationStateCommon	Conjunto de campos comunes a todas las operaciones de administración.
OperationDetails	Obtiene el objeto de respuesta Operation.
OperationSummary	Información de la operación.
Point2D	Representa un punto utilizado para definir polígonos delimitador. La unidad es "píxel" o "pulgada" (vea LengthUnit).
PollerOptions	Opciones de operaciones de larga duración (sondeos) en los clientes de Form Recognizer.
QuotaDetails	Cuota usada, límite y siguiente restablecimiento de fecha y hora.
ResourceDetails	Información general sobre el recurso actual.

Alias de tipos

AnalysisPoller	Una operación de larga duración (poller) que realiza un seguimiento del estado de una operación de análisis y, finalmente, produce el tipo de resultado que corresponde al modelo.
AnalyzeResultOperationStatus	Define valores para AnalyzeResultOperationStatus.
DocumentBarcodeKind	Define los valores de 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 y 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. Código39: código de barras 39, tal y como se define en ISO/IEC 16388:2007. Código 128: código de barras 128, tal y 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 la barra de datos GS1. Code93: Código de barras 93, tal y 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 la barra de datos GS1. ITF: Intercalado 2 de 5 códigos de barras, tal y como se define en ANSI/AIM BC2-1995. MicroQRCode: código QR micro, tal como se define en ISO/IEC 23941:2022. Directorio: código descentralizado, tal y 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 y como se define en ISO/IEC 16023:2000.
DocumentBuildMode	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 template: documentos de destino con plantillas visuales similares. neural: admite documentos con diversas plantillas visuales.
DocumentClassifierPoller	Una operación de larga duración (poller) que realiza un seguimiento del estado de una operación de creación de clasificador personalizada, lo que finalmente genera documentClassifierDetails.
DocumentClassifierSource	Origen de contenido que se puede usar para crear un clasificador de documentos. Uno de los valores siguientes: BlobSource BlobFileListSource
DocumentField	Campo extraído. La kind propiedad identifica (discrimina) el tipo de DocumentField.
DocumentFieldType	Define los valores de 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 string: texto sin formato. date: fecha, normalizada con formato ISO 8601 (AAAA-MM-DD). time: tiempo, normalizado al formato ISO 8601 (hh:mm:ss). phoneNumber: número de teléfono, normalizado a formato E.164 (+{CountryCode}{SubscriberNumber}). number: número de punto flotante, normalizado a punto flotante de precisión doble. entero: número entero, normalizado en entero de 64 bits con signo. selectionMark: ¿Está seleccionado el campo? countryRegion: país o región, normalizado a formato alfa-3166-1 ISO (por ejemplo, EE. UU.). signature: ¿Está presente la firma? array: lista de subcampos del mismo tipo. object: lista con nombre de subcampos de tipos potencialmente diferentes. currency: importe de moneda con símbolo de moneda opcional y unidad. address: dirección analizada. booleano: valor booleano, normalizado en true o false.
DocumentFormulaKind	Define los valores de 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 inline: fórmula insertada dentro del contenido de un párrafo. display: fórmula en modo de visualización que ocupa una línea completa.
DocumentModelBuildMode	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 una empresa a otra, 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
DocumentModelPoller	Una operación de larga duración (poller) que realiza un seguimiento del estado de una operación de creación de modelos, lo que finalmente genera documentModelDetails.
DocumentModelSource	Origen de contenido que se puede usar para crear un modelo de documento. Uno de los valores siguientes: BlobSource BlobFileListSource
DocumentSignatureType	Define los valores de 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 signed: se detecta una firma. unsigned: no se detectan firmas.
DocumentTableCellKind	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 content: 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. description: describe el contenido de (partes de) de la tabla.
FontStyle	Define los valores de 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.
FontWeight	Define los valores de 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.
FormRecognizerFeature	Funcionalidades de complementos (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
FormRecognizerRequestBody	Entrada de solicitud que se puede cargar como datos binarios en el servicio Form Recognizer. Form Recognizer trata las string entradas como direcciones URL, por lo que para enviar una cadena como entrada binaria, primero convierta la cadena en uno de los siguientes tipos de entrada.
LengthUnit	Define valores para 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 pixel: unidad de longitud para los archivos de imagen. pulgada: unidad de longitud para archivos PDF.
OperationDetailsUnion	Detalles sobre cualquiera de los distintos tipos de operaciones de administración de Form Recognizer.
OperationKind	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.
OperationStatus	Define valores para OperationStatus.
ParagraphRole	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 situado cerca del borde inferior de la página. pageNumber: número de página. title: título de nivel superior que describe todo el documento. sectionHeading: 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.
SelectionMarkState	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 selected: 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: la marca de selección no está seleccionada.
StringIndexType	Tipos de índice de cadena válidos admitidos por el servicio Form Recognizer y los clientes del SDK.

Enumeraciones

KnownDocumentBarcodeKind	Valores conocidos de DocumentBarcodeKind que acepta el servicio.
KnownDocumentBuildMode	Valores conocidos de DocumentBuildMode que acepta el servicio.
KnownDocumentFieldType	Valores conocidos de DocumentFieldType que acepta el servicio.
KnownDocumentFormulaKind	Valores conocidos de DocumentFormulaKind que acepta el servicio.
KnownDocumentSignatureType	Valores conocidos de DocumentSignatureType que acepta el servicio.
KnownDocumentTableCellKind	Valores conocidos de DocumentTableCellKind que acepta el servicio.
KnownFontStyle	Valores conocidos de FontStyle que acepta el servicio.
KnownFontWeight	Valores conocidos de FontWeight que acepta el servicio.
KnownLengthUnit	Valores conocidos de LengthUnit que acepta el servicio.
KnownOperationKind	Valores conocidos de OperationKind que acepta el servicio.
KnownParagraphRole	Valores conocidos de ParagraphRole que acepta el servicio.
KnownSelectionMarkState	Valores conocidos de SelectionMarkState que acepta el servicio.