Démarrage rapide : liaison d’entités à l’aide de la bibliothèque de client et de l’API REST
Documentation de référence | Plus d’exemples | Package (NuGet) | Code source de la bibliothèque
Utilisez ce guide de démarrage rapide pour créer une application de liaison d’entités avec la bibliothèque de client pour .NET. Dans l’exemple suivant, vous allez créer une application C# qui peut identifier et lever l’ambiguïté des entités trouvées dans du texte.
Conseil
Vous pouvez utiliser AI Studio pour essayer le résumé sans avoir à écrire de code.
Prérequis
- Abonnement Azure - En créer un gratuitement
- IDE Visual Studio
Configuration
Créer une ressource Azure
Pour utiliser l’exemple de code ci-dessous, vous devez déployer une ressource Azure. Cette ressource contient une clé et un point de terminaison que vous utiliserez pour authentifier les appels d’API que vous envoyez au service Language.
Utilisez le lien suivant pour créer une ressource de langage à l’aide du Portail Azure. Vous devez vous connecter à l’aide de votre abonnement Azure.
Sur l’écran Sélectionner des fonctionnalités supplémentaires qui s’affiche, sélectionnez Continuer à créer votre ressource.
Sur l’écran Créer un langage, indiquez les informations suivantes :
Détail Description Abonnement Compte d’abonnement auquel votre ressource sera associée. Sélectionnez votre abonnement Azure dans le menu déroulant. Resource group Un groupe de ressources est un conteneur qui stocke les ressources que vous créez. Sélectionnez Créer pour créer un groupe de ressources. Région Emplacement de votre ressource de langue. Des régions différentes peuvent entraîner une latence en fonction de votre emplacement physique. Toutefois, cela n’aura pas d’impact sur la disponibilité du runtime de votre ressource. Pour ce guide de démarrage rapide, sélectionnez une région disponible près de vous ou choisissez USA Est. Name Nom de votre ressource de langage. Ce nom sera également utilisé pour créer une URL de point de terminaison que vos applications utiliseront pour envoyer des demandes d’API. Niveau tarifaire Niveau tarifaire de votre ressource de langue. Vous pouvez utiliser le niveau Gratuit F0 pour tester le service, puis passer par la suite à un niveau payant pour la production. Vérifiez que l’Avis d’IA responsable est coché.
Au bas de la page, sélectionnez Vérifier + créer.
Dans l’écran qui s’affiche, assurez-vous que la validation a réussi et que vous avez entré vos informations correctement. Sélectionnez ensuite Créer.
Obtenir votre clé et votre point de terminaison
Ensuite, vous avez besoin de la clé et du point de terminaison de la ressource que pour connecter votre application à l’API. Vous collerez votre clé et votre point de terminaison dans le code plus loin dans ce guide de démarrage rapide.
Une fois la ressource de langage déployée, cliquez sur le bouton Accéder à la ressource sous Étapes suivantes.
Sur l’écran de votre ressource, sélectionnez Clés et point de terminaison dans le menu de navigation de gauche. Vous allez utiliser l’une de vos clés et votre point de terminaison dans les étapes ci-dessous.
Créer des variables d’environnement
Votre application doit être authentifiée pour envoyer des requêtes d’API. Pour la production, utilisez une méthode de stockage et d’accès sécurisée pour vos informations d’identification. Dans cet exemple, vous allez écrire vos informations d’identification dans des variables d’environnement sur l’ordinateur local exécutant l’application.
Pour définir la variable d’environnement de votre clé de ressource de langage, ouvrez une fenêtre de console et suivez les instructions relatives à votre système d’exploitation et à votre environnement de développement.
- Pour définir la variable d’environnement
LANGUAGE_KEY
, remplacezyour-key
par l’une des clés de votre ressource. - Pour définir la
LANGUAGE_ENDPOINT
variable d’environnement, remplacezyour-endpoint
par le point de terminaison de votre ressource.
Important
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.
setx LANGUAGE_KEY your-key
setx LANGUAGE_ENDPOINT your-endpoint
Notes
Si vous avez uniquement besoin d’accéder aux variables d’environnement dans la console en cours d’exécution, vous pouvez la définir avec set
au lieu de setx
.
Après avoir ajouté les variables d’environnement, vous devrez peut-être redémarrer tous les programmes en cours d’exécution qui devront les lire, y compris la fenêtre de console. Par exemple, si vous utilisez Visual Studio comme éditeur, redémarrez Visual Studio avant d’exécuter l’exemple.
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 et exécutez le code.
using Azure;
using System;
using System.Globalization;
using Azure.AI.TextAnalytics;
namespace EntityLinkingExample
{
class Program
{
// This example requires environment variables named "LANGUAGE_KEY" and "LANGUAGE_ENDPOINT"
static string languageKey = Environment.GetEnvironmentVariable("LANGUAGE_KEY");
static string languageEndpoint = Environment.GetEnvironmentVariable("LANGUAGE_ENDPOINT");
private static readonly AzureKeyCredential credentials = new AzureKeyCredential(languageKey);
private static readonly Uri endpoint = new Uri(languageEndpoint);
// Example method for recognizing entities and providing a link to an online data source.
static void EntityLinkingExample(TextAnalyticsClient client)
{
var response = client.RecognizeLinkedEntities(
"Microsoft was founded by Bill Gates and Paul Allen on April 4, 1975, " +
"to develop and sell BASIC interpreters for the Altair 8800. " +
"During his career at Microsoft, Gates held the positions of chairman, " +
"chief executive officer, president and chief software architect, " +
"while also being the largest individual shareholder until May 2014.");
Console.WriteLine("Linked Entities:");
foreach (var entity in response.Value)
{
Console.WriteLine($"\tName: {entity.Name},\tID: {entity.DataSourceEntityId},\tURL: {entity.Url}\tData Source: {entity.DataSource}");
Console.WriteLine("\tMatches:");
foreach (var match in entity.Matches)
{
Console.WriteLine($"\t\tText: {match.Text}");
Console.WriteLine($"\t\tScore: {match.ConfidenceScore:F2}\n");
}
}
}
static void Main(string[] args)
{
var client = new TextAnalyticsClient(endpoint, credentials);
EntityLinkingExample(client);
Console.Write("Press any key to exit.");
Console.ReadKey();
}
}
}
Sortie
Linked Entities:
Name: Microsoft, ID: Microsoft, URL: https://en.wikipedia.org/wiki/Microsoft Data Source: Wikipedia
Matches:
Text: Microsoft
Score: 0.55
Text: Microsoft
Score: 0.55
Name: Bill Gates, ID: Bill Gates, URL: https://en.wikipedia.org/wiki/Bill_Gates Data Source: Wikipedia
Matches:
Text: Bill Gates
Score: 0.63
Text: Gates
Score: 0.63
Name: Paul Allen, ID: Paul Allen, URL: https://en.wikipedia.org/wiki/Paul_Allen Data Source: Wikipedia
Matches:
Text: Paul Allen
Score: 0.60
Name: April 4, ID: April 4, URL: https://en.wikipedia.org/wiki/April_4 Data Source: Wikipedia
Matches:
Text: April 4
Score: 0.32
Name: BASIC, ID: BASIC, URL: https://en.wikipedia.org/wiki/BASIC Data Source: Wikipedia
Matches:
Text: BASIC
Score: 0.33
Name: Altair 8800, ID: Altair 8800, URL: https://en.wikipedia.org/wiki/Altair_8800 Data Source: Wikipedia
Matches:
Text: Altair 8800
Score: 0.88
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
Documentation de référence | Plus d’exemples | Package (Maven) | Code source de la bibliothèque
Utilisez ce guide de démarrage rapide pour créer une application de liaison d’entités avec la bibliothèque de client pour Java. Dans l’exemple suivant, vous allez créer une application Java qui peut identifier et lever l’ambiguïté des entités trouvées dans du texte.
Prérequis
- Abonnement Azure - En créer un gratuitement
- Kit de développement Java (JDK) avec version 8 ou ultérieure
Configuration
Créer une ressource Azure
Pour utiliser l’exemple de code ci-dessous, vous devez déployer une ressource Azure. Cette ressource contient une clé et un point de terminaison que vous utiliserez pour authentifier les appels d’API que vous envoyez au service Language.
Utilisez le lien suivant pour créer une ressource de langage à l’aide du Portail Azure. Vous devez vous connecter à l’aide de votre abonnement Azure.
Sur l’écran Sélectionner des fonctionnalités supplémentaires qui s’affiche, sélectionnez Continuer à créer votre ressource.
Sur l’écran Créer un langage, indiquez les informations suivantes :
Détail Description Abonnement Compte d’abonnement auquel votre ressource sera associée. Sélectionnez votre abonnement Azure dans le menu déroulant. Resource group Un groupe de ressources est un conteneur qui stocke les ressources que vous créez. Sélectionnez Créer pour créer un groupe de ressources. Région Emplacement de votre ressource de langue. Des régions différentes peuvent entraîner une latence en fonction de votre emplacement physique. Toutefois, cela n’aura pas d’impact sur la disponibilité du runtime de votre ressource. Pour ce guide de démarrage rapide, sélectionnez une région disponible près de vous ou choisissez USA Est. Name Nom de votre ressource de langage. Ce nom sera également utilisé pour créer une URL de point de terminaison que vos applications utiliseront pour envoyer des demandes d’API. Niveau tarifaire Niveau tarifaire de votre ressource de langue. Vous pouvez utiliser le niveau Gratuit F0 pour tester le service, puis passer par la suite à un niveau payant pour la production. Vérifiez que l’Avis d’IA responsable est coché.
Au bas de la page, sélectionnez Vérifier + créer.
Dans l’écran qui s’affiche, assurez-vous que la validation a réussi et que vous avez entré vos informations correctement. Sélectionnez ensuite Créer.
Obtenir votre clé et votre point de terminaison
Ensuite, vous avez besoin de la clé et du point de terminaison de la ressource que pour connecter votre application à l’API. Vous collerez votre clé et votre point de terminaison dans le code plus loin dans ce guide de démarrage rapide.
Une fois la ressource de langage déployée, cliquez sur le bouton Accéder à la ressource sous Étapes suivantes.
Sur l’écran de votre ressource, sélectionnez Clés et point de terminaison dans le menu de navigation de gauche. Vous allez utiliser l’une de vos clés et votre point de terminaison dans les étapes ci-dessous.
Créer des variables d’environnement
Votre application doit être authentifiée pour envoyer des requêtes d’API. Pour la production, utilisez une méthode de stockage et d’accès sécurisée pour vos informations d’identification. Dans cet exemple, vous allez écrire vos informations d’identification dans des variables d’environnement sur l’ordinateur local exécutant l’application.
Pour définir la variable d’environnement de votre clé de ressource de langage, ouvrez une fenêtre de console et suivez les instructions relatives à votre système d’exploitation et à votre environnement de développement.
- Pour définir la variable d’environnement
LANGUAGE_KEY
, remplacezyour-key
par l’une des clés de votre ressource. - Pour définir la
LANGUAGE_ENDPOINT
variable d’environnement, remplacezyour-endpoint
par le point de terminaison de votre ressource.
Important
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.
setx LANGUAGE_KEY your-key
setx LANGUAGE_ENDPOINT your-endpoint
Notes
Si vous avez uniquement besoin d’accéder aux variables d’environnement dans la console en cours d’exécution, vous pouvez la définir avec set
au lieu de setx
.
Après avoir ajouté les variables d’environnement, vous devrez peut-être redémarrer tous les programmes en cours d’exécution qui devront les lire, y compris la fenêtre de console. Par exemple, si vous utilisez Visual Studio comme éditeur, redémarrez Visual Studio avant d’exécuter l’exemple.
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. Exécutez ensuite le code.
import com.azure.core.credential.AzureKeyCredential;
import com.azure.ai.textanalytics.models.*;
import com.azure.ai.textanalytics.TextAnalyticsClientBuilder;
import com.azure.ai.textanalytics.TextAnalyticsClient;
public class Example {
// This example requires environment variables named "LANGUAGE_KEY" and "LANGUAGE_ENDPOINT"
private static String languageKey = System.getenv("LANGUAGE_KEY");
private static String languageEndpoint = System.getenv("LANGUAGE_ENDPOINT");
public static void main(String[] args) {
TextAnalyticsClient client = authenticateClient(languageKey, languageEndpoint);
recognizeLinkedEntitiesExample(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 recognizing entities and providing a link to an online data source
static void recognizeLinkedEntitiesExample(TextAnalyticsClient client)
{
// The text that need be analyzed.
String text = "Microsoft was founded by Bill Gates and Paul Allen on April 4, 1975, " +
"to develop and sell BASIC interpreters for the Altair 8800. " +
"During his career at Microsoft, Gates held the positions of chairman, " +
"chief executive officer, president and chief software architect, " +
"while also being the largest individual shareholder until May 2014.";
System.out.printf("Linked Entities:%n");
for (LinkedEntity linkedEntity : client.recognizeLinkedEntities(text)) {
System.out.printf("Name: %s, ID: %s, URL: %s, Data Source: %s.%n",
linkedEntity.getName(),
linkedEntity.getDataSourceEntityId(),
linkedEntity.getUrl(),
linkedEntity.getDataSource());
System.out.printf("Matches:%n");
for (LinkedEntityMatch linkedEntityMatch : linkedEntity.getMatches()) {
System.out.printf("Text: %s, Score: %.2f, Offset: %s, Length: %s%n",
linkedEntityMatch.getText(),
linkedEntityMatch.getConfidenceScore(),
linkedEntityMatch.getOffset(),
linkedEntityMatch.getLength());
}
}
}
}
Output
Linked Entities:
Name: Microsoft, ID: Microsoft, URL: https://en.wikipedia.org/wiki/Microsoft, Data Source: Wikipedia.
Matches:
Text: Microsoft, Score: 0.55, Offset: 0, Length: 9
Text: Microsoft, Score: 0.55, Offset: 150, Length: 9
Name: Bill Gates, ID: Bill Gates, URL: https://en.wikipedia.org/wiki/Bill_Gates, Data Source: Wikipedia.
Matches:
Text: Bill Gates, Score: 0.63, Offset: 25, Length: 10
Text: Gates, Score: 0.63, Offset: 161, Length: 5
Name: Paul Allen, ID: Paul Allen, URL: https://en.wikipedia.org/wiki/Paul_Allen, Data Source: Wikipedia.
Matches:
Text: Paul Allen, Score: 0.60, Offset: 40, Length: 10
Name: April 4, ID: April 4, URL: https://en.wikipedia.org/wiki/April_4, Data Source: Wikipedia.
Matches:
Text: April 4, Score: 0.32, Offset: 54, Length: 7
Name: BASIC, ID: BASIC, URL: https://en.wikipedia.org/wiki/BASIC, Data Source: Wikipedia.
Matches:
Text: BASIC, Score: 0.33, Offset: 89, Length: 5
Name: Altair 8800, ID: Altair 8800, URL: https://en.wikipedia.org/wiki/Altair_8800, Data Source: Wikipedia.
Matches:
Text: Altair 8800, Score: 0.88, Offset: 116, Length: 11
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
Documentation de référence | Plus d’échantillons | Package (npm) | Code source de bibliothèque
Utilisez ce guide de démarrage rapide pour créer une application de liaison d’entités avec la bibliothèque de client pour Node.js. Dans l’exemple suivant, vous allez créer une application JavaScript qui peut identifier et lever l’ambiguïté des entités trouvées dans du texte.
Prérequis
- Abonnement Azure - En créer un gratuitement
- Node.js v14 LTS ou version ultérieure
Configuration
Créer une ressource Azure
Pour utiliser l’exemple de code ci-dessous, vous devez déployer une ressource Azure. Cette ressource contient une clé et un point de terminaison que vous utiliserez pour authentifier les appels d’API que vous envoyez au service Language.
Utilisez le lien suivant pour créer une ressource de langage à l’aide du Portail Azure. Vous devez vous connecter à l’aide de votre abonnement Azure.
Sur l’écran Sélectionner des fonctionnalités supplémentaires qui s’affiche, sélectionnez Continuer à créer votre ressource.
Sur l’écran Créer un langage, indiquez les informations suivantes :
Détail Description Abonnement Compte d’abonnement auquel votre ressource sera associée. Sélectionnez votre abonnement Azure dans le menu déroulant. Resource group Un groupe de ressources est un conteneur qui stocke les ressources que vous créez. Sélectionnez Créer pour créer un groupe de ressources. Région Emplacement de votre ressource de langue. Des régions différentes peuvent entraîner une latence en fonction de votre emplacement physique. Toutefois, cela n’aura pas d’impact sur la disponibilité du runtime de votre ressource. Pour ce guide de démarrage rapide, sélectionnez une région disponible près de vous ou choisissez USA Est. Name Nom de votre ressource de langage. Ce nom sera également utilisé pour créer une URL de point de terminaison que vos applications utiliseront pour envoyer des demandes d’API. Niveau tarifaire Niveau tarifaire de votre ressource de langue. Vous pouvez utiliser le niveau Gratuit F0 pour tester le service, puis passer par la suite à un niveau payant pour la production. Vérifiez que l’Avis d’IA responsable est coché.
Au bas de la page, sélectionnez Vérifier + créer.
Dans l’écran qui s’affiche, assurez-vous que la validation a réussi et que vous avez entré vos informations correctement. Sélectionnez ensuite Créer.
Obtenir votre clé et votre point de terminaison
Ensuite, vous avez besoin de la clé et du point de terminaison de la ressource que pour connecter votre application à l’API. Vous collerez votre clé et votre point de terminaison dans le code plus loin dans ce guide de démarrage rapide.
Une fois la ressource de langage déployée, cliquez sur le bouton Accéder à la ressource sous Étapes suivantes.
Sur l’écran de votre ressource, sélectionnez Clés et point de terminaison dans le menu de navigation de gauche. Vous allez utiliser l’une de vos clés et votre point de terminaison dans les étapes ci-dessous.
Créer des variables d’environnement
Votre application doit être authentifiée pour envoyer des requêtes d’API. Pour la production, utilisez une méthode de stockage et d’accès sécurisée pour vos informations d’identification. Dans cet exemple, vous allez écrire vos informations d’identification dans des variables d’environnement sur l’ordinateur local exécutant l’application.
Pour définir la variable d’environnement de votre clé de ressource de langage, ouvrez une fenêtre de console et suivez les instructions relatives à votre système d’exploitation et à votre environnement de développement.
- Pour définir la variable d’environnement
LANGUAGE_KEY
, remplacezyour-key
par l’une des clés de votre ressource. - Pour définir la
LANGUAGE_ENDPOINT
variable d’environnement, remplacezyour-endpoint
par le point de terminaison de votre ressource.
Important
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.
setx LANGUAGE_KEY your-key
setx LANGUAGE_ENDPOINT your-endpoint
Notes
Si vous avez uniquement besoin d’accéder aux variables d’environnement dans la console en cours d’exécution, vous pouvez la définir avec set
au lieu de setx
.
Après avoir ajouté les variables d’environnement, vous devrez peut-être redémarrer tous les programmes en cours d’exécution qui devront les lire, y compris la fenêtre de console. Par exemple, si vous utilisez Visual Studio comme éditeur, redémarrez Visual Studio avant d’exécuter l’exemple.
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. Exécutez ensuite le code.
"use strict";
const { TextAnalyticsClient, AzureKeyCredential } = require("@azure/ai-text-analytics");
// This example requires environment variables named "LANGUAGE_KEY" and "LANGUAGE_ENDPOINT"
const key = process.env.LANGUAGE_KEY;
const endpoint = process.env.LANGUAGE_ENDPOINT;
//example sentence for recognizing entities
const documents = ["Microsoft was founded by Bill Gates and Paul Allen on April 4, 1975."];
//example of how to use the client to perform entity linking on a document
async function main() {
console.log("== Entity linking sample ==");
const client = new TextAnalysisClient(endpoint, new AzureKeyCredential(key));
const results = await client.analyze("EntityLinking", documents);
for (const result of results) {
console.log(`- Document ${result.id}`);
if (!result.error) {
console.log("\tEntities:");
for (const entity of result.entities) {
console.log(
`\t- Entity ${entity.name}; link ${entity.url}; datasource: ${entity.dataSource}`
);
console.log("\t\tMatches:");
for (const match of entity.matches) {
console.log(
`\t\t- Entity appears as "${match.text}" (confidence: ${match.confidenceScore}`
);
}
}
} else {
console.error(" Error:", result.error);
}
}
}
//call the main function
main().catch((err) => {
console.error("The sample encountered an error:", err);
});
Output
== Entity linking sample ==
- Document 0
Entities:
- Entity Microsoft; link https://en.wikipedia.org/wiki/Microsoft; datasource: Wikipedia
Matches:
- Entity appears as "Microsoft" (confidence: 0.48
- Entity Bill Gates; link https://en.wikipedia.org/wiki/Bill_Gates; datasource: Wikipedia
Matches:
- Entity appears as "Bill Gates" (confidence: 0.52
- Entity Paul Allen; link https://en.wikipedia.org/wiki/Paul_Allen; datasource: Wikipedia
Matches:
- Entity appears as "Paul Allen" (confidence: 0.54
- Entity April 4; link https://en.wikipedia.org/wiki/April_4; datasource: Wikipedia
Matches:
- Entity appears as "April 4" (confidence: 0.38
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
Documentation de référence | Plus d’exemples | Package (PyPi) | Code source de la bibliothèque
Utilisez ce guide de démarrage rapide pour créer une application de liaison d’entités avec la bibliothèque de client pour Python. Dans l’exemple suivant, vous allez créer une application Python qui peut identifier et lever l’ambiguïté des entités trouvées dans du texte.
Prérequis
- Abonnement Azure - En créer un gratuitement
- Python 3.7 ou version ultérieure
Configuration
Créer une ressource Azure
Pour utiliser l’exemple de code ci-dessous, vous devez déployer une ressource Azure. Cette ressource contient une clé et un point de terminaison que vous utiliserez pour authentifier les appels d’API que vous envoyez au service Language.
Utilisez le lien suivant pour créer une ressource de langage à l’aide du Portail Azure. Vous devez vous connecter à l’aide de votre abonnement Azure.
Sur l’écran Sélectionner des fonctionnalités supplémentaires qui s’affiche, sélectionnez Continuer à créer votre ressource.
Sur l’écran Créer un langage, indiquez les informations suivantes :
Détail Description Abonnement Compte d’abonnement auquel votre ressource sera associée. Sélectionnez votre abonnement Azure dans le menu déroulant. Resource group Un groupe de ressources est un conteneur qui stocke les ressources que vous créez. Sélectionnez Créer pour créer un groupe de ressources. Région Emplacement de votre ressource de langue. Des régions différentes peuvent entraîner une latence en fonction de votre emplacement physique. Toutefois, cela n’aura pas d’impact sur la disponibilité du runtime de votre ressource. Pour ce guide de démarrage rapide, sélectionnez une région disponible près de vous ou choisissez USA Est. Name Nom de votre ressource de langage. Ce nom sera également utilisé pour créer une URL de point de terminaison que vos applications utiliseront pour envoyer des demandes d’API. Niveau tarifaire Niveau tarifaire de votre ressource de langue. Vous pouvez utiliser le niveau Gratuit F0 pour tester le service, puis passer par la suite à un niveau payant pour la production. Vérifiez que l’Avis d’IA responsable est coché.
Au bas de la page, sélectionnez Vérifier + créer.
Dans l’écran qui s’affiche, assurez-vous que la validation a réussi et que vous avez entré vos informations correctement. Sélectionnez ensuite Créer.
Obtenir votre clé et votre point de terminaison
Ensuite, vous avez besoin de la clé et du point de terminaison de la ressource que pour connecter votre application à l’API. Vous collerez votre clé et votre point de terminaison dans le code plus loin dans ce guide de démarrage rapide.
Une fois la ressource de langage déployée, cliquez sur le bouton Accéder à la ressource sous Étapes suivantes.
Sur l’écran de votre ressource, sélectionnez Clés et point de terminaison dans le menu de navigation de gauche. Vous allez utiliser l’une de vos clés et votre point de terminaison dans les étapes ci-dessous.
Créer des variables d’environnement
Votre application doit être authentifiée pour envoyer des requêtes d’API. Pour la production, utilisez une méthode de stockage et d’accès sécurisée pour vos informations d’identification. Dans cet exemple, vous allez écrire vos informations d’identification dans des variables d’environnement sur l’ordinateur local exécutant l’application.
Pour définir la variable d’environnement de votre clé de ressource de langage, ouvrez une fenêtre de console et suivez les instructions relatives à votre système d’exploitation et à votre environnement de développement.
- Pour définir la variable d’environnement
LANGUAGE_KEY
, remplacezyour-key
par l’une des clés de votre ressource. - Pour définir la
LANGUAGE_ENDPOINT
variable d’environnement, remplacezyour-endpoint
par le point de terminaison de votre ressource.
Important
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.
setx LANGUAGE_KEY your-key
setx LANGUAGE_ENDPOINT your-endpoint
Notes
Si vous avez uniquement besoin d’accéder aux variables d’environnement dans la console en cours d’exécution, vous pouvez la définir avec set
au lieu de setx
.
Après avoir ajouté les variables d’environnement, vous devrez peut-être redémarrer tous les programmes en cours d’exécution qui devront les lire, y compris la fenêtre de console. Par exemple, si vous utilisez Visual Studio comme éditeur, redémarrez Visual Studio avant d’exécuter l’exemple.
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. Exécutez ensuite le code.
# This example requires environment variables named "LANGUAGE_KEY" and "LANGUAGE_ENDPOINT"
language_key = os.environ.get('LANGUAGE_KEY')
language_endpoint = os.environ.get('LANGUAGE_ENDPOINT')
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(language_key)
text_analytics_client = TextAnalyticsClient(
endpoint=language_endpoint,
credential=ta_credential)
return text_analytics_client
client = authenticate_client()
# Example function for recognizing entities and providing a link to an online data source.
def entity_linking_example(client):
try:
documents = ["""Microsoft was founded by Bill Gates and Paul Allen on April 4, 1975,
to develop and sell BASIC interpreters for the Altair 8800.
During his career at Microsoft, Gates held the positions of chairman,
chief executive officer, president and chief software architect,
while also being the largest individual shareholder until May 2014."""]
result = client.recognize_linked_entities(documents = documents)[0]
print("Linked Entities:\n")
for entity in result.entities:
print("\tName: ", entity.name, "\tId: ", entity.data_source_entity_id, "\tUrl: ", entity.url,
"\n\tData Source: ", entity.data_source)
print("\tMatches:")
for match in entity.matches:
print("\t\tText:", match.text)
print("\t\tConfidence Score: {0:.2f}".format(match.confidence_score))
print("\t\tOffset: {}".format(match.offset))
print("\t\tLength: {}".format(match.length))
except Exception as err:
print("Encountered exception. {}".format(err))
entity_linking_example(client)
Output
Linked Entities:
Name: Microsoft Id: Microsoft Url: https://en.wikipedia.org/wiki/Microsoft
Data Source: Wikipedia
Matches:
Text: Microsoft
Confidence Score: 0.55
Offset: 0
Length: 9
Text: Microsoft
Confidence Score: 0.55
Offset: 168
Length: 9
Name: Bill Gates Id: Bill Gates Url: https://en.wikipedia.org/wiki/Bill_Gates
Data Source: Wikipedia
Matches:
Text: Bill Gates
Confidence Score: 0.63
Offset: 25
Length: 10
Text: Gates
Confidence Score: 0.63
Offset: 179
Length: 5
Name: Paul Allen Id: Paul Allen Url: https://en.wikipedia.org/wiki/Paul_Allen
Data Source: Wikipedia
Matches:
Text: Paul Allen
Confidence Score: 0.60
Offset: 40
Length: 10
Name: April 4 Id: April 4 Url: https://en.wikipedia.org/wiki/April_4
Data Source: Wikipedia
Matches:
Text: BASIC
Confidence Score: 0.33
Offset: 98
Length: 5
Name: Altair 8800 Id: Altair 8800 Url: https://en.wikipedia.org/wiki/Altair_8800
Data Source: Wikipedia
Matches:
Text: Altair 8800
Confidence Score: 0.88
Offset: 125
Length: 11
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
Utilisez ce guide de démarrage rapide pour envoyer des requêtes de liaison d’entités à l’aide de l’API REST. Dans l’exemple suivant, vous allez utiliser cURL pour identifier et lever l’ambiguïté des entités trouvées dans du texte.
Prérequis
- Abonnement Azure - En créer un gratuitement
Configuration
Créer une ressource Azure
Pour utiliser l’exemple de code ci-dessous, vous devez déployer une ressource Azure. Cette ressource contient une clé et un point de terminaison que vous utiliserez pour authentifier les appels d’API que vous envoyez au service Language.
Utilisez le lien suivant pour créer une ressource de langage à l’aide du Portail Azure. Vous devez vous connecter à l’aide de votre abonnement Azure.
Sur l’écran Sélectionner des fonctionnalités supplémentaires qui s’affiche, sélectionnez Continuer à créer votre ressource.
Sur l’écran Créer un langage, indiquez les informations suivantes :
Détail Description Abonnement Compte d’abonnement auquel votre ressource sera associée. Sélectionnez votre abonnement Azure dans le menu déroulant. Resource group Un groupe de ressources est un conteneur qui stocke les ressources que vous créez. Sélectionnez Créer pour créer un groupe de ressources. Région Emplacement de votre ressource de langue. Des régions différentes peuvent entraîner une latence en fonction de votre emplacement physique. Toutefois, cela n’aura pas d’impact sur la disponibilité du runtime de votre ressource. Pour ce guide de démarrage rapide, sélectionnez une région disponible près de vous ou choisissez USA Est. Name Nom de votre ressource de langage. Ce nom sera également utilisé pour créer une URL de point de terminaison que vos applications utiliseront pour envoyer des demandes d’API. Niveau tarifaire Niveau tarifaire de votre ressource de langue. Vous pouvez utiliser le niveau Gratuit F0 pour tester le service, puis passer par la suite à un niveau payant pour la production. Vérifiez que l’Avis d’IA responsable est coché.
Au bas de la page, sélectionnez Vérifier + créer.
Dans l’écran qui s’affiche, assurez-vous que la validation a réussi et que vous avez entré vos informations correctement. Sélectionnez ensuite Créer.
Obtenir votre clé et votre point de terminaison
Ensuite, vous avez besoin de la clé et du point de terminaison de la ressource que pour connecter votre application à l’API. Vous collerez votre clé et votre point de terminaison dans le code plus loin dans ce guide de démarrage rapide.
Une fois la ressource de langage déployée, cliquez sur le bouton Accéder à la ressource sous Étapes suivantes.
Sur l’écran de votre ressource, sélectionnez Clés et point de terminaison dans le menu de navigation de gauche. Vous allez utiliser l’une de vos clés et votre point de terminaison dans les étapes ci-dessous.
Créer des variables d’environnement
Votre application doit être authentifiée pour envoyer des requêtes d’API. Pour la production, utilisez une méthode de stockage et d’accès sécurisée pour vos informations d’identification. Dans cet exemple, vous allez écrire vos informations d’identification dans des variables d’environnement sur l’ordinateur local exécutant l’application.
Pour définir la variable d’environnement de votre clé de ressource de langage, ouvrez une fenêtre de console et suivez les instructions relatives à votre système d’exploitation et à votre environnement de développement.
- Pour définir la variable d’environnement
LANGUAGE_KEY
, remplacezyour-key
par l’une des clés de votre ressource. - Pour définir la
LANGUAGE_ENDPOINT
variable d’environnement, remplacezyour-endpoint
par le point de terminaison de votre ressource.
Important
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.
setx LANGUAGE_KEY your-key
setx LANGUAGE_ENDPOINT your-endpoint
Notes
Si vous avez uniquement besoin d’accéder aux variables d’environnement dans la console en cours d’exécution, vous pouvez la définir avec set
au lieu de setx
.
Après avoir ajouté les variables d’environnement, vous devrez peut-être redémarrer tous les programmes en cours d’exécution qui devront les lire, y compris la fenêtre de console. Par exemple, si vous utilisez Visual Studio comme éditeur, redémarrez Visual Studio avant d’exécuter l’exemple.
Créer un fichier JSON avec l’exemple de corps de requête
Dans un éditeur de code, créez un fichier nommé test_entitylinking_payload.json
, puis copiez l’exemple JSON suivant. Cet exemple de requête sera envoyé à l’API à l’étape suivante.
{
"kind": "EntityLinking",
"parameters": {
"modelVersion": "latest"
},
"analysisInput":{
"documents":[
{
"id":"1",
"language":"en",
"text": "Microsoft was founded by Bill Gates and Paul Allen on April 4, 1975."
}
]
}
}
Enregistrez test_entitylinking_payload.json
quelque part sur votre ordinateur. Par exemple, sur le Bureau.
Envoyer une demande d’API de liaison d’entités
Utilisez les commandes suivantes pour envoyer la requête d’API à l’aide du programme que vous utilisez. Copiez la commande dans votre terminal, puis exécutez-la.
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. |
Remplacez C:\Users\<myaccount>\Desktop\test_entitylinking_payload.json
par l’emplacement de l’exemple de fichier de requête JSON que vous avez créé à l’étape précédente.
Invite de commande
curl -X POST "%LANGUAGE_ENDPOINT%/language/:analyze-text?api-version=2022-05-01" ^
-H "Content-Type: application/json" ^
-H "Ocp-Apim-Subscription-Key: %LANGUAGE_KEY%" ^
-d "@C:\Users\<myaccount>\Desktop\test_entitylinking_payload.json"
PowerShell
curl.exe -X POST $env:LANGUAGE_ENDPOINT/language/:analyze-text?api-version=2022-05-01 `
-H "Content-Type: application/json" `
-H "Ocp-Apim-Subscription-Key: $env:LANGUAGE_KEY" `
-d "@C:\Users\<myaccount>\Desktop\test_entitylinking_payload.json"
Réponse JSON
{
"kind": "EntityLinkingResults",
"results": {
"documents": [{
"id": "1",
"entities": [{
"bingId": "a093e9b9-90f5-a3d5-c4b8-5855e1b01f85",
"name": "Microsoft",
"matches": [{
"text": "Microsoft",
"offset": 0,
"length": 9,
"confidenceScore": 0.48
}],
"language": "en",
"id": "Microsoft",
"url": "https://en.wikipedia.org/wiki/Microsoft",
"dataSource": "Wikipedia"
}, {
"bingId": "0d47c987-0042-5576-15e8-97af601614fa",
"name": "Bill Gates",
"matches": [{
"text": "Bill Gates",
"offset": 25,
"length": 10,
"confidenceScore": 0.52
}],
"language": "en",
"id": "Bill Gates",
"url": "https://en.wikipedia.org/wiki/Bill_Gates",
"dataSource": "Wikipedia"
}, {
"bingId": "df2c4376-9923-6a54-893f-2ee5a5badbc7",
"name": "Paul Allen",
"matches": [{
"text": "Paul Allen",
"offset": 40,
"length": 10,
"confidenceScore": 0.54
}],
"language": "en",
"id": "Paul Allen",
"url": "https://en.wikipedia.org/wiki/Paul_Allen",
"dataSource": "Wikipedia"
}, {
"bingId": "52535f87-235e-b513-54fe-c03e4233ac6e",
"name": "April 4",
"matches": [{
"text": "April 4",
"offset": 54,
"length": 7,
"confidenceScore": 0.38
}],
"language": "en",
"id": "April 4",
"url": "https://en.wikipedia.org/wiki/April_4",
"dataSource": "Wikipedia"
}],
"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.