WebSearchOptionalParams interface

Paket:

@azure/cognitiveservices-websearch

Optionale Parameter.

Extends

RequestOptionsBase

Eigenschaften

acceptLanguage	Eine durch Trennzeichen getrennte Liste einer oder mehrerer Sprachen, die für Benutzeroberflächenzeichenfolgen verwendet werden sollen. Die Liste nimmt die Reihenfolge der Voreinstellungen ab. Weitere Informationen, einschließlich des erwarteten Formats, finden Sie unter RFC2616. Dieser Header und der setLang-Abfrageparameter schließen sich gegenseitig aus; geben Sie nicht beides an. Wenn Sie diesen Header festlegen, müssen Sie auch den Cc-Abfrageparameter angeben. Bing verwendet die erste unterstützte Sprache, die sie aus der Liste findet, und kombiniert diese Sprache mit dem Cc-Parameterwert, um den Markt zu bestimmen, für den Ergebnisse zurückgegeben werden sollen. Wenn die Liste keine unterstützte Sprache enthält, findet Bing die nächstgelegene Sprache und den nächstgelegenen Markt, der die Anforderung unterstützt, und kann einen aggregierten oder Standardmarkt für die Ergebnisse anstelle eines angegebenen Markts verwenden. Sie sollten diesen Header und den Cc-Abfrageparameter nur verwenden, wenn Sie mehrere Sprachen angeben. andernfalls sollten Sie die Parameter "mkt" und "setLang" verwenden. Eine Zeichenfolge der Benutzeroberfläche ist eine Zeichenfolge, die als Bezeichnung in einer Benutzeroberfläche verwendet wird. Es gibt sehr wenige Benutzeroberflächenzeichenfolgen in den JSON-Antwortobjekten. Alle Links in den Antwortobjekten zu Bing.com Eigenschaften wenden die angegebene Sprache an.
answerCount	Die Anzahl der Antworten, die die Antwort enthalten soll. Die Antworten, die Bing zurückgibt, basieren auf der Rangfolge. Wenn Bing beispielsweise Webseiten, Bilder, Videos und verwandteSearchs für eine Anforderung zurückgibt und Sie diesen Parameter auf zwei (2) festlegen, enthält die Antwort Webseiten und Bilder. Wenn Sie den Abfrageparameter "responseFilter" in derselben Anforderung eingeschlossen und auf Webseiten und Nachrichten festgelegt haben, enthält die Antwort nur Webseiten.
clientId	Bing verwendet diesen Header, um Benutzern ein einheitliches Verhalten für Bing-API-Aufrufe bereitzustellen. Bing fliegt häufig neue Features und Verbesserungen ab und verwendet die Client-ID als Schlüssel zum Zuweisen von Datenverkehr auf verschiedenen Flügen. Wenn Sie nicht dieselbe Client-ID für einen Benutzer über mehrere Anforderungen hinweg verwenden, kann Bing dem Benutzer mehrere Konflikte verursachende Flüge zuweisen. Die Zuweisung mehrerer konflikteder Flüge kann zu einer inkonsistenten Benutzererfahrung führen. Wenn die zweite Anforderung beispielsweise eine andere Test-Flight-Zuordnung aufweist als die erste, kann die Erfahrung unerwartet sein. Außerdem kann Bing die Client-ID verwenden, um Webergebnisse an den Suchverlauf dieser Client-ID anzupassen, was eine umfassendere Benutzeroberfläche für den Benutzer bietet. Bing verwendet diesen Header auch, um die Ergebnisbewertungen zu verbessern, indem die von einer Client-ID generierte Aktivität analysiert wird. Die Relevanzverbesserungen helfen bei einer besseren Qualität der Ergebnisse, die von Bing-APIs bereitgestellt werden, und ermöglicht wiederum höhere Klickraten für den API-Verbraucher. WICHTIG: Obwohl optional, sollten Sie diesen Header als erforderlich betrachten. Das Beibehalten der Client-ID über mehrere Anforderungen für denselben Endbenutzer und die Gerätekombination ermöglicht 1) den API-Consumer, eine konsistente Benutzererfahrung zu erhalten, und 2) höhere Klickraten über eine bessere Qualität der Ergebnisse aus den Bing-APIs. Jeder Benutzer, der Ihre Anwendung auf dem Gerät verwendet, muss über eine eindeutige, von Bing generierte Client-ID verfügen. Wenn Sie diesen Header nicht in die Anforderung einschließen, generiert Bing eine ID und gibt sie im X-MSEdge-ClientID Antwortheader zurück. Das einzige Mal, dass Sie diesen Header NICHT in eine Anforderung einschließen sollten, ist das erste Mal, wenn der Benutzer Ihre App auf diesem Gerät verwendet. Verwenden Sie die Client-ID für jede Bing-API-Anforderung, die Ihre App für diesen Benutzer auf dem Gerät vorgibt. Speichern Sie die Client-ID. Um die ID in einer Browser-App beizubehalten, verwenden Sie ein persistentes HTTP-Cookie, um sicherzustellen, dass die ID in allen Sitzungen verwendet wird. Verwenden Sie kein Sitzungscookies. Verwenden Sie für andere Apps wie mobile Apps den persistenten Speicher des Geräts, um die ID beizubehalten. Wenn der Benutzer ihre App das nächste Mal auf diesem Gerät verwendet, rufen Sie die client-ID ab, die Sie beibehalten haben. Bing-Antworten können diesen Header enthalten oder nicht. Wenn die Antwort diesen Header enthält, erfassen Sie die Client-ID, und verwenden Sie sie für alle nachfolgenden Bing-Anforderungen für den Benutzer auf diesem Gerät. Wenn Sie die X-MSEdge-ClientID einschließen, dürfen Sie keine Cookies in die Anforderung aufnehmen.
clientIp	Die IPv4- oder IPv6-Adresse des Clientgeräts. Die IP-Adresse wird verwendet, um den Standort des Benutzers zu ermitteln. Bing verwendet die Standortinformationen, um das sichere Suchverhalten zu ermitteln. Obwohl optional, sollten Sie diese Kopfzeile und den X-Search-Location-Header immer angeben. Verschleiern Sie die Adresse nicht (z. B. durch Ändern des letzten Oktetts auf 0). Das Verschleiern der Adresse führt dazu, dass sich der Standort nicht in der Nähe des tatsächlichen Standorts des Geräts befindet, was dazu führen kann, dass Bing fehlerhafte Ergebnisse enthält.
count	Die Anzahl der Suchergebnisse, die in der Antwort zurückgegeben werden sollen. Der Standardwert ist 10 und der Maximalwert ist 50. Die tatsächlich gelieferte Zahl kann kleiner als angefordert sein. Verwenden Sie diesen Parameter zusammen mit dem Offsetparameter für Seitenergebnisse. Wenn auf der Benutzeroberfläche beispielsweise 10 Suchergebnisse pro Seite angezeigt werden, legen Sie die Anzahl auf 10 fest, und setzen Sie den Offset auf 0, um die erste Seite der Ergebnisse abzurufen. Erhöhen Sie für jede nachfolgende Seite den Offset um 10 (z. B. 0, 10, 20). Es ist möglich, dass mehrere Seiten in Ergebnisse überlappen.
countryCode	Eine 2-stellige Länderkennzahl des Landes, aus dem die Ergebnisse stammen. Diese API unterstützt nur den US-Markt. Wenn Sie diesen Abfrageparameter angeben, muss er auf uns festgelegt werden. Wenn Sie diesen Parameter festlegen, müssen Sie auch den Accept-Language Header angeben. Bing verwendet die erste unterstützte Sprache aus der Sprachenliste, und kombinieren Sie diese Sprache mit dem Ländercode, den Sie angeben, um den Markt für die Ergebnisse zurückzugeben. Wenn die Sprachenliste keine unterstützte Sprache enthält, findet Bing die nächstgelegene Sprache und den nächstgelegenen Markt, der die Anforderung unterstützt, oder es kann einen aggregierten oder Standardmarkt für die Ergebnisse anstelle eines angegebenen Markts verwenden. Sie sollten diesen Abfrageparameter und den Accept-Language Abfrageparameter nur verwenden, wenn Sie mehrere Sprachen angeben. andernfalls sollten Sie die Parameter "mkt" und "setLang" verwenden. Dieser Parameter und der mkt-Abfrageparameter schließen sich gegenseitig aus – geben Sie nicht beide an.
freshness	Filtern Sie Suchergebnisse nach den folgenden Alterswerten: Tag – Zurückgeben von Webseiten, die Bing innerhalb der letzten 24 Stunden ermittelt hat. Woche – Zurückgeben von Webseiten, die Bing innerhalb der letzten 7 Tage entdeckt hat. Monat – Zurückgeben von Webseiten, die innerhalb der letzten 30 Tage ermittelt wurden. Dieser Filter gilt nur für Webseitenergebnisse und nicht für die anderen Ergebnisse wie News und Bilder. Mögliche Werte sind: "Tag", "Woche", "Monat"
location	Eine durch Semikolons getrennte Liste von Schlüssel-Wert-Paaren, die den geografischen Standort des Clients beschreiben. Bing verwendet die Standortinformationen, um das sichere Suchverhalten zu ermitteln und relevante lokale Inhalte zurückzugeben. Geben Sie das Schlüssel-Wert-Paar als <Schlüssel>:<Wert> an. Im Folgenden sind die Schlüssel aufgeführt, die Sie zum Angeben des Standorts des Benutzers verwenden. lat (erforderlich): Der Breitengrad des Standorts des Clients in Grad. Der Breitengrad muss größer oder gleich -90,0 und kleiner als oder gleich +90,0 sein. Negative Werte deuten auf südliche Breiten und positive Werte auf nördliche Breiten hin. long (required): Der Längengrad des Standorts des Kunden in Grad. Der Längengrad muss größer oder gleich -180,0 und kleiner als oder gleich +180,0 sein. Negative Werte deuten auf westliche Längengrade und positive Werte auf östliche Längengrade hin. re (erforderlich): Der Radius in Metern, der die horizontale Genauigkeit der Koordinaten angibt. Übergeben Sie den vom Standortdienst des Geräts zurückgegebenen Wert. Typische Werte können 22 m für GPS/WI-Fi, 380m für die Zellturmtriangulation und 18.000m für umgekehrte IP-Suche sein. ts (optional): Der UTC UNIX-Zeitstempel des Zeitpunkts, an dem sich der Client am Standort befand. (Der UNIX-Zeitstempel ist die Anzahl der Sekunden seit dem 1. Januar 1970.) head (optional): Die relative Richtung oder Richtung des Reisens des Kunden. Geben Sie die Richtung des Reisens als Grad von 0 bis 360 an, wobei sie im Uhrzeigersinn relativ zum wahren Norden gezählt wird. Geben Sie diesen Schlüssel nur an, wenn der Sp-Schlüssel nicht null ist. sp (optional): Die horizontale Geschwindigkeit (Geschwindigkeit) in Metern pro Sekunde, die das Clientgerät unterwegs ist. alt (optional): Die Höhe des Clientgeräts in Metern. sind (optional): Der Radius in Metern, der die vertikale Genauigkeit der Koordinaten angibt. Geben Sie diesen Schlüssel nur an, wenn Sie die ALT-TASTE angeben. Obwohl viele der Schlüssel optional sind, desto mehr Informationen, die Sie bereitstellen, desto genauer sind die Standortergebnisse. Obwohl optional, sollten Sie immer den geografischen Standort des Benutzers angeben. Die Bereitstellung des Standorts ist besonders wichtig, wenn die IP-Adresse des Clients den physischen Standort des Benutzers nicht genau widerspiegelt (z. B. wenn der Client VPN verwendet). Um optimale Ergebnisse zu erzielen, sollten Sie diese Kopfzeile und den X-MSEdge-ClientIP-Header einschließen, sie sollten jedoch mindestens diesen Header einschließen.
market	Der Markt, aus dem die Ergebnisse stammen. In der Regel ist mkt das Land, aus dem der Benutzer die Anfrage stellt. Es kann jedoch ein anderes Land sein, wenn sich der Benutzer nicht in einem Land befindet, in dem Bing Ergebnisse liefert. Der Markt muss die Form <Sprachcode-Ländercode<>> haben. Beispiel: en-US. Bei der Zeichenfolge wird die Groß-/Kleinschreibung nicht beachtet. Wenn bekannt, werden Sie ermutigt, immer den Markt anzugeben. Wenn Sie den Markt angeben, hilft Bing, die Anforderung weiter zu leiten und eine entsprechende und optimale Antwort zurückzugeben. Wenn Sie einen Markt angeben, der nicht in Market Codes aufgeführt ist, verwendet Bing einen am besten geeigneten Marktcode basierend auf einer internen Zuordnung, die geändert werden kann. Dieser Parameter und der Cc-Abfrageparameter schließen sich gegenseitig aus– geben Sie nicht beide an. Standardwert: 'en-us'.
offset	Der nullbasierte Offset, der die Anzahl der zu überspringenden Suchergebnisse angibt, bevor Ergebnisse zurückgegeben werden. Der Standardwert ist 0. Der Offset sollte kleiner sein als (totalEstimatedMatches - count). Verwenden Sie diesen Parameter zusammen mit dem Count-Parameter für Seitenergebnisse. Wenn auf der Benutzeroberfläche beispielsweise 10 Suchergebnisse pro Seite angezeigt werden, legen Sie die Anzahl auf 10 fest, und setzen Sie den Offset auf 0, um die erste Seite der Ergebnisse abzurufen. Erhöhen Sie für jede nachfolgende Seite den Offset um 10 (z. B. 0, 10, 20). Es ist möglich, dass mehrere Seiten einige überlappende Ergebnisse enthalten.
pragma	Standardmäßig gibt Bing zwischengespeicherte Inhalte zurück, falls verfügbar. Um zu verhindern, dass Bing zwischengespeicherte Inhalte zurückgibt, legen Sie den Pragma-Header auf "no-cache" fest (z. B. Pragma: no-cache).
promote	Eine durch Trennzeichen getrennte Liste mit Antworten, die die Antwort unabhängig von ihrer Rangfolge enthalten soll. Wenn Sie beispielsweise "answerCount" auf zwei (2) festlegen, sodass Bing die beiden wichtigsten Antworten zurückgibt, aber sie möchten auch, dass die Antwort Nachrichten enthält, legen Sie "Höherstufen" auf "News" fest. Wenn es sich bei den am häufigsten bewerteten Antworten um Webseiten, Bilder, Videos und verwandteSearches handelt, enthält die Antwort Webseiten und Bilder, da Nachrichten keine bewertete Antwort sind. Wenn Sie jedoch werbung für Video festlegen, würde Bing die Videoantwort in die Antwort bewerben und Webseiten, Bilder und Videos zurückgeben. Die Antworten, die Sie höherstufen möchten, zählen nicht mit dem AnswerCount-Limit. Wenn die bewerteten Antworten z. B. Nachrichten, Bilder und Videos sind und Sie "answerCount" auf 1 festlegen und Nachrichten bewerben, enthält die Antwort Nachrichten und Bilder. Oder wenn die bewerteten Antworten Videos, Bilder und Nachrichten sind, enthält die Antwort Videos und Nachrichten. Mögliche Werte sind "Berechnung", "Bilder", "News", "RelatedSearches", "SpellSuggestions", "TimeZone", "Videos", "Webseiten". Wird nur verwendet, wenn Sie answerCount angeben.
responseFilter	Eine durch Trennzeichen getrennte Liste der Antworten, die in die Antwort aufgenommen werden sollen. Wenn Sie diesen Parameter nicht angeben, enthält die Antwort alle Suchantworten, für die relevante Daten vorhanden sind. Mögliche Filterwerte sind Berechnung, Bilder, Nachrichten, RelatedSearches, SpellSuggestions, TimeZone, Videos, Webseiten. Obwohl Sie diesen Filter verwenden können, um eine einzelne Antwort zu erhalten, sollten Sie stattdessen den antwortspezifischen Endpunkt verwenden, um umfassendere Ergebnisse zu erzielen. Um beispielsweise nur Bilder zu empfangen, senden Sie die Anforderung an einen der Image Search API-Endpunkte. Die Antworten "RelatedSearches" und "SpellSuggestions" unterstützen keinen separaten Endpunkt wie die Bildsuche-API (nur die Websuch-API gibt sie zurück). Informationen zum Einschließen von Antworten, die aufgrund der Rangfolge andernfalls ausgeschlossen werden würden, finden Sie im Abfrageparameter "Höherstufen".
safeSearch	Ein Filter, der verwendet wird, um erwachsene Inhalte zu filtern. Deaktiviert: Zurückgeben von Webseiten mit erwachsenem Text, Bildern oder Videos. Moderat: Zurückgeben von Webseiten mit erwachsenem Text, aber nicht von Erwachsenenbildern oder Videos. Streng: Geben Sie keine Webseiten mit erwachsenen Text, Bildern oder Videos zurück. Der Standardwert ist "Moderat". Wenn die Anforderung von einem Markt stammt, für den die Richtlinie für Erwachsene von Bing erfordert, dass safeSearch auf "Strict" festgelegt ist, ignoriert Bing den Wert "safeSearch" und verwendet "Strict". Wenn Sie den Abfrageoperator "site:" verwenden, besteht die Möglichkeit, dass die Antwort möglicherweise erwachsene Inhalte enthält, unabhängig davon, auf welchen SafeSearch-Abfrageparameter festgelegt ist. Verwenden Sie die Website: nur, wenn Sie den Inhalt auf der Website kennen und Ihr Szenario die Möglichkeit von erwachsenen Inhalten unterstützt. Mögliche Werte sind: "Aus", "Moderate", "Strict"
setLang	Die Sprache, die für Benutzeroberflächenzeichenfolgen verwendet werden soll. Geben Sie die Sprache mit dem ISO 639-1 2-Buchstaben-Sprachcode an. Beispielsweise lautet der Sprachcode für Englisch EN. Der Standardwert ist EN (Englisch). Obwohl optional, sollten Sie immer die Sprache angeben. In der Regel legen Sie "Lang" auf dieselbe sprache fest, die von mkt angegeben wird, es sei denn, der Benutzer möchte, dass die Zeichenfolgen der Benutzeroberfläche in einer anderen Sprache angezeigt werden. Dieser Parameter und der Accept-Language Header schließen sich gegenseitig aus; geben Sie nicht beides an. Eine Zeichenfolge der Benutzeroberfläche ist eine Zeichenfolge, die als Bezeichnung in einer Benutzeroberfläche verwendet wird. In den JSON-Antwortobjekten gibt es nur wenige Zeichenfolgen für die Benutzeroberfläche. Außerdem wenden alle Links zu Bing.com Eigenschaften in den Antwortobjekten die angegebene Sprache an.
textDecorations	Ein boolescher Wert, der bestimmt, ob Anzeigezeichenfolgen Dekorationsmarkierungen enthalten sollen, z. B. Treffermarkierungszeichen. Wenn true, können die Zeichenfolgen Markierungen enthalten. Der Standardwert ist "false". Informationen zum Angeben, ob Unicode-Zeichen oder HTML-Tags als Markierungen verwendet werden sollen, finden Sie im TextFormat-Abfrageparameter.
textFormat	Der Typ der Markierungen, die für Textzierer verwendet werden sollen (siehe textDecorations-Abfrageparameter). Mögliche Werte sind "Raw": Verwenden Sie Unicode-Zeichen, um Inhalte zu markieren, die spezielle Formatierungen erfordern. Die Unicode-Zeichen befinden sich im Bereich E000 bis E019. Bing verwendet z. B. E000 und E001, um den Anfang und das Ende der Abfragebegriffe für die Treffermarkierung zu markieren. HTML: Verwenden Sie HTML-Tags, um Inhalte zu markieren, die spezielle Formatierungen benötigen. Verwenden Sie beispielsweise Tags, um Abfragebegriffe in Anzeigezeichenfolgen hervorzuheben. Der Standardwert ist "Raw". Bei Anzeigezeichenfolgen, die aus escapebare HTML-Zeichen wie <, >und &enthalten, wird bing die Zeichen entsprechend escapet (z. B. wird < auf <escaped). Mögliche Werte sind: 'Raw', 'Html'
userAgent	Der Benutzer-Agent, der die Anforderung stammt. Bing verwendet den Benutzer-Agent, um mobilen Benutzern eine optimierte Benutzeroberfläche bereitzustellen. Obwohl optional, wird dringend empfohlen, diese Kopfzeile immer anzugeben. Der Benutzer-Agent sollte die gleiche Zeichenfolge sein, die jeder häufig verwendete Browser senden würde. Informationen zu Benutzer-Agents finden Sie unter RFC 2616.

