ImagesSearchOptionalParams interface

Paquet:

@azure/cognitiveservices-imagesearch

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. 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. Pour déterminer le marché pour lequel retourner des résultats, Bing utilise la première langue prise en charge qu’il trouve dans la liste et le combine avec la valeur du paramètre cc. Si la liste ne comporte pas de langue prise en charge, Bing recherche la langue et le marché les plus proches qui prennent en charge la demande, ou utilise un marché agrégé ou par défaut pour les résultats. Pour identifier le marché utilisé par Bing, voir l’en-tête BingAPIs-Market. Utilisez cet en-tête et le paramètre de requête cc uniquement si vous spécifiez plusieurs langues. Sinon, utilisez 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. Les objets de réponse JSON en comportent quelques-unes. Les liens vers les propriétés Bing.com dans les objets de la réponse s’appliquent à la langue spécifiée.
aspect	Filtrez les images selon les proportions suivantes. Tout : ne filtrez pas par aspect. La spécification de cette valeur revient à ne pas spécifier le paramètre d’aspect. Carré : retourne des images avec un rapport d’aspect standard. Large : retourne des images avec un format d’écran large. Grand : retourne des images avec un rapport d’aspect élevé. Les valeurs possibles sont les suivantes : 'All', 'Square', 'Wide', 'Tall'
clientId	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	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.
color	Filtrez les images selon les options de couleur suivantes. ColorOnly : retourne des images en couleur. Monochrome : retourne des images en noir et blanc. Renvoyer des images avec l’une des couleurs dominantes suivantes : Noir, Bleu, Brun, Gris, Vert, Orange, Rose, Violet, Rouge, Sarcelle, Blanc, Jaune. Les valeurs possibles sont les suivantes : 'ColorOnly', 'Monochrome', 'Black', 'Blue', 'Brown', 'Gray', 'Green', 'Orange', 'Pink', 'Purple', 'Red', 'Teal', 'White', 'Yellow'
count	Nombre d’images à retourner dans la réponse. Le nombre réel renvoyé peut être inférieur à ce que vous avez demandé. La valeur par défaut est 35. La valeur maximale est 150. Vous utilisez ce paramètre avec le paramètre offset pour les résultats de page. Par exemple, si votre interface utilisateur affiche 20 images par page, définissez nombre sur 20 et décalage sur 0 pour obtenir la première page de résultats. Pour chaque page suivante, incrémentez le décalage de 20 (par exemple, 0, 20, 40). Utilisez ce paramètre uniquement avec la recherche d’images API.Do ne spécifiez pas ce paramètre lors de l’appel des API Insights, Trending Images ou Recherche web.
countryCode	Code à 2 caractères du pays d'où proviennent les résultats. Pour obtenir la liste des valeurs possibles, consultez Codes de marché. 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 des 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.
freshness	Filtrez les images selon les options de découverte suivantes. Jour : retourne les images découvertes par Bing au cours des dernières 24 heures. Semaine : retourne les images découvertes par Bing au cours des 7 derniers jours. Mois : retourne les images découvertes par Bing au cours des 30 derniers jours. Les valeurs possibles sont les suivantes : 'Day', 'Week', 'Month'
height	Filtrez les images qui ont la hauteur spécifiée, en pixels. Vous pouvez utiliser ce filtre avec le filtre de taille pour renvoyer de petites images d’une hauteur de 150 pixels.
id	ID qui identifie une image de manière unique. Utilisez ce paramètre pour vous assurer que l’image spécifiée est la première image de la liste d’images retournée par Bing. Le champ imageId de l’objet Image contient l’ID sur lequel vous définissez ce paramètre.
imageContent	Filtrez les images selon les types de contenu suivants. Visage : retourne des images qui n’affichent que le visage d’une personne. Portrait : retourne des images qui montrent uniquement la tête et les épaules d’une personne. Les valeurs possibles sont les suivantes : 'Visage', 'Portrait'
imageType	Filtrez les images selon les types d’images suivants. AnimatedGif : retourne uniquement les GIF animés. Clipart : retourne uniquement les images clipart. Trait : retourne uniquement les dessins de traits. Photo : Retourne uniquement les photographies (à l’exception des dessins au trait, des gifs animés et des images clipart). Shopping : retourne uniquement les images qui contiennent des articles où Bing connaît un marchand qui vend les articles. Cette option est valide uniquement sur le marché en - US. Transparent : retourne uniquement les images avec un arrière-plan transparent. Les valeurs possibles sont les suivantes : 'AnimatedGif', 'Clipart', 'Line', 'Photo', 'Shopping', 'Transparent'
license	Filtrez les images selon les types de licence suivants. Tout : ne filtrez pas par type de licence. La spécification de cette valeur revient à ne pas spécifier le paramètre de licence. N’importe quel : retourne les images qui se trouvent sous n’importe quel type de licence. La réponse n’inclut pas d’images qui ne spécifient pas de licence ou la licence est inconnue. Public : retourner des images lorsque le créateur a renoncé à leurs droits exclusifs, dans toute la mesure autorisée par la loi. Partager : retourne des images qui peuvent être partagées avec d’autres personnes. La modification ou la modification de l’image peut ne pas être autorisée. En outre, la modification, le partage et l’utilisation de l’image à des fins commerciales peuvent ne pas être autorisés. En règle générale, cette option retourne le plus d’images. ShareCommercially : retourne des images qui peuvent être partagées avec d’autres personnes à des fins personnelles ou commerciales. La modification ou la modification de l’image peut ne pas être autorisée. Modifier : retourne les images qui peuvent être modifiées, partagées et utilisées. La modification ou la modification de l’image peut ne pas être autorisée. La modification, le partage et l’utilisation de l’image à des fins commerciales peuvent ne pas être autorisés. ModifyCommercially : retourne des images qui peuvent être modifiées, partagées et utilisées à des fins personnelles ou commerciales. En règle générale, cette option retourne le moins d’images. Pour plus d’informations sur ces types de licences, consultez Filtrer les images par type de licence. Les valeurs possibles sont les suivantes : 'All', 'Any', 'Public', 'Share', 'ShareCommercially', 'Modify', 'ModifyCommercially'
location	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 :. 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 correspond au nombre de secondes écoulées depuis le 1er janvier 1970.) head (facultatif) : titre 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) : vitesse horizontale (vitesse), en mètres par seconde, que l’appareil client est en train de parcourir. 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.
market	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 dans la forme -. Par exemple, en-US. La chaîne ne respecte pas la casse. Pour obtenir la liste des valeurs de marché possibles, consultez Codes de marché. REMARQUE : 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é le mieux adapté basé sur un mappage interne susceptible d’être modifié. Ce paramètre et le paramètre de requête cc s’excluent mutuellement ; ne spécifiez pas les deux.
maxFileSize	Filtrez les images qui sont inférieures ou égales à la taille de fichier spécifiée. La taille de fichier maximale que vous pouvez spécifier est de 520 192 octets. Si vous spécifiez une valeur plus élevée, l’API utilise 520 192. Il est possible que la réponse inclue des images légèrement supérieures à la valeur maximale spécifiée. Vous pouvez spécifier ce filtre et minFileSize pour filtrer les images dans une plage de tailles de fichier.
maxHeight	Filtrez les images dont la hauteur est inférieure ou égale à la hauteur spécifiée. Spécifiez la hauteur en pixels. Vous pouvez spécifier ce filtre et minHeight pour filtrer les images dans une plage de hauteurs. Ce filtre et le filtre de hauteur s’excluent mutuellement.
maxWidth	Filtrez les images dont la largeur est inférieure ou égale à la largeur spécifiée. Spécifiez la largeur en pixels. Vous pouvez spécifier ce filtre et maxWidth pour filtrer les images dans une plage de largeurs. Ce filtre et le filtre de largeur s’excluent mutuellement.
minFileSize	Filtrez les images supérieures ou égales à la taille de fichier spécifiée. La taille de fichier maximale que vous pouvez spécifier est de 520 192 octets. Si vous spécifiez une valeur plus élevée, l’API utilise 520 192. Il est possible que la réponse inclue des images légèrement inférieures à la valeur minimale spécifiée. Vous pouvez spécifier ce filtre et maxFileSize pour filtrer les images dans une plage de tailles de fichier.
minHeight	Filtrez les images dont la hauteur est supérieure ou égale à la hauteur spécifiée. Spécifiez la hauteur en pixels. Vous pouvez spécifier ce filtre et maxHeight pour filtrer les images dans une plage de hauteurs. Ce filtre et le filtre de hauteur s’excluent mutuellement.
minWidth	Filtrez les images dont la largeur est supérieure ou égale à la largeur spécifiée. Spécifiez la largeur en pixels. Vous pouvez spécifier ce filtre et maxWidth pour filtrer les images dans une plage de largeurs. Ce filtre et le filtre de largeur s’excluent mutuellement.
offset	Décalage de base zéro qui indique le nombre d’images à ignorer avant de retourner des images. 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 20 images par page, définissez count sur 20 et offset sur 0 pour obtenir la première page de résultats. Pour chaque page suivante, incrémentez le décalage de 20 (par exemple, 0, 20, 40). Il est possible que plusieurs pages incluent des chevauchements dans les résultats. Pour éviter les doublons, consultez nextOffset. Utilisez ce paramètre uniquement avec l’API Image. Ne spécifiez pas ce paramètre lors de l’appel de l’API Trending Images ou de l’API Recherche web.
safeSearch	Filtrer les images pour le contenu pour adultes. Voici les valeurs de filtre possibles. Désactivé : peut retourner des images avec du contenu pour adultes. Si la requête passe par l’API Recherche d’images, la réponse inclut des images miniatures qui sont claires (non floues). Toutefois, si la requête passe par l’API Recherche web, la réponse inclut des images miniatures pixelisées (approximatives). Modéré : si la demande passe par l’API Recherche d’images, la réponse n’inclut pas d’images avec du contenu pour adultes. Si la demande passe par l’API Recherche web, la réponse peut inclure des images avec du contenu pour adultes (les images miniatures sont pixelisées (floues)). Strict : ne retournez pas d’images avec du contenu 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	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.
size	Filtrez les images selon les tailles suivantes. Tout : ne filtrez pas par taille. La spécification de cette valeur revient à ne pas spécifier le paramètre size. Petite : retourne des images inférieures à 200 x 200 pixels. Moyen : renvoie des images supérieures ou égales à 200 x 200 pixels, mais inférieures à 500 x 500 pixels. Grande : retourne des images de 500 x 500 pixels ou plus. Papier peint : renvoyer des images de papier peint. Vous pouvez utiliser ce paramètre avec les paramètres height ou width. Par exemple, vous pouvez utiliser la hauteur et la taille pour demander des images de petite taille de 150 pixels. Les valeurs possibles sont les suivantes : « All », « Small », « Medium », « Large », « Wallpaper »
userAgent	Agent utilisateur à l’origine de la requête. Bing utilise l’agent utilisateur pour offrir une expérience optimisée aux utilisateurs mobiles. Nous vous conseillons de toujours indiquer cet en-tête, bien qu’il soit facultatif. L’agent utilisateur doit correspondre à la chaîne envoyée par n’importe quel navigateur couramment utilisé. Pour plus d’informations sur les agents utilisateurs, voir RFC 2616. Voici quelques exemples de chaînes de l’agent utilisateur. Windows Phone : Mozilla/5.0 (compatible; MSIE 10.0 ; Windows Phone 8.0 ; Trident/6.0; IEMobile/10.0 ; BRAS; Toucher; NOKIA; Lumia 822). Android : Mozilla / 5.0 (Linux; U; Android 2.3.5 ; en - us; SCH - I500 Build / GINGERBREAD) AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0 Mobile Safari / 533.1. iPhone: Mozilla / 5.0 (iPhone; Processeur iPhone OS 6_1 comme Mac OS X) AppleWebKit / 536.26 (KHTML; comme Gecko) Mobile / 10B142 iPhone4; 1 BingWeb / 3.03.1428.20120423. PC : Mozilla / 5.0 (Windows NT 6.3; WOW64; Trident / 7.0; Toucher; rv:11.0) comme Gecko. iPad: Mozilla / 5.0 (iPad; Système d’exploitation du processeur 7_0 comme Mac OS X) AppleWebKit / 537.51.1 (KHTML, comme Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53
width	Filtrez les images dont la largeur est spécifiée, en pixels. Vous pouvez utiliser ce filtre avec le filtre de taille pour renvoyer de petites images d’une largeur de 150 pixels.

Propriétés héritées

abortSignal	Signal qui peut être utilisé pour annuler les demandes.
customHeaders	L’utilisateur a défini des en-têtes de requête personnalisés 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	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. 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. Pour déterminer le marché pour lequel retourner des résultats, Bing utilise la première langue prise en charge qu’il trouve dans la liste et le combine avec la valeur du paramètre cc. Si la liste ne comporte pas de langue prise en charge, Bing recherche la langue et le marché les plus proches qui prennent en charge la demande, ou utilise un marché agrégé ou par défaut pour les résultats. Pour identifier le marché utilisé par Bing, voir l’en-tête BingAPIs-Market. Utilisez cet en-tête et le paramètre de requête cc uniquement si vous spécifiez plusieurs langues. Sinon, utilisez 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. Les objets de réponse JSON en comportent quelques-unes. Les liens vers les propriétés Bing.com dans les objets de la réponse s’appliquent à la langue spécifiée.

acceptLanguage?: string

Valeur de propriété

string

aspect

Filtrez les images selon les proportions suivantes. Tout : ne filtrez pas par aspect. La spécification de cette valeur revient à ne pas spécifier le paramètre d’aspect. Carré : retourne des images avec un rapport d’aspect standard. Large : retourne des images avec un format d’écran large. Grand : retourne des images avec un rapport d’aspect élevé. Les valeurs possibles sont les suivantes : 'All', 'Square', 'Wide', 'Tall'

aspect?: ImageAspect

Valeur de propriété

ImageAspect

clientId

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.

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 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.

clientIp?: string

Valeur de propriété

string

color

Filtrez les images selon les options de couleur suivantes. ColorOnly : retourne des images en couleur. Monochrome : retourne des images en noir et blanc. Renvoyer des images avec l’une des couleurs dominantes suivantes : Noir, Bleu, Brun, Gris, Vert, Orange, Rose, Violet, Rouge, Sarcelle, Blanc, Jaune. Les valeurs possibles sont les suivantes : 'ColorOnly', 'Monochrome', 'Black', 'Blue', 'Brown', 'Gray', 'Green', 'Orange', 'Pink', 'Purple', 'Red', 'Teal', 'White', 'Yellow'

color?: ImageColor

Valeur de propriété

ImageColor

count

Nombre d’images à retourner dans la réponse. Le nombre réel renvoyé peut être inférieur à ce que vous avez demandé. La valeur par défaut est 35. La valeur maximale est 150. Vous utilisez ce paramètre avec le paramètre offset pour les résultats de page. Par exemple, si votre interface utilisateur affiche 20 images par page, définissez nombre sur 20 et décalage sur 0 pour obtenir la première page de résultats. Pour chaque page suivante, incrémentez le décalage de 20 (par exemple, 0, 20, 40). Utilisez ce paramètre uniquement avec la recherche d’images API.Do ne spécifiez pas ce paramètre lors de l’appel des API Insights, Trending Images ou Recherche web.

count?: number

Valeur de propriété

number

countryCode

Code à 2 caractères du pays d'où proviennent les résultats. Pour obtenir la liste des valeurs possibles, consultez Codes de marché. 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 des 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.

countryCode?: string

Valeur de propriété

string

freshness

Filtrez les images selon les options de découverte suivantes. Jour : retourne les images découvertes par Bing au cours des dernières 24 heures. Semaine : retourne les images découvertes par Bing au cours des 7 derniers jours. Mois : retourne les images découvertes par Bing au cours des 30 derniers jours. Les valeurs possibles sont les suivantes : 'Day', 'Week', 'Month'

freshness?: Freshness

Valeur de propriété

Freshness

height

Filtrez les images qui ont la hauteur spécifiée, en pixels. Vous pouvez utiliser ce filtre avec le filtre de taille pour renvoyer de petites images d’une hauteur de 150 pixels.

height?: number

Valeur de propriété

number

id

ID qui identifie une image de manière unique. Utilisez ce paramètre pour vous assurer que l’image spécifiée est la première image de la liste d’images retournée par Bing. Le champ imageId de l’objet Image contient l’ID sur lequel vous définissez ce paramètre.

id?: string

Valeur de propriété

string

imageContent

Filtrez les images selon les types de contenu suivants. Visage : retourne des images qui n’affichent que le visage d’une personne. Portrait : retourne des images qui montrent uniquement la tête et les épaules d’une personne. Les valeurs possibles sont les suivantes : 'Visage', 'Portrait'

imageContent?: ImageContent

Valeur de propriété

ImageContent

imageType

Filtrez les images selon les types d’images suivants. AnimatedGif : retourne uniquement les GIF animés. Clipart : retourne uniquement les images clipart. Trait : retourne uniquement les dessins de traits. Photo : Retourne uniquement les photographies (à l’exception des dessins au trait, des gifs animés et des images clipart). Shopping : retourne uniquement les images qui contiennent des articles où Bing connaît un marchand qui vend les articles. Cette option est valide uniquement sur le marché en - US. Transparent : retourne uniquement les images avec un arrière-plan transparent. Les valeurs possibles sont les suivantes : 'AnimatedGif', 'Clipart', 'Line', 'Photo', 'Shopping', 'Transparent'

imageType?: ImageType

Valeur de propriété

ImageType

license

Filtrez les images selon les types de licence suivants. Tout : ne filtrez pas par type de licence. La spécification de cette valeur revient à ne pas spécifier le paramètre de licence. N’importe quel : retourne les images qui se trouvent sous n’importe quel type de licence. La réponse n’inclut pas d’images qui ne spécifient pas de licence ou la licence est inconnue. Public : retourner des images lorsque le créateur a renoncé à leurs droits exclusifs, dans toute la mesure autorisée par la loi. Partager : retourne des images qui peuvent être partagées avec d’autres personnes. La modification ou la modification de l’image peut ne pas être autorisée. En outre, la modification, le partage et l’utilisation de l’image à des fins commerciales peuvent ne pas être autorisés. En règle générale, cette option retourne le plus d’images. ShareCommercially : retourne des images qui peuvent être partagées avec d’autres personnes à des fins personnelles ou commerciales. La modification ou la modification de l’image peut ne pas être autorisée. Modifier : retourne les images qui peuvent être modifiées, partagées et utilisées. La modification ou la modification de l’image peut ne pas être autorisée. La modification, le partage et l’utilisation de l’image à des fins commerciales peuvent ne pas être autorisés. ModifyCommercially : retourne des images qui peuvent être modifiées, partagées et utilisées à des fins personnelles ou commerciales. En règle générale, cette option retourne le moins d’images. Pour plus d’informations sur ces types de licences, consultez Filtrer les images par type de licence. Les valeurs possibles sont les suivantes : 'All', 'Any', 'Public', 'Share', 'ShareCommercially', 'Modify', 'ModifyCommercially'

license?: ImageLicense

Valeur de propriété

ImageLicense

location

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 :. 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 correspond au nombre de secondes écoulées depuis le 1er janvier 1970.) head (facultatif) : titre 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) : vitesse horizontale (vitesse), en mètres par seconde, que l’appareil client est en train de parcourir. 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.

