Använda modeller för dokumentinformation

Det här innehållet gäller för:v4.0 (förhandsversion) | Tidigare versioner:v3.1 (GA)v3.0 (GA)v2.1 (GA)

I den här guiden får du lära dig hur du lägger till modeller för dokumentinformation i dina program och arbetsflöden. Använd valfri programmeringsspråk-SDK eller REST-API:et.

Azure AI Document Intelligence är en molnbaserad Azure AI-tjänst som använder maskininlärning för att extrahera nyckeltext- och strukturelement från dokument. Vi rekommenderar att du använder den kostnadsfria tjänsten medan du lär dig tekniken. Kom ihåg att antalet kostnadsfria sidor är begränsat till 500 per månad.

Välj mellan följande modeller för dokumentinformation och analysera och extrahera data och värden från formulär och dokument:

• Den fördefinierade läsmodellen är kärnan i alla modeller för dokumentinformation och kan identifiera rader, ord, platser och språk. Layout, allmänna dokument, fördefinierade och anpassade modeller använder read alla modellen som en grund för att extrahera texter från dokument.

• Den fördefinierade layoutmodellen extraherar text- och textplatser, tabeller, markeringsmarkeringar och strukturinformation från dokument och bilder. Du kan extrahera nyckel/värde-par med hjälp av layoutmodellen med den valfria frågesträngsparametern features=keyValuePairs aktiverad.

• Den fördefinierade kontraktsmodellen extraherar viktig information från avtal.

• Prebuilt-healthInsuranceCard.us-modellen extraherar viktig information från amerikanska sjukförsäkringskort.

• Den fördefinierade modellen för skattedokumentmodeller extraherar information som rapporterats på amerikanska skatteformulär.

• Den fördefinierade fakturamodellen extraherar nyckelfält och radobjekt från försäljningsfakturor i olika format och kvalitet. Fälten omfattar telefontagna bilder, skannade dokument och digitala PDF-filer.

• Den fördefinierade kvittomodellen extraherar nyckelinformation från tryckta och handskrivna försäljningskvitton.

• Modellen prebuilt-idDocument extraherar viktig information från amerikanska körkort, internationella passbiografiska sidor, amerikanska statliga ID:er, socialförsäkringskort och permanent bosatta kort.

Förutsättningar

• En Azure-prenumeration – Skapa en kostnadsfritt.

• Visual Studio IDE.

• En Azure AI-tjänst eller dokumentinformationsresurs. Skapa en enskild tjänst eller flera tjänster. Du kan använda den kostnadsfria prisnivån (F0) för att prova tjänsten och uppgradera senare till en betald nivå för produktion.

• Nyckeln och slutpunkten från resursen som du skapar för att ansluta ditt program till Azure Document Intelligence-tjänsten.

  1. När resursen har distribuerats väljer du Gå till resurs.
  2. I den vänstra navigeringsmenyn väljer du Nycklar och Slutpunkt.
  3. Kopiera en av nycklarna och slutpunkten för användning senare i den här artikeln.

  

• En dokumentfil på en URL-plats. För det här projektet kan du använda exempelformulären i följande tabell för varje funktion:

  Funktion	modelID	document-url
  Läs modell	prebuilt-read	Exempelbroschyr
  Layoutmodell	fördefinierad layout	Bokningsbekräftelse för exempel
  W-2-formulärmodell	prebuilt-tax.us.w2	Exempel på W-2-formulär
  Fakturamodell	fördefinierad faktura	Exempelfaktura
  Kvittomodell	fördefinierad kvitto	Exempelkvitto
  ID-dokumentmodell	prebuilt-idDocument	Exempel-ID-dokument
  Visitkortsmodell	prebuilt-businessCard	Exempel på visitkort

Ange miljövariabler

Om du vill interagera med document intelligence-tjänsten måste du skapa en instans av DocumentAnalysisClient klassen. Det gör du genom att instansiera klienten med din key och endpoint från Azure-portalen. I det här projektet använder du miljövariabler för att lagra och komma åt autentiseringsuppgifter.

Viktigt!

Inkludera inte din nyckel direkt i koden och publicera den aldrig offentligt. För produktion använder du ett säkert sätt att lagra och komma åt dina autentiseringsuppgifter, till exempel Azure Key Vault. Mer information finns i Säkerhet för Azure AI-tjänster.

Om du vill ange miljövariabeln för resursnyckeln för dokumentinformation öppnar du ett konsolfönster och följer anvisningarna för operativsystemet och utvecklingsmiljön. Ersätt <yourKey> och <yourEndpoint> med värdena från resursen i Azure-portalen.

Windows

Miljövariabler i Windows är inte skiftlägeskänsliga. De deklareras vanligtvis i versaler, med ord som är sammanfogade med ett understreck. Kör följande kommandon i en kommandotolk:

1. Ange nyckelvariabeln:

   setx DI_KEY <yourKey>
   

2. Ange slutpunktsvariabeln

   setx DI_ENDPOINT <yourEndpoint>
   

3. Stäng kommandotolken när du har angett miljövariabler. Värdena finns kvar tills du ändrar dem igen.

4. Starta om alla program som körs som läser miljövariabeln. Om du till exempel använder Visual Studio eller Visual Studio Code som redigeringsprogram startar du om innan du kör exempelkoden.

Här följer några fler användbara kommandon att använda med miljövariabler:

Command	Åtgärd	Exempel
setx VARIABLE_NAME=	Ta bort miljövariabeln genom att ange värdet till en tom sträng.	setx DI_KEY=
setx VARIABLE_NAME=value	Ange eller ändra värdet för en miljövariabel.	setx DI_KEY=<yourKey>
set VARIABLE_NAME	Visa värdet för en specifik miljövariabel.	set DI_KEY
set	Visa alla miljövariabler.	set

macOS

Miljövariabler i macOS är skiftlägeskänsliga. Normalt deklareras variabelnamnet med versaler.

Kommandot export anger variabeln och exporterar den till den globala miljön, som är tillgänglig för andra processer. Värdet är dock tillfälligt och varar bara tills du stänger terminalsessionen. Öppna terminalen och ange följande kommandon:

1. Ange nyckelvariabeln:

   export key=<yourKey>
   

2. Ange slutpunktsvariabeln:

   export endpoint=<yourEndpoint>
   

Om du vill ange en miljövariabel permanent placerar du ett exportkommando i bash-startskriptet ~/.bash_profile :

1. Använd en textredigerare för att öppna filen ~/.bash_profile och lägg till följande kommando för att skapa en permanent miljövariabel:

   export DI_KEY=<yourKey> DI_ENDPOINT=<yourEndpoint>
   

   Exempel: export DI_KEY="<yourKey>"

2. Spara ändringarna i filen bash_profile .

3. Om du vill att ändringarna ska gälla kör du följande kommando från terminalfönstret:

   source ~/.bash-profile
   

Här följer några fler användbara kommandon att använda med miljövariabler:

Command	Åtgärd	Exempel
unset VARIABLE_NAME	Ta bort en miljövariabel.	unset DI_KEY
export VARIABLE_NAME=value	Ange eller ändra värdet för en tillfällig miljövariabel.	export DI_KEY=<yourKey>
printenv VARIABLE_NAME echo $VARIABLE_NAME	Visa värdet för en specifik miljövariabel. echo Med kommandot föregår du variabeln med $.	printenv DI_KEY echo $DI_KEY
printenv	Visa alla miljövariabler.	printenv

Linux

Miljövariabler i Linux är skiftlägeskänsliga. Normalt deklareras variabelnamnet med versaler.

Kommandot export anger variabeln och exporterar den till den globala miljön, som är tillgänglig för andra processer. Värdet är dock tillfälligt och varar bara tills du stänger terminalsessionen:

1. Ange nyckelvariabeln:

   export DI_KEY=<yourKey>
   

2. Ange slutpunktsvariabeln:

   export DI_ENDPOINT=<yourEndpoint>
   

Om du vill ange en miljövariabel permanent placerar du ett exportkommando i bash-startskriptet ~/.bashrc :

1. Använd en textredigerare för att öppna filen ~/.bashrc och lägg till följande kommando för att skapa en permanent miljövariabel:

   export <VARIABLE>=<value>
   

   Exempel: export DI_KEY=<yourKey>

2. Spara ändringarna i .bashrc-filen .

3. Om du vill att ändringarna ska gälla kör du följande kommando från terminalfönstret:

   source ~/.bashrc
   

Här följer några fler användbara kommandon att använda med miljövariabler:

Command	Åtgärd	Exempel
unset VARIABLE_NAME	Ta bort en miljövariabel.	unset DI_KEY=
export VARIABLE_NAME=value	Ange eller ändra värdet för en tillfällig miljövariabel.	export DI_KEY={yourKey}
printenv VARIABLE_NAME echo $VARIABLE_NAME	Visa värdet för en miljövariabel. echo Med kommandot föregår du variabeln med $.	printenv DI_KEY echo $DI_KEY
printenv	Visa alla miljövariabler.	printenv

Konfigurera din programmeringsmiljö

1. Starta Visual Studio.

2. På startsidan väljer du Skapa ett nytt projekt.

   

3. På sidan Skapa ett nytt projekt anger du konsolen i sökrutan. Välj mallen Konsolprogram och välj sedan Nästa.

   

4. På sidan Konfigurera ditt nya projekt under Projektnamn anger du docIntelligence_app. Välj sedan Nästa.

   

5. På sidan Ytterligare information väljer du .NET 8.0 (långsiktigt stöd)och väljer sedan Skapa.

   

Installera klientbiblioteket med NuGet

1. Högerklicka på ditt docIntelligence_app projekt och välj Hantera NuGet-paket... .

   

2. Välj fliken Bläddra och skriv Azure.AI.FormRecognizer.

   

3. Välj en version från den nedrullningsbara menyn och installera paketet i projektet.

Skapa ditt program

Kommentar

Från och med .NET 6 genererar nya projekt med mallen console ett nytt programformat som skiljer sig från tidigare versioner. De nya utdata använder de senaste C#-funktionerna som förenklar koden du behöver skriva.

När du använder den nyare versionen behöver du bara skriva metodens Main brödtext. Du behöver inte inkludera toppnivåinstruktioner, globala användningsdirektiv eller implicita med hjälp av direktiv. Mer information finns i C#-konsolappmallen genererar toppnivåinstruktioner.

1. Öppna filen Program.cs .

2. Ta bort den befintliga koden, inklusive raden Console.Writeline("Hello World!").

3. Välj något av följande kodexempel och kopiera/klistra in i programmets Program.cs-fil :

   • prebuilt-read
   • fördefinierad layout
   • prebuilt-tax.us.w2
   • fördefinierad faktura
   • fördefinierad kvitto
   • prebuilt-idDocument

4. När du har lagt till ett kodexempel i programmet väljer du den gröna Start-knappen bredvid projektnamnet för att skapa och köra programmet, eller tryck på F5.

   

Använda läsmodellen

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}.");
}

Besök Azure-exempellagringsplatsen på GitHub och visa read modellutdata.

Använda layoutmodellen

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}'.");
    }
}

Besök Azure-exempellagringsplatsen på GitHub och visa utdata för layoutmodellen.

Använda dokumentmodellen Allmänt

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}'.");
    }
}

Besök Azure-exempellagringsplatsen på GitHub och visa de allmänna dokumentmodellutdata.

Använda W-2-skattemodellen

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}");
                }
            }
        }
    }
}

Besök Azure-exempellagringsplatsen på GitHub och visa utdata från W-2-skattemodellen.

Använda fakturamodellen

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}");
        }
    }
}

Besök Azure-exempellagringsplatsen på GitHub och visa fakturamodellens utdata.

Använda kvittomodellen

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}'");
        }
    }
}

Besök Azure-exempellagringsplatsen på GitHub och visa kvittomodellens utdata.

ID-dokumentmodell

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}");
    }
}

Besök Azure-exempellagringsplatsen på GitHub och visa id-dokumentmodellens utdata.

Använda visitkortsmodellen

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}");
                }
            }
        }
    }
}

Besök Azure-exempellagringsplatsen på GitHub och visa utdata från visitkortsmodellen.

Klientbibliotekets SDK-referens | REST API-referenspaket | (Maven) | Exempel |som stöds REST API-version |

Förutsättningar

• En Azure-prenumeration – Skapa en kostnadsfritt.

• Den senaste versionen av Visual Studio Code eller önskad IDE. Se Java i Visual Studio Code.

  • Visual Studio Code erbjuder ett kodningspaket för Java för Windows och macOS. Kodningspaketet är ett paket VS med Kod, Java Development Kit (JDK) och en samling föreslagna tillägg från Microsoft. Kodningspaketet kan också användas för att åtgärda en befintlig utvecklingsmiljö.
  • Om du använder VS Kod och kodningspaketet för Java installerar du Tillägget Gradle för Java .

  Om du inte använder Visual Studio Code kontrollerar du att följande är installerat i utvecklingsmiljön:

  • Java Development Kit (JDK) version 8 eller senare. Mer information finns i Microsoft Build of OpenJDK.
  • Gradle, version 6.8 eller senare.

• En Azure AI-tjänst eller dokumentinformationsresurs. Skapa en enskild tjänst eller flera tjänster. Du kan använda den kostnadsfria prisnivån (F0) för att prova tjänsten och uppgradera senare till en betald nivå för produktion.

  Dricks

  Skapa en Azure AI-tjänstresurs om du planerar att komma åt flera Azure AI-tjänster med hjälp av en enda slutpunkt och nyckel. För endast åtkomst till dokumentinformation skapar du en dokumentinformationsresurs. Du behöver en resurs med en enda tjänst om du tänker använda Microsoft Entra-autentisering.

• Nyckeln och slutpunkten från resursen som du skapar för att ansluta ditt program till Azure Document Intelligence-tjänsten.

  1. När resursen har distribuerats väljer du Gå till resurs.
  2. I den vänstra navigeringsmenyn väljer du Nycklar och Slutpunkt.
  3. Kopiera en av nycklarna och slutpunkten för användning senare i den här artikeln.

  

