@azure/ai-form-recognizer package

Classes

AzureKeyCredential	Informations d’identification statiques basées sur une clé qui prend en charge la mise à jour de la valeur de clé sous-jacente.
DocumentAnalysisClient	Un client pour interagir avec les fonctionnalités d’analyse du service Form Recognizer. Exemples: Le service Form Recognizer et les clients prennent en charge deux moyens d’authentification : 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, ); Clé API (clé d’abonnement) 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, );
DocumentModelAdministrationClient	Un client pour interagir avec les fonctionnalités de gestion des modèles du service Form Recognizer, telles que la création, la lecture, la description, la suppression et la copie de modèles. Exemples: 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, ); Clé API (clé d’abonnement) 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, );

Interfaces

AddressValue	Valeur du champ Adresse.
AnalyzeDocumentOptions	Options de l’opération d’analyse de document.
AnalyzeResult	Résultat d’une opération d’analyse. Le type du document peut être déterminé par le modèle utilisé pour effectuer l’analyse.
AnalyzeResultCommon	Champs communs de tous les types de type AnalyzeResult, tels que LayoutResult, ReadResult et GeneralDocumentResult.
AnalyzedDocument	Objet de document extrait. Un AnalyzedDocument est une instance de l’un des types de documents au sein d’un modèle. Ses champs correspondent au schéma de champ du type de document.
AzureBlobFileListSource	Source de données d’apprentissage définie par un conteneur d’objets blob Azure et une liste de fichiers JSONL dans le conteneur.
AzureBlobFileListSourceDetails	Liste de fichiers dans Stockage Blob Azure.
AzureBlobSource	Source de données d’apprentissage définie par un conteneur d’objets blob Azure.
AzureBlobSourceDetails	Contenu stockage Blob Azure.
BeginBuildDocumentClassifierOptions	Options de l’opération de génération du classifieur de document.
BeginBuildDocumentModelOptions	Options de l’opération de génération de modèle.
BeginComposeDocumentModelOptions	Options de l’opération de composition de modèle.
BeginCopyModelOptions	Options de l’opération de modèle de copie.
BoundingRegion	Polygone englobant sur une page spécifique de l’entrée.
ClassifierDocumentTypeDetails	Informations de type de document classifieur.
ClassifyDocumentOptions	Options de l’opération de classification de document.
CommonModelCreationOptions	Options communes à toutes les opérations qui définissent de nouveaux modèles, tels que beginBuildDocumentModel, beginComposeDocumentModelet getCopyAuthorization.
CopyAuthorization	Autorisation de copier un modèle de document vers la ressource cible et modelId spécifiés.
CreateDocumentModelOptions	Options de l’opération de création de modèle.
CurrencyValue	Valeur du champ Monétaire.
CustomDocumentModelsDetails	Détails relatifs aux modèles de document personnalisés.
DeleteDocumentModelOptions	Options de suppression de modèle.
DocumentAddressField	Champ de document qui décrit une adresse physique structurée.
DocumentAnalysisClientOptions	Options configurables pour DocumentAnalysisClient.
DocumentAnalysisPollOperationState	État d’une opération d’analyse, qui produira finalement le type de résultat qui correspond au modèle.
DocumentAnnotation	Élément d’annotation visuelle dans le document, tel qu’une coche ou une croix.
DocumentArrayField	DocumentField qui se compose d’un tableau de champs imbriqués. Tous les champs du tableau auront le même type.
DocumentBarcode	Code-barres extrait.
DocumentBooleanField	DocumentField qui a une valeur booléenne.
DocumentCaption	Objet représentant l’emplacement et le contenu d’une légende de table.
DocumentClassifierBuildOperationDetails	Obtenir l’objet de réponse de l’opération.
DocumentClassifierDetails	Informations de classifieur de document.
DocumentClassifierDocumentTypeSources	Ensemble de sources utilisées pour créer un classifieur de document. Il s’agit d’une carte des noms de types de documents aux sources qui seront utilisées pour entraîner le modèle pour classifier les documents du type source correspondant.
DocumentClassifierOperationState	État d’une opération de création de modèle.
DocumentCountryRegionField	DocumentField qui a une valeur indiquant un pays ou une région, représenté sous forme de chaîne.
DocumentCurrencyField	DocumentField qui décrit un montant d’une certaine devise.
DocumentDateField	DocumentField qui a une valeur Date.
DocumentFieldCommon	Champs communs à toutes les variantes DocumentField.
DocumentFieldSchema	Description du schéma sémantique de champ à l’aide d’une syntaxe de style de schéma JSON.
DocumentFootnote	Objet représentant l’emplacement et le contenu d’une note de bas de page de table.
DocumentFormula	Formule extraite.
DocumentIntegerField	DocumentField qui a une valeur entière.
DocumentKeyValueElement	Objet représentant la clé ou la valeur de champ dans une paire clé-valeur.
DocumentKeyValuePair	Objet représentant un champ de formulaire 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 constitué d’une séquence adjacente d’éléments de contenu, tels que des mots et des marques de sélection.
DocumentModel	Spécification de modèle connue qui prend en charge l’extraction de documents structurés. Consultez la méthode beginAnalyzeDocument de DocumentAnalysisClient, qui prend en charge l’utilisation de ces objets DocumentModel au lieu de chaînes d’ID de modèle pour fournir des types de résultats plus forts.
DocumentModelAdministrationClientOptions	Options configurables pour DocumentModelAdministrationClient.
DocumentModelBuildOperationDetails	Obtenir l’objet de réponse de l’opération.
DocumentModelComposeOperationDetails	Obtenir l’objet de réponse de l’opération.
DocumentModelCopyToOperationDetails	Obtenir l’objet de réponse de l’opération.
DocumentModelDetails	Informations sur le modèle de document.
DocumentModelOperationState	État d’une opération de création de modèle.
DocumentModelSummary	Résumé du modèle de document.
DocumentNumberField	DocumentField qui a une valeur numérique.
DocumentObjectField	DocumentField qui se compose de plusieurs propriétés nommées qui ont leurs propres valeurs DocumentField.
DocumentPage	Éléments de contenu et de disposition extraits d’une page de l’entrée.
DocumentParagraph	Objet de paragraphe constitué de lignes contiguës généralement avec un alignement et un espacement communs.
DocumentPhoneNumberField	DocumentField qui a une valeur de numéro de téléphone, représentée sous forme de chaîne.
DocumentSelectionMark	Objet de marque de sélection représentant des cases à cocher, des cases d’option et d’autres éléments indiquant une sélection.
DocumentSelectionMarkField	DocumentField qui a une valeur indiquant un état de marque de sélection (par exemple, une case à cocher ou une case d’option), représentée sous forme de chaîne.
DocumentSignatureField	DocumentField qui indique l’état d’une signature, représentée sous forme de chaîne.
DocumentSpan	Région contiguë de la propriété de contenu concaténée, spécifiée en tant que décalage et longueur.
DocumentStringField	DocumentField qui a une valeur de chaîne.
DocumentStyle	Objet représentant des styles de texte observés.
DocumentTable	Objet table composé de cellules de tableau organisées dans une disposition rectangulaire.
DocumentTableCell	Objet représentant l’emplacement et le contenu d’une cellule de tableau.
DocumentTimeField	DocumentField qui a une valeur de temps, représentée sous forme de chaîne.
DocumentTypeDetails	Informations sur le type de document.
DocumentValueField	Champ simple qui a une valeur primitive, telle qu’une chaîne, un nombre, etc.
DocumentWord	Objet word constitué d’une séquence contiguë de caractères. Pour les langues non délimitées spatiales, telles que le chinois, le japonais et le coréen, chaque caractère est représenté comme son propre mot.
ErrorModel	Informations d’erreur.
GetCopyAuthorizationOptions	Options de la méthode d’autorisation de copie get.
GetModelOptions	Options de récupération des informations de modèle.
GetOperationOptions	Options de récupération d’un état d’opération.
GetResourceDetailsOptions	Options de récupération des informations sur les ressources Form Recognizer.
HasBoundingPolygon	Les éléments de document simples tels que les mots, les marques de sélection et les lignes sont limités par le polygone.
InnerError	Erreur détaillée.
ListModelsOptions	Options de référencement des modèles.
ListOperationsOptions	Options pour les opérations de référencement.
ModelAdministrationOperationStateCommon	Ensemble de champs communs à toutes les opérations d’administration.
OperationDetails	Obtenir l’objet de réponse de l’opération.
OperationSummary	Informations sur l’opération.
Point2D	Représente un point utilisé pour définir des polygones englobants. L’unité est « pixel » ou « pouce » (voir LengthUnit).
PollerOptions	Options pour les opérations de longue durée (pollueurs) dans les clients Form Recognizer.
QuotaDetails	Quota utilisé, limite et date/heure de réinitialisation suivante.
ResourceDetails	Informations générales sur la ressource actuelle.

