azure_cognitiveservices_visualsearch 0.17.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e15ef480b7df619f6dea70096bf49c65ff649c5d
+  data.tar.gz: 537bddaa25a50e08bcb2ba5158b950a198246a8e
+SHA512:
+  metadata.gz: 5251ba3d12a9ea50fb3c3955f4f14954027461256efa006336782a1b6594ca7917eda2818b1919edf800d92923b0341f0afe7243a5ac5ceb29e15c3cd0ed1ef8
+  data.tar.gz: bb7fa0a09f5327bd5f93b51376e668d583402b5e6353d79b02b66569628947626cf6be030ad491c5324fd9b362fde44a06015d43ed7c0841f02ced6439d0228c

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Microsoft Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/1.0/generated/azure_cognitiveservices_visualsearch.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+require 'uri'
+require 'cgi'
+require 'date'
+require 'json'
+require 'base64'
+require 'erb'
+require 'securerandom'
+require 'time'
+require 'timeliness'
+require 'faraday'
+require 'faraday-cookie_jar'
+require 'concurrent'
+require 'ms_rest'
+require '1.0/generated/azure_cognitiveservices_visualsearch/module_definition'
+require 'ms_rest_azure'
+
+module Azure::CognitiveServices::VisualSearch::V1_0
+  autoload :Images,                                             '1.0/generated/azure_cognitiveservices_visualsearch/images.rb'
+  autoload :VisualSearchClient,                                 '1.0/generated/azure_cognitiveservices_visualsearch/visual_search_client.rb'
+
+  module Models
+    autoload :Error,                                              '1.0/generated/azure_cognitiveservices_visualsearch/models/error.rb'
+    autoload :CropArea,                                           '1.0/generated/azure_cognitiveservices_visualsearch/models/crop_area.rb'
+    autoload :ImageInfo,                                          '1.0/generated/azure_cognitiveservices_visualsearch/models/image_info.rb'
+    autoload :ImageTagRegion,                                     '1.0/generated/azure_cognitiveservices_visualsearch/models/image_tag_region.rb'
+    autoload :ImagesImageMetadata,                                '1.0/generated/azure_cognitiveservices_visualsearch/models/images_image_metadata.rb'
+    autoload :RelatedSearchesModule,                              '1.0/generated/azure_cognitiveservices_visualsearch/models/related_searches_module.rb'
+    autoload :Filters,                                            '1.0/generated/azure_cognitiveservices_visualsearch/models/filters.rb'
+    autoload :ImagesModule,                                       '1.0/generated/azure_cognitiveservices_visualsearch/models/images_module.rb'
+    autoload :KnowledgeRequest,                                   '1.0/generated/azure_cognitiveservices_visualsearch/models/knowledge_request.rb'
+    autoload :RecipesModule,                                      '1.0/generated/azure_cognitiveservices_visualsearch/models/recipes_module.rb'
+    autoload :ResponseBase,                                       '1.0/generated/azure_cognitiveservices_visualsearch/models/response_base.rb'
+    autoload :Query,                                              '1.0/generated/azure_cognitiveservices_visualsearch/models/query.rb'
+    autoload :VisualSearchRequest,                                '1.0/generated/azure_cognitiveservices_visualsearch/models/visual_search_request.rb'
+    autoload :PropertiesItem,                                     '1.0/generated/azure_cognitiveservices_visualsearch/models/properties_item.rb'
+    autoload :Point2D,                                            '1.0/generated/azure_cognitiveservices_visualsearch/models/point2d.rb'
+    autoload :NormalizedQuadrilateral,                            '1.0/generated/azure_cognitiveservices_visualsearch/models/normalized_quadrilateral.rb'
+    autoload :ImageAction,                                        '1.0/generated/azure_cognitiveservices_visualsearch/models/image_action.rb'
+    autoload :ImageTag,                                           '1.0/generated/azure_cognitiveservices_visualsearch/models/image_tag.rb'
+    autoload :Organization,                                       '1.0/generated/azure_cognitiveservices_visualsearch/models/organization.rb'
+    autoload :AggregateRating,                                    '1.0/generated/azure_cognitiveservices_visualsearch/models/aggregate_rating.rb'
+    autoload :Offer,                                              '1.0/generated/azure_cognitiveservices_visualsearch/models/offer.rb'
+    autoload :AggregateOffer,                                     '1.0/generated/azure_cognitiveservices_visualsearch/models/aggregate_offer.rb'
+    autoload :ImageObject,                                        '1.0/generated/azure_cognitiveservices_visualsearch/models/image_object.rb'
+    autoload :Identifiable,                                       '1.0/generated/azure_cognitiveservices_visualsearch/models/identifiable.rb'
+    autoload :Response,                                           '1.0/generated/azure_cognitiveservices_visualsearch/models/response.rb'
+    autoload :ImageKnowledge,                                     '1.0/generated/azure_cognitiveservices_visualsearch/models/image_knowledge.rb'
+    autoload :ErrorResponse,                                      '1.0/generated/azure_cognitiveservices_visualsearch/models/error_response.rb'
+    autoload :Thing,                                              '1.0/generated/azure_cognitiveservices_visualsearch/models/thing.rb'
+    autoload :CreativeWork,                                       '1.0/generated/azure_cognitiveservices_visualsearch/models/creative_work.rb'
+    autoload :Action,                                             '1.0/generated/azure_cognitiveservices_visualsearch/models/action.rb'
+    autoload :MediaObject,                                        '1.0/generated/azure_cognitiveservices_visualsearch/models/media_object.rb'
+    autoload :Person,                                             '1.0/generated/azure_cognitiveservices_visualsearch/models/person.rb'
+    autoload :Intangible,                                         '1.0/generated/azure_cognitiveservices_visualsearch/models/intangible.rb'
+    autoload :ImageEntityAction,                                  '1.0/generated/azure_cognitiveservices_visualsearch/models/image_entity_action.rb'
+    autoload :ImageModuleAction,                                  '1.0/generated/azure_cognitiveservices_visualsearch/models/image_module_action.rb'
+    autoload :Recipe,                                             '1.0/generated/azure_cognitiveservices_visualsearch/models/recipe.rb'
+    autoload :ImageRecipesAction,                                 '1.0/generated/azure_cognitiveservices_visualsearch/models/image_recipes_action.rb'
+    autoload :ImageRelatedSearchesAction,                         '1.0/generated/azure_cognitiveservices_visualsearch/models/image_related_searches_action.rb'
+    autoload :ImageShoppingSourcesAction,                         '1.0/generated/azure_cognitiveservices_visualsearch/models/image_shopping_sources_action.rb'
+    autoload :StructuredValue,                                    '1.0/generated/azure_cognitiveservices_visualsearch/models/structured_value.rb'
+    autoload :Rating,                                             '1.0/generated/azure_cognitiveservices_visualsearch/models/rating.rb'
+    autoload :Currency,                                           '1.0/generated/azure_cognitiveservices_visualsearch/models/currency.rb'
+    autoload :ItemAvailability,                                   '1.0/generated/azure_cognitiveservices_visualsearch/models/item_availability.rb'
+    autoload :ErrorCode,                                          '1.0/generated/azure_cognitiveservices_visualsearch/models/error_code.rb'
+    autoload :ErrorSubCode,                                       '1.0/generated/azure_cognitiveservices_visualsearch/models/error_sub_code.rb'
+    autoload :SafeSearch,                                         '1.0/generated/azure_cognitiveservices_visualsearch/models/safe_search.rb'
+    autoload :ContentTypes,                                       '1.0/generated/azure_cognitiveservices_visualsearch/models/content_types.rb'
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_visualsearch/images.rb

