Inicio rápido: Revisión ortográfica con la API REST de Bing Spell Check y Node.js

Advertencia

El 30 de octubre de 2020, las API de Bing Search se trasladaron de los servicios de Azure AI a los servicios de Bing Search. Esta documentación se proporciona solo como referencia. Para obtener documentación actualizada, consulte la documentación de Bing Search API. Para obtener instrucciones sobre cómo crear nuevos recursos de Azure para Bing Search, consulte el artículo sobre la creación de un recurso de Bing Search a través de Azure Marketplace.

Use este inicio rápido para realizar la primera llamada a la API REST de Bing Spell Check. Esta sencilla aplicación de JavaScript envía una solicitud a la API y devuelve una lista de correcciones sugeridas.

Aunque esta aplicación está escrita en JavaScript, la API es un servicio web RESTful compatible con la mayoría de los lenguajes de programación. El código fuente de esta aplicación está disponible en GitHub.

Prerrequisitos

• Node.js 6 o posterior.

Creación de un recurso de Azure

Para empezar a usar la API Bing Spell Check, cree uno de los siguientes recursos de Azure:

Recurso de Bing Spell Check

• Disponible en Azure Portal hasta que lo elimine.
• Use el plan de tarifa gratuito para probar el servicio y actualícelo más adelante a un nivel de pago para producción.
• API Bing Spell Check también se ofrece en algunos niveles del recurso Bing Search, versión 7.

Recurso de varios servicios

• Disponible en Azure Portal hasta que lo elimine.
• Utilice la misma clave y el mismo punto de conexión para sus aplicaciones en varios servicios de Azure AI.

Creación e inicialización de un proyecto

1. Cree un archivo de JavaScript en su IDE o editor favorito. Establezca la rigurosidad y que se requiera https. A continuación, cree variables para el host, la ruta de acceso y la clave de suscripción del punto de conexión de API. Puede usar el punto de conexión global en el código siguiente, o el punto de conexión del subdominio personalizado que se muestra en Azure Portal para el recurso.

   'use strict';
   let https = require ('https');
   
   let host = 'api.cognitive.microsoft.com';
   let path = '/bing/v7.0/spellcheck';
   let key = '<ENTER-KEY-HERE>';
   

2. Cree las variables de los parámetros de búsqueda y el texto que desea comprobar:

   1. Asigne el código de mercado al parámetro mkt con el operador =. El código de mercado es el código del país desde el que se realiza la solicitud.

   2. Agregue el parámetro mode con el operador & y, a continuación, asigne el modo de revisión ortográfica. El modo puede ser proof (detecta la mayoría de los errores ortográficos y gramaticales) o spell (detecta la mayoría de los errores ortográficos, pero no todos los gramaticales).

   let mkt = "en-US";
   let mode = "proof";
   let text = "Hollo, wrld!";
   let query_string = "?mkt=" + mkt + "&mode=" + mode;
   

Creación de los parámetros de solicitud

Para crear los parámetros de solicitud, cree un objeto con un método POST. Agregue la ruta de acceso mediante la anexión de la ruta de acceso del punto de conexión y la cadena de consulta. A continuación, agregue la clave de suscripción al encabezado 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,
   }
};

Creación de un controlador de respuesta

Cree una función denominada response_handler que tome la respuesta JSON de la API e imprímala. Cree una variable para el cuerpo de la respuesta. Anexe la respuesta cuando se reciba una marca data, mediante response.on(). Después de recibir una marca end, imprima el cuerpo JSON en la consola.

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

Envío de la solicitud

Llame a la API mediante https.request() con los parámetros de solicitud y el controlador de respuesta. Escriba el texto en la API y finalice la solicitud.

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

Ejecución de la aplicación

1. Compile y ejecute el proyecto.

2. Si usa la línea de comandos, utilice los siguientes comandos para compilar y ejecutar la aplicación:

   node <FILE_NAME>.js
   

Ejemplo de respuesta JSON

Se devuelve una respuesta correcta en JSON, como se muestra en el siguiente ejemplo:

{
   "_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 siguientes

Creación de una aplicación web de una sola página

• ¿Qué es Bing Spell Check API?
• Referencia de la API Bing Spell Check v7