Share via


formrecognizer Paquet

Paquets

aio

Classes

AccountProperties

Résumé de tous les modèles personnalisés sur le compte.

Nouveautés de la version v2.1 : prise en charge des méthodes to_dict et from_dict

AddressValue

Valeur de champ d’adresse.

Nouveautés de la version 2023-07-31 : propriétés unit, city_district, state_district, suburb, house et level .

AnalyzeResult

Résultat de l’analyse de document.

AnalyzedDocument

Objet décrivant l’emplacement et le contenu sémantique d’un document.

BlobFileListSource

Source de contenu pour une liste de fichiers dans Stockage Blob Azure.

BlobSource

Source de contenu pour Stockage Blob Azure.

BoundingRegion

Région englobante correspondant à une page.

ClassifierDocumentTypeDetails

Source de données d’apprentissage.

CurrencyValue

Élément de valeur monétaire.

Nouveautés de la version 2023-07-31 : propriété de code .

CustomDocumentModelsDetails

Détails concernant les modèles personnalisés sous la ressource Form Recognizer.

CustomFormModel

Représente un modèle entraîné.

Nouveautés de la version v2.1 : propriétés model_name et propriétés, prise en charge des méthodes to_dict et from_dict

CustomFormModelField

Champ que le modèle extrait des formulaires qu’il analyse.

Nouveautés de la version v2.1 : prise en charge des méthodes to_dict et from_dict

CustomFormModelInfo

Informations de modèle personnalisées.

Nouveautés de la version v2.1 : propriétés model_name et propriétés, prise en charge des méthodes to_dict et from_dict

CustomFormModelProperties

Propriétés de modèle facultatives.

Nouveautés de la version v2.1 : prise en charge des méthodes to_dict et from_dict

CustomFormSubmodel

Représente un sous-modèle qui extrait les champs d’un type de formulaire spécifique.

Nouveautés de la version v2.1 : propriété model_id, prise en charge des méthodes to_dict et from_dict

DocumentAnalysisClient

