Kom igång med Dokumentinformation

Viktigt!

• Azure Cognitive Services Formigenkänning är nu Azure AI Document Intelligence.
• Vissa plattformar väntar fortfarande på uppdatering av namnbytet.
• Alla omnämnanden av Formigenkänning eller dokumentinformation i vår dokumentation avser samma Azure-tjänst.

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

• Kom igång med Azure Formigenkänning senaste GA-versionen (2023-07-31).

• Azure AI Document Intelligence/Formigenkänning är en molnbaserad Azure AI-tjänst som använder maskininlärning för att extrahera nyckel/värde-par, text, tabeller och nyckeldata från dina dokument.

• Du kan enkelt integrera modeller för dokumentbearbetning i dina arbetsflöden och program med hjälp av ett SDK för programmeringsspråk eller genom att anropa REST-API:et.

• För den här snabbstarten rekommenderar vi 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.

Mer information om API-funktioner och utvecklingsalternativ finns på vår översiktssida .

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

I den här snabbstarten använder du följande funktioner för att analysera och extrahera data och värden från formulär och dokument:

• Layoutmodell – Analysera och extrahera tabeller, linjer, ord och markeringsmarkeringar som alternativknappar och kryssrutor i dokument, utan att behöva träna en modell.

• Fördefinierad modell – Analysera och extrahera vanliga fält från specifika dokumenttyper med hjälp av en fördefinierad modell.

Förutsättningar

• Azure-prenumeration – Skapa en kostnadsfritt.

• Den aktuella versionen av Visual Studio IDE.

• En Azure AI-tjänst eller Formigenkänning resurs. När du har din Azure-prenumeration skapar du en resurs med en enda tjänst eller Azure AI med flera tjänster i Azure Portal för att hämta din nyckel och slutpunkt.

• 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 under en enda slutpunkt/nyckel. Skapa en Formigenkänning resurs för endast Formigenkänning åtkomst. Observera att du behöver en resurs med en enda tjänst om du tänker använda Microsoft Entra-autentisering.

• När resursen har distribuerats väljer du Gå till resurs. Du behöver nyckeln och slutpunkten från resursen som du skapar för att ansluta ditt program till Formigenkänning-API:et. Du klistrar in nyckeln och slutpunkten i koden senare i snabbstarten:

  

Konfigurera

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. I dialogrutan Konfigurera det nya projektet anger du form_recognizer_quickstart i rutan Projektnamn. Välj sedan Nästa.

5. I dialogrutan 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 form_recognizer_quickstart projekt och välj Hantera NuGet-paket... .

   

2. Välj fliken Bläddra och skriv Azure.AI.FormRecognizer. Välj version 4.1.0 i listrutan

   

Skapa ditt program

Om du vill interagera med Formigenkänning-tjänsten måste du skapa en instans av DocumentAnalysisClient klassen. För att göra det skapar du en AzureKeyCredential med din key från Azure Portal och en DocumentAnalysisClient instans med AzureKeyCredential och din Formigenkänning endpoint.

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 Nya C#-mallar genererar toppnivåinstruktioner.

1. Öppna filen Program.cs .

2. Ta bort den befintliga koden, inklusive raden Console.Writeline("Hello World!"), och välj något av följande kodexempel för att kopiera och klistra in i programmets Program.cs fil:

   • Layoutmodell

   • Fördefinierad modell

Viktigt!

Kom ihåg att ta bort nyckeln från koden när du är klar och publicera den aldrig offentligt. För produktion använder du ett säkert sätt att lagra och komma åt dina autentiseringsuppgifter som Azure Key Vault. Mer information finns i Säkerhet för Azure AI-tjänster.

Layoutmodell

Extrahera text, markeringsmarkeringar, textformat, tabellstrukturer och koordinater för avgränsningsregionen från dokument.

• I det här exemplet behöver du en dokumentfil från en URI. Du kan använda vårt exempeldokument för den här snabbstarten.
• Vi har lagt till fil-URI-värdet i variabeln Uri fileUri överst i skriptet.
• Om du vill extrahera layouten från en viss fil vid en URI använder du StartAnalyzeDocumentFromUri metoden och skickar prebuilt-layout den som modell-ID. Det returnerade värdet är ett AnalyzeResult objekt som innehåller data från det skickade dokumentet.

Lägg till följande kodexempel i filen Program.cs. Se till att du uppdaterar nyckel- och slutpunktsvariablerna med värden från din Azure Portal Formigenkänning-instans:

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