location?: string

Valeur de propriété

string

market

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 dans la forme -. Par exemple, en-US. La chaîne ne respecte pas la casse. Pour obtenir la liste des valeurs de marché possibles, consultez Codes de marché. REMARQUE : 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é le mieux adapté basé sur un mappage interne susceptible d’être modifié. Ce paramètre et le paramètre de requête cc s’excluent mutuellement ; ne spécifiez pas les deux.

market?: string

Valeur de propriété

string

maxFileSize

Filtrez les images qui sont inférieures ou égales à la taille de fichier spécifiée. La taille de fichier maximale que vous pouvez spécifier est de 520 192 octets. Si vous spécifiez une valeur plus élevée, l’API utilise 520 192. Il est possible que la réponse inclue des images légèrement supérieures à la valeur maximale spécifiée. Vous pouvez spécifier ce filtre et minFileSize pour filtrer les images dans une plage de tailles de fichier.

maxFileSize?: number

Valeur de propriété

number

maxHeight

Filtrez les images dont la hauteur est inférieure ou égale à la hauteur spécifiée. Spécifiez la hauteur en pixels. Vous pouvez spécifier ce filtre et minHeight pour filtrer les images dans une plage de hauteurs. Ce filtre et le filtre de hauteur s’excluent mutuellement.

