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

Upozornění

30. října 2020 se rozhraní API vyhledávání Bingu přesunula ze služeb Azure AI na Vyhledávací služby Bingu. 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í Bingem najdete v tématu Vytvoření prostředku vyhledávání Bingu prostřednictvím Azure Marketplace.

Pomocí tohoto rychlého startu provedete první volání rozhraní REST API Bingu pro kontrolu pravopisu. 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 této aplikace 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 tím, že vytvoříte jeden z následujících prostředků Azure:

Prostředek Kontroly pravopisu Bingu

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

Prostředek s více službami

• K dispozici prostřednictvím Azure Portal, dokud prostředek neodstraníte.
• Pro své aplikace použijte stejný klíč a koncový bod napříč několika službami Azure AI.

Vytvoření a inicializace projektu

1. 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 a klíč předplatného koncového bodu rozhraní API. Globální koncový bod můžete použít v následujícím kódu nebo vlastní koncový bod subdomény zobrazený v Azure Portal 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>';
   

2. 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ě nebo oblasti, ze které žádost vytvoříte.

   2. mode Přidejte parametr s operátorem & a pak přiřaďte režim kontroly pravopisu. Režim může být buď proof (zachytí 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 POST pomocí metody . Přidejte cestu tak, že připojíte cestu ke koncovému bodu a řetězec dotazu. Pak do hlavičky přidejte klíč předplatného 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,
   }
};

Vytvoření obslužné rutiny 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ři přijetí příznaku data pomocí response.on()připojte odpověď . 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í žádosti

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

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

Spuštění aplikace

1. Sestavte a spusťte projekt.

2. Pokud používáte příkazový řádek, použijte k sestavení a spuštění aplikace následující příkaz:

   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ánkové webové aplikace

• Co je rozhraní API pro kontrolu pravopisu Bingu?
• Referenční informace k rozhraní API bingu pro kontrolu pravopisu v7