Geerbte Eigenschaften

abortSignal	Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.
customHeaders	Benutzerdefinierte Anforderungsheader, die vor dem Senden der Anforderung angewendet werden.
onDownloadProgress	Rückruf, der beim Downloadfortschritt ausgelöst wird.
onUploadProgress	Rückruf, der beim Uploadfortschritt ausgelöst wird.
timeout	Die Anzahl der Millisekunden, die eine Anforderung annehmen kann, bevor sie automatisch beendet wird.

Details zur Eigenschaft

acceptLanguage

Eine durch Trennzeichen getrennte Liste einer oder mehrerer Sprachen, die für Benutzeroberflächenzeichenfolgen verwendet werden sollen. Die Liste nimmt die Reihenfolge der Voreinstellungen ab. Weitere Informationen, einschließlich des erwarteten Formats, finden Sie unter RFC2616. Dieser Header und der setLang-Abfrageparameter schließen sich gegenseitig aus; geben Sie nicht beides an. Wenn Sie diesen Header festlegen, müssen Sie auch den Cc-Abfrageparameter angeben. Bing verwendet die erste unterstützte Sprache, die sie aus der Liste findet, und kombiniert diese Sprache mit dem Cc-Parameterwert, um den Markt zu bestimmen, für den Ergebnisse zurückgegeben werden sollen. Wenn die Liste keine unterstützte Sprache enthält, findet Bing die nächstgelegene Sprache und den nächstgelegenen Markt, der die Anforderung unterstützt, und kann einen aggregierten oder Standardmarkt für die Ergebnisse anstelle eines angegebenen Markts verwenden. Sie sollten diesen Header und den Cc-Abfrageparameter nur verwenden, wenn Sie mehrere Sprachen angeben. andernfalls sollten Sie die Parameter "mkt" und "setLang" verwenden. Eine Zeichenfolge der Benutzeroberfläche ist eine Zeichenfolge, die als Bezeichnung in einer Benutzeroberfläche verwendet wird. Es gibt sehr wenige Benutzeroberflächenzeichenfolgen in den JSON-Antwortobjekten. Alle Links in den Antwortobjekten zu Bing.com Eigenschaften wenden die angegebene Sprache an.

