SDK 目標：REST API 2022–08–31 （GA）

REST API 版本 2022–08–31 （GA）

Azure AI 文件智慧服務是一項雲端服務，會使用機器學習來分析文件中的文字和結構化資料。 文件智慧軟體開發套件 (SDK) 是一組程式庫和工具，可讓您輕鬆地將文件智慧模型和功能整合到應用程式中。 可跨平台使用 C#/.NET、Java、JavaScript 和 Python 程式設計語言，來使用文件智慧 SDK。

支援的程式設計語言

文件智慧 SDK 支援下列語言和平台：

語言 → 文件智慧 SDK 版本	套件	支援的 API 版本	平台支援
.NET/C# → 4.0.0 (GA)	NuGet (英文)	v3.0 v2.1 v2.0	Windows、macOS、Linux、Docker
JAVA → 4.0.6 (GA)	MVN 存放庫	v3.0 v2.1 v2.0	Windows、macOS、Linux
JavaScript → 4.0.0 (GA)	npm \(英文\)	v3.0 v2.1 v2.0	Browser、Windows、macOS、Linux
Python → 3.2.0 (GA)	PyPI	v3.0 v2.1 v2.0	Windows、macOS、Linux

支援的用戶端

語言	SDK 版本	API 版本	支援的用戶端
.NET/C# JAVA JavaScript	4.0.0 (GA)	v3.0：2022-08-31 （預設值）	DocumentAnalysisClient DocumentModelAdministrationClient
.NET/C# JAVA JavaScript	3.1.x	v2.1 (預設) v2.0	FormRecognizerClient FormTrainingClient
.NET/C# JAVA JavaScript	3.0.x	v2.0	FormRecognizerClient FormTrainingClient
Python	3.2.x (GA)	v3.0：2022-08-31 （預設值）	DocumentAnalysisClient DocumentModelAdministrationClient
Python	3.1.x	v2.1 (預設) v2.0	FormRecognizerClient FormTrainingClient
Python	3.0.0	v2.0	FormRecognizerClient FormTrainingClient

在應用程式中使用文件智慧 SDK

文件智慧 SDK 讓您能夠在應用程式中使用和管理文件智慧服務。 SDK 建置於基礎文件智慧 REST API 上，可讓您輕鬆地在程式設計語言範例內使用這些 API。 以下說明如何使用您慣用語言的文件智慧 SDK：

1.安裝 SDK 用戶端連結庫

C#/.NET

dotnet add package Azure.AI.FormRecognizer --version 4.0.0

Install-Package Azure.AI.FormRecognizer -Version 4.0.0

Java

<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-ai-formrecognizer</artifactId>
<version>4.0.6</version>
</dependency>

implementation("com.azure:azure-ai-formrecognizer:4.0.6")

JavaScript

npm i @azure/ai-form-recognizer@4.0.0

Python

pip install azure-ai-formrecognizer==3.2.0

2.將 SDK 用戶端連結庫匯入您的應用程式

C#/.NET

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

Java

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

import com.azure.core.credential.AzureKeyCredential;

JavaScript

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

Python

from azure.ai.formrecognizer import DocumentAnalysisClient
from azure.core.credentials import AzureKeyCredential

3.設定驗證

驗證有兩個支援的方法

• 使用文件智慧 API 金鑰搭配 azure.core.credentials 中的 AzureKeyCredential。

• 使用來自 azure 身分識別的令牌認證，以 Microsoft Entra ID 進行驗證。

使用您的 API 金鑰

您可以在 Azure 入口網站中的下列位置找到文件智慧 API 金鑰：

C#/.NET

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

Java

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

JavaScript

