Início Rápido: Enviar uma solicitação de pesquisa à API REST de Pesquisa de Entidade do Bing usando Python

  • Artigo

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 de Pesquisa de Entidade do Bing e exibir a resposta JSON. Este aplicativo Python simples envia uma consulta de pesquisa de notícias para a API e exibe a resposta. O código-fonte deste exemplo está disponível no GitHub.

Embora esse aplicativo seja escrito em Python, a API é um serviço Web RESTful compatível com a maioria das linguagens de programação.

Pré-requisitos

Criar um recurso do Azure

Comece a usar a API de Pesquisa de Entidade do Bing criando um dos recursos do Azure a seguir.

Recurso de Pesquisa de Entidade 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 Pesquisa de Entidade do Bing também é oferecida em camadas pagas 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 o aplicativo

  1. Crie um novo arquivo Python em seu IDE ou editor favorito e adicione as seguintes importações. Crie variáveis para a chave de assinatura, o ponto de extremidade, o mercado e a consulta de pesquisa. É 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.

    import http.client, urllib.parse
import json

subscriptionKey = 'ENTER YOUR KEY HERE'
host = 'api.bing.microsoft.com'
path = '/v7.0/search'
mkt = 'en-US'
query = 'italian restaurants near me'

  2. Crie uma url de solicitação acrescentando sua variável de mercado ao parâmetro ?mkt=. Codifique a consulta como URL e acrescente-a ao parâmetro &q=.

    params = '?mkt=' + mkt + '&q=' + urllib.parse.quote (query)

Enviar uma solicitação e obter uma resposta

  1. Crie uma função chamada get_suggestions().

  2. Nessa função, adicione a chave de assinatura a um dicionário que tem Ocp-Apim-Subscription-Key como chave.

  3. Use http.client.HTTPSConnection() para criar um objeto de cliente HTTPS. Envie uma solicitação GET usando request() com seu caminho e parâmetros e informações de cabeçalho.

  4. Armazene a resposta com getresponse() e retorne response.read().

    def get_suggestions ():
 headers = {'Ocp-Apim-Subscription-Key': subscriptionKey}
 conn = http.client.HTTPSConnection (host)
 conn.request ("GET", path + params, None, headers)
 response = conn.getresponse ()
 return response.read()

  5. Chame get_suggestions() e imprima a resposta JSON.

    result = get_suggestions ()
print (json.dumps(json.loads(result), indent=4))

Resposta JSON de exemplo

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

{
  "_type": "SearchResponse",
  "queryContext": {
    "originalQuery": "italian restaurant near me",
    "askUserForLocation": true
  },
  "places": {
    "value": [
      {
        "_type": "LocalBusiness",
        "webSearchUrl": "https://www.bing.com/search?q=sinful+bakery&filters=local...",
        "name": "Liberty's Delightful Sinful Bakery & Cafe",
        "url": "https://www.contoso.com/",
        "entityPresentationInfo": {
          "entityScenario": "ListItem",
          "entityTypeHints": [
            "Place",
            "LocalBusiness"
          ]
        },
        "address": {
          "addressLocality": "Seattle",
          "addressRegion": "WA",
          "postalCode": "98112",
          "addressCountry": "US",
          "neighborhood": "Madison Park"
        },
        "telephone": "(800) 555-1212"
      },

      . . .
      {
        "_type": "Restaurant",
        "webSearchUrl": "https://www.bing.com/search?q=Pickles+and+Preserves...",
        "name": "Munson's Pickles and Preserves Farm",
        "url": "https://www.princi.com/",
        "entityPresentationInfo": {
          "entityScenario": "ListItem",
          "entityTypeHints": [
            "Place",
            "LocalBusiness",
            "Restaurant"
          ]
        },
        "address": {
          "addressLocality": "Seattle",
          "addressRegion": "WA",
          "postalCode": "98101",
          "addressCountry": "US",
          "neighborhood": "Capitol Hill"
        },
        "telephone": "(800) 555-1212"
      },
      
      . . .
    ]
  }
}

Próximas etapas

Criar um aplicativo Web de página única