maxHeight?: number

Valeur de propriété

number

maxWidth

Filtrez les images dont la largeur est inférieure ou égale à la largeur spécifiée. Spécifiez la largeur en pixels. Vous pouvez spécifier ce filtre et maxWidth pour filtrer les images dans une plage de largeurs. Ce filtre et le filtre de largeur s’excluent mutuellement.

maxWidth?: number

Valeur de propriété

number

minFileSize

Filtrez les images supérieures ou égales à la taille de fichier spécifiée. La taille de fichier maximale que vous pouvez spécifier est de 520 192 octets. Si vous spécifiez une valeur plus élevée, l’API utilise 520 192. Il est possible que la réponse inclue des images légèrement inférieures à la valeur minimale spécifiée. Vous pouvez spécifier ce filtre et maxFileSize pour filtrer les images dans une plage de tailles de fichier.

minFileSize?: number

Valeur de propriété

number

minHeight

Filtrez les images dont la hauteur est supérieure ou égale à la hauteur spécifiée. Spécifiez la hauteur en pixels. Vous pouvez spécifier ce filtre et maxHeight pour filtrer les images dans une plage de hauteurs. Ce filtre et le filtre de hauteur s’excluent mutuellement.

minHeight?: number

Valeur de propriété

number

minWidth

Filtrez les images dont la largeur est supérieure ou égale à la largeur spécifiée. Spécifiez la largeur en pixels. Vous pouvez spécifier ce filtre et maxWidth pour filtrer les images dans une plage de largeurs. Ce filtre et le filtre de largeur s’excluent mutuellement.