acceptLanguage?: string

Eigenschaftswert

string

answerCount

Die Anzahl der Antworten, die die Antwort enthalten soll. Die Antworten, die Bing zurückgibt, basieren auf der Rangfolge. Wenn Bing beispielsweise Webseiten, Bilder, Videos und verwandteSearchs für eine Anforderung zurückgibt und Sie diesen Parameter auf zwei (2) festlegen, enthält die Antwort Webseiten und Bilder. Wenn Sie den Abfrageparameter "responseFilter" in derselben Anforderung eingeschlossen und auf Webseiten und Nachrichten festgelegt haben, enthält die Antwort nur Webseiten.

answerCount?: number

Eigenschaftswert

number

clientId

Bing verwendet diesen Header, um Benutzern ein einheitliches Verhalten für Bing-API-Aufrufe bereitzustellen. Bing fliegt häufig neue Features und Verbesserungen ab und verwendet die Client-ID als Schlüssel zum Zuweisen von Datenverkehr auf verschiedenen Flügen. Wenn Sie nicht dieselbe Client-ID für einen Benutzer über mehrere Anforderungen hinweg verwenden, kann Bing dem Benutzer mehrere Konflikte verursachende Flüge zuweisen. Die Zuweisung mehrerer konflikteder Flüge kann zu einer inkonsistenten Benutzererfahrung führen. Wenn die zweite Anforderung beispielsweise eine andere Test-Flight-Zuordnung aufweist als die erste, kann die Erfahrung unerwartet sein. Außerdem kann Bing die Client-ID verwenden, um Webergebnisse an den Suchverlauf dieser Client-ID anzupassen, was eine umfassendere Benutzeroberfläche für den Benutzer bietet. Bing verwendet diesen Header auch, um die Ergebnisbewertungen zu verbessern, indem die von einer Client-ID generierte Aktivität analysiert wird. Die Relevanzverbesserungen helfen bei einer besseren Qualität der Ergebnisse, die von Bing-APIs bereitgestellt werden, und ermöglicht wiederum höhere Klickraten für den API-Verbraucher. WICHTIG: Obwohl optional, sollten Sie diesen Header als erforderlich betrachten. Das Beibehalten der Client-ID über mehrere Anforderungen für denselben Endbenutzer und die Gerätekombination ermöglicht 1) den API-Consumer, eine konsistente Benutzererfahrung zu erhalten, und 2) höhere Klickraten über eine bessere Qualität der Ergebnisse aus den Bing-APIs. Jeder Benutzer, der Ihre Anwendung auf dem Gerät verwendet, muss über eine eindeutige, von Bing generierte Client-ID verfügen. Wenn Sie diesen Header nicht in die Anforderung einschließen, generiert Bing eine ID und gibt sie im X-MSEdge-ClientID Antwortheader zurück. Das einzige Mal, dass Sie diesen Header NICHT in eine Anforderung einschließen sollten, ist das erste Mal, wenn der Benutzer Ihre App auf diesem Gerät verwendet. Verwenden Sie die Client-ID für jede Bing-API-Anforderung, die Ihre App für diesen Benutzer auf dem Gerät vorgibt. Speichern Sie die Client-ID. Um die ID in einer Browser-App beizubehalten, verwenden Sie ein persistentes HTTP-Cookie, um sicherzustellen, dass die ID in allen Sitzungen verwendet wird. Verwenden Sie kein Sitzungscookies. Verwenden Sie für andere Apps wie mobile Apps den persistenten Speicher des Geräts, um die ID beizubehalten. Wenn der Benutzer ihre App das nächste Mal auf diesem Gerät verwendet, rufen Sie die client-ID ab, die Sie beibehalten haben. Bing-Antworten können diesen Header enthalten oder nicht. Wenn die Antwort diesen Header enthält, erfassen Sie die Client-ID, und verwenden Sie sie für alle nachfolgenden Bing-Anforderungen für den Benutzer auf diesem Gerät. Wenn Sie die X-MSEdge-ClientID einschließen, dürfen Sie keine Cookies in die Anforderung aufnehmen.

