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:v4.0 (förhandsversion)Tidigare versioner:v3.1 (GA)v3.0 (GA)

• Kom igång med Azure AI Document Intelligence senaste förhandsversion (2024-02-29-preview).

• 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 | REST API-referens | Paketexempel|| 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 dokumentinformationsresurs. När du har din Azure-prenumeration skapar du en resurs med en enda tjänst eller Azure AI-multitjänst i Azure-portalen 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. 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 doc_intel_quickstart i rutan Projektnamn. Välj sedan Nästa.

5. I dialogrutan Ytterligare information väljer du .NET 6.0 (långsiktigt stöd)och väljer sedan Skapa.

   

Installera klientbiblioteket med NuGet

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

   

2. Välj fliken Bläddra och skriv Azure.AI.DocumentIntelligence. Välj kryssrutan Include prerelease och välj version 1.0.0-beta.1 i listrutan

   

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 key från Azure-portalen och en DocumentIntelligenceClient instans med och dokumentinformationen AzureKeyCredentialendpoint.

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 iNya 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 azure-portalens document intelligence-instans:

using Azure;
using Azure.AI.DocumentIntelligence;

//set `<your-endpoint>` and `<your-key>` variables with the values from the Azure portal to create your `AzureKeyCredential` and `DocumentIntelligenceClient` instance
string endpoint = "<your-endpoint>";
string key = "<your-key>";
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentIntelligenceClient client = new DocumentIntelligenceClient(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");

Operation<AnalyzeResult> operation = await client.AnalyzeDocumentAsync(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)," +
        $" 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}:");
        Console.WriteLine($"    Content: '{line.Content}'");

        Console.Write("    Bounding polygon, with points ordered clockwise:");
        for (int j = 0; j < line.Polygon.Count; j += 2)
        {
            Console.Write($" ({line.Polygon[j]}, {line.Polygon[j + 1]})");
        }

        Console.WriteLine();
    }

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

        Console.WriteLine($"  Selection Mark {i} is {selectionMark.State}.");
        Console.WriteLine($"    State: {selectionMark.State}");

        Console.Write("    Bounding polygon, with points ordered clockwise:");
        for (int j = 0; j < selectionMark.Polygon.Count; j++)
        {
            Console.Write($" ({selectionMark.Polygon[j]}, {selectionMark.Polygon[j + 1]})");
        }

        Console.WriteLine();
    }
}

for (int i = 0; i < result.Paragraphs.Count; i++)
{
    DocumentParagraph paragraph = result.Paragraphs[i];

    Console.WriteLine($"Paragraph {i}:");
    Console.WriteLine($"  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)
        {
            var handwrittenContent = result.Content.Substring(span.Offset, span.Length);
            Console.WriteLine($"  {handwrittenContent}");
        }
    }
}

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}) is a '{cell.Kind}' with 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.

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 azure-portalens document intelligence-instans:

using Azure;
using Azure.AI.DocumentIntelligence;

