Utiliser des modèles Intelligence documentaire

Ce contenu s’applique à :v4.0 (préversion) | Versions précédentes :v3.1(GA)v3.0 (GA)v2.1 (GA)

Dans ce guide, découvrez comment ajouter des modèles Intelligence documentaire à vos applications et workflows. Utilisez un SDK de langage de programmation de votre choix ou l’API REST.

Azure AI Intelligence documentaire est une fonctionnalité d’Azure AI services basée sur le cloud, qui utilise le Machine Learning pour extraire des éléments de structure et de texte clés de vos documents. Nous vous recommandons d’utiliser le service gratuit pendant que vous apprenez la technologie. N’oubliez pas que le nombre de pages gratuites est limité à 500 par mois.

Choisissez parmi les modèles Intelligence documentaire suivants pour analyser et extraire les données et les valeurs de formulaires et de documents :

• Le modèle prebuilt-read est au cœur de tous les modèles Intelligence documentaire et peut détecter des lignes, des mots, des lieux et des langues. Les modèles prédéfinis, personnalisés, de disposition et de document général utilisent le modèle read comme base pour extraire du texte à partir de documents.

• Le modèle prebuilt-layout extrait le texte et ses emplacements, les tableaux, les marques de sélection et les informations de structure des documents et des images. Vous pouvez extraire des paires clé-valeur à l’aide du modèle de disposition avec le paramètre de chaîne de requête facultatif features=keyValuePairs activé.

• Le modèle prebuilt-contract extrait les informations clés des accords contractuels.

• Le modèle prebuilt-healthInsuranceCard.us extrait les informations essentielles des cartes d’assurance maladie aux États-Unis.

• Les modèles de documents fiscaux prédéfinis extraient les informations déclarées sur les formulaires fiscaux américains.

• Le modèle prebuilt-invoice extrait les champs clés et les éléments des lignes des factures de vente dans différentes formats et qualités. Les champs incluent les images capturées par téléphone, les documents numérisés et les fichiers PDF numériques.

• Le modèle prebuilt-receipt analyse et extrait les informations clés des reçus de vente imprimés et manuscrits.

• Le modèle prebuilt-idDocument extrait les informations clés des permis de conduire américains, des pages biographiques des passeports internationaux, des cartes d’identité des États américains, des cartes de sécurité sociale et des cartes de résident permanent.

Prérequis

• Un abonnement Azure : créez-en un gratuitement.

• IDE Visual Studio.

• Une ressource Azure AI services ou Document Intelligence. Créez un service unique ou un service multiple. Vous pouvez utiliser le niveau tarifaire Gratuit (F0) pour tester le service, puis passer par la suite à un niveau payant pour la production.

• La clé et le point de terminaison de la ressource que vous créez pour connecter votre application au service Intelligence documentaire Azure.

  1. Après le déploiement de votre ressource, sélectionnez Accéder à la ressource.
  2. Dans le menu de navigation de gauche, sélectionnez Clés et point de terminaison.
  3. Copiez une des clés et le point de terminaison pour une utilisation ultérieure dans cet article.

  

• Un fichier de document à un emplacement d’URL. Pour ce projet, vous pouvez utiliser les exemples de formulaires fournis dans le tableau suivant pour chaque fonctionnalité :

  Fonction	modelID	document-url
  Modèle Read	prebuilt-read	Exemple de brochure
  Modèle de disposition	prebuilt-layout	Exemple de confirmation de réservation
  Modèle de formulaire W-2	prebuilt-tax.us.w2	Exemple de formulaire W-2
  Modèle de facture	Facture prédéfinie	Exemple de facture
  Modèle de reçu	prebuilt-receipt	Exemple de ticket de caisse
  Modèle de pièce d’identité	prebuilt-idDocument	Exemple de pièce d’identité
  Modèle de carte de visite	prebuilt-businessCard	Exemple de carte de visite

Définir vos variables d’environnement

Pour interagir avec le service d’Intelligence documentaire, vous devez créer une instance de classe DocumentAnalysisClient. Pour ce faire, vous instanciez le client avec vos key et endpoint depuis le portail Azure. Pour ce projet, utilisez des variables d’environnement pour stocker des informations d’identification et y accéder.

Important

N’incluez pas votre clé directement dans le code et ne la publiez jamais publiquement. Pour la production, utilisez un moyen sécurisé pour stocker et accéder à vos informations d’identification, comme Azure Key Vault. Pour plus d’informations, veuillez consulter Sécurité d’Azure AI services.

Pour définir la variable d’environnement de votre clé de ressource Intelligence documentaire, ouvrez une fenêtre de console et suivez les instructions relatives à votre système d’exploitation et à votre environnement de développement. Remplacez <yourKey> et <yourEndpoint> par les valeurs de votre ressource dans le portail Azure.

Windows

Les variables d’environnement dans Windows ne respectent pas la casse. Elles sont généralement déclarées en majuscules, avec des mots joints par un trait de soulignement. Depuis une invite de commandes, exécutez les commandes suivantes :

1. Définissez votre variable de clé :

   setx DI_KEY <yourKey>
   

2. Définissez votre variable de point de terminaison

   setx DI_ENDPOINT <yourEndpoint>
   

3. Après avoir défini vos variables d’environnement, fermez la fenêtre d’invite de commandes. Les valeurs restent les mêmes jusqu’à ce que vous les modifiez à nouveau.

4. Redémarrez tous les programmes en cours d’exécution qui lisent la variable d’environnement. Par exemple, si vous utilisez Visual Studio ou Visual Studio Code comme éditeur, redémarrez-le avant d’exécuter l’échantillon de code.

Voici d’autres commandes utiles à utiliser avec les variables d’environnement :

Commande	Action	Exemple
setx VARIABLE_NAME=	Supprimez la variable d’environnement en définissant la valeur sur une chaîne vide.	setx DI_KEY=
setx VARIABLE_NAME=value	Définissez ou changez la valeur d’une variable d’environnement.	setx DI_KEY=<yourKey>
set VARIABLE_NAME	Affichez la valeur d’une variable d’environnement spécifique.	set DI_KEY
set	Affichez toutes les variables d’environnement.	set

macOS

Les variables d’environnement dans macOS respectent la casse. Par convention, le nom de la variable est déclaré en majuscules.

La commande export définit la variable et l’exporte dans l’environnement global, qui est disponible pour les autres processus. Cependant, la valeur est temporaire et dure seulement jusqu’au moment où vous fermez la session du terminal. Ouvrez votre terminal et entrez les commandes suivantes :

1. Définissez votre variable de clé :

   export key=<yourKey>
   

2. Définissez votre variable de point de terminaison :

   export endpoint=<yourEndpoint>
   

Pour définir une variable d’environnement de façon permanente, placez une commande d’exportation dans votre script de démarrage Bash ~/.bash_profile :

1. Utilisez un éditeur de texte pour ouvrir le fichier ~/.bash_profile et ajoutez la commande suivante pour créer une variable d’environnement permanente :

   export DI_KEY=<yourKey> DI_ENDPOINT=<yourEndpoint>
   

   Exemple : export DI_KEY="<yourKey>"

2. Enregistrez les modifications apportées au fichier bash_profile.

3. Pour que les modifications entrent en vigueur, exécutez la commande suivante dans la fenêtre du terminal :

   source ~/.bash-profile
   

Voici d’autres commandes utiles à utiliser avec les variables d’environnement :

Commande	Action	Exemple
unset VARIABLE_NAME	Supprimez une variable d’environnement.	unset DI_KEY
export VARIABLE_NAME=value	Définissez ou modifiez la valeur d’une variable d’environnement temporaire.	export DI_KEY=<yourKey>
printenv VARIABLE_NAME echo $VARIABLE_NAME	Affichez la valeur d’une variable d’environnement spécifique. Avec la commande echo, faites précéder la variable de $.	printenv DI_KEY echo $DI_KEY
printenv	Affichez toutes les variables d’environnement.	printenv

Linux

Les variables d’environnement dans Linux respectent la casse. Par convention, le nom de la variable est déclaré en majuscules.

La commande export définit la variable et l’exporte dans l’environnement global, qui est disponible pour les autres processus. Cependant, la valeur est temporaire et dure seulement jusqu’au moment où vous fermez la session du terminal :

1. Définissez votre variable de clé :

   export DI_KEY=<yourKey>
   

2. Définissez votre variable de point de terminaison :

   export DI_ENDPOINT=<yourEndpoint>
   

Pour définir une variable d’environnement de façon permanente, placez une commande d’exportation dans votre script de démarrage Bash ~/.bashrc :

1. Utilisez un éditeur de texte pour ouvrir le fichier ~/.bashrc et ajoutez la commande suivante pour créer une variable d’environnement permanente :

   export <VARIABLE>=<value>
   

   Exemple : export DI_KEY=<yourKey>

2. Enregistrez vos modifications apportées au fichier .bashrc.

3. Pour que les modifications entrent en vigueur, exécutez la commande suivante dans la fenêtre du terminal :

   source ~/.bashrc
   

Voici d’autres commandes utiles à utiliser avec les variables d’environnement :

Commande	Action	Exemple
unset VARIABLE_NAME	Supprimez une variable d’environnement.	unset DI_KEY=
export VARIABLE_NAME=value	Définissez ou modifiez la valeur d’une variable d’environnement temporaire.	export DI_KEY={yourKey}
printenv VARIABLE_NAME echo $VARIABLE_NAME	Affichez la valeur d’une variable d’environnement. Avec la commande echo, faites précéder la variable de $.	printenv DI_KEY echo $DI_KEY
printenv	Affichez toutes les variables d’environnement.	printenv

Configurer votre environnement de programmation

1. Démarrez Visual Studio.

2. Dans la page de démarrage, choisissez Créer un projet.

   

3. Sur la page Créer un projet, entrez console dans la zone de recherche. Sélectionnez le modèle Application console, puis choisissez Suivant.

   

4. Dans la page Configurer votre nouveau projet, sous Nom du projet, entrez docIntelligence_app. Sélectionnez ensuite Suivant.

   

5. Dans la page Informations supplémentaires, sélectionnez .NET 8.0 (prise en charge à long terme), puis Créer.

   

Installer la bibliothèque de client avec NuGet

1. Cliquez avec le bouton droit sur votre projet docIntelligence_app, puis sélectionnez Gérer les packages NuGet.

   

2. Sélectionnez l’onglet Parcourir, puis tapez Azure.AI.FormRecognizer.

   

3. Sélectionnez une version dans le menu déroulant, puis installez le package dans votre projet.

Générer votre application

Notes

À compter de .NET 6, de nouveaux projets utilisant le modèle console génèrent un nouveau style de programme qui diffère des versions précédentes. La nouvelle sortie utilise des fonctionnalités C# récentes qui simplifient le code que vous devez écrire.

Lorsque vous utilisez la version la plus récente, vous devez uniquement écrire le corps de la Main méthode. Vous n’avez pas besoin d’inclure des instructions de niveau supérieur, des directives globales à l’aide de directives ou des directives implicites. Pour plus d’informations, consultez Le modèle d’application console C# génère des instructions de haut niveau.

1. Ouvrez le fichier Program.cs.

2. Supprimez le code préexistant, y compris la ligne Console.Writeline("Hello World!").

3. Sélectionnez l’un des exemples de code suivants, puis copiez-collez l’exemple dans le fichier Program.cs de votre application :

   • prebuilt-read
   • prebuilt-layout
   • prebuilt-tax.us.w2
   • Facture prédéfinie
   • prebuilt-receipt
   • prebuilt-idDocument

4. Une fois que vous avez ajouté un exemple de code à votre application, choisissez le bouton vert Démarrer en regard du nom du projet pour générer et exécuter votre programme, ou appuyez sur F5.

   

Utiliser le modèle Lecture

using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;

//use your `key` and `endpoint` environment variables to create your `AzureKeyCredential` and `DocumentAnalysisClient` instances
string key = Environment.GetEnvironmentVariable("DI_KEY");
string endpoint = Environment.GetEnvironmentVariable("DI_ENDPOINT");
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentAnalysisClient client = new DocumentAnalysisClient(new Uri(endpoint), credential);

//sample document
Uri fileUri = new Uri("https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/read.png");

AnalyzeDocumentOperation operation = await client.AnalyzeDocumentFromUriAsync(WaitUntil.Completed, "prebuilt-read", fileUri);
AnalyzeResult result = operation.Value;

foreach (DocumentPage page in result.Pages)
{
    Console.WriteLine($"Document Page {page.PageNumber} has {page.Lines.Count} line(s), {page.Words.Count} word(s),");
    Console.WriteLine($"and {page.SelectionMarks.Count} selection mark(s).");

    for (int i = 0; i < page.Lines.Count; i++)
    {
        DocumentLine line = page.Lines[i];
        Console.WriteLine($"  Line {i} has content: '{line.Content}'.");

        Console.WriteLine($"    Its bounding polygon (points ordered clockwise):");

        for (int j = 0; j < line.BoundingPolygon.Count; j++)
        {
            Console.WriteLine($"      Point {j} => X: {line.BoundingPolygon[j].X}, Y: {line.BoundingPolygon[j].Y}");
        }
    }
}

foreach (DocumentStyle style in result.Styles)
{
    // Check the style and style confidence to see if text is handwritten.
    // Note that value '0.8' is used as an example.

    bool isHandwritten = style.IsHandwritten.HasValue && style.IsHandwritten == true;

    if (isHandwritten && style.Confidence > 0.8)
    {
        Console.WriteLine($"Handwritten content found:");

        foreach (DocumentSpan span in style.Spans)
        {
            Console.WriteLine($"  Content: {result.Content.Substring(span.Index, span.Length)}");
        }
    }
}

Console.WriteLine("Detected languages:");

foreach (DocumentLanguage language in result.Languages)
{
    Console.WriteLine($"  Found language with locale'{language.Locale}' with confidence {language.Confidence}.");
}

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle read.

Utiliser le modèle de disposition

using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;

//use your `key` and `endpoint` environment variables to create your `AzureKeyCredential` and `DocumentAnalysisClient` instances
string key = Environment.GetEnvironmentVariable("DI_KEY");
string endpoint = Environment.GetEnvironmentVariable("DI_ENDPOINT");
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentAnalysisClient client = new DocumentAnalysisClient(new Uri(endpoint), credential);

// sample document document
Uri fileUri = new Uri ("https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/layout.png");

AnalyzeDocumentOperation operation = await client.AnalyzeDocumentFromUriAsync(WaitUntil.Completed, "prebuilt-layout", fileUri);

AnalyzeResult result = operation.Value;

foreach (DocumentPage page in result.Pages)
{
    Console.WriteLine($"Document Page {page.PageNumber} has {page.Lines.Count} line(s), {page.Words.Count} word(s),");
    Console.WriteLine($"and {page.SelectionMarks.Count} selection mark(s).");

    for (int i = 0; i < page.Lines.Count; i++)
    {
        DocumentLine line = page.Lines[i];
        Console.WriteLine($"  Line {i} has content: '{line.Content}'.");

        Console.WriteLine($"    Its bounding polygon (points ordered clockwise):");

        for (int j = 0; j < line.BoundingPolygon.Count; j++)
        {
            Console.WriteLine($"      Point {j} => X: {line.BoundingPolygon[j].X}, Y: {line.BoundingPolygon[j].Y}");
        }
    }

    for (int i = 0; i < page.SelectionMarks.Count; i++)
    {
        DocumentSelectionMark selectionMark = page.SelectionMarks[i];

        Console.WriteLine($"  Selection Mark {i} is {selectionMark.State}.");
        Console.WriteLine($"    Its bounding polygon (points ordered clockwise):");

        for (int j = 0; j < selectionMark.BoundingPolygon.Count; j++)
        {
            Console.WriteLine($"      Point {j} => X: {selectionMark.BoundingPolygon[j].X}, Y: {selectionMark.BoundingPolygon[j].Y}");
        }
    }
}

Console.WriteLine("Paragraphs:");

foreach (DocumentParagraph paragraph in result.Paragraphs)
{
    Console.WriteLine($"  Paragraph content: {paragraph.Content}");

    if (paragraph.Role != null)
    {
        Console.WriteLine($"    Role: {paragraph.Role}");
    }
}

foreach (DocumentStyle style in result.Styles)
{
    // Check the style and style confidence to see if text is handwritten.
    // Note that value '0.8' is used as an example.

    bool isHandwritten = style.IsHandwritten.HasValue && style.IsHandwritten == true;

    if (isHandwritten && style.Confidence > 0.8)
    {
        Console.WriteLine($"Handwritten content found:");

        foreach (DocumentSpan span in style.Spans)
        {
            Console.WriteLine($"  Content: {result.Content.Substring(span.Index, span.Length)}");
        }
    }
}

Console.WriteLine("The following tables were extracted:");

for (int i = 0; i < result.Tables.Count; i++)
{
    DocumentTable table = result.Tables[i];
    Console.WriteLine($"  Table {i} has {table.RowCount} rows and {table.ColumnCount} columns.");

    foreach (DocumentTableCell cell in table.Cells)
    {
        Console.WriteLine($"    Cell ({cell.RowIndex}, {cell.ColumnIndex}) has kind '{cell.Kind}' and content: '{cell.Content}'.");
    }
}

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle de disposition.

Utiliser le modèle Document général

using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;

//use your `key` and `endpoint` environment variables to create your `AzureKeyCredential` and `DocumentAnalysisClient` instances
string key = Environment.GetEnvironmentVariable("DI_KEY");
string endpoint = Environment.GetEnvironmentVariable("DI_ENDPOINT");
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentAnalysisClient client = new DocumentAnalysisClient(new Uri(endpoint), credential);

// sample document document
Uri fileUri = new Uri("https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/sample-layout.pdf");

AnalyzeDocumentOperation operation = await client.AnalyzeDocumentFromUriAsync(WaitUntil.Completed, "prebuilt-document", fileUri);

AnalyzeResult result = operation.Value;

Console.WriteLine("Detected key-value pairs:");

foreach (DocumentKeyValuePair kvp in result.KeyValuePairs)
{
    if (kvp.Value == null)
    {
        Console.WriteLine($"  Found key with no value: '{kvp.Key.Content}'");
    }
    else
    {
        Console.WriteLine($"  Found key-value pair: '{kvp.Key.Content}' and '{kvp.Value.Content}'");
    }
}

foreach (DocumentPage page in result.Pages)
{
    Console.WriteLine($"Document Page {page.PageNumber} has {page.Lines.Count} line(s), {page.Words.Count} word(s),");
    Console.WriteLine($"and {page.SelectionMarks.Count} selection mark(s).");

    for (int i = 0; i < page.Lines.Count; i++)
    {
        DocumentLine line = page.Lines[i];
        Console.WriteLine($"  Line {i} has content: '{line.Content}'.");

        Console.WriteLine($"    Its bounding polygon (points ordered clockwise):");

        for (int j = 0; j < line.BoundingPolygon.Count; j++)
        {
            Console.WriteLine($"      Point {j} => X: {line.BoundingPolygon[j].X}, Y: {line.BoundingPolygon[j].Y}");
        }
    }

    for (int i = 0; i < page.SelectionMarks.Count; i++)
    {
        DocumentSelectionMark selectionMark = page.SelectionMarks[i];

        Console.WriteLine($"  Selection Mark {i} is {selectionMark.State}.");
        Console.WriteLine($"    Its bounding polygon (points ordered clockwise):");

        for (int j = 0; j < selectionMark.BoundingPolygon.Count; j++)
        {
            Console.WriteLine($"      Point {j} => X: {selectionMark.BoundingPolygon[j].X}, Y: {selectionMark.BoundingPolygon[j].Y}");
        }
    }
}

foreach (DocumentStyle style in result.Styles)
{
    // Check the style and style confidence to see if text is handwritten.
    // Note that value '0.8' is used as an example.

    bool isHandwritten = style.IsHandwritten.HasValue && style.IsHandwritten == true;

    if (isHandwritten && style.Confidence > 0.8)
    {
        Console.WriteLine($"Handwritten content found:");

        foreach (DocumentSpan span in style.Spans)
        {
            Console.WriteLine($"  Content: {result.Content.Substring(span.Index, span.Length)}");
        }
    }
}

Console.WriteLine("The following tables were extracted:");

for (int i = 0; i < result.Tables.Count; i++)
{
    DocumentTable table = result.Tables[i];
    Console.WriteLine($"  Table {i} has {table.RowCount} rows and {table.ColumnCount} columns.");

    foreach (DocumentTableCell cell in table.Cells)
    {
        Console.WriteLine($"    Cell ({cell.RowIndex}, {cell.ColumnIndex}) has kind '{cell.Kind}' and content: '{cell.Content}'.");
    }
}

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle de document général.

