Цель пакета SDK: REST API версии 2.1 (GA)

REST API версии 2.1 (GA) 21-06-08

Azure AI Document Intelligence — это облачная служба, которая использует машинное обучение для анализа текста и структурированных данных из документов. Пакет средств разработки программного обеспечения для аналитики документов (SDK) — это набор библиотек и инструментов, которые позволяют легко интегрировать модели и возможности аналитики документов в приложения. Пакет SDK для аналитики документов доступен на разных платформах на языках программирования C#/.NET, Java, JavaScript и Python.

Поддерживаемые языки программирования

Пакет SDK для аналитики документов поддерживает следующие языки и платформы:

Версия пакета SDK для аналитики документов для языка →	Пакет	Поддерживаемая версия API	Поддержка платформы
.NET/C# → 3.1.x (GA)	NuGet	Версия 2.1	Windows, macOS, Linux, Docker
Java → 3.1.x (GA)	Репозиторий Maven	Версия 2.1	Windows, macOS, Linux
JavaScript → 3.1.0 (GA)	npm	Версия 2.1	Браузер, Windows, macOS, Linux
Python → 3.1.0 (GA)	PyPI	Версия 2.1
Windows, macOS, Linux

Дополнительные сведения о других версиях пакета SDK см. в следующих статье:

• 2024-02-29 (предварительная версия)
• 2023-07-31 v3.1 (GA)
• 2022-08-31 v3.0 (GA)

Поддерживаемые клиенты

Язык	Версия пакета SDK	Версия API	Поддерживаемые клиенты
JavaScript javaScript для .NET/C#	3.1.x	v2.1 (по умолчанию) v2.0	FormRecognizerClient FormTrainingClient
JavaScript javaScript для .NET/C#	3.0.x	Версия 2.0	FormRecognizerClient FormTrainingClient
Python	3.1.x	v2.1 (по умолчанию) v2.0	FormRecognizerClient FormTrainingClient
Python	3.0.0	Версия 2.0	FormRecognizerClient FormTrainingClient

Использование пакета SDK аналитики документов в приложениях

Пакет SDK для аналитики документов позволяет использовать и управлять службой аналитики документов в приложении. Пакет SDK основан на базовом REST API аналитики документов, что позволяет легко использовать эти API в парадигме языка программирования. Вот как вы используете пакет SDK для аналитики документов для предпочитаемого языка:

1. Установите клиентскую библиотеку.

C#/.NET

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

Install-Package Azure.AI.FormRecognizer -Version 3.1.0

Java

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

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

JavaScript

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

Python

pip install azure-ai-formrecognizer==3.1.0

2. Импортируйте клиентскую библиотеку пакета SDK в приложение.

C#/.NET

using Azure;
using Azure.AI.FormRecognizer.Models;

Java

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

import com.azure.core.credential.AzureKeyCredential;

JavaScript

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

Python

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

3. Настройте проверку подлинности.

Существует два поддерживаемых метода проверки подлинности.

• Используйте ключ API аналитики документов с AzureKeyCredential из azure.core.credentials.

• Используйте учетные данные маркера из azure-identity для проверки подлинности с помощью идентификатора Microsoft Entra.

Использование ключа API

Вот где найти ключ API аналитики документов в портал Azure:

Внимание

Мы рекомендуем использовать проверку подлинности Идентификатора Microsoft Entra с управляемыми удостоверениями для ресурсов Azure, чтобы избежать хранения учетных данных с приложениями, работающими в облаке.

Если вы используете ключ API, сохраните его в другом месте, например в Azure Key Vault. Не включайте ключ API непосредственно в код и никогда не публикуйте его.

Дополнительные сведения о безопасности служб ИИ см. в статье "Проверка подлинности запросов к службам ИИ Azure".

C#/.NET

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

Java

// create your `FormRecognizerClient` instance and `AzureKeyCredential` variable
FormRecognizerClient formRecognizerClient = new FormRecognizerClientBuilder()
     .credential(new AzureKeyCredential("<your-key>"))
     .endpoint("<your-endpoint>")
     .buildClient();

