Cible SDK : API REST 2023-07-31 (GA)
API REST version 2023-07-31 (GA)
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 SDK Intelligence documentaire | Package | Version de l’API prise en charge | Plateforme prise en charge |
|---|---|---|---|
| .NET/C# → dernière version (GA) | NuGet | 31-07-2023 (GA) | |
| Java → dernière version (GA) | Référentiel Maven | 31-07-2023 (GA) | Windows, macOS, Linux |
| JavaScript → dernière version (GA) | npm | 31-07-2023 (GA) | Browser, Windows, macOS, Linux |
| Python → dernière version (GA) | PyPI | 31-07-2023 (GA) | Windows, macOS, Linux |
Pour plus d’informations sur les autres versions du SDK, consultez :
Clients pris en charge
Les tableaux suivants présentent la corrélation entre chaque version du SDK et les versions d’API prises en charge du service Intelligence documentaire.
| Langue | Version du SDK | Version d’API (par défaut) | Clients pris en charge |
|---|---|---|---|
| .NET/C# 4.1.0 | version 3.1 la plus récente (GA) | 2023-07-31 | DocumentAnalysisClient DocumentModelAdministrationClient |
| .NET/C# 4.0.0 | v3.0 (GA) | 2022-08-31 | DocumentAnalysisClient DocumentModelAdministrationClient |
| .NET/C# 3.1.x | v2.1 | v2.1 | FormRecognizerClient FormTrainingClient |
| .NET/C# 3.0.x | v2.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
dotnet add package Azure.AI.FormRecognizer --version 4.1.0
Install-Package Azure.AI.FormRecognizer -Version 4.1.0
2. Importez la bibliothèque de client du SDK dans votre application
using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;
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.
//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);
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.
Pour acquérir et utiliser DefaultAzureCredential pour les applications .NET, procédez comme suit :
Installez la bibliothèque Azure Identity pour .NET :
dotnet add package Azure.IdentityInstall-Package Azure.IdentityInscrivez une application Microsoft Entra et créez un principal de service.
Accordez l’accès à Intelligence documentaire en attribuant le rôle
Cognitive Services Userà votre principal de service.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_IDetAZURE_CLIENT_SECRET.Créez votre instance
DocumentAnalysisClient, en incluantDefaultAzureCredential:string endpoint = "<your-endpoint>"; var client = new DocumentAnalysisClient(new Uri(endpoint), new DefaultAzureCredential());
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
Découvrez les opérations de l’API REST Intelligence documentaire v3.2023-07-31.