formrecognizer Paquete

Paquetes

aio

Clases

AccountProperties	Resumen de todos los modelos personalizados de la cuenta. Novedad de la versión 2.1: Compatibilidad con métodos de to_dict y from_dict
AddressValue	Valor de campo de dirección. Novedad en la versión 2023-07-31: Las propiedades unitarias, city_district, state_district, residencial, casa y nivel .
AnalyzeResult	Resultado del análisis de documentos.
AnalyzedDocument	Objeto que describe la ubicación y el contenido semántico de un documento.
BlobFileListSource	Origen de contenido de una lista de archivos en Azure Blob Storage.
BlobSource	Origen de contenido para Azure Blob Storage.
BoundingRegion	Región delimitador correspondiente a una página.
ClassifierDocumentTypeDetails	Origen de datos de entrenamiento.
CurrencyValue	Elemento de valor de moneda. Novedad de la versión 2023-07-31: la propiedad code .
CustomDocumentModelsDetails	Detalles sobre los modelos personalizados en el recurso Form Recognizer.
CustomFormModel	Representa un modelo entrenado. Novedad de la versión v2.1: las propiedades model_name y propiedades, compatibilidad con métodos de to_dict y from_dict
CustomFormModelField	Campo que el modelo extraerá de los formularios que analiza. Novedad de la versión 2.1: Compatibilidad con métodos de to_dict y from_dict
CustomFormModelInfo	Información del modelo personalizado. Novedad de la versión v2.1: las propiedades model_name y propiedades, compatibilidad con métodos de to_dict y from_dict
CustomFormModelProperties	Propiedades de modelo opcionales. Novedad de la versión 2.1: Compatibilidad con métodos de to_dict y from_dict
CustomFormSubmodel	Representa un submodelo que extrae campos de un tipo específico de formulario. Novedad de la versión v2.1: la propiedad model_id, compatibilidad con métodos de to_dict y from_dict
DocumentAnalysisClient	DocumentAnalysisClient analiza la información de documentos e imágenes y clasifica los documentos. Es la interfaz que se usa para analizar con modelos precompilados (recibos, tarjetas de presentación, facturas, documentos de identidad, entre otros), análisis del diseño de documentos, análisis de tipos de documentos generales y análisis de documentos personalizados con modelos compilados (para ver una lista completa de los modelos admitidos por el servicio, consulte: https://aka.ms/azsdk/formrecognizer/models). Proporciona diferentes métodos basados en entradas de una dirección URL y entradas de una secuencia. Nota: DocumentAnalysisClient debe usarse con versiones de API 2022-08-31 y versiones posteriores. Para usar versiones <de API =v2.1, cree una instancia de FormRecognizerClient. Novedad de la versión 2022-08-31: DocumentAnalysisClient y sus métodos de cliente.
DocumentAnalysisError	DocumentAnalysisError contiene los detalles del error devuelto por el servicio.
DocumentAnalysisInnerError	Detalles del error interno del documentAnalysisError.
DocumentBarcode	Objeto de código de barras.
DocumentClassifierDetails	Información del clasificador de documentos. Incluye los tipos de documento que el modelo puede clasificar.
DocumentField	Objeto que representa el contenido y la ubicación de un valor de campo de documento. Novedad de la versión 2023-07-31: valor booleano value_type y bool
DocumentFormula	Objeto de fórmula.
DocumentKeyValueElement	Objeto que representa la clave de campo o el valor de un par clave-valor.
DocumentKeyValuePair	Objeto que representa un campo de documento 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 representa el contenido encontrado en una sola línea del documento.
DocumentModelAdministrationClient	DocumentModelAdministrationClient es la interfaz Form Recognizer que se va a usar para compilar y administrar modelos. Proporciona métodos para crear modelos y clasificadores, así como métodos para ver y eliminar modelos y clasificadores, ver operaciones de modelo y clasificador, acceder a la información de la cuenta, copiar modelos a otro recurso Form Recognizer y crear un nuevo modelo a partir de una colección de modelos existentes. Nota DocumentModelAdministrationClient debe usarse con versiones de API 2022-08-31 y versiones posteriores. Para usar versiones <de API =v2.1, cree una instancia de FormTrainingClient. Novedad de la versión 2022-08-31: DocumentModelAdministrationClient y sus métodos de cliente.
DocumentModelAdministrationLROPoller	Implementa un protocolo seguido de objetos de sondeo devueltos.
DocumentModelDetails	Información del modelo de documento. Incluye los tipos de documento que el modelo puede analizar. Novedad de la versión 2023-07-31: la propiedad expires_on .
DocumentModelSummary	Resumen de la información del modelo de documento, incluido el identificador del modelo, su descripción y cuándo se creó el modelo. Novedad de la versión 2023-07-31: la propiedad expires_on .
DocumentPage	Contenido y elementos de diseño extraídos de una página de la entrada. Novedad de la versión 2023-07-31: Las propiedades de códigos de barras y fórmulas .
DocumentParagraph	Un objeto de párrafo generalmente consta de líneas contiguas con alineación y espaciado comunes. Novedad de la versión 2023-07-31: el rol formulaBlock .
DocumentSelectionMark	Objeto de marca de selección que representa casillas de verificación, botones de radio y otros elementos que indican una selección.
DocumentSpan	Región contigua del contenido de la propiedad, especificada como desplazamiento y longitud.
DocumentStyle	Objeto que representa estilos de texto observados. Novedad de la versión 2023-07-31: las propiedades similar_font_family, font_style, font_weight, color y background_color .
DocumentTable	Objeto table 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.
DocumentTypeDetails	DocumentTypeDetails representa un tipo de documento que un modelo puede reconocer, incluidos sus campos y tipos, y la confianza de esos campos.
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.
FieldData	Contiene los datos del campo de formulario. Esto incluye el texto, la ubicación del texto en el formulario y una colección de los elementos que componen el texto. Novedad de la versión v2.1: FormSelectionMark se agrega a los tipos devueltos en la lista de field_elements, compatibilidad con métodos de to_dict y from_dict
FormElement	Tipo base que incluye propiedades para un elemento de formulario. Novedad de la versión 2.1: Compatibilidad con métodos de to_dict y from_dict
FormField	Representa un campo reconocido en un formulario de entrada. Novedad de la versión 2.1: Compatibilidad con métodos de to_dict y from_dict
FormLine	Objeto que representa una línea de texto extraída. Novedad de la versión v2.1: propiedad appearance, compatibilidad con métodos de to_dict y from_dict
FormPage	Representa una página reconocida en el documento de entrada. Contiene líneas, palabras, marcas de selección, tablas y metadatos de página. Novedad de la versión 2.1: selection_marks propiedad, compatibilidad con métodos de to_dict y from_dict
FormPageRange	Intervalo de páginas basado en 1 del formulario. Novedad de la versión 2.1: Compatibilidad con métodos de to_dict y from_dict
FormRecognizerClient	FormRecognizerClient extrae información de formularios e imágenes en datos estructurados. Es la interfaz que se usa para analizar con modelos creados previamente (recibos, tarjetas de presentación, facturas, documentos de identidad), reconocimiento del contenido o diseño de formularios y análisis de formularios personalizados a partir de modelos entrenados. Proporciona diferentes métodos basados en entradas de una dirección URL y entradas de una secuencia. Nota FormRecognizerClient debe usarse con versiones <de API =v2.1. Para usar las versiones de API 2022-08-31 y versiones posteriores, cree una instancia de DocumentAnalysisClient.
FormRecognizerError	Representa un error que se produjo durante el entrenamiento. Novedad de la versión 2.1: Compatibilidad con métodos de to_dict y from_dict
FormSelectionMark	Información sobre la marca de selección extraída. Novedad de la versión v2.1: compatibilidad con métodos de to_dict y from_dict
FormTable	Información sobre la tabla extraída contenida en una página. Novedad de la versión v2.1: la propiedad bounding_box, compatibilidad con métodos de to_dict y from_dict
FormTableCell	Representa una celda contenida en una tabla reconocida desde el documento de entrada. Novedad de la versión v2.1: FormSelectionMark se agrega a los tipos devueltos en la lista de field_elements, compatibilidad con métodos de to_dict y from_dict
FormTrainingClient	FormTrainingClient es la interfaz de Form Recognizer que se va a usar para crear y administrar modelos personalizados. Proporciona métodos para entrenar modelos en los formularios que se proporcionan, así como métodos para ver y eliminar modelos, acceder a propiedades de cuenta, copiar modelos a otro recurso Form Recognizer y crear modelos a partir de una colección de modelos existentes entrenados con etiquetas. Nota: FormTrainingClient debe usarse con versiones <de API =v2.1. Para usar las versiones de API 2022-08-31 y versiones posteriores, cree una instancia de DocumentModelAdministrationClient.
FormWord	Representa una palabra reconocida del documento de entrada. Novedad de la versión v2.1: compatibilidad con métodos de to_dict y from_dict
OperationDetails	OperationDetails consta de información sobre la operación del modelo, incluido el resultado o el error de la operación si se ha completado. Tenga en cuenta que la información de operación solo se conserva durante 24 horas. Si la operación se realizó correctamente, también se puede acceder al modelo mediante las <xref:azure.ai.formrecognizer.get_document_model>API , <xref:azure.ai.formrecognizer.list_document_models>, <xref:azure.ai.formrecognizer.get_document_classifier>y <xref:azure.ai.formrecognizer.list_document_classifiers> . Novedad de la versión 2023-07-31: el tipo documentClassifierBuild y el resultado documentClassifierDetails .
OperationSummary	Información de la operación del modelo, incluido el tipo y el estado de la operación, cuándo se creó, etc. Tenga en cuenta que la información de operación solo se conserva durante 24 horas. Si la operación se realizó correctamente, se puede acceder al modelo mediante las <xref:azure.ai.formrecognizer.get_document_model>API , <xref:azure.ai.formrecognizer.list_document_models>, <xref:azure.ai.formrecognizer.get_document_classifier>y <xref:azure.ai.formrecognizer.list_document_classifiers> . Para averiguar por qué se produjo un error en una operación, use <xref:azure.ai.formrecognizer.get_operation> y proporcione el operation_id. Novedad de la versión 2023-07-31: el tipo documentClassifierBuild .
Point	Coordenada x, y de un punto en un rectángulo delimitador o polígono. Novedad de la versión v2.1: compatibilidad con métodos de to_dict y from_dict
QuotaDetails	Cuota usada, límite y siguiente restablecimiento de fecha y hora.
RecognizedForm	Representa un formulario reconocido por un modelo entrenado o precompilado. La propiedad fields contiene los campos de formulario que se extrajeron del formulario. Las tablas, las líneas de texto o las palabras y las marcas de selección se extraen por página y se encuentran en la propiedad pages . Novedades de la versión v2.1: las propiedades form_type_confidence y model_id, compatibilidad con métodos de to_dict y from_dict
ResourceDetails	Detalles sobre el recurso de Form Recognizer. Novedad en la versión 2023-07-31: la propiedad neural_document_model_quota .
TextAppearance	Objeto que representa la apariencia de la línea de texto. Novedad de la versión v2.1: compatibilidad con métodos de to_dict y from_dict
TrainingDocumentInfo	Informe de un documento individual usado para entrenar un modelo personalizado. Novedad de la versión v2.1: la propiedad model_id, compatibilidad con métodos de to_dict y from_dict

Enumeraciones

AnalysisFeature	Características de análisis de documentos que se van a habilitar.
CustomFormModelStatus	Estado que indica la preparación del modelo para su uso.
DocumentAnalysisApiVersion	Form Recognizer versiones de API compatibles con DocumentAnalysisClient y DocumentModelAdministrationClient.
FieldValueType	Tipo de datos semántico del valor del campo. Novedad de la versión v2.1: los valores selectionMark y countryRegion
FormContentType	Tipo de contenido para la carga. Novedad de la versión v2.1: compatibilidad con image/bmp
FormRecognizerApiVersion	Form Recognizer versiones de API compatibles con FormRecognizerClient y FormTrainingClient.
LengthUnit	Unidad usada por las propiedades de cuadro de ancho, alto y límite. En el caso de las imágenes, la unidad es "píxel". Para PDF, la unidad es "pulgada".
ModelBuildMode	Modo que se usa al compilar modelos personalizados. Para más información, consulte https://aka.ms/azsdk/formrecognizer/buildmode.
TrainingStatus	Estado de la operación de entrenamiento.