Zoekaanvragen verzenden naar de Bing Video's zoeken-API
Waarschuwing
Op 30 oktober 2020 zijn de Zoeken in Bing API's verplaatst van Azure AI-services naar Zoeken in Bing Services. Deze documentatie is alleen bedoeld ter referentie. Zie de bing-documentatie voor zoeken-API voor bijgewerkte documentatie. Zie Een Zoeken in Bing-resource maken via de Azure Marketplace voor instructies over het maken van nieuwe Azure-resources voor Bing Search.
In dit artikel vindt u informatie over de parameters en de kenmerken van aanvragen die naar de Bing Video's zoeken-API worden verzonden, evenals het JSON-antwoordobject dat wordt geretourneerd.
Een Azure-resource maken
Begin met het gebruik van de Bing Video Search-API door een van de volgende Azure-resources te maken:
- Beschikbaar via de Azure-portal totdat u de resource verwijdert.
- Gebruik de gratis prijscategorie om de service uit te proberen, en voer later een upgrade uit naar een betaalde categorie voor productie.
Resource voor meerdere services
- Beschikbaar via de Azure-portal totdat u de resource verwijdert.
- Gebruik dezelfde sleutel en hetzelfde eindpunt voor uw toepassingen, in meerdere Azure AI-services.
Zoektermen voorstellen met de Bing Automatische suggestie-API
Als u een zoekvak aanbiedt waarin de gebruiker een zoekterm invoert, kunt u de Automatische suggestie-API voor Bing gebruiken om de ervaring te verbeteren. De API retourneert voorgestelde queryreeksen op basis van gedeeltelijke zoektermen terwijl de gebruiker typt.
Nadat de gebruiker de zoekterm heeft ingevoerd, past u URL-codering toe op de term voordat u de queryparameter q instelt. Als de gebruiker bijvoorbeeld sailing dinghies invoert, stelt u q in op sailing+dinghies of sailing%20dinghies.
Een aanvraag verzenden
Om video's als zoekresultaat te krijgen, verstuurt u een GET-aanvraag naar het volgende eindpunt:
https://api.cognitive.microsoft.com/bing/v7.0/videos/search
Voor de aanvraag moet het HTTPS-protocol worden gebruikt.
Het is raadzaam dat alle aanvragen afkomstig zijn van een server. Het distribueren van de sleutel als onderdeel van een clienttoepassing biedt een kwaadwillende gebruiker namelijk meer mogelijkheden om de sleutel te onderscheppen. Als u ervoor kiest om alle aanroepen via een server te laten lopen, beschikt u bovendien over een centraal upgradepunt voor toekomstige versies van de API.
De aanvraag moet de parameter q bevatten, met daarin de zoekterm van de gebruiker. Hoewel dit optioneel is, moet de aanvraag ook de queryparameter mkt bevatten. Hiermee geeft u de markt aan waarvan de resultaten afkomstig moeten zijn. Zie Queryparameters voor een lijst met optionele queryparameters, zoals pricing. Alle waarden van queryparameter moeten als een URL zijn gecodeerd.
De aanvraag moet de header Ocp-Apim-Subscription-Key bevatten. Hoewel dit optioneel is, wordt u aangeraden ook altijd deze headers op te geven:
De headers ClientIP en Location zijn belangrijk voor het retourneren van locatiespecifieke inhoud.
Zie Headers voor een lijst met alle aanvraag- en antwoordheaders.
Voorbeeld van zoekaanvraag
Hieronder ziet u een zoekaanvraag waarin alle voorgestelde queryparameters en headers zijn opgenomen. Als dit de eerste keer is van u een van de Bing-API's aanroept, moet u de header met de client-id weglaten. Voeg de client-id alleen toe als u eerder een Bing-API hebt aangeroepen en Bing een client-id heeft geretourneerd voor de combinatie van gebruiker en apparaat.
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
Voorbeeld van JSON-antwoord
Hieronder ziet u het antwoord op de vorige aanvraag. Het voorbeeld bevat ook de Bing-specifieke antwoordheaders.
Notitie
Omdat URL-indelingen en -parameters zonder kennisgeving kunnen worden gewijzigd, moet u alle URL's in hun huidige vorm gebruiken. Tenzij anders wordt vermeld, is het beter geen afhankelijkheden van de URL-indeling of parameters te gebruiken.
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..."
}
},
. . .
]
}
]
}
Volgende stappen
Probeer de API uit. Ga naar Video Search API Testing Console.
Zie What is Bing Video Search? (Wat is Bing Video's zoeken?) voor meer informatie over het gebruiken van de antwoordobjecten.
Zie Inzichten over video's voor meer informatie over het verkrijgen van inzichten over een video, zoals verwante zoekopdrachten.
Zie Trending video's ophalen voor meer informatie over video's die trending zijn op sociale media.