minWidth?: number

Valeur de propriété

number

offset

Décalage de base zéro qui indique le nombre d’images à ignorer avant de retourner des images. 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 20 images par page, définissez count sur 20 et offset sur 0 pour obtenir la première page de résultats. Pour chaque page suivante, incrémentez le décalage de 20 (par exemple, 0, 20, 40). Il est possible que plusieurs pages incluent des chevauchements dans les résultats. Pour éviter les doublons, consultez nextOffset. Utilisez ce paramètre uniquement avec l’API Image. Ne spécifiez pas ce paramètre lors de l’appel de l’API Trending Images ou de l’API Recherche web.

offset?: number

Valeur de propriété

number

safeSearch

Filtrer les images pour le contenu pour adultes. Voici les valeurs de filtre possibles. Désactivé : peut retourner des images avec du contenu pour adultes. Si la requête passe par l’API Recherche d’images, la réponse inclut des images miniatures qui sont claires (non floues). Toutefois, si la requête passe par l’API Recherche web, la réponse inclut des images miniatures pixelisées (approximatives). Modéré : si la demande passe par l’API Recherche d’images, la réponse n’inclut pas d’images avec du contenu pour adultes. Si la demande passe par l’API Recherche web, la réponse peut inclure des images avec du contenu pour adultes (les images miniatures sont pixelisées (floues)). Strict : ne retournez pas d’images avec du contenu 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 »