DocumentAnalysisClient analyse les informations des documents et des images, et classifie les documents. Il s’agit de l’interface à utiliser pour l’analyse avec des modèles prédéfinis (reçus, cartes de visite, factures, documents d’identité, entre autres), l’analyse de la mise en page des documents, l’analyse des types de documents généraux et l’analyse de documents personnalisés avec des modèles créés (pour voir la liste complète des modèles pris en charge par le service, voir : https://aka.ms/azsdk/formrecognizer/models). Il fournit différentes méthodes basées sur les entrées d’une URL et les entrées d’un flux.

Notes

DocumentAnalysisClient doit être utilisé avec les versions d’API

2022-08-31 et plus. Pour utiliser les versions <d’API =v2.1, instanciez un FormRecognizerClient.

Nouveauté de la version 2022-08-31 : DocumentAnalysisClient et ses méthodes clientes.

DocumentAnalysisError

DocumentAnalysisError contient les détails de l’erreur retournée par le service.

DocumentAnalysisInnerError

Détails de l’erreur interne pour DocumentAnalysisError.

DocumentBarcode

Objet de code-barres.

DocumentClassifierDetails

Informations sur le classifieur de documents. Inclut les types de documents que le modèle peut classifier.

DocumentField

Objet représentant le contenu et l’emplacement d’une valeur de champ de document.

Nouveautés de la version 2023-07-31 : valeur booléenne value_type et bool

DocumentFormula

Objet de formule.

DocumentKeyValueElement

Objet représentant la clé ou la valeur de champ dans une paire clé-valeur.

DocumentKeyValuePair

Objet représentant un champ de document avec une étiquette de champ distincte (clé) et une valeur de champ (peut être vide).

DocumentLanguage

Objet représentant la langue détectée pour une étendue de texte donnée.

DocumentLine

Objet de ligne de contenu représentant le contenu trouvé sur une seule ligne du document.

DocumentModelAdministrationClient

DocumentModelAdministrationClient est l’interface Form Recognizer à utiliser pour créer et gérer des modèles.

Il fournit des méthodes permettant de créer des modèles et des classifieurs, ainsi que des méthodes d’affichage et de suppression de modèles et classifieurs, d’affichage des opérations de modèle et de classifieur, d’accès aux informations de compte, de copie de modèles vers une autre ressource Form Recognizer et de composition d’un nouveau modèle à partir d’une collection de modèles existants.

Notes

DocumentModelAdministrationClient doit être utilisé avec les versions d’API

2022-08-31 et plus. Pour utiliser les versions <d’API =v2.1, instanciez un FormTrainingClient.

Nouveauté de la version 2022-08-31 : DocumentModelAdministrationClient et ses méthodes clientes.

DocumentModelAdministrationLROPoller

Implémente un protocole suivi d’objets d’interrogation retournés.

DocumentModelDetails

Informations sur le modèle de document. Inclut les types de documents que le modèle peut analyser.

Nouveauté de la version 2023-07-31 : propriété expires_on .

DocumentModelSummary

Résumé des informations sur le modèle de document, y compris l’ID du modèle, sa description et la date de création du modèle.

Nouveauté de la version 2023-07-31 : propriété expires_on .

DocumentPage

Éléments de contenu et de disposition extraits d’une page de l’entrée.

Nouveautés de la version 2023-07-31 : propriétés des codes-barres et des formules .

DocumentParagraph

Objet de paragraphe généralement constitué de lignes contiguës avec alignement et espacement communs.

Nouveautés de la version 2023-07-31 : le rôle formulaBlock .

DocumentSelectionMark

Objet de marque de sélection représentant case activée zones, cases d’option et autres éléments indiquant une sélection.

DocumentSpan

Zone contiguë du contenu de la propriété, spécifiée en tant que décalage et longueur.

DocumentStyle

Objet représentant les styles de texte observés.

Nouveautés de la version 2023-07-31 : propriétés similar_font_family, font_style, font_weight, color et background_color .

DocumentTable

Objet de tableau constitué de cellules de tableau disposées dans une disposition rectangulaire.

DocumentTableCell

Objet représentant l’emplacement et le contenu d’une cellule de tableau.

DocumentTypeDetails

DocumentTypeDetails représente un type de document qu’un modèle peut reconnaître, y compris ses champs et types, ainsi que la confiance pour ces champs.

DocumentWord

Objet word constitué d’une séquence contiguë de caractères. Pour les langues non délimitées par l’espace, telles que le chinois, le japonais et le coréen, chaque caractère est représenté comme son propre mot.

FieldData

Contient les données du champ de formulaire. Cela inclut le texte, l’emplacement du texte sur le formulaire et une collection d’éléments qui composent le texte.

Nouveauté de la version v2.1 : FormSelectionMark est ajouté aux types retournés dans la liste des field_elements, prise en charge des méthodes to_dict et from_dict

FormElement

Type de base qui inclut les propriétés d’un élément de formulaire.

Nouveautés de la version v2.1 : prise en charge des méthodes to_dict et from_dict

FormField

Représente un champ reconnu dans un formulaire d’entrée.

Nouveautés de la version v2.1 : prise en charge des méthodes to_dict et from_dict

FormLine

Objet représentant une ligne de texte extraite.

Nouveautés de la version v2.1 : propriété d’apparence, prise en charge des méthodes to_dict et from_dict

FormPage

Représente une page reconnue à partir du document d’entrée. Contient des lignes, des mots, des marques de sélection, des tableaux et des métadonnées de page.

Nouveautés de la version v2.1 : propriété selection_marks, prise en charge des méthodes to_dict et from_dict

FormPageRange

Plage de pages de base 1 du formulaire.

Nouveautés de la version v2.1 : prise en charge des méthodes to_dict et from_dict

FormRecognizerClient

FormRecognizerClient extrait des informations des formulaires et des images dans des données structurées. Il s’agit de l’interface à utiliser pour analyser avec des modèles prédéfinis (reçus, cartes de visite, factures, documents d’identité), reconnaître le contenu/la disposition des formulaires et analyser les formulaires personnalisés à partir de modèles entraînés. Il fournit différentes méthodes basées sur les entrées d’une URL et les entrées d’un flux.

Notes

FormRecognizerClient doit être utilisé avec les versions <d’API =v2.1.

Pour utiliser les versions d’API 2022-08-31 et ultérieures, instanciez un DocumentAnalysisClient.

FormRecognizerError

Représente une erreur qui s’est produite lors de l’entraînement.

Nouveautés de la version v2.1 : prise en charge des méthodes to_dict et from_dict

FormSelectionMark

Informations sur la marque de sélection extraite.

Nouveautés de la version v2.1 : prise en charge des méthodes to_dict et from_dict

FormTable

Informations sur la table extraite contenue dans une page.

Nouveautés de la version v2.1 : propriété bounding_box, prise en charge des méthodes to_dict et from_dict

FormTableCell

Représente une cellule contenue dans un tableau reconnu à partir du document d’entrée.

Nouveauté de la version v2.1 : FormSelectionMark est ajouté aux types retournés dans la liste des field_elements, prise en charge des méthodes to_dict et from_dict

FormTrainingClient

FormTrainingClient est l’interface Form Recognizer à utiliser pour créer et gérer des modèles personnalisés. Il fournit des méthodes d’apprentissage des modèles sur les formulaires que vous fournissez, ainsi que des méthodes pour afficher et supprimer des modèles, accéder aux propriétés de compte, copier des modèles vers une autre ressource Form Recognizer et composer des modèles à partir d’une collection de modèles existants entraînés avec des étiquettes.

Notes

FormTrainingClient doit être utilisé avec les versions <d’API =v2.1.

Pour utiliser les versions d’API 2022-08-31 et ultérieures, instanciez un DocumentModelAdministrationClient.

FormWord

Représente un mot reconnu à partir du document d’entrée.

Nouveautés de la version v2.1 : prise en charge des méthodes to_dict et from_dict

OperationDetails

OperationDetails se compose d’informations sur l’opération de modèle, y compris le résultat ou l’erreur de l’opération si elle s’est terminée.

Notez que les informations d’opération ne sont conservées que pendant 24 heures. Si l’opération a réussi, le modèle est également accessible à l’aide <xref:azure.ai.formrecognizer.get_document_model>des API , <xref:azure.ai.formrecognizer.list_document_models>, , <xref:azure.ai.formrecognizer.get_document_classifier><xref:azure.ai.formrecognizer.list_document_classifiers> .

Nouveauté de la version 2023-07-31 : le type documentClassifierBuild et le résultat DocumentClassifierDetails .

OperationSummary

Informations sur l’opération de modèle, y compris le type et la status de l’opération, lors de sa création, etc.

Notez que les informations d’opération ne sont conservées que pendant 24 heures. Si l’opération a réussi, le modèle est accessible à l’aide <xref:azure.ai.formrecognizer.get_document_model>des API , <xref:azure.ai.formrecognizer.list_document_models>, <xref:azure.ai.formrecognizer.get_document_classifier>, <xref:azure.ai.formrecognizer.list_document_classifiers> . Pour savoir pourquoi une opération a échoué, utilisez <xref:azure.ai.formrecognizer.get_operation> et fournissez les operation_id.

Nouveautés de la version 2023-07-31 : type documentClassifierBuild .

Point

Coordonnée x, y d’un point sur un rectangle englobant ou un polygone.

Nouveautés de la version v2.1 : prise en charge des méthodes to_dict et from_dict

QuotaDetails

Date/heure du quota utilisé, limite et prochaine réinitialisation.

RecognizedForm

Représente un formulaire qui a été reconnu par un modèle formé ou prédéfini. La propriété fields contient les champs de formulaire qui ont été extraits du formulaire. Les tableaux, les lignes/mots de texte et les marques de sélection sont extraits par page et se trouvent dans la propriété pages .

Nouveautés de la version v2.1 : propriétés form_type_confidence et model_id, prise en charge des méthodes to_dict et from_dict

ResourceDetails

Détails concernant la ressource Form Recognizer.

Nouveautés de la version 2023-07-31 : propriété neural_document_model_quota .

TextAppearance

Objet représentant l’apparence de la ligne de texte.

Nouveautés de la version v2.1 : prise en charge des méthodes to_dict et from_dict

TrainingDocumentInfo

Rapport pour un document individuel utilisé pour l’apprentissage d’un modèle personnalisé.

Nouveautés de la version v2.1 : propriété model_id, prise en charge des méthodes to_dict et from_dict

Énumérations

AnalysisFeature

Fonctionnalités d’analyse de document à activer.

CustomFormModelStatus

État indiquant la préparation du modèle à l’utilisation.

DocumentAnalysisApiVersion

Form Recognizer versions d’API prises en charge par DocumentAnalysisClient et DocumentModelAdministrationClient.

FieldValueType

Type de données sémantique de la valeur de champ.

Nouveautés de la version v2.1 : les valeurs selectionMark et countryRegion

FormContentType

Type de contenu pour le chargement.

Nouveautés de la version v2.1 : prise en charge de l’image/bmp

FormRecognizerApiVersion

Form Recognizer versions d’API prises en charge par FormRecognizerClient et FormTrainingClient.

LengthUnit

Unité utilisée par les propriétés de largeur, de hauteur et de cadre englobant. Pour les images, l’unité est « pixel ». Pour PDF, l’unité est « pouce ».

ModelBuildMode

Mode utilisé lors de la création de modèles personnalisés.

Pour plus d’informations, consultez https://aka.ms/azsdk/formrecognizer/buildmode.

TrainingStatus

État de l’opération d’entraînement.