//set `<your-endpoint>` and `<your-key>` variables with the values from the Azure portal to create your `AzureKeyCredential` and `DocumentAnalysisClient` instance
string endpoint = "<your-endpoint>";
string key = "<your-key>";
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/sample-layout.pdf");

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 box is:");
        Console.WriteLine($"      Upper left => X: {line.BoundingPolygon[0].X}, Y= {line.BoundingPolygon[0].Y}");
        Console.WriteLine($"      Upper right => X: {line.BoundingPolygon[1].X}, Y= {line.BoundingPolygon[1].Y}");
        Console.WriteLine($"      Lower right => X: {line.BoundingPolygon[2].X}, Y= {line.BoundingPolygon[2].Y}");
        Console.WriteLine($"      Lower left => X: {line.BoundingPolygon[3].X}, Y= {line.BoundingPolygon[3].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 box is:");
        Console.WriteLine($"      Upper left => X: {selectionMark.BoundingPolygon[0].X}, Y= {selectionMark.BoundingPolygon[0].Y}");
        Console.WriteLine($"      Upper right => X: {selectionMark.BoundingPolygon[1].X}, Y= {selectionMark.BoundingPolygon[1].Y}");
        Console.WriteLine($"      Lower right => X: {selectionMark.BoundingPolygon[2].X}, Y= {selectionMark.BoundingPolygon[2].Y}");
        Console.WriteLine($"      Lower left => X: {selectionMark.BoundingPolygon[3].X}, Y= {selectionMark.BoundingPolygon[3].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}'.");
    }
}

Kör ditt program

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

Utdata för layoutmodell

Här är ett kodfragment av förväntade utdata:

  Document Page 1 has 69 line(s), 425 word(s), and 15 selection mark(s).
  Line 0 has content: 'UNITED STATES'.
    Its bounding box is:
      Upper left => X: 3.4915, Y= 0.6828
      Upper right => X: 5.0116, Y= 0.6828
      Lower right => X: 5.0116, Y= 0.8265
      Lower left => X: 3.4915, Y= 0.8265
  Line 1 has content: 'SECURITIES AND EXCHANGE COMMISSION'.
    Its bounding box is:
      Upper left => X: 2.1937, Y= 0.9061
      Upper right => X: 6.297, Y= 0.9061
      Lower right => X: 6.297, Y= 1.0498
      Lower left => X: 2.1937, Y= 1.0498

Om du vill visa hela utdata går du till Azure-exempellagringsplatsen på GitHub för att visa layoutmodellens utdata.

Fördefinierad modell

Analysera och extrahera vanliga fält från specifika dokumenttyper med hjälp av en fördefinierad modell. I det här exemplet analyserar vi en faktura med hjälp av den fördefinierade fakturamodellen .

Dricks

Du är inte begränsad till fakturor – det finns flera fördefinierade modeller att välja mellan, som var och en har en egen uppsättning fält som stöds. Vilken modell som ska användas för analyze åtgärden beror på vilken typ av dokument som ska analyseras. Se extrahering av modelldata.

• Analysera en faktura med hjälp av den fördefinierade fakturamodellen. Du kan använda vårt exempelfakturadokument för den här snabbstarten.
• Vi har lagt till fil-URI-värdet i variabeln Uri invoiceUri överst i filen Program.cs.
• Om du vill analysera en viss fil vid en URI använder du StartAnalyzeDocumentFromUri metoden och skickar prebuilt-invoice den som modell-ID. Det returnerade värdet är ett AnalyzeResult objekt som innehåller data från det skickade dokumentet.
• För enkelhetens skull visas inte alla nyckel/värde-par som tjänsten returnerar här. Om du vill se listan över alla fält som stöds och motsvarande typer kan du läsa vår fakturakonceptsida.

Lägg till följande kodexempel i din Program.cs-fil. Se till att du uppdaterar nyckel- och slutpunktsvariablerna med värden från din Azure Portal Formigenkänning-instans:

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

//set `<your-endpoint>` and `<your-key>` variables with the values from the Azure portal to create your `AzureKeyCredential` and `FormRecognizerClient` instance
string endpoint = "<your-endpoint>";
string key = "<your-key>";
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentAnalysisClient client = new DocumentAnalysisClient(new Uri(endpoint), credential);

//sample invoice document

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

Operation operation = await client.AnalyzeDocumentAsync(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}");
        }
    }
}

Kör ditt program

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

Fördefinierade modellutdata

Här är ett kodfragment av förväntade utdata:

  Document 0:
  Vendor Name: 'CONTOSO LTD.', with confidence 0.962
  Customer Name: 'MICROSOFT CORPORATION', with confidence 0.951
  Item:
    Description: 'Test for 23 fields', with confidence 0.899
    Amount: '100', with confidence 0.902
  Sub Total: '100', with confidence 0.979

Om du vill visa hela utdata går du till Azure-exempellagringsplatsen på GitHub för att visa de fördefinierade fakturamodellutdata.

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

I den här snabbstarten använder du följande funktioner för att analysera och extrahera data och värden från formulär och dokument:

• Layout – Analysera och extrahera tabeller, rader, ord och markeringar som alternativknappar och kryssrutor i dokument, utan att behöva träna en modell.

• Fördefinierad faktura – Analysera och extrahera vanliga fält från specifika dokumenttyper med hjälp av en förtränad modell.

Förutsättningar