JavaScript

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

Python

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

Использование учетных данных маркера Microsoft Entra

Примечание.

Региональные конечные точки не поддерживают проверку подлинности Microsoft Entra. Создайте пользовательский поддомен для ресурса, чтобы применять этот тип проверки подлинности.

Авторизоваться проще всего с помощью DefaultAzureCredential. Этот способ предоставляет учетные данные маркера по умолчанию на основе работающей среды, способной обрабатывать большинство сценариев проверки подлинности Azure.

C#/.NET

Ниже указано, как получить и использовать DefaultAzureCredential для приложений .NET.

1. Установите библиотеку удостоверений Azure для .NET:

       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. Создайте экземпляр FormRecognizerClient, включив DefaultAzureCredential:

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

Дополнительные сведения см. в разделе "Проверка подлинности клиента".

Java

Ниже указано, как получить и использовать DefaultAzureCredential для приложений Java.

1. Установите библиотеку удостоверений Azure для Java:

   <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. Создайте экземпляр FormRecognizerClient и переменную TokenCredential:

   TokenCredential credential = new DefaultAzureCredentialBuilder().build();
   FormRecognizerClient formRecognizerClient = new FormRecognizerClientBuilder()
       .endpoint("{your-endpoint}")
       .credential(credential)
       .buildClient();
   

Дополнительные сведения см. в разделе "Проверка подлинности клиента".

JavaScript

Ниже указано, как получить и использовать DefaultAzureCredential для приложений JavaScript.

1. Установите библиотеку удостоверений Azure для JavaScript:

   npm install @azure/identity
   

2. Зарегистрируйте приложение Microsoft Entra и создайте новый субъект-службу.

3. Предоставьте доступ к аналитике документов, назначив Cognitive Services User роль субъекту-службе.

4. Задайте значения идентификатора клиента, идентификатора клиента и секрета клиента приложения Microsoft Entra в качестве переменных среды: AZURE_CLIENT_ID, AZURE_TENANT_IDи AZURE_CLIENT_SECRETсоответственно.

5. Создайте экземпляр FormRecognizerClient, включив DefaultAzureCredential:

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

Дополнительные сведения см. в статье "Создание и проверка подлинности клиента".

Python

Ниже указано, как получить и использовать DefaultAzureCredential для приложений Python.

1. Установите библиотеку удостоверений Azure для Python.

   pip install azure-identity
   

2. Зарегистрируйте приложение Microsoft Entra и создайте новый субъект-службу.

3. Предоставьте доступ к аналитике документов, назначив Cognitive Services User роль субъекту-службе.

4. Задайте значения идентификатора клиента, идентификатора клиента и секрета клиента приложения Microsoft Entra в качестве переменных среды: AZURE_CLIENT_ID, AZURE_TENANT_IDи AZURE_CLIENT_SECRETсоответственно.

5. Создайте экземпляр FormRecognizerClient, включив DefaultAzureCredential:

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

Дополнительные сведения см. в разделе "Проверка подлинности клиента".

4. Выполните сборку приложения.

Создайте клиентский объект для взаимодействия с пакетом SDK для Аналитики документов, а затем вызовите методы для этого клиентского объекта для взаимодействия со службой. Пакеты SDK предоставляют синхронные и асинхронные методы. Дополнительные сведения см. в кратком руководстве по выбранному языку.

Варианты справки

Форумы Microsoft Q и Stack Overflow доступны для сообщества разработчиков, чтобы задать и ответить на вопросы об аналитике документов ИИ Azure и других службах. Корпорация Майкрософт отслеживает форумы и отвечает на вопросы, на которые сообщество пока не ответило. Чтобы убедиться, что ваш вопрос отображается, пометьте его тегом azure-form-recognizer.

Следующие шаги

Изучение REST API аналитики документов версии 2.1

Краткое руководство по анализу документов