Web.SearchWithHttpMessagesAsync Methode

Referenz

Definition

Namespace:: Microsoft.Azure.CognitiveServices.Search.WebSearch

Assembly:: Microsoft.Azure.CognitiveServices.Search.WebSearch.dll

Paket:: Microsoft.Azure.CognitiveServices.Search.WebSearch v2.0.0

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Mit der Websuche-API können Sie eine Suchabfrage an Bing senden und Suchergebnisse abrufen, die Links zu Webseiten, Bildern und mehr enthalten.

public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.WebSearch.Models.SearchResponse>> SearchWithHttpMessagesAsync (string query, string acceptLanguage = default, string pragma = default, string userAgent = default, string clientId = default, string clientIp = default, string location = default, int? answerCount = default, string countryCode = default, int? count = default, string freshness = default, string market = "en-us", int? offset = default, System.Collections.Generic.IList<string> promote = default, System.Collections.Generic.IList<string> responseFilter = default, string safeSearch = default, string setLang = default, bool? textDecorations = default, string textFormat = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member SearchWithHttpMessagesAsync : string * string * string * string * string * string * string * Nullable<int> * string * Nullable<int> * string * string * Nullable<int> * System.Collections.Generic.IList<string> * System.Collections.Generic.IList<string> * string * string * Nullable<bool> * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.WebSearch.Models.SearchResponse>>
override this.SearchWithHttpMessagesAsync : string * string * string * string * string * string * string * Nullable<int> * string * Nullable<int> * string * string * Nullable<int> * System.Collections.Generic.IList<string> * System.Collections.Generic.IList<string> * string * string * Nullable<bool> * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.WebSearch.Models.SearchResponse>>

Public Function SearchWithHttpMessagesAsync (query As String, Optional acceptLanguage As String = Nothing, Optional pragma As String = Nothing, Optional userAgent As String = Nothing, Optional clientId As String = Nothing, Optional clientIp As String = Nothing, Optional location As String = Nothing, Optional answerCount As Nullable(Of Integer) = Nothing, Optional countryCode As String = Nothing, Optional count As Nullable(Of Integer) = Nothing, Optional freshness As String = Nothing, Optional market As String = "en-us", Optional offset As Nullable(Of Integer) = Nothing, Optional promote As IList(Of String) = Nothing, Optional responseFilter As IList(Of String) = Nothing, Optional safeSearch As String = Nothing, Optional setLang As String = Nothing, Optional textDecorations As Nullable(Of Boolean) = Nothing, Optional textFormat As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of SearchResponse))

Parameter

query: String

Der Suchabfragebegriff des Benutzers. Der Begriff ist möglicherweise nicht leer. Der Begriff kann erweiterte Bing-Operatoren enthalten. Verwenden Sie beispielsweise den Site:-Operator, um die Ergebnisse auf eine bestimmte Domäne zu beschränken.

acceptLanguage: String

Eine durch Trennzeichen getrennte Liste einer oder mehrerer Sprachen, die für Benutzeroberflächenzeichenfolgen verwendet werden soll. Die Liste ist absteigend nach Präferenz sortiert. 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 beide an. Wenn Sie diesen Header festlegen, müssen Sie auch den Abfrageparameter „cc“ angeben. Bing verwendet die erste unterstützte Sprache, die es 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 anstelle eines angegebenen einen aggregierten oder Standardmarkt für die Ergebnisse verwenden. Sie sollten diesen Header und den Abfrageparameter cc nur verwenden, wenn Sie mehrere Sprachen angeben. Andernfalls sollten Sie die Abfrageparameter mkt und setLang verwenden. Eine Zeichenfolge der Benutzeroberfläche ist eine Zeichenfolge, die als Bezeichnung in einer Benutzeroberfläche verwendet wird. Es gibt nur sehr wenige Benutzeroberflächenzeichenfolgen in den JSON-Antwortobjekten. Alle Links in den Antwortobjekten zu Bing.com Eigenschaften wenden die angegebene Sprache an.

pragma: String