Utiliser le modèle fiscal W-2

using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;

//use your `key` and `endpoint` environment variables to create your `AzureKeyCredential` and `DocumentAnalysisClient` instances
string key = Environment.GetEnvironmentVariable("DI_KEY");
string endpoint = Environment.GetEnvironmentVariable("DI_ENDPOINT");
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentAnalysisClient client = new DocumentAnalysisClient(new Uri(endpoint), credential);

// sample document document
Uri w2Uri = new Uri("https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/w2.png");

AnalyzeDocumentOperation operation = await client.AnalyzeDocumentFromUriAsync(WaitUntil.Completed, "prebuilt-tax.us.w2", w2Uri);

AnalyzeResult result = operation.Value;

for (int i = 0; i < result.Documents.Count; i++)
{
    Console.WriteLine($"Document {i}:");

    AnalyzedDocument document = result.Documents[i];

    if (document.Fields.TryGetValue("AdditionalInfo", out DocumentField? additionalInfoField))
    {
        if (additionalInfoField.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField infoField in additionalInfoField.Value.AsList())
            {
                Console.WriteLine("AdditionalInfo:");

                if (infoField.FieldType == DocumentFieldType.Dictionary)
                {
                    IReadOnlyDictionary<string, DocumentField> infoFields = infoField.Value.AsDictionary();

                    if (infoFields.TryGetValue("Amount", out DocumentField? amountField))
                    {
                        if (amountField.FieldType == DocumentFieldType.Double)
                        {
                            double amount = amountField.Value.AsDouble();

                            Console.WriteLine($"  Amount: '{amount}', with confidence {amountField.Confidence}");
                        }
                    }

                    if (infoFields.TryGetValue("LetterCode", out DocumentField? letterCodeField))
                    {
                        if (letterCodeField.FieldType == DocumentFieldType.String)
                        {
                            string letterCode = letterCodeField.Value.AsString();

                            Console.WriteLine($"  LetterCode: '{letterCode}', with confidence {letterCodeField.Confidence}");
                        }
                    }
                }
            }
        }
    }


    if (document.Fields.TryGetValue("AllocatedTips", out DocumentField? allocatedTipsField))
    {
        if (allocatedTipsField.FieldType == DocumentFieldType.Double)
        {
            double allocatedTips = allocatedTipsField.Value.AsDouble();
            Console.WriteLine($"Allocated Tips: '{allocatedTips}', with confidence {allocatedTipsField.Confidence}");
        }
    }

    if (document.Fields.TryGetValue("Employer", out DocumentField? employerField))
    {
        if (employerField.FieldType == DocumentFieldType.Dictionary)
        {
            IReadOnlyDictionary<string, DocumentField> employerFields = employerField.Value.AsDictionary();

            if (employerFields.TryGetValue("Name", out DocumentField? employerNameField))
            {
                if (employerNameField.FieldType == DocumentFieldType.String)
                {
                    string name = employerNameField.Value.AsString();

                    Console.WriteLine($"Employer Name: '{name}', with confidence {employerNameField.Confidence}");
                }
            }

            if (employerFields.TryGetValue("IdNumber", out DocumentField? idNumberField))
            {
                if (idNumberField.FieldType == DocumentFieldType.String)
                {
                    string id = idNumberField.Value.AsString();

                    Console.WriteLine($"Employer ID Number: '{id}', with confidence {idNumberField.Confidence}");
                }
            }

            if (employerFields.TryGetValue("Address", out DocumentField? addressField))
            {
                if (addressField.FieldType == DocumentFieldType.Address)
                {
                    Console.WriteLine($"Employer Address: '{addressField.Content}', with confidence {addressField.Confidence}");
                }
            }
        }
    }
}

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle fiscal W-2.

Utiliser le modèle de facture

using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;

//use your `key` and `endpoint` environment variables to create your `AzureKeyCredential` and `DocumentAnalysisClient` instances
string key = Environment.GetEnvironmentVariable("DI_KEY");
string endpoint = Environment.GetEnvironmentVariable("DI_ENDPOINT");
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentAnalysisClient client = new DocumentAnalysisClient(new Uri(endpoint), credential);

// sample document document
Uri invoiceUri = new Uri("https://github.com/Azure-Samples/cognitive-services-REST-api-samples/raw/master/curl/form-recognizer/rest-api/invoice.pdf");

AnalyzeDocumentOperation operation = await client.AnalyzeDocumentFromUriAsync(WaitUntil.Completed, "prebuilt-invoice", invoiceUri);

AnalyzeResult result = operation.Value;

for (int i = 0; i < result.Documents.Count; i++)
{
    Console.WriteLine($"Document {i}:");

    AnalyzedDocument document = result.Documents[i];

    if (document.Fields.TryGetValue("VendorName", out DocumentField vendorNameField))
    {
        if (vendorNameField.FieldType == DocumentFieldType.String)
        {
            string vendorName = vendorNameField.Value.AsString();
            Console.WriteLine($"Vendor Name: '{vendorName}', with confidence {vendorNameField.Confidence}");
        }
    }

    if (document.Fields.TryGetValue("CustomerName", out DocumentField customerNameField))
    {
        if (customerNameField.FieldType == DocumentFieldType.String)
        {
            string customerName = customerNameField.Value.AsString();
            Console.WriteLine($"Customer Name: '{customerName}', with confidence {customerNameField.Confidence}");
        }
    }

    if (document.Fields.TryGetValue("Items", out DocumentField itemsField))
    {
        if (itemsField.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField itemField in itemsField.Value.AsList())
            {
                Console.WriteLine("Item:");

                if (itemField.FieldType == DocumentFieldType.Dictionary)
                {
                    IReadOnlyDictionary<string, DocumentField> itemFields = itemField.Value.AsDictionary();

                    if (itemFields.TryGetValue("Description", out DocumentField itemDescriptionField))
                    {
                        if (itemDescriptionField.FieldType == DocumentFieldType.String)
                        {
                            string itemDescription = itemDescriptionField.Value.AsString();

                            Console.WriteLine($"  Description: '{itemDescription}', with confidence {itemDescriptionField.Confidence}");
                        }
                    }

                    if (itemFields.TryGetValue("Amount", out DocumentField itemAmountField))
                    {
                        if (itemAmountField.FieldType == DocumentFieldType.Currency)
                        {
                            CurrencyValue itemAmount = itemAmountField.Value.AsCurrency();

                            Console.WriteLine($"  Amount: '{itemAmount.Symbol}{itemAmount.Amount}', with confidence {itemAmountField.Confidence}");
                        }
                    }
                }
            }
        }
    }

    if (document.Fields.TryGetValue("SubTotal", out DocumentField subTotalField))
    {
        if (subTotalField.FieldType == DocumentFieldType.Currency)
        {
            CurrencyValue subTotal = subTotalField.Value.AsCurrency();
            Console.WriteLine($"Sub Total: '{subTotal.Symbol}{subTotal.Amount}', with confidence {subTotalField.Confidence}");
        }
    }

    if (document.Fields.TryGetValue("TotalTax", out DocumentField totalTaxField))
    {
        if (totalTaxField.FieldType == DocumentFieldType.Currency)
        {
            CurrencyValue totalTax = totalTaxField.Value.AsCurrency();
            Console.WriteLine($"Total Tax: '{totalTax.Symbol}{totalTax.Amount}', with confidence {totalTaxField.Confidence}");
        }
    }

    if (document.Fields.TryGetValue("InvoiceTotal", out DocumentField invoiceTotalField))
    {
        if (invoiceTotalField.FieldType == DocumentFieldType.Currency)
        {
            CurrencyValue invoiceTotal = invoiceTotalField.Value.AsCurrency();
            Console.WriteLine($"Invoice Total: '{invoiceTotal.Symbol}{invoiceTotal.Amount}', with confidence {invoiceTotalField.Confidence}");
        }
    }
}

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle de facture.

Utiliser le modèle de reçu

using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;

//use your `key` and `endpoint` environment variables to create your `AzureKeyCredential` and `DocumentAnalysisClient` instances
string key = Environment.GetEnvironmentVariable("DI_KEY");
string endpoint = Environment.GetEnvironmentVariable("DI_ENDPOINT");
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentAnalysisClient client = new DocumentAnalysisClient(new Uri(endpoint), credential);

// sample document document
Uri receiptUri = new Uri("https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/receipt.png");

AnalyzeDocumentOperation operation = await client.AnalyzeDocumentFromUriAsync(WaitUntil.Completed, "prebuilt-receipt", receiptUri);

AnalyzeResult receipts = operation.Value;

foreach (AnalyzedDocument receipt in receipts.Documents)
{
    if (receipt.Fields.TryGetValue("MerchantName", out DocumentField merchantNameField))
    {
        if (merchantNameField.FieldType == DocumentFieldType.String)
        {
            string merchantName = merchantNameField.Value.AsString();

            Console.WriteLine($"Merchant Name: '{merchantName}', with confidence {merchantNameField.Confidence}");
        }
    }

    if (receipt.Fields.TryGetValue("TransactionDate", out DocumentField transactionDateField))
    {
        if (transactionDateField.FieldType == DocumentFieldType.Date)
        {
            DateTimeOffset transactionDate = transactionDateField.Value.AsDate();

            Console.WriteLine($"Transaction Date: '{transactionDate}', with confidence {transactionDateField.Confidence}");
        }
    }

    if (receipt.Fields.TryGetValue("Items", out DocumentField itemsField))
    {
        if (itemsField.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField itemField in itemsField.Value.AsList())
            {
                Console.WriteLine("Item:");

                if (itemField.FieldType == DocumentFieldType.Dictionary)
                {
                    IReadOnlyDictionary<string, DocumentField> itemFields = itemField.Value.AsDictionary();

                    if (itemFields.TryGetValue("Description", out DocumentField itemDescriptionField))
                    {
                        if (itemDescriptionField.FieldType == DocumentFieldType.String)
                        {
                            string itemDescription = itemDescriptionField.Value.AsString();

                            Console.WriteLine($"  Description: '{itemDescription}', with confidence {itemDescriptionField.Confidence}");
                        }
                    }

                    if (itemFields.TryGetValue("TotalPrice", out DocumentField itemTotalPriceField))
                    {
                        if (itemTotalPriceField.FieldType == DocumentFieldType.Double)
                        {
                            double itemTotalPrice = itemTotalPriceField.Value.AsDouble();

                            Console.WriteLine($"  Total Price: '{itemTotalPrice}', with confidence {itemTotalPriceField.Confidence}");
                        }
                    }
                }
            }
        }
    }

    if (receipt.Fields.TryGetValue("Total", out DocumentField totalField))
    {
        if (totalField.FieldType == DocumentFieldType.Double)
        {
            double total = totalField.Value.AsDouble();

            Console.WriteLine($"Total: '{total}', with confidence '{totalField.Confidence}'");
        }
    }
}

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle de reçu.

Modèle de pièce d’identité

using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;

//use your `key` and `endpoint` environment variables to create your `AzureKeyCredential` and `DocumentAnalysisClient` instances
string key = Environment.GetEnvironmentVariable("DI_KEY");
string endpoint = Environment.GetEnvironmentVariable("DI_ENDPOINT");
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentAnalysisClient client = new DocumentAnalysisClient(new Uri(endpoint), credential);

// sample document document

Uri idDocumentUri = new Uri("https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/identity_documents.png");

AnalyzeDocumentOperation operation = await client.AnalyzeDocumentFromUriAsync(WaitUntil.Completed, "prebuilt-idDocument", idDocumentUri);

AnalyzeResult identityDocuments = operation.Value;

AnalyzedDocument identityDocument = identityDocuments.Documents.Single();

if (identityDocument.Fields.TryGetValue("Address", out DocumentField addressField))
{
    if (addressField.FieldType == DocumentFieldType.String)
    {
        string address = addressField.Value. AsString();
        Console.WriteLine($"Address: '{address}', with confidence {addressField.Confidence}");
    }
}

if (identityDocument.Fields.TryGetValue("CountryRegion", out DocumentField countryRegionField))
{
    if (countryRegionField.FieldType == DocumentFieldType.CountryRegion)
    {
        string countryRegion = countryRegionField.Value.AsCountryRegion();
        Console.WriteLine($"CountryRegion: '{countryRegion}', with confidence {countryRegionField.Confidence}");
    }
}

if (identityDocument.Fields.TryGetValue("DateOfBirth", out DocumentField dateOfBirthField))
{
    if (dateOfBirthField.FieldType == DocumentFieldType.Date)
    {
        DateTimeOffset dateOfBirth = dateOfBirthField.Value.AsDate();
        Console.WriteLine($"Date Of Birth: '{dateOfBirth}', with confidence {dateOfBirthField.Confidence}");
    }
}

if (identityDocument.Fields.TryGetValue("DateOfExpiration", out DocumentField dateOfExpirationField))
{
    if (dateOfExpirationField.FieldType == DocumentFieldType.Date)
    {
        DateTimeOffset dateOfExpiration = dateOfExpirationField.Value.AsDate();
        Console.WriteLine($"Date Of Expiration: '{dateOfExpiration}', with confidence {dateOfExpirationField.Confidence}");
    }
}

if (identityDocument.Fields.TryGetValue("DocumentNumber", out DocumentField documentNumberField))
{
    if (documentNumberField.FieldType == DocumentFieldType.String)
    {
        string documentNumber = documentNumberField.Value.AsString();
        Console.WriteLine($"Document Number: '{documentNumber}', with confidence {documentNumberField.Confidence}");
    }
}

if (identityDocument.Fields.TryGetValue("FirstName", out DocumentField firstNameField))
{
    if (firstNameField.FieldType == DocumentFieldType.String)
    {
        string firstName = firstNameField.Value.AsString();
        Console.WriteLine($"First Name: '{firstName}', with confidence {firstNameField.Confidence}");
    }
}

if (identityDocument.Fields.TryGetValue("LastName", out DocumentField lastNameField))
{
    if (lastNameField.FieldType == DocumentFieldType.String)
    {
        string lastName = lastNameField.Value.AsString();
        Console.WriteLine($"Last Name: '{lastName}', with confidence {lastNameField.Confidence}");
    }
}

if (identityDocument.Fields.TryGetValue("Region", out DocumentField regionfield))
{
    if (regionfield.FieldType == DocumentFieldType.String)
    {
        string region = regionfield.Value.AsString();
        Console.WriteLine($"Region: '{region}', with confidence {regionfield.Confidence}");
    }
}

if (identityDocument.Fields.TryGetValue("Sex", out DocumentField sexfield))
{
    if (sexfield.FieldType == DocumentFieldType.String)
    {
        string sex = sexfield.Value.AsString();
        Console.WriteLine($"Sex: '{sex}', with confidence {sexfield.Confidence}");
    }
}

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle de document d’identité.

Utiliser le modèle de carte de visite

using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;

//use your `key` and `endpoint` environment variables to create your `AzureKeyCredential` and `DocumentAnalysisClient` instances
string key = Environment.GetEnvironmentVariable("DI_KEY");
string endpoint = Environment.GetEnvironmentVariable("DI_ENDPOINT");
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentAnalysisClient client = new DocumentAnalysisClient(new Uri(endpoint), credential);

// sample document document
Uri businessCardUri = new Uri("https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/business-card-english.jpg");

AnalyzeDocumentOperation operation = await client.AnalyzeDocumentFromUriAsync(WaitUntil.Completed, "prebuilt-businessCard", businessCardUri);

AnalyzeResult businessCards = operation.Value;

foreach (AnalyzedDocument businessCard in businessCards.Documents)
{
    if (businessCard.Fields.TryGetValue("ContactNames", out DocumentField ContactNamesField))
    {
        if (ContactNamesField.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField contactNameField in ContactNamesField.Value.AsList())
            {
                Console.WriteLine("Contact Name: ");

                if (contactNameField.FieldType == DocumentFieldType.Dictionary)
                {
                    IReadOnlyDictionary<string, DocumentField> contactNameFields = contactNameField.Value.AsDictionary();

                    if (contactNameFields.TryGetValue("FirstName", out DocumentField firstNameField))
                    {
                        if (firstNameField.FieldType == DocumentFieldType.String)
                        {
                            string firstName = firstNameField.Value.AsString();

                            Console.WriteLine($"  First Name: '{firstName}', with confidence {firstNameField.Confidence}");
                        }
                    }

                    if (contactNameFields.TryGetValue("LastName", out DocumentField lastNameField))
                    {
                        if (lastNameField.FieldType == DocumentFieldType.String)
                        {
                            string lastName = lastNameField.Value.AsString();

                            Console.WriteLine($"  Last Name: '{lastName}', with confidence {lastNameField.Confidence}");
                        }
                    }
                }
            }
        }
    }

    if (businessCard.Fields.TryGetValue("JobTitles", out DocumentField jobTitlesFields))
    {
        if (jobTitlesFields.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField jobTitleField in jobTitlesFields.Value.AsList())
            {
                if (jobTitleField.FieldType == DocumentFieldType.String)
                {
                    string jobTitle = jobTitleField.Value.AsString();

                    Console.WriteLine($"Job Title: '{jobTitle}', with confidence {jobTitleField.Confidence}");
                }
            }
        }
    }

    if (businessCard.Fields.TryGetValue("Departments", out DocumentField departmentFields))
    {
        if (departmentFields.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField departmentField in departmentFields.Value.AsList())
            {
                if (departmentField.FieldType == DocumentFieldType.String)
                {
                    string department = departmentField.Value.AsString();

                    Console.WriteLine($"Department: '{department}', with confidence {departmentField.Confidence}");
                }
            }
        }
    }

    if (businessCard.Fields.TryGetValue("Emails", out DocumentField emailFields))
    {
        if (emailFields.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField emailField in emailFields.Value.AsList())
            {
                if (emailField.FieldType == DocumentFieldType.String)
                {
                    string email = emailField.Value.AsString();

                    Console.WriteLine($"Email: '{email}', with confidence {emailField.Confidence}");
                }
            }
        }
    }

    if (businessCard.Fields.TryGetValue("Websites", out DocumentField websiteFields))
    {
        if (websiteFields.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField websiteField in websiteFields.Value.AsList())
            {
                if (websiteField.FieldType == DocumentFieldType.String)
                {
                    string website = websiteField.Value.AsString();

                    Console.WriteLine($"Website: '{website}', with confidence {websiteField.Confidence}");
                }
            }
        }
    }

    if (businessCard.Fields.TryGetValue("MobilePhones", out DocumentField mobilePhonesFields))
    {
        if (mobilePhonesFields.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField mobilePhoneField in mobilePhonesFields.Value.AsList())
            {
                if (mobilePhoneField.FieldType == DocumentFieldType.PhoneNumber)
                {
                    string mobilePhone = mobilePhoneField.Value.AsPhoneNumber();

                    Console.WriteLine($"Mobile phone number: '{mobilePhone}', with confidence {mobilePhoneField.Confidence}");
                }
            }
        }
    }

    if (businessCard.Fields.TryGetValue("WorkPhones", out DocumentField workPhonesFields))
    {
        if (workPhonesFields.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField workPhoneField in workPhonesFields.Value.AsList())
            {
                if (workPhoneField.FieldType == DocumentFieldType.PhoneNumber)
                {
                    string workPhone = workPhoneField.Value.AsPhoneNumber();

                    Console.WriteLine($"Work phone number: '{workPhone}', with confidence {workPhoneField.Confidence}");
                }
            }
        }
    }

    if (businessCard.Fields.TryGetValue("Faxes", out DocumentField faxesFields))
    {
        if (faxesFields.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField faxField in faxesFields.Value.AsList())
            {
                if (faxField.FieldType == DocumentFieldType.PhoneNumber)
                {
                    string fax = faxField.Value.AsPhoneNumber();

                    Console.WriteLine($"Fax phone number: '{fax}', with confidence {faxField.Confidence}");
                }
            }
        }
    }

    if (businessCard.Fields.TryGetValue("Addresses", out DocumentField addressesFields))
    {
        if (addressesFields.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField addressField in addressesFields.Value.AsList())
            {
                if (addressField.FieldType == DocumentFieldType.String)
                {
                    string address = addressField.Value.AsString();

                    Console.WriteLine($"Address: '{address}', with confidence {addressField.Confidence}");
                }
            }
        }
    }

    if (businessCard.Fields.TryGetValue("CompanyNames", out DocumentField companyNamesFields))
    {
        if (companyNamesFields.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField companyNameField in companyNamesFields.Value.AsList())
            {
                if (companyNameField.FieldType == DocumentFieldType.String)
                {
                    string companyName = companyNameField.Value.AsString();

                    Console.WriteLine($"Company name: '{companyName}', with confidence {companyNameField.Confidence}");
                }
            }
        }
    }
}

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle de carte de visite.

