EntitiesOperationsExtensions.SearchAsync Méthode

Définition

Espace de noms:

Microsoft.Azure.CognitiveServices.Search.EntitySearch

Assembly:

Microsoft.Azure.CognitiveServices.Search.EntitySearch.dll

Paquet:

Microsoft.Azure.CognitiveServices.Search.EntitySearch v2.0.0

L’API Recherche d’entités vous permet d’envoyer une requête de recherche à Bing et d’obtenir des résultats de recherche qui incluent des entités et des emplacements. Les résultats de lieux incluent les restaurants, les hôtels et d’autres commerces locaux. Pour les lieux, la requête peut spécifier le nom du commerce local ou elle peut demander une liste (par exemple, les restaurants dans ma zone). Les résultats d’entités incluent des personnes, des lieux ou d’autres éléments. Dans ce contexte, les lieux correspondent à des sites touristiques, des États, des pays, etc.

public static System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Search.EntitySearch.Models.SearchResponse> SearchAsync (this Microsoft.Azure.CognitiveServices.Search.EntitySearch.IEntitiesOperations operations, 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", System.Collections.Generic.IList<string> responseFilter = default, System.Collections.Generic.IList<string> responseFormat = default, string safeSearch = default, string setLang = default, System.Threading.CancellationToken cancellationToken = default);

static member SearchAsync : Microsoft.Azure.CognitiveServices.Search.EntitySearch.IEntitiesOperations * string * string * string * string * string * string * string * string * string * System.Collections.Generic.IList<string> * System.Collections.Generic.IList<string> * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Search.EntitySearch.Models.SearchResponse>

<Extension()>
Public Function SearchAsync (operations As IEntitiesOperations, 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 responseFilter As IList(Of String) = Nothing, Optional responseFormat As IList(Of String) = Nothing, Optional safeSearch As String = Nothing, Optional setLang As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of SearchResponse)

Paramètres

operations

IEntitiesOperations

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

query

String

Critère de recherche de l’utilisateur.

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.

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.

market

String

Marché d’où proviennent les résultats. Nous vous encourageons vivement à toujours spécifier le marché, s’il est connu. Le fait d’indiquer le marché aide Bing à router la requête et à renvoyer une réponse appropriée et optimale. Ce paramètre et le paramètre de requête cc s’excluent mutuellement ; ne spécifiez pas les deux.

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.

responseFormat

IList<String>

Type de média à utiliser pour la réponse. Voici les valeurs possibles qui ne respectent pas la casse : JSON, JSONLD. La valeur par défaut est JSON. Si vous spécifiez JSONLD, le corps de la réponse inclut des objets JSON-LD qui contiennent les résultats de la recherche.

safeSearch

String

Filtre utilisé pour filtrer le contenu pour adultes. Désactivé : renvoyer 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 renvoyez 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 que 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 de l’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.

cancellationToken

CancellationToken

Jeton d'annulation.

Retours

Task<SearchResponse>