Como percorrer as páginas de resultados das APIs de Pesquisa do Bing

  • 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.

Quando você envia uma chamada às APIs de Pesquisa na Web, Personalizada, Imagem, Notícias ou Vídeo, o Bing retorna um subconjunto do número total de resultados que podem ser relevantes para a consulta. Para obter o número total estimado de resultados disponíveis, acesse o campo totalEstimatedMatches do objeto de resposta.

Por exemplo:

{
    "_type" : "SearchResponse",
    "webPages" : {
        "webSearchUrl" : "https:\/\/www.bing.com\/cr?IG=3A43CA...",
        "totalEstimatedMatches" : 262000,
        "value" : [...]
    }
}

Paginar os resultados da pesquisa

Para percorrer as páginas de resultados disponíveis, use os parâmetros de consulta count e offset ao enviar a solicitação.

Observação

  • A paginação com as APIs de vídeo, imagem e notícias do Bing se aplica somente às pesquisas gerais de vídeo (/video/search), notícias (/news/search) e imagem (/image/search). Não há compatibilidade com a paginação por meio de tópicos mais populares e categorias.
  • O campo TotalEstimatedMatches é uma estimativa do número total de resultados da pesquisa da consulta atual. Quando você define os parâmetros count e offset, essa estimativa pode ser alterada.
Parâmetro Descrição
count Especifica o número de resultados a serem retornados na resposta. Observe que o valor padrão de count e o número máximo de resultados que você pode solicitar variam de acordo com a API. Encontre esses valores na documentação de referência em Próximas etapas.
offset Especifica o número de resultados para ignorar. O offset é baseado em zero e deve ser menor que (totalEstimatedMatches - count).

Por exemplo, se você quiser exibir 15 artigos por página, defina count como 15 e offset como 0 para a primeira página de resultados. Para cada chamada à API subsequente, aumente offset em 15. O exemplo a seguir solicita 15 páginas da Web começando no deslocamento 45.

GET https://api.cognitive.microsoft.com/bing/v7.0/search?q=sailing+dinghies&count=15&offset=45&mkt=en-us HTTP/1.1  
Ocp-Apim-Subscription-Key: 123456789ABCDE  
Host: api.cognitive.microsoft.com

Se você usar o valor padrão count, só precisará especificar o parâmetro de consulta offset nas chamadas à API.

GET https://api.cognitive.microsoft.com/bing/v7.0/search?q=sailing+dinghies&offset=45&mkt=en-us HTTP/1.1  
Ocp-Apim-Subscription-Key: 123456789ABCDE  
Host: api.cognitive.microsoft.com

Ao usar as APIs de Imagem e Vídeo do Bing, você pode usar o valor nextOffset para evitar resultados da pesquisa duplicados. Obtenha o valor dos objetos de resposta Images ou Videos e o use em suas solicitações com o parâmetro offset.

Observação

A API de Pesquisa na Web do Bing retorna resultados que podem incluir páginas da Web, imagens, vídeos e notícias. Ao percorrer as páginas de resultados da API de Pesquisa na Web do Bing, você está percorrendo apenas WebPages, e não outros tipos de resposta, como imagens ou notícias. Os resultados da pesquisa em objetos WebPage podem incluir resultados que também aparecem em outros tipos de resposta.

Se você usar o parâmetro de consulta responseFilter sem especificar nenhum valor de filtro, não use os parâmetros count e offset.

Próximas etapas