WebExtensions.SearchAsync Méthode

Définition

Espace de noms:

Microsoft.Azure.CognitiveServices.Search.WebSearch

Assembly:

Microsoft.Azure.CognitiveServices.Search.WebSearch.dll

Paquet:

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

L’API Recherche web vous permet d’envoyer une requête de recherche à Bing et d’obtenir des résultats de recherche qui incluent des liens vers des pages web, des images, etc.

public static System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Search.WebSearch.Models.SearchResponse> SearchAsync (this Microsoft.Azure.CognitiveServices.Search.WebSearch.IWeb operations, 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.Threading.CancellationToken cancellationToken = default);

static member SearchAsync : Microsoft.Azure.CognitiveServices.Search.WebSearch.IWeb * 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.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Search.WebSearch.Models.SearchResponse>

<Extension()>
Public Function SearchAsync (operations As IWeb, 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 cancellationToken As CancellationToken = Nothing) As Task(Of SearchResponse)

Paramètres

operations

IWeb

Groupe d’opérations pour cette méthode d’extension.

query

String

Terme de requête de recherche de l’utilisateur. Le terme n’est peut-être pas vide. Le terme peut contenir des opérateurs avancés Bing. Par exemple, pour limiter les résultats à un domaine spécifique, utilisez l’opérateur site:.

acceptLanguage

String

Liste délimitée par des virgules d’une ou plusieurs langues à utiliser pour les chaînes d’interface utilisateur. Elle est triée par ordre de préférence décroissant. Pour plus d’informations, notamment sur le format attendu, consultez RFC2616. Cet en-tête et le paramètre de requête setLang s’excluent mutuellement ; ne spécifiez pas les deux. Si vous définissez cet en-tête, vous devrez également spécifier le paramètre de requête cc. Bing utilise la première langue prise en charge qu’il trouve dans la liste et combine cette langue avec la valeur du paramètre cc pour déterminer le marché pour lequel retourner les résultats. Si la liste n’inclut pas de langue prise en charge, Bing trouve la langue et le marché les plus proches qui prennent en charge la demande, et peut utiliser un marché agrégé ou par défaut pour les résultats au lieu d’un marché spécifié. Vous devez utiliser cet en-tête et le paramètre de requête cc uniquement si vous spécifiez plusieurs langues ; sinon, vous devez utiliser les paramètres de requête mkt et setLang. Une chaîne d’interface utilisateur est une chaîne utilisée comme étiquette dans une interface utilisateur. Il existe très peu de chaînes d’interface utilisateur dans les objets de réponse JSON. Tous les liens dans les objets de réponse vers Bing.com propriétés appliquent la langue spécifiée.

pragma

String

Par défaut, Bing retourne le contenu en cache, s’il est disponible. Pour éviter cela, définissez l’en-tête Pragma sur no-cache (par exemple, Pragma: no-cache).

userAgent

String

Agent utilisateur à l’origine de la requête. Bing utilise l’agent utilisateur pour offrir une expérience optimisée aux utilisateurs mobiles. Bien que facultatif, nous vous encourageons vivement à toujours spécifier cet en-tête. L’agent utilisateur doit être la même chaîne que n’importe quel navigateur couramment utilisé. Pour plus d’informations sur les agents utilisateurs, voir RFC 2616.

clientId

String

Bing utilise cet en-tête pour garantir aux utilisateurs un comportement cohérent d’un appel d’API Bing à l’autre. Bing propose souvent de nouvelles fonctionnalités et améliorations, et se sert de l’ID client comme d’une clé pour attribuer le trafic aux différentes versions d’évaluation. Si vous n’assignez pas le même ID client à un utilisateur d’une demande à l’autre, Bing est susceptible d’affecter cet utilisateur à plusieurs versions d’évaluation en conflit, ce qui risque de nuire à l’expérience utilisateur. Par exemple, si la deuxième demande comporte une attribution de version d’évaluation différente de la première, l’expérience se révélera peut-être inattendue. De même, Bing peut utiliser l’ID client pour personnaliser les résultats web d’après l’historique de recherche correspondant à cet ID et ainsi proposer à l’utilisateur une expérience plus riche. Bing utilise également cet en-tête pour aider à améliorer le classement des résultats en analysant l’activité générée par un ID client. L’amélioration de la pertinence permet d’obtenir des résultats de meilleure qualité de la part des API Bing et, en retour, des taux de clic plus élevés pour le consommateur des API. IMPORTANT : Il est vivement recommandé d’indiquer cet en-tête, bien qu’il soit facultatif. Grâce à la persistance de l’ID client dans plusieurs demandes pour une même combinaison appareil/utilisateur final, (1) le consommateur des API bénéficie d’une expérience utilisateur cohérente et (2) le taux de clic est plus élevé du fait des résultats de meilleure qualité provenant des API Bing. Chaque utilisateur de votre application sur l’appareil doit avoir un ID client unique, généré par Bing. Si vous n’insérez pas cet en-tête dans la demande, Bing génère un ID et le retourne dans l’en-tête de réponse X-MSEdge-ClientID. La première fois que l’utilisateur utilise votre application sur cet appareil est la seule fois où vous ne devez PAS inclure cet en-tête dans la demande. Utilisez l’ID client pour chaque requête d’API Bing qu’effectue votre application pour cet utilisateur sur l’appareil. Conservez l’ID client. Pour conserver l’identifiant dans une application de navigateur, utilisez un cookie HTTP persistant qui garantit l’utilisation de cet identifiant dans toutes les sessions. N’utilisez pas de cookie de session. Dans le cas d’autres applications, comme des applications mobiles, utilisez le stockage persistant de l’appareil pour conserver cet identifiant. La prochaine fois que l’utilisateur utilisera votre application sur cet appareil, vous récupérerez l’ID client que vous aurez conservé. Les réponses de Bing ne comportent pas forcément cet en-tête. Si elles l’incluent, capturez l’ID client et utilisez-le pour toutes les demandes Bing suivantes concernant l’utilisateur sur cet appareil. Si vous insérez l’en-tête X-MSEdge-ClientID, n’incluez pas les cookies dans la requête.

