Korzystanie z modeli analizy dokumentów

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

Z tego przewodnika dowiesz się, jak dodawać modele analizy dokumentów do aplikacji i przepływów pracy. Użyj wybranego zestawu SDK języka programowania lub interfejsu API REST.

Azure AI Document Intelligence to oparta na chmurze usługa Azure AI, która używa uczenia maszynowego do wyodrębniania kluczowych elementów tekstu i struktury z dokumentów. Zalecamy korzystanie z bezpłatnej usługi podczas uczenia się technologii. Pamiętaj, że liczba bezpłatnych stron jest ograniczona do 500 miesięcznie.

Wybierz spośród następujących modeli analizy dokumentów i analizuj i wyodrębnij dane oraz wartości z formularzy i dokumentów:

• Wstępnie utworzony model odczytu jest podstawą wszystkich modeli analizy dokumentów i może wykrywać wiersze, wyrazy, lokalizacje i języki. Układ, ogólny dokument, wstępnie utworzone i niestandardowe modele używają read modelu jako podstawy do wyodrębniania tekstów z dokumentów.

• Wstępnie utworzony model układu wyodrębnia lokalizacje tekstu i tekstu, tabele, znaczniki zaznaczenia i informacje o strukturze z dokumentów i obrazów. Pary klucz/wartość można wyodrębnić przy użyciu modelu układu z włączonym opcjonalnym parametrem features=keyValuePairs ciągu zapytania.

• Wstępnie utworzony model kontraktu wyodrębnia kluczowe informacje z umów umownych.

• Model prebuilt-healthInsuranceCard.us wyodrębnia kluczowe informacje z amerykańskich kart ubezpieczenia zdrowotnego.

• Wstępnie utworzony model dokumentów podatkowych wyodrębnia informacje zgłaszane na temat formularzy podatkowych w USA.

• Wstępnie utworzony model faktury wyodrębnia pola kluczy i elementy wiersza z faktur sprzedaży w różnych formatach i jakości. Pola obejmują obrazy przechwycone przez telefon, zeskanowane dokumenty i cyfrowe pliki PDF.

• Wstępnie utworzony model paragonu wyodrębnia kluczowe informacje z drukowanych i odręcznych paragonów sprzedaży.

• Wstępnie utworzony model idDocument wyodrębnia kluczowe informacje z amerykańskich licencji kierowców, międzynarodowych stron biograficznych paszportów, identyfikatorów stanów USA, kart ubezpieczenia społecznego i stałych kart rezydentów.

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

Wymagania wstępne

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

• Środowisko IDE programu Visual Studio.

• Usługi azure AI lub zasób analizy dokumentów. Utwórz pojedynczą usługę lub wiele usług. 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.

• Klucz i punkt końcowy z utworzonego zasobu w celu połączenia aplikacji z usługą Azure Document Intelligence.

  1. Po wdrożeniu zasobu wybierz pozycję Przejdź do zasobu.
  2. W menu nawigacji po lewej stronie wybierz pozycję Klucze i punkt końcowy.
  3. Skopiuj jeden z kluczy i punkt końcowy do użycia w dalszej części tego artykułu.

  

• Plik dokumentu w lokalizacji adresu URL. W tym projekcie można użyć przykładowych formularzy podanych w poniższej tabeli dla każdej funkcji:

  Funkcja	modelID	document-url
  Odczyt modelu	odczyt wstępnie utworzony	Broszura przykładowa
  Model układu	wstępnie utworzony układ	Potwierdzenie rezerwacji przykładowej
  Model formularza W-2	prebuilt-tax.us.w2	Przykładowy formularz W-2
  Model faktury	wstępnie utworzona faktura	Przykładowa faktura
  Model paragonu	wstępnie utworzone potwierdzenie	Przykładowe potwierdzenie
  Model dokumentu identyfikatora	prebuilt-idDocument	Przykładowy dokument o identyfikatorze

Ustawianie zmiennych środowiskowych

Aby wchodzić w interakcje z usługą Analizy dokumentów, musisz utworzyć wystąpienie DocumentAnalysisClient klasy . W tym celu utwórz wystąpienie klienta za pomocą witryny key Azure Portal.endpoint W tym projekcie użyj zmiennych środowiskowych do przechowywania poświadczeń i uzyskiwania do nich dostępu.

Ważne

Jeśli używasz klucza interfejsu API, zapisz go bezpiecznie w innym miejscu, na przykład w usłudze Azure Key Vault. Nie dołączaj klucza interfejsu API bezpośrednio do kodu i nigdy nie publikuj go publicznie.

Aby uzyskać więcej informacji na temat zabezpieczeń usług sztucznej inteligencji, zobacz Uwierzytelnianie żądań w usługach Azure AI.

Aby ustawić zmienną środowiskową dla klucza zasobu analizy dokumentów, otwórz okno konsoli i postępuj zgodnie z instrukcjami dotyczącymi systemu operacyjnego i środowiska programistycznego. Zastąp <ciąg yourKey> i <yourEndpoint> wartościami z zasobu w witrynie Azure Portal.

Windows

Zmienne środowiskowe w systemie Windows nie są uwzględniane wielkości liter. Są one zwykle deklarowane wielkimi literami, ze słowami połączonymi podkreśleniami. W wierszu polecenia uruchom następujące polecenia:

1. Ustaw zmienną klucza:

   setx DI_KEY <yourKey>
   

2. Ustawianie zmiennej punktu końcowego

   setx DI_ENDPOINT <yourEndpoint>
   

3. Zamknij okno wiersza polecenia po ustawieniu zmiennych środowiskowych. Wartości pozostają do momentu ich ponownej zmiany.

4. Uruchom ponownie wszystkie uruchomione programy, które odczytują zmienną środowiskową. Jeśli na przykład używasz programu Visual Studio lub Visual Studio Code jako edytora, uruchom ponownie przed uruchomieniem przykładowego kodu.

Oto kilka bardziej przydatnych poleceń do użycia ze zmiennymi środowiskowymi:

Polecenie	Akcja	Przykład
setx VARIABLE_NAME=	Usuń zmienną środowiskową, ustawiając wartość na pusty ciąg.	setx DI_KEY=
setx VARIABLE_NAME=value	Ustaw lub zmień wartość zmiennej środowiskowej.	setx DI_KEY=<yourKey>
set VARIABLE_NAME	Wyświetl wartość określonej zmiennej środowiskowej.	set DI_KEY
set	Wyświetl wszystkie zmienne środowiskowe.	set

macOS

Zmienne środowiskowe w systemie macOS są uwzględniane wielkości liter. Konwencjonalnie nazwa zmiennej jest deklarowana w wielkich literach.

Polecenie export ustawia zmienną i eksportuje ją do środowiska globalnego, które jest dostępne dla innych procesów. Jednak wartość jest tymczasowa i trwa tylko do momentu zamknięcia sesji terminalu. Otwórz terminal i wprowadź następujące polecenia:

1. Ustaw zmienną klucza:

   export key=<yourKey>
   

2. Ustaw zmienną punktu końcowego:

   export endpoint=<yourEndpoint>
   

Aby trwale ustawić zmienną środowiskową, umieść polecenie eksportu w skryscie uruchamiania powłoki Bash ~/.bash_profile :

1. Za pomocą edytora tekstów otwórz plik ~/.bash_profile i dodaj następujące polecenie, aby utworzyć stałą zmienną środowiskową:

   export DI_KEY=<yourKey> DI_ENDPOINT=<yourEndpoint>
   

   Przykład: export DI_KEY="<yourKey>"

2. Zapisz zmiany w pliku bash_profile .

3. Aby wprowadzić zmiany, uruchom następujące polecenie w oknie terminalu:

   source ~/.bash-profile
   

Oto kilka bardziej przydatnych poleceń do użycia ze zmiennymi środowiskowymi:

Polecenie	Akcja	Przykład
unset VARIABLE_NAME	Usuń zmienną środowiskową.	unset DI_KEY
export VARIABLE_NAME=value	Ustaw lub zmień wartość tymczasowej zmiennej środowiskowej.	export DI_KEY=<yourKey>
printenv VARIABLE_NAME echo $VARIABLE_NAME	Wyświetl wartość określonej zmiennej środowiskowej. echo Za pomocą polecenia przed zmienną $za pomocą polecenia .	printenv DI_KEY echo $DI_KEY
printenv	Wyświetl wszystkie zmienne środowiskowe.	printenv

Linux

Zmienne środowiskowe w systemie Linux są wrażliwe na wielkość liter. Konwencjonalnie nazwa zmiennej jest deklarowana w wielkich literach.

Polecenie export ustawia zmienną i eksportuje ją do środowiska globalnego, które jest dostępne dla innych procesów. Jednak wartość jest tymczasowa i trwa tylko do momentu zamknięcia sesji terminalu:

1. Ustaw zmienną klucza:

   export DI_KEY=<yourKey>
   

2. Ustaw zmienną punktu końcowego:

   export DI_ENDPOINT=<yourEndpoint>
   

Aby trwale ustawić zmienną środowiskową, umieść polecenie eksportu w skryscie uruchamiania powłoki Bash ~/.bashrc :

