IAutoSuggestClient.AutoSuggestMethodWithHttpMessagesAsync Methode

Definition

Namespace:

Microsoft.Azure.CognitiveServices.Search.AutoSuggest

Assembly:

Microsoft.Azure.CognitiveServices.Search.AutoSuggest.dll

Paket:

Microsoft.Azure.CognitiveServices.Search.AutoSuggest v2.0.0

Mit der AutoSuggest-API können Sie eine Suchabfrage an Bing senden und eine Liste mit Vorschlägen abrufen. Dieser Abschnitt enthält technische Details zu den Abfrageparametern und Headern, die Sie zum Anfordern von Vorschlägen verwenden, und zu den JSON-Antwortobjekten, die diese enthalten.

public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.AutoSuggest.Models.Suggestions>> AutoSuggestMethodWithHttpMessagesAsync (string query, string acceptLanguage = default, string pragma = default, string userAgent = default, string clientId = default, string clientIp = default, string location = default, string countryCode = default, string market = "en-us", string safeSearch = default, string setLang = default, System.Collections.Generic.IList<string> responseFormat = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member AutoSuggestMethodWithHttpMessagesAsync : string * string * string * string * string * string * string * string * string * string * string * System.Collections.Generic.IList<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.AutoSuggest.Models.Suggestions>>

Public Function AutoSuggestMethodWithHttpMessagesAsync (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 countryCode As String = Nothing, Optional market As String = "en-us", Optional safeSearch As String = Nothing, Optional setLang As String = Nothing, Optional responseFormat As IList(Of String) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of Suggestions))

Parameter

query

String

Der Suchbegriff des Benutzers.

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 abfrageparameter setLang schließen sich gegenseitig aus. Geben Sie nicht beides an. Wenn Sie diesen Header festlegen, müssen Sie auch den Abfrageparameter cc angeben. Um den Markt zu bestimmen, für den Ergebnisse zurückgegeben werden sollen, verwendet Bing die erste unterstützte Sprache, die es aus der Liste findet, und kombiniert sie mit dem cc-Parameterwert. Enthält die Liste keine unterstützte Sprache, sucht Bing die nächstgelegene Sprache und den nächstgelegenen Markt, die bzw. der die Anforderung unterstützt. Alternativ dazu wird für die Ergebnisse ein aggregierter oder Standardmarkt verwendet. Wenn Sie sehen möchten, welchen Markt Bing verwendet hat, untersuchen Sie den Header „BingAPIs-Market“. Verwenden Sie diesen Header und den abfrageparameter cc nur, wenn Sie mehrere Sprachen angeben. Verwenden Sie andernfalls die Abfrageparameter mkt und setLang. 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 Links zu Eigenschaften von „bing.com“ in den Antwortobjekten verwenden die angegebene Sprache.

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. Auch wenn dies optional ist, sollten Sie diesen Header immer angeben. Der Benutzer-Agent sollte der Zeichenfolge entsprechen, die alle häufig verwendeten Browser senden. Informationen zu Benutzer-Agents finden Sie unter RFC 2616. Im Folgenden sind Beispiele für Benutzer-Agent-Zeichenfolgen aufgeführt. Windows Phone: Mozilla/5.0 (kompatibel; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 (Linux; U; Android 2.3.5; en - uns; SCH - I500 Build / GINGERBREAD) AppleWebKit / 533.1 (KHTML; wie Gecko) Version / 4.0 Mobile Safari / 533.1. iPhone: Mozilla / 5.0 (iPhone; CPU iPhone OS 6_1 wie Mac OS X) AppleWebKit / 536.26 (KHTML; wie Gecko) Mobile / 10B142 iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0 (Windows NT 6.3; WOW64; Dreizack / 7.0; Touch; rv:11.0) wie Gecko. iPad: Mozilla / 5.0 (iPad; CPU OS 7_0 wie Mac OS X) AppleWebKit / 537.51.1 (KHTML, wie Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53

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 Clientstandorts 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 von Sekunden seit dem 1. Januar 1970.) head (optional): Die relative Richtung oder Fahrtrichtung 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 nichtzero 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. 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.

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 aus der Sprachenliste gefunden wird, und kombiniert diese Sprache mit dem von Ihnen angegebenen Ländercode, 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.

market

String

Der Markt, aus dem die Ergebnisse stammen. Es wird dringend empfohlen, immer den Markt anzugeben, sofern bekannt. Die Angabe des Marktes ermöglicht Bing, die Anforderung weiterzuleiten und eine geeignete und optimale Antwort zurückzugeben. Dieser Parameter und der Abfrageparameter cc schließen sich gegenseitig aus. Geben Sie daher nicht beide an.

safeSearch

String

Filtervorschläge für nicht jugendfreie Inhalte. Im Folgenden sind die möglichen Filterwerte aufgeführt. Aus: Zurückgeben von Vorschlägen mit Text, Bildern oder Videos für erwachsene Personen. Moderieren: Geben Sie den Vorschlag mit erwachsenen Text zurück, aber nicht mit erwachsenen Bildern oder Videos. Streng: Geben Sie keine Nachrichtenartikel mit erwachsenen Texten, Bildern oder Videos zurück. 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.

responseFormat

IList<String>

Der Medientyp, der für die Antwort verwendet werden soll. Es folgen die möglichen Werte, bei denen die Groß-/Kleinschreibung nicht beachtet wird: JSON, JSONLD. Der Standardwert ist JSON. Wenn Sie JSONLD angeben, enthält der Antworttext JSON-LD-Objekte, die die Suchergebnisse enthalten.

customHeaders

Dictionary<String,List<String>>

Die Header, die der Anforderung hinzugefügt werden.

cancellationToken

CancellationToken

Das Abbruchtoken.

Gibt zurück

Task<HttpOperationResponse<Suggestions>>