Cible du SDK : API REST v2.1 (disponibilité générale)

API REST version 2.1 (disponibilité générale) 21-06-08

Intelligence documentaire Azure AI est un service cloud qui utilise le Machine Learning pour analyser le texte et les données structurées des documents. Le Kit de développement logiciel (SDK) Intelligence documentaire est un ensemble de bibliothèques et d’outils qui vous permettent d’intégrer facilement les modèles et fonctionnalités d’Intelligence documentaire dans vos applications. Le SDK Intelligence documentaire est disponible sur toutes les plateformes dans les langages de programmation C#/.NET, Java, JavaScript et Python.

Langages de programmation pris en charge

Le SDK Intelligence documentaire prend en charge les langages et plateformes suivantes :

Langage → version du KIT DE développement logiciel (SDK) Intelligence documentaire	Package	Version de l’API prise en charge	Plateforme prise en charge
.NET/C# → 3.1.x (disponibilité générale)	NuGet	v2.1	Windows, macOS, Linux, Docker
Java → 3.1.x (disponibilité générale)	Référentiel Maven	v2.1	Windows, macOS, Linux
JavaScript → 3.1.0 (disponibilité générale)	npm	v2.1	Browser, Windows, macOS, Linux
Python → 3.1.0 (disponibilité générale)	PyPI	v2.1
Windows, macOS, Linux

Pour plus d’informations sur les autres versions du SDK, consultez :

• 2024-02-29 (préversion)
• 2023-07-31 v3.1 (GA)
• 2022-08-31 v3.0 (GA)

Clients pris en charge

Langage	Version du SDK	Version de l'API	Clients pris en charge
.NET/C# Java JavaScript	3.1.x	v2.1 (par défaut) v2.0	FormRecognizerClient FormTrainingClient
.NET/C# Java JavaScript	3.0.x	v2.0	FormRecognizerClient FormTrainingClient
Python	3.1.x	v2.1 (par défaut) v2.0	FormRecognizerClient FormTrainingClient
Python	3.0.0	v2.0	FormRecognizerClient FormTrainingClient

Utiliser le SDK Intelligence documentaire dans vos applications

Le Kit de développement logiciel (SDK) Intelligence documentaire permet l’utilisation et la gestion du service Intelligence documentaire dans votre application. Le SDK s’appuie sur l’API REST sous-jacente d’Intelligence documentaire, ce qui vous permet d’utiliser facilement ces API dans le paradigme de votre langage de programmation. Procédez comme suit pour utiliser le SDK Intelligence documentaire dans votre langage préféré :

1. Installez la bibliothèque de client du SDK

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. Importez la bibliothèque de client du SDK dans votre application

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. Configurez l’authentification

Deux méthodes sont prises en charge pour l’authentification.

• Utilisez une clé API Intelligence documentaire avec AzureKeyCredential à partir d’azure.core.credentials.

• Utilisez des informations d’identification de jeton à partir d’azure-identity pour vous authentifier avec Microsoft Entra ID.

Utiliser votre clé API

Suivez les indications ci-dessous pour accéder à votre clé API Intelligence documentaire sur le portail Azure :

Important

Nous vous recommandons l’authentification Microsoft Entra ID avec les identités managées pour les ressources Azure pour éviter de stocker des informations d’identification avec vos applications qui s’exécutent dans le cloud.

Si vous utilisez une clé API, stockez-la en toute sécurité dans un autre emplacement, par exemple dans Azure Key Vault. N'incluez pas la clé API directement dans votre code et ne la diffusez jamais publiquement.

Pour plus d’informations sur la sécurité des services IA, consultez Authentifier les demandes auprès d’Azure AI services.

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

Utiliser des informations d’identification de jeton Microsoft Entra

Remarque

Les points de terminaison régionaux ne prennent pas en charge l’authentification Microsoft Entra. Créez un sous-domaine personnalisé pour votre ressource afin d’utiliser ce type d’authentification.

L’autorisation est la plus facile avec le paramètre DefaultAzureCredential. Celui-ci fournit des informations d’identification de jeton par défaut, basées sur l’environnement d’exécution et capables de gérer la plupart des scénarios d’authentification Azure.

