開始使用文件智慧服務

重要

• Azure 認知服務 表格辨識器 現在是 Azure AI 檔智慧。
• 某些平台仍在等候重新命名更新。
• 我們文件中的 Azure 表格辨識器或文件智慧服務全都是指相同的 Azure 服務。

此內容適用於：v4.0 （預覽）舊版：v3.1 （GA）v3.0 （GA）

• 開始使用 Azure AI 檔智慧最新預覽版本 （2024-02-29-preview）。

• Azure AI 檔案智慧/表格辨識器 是雲端式 Azure AI 服務，使用機器學習從您的檔案擷取索引鍵/值組、文字、數據表和密鑰數據。

• 您可以使用程式設計語言 SDK 或呼叫 REST API，輕鬆地將檔案處理模型整合到工作流程和應用程式中。

• 在本快速入門中，建議您在學習技術時使用免費服務。 請記住，免費頁面數目限制為每月 500 個。

若要深入瞭解 API 功能和開發選項，請瀏覽我們的 [概觀 ] 頁面。

用戶端連結庫 | SDK 參考 REST API 參考 | | 套件| 範例|支援的 REST API 版本

在本快速入門中，使用下列功能來分析及擷取表單和文件中的數據和值：

• 版面配置模型—分析及擷取檔中的單選按鈕和複選框等表格、線條、文字和選取標記，而不需要定型模型。

• 預先建置的模型— 使用預先建置的模型，分析及擷取特定文件類型的一般欄位。

必要條件

• Azure 訂用帳戶 - 建立免費帳戶。

• Visual Studio IDE 的目前版本。

• Azure AI 服務或文件智慧服務資源。 擁有 Azure 訂用帳戶之後，請在 Azure 入口網站 中建立單一服務或 Azure AI 多服務資源，以取得您的密鑰和端點。

• 您可以使用免費定價層 (F0) 來試用服務，之後可升級至付費層以用於實際執行環境。

提示

如果您打算在單一端點/金鑰下存取多個 Azure AI 服務，請建立 Azure AI 服務資源。 若為僅限文件智慧服務存取，請建立文件智慧服務資源。 請注意，如果您想要使用 Microsoft Entra 驗證，您將需要單一服務資源。

• 部署資源之後，選取 [移至資源]。 您需要使用已建立資源的金鑰和端點，將應用程式連線至文件智慧服務 API。 您稍後會在快速入門中將金鑰和端點貼上至程式碼中：

  

設定

1. 啟動 Visual Studio。

2. 在開始頁面中，選擇 [建立新的專案]。

   

3. 在 [建立新的專案] 頁面的搜尋方塊中，輸入主控台。 選擇主控台 應用程式 範本，然後選擇 [ 下一步]。

   

4. 在 [ 設定新專案] 對話框視窗中，於 [項目 名稱] 方塊中輸入 doc_intel_quickstart 。 接著，選擇 [下一步]。

