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

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

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

Pré-requisitos

• Python 3.x

Criar um recurso do Azure

Comece a usar 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 plano de preços gratuito para experimentar o serviço, e depois mude para um plano pago para fins de produção.
• A API de Verificação Ortográfica do Bing também é oferecida em algumas camadas do recurso Bing Search 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, em vários serviços de IA do Azure.

Inicializar o aplicativo

1. Crie um novo arquivo Python em seu IDE ou editor favorito e adicione as seguintes instruções de importação:

   import requests
   import json
   

2. Crie variáveis para o texto que você deseja verificar ortograficamente, sua chave de assinatura e o endpoint de Verificação Ortográfica do Bing. Você pode usar o ponto de extremidade global no código a seguir ou usar o ponto de extremidade do subdomínio personalizado exibido no portal do Azure para seu recurso.

   api_key = "<ENTER-KEY-HERE>"
   example_text = "Hollo, wrld" # the text to be spell-checked
   endpoint = "https://api.cognitive.microsoft.com/bing/v7.0/SpellCheck"
   

Criar os parâmetros para a solicitação

1. Crie um novo dicionário com text a chave e o texto como o valor.

   data = {'text': example_text}
   

2. Adicione os parâmetros para sua solicitação:

   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/região do qual você faz a solicitação.

   2. Adicione o parâmetro mode com o operador & e 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).

   params = {
       'mkt':'en-us',
       'mode':'proof'
       }
   

3. Adicione um Content-Type cabeçalho e sua chave de assinatura ao Ocp-Apim-Subscription-Key cabeçalho.

   headers = {
       'Content-Type': 'application/x-www-form-urlencoded',
       'Ocp-Apim-Subscription-Key': api_key,
       }
   

Enviar a solicitação e ler a resposta

1. Envie a solicitação POST usando a biblioteca de solicitações.

   response = requests.post(endpoint, headers=headers, params=params, data=data)
   

2. Obtenha a resposta JSON e imprima-a.

   json_response = response.json()
   print(json.dumps(json_response, indent=4))
   

Executar o aplicativo

Se você estiver usando a linha de comando, use o seguinte comando para executar o aplicativo:

python <FILE_NAME>.py

Exemplo de resposta JSON

Uma resposta bem-sucedida é retornada no JSON, conforme mostrado no exemplo a seguir:

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

• O que é a API de Verificação Ortográfica do Bing?
• referência da API de Verificação Ortográfica do Bing v7