• En dokumentfil på en URL. För det här projektet kan du använda exempelformulären i följande tabell för varje funktion:

  Funktion	modelID	document-url
  Läs modell	prebuilt-read	Exempelbroschyr
  Layoutmodell	fördefinierad layout	Bokningsbekräftelse för exempel
  W-2-formulärmodell	prebuilt-tax.us.w2	Exempel på W-2-formulär
  Fakturamodell	fördefinierad faktura	Exempelfaktura
  Kvittomodell	fördefinierad kvitto	Exempelkvitto
  ID-dokumentmodell	prebuilt-idDocument	Exempel-ID-dokument

Ange miljövariabler

Om du vill interagera med document intelligence-tjänsten måste du skapa en instans av DocumentAnalysisClient klassen. Det gör du genom att instansiera klienten med din key och endpoint från Azure-portalen. I det här projektet använder du miljövariabler för att lagra och komma åt autentiseringsuppgifter.

Viktigt!

Inkludera inte din nyckel direkt i koden och publicera den aldrig offentligt. För produktion använder du ett säkert sätt att lagra och komma åt dina autentiseringsuppgifter, till exempel Azure Key Vault. Mer information finns i Säkerhet för Azure AI-tjänster.

Om du vill ange miljövariabeln för resursnyckeln för dokumentinformation öppnar du ett konsolfönster och följer anvisningarna för operativsystemet och utvecklingsmiljön. Ersätt <yourKey> och <yourEndpoint> med värdena från resursen i Azure-portalen.

Windows

Miljövariabler i Windows är inte skiftlägeskänsliga. De deklareras vanligtvis i versaler, med ord som är sammanfogade med ett understreck. Kör följande kommandon i en kommandotolk:

1. Ange nyckelvariabeln:

   setx DI_KEY <yourKey>
   

2. Ange slutpunktsvariabeln

   setx DI_ENDPOINT <yourEndpoint>
   

3. Stäng kommandotolken när du har angett miljövariabler. Värdena finns kvar tills du ändrar dem igen.

4. Starta om alla program som körs som läser miljövariabeln. Om du till exempel använder Visual Studio eller Visual Studio Code som redigeringsprogram startar du om innan du kör exempelkoden.

Här följer några fler användbara kommandon att använda med miljövariabler:

Command	Åtgärd	Exempel
setx VARIABLE_NAME=	Ta bort miljövariabeln genom att ange värdet till en tom sträng.	setx DI_KEY=
setx VARIABLE_NAME=value	Ange eller ändra värdet för en miljövariabel.	setx DI_KEY=<yourKey>
set VARIABLE_NAME	Visa värdet för en specifik miljövariabel.	set DI_KEY
set	Visa alla miljövariabler.	set

macOS

Miljövariabler i macOS är skiftlägeskänsliga. Normalt deklareras variabelnamnet med versaler.

Kommandot export anger variabeln och exporterar den till den globala miljön, som är tillgänglig för andra processer. Värdet är dock tillfälligt och varar bara tills du stänger terminalsessionen. Öppna terminalen och ange följande kommandon:

1. Ange nyckelvariabeln:

   export key=<yourKey>
   

2. Ange slutpunktsvariabeln:

   export endpoint=<yourEndpoint>
   

Om du vill ange en miljövariabel permanent placerar du ett exportkommando i bash-startskriptet ~/.bash_profile :

1. Använd en textredigerare för att öppna filen ~/.bash_profile och lägg till följande kommando för att skapa en permanent miljövariabel:

   export DI_KEY=<yourKey> DI_ENDPOINT=<yourEndpoint>
   

   Exempel: export DI_KEY="<yourKey>"

2. Spara ändringarna i filen bash_profile .

3. Om du vill att ändringarna ska gälla kör du följande kommando från terminalfönstret:

   source ~/.bash-profile
   

Här följer några fler användbara kommandon att använda med miljövariabler:

Command	Åtgärd	Exempel
unset VARIABLE_NAME	Ta bort en miljövariabel.	unset DI_KEY
export VARIABLE_NAME=value	Ange eller ändra värdet för en tillfällig miljövariabel.	export DI_KEY=<yourKey>
printenv VARIABLE_NAME echo $VARIABLE_NAME	Visa värdet för en specifik miljövariabel. echo Med kommandot föregår du variabeln med $.	printenv DI_KEY echo $DI_KEY
printenv	Visa alla miljövariabler.	printenv

Linux

Miljövariabler i Linux är skiftlägeskänsliga. Normalt deklareras variabelnamnet med versaler.

Kommandot export anger variabeln och exporterar den till den globala miljön, som är tillgänglig för andra processer. Värdet är dock tillfälligt och varar bara tills du stänger terminalsessionen:

1. Ange nyckelvariabeln:

   export DI_KEY=<yourKey>
   

2. Ange slutpunktsvariabeln:

   export DI_ENDPOINT=<yourEndpoint>
   

Om du vill ange en miljövariabel permanent placerar du ett exportkommando i bash-startskriptet ~/.bashrc :

1. Använd en textredigerare för att öppna filen ~/.bashrc och lägg till följande kommando för att skapa en permanent miljövariabel:

   export <VARIABLE>=<value>
   

   Exempel: export DI_KEY=<yourKey>

2. Spara ändringarna i .bashrc-filen .

3. Om du vill att ändringarna ska gälla kör du följande kommando från terminalfönstret:

   source ~/.bashrc
   

Här följer några fler användbara kommandon att använda med miljövariabler:

Command	Åtgärd	Exempel
unset VARIABLE_NAME	Ta bort en miljövariabel.	unset DI_KEY=
export VARIABLE_NAME=value	Ange eller ändra värdet för en tillfällig miljövariabel.	export DI_KEY={yourKey}
printenv VARIABLE_NAME echo $VARIABLE_NAME	Visa värdet för en miljövariabel. echo Med kommandot föregår du variabeln med $.	printenv DI_KEY echo $DI_KEY
printenv	Visa alla miljövariabler.	printenv

Konfigurera din programmeringsmiljö

Om du vill konfigurera programmeringsmiljön skapar du ett Gradle-projekt och installerar klientbiblioteket.

Skapa ett Gradle-projekt

1. I ett konsolfönster skapar du en katalog för din app med namnet doc-intelligence-app och navigerar till den.

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

2. Kör kommandot från arbetskatalogen gradle init . Det här kommandot skapar viktiga byggfiler för Gradle, inklusive build.gradle.kts, som används vid körning för att skapa och konfigurera ditt program.

   gradle init --type basic
   

3. Välj en DSL när du uppmanas till det och välj Kotlin.

4. Välj Retur för att acceptera standardprojektets namn, doc-intelligence-app.

Installera klientbiblioteket

I den här artikeln används Gradle-beroendehanteraren. Du hittar klientbiblioteket och information för andra beroendehanterare på Den centrala Maven-lagringsplatsen.

1. Öppna projektets build.gradle.kts-fil i din IDE. Kopiera och klistra in följande kod för att inkludera klientbiblioteket som en implementation instruktion, tillsammans med nödvändiga plugin-program och inställningar.

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

Skapa ett Java-program

