Szybki start: sprawdzanie pisowni przy użyciu interfejsu API REST sprawdzania pisowni Bing i Node.js

Artykuł
05/21/2020

Ostrzeżenie

30 października 2020 r. interfejsy API Wyszukiwanie Bing zostały przeniesione z usług Azure AI do usług Wyszukiwanie Bing Services. Ta dokumentacja jest dostarczana tylko do celów referencyjnych. Aby uzyskać zaktualizowaną dokumentację, zobacz dokumentację interfejsu API wyszukiwania Bing. Aby uzyskać instrukcje dotyczące tworzenia nowych zasobów platformy Azure na potrzeby wyszukiwania Bing, zobacz Tworzenie zasobu Wyszukiwanie Bing za pomocą Azure Marketplace.

Użyj tego przewodnika Szybki start, aby wykonać pierwsze wywołanie interfejsu API REST sprawdzania pisowni Bing. Ta prosta aplikacja JavaScript wysyła żądanie do interfejsu API i zwraca listę sugerowanych poprawek.

Mimo że ta aplikacja jest napisana w języku JavaScript, interfejs API jest usługą internetową RESTful zgodną z większością języków programowania. Kod źródłowy tej aplikacji jest dostępny w usłudze GitHub.

Wymagania wstępne

Środowisko Node.js 6 lub nowsze.

Tworzenie zasobu platformy Azure

Zacznij korzystać z interfejsu API sprawdzania pisowni Bing, tworząc jeden z następujących zasobów platformy Azure:

Zasób sprawdzania pisowni Bing

Dostępne za pośrednictwem Azure Portal do momentu usunięcia zasobu.
Użyj warstwy cenowej Bezpłatna, aby wypróbować usługę, a następnie uaktualnić ją do warstwy płatnej dla środowiska produkcyjnego.
Interfejs API sprawdzania pisowni Bing jest również oferowany w niektórych warstwach zasobu Wyszukiwanie Bing v7.

Zasób z wieloma usługami

Dostępne za pośrednictwem Azure Portal do momentu usunięcia zasobu.
Użyj tego samego klucza i punktu końcowego dla aplikacji w wielu usługach azure AI.

Tworzenie i inicjowanie projektu

Utwórz nowy plik JavaScript w ulubionym środowisku IDE lub edytorze. Ustaw ścisłość i wymagaj https. Następnie utwórz zmienne dla hosta, ścieżki i klucza subskrypcji punktu końcowego interfejsu API. Możesz użyć globalnego punktu końcowego w poniższym kodzie lub użyć niestandardowego punktu końcowego poddomeny wyświetlanego w Azure Portal dla zasobu.
```
'use strict';
let https = require ('https');

let host = 'api.cognitive.microsoft.com';
let path = '/bing/v7.0/spellcheck';
let key = '<ENTER-KEY-HERE>';
```
Utwórz zmienne dla parametrów wyszukiwania i tekstu, który chcesz sprawdzić:
1. Przypisz kod rynku do parametru mkt za pomocą = operatora . Kod rynku to kod kraju/regionu, z którego wysyłasz żądanie.
2. mode Dodaj parametr z operatorem&, a następnie przypisz tryb sprawdzania pisowni. Tryb może być albo proof (przechwytuje większość błędów pisowni/gramatyki) lub spell (przechwytuje większość błędów pisowni, ale nie tyle błędów gramatycznych).
```
let mkt = "en-US";
let mode = "proof";
let text = "Hollo, wrld!";
let query_string = "?mkt=" + mkt + "&mode=" + mode;
```

Tworzenie parametrów żądania

Utwórz parametry żądania przez utworzenie nowego obiektu przy użyciu metody POST. Dodaj ścieżkę utworzoną przez połączenie ścieżki do punktu końcowego i ciągu zapytania. Następnie dodaj klucz subskrypcji do nagłówka 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,
   }
};

Tworzenie procedury obsługi odpowiedzi

Utwórz funkcję o nazwie response_handler, która będzie przyjmować odpowiedź JSON z interfejsu API i wyświetlać ją. Utwórz zmienną na potrzeby treści odpowiedzi. Dołącz odpowiedź po odebraniu data flagi przy użyciu polecenia response.on(). Po odebraniu end flagi wyświetl treść JSON w konsoli programu .

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

Wysyłanie żądania

Wywołaj interfejs API przy użyciu https.request() parametrów żądania i procedury obsługi odpowiedzi. Napisz tekst do interfejsu API, a następnie zakończ żądanie.

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

Uruchamianie aplikacji

Skompiluj i uruchom projekt.
Jeśli używasz wiersza polecenia, użyj następującego polecenia, aby skompilować i uruchomić aplikację:
```
node <FILE_NAME>.js
```

Przykładowa odpowiedź JSON

Po pomyślnym przetworzeniu żądania zostanie zwrócona odpowiedź w formacie JSON, jak pokazano w następującym przykładzie:

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

Następne kroki

Tworzenie jednostronicowej aplikacji internetowej

Udostępnij za pośrednictwem