clientId?: string

Eigenschaftswert

string

clientIp

Die IPv4- oder IPv6-Adresse des Clientgeräts. Die IP-Adresse wird verwendet, um den Standort des Benutzers zu ermitteln. Bing verwendet die Standortinformationen, um das sichere Suchverhalten zu ermitteln. Obwohl optional, sollten Sie diese Kopfzeile und den X-Search-Location-Header immer angeben. Verschleiern Sie die Adresse nicht (z. B. durch Ändern des letzten Oktetts auf 0). Das Verschleiern der Adresse führt dazu, dass sich der Standort nicht in der Nähe des tatsächlichen Standorts des Geräts befindet, was dazu führen kann, dass Bing fehlerhafte Ergebnisse enthält.

clientIp?: string

Eigenschaftswert

string

count

Die Anzahl der Suchergebnisse, die in der Antwort zurückgegeben werden sollen. Der Standardwert ist 10 und der Maximalwert ist 50. Die tatsächlich gelieferte Zahl kann kleiner als angefordert sein. Verwenden Sie diesen Parameter zusammen mit dem Offsetparameter für Seitenergebnisse. Wenn auf der Benutzeroberfläche beispielsweise 10 Suchergebnisse pro Seite angezeigt werden, legen Sie die Anzahl auf 10 fest, und setzen Sie den Offset auf 0, um die erste Seite der Ergebnisse abzurufen. Erhöhen Sie für jede nachfolgende Seite den Offset um 10 (z. B. 0, 10, 20). Es ist möglich, dass mehrere Seiten in Ergebnisse überlappen.