clientIp

String

Adresse IPv4 ou IPv6 de l’appareil client. L’adresse IP est utilisée pour découvrir l’emplacement de l’utilisateur. Bing utilise les informations de localisation pour déterminer le comportement de recherche approprié. Nous vous conseillons de toujours indiquer cet en-tête et l’en-tête X-Search-Location, bien qu’ils soient facultatifs. N’obfusquez pas l’adresse (par exemple, en remplaçant le dernier octet par 0). Cela aurait pour effet d’éloigner la localisation de l’emplacement réel de l’appareil, ce qui pourrait conduire Bing à retourner des résultats erronés.

location

String

Liste délimitée par des points-virgules de paires clé/valeur qui décrivent la situation géographique du client. Bing utilise les informations de localisation pour déterminer le comportement de recherche approprié et retourner le contenu local pertinent. Spécifiez la paire clé/valeur sous la forme <clé>:<valeur>. Voici les clés permettant de spécifier l’emplacement de l’utilisateur. lat (obligatoire) : latitude de l’emplacement du client, en degrés. Elle doit être supérieure ou égale à -90,0 et inférieure ou égale à +90,0. Les valeurs négatives indiquent les latitudes sud et les valeurs positives les latitudes nord. long (obligatoire) : longitude de l’emplacement du client, en degrés. Elle doit être supérieure ou égale à -180,0 et inférieure ou égale à +180,0. Les valeurs négatives indiquent les longitudes occidentales et les valeurs positives les longitudes orientales. re (obligatoire) : rayon, en mètres, qui spécifie la précision horizontale des coordonnées. Transmettez la valeur retournée par le service de localisation de l’appareil. Voici quelques valeurs courantes : 22 m pour le GPS/Wi-Fi, 380 m pour la triangulation des tours cellulaires et 18 000 m pour la recherche IP inversée. ts (facultatif) : horodatage UNIX UTC du moment où le client se trouvait à l’emplacement. (L’horodatage UNIX est le nombre de secondes depuis le 1er janvier 1970.) head (facultatif) : cap ou sens de déplacement relatif du client. Spécifiez-la en degrés, entre 0 et 360, dans le sens horaire par rapport au nord géographique. Spécifiez cette clé uniquement si la clé sp est différente de zéro. sp (facultatif) : vélocité horizontale (vitesse), en mètres par seconde, que l’appareil client est en cours de déplacement. alt (facultatif) : altitude de l’appareil client, en mètres. sont (facultatif) : rayon, en mètres, qui spécifie la précision verticale des coordonnées. Spécifiez cette clé uniquement si vous spécifiez la touche de remplacement. Bien que la plupart des clés soient facultatives, plus vous fournissez d’informations, plus les résultats de localisation sont précis. Nous vous conseillons de toujours indiquer la situation géographique de l’utilisateur (qui est facultative). C’est particulièrement important si l’adresse IP du client ne reflète pas exactement l’emplacement physique de l’utilisateur (par exemple, si le client utilise un VPN). Pour des résultats optimaux, précisez cet en-tête et l’en-tête X-MSEdge-ClientIP ; au minimum, indiquez cet en-tête.

answerCount

Nullable<Int32>

Nombre de réponses que vous souhaitez inclure. Les réponses retournées par Bing sont basées sur le classement. Par exemple, si Bing renvoie des pages web, des images, des vidéos et des recherches connexes pour une demande et que vous définissez ce paramètre sur deux (2), la réponse inclut des pages web et des images. Si vous avez inclus le paramètre de requête responseFilter dans la même requête et que vous le définissez sur pages web et actualités, la réponse inclut uniquement les pages web.

