public void VisualSearchWithBinary()
{
using (MockContext context = MockContext.Start(this.GetType()))
{
HttpMockServer.Initialize(this.GetType(), "VisualSearchWithBinary");
IVisualSearchClient client = new VisualSearchClient(new ApiKeyServiceClientCredentials(SubscriptionKey), HttpMockServer.CreateInstance());
using (FileStream stream = new FileStream(Path.Combine("TestImages", "image.jpg"), FileMode.Open))
{
VisualSearchRequest VisualSearchRequest = new VisualSearchRequest();
var resp = client.Images.VisualSearchMethodAsync(image: stream, knowledgeRequest: JsonConvert.SerializeObject(VisualSearchRequest)).Result;
Assert.NotNull(resp);
Assert.NotNull(resp.Tags);
Assert.True(resp.Tags.Count > 0);
var tag = resp.Tags[0];
Assert.NotNull(tag.Actions);
Assert.True(tag.Actions.Count > 0);
var action = tag.Actions[0];
Assert.NotNull(action.ActionType);
}
}
}
public void VisualSearchWithUrl()
{
using (MockContext context = MockContext.Start(this.GetType()))
{
HttpMockServer.Initialize(this.GetType(), "VisualSearchWithUrl");
IVisualSearchClient client = new VisualSearchClient(new ApiKeyServiceClientCredentials(SubscriptionKey), HttpMockServer.CreateInstance());
ImageInfo ImageInfo = new ImageInfo(url: ImageUrl, cropArea: CropArea);
VisualSearchRequest VisualSearchRequest = new VisualSearchRequest(imageInfo: ImageInfo);
var resp = client.Images.VisualSearchMethodAsync(knowledgeRequest: JsonConvert.SerializeObject(VisualSearchRequest)).Result;
Assert.NotNull(resp);
Assert.NotNull(resp.Tags);
Assert.True(resp.Tags.Count > 0);
var tag = resp.Tags[0];
Assert.NotNull(tag.Actions);
Assert.True(tag.Actions.Count > 0);
var action = tag.Actions[0];
Assert.NotNull(action.ActionType);
}
}
public void VisualSearchWithInsightsToken()
{
using (MockContext context = MockContext.Start(this.GetType().FullName))
{
HttpMockServer.Initialize(this.GetType().FullName, "VisualSearchWithInsightsToken");
IVisualSearchClient client = new VisualSearchClient(new ApiKeyServiceClientCredentials(SubscriptionKey), HttpMockServer.CreateInstance());
ImageInfo ImageInfo = new ImageInfo(imageInsightsToken: ImageInsightsToken, cropArea: CropArea);
Filters Filters = new Filters(site: "www.bing.com");
KnowledgeRequest KnowledgeRequest = new KnowledgeRequest(filters: Filters);
VisualSearchRequest VisualSearchRequest = new VisualSearchRequest(imageInfo: ImageInfo, knowledgeRequest: KnowledgeRequest);
var resp = client.Images.VisualSearchMethodAsync(knowledgeRequest: JsonConvert.SerializeObject(VisualSearchRequest)).Result;
Assert.NotNull(resp);
Assert.NotNull(resp.Tags);
Assert.True(resp.Tags.Count > 0);
var tag = resp.Tags[0];
Assert.NotNull(tag.Actions);
Assert.True(tag.Actions.Count > 0);
var action = tag.Actions[0];
Assert.NotNull(action.ActionType);
}
}
public static VisualSearchRequest BuildKnowledgeRequest(string site, ImageInfo imgInfo)
{
Filters Filters = new Filters(site: site);
KnowledgeRequest KnowledgeRequest = new KnowledgeRequest(filters: Filters);
VisualSearchRequest VisualSearchRequest = new VisualSearchRequest(imageInfo: imgInfo, knowledgeRequest: KnowledgeRequest);
return(VisualSearchRequest);
}
public static void VisualSearchImageBinaryWithCropArea(string subscriptionKey)
{
var client = new VisualSearchAPI(new Microsoft.Azure.CognitiveServices.Search.VisualSearch.ApiKeyServiceClientCredentials(subscriptionKey));
try
{
CropArea CropArea = new CropArea(top: (float)0.01, bottom: (float)0.30, left: (float)0.01, right: (float)0.20);
// The ImageInfo struct specifies the crop area in the image and the URL of the larger image.
string imageURL = "https://docs.microsoft.com/azure/cognitive-services/bing-visual-search/media/ms_srleaders.jpg";
ImageInfo imageInfo = new ImageInfo(cropArea: CropArea, url: imageURL);
VisualSearchRequest visualSearchRequest = new VisualSearchRequest(imageInfo: imageInfo);
var visualSearchResults = client.Images.VisualSearchMethodAsync(knowledgeRequest: visualSearchRequest).Result;
Console.WriteLine("\r\nVisual search request with image from URL and crop area combined in knowledgeRequest");
if (visualSearchResults == null)
{
Console.WriteLine("No visual search result data.");
}
else
{
// List of tags
if (visualSearchResults.Tags.Count > 0)
{
foreach (ImageTag t in visualSearchResults.Tags)
{
foreach (ImageAction i in t.Actions)
{
Console.WriteLine("\r\n" + "ActionType: " + i.ActionType + " -> WebSearchUrl: " + i.WebSearchUrl);
if (i.ActionType == "PagesIncluding")
{
foreach (ImageObject o in (i as ImageModuleAction).Data.Value)
{
Console.WriteLine("ContentURL: " + o.ContentUrl);
}
}
}
}
}
else
{
Console.WriteLine("Couldn't find image tags!");
}
}
}
catch (Exception ex)
{
Console.WriteLine("Encountered exception. " + ex.Message);
}
}
// This method will get Visual Search results from an imageInsightsToken obtained from the return value of the ImageResults method.
// The method includes imageInsightsToken the in a knowledgeRequest parameter, along with a cropArea object.
// It prints out the imageInsightsToken uploaded in the request.
// Finally the example prints URLs of images found using the imageInsightsToken.
public static void VisualSearchInsightsToken(string subscriptionKey, string insightsTok)
{
var client = new VisualSearchAPI(new Microsoft.Azure.CognitiveServices.Search.VisualSearch.ApiKeyServiceClientCredentials(subscriptionKey));
try
{
// The image can be specified via an insights token, in the ImageInfo object.
ImageInfo ImageInfo = new ImageInfo(imageInsightsToken: insightsTok);
// An image binary is not necessary here, as the image is specified by insights token.
VisualSearchRequest VisualSearchRequest = new VisualSearchRequest(ImageInfo);
var visualSearchResults = client.Images.VisualSearchMethodAsync(knowledgeRequest: VisualSearchRequest).Result;
Console.WriteLine("\r\nVisual search request with imageInsightsToken and knowledgeRequest");
if (visualSearchResults == null)
{
Console.WriteLine("No visual search result data.");
}
else
{
// Visual Search results
if (visualSearchResults.Image?.ImageInsightsToken != null)
{
Console.WriteLine($"Uploaded image insights token: {insightsTok}");
}
else
{
Console.WriteLine("Couldn't find image insights token!");
}
if (visualSearchResults.Tags.Count > 0)
{
// List of tags
foreach (ImageTag t in visualSearchResults.Tags)
{
foreach (ImageAction i in t.Actions)
{
Console.WriteLine("\r\n" + "ActionType: " + i.ActionType + " WebSearchURL: " + i.WebSearchUrl);
if (i.ActionType == "PagesIncluding")
{
foreach (ImageObject o in (i as ImageModuleAction).Data.Value)
{
Console.WriteLine("ContentURL: " + o.ContentUrl);
}
}
}
}
}
else
{
Console.WriteLine("Couldn't find image tags!");
}
}
}
catch (Exception ex)
{
Console.WriteLine("Encountered exception. " + ex.Message);
}
}
/// <summary>
/// The Image Visual Search API lets you send an image to Bing and get back a
/// list of relevant tags. Each tag contains potential actions a user might be
/// interested in. This section provides technical details about the request
/// format and headers that you use to request actions and the JSON response
/// objects that contain them. For examples that show how to make requests, see
/// [Searching the Web for
/// Images](https://docs.microsoft.com/azure/cognitive-services/bing-image-search/search-the-web).
/// </summary>
/// <param name='acceptLanguage'>
/// A comma-delimited list of one or more languages to use for user interface
/// strings. The list is in decreasing order of preference. For additional
/// information, including expected format, see
/// [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This
/// header and the
/// [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#setlang)
/// query parameter are mutually exclusive; do not specify both. If you set
/// this header, you must also specify the
/// [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#cc)
/// query parameter. To determine the market to return results for, Bing uses
/// the first supported language it finds from the list and combines it with
/// the cc parameter value. If the list does not include a supported language,
/// Bing finds the closest language and market that supports the request or it
/// uses an aggregated or default market for the results. To determine the
/// market that Bing used, see the BingAPIs-Market header. Use this header and
/// the cc query parameter only if you specify multiple languages. Otherwise,
/// use the
/// [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#mkt)
/// and
/// [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#setlang)
/// query parameters. A user interface string is a string that's used as a
/// label in a user interface. There are few user interface strings in the JSON
/// response objects. Any links to Bing.com properties in the response objects
/// apply the specified language.
/// </param>
/// <param name='contentType'>
/// Optional request header. If you set the
/// [modules](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#modulesrequested)
/// query parameter to RecognizedEntities, you may specify the binary of an
/// image in the body of a POST request. If you specify the image in the body
/// of a POST request, you must specify this header and set its value to
/// multipart/form-data. The maximum image size is 1 MB.
/// </param>
/// <param name='userAgent'>
/// The user agent originating the request. Bing uses the user agent to provide
/// mobile users with an optimized experience. Although optional, you are
/// encouraged to always specify this header. The user-agent should be the same
/// string that any commonly used browser sends. For information about user
/// agents, see [RFC
/// 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The
/// following are examples of user-agent strings. Windows Phone: Mozilla/5.0
/// (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM;
/// Touch; 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;
/// CPU iPhone OS 6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko)
/// Mobile / 10B142 iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0
/// (Windows NT 6.3; WOW64; Trident / 7.0; Touch; rv:11.0) like Gecko. iPad:
/// Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1
/// (KHTML, like Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53
/// </param>
/// <param name='clientId'>
/// Bing uses this header to provide users with consistent behavior across Bing
/// API calls. Bing often flights new features and improvements, and it uses
/// the client ID as a key for assigning traffic on different flights. If you
/// do not use the same client ID for a user across multiple requests, then
/// Bing may assign the user to multiple conflicting flights. Being assigned to
/// multiple conflicting flights can lead to an inconsistent user experience.
/// For example, if the second request has a different flight assignment than
/// the first, the experience may be unexpected. Also, Bing can use the client
/// ID to tailor web results to that client ID’s search history, providing a
/// richer experience for the user. Bing also uses this header to help improve
/// result rankings by analyzing the activity generated by a client ID. The
/// relevance improvements help with better quality of results delivered by
/// Bing APIs and in turn enables higher click-through rates for the API
/// consumer. IMPORTANT: Although optional, you should consider this header
/// required. Persisting the client ID across multiple requests for the same
/// end user and device combination enables 1) the API consumer to receive a
/// consistent user experience, and 2) higher click-through rates via better
/// quality of results from the Bing APIs. Each user that uses your application
/// on the device must have a unique, Bing generated client ID. If you do not
/// include this header in the request, Bing generates an ID and returns it in
/// the X-MSEdge-ClientID response header. The only time that you should NOT
/// include this header in a request is the first time the user uses your app
/// on that device. Use the client ID for each Bing API request that your app
/// makes for this user on the device. Persist the client ID. To persist the ID
/// in a browser app, use a persistent HTTP cookie to ensure the ID is used
/// across all sessions. Do not use a session cookie. For other apps such as
/// mobile apps, use the device's persistent storage to persist the ID. The
/// next time the user uses your app on that device, get the client ID that you
/// persisted. Bing responses may or may not include this header. If the
/// response includes this header, capture the client ID and use it for all
/// subsequent Bing requests for the user on that device. If you include the
/// X-MSEdge-ClientID, you must not include cookies in the request.
/// </param>
/// <param name='clientIp'>
/// The IPv4 or IPv6 address of the client device. The IP address is used to
/// discover the user's location. Bing uses the location information to
/// determine safe search behavior. Although optional, you are encouraged to
/// always specify this header and the X-Search-Location header. Do not
/// obfuscate the address (for example, by changing the last octet to 0).
/// Obfuscating the address results in the location not being anywhere near the
/// device's actual location, which may result in Bing serving erroneous
/// results.
/// </param>
/// <param name='location'>
/// A semicolon-delimited list of key/value pairs that describe the client's
/// geographical location. Bing uses the location information to determine safe
/// search behavior and to return relevant local content. Specify the key/value
/// pair as <key>:<value>. The following are the keys that you use
/// to specify the user's location. lat (required): The latitude of the
/// client's location, in degrees. The latitude must be greater than or equal
/// to -90.0 and less than or equal to +90.0. Negative values indicate southern
/// latitudes and positive values indicate northern latitudes. long (required):
/// The longitude of the client's location, in degrees. The longitude must be
/// greater than or equal to -180.0 and less than or equal to +180.0. Negative
/// values indicate western longitudes and positive values indicate eastern
/// longitudes. re (required): The radius, in meters, which specifies the
/// horizontal accuracy of the coordinates. Pass the value returned by the
/// device's location service. Typical values might be 22m for GPS/Wi-Fi, 380m
/// for cell tower triangulation, and 18,000m for reverse IP lookup. ts
/// (optional): The UTC UNIX timestamp of when the client was at the location.
/// (The UNIX timestamp is the number of seconds since January 1, 1970.) head
/// (optional): The client's relative heading or direction of travel. Specify
/// the direction of travel as degrees from 0 through 360, counting clockwise
/// relative to true north. Specify this key only if the sp key is nonzero. sp
/// (optional): The horizontal velocity (speed), in meters per second, that the
/// client device is traveling. alt (optional): The altitude of the client
/// device, in meters. are (optional): The radius, in meters, that specifies
/// the vertical accuracy of the coordinates. Specify this key only if you
/// specify the alt key. Although many of the keys are optional, the more
/// information that you provide, the more accurate the location results are.
/// Although optional, you are encouraged to always specify the user's
/// geographical location. Providing the location is especially important if
/// the client's IP address does not accurately reflect the user's physical
/// location (for example, if the client uses VPN). For optimal results, you
/// should include this header and the X-MSEdge-ClientIP header, but at a
/// minimum, you should include this header.
/// </param>
/// <param name='market'>
/// The market where the results come from. Typically, mkt is the country where
/// the user is making the request from. However, it could be a different
/// country if the user is not located in a country where Bing delivers
/// results. The market must be in the form <language code>-<country
/// code>. For example, en-US. The string is case insensitive. For a list of
/// possible market values, see [Market
/// Codes](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-visual-search/supported-countries-markets).
/// NOTE: If known, you are encouraged to always specify the market. Specifying
/// the market helps Bing route the request and return an appropriate and
/// optimal response. If you specify a market that is not listed in [Market
/// Codes](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-visual-search/supported-countries-markets),
/// Bing uses a best fit market code based on an internal mapping that is
/// subject to change.
/// </param>
/// <param name='safeSearch'>
/// Filter the image results in actions with type 'VisualSearch' for adult
/// content. The following are the possible filter values. Off: May return
/// images with adult content. Moderate: Do not return images with adult
/// content. Strict: Do not return images with adult content. The default is
/// Moderate. If the request comes from a market that Bing's adult policy
/// requires that safeSearch is set to Strict, Bing ignores the safeSearch
/// value and uses Strict. If you use the site: filter in the knowledge
/// request, there is the chance that the response may contain adult content
/// regardless of what the safeSearch query parameter is set to. Use site: only
/// if you are aware of the content on the site and your scenario supports the
/// possibility of adult content. Possible values include: 'Off', 'Moderate',
/// 'Strict'
/// </param>
/// <param name='setLang'>
/// The language to use for user interface strings. Specify the language using
/// the ISO 639-1 2-letter language code. For example, the language code for
/// English is EN. The default is EN (English). Although optional, you should
/// always specify the language. Typically, you set setLang to the same
/// language specified by mkt unless the user wants the user interface strings
/// displayed in a different language. A user interface string is a string
/// that's used as a label in a user interface. There are few user interface
/// strings in the JSON response objects. Also, any links to Bing.com
/// properties in the response objects apply the specified language.
/// </param>
/// <param name='knowledgeRequest'>
/// A JSON object containing information about the image. The image and
/// imageInsightsToken fields are mutually exclusive – the body of the request
/// must include only one of them.
/// </param>
/// <param name='image'>
/// The uploaded image file. The size of the image is limited to 1 MB and the
/// file name must be "image". The image and imageInsightsToken fields are
/// mutually exclusive – the body of the request must include only one of them.
/// </param>
/// <param name='customHeaders'>
/// Headers that will be added to request.
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
/// <exception cref="ErrorResponseException">
/// Thrown when the operation returned an invalid status code
/// </exception>
/// <exception cref="SerializationException">
/// Thrown when unable to deserialize the response
/// </exception>
/// <return>
/// A response object containing the response body and response headers.
/// </return>
public async Task <HttpOperationResponse <ImageKnowledge> > VisualSearchMethodWithHttpMessagesAsync(string acceptLanguage = default(string), string contentType = default(string), string userAgent = default(string), string clientId = default(string), string clientIp = default(string), string location = default(string), string market = default(string), string safeSearch = default(string), string setLang = default(string), VisualSearchRequest knowledgeRequest = default(VisualSearchRequest), Stream image = default(Stream), Dictionary <string, List <string> > customHeaders = null, CancellationToken cancellationToken = default(CancellationToken))
{
return(await VisualSearchMethodWithHttpMessagesAsync(acceptLanguage, contentType, userAgent, clientId, clientIp, location, market, safeSearch, setLang, JsonConvert.SerializeObject(knowledgeRequest), image, customHeaders, cancellationToken).ConfigureAwait(false));
}
public static void VisualSearchImageBinaryWithCropArea(string subscriptionKey)
{
var client = new VisualSearchAPI(new ApiKeyServiceClientCredentials(subscriptionKey));
try
{
using (FileStream stream = new FileStream(Path.Combine("TestImages", "image.jpg"), FileMode.Open))
{
// The ImageInfo struct contains a crop area specifying a region to crop in the uploaded image
CropArea CropArea = new CropArea(top: (float)0.1, bottom: (float)0.5, left: (float)0.1, right: (float)0.9);
ImageInfo ImageInfo = new ImageInfo(cropArea: CropArea);
VisualSearchRequest VisualSearchRequest = new VisualSearchRequest(imageInfo: ImageInfo);
// The knowledgeRequest here holds additional information about the image, which is passed in in binary form
var visualSearchResults = client.Images.VisualSearchMethodAsync(image: stream, knowledgeRequest: VisualSearchRequest).Result;
Console.WriteLine("Search visual search request with binary of dog image");
if (visualSearchResults == null)
{
Console.WriteLine("No visual search result data.");
}
else
{
// Visual Search results
if (visualSearchResults.Image?.ImageInsightsToken != null)
{
Console.WriteLine($"Uploaded image insights token: {visualSearchResults.Image.ImageInsightsToken}");
}
else
{
Console.WriteLine("Couldn't find image insights token!");
}
// List of tags
if (visualSearchResults.Tags.Count > 0)
{
var firstTagResult = visualSearchResults.Tags.First();
Console.WriteLine($"Visual search tag count: {visualSearchResults.Tags.Count}");
// List of actions in first tag
if (firstTagResult.Actions.Count > 0)
{
var firstActionResult = firstTagResult.Actions.First();
Console.WriteLine($"First tag action count: {firstTagResult.Actions.Count}");
Console.WriteLine($"First tag action type: {firstActionResult.ActionType}");
}
else
{
Console.WriteLine("Couldn't find tag actions!");
}
}
else
{
Console.WriteLine("Couldn't find image tags!");
}
}
}
}
catch (Exception ex)
{
Console.WriteLine("Encountered exception. " + ex.Message);
}
}
public static void VisualSearchInsightsTokenWithCropArea(string subscriptionKey)
{
var client = new VisualSearchAPI(new ApiKeyServiceClientCredentials(subscriptionKey));
try
{
// The image can be specified via an insights token, in the ImageInfo object
var ImageInsightsToken = "bcid_113F29C079F18F385732D8046EC80145*ccid_oV/QcH95*mid_687689FAFA449B35BC11A1AE6CEAB6F9A9B53708*thid_R.113F29C079F18F385732D8046EC80145";
// An optional crop area can be passed in to define a region of interest in the image
CropArea CropArea = new CropArea(top: (float)0.1, bottom: (float)0.5, left: (float)0.1, right: (float)0.9);
ImageInfo ImageInfo = new ImageInfo(imageInsightsToken: ImageInsightsToken, cropArea: CropArea);
// An image binary is not necessary here, as the image is specified via insights token
VisualSearchRequest VisualSearchRequest = new VisualSearchRequest(imageInfo: ImageInfo);
var visualSearchResults = client.Images.VisualSearchMethodAsync(knowledgeRequest: VisualSearchRequest).Result;
Console.WriteLine("Search visual search request with url of dog image");
if (visualSearchResults == null)
{
Console.WriteLine("No visual search result data.");
}
else
{
// Visual Search results
if (visualSearchResults.Image?.ImageInsightsToken != null)
{
Console.WriteLine($"Uploaded image insights token: {visualSearchResults.Image.ImageInsightsToken}");
}
else
{
Console.WriteLine("Couldn't find image insights token!");
}
// List of tags
if (visualSearchResults.Tags.Count > 0)
{
var firstTagResult = visualSearchResults.Tags.First();
Console.WriteLine($"Visual search tag count: {visualSearchResults.Tags.Count}");
// List of actions in first tag
if (firstTagResult.Actions.Count > 0)
{
var firstActionResult = firstTagResult.Actions.First();
Console.WriteLine($"First tag action count: {firstTagResult.Actions.Count}");
Console.WriteLine($"First tag action type: {firstActionResult.ActionType}");
}
else
{
Console.WriteLine("Couldn't find tag actions!");
}
}
else
{
Console.WriteLine("Couldn't find image tags!");
}
}
}
catch (Exception ex)
{
Console.WriteLine("Encountered exception. " + ex.Message);
}
}
public static void VisualSearchUrlWithFilters(string subscriptionKey)
{
var client = new VisualSearchAPI(new ApiKeyServiceClientCredentials(subscriptionKey));
try
{
// The image can be specified via URL, in the ImageInfo object
var ImageUrl = "https://images.unsplash.com/photo-1512546148165-e50d714a565a?w=600&q=80";
ImageInfo ImageInfo = new ImageInfo(url: ImageUrl);
// Optional filters inside the knowledgeRequest will restrict similar products and images to certain domains
Filters Filters = new Filters(site: "www.bing.com");
KnowledgeRequest KnowledgeRequest = new KnowledgeRequest(filters: Filters);
// An image binary is not necessary here, as the image is specified via URL
VisualSearchRequest VisualSearchRequest = new VisualSearchRequest(imageInfo: ImageInfo, knowledgeRequest: KnowledgeRequest);
var visualSearchResults = client.Images.VisualSearchMethodAsync(knowledgeRequest: VisualSearchRequest).Result;
Console.WriteLine("Search visual search request with url of dog image");
if (visualSearchResults == null)
{
Console.WriteLine("No visual search result data.");
}
else
{
// Visual Search results
if (visualSearchResults.Image?.ImageInsightsToken != null)
{
Console.WriteLine($"Uploaded image insights token: {visualSearchResults.Image.ImageInsightsToken}");
}
else
{
Console.WriteLine("Couldn't find image insights token!");
}
// List of tags
if (visualSearchResults.Tags.Count > 0)
{
var firstTagResult = visualSearchResults.Tags.First();
Console.WriteLine($"Visual search tag count: {visualSearchResults.Tags.Count}");
// List of actions in first tag
if (firstTagResult.Actions.Count > 0)
{
var firstActionResult = firstTagResult.Actions.First();
Console.WriteLine($"First tag action count: {firstTagResult.Actions.Count}");
Console.WriteLine($"First tag action type: {firstActionResult.ActionType}");
}
else
{
Console.WriteLine("Couldn't find tag actions!");
}
}
else
{
Console.WriteLine("Couldn't find image tags!");
}
}
}
catch (Exception ex)
{
Console.WriteLine("Encountered exception. " + ex.Message);
}
}
/// <summary>
/// The Image Visual Search API lets you send an image to Bing and get back a
/// list of relevant tags. Each tag contains potential actions a user might be
/// interested in. This section provides technical details about the request
/// format and headers that you use to request actions and the JSON response
/// objects that contain them. For examples that show how to make requests, see
/// [Searching the Web for
/// Images](https://docs.microsoft.com/azure/cognitive-services/bing-image-search/search-the-web).
/// </summary>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='acceptLanguage'>
/// A comma-delimited list of one or more languages to use for user interface
/// strings. The list is in decreasing order of preference. For additional
/// information, including expected format, see
/// [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This
/// header and the
/// [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#setlang)
/// query parameter are mutually exclusive; do not specify both. If you set
/// this header, you must also specify the
/// [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#cc)
/// query parameter. To determine the market to return results for, Bing uses
/// the first supported language it finds from the list and combines it with
/// the cc parameter value. If the list does not include a supported language,
/// Bing finds the closest language and market that supports the request or it
/// uses an aggregated or default market for the results. To determine the
/// market that Bing used, see the BingAPIs-Market header. Use this header and
/// the cc query parameter only if you specify multiple languages. Otherwise,
/// use the
/// [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#mkt)
/// and
/// [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#setlang)
/// query parameters. A user interface string is a string that's used as a
/// label in a user interface. There are few user interface strings in the JSON
/// response objects. Any links to Bing.com properties in the response objects
/// apply the specified language.
/// </param>
/// <param name='contentType'>
/// Optional request header. If you set the
/// [modules](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#modulesrequested)
/// query parameter to RecognizedEntities, you may specify the binary of an
/// image in the body of a POST request. If you specify the image in the body
/// of a POST request, you must specify this header and set its value to
/// multipart/form-data. The maximum image size is 1 MB.
/// </param>
/// <param name='userAgent'>
/// The user agent originating the request. Bing uses the user agent to provide
/// mobile users with an optimized experience. Although optional, you are
/// encouraged to always specify this header. The user-agent should be the same
/// string that any commonly used browser sends. For information about user
/// agents, see [RFC
/// 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The
/// following are examples of user-agent strings. Windows Phone: Mozilla/5.0
/// (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM;
/// Touch; 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;
/// CPU iPhone OS 6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko)
/// Mobile / 10B142 iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0
/// (Windows NT 6.3; WOW64; Trident / 7.0; Touch; rv:11.0) like Gecko. iPad:
/// Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1
/// (KHTML, like Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53
/// </param>
/// <param name='clientId'>
/// Bing uses this header to provide users with consistent behavior across Bing
/// API calls. Bing often flights new features and improvements, and it uses
/// the client ID as a key for assigning traffic on different flights. If you
/// do not use the same client ID for a user across multiple requests, then
/// Bing may assign the user to multiple conflicting flights. Being assigned to
/// multiple conflicting flights can lead to an inconsistent user experience.
/// For example, if the second request has a different flight assignment than
/// the first, the experience may be unexpected. Also, Bing can use the client
/// ID to tailor web results to that client ID’s search history, providing a
/// richer experience for the user. Bing also uses this header to help improve
/// result rankings by analyzing the activity generated by a client ID. The
/// relevance improvements help with better quality of results delivered by
/// Bing APIs and in turn enables higher click-through rates for the API
/// consumer. IMPORTANT: Although optional, you should consider this header
/// required. Persisting the client ID across multiple requests for the same
/// end user and device combination enables 1) the API consumer to receive a
/// consistent user experience, and 2) higher click-through rates via better
/// quality of results from the Bing APIs. Each user that uses your application
/// on the device must have a unique, Bing generated client ID. If you do not
/// include this header in the request, Bing generates an ID and returns it in
/// the X-MSEdge-ClientID response header. The only time that you should NOT
/// include this header in a request is the first time the user uses your app
/// on that device. Use the client ID for each Bing API request that your app
/// makes for this user on the device. Persist the client ID. To persist the ID
/// in a browser app, use a persistent HTTP cookie to ensure the ID is used
/// across all sessions. Do not use a session cookie. For other apps such as
/// mobile apps, use the device's persistent storage to persist the ID. The
/// next time the user uses your app on that device, get the client ID that you
/// persisted. Bing responses may or may not include this header. If the
/// response includes this header, capture the client ID and use it for all
/// subsequent Bing requests for the user on that device. If you include the
/// X-MSEdge-ClientID, you must not include cookies in the request.
/// </param>
/// <param name='clientIp'>
/// The IPv4 or IPv6 address of the client device. The IP address is used to
/// discover the user's location. Bing uses the location information to
/// determine safe search behavior. Although optional, you are encouraged to
/// always specify this header and the X-Search-Location header. Do not
/// obfuscate the address (for example, by changing the last octet to 0).
/// Obfuscating the address results in the location not being anywhere near the
/// device's actual location, which may result in Bing serving erroneous
/// results.
/// </param>
/// <param name='location'>
/// A semicolon-delimited list of key/value pairs that describe the client's
/// geographical location. Bing uses the location information to determine safe
/// search behavior and to return relevant local content. Specify the key/value
/// pair as <key>:<value>. The following are the keys that you use
/// to specify the user's location. lat (required): The latitude of the
/// client's location, in degrees. The latitude must be greater than or equal
/// to -90.0 and less than or equal to +90.0. Negative values indicate southern
/// latitudes and positive values indicate northern latitudes. long (required):
/// The longitude of the client's location, in degrees. The longitude must be
/// greater than or equal to -180.0 and less than or equal to +180.0. Negative
/// values indicate western longitudes and positive values indicate eastern
/// longitudes. re (required): The radius, in meters, which specifies the
/// horizontal accuracy of the coordinates. Pass the value returned by the
/// device's location service. Typical values might be 22m for GPS/Wi-Fi, 380m
/// for cell tower triangulation, and 18,000m for reverse IP lookup. ts
/// (optional): The UTC UNIX timestamp of when the client was at the location.
/// (The UNIX timestamp is the number of seconds since January 1, 1970.) head
/// (optional): The client's relative heading or direction of travel. Specify
/// the direction of travel as degrees from 0 through 360, counting clockwise
/// relative to true north. Specify this key only if the sp key is nonzero. sp
/// (optional): The horizontal velocity (speed), in meters per second, that the
/// client device is traveling. alt (optional): The altitude of the client
/// device, in meters. are (optional): The radius, in meters, that specifies
/// the vertical accuracy of the coordinates. Specify this key only if you
/// specify the alt key. Although many of the keys are optional, the more
/// information that you provide, the more accurate the location results are.
/// Although optional, you are encouraged to always specify the user's
/// geographical location. Providing the location is especially important if
/// the client's IP address does not accurately reflect the user's physical
/// location (for example, if the client uses VPN). For optimal results, you
/// should include this header and the X-MSEdge-ClientIP header, but at a
/// minimum, you should include this header.
/// </param>
/// <param name='market'>
/// The market where the results come from. Typically, mkt is the country where
/// the user is making the request from. However, it could be a different
/// country if the user is not located in a country where Bing delivers
/// results. The market must be in the form <language code>-<country
/// code>. For example, en-US. The string is case insensitive. For a list of
/// possible market values, see [Market
/// Codes](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-visual-search/supported-countries-markets).
/// NOTE: If known, you are encouraged to always specify the market. Specifying
/// the market helps Bing route the request and return an appropriate and
/// optimal response. If you specify a market that is not listed in [Market
/// Codes](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-visual-search/supported-countries-markets),
/// Bing uses a best fit market code based on an internal mapping that is
/// subject to change.
/// </param>
/// <param name='safeSearch'>
/// Filter the image results in actions with type 'VisualSearch' for adult
/// content. The following are the possible filter values. Off: May return
/// images with adult content. Moderate: Do not return images with adult
/// content. Strict: Do not return images with adult content. The default is
/// Moderate. If the request comes from a market that Bing's adult policy
/// requires that safeSearch is set to Strict, Bing ignores the safeSearch
/// value and uses Strict. If you use the site: filter in the knowledge
/// request, there is the chance that the response may contain adult content
/// regardless of what the safeSearch query parameter is set to. Use site: only
/// if you are aware of the content on the site and your scenario supports the
/// possibility of adult content. Possible values include: 'Off', 'Moderate',
/// 'Strict'
/// </param>
/// <param name='setLang'>
/// The language to use for user interface strings. Specify the language using
/// the ISO 639-1 2-letter language code. For example, the language code for
/// English is EN. The default is EN (English). Although optional, you should
/// always specify the language. Typically, you set setLang to the same
/// language specified by mkt unless the user wants the user interface strings
/// displayed in a different language. A user interface string is a string
/// that's used as a label in a user interface. There are few user interface
/// strings in the JSON response objects. Also, any links to Bing.com
/// properties in the response objects apply the specified language.
/// </param>
/// <param name='knowledgeRequest'>
/// A JSON object containing information about the image. The image and
/// imageInsightsToken fields are mutually exclusive – the body of the request
/// must include only one of them.
/// </param>
/// <param name='image'>
/// The uploaded image file. The size of the image is limited to 1 MB and the
/// file name must be "image". The image and imageInsightsToken fields are
/// mutually exclusive – the body of the request must include only one of them.
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
public static async Task <ImageKnowledge> VisualSearchMethodAsync(this IImages operations, string acceptLanguage = default(string), string contentType = default(string), string userAgent = default(string), string clientId = default(string), string clientIp = default(string), string location = default(string), string market = default(string), string safeSearch = default(string), string setLang = default(string), VisualSearchRequest knowledgeRequest = default(VisualSearchRequest), Stream image = default(Stream), CancellationToken cancellationToken = default(CancellationToken))
{
using (var _result = await operations.VisualSearchMethodWithHttpMessagesAsync(acceptLanguage, contentType, userAgent, clientId, clientIp, location, market, safeSearch, setLang, knowledgeRequest, image, null, cancellationToken).ConfigureAwait(false))
{
return(_result.Body);
}
}