Om du vill interagera med document intelligence-tjänsten skapar du en instans av DocumentIntelligenceClient klassen. För att göra det skapar du en AzureKeyCredential med din key från Azure-portalen och en DocumentIntelligenceClient instans med och dokumentinformationen AzureKeyCredentialendpoint.

1. Kör följande kommando från katalogen doc-intelligence-app :

   mkdir -p src/main/java
   

Kommandot skapar följande katalogstruktur:

1. Navigera till java katalogen och skapa en fil med namnet DocIntelligence.java.

   Dricks

   Du kan skapa en ny fil med hjälp av PowerShell. Öppna ett PowerShell-fönster i projektkatalogen genom att hålla ned Skift-tangenten och högerklicka på mappen och skriv sedan följande kommando: New-Item DocIntelligence.java.

2. Öppna filen DocIntelligence.java och välj något av följande kodexempel OCH kopiera/klistra in i ditt program:

   • Den fördefinierade läsmodellen är kärnan i alla modeller för dokumentinformation och kan identifiera rader, ord, platser och språk. Layouten, det allmänna dokumentet, de fördefinierade och anpassade modellerna använder read alla modellen som grund för att extrahera texter från dokument.
   • Den fördefinierade layoutmodellen extraherar text- och textplatser, tabeller, markeringsmarkeringar och strukturinformation från dokument och bilder.
   • Modellen prebuilt-tax.us.w2 extraherar information som rapporterats på skatteformulär för US Internal Revenue Service (IRS).
   • Den fördefinierade fakturamodellen extraherar nyckelfält och radobjekt från försäljningsfakturor i olika format.
   • Den fördefinierade kvittomodellen extraherar nyckelinformation från tryckta och handskrivna försäljningskvitton.
   • Modellen prebuilt-idDocument extraherar viktig information från amerikanska körkort; internationella pass biografiska sidor; AMERIKANSKA tillstånds-ID: ar; socialförsäkringskort. och permanent bosatta kort.

3. Skriv följande kommandon:

   gradle build
   gradle run
   

Använda läsmodellen

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()));
});
}
}

Besök Azure-exempellagringsplatsen på GitHub och visa read modellutdata.

Använda layoutmodellen

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(", "));
}

}

Besök Azure-exempellagringsplatsen på GitHub och visa utdata för layoutmodellen.

Använda dokumentmodellen Allmänt

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());
  }
});

}

}

Besök Azure-exempellagringsplatsen på GitHub och visa de allmänna dokumentmodellutdata.

Använda W-2-skattemodellen

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());
    }
  }
}
}
}

Besök Azure-exempellagringsplatsen på GitHub och visa utdata från W-2-skattemodellen.

Använda fakturamodellen

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());
            }
          }
        }));
    }
  }
}
}
}

Besök Azure-exempellagringsplatsen på GitHub och visa fakturamodellens utdata.

Använda kvittomodellen

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());
            }
          }
        }));
    }
  }
}
}
}

Besök Azure-exempellagringsplatsen på GitHub och visa kvittomodellens utdata.

Använda ID-dokumentmodellen

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());
    }
  }
}
}
}

Besök Azure-exempellagringsplatsen på GitHub och visa utdata för ID-dokumentmodellen.

REST API-referenspaket för klientbibliotek | (npm) | Exempel |som stöds REST API-version |

Förutsättningar

• En Azure-prenumeration – Skapa en kostnadsfritt.

• Den senaste versionen av Visual Studio Code eller önskad IDE. Mer information finns i Node.js i Visual Studio Code.

• Den senaste LTS versionen av Node.js.

• En Azure AI-tjänst eller dokumentinformationsresurs. Skapa en enskild tjänst eller flera tjänster. Du kan använda den kostnadsfria prisnivån (F0) för att prova tjänsten och uppgradera senare till en betald nivå för produktion.

  Dricks

  Skapa en Azure AI-tjänstresurs om du planerar att komma åt flera Azure AI-tjänster med hjälp av en enda slutpunkt och nyckel. För endast åtkomst till dokumentinformation skapar du en dokumentinformationsresurs. Du behöver en resurs med en enda tjänst om du tänker använda Microsoft Entra-autentisering.

• Nyckeln och slutpunkten från resursen som du skapar för att ansluta ditt program till Azure Document Intelligence-tjänsten.

  1. När resursen har distribuerats väljer du Gå till resurs.
  2. I den vänstra navigeringsmenyn väljer du Nycklar och Slutpunkt.
  3. Kopiera en av nycklarna och slutpunkten för användning senare i den här artikeln.

  

• En dokumentfil på en URL. För det här projektet kan du använda exempelformulären i följande tabell för varje funktion:

  Funktion	modelID	document-url
  Läs modell	prebuilt-read	Exempelbroschyr
  Layoutmodell	fördefinierad layout	Bokningsbekräftelse för exempel
  W-2-formulärmodell	prebuilt-tax.us.w2	Exempel på W-2-formulär
  Fakturamodell	fördefinierad faktura	Exempelfaktura
  Kvittomodell	fördefinierad kvitto	Exempelkvitto
  ID-dokumentmodell	prebuilt-idDocument	Exempel-ID-dokument

Ange miljövariabler

Om du vill interagera med document intelligence-tjänsten måste du skapa en instans av DocumentAnalysisClient klassen. Det gör du genom att instansiera klienten med din key och endpoint från Azure-portalen. I det här projektet använder du miljövariabler för att lagra och komma åt autentiseringsuppgifter.

Viktigt!

Inkludera inte din nyckel direkt i koden och publicera den aldrig offentligt. För produktion använder du ett säkert sätt att lagra och komma åt dina autentiseringsuppgifter, till exempel Azure Key Vault. Mer information finns i Säkerhet för Azure AI-tjänster.

Om du vill ange miljövariabeln för resursnyckeln för dokumentinformation öppnar du ett konsolfönster och följer anvisningarna för operativsystemet och utvecklingsmiljön. Ersätt <yourKey> och <yourEndpoint> med värdena från resursen i Azure-portalen.

Windows

Miljövariabler i Windows är inte skiftlägeskänsliga. De deklareras vanligtvis i versaler, med ord som är sammanfogade med ett understreck. Kör följande kommandon i en kommandotolk:

1. Ange nyckelvariabeln:

   setx DI_KEY <yourKey>
   

2. Ange slutpunktsvariabeln

   setx DI_ENDPOINT <yourEndpoint>
   

3. Stäng kommandotolken när du har angett miljövariabler. Värdena finns kvar tills du ändrar dem igen.

4. Starta om alla program som körs som läser miljövariabeln. Om du till exempel använder Visual Studio eller Visual Studio Code som redigeringsprogram startar du om innan du kör exempelkoden.

Här följer några fler användbara kommandon att använda med miljövariabler:

Command	Åtgärd	Exempel
setx VARIABLE_NAME=	Ta bort miljövariabeln genom att ange värdet till en tom sträng.	setx DI_KEY=
setx VARIABLE_NAME=value	Ange eller ändra värdet för en miljövariabel.	setx DI_KEY=<yourKey>
set VARIABLE_NAME	Visa värdet för en specifik miljövariabel.	set DI_KEY
set	Visa alla miljövariabler.	set

macOS

Miljövariabler i macOS är skiftlägeskänsliga. Normalt deklareras variabelnamnet med versaler.