@@ -0,0 +1,639 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::VisualSearch::V1_0
+  #
+  # Visual Search API lets you discover insights about an image such as
+  # visually similar images, shopping sources, and related searches. The API
+  # can also perform text recognition, identify entities (people, places,
+  # things), return other topical content for the user to explore, and more.
+  # For more information, see [Visual Search
+  # Overview](https://docs.microsoft.com/azure/cognitive-services/bing-visual-search/overview).
+  #
+  class Images
+    include MsRestAzure
+
+    #
+    # Creates and initializes a new instance of the Images class.
+    # @param client service class for accessing basic functionality.
+    #
+    def initialize(client)
+      @client = client
+    end
+
+    # @return [VisualSearchClient] reference to the VisualSearchClient
+    attr_reader :client
+
+    #
+    # Visual Search API lets you discover insights about an image such as visually
+    # similar images, shopping sources, and related searches. The API can also
+    # perform text recognition, identify entities (people, places, things), return
+    # other topical content for the user to explore, and more. For more
+    # information, see [Visual Search
+    # Overview](https://docs.microsoft.com/azure/cognitive-services/bing-visual-search/overview).
+    #
+    # @param content_type [Enum] Must be set to multipart/form-data and include a
+    # boundary parameter (for example, multipart/form-data; boundary=<boundary
+    # string>). For more details, see [Content form types](
+    # https://docs.microsoft.com/en-us/azure/cognitive-services/bing-visual-search/overview#content-form-types).
+    # Possible values include: 'multipart/form-data', 'application/json',
+    # 'text/json', 'application/xml', 'text/xml',
+    # 'application/x-www-form-urlencoded'
+    # @param accept_language [String] 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-visual-search-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-visual-search-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-visual-search-api-v7-reference#mkt)
+    # and
+    # [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-visual-search-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 user_agent [String] 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 client_id [String] 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. ATTENTION: You must ensure that
+    # this Client ID is not linkable to any authenticatable user account
+    # information. If you include the X-MSEdge-ClientID, you must not include
+    # cookies in the request.
+    # @param client_ip [String] 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 location [String] 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 market [String] 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 safe_search [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 set_lang [String] 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 visual_search_request [String] The form data is a JSON object that
+    # identifies the image using an insights token or URL to the image. The object
+    # may also include an optional crop area that identifies an area of interest in
+    # the image. The insights token and URL are mutually exclusive – do not specify
+    # both. You may specify knowledgeRequest form data and image form data in the
+    # same request only if knowledgeRequest form data specifies the cropArea field
+    # only (it must not include an insights token or URL).
+    # @param image The form data is an image binary. The Content-Disposition
+    # header's name parameter must be set to "image". You must specify an image
+    # binary if you do not use knowledgeRequest form data to specify the image; you
+    # may not use both forms to specify an image. You may specify knowledgeRequest
+    # form data and image form data in the same request only if knowledgeRequest
+    # form data specifies the cropArea field only  (it must not include an insights
+    # token or URL).
+    # @param custom_headers [Hash{String => String}] A hash of custom headers that
+    # will be added to the HTTP request.
+    #
+    # @return [ImageKnowledge] operation results.
+    #
+    def visual_search(content_type, accept_language:nil, user_agent:nil, client_id:nil, client_ip:nil, location:nil, market:nil, safe_search:nil, set_lang:nil, visual_search_request:nil, image:nil, custom_headers:nil)
+      response = visual_search_async(content_type, accept_language:accept_language, user_agent:user_agent, client_id:client_id, client_ip:client_ip, location:location, market:market, safe_search:safe_search, set_lang:set_lang, visual_search_request:visual_search_request, image:image, custom_headers:custom_headers).value!
+      response.body unless response.nil?
+    end
+
+    #
+    # Visual Search API lets you discover insights about an image such as visually
+    # similar images, shopping sources, and related searches. The API can also
+    # perform text recognition, identify entities (people, places, things), return
+    # other topical content for the user to explore, and more. For more
+    # information, see [Visual Search
+    # Overview](https://docs.microsoft.com/azure/cognitive-services/bing-visual-search/overview).
+    #
+    # @param content_type [Enum] Must be set to multipart/form-data and include a
+    # boundary parameter (for example, multipart/form-data; boundary=<boundary
+    # string>). For more details, see [Content form types](
+    # https://docs.microsoft.com/en-us/azure/cognitive-services/bing-visual-search/overview#content-form-types).
+    # Possible values include: 'multipart/form-data', 'application/json',
+    # 'text/json', 'application/xml', 'text/xml',
+    # 'application/x-www-form-urlencoded'
+    # @param accept_language [String] 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-visual-search-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-visual-search-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-visual-search-api-v7-reference#mkt)
+    # and
+    # [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-visual-search-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 user_agent [String] 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 client_id [String] 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. ATTENTION: You must ensure that
+    # this Client ID is not linkable to any authenticatable user account
+    # information. If you include the X-MSEdge-ClientID, you must not include
+    # cookies in the request.
+    # @param client_ip [String] 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 location [String] 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 market [String] 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 safe_search [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 set_lang [String] 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 visual_search_request [String] The form data is a JSON object that
+    # identifies the image using an insights token or URL to the image. The object
+    # may also include an optional crop area that identifies an area of interest in
+    # the image. The insights token and URL are mutually exclusive – do not specify
+    # both. You may specify knowledgeRequest form data and image form data in the
+    # same request only if knowledgeRequest form data specifies the cropArea field
+    # only (it must not include an insights token or URL).
+    # @param image The form data is an image binary. The Content-Disposition
+    # header's name parameter must be set to "image". You must specify an image
+    # binary if you do not use knowledgeRequest form data to specify the image; you
+    # may not use both forms to specify an image. You may specify knowledgeRequest
+    # form data and image form data in the same request only if knowledgeRequest
+    # form data specifies the cropArea field only  (it must not include an insights
+    # token or URL).
+    # @param custom_headers [Hash{String => String}] A hash of custom headers that
+    # will be added to the HTTP request.
+    #
+    # @return [MsRestAzure::AzureOperationResponse] HTTP response information.
+    #
+    def visual_search_with_http_info(content_type, accept_language:nil, user_agent:nil, client_id:nil, client_ip:nil, location:nil, market:nil, safe_search:nil, set_lang:nil, visual_search_request:nil, image:nil, custom_headers:nil)
+      visual_search_async(content_type, accept_language:accept_language, user_agent:user_agent, client_id:client_id, client_ip:client_ip, location:location, market:market, safe_search:safe_search, set_lang:set_lang, visual_search_request:visual_search_request, image:image, custom_headers:custom_headers).value!
+    end
+
+    #
+    # Visual Search API lets you discover insights about an image such as visually
+    # similar images, shopping sources, and related searches. The API can also
+    # perform text recognition, identify entities (people, places, things), return
+    # other topical content for the user to explore, and more. For more
+    # information, see [Visual Search
+    # Overview](https://docs.microsoft.com/azure/cognitive-services/bing-visual-search/overview).
+    #
+    # @param content_type [Enum] Must be set to multipart/form-data and include a
+    # boundary parameter (for example, multipart/form-data; boundary=<boundary
+    # string>). For more details, see [Content form types](
+    # https://docs.microsoft.com/en-us/azure/cognitive-services/bing-visual-search/overview#content-form-types).
+    # Possible values include: 'multipart/form-data', 'application/json',
+    # 'text/json', 'application/xml', 'text/xml',
+    # 'application/x-www-form-urlencoded'
+    # @param accept_language [String] 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-visual-search-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-visual-search-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-visual-search-api-v7-reference#mkt)
+    # and
+    # [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-visual-search-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 user_agent [String] 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 client_id [String] 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. ATTENTION: You must ensure that
+    # this Client ID is not linkable to any authenticatable user account
+    # information. If you include the X-MSEdge-ClientID, you must not include
+    # cookies in the request.
+    # @param client_ip [String] 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 location [String] 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 market [String] 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 safe_search [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 set_lang [String] 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 visual_search_request [String] The form data is a JSON object that
+    # identifies the image using an insights token or URL to the image. The object
+    # may also include an optional crop area that identifies an area of interest in
+    # the image. The insights token and URL are mutually exclusive – do not specify
+    # both. You may specify knowledgeRequest form data and image form data in the
+    # same request only if knowledgeRequest form data specifies the cropArea field
+    # only (it must not include an insights token or URL).
+    # @param image The form data is an image binary. The Content-Disposition
+    # header's name parameter must be set to "image". You must specify an image
+    # binary if you do not use knowledgeRequest form data to specify the image; you
+    # may not use both forms to specify an image. You may specify knowledgeRequest
+    # form data and image form data in the same request only if knowledgeRequest
+    # form data specifies the cropArea field only  (it must not include an insights
+    # token or URL).
+    # @param [Hash{String => String}] A hash of custom headers that will be added
+    # to the HTTP request.
+    #
+    # @return [Concurrent::Promise] Promise object which holds the HTTP response.
+    #
+    def visual_search_async(content_type, accept_language:nil, user_agent:nil, client_id:nil, client_ip:nil, location:nil, market:nil, safe_search:nil, set_lang:nil, visual_search_request:nil, image:nil, custom_headers:nil)
+      x_bing_apis_sdk = 'true'
+      fail ArgumentError, 'content_type is nil' if content_type.nil?
+
+
+      request_headers = {}
+      request_headers['Content-Type'] = 'application/json; charset=utf-8'
+
+      # Set Headers
+      request_headers['x-ms-client-request-id'] = SecureRandom.uuid
+      request_headers['X-BingApis-SDK'] = x_bing_apis_sdk unless x_bing_apis_sdk.nil?
+      request_headers['Accept-Language'] = accept_language unless accept_language.nil?
+      request_headers['Content-Type'] = content_type.to_s unless content_type.to_s.nil?
+      request_headers['User-Agent'] = user_agent unless user_agent.nil?
+      request_headers['X-MSEdge-ClientID'] = client_id unless client_id.nil?
+      request_headers['X-MSEdge-ClientIP'] = client_ip unless client_ip.nil?
+      request_headers['X-Search-Location'] = location unless location.nil?
+
+      # Set Form Data
+      form_data = {}
+      form_data['knowledgeRequest'] = visual_search_request unless visual_search_request.nil?
+      form_data['image'] = image.to_s unless image.to_s.nil?
+
+      path_template = 'images/visualsearch'
+
+      request_url = @base_url || @client.base_url
+
+      options = {
+          middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
+          query_params: {'mkt' => market,'safeSearch' => safe_search,'setLang' => set_lang},
+          headers: request_headers.merge(custom_headers || {}),
+          body: URI.encode_www_form(form_data),
+          base_url: request_url
+      }
+      promise = @client.make_request_async(:post, path_template, options)
+
+      promise = promise.then do |result|
+        http_response = result.response
+        status_code = http_response.status
+        response_content = http_response.body
+        unless status_code == 200
+          error_model = JSON.load(response_content)
+          fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
+        end
+
+        result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
+        # Deserialize Response
+        if status_code == 200
+          begin
+            parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
+            result_mapper = Azure::CognitiveServices::VisualSearch::V1_0::Models::ImageKnowledge.mapper()
+            result.body = @client.deserialize(result_mapper, parsed_response)
+          rescue Exception => e
+            fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
+          end
+        end
+
+        result
+      end
+
+      promise.execute
+    end
+
+  end
+end