countryCode

String

Code à 2 caractères du pays d'où proviennent les résultats. Cette API prend uniquement en charge le marché États-Unis. Si vous spécifiez ce paramètre de requête, il doit être défini sur nous. Si vous définissez ce paramètre, vous devez également spécifier l’en-tête Accept-Language. Bing utilise la première langue prise en charge qu’il trouve dans la liste des langues et combine cette langue avec l’indicatif de pays que vous spécifiez pour déterminer le marché pour lequel retourner les résultats. Si la liste des langues n’inclut pas de langue prise en charge, Bing recherche la langue et le marché les plus proches qui prennent en charge la demande, ou il peut utiliser un marché agrégé ou par défaut pour les résultats au lieu d’un marché spécifié. Vous devez utiliser ce paramètre de requête et le paramètre de requête Accept-Language uniquement si vous spécifiez plusieurs langues ; sinon, vous devez utiliser les paramètres de requête mkt et setLang. Ce paramètre et le paramètre de requête mkt s’excluent mutuellement ; ne spécifiez pas les deux.

count

Nullable<Int32>

Nombre de résultats de recherche à renvoyer dans la réponse. La valeur par défaut est 10 et la valeur maximale est 50. Le nombre réel remis peut être inférieur à celui demandé. Utilisez ce paramètre avec le paramètre offset pour les résultats de la page. Par exemple, si votre interface utilisateur affiche 10 résultats de recherche par page, définissez nombre sur 10 et décalage sur 0 pour obtenir la première page de résultats. Pour chaque page suivante, incrémentez le décalage de 10 (par exemple, 0, 10, 20). Il est possible que plusieurs pages incluent des chevauchements dans les résultats.

freshness

String

Filtrez les résultats de la recherche en fonction des valeurs d’âge suivantes : Jour : Retour des pages web que Bing a découvertes au cours des dernières 24 heures. Semaine : retourne les pages web que Bing a découvertes au cours des 7 derniers jours. Mois : retourne les pages web qui ont été découvertes au cours des 30 derniers jours. Ce filtre s’applique uniquement aux résultats de la page web et non aux autres résultats tels que les actualités et les images. Les valeurs possibles sont les suivantes : 'Day', 'Week', 'Month'

market

String

Marché d’où proviennent les résultats. En règle générale, mkt est le pays à partir duquel l’utilisateur effectue la demande. Toutefois, il peut s’agir d’un autre pays si l’utilisateur ne se trouve pas dans un pays où Bing fournit des résultats. Le marché doit être sous la forme <du code-pays><> de langue. Par exemple, en-US. La chaîne ne respecte pas la casse. S’il est connu, nous vous encourageons à toujours spécifier le marché. Le fait d’indiquer le marché aide Bing à router la requête et à renvoyer une réponse appropriée et optimale. Si vous spécifiez un marché qui n’est pas répertorié dans Codes de marché, Bing utilise un code de marché adapté à un mappage interne susceptible de changer. Ce paramètre et le paramètre de requête cc s’excluent mutuellement ; ne spécifiez pas les deux.

offset

Nullable<Int32>

Décalage de base zéro qui indique le nombre de résultats de recherche à ignorer avant de retourner les résultats. La valeur par défaut est 0. Le décalage doit être inférieur à (totalEstimatedMatches - count). Utilisez ce paramètre avec le paramètre count pour pager les résultats. Par exemple, si votre interface utilisateur affiche 10 résultats de recherche par page, définissez nombre sur 10 et décalage sur 0 pour obtenir la première page de résultats. Pour chaque page suivante, incrémentez le décalage de 10 (par exemple, 0, 10, 20). il est possible que plusieurs pages incluent des chevauchements dans les résultats.

promote

IList<String>

Liste délimitée par des virgules de réponses que vous souhaitez inclure, quel que soit leur classement. Par exemple, si vous définissez answerCount) sur deux (2) afin que Bing retourne les deux premières réponses classées, mais que vous souhaitez également que la réponse inclue des actualités, vous devez définir la promotion sur actualités. Si les réponses les mieux classées sont des pages web, des images, des vidéos et des recherches connexes, la réponse inclut des pages web et des images, car les actualités ne sont pas une réponse classée. Mais si vous définissez la promotion sur vidéo, Bing promeut la réponse vidéo dans la réponse et retourne des pages web, des images et des vidéos. Les réponses que vous souhaitez promouvoir ne sont pas comptabilisées dans la limite answerCount. Par exemple, si les réponses classées sont des actualités, des images et des vidéos, et que vous définissez answerCount sur 1 et que vous effectuez une promotion en nouvelles, la réponse contient des actualités et des images. Par ailleurs, si les correspondances classées sont des actualités, des images et des vidéos, la réponse contient des vidéos et des actualités. Les valeurs possibles sont Calcul, Images, Actualités, RelatedSearches, SpellSuggestions, TimeZone, Vidéos, Pages web. Utilisez uniquement si vous spécifiez answerCount.