1. Za pomocą edytora tekstów otwórz plik ~/.bashrc i dodaj następujące polecenie, aby utworzyć stałą zmienną środowiskową:

   export <VARIABLE>=<value>
   

   Przykład: export DI_KEY=<yourKey>

2. Zapisz zmiany w pliku bashrc .

3. Aby wprowadzić zmiany, uruchom następujące polecenie w oknie terminalu:

   source ~/.bashrc
   

Oto kilka bardziej przydatnych poleceń do użycia ze zmiennymi środowiskowymi:

Polecenie	Akcja	Przykład
unset VARIABLE_NAME	Usuń zmienną środowiskową.	unset DI_KEY=
export VARIABLE_NAME=value	Ustaw lub zmień wartość tymczasowej zmiennej środowiskowej.	export DI_KEY={yourKey}
printenv VARIABLE_NAME echo $VARIABLE_NAME	Wyświetl wartość zmiennej środowiskowej. echo Za pomocą polecenia przed zmienną $za pomocą polecenia .	printenv DI_KEY echo $DI_KEY
printenv	Wyświetl wszystkie zmienne środowiskowe.	printenv

Konfigurowanie środowiska programowania

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. Na stronie Konfigurowanie nowego projektu w obszarze Nazwa projektu wprowadź docIntelligence_app. Następnie kliknij przycisk Dalej.

   

5. Na stronie 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 docIntelligence_app i wybierz polecenie Zarządzaj pakietami NuGet... .

   

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

3. Include prerelease Zaznacz pole wyboru.

   

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

Kompilowanie aplikacji

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 Szablon aplikacji konsolowej języka C# generuje instrukcje najwyższego poziomu.

1. Otwórz plik Program.cs.

2. Usuń istniejący kod, w tym wiersz Console.Writeline("Hello World!").

3. Wybierz jeden z następujących przykładów kodu i skopiuj/wklej do pliku Program.cs aplikacji:

   • odczyt wstępnie utworzony
   • wstępnie utworzony układ
   • prebuilt-tax.us.w2
   • wstępnie utworzona faktura
   • wstępnie utworzone potwierdzenie
   • prebuilt-idDocument

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

   

Korzystanie z modelu odczytu

using Azure;
using Azure.AI.DocumentIntelligence;

//use your `key` and `endpoint` environment variables to create your `AzureKeyCredential` and `DocumentIntelligenceClient` instances
string key = Environment.GetEnvironmentVariable("DI_KEY");
string endpoint = Environment.GetEnvironmentVariable("DI_ENDPOINT");
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/rest-api/read.png");

Operation<AnalyzeResult> operation = await client.AnalyzeDocumentAsync(WaitUntil.Completed, "prebuilt-read", fileUri);
AnalyzeResult result = operation.Value;

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

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

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

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

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

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

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

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

Console.WriteLine("Detected languages:");

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

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl read dane wyjściowe modelu.

Korzystanie z modelu układu

using Azure;
using Azure.AI.DocumentIntelligence;

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

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

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),");
    Console.WriteLine($"and {page.SelectionMarks.Count} selection mark(s).");

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

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

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

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

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

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

Console.WriteLine("Paragraphs:");

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

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

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

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

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

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

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

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

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

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl dane wyjściowe modelu układu.

Korzystanie z ogólnego modelu dokumentów

using Azure;
using Azure.AI.DocumentIntelligence;

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

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

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

AnalyzeResult result = operation.Value;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl ogólne dane wyjściowe modelu dokumentu.

Korzystanie z modelu podatkowego W-2

using Azure;
using Azure.AI.DocumentIntelligence;

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

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

Operation<AnalyzeResult> operation = await client.AnalyzeDocumentAsync(WaitUntil.Completed, "prebuilt-tax.us.w2", w2Uri);

AnalyzeResult result = operation.Value;

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

    AnalyzedDocument document = result.Documents[i];

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

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

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

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

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

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


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

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

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

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

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

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

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

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl dane wyjściowe modelu podatkowego W-2.

Korzystanie z modelu faktury

using Azure;
using Azure.AI.DocumentIntelligence;

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

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

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))
    {
        if (vendorNameField.FieldType == DocumentFieldType.String)
        {
            string vendorName = vendorNameField.Value.AsString();
            Console.WriteLine($"Vendor Name: '{vendorName}', with confidence {vendorNameField.Confidence}");
        }
    }

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

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

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

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

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

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

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

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

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

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

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl dane wyjściowe modelu faktury.

Korzystanie z modelu paragonu

using Azure;
using Azure.AI.DocumentIntelligence;

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

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

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

AnalyzeResult receipts = operation.Value;

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

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

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

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

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

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

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

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

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

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

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

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

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl dane wyjściowe modelu paragonu.

Korzystanie z modelu dokumentów identyfikatorów

using Azure;
using Azure.AI.DocumentIntelligence;

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

// sample document document

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

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

AnalyzeResult identityDocuments = operation.Value;

AnalyzedDocument identityDocument = identityDocuments.Documents.Single();

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

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

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

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

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

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

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

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

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

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl dane wyjściowe modelu dokumentu identyfikatora.

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

Wymagania wstępne

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

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

  • Program Visual Studio Code oferuje pakiet kodowania dla języka Java dla systemów Windows i macOS. Pakiet kodowania jest pakietem VS kodu, zestawu 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 kodu i pakietu kodowania dla języka VS Java, zainstaluj rozszerzenie Gradle dla języka 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. Utwórz pojedynczą usługę lub wiele usług. 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 przy użyciu jednego punktu końcowego i klucza. W przypadku dostępu tylko do analizy dokumentów utwórz zasób analizy dokumentów. Jeśli zamierzasz używać uwierzytelniania Firmy Microsoft Entra, potrzebujesz zasobu z jedną usługą.

• Klucz i punkt końcowy z utworzonego zasobu w celu połączenia aplikacji z usługą Azure Document Intelligence.

  1. Po wdrożeniu zasobu wybierz pozycję Przejdź do zasobu.
  2. W menu nawigacji po lewej stronie wybierz pozycję Klucze i punkt końcowy.
  3. Skopiuj jeden z kluczy i punkt końcowy do użycia w dalszej części tego artykułu.

  

• Plik dokumentu pod adresem URL. W tym projekcie można użyć przykładowych formularzy podanych w poniższej tabeli dla każdej funkcji:

  Funkcja	modelID	document-url
  Odczyt modelu	odczyt wstępnie utworzony	Broszura przykładowa
  Model układu	wstępnie utworzony układ	Potwierdzenie rezerwacji przykładowej
  Model formularza W-2	prebuilt-tax.us.w2	Przykładowy formularz W-2
  Model faktury	wstępnie utworzona faktura	Przykładowa faktura
  Model paragonu	wstępnie utworzone potwierdzenie	Przykładowe potwierdzenie
  Model dokumentu identyfikatora	prebuilt-idDocument	Przykładowy dokument o identyfikatorze

Ustawianie zmiennych środowiskowych

Aby wchodzić w interakcje z usługą Analizy dokumentów, musisz utworzyć wystąpienie DocumentAnalysisClient klasy . W tym celu utwórz wystąpienie klienta za pomocą witryny key Azure Portal.endpoint W tym projekcie użyj zmiennych środowiskowych do przechowywania poświadczeń i uzyskiwania do nich dostępu.

Ważne

Jeśli używasz klucza interfejsu API, zapisz go bezpiecznie w innym miejscu, na przykład w usłudze Azure Key Vault. Nie dołączaj klucza interfejsu API bezpośrednio do kodu i nigdy nie publikuj go publicznie.

Aby uzyskać więcej informacji na temat zabezpieczeń usług sztucznej inteligencji, zobacz Uwierzytelnianie żądań w usługach Azure AI.

Aby ustawić zmienną środowiskową dla klucza zasobu analizy dokumentów, otwórz okno konsoli i postępuj zgodnie z instrukcjami dotyczącymi systemu operacyjnego i środowiska programistycznego. Zastąp <ciąg yourKey> i <yourEndpoint> wartościami z zasobu w witrynie Azure Portal.

Windows

Zmienne środowiskowe w systemie Windows nie są uwzględniane wielkości liter. Są one zwykle deklarowane wielkimi literami, ze słowami połączonymi podkreśleniami. W wierszu polecenia uruchom następujące polecenia:

1. Ustaw zmienną klucza:

   setx DI_KEY <yourKey>
   

2. Ustawianie zmiennej punktu końcowego

   setx DI_ENDPOINT <yourEndpoint>
   

3. Zamknij okno wiersza polecenia po ustawieniu zmiennych środowiskowych. Wartości pozostają do momentu ich ponownej zmiany.

4. Uruchom ponownie wszystkie uruchomione programy, które odczytują zmienną środowiskową. Jeśli na przykład używasz programu Visual Studio lub Visual Studio Code jako edytora, uruchom ponownie przed uruchomieniem przykładowego kodu.

Oto kilka bardziej przydatnych poleceń do użycia ze zmiennymi środowiskowymi:

Polecenie	Akcja	Przykład
setx VARIABLE_NAME=	Usuń zmienną środowiskową, ustawiając wartość na pusty ciąg.	setx DI_KEY=
setx VARIABLE_NAME=value	Ustaw lub zmień wartość zmiennej środowiskowej.	setx DI_KEY=<yourKey>
set VARIABLE_NAME	Wyświetl wartość określonej zmiennej środowiskowej.	set DI_KEY
set	Wyświetl wszystkie zmienne środowiskowe.	set

macOS

Zmienne środowiskowe w systemie macOS są uwzględniane wielkości liter. Konwencjonalnie nazwa zmiennej jest deklarowana w wielkich literach.

Polecenie export ustawia zmienną i eksportuje ją do środowiska globalnego, które jest dostępne dla innych procesów. Jednak wartość jest tymczasowa i trwa tylko do momentu zamknięcia sesji terminalu. Otwórz terminal i wprowadź następujące polecenia:

1. Ustaw zmienną klucza:

   export key=<yourKey>
   

2. Ustaw zmienną punktu końcowego:

   export endpoint=<yourEndpoint>
   

Aby trwale ustawić zmienną środowiskową, umieść polecenie eksportu w skryscie uruchamiania powłoki Bash ~/.bash_profile :

1. Za pomocą edytora tekstów otwórz plik ~/.bash_profile i dodaj następujące polecenie, aby utworzyć stałą zmienną środowiskową:

   export DI_KEY=<yourKey> DI_ENDPOINT=<yourEndpoint>
   

   Przykład: export DI_KEY="<yourKey>"

2. Zapisz zmiany w pliku bash_profile .

3. Aby wprowadzić zmiany, uruchom następujące polecenie w oknie terminalu:

   source ~/.bash-profile
   

Oto kilka bardziej przydatnych poleceń do użycia ze zmiennymi środowiskowymi:

Polecenie	Akcja	Przykład
unset VARIABLE_NAME	Usuń zmienną środowiskową.	unset DI_KEY
export VARIABLE_NAME=value	Ustaw lub zmień wartość tymczasowej zmiennej środowiskowej.	export DI_KEY=<yourKey>
printenv VARIABLE_NAME echo $VARIABLE_NAME	Wyświetl wartość określonej zmiennej środowiskowej. echo Za pomocą polecenia przed zmienną $za pomocą polecenia .	printenv DI_KEY echo $DI_KEY
printenv	Wyświetl wszystkie zmienne środowiskowe.	printenv

Linux

Zmienne środowiskowe w systemie Linux są wrażliwe na wielkość liter. Konwencjonalnie nazwa zmiennej jest deklarowana w wielkich literach.

Polecenie export ustawia zmienną i eksportuje ją do środowiska globalnego, które jest dostępne dla innych procesów. Jednak wartość jest tymczasowa i trwa tylko do momentu zamknięcia sesji terminalu:

1. Ustaw zmienną klucza:

   export DI_KEY=<yourKey>
   

2. Ustaw zmienną punktu końcowego:

   export DI_ENDPOINT=<yourEndpoint>
   

Aby trwale ustawić zmienną środowiskową, umieść polecenie eksportu w skryscie uruchamiania powłoki Bash ~/.bashrc :

1. Za pomocą edytora tekstów otwórz plik ~/.bashrc i dodaj następujące polecenie, aby utworzyć stałą zmienną środowiskową:

   export <VARIABLE>=<value>
   

   Przykład: export DI_KEY=<yourKey>

2. Zapisz zmiany w pliku bashrc .

3. Aby wprowadzić zmiany, uruchom następujące polecenie w oknie terminalu:

   source ~/.bashrc
   

Oto kilka bardziej przydatnych poleceń do użycia ze zmiennymi środowiskowymi:

Polecenie	Akcja	Przykład
unset VARIABLE_NAME	Usuń zmienną środowiskową.	unset DI_KEY=
export VARIABLE_NAME=value	Ustaw lub zmień wartość tymczasowej zmiennej środowiskowej.	export DI_KEY={yourKey}
printenv VARIABLE_NAME echo $VARIABLE_NAME	Wyświetl wartość zmiennej środowiskowej. echo Za pomocą polecenia przed zmienną $za pomocą polecenia .	printenv DI_KEY echo $DI_KEY
printenv	Wyświetl wszystkie zmienne środowiskowe.	printenv

Konfigurowanie środowiska programowania

Aby skonfigurować środowisko programowania, utwórz projekt Gradle i zainstaluj bibliotekę klienta.

Tworzenie projektu Gradle

1. W oknie konsoli utwórz katalog dla aplikacji o nazwie doc-intelligence-app i przejdź do niego.

   mkdir doc-intelligence-app
   cd doc-intelligence-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. Wybierz Enter , aby zaakceptować domyślną nazwę projektu, doc-intelligence-app.

Instalowanie biblioteki klienta

W tym artykule 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.

1. Otwórz plik build.gradle.kts projektu w środowisku IDE. Skopiuj 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, utwórz 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-intelligence-app uruchom następujące polecenie:

   mkdir -p src/main/java
   

To polecenie tworzy następującą strukturę katalogów:

1. 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 prawym przyciskiem myszy folder, a następnie wpisz następujące polecenie: New-Item DocIntelligence.java.

2. Otwórz plik DocIntelligence.java i wybierz jeden z następujących przykładów kodu ORAZ skopiuj/wklej do aplikacji:

   • Wstępnie utworzony model odczytu jest podstawą wszystkich modeli analizy dokumentów i może wykrywać wiersze, wyrazy, lokalizacje i języki. Układ, ogólny dokument, wstępnie utworzone i niestandardowe modele używają read modelu jako podstawy do wyodrębniania tekstów z dokumentów.
   • Wstępnie utworzony model układu wyodrębnia lokalizacje tekstu i tekstu, tabele, znaczniki zaznaczenia i informacje o strukturze z dokumentów i obrazów.
   • Wstępnie utworzony model tax.us.w2 wyodrębnia informacje zgłaszane na formularzach podatkowych us Internal Revenue Service (IRS).
   • Wstępnie utworzony model faktury wyodrębnia pola kluczy i elementy wiersza z faktur sprzedaży w różnych formatach.
   • Wstępnie utworzony model paragonu wyodrębnia kluczowe informacje z drukowanych i odręcznych paragonów sprzedaży.
   • Wstępnie utworzony model idDocument wyodrębnia kluczowe informacje z amerykańskich licencji kierowców; międzynarodowe strony biograficzne paszportu; Identyfikatory stanów USA; karty ubezpieczenia społecznego; i stałe karty zamieszkania.

3. Wpisz następujące polecenia:

   gradle build
   gradle run
   

Korzystanie z modelu odczytu

import com.azure.ai.documentintelligence;

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

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


public class DocIntelligence {

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

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

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

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

String modelId = "prebuilt-read";

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

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

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

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

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

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl read dane wyjściowe modelu.

Korzystanie z modelu układu

import com.azure.ai.documentintelligence;

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

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

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

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

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

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

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

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

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

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

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

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

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

}

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

}

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl dane wyjściowe modelu układu.

Korzystanie z ogólnego modelu dokumentów

import com.azure.ai.documentintelligence;

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

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

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

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

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

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

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

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

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

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

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

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

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

}

}

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl ogólne dane wyjściowe modelu dokumentu.

Korzystanie z modelu podatkowego W-2

import com.azure.ai.documentintelligence;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl dane wyjściowe modelu podatkowego W-2.

Korzystanie z modelu faktury

import com.azure.ai.documentintelligence;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl dane wyjściowe modelu faktury.

Korzystanie z modelu paragonów

import com.azure.ai.documentintelligence;

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

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

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

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

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

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

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

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

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

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

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

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

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

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl dane wyjściowe modelu paragonu.

Korzystanie z modelu dokumentów identyfikatorów

import com.azure.ai.documentintelligence;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl dane wyjściowe modelu dokumentu identyfikatora.

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

Wymagania wstępne

• Subskrypcja platformy Azure — utwórz 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. Utwórz pojedynczą usługę lub wiele usług. 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 przy użyciu jednego punktu końcowego i klucza. W przypadku dostępu tylko do analizy dokumentów utwórz zasób analizy dokumentów. Jeśli zamierzasz używać uwierzytelniania Firmy Microsoft Entra, potrzebujesz zasobu z jedną usługą.

• Klucz i punkt końcowy z utworzonego zasobu w celu połączenia aplikacji z usługą Azure Document Intelligence.

  1. Po wdrożeniu zasobu wybierz pozycję Przejdź do zasobu.
  2. W menu nawigacji po lewej stronie wybierz pozycję Klucze i punkt końcowy.
  3. Skopiuj jeden z kluczy i punkt końcowy do użycia w dalszej części tego artykułu.

  

• Plik dokumentu pod adresem URL. W tym projekcie można użyć przykładowych formularzy podanych w poniższej tabeli dla każdej funkcji:

  Funkcja	modelID	document-url
  Odczyt modelu	odczyt wstępnie utworzony	Broszura przykładowa
  Model układu	wstępnie utworzony układ	Potwierdzenie rezerwacji przykładowej
  Model formularza W-2	prebuilt-tax.us.w2	Przykładowy formularz W-2
  Model faktury	wstępnie utworzona faktura	Przykładowa faktura
  Model paragonu	wstępnie utworzone potwierdzenie	Przykładowe potwierdzenie
  Model dokumentu identyfikatora	prebuilt-idDocument	Przykładowy dokument o identyfikatorze

