通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

SDK 目标：REST API 2024-07-31-preview

  • 项目

重要

  • 使用文档智能选公共预览版，可以提前使用目前正处于开发状态的功能。 在正式发布 (GA) 之前，根据用户反馈，功能、方法和流程可能会发生更改。
  • 文档智能客户端库的公共预览版默认使用 REST API 版本 2024-07-31-preview。
  • 公共预览版 2024-07-31-preview 目前仅在以下 Azure 区域中可用。 请注意，AI Studio 中的自定义生成式（文档字段提取）模型仅适用于美国中北部区域：
    • 美国东部
    • 美国西部 2
    • “西欧”
    • 美国中北部

文档智能复选标记 REST API 版本 2024-07-31-preview

Azure AI 文档智能是一种云服务，它使用机器学习从文档中分析文本和结构化数据。 文档智能软件开发工具包 (SDK) 是一组库和工具，可用于轻松地将文档智能模型和功能集成到应用程序中。 文档智能 SDK 可用于采用 C#/.NET、Java、JavaScript 和 Python 编程语言的平台。

支持的编程语言

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

语言 → 文档智能 SDK 版本 包 支持的 API 版本 平台支持
.NET/C# → 1.0.0-beta.3（预览版） NuGet 2024-07-31（预览版） Windows、macOS、Linux、Docker
Java → 1.0.0-beta.4（预览版） Maven 存储库 2024-07-31（预览版） Windows、macOS、Linux
JavaScript → 1.0.0-beta.3（预览版） npm 2024-07-31（预览版） Browser、Windows、macOS、Linux
Python → 1.0.0b4（预览版） PyPI 2024-07-31（预览版） Windows、macOS、Linux

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

支持的客户端

下表显示了每个 SDK 版本与支持的文档智能服务 API 版本之间的相关性。

语言 SDK 别名 API 版本（默认） 支持的客户端
.NET/C# 1.0.0-beta.2（预览版） v4.0（预览版） 2024-07-31-preview DocumentIntelligenceClient
DocumentIntelligenceAdministrationClient
.NET/C# 4.1.0 v3.1 最新 (GA) 2023-07-31 DocumentAnalysisClient
DocumentModelAdministrationClient
.NET/C# 4.0.0 v3.0 (GA) 2022-08-31 DocumentAnalysisClient
DocumentModelAdministrationClient
.NET/C# 3.1.x v2.1 v2.1 FormRecognizerClient
FormTrainingClient
.NET/C# 3.0.x v2.0 v2.0 FormRecognizerClient
FormTrainingClient

在应用程序中使用文档智能 SDK

借助文档智能 SDK，可以在应用程序中使用和管理文档智能服务。 SDK 基于底层文档智能 REST API，允许在编程语言范例中轻松使用这些 API。 以下介绍如何为首选语言使用文档智能 SDK：

1. 安装 SDK 客户端库

dotnet add package Azure.AI.DocumentIntelligence --prerelease

Install-Package Azure.AI.FormRecognizer -Version 1.0.0-beta.3

2. 将 SDK 客户端库导入应用程序

using Azure;
using Azure.AI.DocumentIntelligence;

3. 设置身份验证

可以使用两种受支持的身份验证方法：

使用 API 密钥

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

该屏幕截图显示了 Azure 门户中密钥和终结点的位置。

重要

我们建议使用 Azure 资源的托管标识进行 Microsoft Entra ID 身份验证，以避免将凭据随云中运行的应用程序一起存储。

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

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


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

使用 Microsoft Entra 令牌凭据

注意

区域终结点不支持 Microsoft Entra 身份验证。 为资源创建自定义子域，以使用此类身份验证。

使用 DefaultAzureCredential 是进行授权的最简单方式。 它根据运行环境提供默认令牌凭据，可处理大多数 Azure 身份验证方案。

以下是为 .NET 应用程序获取和使用 DefaultAzureCredential 的方法：

  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. 创建 DocumentIntelligenceClient 实例，包括 DefaultAzureCredential：

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

有关详细信息，请参阅对客户端进行身份验证。

4. 生成应用程序

创建客户端对象以与文档智能 SDK 交互，然后调用该客户端对象上的方法来与服务交互。 SDK 提供同步和异步方法。 有关详细信息，请使用所选语言尝试快速入门。

帮助选项

Microsoft Q&A 和 Stack Overflow 论坛可供开发人员社区提出和回答有关 Azure AI 文档智能和其他服务的问题。 Microsoft 会监视论坛并回复社区尚未回答的问题。 为保险起见，请使用以下标记，以便我们能看到你的问题。

  • Microsoft Q&A：Azure AI Document Intelligence。

  • Stack Overflow：azure-ai-document-intelligence。

后续步骤

探索文档智能 REST API 2023-10-31-rest 操作。