5. 在 [ 其他資訊 ] 對話框視窗中，選取 [.NET 6.0（長期支援），然後選取 [ 建立]。

   

使用 NuGet 安裝客戶端連結庫

1. 以滑鼠右鍵按兩下doc_intel_quickstart項目，然後選取 [管理 NuGet 套件...]。

   

2. 選取 [流覽] 索引標籤，然後輸入 Azure.AI.DocumentIntelligence。 選擇複選框， Include prerelease 然後從下拉功能表中選取 1.0.0-beta.1 版

   

建置您的 應用程式

若要與此文件智慧服務互動，您必須建立 DocumentIntelligenceClient 類別的執行個體。 若要這樣做，請使用 key 從 Azure 入口網站建立 AzureKeyCredential，並使用 AzureKeyCredential 和文件智慧服務 endpoint 來建立 DocumentIntelligenceClient 執行個體。

注意

• 從 .NET 6 開始，使用 console 範本的新專案會產生與舊版不同的新程序樣式。
• 新的輸出會使用最新的 C# 功能，以簡化您需要撰寫的程式代碼。
• 當您使用較新版本時，只需要撰寫 Main 方法的本文。 您不需要包含最上層語句、全域 using 指示詞，或隱含 using using 指示詞。
• 如需詳細資訊，請參閱新的 C# 範本產生最上層語句。

1. 開啟 Program.cs 檔案。

2. 刪除預先存在的程式代碼，包括 這一行 Console.Writeline("Hello World!")，然後選取下列其中一個程式代碼範例，以複製並貼到應用程式的 Program.cs 檔案中：

   • 版面配置模型

   • 預先建置的模型

重要

完成時，請記得從程式碼中移除金鑰，且不要公開張貼金鑰。 在生產環境中，請使用安全的方式來儲存和存取您的認證，例如 Azure Key Vault。 如需詳細資訊，請參閱 Azure AI 服務安全性。

版面配置模型

從檔擷取文字、選取標記、文字樣式、表格結構和周框區域座標。

• 在此範例中，您需要 來自 URI 的檔案檔案。 您可以使用本快速入門的 範例檔 。
• 我們已將檔案 URI 值新增至 Uri fileUri 腳本頂端的變數。
• 若要從 URI 上的指定檔案擷取配置，請使用 StartAnalyzeDocumentFromUri 方法並傳遞 prebuilt-layout 作為模型標識碼。 傳回的值是物件 AnalyzeResult ，其中包含送出之文件的數據。

將下列程式代碼範例新增至 Program.cs 檔案。 請確定您已使用 Azure 入口網站 Document Intelligence 實例中的值來更新金鑰和端點變數：

using Azure;
using Azure.AI.DocumentIntelligence;

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

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

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

AnalyzeResult result = operation.Value;

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

    for (int i = 0; i < page.Lines.Count; i++)
    {
        DocumentLine line = page.Lines[i];

        Console.WriteLine($"  Line {i}:");
        Console.WriteLine($"    Content: '{line.Content}'");

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

        Console.WriteLine();
    }

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

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

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

        Console.WriteLine();
    }
}

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

    Console.WriteLine($"Paragraph {i}:");
    Console.WriteLine($"  Content: {paragraph.Content}");

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

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

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

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

        foreach (DocumentSpan span in style.Spans)
        {
            var handwrittenContent = result.Content.Substring(span.Offset, span.Length);
            Console.WriteLine($"  {handwrittenContent}");
        }
    }
}