• Azure-prenumeration – Skapa en kostnadsfritt.

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

  Dricks

  • Visual Studio Code erbjuder ett kodningspaket för Java för Windows och macOS. Kodningspaketet är ett paket med VS Code, 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 Code och kodningspaketet för Java installerar du Tillägget Gradle for 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. När du har din Azure-prenumeration skapar du en dokumentinformationsresurs med en tjänst eller flera tjänster i Azure Portal för att hämta din nyckel och slutpunkt. 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 under en enda slutpunkt/nyckel. För endast åtkomst till dokumentinformation skapar du en dokumentinformationsresurs. Observera att du behöver en resurs med en enda tjänst om du tänker använda Microsoft Entra-autentisering.

• När resursen har distribuerats väljer du Gå till resurs. Du behöver nyckeln och slutpunkten från resursen som du skapar för att ansluta ditt program till API:et för dokumentinformation. Senare klistrar du in nyckeln och slutpunkten i koden:

  

Konfigurera

Skapa ett nytt Gradle-projekt

1. I konsolfönstret (till exempel cmd, PowerShell eller Bash) skapar du en ny katalog för din app med namnet formigenkänningsapp och navigerar till den.

   mkdir form-recognize-app && form-recognize-app
   

   mkdir form-recognize-app; cd form-recognize-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. Acceptera standardprojektets namn (formigenkänningsapp) genom att välja Retur eller Retur.

Installera klientbiblioteket

Den här snabbstarten använder Gradle-beroendehanteraren. Du hittar klientbiblioteket och information för andra beroendehanterare på Den centrala Maven-lagringsplatsen.

Öppna projektets build.gradle.kts-fil i din IDE. Copay och förbi 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("FormRecognizer")
   }
   repositories {
       mavenCentral()
   }
   dependencies {
       implementation group: 'com.azure', name: 'azure-ai-formrecognizer', version: '4.1.0'

   }

Skapa ett Java-program

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

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

   mkdir -p src/main/java
   

   Du skapar följande katalogstruktur:

   

1. Navigera till java katalogen och skapa en fil med namnet FormRecognizer.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.
   • Skriv följande kommando new-item FormRecognizer.java.

2. Öppna FormRecognizer.java-filen. Kopiera och klistra in något av följande kodexempel i ditt program:

   • Layout

   • Fördefinierad faktura

Viktigt!

Kom ihåg att ta bort nyckeln från koden när du är klar och publicera den aldrig offentligt. För produktion använder du ett säkert sätt att lagra och komma åt dina autentiseringsuppgifter som Azure Key Vault. Mer information finns i Säkerhet för Azure AI-tjänster.

Layoutmodell

Extrahera text, markeringsmarkeringar, textformat, tabellstrukturer och koordinater för avgränsningsregionen från dokument.

• I det här exemplet behöver du en dokumentfil på en URI. Du kan använda vårt exempeldokument för den här snabbstarten.
• Om du vill analysera en viss fil vid en URI använder beginAnalyzeDocumentFromUrl du metoden och skickar prebuilt-layout den som modell-ID. Det returnerade värdet är ett AnalyzeResult objekt som innehåller data om det skickade dokumentet.
• Vi har lagt till fil-URI-värdet i variabeln documentUrl i huvudmetoden.

Lägg till följande kodexempel i FormRecognizer.java filen. Se till att du uppdaterar nyckel- och slutpunktsvariablerna med värden från din Azure Portal Document Intelligence-instans:

import com.azure.ai.formrecognizer.documentanalysis.models.*;
import com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClient;
import com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder;

import com.azure.core.credential.AzureKeyCredential;
import com.azure.core.util.polling.SyncPoller;

import java.io.IOException;
import java.util.List;
import java.util.Arrays;
import java.time.LocalDate;
import java.util.Map;
import java.util.stream.Collectors;

public class FormRecognizer {

  // set `<your-endpoint>` and `<your-key>` variables with the values from the Azure portal
  private static final String endpoint = "<your-endpoint>";
  private static final String key = "<your-key>";

  public static void main(String[] args) {

    // create your `DocumentAnalysisClient` instance and `AzureKeyCredential` variable
    DocumentAnalysisClient client = new DocumentAnalysisClientBuilder()
      .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/sample-layout.pdf";
    String modelId = "prebuilt-layout";

    SyncPoller < OperationResult, AnalyzeResult > analyzeLayoutResultPoller =
      client.beginAnalyzeDocumentFromUrl(modelId, documentUrl);

    AnalyzeResult analyzeLayoutResult = analyzeLayoutResultPoller.getFinalResult();

    // 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.getState().toString(),
          documentSelectionMark.getBoundingPolygon().toString(),
          documentSelectionMark.getConfidence()));
    });

    // tables
    List < DocumentTable > tables = analyzeLayoutResult.getTables();
    for (int i = 0; i < tables.size(); i++) {
      DocumentTable documentTable = tables.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();
    }
  }
  // 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(", "));
  }
}

Skapa och köra programmet

När du har lagt till ett kodexempel i programmet går du tillbaka till huvudprojektkatalogen – formigenkänningsapp.

1. Skapa ditt program med build kommandot :

   gradle build
   

2. Kör programmet med run kommandot :

   gradle run
   

Utdata för layoutmodell

