Partager via

ImagesVisualSearchOptionalParams interface

  • Référence
Paquet:
@azure/cognitiveservices-visualsearch

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 la 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.
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. ATTENTION : Vérifiez que cet ID client ne peut pas être associé à des informations authentifiables sur le compte d’utilisateur. 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.
contentType

Doit être défini sur plusieurs parties/form-data et inclure un paramètre de limite (par exemple, multipart/form-data ; boundary=). Pour plus d’informations, voir les types de formulaires de contenu.
image

Les données de formulaire sont un binaire d’image. Le paramètre de nom de l’en-tête Content-Disposition doit être défini sur « image ». Vous devez spécifier un fichier binaire d’image si vous n’utilisez pas les données de formulaire knowledgeRequest pour spécifier l’image ; vous ne pouvez pas utiliser les deux formulaires pour spécifier une image. Vous pouvez spécifier des données de formulaire knowledgeRequest et des données de formulaire image dans la même demande uniquement si les données du formulaire knowledgeRequest spécifient uniquement le champ cropArea (elles ne doivent pas inclure de jeton d’insights ou d’URL).
knowledgeRequest

Les données de formulaire sont un objet JSON qui identifie l’image à l’aide d’un jeton d’insights ou d’une URL vers l’image. L’objet peut également inclure une zone de rognage facultative qui identifie une zone d’intérêt dans l’image. Le jeton d’insights et l’URL s’excluent mutuellement. Ne spécifiez pas les deux. Vous pouvez spécifier des données de formulaire knowledgeRequest et des données de formulaire image dans la même demande uniquement si les données du formulaire knowledgeRequest spécifient uniquement le champ cropArea (elles ne doivent pas inclure de jeton d’insights ou d’URL).
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 sous 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é adapté à un mappage interne susceptible de changer.
safeSearch

Filtrez les résultats de l’image dans les actions de type « VisualSearch » pour le contenu pour adultes. Voici les valeurs de filtre possibles. Désactivé : peut renvoyer des images avec du contenu pour adultes. Modéré : ne retournez pas d’images avec du contenu pour adultes. 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 le filtre site : dans la demande de connaissances, il est possible que la réponse contienne du contenu pour adultes, quel que soit le paramètre de requête safeSearch défini. Utiliser le site : uniquement si vous connaissez le contenu du site et si votre scénario prend en charge la possibilité de contenu pour adultes. Les valeurs possibles sont les suivantes : 'Off', 'Moderate', 'Strict'
setLang

Langue à utiliser pour les chaînes de l’interface utilisateur. Spécifiez la langue en utilisant le code de langue ISO 639-1 à deux lettres. Par exemple, celui de l’anglais est EN. La valeur par défaut est EN (anglais). Nous vous conseillons de toujours indiquer la langue, bien qu’elle soit facultative. En règle générale, vous définissez setLang sur la même langue spécifiée par mkt, sauf si l’utilisateur souhaite que les chaînes d’interface utilisateur soient affichées dans une autre langue. 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.
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 processeur 7_0 comme Mac OS X) AppleWebKit / 537.51.1 (KHTML, comme Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53.

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

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

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. ATTENTION : Vérifiez que cet ID client ne peut pas être associé à des informations authentifiables sur le compte d’utilisateur. 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

contentType

Doit être défini sur plusieurs parties/form-data et inclure un paramètre de limite (par exemple, multipart/form-data ; boundary=). Pour plus d’informations, voir les types de formulaires de contenu.

contentType?: string

Valeur de propriété

string

image

Les données de formulaire sont un binaire d’image. Le paramètre de nom de l’en-tête Content-Disposition doit être défini sur « image ». Vous devez spécifier un fichier binaire d’image si vous n’utilisez pas les données de formulaire knowledgeRequest pour spécifier l’image ; vous ne pouvez pas utiliser les deux formulaires pour spécifier une image. Vous pouvez spécifier des données de formulaire knowledgeRequest et des données de formulaire image dans la même demande uniquement si les données du formulaire knowledgeRequest spécifient uniquement le champ cropArea (elles ne doivent pas inclure de jeton d’insights ou d’URL).

image?: HttpRequestBody

Valeur de propriété

HttpRequestBody

knowledgeRequest

Les données de formulaire sont un objet JSON qui identifie l’image à l’aide d’un jeton d’insights ou d’une URL vers l’image. L’objet peut également inclure une zone de rognage facultative qui identifie une zone d’intérêt dans l’image. Le jeton d’insights et l’URL s’excluent mutuellement. Ne spécifiez pas les deux. Vous pouvez spécifier des données de formulaire knowledgeRequest et des données de formulaire image dans la même demande uniquement si les données du formulaire knowledgeRequest spécifient uniquement le champ cropArea (elles ne doivent pas inclure de jeton d’insights ou d’URL).

knowledgeRequest?: string

Valeur de propriété

string

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 sous 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é adapté à un mappage interne susceptible de changer.

market?: string

Valeur de propriété

string

safeSearch

Filtrez les résultats de l’image dans les actions de type « VisualSearch » pour le contenu pour adultes. Voici les valeurs de filtre possibles. Désactivé : peut renvoyer des images avec du contenu pour adultes. Modéré : ne retournez pas d’images avec du contenu pour adultes. 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 le filtre site : dans la demande de connaissances, il est possible que la réponse contienne du contenu pour adultes, quel que soit le paramètre de requête safeSearch défini. Utiliser le site : uniquement si vous connaissez le contenu du site et si votre scénario prend en charge la possibilité de contenu pour adultes. Les valeurs possibles sont les suivantes : 'Off', 'Moderate', 'Strict'

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 d’interface utilisateur soient affichées dans une autre langue. 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

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

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