count?: number

Eigenschaftswert

number

countryCode

Eine 2-stellige Länderkennzahl des Landes, aus dem die Ergebnisse stammen. Diese API unterstützt nur den US-Markt. Wenn Sie diesen Abfrageparameter angeben, muss er auf uns festgelegt werden. Wenn Sie diesen Parameter festlegen, müssen Sie auch den Accept-Language Header angeben. Bing verwendet die erste unterstützte Sprache aus der Sprachenliste, und kombinieren Sie diese Sprache mit dem Ländercode, den Sie angeben, um den Markt für die Ergebnisse zurückzugeben. Wenn die Sprachenliste keine unterstützte Sprache enthält, findet Bing die nächstgelegene Sprache und den nächstgelegenen Markt, der die Anforderung unterstützt, oder es kann einen aggregierten oder Standardmarkt für die Ergebnisse anstelle eines angegebenen Markts verwenden. Sie sollten diesen Abfrageparameter und den Accept-Language Abfrageparameter nur verwenden, wenn Sie mehrere Sprachen angeben. andernfalls sollten Sie die Parameter "mkt" und "setLang" verwenden. Dieser Parameter und der mkt-Abfrageparameter schließen sich gegenseitig aus – geben Sie nicht beide an.

countryCode?: string

Eigenschaftswert

