Примечание.
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
🟩 Версия REST API 2023-07-31 (GA)
Аналитика документов Azure в средстве Foundry — это облачная служба, использующая машинное обучение для анализа текста и структурированных данных из документов. Пакет средств разработки программного обеспечения для аналитики документов (SDK) — это набор библиотек и инструментов, которые позволяют легко интегрировать модели и возможности аналитики документов в приложения. Пакет SDK для аналитики документов доступен на разных платформах на языках программирования C#/.NET, Java, JavaScript и Python.
Поддерживаемые языки программирования
Пакет SDK для аналитики документов поддерживает следующие языки и платформы:
| Язык → версия SDK для анализа документов | Пакет | Поддерживаемая версия API | Поддержка платформы |
|---|---|---|---|
.NET/C# → latest (GA) |
NuGet | 2023-07-31 (GA) | |
Java → latest (GA) |
Репозиторий Maven | 2023-07-31 (GA) | Windows, macOS, Linux |
JavaScript → latest (GA) |
npm | 2023-07-31 (GA) | Браузер, Windows, macOS, Linux |
Python → latest (GA) |
PyPI | 2023-07-31 (GA) | Windows, macOS, Linux |
Дополнительные сведения о других версиях пакета SDK см. в следующих статье:
Поддерживаемые клиенты
В следующих таблицах представлена корреляция между каждой версией пакета SDK поддерживаемыми версиями API службы аналитики документов.
| Язык | Версия пакета SDK | Версия API (по умолчанию) | Поддерживаемые клиенты |
|---|---|---|---|
| .NET/C# 4.1.0 | последняя версия 3.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 | Версия 2.1 | Версия 2.1 |
FormRecognizerClient FormTrainingClient |
| .NET/C# 3.0.x | Версия 2.0 | Версия 2.0 |
FormRecognizerClient FormTrainingClient |
Использование пакета SDK аналитики документов в приложениях
Пакет SDK для аналитики документов позволяет использовать и управлять службой аналитики документов в приложении. Пакет SDK основан на базовом REST API аналитики документов, что позволяет легко использовать эти API в парадигме языка программирования. Вот как вы используете пакет SDK для аналитики документов для предпочитаемого языка:
1. Установите клиентскую библиотеку.
dotnet add package Azure.AI.FormRecognizer --version 4.1.0
Install-Package Azure.AI.FormRecognizer -Version 4.1.0
2. Импортируйте клиентскую библиотеку пакета SDK в приложение.
using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;
3. Настройте проверку подлинности.
Существует два поддерживаемых метода проверки подлинности:
Используйте ключ API аналитики документов с AzureKeyCredential из azure.core.credentials.
Используйте учетные данные токена из azure-identity для аутентификации в Microsoft Entra ID.
Использование ключа API
Вот где можно найти ключ API Document Intelligence в портале Azure:
Внимание
Мы рекомендуем использовать проверку подлинности с помощью Microsoft Entra ID и управляемые удостоверения для ресурсов 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.
Установите библиотеку Azure Identity для .NET:
dotnet add package Azure.IdentityInstall-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());
Дополнительные сведения см. в разделе"Проверка подлинности клиента".
4. Выполните сборку приложения.
Создайте клиентский объект для взаимодействия с пакетом SDK для Аналитики документов, а затем вызовите методы для этого клиентского объекта для взаимодействия со службой. Пакеты SDK предоставляют синхронные и асинхронные методы. Чтобы получить более полное представление, попробуйте руководство по быстрому началу на выбранном вами языке.
Варианты справки
Форумы azure-form-recognizer.
Следующие шаги
Изучите операции REST API Document Intelligence 2023-07-31.