Wprowadzenie do analizy dokumentów

Ważne

• Rozpoznawanie formularzy usług Azure Cognitive Services to teraz analiza dokumentów usługi Azure AI.
• Niektóre platformy nadal czekają na zmianę nazwy aktualizacji.
• Wszystkie wzmianki o rozpoznawaniu formularzy lub analizie dokumentów w naszej dokumentacji odnoszą się do tej samej usługi platformy Azure.

Ta zawartość dotyczy: wersja 4.0 (GA) Starsze wersje: v3.1 (GA) v3.0 (GA)

• Rozpocznij pracę z usługą Azure AI Document Intelligence w najnowszej stabilnej wersji 4.0 2024-11-30 (GA).

• Azure AI Document Intelligence / Form Recognizer to oparta na chmurze usługa Azure AI, która używa uczenia maszynowego do wyodrębniania par klucz-wartość, tekstu, tabel i kluczowych danych z dokumentów.

• Modele przetwarzania dokumentów można łatwo zintegrować z przepływami pracy i aplikacjami przy użyciu zestawu SDK języka programowania lub wywoływania interfejsu API REST.

• Zalecamy korzystanie z bezpłatnej usługi podczas nauki technologii na potrzeby tego przewodnika Szybki start. Pamiętaj, że liczba bezpłatnych stron jest ograniczona do 500 miesięcznie.

Aby dowiedzieć się więcej o funkcjach interfejsu API i opcjach programowania, odwiedź naszą stronę Przegląd .

Dokumentacja zestawu SDK biblioteki | klienta — dokumentacja| | | interfejsu API REST — przykłady przykładów|obsługiwanych wersji interfejsu API REST

W tym przewodniku Szybki start użyj następujących funkcji, aby analizować i wyodrębniać dane oraz wartości z formularzy i dokumentów:

• Model układu — analizuj i wyodrębniaj tabele, linie, wyrazy i znaczniki zaznaczenia, takie jak przyciski radiowe i pola wyboru w dokumentach, bez konieczności trenowania modelu.

• Wstępnie utworzony model — analizowanie i wyodrębnianie typowych pól z określonych typów dokumentów przy użyciu wstępnie utworzonego modelu.

Wymagania wstępne

• Subskrypcja platformy Azure — utwórz jedną bezpłatnie.

• Bieżąca wersja środowiska IDE programu Visual Studio.

• Usługi azure AI lub zasób analizy dokumentów. Po utworzeniu subskrypcji platformy Azure utwórz zasób wielosób wielosłużytkowy usługi azure lub usługi Azure AI w witrynie Azure Portal, aby uzyskać klucz i punkt końcowy.

• Możesz użyć warstwy cenowej bezpłatna (F0), aby wypróbować usługę, a następnie uaktualnić ją do warstwy płatnej dla środowiska produkcyjnego.

Napiwek

Utwórz zasób usług Azure AI, jeśli planujesz uzyskać dostęp do wielu usług azure AI w ramach jednego punktu końcowego/klucza. W przypadku dostępu tylko do analizy dokumentów utwórz zasób analizy dokumentów. Należy pamiętać, że jeśli zamierzasz używać uwierzytelniania firmy Microsoft Entra, potrzebujesz zasobu z jedną usługą.

• Po wdrożeniu zasobu wybierz pozycję Przejdź do zasobu. Potrzebujesz klucza i punktu końcowego z utworzonego zasobu, aby połączyć aplikację z interfejsem API analizy dokumentów. Klucz i punkt końcowy wklejasz do kodu w dalszej części przewodnika Szybki start:

  

Konfiguruj

1. Uruchom program Visual Studio.

2. Na stronie początkowej wybierz pozycję Utwórz nowy projekt.

   

3. Na stronie Tworzenie nowego projektu wprowadź konsolę w polu wyszukiwania. Wybierz szablon Aplikacja konsolowa, a następnie wybierz pozycję Dalej.

   

4. W oknie dialogowym Konfigurowanie nowego projektu wprowadź doc_intel_quickstart w polu Nazwa projektu. Następnie wybierz pozycję Dalej.

5. W oknie dialogowym Dodatkowe informacje wybierz pozycję .NET 8.0 (obsługa długoterminowa), a następnie wybierz pozycję Utwórz.

   

Instalowanie biblioteki klienta za pomocą narzędzia NuGet

1. Kliknij prawym przyciskiem myszy projekt doc_intel_quickstart i wybierz polecenie Zarządzaj pakietami NuGet... .

   

2. Wybierz kartę Przeglądaj i wpisz Azure.AI.DocumentIntelligence.

3. Include prerelease Zaznacz pole wyboru.

   

4. Wybierz wersję z menu rozwijanego i zainstaluj pakiet w projekcie.

Kompilowanie aplikacji

Aby wchodzić w interakcje z usługą Analizy dokumentów, musisz utworzyć wystąpienie DocumentIntelligenceClient klasy . W tym celu należy utworzyć element za AzureKeyCredential key pomocą witryny Azure Portal i DocumentIntelligenceClient wystąpienia za pomocą narzędzia AzureKeyCredential i analizy endpointdokumentów.

Uwaga

