Rychlý start: Kontrola pravopisu pomocí rozhraní REST API Bingu pro kontrolu pravopisu a Node.js

2020-05-21

Varování

30. října 2020 se rozhraní API Bingu pro vyhledávání přesunula ze služeb Azure AI do služby Bing Search Services. Tato dokumentace je k dispozici pouze pro referenci. Aktualizovanou dokumentaci najdete v dokumentaci k rozhraní API Bingu pro vyhledávání. Pokyny k vytváření nových prostředků Azure pro vyhledávání Bingu najdete v tématu Vytvoření prostředku Vyhledávání Bingu prostřednictvím Azure Marketplace.

Použijte tento rychlý začátek k provedení prvního volání rozhraní REST API pro kontrolu pravopisu Bing. Tato jednoduchá javascriptová aplikace odešle požadavek do rozhraní API a vrátí seznam navrhovaných oprav.

I když je tato aplikace napsaná v JavaScriptu, rozhraní API je webová služba RESTful kompatibilní s většinou programovacích jazyků. Zdrojový kód pro tuto aplikaci je k dispozici na GitHubu.

Požadavky

Node.js 6 nebo novější.

Vytvoření prostředku Azure

Začněte používat rozhraní API Bingu pro kontrolu pravopisu vytvořením jednoho z následujících prostředků Azure:

Prostředek Kontroly pravopisu Bingu

K dispozici prostřednictvím webu Azure Portal, dokud prostředek neodstraníte.
K vyzkoušení služby použijte cenovou úroveň Free a upgradujte ji později na placenou úroveň pro produkční prostředí.
Rozhraní API Bingu pro kontrolu pravopisu se také nabízí v některých úrovních prostředku Bing Search v7.

Prostředek s více službami

K dispozici prostřednictvím webu Azure Portal, dokud prostředek neodstraníte.
Použijte stejný klíč a koncový bod pro vaše aplikace napříč několika službami Azure AI.

Vytvoření a inicializace projektu

Ve svém oblíbeném integrovaném vývojovém prostředí nebo editoru vytvořte nový javascriptový soubor. Nastavte striktnost a vyžadujte https. Pak vytvořte proměnné pro hostitele, cestu koncového bodu API a klíč předplatného. Globální koncový bod můžete použít v následujícím kódu, nebo můžete použít koncový bod vlastní subdomény zobrazený v Azure portálu pro váš prostředek.
```
'use strict';
let https = require ('https');

let host = 'api.cognitive.microsoft.com';
let path = '/bing/v7.0/spellcheck';
let key = '<ENTER-KEY-HERE>';
```
Vytvořte proměnné pro parametry hledání a text, který chcete zkontrolovat:
1. Přiřaďte kód trhu k parametru mkt pomocí operátoru =. Kód trhu je kód země/oblasti, ze které žádost provedete.
2. Přidejte parametr mode pomocí operátoru & a pak přiřaďte režim kontroly pravopisu. Režim může být proof (zachytává většinu pravopisu a gramatických chyb) nebo spell (zachytává většinu pravopisových chyb, ale ne tolik gramatických chyb).
```
let mkt = "en-US";
let mode = "proof";
let text = "Hollo, wrld!";
let query_string = "?mkt=" + mkt + "&mode=" + mode;
```

Vytvoření parametrů požadavku

Vytvořte parametry požadavku vytvořením nového objektu pomocí metody POST. Přidejte svou cestu přidáním cesty ke koncovému bodu a přidáním řetězce dotazu. Potom do hlavičky Ocp-Apim-Subscription-Key přidejte klíč předplatného.

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

Vytvořte obslužnou rutinu odpovědi

Vytvořte funkci s názvem response_handler, která převezme odpověď JSON z rozhraní API a vytiskne ji. Vytvořte proměnnou pro tělo odpovědi. Připojte odpověď při obdržení příznaku data pomocí response.on(). Po přijetí příznaku end vytiskněte text JSON do konzoly.

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

Odeslání požadavku

Zavolejte rozhraní API pomocí https.request() s parametry požadavku a obslužnou rutinou odpovědi. Napište text do rozhraní API a pak žádost ukončete.

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

Spuštění aplikace

Sestavte a spusťte projekt.
Pokud používáte příkazový řádek, sestavte a spusťte aplikaci pomocí následujícího příkazu:
```
node <FILE_NAME>.js
```

Příklad odpovědi JSON

Úspěšná odpověď se vrátí ve formátu JSON, jak je znázorněno v následujícím příkladu:

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

Další kroky

Vytvoření jednostráňové webové aplikace

Sdílet prostřednictvím