safeSearch?: SafeSearch

Valeur de propriété

SafeSearch

setLang

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.

setLang?: string

Valeur de propriété

string

size

Filtrez les images selon les tailles suivantes. Tout : ne filtrez pas par taille. La spécification de cette valeur revient à ne pas spécifier le paramètre size. Petite : retourne des images inférieures à 200 x 200 pixels. Moyen : renvoie des images supérieures ou égales à 200 x 200 pixels, mais inférieures à 500 x 500 pixels. Grande : retourne des images de 500 x 500 pixels ou plus. Papier peint : renvoyer des images de papier peint. Vous pouvez utiliser ce paramètre avec les paramètres height ou width. Par exemple, vous pouvez utiliser la hauteur et la taille pour demander des images de petite taille de 150 pixels. Les valeurs possibles sont les suivantes : « All », « Small », « Medium », « Large », « Wallpaper »

size?: ImageSize

Valeur de propriété

ImageSize

userAgent

Agent utilisateur à l’origine de la requête. Bing utilise l’agent utilisateur pour offrir une expérience optimisée aux utilisateurs mobiles. Nous vous conseillons de toujours indiquer cet en-tête, bien qu’il soit facultatif. L’agent utilisateur doit correspondre à la chaîne envoyée par n’importe quel navigateur couramment utilisé. Pour plus d’informations sur les agents utilisateurs, voir RFC 2616. Voici quelques exemples de chaînes de l’agent utilisateur. Windows Phone : Mozilla/5.0 (compatible; MSIE 10.0 ; Windows Phone 8.0 ; Trident/6.0; IEMobile/10.0 ; BRAS; Toucher; NOKIA; Lumia 822). Android : Mozilla / 5.0 (Linux; U; Android 2.3.5 ; en - us; SCH - I500 Build / GINGERBREAD) AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0 Mobile Safari / 533.1. iPhone: Mozilla / 5.0 (iPhone; Processeur iPhone OS 6_1 comme Mac OS X) AppleWebKit / 536.26 (KHTML; comme Gecko) Mobile / 10B142 iPhone4; 1 BingWeb / 3.03.1428.20120423. PC : Mozilla / 5.0 (Windows NT 6.3; WOW64; Trident / 7.0; Toucher; rv:11.0) comme Gecko. iPad: Mozilla / 5.0 (iPad; Système d’exploitation du processeur 7_0 comme Mac OS X) AppleWebKit / 537.51.1 (KHTML, comme Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53

userAgent?: string

Valeur de propriété

string

width

Filtrez les images dont la largeur est spécifiée, en pixels. Vous pouvez utiliser ce filtre avec le filtre de taille pour renvoyer de petites images d’une largeur de 150 pixels.

width?: number

Valeur de propriété

number

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

abortSignal

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

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

Hérité de msRest.RequestOptionsBase.abortSignal

customHeaders

L’utilisateur a défini des en-têtes de requête personnalisés qui seront appliqués avant l’envoi de la demande.

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

Valeur de propriété

{[key: string]: string}

Hérité 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é 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é de msRest.RequestOptionsBase.onUploadProgress

timeout

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

timeout?: number

Valeur de propriété

number

Hérité de msRest.RequestOptionsBase.timeout