string

freshness

Filtern Sie Suchergebnisse nach den folgenden Alterswerten: Tag – Zurückgeben von Webseiten, die Bing innerhalb der letzten 24 Stunden ermittelt hat. Woche – Zurückgeben von Webseiten, die Bing innerhalb der letzten 7 Tage entdeckt hat. Monat – Zurückgeben von Webseiten, die innerhalb der letzten 30 Tage ermittelt wurden. Dieser Filter gilt nur für Webseitenergebnisse und nicht für die anderen Ergebnisse wie News und Bilder. Mögliche Werte sind: "Tag", "Woche", "Monat"

freshness?: Freshness

Eigenschaftswert

Freshness

location

Eine durch Semikolons getrennte Liste von Schlüssel-Wert-Paaren, die den geografischen Standort des Clients beschreiben. Bing verwendet die Standortinformationen, um das sichere Suchverhalten zu ermitteln und relevante lokale Inhalte zurückzugeben. Geben Sie das Schlüssel-Wert-Paar als <Schlüssel>:<Wert> an. Im Folgenden sind die Schlüssel aufgeführt, die Sie zum Angeben des Standorts des Benutzers verwenden. lat (erforderlich): Der Breitengrad des Standorts des Clients in Grad. Der Breitengrad muss größer oder gleich -90,0 und kleiner als oder gleich +90,0 sein. Negative Werte deuten auf südliche Breiten und positive Werte auf nördliche Breiten hin. long (required): Der Längengrad des Standorts des Kunden in Grad. Der Längengrad muss größer oder gleich -180,0 und kleiner als oder gleich +180,0 sein. Negative Werte deuten auf westliche Längengrade und positive Werte auf östliche Längengrade hin. re (erforderlich): Der Radius in Metern, der die horizontale Genauigkeit der Koordinaten angibt. Übergeben Sie den vom Standortdienst des Geräts zurückgegebenen Wert. Typische Werte können 22 m für GPS/WI-Fi, 380m für die Zellturmtriangulation und 18.000m für umgekehrte IP-Suche sein. ts (optional): Der UTC UNIX-Zeitstempel des Zeitpunkts, an dem sich der Client am Standort befand. (Der UNIX-Zeitstempel ist die Anzahl der Sekunden seit dem 1. Januar 1970.) head (optional): Die relative Richtung oder Richtung des Reisens des Kunden. Geben Sie die Richtung des Reisens als Grad von 0 bis 360 an, wobei sie im Uhrzeigersinn relativ zum wahren Norden gezählt wird. Geben Sie diesen Schlüssel nur an, wenn der Sp-Schlüssel nicht null ist. sp (optional): Die horizontale Geschwindigkeit (Geschwindigkeit) in Metern pro Sekunde, die das Clientgerät unterwegs ist. alt (optional): Die Höhe des Clientgeräts in Metern. sind (optional): Der Radius in Metern, der die vertikale Genauigkeit der Koordinaten angibt. Geben Sie diesen Schlüssel nur an, wenn Sie die ALT-TASTE angeben. Obwohl viele der Schlüssel optional sind, desto mehr Informationen, die Sie bereitstellen, desto genauer sind die Standortergebnisse. Obwohl optional, sollten Sie immer den geografischen Standort des Benutzers angeben. Die Bereitstellung des Standorts ist besonders wichtig, wenn die IP-Adresse des Clients den physischen Standort des Benutzers nicht genau widerspiegelt (z. B. wenn der Client VPN verwendet). Um optimale Ergebnisse zu erzielen, sollten Sie diese Kopfzeile und den X-MSEdge-ClientIP-Header einschließen, sie sollten jedoch mindestens diesen Header einschließen.

