Partage via

Cible du Kit de développement logiciel (SDK) : API REST 2024-02-29-preview

  • Article

Important

  • Les mises en production de préversion publique Document Intelligence fournissent un accès anticipé aux fonctionnalités en cours de développement actif.
  • Les fonctionnalités, approches et processus peuvent changer, avant la disponibilité générale (GA), en fonction des commentaires des utilisateurs.
  • La version d'aperçu publique des bibliothèques clientes Document Intelligence est par défaut la version 2024-02-29-preview de l'API REST.
  • La version d’évaluation publique 2024-02-29-preview est actuellement disponible uniquement dans les régions Azure suivantes :
  • USA Est
  • USA Ouest 2
  • Europe Ouest

Coche Intelligence documentaireVersion API REST 2024-02-29-preview

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# → 1.0.0-beta.2 (préversion) NuGet 2024-02-29 (préversion) Windows, macOS, Linux, Docker
Java → 1.0.0-beta.2 (préversion) Référentiel Maven 2024-02-29 (préversion) Windows, macOS, Linux
JavaScript → 1.0.0-beta.2 (préversion) npm 2024-02-29 (préversion) Browser, Windows, macOS, Linux
Python → 1.0.0b2 (préversion) PyPI 2024-02-29 (préversion) 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.

Langage Alias du kit de développement logiciel (SDK) Version d’API (par défaut) Clients pris en charge
.NET/C# → 1.0.0-beta.2 (préversion) v4.0 (préversion) 2024-02-29-preview DocumentIntelligenceClient
DocumentIntelligenceAdministrationClient
.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.DocumentIntelligence --version 1.0.0-beta.2

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

2. Importez la bibliothèque de client du SDK dans votre application

using Azure;
using Azure.AI.DocumentIntelligence;

3. Configurez l’authentification

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

Utiliser votre clé API

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

Capture d’écran de l’emplacement des clés et des points de terminaison sur le portail Azure. 


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

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 :

  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 DocumentIntelligenceClient, en incluant DefaultAzureCredential :

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

Pour plus d’informations, consultezAuthentifier 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 et répondre à des questions sur Azure AI Intelligence documentaire et sur d’autres services. Microsoft surveille les forums et répond aux questions auxquelles la communauté n’a pas encore répondu. Pour vous assurer que nous voyons votre question, utilisez les balises suivantes.

  • Microsoft Q&A : Azure AI Document Intelligence.

  • Stack Overflow : azure-ai-document-intelligence.

Étapes suivantes

Découvrez les opérations de l’API REST Intelligence documentaire 2023-10-31-rest.