開始使用文件智慧服務

重要

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

此內容適用於： v3.1 (GA) 較舊版本： v3.0 v2.1

• 開始使用 Azure 表格辨識器最新 GA 版本 (2023-07-31)。

• Azure AI 文件智慧服務/表格辨識器是雲端式 Azure AI 服務，其使用機器學習從文件中擷取機碼值組、文字、資料表和重要資料。

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

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

若要深入了解 API 的功能和開發選項，請瀏覽我們的概觀 (部分機器翻譯) 頁面。

用戶端程式庫 (英文) | SDK 參考 (英文) | API 參考 (部分機器翻譯) | 套件 (NuGet) (英文) | 範例 (英文) | 支援的 REST API 版本 (部分機器翻譯)

在本快速入門中，請使用下列功能，從表單和文件中分析及擷取資料和值：

• 版面配置模型 - 分析及擷取表格、行、單字和選取標記，例如檔中的選項按鈕和核取方塊，而不需要定型模型。

• 預先建置的模型 - 使用預先建置的模型，分析及擷取特定檔案類型中的常見欄位。

必要條件

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

• 目前的 Visual Studio 整合式開發環境 (IDE) 版本。

• Azure AI 服務或表格辨識器資源。 擁有 Azure 訂用帳戶後，請在 Azure 入口網站中建立單一服務或 Azure AI 多重服務資源，以取得金鑰與端點。

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

提示

如果您打算在單一端點/金鑰下存取多個 Azure AI 服務，請建立 Azure AI 服務資源。 僅針對 Azure 表格辨識器的存取，請建立 Azure 表格辨識器資源。 請注意，如果您想要使用 Microsoft Entra 驗證 (部分機器翻譯)，需要使用單一服務資源。

• 部署資源之後，請選取 [移至資源]。 您需要您所建立資源的金鑰和端點，以將應用程式連線至 Azure 表格辨識器 API。 您稍後會在快速入門中將金鑰和端點貼上至程式碼中：

  

設定

1. 啟動 Visual Studio。

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

   

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

   

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

5. 在 [其他資訊] 對話方塊視窗中，選取 [.NET 8.0 (長期支援)]，然後選取 [建立]。

   

使用 NuGet 安裝用戶端程式庫

1. 以滑鼠右鍵按一下您的 form_recognizer_quickstart 專案，然後選取 [管理 NuGet 套件...]。

   

2. 選取 [瀏覽] 索引標籤，然後輸入 [Azure.AI.FormRecognizer]。 從下拉式功能表中選取 [4.1.0] 版

   

建置您的 應用程式

若要與 Azure 表格辨識器服務互動，您需要建立 DocumentAnalysisClient 類別的執行個體。 若要這樣做，您要使用 key 從 Azure 入口網站建立 AzureKeyCredential，並使用 AzureKeyCredential 和 Azure 表格辨識器 endpoint 來建立 DocumentAnalysisClient 執行個體。

注意

• 從 .NET 6 開始，使用 console 範本的新專案會產生與舊版不同的新程式樣式。
• 新輸出會使用最新的 C# 功能，以簡化您需要撰寫的程式碼。
• 當您使用較新版本時，只需要撰寫 Main 方法的本文。 您不需要包含最上層陳述式、全域 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 入口網站 Azure 表格辨識器執行個體的值來更新金鑰和端點變數：

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

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

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

AnalyzeDocumentOperation operation = await client.AnalyzeDocumentFromUriAsync(WaitUntil.Completed, "prebuilt-layout", fileUri);

AnalyzeResult result = operation.Value;

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

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

        Console.WriteLine($"    Its bounding box is:");
        Console.WriteLine($"      Upper left => X: {line.BoundingPolygon[0].X}, Y= {line.BoundingPolygon[0].Y}");
        Console.WriteLine($"      Upper right => X: {line.BoundingPolygon[1].X}, Y= {line.BoundingPolygon[1].Y}");
        Console.WriteLine($"      Lower right => X: {line.BoundingPolygon[2].X}, Y= {line.BoundingPolygon[2].Y}");
        Console.WriteLine($"      Lower left => X: {line.BoundingPolygon[3].X}, Y= {line.BoundingPolygon[3].Y}");
    }

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

        Console.WriteLine($"  Selection Mark {i} is {selectionMark.State}.");
        Console.WriteLine($"    Its bounding box is:");
        Console.WriteLine($"      Upper left => X: {selectionMark.BoundingPolygon[0].X}, Y= {selectionMark.BoundingPolygon[0].Y}");
        Console.WriteLine($"      Upper right => X: {selectionMark.BoundingPolygon[1].X}, Y= {selectionMark.BoundingPolygon[1].Y}");
        Console.WriteLine($"      Lower right => X: {selectionMark.BoundingPolygon[2].X}, Y= {selectionMark.BoundingPolygon[2].Y}");
        Console.WriteLine($"      Lower left => X: {selectionMark.BoundingPolygon[3].X}, Y= {selectionMark.BoundingPolygon[3].Y}");
    }
}

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

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

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

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

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

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

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