Als Standardeinstellung gibt Bing zwischengespeicherte Inhalte (sofern vorhanden) zurück. Wenn Sie dies verhindern möchten, legen Sie den Pragma-Header auf „no-cache“ fest (z.B. „Pragma: no-cache“).

userAgent: String

Der Benutzer-Agent, von dem die Anforderung stammt. Bing verwendet den Benutzer-Agent, um die Erfahrung mobiler Benutzer zu optimieren. Obwohl optional, wird dringend empfohlen, diesen Header immer anzugeben. Der User-Agent sollte dieselbe Zeichenfolge sein, die jeder häufig verwendete Browser senden würde. Informationen zu Benutzer-Agents finden Sie in RFC 2616.

clientId: String

Bing verwendet diesen Header, um Benutzern beim Aufrufen der Bing-API ein konsistentes Verhalten bereitzustellen. Bing testet häufig neue Funktionen und Verbesserungen und verwendet dabei die Client-ID als Schlüssel für die Zuweisung von Datenverkehr an verschiedene Flights. Wenn Sie für einen Benutzer bei unterschiedlichen Anforderungen nicht dieselbe Client-ID verwenden, weist Bing den Benutzer möglicherweise mehreren widersprüchlichen Flights zu. Die Zuweisung zu mehreren widersprüchlichen Flights kann zu einer inkonsistenten Benutzererfahrung führen. Weist die zweite Anforderung beispielsweise eine andere Flight-Zuweisung als die erste auf, kann dies zu einer unerwarteten Benutzererfahrung führen. Außerdem kann Bing die Client-ID zur Anpassung der Webergebnisse an den Suchverlauf dieser Client-ID verwenden. Dies führt zu einer noch besseren Benutzererfahrung. Bing verwendet den Header auch, um die Rangfolge der Ergebnisse zu verbessern, indem es die Aktivität der Client-ID analysiert. Durch die verbesserte Relevanz erhöht sich die Qualität der von Bing-APIs bereitgestellten Ergebnisse, was wiederum zu höheren Durchklickraten für den API-Consumer führt. WICHTIG: Auch wenn er optional ist, sollten Sie diesen Header als erforderlich betrachten. Das Beibehalten der Client-ID für dieselbe Kombination aus Benutzer und Gerät über mehrere Anforderungen hinweg ermöglicht 1) dem API-Consumer eine konsistente Benutzererfahrung sowie 2) höhere Durchklickraten durch eine bessere Qualität der Bing-API-Ergebnisse. Jeder Benutzer, der die 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 einfügen, generiert Bing eine ID, die im Antwortheader „X-MSEdge-ClientID“ zurückgegeben wird. Der einzige Zeitpunkt, zu dem dieser Header NICHT in eine Anforderung eingeschlossen werden sollte, ist bei der erstmaligen Verwendung der App auf dem Gerät. Verwenden Sie die Client-ID für jede Anforderung der Bing-API, die die App für diesen Benutzer auf dem Gerät durchführt. Behalten Sie die Client-ID bei. Verwenden Sie ein permanentes HTTP-Cookie, um sicherzustellen, dass die ID in einer Browser-App bei allen Sitzungen verwendet wird. Verwenden Sie kein Sitzungscookie. Verwenden Sie für andere Apps wie z.B. mobile Apps den permanenten Speicher des Geräts, um die ID beizubehalten. Rufen Sie bei der nächsten Verwendung der App auf dem Gerät durch den Benutzer die gespeicherte Client-ID ab. Bing-Antworten können diesen Header enthalten, müssen es aber nicht. Enthält die Antwort diesen Header, erfassen Sie die Client-ID, und verwenden Sie sie für alle nachfolgenden Bing-Anforderungen des Benutzers auf diesem Gerät. Wenn Sie den Header „X-MSEdge-ClientID“ einfügen, dürfen Sie in die Anforderung nicht gleichzeitig Cookies einschließen.

clientIp: String