Bibliothèque de client | Informations de référence sur le SDK | Informations de référence sur l’API REST | Package (Maven) | Exemples |Version de l’API REST prise en charge

Prérequis

• Un abonnement Azure : créez-en un gratuitement.

• Dernière version de Visual Studio Code ou de votre IDE préféré. Consultez Java dans Visual Studio Code.

  • Visual Studio Code offre un pack de programmation pour Java pour Windows et macOS. Le pack de programmation est une offre groupée comprenant VS Code, le JDK (Java Development Kit) et une collection d’extensions suggérées par Microsoft. Le Pack de programmation peut également être utilisé pour corriger un environnement de développement existant.
  • Si vous utilisez VS Code et le pack de programmation pour Java, installez l’extension Gradle pour Java.

  Si vous n’utilisez pas Visual Studio Code, vérifiez que les éléments suivants sont installés dans votre environnement de développement :

  • Un Kit de développement Java (JDK), version 8 ou ultérieure. Pour plus d’informations, consultez Build Microsoft d’OpenJDK.
  • Gradle, version 6.8 ou ultérieure.

• Une ressource Azure AI services ou Intelligence documentaire. Créez un service unique ou un service multiple. Vous pouvez utiliser le niveau tarifaire Gratuit (F0) pour tester le service, puis passer par la suite à un niveau payant pour la production.

  Conseil

  Créez une ressource Azure AI services si vous prévoyez d’accéder à plusieurs services Azure AI en utilisant un même point de terminaison et une même clé. Pour l’accès à Document Intelligence uniquement, créez une ressource Document Intelligence. Vous avez besoin d’une ressource à service unique si vous avez l’intention d’utiliser l’authentification Microsoft Entra.

• La clé et le point de terminaison de la ressource que vous créez pour connecter votre application au service Intelligence documentaire Azure.

  1. Après le déploiement de votre ressource, sélectionnez Accéder à la ressource.
  2. Dans le menu de navigation de gauche, sélectionnez Clés et point de terminaison.
  3. Copiez une des clés et le point de terminaison pour une utilisation ultérieure dans cet article.

  

• Un fichier de document à une URL. Pour ce projet, vous pouvez utiliser les exemples de formulaires fournis dans le tableau suivant pour chaque fonctionnalité :

  Fonction	modelID	document-url
  Modèle Read	prebuilt-read	Exemple de brochure
  Modèle de disposition	prebuilt-layout	Exemple de confirmation de réservation
  Modèle de formulaire W-2	prebuilt-tax.us.w2	Exemple de formulaire W-2
  Modèle de facture	Facture prédéfinie	Exemple de facture
  Modèle de reçu	prebuilt-receipt	Exemple de ticket de caisse
  Modèle de pièce d’identité	prebuilt-idDocument	Exemple de pièce d’identité

Définir vos variables d’environnement

Pour interagir avec le service d’Intelligence documentaire, vous devez créer une instance de classe DocumentAnalysisClient. Pour ce faire, vous instanciez le client avec vos key et endpoint depuis le portail Azure. Pour ce projet, utilisez des variables d’environnement pour stocker des informations d’identification et y accéder.

Important

N’incluez pas votre clé directement dans le code et ne la publiez jamais publiquement. Pour la production, utilisez un moyen sécurisé pour stocker et accéder à vos informations d’identification, comme Azure Key Vault. Pour plus d’informations, veuillez consulter Sécurité d’Azure AI services.

Pour définir la variable d’environnement de votre clé de ressource Intelligence documentaire, ouvrez une fenêtre de console et suivez les instructions relatives à votre système d’exploitation et à votre environnement de développement. Remplacez <yourKey> et <yourEndpoint> par les valeurs de votre ressource dans le portail Azure.

Windows

Les variables d’environnement dans Windows ne respectent pas la casse. Elles sont généralement déclarées en majuscules, avec des mots joints par un trait de soulignement. Depuis une invite de commandes, exécutez les commandes suivantes :

1. Définissez votre variable de clé :

   setx DI_KEY <yourKey>
   

2. Définissez votre variable de point de terminaison

   setx DI_ENDPOINT <yourEndpoint>
   

3. Après avoir défini vos variables d’environnement, fermez la fenêtre d’invite de commandes. Les valeurs restent les mêmes jusqu’à ce que vous les modifiez à nouveau.

4. Redémarrez tous les programmes en cours d’exécution qui lisent la variable d’environnement. Par exemple, si vous utilisez Visual Studio ou Visual Studio Code comme éditeur, redémarrez-le avant d’exécuter l’échantillon de code.

Voici d’autres commandes utiles à utiliser avec les variables d’environnement :

Commande	Action	Exemple
setx VARIABLE_NAME=	Supprimez la variable d’environnement en définissant la valeur sur une chaîne vide.	setx DI_KEY=
setx VARIABLE_NAME=value	Définissez ou changez la valeur d’une variable d’environnement.	setx DI_KEY=<yourKey>
set VARIABLE_NAME	Affichez la valeur d’une variable d’environnement spécifique.	set DI_KEY
set	Affichez toutes les variables d’environnement.	set

macOS

Les variables d’environnement dans macOS respectent la casse. Par convention, le nom de la variable est déclaré en majuscules.

La commande export définit la variable et l’exporte dans l’environnement global, qui est disponible pour les autres processus. Cependant, la valeur est temporaire et dure seulement jusqu’au moment où vous fermez la session du terminal. Ouvrez votre terminal et entrez les commandes suivantes :

1. Définissez votre variable de clé :

   export key=<yourKey>
   

2. Définissez votre variable de point de terminaison :

   export endpoint=<yourEndpoint>
   

Pour définir une variable d’environnement de façon permanente, placez une commande d’exportation dans votre script de démarrage Bash ~/.bash_profile :

1. Utilisez un éditeur de texte pour ouvrir le fichier ~/.bash_profile et ajoutez la commande suivante pour créer une variable d’environnement permanente :

   export DI_KEY=<yourKey> DI_ENDPOINT=<yourEndpoint>
   

   Exemple : export DI_KEY="<yourKey>"

2. Enregistrez les modifications apportées au fichier bash_profile.

3. Pour que les modifications entrent en vigueur, exécutez la commande suivante dans la fenêtre du terminal :

   source ~/.bash-profile
   

Voici d’autres commandes utiles à utiliser avec les variables d’environnement :

Commande	Action	Exemple
unset VARIABLE_NAME	Supprimez une variable d’environnement.	unset DI_KEY
export VARIABLE_NAME=value	Définissez ou modifiez la valeur d’une variable d’environnement temporaire.	export DI_KEY=<yourKey>
printenv VARIABLE_NAME echo $VARIABLE_NAME	Affichez la valeur d’une variable d’environnement spécifique. Avec la commande echo, faites précéder la variable de $.	printenv DI_KEY echo $DI_KEY
printenv	Affichez toutes les variables d’environnement.	printenv

Linux

Les variables d’environnement dans Linux respectent la casse. Par convention, le nom de la variable est déclaré en majuscules.

La commande export définit la variable et l’exporte dans l’environnement global, qui est disponible pour les autres processus. Cependant, la valeur est temporaire et dure seulement jusqu’au moment où vous fermez la session du terminal :

1. Définissez votre variable de clé :

   export DI_KEY=<yourKey>
   

2. Définissez votre variable de point de terminaison :

   export DI_ENDPOINT=<yourEndpoint>
   

Pour définir une variable d’environnement de façon permanente, placez une commande d’exportation dans votre script de démarrage Bash ~/.bashrc :

1. Utilisez un éditeur de texte pour ouvrir le fichier ~/.bashrc et ajoutez la commande suivante pour créer une variable d’environnement permanente :

   export <VARIABLE>=<value>
   

   Exemple : export DI_KEY=<yourKey>

2. Enregistrez vos modifications apportées au fichier .bashrc.

3. Pour que les modifications entrent en vigueur, exécutez la commande suivante dans la fenêtre du terminal :

   source ~/.bashrc
   

Voici d’autres commandes utiles à utiliser avec les variables d’environnement :

Commande	Action	Exemple
unset VARIABLE_NAME	Supprimez une variable d’environnement.	unset DI_KEY=
export VARIABLE_NAME=value	Définissez ou modifiez la valeur d’une variable d’environnement temporaire.	export DI_KEY={yourKey}
printenv VARIABLE_NAME echo $VARIABLE_NAME	Affichez la valeur d’une variable d’environnement. Avec la commande echo, faites précéder la variable de $.	printenv DI_KEY echo $DI_KEY
printenv	Affichez toutes les variables d’environnement.	printenv

Configurer votre environnement de programmation

Pour configurer votre environnement de programmation, créez un projet Gradle et installez la bibliothèque de client.

Créer un projet Gradle

1. Dans une fenêtre de console, créez un répertoire pour votre application, nommez-le doc-intelligence-app, puis accédez-y.

   mkdir doc-intelligence-app
   cd doc-intelligence-app
   

2. Exécutez la commande gradle init à partir de votre répertoire de travail. Cette commande crée des fichiers de build essentiels pour Gradle, notamment build.gradle.kts, qui est utilisé au moment de l’exécution pour créer et configurer votre application.

   gradle init --type basic
   

3. Quand vous êtes invité à choisir un DSL, sélectionnez Kotlin.

4. Sélectionnez Entrée pour accepter le nom du projet par défaut (doc-intelligence-app).

Installer la bibliothèque de client

Cet article utilise le gestionnaire de dépendances Gradle. Vous trouverez la bibliothèque de client et des informations concernant d’autres gestionnaires de dépendances sur le référentiel central Maven.

1. Ouvrez le fichier build.gradle.kts du projet dans votre IDE. Copiez et collez le code suivant pour inclure la bibliothèque de client avec une instruction implementation ainsi que les plug-ins et les paramètres nécessaires.

   plugins {
      java
      application
   }
   application {
      mainClass.set("DocIntelligence")
   }
   repositories {
      mavenCentral()
   }
   dependencies {
      implementation group: 'com.azure', name: 'azure-ai-documentintelligence', version: '1.0.0-beta.2'
   
   }
   

Création d’une application Java

Pour interagir avec le service Intelligence documentaire, créez une instance de la classe DocumentIntelligenceClient. Pour ce faire, vous créez un AzureKeyCredential avec votre key depuis le portail Azure et une instance DocumentIntelligenceClient avec le AzureKeyCredential et votre endpoint d’Intelligence documentaire.

1. À partir du répertoire doc-intelligence-app, exécutez la commande suivante :

   mkdir -p src/main/java
   

La commande crée la structure de répertoires suivante :

1. Accédez au répertoire java et créez un fichier nommé DocIntelligence.java.

   Conseil

   Vous pouvez créer un nouveau fichier en utilisant PowerShell. Ouvrez une fenêtre PowerShell dans le répertoire de votre projet en maintenant la touche Maj enfoncée et en cliquant avec le bouton droit sur le dossier, puis tapez la commande suivante : New-Item DocIntelligence.java.

2. Ouvrez le fichier DocIntelligence.java, sélectionnez l’un des exemples de code suivants, puis copiez-collez l’exemple dans votre application :

   • Le modèle prebuilt-read est au cœur de tous les modèles Intelligence documentaire et peut détecter des lignes, des mots, des lieux et des langues. Les modèles prédéfinis, personnalisés, de disposition et de document général utilisent le modèle read comme base pour extraire du texte à partir de documents.
   • Le modèle prebuilt-layout extrait le texte et ses emplacements, les tableaux, les marques de sélection et les informations de structure des documents et des images.
   • Le modèle prebuilt-tax.us.w2 extrait les informations rapportées sur les formulaires fiscaux de l’Internal Revenue Service (IRS) des États-Unis.
   • Le modèle prebuilt-invoice extrait les champs clés et les éléments des lignes des factures de vente dans différents formats.
   • Le modèle prebuilt-receipt analyse et extrait les informations clés des reçus de vente imprimés et manuscrits.
   • Le modèle prebuilt-idDocument extrait les informations clés des permis de conduire américains, des pages biographiques des passeports internationaux, des cartes d’identité des États américains, des cartes de sécurité sociale et des cartes de résident permanent.

3. Tapez les commandes suivantes :

   gradle build
   gradle run
   

Utiliser le modèle Lecture

import com.azure.ai.documentintelligence;

import com.azure.ai.documentintelligence.models.AnalyzeDocumentRequest;
import com.azure.ai.documentintelligence.models.AnalyzeResult;
import com.azure.ai.documentintelligence.models.AnalyzeResultOperation;
import com.azure.ai.documentintelligence.models.Document;
import com.azure.ai.documentintelligence.models.DocumentField;
import com.azure.ai.documentintelligence.models.DocumentFieldType;
import com.azure.core.credential.AzureKeyCredential;
import com.azure.core.util.polling.SyncPoller;

import java.io.IOException;
import java.time.LocalDate;
import java.util.List;
import java.util.Map;


public class DocIntelligence {

  //use your `key` and `endpoint` environment variables
  private static final String key = System.getenv("FR_KEY");
  private static final String endpoint = System.getenv("FR_ENDPOINT");

  public static void main(final String[] args) {

      // create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
      DocumentIntelligenceClient client = new DocumentIntelligenceClientBuilder()
        .credential(new AzureKeyCredential(key))
        .endpoint(endpoint)
        .buildClient();

//sample document
String documentUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/read.png";

String modelId = "prebuilt-read";

SyncPoller < OperationResult, AnalyzeResult > analyzeLayoutResultPoller =
  client.beginAnalyzeDocument(modelId, invoiceUrl);;

AnalyzeResult analyzeLayoutResult = analyzeLayoutResultPoller.getFinalResult().getAnalyzeResult();

// pages
analyzeLayoutResult.getPages().forEach(documentPage -> {
  System.out.printf("Page has width: %.2f and height: %.2f, measured with unit: %s%n",
    documentPage.getWidth(),
    documentPage.getHeight(),
    documentPage.getUnit());

  // lines
  documentPage.getLines().forEach(documentLine ->
    System.out.printf("Line %s is within a bounding polygon %s.%n",
      documentLine.getContent(),
      documentLine.getBoundingPolygon().toString()));

  // words
  documentPage.getWords().forEach(documentWord ->
    System.out.printf("Word '%s' has a confidence score of %.2f.%n",
      documentWord.getContent(),
      documentWord.getConfidence()));
});
}
}

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle read.

Utiliser le modèle de disposition

import com.azure.ai.documentintelligence;

import com.azure.ai.documentintelligence.models.AnalyzeDocumentRequest;
import com.azure.ai.documentintelligence.models.AnalyzeResult;
import com.azure.ai.documentintelligence.models.AnalyzeResultOperation;
import com.azure.ai.documentintelligence.models.Document;
import com.azure.ai.documentintelligence.models.DocumentField;
import com.azure.ai.documentintelligence.models.DocumentFieldType;
import com.azure.core.credential.AzureKeyCredential;
import com.azure.core.util.polling.SyncPoller;

import java.io.IOException;
import java.time.LocalDate;
import java.util.List;
import java.util.Map;

public class DocIntelligence {
  //use your `key` and `endpoint` environment variables
  private static final String key = System.getenv("FR_KEY");
  private static final String endpoint = System.getenv("FR_ENDPOINT");

  public static void main(final String[] args) {

      // create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
      DocumentIntelligenceClient client = new DocumentIntelligenceClientBuilder()
        .credential(new AzureKeyCredential(key))
        .endpoint(endpoint)
        .buildClient();

//sample document
String layoutDocumentUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/layout.png";
String modelId = "prebuilt-layout";

SyncPoller < OperationResult, AnalyzeResult > analyzeLayoutResultPoller =
  client.beginAnalyzeDocument(modelId, layoutDocumentUrl);

AnalyzeResult analyzeLayoutResult = analyzeLayoutResultPoller.getFinalResult().getAnalyzeResult();

// pages
analyzeLayoutResult.getPages().forEach(documentPage -> {
  System.out.printf("Page has width: %.2f and height: %.2f, measured with unit: %s%n",
    documentPage.getWidth(),
    documentPage.getHeight(),
    documentPage.getUnit());

  // lines
  documentPage.getLines().forEach(documentLine ->
    System.out.printf("Line %s is within a bounding polygon %s.%n",
      documentLine.getContent(),
      documentLine.getBoundingPolygon().toString()));

  // words
  documentPage.getWords().forEach(documentWord ->
    System.out.printf("Word '%s' has a confidence score of %.2f%n",
      documentWord.getContent(),
      documentWord.getConfidence()));

  // selection marks
  documentPage.getSelectionMarks().forEach(documentSelectionMark ->
    System.out.printf("Selection mark is '%s' and is within a bounding polygon %s with confidence %.2f.%n",
      documentSelectionMark.getSelectionMarkState().toString(),
      getBoundingCoordinates(documentSelectionMark.getBoundingPolygon()),
      documentSelectionMark.getConfidence()));
});

// tables
List < DocumentTable > tables = analyzeLayoutResult.getTables();
for (int i = 0; i < tables.size(); i++) {
  DocumentTable documentTables = tables.get(i);
  System.out.printf("Table %d has %d rows and %d columns.%n", i, documentTables.getRowCount(),
    documentTables.getColumnCount());
  documentTables.getCells().forEach(documentTableCell -> {
    System.out.printf("Cell '%s', has row index %d and column index %d.%n", documentTableCell.getContent(),
      documentTableCell.getRowIndex(), documentTableCell.getColumnIndex());
  });
  System.out.println();
}

}

// Utility function to get the bounding polygon coordinates.
private static String getBoundingCoordinates(List < Point > boundingPolygon) {
  return boundingPolygon.stream().map(point -> String.format("[%.2f, %.2f]", point.getX(),
    point.getY())).collect(Collectors.joining(", "));
}

}

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle de disposition.

Utiliser le modèle Document général

import com.azure.ai.documentintelligence;

import com.azure.ai.documentintelligence.models.AnalyzeDocumentRequest;
import com.azure.ai.documentintelligence.models.AnalyzeResult;
import com.azure.ai.documentintelligence.models.AnalyzeResultOperation;
import com.azure.ai.documentintelligence.models.Document;
import com.azure.ai.documentintelligence.models.DocumentField;
import com.azure.ai.documentintelligence.models.DocumentFieldType;
import com.azure.core.credential.AzureKeyCredential;
import com.azure.core.util.polling.SyncPoller;

import java.io.IOException;
import java.time.LocalDate;
import java.util.List;
import java.util.Map;

public class DocIntelligence {
  //use your `key` and `endpoint` environment variables
  private static final String key = System.getenv("FR_KEY");
  private static final String endpoint = System.getenv("FR_ENDPOINT");

  public static void main(final String[] args) {

      // create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
      DocumentIntelligenceClient client = new DocumentIntelligenceClientBuilder()
        .credential(new AzureKeyCredential(key))
        .endpoint(endpoint)
        .buildClient();

//sample document
String generalDocumentUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/sample-layout.pdf";
String modelId = "prebuilt-document";
SyncPoller < OperationResult, AnalyzeResult > analyzeDocumentPoller =
  client.beginAnalyzeDocument(modelId, generalDocumentUrl);

AnalyzeResult analyzeResult = analyzeDocumentPoller.getFinalResult().getAnalyzeResult();;

// pages
analyzeResult.getPages().forEach(documentPage -> {
  System.out.printf("Page has width: %.2f and height: %.2f, measured with unit: %s%n",
    documentPage.getWidth(),
    documentPage.getHeight(),
    documentPage.getUnit());

  // lines
  documentPage.getLines().forEach(documentLine ->
    System.out.printf("Line %s is within a bounding polygon %s.%n",
      documentLine.getContent(),
      documentLine.getBoundingPolygon().toString()));

  // words
  documentPage.getWords().forEach(documentWord ->
    System.out.printf("Word %s has a confidence score of %.2f%n.",
      documentWord.getContent(),
      documentWord.getConfidence()));
});

// tables
List < DocumentTable > tab_les = analyzeResult.getTables();
for (int i = 0; i < tab_les.size(); i++) {
  DocumentTable documentTable = tab_les.get(i);
  System.out.printf("Table %d has %d rows and %d columns.%n", i, documentTable.getRowCount(),
    documentTable.getColumnCount());
  documentTable.getCells().forEach(documentTableCell -> {
    System.out.printf("Cell '%s', has row index %d and column index %d.%n",
      documentTableCell.getContent(),
      documentTableCell.getRowIndex(), documentTableCell.getColumnIndex());
  });
  System.out.println();
}

// Key-value pairs
analyzeResult.getKeyValuePairs().forEach(documentKeyValuePair -> {
  System.out.printf("Key content: %s%n", documentKeyValuePair.getKey().getContent());
  System.out.printf("Key content bounding region: %s%n",
    documentKeyValuePair.getKey().getBoundingRegions().toString());

  if (documentKeyValuePair.getValue() != null) {
    System.out.printf("Value content: %s%n", documentKeyValuePair.getValue().getContent());
    System.out.printf("Value content bounding region: %s%n", documentKeyValuePair.getValue().getBoundingRegions().toString());
  }
});

}

}

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle de document général.