Alias de type

AnalysisPoller	Opération de longue durée (polleur) qui suit l’état d’une opération d’analyse, produisant finalement le type de résultat qui correspond au modèle.
AnalyzeResultOperationStatus	Définit des valeurs pour AnalyzeResultOperationStatus.
DocumentBarcodeKind	Définit des valeurs pour DocumentBarcodeKind. KnownDocumentBarcodeKind pouvez être utilisé de manière interchangeable avec DocumentBarcodeKind, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service QRCode: code QR, tel que défini dans ISO/IEC 18004:2015. PDF417: PDF417, tel que défini dans ISO 15438. UPCA: Code de produit universel GS1 à 12 chiffres. UPCE: Code de produit universel À 6 chiffres GS1. Code39: code-barres 39, tel que défini dans ISO/IEC 16388:2007. Code128: Code-barres 128, tel que défini dans ISO/IEC 15417:2007. EAN8: GS1 8 chiffres Numéro d’article international (numéro d’article européen). EAN13: GS1 13 chiffres Numéro d’article international (numéro d’article européen). DataBar: code-barres DataBar GS1. Code93: code-barres 93, tel que défini dans ANSI/AIM BC5-1995. Codabar: code-barres Codabar, tel que défini dans ANSI/AIM BC3-1995. DataBarExpanded: code-barres développé GS1 DataBar. ITF: code-barres entrelacé 2 sur 5, tel que défini dans ANSI/AIM BC2-1995. MicroQRCode: Code QR micro, tel que défini dans ISO/IEC 23941:2022. Aztec: code Aztec, tel que défini dans iso/IEC 24778:2008. DataMatrix: code de matrice de données, tel que défini dans ISO/IEC 16022:2006. MaxiCode: MaxiCode, tel que défini dans ISO/IEC 16023:2000.
DocumentBuildMode	Définit des valeurs pour DocumentBuildMode. KnownDocumentBuildMode pouvez être utilisé de manière interchangeable avec DocumentBuildMode, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service modèle: cibler des documents avec des modèles visuels similaires. neuronal : prise en charge des documents avec différents modèles visuels.
DocumentClassifierPoller	Opération longue (polleur) qui suit l’état d’une opération de création de classifieur personnalisée, produisant finalement un DocumentClassifierDetails.
DocumentClassifierSource	Source de contenu qui peut être utilisée pour générer un classifieur de document. Une des suivantes : BlobSource BlobFileListSource
DocumentField	Champ extrait. La propriété kind identifie (discrimine) le type du DocumentField.
DocumentFieldType	Définit des valeurs pour DocumentFieldType. KnownDocumentFieldType peut être utilisé de manière interchangeable avec DocumentFieldType, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service chaîne: texte brut. date: date, normalisée au format ISO 8601 (AAAA-MM-DD). heure: heure, normalisée au format ISO 8601 (hh :mm :ss). phoneNumber: numéro de téléphone, normalisé au format E.164 (+{CountryCode}{SubscriberNumber}). nombre: nombre à virgule flottante, normalisé en virgule flottante double précision. entier: nombre entier normalisé en entier signé 64 bits. selectionMark: le champ est-il sélectionné ? countryRegion: pays/région, normalisé au format ISO 3166-1 alpha-3 (ex. Usa). signature: la signature est-elle présente ? tableau: liste de sous-champs du même type. objet: liste nommée de sous-champs de types potentiellement différents. devise: montant monétaire avec symbole et unité de devise facultatifs. adresse: adresse analysée. booléen : valeur booléenne, normalisée en true ou false.
DocumentFormulaKind	Définit des valeurs pour DocumentFormulaKind. KnownDocumentFormulaKind peut être utilisé de manière interchangeable avec DocumentFormulaKind, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service inline : formule incorporée dans le contenu d’un paragraphe. afficher: formule en mode d’affichage qui prend une ligne entière.
DocumentModelBuildMode	Modes de génération de modèle pris en charge. Le mode de génération du modèle sélectionne le moteur utilisé par le service pour entraîner le modèle en fonction des données d’entraînement étiquetées. Les options sont les suivantes : « neuronal », qui génère la meilleure qualité de modèle capable d’extraire des données à partir de classes de documents qui ont la même structure de données, mais différentes dispositions (par exemple, les formulaires fiscaux W2, qui peuvent varier d’une entreprise à l’autre, mais qui contiennent toujours les mêmes informations). « modèle », qui nécessite que tous les documents aient la même disposition fixe (modèle). Pour plus d’informations, consultez le lien suivant : https://aka.ms/azsdk/formrecognizer/buildmode
DocumentModelPoller	Opération de longue durée (polleur) qui suit l’état d’une opération de création de modèle, produisant finalement un DocumentModelDetails.
DocumentModelSource	Source de contenu qui peut être utilisée pour générer un modèle de document. Une des suivantes : BlobSource BlobFileListSource
DocumentSignatureType	Définit des valeurs pour DocumentSignatureType. KnownDocumentSignatureType pouvez être utilisé de manière interchangeable avec DocumentSignatureType, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service signé : une signature est détectée. non signé : aucune signature n’est détectée.
DocumentTableCellKind	Définit des valeurs pour DocumentTableCellKind. KnownDocumentTableCellKind peut être utilisé de manière interchangeable avec DocumentTableCellKind, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service contenu: contient le contenu/les données principaux. rowHeader: décrit le contenu de la ligne. columnHeader: décrit le contenu de la colonne. stubHead: décrit les en-têtes de ligne, généralement situés dans le coin supérieur gauche d’une table. description: décrit le contenu dans (parties de) la table.
FontStyle	Définit des valeurs pour FontStyle. KnownFontStyle peut être utilisé de manière interchangeable avec FontStyle, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service normale : les caractères sont représentés normalement. italique : les caractères sont visuellement inclinés à droite.
FontWeight	Définit des valeurs pour FontWeight. KnownFontWeight peut être utilisé de manière interchangeable avec FontWeight, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service normale : les caractères sont représentés normalement. gras: les caractères sont représentés avec des traits plus épais.
FormRecognizerFeature	Fonctionnalités de module complémentaire (fonctionnalités) qui peuvent être activées pour la requête. Pour plus d’informations sur les fonctionnalités disponibles dans Form Recognizer, consultez la documentation du service : https://aka.ms/azsdk/formrecognizer/features
FormRecognizerRequestBody	Entrée de demande qui peut être chargée en tant que données binaires dans le service Form Recognizer. Form Recognizer traite les entrées string en tant qu’URL. Par conséquent, pour envoyer une chaîne en tant qu’entrée binaire, commencez par convertir la chaîne en un des types d’entrée suivants.
LengthUnit	Définit des valeurs pour LengthUnit. KnownLengthUnit peut être utilisé de manière interchangeable avec LengthUnit, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service pixels : unité de longueur pour les fichiers image. pouce: unité de longueur pour les fichiers PDF.
OperationDetailsUnion	Détails sur l’un des différents types d’opérations de gestion Form Recognizer.
OperationKind	Définit des valeurs pour OperationKind. KnownOperationKind peut être utilisé de manière interchangeable avec OperationKind, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service documentModelBuild: créez un nouveau modèle de document personnalisé. documentModelCompose: composez un nouveau modèle de document personnalisé à partir de modèles existants. documentModelCopyTo: copiez un modèle de document existant vers une ressource, une région ou un abonnement différent. documentClassifierBuild: créez un nouveau modèle de classifieur personnalisé.
OperationStatus	Définit des valeurs pour OperationStatus.
ParagraphRole	Définit des valeurs pour ParagraphRole. KnownParagraphRole pouvez être utilisé de manière interchangeable avec ParagraphRole, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service pageHeader: texte près du bord supérieur de la page. pageFooter: texte près du bord inférieur de la page. pageNumber: Numéro de page. titre: titre de niveau supérieur décrivant l’intégralité du document. sectionHeading: sous-titre décrivant une section du document. note de bas de page: note généralement placée après le contenu principal d’une page. formulaBlock: bloc de formules, souvent avec alignement partagé.
SelectionMarkState	Définit des valeurs pour SelectionMarkState. KnownSelectionMarkState peut être utilisé de manière interchangeable avec SelectionMarkState, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service sélectionné: la marque de sélection est sélectionnée, souvent indiquée par une coche ou une croix X à l’intérieur de la marque de sélection. non sélectionné: la marque de sélection n’est pas sélectionnée.
StringIndexType	Types d’index de chaîne valides pris en charge par le service Form Recognizer et les clients sdk.