Kommandot export anger variabeln och exporterar den till den globala miljön, som är tillgänglig för andra processer. Värdet är dock tillfälligt och varar bara tills du stänger terminalsessionen. Öppna terminalen och ange följande kommandon:

1. Ange nyckelvariabeln:

   export key=<yourKey>
   

2. Ange slutpunktsvariabeln:

   export endpoint=<yourEndpoint>
   

Om du vill ange en miljövariabel permanent placerar du ett exportkommando i bash-startskriptet ~/.bash_profile :

1. Använd en textredigerare för att öppna filen ~/.bash_profile och lägg till följande kommando för att skapa en permanent miljövariabel:

   export DI_KEY=<yourKey> DI_ENDPOINT=<yourEndpoint>
   

   Exempel: export DI_KEY="<yourKey>"

2. Spara ändringarna i filen bash_profile .

3. Om du vill att ändringarna ska gälla kör du följande kommando från terminalfönstret:

   source ~/.bash-profile
   

Här följer några fler användbara kommandon att använda med miljövariabler:

Command	Åtgärd	Exempel
unset VARIABLE_NAME	Ta bort en miljövariabel.	unset DI_KEY
export VARIABLE_NAME=value	Ange eller ändra värdet för en tillfällig miljövariabel.	export DI_KEY=<yourKey>
printenv VARIABLE_NAME echo $VARIABLE_NAME	Visa värdet för en specifik miljövariabel. echo Med kommandot föregår du variabeln med $.	printenv DI_KEY echo $DI_KEY
printenv	Visa alla miljövariabler.	printenv

Linux

Miljövariabler i Linux är skiftlägeskänsliga. Normalt deklareras variabelnamnet med versaler.

Kommandot export anger variabeln och exporterar den till den globala miljön, som är tillgänglig för andra processer. Värdet är dock tillfälligt och varar bara tills du stänger terminalsessionen:

1. Ange nyckelvariabeln:

   export DI_KEY=<yourKey>
   

2. Ange slutpunktsvariabeln:

   export DI_ENDPOINT=<yourEndpoint>
   

Om du vill ange en miljövariabel permanent placerar du ett exportkommando i bash-startskriptet ~/.bashrc :

1. Använd en textredigerare för att öppna filen ~/.bashrc och lägg till följande kommando för att skapa en permanent miljövariabel:

   export <VARIABLE>=<value>
   

   Exempel: export DI_KEY=<yourKey>

2. Spara ändringarna i .bashrc-filen .

3. Om du vill att ändringarna ska gälla kör du följande kommando från terminalfönstret:

   source ~/.bashrc
   

Här följer några fler användbara kommandon att använda med miljövariabler:

Command	Åtgärd	Exempel
unset VARIABLE_NAME	Ta bort en miljövariabel.	unset DI_KEY=
export VARIABLE_NAME=value	Ange eller ändra värdet för en tillfällig miljövariabel.	export DI_KEY={yourKey}
printenv VARIABLE_NAME echo $VARIABLE_NAME	Visa värdet för en miljövariabel. echo Med kommandot föregår du variabeln med $.	printenv DI_KEY echo $DI_KEY
printenv	Visa alla miljövariabler.	printenv

Konfigurera din programmeringsmiljö

Skapa ett Node.js Express-program.

1. I ett konsolfönster skapar och navigerar du till en ny katalog för din app med namnet doc-intel-app.

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

2. npm init Kör kommandot för att initiera programmet och skapa en autogenerering av projektet.

   npm init
   

3. Ange projektets attribut med hjälp av de prompter som visas i terminalen.

   • De viktigaste attributen är namn, versionsnummer och startpunkt.
   • Vi rekommenderar att du behåller index.js namnet på startpunkten. Beskrivningen, testkommandot, GitHub-lagringsplatsen, nyckelord, författare och licensinformation är valfria attribut. Du kan hoppa över dem för det här projektet.
   • Välj Retur för att acceptera förslagen inom parenteser.

   När du har slutfört anvisningarna skapar kommandot en package.json fil i katalogen doc-intel-app .

4. ai-document-intelligence Installera klientbiblioteket och azure/identity npm-paketen:

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

Appens package.json-fil uppdateras med beroendena.

1. Skapa en fil med namnet index.js i programkatalogen.

   Dricks

   Du kan skapa en ny fil med hjälp av PowerShell. Öppna ett PowerShell-fönster i projektkatalogen genom att hålla ned Skift-tangenten och högerklicka på mappen och skriv sedan följande kommando: New-Item index.js.

Skapa ditt program

Om du vill interagera med document intelligence-tjänsten måste du skapa en instans av DocumentIntelligenceClient klassen. För att göra det skapar du en AzureKeyCredential med din nyckel från Azure-portalen och en DocumentIntelligenceClient instans med AzureKeyCredential slutpunkten och dokumentinformationen.

index.js Öppna filen i Visual Studio Code eller din favorit-IDE och välj något av följande kodexempel och kopiera/klistra in i ditt program:

• Den fördefinierade läsmodellen är kärnan i alla modeller för dokumentinformation och kan identifiera rader, ord, platser och språk. Layouten, det allmänna dokumentet, de fördefinierade och anpassade modellerna använder read alla modellen som grund för att extrahera texter från dokument.
• Den fördefinierade layoutmodellen extraherar text- och textplatser, tabeller, markeringsmarkeringar och strukturinformation från dokument och bilder.
• Modellen prebuilt-tax.us.w2 extraherar information som rapporterats på skatteformulär för US Internal Revenue Service (IRS).
• Den fördefinierade fakturamodellen extraherar information som rapporterats på amerikanska skatteformulär för intern intäkt.
• Den fördefinierade kvittomodellen extraherar nyckelinformation från tryckta och handskrivna försäljningskvitton.
• Modellen prebuilt-idDocument extraherar viktig information från amerikanska körkort; internationella pass biografiska sidor; AMERIKANSKA tillstånds-ID: ar; socialförsäkringskort. och permanent bosatta kort.

Använda läsmodellen

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);
});

Besök Azure-exempellagringsplatsen på GitHub och visa read modellutdata.

Använda layoutmodellen

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);
  });

Besök Azure-exempellagringsplatsen på GitHub och visa utdata för layoutmodellen.

Använda dokumentmodellen Allmänt

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);
});

Besök Azure-exempellagringsplatsen på GitHub och visa de allmänna dokumentmodellutdata.

Använda W-2-skattemodellen

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);
});

Besök Azure-exempellagringsplatsen på GitHub och visa utdata från W-2-skattemodellen.

Använda fakturamodellen

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);
});

Besök Azure-exempellagringsplatsen på GitHub och visa fakturamodellens utdata.

Använda kvittomodellen

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);
});

Besök Azure-exempellagringsplatsen på GitHub och visa kvittomodellens utdata.

Använda ID-dokumentmodellen

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);
});

Besök Azure-exempellagringsplatsen på GitHub och visa utdata för ID-dokumentmodellen.

Klientbibliotekets SDK-referens | REST API-referenspaket | (PyPi) | Exempel | som stöds REST API-version |

Förutsättningar

• En Azure-prenumeration – Skapa en kostnadsfritt.