Här är ett kodfragment av förväntade utdata:

  Table 0 has 5 rows and 3 columns.
  Cell 'Title of each class', has row index 0 and column index 0.
  Cell 'Trading Symbol', has row index 0 and column index 1.
  Cell 'Name of exchange on which registered', has row index 0 and column index 2.
  Cell 'Common stock, $0.00000625 par value per share', has row index 1 and column index 0.
  Cell 'MSFT', has row index 1 and column index 1.
  Cell 'NASDAQ', has row index 1 and column index 2.
  Cell '2.125% Notes due 2021', has row index 2 and column index 0.
  Cell 'MSFT', has row index 2 and column index 1.
  Cell 'NASDAQ', has row index 2 and column index 2.
  Cell '3.125% Notes due 2028', has row index 3 and column index 0.
  Cell 'MSFT', has row index 3 and column index 1.
  Cell 'NASDAQ', has row index 3 and column index 2.
  Cell '2.625% Notes due 2033', has row index 4 and column index 0.
  Cell 'MSFT', has row index 4 and column index 1.
  Cell 'NASDAQ', has row index 4 and column index 2.

Om du vill visa hela utdata går du till Azure-exempellagringsplatsen på GitHub för att visa layoutmodellens utdata.

Fördefinierad modell

Analysera och extrahera vanliga fält från specifika dokumenttyper med hjälp av en fördefinierad modell. I det här exemplet analyserar vi en faktura med hjälp av den fördefinierade fakturamodellen .

Dricks

Du är inte begränsad till fakturor – det finns flera fördefinierade modeller att välja mellan, som var och en har en egen uppsättning fält som stöds. Vilken modell som ska användas för analyze åtgärden beror på vilken typ av dokument som ska analyseras. Se extrahering av modelldata.

• Analysera en faktura med hjälp av den fördefinierade fakturamodellen. Du kan använda vårt exempelfakturadokument för den här snabbstarten.
• Vi har lagt till fil-URL-värdet i variabeln invoiceUrl överst i filen.
• Om du vill analysera en viss fil vid en URI använder beginAnalyzeDocuments du metoden och skickar PrebuiltModels.Invoice den som modell-ID. Det returnerade värdet är ett result objekt som innehåller data om det skickade dokumentet.
• För enkelhetens skull visas inte alla nyckel/värde-par som tjänsten returnerar här. Om du vill se listan över alla fält som stöds och motsvarande typer kan du läsa vår fakturakonceptsida.

Lägg till följande kodexempel i FormRecognizer.java filen. Se till att du uppdaterar nyckel- och slutpunktsvariablerna med värden från din Azure Portal Document Intelligence-instans:

import com.azure.ai.formrecognizer.documentanalysis.models.*;
import com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClient;
import com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder;

import com.azure.core.credential.AzureKeyCredential;
import com.azure.core.util.polling.SyncPoller;

import java.io.IOException;
import java.util.List;
import java.util.Arrays;
import java.time.LocalDate;
import java.util.Map;
import java.util.stream.Collectors;

public class FormRecognizer {

  // set `<your-endpoint>` and `<your-key>` variables with the values from the Azure portal
  private static final String endpoint = "<your-endpoint>";
  private static final String key = "<your-key>";

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

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

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

    SyncPoller < OperationResult, AnalyzeResult > analyzeInvoicePoller = client.beginAnalyzeDocumentFromUrl(modelId, invoiceUrl);

    AnalyzeResult analyzeInvoiceResult = analyzeInvoicePoller.getFinalResult();

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

              // See a full list of fields found on an invoice here:
              // https://aka.ms/formrecognizer/invoicefields

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

Skapa och köra programmet

När du har lagt till ett kodexempel i programmet går du tillbaka till huvudprojektkatalogen – doc-intel-app.

1. Skapa ditt program med build kommandot :

   gradle build
   

2. Kör programmet med run kommandot :

   gradle run
   

Fördefinierade modellutdata

Här är ett kodfragment av förväntade utdata:

  ----------- Analyzing invoice  0 -----------
  Analyzed document has doc type invoice with confidence : 1.00
  Vendor Name: CONTOSO LTD., confidence: 0.92
  Vendor address: 123 456th St New York, NY, 10001, confidence: 0.91
  Customer Name: MICROSOFT CORPORATION, confidence: 0.84
  Customer Address Recipient: Microsoft Corp, confidence: 0.92
  Invoice ID: INV-100, confidence: 0.97
  Invoice Date: 2019-11-15, confidence: 0.97

Om du vill visa hela utdata går du till Azure-exempellagringsplatsen på GitHub för att visa de fördefinierade fakturamodellutdata.

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

I den här snabbstarten använder du följande funktioner för att analysera och extrahera data och värden från formulär och dokument:

• Layout – Analysera och extrahera tabeller, rader, ord och markeringar som alternativknappar och kryssrutor i dokument, utan att behöva träna en modell.

• Fördefinierad faktura – Analysera och extrahera vanliga fält från specifika dokumenttyper med hjälp av en förtränad fakturamodell.

Förutsättningar

• 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. När du har din Azure-prenumeration skapar du en dokumentinformationsresurs med en tjänst eller flera tjänster i Azure Portal för att hämta din nyckel och slutpunkt. 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 under en enda slutpunkt/nyckel. För endast åtkomst till dokumentinformation skapar du en dokumentinformationsresurs. Observera att du behöver en resurs med en enda tjänst om du tänker använda Microsoft Entra-autentisering.

• När resursen har distribuerats väljer du Gå till resurs. Du behöver nyckeln och slutpunkten från resursen som du skapar för att ansluta ditt program till API:et för dokumentinformation. Du klistrar in nyckeln och slutpunkten i koden senare i snabbstarten:

  

Konfigurera

1. Skapa ett nytt Node.js Express-program: I ett konsolfönster (till exempel cmd, PowerShell eller Bash) 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 – de kan hoppas över för det här projektet.
   • Acceptera förslagen inom parenteser genom att välja Retur eller Retur.
   • När du har slutfört anvisningarna skapas en package.json fil i katalogen doc-intel-app.

4. ai-form-recognizer Installera klientbiblioteket och azure/identity npm-paketen:

