Compartilhar via


Atualizar da API de Pesquisa na Web do Bing v5 para v7

Aviso

Em 30 de outubro de 2020, as APIs de Pesquisa do Bing foram transferidas 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 dodo Azure Marketplace.

Este guia de atualização identifica as alterações entre a versão 5 e a versão 7 da API de Pesquisa na Web do Bing. Use este guia para ajudá-lo a identificar as partes do aplicativo que você precisa atualizar para usar a versão 7.

Alterações da falha

Pontos de extremidade

  • O número de versão do endpoint API foi alterado de v5 para v7. Por exemplo, https://api.cognitive.microsoft.com/bing/v7.0/search.

Objetos de resposta de erro e códigos de erro

  • Todas as solicitações com falha agora devem incluir um objeto ErrorResponse no corpo da resposta.

  • Os campos a seguir foram adicionados ao objeto Error.

    • subCode— Particiona o código de erro em buckets discretos, se possível
    • moreDetails— Informações adicionais sobre o erro descrito no campo message
  • Os códigos de erro v5 foram substituídos pelos seguintes valores possíveis de code e subCode.

Código Subcódigo Descrição
ServerError ErroInesperado
ResourceError
Não Implementado
O Bing retorna ServerError sempre que qualquer uma das condições de subcodificação ocorrer. A resposta incluirá esses erros se o código de status HTTP for 500.
SolicitaçãoInválida ParâmetroAusente
ValorDeParâmetroInválido
HttpNãoPermitido
Bloqueado
O Bing retorna InvalidRequest sempre que qualquer parte da solicitação não é válida. Por exemplo, um parâmetro necessário está ausente ou um valor de parâmetro não é válido.

Se o erro for ParameterMissing ou ParameterInvalidValue, o código de status HTTP será 400.

Se o erro for HttpNotAllowed, o código de status HTTP é 410.
Limite de Taxa Excedido O Bing retorna RateLimitExceeded sempre que você excede suas consultas por segundo (QPS) ou a cota de consultas por mês (QPM).

O Bing retornará o código de status HTTP 429 se você excedeu o QPS e 403 se excedeu o QPM.
Autorização Inválida Autorização Ausente
Redundância de Autorização
O Bing retorna InvalidAuthorization quando o Bing não pode autenticar o chamador. Por exemplo, o cabeçalho Ocp-Apim-Subscription-Key está ausente ou a chave de assinatura não é válida.

A redundância ocorrerá se você especificar mais de um método de autenticação.

Se o erro for InvalidAuthorization, o código de status HTTP será 401.
Autorização Insuficiente Autorização Desabilitada
Autorização Expirada
O Bing retorna InsufficientAuthorization quando o chamador não tem permissões para acessar o recurso. Esse erro pode ocorrer se a chave de assinatura tiver sido desabilitada ou tiver expirado.

Se o erro for InsufficientAuthorization, o código de status HTTP será 403.
  • O seguinte mapeia os códigos de erro anteriores para os novos códigos. Se você tiver uma dependência nos códigos de erro v5, atualize seu código adequadamente.
Código da versão 5 Versão 7 code.subCode
ParâmetroDeRequisiçãoFaltando SolicitaçãoInválida.ParâmetroAusente
ValorInválidoDoParâmetroDeRequisição RequisiçãoInválida.ParâmetroValorInválido
ResourceAccessDenied Autorização Insuficiente
VolumeExcedido Limite de Taxa Excedido
Limite de QPS Excedido Limite de Taxa Excedido
Desabilitado AutorizaçãoInsuficiente.AutorizaçãoDesativada
ErroInesperado ErroServidor.ErroInesperado
Erros da Fonte de Dados Erro do Servidor.Erro de Recurso
Autorização Ausente AutorizaçãoInválida.AutorizaçãoAusente
HttpNãoPermitido SolicitaçãoInválida.HttpNãoPermitido
Agente do Usuário Ausente SolicitaçãoInválida.ParâmetroAusente
Não Implementado ErroDoServidor.NãoImplementado
Autorização Inválida Autorização Inválida
MétodoDeAutorizaçãoInválido Autorização Inválida
Método de Autorização Múltipla AutorizaçãoInválida.AutorizaçãoRedundante
TokenDeAutorizacaoExpirado AutorizaçãoInsuficiente.AutorizaçãoExpirada
Escopo Insuficiente Autorização Insuficiente
Bloqueado SolicitaçãoInválida.Bloqueado

Alterações sem interrupção

Cabeçalhos

  • Adicionado o cabeçalho de solicitação opcional Pragma. Por padrão, o Bing retorna conteúdo armazenado em cache, se disponível. Para impedir que o Bing retorne conteúdo armazenado em cache, defina o cabeçalho Pragma como sem cache (por exemplo, Pragma: sem cache).

Parâmetros de consulta

  • Adicionado o parâmetro de consulta answerCount. Use esse parâmetro para especificar o número de respostas que você deseja que a resposta inclua. As respostas são escolhidas com base na classificação. Por exemplo, se você definir esse parâmetro como três (3), a resposta incluirá as três principais respostas classificadas.

  • Adicionou o parâmetro de consulta promover. Use esse parâmetro juntamente com answerCount para incluir explicitamente um ou mais tipos de resposta, independentemente de sua classificação. Por exemplo, para promover vídeos e imagens na resposta, você configuraria a promoção para vídeos, imagens. A lista de respostas que você deseja promover não conta para o limite de answerCount. Por exemplo, se answerCount for 2 e promote estiver definido como vídeos, imagens, a resposta poderá incluir páginas da Web, notícias, vídeos e imagens.

Alterações de objeto

  • O campo someResultsRemoved foi adicionado ao objeto WebAnswer. O campo contém um valor booliano que indica se a resposta excluiu alguns resultados da resposta da Web.