• Począwszy od platformy .NET 6, nowe projekty korzystające z console szablonu generują nowy styl programu, który różni się od poprzednich wersji.
• Nowe dane wyjściowe korzystają z ostatnich funkcji języka C#, które upraszczają pisanie kodu.
• W przypadku korzystania z nowszej wersji wystarczy napisać treść Main metody. Nie trzeba dołączać instrukcji najwyższego poziomu, globalnych dyrektyw using ani niejawnych dyrektyw using.
• Aby uzyskać więcej informacji, zobacz Nowe szablony języka C# generują instrukcje najwyższego poziomu.

1. Otwórz plik Program.cs.

2. Usuń istniejący kod, w tym wiersz Console.Writeline("Hello World!"), i wybierz jeden z następujących przykładów kodu, aby skopiować i wkleić go do pliku Program.cs aplikacji:

   • Model układu

   • Wstępnie utworzony model

Ważne

Pamiętaj, aby usunąć klucz z kodu po zakończeniu i nigdy nie publikować go publicznie. W przypadku środowiska produkcyjnego użyj bezpiecznego sposobu przechowywania i uzyskiwania dostępu do poświadczeń, takich jak usługa Azure Key Vault. Aby uzyskać więcej informacji, zobacz Zabezpieczenia usług Azure AI.

Model układu

Wyodrębnij tekst, znaczniki zaznaczenia, style tekstu, struktury tabel i współrzędne regionu ograniczenia z dokumentów.

• W tym przykładzie potrzebny będzie plik dokumentu z identyfikatora URI. W tym przewodniku Szybki start możesz użyć naszego przykładowego dokumentu .
• Dodaliśmy wartość identyfikatora URI pliku do Uri fileUri zmiennej w górnej części skryptu.
• Aby wyodrębnić układ z danego pliku w identyfikatorze URI, użyj StartAnalyzeDocumentFromUri metody i przekaż prebuilt-layout jako identyfikator modelu. Zwracana wartość jest obiektem zawierającym AnalyzeResult dane z przesłanego dokumentu.

Dodaj następujący przykładowy kod do pliku Program.cs. Pamiętaj, aby zaktualizować zmienne klucza i punktu końcowego przy użyciu wartości z wystąpienia analizy dokumentów w witrynie Azure Portal:

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

AnalyzeDocumentContent content = new AnalyzeDocumentContent()
{
    UrlSource= fileUri
};

Operation<AnalyzeResult> operation = await client.AnalyzeDocumentAsync(WaitUntil.Completed, "prebuilt-layout", content);

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

Uruchamianie aplikacji

Po dodaniu przykładowego kodu do aplikacji wybierz zielony przycisk Start obok formRecognizer_quickstart, aby skompilować i uruchomić program, lub naciśnij F5.

Wstępnie utworzony model

Analizowanie i wyodrębnianie typowych pól z określonych typów dokumentów przy użyciu wstępnie utworzonego modelu. W tym przykładzie analizujemy fakturę przy użyciu wstępnie utworzonego modelu faktury .

Napiwek

Nie masz ograniczeń do faktur — istnieje kilka wstępnie utworzonych modeli do wyboru, z których każdy ma własny zestaw obsługiwanych pól. Model do użycia dla analyze operacji zależy od typu dokumentu do przeanalizowania. Zobacz wyodrębnianie danych modelu.

• Analizowanie faktury przy użyciu wstępnie utworzonego modelu faktury. Na potrzeby tego przewodnika Szybki start możesz użyć naszego przykładowego dokumentu faktury.
• Dodaliśmy wartość identyfikatora URI pliku do Uri invoiceUri zmiennej w górnej części pliku Program.cs.
• Aby przeanalizować dany plik przy użyciu identyfikatora URI, użyj StartAnalyzeDocumentFromUri metody i przekaż prebuilt-invoice go jako identyfikator modelu. Zwracana wartość jest obiektem zawierającym AnalyzeResult dane z przesłanego dokumentu.
• Dla uproszczenia wszystkie pary klucz-wartość zwracane przez usługę nie są tutaj wyświetlane. Aby wyświetlić listę wszystkich obsługiwanych pól i odpowiednich typów, zobacz naszą stronę koncepcji faktury .

Dodaj następujący przykładowy kod do pliku Program.cs. Pamiętaj, aby zaktualizować zmienne klucza i punktu końcowego przy użyciu wartości z wystąpienia analizy dokumentów w witrynie Azure Portal:

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

AnalyzeDocumentContent content = new AnalyzeDocumentContent()
{
    UrlSource = invoiceUri
};

Operation<AnalyzeResult> operation = await client.AnalyzeDocumentAsync(WaitUntil.Completed, "prebuilt-invoice", content);

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

Uruchamianie aplikacji

Po dodaniu przykładowego kodu do aplikacji wybierz zielony przycisk Start obok formRecognizer_quickstart, aby skompilować i uruchomić program, lub naciśnij F5.

Dokumentacja interfejsu API REST ( | Maven) | Przykłady |obsługiwanej wersji interfejsu API REST biblioteki klienta | |

W tym przewodniku Szybki start użyj następujących funkcji, aby analizować i wyodrębniać dane oraz wartości z formularzy i dokumentów:

• Układ — analizuj i wyodrębniaj tabele, linie, wyrazy i znaczniki zaznaczenia, takie jak przyciski radiowe i pola wyboru w dokumentach, bez konieczności trenowania modelu.

• Wstępnie utworzona faktura — analizowanie i wyodrębnianie typowych pól z określonych typów dokumentów przy użyciu wstępnie wytrenowanego modelu.

Wymagania wstępne

• Subskrypcja platformy Azure — utwórz jedną bezpłatnie.