for (int i = 0; i < result.Tables.Count; i++)
{
    DocumentTable table = result.Tables[i];

    Console.WriteLine($"Table {i} has {table.RowCount} rows and {table.ColumnCount} columns.");

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

執行您的應用程式

將程式代碼範例新增至應用程式之後，請選擇formRecognizer_quickstart旁的綠色 [開始 ] 按鈕，以建置和執行程式，或按 F5。

預先建置的模型

使用預先建置的模型，從特定文件類型分析及擷取一般欄位。 在此範例中，我們會使用 預先建置的發票模型來分析發票 。

提示

您不限於發票，有數個預先建置的模型可供選擇，每個模型都有自己的支援欄位集。 要用於作業的 analyze 模型取決於要分析的文件類型。 請參閱模型數據擷取。

• 使用預建發票模型分析發票。 您可以針對本快速入門使用我們的 範例發票檔 。
• 我們已將檔案 URI 值新增至 Uri invoiceUri Program.cs檔案頂端的 變數。
• 若要在 URI 分析指定的檔案，請使用 StartAnalyzeDocumentFromUri 方法並傳遞 prebuilt-invoice 作為模型標識碼。 傳回的值是物件 AnalyzeResult ，其中包含送出之文件的數據。
• 為了簡單起見，服務傳回的所有索引鍵/值組不會在此顯示。 若要查看所有支援的欄位和對應類型清單，請參閱我們的 發票 概念頁面。

將下列程式代碼範例新增至您的Program.cs檔案。 請確定您已使用 Azure 入口網站 Document Intelligence 實例中的值來更新金鑰和端點變數：

using Azure;
using Azure.AI.DocumentIntelligence;

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

//sample invoice document

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

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

AnalyzeResult result = operation.Value;

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

    AnalyzedDocument document = result.Documents[i];

    if (document.Fields.TryGetValue("VendorName", out DocumentField vendorNameField)
        && vendorNameField.Type == DocumentFieldType.String)
    {
        string vendorName = vendorNameField.ValueString;
        Console.WriteLine($"Vendor Name: '{vendorName}', with confidence {vendorNameField.Confidence}");
    }

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

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

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

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

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

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

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

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

執行您的應用程式

將程式代碼範例新增至應用程式之後，請選擇formRecognizer_quickstart旁的綠色 [開始 ] 按鈕，以建置和執行程式，或按 F5。

用戶端連結庫 | SDK 參考 REST API 參考 | | 套件 （Maven） | 範例 |支援的 REST API 版本

在本快速入門中，使用下列功能來分析及擷取表單和文件中的數據和值：

• 版面配置：分析及擷取檔中的單選按鈕和複選框等表格、線條、單字和選取標記，而不需要定型模型。

• 預先建置的發票 — 使用預先定型的模型，分析及擷取特定文件類型的一般欄位。

必要條件

• Azure 訂用帳戶 - 建立免費帳戶。

• 最新版的 Visual Studio Code 或您慣用的 IDE。 請參閱Visual Studio Code 中的 Java。

  提示

  • Visual Studio Code 提供 適用於 Windows 和 macOS 的 Java 編碼套件。程式代碼套件是 VS Code 套件組合、Java 開發工具包 （JDK），以及 Microsoft 建議的延伸模組集合。 程式代碼撰寫套件也可用來修正現有的開發環境。
  • 如果您使用 VS Code 和適用於 Java 的 編碼套件，請安裝適用於 Java 的 Gradle 擴充功能。

• 如果您未使用 Visual Studio Code，請確保在開發環境中安裝下列項目：

  • Java 開發工具套件 （JDK） 第 8 版或更新版本。 如需詳細資訊， 請參閱Microsoft Build of OpenJDK。

  • Gradle 6.8 版或更新版本。

• Azure AI 服務或文件智慧服務資源。 擁有 Azure 訂閱後，請在 Azure 入口網站中建立單一服務或多重服務文件智慧服務資源，以取得您的金鑰和端點。 您可以使用免費定價層 (F0) 來試用服務，之後可升級至付費層以用於實際執行環境。

  提示

  如果您打算在單一端點/金鑰下存取多個 Azure AI 服務，請建立 Azure AI 服務資源。 若為僅限文件智慧服務存取，請建立文件智慧服務資源。 請注意，如果您想要使用 Microsoft Entra 驗證，您將需要單一服務資源。

• 部署資源之後，選取 [移至資源]。 您需要使用已建立資源的金鑰和端點，將應用程式連線至文件智慧服務 API。 稍後，您會將金鑰和端點貼到程式代碼中：

  

設定

建立新的 Gradle 專案

1. 在主控台視窗中（例如 cmd、PowerShell 或 Bash），為您的應用程式建立名為 doc-intel-app 的新目錄，然後流覽至該目錄。

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

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

2. gradle init從工作目錄執行 命令。 此命令會建立 Gradle 的基本組建檔案，包括 build.gradle.kts，將在執行階段使用 build.gradle.kts，來建立及設定應用程式。

   gradle init --type basic
   

3. 當系統提示您選擇 DSL 時，請選取 [Kotlin]。

4. 選取 [傳回] 或 [Enter]，以接受預設項目名稱 （doc-intel-app）。

安裝用戶端程式庫

本快速入門使用 Gradle 相依性管理員。 您可以在 Maven 中央存放庫找到其他相依性管理員的用戶端連結庫和資訊。

在 IDE 中開啟專案的 build.gradle.kts 檔案。 Copay 並貼上下列程式代碼以包含用戶端連結庫做為 implementation 語句，以及必要的外掛程式和設定。

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

   }

建立 Java 應用程式

若要與此文件智慧服務互動，您必須建立 DocumentIntelligenceClient 類別的執行個體。 若要這樣做，請使用 key 從 Azure 入口網站建立 AzureKeyCredential，並使用 AzureKeyCredential 和文件智慧服務 endpoint 來建立 DocumentIntelligenceClient 執行個體。

1. 從 doc-intel-app 目錄執行下列命令：

   mkdir -p src/main/java
   

   您會建立下列目錄結構：

   

