SDK 目标：REST API 2022–08–31 v3.0

REST API 版本 2022–08–31 v3.0

重要

• 文档智能 REST API 2022-08-31 v3.0 于 2029 年 3 月 30 日终止支持。
• 若要避免生产中断，请立即迁移到 Azure Document Intelligence 2024-11-30 v4.0。 有关详细信息，请参阅 文档智能迁移指南。

Azure Foundry Tools 中的文档智能是一项云服务，它使用机器学习来分析文档中的文本和结构化数据。 Document Intelligence 软件开发工具包（SDK）是一组库和工具，可用于轻松地将文档智能模型和功能集成到应用程序中。 文档智能 SDK 在 C#/.NET、Java、JavaScript 和 Python 编程语言中跨平台提供。

支持的编程语言

文档智能 SDK 支持以下语言和平台：

语言→文档智能 SDK 版本	软件包	支持的 API 版本	平台支持
.NET/C# → 4.0.0 (GA)	NuGet	v3.0	Windows、macOS、Linux、Docker
Java → 4.0.6 (GA)	Maven 存储库	v3.0	Windows、macOS、Linux
JavaScript → 4.0.0 (GA)	Npm	v3.0	Browser、Windows、macOS、Linux
Python → 3.2.0 (GA)	PyPI	v3.0	Windows、macOS、Linux

有关其他 SDK 版本的详细信息，请参阅：

• 2023-07-31 v3.1 （正式版）

• v2.1 （GA）

支持的客户端

语言	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.设置身份验证

身份验证有两种支持的方法：

• 通过 azure.core.credentials 将 文档智能 API 密钥 与 AzureKeyCredential 配合使用。

• 使用 azure-identity 的 token 凭据通过 Microsoft Entra ID 进行身份验证。

使用 API 密钥

下面是在 Azure 门户中查找文档智能 API 密钥的位置：

重要

我们推荐使用 Microsoft Entra ID 身份验证以及 Azure 资源的托管标识，以避免将凭据存储在云中运行的应用程序里。

如果使用 API 密钥，请安全地将其存储在其他位置，例如Azure 密钥保管库。 不要直接在代码中包括 API 密钥，并且从不公开发布。

有关 AI 服务安全性的详细信息，请参阅 验证对 Azure AI 服务的请求。

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

下面介绍如何获取和使用 DefaultAzureCredential for .NET 应用程序：

1. 安装 用于 .NET 的 Azure 标识库。

       dotnet add package Azure.Identity
   

       Install-Package Azure.Identity
   

2. 注册Microsoft Entra应用程序并创建新的服务主体。

3. 通过向服务主体分配 Cognitive Services User 角色授予对文档智能的访问权限。

4. 将Microsoft Entra应用程序中客户端 ID、租户 ID 和客户端机密的值分别设置为环境变量：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应用程序的客户端 ID、租户 ID 和客户端机密的值分别设置为环境变量：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应用程序的客户端 ID、租户 ID 和客户端机密的值分别设置为环境变量：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应用程序的客户端 ID、租户 ID 和客户端机密的值分别设置为环境变量：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 问答A 和 Stack Overflow 论坛可供开发人员社区询问和回答有关Azure文档智能和其他服务的问题。 Microsoft监视论坛，并回答社区尚未回答的问题。 若要确保我们看到您的问题，请使用 azure-form-recognizer 标记它。

后续步骤

探索文档智能 REST API v3.0

尝试文档智能快速入门