Цель пакета SDK: REST API 2022–08–31 (GA)

! [Флажок аналитики документов].. REST API /media/yes-icon.png) версии 2022–08–31 (GA)

Azure AI 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 Браузер, Windows, macOS, Linux
Python → 3.2.0 (GA) PyPI v3.0 Windows, macOS, Linux

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

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

Язык Версия пакета SDK Версия API Поддерживаемые клиенты
JavaScript javaScript
для .NET/C#

4.0.0 (GA) v3.0:2022-08-31 (по умолчанию) DocumentAnalysisClient DocumentModelAdministrationClient
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.2.x (GA) v3.0:2022-08-31 (по умолчанию) DocumentAnalysisClient DocumentModelAdministrationClient
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. Установите клиентскую библиотеку.

dotnet add package Azure.AI.FormRecognizer --version 4.0.0
Install-Package Azure.AI.FormRecognizer -Version 4.0.0

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

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

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

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

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

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

Снимок экрана: расположение ключей и конечной точки на портале Azure.

Внимание

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

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

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


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

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

Примечание.

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

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

Ниже указано, как получить и использовать 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. Создайте экземпляр DocumentAnalysisClient, включив DefaultAzureCredential:

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

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

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

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

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

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

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