Partager via

WebSearchOptionalParams interface

Paquet:
@azure/cognitiveservices-websearch

Paramètres facultatifs.

Extends
RequestOptionsBase

Propriétés

acceptLanguage

Liste délimitée par des virgules d’une ou plusieurs langues à utiliser pour les chaînes d’interface utilisateur. La liste est en ordre décroissant de préférence. Pour plus d’informations, y compris 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 devez é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 à Bing.com propriétés appliquent le langage spécifié.
answerCount

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 retourne des pages web, des images, des vidéos et relatedSearches pour une requête 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 l’avez défini sur des pages web et des actualités, la réponse inclurait uniquement les pages web.
clientId

Bing utilise cet en-tête pour fournir aux utilisateurs un comportement cohérent entre les appels d’API Bing. Bing vole souvent de nouvelles fonctionnalités et améliorations, et utilise l’ID client comme clé pour affecter le trafic sur différents vols. Si vous n’utilisez pas le même ID client pour un utilisateur sur plusieurs requêtes, Bing peut affecter l’utilisateur à plusieurs vols en conflit. L’affectation de plusieurs vols en conflit peut entraîner une expérience utilisateur incohérente. Par exemple, si la deuxième demande a une affectation de vol différente de la première, l’expérience peut être inattendue. En outre, Bing peut utiliser l’ID client pour adapter les résultats web à l’historique de recherche de cet ID client, offrant une expérience plus riche pour l’utilisateur. Bing utilise également cet en-tête pour améliorer les classements de résultats en analysant l’activité générée par un ID client. Les améliorations de pertinence aident à améliorer la qualité des résultats fournis par les API Bing et à leur tour permettent d’augmenter les taux de clic pour le consommateur d’API. IMPORTANT : Bien que facultatif, vous devez prendre en compte cet en-tête requis. La persistance de l’ID client sur plusieurs requêtes pour la même combinaison d’utilisateurs finaux et d’appareils permet au consommateur d’API de recevoir une expérience utilisateur cohérente, et 2) des taux de clic plus élevés via une meilleure qualité des résultats des API Bing. Chaque utilisateur qui utilise votre application sur l’appareil doit avoir un ID client généré par Bing unique. Si vous n’incluez pas cet en-tête dans la requête, Bing génère un ID et le retourne dans l’en-tête de réponse X-MSEdge-ClientID. La seule fois que vous ne devez pas inclure cet en-tête dans une demande est la première fois que l’utilisateur utilise votre application sur cet appareil. Utilisez l’ID client pour chaque demande d’API Bing que votre application effectue pour cet utilisateur sur l’appareil. Conservez l’ID client. Pour conserver l’ID dans une application de navigateur, utilisez un cookie HTTP persistant pour vous assurer que l’ID est utilisé dans toutes les sessions. N’utilisez pas de cookie de session. Pour d’autres applications telles que les applications mobiles, utilisez le stockage persistant de l’appareil pour conserver l’ID. La prochaine fois que l’utilisateur utilise votre application sur cet appareil, obtenez l’ID client que vous avez conservé. Les réponses Bing peuvent inclure ou non cet en-tête. Si la réponse inclut cet en-tête, capturez l’ID client et utilisez-le pour toutes les demandes Bing suivantes pour l’utilisateur sur cet appareil. Si vous incluez le X-MSEdge-ClientID, vous ne devez pas inclure de cookies dans la demande.
clientIp

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 d’emplacement pour déterminer le comportement de recherche sécurisé. Bien que facultatif, vous êtes invité à toujours spécifier cet en-tête et l’en-tête X-Search-Location. N’obfusez pas l’adresse (par exemple, en remplaçant le dernier octet par 0). L’obfuscatation de l’adresse entraîne l’emplacement qui n’est pas situé à proximité de l’emplacement réel de l’appareil, ce qui peut entraîner la diffusion de résultats erronés par Bing.
count

Nombre de résultats de recherche à retourner 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 le nombre sur 10 et décalé sur 0 pour obtenir la première page des 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.
countryCode

Code de pays à 2 caractères du pays à partir duquel proviennent les résultats. Cette API prend uniquement en charge le marché américain. 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 le code 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 trouve 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.
freshness

Filtrez les résultats de la recherche selon les valeurs d’âge suivantes : Jour : renvoyer des pages web découvertes par Bing au cours des 24 dernières heures. Semaine : renvoyer des pages web découvertes par Bing au cours des 7 derniers jours. Mois : renvoyer des pages web 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'
location

