Schnellstart: Überprüfen der Rechtschreibung mit der Bing-Rechtschreibprüfungs-REST-API und JavaQuickstart: Check spelling with the Bing Spell Check REST API and Java

Verwenden Sie diese Schnellstartanleitung, um die Bing-Rechtschreibprüfungs-REST-API zum ersten Mal aufzurufen.Use this quickstart to make your first call to the Bing Spell Check REST API. Diese einfache Java-Anwendung sendet eine Anforderung an die API und gibt eine Liste mit Korrekturvorschlägen zurück.This simple Java application sends a request to the API and returns a list of suggested corrections. Diese Anwendung ist in Java geschrieben, die API ist jedoch ein RESTful-Webdienst, der mit den meisten Programmiersprachen kompatibel ist.While this application is written in Java, the API is a RESTful web service compatible with most programming languages. Der Quellcode für diese Anwendung ist auf GitHub verfügbar.The source code for this application is available on GitHub.

VoraussetzungenPrerequisites

  • Das Java Development Kit (JDK) 7 oder höherThe Java Development Kit(JDK) 7 or later.

  • Importieren Sie gson-2.8.5.jar oder die neueste Gson-Version.Import the gson-2.8.5.jar or the most current Gson version. Für die Befehlszeilenausführung fügen Sie .jar mit der „main“-Klasse Ihrem Java-Ordner hinzu.For command line execution, add the .jar to your Java folder with the main class.

Sie benötigen ein Cognitive Services-API-Konto mit Zugriff auf die Bing-Rechtschreibprüfungs-API.You must have a Cognitive Services API account with access to the Bing Spell Check API. Falls Sie nicht über ein Azure-Abonnement verfügen, können Sie ein kostenloses Konto erstellen.If you don't have an Azure subscription, you can create an account for free. Vor dem Fortfahren benötigen Sie den Zugriffsschlüssel, der nach dem Aktivieren Ihrer kostenlosen Testversion bereitgestellt wird. Alternativ hierzu können Sie auch den Schlüssel eines kostenpflichtigen Abonnements aus Ihrem Azure-Dashboard verwenden.Before continuing, You will need the access key provided after activating your free trial, or a paid subscription key from your Azure dashboard.

Erstellen und Initialisieren einer AnwendungCreate and initialize an application

  1. Erstellen Sie ein neues Java-Projekt in Ihrer bevorzugten IDE oder in Ihrem bevorzugten Editor mit einem Klassennamen Ihrer Wahl, und importieren Sie die folgenden Pakete.Create a new Java Project in your favorite IDE or editor with a class name of your choosing, and then import the following packages.

    import java.io.*;
    import java.net.*;
    import com.google.gson.*;
    import javax.net.ssl.HttpsURLConnection;
    
  2. Erstellen Sie Variablen für den Host, Pfad und Abonnementschlüssel Ihres API-Endpunkts.Create variables for the API endpoint's host, path, and your subscription key. Erstellen Sie anschließend Variablen für Ihren Markt, für den Text, für den die Rechtschreibprüfung ausgeführt werden soll, und für eine Zeichenfolge für den Rechtschreibprüfungsmodus.Then create variables for your market, the text you want to spell check, and a string for the spell check mode.

    static String host = "https://api.cognitive.microsoft.com";
    static String path = "/bing/v7.0/spellcheck";
    
    static String key = "<ENTER-KEY-HERE>";
    
    static String mkt = "en-US";
    static String mode = "proof";
    static String text = "Hollo, wrld!";
    

Erstellen und Senden einer API-AnforderungCreate and send an API request

  1. Erstellen Sie eine Funktion namens check(), um die API-Anforderung zu erstellen und zu senden.Create a function called check() to create and send the API request. Führen Sie darin die folgenden Schritte aus:Within it, follow these steps. Erstellen Sie eine Zeichenfolge für die Anforderungsparameter.Create a string for the request parameters. Fügen Sie den Parameter ?mkt= an die Marktzeichenfolge und den Parameter &mode= an den Rechtschreibprüfungsmodus an.append the ?mkt= parameter to your market string, and the &mode= parameter to your spell check mode.

    public static void check () throws Exception {
        String params = "?mkt=" + mkt + "&mode=" + mode;
       // add the rest of the code snippets here (except prettify() and main())...
    }
    
  2. Kombinieren Sie Host, Pfad und Parameterzeichenfolge Ihres Endpunkts, um eine URL zu erstellen. Erstellen Sie ein neues HttpsURLConnection-Objekt.Create a new HttpsURLConnection object.

    URL url = new URL(host + path + params);
    HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
    
  3. Öffnen Sie die URL.Open a connection to the URL. Legt die Anforderungsmethode auf POST fest.Set the request method to POST. Fügen Sie Ihre Anforderungsparameter hinzu.Add your request parameters. Achten Sie darauf, dass Sie dem Header Ocp-Apim-Subscription-Key Ihren Abonnementschlüssel hinzufügen.Make sure to add your subscription key to the Ocp-Apim-Subscription-Key header.

    connection.setRequestMethod("POST");
    connection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
    connection.setRequestProperty("Ocp-Apim-Subscription-Key", key);
    connection.setDoOutput(true);
    
  4. Erstellen Sie ein neues DataOutputStream-Objekt, und senden Sie die Anforderung an die API.Create a new DataOutputStream object and Send the request to the API.

        DataOutputStream wr = new DataOutputStream(connection.getOutputStream());
        wr.writeBytes("text=" + text);
        wr.flush();
        wr.close();
    

Formatieren und Lesen der API-AntwortFormat and read the API response

  1. Fügen Sie diese Methode Ihrer Klasse hinzu.Add this method to your class. Sie formatiert den JSON-Code für eine besser lesbare Ausgabe.It formats the JSON for a more readable output.

    // This function prettifies the json response.
    public static String prettify(String json_text) {
        JsonParser parser = new JsonParser();
        JsonElement json = parser.parse(json_text);
        Gson gson = new GsonBuilder().setPrettyPrinting().create();
        return gson.toJson(json);
    }
    
  2. Erstellen Sie ein BufferedReader-Element, und lesen Sie die Antwort der API.Create a BufferedReader and read the response from the API. Geben Sie sie in der Konsole aus.Print it to the console.

    BufferedReader in = new BufferedReader(
    new InputStreamReader(connection.getInputStream()));
    String line;
    while ((line = in.readLine()) != null) {
        System.out.println(prettify(line));
    }
    in.close();
    

Aufrufen der APICall the API

Rufen Sie in der „main“-Funktion Ihrer Anwendung die oben erstellte „check()“-Methode auf.In the main function of your application, call your check() method created above.

        public static void main(String[] args) {
            try {
                check();
            }
            catch (Exception e) {
                System.out.println (e);
            }
        }

Ausführen der AnwendungRun the application

Erstellen Sie Ihr Projekt, und führen Sie es aus.Build and run your project.

Geben Sie bei Verwenden der Befehlszeile die folgenden Befehle an, um die Anwendung zu erstellen und auszuführen.If you're using the command line, use the following commands to build and run the application.

Zum Erstellen:Build:

javac -classpath .;gson-2.2.2.jar\* <CLASS_NAME>.java

Zum Ausführen:Run:

java -cp .;gson-2.2.2.jar\* <CLASS_NAME>

JSON-BeispielantwortExample JSON response

Es wird eine erfolgreiche Antwort im JSON-Format zurückgegeben, wie im folgenden Beispiel gezeigt:A successful response is returned in JSON, as shown in the following example:

{
   "_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 SchritteNext steps