Démarrage rapide : utilisation de la bibliothèque cliente Extraction de phrases clés et de l’API REST

Article
12/19/2023

Documentation de référence | Exemples supplémentaires | Package (NuGet) | Code source de la bibliothèque

Utilisez ce guide de démarrage rapide pour créer une application d’extraction d’expressions clés avec la bibliothèque de client pour .NET. Dans l’exemple suivant, vous allez créer une application C# qui peut identifier des mots et expressions clés trouvés dans le texte.

Conseil

Vous pouvez utiliser Language Studio pour essayer les fonctionnalités du service Language sans avoir besoin d’écrire du code.

Prérequis

Abonnement Azure - En créer un gratuitement
IDE Visual Studio
Une fois que vous avez votre abonnement Azure, créez une ressource de langue dans le portail Azure pour obtenir votre clé et votre point de terminaison. À la fin du déploiement, sélectionnez Accéder à la ressource.
- Vous aurez besoin de la clé et du point de terminaison de la ressource que vous créez pour connecter votre application à l’API. Vous collerez votre clé et votre point de terminaison dans le code ci-dessous plus loin dans le guide de démarrage rapide.
- Vous pouvez utiliser le niveau tarifaire Gratuit (Free F0) pour tester le service, puis passer par la suite à un niveau payant pour la production.
Pour utiliser la fonctionnalité d’analyse, vous aurez besoin d’une ressource Language avec le niveau tarifaire Standard (S).

Configuration

Créez une application .NET Core

En utilisant l’IDE Visual Studio, créez une application console .NET Core. Cette action va créer un projet nommé « Hello World » avec un seul fichier source C# : program.cs.

Installez la bibliothèque cliente en cliquant avec le bouton droit sur la solution dans l’Explorateur de solutions et en sélectionnant Gérer les packages NuGet. Dans le gestionnaire de package qui s’ouvre, sélectionnez Parcourir et recherchez Azure.AI.TextAnalytics. Sélectionnez la version 5.2.0, puis Installer. Vous pouvez aussi utiliser la Console du Gestionnaire de package.

Exemple de code

Copiez le code suivant dans votre fichier program.cs. N’oubliez pas de remplacer la variable key par la clé de votre ressource et la variable endpoint par le point de terminaison de votre ressource. Exécutez ensuite le code.

Important

Accédez au portail Azure. Si la ressource Language que vous avez créée dans la section Prérequis a été déployée correctement, cliquez sur le bouton Accéder à la ressource sous Étapes suivantes. Pour trouver la clé et le point de terminaison, accédez à la page Clés et point de terminaison de votre ressource sous Gestion des ressources.

Important

N’oubliez pas de supprimer la clé de votre code une fois que vous avez terminé, et ne la postez jamais publiquement. Pour la production, utilisez un moyen sécurisé de stocker et d’accéder à vos informations d’identification comme Azure Key Vault. Pour plus d’informations, consultez l’article sur la sécurité d’Azure AI services.

using Azure;
using System;
using Azure.AI.TextAnalytics;

namespace KeyPhraseExtractionExample
{
    class Program
    {
        private static readonly AzureKeyCredential credentials = new AzureKeyCredential("replace-with-your-key-here");
        private static readonly Uri endpoint = new Uri("replace-with-your-endpoint-here");

        // Example method for extracting key phrases from text
        static void KeyPhraseExtractionExample(TextAnalyticsClient client)
        {
            var response = client.ExtractKeyPhrases(@"Dr. Smith has a very modern medical office, and she has great staff.");

            // Printing key phrases
            Console.WriteLine("Key phrases:");

            foreach (string keyphrase in response.Value)
            {
                Console.WriteLine($"\t{keyphrase}");
            }
        }

        static void Main(string[] args)
        {
            var client = new TextAnalyticsClient(endpoint, credentials);
            KeyPhraseExtractionExample(client);

            Console.Write("Press any key to exit.");
            Console.ReadKey();
        }

    }
}

Sortie

Key phrases:
    modern medical office
    Dr. Smith
    great staff

Documentation de référence | Exemples supplémentaires | Package (Maven) | Code source de la bibliothèque

Utilisez ce guide de démarrage rapide pour créer une application d’extraction d’expressions clés avec la bibliothèque de client pour Java. Dans l’exemple suivant, vous allez créer une application Java qui peut identifier des mots et expressions clés trouvés dans le texte.

Conseil

Vous pouvez utiliser Language Studio pour essayer les fonctionnalités du service Language sans avoir besoin d’écrire du code.