執行應用程式

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

版面配置模型輸出

以下是預期的輸出程式碼片段：

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

若要檢視整個輸出，請造訪 GitHub 上的 Azure 範例存放庫，以檢視配置模型輸出。

預先建置模型

使用預建模型來分析及擷取特定檔案類型中的常見欄位。 在此範例中，我們會使用預建發票模型來分析發票。

提示

這不限於發票，有多種預建模型可供選擇，每個模型都有一組自身支援的欄位。 analyze 作業所用的模型取決於要分析的文件類型。 請參閱模型資料擷取。

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

將下列程式碼範例新增到您的 Program.cs 檔案中。 請務必使用來自 Azure 入口網站 Azure 表格辨識器執行個體的值來更新金鑰和端點變數：

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

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

//sample invoice document

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

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

AnalyzeResult result = operation.Value;

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

    AnalyzedDocument document = result.Documents[i];

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

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

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

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

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

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

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

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

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

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

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

執行應用程式

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

預建模型輸出

以下是預期的輸出程式碼片段：

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

若要檢視整個輸出，請造訪 GitHub 上的 Azure 範例存放庫，以檢視預先建置發票模型輸出。

用戶端程式庫 (英文) | 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 建議延伸模組的集合。 編碼套件也可以用於修正現有的開發環境。
  • 如果您使用適用於 JAVA 的 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) 中，為您的應用程式建立一個名為 form-recognize-app 的新目錄，並瀏覽至該目錄。

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

   mkdir form-recognize-app; cd form-recognize-app
   

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

   gradle init --type basic
   

3. 出現選擇 DSL 的提示時，請選取 [Kotlin]。

4. 選取 Return 或 Enter 以接受預設專案名稱 (form-recognize-app)。

安裝用戶端程式庫

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

在 IDE 中開啟專案的 build.gradle.kts 檔案。 複製並貼上下列程式碼以將用戶端程式庫作為 implementation 陳述式包含在內，一併加入必要的外掛程式和設定。

   plugins {
       java
       application
   }
   application {
       mainClass.set("FormRecognizer")
   }
   repositories {
       mavenCentral()
   }
   dependencies {
       implementation group: 'com.azure', name: 'azure-ai-formrecognizer', version: '4.1.0'

   }

建立 Java 應用程式

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

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

   mkdir -p src/main/java
   

   您會建立下列目錄結構：

   

1. 瀏覽至 java 目錄並建立名為 FormRecognizer.java 的檔案。

   提示

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

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

   • 版面配置

   • 預建發票

重要

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

版面配置模型

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

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

將下列範例程式碼新增至檔案 FormRecognizer.java。 請務必使用來自 Azure 入口網站文件智慧服務執行個體的值來更新金鑰與端點變數：

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

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

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

public class FormRecognizer {

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

  public static void main(String[] args) {

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

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

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

    AnalyzeResult analyzeLayoutResult = analyzeLayoutResultPoller.getFinalResult();

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

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

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

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

    // tables
    List < DocumentTable > tables = analyzeLayoutResult.getTables();
    for (int i = 0; i < tables.size(); i++) {
      DocumentTable documentTable = tables.get(i);
      System.out.printf("Table %d has %d rows and %d columns.%n", i, documentTable.getRowCount(),
        documentTable.getColumnCount());
      documentTable.getCells().forEach(documentTableCell -> {
        System.out.printf("Cell '%s', has row index %d and column index %d.%n", documentTableCell.getContent(),
          documentTableCell.getRowIndex(), documentTableCell.getColumnIndex());
      });
      System.out.println();
    }
  }
  // Utility function to get the bounding polygon coordinates
  private static String getBoundingCoordinates(List < Point > boundingPolygon) {
    return boundingPolygon.stream().map(point -> String.format("[%.2f, %.2f]", point.getX(),
      point.getY())).collect(Collectors.joining(", "));
  }
}

建置並執行應用程式

