Цель пакета SDK: REST API 2024-07-31-preview

Внимание

• Выпуски общедоступной предварительной версии Document Intelligence предоставляют ранний доступ к функциям, которые находятся в активной разработке. Функции, подходы и процессы могут изменяться до общедоступной доступности на основе отзывов пользователей.
• Общедоступная предварительная версия клиентских библиотек Аналитики документов по умолчанию использует REST API версии 2024-07-31-preview.
• Общедоступная предварительная версия 2024-07-31-preview в настоящее время доступна только в следующих регионах Azure. Обратите внимание, что пользовательская модель создания (извлечение полей документов) в AI Studio доступна только в регионе "Северная часть США":
  • Восточная часть США
  • Западная часть США2
  • Западная Европа
  • Северная часть США

REST API версии 2024-07-31-preview

Azure AI Document Intelligence — это облачная служба, которая использует машинное обучение для анализа текста и структурированных данных из документов. Пакет средств разработки программного обеспечения для аналитики документов (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 (предварительная версия)	Браузер, Windows, macOS, Linux
Python → 1.0.0b4 (предварительная версия)	PyPI	2024-07-31 (предварительная версия)	Windows, macOS, Linux

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

• 2023-07-31 v3.1 (GA)
• 2022-08-31 v3.0 (GA)
• v2.1 (GA)

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

В следующих таблицах представлена корреляция между каждой версией пакета SDK поддерживаемыми версиями API службы аналитики документов.

C#/.NET

Язык	Псевдоним пакета SDK	Версия API (по умолчанию)	Поддерживаемые клиенты
.NET/C# 1.0.0-beta.2 (предварительная версия)	v4.0 (предварительная версия)	2024-07-31-preview	DocumentIntelligenceClient DocumentIntelligenceAdministrationClient
.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

Java

Язык	Псевдоним пакета SDK	Версия API (по умолчанию)	Поддерживаемые клиенты
Java 1.0.0-beta.2 (предварительная версия)	v4.0 (предварительная версия)	2024-07-31-preview	DocumentIntelligenceClient DocumentIntelligenceAdministrationClient
Java 4.1.0	последняя версия 3.1 (GA)	2023-07-31	DocumentAnalysisClient DocumentModelAdministrationClient
Java 4.0.0	v3.0 (GA)	2022-08-31	DocumentAnalysisClient DocumentModelAdministrationClient
Java 3.1.x	Версия 2.1	Версия 2.1	FormRecognizerClient FormTrainingClient
Java 3.0.x	Версия 2.0	Версия 2.0	FormRecognizerClient FormTrainingClient

JavaScript

Язык	Псевдоним пакета SDK	Версия API (по умолчанию)	Поддерживаемые клиенты
JavaScript 1.0.0-beta.2	v4.0 (предварительная версия)	2024-07-31-preview	DocumentIntelligenceClient DocumentIntelligenceAdministrationClient
JavaScript 5.0.0	последняя версия 3.1 (GA)	2023-07-31	DocumentAnalysisClient DocumentModelAdministrationClient
JavaScript 4.0.0	v3.0 (GA)	2022-08-31	DocumentAnalysisClient DocumentModelAdministrationClient
JavaScript 3.1.x	Версия 2.1	Версия 2.1	FormRecognizerClient FormTrainingClient
JavaScript 3.0.x	Версия 2.0	Версия 2.0	FormRecognizerClient FormTrainingClient

Python

Язык	Псевдоним пакета SDK	Версия API (по умолчанию)	Поддерживаемые клиенты
Python 1.0.0b2	v4.0 (предварительная версия)	2024-07-31-preview	DocumentIntelligenceClient DocumentIntelligenceAdministrationClient
Python 3.3.0	последняя версия 3.1 (GA)	2023-07-31	DocumentAnalysisClient DocumentModelAdministrationClient
Python 3.2.x	v3.0 (GA)	2022-08-31	DocumentAnalysisClient DocumentModelAdministrationClient
Python 3.1.x	Версия 2.1	Версия 2.1	FormRecognizerClient FormTrainingClient
Python 3.0.0	Версия 2.0	Версия 2.0	FormRecognizerClient FormTrainingClient

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

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

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

C#/.NET

dotnet add package Azure.AI.DocumentIntelligence --prerelease

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

Java

  <dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-ai-documentintelligence</artifactId>
    <version>1.0.0-beta.2</version>
  </dependency>

implementation("com.azure:azure-ai-documentintelligence:1.0.0-beta.4")

JavaScript

npm i @azure-rest/ai-document-intelligence version 1.0.0-beta.3

Python

pip install azure-ai-documentintelligence==1.0.0b4

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

C#/.NET

using Azure;
using Azure.AI.DocumentIntelligence;

Java

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

import com.azure.core.credential.AzureKeyCredential;

JavaScript

const { AzureKeyCredential, DocumentIntelligence } = require("@azure-rest/ai-document-intelligence@1.0.0-beta.3");

Python

from azure.ai.documentintelligence import DocumentIntelligenceClient
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 `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));

Java

// create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
DocumentIntelligenceClient documentIntelligenceClient = new DocumentIntelligenceClientBuilder()
    .credential(new AzureKeyCredential("<your-key>"))
    .endpoint("<your-endpoint>")
    .buildClient();

JavaScript

// create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
async function main() {
    const client = DocumentIntelligence(process.env["your-endpoint>"], {
  key: process.env["<your-key>"],
});

Python

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

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

   string endpoint = "<your-endpoint>";
   var client = new DocumentIntelligenceClient(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. Создайте экземпляр DocumentIntelligenceClient и переменную TokenCredential:

   TokenCredential credential = new DefaultAzureCredentialBuilder().build();
   DocumentIntelligenceClient documentIntelligenceClient = new DocumentIntelligenceClientBuilder()
       .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. Создайте экземпляр DocumentIntelligenceClient, включив DefaultAzureCredential:

   const { DocumentIntelligenceClient } = require("@azure-rest/ai-document-intelligence@1.0.0-beta.2");
   const { DefaultAzureCredential } = require("@azure/identity");
   
   const client = new DocumentIntelligenceClient("<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. Создайте экземпляр DocumentIntelligenceClient, включив DefaultAzureCredential:

   from azure.identity import DefaultAzureCredential
   from azure.ai.documentintelligence import DocumentIntelligenceClient
   
   credential = DefaultAzureCredential()
   client = DocumentIntelligenceClient(
       endpoint="<your-endpoint>",
       credential=credential
   )
   

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

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

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

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

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

• Microsoft Q&A: Azure AI Document Intelligence.

• Стек переполнения: azure-ai-document-intelligence.

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

Изучите REST API аналитики документов 2023-10-31-rest operations.