Utiliser le modèle fiscal W-2

import com.azure.ai.documentintelligence;

import com.azure.ai.documentintelligence.models.AnalyzeDocumentRequest;
import com.azure.ai.documentintelligence.models.AnalyzeResult;
import com.azure.ai.documentintelligence.models.AnalyzeResultOperation;
import com.azure.ai.documentintelligence.models.Document;
import com.azure.ai.documentintelligence.models.DocumentField;
import com.azure.ai.documentintelligence.models.DocumentFieldType;
import com.azure.core.credential.AzureKeyCredential;
import com.azure.core.util.polling.SyncPoller;

import java.io.IOException;
import java.time.LocalDate;
import java.util.List;
import java.util.Map;

public class DocIntelligence {
  //use your `key` and `endpoint` environment variables
  private static final String key = System.getenv("FR_KEY");
  private static final String endpoint = System.getenv("FR_ENDPOINT");

  public static void main(final String[] args) {

      // create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
      DocumentIntelligenceClient client = new DocumentIntelligenceClientBuilder()
        .credential(new AzureKeyCredential(key))
        .endpoint(endpoint)
        .buildClient();

// sample document
String w2Url = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/w2.png";
String modelId = "prebuilt-tax.us.w2";

SyncPoller < OperationResult, AnalyzeResult > analyzeW2Poller =
  client.beginAnalyzeDocument(modelId, w2Url);

AnalyzeResult analyzeTaxResult = analyzeW2Poller.getFinalResult().getAnalyzeResult();

for (int i = 0; i < analyzeTaxResult.getDocuments().size(); i++) {
  AnalyzedDocument analyzedTaxDocument = analyzeTaxResult.getDocuments().get(i);
  Map < String, DocumentField > taxFields = analyzedTaxDocument.getFields();
  System.out.printf("----------- Analyzing Document  %d -----------%n", i);
  DocumentField w2FormVariantField = taxFields.get("W2FormVariant");
  if (w2FormVariantField != null) {
    if (DocumentFieldType.STRING == w2FormVariantField.getType()) {
      String merchantName = w2FormVariantField.getValueAsString();
      System.out.printf("Form variant: %s, confidence: %.2f%n",
        merchantName, w2FormVariantField.getConfidence());
    }
  }

  DocumentField employeeField = taxFields.get("Employee");
  if (employeeField != null) {
    System.out.println("Employee Data: ");
    if (DocumentFieldType.MAP == employeeField.getType()) {
      Map < String, DocumentField > employeeDataFieldMap = employeeField.getValueAsMap();
      DocumentField employeeName = employeeDataFieldMap.get("Name");
      if (employeeName != null) {
        if (DocumentFieldType.STRING == employeeName.getType()) {
          String employeesName = employeeName.getValueAsString();
          System.out.printf("Employee Name: %s, confidence: %.2f%n",
            employeesName, employeeName.getConfidence());
        }
      }
      DocumentField employeeAddrField = employeeDataFieldMap.get("Address");
      if (employeeAddrField != null) {
        if (DocumentFieldType.STRING == employeeAddrField.getType()) {
          String employeeAddress = employeeAddrField.getValueAsString();
          System.out.printf("Employee Address: %s, confidence: %.2f%n",
            employeeAddress, employeeAddrField.getConfidence());
        }
      }
    }
  }

  DocumentField employerField = taxFields.get("Employer");
  if (employerField != null) {
    System.out.println("Employer Data: ");
    if (DocumentFieldType.MAP == employerField.getType()) {
      Map < String, DocumentField > employerDataFieldMap = employerField.getValueAsMap();
      DocumentField employerNameField = employerDataFieldMap.get("Name");
      if (employerNameField != null) {
        if (DocumentFieldType.STRING == employerNameField.getType()) {
          String employerName = employerNameField.getValueAsString();
          System.out.printf("Employer Name: %s, confidence: %.2f%n",
            employerName, employerNameField.getConfidence());
        }
      }

      DocumentField employerIDNumberField = employerDataFieldMap.get("IdNumber");
      if (employerIDNumberField != null) {
        if (DocumentFieldType.STRING == employerIDNumberField.getType()) {
          String employerIdNumber = employerIDNumberField.getValueAsString();
          System.out.printf("Employee ID Number: %s, confidence: %.2f%n",
            employerIdNumber, employerIDNumberField.getConfidence());
        }
      }
    }
  }

  DocumentField taxYearField = taxFields.get("TaxYear");
  if (taxYearField != null) {
    if (DocumentFieldType.STRING == taxYearField.getType()) {
      String taxYear = taxYearField.getValueAsString();
      System.out.printf("Tax year: %s, confidence: %.2f%n",
        taxYear, taxYearField.getConfidence());
    }
  }

  DocumentField taxDateField = taxFields.get("TaxDate");
  if (taxDateField != null) {
    if (DocumentFieldType.DATE == taxDateField.getType()) {
      LocalDate taxDate = taxDateField.getValueAsDate();
      System.out.printf("Tax Date: %s, confidence: %.2f%n",
        taxDate, taxDateField.getConfidence());
    }
  }

  DocumentField socialSecurityTaxField = taxFields.get("SocialSecurityTaxWithheld");
  if (socialSecurityTaxField != null) {
    if (DocumentFieldType.DOUBLE == socialSecurityTaxField.getType()) {
      Double socialSecurityTax = socialSecurityTaxField.getValueAsDouble();
      System.out.printf("Social Security Tax withheld: %.2f, confidence: %.2f%n",
        socialSecurityTax, socialSecurityTaxField.getConfidence());
    }
  }
}
}
}

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle fiscal W-2.

Utiliser le modèle de facture

import com.azure.ai.documentintelligence;

import com.azure.ai.documentintelligence.models.AnalyzeDocumentRequest;
import com.azure.ai.documentintelligence.models.AnalyzeResult;
import com.azure.ai.documentintelligence.models.AnalyzeResultOperation;
import com.azure.ai.documentintelligence.models.Document;
import com.azure.ai.documentintelligence.models.DocumentField;
import com.azure.ai.documentintelligence.models.DocumentFieldType;
import com.azure.core.credential.AzureKeyCredential;
import com.azure.core.util.polling.SyncPoller;

import java.io.IOException;
import java.time.LocalDate;
import java.util.List;
import java.util.Map;

public class DocIntelligence {
  //use your `key` and `endpoint` environment variables
  private static final String key = System.getenv("FR_KEY");
  private static final String endpoint = System.getenv("FR_ENDPOINT");

  public static void main(final String[] args) {

      // create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
      DocumentIntelligenceClient client = new DocumentIntelligenceClientBuilder()
        .credential(new AzureKeyCredential(key))
        .endpoint(endpoint)
        .buildClient();

// sample document
String invoiceUrl = "https://github.com/Azure-Samples/cognitive-services-REST-api-samples/raw/master/curl/form-recognizer/rest-api/invoice.pdf";
String modelId = "prebuilt-invoice";

SyncPoller < OperationResult, AnalyzeResult > analyzeInvoicesPoller =
  client.beginAnalyzeDocument(modelId, invoiceUrl);

AnalyzeResult analyzeInvoiceResult = analyzeInvoicesPoller.getFinalResult().getAnalyzeResult();

for (int i = 0; i < analyzeInvoiceResult.getDocuments().size(); i++) {
  AnalyzedDocument analyzedInvoice = analyzeInvoiceResult.getDocuments().get(i);
  Map < String, DocumentField > invoiceFields = analyzedInvoice.getFields();
  System.out.printf("----------- Analyzing invoice  %d -----------%n", i);
  DocumentField vendorNameField = invoiceFields.get("VendorName");
  if (vendorNameField != null) {
    if (DocumentFieldType.STRING == vendorNameField.getType()) {
      String merchantName = vendorNameField.getValueAsString();
      System.out.printf("Vendor Name: %s, confidence: %.2f%n",
        merchantName, vendorNameField.getConfidence());
    }
  }

  DocumentField vendorAddressField = invoiceFields.get("VendorAddress");
  if (vendorAddressField != null) {
    if (DocumentFieldType.STRING == vendorAddressField.getType()) {
      String merchantAddress = vendorAddressField.getValueAsString();
      System.out.printf("Vendor address: %s, confidence: %.2f%n",
        merchantAddress, vendorAddressField.getConfidence());
    }
  }

  DocumentField customerNameField = invoiceFields.get("CustomerName");
  if (customerNameField != null) {
    if (DocumentFieldType.STRING == customerNameField.getType()) {
      String merchantAddress = customerNameField.getValueAsString();
      System.out.printf("Customer Name: %s, confidence: %.2f%n",
        merchantAddress, customerNameField.getConfidence());
    }
  }

  DocumentField customerAddressRecipientField = invoiceFields.get("CustomerAddressRecipient");
  if (customerAddressRecipientField != null) {
    if (DocumentFieldType.STRING == customerAddressRecipientField.getType()) {
      String customerAddr = customerAddressRecipientField.getValueAsString();
      System.out.printf("Customer Address Recipient: %s, confidence: %.2f%n",
        customerAddr, customerAddressRecipientField.getConfidence());
    }
  }

  DocumentField invoiceIdField = invoiceFields.get("InvoiceId");
  if (invoiceIdField != null) {
    if (DocumentFieldType.STRING == invoiceIdField.getType()) {
      String invoiceId = invoiceIdField.getValueAsString();
      System.out.printf("Invoice ID: %s, confidence: %.2f%n",
        invoiceId, invoiceIdField.getConfidence());
    }
  }

  DocumentField invoiceDateField = invoiceFields.get("InvoiceDate");
  if (customerNameField != null) {
    if (DocumentFieldType.DATE == invoiceDateField.getType()) {
      LocalDate invoiceDate = invoiceDateField.getValueAsDate();
      System.out.printf("Invoice Date: %s, confidence: %.2f%n",
        invoiceDate, invoiceDateField.getConfidence());
    }
  }

  DocumentField invoiceTotalField = invoiceFields.get("InvoiceTotal");
  if (customerAddressRecipientField != null) {
    if (DocumentFieldType.DOUBLE == invoiceTotalField.getType()) {
      Double invoiceTotal = invoiceTotalField.getValueAsDouble();
      System.out.printf("Invoice Total: %.2f, confidence: %.2f%n",
        invoiceTotal, invoiceTotalField.getConfidence());
    }
  }

  DocumentField invoiceItemsField = invoiceFields.get("Items");
  if (invoiceItemsField != null) {
    System.out.printf("Invoice Items: %n");
    if (DocumentFieldType.LIST == invoiceItemsField.getType()) {
      List < DocumentField > invoiceItems = invoiceItemsField.getValueAsList();
      invoiceItems.stream()
        .filter(invoiceItem -> DocumentFieldType.MAP == invoiceItem.getType())
        .map(documentField -> documentField.getValueAsMap())
        .forEach(documentFieldMap -> documentFieldMap.forEach((key, documentField) -> {
          if ("Description".equals(key)) {
            if (DocumentFieldType.STRING == documentField.getType()) {
              String name = documentField.getValueAsString();
              System.out.printf("Description: %s, confidence: %.2fs%n",
                name, documentField.getConfidence());
            }
          }
          if ("Quantity".equals(key)) {
            if (DocumentFieldType.DOUBLE == documentField.getType()) {
              Double quantity = documentField.getValueAsDouble();
              System.out.printf("Quantity: %f, confidence: %.2f%n",
                quantity, documentField.getConfidence());
            }
          }
          if ("UnitPrice".equals(key)) {
            if (DocumentFieldType.DOUBLE == documentField.getType()) {
              Double unitPrice = documentField.getValueAsDouble();
              System.out.printf("Unit Price: %f, confidence: %.2f%n",
                unitPrice, documentField.getConfidence());
            }
          }
          if ("ProductCode".equals(key)) {
            if (DocumentFieldType.DOUBLE == documentField.getType()) {
              Double productCode = documentField.getValueAsDouble();
              System.out.printf("Product Code: %f, confidence: %.2f%n",
                productCode, documentField.getConfidence());
            }
          }
        }));
    }
  }
}
}
}

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle de facture.

Utiliser le modèle Reçu

import com.azure.ai.documentintelligence;

import com.azure.ai.documentintelligence.models.AnalyzeDocumentRequest;
import com.azure.ai.documentintelligence.models.AnalyzeResult;
import com.azure.ai.documentintelligence.models.AnalyzeResultOperation;
import com.azure.ai.documentintelligence.models.Document;
import com.azure.ai.documentintelligence.models.DocumentField;
import com.azure.ai.documentintelligence.models.DocumentFieldType;
import com.azure.core.credential.AzureKeyCredential;
import com.azure.core.util.polling.SyncPoller;

import java.io.IOException;
import java.time.LocalDate;
import java.util.List;
import java.util.Map;

public class DocIntelligence {
  //use your `key` and `endpoint` environment variables
  private static final String key = System.getenv("FR_KEY");
  private static final String endpoint = System.getenv("FR_ENDPOINT");

  public static void main(final String[] args) {

      // create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
      DocumentIntelligenceClient client = new DocumentIntelligenceClientBuilder()
        .credential(new AzureKeyCredential(key))
        .endpoint(endpoint)
        .buildClient();

String receiptUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/receipt.png";
String modelId = "prebuilt-receipt";

SyncPoller < OperationResult, AnalyzeResult > analyzeReceiptPoller =
  client.beginAnalyzeDocument(modelId, receiptUrl);

AnalyzeResult receiptResults = analyzeReceiptPoller.getFinalResult().getAnalyzeResult();

for (int i = 0; i < receiptResults.getDocuments().size(); i++) {
  AnalyzedDocument analyzedReceipt = receiptResults.getDocuments().get(i);
  Map < String, DocumentField > receiptFields = analyzedReceipt.getFields();
  System.out.printf("----------- Analyzing receipt info %d -----------%n", i);
  DocumentField merchantNameField = receiptFields.get("MerchantName");
  if (merchantNameField != null) {
    if (DocumentFieldType.STRING == merchantNameField.getType()) {
      String merchantName = merchantNameField.getValueAsString();
      System.out.printf("Merchant Name: %s, confidence: %.2f%n",
        merchantName, merchantNameField.getConfidence());
    }
  }

  DocumentField merchantPhoneNumberField = receiptFields.get("MerchantPhoneNumber");
  if (merchantPhoneNumberField != null) {
    if (DocumentFieldType.PHONE_NUMBER == merchantPhoneNumberField.getType()) {
      String merchantAddress = merchantPhoneNumberField.getValueAsPhoneNumber();
      System.out.printf("Merchant Phone number: %s, confidence: %.2f%n",
        merchantAddress, merchantPhoneNumberField.getConfidence());
    }
  }

  DocumentField merchantAddressField = receiptFields.get("MerchantAddress");
  if (merchantAddressField != null) {
    if (DocumentFieldType.STRING == merchantAddressField.getType()) {
      String merchantAddress = merchantAddressField.getValueAsString();
      System.out.printf("Merchant Address: %s, confidence: %.2f%n",
        merchantAddress, merchantAddressField.getConfidence());
    }
  }

  DocumentField transactionDateField = receiptFields.get("TransactionDate");
  if (transactionDateField != null) {
    if (DocumentFieldType.DATE == transactionDateField.getType()) {
      LocalDate transactionDate = transactionDateField.getValueAsDate();
      System.out.printf("Transaction Date: %s, confidence: %.2f%n",
        transactionDate, transactionDateField.getConfidence());
    }
  }

  DocumentField receiptItemsField = receiptFields.get("Items");
  if (receiptItemsField != null) {
    System.out.printf("Receipt Items: %n");
    if (DocumentFieldType.LIST == receiptItemsField.getType()) {
      List < DocumentField > receiptItems = receiptItemsField.getValueAsList();
      receiptItems.stream()
        .filter(receiptItem -> DocumentFieldType.MAP == receiptItem.getType())
        .map(documentField -> documentField.getValueAsMap())
        .forEach(documentFieldMap -> documentFieldMap.forEach((key, documentField) -> {
          if ("Name".equals(key)) {
            if (DocumentFieldType.STRING == documentField.getType()) {
              String name = documentField.getValueAsString();
              System.out.printf("Name: %s, confidence: %.2fs%n",
                name, documentField.getConfidence());
            }
          }
          if ("Quantity".equals(key)) {
            if (DocumentFieldType.DOUBLE == documentField.getType()) {
              Double quantity = documentField.getValueAsDouble();
              System.out.printf("Quantity: %f, confidence: %.2f%n",
                quantity, documentField.getConfidence());
            }
          }
          if ("Price".equals(key)) {
            if (DocumentFieldType.DOUBLE == documentField.getType()) {
              Double price = documentField.getValueAsDouble();
              System.out.printf("Price: %f, confidence: %.2f%n",
                price, documentField.getConfidence());
            }
          }
          if ("TotalPrice".equals(key)) {
            if (DocumentFieldType.DOUBLE == documentField.getType()) {
              Double totalPrice = documentField.getValueAsDouble();
              System.out.printf("Total Price: %f, confidence: %.2f%n",
                totalPrice, documentField.getConfidence());
            }
          }
        }));
    }
  }
}
}
}

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle de reçu.

Utiliser le modèle de pièce d’identité

import com.azure.ai.documentintelligence;

import com.azure.ai.documentintelligence.models.AnalyzeDocumentRequest;
import com.azure.ai.documentintelligence.models.AnalyzeResult;
import com.azure.ai.documentintelligence.models.AnalyzeResultOperation;
import com.azure.ai.documentintelligence.models.Document;
import com.azure.ai.documentintelligence.models.DocumentField;
import com.azure.ai.documentintelligence.models.DocumentFieldType;
import com.azure.core.credential.AzureKeyCredential;
import com.azure.core.util.polling.SyncPoller;

import java.io.IOException;
import java.time.LocalDate;
import java.util.List;
import java.util.Map;

public class DocIntelligence {
  //use your `key` and `endpoint` environment variables
  private static final String key = System.getenv("FR_KEY");
  private static final String endpoint = System.getenv("FR_ENDPOINT");