2. 流覽至目錄， java 並建立名為 DocIntelligence.java的檔案。

   提示

   • 您可以使用 PowerShell 建立新的檔案。
   • 按住 Shift 鍵，並在資料夾上按下滑鼠右鍵，在您的專案目錄中開啟 PowerShell 視窗。
   • 輸入下列命令 New-Item DocIntelligence.java。

3. 開啟 DocIntelligence.java 檔案。 將下列其中一個程式代碼範例複製並貼到您的應用程式中：

   • 版面配置

   • 預先建置的發票

重要

完成時，請記得從程式碼中移除金鑰，且不要公開張貼金鑰。 在生產環境中，請使用安全的方式來儲存和存取您的認證，例如 Azure Key Vault。 如需詳細資訊，請參閱 Azure AI 服務安全性。

版面配置模型

從檔擷取文字、選取標記、文字樣式、表格結構和周框區域座標。

• 在此範例中，您需要 URI 的檔案檔案。 您可以使用本快速入門的 範例檔 。
• 若要在 URI 分析指定的檔案，您將使用 beginAnalyzeDocumentFromUrl 方法，並傳遞 prebuilt-layout 作為模型識別碼。傳回的值是包含 AnalyzeResult 所提交文件相關數據的物件。
• 我們已將檔案 URI 值新增至 documentUrl main 方法中的 變數。

將下列程式代碼範例新增至 DocIntelligence.java 檔案。 請確定您已使用 Azure 入口網站 Document Intelligence 實例中的值來更新金鑰和端點變數：

import com.azure.ai.documentintelligence;

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

import java.util.List;

public class DocIntelligence {

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