Die IPv4- oder IPv6-Adresse des Clientgeräts. Die IP-Adresse wird verwendet, um den Standort des Benutzers zu ermitteln. Bing verwendet die Standortinformationen für ein sicheres Suchverhalten. Auch wenn dies optional ist, sollten Sie diesen Header und den Header „X-Search-Location“ immer angeben. Verschleiern Sie nicht die Adresse (z.B. durch Ändern des letzten Oktetts in 0). Durch Verschleiern der Adresse stimmen Ihr Standort und der tatsächliche Gerätestandort nicht überein, wodurch Bing möglicherweise fehlerhafte Ergebnisse anzeigt.

location: String

Eine durch Semikolons getrennte Liste mit Schlüssel/Wert-Paaren, die den geografischen Standort des Clients beschreiben. Bing verwendet die Standortinformationen für ein sicheres Suchverhalten und zur Rückgabe von lokalen relevanten Inhalten. Geben Sie das Schlüssel-Wert-Paar im Format <Schlüssel>:<Wert> an. Verwenden Sie die folgenden Schlüssel zur Angabe des Benutzerstandorts. lat (erforderlich): Der Breitengrad des Clientstandorts in Grad. Der Breitengrad muss größer als oder gleich -90,0 und kleiner als oder gleich +90,0 sein. Negative Werte geben südliche Breitengrade und positive Werte nördliche Breitengrade an. long (erforderlich): Der Längengrad des Standorts des Clients in Grad. Der Längengrad muss größer als oder gleich -180,0 und kleiner als oder gleich +180,0 sein. Negative Werte geben westliche Längengrade und positive Werte östliche Längengrade an. re (erforderlich): Der Radius in Metern, der die horizontale Genauigkeit der Koordinaten angibt. Übergeben Sie den Wert, der vom Standortdienst des Geräts zurückgegeben wird. Typische Werte sind 22 m für GPS/WLAN, 380 m für die Funkmasttriangulation und 18.000 m für die umgekehrte IP-Suche. 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 Clients. Geben Sie die Reiserichtung von 0 bis 360 (in Grad) im Uhrzeigersinn ausgehend vom geografischen Norden an. Geben Sie diesen Schlüssel nur an, wenn der SP-Schlüssel ungleich 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. are (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. Auch wenn viele der Schlüssel optional sind, werden die Standortergebnisse immer genauer, je mehr Informationen Sie bereitstellen. Auch wenn dies optional ist, sollten Sie den geografischen Standort des Benutzers immer angeben. Besonders wichtig ist die Standortangabe dann, wenn die IP-Adresse des Clients den physischen Standort des Benutzers nicht exakt wiedergibt (wenn der Client beispielsweise VPN verwendet). Für optimale Ergebnisse sollten Sie diesen Header und den Header „X-MSEdge-ClientIP“ einfügen. Auf jeden Fall sollten Sie aber zumindest diesen Header verwenden.

answerCount: Nullable<Int32>

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 relatedSearches 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 die gleiche Anforderung einschließen und ihn auf Webseiten und Nachrichten festlegen, würde die Antwort nur Webseiten enthalten.

countryCode: String

Ein zweistelliger Ländercode des Landes, aus dem die Ergebnisse stammen. Diese API unterstützt nur den USA Markt. Wenn Sie diesen Abfrageparameter angeben, muss er auf uns festgelegt werden. Wenn Sie diesen Parameter festlegen, müssen Sie auch den Header Accept-Language angeben. Bing verwendet die erste unterstützte Sprache, die es aus der Sprachenliste findet, und kombiniert diese Sprache mit dem Ländercode, den Sie angeben, um den Markt zu bestimmen, für den Ergebnisse zurückgegeben werden sollen. 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 verwenden. Sie sollten diesen Abfrageparameter und den Accept-Language Abfrageparameter nur verwenden, wenn Sie mehrere Sprachen angeben. Andernfalls sollten Sie die Abfrageparameter mkt und setLang verwenden. Dieser Parameter und der Abfrageparameter mkt schließen sich gegenseitig aus. Geben Sie daher nicht beide an.

count: Nullable<Int32>

Die Anzahl von Suchergebnissen, die in der Antwort zurückgegeben werden sollen. Der Standardwert ist 10, und der Höchstwert ist 50. Die tatsächlich übermittelte 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 und den Offset auf 0 fest, um die erste Seite der Ergebnisse zu erhalten. 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 Überschneidungen in den Ergebnissen enthalten.

freshness: String

Filtern von Suchergebnissen nach den folgenden Alterswerten: Tag: Zurückgeben von Webseiten, die Bing innerhalb der letzten 24 Stunden ermittelt hat. Woche: Gibt Webseiten zurück, die Bing innerhalb der letzten 7 Tage ermittelt hat. Monat: Gibt Webseiten zurück, die innerhalb der letzten 30 Tage ermittelt wurden. Dieser Filter gilt nur für Webseitenergebnisse und nicht für die anderen Ergebnisse wie Nachrichten und Bilder. Mögliche Werte: "Day", "Week", "Month"

market: String

Der Markt, aus dem die Ergebnisse stammen. In der Regel ist mkt das Land, aus dem der Benutzer die Anforderung 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 in der Formatsprache <Code-Ländercode><> vorliegen. Beispiel: en-US. Bei der Zeichenfolge wird die Groß-/Kleinschreibung nicht beachtet. Falls bekannt, sollten Sie immer den Markt angeben. Die Angabe des Marktes ermöglicht Bing, die Anforderung weiterzuleiten und eine geeignete und optimale Antwort zurückzugeben. Wenn Sie einen Markt angeben, der nicht in Marktcodes aufgeführt ist, verwendet Bing einen Marktcode, der am besten geeignet ist, basierend auf einer internen Zuordnung, die sich ändern kann. Dieser Parameter und der Abfrageparameter cc schließen sich gegenseitig aus. Geben Sie daher nicht beide an.

offset: Nullable<Int32>

Der nullbasierte Offset, der die Anzahl der zu überspringenden Suchergebnisse angibt, bevor Ergebnisse zurückgegeben werden. Die Standardeinstellung ist 0. Der Offset sollte kleiner als (totalEstimatedMatches - count) sein. Verwenden Sie diesen Parameter zusammen mit dem Count-Parameter, um Ergebnisse zu seiten. Wenn ihre Benutzeroberfläche beispielsweise 10 Suchergebnisse pro Seite anzeigt, legen Sie die Anzahl auf 10 und den Offset auf 0 fest, um die erste Seite der Ergebnisse zu erhalten. Erhöhen Sie für jede nachfolgende Seite den Offset um 10 (z. B. 0, 10, 20). es ist möglich, dass mehrere Seiten eine gewisse Überlappung in den Ergebnissen enthalten.

promote: IList<String>

Eine durch Kommas getrennte Liste von Antworten, die die Antwort unabhängig von ihrer Rangfolge enthalten soll. Wenn Sie z. B. answerCount) auf zwei (2) festlegen, damit Bing die beiden besten Antworten zurückgibt, aber sie möchten, dass die Antwort auch Nachrichten enthält, legen Sie "Höherstufen" auf "Nachrichten" fest. Wenn die Antworten am besten auf Webseiten, Bilder, Videos und verwandte Suchvorgänge zurückzuführen sind, enthält die Antwort Webseiten und Bilder, da Nachrichten keine rangierte Antwort sind. Wenn Sie jedoch "Höherstufen" auf "Video" festlegen, würde Bing die Videoantwort in die Antwort höherstufen und Webseiten, Bilder und Videos zurückgeben. Die Antworten, die Sie höherstufen möchten, zählen nicht auf das answerCount-Limit. Wenn die antworten beispielsweise Nachrichten, Bilder und Videos sind und Sie answerCount auf 1 festlegen und in Nachrichten höherstufen, enthält die Antwort Nachrichten und Bilder. Wenn die Antworten mit Rangfolge Videos, Bilder und News sind, enthält die Antwort Videos und News. Mögliche Werte sind Computation, Images, News, RelatedSearches, SpellSuggestions, TimeZone, Videos, Webpages. Verwenden Sie nur, wenn Sie answerCount angeben.

