IImagesOperations.DetailsWithHttpMessagesAsync Méthode

Référence

Définition

Espace de noms:: Microsoft.Azure.CognitiveServices.Search.ImageSearch

Assembly:: Microsoft.Azure.CognitiveServices.Search.ImageSearch.dll

Paquet:: Microsoft.Azure.CognitiveServices.Search.ImageSearch v2.0.0

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

L’API Recherche de détails d’image vous permet de rechercher sur Bing et d’obtenir des informations sur une image, telles que des pages web qui incluent l’image. Cette section fournit des détails techniques sur les paramètres de requête et les en-têtes que vous utilisez pour demander des insights sur les images et les objets de réponse JSON qui les contiennent. Pour obtenir des exemples qui montrent comment effectuer des demandes, consultez Recherche d’images sur le web.

public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.ImageSearch.Models.ImageInsights>> DetailsWithHttpMessagesAsync (string query, string acceptLanguage = default, string contentType = default, string userAgent = default, string clientId = default, string clientIp = default, string location = default, double? cropBottom = default, double? cropLeft = default, double? cropRight = default, double? cropTop = default, string cropType = default, string countryCode = default, string id = default, string imageUrl = default, string insightsToken = default, System.Collections.Generic.IList<string> modules = default, string market = default, string safeSearch = default, string setLang = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DetailsWithHttpMessagesAsync : string * string * string * string * string * string * string * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> * string * string * string * string * string * System.Collections.Generic.IList<string> * string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.ImageSearch.Models.ImageInsights>>

Public Function DetailsWithHttpMessagesAsync (query As String, Optional acceptLanguage As String = Nothing, Optional contentType As String = Nothing, Optional userAgent As String = Nothing, Optional clientId As String = Nothing, Optional clientIp As String = Nothing, Optional location As String = Nothing, Optional cropBottom As Nullable(Of Double) = Nothing, Optional cropLeft As Nullable(Of Double) = Nothing, Optional cropRight As Nullable(Of Double) = Nothing, Optional cropTop As Nullable(Of Double) = Nothing, Optional cropType As String = Nothing, Optional countryCode As String = Nothing, Optional id As String = Nothing, Optional imageUrl As String = Nothing, Optional insightsToken As String = Nothing, Optional modules As IList(Of String) = Nothing, Optional market As String = Nothing, Optional safeSearch As String = Nothing, Optional setLang As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of ImageInsights))

Paramètres

query: String

Terme de requête de recherche de l’utilisateur. Le terme ne peut pas être vide. Le terme peut contenir des opérateurs avancés Bing. Par exemple, pour limiter les images à un domaine spécifique, utilisez l’opérateur site: . Pour améliorer la pertinence d’une requête Insights (voir insightsToken), vous devez toujours inclure le terme de requête de l’utilisateur. Utilisez ce paramètre uniquement avec la recherche d’images API.Do ne spécifiez pas ce paramètre lors de l’appel de l’API Trending Images.

acceptLanguage: String

Liste délimitée par des virgules d’une ou plusieurs langues à utiliser pour les chaînes d’interface utilisateur. Elle est triée par ordre de préférence décroissant. Pour plus d’informations, notamment sur le format attendu, consultez RFC2616. Cet en-tête et le paramètre de requête setLang s’excluent mutuellement ; ne spécifiez pas les deux. Si vous définissez cet en-tête, vous devrez également spécifier le paramètre de requête cc. 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.

contentType: String

En-tête de demande facultatif. Si vous définissez le paramètre de requête modules sur RecognizedEntities, vous pouvez spécifier le binaire d’une image dans le corps d’une requête POST. Si vous spécifiez l’image dans le corps d’une requête POST, vous devez spécifier cet en-tête et définir sa valeur sur multipart/form-data. La taille maximale de l’image est de 1 Mo.

userAgent: String

Agent utilisateur à l’origine de la requête. Bing utilise l’agent utilisateur pour offrir une expérience optimisée aux utilisateurs mobiles. 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 utilisateur, consultez RFC 2616. Voici des exemples de chaînes d’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

