Share via


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

Aviso

A 30 de outubro de 2020, as APIs de Pesquisa do Bing passaram dos serviços de IA do Azure para os Serviços Pesquisa do Bing. Esta documentação é fornecida apenas para referência. Para obter documentação atualizada, veja 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, veja Criar um recurso de Pesquisa do Bing através do Azure Marketplace.

Utilize este início rápido para efetuar a sua primeira chamada à API REST de Verificação ortográfica do Bing. Esta aplicação JavaScript simples envia um pedido para a API e devolve uma lista de correções sugeridas.

Embora esta aplicação esteja escrita em JavaScript, a API é um serviço Web RESTful compatível com a maioria das linguagens de programação. O código fonte desta aplicação está disponível no GitHub.

Pré-requisitos

Criar um recurso do Azure

Comece a utilizar a API de Verificação ortográfica do Bing ao criar um dos seguintes recursos do Azure:

Recurso de Verificação Ortográfica do Bing

  • Disponível através do portal do Azure até eliminar o recurso.
  • Utilize o escalão de preço gratuito para experimentar o serviço e atualize mais tarde para um escalão pago para produção.
  • A API de Verificação ortográfica do Bing também é disponibilizada em alguns escalões do recurso Pesquisa do Bing v7.

Recurso multi-serviço

  • Disponível através do portal do Azure até eliminar o recurso.
  • Utilize a mesma chave e ponto final para as suas aplicações, em vários serviços de IA do Azure.

Criar e inicializar um projeto

  1. Crie um novo ficheiro JavaScript no seu IDE ou editor favorito. Defina a rigor e exija https. Em seguida, crie variáveis para o anfitrião, caminho e chave de subscrição do ponto final da API. Pode utilizar o ponto final global no seguinte código ou utilizar o ponto final de subdomínio personalizado apresentado no portal do Azure do 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 pretende verificar:

    1. Atribua o código de mercado ao mkt parâmetro com o = operador. O código de mercado é o código do país/região a partir do qual efetua o pedido.

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

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

Criar os parâmetros do pedido

Crie os parâmetros do pedido ao criar um novo objeto com um POST método. Adicione o seu caminho ao anexar o caminho do ponto final e à cadeia de consulta. Em seguida, adicione a chave de subscrição ao Ocp-Apim-Subscription-Key cabeçalho.

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 processador de resposta

Crie uma função chamada response_handler para obter a resposta JSON da API e imprimi-la. Crie uma variável para o corpo da resposta. Acrescente a resposta quando um data sinalizador é recebido com response.on(). Depois de receber um end sinalizador, imprima o corpo JSON na 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);
    });
};

Enviar o pedido

Chame a API com https.request() os parâmetros do pedido e o processador de resposta. Escreva o seu texto na API e, em seguida, termine o pedido.

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

Executar a aplicação

  1. Crie e execute o seu projeto.

  2. Se estiver a utilizar a linha de comandos, utilize o seguinte comando para criar e executar a aplicação:

    node <FILE_NAME>.js
    

Resposta JSON de exemplo

É devolvida uma resposta com êxito em JSON, tal como é apresentado no exemplo seguinte:

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

Passos seguintes