Quickstart: spelling controleren met de Bing Spellingcontrole-REST API en Node.js

Artikel
05/21/2020

Waarschuwing

Op 30 oktober 2020 zijn de Zoeken in Bing API's verplaatst van Azure AI-services naar Zoeken in Bing Services. Deze documentatie is alleen bedoeld ter referentie. Zie de bing zoek-API-documentatie voor bijgewerkte documentatie. Zie Een Zoeken in Bing resource maken via de Azure Marketplace voor instructies voor het maken van nieuwe Azure-resources voor Bing Search.

Gebruik deze quickstart om uw eerste aanroep naar de Bing Spellingcontrole REST API te maken. Met deze eenvoudige JavaScript-toepassing verzendt u een aanvraag naar de API en wordt een lijst met voorgestelde correcties geretourneerd.

Hoewel deze toepassing in JavaScript is geschreven, is de API een RESTful-webservice die compatibel is met vrijwel elke programmeertaal. De broncode voor deze toepassing is beschikbaar op GitHub.

Vereisten

Node.js 6 of later.

Een Azure-resource maken

Begin met het gebruik van de API voor Bing Spellingscontrole door een van de volgende Azure-resources te maken:

Resource voor Bing Spellingcontrole

Beschikbaar via de Azure-portal totdat u de resource verwijdert.
Gebruik de gratis prijscategorie om de service uit te proberen, en voer later een upgrade uit naar een betaalde categorie voor productie.
De API voor Bing Spellingcontrole wordt ook aangeboden in sommige categorieën van de Bing Search V7-resource.

Resource met meerdere services

Beschikbaar via de Azure-portal totdat u de resource verwijdert.
Gebruik dezelfde sleutel en hetzelfde eindpunt voor uw toepassingen, in meerdere Azure AI-services.

Een project maken en initialiseren

Maak een nieuw JavaScript-bestand in uw favoriete IDE of editor. Stel het niveau voor strengheid in en vereis het gebruik van https. Maak vervolgens variabelen voor de host en het pad van het API-eindpunt en uw abonnementssleutel. U kunt het globale eindpunt in de volgende code gebruiken of het eindpunt voor een aangepast subdomein gebruiken dat wordt weergegeven in de Azure-portal voor uw resource.
```
'use strict';
let https = require ('https');

let host = 'api.cognitive.microsoft.com';
let path = '/bing/v7.0/spellcheck';
let key = '<ENTER-KEY-HERE>';
```
Maak variabelen voor uw zoekparameters en de tekst die u wilt controleren:
1. Wijs uw marktcode toe aan de parameter mkt met de operator =. De marktcode is de code van het land of de regio van waaruit u de aanvraag indient.
2. Voeg de parameter mode met de & operator toe en wijs vervolgens de spellingcontrolemodus toe. De modus kan de waarde proof (de meeste spelling- en grammaticafouten worden onderschept) of de waarde spell (de meeste spellingfouten worden onderschept, maar niet zo veel grammaticafouten) zijn.
```
let mkt = "en-US";
let mode = "proof";
let text = "Hollo, wrld!";
let query_string = "?mkt=" + mkt + "&mode=" + mode;
```

Parameters voor de aanvraag maken

Maak aanvraagparameters door een nieuw object met een methode van het type POST te maken. Voeg uw pad toe door uw eindpuntpad en de queryreeks toe te voegen. Voeg vervolgens uw abonnementssleutel toe aan de Ocp-Apim-Subscription-Key-header.

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,
   }
};

Een antwoordhandler maken

Maak een functie met de naam response_handler om een JSON-antwoord van de API weer te geven. Maak een variabele voor de hoofdtekst van het antwoord. Voeg door middel van response.on() het antwoord toe als de vlag data wordt ontvangen. Nadat de vlag end is ontvangen, geeft u de JSON-hoofdtekst weer in de 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);
    });
};

De aanvraag verzenden

Roep de API aan door middel van https.request() met uw aanvraagparameters en de antwoordhandler. Schrijf uw tekst naar de API en beëindig de aanvraag.

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

De toepassing uitvoeren

Bouw uw project en voer het uit.
Als u gebruikmaakt van de opdrachtregel, gebruikt u de volgende opdracht om de toepassing te maken en uit te voeren:
```
node <FILE_NAME>.js
```

Voorbeeld van JSON-antwoord

Een geslaagd antwoord wordt geretourneerd in de JSON-indeling, zoals u kunt zien in het volgende voorbeeld:

{
   "_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
            }
         ]
      }
   ]
}

Volgende stappen

Een web-app met één pagina maken