Liste délimitée par des points-virgules de paires clé/valeur qui décrivent l’emplacement géographique du client. Bing utilise les informations d’emplacement pour déterminer le comportement de recherche sécurisé et retourner le contenu local approprié. Spécifiez la paire clé/valeur comme <clé>:<valeur>. Voici les clés que vous utilisez pour spécifier l’emplacement de l’utilisateur. lat (obligatoire) : latitude de l’emplacement du client, en degrés. La latitude 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 indiquent les latitudes du nord. long (obligatoire) : longitude de l’emplacement du client, en degrés. La longitude 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 indiquent 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 d’emplacement de l’appareil. Les valeurs classiques peuvent être de 22m pour GPS/Wi-Fi, 380m pour la triangulation de tour de cellule et 18 000m pour la recherche d’adresses IP inversées. ts (facultatif) : horodatage UNIX UTC du moment où le client était à l’emplacement. (L’horodatage UNIX est le nombre de secondes depuis le 1er janvier 1970.) head (facultatif) : titre ou direction du voyage relatif du client. Spécifiez le sens du déplacement sous forme de degrés allant de 0 à 360, en comptant le sens des aiguilles d’une montre par rapport à true nord. Spécifiez cette clé uniquement si la clé sp est différente de zéro. sp (facultatif) : vitesse horizontale (vitesse), en mètres par seconde, que l’appareil client voyage. 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 d’emplacement sont précis. Bien que facultatif, vous êtes invité à toujours spécifier l’emplacement géographique de l’utilisateur. Fournir l’emplacement est particulièrement important si l’adresse IP du client ne reflète pas précisément l’emplacement physique de l’utilisateur (par exemple, si le client utilise un VPN). Pour obtenir des résultats optimaux, vous devez inclure cet en-tête et l’en-tête X-MSEdge-ClientIP, mais au minimum, vous devez inclure cet en-tête.
market

Le 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 n’est pas situé dans un pays où Bing fournit des résultats. Le marché doit être sous la forme <code> langue-code<> pays. Par exemple, en-US. La chaîne ne respecte pas la casse. Si vous le connaissez, vous êtes encouragé à toujours spécifier le marché. La spécification du marché aide Bing à acheminer la requête et à retourner une réponse appropriée et optimale. Si vous spécifiez un marché qui n’est pas répertorié dans les codes de marché, Bing utilise un code de marché adapté en fonction d’un mappage interne susceptible de changer. Ce paramètre et le paramètre de requête cc s’excluent mutuellement, ne spécifient pas les deux. Valeur par défaut : 'en-us'.
offset

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 ainsi que le paramètre count pour les résultats de la page. Par exemple, si votre interface utilisateur affiche 10 résultats de recherche par page, définissez le nombre sur 10 et décalé sur 0 pour obtenir la première page des 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.
pragma

Par défaut, Bing retourne du contenu mis en cache, le cas échéant. Pour empêcher Bing de retourner du contenu mis en cache, définissez l’en-tête Pragma sur no-cache (par exemple, Pragma : no-cache).
promote

Liste délimitée par des virgules de réponses que vous souhaitez inclure la réponse indépendamment de leur classement. Par exemple, si vous définissez answerCount) sur deux (2) pour 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 vers les actualités. Si les réponses les plus 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 vers la vidéo, Bing promouvoirait la réponse vidéo dans la réponse et renvoyer des pages web, des images et des vidéos. Les réponses que vous souhaitez promouvoir ne comptent pas par rapport à 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 faites la promotion vers les actualités, la réponse contient des actualités et des images. Ou, si les réponses classées sont des vidéos, des images et des actualités, 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

Liste délimitée par des virgules de réponses à 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. Bien que vous puissiez utiliser ce filtre pour obtenir une réponse unique, vous devez utiliser plutôt le point de terminaison spécifique à la réponse pour obtenir des résultats plus riches. Par exemple, pour recevoir uniquement des images, envoyez la requête à 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 l’API Recherche d’images (seule l’API Recherche web les renvoie). Pour inclure des réponses qui seraient autrement exclues en raison du classement, consultez le paramètre de requête promouvoir.
safeSearch

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é : retournez des pages web avec du texte adulte, mais pas des images ou des vidéos adultes. Strict : ne retournez pas de pages web avec du texte, des images ou des vidéos adultes. La valeur par défaut est Modéré. Si la demande provient d’un marché que la stratégie adulte de Bing exige que safeSearch soit défini sur Strict, Bing ignore la valeur safeSearch et utilise Strict. Si vous utilisez le site : opérateur de requête, il est possible que la réponse contienne du contenu adulte, quel que soit le paramètre de requête safeSearch défini. Utiliser le site : uniquement si vous connaissez le contenu sur le 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

