Démarrage rapide : Vérifier l’orthographe avec l’API REST Vérification orthographique Bing et Node.js

Avertissement

Le 30 octobre 2020, les API de recherche Bing sont passées des services Azure AI aux services de recherche Bing. Cette documentation est fournie à des fins de référence uniquement. Pour accéder à la documentation mise à jour, consultez la documentation de l’API Recherche Bing. Pour obtenir des instructions sur la création de nouvelles ressources Azure pour Recherche Bing, consultez Créer une ressource Recherche Bing à l’aide de Place de marché Azure.

Utilisez ce guide de démarrage rapide pour effectuer votre premier appel à l’API REST Vérification orthographique Bing. Cette simple application JavaScript envoie une demande à l’API et retourne une liste de suggestions de corrections.

Bien que cette application soit écrite en JavaScript, l’API est un service web RESTful compatible avec la plupart des langages de programmation. Le code source de cette application est disponible sur GitHub.

Prérequis

• Node.js 6 ou version ultérieure.

Créer une ressource Azure

Commencez à utiliser l’API Vérification orthographique Bing en créant une des ressources Azure ci-dessous :

Ressource Vérification orthographique Bing

• Disponible via le portail Azure jusqu’à ce que vous supprimiez la ressource.
• Utilisez le niveau tarifaire Gratuit pour tester le service, puis effectuez par la suite une mise à niveau vers un niveau payant pour la production.
• L’API Vérification orthographique Bing est aussi proposée à certains niveaux de la ressource Recherche Bing v7.

Ressource multiservice

• Disponible via le portail Azure jusqu’à ce que vous supprimiez la ressource.
• Utilisez la même clé et le même point de terminaison pour vos applications, sur plusieurs services Azure AI.

Créer et initialiser un projet

1. Créez un fichier JavaScript dans votre IDE ou éditeur favori. Définissez la sévérité et exigez https. Créez ensuite des variables pour vos hôte du point de terminaison d’API, chemin et clé d’abonnement. Vous pouvez utiliser le point de terminaison global dans le code suivant, ou le point de terminaison de sous-domaine personnalisé affiché dans le portail Azure pour votre ressource.

   'use strict';
   let https = require ('https');
   
   let host = 'api.cognitive.microsoft.com';
   let path = '/bing/v7.0/spellcheck';
   let key = '<ENTER-KEY-HERE>';
   

2. Créez des variables pour vos paramètres de recherche et le texte à vérifier :

   1. Attribuez le code de votre marché au paramètre mkt à l’aide de l’opérateur =. Le code du marché correspond au code du pays ou de la région depuis lesquels vous effectuez la demande.

   2. Ajoutez le paramètre mode avec l’opérateur &, puis attribuez le mode de vérification orthographique. Le mode peut être soit proof (détecte la plupart des erreurs d’orthographe et de grammaire) ou spell (détecte la plupart des erreurs d’orthographe mais pas autant d’erreurs de grammaire).

   let mkt = "en-US";
   let mode = "proof";
   let text = "Hollo, wrld!";
   let query_string = "?mkt=" + mkt + "&mode=" + mode;
   

Créer les paramètres de demande

Créez vos paramètres de demande en créant un objet avec une méthode POST. Ajoutez votre chemin en ajoutant le chemin du point de terminaison et la chaîne de requête. Ajoutez ensuite votre clé d’abonnement dans l’en-tête Ocp-Apim-Subscription-Key.

let request_params = {
   method : 'POST',
   hostname : host,
   path : path + query_string,
   headers : {
   'Content-Type' : 'application/x-www-form-urlencoded',
   'Content-Length' : text.length + 5,
      'Ocp-Apim-Subscription-Key' : key,
   }
};

Créer un gestionnaire de réponse

Créez une fonction nommée response_handler pour prendre la réponse JSON de l’API, puis imprimez-la. Créez une variable pour le corps de la réponse. Ajoutez la réponse quand un indicateur data est reçu, en utilisant response.on(). Une fois qu’un indicateur end est reçu, affichez le corps JSON dans la console.

let response_handler = function (response) {
    let body = '';
    response.on ('data', function (d) {
        body += d;
    });
    response.on ('end', function () {
        let body_ = JSON.parse (body);
        console.log (body_);
    });
    response.on ('error', function (e) {
        console.log ('Error: ' + e.message);
    });
};

Envoyer la demande

Appelez l’API en utilisant https.request() avec vos paramètres de demande et le gestionnaire de réponse. Écrivez votre texte dans l’API, puis mettez fin à la demande.

let req = https.request (request_params, response_handler);
req.write ("text=" + text);
req.end ();

Exécution de l'application

1. Créez et exécutez votre projet.

2. Si vous utilisez la ligne de commande, utilisez la commande suivante pour générer et exécuter l’application :

   node <FILE_NAME>.js
   

Exemple de réponse JSON

Une réponse correcte est retournée au format JSON, comme dans l’exemple suivant :

{
   "_type": "SpellCheck",
   "flaggedTokens": [
      {
         "offset": 0,
         "token": "Hollo",
         "type": "UnknownToken",
         "suggestions": [
            {
               "suggestion": "Hello",
               "score": 0.9115257530801
            },
            {
               "suggestion": "Hollow",
               "score": 0.858039839213461
            },
            {
               "suggestion": "Hallo",
               "score": 0.597385084464481
            }
         ]
      },
      {
         "offset": 7,
         "token": "wrld",
         "type": "UnknownToken",
         "suggestions": [
            {
               "suggestion": "world",
               "score": 0.9115257530801
            }
         ]
      }
   ]
}

Étapes suivantes

Créer une application web monopage

• Qu’est-ce que l’API Vérification orthographique Bing ?
• Informations de référence sur l’API Vérification orthographique Bing v7