clientId: String

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

clientIp: String

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

location: String

Liste délimitée par des points-virgules de paires clé/valeur qui décrivent la situation géographique du client. Bing utilise les informations de localisation pour déterminer le comportement de recherche approprié et retourner le contenu local pertinent. Spécifiez la paire clé/valeur sous la forme <clé>:<valeur>. Voici les clés permettant de spécifier l’emplacement de l’utilisateur. lat (obligatoire) : latitude de l’emplacement du client, en degrés. Elle doit être supérieure ou égale à -90,0 et inférieure ou égale à +90,0. Les valeurs négatives indiquent les latitudes sud et les valeurs positives les latitudes nord. long (obligatoire) : longitude de l’emplacement du client, en degrés. Elle doit être supérieure ou égale à -180,0 et inférieure ou égale à +180,0. Les valeurs négatives indiquent les longitudes occidentales et les valeurs positives les longitudes orientales. re (obligatoire) : rayon, en mètres, qui spécifie la précision horizontale des coordonnées. Transmettez la valeur retournée par le service de localisation de l’appareil. Voici quelques valeurs courantes : 22 m pour le GPS/Wi-Fi, 380 m pour la triangulation des tours cellulaires et 18 000 m pour la recherche IP inversée. ts (facultatif) : horodatage UNIX UTC du moment où le client se trouvait à l’emplacement. (L’horodatage UNIX 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.

cropBottom: Nullable<Double>

Coordonnée inférieure de la région à rogner. La coordonnée est une valeur fractionnaire de la hauteur de l’image d’origine et est mesurée à partir du coin supérieur gauche de l’image. Spécifiez la coordonnée sous la forme d’une valeur comprise entre 0,0 et 1,0. Utilisez ce paramètre uniquement avec l’API Insights. Ne spécifiez pas ce paramètre lors de l’appel des API Images, Trending Images ou Recherche web.

cropLeft: Nullable<Double>

Coordonnée gauche de la région à rogner. La coordonnée est une valeur fractionnaire de la hauteur de l’image d’origine et est mesurée à partir du coin supérieur gauche de l’image. Spécifiez la coordonnée sous la forme d’une valeur comprise entre 0,0 et 1,0. Utilisez ce paramètre uniquement avec l’API Insights. Ne spécifiez pas ce paramètre lors de l’appel des API Images, Images tendances ou Recherche web.

cropRight: Nullable<Double>

Coordonnée droite de la région à rogner. La coordonnée est une valeur fractionnaire de la hauteur de l’image d’origine et est mesurée à partir du coin supérieur gauche de l’image. Spécifiez la coordonnée sous la forme d’une valeur comprise entre 0,0 et 1,0. Utilisez ce paramètre uniquement avec l’API Insights. Ne spécifiez pas ce paramètre lors de l’appel des API Images, Images tendances ou Recherche web.

cropTop: Nullable<Double>

Coordonnée supérieure de la région à rogner. La coordonnée est une valeur fractionnaire de la hauteur de l’image d’origine et est mesurée à partir du coin supérieur gauche de l’image. Spécifiez la coordonnée sous la forme d’une valeur comprise entre 0,0 et 1,0. Utilisez ce paramètre uniquement avec l’API Insights. Ne spécifiez pas ce paramètre lors de l’appel des API Images, Images tendances ou Recherche web.

cropType: String

Type de rognage à utiliser lors du rognage de l’image en fonction des coordonnées spécifiées dans les paramètres cal, cat, car et cab. Les valeurs possibles sont les suivantes. 0 : rectangulaire (par défaut). Utilisez ce paramètre uniquement avec l’API Insights. Ne spécifiez pas ce paramètre lors de l’appel des API Images, Images tendances ou Recherche web. Les valeurs possibles sont les suivantes : « Rectangulaire »

countryCode: String

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 l’indicatif de pays que vous spécifiez pour déterminer le marché pour lequel retourner les résultats. Si la liste des langues n’inclut pas de langue prise en charge, Bing recherche la langue et le marché les plus proches qui prennent en charge la demande, ou il peut utiliser un marché agrégé ou par défaut pour les résultats au lieu d’un marché spécifié. Vous devez utiliser ce paramètre de requête et le paramètre de requête Accept-Language uniquement si vous spécifiez plusieurs langues ; sinon, vous devez utiliser les paramètres de requête mkt et setLang. Ce paramètre et le paramètre de requête mkt s’excluent mutuellement ; ne spécifiez pas les deux.

id: String

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.

imageUrl: String

URL d’une image sur laquelle vous souhaitez obtenir des insights. Utilisez ce paramètre comme alternative à l’utilisation du paramètre insightsToken pour spécifier l’image. Vous pouvez également spécifier l’image en plaçant le fichier binaire de l’image dans le corps d’une requête POST. Si vous utilisez l’option binaire, consultez l’en-tête Content-Type . La taille d’image maximale prise en charge est 1 Mo. Utilisez ce paramètre uniquement avec l’API Insights. Ne spécifiez pas ce paramètre lors de l’appel des API Images, Images tendances ou Recherche web.

insightsToken: String

Jeton d’image. Le jeton imageInsightsToken de l’objet Image contient le jeton. Spécifiez ce paramètre pour obtenir des informations supplémentaires sur une image, telles qu’une légende ou une source d’achat. Pour obtenir la liste des informations supplémentaires sur une image que vous pouvez obtenir, consultez le paramètre de requête modules . Utilisez ce paramètre uniquement avec l’API Insights. Ne spécifiez pas ce paramètre lors de l’appel des API Images, Images tendances ou Recherche web.

modules: IList<String>

Liste délimitée par des virgules d’insights à demander. Voici les valeurs possibles. Elles ne sont pas sensibles à la casse. Tous : retourne tous les insights, le cas échéant, à l’exception de RecognizedEntities. BRQ : meilleure requête représentative. Terme de requête qui décrit le mieux l’image. Légende : légende qui fournit des informations sur l’image. Si le légende contient des entités, la réponse peut inclure des liens vers des images de ces entités. Collections : liste d’images associées. Recettes : liste de recettes pour la cuisson des aliments présentés dans les images. PagesIncluding : liste des pages web qui incluent l’image. RecognizedEntities : liste des entités (personnes) qui ont été reconnues dans l’image. REMARQUE : Vous ne pouvez pas spécifier ce module avec un autre module. Si vous le spécifiez avec d’autres modules, la réponse n’inclut pas d’entités reconnues. RelatedSearches : liste des recherches associées effectuées par d’autres personnes. ShoppingSources : liste des marchands où vous pouvez acheter des offres connexes. SimilarImages : liste d’images visuellement similaires à l’image d’origine. SimilarProducts : liste d’images qui contiennent un produit similaire à un produit trouvé dans l’image d’origine. Balises : fournit des caractéristiques du type de contenu trouvé dans l’image. Par exemple, si l’image est d’une personne, les étiquettes peuvent indiquer le sexe et le type de vêtements de la personne qu’elle porte. Si vous spécifiez un module et qu’il n’existe aucune donnée pour le module, l’objet de réponse n’inclut pas le champ associé. Par exemple, si vous spécifiez Caption et qu’elle n’existe pas, la réponse n’inclut pas le champ imageCaption. Pour inclure les recherches associées, la demande doit inclure la chaîne de requête d’origine. Bien que la chaîne de requête d’origine ne soit pas requise pour des images ou des produits similaires, vous devez toujours l’inclure, car elle peut aider à améliorer la pertinence et les résultats. Utilisez ce paramètre uniquement avec l’API Insights. Ne spécifiez pas ce paramètre lors de l’appel des API Images, Images tendances ou Recherche web.

market: String

Marché d’où proviennent les résultats. En règle générale, mkt est le pays à partir duquel l’utilisateur effectue la demande. Toutefois, il peut s’agir d’un autre pays si l’utilisateur ne se trouve pas dans un pays où Bing fournit des résultats. Le marché doit être sous la forme <langue code-code>> pays<. 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.

safeSearch: String

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

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