responseFilter: IList<String>

Eine durch Trennzeichen getrennte Liste von 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 vorliegen. Mögliche Filterwerte sind Computation, Images, News, RelatedSearches, SpellSuggestions, TimeZone, Videos, Webpages. Obwohl Sie diesen Filter verwenden können, um eine einzelne Antwort zu erhalten, sollten Sie stattdessen den antwortspezifischen Endpunkt verwenden, um umfangreichere Ergebnisse zu erhalten. Um beispielsweise nur Bilder zu empfangen, senden Sie die Anforderung an einen der Endpunkte der Bildsuche-API. Die Antworten relatedSearches und SpellSuggestions unterstützen keinen separaten Endpunkt wie die Bildsuche-API (nur die Websuche-API gibt sie zurück). Informationen zum Einschließen von Antworten, die andernfalls aufgrund der Rangfolge ausgeschlossen würden, finden Sie im Abfrageparameter "Heraufstufen".

safeSearch: String

Ein Filter für nicht jugendfreie Inhalte. Off: Zurückgeben von Webseiten mit textfreiem Text, Bildern oder Videos. Moderat: Gibt Webseiten mit erwachsenen Text zurück, aber keine erwachsenen Bilder oder Videos. Streng: Geben Sie keine Webseiten mit textfreiem Text, Bildern oder Videos zurück. Die Standardeinstellung ist „Moderate“. Wenn die Anforderung von einem Markt stammt, für den die Erwachsenenrichtlinie 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 nicht jugendfreie Inhalte enthält, unabhängig davon, auf was der safeSearch-Abfrageparameter festgelegt ist. Website verwenden: nur, wenn Sie den Inhalt auf der Website kennen und Ihr Szenario die Möglichkeit von erwachsenen Inhalten unterstützt. Mögliche Werte: "Off", "Moderate", "Strict"