Ustawianie zmiennych środowiskowych

Aby wchodzić w interakcje z usługą Analizy dokumentów, musisz utworzyć wystąpienie DocumentAnalysisClient klasy . W tym celu utwórz wystąpienie klienta za pomocą witryny key Azure Portal.endpoint W tym projekcie użyj zmiennych środowiskowych do przechowywania poświadczeń i uzyskiwania do nich dostępu.

Ważne

Jeśli używasz klucza interfejsu API, zapisz go bezpiecznie w innym miejscu, na przykład w usłudze Azure Key Vault. Nie dołączaj klucza interfejsu API bezpośrednio do kodu i nigdy nie publikuj go publicznie.

Aby uzyskać więcej informacji na temat zabezpieczeń usług sztucznej inteligencji, zobacz Uwierzytelnianie żądań w usługach Azure AI.

Aby ustawić zmienną środowiskową dla klucza zasobu analizy dokumentów, otwórz okno konsoli i postępuj zgodnie z instrukcjami dotyczącymi systemu operacyjnego i środowiska programistycznego. Zastąp <ciąg yourKey> i <yourEndpoint> wartościami z zasobu w witrynie Azure Portal.

Windows

Zmienne środowiskowe w systemie Windows nie są uwzględniane wielkości liter. Są one zwykle deklarowane wielkimi literami, ze słowami połączonymi podkreśleniami. W wierszu polecenia uruchom następujące polecenia:

1. Ustaw zmienną klucza:

   setx DI_KEY <yourKey>
   

2. Ustawianie zmiennej punktu końcowego

   setx DI_ENDPOINT <yourEndpoint>
   

3. Zamknij okno wiersza polecenia po ustawieniu zmiennych środowiskowych. Wartości pozostają do momentu ich ponownej zmiany.

4. Uruchom ponownie wszystkie uruchomione programy, które odczytują zmienną środowiskową. Jeśli na przykład używasz programu Visual Studio lub Visual Studio Code jako edytora, uruchom ponownie przed uruchomieniem przykładowego kodu.

Oto kilka bardziej przydatnych poleceń do użycia ze zmiennymi środowiskowymi:

Polecenie	Akcja	Przykład
setx VARIABLE_NAME=	Usuń zmienną środowiskową, ustawiając wartość na pusty ciąg.	setx DI_KEY=
setx VARIABLE_NAME=value	Ustaw lub zmień wartość zmiennej środowiskowej.	setx DI_KEY=<yourKey>
set VARIABLE_NAME	Wyświetl wartość określonej zmiennej środowiskowej.	set DI_KEY
set	Wyświetl wszystkie zmienne środowiskowe.	set

macOS

Zmienne środowiskowe w systemie macOS są uwzględniane wielkości liter. Konwencjonalnie nazwa zmiennej jest deklarowana w wielkich literach.

Polecenie export ustawia zmienną i eksportuje ją do środowiska globalnego, które jest dostępne dla innych procesów. Jednak wartość jest tymczasowa i trwa tylko do momentu zamknięcia sesji terminalu. Otwórz terminal i wprowadź następujące polecenia:

1. Ustaw zmienną klucza:

   export key=<yourKey>
   

2. Ustaw zmienną punktu końcowego:

   export endpoint=<yourEndpoint>
   

Aby trwale ustawić zmienną środowiskową, umieść polecenie eksportu w skryscie uruchamiania powłoki Bash ~/.bash_profile :

1. Za pomocą edytora tekstów otwórz plik ~/.bash_profile i dodaj następujące polecenie, aby utworzyć stałą zmienną środowiskową:

   export DI_KEY=<yourKey> DI_ENDPOINT=<yourEndpoint>
   

   Przykład: export DI_KEY="<yourKey>"

2. Zapisz zmiany w pliku bash_profile .

3. Aby wprowadzić zmiany, uruchom następujące polecenie w oknie terminalu:

   source ~/.bash-profile
   

Oto kilka bardziej przydatnych poleceń do użycia ze zmiennymi środowiskowymi:

Polecenie	Akcja	Przykład
unset VARIABLE_NAME	Usuń zmienną środowiskową.	unset DI_KEY
export VARIABLE_NAME=value	Ustaw lub zmień wartość tymczasowej zmiennej środowiskowej.	export DI_KEY=<yourKey>
printenv VARIABLE_NAME echo $VARIABLE_NAME	Wyświetl wartość określonej zmiennej środowiskowej. echo Za pomocą polecenia przed zmienną $za pomocą polecenia .	printenv DI_KEY echo $DI_KEY
printenv	Wyświetl wszystkie zmienne środowiskowe.	printenv

Linux

Zmienne środowiskowe w systemie Linux są wrażliwe na wielkość liter. Konwencjonalnie nazwa zmiennej jest deklarowana w wielkich literach.

Polecenie export ustawia zmienną i eksportuje ją do środowiska globalnego, które jest dostępne dla innych procesów. Jednak wartość jest tymczasowa i trwa tylko do momentu zamknięcia sesji terminalu:

1. Ustaw zmienną klucza:

   export DI_KEY=<yourKey>
   

2. Ustaw zmienną punktu końcowego:

   export DI_ENDPOINT=<yourEndpoint>
   

Aby trwale ustawić zmienną środowiskową, umieść polecenie eksportu w skryscie uruchamiania powłoki Bash ~/.bashrc :

1. Za pomocą edytora tekstów otwórz plik ~/.bashrc i dodaj następujące polecenie, aby utworzyć stałą zmienną środowiskową:

   export <VARIABLE>=<value>
   

   Przykład: export DI_KEY=<yourKey>

2. Zapisz zmiany w pliku bashrc .

3. Aby wprowadzić zmiany, uruchom następujące polecenie w oknie terminalu:

   source ~/.bashrc
   

Oto kilka bardziej przydatnych poleceń do użycia ze zmiennymi środowiskowymi:

Polecenie	Akcja	Przykład
unset VARIABLE_NAME	Usuń zmienną środowiskową.	unset DI_KEY=
export VARIABLE_NAME=value	Ustaw lub zmień wartość tymczasowej zmiennej środowiskowej.	export DI_KEY={yourKey}
printenv VARIABLE_NAME echo $VARIABLE_NAME	Wyświetl wartość zmiennej środowiskowej. echo Za pomocą polecenia przed zmienną $za pomocą polecenia .	printenv DI_KEY echo $DI_KEY
printenv	Wyświetl wszystkie zmienne środowiskowe.	printenv

Konfigurowanie środowiska programowania

Utwórz aplikację Node.js Express.

1. W oknie konsoli 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żesz pominąć je dla tego projektu.
   • Wybierz Enter, aby zaakceptować sugestie w nawiasach.

   Po zakończeniu monitów polecenie tworzy package.json plik 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/identity
   

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

1. 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 prawym przyciskiem myszy folder, a następnie 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 utworzysz element AzureKeyCredential z kluczem z witryny Azure Portal i DocumentIntelligenceClient wystąpieniem z AzureKeyCredential punktem końcowym analizy dokumentów i .

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

• Wstępnie utworzony model odczytu jest podstawą wszystkich modeli analizy dokumentów i może wykrywać wiersze, wyrazy, lokalizacje i języki. Układ, ogólny dokument, wstępnie utworzone i niestandardowe modele używają read modelu jako podstawy do wyodrębniania tekstów z dokumentów.
• Wstępnie utworzony model układu wyodrębnia lokalizacje tekstu i tekstu, tabele, znaczniki zaznaczenia i informacje o strukturze z dokumentów i obrazów.
• Wstępnie utworzony model tax.us.w2 wyodrębnia informacje zgłaszane na formularzach podatkowych us Internal Revenue Service (IRS).
• Wstępnie utworzony model faktury wyodrębnia informacje zgłoszone w formularzach podatkowych us Internal Revenue Service.
• Wstępnie utworzony model paragonu wyodrębnia kluczowe informacje z drukowanych i odręcznych paragonów sprzedaży.
• Wstępnie utworzony model idDocument wyodrębnia kluczowe informacje z amerykańskich licencji kierowców; międzynarodowe strony biograficzne paszportu; Identyfikatory stanów USA; karty ubezpieczenia społecznego; i stałe karty zamieszkania.

Korzystanie z modelu odczytu

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl read dane wyjściowe modelu.

Korzystanie z modelu układu

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

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

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

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

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

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

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

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

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

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

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

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

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl dane wyjściowe modelu układu.

Korzystanie z ogólnego modelu dokumentów

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

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

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

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

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

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

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

}

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

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl ogólne dane wyjściowe modelu dokumentu.

Korzystanie z modelu podatkowego W-2

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl dane wyjściowe modelu podatkowego W-2.

Korzystanie z modelu faktury

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

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

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