C#/.NET

Pour acquérir et utiliser DefaultAzureCredential pour les applications .NET, procédez comme suit :

1. Installez la bibliothèque Azure Identity pour .NET :

       dotnet add package Azure.Identity
   

       Install-Package Azure.Identity
   

2. Inscrivez une application Microsoft Entra et créez un principal de service.

3. Accordez l’accès à Intelligence documentaire en attribuant le rôle Cognitive Services User à votre principal de service.

4. Définissez les valeurs de l’ID client, de l’ID locataire et de la clé secrète client de l’application Microsoft Entra en tant que variables d’environnement : respectivement AZURE_CLIENT_ID, AZURE_TENANT_ID et AZURE_CLIENT_SECRET.

5. Créez votre instance FormRecognizerClient, en incluant DefaultAzureCredential :

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

Pour plus d’informations, consultez Authentifier le client.

Java

Pour acquérir et utiliser DefaultAzureCredential pour les applications Java, procédez comme suit :

1. Installez la bibliothèque Azure Identity pour Java :

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

2. Inscrivez une application Microsoft Entra et créez un principal de service.

3. Accordez l’accès à Intelligence documentaire en attribuant le rôle Cognitive Services User à votre principal de service.

4. Définissez les valeurs de l’ID client, de l’ID de locataire et de la clé secrète client de l’application Microsoft Entra en indiquant les variables d’environnement suivantes : AZURE_CLIENT_ID, AZURE_TENANT_ID et AZURE_CLIENT_SECRET.

5. Créez votre instance FormRecognizerClient et la variable TokenCredential :

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

Pour plus d’informations, consultez Authentifier le client.

JavaScript

Pour acquérir et utiliser DefaultAzureCredential pour les applications JavaScript, procédez comme suit :

1. Installez la bibliothèque Azure Identity pour JavaScript :

   npm install @azure/identity
   

2. Inscrivez une application Microsoft Entra et créez un principal de service.

3. Accordez l’accès à Intelligence documentaire en attribuant le rôle Cognitive Services User à votre principal de service.

4. Définissez les valeurs de l’ID client, de l’ID de locataire et de la clé secrète client de l’application Microsoft Entra en indiquant les variables d’environnement suivantes : AZURE_CLIENT_ID, AZURE_TENANT_ID et AZURE_CLIENT_SECRET.

5. Créez votre instance FormRecognizerClient, en incluant DefaultAzureCredential :

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

Pour plus d’informations, consultez Créer et authentifier un client.

Python

Pour acquérir et utiliser DefaultAzureCredential pour les applications Python, procédez comme suit :

1. Installez la bibliothèque Azure Identity pour Python :

   pip install azure-identity
   

2. Inscrivez une application Microsoft Entra et créez un principal de service.

3. Accordez l’accès à Intelligence documentaire en attribuant le rôle Cognitive Services User à votre principal de service.

4. Définissez les valeurs de l’ID client, de l’ID de locataire et de la clé secrète client de l’application Microsoft Entra en indiquant les variables d’environnement suivantes : AZURE_CLIENT_ID, AZURE_TENANT_ID et AZURE_CLIENT_SECRET.

5. Créez votre instance FormRecognizerClient, en incluant 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
   )
   

Pour plus d’informations, consultez Authentifier le client.

4. Générez votre application

Créez un objet client pour interagir avec le kit de développement logiciel (SDK) Intelligence documentaire, puis appeler des méthodes sur cet objet client pour interagir avec le service. Les SDK fournissent des méthodes synchrones et asynchrones. Pour plus d’informations, consultez un guide de démarrage rapide dans le langage de votre choix.

Options d’aide

Les forums Microsoft Q&A et Stack Overflow sont à la disposition de la communauté des développeurs pour poser des questions sur Azure AI Intelligence documentaire et sur d’autres services, et y répondre. Microsoft surveille les forums et répond aux questions auxquelles la communauté n’a pas encore répondu. Pour nous permettre de voir votre question, attribuez-lui l’étiquette azure-form-recognizer.

Étapes suivantes

Explorer l’API REST Intelligence documentaire v2.1

Essayer un guide de démarrage rapide Intelligence documentaire