   npm i @azure/ai-form-recognizer@5.0.0 @azure/identity
   

   • Appens package.json fil uppdateras med beroendena.

5. 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.
   • Skriv 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 DocumentAnalysisClient klassen. För att göra det skapar du en AzureKeyCredential med din key från Azure Portal och en DocumentAnalysisClient instans med AzureKeyCredential och din Formigenkänning endpoint.

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

   • Layout

   • Fördefinierad faktura

Viktigt!

Kom ihåg att ta bort nyckeln från koden när du är klar och publicera den aldrig offentligt. För produktion använder du ett säkert sätt att lagra och komma åt dina autentiseringsuppgifter som Azure Key Vault. Mer information finns i Säkerhet för Azure AI-tjänster.

Layoutmodell

Extrahera text, markeringsmarkeringar, textformat, tabellstrukturer och koordinater för avgränsningsregionen från dokument.

• I det här exemplet behöver du en dokumentfil från en URL. Du kan använda vårt exempeldokument för den här snabbstarten.
• Vi har lagt till fil-URL-värdet i variabeln formUrl längst upp i filen.
• Om du vill analysera en viss fil från en URL använder beginAnalyzeDocuments du metoden och skickar in prebuilt-layout som modell-ID.

Lägg till följande kodexempel i index.js filen. Se till att du uppdaterar nyckel- och slutpunktsvariablerna med värden från din Azure Portal Document Intelligence-instans:

 const { AzureKeyCredential, DocumentAnalysisClient } = require("@azure/ai-form-recognizer");

    // set `<your-key>` and `<your-endpoint>` variables with the values from the Azure portal.
    const key = "<your-key>";
    const endpoint = "<your-endpoint>";

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

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

    const poller = await client.beginAnalyzeDocumentFromUrl("prebuilt-layout", formUrl);

    const {
        pages,
        tables
    } = 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 (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);
});

Kör ditt program

När du har lagt till ett kodexempel i programmet kör du programmet:

1. Gå till mappen där du har ditt dokumentinformationsprogram (doc-intel-app).

2. Skriv följande kommando i terminalen:

   node index.js
   

Utdata för layoutmodell

Här är ett kodfragment av förväntade utdata:

Pages:
- Page 1 (unit: inch)
  8.5x11, angle: 0
  69 lines, 425 words
Tables:
- Extracted table: 3 columns, 5 rows (15 cells)

Om du vill visa hela utdata går du till Azure-exempellagringsplatsen på GitHub för att visa layoutmodellens utdata.

Fördefinierad modell

I det här exemplet analyserar vi en faktura med hjälp av den fördefinierade fakturamodellen .

Dricks

Du är inte begränsad till fakturor – det finns flera fördefinierade modeller att välja mellan, som var och en har en egen uppsättning fält som stöds. Vilken modell som ska användas för analyze åtgärden beror på vilken typ av dokument som ska analyseras. Se extrahering av modelldata.

• Analysera en faktura med hjälp av den fördefinierade fakturamodellen. Du kan använda vårt exempelfakturadokument för den här snabbstarten.
• Vi har lagt till fil-URL-värdet i variabeln invoiceUrl överst i filen.
• Om du vill analysera en viss fil vid en URI använder beginAnalyzeDocuments du metoden och skickar PrebuiltModels.Invoice den som modell-ID. Det returnerade värdet är ett result objekt som innehåller data om det skickade dokumentet.
• För enkelhetens skull visas inte alla nyckel/värde-par som tjänsten returnerar här. Om du vill se listan över alla fält som stöds och motsvarande typer kan du läsa vår fakturakonceptsida.

 const {
    AzureKeyCredential,
    DocumentAnalysisClient
} = require("@azure/ai-form-recognizer");

// set `<your-key>` and `<your-endpoint>` variables with the values from the Azure portal.
const key = "<your-key>";
const endpoint = "<your-endpoint>";
// sample document
invoiceUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/sample-invoice.pdf"

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

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

    const {
        pages,
        tables
    } = 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 && 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.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);
});