Langue à utiliser pour les chaînes d’interface utilisateur. Spécifiez la langue à l’aide du code de langue ISO 639-1 à 2 lettres. Par exemple, le code de langue pour l’anglais est EN. La valeur par défaut est EN (anglais). Bien que facultatif, vous devez toujours spécifier la langue. 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 s’affichent 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. Il existe quelques chaînes d’interface utilisateur dans les objets de réponse JSON. En outre, les liens vers Bing.com propriétés dans les objets de réponse appliquent le langage spécifié.
textDecorations

Valeur booléenne qui détermine si les chaînes d’affichage doivent contenir des marqueurs de décoration tels que la mise en surbrillance des caractères. 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

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 nécessitant 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 balises 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 échapables tels que <, >et &, si textFormat est défini sur HTML, Bing échappe les caractères appropriés (par exemple, < est échappé à <). Les valeurs possibles sont les suivantes : « Raw », « Html »
userAgent

Agent utilisateur à l’origine de la requête. Bing utilise l’agent utilisateur pour fournir aux utilisateurs mobiles une expérience optimisée. Bien que facultatif, vous êtes fortement encouragé à 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 utilisateur, consultez RFC 2616.

Propriétés héritées

abortSignal

Signal qui peut être utilisé pour abandonner les demandes.
customHeaders

En-têtes de requête personnalisés définis par l’utilisateur qui seront appliqués avant l’envoi de la demande.
onDownloadProgress

Rappel qui se déclenche lors de la progression du téléchargement.
onUploadProgress

Rappel qui se déclenche lors de la progression du chargement.
timeout

Le nombre de millisecondes qu’une demande peut prendre avant de se terminer automatiquement.

Détails de la propriété

acceptLanguage

Liste délimitée par des virgules d’une ou plusieurs langues à utiliser pour les chaînes d’interface utilisateur. La liste est en ordre décroissant de préférence. Pour plus d’informations, y compris 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 devez é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 à Bing.com propriétés appliquent le langage spécifié.

acceptLanguage?: string

Valeur de propriété

string

answerCount

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 retourne des pages web, des images, des vidéos et relatedSearches pour une requête 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 l’avez défini sur des pages web et des actualités, la réponse inclurait uniquement les pages web.

answerCount?: number

Valeur de propriété

number

clientId

Bing utilise cet en-tête pour fournir aux utilisateurs un comportement cohérent entre les appels d’API Bing. Bing vole souvent de nouvelles fonctionnalités et améliorations, et utilise l’ID client comme clé pour affecter le trafic sur différents vols. Si vous n’utilisez pas le même ID client pour un utilisateur sur plusieurs requêtes, Bing peut affecter l’utilisateur à plusieurs vols en conflit. L’affectation de plusieurs vols en conflit peut entraîner une expérience utilisateur incohérente. Par exemple, si la deuxième demande a une affectation de vol différente de la première, l’expérience peut être inattendue. En outre, Bing peut utiliser l’ID client pour adapter les résultats web à l’historique de recherche de cet ID client, offrant une expérience plus riche pour l’utilisateur. Bing utilise également cet en-tête pour améliorer les classements de résultats en analysant l’activité générée par un ID client. Les améliorations de pertinence aident à améliorer la qualité des résultats fournis par les API Bing et à leur tour permettent d’augmenter les taux de clic pour le consommateur d’API. IMPORTANT : Bien que facultatif, vous devez prendre en compte cet en-tête requis. La persistance de l’ID client sur plusieurs requêtes pour la même combinaison d’utilisateurs finaux et d’appareils permet au consommateur d’API de recevoir une expérience utilisateur cohérente, et 2) des taux de clic plus élevés via une meilleure qualité des résultats des API Bing. Chaque utilisateur qui utilise votre application sur l’appareil doit avoir un ID client généré par Bing unique. Si vous n’incluez pas cet en-tête dans la requête, Bing génère un ID et le retourne dans l’en-tête de réponse X-MSEdge-ClientID. La seule fois que vous ne devez pas inclure cet en-tête dans une demande est la première fois que l’utilisateur utilise votre application sur cet appareil. Utilisez l’ID client pour chaque demande d’API Bing que votre application effectue pour cet utilisateur sur l’appareil. Conservez l’ID client. Pour conserver l’ID dans une application de navigateur, utilisez un cookie HTTP persistant pour vous assurer que l’ID est utilisé dans toutes les sessions. N’utilisez pas de cookie de session. Pour d’autres applications telles que les applications mobiles, utilisez le stockage persistant de l’appareil pour conserver l’ID. La prochaine fois que l’utilisateur utilise votre application sur cet appareil, obtenez l’ID client que vous avez conservé. Les réponses Bing peuvent inclure ou non cet en-tête. Si la réponse inclut cet en-tête, capturez l’ID client et utilisez-le pour toutes les demandes Bing suivantes pour l’utilisateur sur cet appareil. Si vous incluez le X-MSEdge-ClientID, vous ne devez pas inclure de cookies dans la demande.