// create your `DocumentAnalysisClient` instance and `AzureKeyCredential` variable
async function main() {
    const client = new DocumentAnalysisClient("<your-endpoint>", new AzureKeyCredential("<your-key>"));

Python

# create your `DocumentAnalysisClient` instance and `AzureKeyCredential` variable
    document_analysis_client = DocumentAnalysisClient(endpoint="<your-endpoint>", credential=AzureKeyCredential("<your-key>"))

使用 Microsoft Entra 令牌認證

注意

區域端點不支援 Microsoft Entra 驗證。 為您的資源建立 自定義子域 ，以使用這種類型的驗證。

使用 最輕鬆的 DefaultAzureCredential授權。 它會根據執行中的環境提供預設令牌認證，能夠處理大部分的 Azure 驗證案例。

C#/.NET

以下說明如何取得和使用 .NET 應用程式的 DefaultAzureCredential ：

1. 安裝適用於 .NET 的 Azure 身分識別連結庫：

       dotnet add package Azure.Identity
   

       Install-Package Azure.Identity
   

2. 註冊 Microsoft Entra 應用程式並建立新的服務主體。

3. 將 Cognitive Services User 角色指派給服務主體，以授與對文件智慧的存取權。

4. 將 Microsoft Entra 應用程式中用戶端識別碼、租使用者識別碼和客戶端密碼的值分別設定為環境變數： AZURE_CLIENT_ID、 AZURE_TENANT_ID和 AZURE_CLIENT_SECRET。

5. 建立您的 DocumentAnalysisClient 實體， DefaultAzureCredential包括 ：

   string endpoint = "<your-endpoint>";
   var client = new DocumentAnalysisClient(new Uri(endpoint), new DefaultAzureCredential());
   

如需詳細資訊， 請參閱驗證用戶端

Java

以下說明如何取得及使用 Java 應用程式的 DefaultAzureCredential ：

1. 安裝適用於 Java 的 Azure 身分識別連結庫：

   <dependency>
       <groupId>com.azure</groupId>
       <artifactId>azure-identity</artifactId>
       <version>1.5.3</version>
   </dependency>
   

2. 註冊 Microsoft Entra 應用程式並建立新的服務主體。

3. 將 Cognitive Services User 角色指派給服務主體，以授與對文件智慧的存取權。

4. 將 Microsoft Entra 應用程式的用戶端識別碼、租使用者識別碼和客戶端密碼的值分別設定為環境變數： AZURE_CLIENT_ID、 AZURE_TENANT_ID和 AZURE_CLIENT_SECRET。

5. 建立您的 DocumentAnalysisClient 實體與 TokenCredential 變數：

   TokenCredential credential = new DefaultAzureCredentialBuilder().build();
   DocumentAnalysisClient documentAnalysisClient = new DocumentAnalysisClientBuilder()
       .endpoint("{your-endpoint}")
       .credential(credential)
       .buildClient();
   

如需詳細資訊， 請參閱驗證用戶端

JavaScript

以下說明如何取得及使用 JavaScript 應用程式的 DefaultAzureCredential ：

1. 安裝適用於 JavaScript 的 Azure 身分識別連結庫：

   npm install @azure/identity
   

2. 註冊 Microsoft Entra 應用程式並建立新的服務主體。

3. 將 Cognitive Services User 角色指派給服務主體，以授與對文件智慧的存取權。

4. 將 Microsoft Entra 應用程式的用戶端識別碼、租使用者識別碼和客戶端密碼的值分別設定為環境變數： AZURE_CLIENT_ID、 AZURE_TENANT_ID和 AZURE_CLIENT_SECRET。

5. 建立您的 DocumentAnalysisClient 實體， DefaultAzureCredential包括 ：

   const { DocumentAnalysisClient } = require("@azure/ai-form-recognizer");
   const { DefaultAzureCredential } = require("@azure/identity");
   
   const client = new DocumentAnalysisClient("<your-endpoint>", new DefaultAzureCredential());
   

如需詳細資訊， 請參閱建立和驗證用戶端。

Python

以下說明如何取得和使用 適用於 Python 應用程式的 DefaultAzureCredential 。

1. 安裝適用於 Python 的 Azure 身分識別連結庫：

   pip install azure-identity
   

2. 註冊 Microsoft Entra 應用程式並建立新的服務主體。

3. 將 Cognitive Services User 角色指派給服務主體，以授與對文件智慧的存取權。

4. 將 Microsoft Entra 應用程式的用戶端識別碼、租使用者識別碼和客戶端密碼的值分別設定為環境變數： AZURE_CLIENT_ID、 AZURE_TENANT_ID和 AZURE_CLIENT_SECRET。

5. 建立您的 DocumentAnalysisClient 實體， DefaultAzureCredential包括 ：

   from azure.identity import DefaultAzureCredential
   from azure.ai.formrecognizer import DocumentAnalysisClient
   
   credential = DefaultAzureCredential()
   document_analysis_client = DocumentAnalysisClient(
       endpoint="https://<my-custom-subdomain>.cognitiveservices.azure.com/",
       credential=credential
   )
   

如需詳細資訊， 請參閱驗證用戶端

4.建置您的應用程式

建立用戶端物件以與文件智慧 SDK 互動，然後在該用戶端物件上呼叫與服務互動的方法。 SDK 同時提供同步和異步方法。 如需深入解析，請嘗試 以您選擇的語言進行快速入門 。

說明選項

Microsoft Q&A 和 Stack Overflow 論壇可供開發人員社群詢問和回答有關 Azure AI 檔智慧和其他服務的問題。 Microsoft 會監視論壇，並回復社群尚未回答的問題。 若要確定我們看到您的問題，請使用標記 azure-form-recognizer。

下一步

探索文件智慧 REST API v3.0

試用文件智慧快速入門