Compartilhar via


Início Rápido: Verificar a ortografia com a API REST de Verificação Ortográfica do Bing e o Node.js

Aviso

Em 30 de outubro de 2020, as APIs de Pesquisa do Bing foram migradas dos serviços de IA do Azure para os Serviços de Pesquisa do Bing. Esta documentação é fornecida apenas para referência. Para obter a documentação atualizada, consulte a documentação da API de pesquisa do Bing. Para obter instruções sobre como criar novos recursos do Azure para a Pesquisa do Bing, consulte Criar um recurso de Pesquisa do Bing por meio do Azure Marketplace.

Use este Início Rápido para fazer sua primeira chamada à API REST de Verificação Ortográfica do Bing. Este aplicativo JavaScript simples envia uma solicitação à API e retorna uma lista de correções sugeridas.

Embora esse aplicativo seja escrito em JavaScript, a API é um serviço Web RESTful compatível com a maioria das linguagens de programação. O código-fonte desse aplicativo está disponível no GitHub.

Pré-requisitos

Criar um recurso do Azure

Comece usando a API de Verificação Ortográfica do Bing criando um dos seguintes recursos do Azure:

Recurso de Verificação Ortográfica do Bing

  • Disponível por meio do portal do Azure até que você exclua o recurso.
  • Use o tipo de preço gratuito para experimentar o serviço e atualize mais tarde para uma camada paga para produção.
  • A API de Verificação Ortográfica do Bing também é oferecida em algumas camadas do recurso Pesquisa do Bing v7.

Recurso de vários serviços

  • Disponível por meio do portal do Azure até que você exclua o recurso.
  • Use a mesma chave e ponto de extremidade para seus aplicativos nos vários serviços de IA do Azure.

Criar e inicializar um projeto

  1. Crie um novo arquivo JavaScript em seu IDE ou editor favorito. Defina o rigor e exija https. Em seguida, crie variáveis para o host do ponto de extremidade de API, o caminho e a chave de assinatura. É possível usar o ponto de extremidade global no código a seguir ou o ponto de extremidade do subdomínio personalizado exibido no portal do Azure para seu 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. Crie variáveis para os parâmetros de pesquisa e o texto que deseja verificar:

    1. Atribua seu código de mercado ao parâmetro mkt com o operador =. O código de mercado é o código do país/da região em que você faz a solicitação.

    2. Adicione o parâmetro mode com o operador & e, em seguida, atribua o modo de verificação ortográfica. O modo pode ser proof (captura a maioria dos erros de ortografia/gramática) ou spell (captura a maioria dos erros de ortografia, mas não tantos erros de gramática).

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

Criar os parâmetros de solicitação

Crie os parâmetros de solicitação criando um objeto com um método POST. Adicione o caminho acrescentando o caminho do ponto de extremidade e a cadeia de consulta. Em seguida, adicione a chave de assinatura ao cabeçalho 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,
   }
};

Criar um manipulador de resposta

Crie uma função chamada response_handler para obter a resposta JSON da API e imprima-a. Criar uma variável para o corpo da resposta. Acrescente a resposta quando um sinalizador data for recebido, usando response.on(). Depois que um sinalizador end for recebido, imprima o corpo JSON no console.

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

Enviar a solicitação

Chame a API usando https.request() com os parâmetros de solicitação e o manipulador de resposta. Escreva o texto na API e encerre a solicitação.

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

Executar o aplicativo

  1. Compile e execute seu projeto.

  2. Se estiver usando a linha de comando, use o seguinte comando para criar e executar o aplicativo:

    node <FILE_NAME>.js
    

Resposta JSON de exemplo

Uma resposta com êxito é retornada em JSON, conforme mostrado no seguinte exemplo:

{
   "_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
            }
         ]
      }
   ]
}

Próximas etapas