Schnellstart: Überprüfen der Rechtschreibung mit der Bing-Rechtschreibprüfungs-REST-API und Ruby

Artikel
05/21/2020

Warnung

Am 30. Oktober 2020 wurden die Bing-Suche-APIs aus den Azure KI Services in die Bing-Suchdienste verschoben. Diese Dokumentation wird nur zu Referenzzwecken bereitgestellt. Eine aktualisierte Dokumentation finden Sie in der Dokumentation zu den Bing-Suche-APIs. Anweisungen zum Erstellen neuer Azure-Ressourcen für die Bing-Suche finden Sie unter Erstellen einer Ressource für die Bing-Suche über Azure Marketplace.

In dieser Schnellstartanleitung erfahren Sie, wie Sie die Bing-Rechtschreibprüfungs-REST-API unter Verwendung von Ruby zum ersten Mal aufrufen. Diese einfache Anwendung sendet eine Anforderung an die API und gibt eine Liste mit Korrekturvorschlägen zurück.

Diese Anwendung ist zwar in Ruby geschrieben, an sich ist die API aber ein RESTful-Webdienst, der mit den meisten Programmiersprachen kompatibel ist. Der Quellcode für diese Anwendung ist auf GitHub verfügbar.

Voraussetzungen

Ruby 2.4 oder höher

Erstellen einer Azure-Ressource

Beginnen Sie mit der Verwendung der Bing-Rechtschreibprüfung-API, indem Sie eine der folgenden Azure-Ressourcen erstellen:

Bing-Rechtschreibprüfung-Ressource

Verfügbar über das Azure-Portal, bis Sie die Ressource löschen.
Verwenden Sie den Tarif „Free“, um den Dienst zu testen, und führen Sie später für die Produktion ein Upgrade auf einen kostenpflichtigen Tarif durch.
Die Bing-Rechtschreibprüfung-API wird auch in einigen Tarifen der Bing-Suche v7-Ressource angeboten.

Ressource für mehrere Dienste

Verfügbar über das Azure-Portal, bis Sie die Ressource löschen.
Verwenden Sie in allen Azure KI Services-Instanzen denselben Schlüssel und Endpunkt für Ihre Anwendungen.

Erstellen und Initialisieren der Anwendung

Erstellen Sie in Ihrem bevorzugten Editor oder in Ihrer bevorzugten IDE eine neue Ruby-Datei, und fügen Sie die folgenden Anforderungen hinzu:
```
require 'net/http'
require 'uri'
require 'json'
```
Erstellen Sie Variablen für Ihren Abonnementschlüssel, Endpunkt-URI und Pfad. Sie können den globalen Endpunkt im folgenden Code oder den Endpunkt der benutzerdefinierten Unterdomäne verwenden, der im Azure-Portal für Ihre Ressource angezeigt wird. Erstellen Sie Ihre Anforderungsparameter:
1. Weisen Sie dem mkt-Parameter mit dem =-Operator Ihren Marktcode zu. Der Marktcode ist der Code Lands bzw. der Region, aus dem/der Sie die Anforderung stellen.
2. Fügen Sie den Parameter mode mit dem Operator & hinzu, und weisen Sie dann den Rechtschreibprüfungsmodus zu. Der Modus kann entweder proof (fängt die meisten Rechtschreib-/Grammatikfehler ab) oder spell (fängt die meisten Rechtschreibfehler, aber nicht so viele Grammatikfehler ab) sein.
```
key = 'ENTER YOUR KEY HERE'
uri = 'https://api.cognitive.microsoft.com'
path = '/bing/v7.0/spellcheck?'
params = 'mkt=en-us&mode=proof'
```

Senden einer Rechtschreibprüfungsanforderung

Erstellen Sie einen URI auf der Grundlage Ihres Host-URIs, Ihres Pfads und Ihrer Parameterzeichenfolge. Legen Sie die zugehörige Abfrage so fest, dass sie den Text enthält, für den die Rechtschreibprüfung durchgeführt werden soll.
```
uri = URI(uri + path + params)
uri.query = URI.encode_www_form({
   # Request parameters
'text' => 'Hollo, wrld!'
})
```

Erstellen Sie eine Anforderung mit dem zuvor erstellten URI. Fügen Sie Ihren Schlüssel dem Header Ocp-Apim-Subscription-Key hinzu.

request = Net::HTTP::Post.new(uri)
request['Content-Type'] = "application/x-www-form-urlencoded"
request['Ocp-Apim-Subscription-Key'] = key

Senden Sie die Anforderung.

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

Rufen Sie die JSON-Antwort ab, und geben Sie sie in der Konsole aus.

result = JSON.pretty_generate(JSON.parse(response.body))
puts result

Ausführen der Anwendung

Erstellen Sie Ihr Projekt, und führen Sie es aus. Geben Sie bei Verwenden der Befehlszeile den folgenden Befehl an, um die Anwendung auszuführen:

ruby <FILE_NAME>.rb

JSON-Beispielantwort

Es wird eine erfolgreiche Antwort im JSON-Format zurückgegeben, wie im folgenden Beispiel gezeigt:

{
   "_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ächste Schritte

Erstellen einer Single-Page-Web-App