Enviar pedidos de pesquisa para a API de Pesquisa de Vídeos do Bing
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.
Este artigo descreve os parâmetros e atributos dos pedidos enviados para a API de Pesquisa de Vídeos do Bing, bem como o objeto de resposta JSON que devolve.
Criar um recurso do Azure
Comece a utilizar a API de Pesquisa de Vídeos do Bing ao criar um dos seguintes recursos do Azure:
- Disponível através do portal do Azure até eliminar o recurso.
- Utilize o escalão de preço gratuito para experimentar o serviço e atualize mais tarde para um escalão pago para produção.
- Disponível através do portal do Azure até eliminar o recurso.
- Utilize a mesma chave e ponto final para as suas aplicações, em vários serviços de IA do Azure.
Sugerir termos de pesquisa com a API de Sugestão Automática do Bing
Se disponibilizar uma caixa de pesquisa na qual o utilizador introduz o seu termo de pesquisa, utilize a API de Sugestão Automática do Bing para melhorar a experiência. A API devolve cadeias de consulta sugerida com base em termos de pesquisa parcial à medida que o utilizador escreve.
Depois de o utilizador introduzir o termo de pesquisa, codifica-o por URL antes de definir o parâmetro de consulta q . Por exemplo, se o utilizador introduzir sailing dinghies, defina q como sailing+dinghies ou sailing%20dinghies.
Enviar um pedido
Para obter os resultados da pesquisa de vídeo, enviaria um pedido GET ao seguinte ponto final:
https://api.cognitive.microsoft.com/bing/v7.0/videos/search
O pedido tem de utilizar o protocolo HTTPS.
Recomendamos que todos os pedidos tenham origem num servidor. Distribuir a chave como parte de uma aplicação cliente abre mais oportunidades de acesso à mesma a terceiros mal-intencionados. Efetuar chamadas a partir de um servidor também fornece um ponto de atualização único para versões futuras da API.
O pedido tem de especificar o parâmetro de consulta q, que contém o termo de pesquisa do utilizador. Embora seja opcional, o pedido deve também especificar o parâmetro de consulta mkt, que identifica o mercado de onde pretende que os resultados provenham. Para obter uma lista opcional de parâmetros de consulta, como pricing, veja Parâmetros de Consulta. Todos os valores de parâmetro de consulta têm de estar codificados com URL.
O pedido tem de especificar o cabeçalho Ocp-Apim-Subscription-Key. Embora seja opcional, recomenda-se que especifique também os seguintes cabeçalhos:
Os cabeçalhos de IP e localização do cliente são importantes para devolver o conteúdo com reconhecimento de local.
Para obter uma lista de todos os cabeçalhos de pedido e resposta, veja Cabeçalhos.
Pedido de pesquisa de exemplo
A seguir, é-lhe mostrado um pedido de pesquisa que inclui todos os parâmetros de consulta e cabeçalhos sugeridos. Se for a primeira vez que está a chamar qualquer uma das APIs do Bing, não inclua o cabeçalho de ID de cliente. Inclua apenas o ID de cliente se tiver chamado anteriormente uma API do Bing e o Bing tiver devolvido um ID de cliente para o utilizador e a combinação de dispositivo.
GET https://api.cognitive.microsoft.com/bing/v7.0/videos/search?q=sailing+dinghies&mkt=en-us HTTP/1.1
Ocp-Apim-Subscription-Key: 123456789ABCDE
User-Agent: Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822)
X-Search-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
Resposta JSON de exemplo
O código a seguir mostra a resposta ao pedido anterior. O exemplo também mostra os cabeçalhos de resposta específicos do Bing.
Nota
Uma vez que os parâmetros e os formatos de URL estão sujeitos a alterações sem aviso prévio, utilize todos os URLs tal como estão. Não deve assumir dependências no formato ou parâmetros do URL, exceto quando indicado.
BingAPIs-TraceId: 76DD2C2549B94F9FB55B4BD6FEB6AC
X-MSEdge-ClientID: 1C3352B306E669780D58D607B96869
BingAPIs-Market: en-US
{
"_type" : "Videos",
"webSearchUrl" : "https:\/\/www.bing.com\/cr?IG=81EF7545D5694...",
"totalEstimatedMatches" : 1000,
"value" : [
{
"name" : "How to sail - What to Wear for Dinghy Sailing",
"description" : "An informative video on what to wear when...",
"webSearchUrl" : "https:\/\/www.bing.com\/cr?IG=81EF7545D56...",
"thumbnailUrl" : "https:\/\/tse4.mm.bing.net\/th?id=OVP.DYWCvh...",
"datePublished" : "2014-03-04T11:51:53",
"publisher" : [
{
"name" : "Fabrikam"
}
],
"creator" : {
"name" : "Marcus Appel"
},
"contentUrl" : "https:\/\/www.fabrikam.com\/watch?v=vzmPjHZ--g",
"hostPageUrl" : "https:\/\/www.bing.com\/cr?IG=81EF7545D56944...",
"encodingFormat" : "h264",
"hostPageDisplayUrl" : "https:\/\/www.fabrikam.com\/watch?v=vzmPjBZ--g",
"width" : 1280,
"height" : 720,
"duration" : "PT2M47S",
"motionThumbnailUrl" : "https:\/\/tse3.mm.bing.net\/th?id=OM.Y6...",
"embedHtml" : "<iframe width=\"1280\" height=\"720\" src=\"https:...><\/iframe>",
"allowHttpsEmbed" : true,
"viewCount" : 8743,
"thumbnail" : {
"width" : 300,
"height" : 168
},
"videoId" : "6DB795E11A6E3CBAAD636DB795E11E3CBAAD63",
"allowMobileEmbed" : true,
"isSuperfresh" : false
},
. . .
],
"nextOffset" : 0,
"pivotSuggestions" : [
{
"pivot" : "sailing",
"suggestions" : []
},
{
"pivot" : "dinghies",
"suggestions" : [
{
"text" : "Sailing Cruising",
"displayText" : "Cruising",
"webSearchUrl" : "https:\/\/www.bing.com\/cr?IG=81EF754...",
"searchLink" : "https:\/\/api.cognitive.microsoft.com...",
"thumbnail" : {
"thumbnailUrl" : "https:\/\/tse4.mm.bing.net\/th?q=Sailing..."
}
},
. . .
]
}
]
}
Passos seguintes
Experimente a API. Aceda a Consola de Testes da API da Pesquisa de Vídeos.
Para obter detalhes sobre os objetos de resposta, veja Pesquisar Vídeos na Web.
Para obter detalhes de como obter informações sobre um vídeo, como pesquisas relacionadas, veja Informações de Vídeo.
Para obter detalhes sobre os vídeos que são mais populares nas redes sociais, veja Vídeos Populares.