Цель пакета SDK: REST API 2022–08–31 версии 3.0

версии 2022–08–31 v3.0

Важно

REST API аналитики документов 2022-08-31 версии 3.0 достигает окончания поддержки 30 марта 2029 г.
Чтобы избежать сбоев в рабочей среде, используйте Azure Аналитика документов 2024-11-30 версии 4.0 для всех новых разработок и перенос существующих рабочих нагрузок в Azure Аналитика документов 2024-11-30 версии 4.0 до этой даты. Дополнительные сведения см. в руководстве по миграции аналитики документов.

Azure Интеллект документов в Foundry Tools — это облачная служба, использующая машинное обучение для анализа текста и структурированных данных из документов. Пакет средств разработки программного обеспечения для аналитики документов (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	Браузер, Windows, macOS, Linux
`Python → 3.2.0 (GA)`	PyPI	v3.0	Windows, macOS, Linux

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

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

Язык	Версия пакета 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 (Генеральная доступность)	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

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

Install-Package Azure.AI.FormRecognizer -Version 4.0.0

<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")

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

pip install azure-ai-formrecognizer==3.2.0

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

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

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

import com.azure.core.credential.AzureKeyCredential;

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

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

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

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

Используйте ключ API аналитики документов с AzureKeyCredential из azure.core.credentials.
Используйте учетные данные токена из azure-identity для аутентификации с помощью Microsoft Entra ID.

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

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

Снимок экрана, показывающий расположение ключей и конечной точки на портале Azure.

Важно

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

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

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


//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);


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


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


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

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

Примечание

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

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

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

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

    dotnet add package Azure.Identity

    Install-Package Azure.Identity

Регистрирование приложения Microsoft Entra и создание нового служебного объекта.
Предоставьте доступ к Интеллектуальной обработке документов, назначив Cognitive Services User роль принципалу службы.
Задайте значения идентификатора клиента, идентификатора клиента и секрета клиента в приложении Microsoft Entra в качестве переменных среды: AZURE_CLIENT_ID, AZURE_TENANT_ID и AZURE_CLIENT_SECRET соответственно.

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

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

Дополнительные сведения см. в Аутентификация клиента.

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

Установите библиотеку Azure Identity для Java:

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

Регистрирование приложения Microsoft Entra и создание нового служебного объекта.
Предоставьте доступ к Интеллектуальной обработке документов, назначив Cognitive Services User роль принципалу службы.
Задайте значения идентификатора клиента, идентификатора клиента и секрета клиента приложения Microsoft Entra в качестве переменных среды: AZURE_CLIENT_ID, AZURE_TENANT_ID и AZURE_CLIENT_SECRET соответственно.

Создайте ваш DocumentAnalysisClient экземпляр и TokenCredential переменную:

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

Дополнительные сведения см. в Аутентификация клиента.

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

Установите библиотеку Azure Identity для JavaScript:
```
npm install @azure/identity
```
Регистрирование приложения Microsoft Entra и создание нового служебного объекта.
Предоставьте доступ к Интеллектуальной обработке документов, назначив Cognitive Services User роль принципалу службы.
Задайте значения идентификатора клиента, идентификатора клиента и секрета клиента приложения Microsoft Entra в качестве переменных среды: AZURE_CLIENT_ID, AZURE_TENANT_ID и AZURE_CLIENT_SECRET соответственно.

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

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

const client = new DocumentAnalysisClient("<your-endpoint>", new DefaultAzureCredential());

Для получения дополнительной информации см. Создание и аутентификацию клиента.

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

Установите библиотеку Azure Identity для Python:
```
pip install azure-identity
```
Регистрирование приложения Microsoft Entra и создание нового служебного объекта.
Предоставьте доступ к Интеллектуальной обработке документов, назначив Cognitive Services User роль принципалу службы.
Задайте значения идентификатора клиента, идентификатора клиента и секрета клиента приложения Microsoft Entra в качестве переменных среды: AZURE_CLIENT_ID, AZURE_TENANT_ID и AZURE_CLIENT_SECRET соответственно.

Создайте экземпляр 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 аналитике документов и других службах. Microsoft отслеживает форумы и отвечает на вопросы, на которые сообщество ещё не ответило. Чтобы убедиться, что вы видите ваш вопрос, пометьте его с помощью тега azure-form-recognizer.

Дальнейшие действия

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

Попробуйте Document Intelligence: краткое руководство

Обратная связь

Были ли сведения на этой странице полезными?

Last updated on 2026-05-08

Цель пакета SDK: REST API 2022–08–31 версии 3.0

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

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

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

1. Установка клиентской библиотеки пакета SDK

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

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

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

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

4. Создание приложения

Опции справки

Дальнейшие действия

Обратная связь

Дополнительные ресурсы