async function main() {

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

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

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

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

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

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

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

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

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl dane wyjściowe modelu faktury.

Korzystanie z modelu paragonu

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

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

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

async function main() {

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

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

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

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

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

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

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

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

}

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

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl dane wyjściowe modelu paragonu.

Korzystanie z modelu dokumentów identyfikatorów

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

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

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

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

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

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

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

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

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

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

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

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl dane wyjściowe modelu dokumentu identyfikatora.

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

Wymagania wstępne

• Subskrypcja platformy Azure — utwórz 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. Zobacz Wprowadzenie do języka Python w programie Visual Studio Code.

• Usługi azure AI lub zasób analizy dokumentów. Utwórz pojedynczą usługę lub wiele usług. 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.

• Klucz i punkt końcowy z utworzonego zasobu w celu połączenia aplikacji z usługą Azure Document Intelligence.

  1. Po wdrożeniu zasobu wybierz pozycję Przejdź do zasobu.
  2. W menu nawigacji po lewej stronie wybierz pozycję Klucze i punkt końcowy.
  3. Skopiuj jeden z kluczy i punkt końcowy do użycia w dalszej części tego artykułu.

  

• Plik dokumentu pod adresem URL. W tym projekcie można użyć przykładowych formularzy podanych w poniższej tabeli dla każdej funkcji:

  Funkcja	modelID	document-url
  Odczyt modelu	odczyt wstępnie utworzony	Broszura przykładowa
  Model układu	wstępnie utworzony układ	Potwierdzenie rezerwacji przykładowej
  Model formularza W-2	prebuilt-tax.us.w2	Przykładowy formularz W-2
  Model faktury	wstępnie utworzona faktura	Przykładowa faktura
  Model paragonu	wstępnie utworzone potwierdzenie	Przykładowe potwierdzenie
  Model dokumentu identyfikatora	prebuilt-idDocument	Przykładowy dokument o identyfikatorze

Ustawianie zmiennych środowiskowych

Aby wchodzić w interakcje z usługą Analizy dokumentów, musisz utworzyć wystąpienie DocumentAnalysisClient klasy . W tym celu utwórz wystąpienie klienta za pomocą witryny key Azure Portal.endpoint W tym projekcie użyj zmiennych środowiskowych do przechowywania poświadczeń i uzyskiwania do nich dostępu.

Ważne

Jeśli używasz klucza interfejsu API, zapisz go bezpiecznie w innym miejscu, na przykład w usłudze Azure Key Vault. Nie dołączaj klucza interfejsu API bezpośrednio do kodu i nigdy nie publikuj go publicznie.

Aby uzyskać więcej informacji na temat zabezpieczeń usług sztucznej inteligencji, zobacz Uwierzytelnianie żądań w usługach Azure AI.

Aby ustawić zmienną środowiskową dla klucza zasobu analizy dokumentów, otwórz okno konsoli i postępuj zgodnie z instrukcjami dotyczącymi systemu operacyjnego i środowiska programistycznego. Zastąp <ciąg yourKey> i <yourEndpoint> wartościami z zasobu w witrynie Azure Portal.

Windows

Zmienne środowiskowe w systemie Windows nie są uwzględniane wielkości liter. Są one zwykle deklarowane wielkimi literami, ze słowami połączonymi podkreśleniami. W wierszu polecenia uruchom następujące polecenia:

1. Ustaw zmienną klucza:

   setx DI_KEY <yourKey>
   

2. Ustawianie zmiennej punktu końcowego

   setx DI_ENDPOINT <yourEndpoint>
   

3. Zamknij okno wiersza polecenia po ustawieniu zmiennych środowiskowych. Wartości pozostają do momentu ich ponownej zmiany.

4. Uruchom ponownie wszystkie uruchomione programy, które odczytują zmienną środowiskową. Jeśli na przykład używasz programu Visual Studio lub Visual Studio Code jako edytora, uruchom ponownie przed uruchomieniem przykładowego kodu.

Oto kilka bardziej przydatnych poleceń do użycia ze zmiennymi środowiskowymi:

Polecenie	Akcja	Przykład
setx VARIABLE_NAME=	Usuń zmienną środowiskową, ustawiając wartość na pusty ciąg.	setx DI_KEY=
setx VARIABLE_NAME=value	Ustaw lub zmień wartość zmiennej środowiskowej.	setx DI_KEY=<yourKey>
set VARIABLE_NAME	Wyświetl wartość określonej zmiennej środowiskowej.	set DI_KEY
set	Wyświetl wszystkie zmienne środowiskowe.	set

macOS

Zmienne środowiskowe w systemie macOS są uwzględniane wielkości liter. Konwencjonalnie nazwa zmiennej jest deklarowana w wielkich literach.

Polecenie export ustawia zmienną i eksportuje ją do środowiska globalnego, które jest dostępne dla innych procesów. Jednak wartość jest tymczasowa i trwa tylko do momentu zamknięcia sesji terminalu. Otwórz terminal i wprowadź następujące polecenia:

1. Ustaw zmienną klucza:

   export key=<yourKey>
   

2. Ustaw zmienną punktu końcowego:

   export endpoint=<yourEndpoint>
   

Aby trwale ustawić zmienną środowiskową, umieść polecenie eksportu w skryscie uruchamiania powłoki Bash ~/.bash_profile :

1. Za pomocą edytora tekstów otwórz plik ~/.bash_profile i dodaj następujące polecenie, aby utworzyć stałą zmienną środowiskową:

   export DI_KEY=<yourKey> DI_ENDPOINT=<yourEndpoint>
   

   Przykład: export DI_KEY="<yourKey>"

2. Zapisz zmiany w pliku bash_profile .

3. Aby wprowadzić zmiany, uruchom następujące polecenie w oknie terminalu:

   source ~/.bash-profile
   

Oto kilka bardziej przydatnych poleceń do użycia ze zmiennymi środowiskowymi:

Polecenie	Akcja	Przykład
unset VARIABLE_NAME	Usuń zmienną środowiskową.	unset DI_KEY
export VARIABLE_NAME=value	Ustaw lub zmień wartość tymczasowej zmiennej środowiskowej.	export DI_KEY=<yourKey>
printenv VARIABLE_NAME echo $VARIABLE_NAME	Wyświetl wartość określonej zmiennej środowiskowej. echo Za pomocą polecenia przed zmienną $za pomocą polecenia .	printenv DI_KEY echo $DI_KEY
printenv	Wyświetl wszystkie zmienne środowiskowe.	printenv

Linux

Zmienne środowiskowe w systemie Linux są wrażliwe na wielkość liter. Konwencjonalnie nazwa zmiennej jest deklarowana w wielkich literach.

Polecenie export ustawia zmienną i eksportuje ją do środowiska globalnego, które jest dostępne dla innych procesów. Jednak wartość jest tymczasowa i trwa tylko do momentu zamknięcia sesji terminalu:

1. Ustaw zmienną klucza:

   export DI_KEY=<yourKey>
   

2. Ustaw zmienną punktu końcowego:

   export DI_ENDPOINT=<yourEndpoint>
   

Aby trwale ustawić zmienną środowiskową, umieść polecenie eksportu w skryscie uruchamiania powłoki Bash ~/.bashrc :

1. Za pomocą edytora tekstów otwórz plik ~/.bashrc i dodaj następujące polecenie, aby utworzyć stałą zmienną środowiskową:

   export <VARIABLE>=<value>
   

   Przykład: export DI_KEY=<yourKey>

2. Zapisz zmiany w pliku bashrc .

3. Aby wprowadzić zmiany, uruchom następujące polecenie w oknie terminalu:

   source ~/.bashrc
   

Oto kilka bardziej przydatnych poleceń do użycia ze zmiennymi środowiskowymi:

Polecenie	Akcja	Przykład
unset VARIABLE_NAME	Usuń zmienną środowiskową.	unset DI_KEY=
export VARIABLE_NAME=value	Ustaw lub zmień wartość tymczasowej zmiennej środowiskowej.	export DI_KEY={yourKey}
printenv VARIABLE_NAME echo $VARIABLE_NAME	Wyświetl wartość zmiennej środowiskowej. echo Za pomocą polecenia przed zmienną $za pomocą polecenia .	printenv DI_KEY echo $DI_KEY
printenv	Wyświetl wszystkie zmienne środowiskowe.	printenv

Konfigurowanie środowiska programowania

Otwórz okno konsoli 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 utworzysz element AzureKeyCredential z kluczem z witryny Azure Portal i DocumentIntelligenceClient wystąpieniem z AzureKeyCredential punktem końcowym analizy dokumentów i .

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

2. Otwórz plik form_recognizer_quickstart.py i wybierz jeden z następujących przykładów kodu i skopiuj/wklej do aplikacji:

   • Wstępnie utworzony model odczytu jest podstawą wszystkich modeli analizy dokumentów i może wykrywać wiersze, wyrazy, lokalizacje i języki. Układ, ogólny dokument, wstępnie utworzone i niestandardowe modele używają read modelu jako podstawy do wyodrębniania tekstów z dokumentów.
   • Wstępnie utworzony model układu wyodrębnia lokalizacje tekstu i tekstu, tabele, znaczniki zaznaczenia i informacje o strukturze z dokumentów i obrazów.
   • Wstępnie utworzony model tax.us.w2 wyodrębnia informacje zgłaszane na formularzach podatkowych us Internal Revenue Service (IRS).
   • Wstępnie utworzony model faktury wyodrębnia pola kluczy i elementy wiersza z faktur sprzedaży w różnych formatach.
   • Wstępnie utworzony model paragonu wyodrębnia kluczowe informacje z drukowanych i odręcznych paragonów sprzedaży.
   • Wstępnie utworzony model idDocument wyodrębnia kluczowe informacje z amerykańskich licencji kierowców; międzynarodowe strony biograficzne paszportu; Identyfikatory stanów USA; karty ubezpieczenia społecznego; i stałe karty zamieszkania.

3. Uruchom kod języka Python z wiersza polecenia.

   python form_recognizer_quickstart.py
   

Korzystanie z modelu odczytu

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

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

# 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_read():
    # sample document
    formUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/read.png"

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

    poller = client.begin_analyze_document(
        "prebuilt-read", AnalyzeDocumentRequest(url_source=formUrl
    ))
    result: AnalyzeResult = poller.result()

    print("----Languages detected in the document----")
    if result.languages is not None:
        for language in result.languages:
            print(f"Language code: '{language.locale}' with confidence {language.confidence}")

    print("----Styles detected in the document----")
    if result.styles:
        for style in result.styles:
            if style.is_handwritten:
                print("Found the following handwritten content: ")
                print(",".join([result.content[span.offset : span.offset + span.length] for span in style.spans]))
            if style.font_style:
                print(f"The document contains '{style.font_style}' font style, applied to the following text: ")
                print(",".join([result.content[span.offset : span.offset + span.length] for span in style.spans]))

    for page in result.pages:
        print(f"----Analyzing document 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 {len(words)} words and text '{line.content}' 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.paragraphs:
        print(f"----Detected #{len(result.paragraphs)} paragraphs in the document----")
        for paragraph in result.paragraphs:
            print(f"Found paragraph with role: '{paragraph.role}' within {paragraph.bounding_regions} bounding region")
            print(f"...with content: '{paragraph.content}'")

        result.paragraphs.sort(key=lambda p: (p.spans.sort(key=lambda s: s.offset), p.spans[0].offset))
        print("-----Print sorted paragraphs-----")
        for idx, paragraph in enumerate(result.paragraphs):
            print(
                f"...paragraph:{idx} with offset: {paragraph.spans[0].offset} and length: {paragraph.spans[0].length}"
            )

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


if __name__ == "__main__":
    analyze_read()

Wyświetl pełny kod w witrynie GitHub. Więcej przykładów

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl read dane wyjściowe modelu.

Korzystanie z modelu układu

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


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


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

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

    poller = client.begin_analyze_document(
        "prebuilt-layout", 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()

Wyświetl pełny kod w witrynie GitHub. Więcej przykładów

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl dane wyjściowe modelu układu.

Korzystanie z modelu podatkowego W-2

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

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

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


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

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

    poller = client.begin_analyze_document(
        "prebuilt-tax.us.w2",  AnalyzeDocumentRequest(url_source=formUrl
    ))

    w2s: AnalyzeResult =  poller.result()

        if w2s.documents:
        for idx, w2 in enumerate(w2s.documents):
            print(f"--------Analyzing US Tax W-2 Form #{idx + 1}--------")
            if w2.fields:
                form_variant = w2.fields.get("W2FormVariant")
                if form_variant:
                    print(
                        f"Form variant: {form_variant.get('valueString')} has confidence: " f"{form_variant.confidence}"
                    )
                tax_year = w2.fields.get("TaxYear")
                if tax_year:
                    print(f"Tax year: {tax_year.get('valueString')} has confidence: {tax_year.confidence}")
                w2_copy = w2.fields.get("W2Copy")
                if w2_copy:
                    print(f"W-2 Copy: {w2_copy.get('valueString')} has confidence: {w2_copy.confidence}")
                employee = w2.fields.get("Employee")
                if employee:
                    print("Employee data:")
                    employee_name = employee.get("valueObject").get("Name")
                    if employee_name:
                        f"confidence: {fed_income_tax_withheld.confidence}"
                    )
                social_security_wages = w2.fields.get("SocialSecurityWages")
                if social_security_wages:
                    print(
                        f"Social Security wages: {social_security_wages.get('valueNumber')} has confidence: "
                        f"{social_security_wages.confidence}"
                    )
                social_security_tax_withheld = w2.fields.get("SocialSecurityTaxWithheld")
                if social_security_tax_withheld:
                    print(
                        f"Social Security tax withheld: {social_security_tax_withheld.get('valueNumber')} "
                        f"has confidence: {social_security_tax_withheld.confidence}"
                    )
                medicare_wages_tips = w2.fields.get("MedicareWagesAndTips")
                if medicare_wages_tips:
                    print(
                        f"Medicare wages and tips: {medicare_wages_tips.get('valueNumber')} has confidence: "
                        f"{medicare_wages_tips.confidence}"
                    )
                medicare_tax_withheld = w2.fields.get("MedicareTaxWithheld")
                if medicare_tax_withheld:
                    print(
                        f"Medicare tax withheld: {medicare_tax_withheld.get('valueNumber')} has confidence: "
                        f"{medicare_tax_withheld.confidence}"
                    )
                social_security_tips = w2.fields.get("SocialSecurityTips")
                if social_security_tips:
                    print(
                        f"Social Security tips: {social_security_tips.get('valueNumber')} has confidence: "
                        f"{social_security_tips.confidence}"
                    )
                allocated_tips = w2.fields.get("AllocatedTips")
                if allocated_tips:
                    print(
                        f"Allocated tips: {allocated_tips.get('valueNumber')} has confidence: {allocated_tips.confidence}"
                    )
                verification_code = w2.fields.get("VerificationCode")
                if verification_code:
                    print(
                        f"Verification code: {verification_code.get('valueNumber')} has confidence: {verification_code.confidence}"
                    )
                dependent_care_benefits = w2.fields.get("DependentCareBenefits")
                if dependent_care_benefits:
                    print(
                        f"Dependent care benefits: {dependent_care_benefits.get('valueNumber')} has confidence: {dependent_care_benefits.confidence}"
                    )
                non_qualified_plans = w2.fields.get("NonQualifiedPlans")
                if non_qualified_plans:
                    print(
                        f"Non-qualified plans: {non_qualified_plans.get('valueNumber')} has confidence: {non_qualified_plans.confidence}"
                    )
                additional_info = w2.fields.get("AdditionalInfo")
                if additional_info:
                    print("Additional information:")
                    for item in additional_info.get("valueArray"):
                        letter_code = item.get("valueObject").get("LetterCode")
                        if letter_code:
                            print(
                                f"...Letter code: {letter_code.get('valueString')} has confidence: {letter_code.confidence}"
                            )
                        amount = item.get("valueObject").get("Amount")
                        if amount:
                            print(f"...Amount: {amount.get('valueNumber')} has confidence: {amount.confidence}")
                is_statutory_employee = w2.fields.get("IsStatutoryEmployee")
                if is_statutory_employee:
                    print(
                        f"Is statutory employee: {is_statutory_employee.get('valueString')} has confidence: {is_statutory_employee.confidence}"
                    )
                is_retirement_plan = w2.fields.get("IsRetirementPlan")
                if is_retirement_plan:
                    print(
                        f"Is retirement plan: {is_retirement_plan.get('valueString')} has confidence: {is_retirement_plan.confidence}"
                    )
                third_party_sick_pay = w2.fields.get("IsThirdPartySickPay")
                if third_party_sick_pay:
                    print(
                        f"Is third party sick pay: {third_party_sick_pay.get('valueString')} has confidence: {third_party_sick_pay.confidence}"
                    )
                other_info = w2.fields.get("Other")
                if other_info:
                    print(f"Other information: {other_info.get('valueString')} has confidence: {other_info.confidence}")
                state_tax_info = w2.fields.get("StateTaxInfos")
                if state_tax_info:
                    print("State Tax info:")
                    for tax in state_tax_info.get("valueArray"):
                        state = tax.get("valueObject").get("State")
                        if state:
                            print(f"...State: {state.get('valueString')} has confidence: {state.confidence}")
                        employer_state_id_number = tax.get("valueObject").get("EmployerStateIdNumber")
                        if employer_state_id_number:
                            print(
                                f"...Employer state ID number: {employer_state_id_number.get('valueString')} has "
                                f"confidence: {employer_state_id_number.confidence}"
                            )
                        state_wages_tips = tax.get("valueObject").get("StateWagesTipsEtc")
                        if state_wages_tips:
                            print(
                                f"...State wages, tips, etc: {state_wages_tips.get('valueNumber')} has confidence: "
                                f"{state_wages_tips.confidence}"
                            )
                        state_income_tax = tax.get("valueObject").get("StateIncomeTax")
                        if state_income_tax:
                            print(
                                f"...State income tax: {state_income_tax.get('valueNumber')} has confidence: "
                                f"{state_income_tax.confidence}"
                            )
                local_tax_info = w2.fields.get("LocalTaxInfos")
                if local_tax_info:
                    print("Local Tax info:")
                    for tax in local_tax_info.get("valueArray"):
                        local_wages_tips = tax.get("valueObject").get("LocalWagesTipsEtc")
                        if local_wages_tips:
                            print(
                                f"...Local wages, tips, etc: {local_wages_tips.get('valueNumber')} has confidence: "
                                f"{local_wages_tips.confidence}"
                            )
                        local_income_tax = tax.get("valueObject").get("LocalIncomeTax")
                        if local_income_tax:
                            print(
                                f"...Local income tax: {local_income_tax.get('valueNumber')} has confidence: "
                                f"{local_income_tax.confidence}"
                            )
                        locality_name = tax.get("valueObject").get("LocalityName")
                        if locality_name:
                            print(
                                f"...Locality name: {locality_name.get('valueString')} has confidence: "
                                f"{locality_name.confidence}"
                            )


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


if __name__ == "__main__":
    analyze_tax_us_w2()

Wyświetl pełny kod w witrynie GitHub. Więcej przykładów

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl dane wyjściowe modelu podatkowego W-2.

Korzystanie z modelu faktury

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

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

def analyze_invoice():

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

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

    poller = client.begin_analyze_document(
        "prebuilt-invoice", AnalyzeDocumentRequest(url_source=formUrl), locale="en-US")

    result: AnalyzeResult = poller.result()

    if invoices.documents:
        for idx, invoice in enumerate(invoices.documents):
            print(f"--------Analyzing invoice #{idx + 1}--------")
            if invoice.fields:
                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 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:")
                items = invoice.fields.get("Items")
                if items:
                    for idx, item in enumerate(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()

Wyświetl pełny kod w witrynie GitHub. Więcej przykładów

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl dane wyjściowe modelu faktury.

Korzystanie z modelu paragonu

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

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

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

   client = DocumentIntelligenceClient(
        endpoint=endpoint, credential=AzureKeyCredential(key)
    )
    poller = client.begin_analyze_document(
        "prebuilt-receipt", AnalyzeDocumentRequest(url_source=receiptUrl), locale="en-US"
    )
    receipts: AnalyzeResult = poller.result()

    if receipts.documents:
        for idx, receipt in enumerate(receipts.documents):
            print(f"--------Analysis of receipt #{idx + 1}--------")
            print(f"Receipt type: {receipt.doc_type if receipt.doc_type else 'N/A'}")
            if receipt.fields:
                merchant_name = receipt.fields.get("MerchantName")
                if merchant_name:
                    print(
                        f"Merchant Name: {merchant_name.get('valueString')} has confidence: "
                        f"{merchant_name.confidence}"
                    )
                transaction_date = receipt.fields.get("TransactionDate")
                if transaction_date:
                    print(
                        f"Transaction Date: {transaction_date.get('valueDate')} has confidence: "
                        f"{transaction_date.confidence}"
                    )
                items = receipt.fields.get("Items")
                if items:
                    print("Receipt items:")
                    for idx, item in enumerate(items.get("valueArray")):
                        print(f"...Item #{idx + 1}")
                        item_description = item.get("valueObject").get("Description")
                        if item_description:
                            print(
                                f"......Item Description: {item_description.get('valueString')} has confidence: "
                                f"{item_description.confidence}"
                            )
                        item_quantity = item.get("valueObject").get("Quantity")
                        if item_quantity:
                            print(
                                f"......Item Quantity: {item_quantity.get('valueString')} has confidence: "
                                f"{item_quantity.confidence}"
                            )
                        item_total_price = item.get("valueObject").get("TotalPrice")
                        if item_total_price:
                            print(
                                f"......Total Item Price: {format_price(item_total_price.get('valueCurrency'))} has confidence: "
                                f"{item_total_price.confidence}"
                            )
                subtotal = receipt.fields.get("Subtotal")
                if subtotal:
                    print(
                        f"Subtotal: {format_price(subtotal.get('valueCurrency'))} has confidence: {subtotal.confidence}"
                    )
                tax = receipt.fields.get("TotalTax")
                if tax:
                    print(f"Total tax: {format_price(tax.get('valueCurrency'))} has confidence: {tax.confidence}")
                tip = receipt.fields.get("Tip")
                if tip:
                    print(f"Tip: {format_price(tip.get('valueCurrency'))} has confidence: {tip.confidence}")
                total = receipt.fields.get("Total")
                if total:
                    print(f"Total: {format_price(total.get('valueCurrency'))} has confidence: {total.confidence}")
            print("--------------------------------------")



if __name__ == "__main__":
    analyze_receipts()

Wyświetl pełny kod w witrynie GitHub. Więcej przykładów

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl dane wyjściowe modelu paragonu.

Korzystanie z modelu dokumentów identyfikatorów

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

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

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

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

    poller =client.begin_analyze_document(
            "prebuilt-idDocument", AnalyzeDocumentRequest(url_source=identityUrl)
        )
     id_documents: AnalyzeResult = poller.result()

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


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

if __name__ == "__main__":
    analyze_identity_documents()

Wyświetl pełny kod w witrynie GitHub. Więcej przykładów

Odwiedź repozytorium przykładów platformy Azure w witrynie GitHub i wyświetl dane wyjściowe modelu dokumentu identyfikatora.

Uwaga

Ten projekt używa narzędzia wiersza polecenia cURL do wykonywania wywołań interfejsu API REST.

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

Wymagania wstępne

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

• Zainstalowane narzędzie wiersza polecenia cURL. Systemy Windows 10 i Windows 11 są dostarczane z kopią biblioteki cURL. W wierszu polecenia wpisz następujące polecenie cURL. Jeśli są wyświetlane opcje pomocy, program cURL jest zainstalowany w środowisku systemu Windows.

  curl -help
  

  Jeśli nie zainstalowano biblioteki cURL, możesz ją uzyskać tutaj:

  • Windows
  • Komputery Mac lub Linux

• Usługi azure AI lub zasób analizy dokumentów. Utwórz pojedynczą usługę lub wiele usług. 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.

• Klucz i punkt końcowy z utworzonego zasobu w celu połączenia aplikacji z usługą Azure Document Intelligence.

  1. Po wdrożeniu zasobu wybierz pozycję Przejdź do zasobu.
  2. W menu nawigacji po lewej stronie wybierz pozycję Klucze i punkt końcowy.
  3. Skopiuj jeden z kluczy i punkt końcowy do użycia w dalszej części tego artykułu.

  

Ustawianie zmiennych środowiskowych

Aby wchodzić w interakcje z usługą Analizy dokumentów, musisz utworzyć wystąpienie DocumentAnalysisClient klasy . W tym celu utwórz wystąpienie klienta za pomocą witryny key Azure Portal.endpoint W tym projekcie użyj zmiennych środowiskowych do przechowywania poświadczeń i uzyskiwania do nich dostępu.

Ważne

Jeśli używasz klucza interfejsu API, zapisz go bezpiecznie w innym miejscu, na przykład w usłudze Azure Key Vault. Nie dołączaj klucza interfejsu API bezpośrednio do kodu i nigdy nie publikuj go publicznie.

Aby uzyskać więcej informacji na temat zabezpieczeń usług sztucznej inteligencji, zobacz Uwierzytelnianie żądań w usługach Azure AI.

Aby ustawić zmienną środowiskową dla klucza zasobu analizy dokumentów, otwórz okno konsoli i postępuj zgodnie z instrukcjami dotyczącymi systemu operacyjnego i środowiska programistycznego. Zastąp <ciąg yourKey> i <yourEndpoint> wartościami z zasobu w witrynie Azure Portal.

Windows

Zmienne środowiskowe w systemie Windows nie są uwzględniane wielkości liter. Są one zwykle deklarowane wielkimi literami, ze słowami połączonymi podkreśleniami. W wierszu polecenia uruchom następujące polecenia:

1. Ustaw zmienną klucza:

   setx DI_KEY <yourKey>
   

2. Ustawianie zmiennej punktu końcowego

   setx DI_ENDPOINT <yourEndpoint>
   

3. Zamknij okno wiersza polecenia po ustawieniu zmiennych środowiskowych. Wartości pozostają do momentu ich ponownej zmiany.

4. Uruchom ponownie wszystkie uruchomione programy, które odczytują zmienną środowiskową. Jeśli na przykład używasz programu Visual Studio lub Visual Studio Code jako edytora, uruchom ponownie przed uruchomieniem przykładowego kodu.

Oto kilka bardziej przydatnych poleceń do użycia ze zmiennymi środowiskowymi:

Polecenie	Akcja	Przykład
setx VARIABLE_NAME=	Usuń zmienną środowiskową, ustawiając wartość na pusty ciąg.	setx DI_KEY=
setx VARIABLE_NAME=value	Ustaw lub zmień wartość zmiennej środowiskowej.	setx DI_KEY=<yourKey>
set VARIABLE_NAME	Wyświetl wartość określonej zmiennej środowiskowej.	set DI_KEY
set	Wyświetl wszystkie zmienne środowiskowe.	set

macOS

Zmienne środowiskowe w systemie macOS są uwzględniane wielkości liter. Konwencjonalnie nazwa zmiennej jest deklarowana w wielkich literach.

Polecenie export ustawia zmienną i eksportuje ją do środowiska globalnego, które jest dostępne dla innych procesów. Jednak wartość jest tymczasowa i trwa tylko do momentu zamknięcia sesji terminalu. Otwórz terminal i wprowadź następujące polecenia:

1. Ustaw zmienną klucza:

   export key=<yourKey>
   

2. Ustaw zmienną punktu końcowego:

   export endpoint=<yourEndpoint>
   

Aby trwale ustawić zmienną środowiskową, umieść polecenie eksportu w skryscie uruchamiania powłoki Bash ~/.bash_profile :

1. Za pomocą edytora tekstów otwórz plik ~/.bash_profile i dodaj następujące polecenie, aby utworzyć stałą zmienną środowiskową:

   export DI_KEY=<yourKey> DI_ENDPOINT=<yourEndpoint>
   

   Przykład: export DI_KEY="<yourKey>"

2. Zapisz zmiany w pliku bash_profile .

3. Aby wprowadzić zmiany, uruchom następujące polecenie w oknie terminalu:

   source ~/.bash-profile
   

Oto kilka bardziej przydatnych poleceń do użycia ze zmiennymi środowiskowymi:

Polecenie	Akcja	Przykład
unset VARIABLE_NAME	Usuń zmienną środowiskową.	unset DI_KEY
export VARIABLE_NAME=value	Ustaw lub zmień wartość tymczasowej zmiennej środowiskowej.	export DI_KEY=<yourKey>
printenv VARIABLE_NAME echo $VARIABLE_NAME	Wyświetl wartość określonej zmiennej środowiskowej. echo Za pomocą polecenia przed zmienną $za pomocą polecenia .	printenv DI_KEY echo $DI_KEY
printenv	Wyświetl wszystkie zmienne środowiskowe.	printenv

Linux

Zmienne środowiskowe w systemie Linux są wrażliwe na wielkość liter. Konwencjonalnie nazwa zmiennej jest deklarowana w wielkich literach.

Polecenie export ustawia zmienną i eksportuje ją do środowiska globalnego, które jest dostępne dla innych procesów. Jednak wartość jest tymczasowa i trwa tylko do momentu zamknięcia sesji terminalu:

1. Ustaw zmienną klucza:

   export DI_KEY=<yourKey>
   

2. Ustaw zmienną punktu końcowego:

   export DI_ENDPOINT=<yourEndpoint>
   

Aby trwale ustawić zmienną środowiskową, umieść polecenie eksportu w skryscie uruchamiania powłoki Bash ~/.bashrc :

1. Za pomocą edytora tekstów otwórz plik ~/.bashrc i dodaj następujące polecenie, aby utworzyć stałą zmienną środowiskową:

   export <VARIABLE>=<value>
   

   Przykład: export DI_KEY=<yourKey>

2. Zapisz zmiany w pliku bashrc .

3. Aby wprowadzić zmiany, uruchom następujące polecenie w oknie terminalu:

   source ~/.bashrc
   

Oto kilka bardziej przydatnych poleceń do użycia ze zmiennymi środowiskowymi:

Polecenie	Akcja	Przykład
unset VARIABLE_NAME	Usuń zmienną środowiskową.	unset DI_KEY=
export VARIABLE_NAME=value	Ustaw lub zmień wartość tymczasowej zmiennej środowiskowej.	export DI_KEY={yourKey}
printenv VARIABLE_NAME echo $VARIABLE_NAME	Wyświetl wartość zmiennej środowiskowej. echo Za pomocą polecenia przed zmienną $za pomocą polecenia .	printenv DI_KEY echo $DI_KEY
printenv	Wyświetl wszystkie zmienne środowiskowe.	printenv

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.

Dla ułatwienia można skorzystać z poniższej tabeli. Zastąp wartości modelId> i <document-url> żądanymi wartościami:<

Model	modelId	opis	document-url
Odczyt modelu	odczyt wstępnie utworzony	Broszura przykładowa	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/read.png
Model układu	wstępnie utworzony układ	Potwierdzenie rezerwacji przykładowej	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/layout.png
Model formularza W-2	prebuilt-tax.us.w2	Przykładowy formularz W-2	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/w2.png
Model faktury	wstępnie utworzona faktura	Przykładowa faktura	https://github.com/Azure-Samples/cognitive-services-REST-api-samples/raw/master/curl/form-recognizer/rest-api/invoice.pdf
Model paragonu	wstępnie utworzone potwierdzenie	Przykładowe potwierdzenie	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/receipt.png
Model dokumentu identyfikatora	prebuilt-idDocument	Przykładowy dokument o identyfikatorze	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/identity_documents.png

Żądanie POST

Otwórz okno konsoli i uruchom następujące polecenie cURL. Polecenia obejmują punkty końcowe i kluczowe zmienne środowiskowe utworzone wcześniej w sekcji ustaw zmienne środowiskowe. Zastąp te zmienne, jeśli nazwy zmiennych różnią się. Pamiętaj, aby zastąpić parametry modelId> i <document-url>.<

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

Aby włączyć możliwości dodatku, użyj parametru features zapytania w żądaniu POST. Istnieją cztery funkcje dodatkowe dostępne w 2023-07-31 wersjach (GA) i nowszych: ocr.highResolution, ocr.formula, ocr.font i queryFields.premium. Aby dowiedzieć się więcej o każdej z możliwości, zobacz Modele niestandardowe.

Funkcje highResolution, formuły i czcionki można wywoływać tylko dla modelu Odczyt i układ oraz możliwości queryFields dla modelu Dokumenty ogólne. W poniższym przykładzie pokazano, jak wywołać funkcje highResolution, formuły i czcionki dla modelu Układu.

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

Odpowiedź POST

202 (Success) Otrzymasz odpowiedź zawierającą Operation-location nagłówek. Użyj wartości tego nagłówka, aby pobrać wyniki odpowiedzi.

Uzyskiwanie wyniku analizy (żądanie GET)

Po wywołaniu interfejsu Analyze document API wywołaj interfejs API [Get analyze result}(/rest/api/aiservices/document-models/get-analyze-result?view=rest-aiservices-2024-02-29-preview&preserve-view=true&tabs=HTTP), aby uzyskać stan operacji i wyodrębnionych danych.

Narzędzie wiersza polecenia cURL nie formatuje odpowiedzi interfejsu API, które zawierają zawartość JSON, co może utrudnić odczytywanie zawartości. Aby sformatować odpowiedź JSON, dołącz znak potoku, po którym następuje narzędzie formatowania JSON z żądaniem GET.

Windows

Użyj narzędzia json nodeJS jako narzędzia formatującego JSON dla biblioteki cURL. Jeśli nie masz zainstalowanej Node.js , pobierz i zainstaluj najnowszą wersję.

1. Otwórz okno konsoli i zainstaluj narzędzie json przy użyciu następującego polecenia:

   npm install -g jsontool
   

2. Dość wydrukuj dane wyjściowe JSON, dołączając znak | json potoku do żądań GET.

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

macOS

Narzędzie poleceń json_pp jest dostarczane z systemem macOS i może służyć jako narzędzie formatujące JSON dla biblioteki cURL.

• Dość wydrukuj dane wyjściowe JSON, dołączając | json_pp je do żądań GET.

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

Linux

Narzędzie wiersza polecenia json_pp jest wstępnie zainstalowane w większości dystrybucji systemu Linux. Jeśli nie jest on dołączony, możesz zainstalować go za pomocą menedżera pakietów dystrybucji.

• Dość wydrukuj dane wyjściowe JSON, dołączając | json_pp je do żądań GET .

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

Żądanie GET

Przed uruchomieniem następującego polecenia wprowadź następujące zmiany:

• Zastąp <odpowiedź> POST nagłówkiem Operation-location z odpowiedzi POST.
• Zastąp <DI_KEY zmienną zmiennej środowiskowej, jeśli różni się ona od nazwy w kodzie.
• Zastąp element *<json-tool> narzędziem do formatowania JSON.

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

Sprawdzanie odpowiedzi

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

Odwiedź repozytorium przykładów platformy Azure w usłudze GitHub, aby wyświetlić GET odpowiedź dla każdego z modeli analizy dokumentów:

Model	Adres URL danych wyjściowych
Odczyt modelu	Odczytywanie danych wyjściowych modelu
Model układu	Dane wyjściowe modelu układu
Model podatkowy W-2	Dane wyjściowe modelu podatkowego W-2
Model faktury	Dane wyjściowe modelu faktury
Model paragonu	Dane wyjściowe modelu paragonu
Model dokumentu identyfikatora	Dane wyjściowe modelu dokumentu identyfikatora

Następne kroki

Gratulacje! Wiesz już, jak używać modeli analizy dokumentów do analizowania różnych dokumentów na różne sposoby. Następnie zapoznaj się z dokumentacją programu Document Intelligence Studio i dokumentacją referencyjną.

Wypróbuj narzędzie Document Intelligence Studio Eksplorowanie interfejsu API REST analizy dokumentów