• Python 3.7 eller senare. Python-installationen bör innehålla pip. Du kan kontrollera om du har pip installerat genom att köra pip --version på kommandoraden. Hämta pip genom att installera den senaste versionen av Python.

• Den senaste versionen av Visual Studio Code eller önskad IDE. Se Komma igång med Python i Visual Studio Code.

• En Azure AI-tjänst eller dokumentinformationsresurs. Skapa en enskild tjänst eller flera tjänster. Du kan använda den kostnadsfria prisnivån (F0) för att prova tjänsten och uppgradera senare till en betald nivå för produktion.

• Nyckeln och slutpunkten från resursen som du skapar för att ansluta ditt program till Azure Document Intelligence-tjänsten.

  1. När resursen har distribuerats väljer du Gå till resurs.
  2. I den vänstra navigeringsmenyn väljer du Nycklar och Slutpunkt.
  3. Kopiera en av nycklarna och slutpunkten för användning senare i den här artikeln.

  

• En dokumentfil på en URL. För det här projektet kan du använda exempelformulären i följande tabell för varje funktion:

  Funktion	modelID	document-url
  Läs modell	prebuilt-read	Exempelbroschyr
  Layoutmodell	fördefinierad layout	Bokningsbekräftelse för exempel
  W-2-formulärmodell	prebuilt-tax.us.w2	Exempel på W-2-formulär
  Fakturamodell	fördefinierad faktura	Exempelfaktura
  Kvittomodell	fördefinierad kvitto	Exempelkvitto
  ID-dokumentmodell	prebuilt-idDocument	Exempel-ID-dokument

Ange miljövariabler

Om du vill interagera med document intelligence-tjänsten måste du skapa en instans av DocumentAnalysisClient klassen. Det gör du genom att instansiera klienten med din key och endpoint från Azure-portalen. I det här projektet använder du miljövariabler för att lagra och komma åt autentiseringsuppgifter.

Viktigt!

Inkludera inte din nyckel direkt i koden och publicera den aldrig offentligt. För produktion använder du ett säkert sätt att lagra och komma åt dina autentiseringsuppgifter, till exempel Azure Key Vault. Mer information finns i Säkerhet för Azure AI-tjänster.

Om du vill ange miljövariabeln för resursnyckeln för dokumentinformation öppnar du ett konsolfönster och följer anvisningarna för operativsystemet och utvecklingsmiljön. Ersätt <yourKey> och <yourEndpoint> med värdena från resursen i Azure-portalen.

Windows

Miljövariabler i Windows är inte skiftlägeskänsliga. De deklareras vanligtvis i versaler, med ord som är sammanfogade med ett understreck. Kör följande kommandon i en kommandotolk:

1. Ange nyckelvariabeln:

   setx DI_KEY <yourKey>
   

2. Ange slutpunktsvariabeln

   setx DI_ENDPOINT <yourEndpoint>
   

3. Stäng kommandotolken när du har angett miljövariabler. Värdena finns kvar tills du ändrar dem igen.

4. Starta om alla program som körs som läser miljövariabeln. Om du till exempel använder Visual Studio eller Visual Studio Code som redigeringsprogram startar du om innan du kör exempelkoden.

Här följer några fler användbara kommandon att använda med miljövariabler:

Command	Åtgärd	Exempel
setx VARIABLE_NAME=	Ta bort miljövariabeln genom att ange värdet till en tom sträng.	setx DI_KEY=
setx VARIABLE_NAME=value	Ange eller ändra värdet för en miljövariabel.	setx DI_KEY=<yourKey>
set VARIABLE_NAME	Visa värdet för en specifik miljövariabel.	set DI_KEY
set	Visa alla miljövariabler.	set

macOS

Miljövariabler i macOS är skiftlägeskänsliga. Normalt deklareras variabelnamnet med versaler.

Kommandot export anger variabeln och exporterar den till den globala miljön, som är tillgänglig för andra processer. Värdet är dock tillfälligt och varar bara tills du stänger terminalsessionen. Öppna terminalen och ange följande kommandon:

1. Ange nyckelvariabeln:

   export key=<yourKey>
   

2. Ange slutpunktsvariabeln:

   export endpoint=<yourEndpoint>
   

Om du vill ange en miljövariabel permanent placerar du ett exportkommando i bash-startskriptet ~/.bash_profile :

1. Använd en textredigerare för att öppna filen ~/.bash_profile och lägg till följande kommando för att skapa en permanent miljövariabel:

   export DI_KEY=<yourKey> DI_ENDPOINT=<yourEndpoint>
   

   Exempel: export DI_KEY="<yourKey>"

2. Spara ändringarna i filen bash_profile .

3. Om du vill att ändringarna ska gälla kör du följande kommando från terminalfönstret:

   source ~/.bash-profile
   

Här följer några fler användbara kommandon att använda med miljövariabler:

Command	Åtgärd	Exempel
unset VARIABLE_NAME	Ta bort en miljövariabel.	unset DI_KEY
export VARIABLE_NAME=value	Ange eller ändra värdet för en tillfällig miljövariabel.	export DI_KEY=<yourKey>
printenv VARIABLE_NAME echo $VARIABLE_NAME	Visa värdet för en specifik miljövariabel. echo Med kommandot föregår du variabeln med $.	printenv DI_KEY echo $DI_KEY
printenv	Visa alla miljövariabler.	printenv

Linux

Miljövariabler i Linux är skiftlägeskänsliga. Normalt deklareras variabelnamnet med versaler.

Kommandot export anger variabeln och exporterar den till den globala miljön, som är tillgänglig för andra processer. Värdet är dock tillfälligt och varar bara tills du stänger terminalsessionen:

1. Ange nyckelvariabeln:

   export DI_KEY=<yourKey>
   

2. Ange slutpunktsvariabeln:

   export DI_ENDPOINT=<yourEndpoint>
   

Om du vill ange en miljövariabel permanent placerar du ett exportkommando i bash-startskriptet ~/.bashrc :

1. Använd en textredigerare för att öppna filen ~/.bashrc och lägg till följande kommando för att skapa en permanent miljövariabel:

   export <VARIABLE>=<value>
   

   Exempel: export DI_KEY=<yourKey>

2. Spara ändringarna i .bashrc-filen .

3. Om du vill att ändringarna ska gälla kör du följande kommando från terminalfönstret:

   source ~/.bashrc
   

Här följer några fler användbara kommandon att använda med miljövariabler:

Command	Åtgärd	Exempel
unset VARIABLE_NAME	Ta bort en miljövariabel.	unset DI_KEY=
export VARIABLE_NAME=value	Ange eller ändra värdet för en tillfällig miljövariabel.	export DI_KEY={yourKey}
printenv VARIABLE_NAME echo $VARIABLE_NAME	Visa värdet för en miljövariabel. echo Med kommandot föregår du variabeln med $.	printenv DI_KEY echo $DI_KEY
printenv	Visa alla miljövariabler.	printenv

Konfigurera din programmeringsmiljö

Öppna ett konsolfönster i din lokala miljö och installera Azure AI Document Intelligence-klientbiblioteket för Python med pip:

