@azure/ai-form-recognizer package

Classes

AzureKeyCredential	Informations d’identification basées sur une clé statique qui prend en charge la mise à jour de la valeur de clé sous-jacente.
DocumentAnalysisClient	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 { 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); Clé API (clé d’abonnement) 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	Client permettant d’interagir avec les fonctionnalités de gestion des modèles du service Form Recognizer, telles que la création, la lecture, la liste, la suppression et la copie de modèles. Exemples : 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); Clé API (clé d’abonnement) 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	Valeur du champ d’adresse.
AnalyzeDocumentOptions	Options pour 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 un 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	Stockage Blob Azure contenu.
BeginBuildDocumentClassifierOptions	Options pour l’opération de génération du classifieur de documents.
BeginBuildDocumentModelOptions	Options pour l’opération de génération de modèle.
BeginComposeDocumentModelOptions	Options pour l’opération de composition du modèle.
BeginCopyModelOptions	Options pour l’opération de copie de modèle.
BoundingRegion	Polygone englobant sur une page spécifique de l’entrée.
ClassifierDocumentTypeDetails	Informations sur le type de document classifieur.
ClassifyDocumentOptions	Options pour l’opération de classification de documents.
CommonModelCreationOptions	Options communes à toutes les opérations qui définissent de nouveaux modèles, telles que beginBuildDocumentModel, beginComposeDocumentModelet getCopyAuthorization.
CopyAuthorization	Autorisation de copier un modèle de document vers la ressource cible et modelId spécifiées.
CreateDocumentModelOptions	Options pour l’opération de création de modèle.
CurrencyValue	Valeur du champ Devise.
CustomDocumentModelsDetails	Détails concernant les modèles de documents 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 finira par produire le type de résultat qui correspond au modèle.
DocumentAnnotation	Élément d’annotation visuelle dans le document, tel qu’une marque case activée 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 table légende.
DocumentClassifierBuildOperationDetails	Obtient l’objet de réponse Operation.
DocumentClassifierDetails	Informations sur le classifieur de document.
DocumentClassifierDocumentTypeSources	Ensemble de sources utilisées pour créer un classifieur de documents. Il s’agit d’un mappage des noms de type de document aux sources qui seront utilisées pour entraîner le modèle afin de classifier les documents du type de 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 la forme d’une 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 tableau.
DocumentFormula	Formule extraite.
DocumentIntegerField	DocumentField qui a une valeur entière.
DocumentKeyValueElement	Objet représentant la clé de champ ou la valeur d’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 beginAnalyzeDocument méthode de DocumentAnalysisClient, qui prend en charge la consommation de ces DocumentModel objets 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	Obtient l’objet de réponse Operation.
DocumentModelComposeOperationDetails	Obtient l’objet de réponse Operation.
DocumentModelCopyToOperationDetails	Obtient l’objet de réponse Operation.
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 composé de lignes contiguës avec généralement un alignement et un espacement communs.
DocumentPhoneNumberField	DocumentField qui a une valeur de numéro de téléphone, représentée sous la forme d’une chaîne.
DocumentSelectionMark	Objet de marque de sélection représentant case activée zones, cases d’option et 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 la forme d’une chaîne.
DocumentSpan	Région contiguë de la propriété de contenu concaténé, spécifiée sous forme de décalage et de longueur.
DocumentStringField	DocumentField qui a une valeur de chaîne.
DocumentStyle	Objet représentant les styles de texte observés.
DocumentTable	Objet table constitué de cellules de tableau organisées dans une disposition rectangulaire.
DocumentTableCell	Objet représentant l’emplacement et le contenu d’une cellule de table.
DocumentTimeField	DocumentField qui a une valeur de temps, représentée sous la forme d’une 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 par l’espace, 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 pour la méthode d’autorisation get copy.
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 délimités par le polygone.
InnerError	Erreur détaillée.
ListModelsOptions	Options pour répertorier les modèles.
ListOperationsOptions	Options pour les opérations de référencement.
ModelAdministrationOperationStateCommon	Ensemble de champs communs à toutes les opérations d’administration.
OperationDetails	Obtient l’objet de réponse Operation.
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	Date/heure de réinitialisation du quota utilisé, limite et prochaine réinitialisation.
ResourceDetails	Informations générales sur la ressource actuelle.

Alias de type

