Antwortstruktur und Antworttypen der Bing-Websuche-API
Warnung
Am 30. Oktober 2020 wurden die Bing-Suche-APIs aus den Azure KI Services in die Bing-Suchdienste verschoben. Diese Dokumentation wird nur zu Referenzzwecken bereitgestellt. Eine aktualisierte Dokumentation finden Sie in der Dokumentation zu den Bing-Suche-APIs. Anweisungen zum Erstellen neuer Azure-Ressourcen für die Bing-Suche finden Sie unter Erstellen einer Ressource für die Bing-Suche über Azure Marketplace.
Wenn Sie eine Suchanforderung an die Bing-Websuche senden, wird im Antworttext ein SearchResponse-Objekt zurückgegeben. Das Objekt enthält jeweils ein Feld für jede Antwort, die nach Bewertung von Bing für die Abfrage relevant ist. In diesem Beispiel wird ein Antwortobjekt gezeigt, bei dem Bing alle Antworten zurückgegeben hat:
{
"_type": "SearchResponse",
"queryContext": {...},
"webPages": {...},
"images": {...},
"relatedSearches": {...},
"videos": {...},
"news": {...},
"spellSuggestion": {...},
"computation": {...},
"timeZone": {...},
"rankingResponse": {...}
}, ...
Normalerweise wird bei der Bing-Websuche eine Teilmenge der Antworten zurückgegeben. Wenn der Abfrageausdruck beispielsweise sailing dinghies war, kann die Antwort webPages, images und rankingResponse enthalten. Sofern Sie nicht responseFilter zum Herausfiltern von Webseiten verwendet haben, umfasst die Antwort immer webpages- und rankingResponse-Antworten.
Hinweis
Da sich URL-Formate und -Parameter ohne Vorankündigung ändern können, sollten Sie alle URLs in der vorliegenden Form verwenden. Es sollten keine Abhängigkeiten von URL-Formaten oder -Parametern bestehen, außer wenn dies angegeben ist.
Antwort zu Webseiten
Die Antwort vom Typ webPages enthält eine Liste mit Links zu Webseiten, die nach Bewertung der Bing-Websuche für die Abfrage relevant sind. Jede Webseite in der Liste beinhaltet den Namen der Seite, die URL, die Anzeige-URL, eine kurze Beschreibung des Inhalts und das Datum, an dem Bing den Inhalt gefunden hat.
{
"id": "https:\/\/api.cognitive.microsoft.com\/api\/v7\/#WebPages.0",
"name": "Dinghy sailing",
"url": "https:\/\/www.bing.com\/cr?IG=3A43CA5...",
"displayUrl": "https:\/\/en.contoso.com\/wiki\/Dinghy_sailing",
"snippet": "Dinghy sailing is the activity of sailing small boats...",
"dateLastCrawled": "2017-04-05T16:25:00"
}, ...
Verwenden Sie name und url, um einen Hyperlink zu erstellen, über den der Benutzer zu der Webseite geleitet wird.
Bildantwort
Die Antwort vom Typ images enthält eine Liste mit Bildern, die nach Einschätzung von Bing für die Abfrage relevant sind. Jedes Bild in der Liste enthält die URL, die Größe, die Abmessungen und das Codierungsformat des Bilds. Darüber hinaus enthält das Bildobjekt die URL einer Miniaturansicht des Bilds sowie die Abmessungen der Miniaturansicht.
{
"name": "Rich Passage Sailing Dinghy",
"webSearchUrl": "https:\/\/www.bing.com\/cr?IG=3A43CA5CA64...",
"thumbnailUrl": "https:\/\/tse1.mm.bing.net\/th?id=OIP....",
"datePublished": "2011-10-29T11:26:00",
"contentUrl": "http:\/\/upload.contoso.com\/sailing\/...",
"hostPageUrl": "http:\/\/www.bing.com\/cr?IG=3A43CA5CA6464....",
"contentSize": "79239 B",
"encodingFormat": "jpeg",
"hostPageDisplayUrl": "http:\/\/en.contoso.com\/wiki\/File...",
"width": 526,
"height": 688,
"thumbnail": {
"width": 229,
"height": 300
},
"insightsSourcesSummary": {
"shoppingSourcesCount": 0,
"recipeSourcesCount": 0
}
}, ...
Abhängig vom Gerät des Benutzers zeigen Sie normalerweise eine Teilmenge der Miniaturansichten an und bieten dem Benutzer die Möglichkeit, durch die restlichen Bilder zu blättern.
Die Miniaturansicht kann erweitert werden, wenn der Benutzer mit dem Cursor darauf zeigt. Wenn das Bild erweitert wird, muss die Quelle angegeben werden. Hierzu können Sie beispielsweise den Host aus hostPageDisplayUrl extrahieren und unter dem Bild anzeigen. Informationen zum Ändern der Größe der Miniaturansicht finden Sie unter Resizing and cropping thumbnail images (Ändern der Größe und Zuschneiden von Miniaturansichten).
Wenn der Benutzer auf die Miniaturansicht klickt, verwenden Sie webSearchUrl, um den Benutzer zu der Bing-Suchergebnisseite für Bilder weiterzuleiten, die eine Collage der Bilder enthält.
Ausführliche Informationen zu der Bildantwort und den Bildern finden Sie unter Bing-Bildersuche-API.
Antwort zu verwandten Suchvorgängen
Die Antwort vom Typ relatedSearches enthält eine Liste der am häufigsten von anderen Benutzern durchgeführten verwandten Abfragen. Jede Abfrage in der Liste beinhaltet eine Abfragezeichenfolge (text), eine Abfragezeichenfolge mit Treffermarkierungszeichen (displayText) und eine URL (webSearchUrl) zu der Bing-Suchergebnisseite für die Abfrage.
{
"text": "dinghy racing teams",
"displayText": "dinghy racing teams",
"webSearchUrl": "https:\/\/www.bing.com\/cr?IG=96C4CF214A0..."
}, ...
Verwenden Sie die Abfragezeichenfolge displayText und die URL webSearchUrl, um einen Hyperlink zu erstellen, über den der Benutzer zu der Bing-Suchergebnisseite für die verwandte Abfrage geleitet wird. Außerdem können Sie die Abfragezeichenfolge text in Ihrer eigenen Abfrage mit der Websuche-API verwenden und die Ergebnisse selbst anzeigen.
Informationen zur Verwendung der Treffermarkierungen in displayText finden Sie unter Treffermarkierung.
Nachfolgend sehen Sie ein Beispiel für die Verwendung verwandter Abfragen in Bing.com.
Antwort zu Videos
Die Antwort vom Typ videos enthält eine Liste mit Videos, die nach Einschätzung von Bing für die Abfrage relevant sind. Jedes Video in der Liste enthält die URL, die Dauer, die Abmessungen und das Codierungsformat des Videos. Darüber hinaus enthält das Videoobjekt die URL einer Miniaturansicht des Videos sowie die Abmessungen der Miniaturansicht.
{
"name": "Sailing dinghy",
"description": "Northwind Traders is a 12 foot gunter rigged...",
"webSearchUrl": "https:\/\/www.bing.com\/cr?IG=1CAE739681D84...",
"thumbnailUrl": "https:\/\/tse2.mm.bing.net\/th?id=OVP.wsKiL...",
"datePublished": "2013-11-06T01:56:28",
"publisher": [{
"name": "Fabrikam"
}],
"contentUrl": "https:\/\/www.fabrikam.com\/watch?v=MrVBWZpJjX",
"hostPageUrl": "https:\/\/www.bing.com\/cr?IG=1CAE739681D8400DB...",
"encodingFormat": "mp4",
"hostPageDisplayUrl": "https:\/\/www.fabrikam.com\/watch?v=MrBWZpJjXo",
"width": 1280,
"height": 720,
"duration": "PT3M47S",
"motionThumbnailUrl": "https:\/\/tse2.mm.bing.net\/th?id=OM.oa...",
"embedHtml": "<iframe width=\"1280\" height=\"720\" src=\"http:\/\/www....><\/iframe>",
"allowHttpsEmbed": true,
"viewCount": 19089,
"thumbnail": {
"width": 300,
"height": 168
},
"allowMobileEmbed": true,
"isSuperfresh": false
}, ...
Abhängig vom Gerät des Benutzers zeigen Sie normalerweise eine Teilmenge der Videos an, mit einer Möglichkeit für den Benutzer, die restlichen Videos anzuzeigen. Sie zeigen z.B. eine Miniaturansicht des Videos mit der Länge, der Beschreibung (Name) und der Quelle (Herausgeber) des Videos an.
Wenn der Benutzer auf die Miniaturansicht zeigt, können Sie motionThumbnailUrl verwenden, um eine Miniaturansichtversion des Videos wiederzugeben. Vergessen Sie bei der Anzeige der bewegten Miniaturansicht nicht, die Quelle anzugeben.
Wenn der Benutzer auf die Miniaturansicht klickt, stehen folgende Optionen zum Anzeigen des Videos zur Verfügung:
- Verwenden Sie
hostPageUrl, um das Video auf der Website des Hosts anzuzeigen (z.B. YouTube). - Verwenden Sie
webSearchUrl, um das Video im Bing-Videobrowser anzuzeigen. - Verwenden Sie
embedHtml, um das Video in Ihrer Benutzeroberfläche einzubetten.
Ausführliche Informationen zur Videoantwort und zu Videos finden Sie unter Bing-Videosuche-API.
Antwort zu Nachrichtenartikeln
Die Antwort vom Typ news enthält eine Liste mit Nachrichtenartikeln, die nach Einschätzung von Bing für die Abfrage relevant sind. Jeder Nachrichtenartikel in der Liste beinhaltet den Namen des Artikels, eine Beschreibung und die URL zu dem Artikel auf der Website des Hosts. Wenn der Artikel ein Bild enthält, umfasst das Objekt eine Miniaturansicht des Bilds.
{
"name": "WC Sailing Qualifies for America Trophy with...",
"url": "http:\/\/www.bing.com\/cr?IG=3445EEF15DAF4FFFBF7...",
"image": {
"contentUrl": "http:\/\/www.contoso.com\/sports\/sail...",
"thumbnail": {
"contentUrl": "https:\/\/www.bing.com\/th?id=ON.1...",
"width": 400,
"height": 272
}
},
"description": "The WC sailing team qualified for a...",
"provider": [{
"_type": "Organization",
"name": "contoso.com"
}],
"datePublished": "2017-04-16T21:56:00"
}, ...
Abhängig vom Gerät des Benutzers zeigen Sie normalerweise eine Teilmenge der Nachrichtenartikel an, mit einer Möglichkeit für den Benutzer, die restlichen Artikel anzuzeigen. Verwenden Sie name und url, um einen Hyperlink zu erstellen, über den der Benutzer zu dem Nachrichtenartikel auf der Website des Hosts geleitet wird. Wenn der Artikel ein Bild enthält, machen Sie das Bild mithilfe von url klickbar. Vergessen Sie nicht, mit provider die Quelle anzugeben.
Ausführliche Informationen zu der News-Antwort und zu Nachrichtenartikeln finden Sie unter News-Suche-API.
Antwort zu Berechnungen
Wenn der Benutzer einen mathematischen Ausdruck oder eine Abfrage zur Einheitenumrechnung eingibt, enthält die Antwort möglicherweise eine Antwort vom Typ Computation. Die Antwort vom Typ computation enthält den normalisierten Ausdruck und das zugehörige Ergebnis.
Eine Abfrage zur Einheitenumrechnung ist eine Abfrage, bei der eine Einheit in eine andere umgerechnet wird. Beispiel: Wieviel Fuß sind 10 Meter? oder Wie viele Teelöffel sind 1/4 Tasse?
Im folgenden Beispiel wird die Antwort vom Typ computation für Wieviel Fuß sind 10 Meter? gezeigt.
"computation": {
"id": "https:\/\/www.bing.com\/api\/v7\/#Computation",
"expression": "10 meters",
"value": "32.808399 feet"
}, ...
Nachfolgend finden Sie Beispiele für mathematische Abfragen und die jeweils entsprechenden Antworten vom Typ computation.
Query: (5+3)(10/2)+8
Encoded query: %285%2B3%29%2810%2F2%29%2B8
"computation": {
"id": "https:\/\/www.bing.com\/api\/v7\/#Computation",
"expression": "((5+3)*(10\/2))+8",
"value": "48"
}
Query: sqrt(4^2+8^2)
Encoded query: sqrt%284^2%2B8^2%29
"computation": {
"id": "https:\/\/www.bing.com\/api\/v7\/#Computation",
"expression": "sqrt((4^2)+(8^2))",
"value": "8.94427191"
}
Query: 30 6/8 - 18 8/16
Encoded query: 30%206%2F8%20-%2018%208%2F16
"computation": {
"id": "https:\/\/www.bing.com\/api\/v7\/#WolframAlpha",
"expression": "30 6\/8-18 8\/16",
"value": "12.25"
}
Query: 8^2+11^2-2*8*11*cos(37)
Encoded query: 8^2%2B11^2-2*8*11*cos%2837%29
"computation": {
"id": "https:\/\/www.bing.com\/api\/v7\/#Computation",
"expression": "(8^2)+(11^2)-(2*8*11*cos(37))",
"value": "44.4401502"
}
Ein mathematischer Ausdruck kann folgende Symbole enthalten:
| Symbol | BESCHREIBUNG |
|---|---|
| + | Addition |
| - | Subtraktion |
| / | Division |
| * | Multiplikation |
| ^ | Power |
| ! | Fakultät |
| . | Decimal |
| () | Prioritätsgruppierung |
| [] | Funktion |
Ein mathematischer Ausdruck kann folgende Konstanten enthalten:
| Symbol | BESCHREIBUNG |
|---|---|
| Pi | 3,14159... |
| Grad | Grad |
| i | Imaginäre Zahl |
| e | e, 2,71828... |
| GoldenRatio | Goldener Schnitt, 1,61803... |
Ein mathematischer Ausdruck kann folgende Funktionen enthalten:
| Symbol | BESCHREIBUNG |
|---|---|
| Sortieren | Quadratwurzel |
| Sin[x], Cos[x], Tan[x] Csc[x], Sec[x], Cot[x] |
Trigonometrische Funktionen (mit Argumenten im Bogenmaß) |
| ArcSin[x], ArcCos[x], ArcTan[x] ArcCsc[x], ArcSec[x], ArcCot[x] |
Inverse trigonometrische Funktionen (Ergebnisse im Bogenmaß) |
| Exp[x], E^x | Exponentialfunktion |
| Log[x] | Natürlicher Logarithmus |
| Sinh[x], Cosh[x], Tanh[x] Csch[x], Sech[x], Coth[x] |
Hyperbolische Funktionen |
| ArcSinh[x], ArcCosh[x], ArcTanh[x] ArcCsch[x], ArcSech[x], ArcCoth[x] |
Inverse hyperbolische Funktionen |
Mathematische Ausdrücke, die Variablen enthalten (z.B. 4x + 6 = 18, wobei x die Variable ist), werden nicht unterstützt.
Antwort zur Zeitzone
Wenn der Benutzer eine Abfrage zu Uhrzeit oder Datum eingibt, kann die Antwort eine Antwort vom Typ TimeZone enthalten. Diese Antwort unterstützt implizite oder explizite Abfragen. Bei einer impliziten Abfrage, z.B. Wie spät ist es? , wird die Ortszeit basierend auf dem Standort des Benutzers zurückgegeben. Bei einer expliziten Abfrage, z.B. Wie spät ist es in Seattle? , wird die Ortszeit für Seattle, Washington, USA zurückgegeben.
Die Antwort vom Typ timeZone beinhaltet den Namen des Standorts, das aktuelle UTC-Datum und die aktuelle UTC-Zeit am angegebenen Standort sowie die UTC-Abweichung. Wenn sich die Standortgrenzen in mehreren Zeitzonen befinden, enthält die Antwort das aktuelle UTC-Datum und die aktuelle UTC-Zeit aller Zeitzonen innerhalb der Grenzen. Da der US-Bundesstaat Florida in zwei Zeitzonen liegt, enthält die Antwort beispielsweise das lokale Datum und die Ortszeit beider Zeitzonen.
Wenn mit der Abfrage die Uhrzeit einer Region oder eines Lands angefordert wird, ermittelt Bing den Hauptort innerhalb der geografischen Grenzen des Standorts und gibt diesen im Feld primaryCityTime zurück. Wenn die geografischen Grenzen mehrere Zeitzonen umfassen, werden die übrigen Zeitzonen im Feld otherCityTimes zurückgegeben.
Nachfolgend finden Sie Beispielabfragen, die eine Antwort vom Typ timeZone zurückgeben.
Query: What time is it?
"timeZone": {
"id": "https:\/\/www.bing.com\/api\/v7\/#TimeZone",
"primaryCityTime": {
"location": "Redmond, Washington, United States",
"time": "2015-10-27T08:38:12.1189231Z",
"utcOffset": "UTC-7"
}
}
Query: What time is it in the Pacific time zone?
"timeZone": {
"id": "https:\/\/www.bing.com\/api\/v7\/#TimeZone",
"primaryCityTime": {
"location": "Pacific Time Zone",
"time": "2015-10-23T12:33:19.0728146Z",
"utcOffset": "UTC-7"
}
}
Query: Time in Florida?
"timeZone": {
"id": "https:\/\/www.bing.com\/api\/v7\/#TimeZone",
"primaryCityTime": {
"location": "Tallahassee, Florida, United States",
"time": "2015-10-23T13:04:56.6774389Z",
"utcOffset": "UTC-4"
},
"otherCityTimes": [{
"location": "Pensacola",
"time": "2015-10-23T12:04:56.6664294Z",
"utcOffset": "UTC-5"
}]
}
Query: What time is it in the U.S.
"timeZone": {
"id": "https:\/\/www.bing.com\/api\/v7\/#TimeZone",
"primaryCityTime": {
"location": "Washington, D.C., United States",
"time": "2015-10-23T15:27:59.8892745Z",
"utcOffset": "UTC-4"
},
"otherCityTimes": [{
"location": "Honolulu",
"time": "2015-10-23T09:27:59.8892745Z",
"utcOffset": "UTC-10"
},
{
"location": "Anchorage",
"time": "2015-10-23T11:27:59.8892745Z",
"utcOffset": "UTC-8"
},
{
"location": "Phoenix",
"time": "2015-10-23T12:27:59.8892745Z",
"utcOffset": "UTC-7"
},
{
"location": "Los Angeles",
"time": "2015-10-23T12:27:59.8942788Z",
"utcOffset": "UTC-7"
},
{
"location": "Denver",
"time": "2015-10-23T13:27:59.8812681Z",
"utcOffset": "UTC-6"
},
{
"location": "Chicago",
"time": "2015-10-23T14:27:59.8892745Z",
"utcOffset": "UTC-5"
}]
}
Antwort zu Rechtschreibvorschlägen
Wenn Bing feststellt, dass der Benutzer möglicherweise einen abweichenden Ausdruck suchen wollte, enthält die Antwort ein SpellSuggestions-Objekt. Wenn der Benutzer z.B. nach carlos pen sucht, geht Bing davon aus, dass der Benutzer stattdessen möglicherweise nach „Carlos Pena“ suchen wollte (basierend auf der früheren Suche nach carlos pen durch andere Benutzer). Nachfolgend finden Sie ein Beispiel für eine Antwort zur Rechtschreibung.
"spellSuggestions": {
"id": "https:\/\/www.bing.com\/api\/v7\/#SpellSuggestions",
"value": [{
"text": "carlos pena",
"displayText": "carlos pena"
}]
}, ...
Antwortheader
Die folgenden Header können in Antworten der Bing-Websuche-API enthalten sein:
| Header | BESCHREIBUNG |
|---|---|
X-MSEdge-ClientID |
Die eindeutige ID, die Bing dem Benutzer zugewiesen hat |
BingAPIs-Market |
Der Markt, der zur Erfüllung der Anforderung verwendet wurde |
BingAPIs-TraceId |
Der Protokolleintrag auf den Bing-API-Server für diese Anforderung (für Unterstützung) |
Es ist besonders wichtig, die Client-ID beizubehalten und mit nachfolgenden Anforderungen zurückzugeben. Wenn Sie dies tun, verwendet die Suche den vergangenen Kontext in der Suchergebnisrangfolge und bietet auch eine konsistente Benutzererfahrung.
Wenn Sie jedoch die Bing-Websuche-API von JavaScript aus aufrufen, kann es sein, dass die in Ihrem Browser integrierten Sicherheitsfunktionen (CORS) unterbinden, dass Sie auf die Werte dieser Header zuzugreifen können.
Um Zugriff auf die Header zu erhalten, können Sie die Bing-Websuche-API über einen CORS-Proxy anfordern. In der Antwort eines solchen Proxys befindet sich ein Access-Control-Expose-Headers-Header, mit dem die Antwortheader gefiltert und für JavaScript verfügbar gemacht werden.
Die Installation eines CORS-Proxys, mit dem die Tutorial-App auf die optionalen Clientheader zugreifen kann, ist schnell und unkompliziert. Installieren Sie Node.js, falls Sie dies noch nicht getan haben. Geben Sie dann an einer Eingabeaufforderung den folgenden Befehl ein.
npm install -g cors-proxy-server
Passen Sie den Bing-Websuche-API-Endpunkt in der HTML-Datei wie folgt an:
http://localhost:9090/https://api.cognitive.microsoft.com/bing/v7.0/search
Starten Sie abschließend den CORS-Proxy mit folgendem Befehl:
cors-proxy-server
Lassen Sie das Fenster während der Nutzung der Tutorial-App geöffnet. Wenn Sie das Fenster schließen, wird auch die Ausführung des Proxys beendet. Im Bereich mit den erweiterbaren HTTP-Headern unter den Suchergebnissen wird nun u.a. der X-MSEdge-ClientID-Header angezeigt. Hier können Sie überprüfen, ob dieser für alle Anforderungen identisch ist.
Antwortheader in einer Produktionsumgebung
Der in der vorherigen Antwort erläuterte Ansatz mit CORS-Proxy ist für Entwicklung, Test und Lernen geeignet.
In einer Produktionsumgebung sollten Sie ein serverseitiges Skript in derselben Domäne wie die Webseite, die die Bing-Websuche-API verwendet, hosten. Dieses Skript sollte die API-Aufrufe auf Anforderung des JavaScript-Codes auf der Webseite ausführen und alle Ergebnisse, einschließlich der Header, an den Client zurückgeben. Da die beiden Ressourcen (Seite und Skript) einen gemeinsamen Ursprung haben, wird CORS nicht verwendet, und die speziellen Header sind für das JavaScript auf der Webseite zugänglich.
Dieser Ansatz schützt auch Ihren API-Schlüssel vor der Offenlegung, da dieser nur vom serverseitigen Skript benötigt wird. Das Skript kann eine andere Methode verwenden, um sicherzustellen, dass die Anforderung autorisiert ist.
Das folgende Beispiel zeigt, wie der Rechtschreibvorschlag in Bing verwendet wird.
Nächste Schritte
- Sehen Sie sich die Dokumentation zur Anforderungsbegrenzung an.