clientId?: string

Valeur de propriété

string

clientIp

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 d’emplacement pour déterminer le comportement de recherche sécurisé. Bien que facultatif, vous êtes invité à toujours spécifier cet en-tête et l’en-tête X-Search-Location. N’obfusez pas l’adresse (par exemple, en remplaçant le dernier octet par 0). L’obfuscatation de l’adresse entraîne l’emplacement qui n’est pas situé à proximité de l’emplacement réel de l’appareil, ce qui peut entraîner la diffusion de résultats erronés par Bing.

clientIp?: string

Valeur de propriété

string

count

Nombre de résultats de recherche à retourner 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 le nombre sur 10 et décalé sur 0 pour obtenir la première page des 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.

count?: number

Valeur de propriété

number

countryCode

Code de pays à 2 caractères du pays à partir duquel proviennent les résultats. Cette API prend uniquement en charge le marché américain. 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 le code 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 trouve 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.

countryCode?: string

Valeur de propriété

string

freshness

Filtrez les résultats de la recherche selon les valeurs d’âge suivantes : Jour : renvoyer des pages web découvertes par Bing au cours des 24 dernières heures. Semaine : renvoyer des pages web découvertes par Bing au cours des 7 derniers jours. Mois : renvoyer des pages web 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'

freshness?: Freshness

Valeur de propriété

Freshness

location

Liste délimitée par des points-virgules de paires clé/valeur qui décrivent l’emplacement géographique du client. Bing utilise les informations d’emplacement pour déterminer le comportement de recherche sécurisé et retourner le contenu local approprié. Spécifiez la paire clé/valeur comme <clé>:<valeur>. Voici les clés que vous utilisez pour spécifier l’emplacement de l’utilisateur. lat (obligatoire) : latitude de l’emplacement du client, en degrés. La latitude 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 indiquent les latitudes du nord. long (obligatoire) : longitude de l’emplacement du client, en degrés. La longitude 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 indiquent 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 d’emplacement de l’appareil. Les valeurs classiques peuvent être de 22m pour GPS/Wi-Fi, 380m pour la triangulation de tour de cellule et 18 000m pour la recherche d’adresses IP inversées. ts (facultatif) : horodatage UNIX UTC du moment où le client était à l’emplacement. (L’horodatage UNIX est le nombre de secondes depuis le 1er janvier 1970.) head (facultatif) : titre ou direction du voyage relatif du client. Spécifiez le sens du déplacement sous forme de degrés allant de 0 à 360, en comptant le sens des aiguilles d’une montre par rapport à true nord. Spécifiez cette clé uniquement si la clé sp est différente de zéro. sp (facultatif) : vitesse horizontale (vitesse), en mètres par seconde, que l’appareil client voyage. 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 d’emplacement sont précis. Bien que facultatif, vous êtes invité à toujours spécifier l’emplacement géographique de l’utilisateur. Fournir l’emplacement est particulièrement important si l’adresse IP du client ne reflète pas précisément l’emplacement physique de l’utilisateur (par exemple, si le client utilise un VPN). Pour obtenir des résultats optimaux, vous devez inclure cet en-tête et l’en-tête X-MSEdge-ClientIP, mais au minimum, vous devez inclure cet en-tête.

location?: string

Valeur de propriété

string

market

Le 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 n’est pas situé dans un pays où Bing fournit des résultats. Le marché doit être sous la forme <code> langue-code<> pays. Par exemple, en-US. La chaîne ne respecte pas la casse. Si vous le connaissez, vous êtes encouragé à toujours spécifier le marché. La spécification du marché aide Bing à acheminer la requête et à retourner une réponse appropriée et optimale. Si vous spécifiez un marché qui n’est pas répertorié dans les codes de marché, Bing utilise un code de marché adapté en fonction d’un mappage interne susceptible de changer. Ce paramètre et le paramètre de requête cc s’excluent mutuellement, ne spécifient pas les deux. Valeur par défaut : 'en-us'.