將程式碼範例新增至應用程式後，請往回瀏覽至您的主要專案目錄：form-recognize-app。

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

   gradle build
   

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

   gradle run
   

版面配置模型輸出

以下是預期的輸出程式碼片段：

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

若要檢視整個輸出，請造訪 GitHub 上的 Azure 範例存放庫，以檢視配置模型輸出。

預先建置模型

使用預建模型來分析及擷取特定檔案類型中的常見欄位。 在此範例中，我們會使用預建發票模型來分析發票。

提示

這不限於發票，有多種預建模型可供選擇，每個模型都有一組自身支援的欄位。 analyze 作業所用的模型取決於要分析的文件類型。 請參閱模型資料擷取。

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

將下列範例程式碼新增至檔案 FormRecognizer.java。 請務必使用來自 Azure 入口網站文件智慧服務執行個體的值來更新金鑰與端點變數：

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

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

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

public class FormRecognizer {

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

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

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

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

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

    AnalyzeResult analyzeInvoiceResult = analyzeInvoicePoller.getFinalResult();

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

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

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

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

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

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

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

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

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

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

建置並執行應用程式

將程式碼範例新增至應用程式後，請往回瀏覽至您的主要專案目錄：doc-intel-app。

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

   gradle build
   

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

   gradle run
   

預建模型輸出

以下是預期的輸出程式碼片段：

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

若要檢視整個輸出，請造訪 GitHub 上的 Azure 範例存放庫，以檢視預先建置發票模型輸出。

用戶端程式庫 (英文) | SDK 參考 (英文) | 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 快速應用程式：在主控台視窗 (例如 cmd、PowerShell 或 Bash) 中，為您的應用程式建立名為 doc-intel-app 的新目錄，並瀏覽至該目錄。

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

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

   npm init
   

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

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

4. 安裝 ai-form-recognizer 用戶端程式庫和 azure/identity npm 套件：

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

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

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

   提示

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

建置您的 應用程式

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

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

   • 版面配置

   • 預建發票

重要

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

版面配置模型

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

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

將下列範例程式碼新增至檔案 index.js。 請務必使用來自 Azure 入口網站文件智慧服務執行個體的值來更新金鑰與端點變數：

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

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

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

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

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

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

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

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

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

執行應用程式

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

1. 瀏覽至文件智慧服務應用程式所在的資料夾 (doc-intel-app)。

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

   node index.js
   

版面配置模型輸出

以下是預期的輸出程式碼片段：

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

若要檢視整個輸出，請造訪 GitHub 上的 Azure 範例存放庫，以檢視配置模型輸出。

預先建置模型

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

提示

這不限於發票，有多種預建模型可供選擇，每個模型都有一組自身支援的欄位。 analyze 作業所用的模型取決於要分析的文件類型。 請參閱模型資料擷取。

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

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

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

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

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

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

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

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

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

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

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

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

執行應用程式

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

1. 瀏覽至文件智慧服務應用程式所在的資料夾 (doc-intel-app)。

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

   node index.js
   

預建模型輸出

以下是預期的輸出程式碼片段：

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

若要檢視整個輸出，請造訪 GitHub 上的 Azure 範例存放庫，以檢視預先建置發票模型輸出。

用戶端程式庫 (英文) |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-formrecognizer==3.3.0

建立 Python 應用程式

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

1. 在您偏好的編輯器或 IDE 中建立一個名為 form_recognizer_quickstart.py 的新 Python 檔案。

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

   • 版面配置

   • 預建發票

重要

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

版面配置模型

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

• 在此範例中，您需要來自 URL 的文件檔案。 您可以針對本快速入門使用我們的範例文件 (英文)。
• 我們已將檔案 URI 值新增至 analyze_layout 函式中的 formUrl 變數。

若要分析位於 URL 的指定檔案，需使用 begin_analyze_document_from_url 方法並傳遞 prebuilt-layout 作為模型識別碼。傳回值是一個 result 物件，其中包含提交文件的相關資料。

將下列程式碼範例新增至您的 form_recognizer_quickstart.py 應用程式。 請務必使用來自 Azure 入口網站 Azure 表格辨識器執行個體的值來更新金鑰和端點變數：

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

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

def format_polygon(polygon):
    if not polygon:
        return "N/A"
    return ", ".join(["[{}, {}]".format(p.x, p.y) for p in polygon])

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

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

    poller = document_analysis_client.begin_analyze_document_from_url(
            "prebuilt-layout", formUrl)
    result = poller.result()

