Inicio rápido: Revisión ortográfica con la API REST de Bing Spell Check y JavaQuickstart: Check spelling with the Bing Spell Check REST API and Java

Use este inicio rápido para realizar la primera llamada a la API REST de Bing Spell Check.Use this quickstart to make your first call to the Bing Spell Check REST API. Esta sencilla aplicación de Java envía una solicitud a la API y devuelve una lista de correcciones sugeridas.This simple Java application sends a request to the API and returns a list of suggested corrections. Si bien esta aplicación está escrita en Java, la API es un servicio web RESTful compatible con la mayoría de los lenguajes de programación.While this application is written in Java, the API is a RESTful web service compatible with most programming languages. El código fuente de esta aplicación está disponible en GitHub.The source code for this application is available on GitHub.

Requisitos previosPrerequisites

  • Kit de desarrollo de Java (JDK) 7 o superiorThe Java Development Kit(JDK) 7 or later.

  • Importe el archivo gson-2.8.5.jar o la versión más actual de Gson.Import the gson-2.8.5.jar or the most current Gson version. Para la ejecución de la línea de comandos, agregue el archivo .jar a la carpeta de Java con la clase principal.For command line execution, add the .jar to your Java folder with the main class.

Debe tener una cuenta de Cognitive Services API con acceso a Bing Spell Check API.You must have a Cognitive Services API account with access to the Bing Spell Check API. Si no tiene una suscripción de Azure, puede crear una cuenta gratuita.If you don't have an Azure subscription, you can create an account for free. Antes de continuar, necesitará la clave de acceso que se le proporcionó al activar la versión de evaluación gratuita o puede usar una clave de suscripción de pago desde el panel de Azure.Before continuing, You will need the access key provided after activating your free trial, or a paid subscription key from your Azure dashboard.

Creación e inicialización de una aplicaciónCreate and initialize an application

  1. Cree un nuevo proyecto de Java en su IDE o editor favoritos con el nombre de clase que elija e importe los siguientes paquetes.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. Cree variables para el host, la ruta de acceso y la clave de suscripción del punto de conexión de API.Create variables for the API endpoint's host, path, and your subscription key. A continuación, cree variables para su mercado, el texto cuya ortografía quiere revisar y una cadena para el modo de revisión ortográfica.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!";
    

Creación y envío de una solicitud de APICreate and send an API request

  1. Cree una función llamada check() para crear y enviar la solicitud de API.Create a function called check() to create and send the API request. Dentro de ella, siga estos pasos.Within it, follow these steps. Cree una cadena para los parámetros de solicitud.Create a string for the request parameters. Anexe el parámetro ?mkt= a la cadena de su mercado y el parámetro &mode= al modo de revisión ortográfica.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. Cree una dirección URL mediante la combinación del host, la ruta de acceso y la cadena de parámetros del punto de conexión. Cree un nuevo objeto HttpsURLConnection.Create a new HttpsURLConnection object.

    URL url = new URL(host + path + params);
    HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
    
  3. Abra una conexión a la dirección URL.Open a connection to the URL. Establezca el método de solicitud en POST.Set the request method to POST. Agregue los parámetros de solicitud.Add your request parameters. No olvide agregar la clave de suscripción al encabezado Ocp-Apim-Subscription-Key.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. Cree un objeto DataOutputStream y envíe la solicitud a la 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();
    

Formato y lectura de la respuesta de APIFormat and read the API response

  1. Agregue este método a la clase.Add this method to your class. Dicho método da formato a JSON para obtener una salida más legible.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. Cree un objeto BufferedReader y lea la respuesta de la API.Create a BufferedReader and read the response from the API. Imprímala en la consola.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();
    

Llamada a la APICall the API

En la función principal de la aplicación, llame al método check() creado anteriormente.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);
            }
        }

Ejecución de la aplicaciónRun the application

Compile y ejecute el proyecto.Build and run your project.

Si usa la línea de comandos, use los siguientes comandos para compilar y ejecutar la aplicación.If you're using the command line, use the following commands to build and run the application.

Compilar:Build:

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

Ejecutar:Run:

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

Ejemplo de respuesta JSONExample JSON response

Se devuelve una respuesta correcta en JSON, como se muestra en el siguiente ejemplo: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
            }
         ]
      }
   ]
}

Pasos siguientesNext steps