• Najnowsza wersja programu Visual Studio Code lub preferowanego środowiska IDE. Zobacz Java w programie Visual Studio Code.

  Napiwek

  • Program Visual Studio Code oferuje pakiet kodowania dla języka Java dla systemów Windows i macOS. Pakiet kodowania jest pakietem programu VS Code, zestawem Java Development Kit (JDK) i kolekcją sugerowanych rozszerzeń firmy Microsoft. Pakiet kodowania może również służyć do naprawiania istniejącego środowiska programistycznego.
  • Jeśli używasz programu VS Code i pakietu programistycznego dla języka Java, zainstaluj rozszerzenie Gradle for Java .

• Jeśli nie używasz programu Visual Studio Code, upewnij się, że w środowisku projektowym zainstalowano następujące elementy:

  • Zestaw Java Development Kit (JDK) w wersji 8 lub nowszej. Aby uzyskać więcej informacji, zobacz Microsoft Build of OpenJDK (Microsoft Build of OpenJDK).

  • Gradle, wersja 6.8 lub nowsza.

• Usługi azure AI lub zasób analizy dokumentów. Po utworzeniu subskrypcji platformy Azure utwórz zasób analizy dokumentów z jedną usługą lub wieloma usługami w witrynie Azure Portal, aby uzyskać klucz i punkt końcowy. Możesz użyć warstwy cenowej bezpłatna (F0), aby wypróbować usługę, a następnie uaktualnić ją do warstwy płatnej dla środowiska produkcyjnego.

  Napiwek

  Utwórz zasób usług Azure AI, jeśli planujesz uzyskać dostęp do wielu usług azure AI w ramach jednego punktu końcowego/klucza. W przypadku dostępu tylko do analizy dokumentów utwórz zasób analizy dokumentów. Należy pamiętać, że jeśli zamierzasz używać uwierzytelniania firmy Microsoft Entra, potrzebujesz zasobu z jedną usługą.

• Po wdrożeniu zasobu wybierz pozycję Przejdź do zasobu. Potrzebujesz klucza i punktu końcowego z utworzonego zasobu, aby połączyć aplikację z interfejsem API analizy dokumentów. Później wklejasz klucz i punkt końcowy do kodu:

  

Konfiguruj

Tworzenie nowego projektu narzędzia Gradle

1. W oknie konsoli (takim jak cmd, PowerShell lub Bash) utwórz nowy katalog dla aplikacji o nazwie doc-intel-app i przejdź do niego.

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

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

2. gradle init Uruchom polecenie z katalogu roboczego. To polecenie tworzy podstawowe pliki kompilacji dla narzędzia Gradle, w tym build.gradle.kts, które są używane w czasie wykonywania do tworzenia i konfigurowania aplikacji.

   gradle init --type basic
   

3. Po wyświetleniu monitu wybierz pozycję Język DSL, a następnie Kotlin.

4. Zaakceptuj domyślną nazwę projektu (doc-intel-app), wybierając pozycję Return lub Enter.

Instalowanie biblioteki klienta

W tym przewodniku Szybki start jest używany menedżer zależności narzędzia Gradle. Bibliotekę klienta i informacje dotyczące innych menedżerów zależności można znaleźć w repozytorium centralnym programu Maven.

Otwórz plik build.gradle.kts projektu w środowisku IDE. Copay i wklej następujący kod, aby dołączyć bibliotekę klienta jako instrukcję implementation wraz z wymaganymi wtyczkami i ustawieniami.

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

   }

Tworzenie aplikacji Java

Aby wchodzić w interakcje z usługą Analizy dokumentów, musisz utworzyć wystąpienie DocumentIntelligenceClient klasy . W tym celu należy utworzyć element za AzureKeyCredential key pomocą witryny Azure Portal i DocumentIntelligenceClient wystąpienia za pomocą narzędzia AzureKeyCredential i analizy endpointdokumentów.

1. W katalogu doc-intel-app uruchom następujące polecenie:

   mkdir -p src/main/java
   

   Utworzysz następującą strukturę katalogów:

   

2. Przejdź do java katalogu i utwórz plik o nazwie DocIntelligence.java.

   Napiwek

   • Nowy plik można utworzyć przy użyciu programu PowerShell.
   • Otwórz okno programu PowerShell w katalogu projektu, trzymając wciśnięty Shift i klikając folder prawym przyciskiem myszy.
   • Wpisz następujące polecenie New-Item DocIntelligence.java.

3. Otwórz plik DocIntelligence.java. Skopiuj i wklej jeden z następujących przykładów kodu do aplikacji:

   • Układ

   • Wstępnie utworzona faktura

Ważne

Pamiętaj, aby usunąć klucz z kodu po zakończeniu i nigdy nie publikować go publicznie. W przypadku środowiska produkcyjnego użyj bezpiecznego sposobu przechowywania i uzyskiwania dostępu do poświadczeń, takich jak usługa Azure Key Vault. Aby uzyskać więcej informacji, zobacz Zabezpieczenia usług Azure AI.

Model układu

Wyodrębnij tekst, znaczniki zaznaczenia, style tekstu, struktury tabel i współrzędne regionu ograniczenia z dokumentów.

