Sugerir termos de consulta

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.

Normalmente, chamaria a API de Sugestão Automática do Bing sempre que um utilizador escreve um novo caráter na caixa de pesquisa da sua aplicação. A exatidão da cadeia de consulta afeta a relevância dos termos de consulta sugeridos devolvidos pela API. Quanto mais completa for a cadeia de consulta, mais relevante será a lista de termos de consulta sugeridos. Por exemplo, as sugestões que a API pode devolver s são provavelmente menos relevantes do que as consultas que devolve para sailing dinghies.

Pedido de exemplo

O seguinte exemplo mostra um pedido que devolve as cadeias de consulta sugeridas para sail. Não se esqueça de codificar com URL o termo de consulta parcial do utilizador quando definir o parâmetro de consulta q. Por exemplo, se o utilizador introduzir sailing les, defina q como sailing+les ou sailing%20les.

GET https://api.cognitive.microsoft.com/bing/v7.0/suggestions?q=sail&mkt=en-us HTTP/1.1
Ocp-Apim-Subscription-Key: 123456789ABCDE
X-MSEdge-ClientIP: 999.999.999.999
X-Search-Location: lat:47.60357;long:-122.3295;re:100
X-MSEdge-ClientID: <blobFromPriorResponseGoesHere>
Host: api.cognitive.microsoft.com

A seguinte resposta contém uma lista de objetos SearchAction com os termos de consulta sugeridos.

{
    "url" : "https:\/\/www.bing.com\/search?q=sailing+lessons+seattle&FORM=USBAPI",
    "displayText" : "sailing lessons seattle",
    "query" : "sailing lessons seattle",
    "searchKind" : "WebSearch"
}, ...

Utilizar termos de consulta sugeridos

Cada sugestão inclui um campo displayText, query e url. O campo displayText contém a consulta sugerida que utiliza para preencher a lista pendente da sua caixa de pesquisa. Tem de apresentar todas as sugestões incluídas na resposta e pela ordem fornecida.

O exemplo seguinte mostra uma caixa de pesquisa pendente com termos de consulta sugeridos da API de Sugestão Automática do Bing.

Lista da caixa de pesquisa pendente de sugestão automática

Se o utilizador selecionar uma consulta sugerida na lista pendente, utilizará o termo de consulta no campo query para chamar a API de Pesquisa na Web do Bing e apresentar os resultados. Em alternativa, pode utilizar o URL no campo url para direcionar o utilizador para a página de resultados da pesquisa do Bing.

Passos seguintes