Kör ditt program

När du har lagt till ett kodexempel i programmet kör du programmet:

1. Gå till mappen där du har ditt dokumentinformationsprogram (doc-intel-app).

2. Skriv följande kommando i terminalen:

   node index.js
   

Fördefinierade modellutdata

Här är ett kodfragment av förväntade utdata:

  Vendor Name: CONTOSO LTD.
  Customer Name: MICROSOFT CORPORATION
  Invoice Date: 2019-11-15T00:00:00.000Z
  Due Date: 2019-12-15T00:00:00.000Z
  Items:
  - <no product code>
    Description: Test for 23 fields
    Quantity: 1
    Date: undefined
    Unit: undefined
    Unit Price: 1
    Tax: undefined
    Amount: 100

Om du vill visa hela utdata går du till Azure-exempellagringsplatsen på GitHub för att visa de fördefinierade fakturamodellutdata.

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

I den här snabbstarten använder du följande funktioner för att analysera och extrahera data från formulär och dokument:

• Layout – Analysera och extrahera tabeller, linjer, ord och markeringsmarkeringar som alternativknappar och kryssrutor och nyckel/värde-par, utan att behöva träna en modell.

• Fördefinierad faktura – Analysera och extrahera vanliga fält från specifika dokumenttyper med hjälp av en förtränad modell.

Förutsättningar

• 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. Mer information finns i Komma igång med Python i Visual Studio Code.

• En Azure AI-tjänst eller dokumentinformationsresurs. När du har din Azure-prenumeration skapar du en dokumentinformationsresurs med en tjänst eller flera tjänster i Azure Portal för att hämta din nyckel och slutpunkt. 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 under en enda slutpunkt/nyckel. För endast åtkomst till dokumentinformation skapar du en dokumentinformationsresurs. Observera att du behöver en resurs med en enda tjänst om du tänker använda Microsoft Entra-autentisering.

• När resursen har distribuerats väljer du Gå till resurs. Du behöver nyckeln och slutpunkten från resursen som du skapar för att ansluta ditt program till API:et för dokumentinformation. Du klistrar in nyckeln och slutpunkten i koden senare i snabbstarten:

  

Konfigurera

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

pip install azure-ai-formrecognizer==3.3.0

Skapa ditt Python-program

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

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

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

   • Layout

   • Fördefinierad faktura

Viktigt!

Kom ihåg att ta bort nyckeln från koden när du är klar och publicera den aldrig offentligt. För produktion använder du ett säkert sätt att lagra och komma åt dina autentiseringsuppgifter som Azure Key Vault. Mer information finns i Säkerhet för Azure AI-tjänster.

Layoutmodell

Extrahera text, markeringsmarkeringar, textformat, tabellstrukturer och koordinater för avgränsningsregionen från dokument.

• I det här exemplet behöver du en dokumentfil från en URL. Du kan använda vårt exempeldokument för den här snabbstarten.
• Vi har lagt till fil-URL-värdet i variabeln formUrl analyze_layout i funktionen.

Om du vill analysera en viss fil på en URL använder begin_analyze_document_from_url du metoden och skickar in prebuilt-layout som modell-ID. Det returnerade värdet är ett result objekt som innehåller data om det skickade dokumentet.

Lägg till följande kodexempel i ditt form_recognizer_quickstart.py-program. Se till att du uppdaterar nyckel- och slutpunktsvariablerna med värden från din Azure Portal Formigenkänning-instans:

# import libraries
import os
from azure.ai.formrecognizer import DocumentAnalysisClient
from azure.core.credentials import AzureKeyCredential