Prérequis

Abonnement Azure - En créer un gratuitement
Kit de développement Java (JDK) avec version 8 ou ultérieure
Une fois que vous avez votre abonnement Azure, créez une ressource de langue dans le portail Azure pour obtenir votre clé et votre point de terminaison. À la fin du déploiement, sélectionnez Accéder à la ressource.
- Vous aurez besoin de la clé et du point de terminaison de la ressource que vous créez pour connecter votre application à l’API. Vous collerez votre clé et votre point de terminaison dans le code ci-dessous plus loin dans le guide de démarrage rapide.
- Vous pouvez utiliser le niveau tarifaire Gratuit (Free F0) pour tester le service, puis passer par la suite à un niveau payant pour la production.
Pour utiliser la fonctionnalité d’analyse, vous aurez besoin d’une ressource Language avec le niveau tarifaire Standard (S).

Configuration

Ajouter la bibliothèque de client

Créez un projet Maven dans l’IDE ou l’environnement de développement de votre choix. Ensuite, ajoutez la dépendance suivante au fichier pom.xml de votre projet : Vous trouverez la syntaxe d’implémentation pour d’autres outils de génération en ligne.

<dependencies>
     <dependency>
        <groupId>com.azure</groupId>
        <artifactId>azure-ai-textanalytics</artifactId>
        <version>5.2.0</version>
    </dependency>
</dependencies>

Exemple de code

Créez un fichier Java nommé Example.java. Ouvrez le fichier et copiez le code ci-dessous. N’oubliez pas de remplacer la variable key par la clé de votre ressource et la variable endpoint par le point de terminaison de votre ressource. Exécutez ensuite le code.

Important

import com.azure.core.credential.AzureKeyCredential;
import com.azure.ai.textanalytics.TextAnalyticsClientBuilder;
import com.azure.ai.textanalytics.TextAnalyticsClient;


public class Example {

    private static String KEY = "replace-with-your-key-here";
    private static String ENDPOINT = "replace-with-your-endpoint-here";

    public static void main(String[] args) {
        TextAnalyticsClient client = authenticateClient(KEY, ENDPOINT);
        extractKeyPhrasesExample(client);
    }
    // Method to authenticate the client object with your key and endpoint
    static TextAnalyticsClient authenticateClient(String key, String endpoint) {
        return new TextAnalyticsClientBuilder()
                .credential(new AzureKeyCredential(key))
                .endpoint(endpoint)
                .buildClient();
    }
    // Example method for extracting key phrases from text
    static void extractKeyPhrasesExample(TextAnalyticsClient client)
    {
        // The text to be analyzed
        String text = "Dr. Smith has a very modern medical office, and she has great staff.";

        System.out.printf("Recognized phrases: %n");
        for (String keyPhrase : client.extractKeyPhrases(text)) {
            System.out.printf("%s%n", keyPhrase);
        }
    }
}

Sortie

Recognized phrases: 

modern medical office
Dr. Smith
great staff

Documentation de référence | Exemples supplémentaires | Package (npm) | Code source de la bibliothèque

Utilisez ce guide de démarrage rapide pour créer une application d’extraction d’expressions clés avec la bibliothèque de client pour Node.js. Dans l’exemple suivant, vous allez créer une application JavaScript qui peut identifier des mots et expressions clés trouvés dans le texte.

Conseil

Vous pouvez utiliser Language Studio pour essayer les fonctionnalités du service Language sans avoir besoin d’écrire du code.

Prérequis

Abonnement Azure - En créer un gratuitement
Node.js v14 LTS ou version ultérieure
Une fois que vous avez votre abonnement Azure, créez une ressource de langue dans le portail Azure pour obtenir votre clé et votre point de terminaison. À la fin du déploiement, sélectionnez Accéder à la ressource.
- Vous aurez besoin de la clé et du point de terminaison de la ressource que vous créez pour connecter votre application à l’API. Vous collerez votre clé et votre point de terminaison dans le code ci-dessous plus loin dans le guide de démarrage rapide.
- Vous pouvez utiliser le niveau tarifaire Gratuit (Free F0) pour tester le service, puis passer par la suite à un niveau payant pour la production.
Pour utiliser la fonctionnalité d’analyse, vous aurez besoin d’une ressource Language avec le niveau tarifaire Standard (S).

Configuration

Création d’une application Node.js

Dans une fenêtre de console (telle que cmd, PowerShell ou bash), créez un répertoire pour votre application et accédez-y.

mkdir myapp 