//set `<your-endpoint>` and `<your-key>` variables with the values from the Azure portal to create your `AzureKeyCredential` and `DocumentIntelligenceClient` instance
string endpoint = "<your-endpoint>";
string key = "<your-key>";
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentIntelligenceClient client = new DocumentIntelligenceClient(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<AnalyzeResult> 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)
        && vendorNameField.Type == DocumentFieldType.String)
    {
        string vendorName = vendorNameField.ValueString;
        Console.WriteLine($"Vendor Name: '{vendorName}', with confidence {vendorNameField.Confidence}");
    }

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

    if (document.Fields.TryGetValue("Items", out DocumentField itemsField)
        && itemsField.Type == DocumentFieldType.Array)
    {
        foreach (DocumentField itemField in itemsField.ValueArray)
        {
            Console.WriteLine("Item:");

            if (itemField.Type == DocumentFieldType.Object)
            {
                IReadOnlyDictionary<string, DocumentField> itemFields = itemField.ValueObject;

                if (itemFields.TryGetValue("Description", out DocumentField itemDescriptionField)
                    && itemDescriptionField.Type == DocumentFieldType.String)
                {
                    string itemDescription = itemDescriptionField.ValueString;
                    Console.WriteLine($"  Description: '{itemDescription}', with confidence {itemDescriptionField.Confidence}");
                }

                if (itemFields.TryGetValue("Amount", out DocumentField itemAmountField)
                    && itemAmountField.Type == DocumentFieldType.Currency)
                {
                    CurrencyValue itemAmount = itemAmountField.ValueCurrency;
                    Console.WriteLine($"  Amount: '{itemAmount.CurrencySymbol}{itemAmount.Amount}', with confidence {itemAmountField.Confidence}");
                }
            }
        }
    }

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

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

    if (document.Fields.TryGetValue("InvoiceTotal", out DocumentField invoiceTotalField)
        && invoiceTotalField.Type == DocumentFieldType.Currency)
    {
        CurrencyValue invoiceTotal = invoiceTotalField.ValueCurrency;
        Console.WriteLine($"Invoice Total: '{invoiceTotal.CurrencySymbol}{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.

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. SeJava 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 iMicrosoft 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-portalen 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 doc-intel-app och navigerar till den.

   mkdir doc-intel-app && doc-intel-app
   

   mkdir doc-intel-app; cd doc-intel-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 (doc-intel-app) 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("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 måste du skapa 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-intel-app:

   mkdir -p src/main/java
   

   Du skapar följande katalogstruktur:

   

2. 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.
   • Skriv följande kommando New-Item DocIntelligence.java.

3. Öppna DocIntelligence.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 DocIntelligence.java filen. Se till att du uppdaterar nyckel- och slutpunktsvariablerna med värden från azure-portalens document intelligence-instans:

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.DocumentTable;
import com.azure.core.credential.AzureKeyCredential;
import com.azure.core.util.polling.SyncPoller;

import java.util.List;

public class DocIntelligence {

  // 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
    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/sample-layout.pdf";
    String modelId = "prebuilt-layout";

    SyncPoller <AnalyzeResultOperation, AnalyzeResultOperation> analyzeLayoutResultPoller =
      client.beginAnalyzeDocument(modelId, documentUrl);

    AnalyzeResult analyzeLayoutResult = analyzeLayoutPoller.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.getPolygon()));

      // 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.getPolygon(),
          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();
    }

    // styles
    analyzeLayoutResult.getStyles().forEach(documentStyle -
      > System.out.printf("Document is handwritten %s.%n", documentStyle.isHandwritten()));
  }
}

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ö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 DocIntelligence.java filen. Se till att du uppdaterar nyckel- och slutpunktsvariablerna med värden från azure-portalens document intelligence-instans:

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 {

  // 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
    DocumentIntelligenceClient client = new DocumentIntelligenceClientBuilder()
      .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";

    public static void main(final String[] args) throws IOException {
      // Instantiate a client that will be used to call the service.
      DocumentIntelligenceClient client = new DocumentIntelligenceClientBuilder()
        .credential(new AzureKeyCredential("{key}"))
        .endpoint("https://{endpoint}.cognitiveservices.azure.com/")
        .buildClient();

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

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

      for (int i = 0; i < analyzeInvoiceResult.getDocuments().size(); i++) {
        Document 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.getValueString();
            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.getValueString();
            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.getValueString();
            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.getValueString();
            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.getValueString();
            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.getValueDate();
            System.out.printf("Invoice Date: %s, confidence: %.2f%n",
              invoiceDate, invoiceDateField.getConfidence());
          }
        }

        DocumentField invoiceTotalField = invoiceFields.get("InvoiceTotal");
        if (customerAddressRecipientField != null) {
          if (DocumentFieldType.NUMBER == invoiceTotalField.getType()) {
            Double invoiceTotal = invoiceTotalField.getValueNumber();
            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.ARRAY == invoiceItemsField.getType()) {
            List < DocumentField > invoiceItems = invoiceItemsField.getValueArray();
            invoiceItems.stream()
              .filter(invoiceItem -> DocumentFieldType.OBJECT == invoiceItem.getType())
              .map(documentField -> documentField.getValueObject())
              .forEach(documentFieldMap -> documentFieldMap.forEach((key, documentField) -> {

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

                if ("Description".equals(key)) {
                  if (DocumentFieldType.STRING == documentField.getType()) {
                    String name = documentField.getValueString();
                    System.out.printf("Description: %s, confidence: %.2fs%n",
                      name, documentField.getConfidence());
                  }
                }
                if ("Quantity".equals(key)) {
                  if (DocumentFieldType.NUMBER == documentField.getType()) {
                    Double quantity = documentField.getValueNumber();
                    System.out.printf("Quantity: %f, confidence: %.2f%n",
                      quantity, documentField.getConfidence());
                  }
                }
                if ("UnitPrice".equals(key)) {
                  if (DocumentFieldType.NUMBER == documentField.getType()) {
                    Double unitPrice = documentField.getValueNumber();
                    System.out.printf("Unit Price: %f, confidence: %.2f%n",
                      unitPrice, documentField.getConfidence());
                  }
                }
                if ("ProductCode".equals(key)) {
                  if (DocumentFieldType.NUMBER == documentField.getType()) {
                    Double productCode = documentField.getValueNumber();
                    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
   

REST API-referenspaket för klientbibliotek | (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-portalen 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-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.

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 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. 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.

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

    // 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 = DocumentIntelligenceClient(endpoint, new AzureKeyCredential(key));

    const poller = await client.beginAnalyzeDocument("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
   

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 { DocumentIntelligenceClient } = require("@azure-rest/ai-document-intelligence");
const  { AzureKeyCredential } = require("@azure/core-auth");

    // 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 = DocumentIntelligenceClient(endpoint, new AzureKeyCredential(key));

    const poller = await client.beginAnalyzeDocument("prebuilt-invoice", invoiceUrl);
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
   

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-portalen 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-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 key från Azure-portalen och en DocumentIntelligenceClient instans med och dokumentinformationen AzureKeyCredentialendpoint.

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

2. Öppna filen doc_intel_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 formUrlanalyze_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 doc_intel_quickstart.py program. Se till att du uppdaterar nyckel- och slutpunktsvariablerna med värden från azure-portalens document intelligence-instans:

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

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

# helper functions

def get_words(page, line):
    result = []
    for word in page.words:
        if _in_span(word, line.spans):
            result.append(word)
    return result


def _in_span(word, spans):
    for span in spans:
        if word.span.offset >= span.offset and (
            word.span.offset + word.span.length
        ) <= (span.offset + span.length):
            return True
    return False


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_intelligence_client = DocumentIntelligenceClient(
        endpoint=endpoint, credential=AzureKeyCredential(key)
    )

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

    analyze_request = AnalyzeDocumentRequest(
        url_source=formUrl
    )

    result: AnalyzeResult = poller.result()

    if result.styles and any([style.is_handwritten for style in result.styles]):
        print("Document contains handwritten content")
    else:
        print("Document does not contain handwritten content")

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

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

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

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

    if result.tables:
        for table_idx, table in enumerate(result.tables):
            print(
                f"Table # {table_idx} has {table.row_count} rows and "
                f"{table.column_count} columns"
            )
            if table.bounding_regions:
                for region in table.bounding_regions:
                    print(
                        f"Table # {table_idx} location on page: {region.page_number} is {region.polygon}"
                    )
            for cell in table.cells:
                print(
                    f"...Cell[{cell.row_index}][{cell.column_index}] has text '{cell.content}'"
                )
                if cell.bounding_regions:
                    for region in cell.bounding_regions:
                        print(
                            f"...content on page {region.page_number} is within bounding 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 mappen där du har din doc_intel_quickstart.py-fil .

2. Skriv följande kommando i terminalen:

   python doc_intel_quickstart.py
   

---

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 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.
• 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 ditt doc_intel_quickstart.py program. Se till att du uppdaterar nyckel- och slutpunktsvariablerna med värden från azure-portalens document intelligence-instans:

# import libraries
import os
from azure.core.credentials import AzureKeyCredential
from azure.ai.documentintelligence import DocumentIntelligenceClient


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

def analyze_invoice():
    # sample document

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

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

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

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

2. Skriv följande kommando i terminalen:

   python doc_intel_quickstart.py
   

| 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-portalen 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 azure-portalens dokumentinformationsinstans.

2. Ersätt {key} med nyckelvärdet från azure-portalens 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}
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äkringskortet	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
Mottagandet	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

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}/documentintelligence/documentModels/{modelId}:analyze?api-version=2024-02-29-preview" -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-portalen.

GET-begäranden

curl -v -X GET "{endpoint}/documentintelligence/documentModels/{modelId}/analyzeResults/{resultId}?api-version=2024-02-29-preview" -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": "2024-03-25T19:31:37Z",
    "lastUpdatedDateTime": "2024-03-25T19:31:43Z",
    "analyzeResult": {
        "apiVersion": "2024-02-29-preview",
        "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.