pip install azure-ai-documentintelligence==1.0.0b2

Skapa ditt Python-program

Om du vill interagera med document intelligence-tjänsten måste du skapa en instans av DocumentIntelligenceClient klassen. För att göra det skapar du en AzureKeyCredential med din nyckel från Azure-portalen och en DocumentIntelligenceClient instans med AzureKeyCredential slutpunkten och dokumentinformationen.

1. Skapa en ny Python-fil med namnet form_recognizer_quickstart.py i en redigerare eller IDE.

2. Öppna filen form_recognizer_quickstart.py och välj något av följande kodexempel och kopiera/klistra in i ditt program:

   • Den fördefinierade läsmodellen är kärnan i alla modeller för dokumentinformation och kan identifiera rader, ord, platser och språk. Layouten, det allmänna dokumentet, de fördefinierade och anpassade modellerna använder read alla modellen som grund för att extrahera texter från dokument.
   • Den fördefinierade layoutmodellen extraherar text- och textplatser, tabeller, markeringsmarkeringar och strukturinformation från dokument och bilder.
   • Modellen prebuilt-tax.us.w2 extraherar information som rapporterats på skatteformulär för US Internal Revenue Service (IRS).
   • Den fördefinierade fakturamodellen extraherar nyckelfält och radobjekt från försäljningsfakturor i olika format.
   • Den fördefinierade kvittomodellen extraherar nyckelinformation från tryckta och handskrivna försäljningskvitton.
   • Modellen prebuilt-idDocument extraherar viktig information från amerikanska körkort; internationella pass biografiska sidor; AMERIKANSKA tillstånds-ID: ar; socialförsäkringskort. och permanent bosatta kort.

3. Kör Python-koden från kommandotolken.

   python form_recognizer_quickstart.py
   

Använda läsmodellen

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()

Besök Azure-exempellagringsplatsen på GitHub och visa read modellutdata.

Använda layoutmodellen

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()

Besök Azure-exempellagringsplatsen på GitHub och visa utdata för layoutmodellen.

Använda dokumentmodellen Allmänt

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()

Besök Azure-exempellagringsplatsen på GitHub och visa de allmänna dokumentmodellutdata.

Använda W-2-skattemodellen

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()

Besök Azure-exempellagringsplatsen på GitHub och visa utdata från W-2-skattemodellen.

Använda fakturamodellen

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()

Besök Azure-exempellagringsplatsen på GitHub och visa fakturamodellens utdata.

Använda kvittomodellen

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()

Besök Azure-exempellagringsplatsen på GitHub och visa kvittomodellens utdata.

Använda ID-dokumentmodellen

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()

Besök Azure-exempellagringsplatsen på GitHub och visa utdata för ID-dokumentmodellen.

Kommentar

Det här projektet använder kommandoradsverktyget cURL för att köra REST API-anrop.

| Rest API för | dokumentinformation som stöds av Azure SDKS

Förutsättningar

• En Azure-prenumeration – Skapa en kostnadsfritt.

• CURL-kommandoradsverktyget installerat. Windows 10 och Windows 11 levereras med en kopia av cURL. I en kommandotolk skriver du följande cURL-kommando. Om hjälpalternativen visas installeras cURL i Din Windows-miljö.

  curl -help
  

  Om cURL inte är installerat kan du hämta det här:

  • Windows
  • Mac eller Linux

• En Azure AI-tjänst eller dokumentinformationsresurs. Skapa en enskild tjänst eller flera tjänster. Du kan använda den kostnadsfria prisnivån (F0) för att prova tjänsten och uppgradera senare till en betald nivå för produktion.

• Nyckeln och slutpunkten från resursen som du skapar för att ansluta ditt program till Azure Document Intelligence-tjänsten.

  1. När resursen har distribuerats väljer du Gå till resurs.
  2. I den vänstra navigeringsmenyn väljer du Nycklar och Slutpunkt.
  3. Kopiera en av nycklarna och slutpunkten för användning senare i den här artikeln.

  

Ange miljövariabler

Om du vill interagera med document intelligence-tjänsten måste du skapa en instans av DocumentAnalysisClient klassen. Det gör du genom att instansiera klienten med din key och endpoint från Azure-portalen. I det här projektet använder du miljövariabler för att lagra och komma åt autentiseringsuppgifter.

Viktigt!

Inkludera inte din nyckel direkt i koden och publicera den aldrig offentligt. För produktion använder du ett säkert sätt att lagra och komma åt dina autentiseringsuppgifter, till exempel Azure Key Vault. Mer information finns i Säkerhet för Azure AI-tjänster.

Om du vill ange miljövariabeln för resursnyckeln för dokumentinformation öppnar du ett konsolfönster och följer anvisningarna för operativsystemet och utvecklingsmiljön. Ersätt <yourKey> och <yourEndpoint> med värdena från resursen i Azure-portalen.

Windows

Miljövariabler i Windows är inte skiftlägeskänsliga. De deklareras vanligtvis i versaler, med ord som är sammanfogade med ett understreck. Kör följande kommandon i en kommandotolk:

1. Ange nyckelvariabeln:

   setx DI_KEY <yourKey>
   

2. Ange slutpunktsvariabeln

   setx DI_ENDPOINT <yourEndpoint>
   

3. Stäng kommandotolken när du har angett miljövariabler. Värdena finns kvar tills du ändrar dem igen.

4. Starta om alla program som körs som läser miljövariabeln. Om du till exempel använder Visual Studio eller Visual Studio Code som redigeringsprogram startar du om innan du kör exempelkoden.

Här följer några fler användbara kommandon att använda med miljövariabler:

Command	Åtgärd	Exempel
setx VARIABLE_NAME=	Ta bort miljövariabeln genom att ange värdet till en tom sträng.	setx DI_KEY=
setx VARIABLE_NAME=value	Ange eller ändra värdet för en miljövariabel.	setx DI_KEY=<yourKey>
set VARIABLE_NAME	Visa värdet för en specifik miljövariabel.	set DI_KEY
set	Visa alla miljövariabler.	set

macOS

Miljövariabler i macOS är skiftlägeskänsliga. Normalt deklareras variabelnamnet med versaler.

Kommandot export anger variabeln och exporterar den till den globala miljön, som är tillgänglig för andra processer. Värdet är dock tillfälligt och varar bara tills du stänger terminalsessionen. Öppna terminalen och ange följande kommandon:

1. Ange nyckelvariabeln:

   export key=<yourKey>
   

2. Ange slutpunktsvariabeln:

   export endpoint=<yourEndpoint>
   

Om du vill ange en miljövariabel permanent placerar du ett exportkommando i bash-startskriptet ~/.bash_profile :

1. Använd en textredigerare för att öppna filen ~/.bash_profile och lägg till följande kommando för att skapa en permanent miljövariabel:

   export DI_KEY=<yourKey> DI_ENDPOINT=<yourEndpoint>
   

   Exempel: export DI_KEY="<yourKey>"

2. Spara ändringarna i filen bash_profile .

3. Om du vill att ändringarna ska gälla kör du följande kommando från terminalfönstret:

   source ~/.bash-profile
   

Här följer några fler användbara kommandon att använda med miljövariabler:

