Dela via


Snabbstart: Kontrollera stavningen med REST API:et för stavningskontroll i Bing och Node.js

Varning

Den 30 oktober 2020 flyttade Bing-sökning API:er från Azure AI-tjänster till Bing-sökning Services. Den här dokumentationen tillhandahålls endast som referens. Uppdaterad dokumentation finns i dokumentationen för API:et för Bing-sökning. Anvisningar om hur du skapar nya Azure-resurser för Bing-sökning finns i Skapa en Bing-sökning resurs via Azure Marketplace.

Använd den här snabbstarten för att göra ditt första anrop till REST API för stavningskontroll i Bing. Det här enkla JavaScript-programmet skickar en begäran till API:et och returnerar en lista över föreslagna korrigeringar.

Även om det här programmet är skrivet i JavaScript är API:et en RESTful-webbtjänst som är kompatibel med de flesta programmeringsspråk. Källkoden för det här programmet är tillgänglig på GitHub.

Förutsättningar

Skapa en Azure-resurs

Börja använda API:et för stavningskontroll i Bing genom att skapa någon av följande Azure-resurser:

Resurs för stavningskontroll i Bing

  • Tillgänglig via Azure Portal tills du tar bort resursen.
  • Använd den kostnadsfria prisnivån för att prova tjänsten och uppgradera senare till en betald nivå för produktion.
  • API:et för stavningskontroll i Bing erbjuds också på vissa nivåer i resursen Bing-sökning v7.

Resurs för flera tjänster

  • Tillgänglig via Azure Portal tills du tar bort resursen.
  • Använd samma nyckel och slutpunkt för dina program i flera Azure AI-tjänster.

Skapa och initiera ett projekt

  1. Skapa en ny JavaScript-fil i valfri IDE eller valfritt redigeringsprogram. Ange strikthet och kräv https. Skapa sedan variabler för API-slutpunktens värd, sökväg och din prenumerationsnyckel. Du kan använda den globala slutpunkten i följande kod eller använda den anpassade underdomänslutpunkten som visas i Azure Portal för resursen.

    'use strict';
    let https = require ('https');
    
    let host = 'api.cognitive.microsoft.com';
    let path = '/bing/v7.0/spellcheck';
    let key = '<ENTER-KEY-HERE>';
    
  2. Skapa variabler för dina sökparametrar och den text som du vill kontrollera:

    1. Tilldela din marknadskod till parametern mkt med operatorn = . Marknadskoden är koden för det land/den region som du skickar begäran från.

    2. Lägg till parametern mode med operatorn & och tilldela sedan stavningskontrollläget. Läget kan vara antingen proof (fångar de flesta stavnings-/grammatikfel) eller spell (fångar de flesta stavfel, men inte lika många grammatikfel).

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

Skapa begärandeparametrar

Skapa dina begärandeparametrar genom att skapa ett nytt objekt med en POST-metod. Lägg till sökvägen genom att lägga till slutpunktssökvägen och frågesträngen. Lägg sedan till din prenumerationsnyckel i Ocp-Apim-Subscription-Key rubriken.

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

Skapa en svarshanterare

Skapa en funktion som heter response_handler för att ta JSON-svaret från API:et och skriva ut det. Skapa en variabel för svarstexten. Lägg till svaret när en data flagga tas emot med hjälp response.on()av . När en end flagga har tagits emot skriver du ut JSON-brödtexten till konsolen.

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

Skicka begäran

Anropa API:et med hjälp av https.request() dina begäransparametrar och svarshanterare. Skriv texten till API:et och avsluta sedan begäran.

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

Kör programmet

  1. Skapa och kör projektet.

  2. Om du använder kommandoraden använder du följande kommando för att skapa och köra programmet:

    node <FILE_NAME>.js
    

Exempel på JSON-svar

Ett svar som anger att åtgärden lyckades returneras i JSON, som du ser i följande exempel:

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

Nästa steg