Freigeben über


Schnellstart: Überprüfen der Rechtschreibung mit der REST-API für die Bing-Rechtschreibprüfung und Python

Warnung

Am 30. Oktober 2020 wurden die Bing Search-APIs von Azure AI-Diensten zu Bing Search Services verschoben. Diese Dokumentation wird nur zur Referenz 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.

Verwenden Sie diese Schnellstartanleitung, um Ihren ersten Aufruf der REST-API für die Bing-Rechtschreibprüfung vorzunehmen. Diese einfache Python-Anwendung sendet eine Anforderung an die API und gibt eine Liste der vorgeschlagenen Korrekturen zurück.

Obwohl diese Anwendung in Python geschrieben ist, ist die API ein RESTful-Webdienst, der mit den meisten Programmiersprachen kompatibel ist. Der Quellcode für diese Anwendung ist auf GitHub verfügbar.

Voraussetzungen

Erstellen einer Azure-Ressource

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

Bing-Rechtschreibprüfungsressource

  • Verfügbar über das Azure-Portal, bis Sie die Ressource löschen.
  • Verwenden Sie das kostenlose Preisniveau, um den Dienst auszuprobieren und später auf eine kostenpflichtige Stufe für die Produktion zu aktualisieren.
  • Die Bing-Rechtschreibprüfungs-API wird auch in einigen Ebenen der Bing Search v7-Ressourceangeboten.

Ressource für mehrere Dienste

  • Verfügbar über das Azure-Portal, bis Sie die Ressource löschen.
  • Verwenden Sie denselben Schlüssel und Endpunkt für Ihre Anwendungen in mehreren Azure AI-Diensten.

Initialisieren der Anwendung

  1. Erstellen Sie eine neue Python-Datei in Ihrer bevorzugten IDE oder Ihrem Bevorzugten Editor, und fügen Sie die folgenden Importanweisungen hinzu:

    import requests
    import json
    
  2. Erstellen Sie Variablen für den Text, den Sie auf Rechtschreibung prüfen möchten, Ihren Abonnementschlüssel und Ihren Bing-Rechtschreibprüfungsendpunkt. Sie können den globalen Endpunkt im folgenden Code verwenden oder den benutzerdefinierten Unterdomänen- Endpunkt verwenden, der im Azure-Portal für Ihre Ressource angezeigt wird.

    api_key = "<ENTER-KEY-HERE>"
    example_text = "Hollo, wrld" # the text to be spell-checked
    endpoint = "https://api.cognitive.microsoft.com/bing/v7.0/SpellCheck"
    

Erstellen der Parameter für die Anforderung

  1. Erstellen Sie ein neues Wörterbuch mit text dem Schlüssel und dem Text als Wert.

    data = {'text': example_text}
    
  2. Fügen Sie die Parameter für Ihre Anforderung hinzu:

    1. Weisen Sie Ihrem Marktcode den Parameter mkt mit dem =-Operator zu. Der Marktcode ist der Code des Landes/der Region, aus dem 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 (behebt die meisten Rechtschreib- und Grammatikfehler) oder spell (behebt die meisten Rechtschreibfehler, aber nicht so viele Grammatikfehler) sein.

    params = {
        'mkt':'en-us',
        'mode':'proof'
        }
    
  3. Fügen Sie dem Content-Type-Header und dem Ocp-Apim-Subscription-Key-Header Ihren Abonnementschlüssel hinzu.

    headers = {
        'Content-Type': 'application/x-www-form-urlencoded',
        'Ocp-Apim-Subscription-Key': api_key,
        }
    

Senden der Anforderung und Lesen der Antwort

  1. Senden Sie die POST-Anforderung mithilfe der Anforderungsbibliothek.

    response = requests.post(endpoint, headers=headers, params=params, data=data)
    
  2. Rufen Sie die JSON-Antwort ab, und drucken Sie sie.

    json_response = response.json()
    print(json.dumps(json_response, indent=4))
    

Ausführen der Anwendung

Wenn Sie die Befehlszeile verwenden, verwenden Sie den folgenden Befehl, um die Anwendung auszuführen:

python <FILE_NAME>.py

Beispiel für JSON-Antwort

Eine erfolgreiche Antwort wird in JSON 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