  public static void main(String[] args) {

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

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

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

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

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

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

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

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

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

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

建置並執行應用程式

將程式代碼範例新增至應用程式之後，請流覽回主要項目目錄-doc-intel-app。

1. 使用 命令建置 build 您的應用程式：

   gradle build
   

2. 使用 命令執行 run 您的應用程式：

   gradle run
   

預先建置的模型

使用預先建置的模型，從特定文件類型分析及擷取一般欄位。 在此範例中，我們會使用 預先建置的發票模型來分析發票 。

提示

您不限於發票，有數個預先建置的模型可供選擇，每個模型都有自己的支援欄位集。 要用於作業的 analyze 模型取決於要分析的文件類型。 請參閱模型數據擷取。

• 使用預建發票模型分析發票。 您可以針對本快速入門使用我們的 範例發票檔 。
• 我們已將檔案 URL 值新增至 invoiceUrl 檔案頂端的 變數。
• 若要在 URI 分析指定的檔案，您將使用 beginAnalyzeDocuments 方法，並傳遞 PrebuiltModels.Invoice 作為模型識別碼。傳回的值是物件， result 其中包含所提交文件的相關數據。
• 為了簡單起見，服務傳回的所有索引鍵/值組不會在此顯示。 若要查看所有支援的欄位和對應類型清單，請參閱我們的 發票 概念頁面。

將下列程式代碼範例新增至 DocIntelligence.java 檔案。 請確定您已使用 Azure 入口網站 Document Intelligence 實例中的值來更新金鑰和端點變數：

import com.azure.ai.documentintelligence;

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

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

public class DocIntelligence {

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

  public static void main(String[] args) {

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

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

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

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

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

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

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

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

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

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

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

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

        DocumentField invoiceItemsField = invoiceFields.get("Items");
        if (invoiceItemsField != null) {
          System.out.printf("Invoice Items: %n");
          if (DocumentFieldType.ARRAY == invoiceItemsField.getType()) {
            List < DocumentField > invoiceItems = invoiceItemsField.getValueArray();
            invoiceItems.stream()
              .filter(invoiceItem -> DocumentFieldType.OBJECT == invoiceItem.getType())
              .map(documentField -> documentField.getValueObject())
              .forEach(documentFieldMap -> documentFieldMap.forEach((key, documentField) -> {

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

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

建置並執行應用程式

將程式代碼範例新增至應用程式之後，請流覽回主要項目目錄-doc-intel-app。

1. 使用 命令建置 build 您的應用程式：

   gradle build
   

2. 使用 命令執行 run 您的應用程式：

   gradle run
   

用戶端連結庫 | REST API 參考 | 套件 （npm） | 範例 |支援的 REST API 版本

在本快速入門中，使用下列功能來分析及擷取表單和文件中的數據和值：

• 版面配置：分析及擷取檔中的單選按鈕和複選框等表格、線條、單字和選取標記，而不需要定型模型。

• 預先建置的發票 — 使用預先定型的發票模型，分析及擷取特定文件類型的一般字段。

必要條件

• Azure 訂用帳戶 - 建立免費帳戶。

• 最新版的 Visual Studio Code 或您慣用的 IDE。 如需詳細資訊， 請參閱Visual Studio Code 中的Node.js。

• 最新版本 LTS 的 Node.js。

• Azure AI 服務或文件智慧服務資源。 擁有 Azure 訂閱後，請在 Azure 入口網站中建立單一服務或多重服務文件智慧服務資源，以取得您的金鑰和端點。 您可以使用免費定價層 (F0) 來試用服務，之後可升級至付費層以用於實際執行環境。

  提示

  如果您打算在單一端點/金鑰下存取多個 Azure AI 服務，請建立 Azure AI 服務資源。 若為僅限文件智慧服務存取，請建立文件智慧服務資源。 請注意，如果您想要使用 Microsoft Entra 驗證，您將需要單一服務資源。

• 部署資源之後，選取 [移至資源]。 您需要使用已建立資源的金鑰和端點，將應用程式連線至文件智慧服務 API。 您稍後會在快速入門中將金鑰和端點貼上至程式碼中：

  

設定

1. 建立新的 Node.js Express 應用程式：在控制台視窗中（例如 cmd、PowerShell 或 Bash），建立並流覽至名為 doc-intel-app的應用程式的新目錄。

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

2. npm init執行 命令來初始化應用程式，並建構您的專案。

   npm init
   

3. 使用終端機中顯示的提示來指定項目的屬性。

   • 最重要的屬性是名稱、版本號碼和進入點。
   • 我們建議保留 index.js 進入點名稱。 描述、測試命令、GitHub 存放庫、關鍵詞、作者和授權資訊都是選擇性屬性，因此可以略過這個專案。
   • 選取 [傳回] 或 [Enter]，以接受括弧中的建議。
   • 完成提示之後， package.json 將會在 doc-intel-app 目錄中建立檔案。

4. 安裝客戶端連結 ai-document-intelligence 庫與 azure/identity npm 套件：

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

   您的應用程式檔案 package.json 會隨著相依性更新。

5. 在應用程式目錄中建立名為 index.js 的檔案。

   提示

   • 您可以使用 PowerShell 建立新的檔案。
   • 按住 Shift 鍵，並在資料夾上按下滑鼠右鍵，在您的專案目錄中開啟 PowerShell 視窗。
   • 輸入下列命令 New-Item index.js。

建置您的 應用程式

若要與此文件智慧服務互動，您必須建立 DocumentIntelligenceClient 類別的執行個體。 若要這樣做，請使用 key 從 Azure 入口網站建立 AzureKeyCredential，並使用 AzureKeyCredential 和文件智慧服務 endpoint 來建立 DocumentIntelligenceClient 執行個體。

1. 在 index.js Visual Studio Code 或您慣用的 IDE 中開啟檔案。 將下列其中一個程式代碼範例複製並貼到您的應用程式中：

   • 版面配置

   • 預先建置的發票

重要

完成時，請記得從程式碼中移除金鑰，且不要公開張貼金鑰。 在生產環境中，請使用安全的方式來儲存和存取您的認證，例如 Azure Key Vault。 如需詳細資訊，請參閱 Azure AI 服務安全性。

版面配置模型

從檔擷取文字、選取標記、文字樣式、表格結構和周框區域座標。

• 在此範例中，您需要 來自 URL 的檔案檔案。 您可以使用本快速入門的 範例檔 。
• 我們已將檔案 URL 值新增至 formUrl 靠近檔案頂端的變數。
• 若要從 URL 分析指定的檔案，您將使用 beginAnalyzeDocuments 方法並傳入 prebuilt-layout 作為模型識別碼。

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

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

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

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

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

const {
        pages,
        tables
    } = await poller.pollUntilDone();

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

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

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

執行您的應用程式

將程式代碼範例新增至應用程式之後，請執行程式：

1. 流覽至您有 Document Intelligence 應用程式的資料夾（doc-intel-app）。

2. 在您的終端機中輸入下列命令：

   node index.js
   

預先建置的模型

在此範例中，我們會使用 預先建置的發票模型來分析發票 。

提示

您不限於發票，有數個預先建置的模型可供選擇，每個模型都有自己的支援欄位集。 要用於作業的 analyze 模型取決於要分析的文件類型。 請參閱模型數據擷取。

• 使用預建發票模型分析發票。 您可以針對本快速入門使用我們的 範例發票檔 。
• 我們已將檔案 URL 值新增至 invoiceUrl 檔案頂端的 變數。
• 若要在 URI 分析指定的檔案，您將使用 beginAnalyzeDocuments 方法，並傳遞 PrebuiltModels.Invoice 作為模型識別碼。傳回的值是物件， result 其中包含所提交文件的相關數據。
• 為了簡單起見，服務傳回的所有索引鍵/值組不會在此顯示。 若要查看所有支援的欄位和對應類型清單，請參閱我們的 發票 概念頁面。

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

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

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

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

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

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

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

執行您的應用程式

將程式代碼範例新增至應用程式之後，請執行程式：

1. 流覽至您有 Document Intelligence 應用程式的資料夾（doc-intel-app）。

2. 在您的終端機中輸入下列命令：

   node index.js
   

用戶端連結庫 |SDK 參考 REST API 參考 | | 套件 （PyPi） | 範例 | 支援的 REST API 版本

在本快速入門中，使用下列功能來分析及擷取表單和文件中的數據：

• 版面配置：分析及擷取數據表、線條、單字和選取標記，例如單選按鈕和複選框，以及索引鍵/值組，而不需要定型模型。

• 預先建置的發票 — 使用預先定型的模型，分析及擷取特定文件類型的一般欄位。

必要條件

• Azure 訂用帳戶 - 建立免費帳戶。

• Python 3.7 或更新版本。

  • 您的 Python 安裝應該包含 pip。 您可以藉由在命令列上執行 pip --version 來檢查您是否已安裝 pip。 安裝最新版本的 Python 以取得 pip。

• 最新版的 Visual Studio Code 或您慣用的 IDE。 如需詳細資訊，請參閱 Visual Studio Code 中的 Python 使用者入門 (英文)。

• Azure AI 服務或文件智慧服務資源。 擁有 Azure 訂閱後，請在 Azure 入口網站中建立單一服務或多重服務文件智慧服務資源，以取得您的金鑰和端點。 您可以使用免費定價層 (F0) 來試用服務，之後可升級至付費層以用於實際執行環境。

提示

如果您打算在單一端點/金鑰下存取多個 Azure AI 服務，請建立 Azure AI 服務資源。 若為僅限文件智慧服務存取，請建立文件智慧服務資源。 請注意，如果您想要使用 Microsoft Entra 驗證，您將需要單一服務資源。

• 部署資源之後，選取 [移至資源]。 您需要使用已建立資源的金鑰和端點，將應用程式連線至文件智慧服務 API。 您稍後會在快速入門中將金鑰和端點貼上至程式碼中：

  

設定

在本機環境中開啟終端機視窗，並使用 pip 安裝適用於 Python 的 Azure AI 文件智慧服務用戶端程式庫：

pip install azure-ai-documentintelligence==1.0.0b2

建立 Python 應用程式

若要與此文件智慧服務互動，您必須建立 DocumentIntelligenceClient 類別的執行個體。 若要這樣做，請使用 key 從 Azure 入口網站建立 AzureKeyCredential，並使用 AzureKeyCredential 和文件智慧服務 endpoint 來建立 DocumentIntelligenceClient 執行個體。

1. 在慣用的編輯器或 IDE 中建立名為 doc_intel_quickstart.py 的新 Python 檔案。

2. 開啟doc_intel_quickstart.py檔案，然後選取下列其中一個程式代碼範例，以複製並貼到您的應用程式：

   • 版面配置

   • 預先建置的發票

重要

完成時，請記得從程式碼中移除金鑰，且不要公開張貼金鑰。 在生產環境中，請使用安全的方式來儲存和存取您的認證，例如 Azure Key Vault。 如需詳細資訊，請參閱 Azure AI 服務安全性。

版面配置模型

從檔擷取文字、選取標記、文字樣式、表格結構和周框區域座標。

• 在此範例中，您需要 來自 URL 的檔案檔案。 您可以使用本快速入門的 範例檔 。
• 我們已將檔案 URL 值新增至 formUrl 函式中的 analyze_layout 變數。
• 若要在 URL 分析指定的檔案，您將使用 begin_analyze_document_from_url 方法並傳入 prebuilt-layout 作為模型識別碼。傳回的值是物件， result 其中包含所提交文件的相關數據。

將下列程式代碼範例新增至doc_intel_quickstart.py應用程式。 請確定您已使用 Azure 入口網站 Document Intelligence 實例中的值來更新金鑰和端點變數：

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

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

# helper functions

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


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


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

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

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

    analyze_request = AnalyzeDocumentRequest(
        url_source=formUrl
    )

    result: AnalyzeResult = poller.result()

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

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

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

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

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

    if result.tables:
        for table_idx, table in enumerate(result.tables):
            print(
                f"Table # {table_idx} has {table.row_count} rows and "
                f"{table.column_count} columns"
            )
            if table.bounding_regions:
                for region in table.bounding_regions:
                    print(
                        f"Table # {table_idx} location on page: {region.page_number} is {region.polygon}"
                    )
            for cell in table.cells:
                print(
                    f"...Cell[{cell.row_index}][{cell.column_index}] has text '{cell.content}'"
                )
                if cell.bounding_regions:
                    for region in cell.bounding_regions:
                        print(
                            f"...content on page {region.page_number} is within bounding polygon '{region.polygon}'"
                        )

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


if __name__ == "__main__":
    analyze_layout()

執行應用程式

將程式代碼範例新增至應用程式之後，請建置並執行程式：

1. 流覽至您 擁有doc_intel_quickstart.py 檔案的資料夾。

2. 在您的終端機中輸入下列命令：

   python doc_intel_quickstart.py
   

---

預先建置的模型

使用預先建置的模型，從特定文件類型分析及擷取一般欄位。 在此範例中，我們會使用 預先建置的發票模型來分析發票 。

提示

您不限於發票，有數個預先建置的模型可供選擇，每個模型都有自己的支援欄位集。 要用於作業的 analyze 模型取決於要分析的文件類型。 請參閱模型數據擷取。

• 使用預建發票模型分析發票。 您可以針對本快速入門使用我們的 範例發票檔 。
• 我們已將檔案 URL 值新增至 invoiceUrl 檔案頂端的 變數。
• 若要在 URI 分析指定的檔案，您將使用 begin_analyze_document_from_url 方法，並傳遞 prebuilt-invoice 作為模型識別碼。傳回的值是物件， result 其中包含所提交文件的相關數據。
• 為了簡單起見，服務傳回的所有索引鍵/值組不會在此顯示。 若要查看所有支援的欄位和對應類型清單，請參閱我們的 發票 概念頁面。

將下列程式代碼範例新增至doc_intel_quickstart.py應用程式。 請確定您已使用 Azure 入口網站 Document Intelligence 實例中的值來更新金鑰和端點變數：

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


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

def analyze_invoice():
    # sample document

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

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

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

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


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


if __name__ == "__main__":
    analyze_invoice()

執行應用程式

將程式代碼範例新增至應用程式之後，請建置並執行程式：

1. 流覽至您 擁有doc_intel_quickstart.py 檔案的資料夾。

2. 在您的終端機中輸入下列命令：

   python doc_intel_quickstart.py
   

| 檔智慧 REST API | 支援的 Azure SDK

在本快速入門中，瞭解如何使用檔智慧 REST API 來分析及擷取檔中的數據和值：

必要條件

• Azure 訂用帳戶 - 建立免費帳戶

• 已安裝 curl 命令行工具。

  • Windows
  • Mac 或 Linux

• PowerShell 版本 7.*+ （或類似的命令行應用程式。）：

  • Windows
  • macOS
  • Linux

• 若要檢查 PowerShell 版本，請輸入下列相對於作業系統的命令：

  • Windows：Get-Host | Select-Object Version
  • macOS 或 Linux： $PSVersionTable

• 文件智慧服務 (單一服務) 或 Azure AI 服務 (多重服務) 資源。 擁有 Azure 訂閱後，請在 Azure 入口網站中建立單一服務或多重服務文件智慧服務資源，以取得您的金鑰和端點。 您可以使用免費定價層 (F0) 來試用服務，之後可升級至付費層以用於實際執行環境。

提示

如果您打算在單一端點/金鑰下存取多個 Azure AI 服務，請建立 Azure AI 服務資源。 若為僅限文件智慧服務存取，請建立文件智慧服務資源。 請注意，如果您想要使用 Microsoft Entra 驗證，您將需要單一服務資源。

• 部署資源之後，選取 [移至資源]。 您需要使用已建立資源的金鑰和端點，將應用程式連線至文件智慧服務 API。 您稍後會在快速入門中將金鑰和端點貼上至程式碼中：

  

分析檔並取得結果

POST 要求可用來使用預先建置或自定義模型來分析檔。 GET 要求可用來擷取檔分析呼叫的結果。 modelId與 POST 和 resultId GET 作業搭配使用。

分析檔案 （POST 要求）

執行 cURL 命令之前，請先對後續要求進行下列變更：

1. 將 取代{endpoint}為您 Azure 入口網站 Document Intelligence 實例中的端點值。

2. 將 取代{key}為您 Azure 入口網站 Document Intelligence 實例中的索引鍵值。

3. 使用下表做為參考，將 和 {your-document-url} 取代{modelID}為您所需的值。

4. 您需要文件檔案的 URL。 在本快速入門中，您可以使用下表中針對每項功能的範例表單：

範例檔

功能	{modelID}	{your-document-url}
讀取	prebuilt-read	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/read.png
版面配置	prebuilt-layout	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/layout.png
健保卡	prebuilt-healthInsuranceCard.us	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/insurance-card.png
W-2	prebuilt-tax.us.w2	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/w2.png
發票	預建發票	https://github.com/Azure-Samples/cognitive-services-REST-api-samples/raw/master/curl/form-recognizer/rest-api/invoice.pdf
收據	prebuilt-receipt	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/receipt.png
身分證明文件	prebuilt-idDocument	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/identity_documents.png

重要

完成時，請記得從程式碼中移除金鑰，且不要公開張貼金鑰。 在生產環境中，請使用安全的方式來儲存和存取您的認證，例如 Azure Key Vault。 如需詳細資訊，請參閱 Azure AI 服務安全性。

POST 要求

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

POST 回應 （resultID）

您收到 202 (Success) 回應，其中包含唯讀 Operation-Location 標頭。 此標頭的值包含 resultID，可透過查詢以取得非同步作業的狀態，並且可使用 GET 要求搭配您的相同資源訂用帳戶金鑰來擷取結果：

取得分析結果 （GET 要求）

呼叫 Analyze document API 之後，請呼叫 取得分析結果 API，以取得作業的狀態和擷取的數據。 執行命令之前，請先進行下列變更：

1. 從 POST 回應取代 {resultID} Operation-Location 標頭。

2. 將 取代{key}為 Azure 入口網站 中 Document Intelligence 實例的索引鍵值。

GET 要求

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

檢查回應

您收到 200 (Success) 回應及 JSON 輸出。 第一個字段 "status"表示作業的狀態。 如果作業未完成，而 "status" 的值是 "running" 或 "notStarted"，此時您應該以手動方式或透過指令碼再次呼叫 API。 我們建議在呼叫之間間隔一秒以上。

預建發票的範例回應

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

支援的檔欄位

預先建置的模型會擷取預先定義的檔欄位集。 如需擷取的功能變數名稱、類型、描述和範例，請參閱 模型數據擷取 。

就是這樣，恭喜！

在本快速入門中，您已使用文件智慧模型來分析各種表單和檔。 接下來，探索 Document Intelligence Studio 和參考檔，以深入瞭解檔智慧 API。

下一步

• 如需增強的體驗和進階模型品質，請嘗試 Document Intelligence Studio

• 如需 v3.1 至 v4.0 移轉，請參閱 變更記錄移轉指南。