Command	Åtgärd	Exempel
unset VARIABLE_NAME	Ta bort en miljövariabel.	unset DI_KEY
export VARIABLE_NAME=value	Ange eller ändra värdet för en tillfällig miljövariabel.	export DI_KEY=<yourKey>
printenv VARIABLE_NAME echo $VARIABLE_NAME	Visa värdet för en specifik miljövariabel. echo Med kommandot föregår du variabeln med $.	printenv DI_KEY echo $DI_KEY
printenv	Visa alla miljövariabler.	printenv

Linux

Miljövariabler i Linux är skiftlägeskänsliga. Normalt deklareras variabelnamnet med versaler.

Kommandot export anger variabeln och exporterar den till den globala miljön, som är tillgänglig för andra processer. Värdet är dock tillfälligt och varar bara tills du stänger terminalsessionen:

1. Ange nyckelvariabeln:

   export DI_KEY=<yourKey>
   

2. Ange slutpunktsvariabeln:

   export DI_ENDPOINT=<yourEndpoint>
   

Om du vill ange en miljövariabel permanent placerar du ett exportkommando i bash-startskriptet ~/.bashrc :

1. Använd en textredigerare för att öppna filen ~/.bashrc och lägg till följande kommando för att skapa en permanent miljövariabel:

   export <VARIABLE>=<value>
   

   Exempel: export DI_KEY=<yourKey>

2. Spara ändringarna i .bashrc-filen .

3. Om du vill att ändringarna ska gälla kör du följande kommando från terminalfönstret:

   source ~/.bashrc
   

Här följer några fler användbara kommandon att använda med miljövariabler:

Command	Åtgärd	Exempel
unset VARIABLE_NAME	Ta bort en miljövariabel.	unset DI_KEY=
export VARIABLE_NAME=value	Ange eller ändra värdet för en tillfällig miljövariabel.	export DI_KEY={yourKey}
printenv VARIABLE_NAME echo $VARIABLE_NAME	Visa värdet för en miljövariabel. echo Med kommandot föregår du variabeln med $.	printenv DI_KEY echo $DI_KEY
printenv	Visa alla miljövariabler.	printenv

Analysera dokument och få resultat

En POST-begäran används för att analysera dokument med en fördefinierad eller anpassad modell. En GET-begäran används för att hämta resultatet av ett dokumentanalysanrop. modelId Används med POST och resultId med GET-åtgärder.

Använd följande tabell som referens. Ersätt <modelId> och <document-url> med önskade värden:

Modell	modelId	description	document-url
Läs modell	prebuilt-read	Exempelbroschyr	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/read.png
Layoutmodell	fördefinierad layout	Bokningsbekräftelse för exempel	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/layout.png
W-2-formulärmodell	prebuilt-tax.us.w2	Exempel på W-2-formulär	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/w2.png
Fakturamodell	fördefinierad faktura	Exempelfaktura	https://github.com/Azure-Samples/cognitive-services-REST-api-samples/raw/master/curl/form-recognizer/rest-api/invoice.pdf
Kvittomodell	fördefinierad kvitto	Exempelkvitto	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/receipt.png
ID-dokumentmodell	prebuilt-idDocument	Exempel-ID-dokument	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/identity_documents.png

POST-begäran

Öppna ett konsolfönster och kör följande cURL-kommando. Kommandona innehåller miljövariablerna slutpunkt och nyckel som tidigare skapades i avsnittet ange miljövariabler. Ersätt dessa variabler om dina variabelnamn skiljer sig åt. Kom ihåg att ersätta parametrarna modelId> och <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>'}"

Om du vill aktivera tilläggsfunktioner använder du features frågeparametern i POST-begäran. Det finns fyra tillgängliga tilläggsfunktioner med 2023-07-31 (GA) och senare versioner: ocr.highResolution, ocr.formula, ocr.font och queryFields.premium. Mer information om var och en av funktionerna finns i Anpassade modeller.

Du kan bara anropa funktionerna highResolution, formel och teckensnitt för modellen Läs och Layout och funktionen queryFields för modellen Allmänna dokument. I följande exempel visas hur du anropar funktionerna highResolution, formel och teckensnitt för layoutmodellen.

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>'}"

POST-svar

Du får ett 202 (Success) svar som innehåller en Operation-location rubrik. Använd värdet för den här rubriken för att hämta svarsresultaten.

Hämta analysresultat (GET-begäran)

När du har anropat API:et Analyze document anropar du API:et [Get analyze result}(/rest/api/aiservices/document-models/get-analyze-result?view=rest-aiservices-2024-02-29-preview&preserve-view=true&tabs=HTTP) för att hämta status för åtgärden och extraherade data.

CURL-kommandoradsverktyget formaterar inte API-svar som innehåller JSON-innehåll, vilket kan göra innehållet svårt att läsa. Om du vill formatera JSON-svaret inkluderar du pipe-tecknet följt av ett JSON-formateringsverktyg med din GET-begäran.

Windows

Använd verktyget NodeJS json som JSON-formaterare för cURL. Om du inte har Node.js installerat laddar du ned och installerar den senaste versionen.

1. Öppna ett konsolfönster och installera json-verktyget med hjälp av följande kommando:

   npm install -g jsontool
   

2. Skriv ut JSON-utdata genom att inkludera pipe-tecknet | json med dina GET-begäranden.

   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

Kommandoverktyget json_pp levereras med macOS och kan användas som JSON-formaterare för cURL.

• Skriv ut JSON-utdata med | json_pp dina GET-begäranden.

  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

Kommandoradsverktyget json_pp är förinstallerat i de flesta Linux-distributioner. Om den inte ingår kan du använda distributionens pakethanterare för att installera den.

• Skriv ut JSON-utdata genom att inkludera | json_pp med dina GET begäranden.

  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
  

GET-begäranden

Innan du kör följande kommando gör du följande ändringar:

• Ersätt <POST-svaret> med Operation-location rubriken från POST-svaret.
• Ersätt <DI_KEY med variabeln för miljövariabeln om den skiljer sig från namnet i koden.
• Ersätt *<json-tool> med ditt JSON-formateringsverktyg.

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

Granska svaret

Du får ett 200 (Success) svar med JSON-utdata. Det första fältet, status, anger status för åtgärden. Om åtgärden inte är slutförd är running värdet status för eller notStarted. Anropa API:et igen, antingen manuellt eller via ett skript. Vi rekommenderar ett intervall på en sekund eller mer mellan anrop.

Besök Azure-exempellagringsplatsen på GitHub för att visa GET svaret för var och en av modellerna för dokumentinformation:

Modell	Utdata-URL
Läs modell	Läsa modellutdata
Layoutmodell	Utdata för layoutmodell
W-2 skattemodell	Utdata från W-2-skattemodell
Fakturamodell	Fakturamodellutdata
Kvittomodell	Kvittomodellutdata
ID-dokumentmodell	Utdata för ID-dokumentmodell

Nästa steg

Grattis! Du har lärt dig att använda modeller för dokumentinformation för att analysera olika dokument på olika sätt. Utforska sedan Document Intelligence Studio och referensdokumentationen.

Prova Document Intelligence StudioUtforska REST-API:et för dokumentinformation