# set `<your-endpoint>` and `<your-key>` variables with the values from the Azure portal
endpoint = "<your-endpoint>"
key = "<your-key>"

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/sample-layout.pdf"

    document_analysis_client = DocumentAnalysisClient(
        endpoint=endpoint, credential=AzureKeyCredential(key)
    )

    poller = document_analysis_client.begin_analyze_document_from_url(
            "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()

Kör programmet

När du har lagt till ett kodexempel i ditt program skapar och kör du programmet:

1. Gå till den mapp där du har din form_recognizer_quickstart.py-fil .

2. Skriv följande kommando i terminalen:

   python form_recognizer_quickstart.py
   

Utdata för layoutmodell

Här är ett kodfragment av förväntade utdata:

  ----Analyzing layout from page #1----
  Page has width: 8.5 and height: 11.0, measured with unit: inch
  ...Line # 0 has word count 2 and text 'UNITED STATES' within bounding box '[3.4915, 0.6828], [5.0116, 0.6828], [5.0116, 0.8265], [3.4915, 0.8265]'
  ......Word 'UNITED' has a confidence of 1.0
  ......Word 'STATES' has a confidence of 1.0
  ...Line # 1 has word count 4 and text 'SECURITIES AND EXCHANGE COMMISSION' within bounding box '[2.1937, 0.9061], [6.297, 0.9061], [6.297, 1.0498], [2.1937, 1.0498]'
  ......Word 'SECURITIES' has a confidence of 1.0
  ......Word 'AND' has a confidence of 1.0
  ......Word 'EXCHANGE' has a confidence of 1.0
  ......Word 'COMMISSION' has a confidence of 1.0
  ...Line # 2 has word count 3 and text 'Washington, D.C. 20549' within bounding box '[3.4629, 1.1179], [5.031, 1.1179], [5.031, 1.2483], [3.4629, 1.2483]'
  ......Word 'Washington,' has a confidence of 1.0
  ......Word 'D.C.' has a confidence of 1.0

Om du vill visa hela utdata går du till Azure-exempellagringsplatsen på GitHub för att visa layoutmodellens utdata.

---

Fördefinierad modell

Analysera och extrahera vanliga fält från specifika dokumenttyper med hjälp av en fördefinierad modell. I det här exemplet analyserar vi en faktura med hjälp av den fördefinierade fakturamodellen .

Dricks

Du är inte begränsad till fakturor – det finns flera fördefinierade modeller att välja mellan, som var och en har en egen uppsättning fält som stöds. Vilken modell som ska användas för analyze åtgärden beror på vilken typ av dokument som ska analyseras. Se extrahering av modelldata.

• Analysera en faktura med hjälp av den fördefinierade fakturamodellen. Du kan använda vårt exempelfakturadokument för den här snabbstarten.
• Vi har lagt till fil-URL-värdet i variabeln invoiceUrl överst i filen.
• För enkelhetens skull visas inte alla nyckel/värde-par som tjänsten returnerar här. Om du vill se listan över alla fält som stöds och motsvarande typer kan du läsa vår fakturakonceptsida.

Om du vill analysera en viss fil vid en URI använder begin_analyze_document_from_url du metoden och skickar prebuilt-invoice den som modell-ID. Det returnerade värdet är ett result objekt som innehåller data om det skickade dokumentet.

Lägg till följande kodexempel i ditt form_recognizer_quickstart.py-program. Se till att du uppdaterar nyckel- och slutpunktsvariablerna med värden från din Azure Portal Formigenkänning-instans:

# import libraries
import os
from azure.ai.formrecognizer import DocumentAnalysisClient
from azure.core.credentials import AzureKeyCredential

# set `<your-endpoint>` and `<your-key>` variables with the values from the Azure portal
endpoint = "<your-endpoint>"
key = "<your-key>"


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
    )


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"

    document_analysis_client = DocumentAnalysisClient(
        endpoint=endpoint, credential=AzureKeyCredential(key)
    )

    poller = document_analysis_client.begin_analyze_document_from_url(
        "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()

Kör programmet

När du har lagt till ett kodexempel i ditt program skapar och kör du programmet:

1. Gå till den mapp där du har din form_recognizer_quickstart.py-fil .

2. Skriv följande kommando i terminalen:

   python form_recognizer_quickstart.py
   

Fördefinierade modellutdata

Här är ett kodfragment av förväntade utdata:

  --------Recognizing invoice #1--------
  Vendor Name: CONTOSO LTD. has confidence: 0.919
  Vendor Address: 123 456th St New York, NY, 10001 has confidence: 0.907
  Vendor Address Recipient: Contoso Headquarters has confidence: 0.919
  Customer Name: MICROSOFT CORPORATION has confidence: 0.84
  Customer Id: CID-12345 has confidence: 0.956
  Customer Address: 123 Other St, Redmond WA, 98052 has confidence: 0.909
  Customer Address Recipient: Microsoft Corp has confidence: 0.917
  Invoice Id: INV-100 has confidence: 0.972
  Invoice Date: 2019-11-15 has confidence: 0.971
  Invoice Total: CurrencyValue(amount=110.0, symbol=$) has confidence: 0.97
  Due Date: 2019-12-15 has confidence: 0.973

Om du vill visa hela utdata går du till Azure-exempellagringsplatsen på GitHub för att visa de fördefinierade fakturamodellutdata.

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

I den här snabbstarten lär du dig att använda REST-API:et för dokumentinformation för att analysera och extrahera data och värden från dokument:

Förutsättningar

• Azure-prenumeration – Skapa en kostnadsfritt

• curl-kommandoradsverktyget installerat.

  • Windows
  • Mac eller Linux

• PowerShell version 7.*+ (eller ett liknande kommandoradsprogram.):

  • Windows
  • macOS
  • Linux

• Om du vill kontrollera din PowerShell-version skriver du följande kommando i förhållande till operativsystemet:

  • Windows: Get-Host | Select-Object Version
  • macOS eller Linux: $PSVersionTable

• En dokumentinformationsresurs (enskild tjänst) eller Azure AI-tjänster (flera tjänster). När du har din Azure-prenumeration skapar du en dokumentinformationsresurs med en tjänst eller flera tjänster i Azure Portal för att hämta din nyckel och slutpunkt. 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 under en enda slutpunkt/nyckel. För endast åtkomst till dokumentinformation skapar du en dokumentinformationsresurs. Observera att du behöver en resurs med en enda tjänst om du tänker använda Microsoft Entra-autentisering.

• När resursen har distribuerats väljer du Gå till resurs. Du behöver nyckeln och slutpunkten från resursen som du skapar för att ansluta ditt program till API:et för dokumentinformation. Du klistrar in nyckeln och slutpunkten i koden senare i snabbstarten:

  

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.

Analysera dokument (POST-begäran)

Innan du kör cURL-kommandot gör du följande ändringar i efterbegäran:

1. Ersätt {endpoint} med slutpunktsvärdet från din Azure Portal Document Intelligence-instans.

2. Ersätt {key} med nyckelvärdet från din Azure Portal Document Intelligence-instans.

3. Använd följande tabell som referens och ersätt {modelID} och {your-document-url} med önskade värden.

4. Du behöver en dokumentfil på en URL. För den här snabbstarten kan du använda exempelformulären i följande tabell för varje funktion:

Exempeldokument

Funktion	{modelID}	{your-document-url}
Allmänt dokument	prebuilt-document	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/sample-layout.pdf
Läs	prebuilt-read	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/read.png
Layout	fördefinierad layout	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/layout.png
Sjukförsäkringskort	prebuilt-healthInsuranceCard.us	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/insurance-card.png
W-2	prebuilt-tax.us.w2	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/w2.png
Faktura	fördefinierad faktura	https://github.com/Azure-Samples/cognitive-services-REST-api-samples/raw/master/curl/form-recognizer/rest-api/invoice.pdf
Kvitto	fördefinierad kvitto	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/receipt.png
ID-dokument	prebuilt-idDocument	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/identity_documents.png
Visitkort	prebuilt-businessCard	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/de5e0d8982ab754823c54de47a47e8e499351523/curl/form-recognizer/rest-api/business_card.jpg

Viktigt!

Kom ihåg att ta bort nyckeln från koden när du är klar och publicera den aldrig offentligt. För produktion använder du ett säkert sätt att lagra och komma åt dina autentiseringsuppgifter som Azure Key Vault. Mer information finns i Säkerhet för Azure AI-tjänster.

POST-begäran

curl -v -i POST "{endpoint}/formrecognizer/documentModels/{modelID}:analyze?api-version=2023-07-31" -H "Content-Type: application/json" -H "Ocp-Apim-Subscription-Key: {key}" --data-ascii "{'urlSource': '{your-document-url}'}"

POST-svar (resultID)

Du får ett 202 (Success) svar som innehåller en skrivskyddad rubrik för åtgärdsplats . Värdet för det här huvudet innehåller en resultID som kan efterfrågas för att hämta status för den asynkrona åtgärden och hämta resultaten med hjälp av en GET-begäran med samma resursprenumerationsnyckel:

Hämta analysresultat (GET-begäran)

När du har anropat API:et Analyze document anropar du API:et Hämta analysresultat för att hämta status för åtgärden och extraherade data. Innan du kör kommandot gör du följande ändringar:

1. Ersätt {resultID} rubriken Operation-Location från POST-svaret.

2. Ersätt {key} med nyckelvärdet från din Document Intelligence-instans i Azure Portal.

GET-begäranden

curl -v -X GET "{endpoint}/formrecognizer/documentModels/{modelId}/analyzeResults/{resultId}?api-version=2023-07-31" -H "Ocp-Apim-Subscription-Key: {key}"

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", och du bör anropa API:et igen, antingen manuellt eller via ett skript. Vi rekommenderar ett intervall på en sekund eller mer mellan anrop.

Exempelsvar för fördefinierad faktura

{
    "status": "succeeded",
    "createdDateTime": "2023-08-25T19:31:37Z",
    "lastUpdatedDateTime": "2023-08-25T19:31:43Z",
    "analyzeResult": {
        "apiVersion": "2023-07-31",
        "modelId": "prebuilt-invoice",
        "stringIndexType": "textElements"...
    ..."pages": [
            {
                "pageNumber": 1,
                "angle": 0,
                "width": 8.5,
                "height": 11,
                "unit": "inch",
                "words": [
                    {
                        "content": "CONTOSO",
                        "boundingBox": [
                            0.5911,
                            0.6857,
                            1.7451,
                            0.6857,
                            1.7451,
                            0.8664,
                            0.5911,
                            0.8664
                        ],
                        "confidence": 1,
                        "span": {
                            "offset": 0,
                            "length": 7
                                }
                      }],
              }]
      }
}

Dokumentfält som stöds

De fördefinierade modellerna extraherar fördefinierade uppsättningar med dokumentfält. Se Extrahering av modelldata för extraherade fältnamn, typer, beskrivningar och exempel.

Det var allt, grattis!

I den här snabbstarten använde du en dokumentinformationsmodell för att analysera olika formulär och dokument. Utforska sedan Document Intelligence Studio och referensdokumentationen för att lära dig mer om API för dokumentinformation på djupet.

Nästa steg

• Om du vill ha en förbättrad upplevelse och avancerad modellkvalitet kan du prova Document Intelligence Studio

• För migrering v3.1 till v4.0, se Migreringsguider för Ändringslogg.

• Hitta fler exempel på GitHub.