  public static void main(final String[] args) {

      // create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
      DocumentIntelligenceClient client = new DocumentIntelligenceClientBuilder()
        .credential(new AzureKeyCredential(key))
        .endpoint(endpoint)
        .buildClient();

//sample document
String licenseUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/identity_documents.png";
String modelId = "prebuilt-idDocument";

SyncPoller < OperationResult, AnalyzeResult > analyzeIdentityDocumentPoller = client.beginAnalyzeDocument(modelId, licenseUrl);

AnalyzeResult identityDocumentResults = analyzeIdentityDocumentPoller.getFinalResult().getAnalyzeResult();

for (int i = 0; i < identityDocumentResults.getDocuments().size(); i++) {
  AnalyzedDocument analyzedIDDocument = identityDocumentResults.getDocuments().get(i);
  Map < String, DocumentField > licenseFields = analyzedIDDocument.getFields();
  System.out.printf("----------- Analyzed license info for page %d -----------%n", i);
  DocumentField addressField = licenseFields.get("Address");
  if (addressField != null) {
    if (DocumentFieldType.STRING == addressField.getType()) {
      String address = addressField.getValueAsString();
      System.out.printf("Address: %s, confidence: %.2f%n",
        address, addressField.getConfidence());
    }
  }

  DocumentField countryRegionDocumentField = licenseFields.get("CountryRegion");
  if (countryRegionDocumentField != null) {
    if (DocumentFieldType.STRING == countryRegionDocumentField.getType()) {
      String countryRegion = countryRegionDocumentField.getValueAsCountry();
      System.out.printf("Country or region: %s, confidence: %.2f%n",
        countryRegion, countryRegionDocumentField.getConfidence());
    }
  }

  DocumentField dateOfBirthField = licenseFields.get("DateOfBirth");
  if (dateOfBirthField != null) {
    if (DocumentFieldType.DATE == dateOfBirthField.getType()) {
      LocalDate dateOfBirth = dateOfBirthField.getValueAsDate();
      System.out.printf("Date of Birth: %s, confidence: %.2f%n",
        dateOfBirth, dateOfBirthField.getConfidence());
    }
  }

  DocumentField dateOfExpirationField = licenseFields.get("DateOfExpiration");
  if (dateOfExpirationField != null) {
    if (DocumentFieldType.DATE == dateOfExpirationField.getType()) {
      LocalDate expirationDate = dateOfExpirationField.getValueAsDate();
      System.out.printf("Document date of expiration: %s, confidence: %.2f%n",
        expirationDate, dateOfExpirationField.getConfidence());
    }
  }

  DocumentField documentNumberField = licenseFields.get("DocumentNumber");
  if (documentNumberField != null) {
    if (DocumentFieldType.STRING == documentNumberField.getType()) {
      String documentNumber = documentNumberField.getValueAsString();
      System.out.printf("Document number: %s, confidence: %.2f%n",
        documentNumber, documentNumberField.getConfidence());
    }
  }

  DocumentField firstNameField = licenseFields.get("FirstName");
  if (firstNameField != null) {
    if (DocumentFieldType.STRING == firstNameField.getType()) {
      String firstName = firstNameField.getValueAsString();
      System.out.printf("First Name: %s, confidence: %.2f%n",
        firstName, documentNumberField.getConfidence());
    }
  }

  DocumentField lastNameField = licenseFields.get("LastName");
  if (lastNameField != null) {
    if (DocumentFieldType.STRING == lastNameField.getType()) {
      String lastName = lastNameField.getValueAsString();
      System.out.printf("Last name: %s, confidence: %.2f%n",
        lastName, lastNameField.getConfidence());
    }
  }

  DocumentField regionField = licenseFields.get("Region");
  if (regionField != null) {
    if (DocumentFieldType.STRING == regionField.getType()) {
      String region = regionField.getValueAsString();
      System.out.printf("Region: %s, confidence: %.2f%n",
        region, regionField.getConfidence());
    }
  }
}
}
}

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle de document d’identité.

Bibliothèque de client | Informations de référence sur l’API REST | Package (npm) | Exemples |Version de l’API REST prise en charge

Prérequis

• Un abonnement Azure : créez-en un gratuitement.

• Dernière version de Visual Studio Code ou de votre IDE préféré. Pour plus d’informations, consultez Node.js dans Visual Studio Code.

• La dernière version LTS de Node.js.

• Une ressource Azure AI services ou Document Intelligence. Créez un service unique ou un service multiple. Vous pouvez utiliser le niveau tarifaire Gratuit (F0) pour tester le service, puis passer par la suite à un niveau payant pour la production.

  Conseil

  Créez une ressource Azure AI services si vous prévoyez d’accéder à plusieurs services Azure AI en utilisant un même point de terminaison et une même clé. Pour l’accès à Document Intelligence uniquement, créez une ressource Document Intelligence. Vous avez besoin d’une ressource à service unique si vous avez l’intention d’utiliser l’authentification Microsoft Entra.

• La clé et le point de terminaison de la ressource que vous créez pour connecter votre application au service Intelligence documentaire Azure.

  1. Après le déploiement de votre ressource, sélectionnez Accéder à la ressource.
  2. Dans le menu de navigation de gauche, sélectionnez Clés et point de terminaison.
  3. Copiez une des clés et le point de terminaison pour une utilisation ultérieure dans cet article.

  

• Un fichier de document à une URL. Pour ce projet, vous pouvez utiliser les exemples de formulaires fournis dans le tableau suivant pour chaque fonctionnalité :

  Fonction	modelID	document-url
  Modèle Read	prebuilt-read	Exemple de brochure
  Modèle de disposition	prebuilt-layout	Exemple de confirmation de réservation
  Modèle de formulaire W-2	prebuilt-tax.us.w2	Exemple de formulaire W-2
  Modèle de facture	Facture prédéfinie	Exemple de facture
  Modèle de reçu	prebuilt-receipt	Exemple de ticket de caisse
  Modèle de pièce d’identité	prebuilt-idDocument	Exemple de pièce d’identité

Définir vos variables d’environnement

Pour interagir avec le service d’Intelligence documentaire, vous devez créer une instance de classe DocumentAnalysisClient. Pour ce faire, vous instanciez le client avec vos key et endpoint depuis le portail Azure. Pour ce projet, utilisez des variables d’environnement pour stocker des informations d’identification et y accéder.

Important

N’incluez pas votre clé directement dans le code et ne la publiez jamais publiquement. Pour la production, utilisez un moyen sécurisé pour stocker et accéder à vos informations d’identification, comme Azure Key Vault. Pour plus d’informations, veuillez consulter Sécurité d’Azure AI services.

Pour définir la variable d’environnement de votre clé de ressource Intelligence documentaire, ouvrez une fenêtre de console et suivez les instructions relatives à votre système d’exploitation et à votre environnement de développement. Remplacez <yourKey> et <yourEndpoint> par les valeurs de votre ressource dans le portail Azure.

Windows

Les variables d’environnement dans Windows ne respectent pas la casse. Elles sont généralement déclarées en majuscules, avec des mots joints par un trait de soulignement. Depuis une invite de commandes, exécutez les commandes suivantes :

1. Définissez votre variable de clé :

   setx DI_KEY <yourKey>
   

2. Définissez votre variable de point de terminaison

   setx DI_ENDPOINT <yourEndpoint>
   

3. Après avoir défini vos variables d’environnement, fermez la fenêtre d’invite de commandes. Les valeurs restent les mêmes jusqu’à ce que vous les modifiez à nouveau.

4. Redémarrez tous les programmes en cours d’exécution qui lisent la variable d’environnement. Par exemple, si vous utilisez Visual Studio ou Visual Studio Code comme éditeur, redémarrez-le avant d’exécuter l’échantillon de code.

Voici d’autres commandes utiles à utiliser avec les variables d’environnement :

Commande	Action	Exemple
setx VARIABLE_NAME=	Supprimez la variable d’environnement en définissant la valeur sur une chaîne vide.	setx DI_KEY=
setx VARIABLE_NAME=value	Définissez ou changez la valeur d’une variable d’environnement.	setx DI_KEY=<yourKey>
set VARIABLE_NAME	Affichez la valeur d’une variable d’environnement spécifique.	set DI_KEY
set	Affichez toutes les variables d’environnement.	set

macOS

Les variables d’environnement dans macOS respectent la casse. Par convention, le nom de la variable est déclaré en majuscules.

La commande export définit la variable et l’exporte dans l’environnement global, qui est disponible pour les autres processus. Cependant, la valeur est temporaire et dure seulement jusqu’au moment où vous fermez la session du terminal. Ouvrez votre terminal et entrez les commandes suivantes :

1. Définissez votre variable de clé :

   export key=<yourKey>
   

2. Définissez votre variable de point de terminaison :

   export endpoint=<yourEndpoint>
   

Pour définir une variable d’environnement de façon permanente, placez une commande d’exportation dans votre script de démarrage Bash ~/.bash_profile :

1. Utilisez un éditeur de texte pour ouvrir le fichier ~/.bash_profile et ajoutez la commande suivante pour créer une variable d’environnement permanente :

   export DI_KEY=<yourKey> DI_ENDPOINT=<yourEndpoint>
   

   Exemple : export DI_KEY="<yourKey>"

2. Enregistrez les modifications apportées au fichier bash_profile.

3. Pour que les modifications entrent en vigueur, exécutez la commande suivante dans la fenêtre du terminal :

   source ~/.bash-profile
   

Voici d’autres commandes utiles à utiliser avec les variables d’environnement :

Commande	Action	Exemple
unset VARIABLE_NAME	Supprimez une variable d’environnement.	unset DI_KEY
export VARIABLE_NAME=value	Définissez ou modifiez la valeur d’une variable d’environnement temporaire.	export DI_KEY=<yourKey>
printenv VARIABLE_NAME echo $VARIABLE_NAME	Affichez la valeur d’une variable d’environnement spécifique. Avec la commande echo, faites précéder la variable de $.	printenv DI_KEY echo $DI_KEY
printenv	Affichez toutes les variables d’environnement.	printenv

Linux

Les variables d’environnement dans Linux respectent la casse. Par convention, le nom de la variable est déclaré en majuscules.

La commande export définit la variable et l’exporte dans l’environnement global, qui est disponible pour les autres processus. Cependant, la valeur est temporaire et dure seulement jusqu’au moment où vous fermez la session du terminal :

1. Définissez votre variable de clé :

   export DI_KEY=<yourKey>
   

2. Définissez votre variable de point de terminaison :

   export DI_ENDPOINT=<yourEndpoint>
   

Pour définir une variable d’environnement de façon permanente, placez une commande d’exportation dans votre script de démarrage Bash ~/.bashrc :

1. Utilisez un éditeur de texte pour ouvrir le fichier ~/.bashrc et ajoutez la commande suivante pour créer une variable d’environnement permanente :

   export <VARIABLE>=<value>
   

   Exemple : export DI_KEY=<yourKey>

2. Enregistrez vos modifications apportées au fichier .bashrc.

3. Pour que les modifications entrent en vigueur, exécutez la commande suivante dans la fenêtre du terminal :

   source ~/.bashrc
   

Voici d’autres commandes utiles à utiliser avec les variables d’environnement :

Commande	Action	Exemple
unset VARIABLE_NAME	Supprimez une variable d’environnement.	unset DI_KEY=
export VARIABLE_NAME=value	Définissez ou modifiez la valeur d’une variable d’environnement temporaire.	export DI_KEY={yourKey}
printenv VARIABLE_NAME echo $VARIABLE_NAME	Affichez la valeur d’une variable d’environnement. Avec la commande echo, faites précéder la variable de $.	printenv DI_KEY echo $DI_KEY
printenv	Affichez toutes les variables d’environnement.	printenv

Configurer votre environnement de programmation

Créez une application Node.js Express.

1. Dans une fenêtre de console, créez un nouveau répertoire pour votre application nommée doc-intel-app et accédez-y.

   mkdir doc-intel-app
   cd doc-intel-app
   

2. Exécutez la commande npm init pour initialiser l’application et échafauder votre projet.

   npm init
   

3. Spécifiez les attributs de votre projet à l’aide des invites qui s’affichent dans le terminal.

   • Les attributs les plus importants sont le nom, le numéro de version et le point d’entrée.
   • Nous vous recommandons de conserver index.js pour le nom du point d’entrée. La description, la commande de test, le dépôt GitHub, les mots clés, l’auteur et les informations de licence sont des attributs facultatifs. Vous pouvez les ignorer pour ce projet.
   • Sélectionnez Entrée pour accepter les suggestions entre parenthèses.

   Une fois que vous avez répondu aux prompts, la commande crée un fichier package.json dans votre répertoire doc-intel-app.

4. Installez le package de la bibliothèque de client ai-document-intelligence et le package npm azure/identity :

   npm i @azure-rest/ai-document-intelligence@1.0.0-beta.2 @azure/identity
   

Le fichier package.json de votre application est mis à jour avec les dépendances.

1. Créez un fichier nommé index.js dans le répertoire de l’application.

   Conseil

   Vous pouvez créer un nouveau fichier en utilisant PowerShell. Ouvrez une fenêtre PowerShell dans le répertoire de votre projet en maintenant la touche Maj enfoncée et en cliquant avec le bouton droit sur le dossier, puis tapez la commande suivante : New-Item index.js.

Générer votre application

Pour interagir avec le service d’Intelligence documentaire, vous devez créer une instance de classe DocumentIntelligenceClient. Pour ce faire, vous créez un AzureKeyCredential avec votre clé depuis le portail Azure et une instance DocumentIntelligenceClient avec le AzureKeyCredential et votre point de terminaison Intelligence documentaire.

Ouvrez le fichier index.js dans Visual Studio Code ou votre IDE favori, sélectionnez l’un des exemples de code suivants, puis copiez-collez l’exemple dans votre application :

• Le modèle prebuilt-read est au cœur de tous les modèles Intelligence documentaire et peut détecter des lignes, des mots, des lieux et des langues. Les modèles prédéfinis, personnalisés, de disposition et de document général utilisent le modèle read comme base pour extraire du texte à partir de documents.
• Le modèle prebuilt-layout extrait le texte et ses emplacements, les tableaux, les marques de sélection et les informations de structure des documents et des images.
• Le modèle prebuilt-tax.us.w2 extrait les informations rapportées sur les formulaires fiscaux de l’Internal Revenue Service (IRS) des États-Unis.
• Le modèle prebuilt-invoice extrait les informations indiquées sur les formulaires fiscaux de l’Internal Revenue Service des États-Unis.
• Le modèle prebuilt-receipt analyse et extrait les informations clés des reçus de vente imprimés et manuscrits.
• Le modèle prebuilt-idDocument extrait les informations clés des permis de conduire américains, des pages biographiques des passeports internationaux, des cartes d’identité des États américains, des cartes de sécurité sociale et des cartes de résident permanent.

Utiliser le modèle Lecture

const { DocumentIntelligenceClient } = require("@azure-rest/ai-document-intelligence");
const  { AzureKeyCredential } = require("@azure/core-auth");

//use your `key` and `endpoint` environment variables
const key = process.env['DI_KEY'];
const endpoint = process.env['DI_ENDPOINT'];

// sample document
const documentUrlRead = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/read.png"

// helper function
function* getTextOfSpans(content, spans) {
    for (const span of spans) {
        yield content.slice(span.offset, span.offset + span.length);
    }
}