location?: string

Eigenschaftswert

string

market

Der Markt, aus dem die Ergebnisse stammen. In der Regel ist mkt das Land, aus dem der Benutzer die Anfrage stellt. Es kann jedoch ein anderes Land sein, wenn sich der Benutzer nicht in einem Land befindet, in dem Bing Ergebnisse liefert. Der Markt muss die Form <Sprachcode-Ländercode<>> haben. Beispiel: en-US. Bei der Zeichenfolge wird die Groß-/Kleinschreibung nicht beachtet. Wenn bekannt, werden Sie ermutigt, immer den Markt anzugeben. Wenn Sie den Markt angeben, hilft Bing, die Anforderung weiter zu leiten und eine entsprechende und optimale Antwort zurückzugeben. Wenn Sie einen Markt angeben, der nicht in Market Codes aufgeführt ist, verwendet Bing einen am besten geeigneten Marktcode basierend auf einer internen Zuordnung, die geändert werden kann. Dieser Parameter und der Cc-Abfrageparameter schließen sich gegenseitig aus– geben Sie nicht beide an. Standardwert: 'en-us'.

market?: string

Eigenschaftswert

string

offset

Der nullbasierte Offset, der die Anzahl der zu überspringenden Suchergebnisse angibt, bevor Ergebnisse zurückgegeben werden. Der Standardwert ist 0. Der Offset sollte kleiner sein als (totalEstimatedMatches - count). Verwenden Sie diesen Parameter zusammen mit dem Count-Parameter für Seitenergebnisse. Wenn auf der Benutzeroberfläche beispielsweise 10 Suchergebnisse pro Seite angezeigt werden, legen Sie die Anzahl auf 10 fest, und setzen Sie den Offset auf 0, um die erste Seite der Ergebnisse abzurufen. Erhöhen Sie für jede nachfolgende Seite den Offset um 10 (z. B. 0, 10, 20). Es ist möglich, dass mehrere Seiten einige überlappende Ergebnisse enthalten.

offset?: number

Eigenschaftswert

number

pragma

Standardmäßig gibt Bing zwischengespeicherte Inhalte zurück, falls verfügbar. Um zu verhindern, dass Bing zwischengespeicherte Inhalte zurückgibt, legen Sie den Pragma-Header auf "no-cache" fest (z. B. Pragma: no-cache).

pragma?: string

Eigenschaftswert

string

promote

Eine durch Trennzeichen getrennte Liste mit Antworten, die die Antwort unabhängig von ihrer Rangfolge enthalten soll. Wenn Sie beispielsweise "answerCount" auf zwei (2) festlegen, sodass Bing die beiden wichtigsten Antworten zurückgibt, aber sie möchten auch, dass die Antwort Nachrichten enthält, legen Sie "Höherstufen" auf "News" fest. Wenn es sich bei den am häufigsten bewerteten Antworten um Webseiten, Bilder, Videos und verwandteSearches handelt, enthält die Antwort Webseiten und Bilder, da Nachrichten keine bewertete Antwort sind. Wenn Sie jedoch werbung für Video festlegen, würde Bing die Videoantwort in die Antwort bewerben und Webseiten, Bilder und Videos zurückgeben. Die Antworten, die Sie höherstufen möchten, zählen nicht mit dem AnswerCount-Limit. Wenn die bewerteten Antworten z. B. Nachrichten, Bilder und Videos sind und Sie "answerCount" auf 1 festlegen und Nachrichten bewerben, enthält die Antwort Nachrichten und Bilder. Oder wenn die bewerteten Antworten Videos, Bilder und Nachrichten sind, enthält die Antwort Videos und Nachrichten. Mögliche Werte sind "Berechnung", "Bilder", "News", "RelatedSearches", "SpellSuggestions", "TimeZone", "Videos", "Webseiten". Wird nur verwendet, wenn Sie answerCount angeben.

promote?: AnswerType[]

Eigenschaftswert

AnswerType[]

responseFilter

Eine durch Trennzeichen getrennte Liste der Antworten, die in die Antwort aufgenommen werden sollen. Wenn Sie diesen Parameter nicht angeben, enthält die Antwort alle Suchantworten, für die relevante Daten vorhanden sind. Mögliche Filterwerte sind Berechnung, Bilder, Nachrichten, RelatedSearches, SpellSuggestions, TimeZone, Videos, Webseiten. Obwohl Sie diesen Filter verwenden können, um eine einzelne Antwort zu erhalten, sollten Sie stattdessen den antwortspezifischen Endpunkt verwenden, um umfassendere Ergebnisse zu erzielen. Um beispielsweise nur Bilder zu empfangen, senden Sie die Anforderung an einen der Image Search API-Endpunkte. Die Antworten "RelatedSearches" und "SpellSuggestions" unterstützen keinen separaten Endpunkt wie die Bildsuche-API (nur die Websuch-API gibt sie zurück). Informationen zum Einschließen von Antworten, die aufgrund der Rangfolge andernfalls ausgeschlossen werden würden, finden Sie im Abfrageparameter "Höherstufen".