AnalysisPoller	Opération de longue durée (pollueur) qui effectue le suivi de l’état d’une opération d’analyse, produisant finalement le type de résultat correspondant au modèle.
AnalyzeResultOperationStatus	Définit des valeurs pour AnalyzeResultOperationStatus.
DocumentBarcodeKind	Définit les valeurs de DocumentBarcodeKind. KnownDocumentBarcodeKind peut être utilisé indifféremment 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 la norme ISO 15438. UPCA : Code de produit universel GS1 à 12 chiffres. UPCE : Code de produit universel GS1 à 6 chiffres. Code39 : code-barres Code 39, tel que défini dans ISO/IEC 16388:2007. Code128 : code-barres Code 128, tel que défini dans ISO/IEC 15417:2007. EAN8 : Numéro d’article international GS1 à 8 chiffres (numéro d’article européen). EAN13 : Numéro d’article international GS1 à 13 chiffres (numéro d’article européen). DataBar : code-barres DataBar GS1. Code93 : code-barres Code 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 étendu DataBar GS1. ITF : code-barres entrelacé 2 sur 5, tel que défini dans ANSI/AIM BC2-1995. MicroQRCode : micro code QR, tel que défini dans ISO/IEC 23941:2022. Aztèque : code aztèque, 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 les valeurs de DocumentBuildMode. KnownDocumentBuildMode peut être utilisé indifféremment avec DocumentBuildMode. Cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service template : documents cibles avec des modèles visuels similaires. neural : documents de support avec divers modèles visuels.
DocumentClassifierPoller	Opération de longue durée (pollueur) qui effectue le suivi de l’état d’une opération de création de classifieur personnalisé, produisant finalement un DocumentClassifierDetails.
DocumentClassifierSource	Source de contenu qui peut être utilisée pour créer un classifieur de documents. Valeurs possibles : BlobSource BlobFileListSource
DocumentField	Champ extrait. La kind propriété identifie (discrimine) le type du DocumentField.
DocumentFieldType	Définit les valeurs de DocumentFieldType. KnownDocumentFieldType peut être utilisé indifféremment avec DocumentFieldType. Cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service string : texte brut. date : Date, normalisée au format ISO 8601 (AAAA-MM-JJ). time : 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. integer : 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 (par exemple, USA). signature : la signature est-elle présente ? array : liste des sous-champs du même type. object : liste nommée de sous-champs de types potentiellement différents. currency : montant monétaire avec symbole et unité de devise facultatifs. adresse : adresse analysée. boolean : valeur booléenne, normalisée sur true ou false.
DocumentFormulaKind	Définit des valeurs pour DocumentFormulaKind. KnownDocumentFormulaKind peut être utilisé indifféremment 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. display : formule en mode d’affichage qui occupe une ligne entière.
DocumentModelBuildMode	Modes de génération de modèles pris en charge. Le mode de génération de modèle sélectionne le moteur que le service utilise pour entraîner le modèle en fonction des données d’entraînement étiquetées. Les options sont : « neuronal », qui produit la plus haute 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 des dispositions différentes (par exemple, les formulaires fiscaux W2, qui peuvent varier d’une entreprise à l’autre, mais qui contiennent toujours les mêmes informations). « template », qui exige 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 (pollueur) qui effectue le suivi de l’état d’une opération de création de modèle, produisant éventuellement un DocumentModelDetails.
DocumentModelSource	Source de contenu qui peut être utilisée pour créer un modèle de document. Valeurs possibles : BlobSource BlobFileListSource
DocumentSignatureType	Définit des valeurs pour DocumentSignatureType. KnownDocumentSignatureType peut être utilisé indifféremment 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. unsigned : 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 content : contient les main contenu/données. 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’un tableau. 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 normal : les caractères sont représentés normalement. italique : les caractères sont visuellement inclinés vers la 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 normal : 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 demande. 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 requête qui peut être chargée en tant que données binaires sur le service Form Recognizer. Form Recognizer traite les entrées comme des string URL. Par conséquent, pour envoyer une chaîne en tant qu’entrée binaire, commencez par convertir la chaîne en l’un des types d’entrée suivants.
LengthUnit	Définit des valeurs pour LengthUnit. KnownLengthUnit peut être utilisé indifféremment avec LengthUnit. Cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service pixel : unité de longueur pour les fichiers image. inch : unité de longueur pour les fichiers PDF.
OperationDetailsUnion	Détails sur l’un des différents types d’opérations de gestion des Form Recognizer.
OperationKind	Définit des valeurs pour OperationKind. KnownOperationKind peut être utilisé indifféremment 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 dans une ressource, une région ou un abonnement potentiellement 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 peut être utilisé indifféremment 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. title : titre de niveau supérieur décrivant l’ensemble 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 main sur 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 un case activée ✓ 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.
KnownLengthUnit	Valeurs connues de LengthUnit que le service accepte.
KnownOperationKind	Valeurs connues d’OperationKind que le service accepte.
KnownParagraphRole	Valeurs connues de ParagraphRole que le service accepte.
KnownSelectionMarkState	Valeurs connues de SelectionMarkState que le service accepte.