market?: string

Valeur de propriété

string

offset

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 ainsi que le paramètre count pour les résultats de la page. Par exemple, si votre interface utilisateur affiche 10 résultats de recherche par page, définissez le nombre sur 10 et décalé sur 0 pour obtenir la première page des 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.

offset?: number

Valeur de propriété

number

pragma

Par défaut, Bing retourne du contenu mis en cache, le cas échéant. Pour empêcher Bing de retourner du contenu mis en cache, définissez l’en-tête Pragma sur no-cache (par exemple, Pragma : no-cache).

pragma?: string

Valeur de propriété

string

promote

Liste délimitée par des virgules de réponses que vous souhaitez inclure la réponse indépendamment de leur classement. Par exemple, si vous définissez answerCount) sur deux (2) pour 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 vers les actualités. Si les réponses les plus 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 vers la vidéo, Bing promouvoirait la réponse vidéo dans la réponse et renvoyer des pages web, des images et des vidéos. Les réponses que vous souhaitez promouvoir ne comptent pas par rapport à 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 faites la promotion vers les actualités, la réponse contient des actualités et des images. Ou, si les réponses classées sont des vidéos, des images et des actualités, 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.

promote?: AnswerType[]

Valeur de propriété

AnswerType[]

responseFilter

Liste délimitée par des virgules de réponses à 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. Bien que vous puissiez utiliser ce filtre pour obtenir une réponse unique, vous devez utiliser plutôt le point de terminaison spécifique à la réponse pour obtenir des résultats plus riches. Par exemple, pour recevoir uniquement des images, envoyez la requête à 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 l’API Recherche d’images (seule l’API Recherche web les renvoie). Pour inclure des réponses qui seraient autrement exclues en raison du classement, consultez le paramètre de requête promouvoir.

responseFilter?: AnswerType[]

Valeur de propriété

AnswerType[]

safeSearch

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

safeSearch?: SafeSearch

Valeur de propriété

SafeSearch

setLang

Langue à utiliser pour les chaînes d’interface utilisateur. Spécifiez la langue à l’aide du code de langue ISO 639-1 à 2 lettres. Par exemple, le code de langue pour l’anglais est EN. La valeur par défaut est EN (anglais). Bien que facultatif, vous devez toujours spécifier la langue. 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 s’affichent 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. Il existe quelques chaînes d’interface utilisateur dans les objets de réponse JSON. En outre, les liens vers Bing.com propriétés dans les objets de réponse appliquent le langage spécifié.

setLang?: string

Valeur de propriété

string

textDecorations

Valeur booléenne qui détermine si les chaînes d’affichage doivent contenir des marqueurs de décoration tels que la mise en surbrillance des caractères. 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.

textDecorations?: boolean

Valeur de propriété

boolean

textFormat

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 nécessitant 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 balises 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 échapables tels que <, >et &, si textFormat est défini sur HTML, Bing échappe les caractères appropriés (par exemple, < est échappé à <). Les valeurs possibles sont les suivantes : « Raw », « Html »

textFormat?: TextFormat

Valeur de propriété

TextFormat

userAgent

Agent utilisateur à l’origine de la requête. Bing utilise l’agent utilisateur pour fournir aux utilisateurs mobiles une expérience optimisée. Bien que facultatif, vous êtes fortement encouragé à 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 utilisateur, consultez RFC 2616.

userAgent?: string

Valeur de propriété

string

Détails de la propriété héritée

abortSignal

Signal qui peut être utilisé pour abandonner les demandes.

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

héritée de msRest.RequestOptionsBase.abortSignal

customHeaders

En-têtes de requête personnalisés définis par l’utilisateur qui seront appliqués avant l’envoi de la demande.

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

Valeur de propriété

{[key: string]: string}

héritée de msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Rappel qui se déclenche lors de la progression du téléchargement.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valeur de propriété

(progress: TransferProgressEvent) => void

héritée de msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Rappel qui se déclenche lors de la progression du chargement.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valeur de propriété

(progress: TransferProgressEvent) => void

héritée de msRest.RequestOptionsBase.onUploadProgress

timeout

Le nombre de millisecondes qu’une demande peut prendre avant de se terminer automatiquement.

timeout?: number

Valeur de propriété

number

héritée de msRest.RequestOptionsBase.timeout