    for idx, style in enumerate(result.styles):
        print(
            "Document contains {} content".format(
                "handwritten" if style.is_handwritten else "no handwritten"
            )
        )

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

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

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

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

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

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


if __name__ == "__main__":
    analyze_layout()

執行應用程式

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

1. 瀏覽至 form_recognizer_quickstart.py 檔案所在的資料夾。

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

   python form_recognizer_quickstart.py
   

版面配置模型輸出

以下是預期的輸出程式碼片段：

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

若要檢視整個輸出，請造訪 GitHub 上的 Azure 範例存放庫，以檢視配置模型輸出。

---

預先建置模型

使用預建模型來分析及擷取特定檔案類型中的常見欄位。 在此範例中，我們會使用預建發票模型來分析發票。

提示

這不限於發票，有多種預建模型可供選擇，每個模型都有一組自身支援的欄位。 analyze 作業所用的模型取決於要分析的文件類型。 請參閱模型資料擷取。

• 請使用預建發票模型來分析發票。 您可以使用本快速入門的範例發票文件。
• 我們已將檔案 URL 值新增至檔案頂端的 invoiceUrl 變數。
• 簡單起見，此處不會顯示服務傳回的所有機碼值組。 若要查看所有支援的欄位和對應類型清單，請參閱發票概念頁面。

若要在 URI 上分析指定檔案，您將使用 begin_analyze_document_from_url 方法並傳遞 prebuilt-invoice 作為模型識別碼。傳回值是一個 result 物件，其中包含提交文件的相關資料。

將下列程式碼範例新增至您的 form_recognizer_quickstart.py 應用程式。 請務必使用來自 Azure 入口網站 Azure 表格辨識器執行個體的值來更新金鑰和端點變數：

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

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


def format_bounding_region(bounding_regions):
    if not bounding_regions:
        return "N/A"
    return ", ".join(
        "Page #{}: {}".format(region.page_number, format_polygon(region.polygon))
        for region in bounding_regions
    )


def format_polygon(polygon):
    if not polygon:
        return "N/A"
    return ", ".join(["[{}, {}]".format(p.x, p.y) for p in polygon])


def analyze_invoice():

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

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

    poller = document_analysis_client.begin_analyze_document_from_url(
        "prebuilt-invoice", invoiceUrl
    )
    invoices = poller.result()

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

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

if __name__ == "__main__":
    analyze_invoice()

執行應用程式

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

1. 瀏覽至 form_recognizer_quickstart.py 檔案所在的資料夾。

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

   python form_recognizer_quickstart.py
   

預建模型輸出

以下是預期的輸出程式碼片段：

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

若要檢視整個輸出，請造訪 GitHub 上的 Azure 範例存放庫，以檢視預先建置發票模型輸出。

| 文件智慧服務 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 命令前，請對 POST 要求進行下列變更：

1. 將 {endpoint} 取代為 Azure 入口網站文件智慧服務執行個體中的端點值。

2. 將 {key} 取代為 Azure 入口網站文件智慧服務執行個體中的金鑰值。

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

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

範例文件

功能	{modelID}	{your-document-url}
一般文件	prebuilt-document	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/sample-layout.pdf
讀取	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
發票	prebuilt-invoice	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
名片	prebuilt-businessCard	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/de5e0d8982ab754823c54de47a47e8e499351523/curl/form-recognizer/rest-api/business_card.jpg

重要

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

POST 要求

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

POST 回應 (resultID)

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

取得分析結果 (GET 要求)

呼叫 Analyze document (部分機器翻譯) API 後，請呼叫取得分析結果 (部分機器翻譯) API 以取得作業狀態和擷取的資料。 執行命令之前，請進行下列變更：

1. 取代 POST 回應的 {resultID} Operation-location 標頭。

2. 將 {key} 取代為 Azure 入口網站中文件智慧服務執行個體中的金鑰值。

GET 要求

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

檢查回應

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

預建發票的回應範例

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

支援的文件欄位

預建模型會擷取預先定義的文件欄位集。 如需擷取欄位名稱、類型、描述和範例，請參閱模型資料擷取。

沒錯，恭喜！

在本快速入門中，您使用文件智慧服務模型分析了多種表單和文件。 接下來，請探索文件智慧服務工作室和參考文件以深入了解文件智慧服務 API。

下一步

• 如需增強體驗和進階模型品質，請嘗試文件智慧服務工作室 (英文)

• 如需 v3.1 至 v4.0 移轉，請參閱變更記錄移轉指南 (部分機器翻譯)。

• 在 GitHub 上尋找更多範例 (英文)。