Énumérations

KnownDocumentBarcodeKind	Valeurs connues de DocumentBarcodeKind que le service accepte.
KnownDocumentBuildMode	Valeurs connues de DocumentBuildMode que le service accepte.
KnownDocumentFieldType	Valeurs connues de DocumentFieldType que le service accepte.
KnownDocumentFormulaKind	Valeurs connues de DocumentFormulaKind que le service accepte.
KnownDocumentSignatureType	Valeurs connues de DocumentSignatureType que le service accepte.
KnownDocumentTableCellKind	Valeurs connues de DocumentTableCellKind que le service accepte.
KnownFontStyle	Valeurs connues de FontStyle que le service accepte.
KnownFontWeight	Valeurs connues de FontWeight que le service accepte.
KnownFormRecognizerAudience	Définit les audiences cloud connues pour Form Recognizer. Pour vous authentifier avec Entra Id (à l’aide d’un TokenCredential) dans un environnement Sovereign Cloud , indiquez la valeur appropriée ci-dessous comme option lors de la création d’un audienceDocumentAnalysisClient ou DocumentModelAdministrationClient. La valeur par défaut convient aux ressources Form Recognizer créées dans le cloud public Azure, de sorte que cette valeur n’est requise que pour utiliser Form Recognizer dans un autre environnement cloud.
KnownLengthUnit	Valeurs connues de LengthUnit que le service accepte.
KnownOperationKind	Valeurs connues de OperationKind que le service accepte.
KnownParagraphRole	Valeurs connues de ParagraphRole que le service accepte.
KnownSelectionMarkState	Valeurs connues de SelectionMarkState que le service accepte.