responseFilter?: AnswerType[]

Eigenschaftswert

AnswerType[]

safeSearch

Ein Filter, der verwendet wird, um erwachsene Inhalte zu filtern. Deaktiviert: Zurückgeben von Webseiten mit erwachsenem Text, Bildern oder Videos. Moderat: Zurückgeben von Webseiten mit erwachsenem Text, aber nicht von Erwachsenenbildern oder Videos. Streng: Geben Sie keine Webseiten mit erwachsenen Text, Bildern oder Videos zurück. Der Standardwert ist "Moderat". Wenn die Anforderung von einem Markt stammt, für den die Richtlinie für Erwachsene von Bing erfordert, dass safeSearch auf "Strict" festgelegt ist, ignoriert Bing den Wert "safeSearch" und verwendet "Strict". Wenn Sie den Abfrageoperator "site:" verwenden, besteht die Möglichkeit, dass die Antwort möglicherweise erwachsene Inhalte enthält, unabhängig davon, auf welchen SafeSearch-Abfrageparameter festgelegt ist. Verwenden Sie die Website: nur, wenn Sie den Inhalt auf der Website kennen und Ihr Szenario die Möglichkeit von erwachsenen Inhalten unterstützt. Mögliche Werte sind: "Aus", "Moderate", "Strict"

safeSearch?: SafeSearch

Eigenschaftswert

SafeSearch

setLang

Die Sprache, die für Benutzeroberflächenzeichenfolgen verwendet werden soll. Geben Sie die Sprache mit dem ISO 639-1 2-Buchstaben-Sprachcode an. Beispielsweise lautet der Sprachcode für Englisch EN. Der Standardwert ist EN (Englisch). Obwohl optional, sollten Sie immer die Sprache angeben. In der Regel legen Sie "Lang" auf dieselbe sprache fest, die von mkt angegeben wird, es sei denn, der Benutzer möchte, dass die Zeichenfolgen der Benutzeroberfläche in einer anderen Sprache angezeigt werden. Dieser Parameter und der Accept-Language Header schließen sich gegenseitig aus; geben Sie nicht beides an. Eine Zeichenfolge der Benutzeroberfläche ist eine Zeichenfolge, die als Bezeichnung in einer Benutzeroberfläche verwendet wird. In den JSON-Antwortobjekten gibt es nur wenige Zeichenfolgen für die Benutzeroberfläche. Außerdem wenden alle Links zu Bing.com Eigenschaften in den Antwortobjekten die angegebene Sprache an.

setLang?: string

Eigenschaftswert

string

textDecorations

Ein boolescher Wert, der bestimmt, ob Anzeigezeichenfolgen Dekorationsmarkierungen enthalten sollen, z. B. Treffermarkierungszeichen. Wenn true, können die Zeichenfolgen Markierungen enthalten. Der Standardwert ist "false". Informationen zum Angeben, ob Unicode-Zeichen oder HTML-Tags als Markierungen verwendet werden sollen, finden Sie im TextFormat-Abfrageparameter.

textDecorations?: boolean

Eigenschaftswert

boolean

textFormat

Der Typ der Markierungen, die für Textzierer verwendet werden sollen (siehe textDecorations-Abfrageparameter). Mögliche Werte sind "Raw": Verwenden Sie Unicode-Zeichen, um Inhalte zu markieren, die spezielle Formatierungen erfordern. Die Unicode-Zeichen befinden sich im Bereich E000 bis E019. Bing verwendet z. B. E000 und E001, um den Anfang und das Ende der Abfragebegriffe für die Treffermarkierung zu markieren. HTML: Verwenden Sie HTML-Tags, um Inhalte zu markieren, die spezielle Formatierungen benötigen. Verwenden Sie beispielsweise Tags, um Abfragebegriffe in Anzeigezeichenfolgen hervorzuheben. Der Standardwert ist "Raw". Bei Anzeigezeichenfolgen, die aus escapebare HTML-Zeichen wie <, >und &enthalten, wird bing die Zeichen entsprechend escapet (z. B. wird < auf <escaped). Mögliche Werte sind: 'Raw', 'Html'

textFormat?: TextFormat

Eigenschaftswert

TextFormat

userAgent

Der Benutzer-Agent, der die Anforderung stammt. Bing verwendet den Benutzer-Agent, um mobilen Benutzern eine optimierte Benutzeroberfläche bereitzustellen. Obwohl optional, wird dringend empfohlen, diese Kopfzeile immer anzugeben. Der Benutzer-Agent sollte die gleiche Zeichenfolge sein, die jeder häufig verwendete Browser senden würde. Informationen zu Benutzer-Agents finden Sie unter RFC 2616.

userAgent?: string

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

geerbt von msRest.RequestOptionsBase.abortSignal

customHeaders

Benutzerdefinierte Anforderungsheader, die vor dem Senden der Anforderung angewendet werden.

customHeaders?: {[key: string]: string}

Eigenschaftswert

{[key: string]: string}

geerbt von msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Rückruf, der beim Downloadfortschritt ausgelöst wird.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

geerbt von msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Rückruf, der beim Uploadfortschritt ausgelöst wird.

onUploadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

geerbt von msRest.RequestOptionsBase.onUploadProgress

timeout

Die Anzahl der Millisekunden, die eine Anforderung annehmen kann, bevor sie automatisch beendet wird.

timeout?: number

Eigenschaftswert

number

geerbt von msRest.RequestOptionsBase.timeout