responseFilter

IList<String>

Liste de réponses délimitées par des virgules à inclure dans la réponse. Si vous ne spécifiez pas ce paramètre, la réponse inclut toutes les réponses de recherche pour lesquelles il existe des données pertinentes. Les valeurs de filtre possibles sont Calcul, Images, Actualités, RelatedSearches, SpellSuggestions, TimeZone, Vidéos, Pages web. Même si vous pouvez utiliser ce filtre pour obtenir une réponse unique, vous devez plutôt utiliser le point de terminaison spécifique à la réponse afin d’obtenir des résultats plus riches. Par exemple, pour recevoir uniquement des images, envoyez la demande à l’un des points de terminaison de l’API Recherche d’images. Les réponses RelatedSearches et SpellSuggestions ne prennent pas en charge un point de terminaison distinct comme le fait l’API Recherche d’images (seule l’API Recherche web les retourne). Pour inclure des réponses qui seraient autrement exclues en raison du classement, consultez le paramètre de requête promote.

safeSearch

String

Filtre utilisé pour filtrer le contenu pour adultes. Désactivé : retournez des pages web avec du texte, des images ou des vidéos pour adultes. Modéré : renvoyer des pages web avec du texte pour adultes, mais pas des images ou des vidéos pour adultes. Strict : ne retournez pas de pages web contenant du texte, des images ou des vidéos pour adultes. La valeur par défaut est Modéré. Si la demande provient d’un marché où la stratégie pour adultes de Bing exige que safeSearch soit défini sur Strict, Bing ignore la valeur safeSearch et utilise Strict. Si vous utilisez l’opérateur de requête site : , il est possible que la réponse contienne du contenu pour adultes, quel que soit le paramètre de requête safeSearch défini. Utiliser le site : uniquement si vous connaissez le contenu du site et si votre scénario prend en charge la possibilité de contenu pour adultes. Les valeurs possibles sont les suivantes : 'Off', 'Moderate', 'Strict'

setLang

String

Langue à utiliser pour les chaînes de l’interface utilisateur. Spécifiez la langue en utilisant le code de langue ISO 639-1 à deux lettres. Par exemple, celui de l’anglais est EN. La valeur par défaut est EN (anglais). Nous vous conseillons de toujours indiquer la langue, bien qu’elle soit facultative. En règle générale, vous définissez setLang sur la même langue spécifiée par mkt, sauf si l’utilisateur souhaite que les chaînes d’interface utilisateur soient affichées dans une autre langue. Ce paramètre et l’en-tête Accept-Language s’excluent mutuellement ; ne spécifiez pas les deux. Une chaîne d’interface utilisateur est une chaîne utilisée comme étiquette dans une interface utilisateur. Les objets de réponse JSON en comportent quelques-unes. En outre, les liens vers les propriétés Bing.com dans les objets de la réponse s’appliquent à la langue spécifiée.

textDecorations

Nullable<Boolean>

Valeur booléenne qui détermine si les chaînes d’affichage doivent contenir des marqueurs de décoration tels que des caractères de mise en surbrillance d’accès. Si la valeur est true, les chaînes peuvent inclure des marqueurs. La valeur par défaut est false. Pour spécifier s’il faut utiliser des caractères Unicode ou des balises HTML comme marqueurs, consultez le paramètre de requête textFormat.

textFormat

String

Type de marqueurs à utiliser pour les décorations de texte (voir le paramètre de requête textDecorations). Les valeurs possibles sont Brutes: utilisez des caractères Unicode pour marquer le contenu qui a besoin d’une mise en forme spéciale. Les caractères Unicode se trouvent dans la plage E000 à E019. Par exemple, Bing utilise E000 et E001 pour marquer le début et la fin des termes de requête pour la mise en surbrillance des accès. HTML : utilisez des balises HTML pour marquer le contenu qui a besoin d’une mise en forme spéciale. Par exemple, utilisez <des balises b> pour mettre en surbrillance les termes de requête dans les chaînes d’affichage. La valeur par défaut est Raw. Pour les chaînes d’affichage qui contiennent des caractères HTML pouvant être échappés tels que <, >et &, si textFormat est défini sur HTML, Bing échappe les caractères comme il convient (par exemple, < est placé dans une séquence d’échappement vers &lt;). Les valeurs possibles sont les suivantes : « Raw », « Html »

cancellationToken

CancellationToken

Jeton d'annulation.

Retours

Task<SearchResponse>