• W tym przykładzie potrzebny będzie plik dokumentu w identyfikatorze URI. W tym przewodniku Szybki start możesz użyć naszego przykładowego dokumentu .
• Aby przeanalizować dany plik przy użyciu identyfikatora URI, użyjesz beginAnalyzeDocumentFromUrl metody i przekażesz prebuilt-layout go jako identyfikator modelu. Zwracana wartość to AnalyzeResult obiekt zawierający dane dotyczące przesłanego dokumentu.
• Dodaliśmy wartość identyfikatora URI pliku do zmiennej documentUrl w metodzie main.

Dodaj następujący przykładowy kod do DocIntelligence.java pliku. Pamiętaj, aby zaktualizować zmienne klucza i punktu końcowego przy użyciu wartości z wystąpienia analizy dokumentów w witrynie Azure Portal:

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 `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
    DocumentIntelligenceClient client = new DocumentIntelligenceClientBuilder()
      .credential(new AzureKeyCredential(key))
      .endpoint(endpoint)
      .buildClient();

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

    SyncPoller <AnalyzeResultOperation, AnalyzeResultOperation> analyzeLayoutPoller =
      client.beginAnalyzeDocument(modelId,
          null,
          null,
          null,
          null,
          null,
          null,
          new AnalyzeDocumentRequest().setUrlSource(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()));
  }
}

Kompilowanie i uruchamianie aplikacji

Po dodaniu przykładu kodu do aplikacji wróć do głównego katalogu projektu — doc-intel-app.

1. Skompiluj aplikację za build pomocą polecenia :

   gradle build
   

2. Uruchom aplikację za run pomocą polecenia :

   gradle run
   

Wstępnie utworzony model

Analizowanie i wyodrębnianie typowych pól z określonych typów dokumentów przy użyciu wstępnie utworzonego modelu. W tym przykładzie analizujemy fakturę przy użyciu wstępnie utworzonego modelu faktury .

Napiwek

Nie masz ograniczeń do faktur — istnieje kilka wstępnie utworzonych modeli do wyboru, z których każdy ma własny zestaw obsługiwanych pól. Model do użycia dla analyze operacji zależy od typu dokumentu do przeanalizowania. Zobacz wyodrębnianie danych modelu.

• Analizowanie faktury przy użyciu wstępnie utworzonego modelu faktury. Na potrzeby tego przewodnika Szybki start możesz użyć naszego przykładowego dokumentu faktury.
• Dodaliśmy wartość adresu URL pliku do zmiennej invoiceUrl w górnej części pliku.
• Aby przeanalizować dany plik przy użyciu identyfikatora URI, użyjesz beginAnalyzeDocuments metody i przekażesz PrebuiltModels.Invoice go jako identyfikator modelu. Zwracana wartość jest obiektem zawierającym result dane dotyczące przesłanego dokumentu.
• Dla uproszczenia wszystkie pary klucz-wartość zwracane przez usługę nie są tutaj wyświetlane. Aby wyświetlić listę wszystkich obsługiwanych pól i odpowiednich typów, zobacz naszą stronę koncepcji faktury .

Dodaj następujący przykładowy kod do DocIntelligence.java pliku. Pamiętaj, aby zaktualizować zmienne klucza i punktu końcowego przy użyciu wartości z wystąpienia analizy dokumentów w witrynie Azure Portal:

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

    // 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(endpoint)
        .buildClient();

      SyncPoller<AnalyzeResultOperation, AnalyzeResultOperation > analyzeInvoicesPoller =
        client.beginAnalyzeDocument(modelId, 
            null,
            null,
            null,
            null,
            null,
            null,
            new AnalyzeDocumentRequest().setUrlSource(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());
                  }
                }
              }));
          }
        }
      }
    }
  }
}

Kompilowanie i uruchamianie aplikacji

Po dodaniu przykładu kodu do aplikacji wróć do głównego katalogu projektu — doc-intel-app.

1. Skompiluj aplikację za build pomocą polecenia :

   gradle build
   

2. Uruchom aplikację za run pomocą polecenia :

   gradle run
   

Pakiet referencyjny | interfejsu API REST biblioteki | klienta (npm) | Przykłady |obsługiwanej wersji interfejsu API REST

W tym przewodniku Szybki start użyj następujących funkcji, aby analizować i wyodrębniać dane oraz wartości z formularzy i dokumentów:

• Układ — analizuj i wyodrębniaj tabele, linie, wyrazy i znaczniki zaznaczenia, takie jak przyciski radiowe i pola wyboru w dokumentach, bez konieczności trenowania modelu.

• Wstępnie utworzona faktura — analizowanie i wyodrębnianie typowych pól z określonych typów dokumentów przy użyciu wstępnie wytrenowanego modelu faktury.

Wymagania wstępne

• Subskrypcja platformy Azure — utwórz jedną bezpłatnie.

• Najnowsza wersja programu Visual Studio Code lub preferowanego środowiska IDE. Aby uzyskać więcej informacji, zobacz Node.js w programie Visual Studio Code.

• Najnowsza LTS wersja Node.js.

• Usługi azure AI lub zasób analizy dokumentów. Po utworzeniu subskrypcji platformy Azure utwórz zasób analizy dokumentów z jedną usługą lub wieloma usługami w witrynie Azure Portal, aby uzyskać klucz i punkt końcowy. Możesz użyć warstwy cenowej bezpłatna (F0), aby wypróbować usługę, a następnie uaktualnić ją do warstwy płatnej dla środowiska produkcyjnego.

  Napiwek

  Utwórz zasób usług Azure AI, jeśli planujesz uzyskać dostęp do wielu usług azure AI w ramach jednego punktu końcowego/klucza. W przypadku dostępu tylko do analizy dokumentów utwórz zasób analizy dokumentów. Należy pamiętać, że jeśli zamierzasz używać uwierzytelniania firmy Microsoft Entra, potrzebujesz zasobu z jedną usługą.

• Po wdrożeniu zasobu wybierz pozycję Przejdź do zasobu. Potrzebujesz klucza i punktu końcowego z utworzonego zasobu, aby połączyć aplikację z interfejsem API analizy dokumentów. Klucz i punkt końcowy wklejasz do kodu w dalszej części przewodnika Szybki start:

  

Konfiguruj

1. Utwórz nową aplikację Node.js Express: w oknie konsoli (takim jak cmd, PowerShell lub Bash) utwórz i przejdź do nowego katalogu aplikacji o nazwie doc-intel-app.

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

2. Uruchom polecenie , npm init aby zainicjować aplikację i szkielet projektu.

   npm init
   

3. Określ atrybuty projektu przy użyciu monitów przedstawionych w terminalu.

   • Najważniejsze atrybuty to nazwa, numer wersji i punkt wejścia.
   • Zalecamy zachowanie index.js nazwy punktu wejścia. Opis, polecenie testowe, repozytorium GitHub, słowa kluczowe, autor i informacje o licencji są atrybutami opcjonalnymi — można je pominąć dla tego projektu.
   • Zaakceptuj sugestie w nawiasach, wybierając pozycję Return lub Enter.
   • Po zakończeniu monitów package.json plik zostanie utworzony w katalogu doc-intel-app.

4. Zainstaluj bibliotekę ai-document-intelligence klienta i azure/identity pakiety npm:

   npm i @azure-rest/ai-document-intelligence@1.0.0-beta.3 @azure/core-auth
   

   Plik aplikacji package.json jest aktualizowany przy użyciu zależności.

5. Utwórz plik o nazwie index.js w katalogu aplikacji.

   Napiwek

   • Nowy plik można utworzyć przy użyciu programu PowerShell.
   • Otwórz okno programu PowerShell w katalogu projektu, trzymając wciśnięty Shift i klikając folder prawym przyciskiem myszy.
   • Wpisz następujące polecenie New-Item index.js.

Kompilowanie aplikacji

Aby wchodzić w interakcje z usługą Analizy dokumentów, musisz utworzyć wystąpienie DocumentIntelligenceClient klasy . W tym celu należy utworzyć element za AzureKeyCredential key pomocą witryny Azure Portal i DocumentIntelligenceClient wystąpienia za pomocą narzędzia AzureKeyCredential i analizy endpointdokumentów.

1. index.js Otwórz plik w programie Visual Studio Code lub ulubionym środowisku IDE. Skopiuj i wklej jeden z następujących przykładów kodu do aplikacji:

   • Układ

   • Wstępnie utworzona faktura

Ważne

Pamiętaj, aby usunąć klucz z kodu po zakończeniu i nigdy nie publikować go publicznie. W przypadku środowiska produkcyjnego użyj bezpiecznego sposobu przechowywania i uzyskiwania dostępu do poświadczeń, takich jak usługa Azure Key Vault. Aby uzyskać więcej informacji, zobacz Zabezpieczenia usług Azure AI.

Model układu

Wyodrębnij tekst, znaczniki zaznaczenia, style tekstu, struktury tabel i współrzędne regionu ograniczenia z dokumentów.

• W tym przykładzie potrzebny będzie plik dokumentu z adresu URL. W tym przewodniku Szybki start możesz użyć naszego przykładowego dokumentu .
• Dodaliśmy wartość adresu URL pliku do zmiennej formUrl w górnej części pliku.
• Aby przeanalizować dany plik z adresu URL, użyjesz beginAnalyzeDocuments metody i przekażesz prebuilt-layout go jako identyfikator modelu.

    const DocumentIntelligence = require("@azure-rest/ai-document-intelligence").default,
  { getLongRunningPoller, isUnexpected } = 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 = DocumentIntelligence(endpoint, new AzureKeyCredential(key));


    const initialResponse = await client
      .path("/documentModels/{modelId}:analyze", "prebuilt-layout")
      .post({
        contentType: "application/json",
        body: {
          urlSource: formUrl
        },
       });

       if (isUnexpected(initialResponse)) {
       throw initialResponse.body.error;
     }

    const poller = await getLongRunningPoller(client, initialResponse);
    const analyzeResult = (await poller.pollUntilDone()).body.analyzeResult;

    const documents = analyzeResult?.documents;

    const document = documents && documents[0];
    if (!document) {
    throw new Error("Expected at least one document in the result.");
    }

    console.log(
    "Extracted document:",
    document.docType,
    `(confidence: ${document.confidence || "<undefined>"})`,
    );
    console.log("Fields:", document.fields);
}

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

Uruchamianie aplikacji

Po dodaniu przykładowego kodu do aplikacji uruchom program:

1. Przejdź do folderu, w którym masz aplikację analizy dokumentów (doc-intel-app).

2. Wpisz następujące polecenie w terminalu:

   node index.js
   

Wstępnie utworzony model

W tym przykładzie analizujemy fakturę przy użyciu wstępnie utworzonego modelu faktury .

Napiwek

Nie masz ograniczeń do faktur — istnieje kilka wstępnie utworzonych modeli do wyboru, z których każdy ma własny zestaw obsługiwanych pól. Model do użycia dla analyze operacji zależy od typu dokumentu do przeanalizowania. Zobacz wyodrębnianie danych modelu.

• Analizowanie faktury przy użyciu wstępnie utworzonego modelu faktury. Na potrzeby tego przewodnika Szybki start możesz użyć naszego przykładowego dokumentu faktury.
• Dodaliśmy wartość adresu URL pliku do zmiennej invoiceUrl w górnej części pliku.
• Aby przeanalizować dany plik przy użyciu identyfikatora URI, użyjesz beginAnalyzeDocuments metody i przekażesz PrebuiltModels.Invoice go jako identyfikator modelu. Zwracana wartość jest obiektem zawierającym result dane dotyczące przesłanego dokumentu.
• Dla uproszczenia wszystkie pary klucz-wartość zwracane przez usługę nie są tutaj wyświetlane. Aby wyświetlić listę wszystkich obsługiwanych pól i odpowiednich typów, zobacz naszą stronę koncepcji faktury .

const DocumentIntelligence = require("@azure-rest/ai-document-intelligence").default,
  { getLongRunningPoller, isUnexpected } = 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 invoiceUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/sample-invoice.pdf"

async function main() {

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

    const initialResponse = await client
    .path("/documentModels/{modelId}:analyze", "prebuilt-invoice")
    .post({
      contentType: "application/json",
      body: {
        // The Document Intelligence service will access the URL to the invoice image and extract data from it
        urlSource: invoiceUrl,
      },
    });

    if (isUnexpected(initialResponse)) {
       throw initialResponse.body.error;
     }

    const poller = await getLongRunningPoller(client, initialResponse);

    poller.onProgress((state) => console.log("Operation:", state.result, state.status));
    const analyzeResult = (await poller.pollUntilDone()).body.analyzeResult;

    const documents = analyzeResult?.documents;

    const result = documents && documents[0];
    if (result) {
      console.log(result.fields);
    } else {
      throw new Error("Expected at least one invoice in the result.");
    }

console.log(
    "Extracted invoice:",
    document.docType,
    `(confidence: ${document.confidence || "<undefined>"})`,
  );
  console.log("Fields:", document.fields);
}


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

Uruchamianie aplikacji

Po dodaniu przykładowego kodu do aplikacji uruchom program:

1. Przejdź do folderu, w którym masz aplikację analizy dokumentów (doc-intel-app).

2. Wpisz następujące polecenie w terminalu:

   node index.js
   

Dokumentacja interfejsu API REST ( | PyPi) | Przykłady | obsługiwanej wersji interfejsu API REST biblioteki klienta | |

W tym przewodniku Szybki start użyj następujących funkcji, aby analizować i wyodrębniać dane z formularzy i dokumentów:

• Układ — analizuj i wyodrębniaj tabele, linie, wyrazy i znaczniki zaznaczenia, takie jak przyciski radiowe i pola wyboru, oraz pary klucz-wartość bez konieczności trenowania modelu.

• Wstępnie utworzona faktura — analizowanie i wyodrębnianie typowych pól z określonych typów dokumentów przy użyciu wstępnie wytrenowanego modelu.

Wymagania wstępne

• Subskrypcja platformy Azure — utwórz jedną bezpłatnie.

• Środowisko Python w wersji 3.7 lub nowszej.

  • Instalacja języka Python powinna zawierać narzędzie. Możesz sprawdzić, czy masz zainstalowane narzędzie, uruchamiając polecenie pip --version w wierszu polecenia. Pobierz narzędzie, instalując najnowszą wersję języka Python.

• Najnowsza wersja programu Visual Studio Code lub preferowanego środowiska IDE. Aby uzyskać więcej informacji, zobacz Wprowadzenie do języka Python w programie Visual Studio Code.

• Usługi azure AI lub zasób analizy dokumentów. Po utworzeniu subskrypcji platformy Azure utwórz zasób analizy dokumentów z jedną usługą lub wieloma usługami w witrynie Azure Portal, aby uzyskać klucz i punkt końcowy. Możesz użyć warstwy cenowej bezpłatna (F0), aby wypróbować usługę, a następnie uaktualnić ją do warstwy płatnej dla środowiska produkcyjnego.

Napiwek

Utwórz zasób usług Azure AI, jeśli planujesz uzyskać dostęp do wielu usług azure AI w ramach jednego punktu końcowego/klucza. W przypadku dostępu tylko do analizy dokumentów utwórz zasób analizy dokumentów. Należy pamiętać, że jeśli zamierzasz używać uwierzytelniania firmy Microsoft Entra, potrzebujesz zasobu z jedną usługą.

• Po wdrożeniu zasobu wybierz pozycję Przejdź do zasobu. Potrzebujesz klucza i punktu końcowego z utworzonego zasobu, aby połączyć aplikację z interfejsem API analizy dokumentów. Klucz i punkt końcowy wklejasz do kodu w dalszej części przewodnika Szybki start:

  

Konfiguruj

Otwórz okno terminalu w środowisku lokalnym i zainstaluj bibliotekę klienta azure AI Document Intelligence dla języka Python za pomocą narzędzia:

pip install azure-ai-documentintelligence==1.0.0b4

Tworzenie aplikacji w języku Python

Aby wchodzić w interakcje z usługą Analizy dokumentów, musisz utworzyć wystąpienie DocumentIntelligenceClient klasy . W tym celu należy utworzyć element za AzureKeyCredential key pomocą witryny Azure Portal i DocumentIntelligenceClient wystąpienia za pomocą narzędzia AzureKeyCredential i analizy endpointdokumentów.

1. Utwórz nowy plik języka Python o nazwie doc_intel_quickstart.py w preferowanym edytorze lub środowisku IDE.

2. Otwórz plik doc_intel_quickstart.py i wybierz jeden z następujących przykładów kodu, aby skopiować i wkleić do aplikacji:

   • Układ

   • Wstępnie utworzona faktura

Ważne

Pamiętaj, aby usunąć klucz z kodu po zakończeniu i nigdy nie publikować go publicznie. W przypadku środowiska produkcyjnego użyj bezpiecznego sposobu przechowywania i uzyskiwania dostępu do poświadczeń, takich jak usługa Azure Key Vault. Aby uzyskać więcej informacji, zobacz Zabezpieczenia usług Azure AI.

Model układu

Wyodrębnij tekst, znaczniki zaznaczenia, style tekstu, struktury tabel i współrzędne regionu ograniczenia z dokumentów.

• W tym przykładzie potrzebny będzie plik dokumentu z adresu URL. W tym przewodniku Szybki start możesz użyć naszego przykładowego dokumentu .
• Dodaliśmy wartość adresu URL pliku do zmiennej formUrl analyze_layout w funkcji .

Dodaj następujący przykładowy kod do aplikacji doc_intel_quickstart.py. Pamiętaj, aby zaktualizować zmienne klucza i punktu końcowego przy użyciu wartości z wystąpienia analizy dokumentów w witrynie Azure Portal:

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

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

Uruchamianie aplikacji

Po dodaniu przykładowego kodu do aplikacji skompiluj i uruchom program:

1. Przejdź do folderu, w którym masz plik doc_intel_quickstart.py .

2. Wpisz następujące polecenie w terminalu:

   python doc_intel_quickstart.py
   

---

Wstępnie utworzony model

Analizowanie i wyodrębnianie typowych pól z określonych typów dokumentów przy użyciu wstępnie utworzonego modelu. W tym przykładzie analizujemy fakturę przy użyciu wstępnie utworzonego modelu faktury .

Napiwek

Nie masz ograniczeń do faktur — istnieje kilka wstępnie utworzonych modeli do wyboru, z których każdy ma własny zestaw obsługiwanych pól. Model do użycia dla analyze operacji zależy od typu dokumentu do przeanalizowania. Zobacz wyodrębnianie danych modelu.

• Analizowanie faktury przy użyciu wstępnie utworzonego modelu faktury. Na potrzeby tego przewodnika Szybki start możesz użyć naszego przykładowego dokumentu faktury.
• Dodaliśmy wartość adresu URL pliku do zmiennej invoiceUrl w górnej części pliku.
• Dla uproszczenia wszystkie pary klucz-wartość zwracane przez usługę nie są tutaj wyświetlane. Aby wyświetlić listę wszystkich obsługiwanych pól i odpowiednich typów, zobacz naszą stronę koncepcji faktury .

Dodaj następujący przykładowy kod do aplikacji doc_intel_quickstart.py. Pamiętaj, aby zaktualizować zmienne klucza i punktu końcowego przy użyciu wartości z wystąpienia analizy dokumentów w witrynie Azure Portal:

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



# 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", AnalyzeDocumentRequest(url_source=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()

Uruchamianie aplikacji

Po dodaniu przykładowego kodu do aplikacji skompiluj i uruchom program:

1. Przejdź do folderu, w którym masz plik doc_intel_quickstart.py .

2. Wpisz następujące polecenie w terminalu:

   python doc_intel_quickstart.py
   

| Interfejs API | REST analizy dokumentów — obsługiwane zestawy Azure SDK

W tym przewodniku Szybki start dowiesz się, jak używać interfejsu API REST analizy dokumentów do analizowania i wyodrębniania danych i wartości z dokumentów:

Wymagania wstępne

• Subskrypcja platformy Azure — utwórz bezpłatnie

• Zainstalowane narzędzie wiersza polecenia curl.

  • Windows
  • Komputery Mac lub Linux

• PowerShell w wersji 7.*+ (lub podobnej aplikacji wiersza polecenia).):

  • Windows
  • macOS
  • Linux

• Aby sprawdzić wersję programu PowerShell, wpisz następujące polecenie względem systemu operacyjnego:

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

• Zasób analizy dokumentów (pojedynczej usługi) lub usługi Azure AI (multi-service). Po utworzeniu subskrypcji platformy Azure utwórz zasób analizy dokumentów z jedną usługą lub wieloma usługami w witrynie Azure Portal, aby uzyskać klucz i punkt końcowy. Możesz użyć warstwy cenowej bezpłatna (F0), aby wypróbować usługę, a następnie uaktualnić ją do warstwy płatnej dla środowiska produkcyjnego.

Napiwek

Utwórz zasób usług Azure AI, jeśli planujesz uzyskać dostęp do wielu usług azure AI w ramach jednego punktu końcowego/klucza. W przypadku dostępu tylko do analizy dokumentów utwórz zasób analizy dokumentów. Należy pamiętać, że jeśli zamierzasz używać uwierzytelniania firmy Microsoft Entra, potrzebujesz zasobu z jedną usługą.

• Po wdrożeniu zasobu wybierz pozycję Przejdź do zasobu. Potrzebujesz klucza i punktu końcowego z utworzonego zasobu, aby połączyć aplikację z interfejsem API analizy dokumentów. Klucz i punkt końcowy wklejasz do kodu w dalszej części przewodnika Szybki start:

  

Analizowanie dokumentów i uzyskiwanie wyników

Żądanie POST służy do analizowania dokumentów przy użyciu wstępnie utworzonego lub niestandardowego modelu. Żądanie GET służy do pobierania wyniku wywołania analizy dokumentu. Element modelId jest używany z operacjami POST i resultId GET.

Analizowanie dokumentu (żądanie POST)

Przed uruchomieniem polecenia cURL wprowadź następujące zmiany w żądaniu post:

1. Zastąp {endpoint} element wartością punktu końcowego z wystąpienia analizy dokumentów w witrynie Azure Portal.

2. Zastąp {key} ciąg wartością klucza z wystąpienia analizy dokumentów w witrynie Azure Portal.

3. Korzystając z poniższej tabeli jako odwołania, zastąp {modelID} wartości i {your-document-url} żądanymi wartościami.

4. Potrzebny jest plik dokumentu pod adresem URL. W tym przewodniku Szybki start możesz użyć przykładowych formularzy podanych w poniższej tabeli dla każdej funkcji:

Przykładowe dokumenty

Funkcja	{modelID}	{twój-dokument-url}
Przeczytaj	odczyt wstępnie utworzony	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/read.png
Układ	wstępnie utworzony układ	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/layout.png
Karta ubezpieczenia zdrowotnego	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	wstępnie utworzona faktura	https://github.com/Azure-Samples/cognitive-services-REST-api-samples/raw/master/curl/form-recognizer/rest-api/invoice.pdf
Paragon	wstępnie utworzone potwierdzenie	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/receipt.png
Dokument tożsamości	prebuilt-idDocument	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/identity_documents.png

Ważne

Pamiętaj, aby usunąć klucz z kodu po zakończeniu i nigdy nie publikować go publicznie. W przypadku środowiska produkcyjnego użyj bezpiecznego sposobu przechowywania i uzyskiwania dostępu do poświadczeń, takich jak usługa Azure Key Vault. Aby uzyskać więcej informacji, zobacz Zabezpieczenia usług Azure AI.

Żądanie POST

curl -v -i POST "{endpoint}/documentintelligence/documentModels/{modelId}:analyze?api-version=2024-11-30" -H "Content-Type: application/json" -H "Ocp-Apim-Subscription-Key: {key}" --data-ascii "{'urlSource': '{your-document-url}'}"

Odpowiedź POST (resultID)

Otrzymasz odpowiedź zawierającą 202 (Success) nagłówek Operation-Location tylko do odczytu. Wartość tego nagłówka zawiera element resultID , który można wysłać do zapytania w celu uzyskania stanu operacji asynchronicznej i pobrania wyników przy użyciu żądania GET z tym samym kluczem subskrypcji zasobu:

Pobieranie wyników analizy (żądanie GET)

Po wywołaniu interfejsu Analyze documentAPI &preserve-view=true&tabs=HTTP wywołaj interfejs API Get analyze result&preserve-view=true&tabs=HTTP), aby uzyskać stan operacji i wyodrębnionych danych. Przed uruchomieniem polecenia wprowadź następujące zmiany:

1. Zastąp {resultID} nagłówek Operation-Location z odpowiedzi POST.

2. Zastąp {key} ciąg wartością klucza z wystąpienia analizy dokumentów w witrynie Azure Portal.

Żądanie GET

curl -v -X GET "{endpoint}/documentintelligence/documentModels/{modelId}/analyzeResults/{resultId}?api-version=2024-11-30" -H "Ocp-Apim-Subscription-Key: {key}"

Sprawdzanie odpowiedzi

200 (Success) Otrzymasz odpowiedź z danymi wyjściowymi JSON. Pierwsze pole , "status"wskazuje stan operacji. Jeśli operacja nie jest ukończona, wartość "status" to "running" lub "notStarted", a należy wywołać interfejs API ponownie, ręcznie lub za pomocą skryptu. Zalecamy interwał co najmniej jednej sekundy między wywołaniami.

Przykładowa odpowiedź dla wstępnie utworzonej faktury

{
    "status": "succeeded",
    "createdDateTime": "2024-03-25T19:31:37Z",
    "lastUpdatedDateTime": "2024-03-25T19:31:43Z",
    "analyzeResult": {
        "apiVersion": "2024-11-30",
        "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
                                }
                      }],
              }]
      }
}

Obsługiwane pola dokumentów

Wstępnie utworzone modele wyodrębniają wstępnie zdefiniowane zestawy pól dokumentów. Zobacz Wyodrębnianie danych modelu, aby uzyskać wyodrębnione nazwy pól, typy, opisy i przykłady.

To wszystko, gratulacje!

W tym przewodniku Szybki start użyto modelu analizy dokumentów do analizowania różnych formularzy i dokumentów. Następnie zapoznaj się z dokumentacją narzędzia Document Intelligence Studio i dokumentacją referencyjną, aby dowiedzieć się więcej o interfejsie API analizy dokumentów.

Następne kroki

• Aby uzyskać ulepszone środowisko i zaawansowaną jakość modelu, wypróbuj narzędzie Document Intelligence Studio

• Aby przeprowadzić migrację z wersji 3.1 do wersji 4.0, zobacz Przewodniki migracji dziennika zmian.

• Znajdź więcej przykładów w witrynie GitHub.