setLang: String

Die Sprache, die für Zeichenfolgen der Benutzeroberfläche verwendet werden soll. Geben Sie die Sprache mithilfe des zweistelligen Sprachcodes nach ISO 639-1 an. Der Sprachcode für Englisch lautet z.B. „EN“. Der Standardwert ist „EN“ (Englisch). Auch wenn dies optional ist, sollten Sie immer eine Sprache angeben. In der Regel legen Sie setLang auf dieselbe Sprache fest, die von mkt angegeben wird, es sei denn, der Benutzer möchte, dass die Benutzeroberfläche-Zeichenfolgen 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. Die JSON-Antwortobjekte enthalten nur wenige Zeichenfolgen für Benutzeroberflächen. Die angegebene Sprache wird auch in Links zu Eigenschaften von „bing.com“ in den Antwortobjekten verwendet.

textDecorations: Nullable<Boolean>

Ein boolescher Wert, der bestimmt, ob Anzeigezeichenfolgen Dekorationsmarkierungen wie Treffermarkierungszeichen enthalten sollen. Wenn true, können die Zeichenfolgen Marker enthalten. Die Standardeinstellung ist „false“. Informationen zum Verwenden von Unicode-Zeichen oder HTML-Tags als Marker finden Sie im Abfrageparameter textFormat.

textFormat: String

Der Typ von Markern, die für Textdekorationen verwendet werden sollen (siehe den Abfrageparameter textDecorations). Mögliche Werte sind Unformatiert: Verwenden Sie Unicode-Zeichen, um Inhalte zu markieren, die eine spezielle Formatierung benötigen. Die Unicode-Zeichen liegen im Bereich E000 bis E019. Bing verwendet beispielsweise E000 und E001, um den Anfang und das Ende von Abfragebegriffen für die Treffermarkierung zu markieren. HTML: Verwenden Sie HTML-Tags, um Inhalte zu markieren, die eine spezielle Formatierung benötigen. Verwenden Sie <beispielsweise b-Tags> , um Abfragebegriffe in Anzeigezeichenfolgen hervorzuheben. Der Standardwert ist Raw. Für Anzeigezeichenfolgen, die escapable HTML-Zeichen wie <, >und &enthalten, wenn textFormat auf HTML festgelegt ist, wird bing die Zeichen entsprechend mit escapen (z. B < . wird als &"lt;" bezeichnet). Mögliche Werte: "Raw", "Html"