async function main() {
    // create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
    const client = DocumentIntelligence(endpoint, new AzureKeyCredential(key));
    const poller = await client.beginAnalyzeDocument("prebuilt-read", documentUrlRead);

    const {
        content,
        pages,
        languages,
        styles
    } = await poller.pollUntilDone();

    if (pages.length <= 0) {
        console.log("No pages were extracted from the document.");
    } else {
        console.log("Pages:");
        for (const page of pages) {
            console.log("- Page", page.pageNumber, `(unit: ${page.unit})`);
            console.log(`  ${page.width}x${page.height}, angle: ${page.angle}`);
            console.log(`  ${page.lines.length} lines, ${page.words.length} words`);

            if (page.lines.length > 0) {
                console.log("  Lines:");

                for (const line of page.lines) {
                    console.log(`  - "${line.content}"`);

                    // The words of the line can also be iterated independently. The words are computed based on their
                    // corresponding spans.
                    for (const word of line.words()) {
                        console.log(`    - "${word.content}"`);
                    }
                }
            }
        }
    }

    if (languages.length <= 0) {
        console.log("No language spans were extracted from the document.");
    } else {
        console.log("Languages:");
        for (const languageEntry of languages) {
            console.log(
                `- Found language: ${languageEntry.languageCode} (confidence: ${languageEntry.confidence})`
            );
            for (const text of getTextOfSpans(content, languageEntry.spans)) {
                const escapedText = text.replace(/\r?\n/g, "\\n").replace(/"/g, '\\"');
                console.log(`  - "${escapedText}"`);
            }
        }
    }

    if (styles.length <= 0) {
        console.log("No text styles were extracted from the document.");
    } else {
        console.log("Styles:");
        for (const style of styles) {
            console.log(
                `- Handwritten: ${style.isHandwritten ? "yes" : "no"} (confidence=${style.confidence})`
            );

            for (const word of getTextOfSpans(content, style.spans)) {
                console.log(`  - "${word}"`);
            }
        }
    }
}

main().catch((error) => {
    console.error("An error occurred:", error);
    process.exit(1);
});

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle read.

Utiliser le modèle de disposition

const { DocumentIntelligenceClient } = require("@azure-rest/ai-document-intelligence");
const  { AzureKeyCredential } = require("@azure/core-auth");

//use your `key` and `endpoint` environment variables
const key = process.env['DI_KEY'];
const endpoint = process.env['DI_ENDPOINT'];

// sample document
const layoutUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/layout.png"

async function main() {
    const client = DocumentIntelligence(endpoint, new AzureKeyCredential(key));

    const poller = await client.beginAnalyzeDocument(
      "prebuilt-layout", layoutUrl);

    // Layout extraction produces basic elements such as pages, words, lines, etc. as well as information about the
    // appearance (styles) of textual elements.
    const { pages, tables } = await poller.pollUntilDone();

    if (!pages || pages.length <= 0) {
      console.log("No pages were extracted from the document.");
    } else {
      console.log("Pages:");
      for (const page of pages) {
        console.log("- Page", page.pageNumber, `(unit: ${page.unit})`);
        console.log(`  ${page.width}x${page.height}, angle: ${page.angle}`);
        console.log(
          `  ${page.lines && page.lines.length} lines, ${page.words && page.words.length} words`
        );

        if (page.lines && page.lines.length > 0) {
          console.log("  Lines:");

          for (const line of page.lines) {
            console.log(`  - "${line.content}"`);

            // The words of the line can also be iterated independently. The words are computed based on their
            // corresponding spans.
            for (const word of line.words()) {
              console.log(`    - "${word.content}"`);
            }
          }
        }
      }
    }

    if (!tables || tables.length <= 0) {
      console.log("No tables were extracted from the document.");
    } else {
      console.log("Tables:");
      for (const table of tables) {
        console.log(
          `- Extracted table: ${table.columnCount} columns, ${table.rowCount} rows (${table.cells.length} cells)`
        );
      }
    }
  }

  main().catch((error) => {
    console.error("An error occurred:", error);
    process.exit(1);
  });

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle de disposition.

Utiliser le modèle Document général

const { DocumentIntelligenceClient } = require("@azure-rest/ai-document-intelligence");
const  { AzureKeyCredential } = require("@azure/core-auth");

//use your `key` and `endpoint` environment variables
const key = process.env['DI_KEY'];
const endpoint = process.env['DI_ENDPOINT'];

// sample document
const documentUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/sample-layout.pdf"

async function main() {
    const client = DocumentIntelligence(endpoint, new AzureKeyCredential(key));

    const poller = await client.beginAnalyzeDocument("prebuilt-document", documentUrl);

    const {
        keyValuePairs
    } = await poller.pollUntilDone();

    if (!keyValuePairs || keyValuePairs.length <= 0) {
        console.log("No key-value pairs were extracted from the document.");
    } else {
        console.log("Key-Value Pairs:");
        for (const {
                key,
                value,
                confidence
            } of keyValuePairs) {
            console.log("- Key  :", `"${key.content}"`);
            console.log("  Value:", `"${(value && value.content) || "<undefined>"}" (${confidence})`);
        }
    }

}

main().catch((error) => {
    console.error("An error occurred:", error);
    process.exit(1);
});

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle de document général.

Utiliser le modèle fiscal W-2

const { DocumentIntelligenceClient } = require("@azure-rest/ai-document-intelligence");
const  { AzureKeyCredential } = require("@azure/core-auth");

//use your `key` and `endpoint` environment variables
const key = process.env['DI_KEY'];
const endpoint = process.env['DI_ENDPOINT'];

const w2DocumentURL = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/w2.png"

async function main() {
 const client = DocumentIntelligence(endpoint, new AzureKeyCredential(key));

 const poller = await client.beginAnalyzeDocument("prebuilt-tax.us.w2", w2DocumentURL);

 const {
   documents: [result]
 } = await poller.pollUntilDone();

  if (result) {
    const { Employee, Employer, ControlNumber, TaxYear, AdditionalInfo } = result.fields;

    if (Employee) {
      const { Name, Address, SocialSecurityNumber } = Employee.properties;
      console.log("Employee:");
      console.log("  Name:", Name && Name.content);
      console.log("  SSN/TIN:", SocialSecurityNumber && SocialSecurityNumber.content);
      if (Address && Address.value) {
        const { streetAddress, postalCode } = Address.value;
        console.log("  Address:");
        console.log("    Street Address:", streetAddress);
        console.log("    Postal Code:", postalCode);
      }
    } else {
      console.log("No employee information extracted.");
    }

    if (Employer) {
      const { Name, Address, IdNumber } = Employer.properties;
      console.log("Employer:");
      console.log("  Name:", Name && Name.content);
      console.log("  ID (EIN):", IdNumber && IdNumber.content);

      if (Address && Address.value) {
        const { streetAddress, postalCode } = Address.value;
        console.log("  Address:");
        console.log("    Street Address:", streetAddress);
        console.log("    Postal Code:", postalCode);
      }
    } else {
      console.log("No employer information extracted.");
    }

    console.log("Control Number:", ControlNumber && ControlNumber.content);
    console.log("Tax Year:", TaxYear && TaxYear.content);

    if (AdditionalInfo) {
      console.log("Additional Info:");

      for (const info of AdditionalInfo.values) {
        const { LetterCode, Amount } = info.properties;
        console.log(`- ${LetterCode && LetterCode.content}: ${Amount && Amount.content}`);
      }
    }
  } else {
    throw new Error("Expected at least one document in the result.");
  }
}

main().catch((error) => {
  console.error(error);
  process.exit(1);
});

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle fiscal W-2.

Utiliser le modèle de facture

const { DocumentIntelligenceClient } = require("@azure-rest/ai-document-intelligence");
const  { AzureKeyCredential } = require("@azure/core-auth");

//use your `key` and `endpoint` environment variables
const key = process.env['DI_KEY'];
const endpoint = process.env['DI_ENDPOINT'];

// sample url
const invoiceUrl = "https://github.com/Azure-Samples/cognitive-services-REST-api-samples/raw/master/curl/form-recognizer/rest-api/invoice.pdf";

async function main() {

  const client = DocumentIntelligence(endpoint, new AzureKeyCredential(key));

  const poller = await client.beginAnalyzeDocument("prebuilt-invoice", invoiceUrl);

  const {
      documents: [result]
  } = await poller.pollUntilDone();

  if (result) {
      const invoice = result.fields;

      console.log("Vendor Name:", invoice.VendorName?.content);
      console.log("Customer Name:", invoice.CustomerName?.content);
      console.log("Invoice Date:", invoice.InvoiceDate?.content);
      console.log("Due Date:", invoice.DueDate?.content);

      console.log("Items:");
      for (const {
              properties: item
          } of invoice.Items?.values ?? []) {
          console.log("-", item.ProductCode?.content ?? "<no product code>");
          console.log("  Description:", item.Description?.content);
          console.log("  Quantity:", item.Quantity?.content);
          console.log("  Date:", item.Date?.content);
          console.log("  Unit:", item.Unit?.content);
          console.log("  Unit Price:", item.UnitPrice?.content);
          console.log("  Tax:", item.Tax?.content);
          console.log("  Amount:", item.Amount?.content);
      }

      console.log("Subtotal:", invoice.SubTotal?.content);
      console.log("Previous Unpaid Balance:", invoice.PreviousUnpaidBalance?.content);
      console.log("Tax:", invoice.TotalTax?.content);
      console.log("Amount Due:", invoice.AmountDue?.content);
  } else {
      throw new Error("Expected at least one receipt in the result.");
  }
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle de facture.

Utiliser le modèle de reçu

const { DocumentIntelligenceClient } = require("@azure-rest/ai-document-intelligence");
const  { AzureKeyCredential } = require("@azure/core-auth");

//use your `key` and `endpoint` environment variables
const key = process.env['DI_KEY'];
const endpoint = process.env['DI_ENDPOINT'];

// sample url
const receiptUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/receipt.png";

async function main() {

    const client = DocumentIntelligence(endpoint, new AzureKeyCredential(key));

    const poller = await client.beginAnalyzeDocument("prebuilt-receipt", receiptUrl);

    const {
        documents: [result]
    } = await poller.pollUntilDone();

    if (result) {
        const {
            MerchantName,
            Items,
            Total
        } = result.fields;

        console.log("=== Receipt Information ===");
        console.log("Type:", result.docType);
        console.log("Merchant:", MerchantName && MerchantName.content);

        console.log("Items:");
        for (const item of (Items && Items.values) || []) {
            const {
                Description,
                TotalPrice
            } = item.properties;

            console.log("- Description:", Description && Description.content);
            console.log("  Total Price:", TotalPrice && TotalPrice.content);
        }

        console.log("Total:", Total && Total.content);
    } else {
        throw new Error("Expected at least one receipt in the result.");
    }

}

main().catch((err) => {
    console.error("The sample encountered an error:", err);
});

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle de reçu.

Utiliser le modèle de pièce d’identité

const { DocumentIntelligenceClient } = require("@azure-rest/ai-document-intelligence");
const  { AzureKeyCredential } = require("@azure/core-auth");

//use your `key` and `endpoint` environment variables
const key = process.env['DI_KEY'];
const endpoint = process.env['DI_ENDPOINT'];

// sample document
const idDocumentURL = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/identity_documents.png"

async function main() {
 const client = DocumentIntelligence(endpoint, new AzureKeyCredential(key));

 const poller = await client.beginAnalyzeDocument("prebuilt-idDocument", idDocumentURL);

 const {
   documents: [result]
 } = await poller.pollUntilDone();

  if (result) {
// The identity document model has multiple document types, so we need to know which document type was actually
    extracted.
    if (result.docType === "idDocument.driverLicense") {
      const { FirstName, LastName, DocumentNumber, DateOfBirth, DateOfExpiration, Height, Weight, EyeColor, Endorsements, Restrictions, VehicleClassifications} = result.fields;

// For the sake of the example, we'll only show a few of the fields that are produced.
      console.log("Extracted a Driver License:");
      console.log("  Name:", FirstName && FirstName.content, LastName && LastName.content);
      console.log("  License No.:", DocumentNumber && DocumentNumber.content);
      console.log("  Date of Birth:", DateOfBirth && DateOfBirth.content);
      console.log("  Expiration:", DateOfExpiration && DateOfExpiration.content);
      console.log("  Height:", Height && Height.content);
      console.log("  Weight:", Weight && Weight.content);
      console.log("  Eye color:", EyeColor && EyeColor.content);
      console.log("  Restrictions:", Restrictions && Restrictions.content);
      console.log("  Endorsements:", Endorsements && Endorsements.content);
      console.log("  Class:", VehicleClassifications && VehicleClassifications.content);
    } else if (result.docType === "idDocument.passport") {
// The passport document type extracts and parses the Passport's machine-readable zone
      if (!result.fields.machineReadableZone) {
        throw new Error("No Machine Readable Zone extracted from passport.");
      }

      const {
        FirstName,
        LastName,
        DateOfBirth,
        Nationality,
        DocumentNumber,
        CountryRegion,
        DateOfExpiration,
      } = result.fields.machineReadableZone.properties;

      console.log("Extracted a Passport:");
      console.log("  Name:", FirstName && FirstName.content, LastName && LastName.content);
      console.log("  Date of Birth:", DateOfBirth && DateOfBirth.content);
      console.log("  Nationality:", Nationality && Nationality.content);
      console.log("  Passport No.:", DocumentNumber && DocumentNumber.content);
      console.log("  Issuer:", CountryRegion && CountryRegion.content);
      console.log("  Expiration Date:", DateOfExpiration && DateOfExpiration.content);
    } else {
// The only reason this would happen is if the client library's schema for the prebuilt identity document model is
      out of date, and a new document type has been introduced.
      console.error("Unknown document type in result:", result);
    }
  } else {
    throw new Error("Expected at least one receipt in the result.");
  }
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle de document d’identité.

Bibliothèque de client |Informations de référence sur le SDK | Informations de référence sur l’API REST | Package (PyPi) | Exemples | Version de l’API REST prise en charge

Prérequis

• Un abonnement Azure : créez-en un gratuitement.

• Python 3.7 ou ultérieur. Votre installation Python doit inclure pip. Vous pouvez vérifier si pip est installé en exécutant pip --version sur la ligne de commande. Procurez-vous pip en installant la dernière version de Python.

• Dernière version de Visual Studio Code ou de votre IDE préféré. Consultez Bien démarrer avec Python dans Visual Studio.

• Une ressource Azure AI services ou Document Intelligence. Créez un service unique ou un service multiple. Vous pouvez utiliser le niveau tarifaire Gratuit (F0) pour tester le service, puis passer par la suite à un niveau payant pour la production.

• La clé et le point de terminaison de la ressource que vous créez pour connecter votre application au service Intelligence documentaire Azure.

  1. Après le déploiement de votre ressource, sélectionnez Accéder à la ressource.
  2. Dans le menu de navigation de gauche, sélectionnez Clés et point de terminaison.
  3. Copiez une des clés et le point de terminaison pour une utilisation ultérieure dans cet article.

  

• Un fichier de document à une URL. Pour ce projet, vous pouvez utiliser les exemples de formulaires fournis dans le tableau suivant pour chaque fonctionnalité :

  Fonction	modelID	document-url
  Modèle Read	prebuilt-read	Exemple de brochure
  Modèle de disposition	prebuilt-layout	Exemple de confirmation de réservation
  Modèle de formulaire W-2	prebuilt-tax.us.w2	Exemple de formulaire W-2
  Modèle de facture	Facture prédéfinie	Exemple de facture
  Modèle de reçu	prebuilt-receipt	Exemple de ticket de caisse
  Modèle de pièce d’identité	prebuilt-idDocument	Exemple de pièce d’identité

Définir vos variables d’environnement

Pour interagir avec le service d’Intelligence documentaire, vous devez créer une instance de classe DocumentAnalysisClient. Pour ce faire, vous instanciez le client avec vos key et endpoint depuis le portail Azure. Pour ce projet, utilisez des variables d’environnement pour stocker des informations d’identification et y accéder.

Important

N’incluez pas votre clé directement dans le code et ne la publiez jamais publiquement. Pour la production, utilisez un moyen sécurisé pour stocker et accéder à vos informations d’identification, comme Azure Key Vault. Pour plus d’informations, veuillez consulter Sécurité d’Azure AI services.

Pour définir la variable d’environnement de votre clé de ressource Intelligence documentaire, ouvrez une fenêtre de console et suivez les instructions relatives à votre système d’exploitation et à votre environnement de développement. Remplacez <yourKey> et <yourEndpoint> par les valeurs de votre ressource dans le portail Azure.

Windows

Les variables d’environnement dans Windows ne respectent pas la casse. Elles sont généralement déclarées en majuscules, avec des mots joints par un trait de soulignement. Depuis une invite de commandes, exécutez les commandes suivantes :

1. Définissez votre variable de clé :

   setx DI_KEY <yourKey>
   

2. Définissez votre variable de point de terminaison

   setx DI_ENDPOINT <yourEndpoint>
   

3. Après avoir défini vos variables d’environnement, fermez la fenêtre d’invite de commandes. Les valeurs restent les mêmes jusqu’à ce que vous les modifiez à nouveau.

4. Redémarrez tous les programmes en cours d’exécution qui lisent la variable d’environnement. Par exemple, si vous utilisez Visual Studio ou Visual Studio Code comme éditeur, redémarrez-le avant d’exécuter l’échantillon de code.

Voici d’autres commandes utiles à utiliser avec les variables d’environnement :

Commande	Action	Exemple
setx VARIABLE_NAME=	Supprimez la variable d’environnement en définissant la valeur sur une chaîne vide.	setx DI_KEY=
setx VARIABLE_NAME=value	Définissez ou changez la valeur d’une variable d’environnement.	setx DI_KEY=<yourKey>
set VARIABLE_NAME	Affichez la valeur d’une variable d’environnement spécifique.	set DI_KEY
set	Affichez toutes les variables d’environnement.	set

macOS

Les variables d’environnement dans macOS respectent la casse. Par convention, le nom de la variable est déclaré en majuscules.

La commande export définit la variable et l’exporte dans l’environnement global, qui est disponible pour les autres processus. Cependant, la valeur est temporaire et dure seulement jusqu’au moment où vous fermez la session du terminal. Ouvrez votre terminal et entrez les commandes suivantes :

1. Définissez votre variable de clé :

   export key=<yourKey>
   

2. Définissez votre variable de point de terminaison :

   export endpoint=<yourEndpoint>
   

Pour définir une variable d’environnement de façon permanente, placez une commande d’exportation dans votre script de démarrage Bash ~/.bash_profile :

1. Utilisez un éditeur de texte pour ouvrir le fichier ~/.bash_profile et ajoutez la commande suivante pour créer une variable d’environnement permanente :

   export DI_KEY=<yourKey> DI_ENDPOINT=<yourEndpoint>
   

   Exemple : export DI_KEY="<yourKey>"

2. Enregistrez les modifications apportées au fichier bash_profile.

3. Pour que les modifications entrent en vigueur, exécutez la commande suivante dans la fenêtre du terminal :

   source ~/.bash-profile
   

Voici d’autres commandes utiles à utiliser avec les variables d’environnement :

Commande	Action	Exemple
unset VARIABLE_NAME	Supprimez une variable d’environnement.	unset DI_KEY
export VARIABLE_NAME=value	Définissez ou modifiez la valeur d’une variable d’environnement temporaire.	export DI_KEY=<yourKey>
printenv VARIABLE_NAME echo $VARIABLE_NAME	Affichez la valeur d’une variable d’environnement spécifique. Avec la commande echo, faites précéder la variable de $.	printenv DI_KEY echo $DI_KEY
printenv	Affichez toutes les variables d’environnement.	printenv

Linux

Les variables d’environnement dans Linux respectent la casse. Par convention, le nom de la variable est déclaré en majuscules.

La commande export définit la variable et l’exporte dans l’environnement global, qui est disponible pour les autres processus. Cependant, la valeur est temporaire et dure seulement jusqu’au moment où vous fermez la session du terminal :

1. Définissez votre variable de clé :

   export DI_KEY=<yourKey>
   

2. Définissez votre variable de point de terminaison :

   export DI_ENDPOINT=<yourEndpoint>
   

Pour définir une variable d’environnement de façon permanente, placez une commande d’exportation dans votre script de démarrage Bash ~/.bashrc :

1. Utilisez un éditeur de texte pour ouvrir le fichier ~/.bashrc et ajoutez la commande suivante pour créer une variable d’environnement permanente :

   export <VARIABLE>=<value>
   

   Exemple : export DI_KEY=<yourKey>

2. Enregistrez vos modifications apportées au fichier .bashrc.

3. Pour que les modifications entrent en vigueur, exécutez la commande suivante dans la fenêtre du terminal :

   source ~/.bashrc
   

Voici d’autres commandes utiles à utiliser avec les variables d’environnement :

Commande	Action	Exemple
unset VARIABLE_NAME	Supprimez une variable d’environnement.	unset DI_KEY=
export VARIABLE_NAME=value	Définissez ou modifiez la valeur d’une variable d’environnement temporaire.	export DI_KEY={yourKey}
printenv VARIABLE_NAME echo $VARIABLE_NAME	Affichez la valeur d’une variable d’environnement. Avec la commande echo, faites précéder la variable de $.	printenv DI_KEY echo $DI_KEY
printenv	Affichez toutes les variables d’environnement.	printenv

Configurer votre environnement de programmation

Ouvrez une fenêtre de console dans votre environnement local et installez la bibliothèque de client Azure AI Intelligence documentaire pour Python avec pip :

pip install azure-ai-documentintelligence==1.0.0b2

Créer votre application Python

Pour interagir avec le service d’Intelligence documentaire, vous devez créer une instance de classe DocumentIntelligenceClient. Pour ce faire, vous créez un AzureKeyCredential avec votre clé depuis le portail Azure et une instance DocumentIntelligenceClient avec le AzureKeyCredential et votre point de terminaison Intelligence documentaire.

1. Créez un fichier Python appelé form_recognizer_quickstart.py dans un éditeur ou un IDE.

2. Ouvrez le fichier form_recognizer_quickstart.py, sélectionnez l’un des exemples de code suivants, puis copiez-collez l’exemple dans votre application :

   • Le modèle prebuilt-read est au cœur de tous les modèles Intelligence documentaire et peut détecter des lignes, des mots, des lieux et des langues. Les modèles prédéfinis, personnalisés, de disposition et de document général utilisent le modèle read comme base pour extraire du texte à partir de documents.
   • Le modèle prebuilt-layout extrait le texte et ses emplacements, les tableaux, les marques de sélection et les informations de structure des documents et des images.
   • Le modèle prebuilt-tax.us.w2 extrait les informations rapportées sur les formulaires fiscaux de l’Internal Revenue Service (IRS) des États-Unis.
   • Le modèle prebuilt-invoice extrait les champs clés et les éléments des lignes des factures de vente dans différents formats.
   • Le modèle prebuilt-receipt analyse et extrait les informations clés des reçus de vente imprimés et manuscrits.
   • Le modèle prebuilt-idDocument extrait les informations clés des permis de conduire américains, des pages biographiques des passeports internationaux, des cartes d’identité des États américains, des cartes de sécurité sociale et des cartes de résident permanent.

3. Exécutez le code Python à partir de l’invite de commandes.

   python form_recognizer_quickstart.py
   

Utiliser le modèle Lecture

import os
from azure.core.credentials import AzureKeyCredential
from azure.ai.documentintelligence import DocumentIntelligenceClient
from azure.ai.documentintelligence.models import AnalyzeResult

# use your `key` and `endpoint` environment variables
key = os.environ.get('DI_KEY')
endpoint = os.environ.get('DI_ENDPOINT')

# formatting function
def format_polygon(polygon):
    if not polygon:
        return "N/A"
    return ", ".join(["[{}, {}]".format(p.x, p.y) for p in polygon])


def analyze_read():
    # sample document
    formUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/read.png"

    client = DocumentIntelligenceClient(
        endpoint=endpoint, credential=AzureKeyCredential(key)
    )

    poller = client.begin_analyze_document(
        "prebuilt-read", formUrl
    )
    result = poller.result()

    print("Document contains content: ", result.content)

    for idx, style in enumerate(result.styles):
        print(
            "Document contains {} content".format(
                "handwritten" if style.is_handwritten else "no handwritten"
            )
        )

    for page in result.pages:
        print("----Analyzing Read from page #{}----".format(page.page_number))
        print(
            "Page has width: {} and height: {}, measured with unit: {}".format(
                page.width, page.height, page.unit
            )
        )

        for line_idx, line in enumerate(page.lines):
            print(
                "...Line # {} has text content '{}' within bounding box '{}'".format(
                    line_idx,
                    line.content,
                    format_polygon(line.polygon),
                )
            )

        for word in page.words:
            print(
                "...Word '{}' has a confidence of {}".format(
                    word.content, word.confidence
                )
            )

    print("----------------------------------------")


if __name__ == "__main__":
    analyze_read()

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle read.

Utiliser le modèle de disposition

import os
from azure.core.credentials import AzureKeyCredential
from azure.ai.documentintelligence import DocumentIntelligenceClient
from azure.ai.documentintelligence.models import AnalyzeResult


# use your `key` and `endpoint` environment variables
key = os.environ.get('DI_KEY')
endpoint = os.environ.get('DI_ENDPOINT')

# formatting function
def format_polygon(polygon):
    if not polygon:
        return "N/A"
    return ", ".join(["[{}, {}]".format(p.x, p.y) for p in polygon])


def analyze_layout():
    # sample document
    formUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/layout.png"

    client = DocumentIntelligenceClient(
        endpoint=endpoint, credential=AzureKeyCredential(key)
    )

    poller = client.begin_analyze_document(
        "prebuilt-layout", formUrl
    )
    result = poller.result()

    for idx, style in enumerate(result.styles):
        print(
            "Document contains {} content".format(
                "handwritten" if style.is_handwritten else "no handwritten"
            )
        )

    for page in result.pages:
        print("----Analyzing layout from page #{}----".format(page.page_number))
        print(
            "Page has width: {} and height: {}, measured with unit: {}".format(
                page.width, page.height, page.unit
            )
        )

        for line_idx, line in enumerate(page.lines):
            words = line.get_words()
            print(
                "...Line # {} has word count {} and text '{}' within bounding box '{}'".format(
                    line_idx,
                    len(words),
                    line.content,
                    format_polygon(line.polygon),
                )
            )

            for word in words:
                print(
                    "......Word '{}' has a confidence of {}".format(
                        word.content, word.confidence
                    )
                )

        for selection_mark in page.selection_marks:
            print(
                "...Selection mark is '{}' within bounding box '{}' and has a confidence of {}".format(
                    selection_mark.state,
                    format_polygon(selection_mark.polygon),
                    selection_mark.confidence,
                )
            )

    for table_idx, table in enumerate(result.tables):
        print(
            "Table # {} has {} rows and {} columns".format(
                table_idx, table.row_count, table.column_count
            )
        )
        for region in table.bounding_regions:
            print(
                "Table # {} location on page: {} is {}".format(
                    table_idx,
                    region.page_number,
                    format_polygon(region.polygon),
                )
            )
        for cell in table.cells:
            print(
                "...Cell[{}][{}] has content '{}'".format(
                    cell.row_index,
                    cell.column_index,
                    cell.content,
                )
            )
            for region in cell.bounding_regions:
                print(
                    "...content on page {} is within bounding box '{}'".format(
                        region.page_number,
                        format_polygon(region.polygon),
                    )
                )

    print("----------------------------------------")


if __name__ == "__main__":
    analyze_layout()

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle de disposition.

Utiliser le modèle Document général

import os
from azure.core.credentials import AzureKeyCredential
from azure.ai.documentintelligence import DocumentIntelligenceClient
from azure.ai.documentintelligence.models import AnalyzeResult

# use your `key` and `endpoint` environment variables
key = os.environ.get('DI_KEY')
endpoint = os.environ.get('DI_ENDPOINT')

# formatting function
def format_bounding_region(bounding_regions):
    if not bounding_regions:
        return "N/A"
    return ", ".join("Page #{}: {}".format(region.page_number, format_polygon(region.polygon)) for region in bounding_regions)

# formatting function
def format_polygon(polygon):
    if not polygon:
        return "N/A"
    return ", ".join(["[{}, {}]".format(p.x, p.y) for p in polygon])


def analyze_general_documents():
    # sample document
    docUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/sample-layout.pdf"

    # create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
   client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))

    poller = client.begin_analyze_document(
            "prebuilt-document", docUrl)
    result = poller.result()

    for style in result.styles:
        if style.is_handwritten:
            print("Document contains handwritten content: ")
            print(",".join([result.content[span.offset:span.offset + span.length] for span in style.spans]))

    print("----Key-value pairs found in document----")
    for kv_pair in result.key_value_pairs:
        if kv_pair.key:
            print(
                    "Key '{}' found within '{}' bounding regions".format(
                        kv_pair.key.content,
                        format_bounding_region(kv_pair.key.bounding_regions),
                    )
                )
        if kv_pair.value:
            print(
                    "Value '{}' found within '{}' bounding regions\n".format(
                        kv_pair.value.content,
                        format_bounding_region(kv_pair.value.bounding_regions),
                    )
                )

    for page in result.pages:
        print("----Analyzing document from page #{}----".format(page.page_number))
        print(
            "Page has width: {} and height: {}, measured with unit: {}".format(
                page.width, page.height, page.unit
            )
        )

        for line_idx, line in enumerate(page.lines):
            print(
                "...Line # {} has text content '{}' within bounding box '{}'".format(
                    line_idx,
                    line.content,
                    format_polygon(line.polygon),
                )
            )

        for word in page.words:
            print(
                "...Word '{}' has a confidence of {}".format(
                    word.content, word.confidence
                )
            )

        for selection_mark in page.selection_marks:
            print(
                "...Selection mark is '{}' within bounding box '{}' and has a confidence of {}".format(
                    selection_mark.state,
                    format_polygon(selection_mark.polygon),
                    selection_mark.confidence,
                )
            )

    for table_idx, table in enumerate(result.tables):
        print(
            "Table # {} has {} rows and {} columns".format(
                table_idx, table.row_count, table.column_count
            )
        )
        for region in table.bounding_regions:
            print(
                "Table # {} location on page: {} is {}".format(
                    table_idx,
                    region.page_number,
                    format_polygon(region.polygon),
                )
            )
        for cell in table.cells:
            print(
                "...Cell[{}][{}] has content '{}'".format(
                    cell.row_index,
                    cell.column_index,
                    cell.content,
                )
            )
            for region in cell.bounding_regions:
                print(
                    "...content on page {} is within bounding box '{}'\n".format(
                        region.page_number,
                        format_polygon(region.polygon),
                    )
                )
    print("----------------------------------------")


if __name__ == "__main__":
    analyze_general_documents()

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle de document général.

Utiliser le modèle fiscal W-2

import os
from azure.core.credentials import AzureKeyCredential
from azure.ai.documentintelligence import DocumentIntelligenceClient
from azure.ai.documentintelligence.models import AnalyzeResult

# use your `key` and `endpoint` environment variables
key = os.environ.get('DI_KEY')
endpoint = os.environ.get('DI_ENDPOINT')

# formatting function
def format_address_value(address_value):
    return f"\n......House/building number: {address_value.house_number}\n......Road: {address_value.road}\n......City: {address_value.city}\n......State: {address_value.state}\n......Postal code: {address_value.postal_code}"


def analyze_tax_us_w2():
    # sample document
    formUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/w2.png"

    client = DocumentIntelligenceClient(
        endpoint=endpoint, credential=AzureKeyCredential(key)
    )

    poller = client.begin_analyze_document(
        "prebuilt-tax.us.w2", formUrl
    )
    w2s = poller.result()

    for idx, w2 in enumerate(w2s.documents):
         print("--------Analyzing US Tax W-2 Form #{}--------".format(idx   1))
        form_variant = w2.fields.get("W2FormVariant")
        if form_variant:
            print(
                "Form variant: {} has confidence: {}".format(
                    form_variant.value, form_variant.confidence
                )
            )
        tax_year = w2.fields.get("TaxYear")
        if tax_year:
            print(
                "Tax year: {} has confidence: {}".format(
                    tax_year.value, tax_year.confidence
                )
            )
        w2_copy = w2.fields.get("W2Copy")
        if w2_copy:
            print(
                "W-2 Copy: {} has confidence: {}".format(
                    w2_copy.value,
                    w2_copy.confidence,
                )
            )
        employee = w2.fields.get("Employee")
        if employee:
            print("Employee data:")
            employee_name = employee.value.get("Name")
            if employee_name:
                print(
                    "...Name: {} has confidence: {}".format(
                        employee_name.value, employee_name.confidence
                    )
                )
            employee_ssn = employee.value.get("SocialSecurityNumber")
            if employee_ssn:
                print(
                    "...SSN: {} has confidence: {}".format(
                        employee_ssn.value, employee_ssn.confidence
                    )
                )
            employee_address = employee.value.get("Address")
            if employee_address:
                print(
                    "...Address: {}\n......has confidence: {}".format(
                        format_address_value(employee_address.value),
                        employee_address.confidence,
                    )
                )
            employee_zipcode = employee.value.get("ZipCode")
            if employee_zipcode:
                print(
                    "...Zipcode: {} has confidence: {}".format(
                        employee_zipcode.value, employee_zipcode.confidence
                    )
                )
        control_number = w2.fields.get("ControlNumber")
        if control_number:
            print(
                "Control Number: {} has confidence: {}".format(
                    control_number.value, control_number.confidence
                )
            )
        employer = w2.fields.get("Employer")
        if employer:
            print("Employer data:")
            employer_name = employer.value.get("Name")
            if employer_name:
                print(
                    "...Name: {} has confidence: {}".format(
                        employer_name.value, employer_name.confidence
                    )
                )
            employer_id = employer.value.get("IdNumber")
            if employer_id:
                print(
                    "...ID Number: {} has confidence: {}".format(
                        employer_id.value, employer_id.confidence
                    )
                )
            employer_address = employer.value.get("Address")
            if employer_address:
                print(
                    "...Address: {}\n......has confidence: {}".format(
                        format_address_value(employer_address.value),
                        employer_address.confidence,
                    )
                )
            employer_zipcode = employer.value.get("ZipCode")
            if employer_zipcode:
                print(
                    "...Zipcode: {} has confidence: {}".format(
                        employer_zipcode.value, employer_zipcode.confidence
                    )
                )
        wages_tips = w2.fields.get("WagesTipsAndOtherCompensation")
        if wages_tips:
            print(
                "Wages, tips, and other compensation: {} has confidence: {}".format(
                    wages_tips.value,
                    wages_tips.confidence,
                )
            )
        fed_income_tax_withheld = w2.fields.get("FederalIncomeTaxWithheld")
        if fed_income_tax_withheld:
            print(
                "Federal income tax withheld: {} has confidence: {}".format(
                    fed_income_tax_withheld.value, fed_income_tax_withheld.confidence
                )
            )
        social_security_wages = w2.fields.get("SocialSecurityWages")
        if social_security_wages:
            print(
                "Social Security wages: {} has confidence: {}".format(
                    social_security_wages.value, social_security_wages.confidence
                )
            )
        social_security_tax_withheld = w2.fields.get("SocialSecurityTaxWithheld")
        if social_security_tax_withheld:
            print(
                "Social Security tax withheld: {} has confidence: {}".format(
                    social_security_tax_withheld.value,
                    social_security_tax_withheld.confidence,
                )
            )
        medicare_wages_tips = w2.fields.get("MedicareWagesAndTips")
        if medicare_wages_tips:
            print(
                "Medicare wages and tips: {} has confidence: {}".format(
                    medicare_wages_tips.value, medicare_wages_tips.confidence
                )
            )
        medicare_tax_withheld = w2.fields.get("MedicareTaxWithheld")
        if medicare_tax_withheld:
            print(
                "Medicare tax withheld: {} has confidence: {}".format(
                    medicare_tax_withheld.value, medicare_tax_withheld.confidence
                )
            )
        social_security_tips = w2.fields.get("SocialSecurityTips")
        if social_security_tips:
            print(
                "Social Security tips: {} has confidence: {}".format(
                    social_security_tips.value, social_security_tips.confidence
                )
            )
        allocated_tips = w2.fields.get("AllocatedTips")
        if allocated_tips:
            print(
                "Allocated tips: {} has confidence: {}".format(
                    allocated_tips.value,
                    allocated_tips.confidence,
                )
            )
        verification_code = w2.fields.get("VerificationCode")
        if verification_code:
            print(
                "Verification code: {} has confidence: {}".format(
                    verification_code.value, verification_code.confidence
                )
            )
        dependent_care_benefits = w2.fields.get("DependentCareBenefits")
        if dependent_care_benefits:
            print(
                "Dependent care benefits: {} has confidence: {}".format(
                    dependent_care_benefits.value,
                    dependent_care_benefits.confidence,
                )
            )
        non_qualified_plans = w2.fields.get("NonQualifiedPlans")
        if non_qualified_plans:
            print(
                "Non-qualified plans: {} has confidence: {}".format(
                    non_qualified_plans.value,
                    non_qualified_plans.confidence,
                )
            )
        additional_info = w2.fields.get("AdditionalInfo")
        if additional_info:
            print("Additional information:")
            for item in additional_info.value:
                letter_code = item.value.get("LetterCode")
                if letter_code:
                    print(
                        "...Letter code: {} has confidence: {}".format(
                            letter_code.value, letter_code.confidence
                        )
                    )
                amount = item.value.get("Amount")
                if amount:
                    print(
                        "...Amount: {} has confidence: {}".format(
                            amount.value, amount.confidence
                        )
                    )
        is_statutory_employee = w2.fields.get("IsStatutoryEmployee")
        if is_statutory_employee:
            print(
                "Is statutory employee: {} has confidence: {}".format(
                    is_statutory_employee.value, is_statutory_employee.confidence
                )
            )
        is_retirement_plan = w2.fields.get("IsRetirementPlan")
        if is_retirement_plan:
            print(
                "Is retirement plan: {} has confidence: {}".format(
                    is_retirement_plan.value, is_retirement_plan.confidence
                )
            )
        third_party_sick_pay = w2.fields.get("IsThirdPartySickPay")
        if third_party_sick_pay:
            print(
                "Is third party sick pay: {} has confidence: {}".format(
                    third_party_sick_pay.value, third_party_sick_pay.confidence
                )
            )
        other_info = w2.fields.get("Other")
        if other_info:
            print(
                "Other information: {} has confidence: {}".format(
                    other_info.value,
                    other_info.confidence,
                )
            )
        state_tax_info = w2.fields.get("StateTaxInfos")
        if state_tax_info:
            print("State Tax info:")
            for tax in state_tax_info.value:
                state = tax.value.get("State")
                if state:
                    print(
                        "...State: {} has confidence: {}".format(
                            state.value, state.confidence
                        )
                    )
                employer_state_id_number = tax.value.get("EmployerStateIdNumber")
                if employer_state_id_number:
                    print(
                        "...Employer state ID number: {} has confidence: {}".format(
                            employer_state_id_number.value,
                            employer_state_id_number.confidence,
                        )
                    )
                state_wages_tips = tax.value.get("StateWagesTipsEtc")
                if state_wages_tips:
                    print(
                        "...State wages, tips, etc: {} has confidence: {}".format(
                            state_wages_tips.value, state_wages_tips.confidence
                        )
                    )
                state_income_tax = tax.value.get("StateIncomeTax")
                if state_income_tax:
                    print(
                        "...State income tax: {} has confidence: {}".format(
                            state_income_tax.value, state_income_tax.confidence
                        )
                    )
        local_tax_info = w2.fields.get("LocalTaxInfos")
        if local_tax_info:
            print("Local Tax info:")
            for tax in local_tax_info.value:
                local_wages_tips = tax.value.get("LocalWagesTipsEtc")
                if local_wages_tips:
                    print(
                        "...Local wages, tips, etc: {} has confidence: {}".format(
                            local_wages_tips.value, local_wages_tips.confidence
                        )
                    )
                local_income_tax = tax.value.get("LocalIncomeTax")
                if local_income_tax:
                    print(
                        "...Local income tax: {} has confidence: {}".format(
                            local_income_tax.value, local_income_tax.confidence
                        )
                    )
                locality_name = tax.value.get("LocalityName")
                if locality_name:
                    print(
                        "...Locality name: {} has confidence: {}".format(
                            locality_name.value, locality_name.confidence
                        )
                    )

                print("----------------------------------------")


if __name__ == "__main__":
    analyze_tax_us_w2()

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle fiscal W-2.

Utiliser le modèle de facture

import os
from azure.core.credentials import AzureKeyCredential
from azure.ai.documentintelligence import DocumentIntelligenceClient
from azure.ai.documentintelligence.models import AnalyzeResult

# use your `key` and `endpoint` environment variables
key = os.environ.get('DI_KEY')
endpoint = os.environ.get('DI_ENDPOINT')

# formatting function
def format_bounding_region(bounding_regions):
    if not bounding_regions:
        return "N/A"
    return ", ".join("Page #{}: {}".format(region.page_number, format_polygon(region.polygon)) for region in bounding_regions)

# formatting function
def format_polygon(polygon):
    if not polygon:
        return "N/A"
    return ", ".join(["[{}, {}]".format(p.x, p.y) for p in polygon])


def analyze_invoice():

    invoiceUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/sample-invoice.pdf"

    client = DocumentIntelligenceClient(
        endpoint=endpoint, credential=AzureKeyCredential(key)
    )

    poller = client.begin_analyze_document(
            "prebuilt-invoice", invoiceUrl)
    invoices = poller.result()

    for idx, invoice in enumerate(invoices.documents):
        print("--------Recognizing invoice #{}--------".format(idx + 1))
        vendor_name = invoice.fields.get("VendorName")
        if vendor_name:
            print(
                "Vendor Name: {} has confidence: {}".format(
                    vendor_name.value, vendor_name.confidence
                )
            )
        vendor_address = invoice.fields.get("VendorAddress")
        if vendor_address:
            print(
                "Vendor Address: {} has confidence: {}".format(
                    vendor_address.value, vendor_address.confidence
                )
            )
        vendor_address_recipient = invoice.fields.get("VendorAddressRecipient")
        if vendor_address_recipient:
            print(
                "Vendor Address Recipient: {} has confidence: {}".format(
                    vendor_address_recipient.value, vendor_address_recipient.confidence
                )
            )
        customer_name = invoice.fields.get("CustomerName")
        if customer_name:
            print(
                "Customer Name: {} has confidence: {}".format(
                    customer_name.value, customer_name.confidence
                )
            )
        customer_id = invoice.fields.get("CustomerId")
        if customer_id:
            print(
                "Customer Id: {} has confidence: {}".format(
                    customer_id.value, customer_id.confidence
                )
            )
        customer_address = invoice.fields.get("CustomerAddress")
        if customer_address:
            print(
                "Customer Address: {} has confidence: {}".format(
                    customer_address.value, customer_address.confidence
                )
            )
        customer_address_recipient = invoice.fields.get("CustomerAddressRecipient")
        if customer_address_recipient:
            print(
                "Customer Address Recipient: {} has confidence: {}".format(
                    customer_address_recipient.value,
                    customer_address_recipient.confidence,
                )
            )
        invoice_id = invoice.fields.get("InvoiceId")
        if invoice_id:
            print(
                "Invoice Id: {} has confidence: {}".format(
                    invoice_id.value, invoice_id.confidence
                )
            )
        invoice_date = invoice.fields.get("InvoiceDate")
        if invoice_date:
            print(
                "Invoice Date: {} has confidence: {}".format(
                    invoice_date.value, invoice_date.confidence
                )
            )
        invoice_total = invoice.fields.get("InvoiceTotal")
        if invoice_total:
            print(
                "Invoice Total: {} has confidence: {}".format(
                    invoice_total.value, invoice_total.confidence
                )
            )
        due_date = invoice.fields.get("DueDate")
        if due_date:
            print(
                "Due Date: {} has confidence: {}".format(
                    due_date.value, due_date.confidence
                )
            )
        purchase_order = invoice.fields.get("PurchaseOrder")
        if purchase_order:
            print(
                "Purchase Order: {} has confidence: {}".format(
                    purchase_order.value, purchase_order.confidence
                )
            )
        billing_address = invoice.fields.get("BillingAddress")
        if billing_address:
            print(
                "Billing Address: {} has confidence: {}".format(
                    billing_address.value, billing_address.confidence
                )
            )
        billing_address_recipient = invoice.fields.get("BillingAddressRecipient")
        if billing_address_recipient:
            print(
                "Billing Address Recipient: {} has confidence: {}".format(
                    billing_address_recipient.value,
                    billing_address_recipient.confidence,
                )
            )
        shipping_address = invoice.fields.get("ShippingAddress")
        if shipping_address:
            print(
                "Shipping Address: {} has confidence: {}".format(
                    shipping_address.value, shipping_address.confidence
                )
            )
        shipping_address_recipient = invoice.fields.get("ShippingAddressRecipient")
        if shipping_address_recipient:
            print(
                "Shipping Address Recipient: {} has confidence: {}".format(
                    shipping_address_recipient.value,
                    shipping_address_recipient.confidence,
                )
            )
        print("Invoice items:")
        for idx, item in enumerate(invoice.fields.get("Items").value):
            print("...Item #{}".format(idx + 1))
            item_description = item.value.get("Description")
            if item_description:
                print(
                    "......Description: {} has confidence: {}".format(
                        item_description.value, item_description.confidence
                    )
                )
            item_quantity = item.value.get("Quantity")
            if item_quantity:
                print(
                    "......Quantity: {} has confidence: {}".format(
                        item_quantity.value, item_quantity.confidence
                    )
                )
            unit = item.value.get("Unit")
            if unit:
                print(
                    "......Unit: {} has confidence: {}".format(
                        unit.value, unit.confidence
                    )
                )
            unit_price = item.value.get("UnitPrice")
            if unit_price:
                print(
                    "......Unit Price: {} has confidence: {}".format(
                        unit_price.value, unit_price.confidence
                    )
                )
            product_code = item.value.get("ProductCode")
            if product_code:
                print(
                    "......Product Code: {} has confidence: {}".format(
                        product_code.value, product_code.confidence
                    )
                )
            item_date = item.value.get("Date")
            if item_date:
                print(
                    "......Date: {} has confidence: {}".format(
                        item_date.value, item_date.confidence
                    )
                )
            tax = item.value.get("Tax")
            if tax:
                print(
                    "......Tax: {} has confidence: {}".format(tax.value, tax.confidence)
                )
            amount = item.value.get("Amount")
            if amount:
                print(
                    "......Amount: {} has confidence: {}".format(
                        amount.value, amount.confidence
                    )
                )
        subtotal = invoice.fields.get("SubTotal")
        if subtotal:
            print(
                "Subtotal: {} has confidence: {}".format(
                    subtotal.value, subtotal.confidence
                )
            )
        total_tax = invoice.fields.get("TotalTax")
        if total_tax:
            print(
                "Total Tax: {} has confidence: {}".format(
                    total_tax.value, total_tax.confidence
                )
            )
        previous_unpaid_balance = invoice.fields.get("PreviousUnpaidBalance")
        if previous_unpaid_balance:
            print(
                "Previous Unpaid Balance: {} has confidence: {}".format(
                    previous_unpaid_balance.value, previous_unpaid_balance.confidence
                )
            )
        amount_due = invoice.fields.get("AmountDue")
        if amount_due:
            print(
                "Amount Due: {} has confidence: {}".format(
                    amount_due.value, amount_due.confidence
                )
            )
        service_start_date = invoice.fields.get("ServiceStartDate")
        if service_start_date:
            print(
                "Service Start Date: {} has confidence: {}".format(
                    service_start_date.value, service_start_date.confidence
                )
            )
        service_end_date = invoice.fields.get("ServiceEndDate")
        if service_end_date:
            print(
                "Service End Date: {} has confidence: {}".format(
                    service_end_date.value, service_end_date.confidence
                )
            )
        service_address = invoice.fields.get("ServiceAddress")
        if service_address:
            print(
                "Service Address: {} has confidence: {}".format(
                    service_address.value, service_address.confidence
                )
            )
        service_address_recipient = invoice.fields.get("ServiceAddressRecipient")
        if service_address_recipient:
            print(
                "Service Address Recipient: {} has confidence: {}".format(
                    service_address_recipient.value,
                    service_address_recipient.confidence,
                )
            )
        remittance_address = invoice.fields.get("RemittanceAddress")
        if remittance_address:
            print(
                "Remittance Address: {} has confidence: {}".format(
                    remittance_address.value, remittance_address.confidence
                )
            )
        remittance_address_recipient = invoice.fields.get("RemittanceAddressRecipient")
        if remittance_address_recipient:
            print(
                "Remittance Address Recipient: {} has confidence: {}".format(
                    remittance_address_recipient.value,
                    remittance_address_recipient.confidence,
                )
            )

        print("----------------------------------------")

if __name__ == "__main__":
    analyze_invoice()

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle de facture.

Utiliser le modèle de reçu

import os
from azure.core.credentials import AzureKeyCredential
from azure.ai.documentintelligence import DocumentIntelligenceClient
from azure.ai.documentintelligence.models import AnalyzeResult

# use your `key` and `endpoint` environment variables
key = os.environ.get('DI_KEY')
endpoint = os.environ.get('DI_ENDPOINT')

def analyze_receipts():
    # sample document
    receiptUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/receipt.png"

   client = DocumentIntelligenceClient(
        endpoint=endpoint, credential=AzureKeyCredential(key)
    )
    poller = client.begin_analyze_document(
        "prebuilt-receipt", receiptUrl, locale="en-US"
    )
    receipts = poller.result()
    for idx, receipt in enumerate(receipts.documents):
         print("--------Analysis of receipt #{}--------".format(idx   1))
        print("Receipt type: {}".format(receipt.doc_type or "N/A"))
        merchant_name = receipt.fields.get("MerchantName")
        if merchant_name:
            print(
                "Merchant Name: {} has confidence: {}".format(
                    merchant_name.value, merchant_name.confidence
                )
            )
        transaction_date = receipt.fields.get("TransactionDate")
        if transaction_date:
            print(
                "Transaction Date: {} has confidence: {}".format(
                    transaction_date.value, transaction_date.confidence
                )
            )
        if receipt.fields.get("Items"):
            print("Receipt items:")
            for idx, item in enumerate(receipt.fields.get("Items").value):
                 print("...Item #{}".format(idx   1))
                item_description = item.value.get("Description")
                if item_description:
                    print(
                        "......Item Description: {} has confidence: {}".format(
                            item_description.value, item_description.confidence
                        )
                    )
                item_quantity = item.value.get("Quantity")
                if item_quantity:
                    print(
                        "......Item Quantity: {} has confidence: {}".format(
                            item_quantity.value, item_quantity.confidence
                        )
                    )
                item_price = item.value.get("Price")
                if item_price:
                    print(
                        "......Individual Item Price: {} has confidence: {}".format(
                            item_price.value, item_price.confidence
                        )
                    )
                item_total_price = item.value.get("TotalPrice")
                if item_total_price:
                    print(
                        "......Total Item Price: {} has confidence: {}".format(
                            item_total_price.value, item_total_price.confidence
                        )
                    )
        subtotal = receipt.fields.get("Subtotal")
        if subtotal:
            print(
                "Subtotal: {} has confidence: {}".format(
                    subtotal.value, subtotal.confidence
                )
            )
        tax = receipt.fields.get("TotalTax")
        if tax:
            print("Total tax: {} has confidence: {}".format(tax.value, tax.confidence))
        tip = receipt.fields.get("Tip")
        if tip:
            print("Tip: {} has confidence: {}".format(tip.value, tip.confidence))
        total = receipt.fields.get("Total")
        if total:
            print("Total: {} has confidence: {}".format(total.value, total.confidence))
        print("--------------------------------------")


if __name__ == "__main__":
    analyze_receipts()

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle de reçu.

Utiliser le modèle de pièce d’identité

import os
from azure.core.credentials import AzureKeyCredential
from azure.ai.documentintelligence import DocumentIntelligenceClient
from azure.ai.documentintelligence.models import AnalyzeResult

# use your `key` and `endpoint` environment variables
key = os.environ.get('DI_KEY')
endpoint = os.environ.get('DI_ENDPOINT')

def analyze_identity_documents():
# sample document
    identityUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/identity_documents.png"

   client = DocumentIntelligenceClient(
        endpoint=endpoint, credential=AzureKeyCredential(key)
    )

    poller =client.begin_analyze_document(
            "prebuilt-idDocument", identityUrl
        )
    id_documents = poller.result()

    for idx, id_document in enumerate(id_documents.documents):
        print("--------Analyzing ID document #{}--------".format(idx + 1))
        first_name = id_document.fields.get("FirstName")
        if first_name:
            print(
                "First Name: {} has confidence: {}".format(
                    first_name.value, first_name.confidence
                )
            )
        last_name = id_document.fields.get("LastName")
        if last_name:
            print(
                "Last Name: {} has confidence: {}".format(
                    last_name.value, last_name.confidence
                )
            )
        document_number = id_document.fields.get("DocumentNumber")
        if document_number:
            print(
                "Document Number: {} has confidence: {}".format(
                    document_number.value, document_number.confidence
                )
            )
        dob = id_document.fields.get("DateOfBirth")
        if dob:
            print(
                "Date of Birth: {} has confidence: {}".format(dob.value, dob.confidence)
            )
        doe = id_document.fields.get("DateOfExpiration")
        if doe:
            print(
                "Date of Expiration: {} has confidence: {}".format(
                    doe.value, doe.confidence
                )
            )
        sex = id_document.fields.get("Sex")
        if sex:
            print("Sex: {} has confidence: {}".format(sex.value, sex.confidence))
        address = id_document.fields.get("Address")
        if address:
            print(
                "Address: {} has confidence: {}".format(
                    address.value, address.confidence
                )
            )
        country_region = id_document.fields.get("CountryRegion")
        if country_region:
            print(
                "Country/Region: {} has confidence: {}".format(
                    country_region.value, country_region.confidence
                )
            )
        region = id_document.fields.get("Region")
        if region:
            print(
                "Region: {} has confidence: {}".format(region.value, region.confidence)
            )

        print("--------------------------------------")

if __name__ == "__main__":
    analyze_identity_documents()

Consultez le référentiel d’exemples Azure sur GitHub et examinez la sortie du modèle de document d’identité.

Remarque

Ce projet utilise l’outil en ligne de commande cURL pour exécuter les appels d’API REST.

| API REST Intelligence documentaire | Kits SDK Azure pris en charge

Prérequis

• Un abonnement Azure : créez-en un gratuitement.

• L’outil en ligne de commande curl installé. Windows 10 et Windows 11 sont livrés avec une copie de cURL. À une invite de commandes, tapez la commande cURL suivante. Si les options d’aide s’affichent, cURL est installé dans votre environnement Windows.

  curl -help
  

  Si cURL n’est pas installé, vous pouvez l’obtenir ici :

  • Windows
  • Mac ou Linux

• Une ressource Azure AI services ou Document Intelligence. Créez un service unique ou un service multiple. Vous pouvez utiliser le niveau tarifaire Gratuit (F0) pour tester le service, puis passer par la suite à un niveau payant pour la production.

• La clé et le point de terminaison de la ressource que vous créez pour connecter votre application au service Intelligence documentaire Azure.

  1. Après le déploiement de votre ressource, sélectionnez Accéder à la ressource.
  2. Dans le menu de navigation de gauche, sélectionnez Clés et point de terminaison.
  3. Copiez une des clés et le point de terminaison pour une utilisation ultérieure dans cet article.

  

Définir vos variables d’environnement

Pour interagir avec le service d’Intelligence documentaire, vous devez créer une instance de classe DocumentAnalysisClient. Pour ce faire, vous instanciez le client avec vos key et endpoint depuis le portail Azure. Pour ce projet, utilisez des variables d’environnement pour stocker des informations d’identification et y accéder.

Important

N’incluez pas votre clé directement dans le code et ne la publiez jamais publiquement. Pour la production, utilisez un moyen sécurisé pour stocker et accéder à vos informations d’identification, comme Azure Key Vault. Pour plus d’informations, veuillez consulter Sécurité d’Azure AI services.

Pour définir la variable d’environnement de votre clé de ressource Intelligence documentaire, ouvrez une fenêtre de console et suivez les instructions relatives à votre système d’exploitation et à votre environnement de développement. Remplacez <yourKey> et <yourEndpoint> par les valeurs de votre ressource dans le portail Azure.

Windows

Les variables d’environnement dans Windows ne respectent pas la casse. Elles sont généralement déclarées en majuscules, avec des mots joints par un trait de soulignement. Depuis une invite de commandes, exécutez les commandes suivantes :

1. Définissez votre variable de clé :

   setx DI_KEY <yourKey>
   

2. Définissez votre variable de point de terminaison

   setx DI_ENDPOINT <yourEndpoint>
   

3. Après avoir défini vos variables d’environnement, fermez la fenêtre d’invite de commandes. Les valeurs restent les mêmes jusqu’à ce que vous les modifiez à nouveau.

4. Redémarrez tous les programmes en cours d’exécution qui lisent la variable d’environnement. Par exemple, si vous utilisez Visual Studio ou Visual Studio Code comme éditeur, redémarrez-le avant d’exécuter l’échantillon de code.

Voici d’autres commandes utiles à utiliser avec les variables d’environnement :

Commande	Action	Exemple
setx VARIABLE_NAME=	Supprimez la variable d’environnement en définissant la valeur sur une chaîne vide.	setx DI_KEY=
setx VARIABLE_NAME=value	Définissez ou changez la valeur d’une variable d’environnement.	setx DI_KEY=<yourKey>
set VARIABLE_NAME	Affichez la valeur d’une variable d’environnement spécifique.	set DI_KEY
set	Affichez toutes les variables d’environnement.	set

macOS

Les variables d’environnement dans macOS respectent la casse. Par convention, le nom de la variable est déclaré en majuscules.

La commande export définit la variable et l’exporte dans l’environnement global, qui est disponible pour les autres processus. Cependant, la valeur est temporaire et dure seulement jusqu’au moment où vous fermez la session du terminal. Ouvrez votre terminal et entrez les commandes suivantes :

1. Définissez votre variable de clé :

   export key=<yourKey>
   

2. Définissez votre variable de point de terminaison :

   export endpoint=<yourEndpoint>
   

Pour définir une variable d’environnement de façon permanente, placez une commande d’exportation dans votre script de démarrage Bash ~/.bash_profile :

1. Utilisez un éditeur de texte pour ouvrir le fichier ~/.bash_profile et ajoutez la commande suivante pour créer une variable d’environnement permanente :

   export DI_KEY=<yourKey> DI_ENDPOINT=<yourEndpoint>
   

   Exemple : export DI_KEY="<yourKey>"

2. Enregistrez les modifications apportées au fichier bash_profile.

3. Pour que les modifications entrent en vigueur, exécutez la commande suivante dans la fenêtre du terminal :

   source ~/.bash-profile
   

Voici d’autres commandes utiles à utiliser avec les variables d’environnement :

Commande	Action	Exemple
unset VARIABLE_NAME	Supprimez une variable d’environnement.	unset DI_KEY
export VARIABLE_NAME=value	Définissez ou modifiez la valeur d’une variable d’environnement temporaire.	export DI_KEY=<yourKey>
printenv VARIABLE_NAME echo $VARIABLE_NAME	Affichez la valeur d’une variable d’environnement spécifique. Avec la commande echo, faites précéder la variable de $.	printenv DI_KEY echo $DI_KEY
printenv	Affichez toutes les variables d’environnement.	printenv

Linux

Les variables d’environnement dans Linux respectent la casse. Par convention, le nom de la variable est déclaré en majuscules.

La commande export définit la variable et l’exporte dans l’environnement global, qui est disponible pour les autres processus. Cependant, la valeur est temporaire et dure seulement jusqu’au moment où vous fermez la session du terminal :

1. Définissez votre variable de clé :

   export DI_KEY=<yourKey>
   

2. Définissez votre variable de point de terminaison :

   export DI_ENDPOINT=<yourEndpoint>
   

Pour définir une variable d’environnement de façon permanente, placez une commande d’exportation dans votre script de démarrage Bash ~/.bashrc :

1. Utilisez un éditeur de texte pour ouvrir le fichier ~/.bashrc et ajoutez la commande suivante pour créer une variable d’environnement permanente :

   export <VARIABLE>=<value>
   

   Exemple : export DI_KEY=<yourKey>

2. Enregistrez vos modifications apportées au fichier .bashrc.

3. Pour que les modifications entrent en vigueur, exécutez la commande suivante dans la fenêtre du terminal :

   source ~/.bashrc
   

Voici d’autres commandes utiles à utiliser avec les variables d’environnement :

Commande	Action	Exemple
unset VARIABLE_NAME	Supprimez une variable d’environnement.	unset DI_KEY=
export VARIABLE_NAME=value	Définissez ou modifiez la valeur d’une variable d’environnement temporaire.	export DI_KEY={yourKey}
printenv VARIABLE_NAME echo $VARIABLE_NAME	Affichez la valeur d’une variable d’environnement. Avec la commande echo, faites précéder la variable de $.	printenv DI_KEY echo $DI_KEY
printenv	Affichez toutes les variables d’environnement.	printenv

Analyser des documents et obtenir les résultats

Une requête POST est utilisée pour analyser des documents avec un modèle prédéfini ou personnalisé. Une requête GET est utilisée pour récupérer le résultat d’un appel d’analyse de document. Le modelId est utilisé avec les opérations POST et resultId avec les opérations GET.

Utilisez le tableau suivant comme référence. Remplacez <modelId> et <document-url> par les valeurs souhaitées :

Modèle	modelId	description	document-url
Modèle Read	prebuilt-read	Exemple de brochure	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/read.png
Modèle de disposition	prebuilt-layout	Exemple de confirmation de réservation	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/layout.png
Modèle de formulaire W-2	prebuilt-tax.us.w2	Exemple de formulaire W-2	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/w2.png
Modèle de facture	Facture prédéfinie	Exemple de facture	https://github.com/Azure-Samples/cognitive-services-REST-api-samples/raw/master/curl/form-recognizer/rest-api/invoice.pdf
Modèle de reçu	prebuilt-receipt	Exemple de ticket de caisse	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/receipt.png
Modèle de pièce d’identité	prebuilt-idDocument	Exemple de pièce d’identité	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/identity_documents.png

requête POST

Ouvrez une fenêtre de console et exécutez la commande cURL suivante. Les commandes incluent les variables d’environnement de point de terminaison et de clé créées dans la section Définir des variables d’environnement. Remplacez ces variables si vos noms de variables diffèrent. N’oubliez pas de remplacer les paramètres <modelId> et <document-url>.

curl -i -X POST "%DI_ENDPOINT%/documentintelligence/documentModels/{modelId}:analyze?api-version=2024-02-29-preview" -H "Content-Type: application/json" -H "Ocp-Apim-Subscription-Key: %DI_KEY%" --data-ascii "{'urlSource': '<document-url>'}"

Pour activer les fonctionnalités du module complémentaire, utilisez le paramètre de requête features dans la requête POST. Quatre fonctionnalités complémentaires sont disponibles pour les versions 2023-07-31 (GA) et ultérieures : ocr.highResolution, ocr.formula, ocr.font et queryFields.premium. Pour en savoir plus sur chacune des fonctionnalités, consultez Modèles personnalisés.

Vous pouvez appeler seulement les fonctionnalités highResolution, formule et police pour le modèle Lecture et Disposition, et la fonctionnalité queryFields pour le modèle Documents généraux. L’exemple suivant montre comment appeler les fonctionnalités highResolution, formule et police pour le modèle Disposition.

curl -i -X POST "%DI_ENDPOINT%documentintelligence/documentModels/prebuilt-layout:analyze?features=ocr.highResolution,ocr.formula,ocr.font?api-version=2024-02-29-preview" -H "Content-Type: application/json" -H "Ocp-Apim-Subscription-Key: %DI_KEY%" --data-ascii "{'urlSource': '<document-url>'}"

Réponse POST

Vous recevez une réponse 202 (Success) incluant un en-tête Operation-location. Utilisez la valeur de cet en-tête pour récupérer les résultats de la réponse.

Obtenir les résultats d’analyse (requête GET)

Après avoir appelé l’API Analyze document, appelez l’API [Get analyze result}(/rest/api/aiservices/document-models/get-analyze-result?view=rest-aiservices-2024-02-29-preview&preserve-view=true&tabs=HTTP) pour obtenir l’état de l’opération et les données extraites.

L’outil en ligne de commande cURL ne met pas en forme les réponses de l’API contenant un document JSON, ce qui peut rendre le contenu difficile à lire. Pour mettre en forme la réponse JSON, incluez le caractère de barre verticale suivi d’un outil de mise en forme JSON avec votre requête GET.

Windows

Utilisez l’outil json NodeJS comme formateur JSON pour cURL. Si vous n’avez pas installé Node.js, téléchargez et installez la dernière version.

1. Ouvrez une fenêtre de console et installez l’outil json en utilisant la commande suivante :

   npm install -g jsontool
   

2. Imprimez joliment la sortie JSON en incluant le caractère de barre verticale | json avec vos requêtes GET.

   curl -i -X GET "<endpoint>documentintelligence/documentModels/prebuilt-read/analyzeResults/0e49604a-2d8e-4b15-b6b8-bb456e5d3e0a?api-version=2024-02-29-preview"-H "Ocp-Apim-Subscription-Key: <subscription key>" | json
   

macOS

L’outil de commande json_pp est livré avec macOS et peut être utilisé comme formateur JSON pour cURL.

• Imprimez joliment la sortie JSON en incluant | json_pp avec vos requêtes GET.

  curl -i -X GET "{endpoint}documentintelligence/documentModels/prebuilt-read/analyzeResults/0e49604a-2d8e-4b15-b6b8-bb456e5d3e0a?api-version=2024-02-29-preview"-H "Ocp-Apim-Subscription-Key: <subscription key>" | json_pp
  

Linux

L’outil de ligne de commande json_pp est préinstallé dans la plupart des distributions Linux. S’il n’est pas inclus, vous pouvez utiliser le gestionnaire de package de votre distribution pour l’installer.

• Imprimez joliment la sortie JSON en incluant | json_pp avec vos requêtes GET.

  curl -i -X GET "<endpoint>documentintelligence/documentModels/prebuilt-read/analyzeResults/0e49604a-2d8e-4b15-b6b8-bb456e5d3e0a?api-version=2024-02-29-preview"-H "Ocp-Apim-Subscription-Key: <subscription key>" | json_pp
  

Requête GET

Avant d’exécuter la commande suivante, apportez ces modifications :

• Remplacez <POST response> par l’en-tête Operation-location de la réponse POST.
• Remplacez <DI_KEY par le nom de votre variable d’environnement s’il diffère du nom dans le code.
• Remplacez <json-tool> par votre outil de mise en forme JSON.

curl -i -X GET "<POST response>" -H "Ocp-Apim-Subscription-Key: %DI_KEY%" | `<json-tool>`

Examiner la réponse

Vous recevez une réponse 200 (Success) avec une sortie JSON. Le premier champ, status, indique l’état de l’opération. Si l’opération n’est pas terminée, la valeur de status est running ou notStarted. Appelez à nouveau l’API, manuellement ou via un script. Nous vous recommandons d’attendre une seconde ou plus entre chaque appel.

Visitez le référentiel d’échantillons Azure sur GitHub pour afficher la réponse GET de chacun des modèles Intelligence documentaire :

Modèle	URL de sortie
Modèle Read	Sortie du modèle de lecture
Modèle de disposition	Sortie du modèle de disposition
Modèle fiscal W-2	Sortie du modèle fiscal W-2
Modèle de facture	Sortie du modèle de facture
Modèle de reçu	Sortie du modèle de reçu
Modèle de pièce d’identité	Sortie du modèle de document d’ID

Étapes suivantes

Félicitations ! Vous avez appris à utiliser les modèles Intelligence documentaire pour analyser divers documents de différentes manières. Ensuite, explorez Intelligence documentaire Studio et la documentation de référence.

Essayer Document Intelligence StudioExplorer l’API REST Intelligence documentaire