cd myapp

Exécutez la commande npm init pour créer une application de nœud avec un fichier package.json.

npm init

Installer la bibliothèque de client

Installez le package npm :

npm install @azure/ai-language-text

Exemple de code

Ouvrez le fichier et copiez le code ci-dessous. N’oubliez pas de remplacer la variable key par la clé de votre ressource et la variable endpoint par le point de terminaison de votre ressource. Exécutez ensuite le code.

Important

"use strict";

const { TextAnalysisClient, AzureKeyCredential } = require("@azure/ai-language-text");
const key = '<paste-your-key-here>';
const endpoint = '<paste-your-endpoint-here>';

//example sentence for performing key phrase extraction
const documents = ["Dr. Smith has a very modern medical office, and she has great staff."];

//example of how to use the client to perform entity linking on a document
async function main() {
    console.log("== key phrase extraction sample ==");
  
    const client = new TextAnalysisClient(endpoint, new AzureKeyCredential(key));
  
    const results = await client.analyze("KeyPhraseExtraction", documents);
  
    for (const result of results) {
      console.log(`- Document ${result.id}`);
      if (!result.error) {
        console.log("\tKey phrases:");
        for (const phrase of result.keyPhrases) {
          console.log(`\t- ${phrase}`);
        }
      } else {
        console.error("  Error:", result.error);
      }
    }
  }
  
  main().catch((err) => {
    console.error("The sample encountered an error:", err);
  });

Sortie

== key phrase extraction sample ==
- Document 0
    Key phrases:
    - modern medical office
    - Dr. Smith
    - great staff

Documentation de référence | Exemples supplémentaires | Package (PyPi) | Code source de la bibliothèque

Utilisez ce guide de démarrage rapide pour créer une application d’extraction d’expressions clés avec la bibliothèque de client pour Python. Dans l’exemple suivant, vous allez créer une application Python qui peut identifier des mots et expressions clés trouvés dans le texte.

Conseil

Vous pouvez utiliser Language Studio pour essayer les fonctionnalités du service Language sans avoir besoin d’écrire du code.

Prérequis

Abonnement Azure - En créer un gratuitement
Python 3.8 ou version ultérieure
Une fois que vous avez votre abonnement Azure, créez une ressource de langue dans le portail Azure pour obtenir votre clé et votre point de terminaison. À la fin du déploiement, sélectionnez Accéder à la ressource.
- Vous aurez besoin de la clé et du point de terminaison de la ressource que vous créez pour connecter votre application à l’API. Vous collerez votre clé et votre point de terminaison dans le code ci-dessous plus loin dans le guide de démarrage rapide.
- Vous pouvez utiliser le niveau tarifaire Gratuit (Free F0) pour tester le service, puis passer par la suite à un niveau payant pour la production.
Pour utiliser la fonctionnalité d’analyse, vous aurez besoin d’une ressource Language avec le niveau tarifaire Standard (S).

Configuration

Installer la bibliothèque de client

Après avoir installé Python, vous pouvez installer la bibliothèque de client avec :

pip install azure-ai-textanalytics==5.2.0

Exemple de code

Créez un fichier Python et copiez le code ci-dessous. N’oubliez pas de remplacer la variable key par la clé de votre ressource et la variable endpoint par le point de terminaison de votre ressource. Exécutez ensuite le code.

Important

key = "paste-your-key-here"
endpoint = "paste-your-endpoint-here"

from azure.ai.textanalytics import TextAnalyticsClient
from azure.core.credentials import AzureKeyCredential

# Authenticate the client using your key and endpoint 
def authenticate_client():
    ta_credential = AzureKeyCredential(key)
    text_analytics_client = TextAnalyticsClient(
            endpoint=endpoint, 
            credential=ta_credential)
    return text_analytics_client

client = authenticate_client()

def key_phrase_extraction_example(client):

    try:
        documents = ["Dr. Smith has a very modern medical office, and she has great staff."]

        response = client.extract_key_phrases(documents = documents)[0]

        if not response.is_error:
            print("\tKey Phrases:")
            for phrase in response.key_phrases:
                print("\t\t", phrase)
        else:
            print(response.id, response.error)

    except Exception as err:
        print("Encountered exception. {}".format(err))
        
key_phrase_extraction_example(client)

Sortie

Key Phrases:
    modern medical office
    Dr. Smith
    great staff

Documentation de référence

Utilisez ce guide de démarrage rapide pour envoyer des requêtes d’extraction d’expressions clés à l’aide de l’API REST. Dans l’exemple suivant, vous allez utiliser cURL pour identifier des mots et expressions clés trouvés dans le texte.

Conseil

Vous pouvez utiliser Language Studio pour essayer les fonctionnalités du service Language sans avoir besoin d’écrire du code.

Prérequis

Abonnement Azure - En créer un gratuitement
Version actuelle de cURL.
Une fois que vous avez votre abonnement Azure, créez une ressource de langue dans le portail Azure pour obtenir votre clé et votre point de terminaison. À la fin du déploiement, sélectionnez Accéder à la ressource.
- Vous aurez besoin de la clé et du point de terminaison de la ressource que vous créez pour connecter votre application à l’API. Vous collerez votre clé et votre point de terminaison dans le code ci-dessous plus loin dans le guide de démarrage rapide.
- Vous pouvez utiliser le niveau tarifaire Gratuit (Free F0) pour tester le service, puis passer par la suite à un niveau payant pour la production.

Notes

Les exemples BASH suivants utilisent le caractère de continuation de ligne \. Si votre console ou terminal utilise un caractère de continuation de ligne différent, utilisez ce caractère.
Vous trouverez des exemples propres aux différents langages sur GitHub.
Accédez au portail Azure, puis recherchez la clé et le point de terminaison de la ressource Language que vous avez créés à l’étape des prérequis. Ces informations se trouvent dans la page sur la clé et le point de terminaison de la ressource, sous gestion des ressources. Remplacez ensuite les chaînes dans le code ci-dessous par votre clé et votre point de terminaison. Pour appeler l’API, vous avez besoin des informations suivantes :

paramètre	Description
`-X POST <endpoint>`	Spécifie votre point de terminaison pour accéder à l’API.
`-H Content-Type: application/json`	Type de contenu pour l’envoi de données JSON.
`-H "Ocp-Apim-Subscription-Key:<key>`	Spécifie la clé pour accéder à l’API.
`-d <documents>`	Code JSON contenant les documents que vous souhaitez envoyer.

Les commandes cURL suivantes sont exécutées à partir d’un interpréteur de commandes bash. Modifiez ces commandes avec vos propres nom de ressource, clé de ressource et valeurs JSON.

Extraction de phrases clés

Copiez la commande dans un éditeur de texte.
Modifiez la commande comme ci-dessous :
1. Remplacez la valeur <your-language-resource-key> par votre propre clé.
2. Remplacez la première partie de l’URL de la requête <your-language-resource-endpoint> par votre propre URL de point de terminaison.
Ouvrir une fenêtre d’invite de commandes.
Collez la commande à partir de l’éditeur de texte dans la fenêtre d’invite de commandes, puis exécutez la commande.

curl -i -X POST https://<your-language-resource-endpoint>/language/:analyze-text?api-version=2022-05-01 \
-H "Content-Type: application/json" \
-H "Ocp-Apim-Subscription-Key: <your-language-resource-key>" \
-d \
'
{
    "kind": "KeyPhraseExtraction",
    "parameters": {
        "modelVersion": "latest"
    },
    "analysisInput":{
        "documents":[
            {
                "id":"1",
                "language":"en",
                "text": "Dr. Smith has a very modern medical office, and she has great staff."
            }
        ]
    }
}
'

Réponse JSON

{
	"kind": "KeyPhraseExtractionResults",
	"results": {
		"documents": [{
			"id": "1",
			"keyPhrases": ["modern medical office", "Dr. Smith", "great staff"],
			"warnings": []
		}],
		"errors": [],
		"modelVersion": "2021-06-01"
	}
}

Nettoyer les ressources

Si vous souhaitez nettoyer et supprimer un abonnement Azure AI services, vous pouvez supprimer la ressource ou le groupe de ressources. La suppression du groupe de ressources efface également les autres ressources qui y sont associées.

Étapes suivantes

Présentation de l’extraction de phrases clés

Démarrage rapide : utilisation de la bibliothèque cliente Extraction de phrases clés et de l’API REST

Prérequis

Configuration

Créez une application .NET Core

Exemple de code

Sortie

Prérequis

Configuration

Ajouter la bibliothèque de client

Exemple de code

Sortie

Prérequis

Configuration

Création d’une application Node.js

Installer la bibliothèque de client

Exemple de code

Sortie

Prérequis

Configuration

Installer la bibliothèque de client

Exemple de code

Sortie

Prérequis

Extraction de phrases clés

Réponse JSON

Nettoyer les ressources

Étapes suivantes

Ressources supplémentaires