azure_cognitiveservices_autosuggest 0.17.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e96cc5588dcdd77d951ac483b84fd391538b3ad2
+  data.tar.gz: 14d3e668b8d0c963f0b95c1a25b55617c876176a
+SHA512:
+  metadata.gz: 68c087f893748976655ea3ad254b5f526a763da0610a73990011cc6c5bdb61ad11cdca60630f9f6c8cdb92b67413966a529736f1b0f36d956f23cb1cac07c1c2
+  data.tar.gz: e66d65df321123693685f23721ccf9bd4ccd258538a4d8ffd4e071ea85f7b3d31b125a25e597bdd2a6e33b425ced39d0ee94d7a0fa5b6373f5b94a5665bb9e92

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

@@ -0,0 +1,46 @@
+# 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_autosuggest/module_definition'
+require 'ms_rest_azure'
+
+module Azure::CognitiveServices::Autosuggest::V1_0
+  autoload :AutosuggestClient,                                  '1.0/generated/azure_cognitiveservices_autosuggest/autosuggest_client.rb'
+
+  module Models
+    autoload :Error,                                              '1.0/generated/azure_cognitiveservices_autosuggest/models/error.rb'
+    autoload :QueryContext,                                       '1.0/generated/azure_cognitiveservices_autosuggest/models/query_context.rb'
+    autoload :SuggestionsSuggestionGroup,                         '1.0/generated/azure_cognitiveservices_autosuggest/models/suggestions_suggestion_group.rb'
+    autoload :ResponseBase,                                       '1.0/generated/azure_cognitiveservices_autosuggest/models/response_base.rb'
+    autoload :Answer,                                             '1.0/generated/azure_cognitiveservices_autosuggest/models/answer.rb'
+    autoload :SearchResultsAnswer,                                '1.0/generated/azure_cognitiveservices_autosuggest/models/search_results_answer.rb'
+    autoload :Suggestions,                                        '1.0/generated/azure_cognitiveservices_autosuggest/models/suggestions.rb'
+    autoload :Thing,                                              '1.0/generated/azure_cognitiveservices_autosuggest/models/thing.rb'
+    autoload :CreativeWork,                                       '1.0/generated/azure_cognitiveservices_autosuggest/models/creative_work.rb'
+    autoload :Action,                                             '1.0/generated/azure_cognitiveservices_autosuggest/models/action.rb'
+    autoload :SearchAction,                                       '1.0/generated/azure_cognitiveservices_autosuggest/models/search_action.rb'
+    autoload :Identifiable,                                       '1.0/generated/azure_cognitiveservices_autosuggest/models/identifiable.rb'
+    autoload :Response,                                           '1.0/generated/azure_cognitiveservices_autosuggest/models/response.rb'
+    autoload :ErrorResponse,                                      '1.0/generated/azure_cognitiveservices_autosuggest/models/error_response.rb'
+    autoload :ScenarioType,                                       '1.0/generated/azure_cognitiveservices_autosuggest/models/scenario_type.rb'
+    autoload :SearchKind,                                         '1.0/generated/azure_cognitiveservices_autosuggest/models/search_kind.rb'
+    autoload :ErrorCode,                                          '1.0/generated/azure_cognitiveservices_autosuggest/models/error_code.rb'
+    autoload :SafeSearch,                                         '1.0/generated/azure_cognitiveservices_autosuggest/models/safe_search.rb'
+    autoload :ResponseFormat,                                     '1.0/generated/azure_cognitiveservices_autosuggest/models/response_format.rb'
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_autosuggest/autosuggest_client.rb

@@ -0,0 +1,700 @@
+# 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::Autosuggest::V1_0
+  #
+  # A service client - single point of access to the REST API.
+  #
+  class AutosuggestClient < MsRestAzure::AzureServiceClient
+    include MsRestAzure
+    include MsRestAzure::Serialization
+
+    # @return [String] the base URI of the service.
+    attr_reader :base_url
+
+    # @return Credentials needed for the client to connect to Azure.
+    attr_reader :credentials1
+
+    # @return [String] Supported Cognitive Services endpoints (protocol and
+    # hostname, for example: "https://westus.api.cognitive.microsoft.com",
+    # "https://api.cognitive.microsoft.com").
+    attr_accessor :endpoint
+
+    # @return Subscription credentials which uniquely identify client
+    # subscription.
+    attr_accessor :credentials
+
+    # @return [String] The preferred language for the response.
+    attr_accessor :accept_language
+
+    # @return [Integer] The retry timeout in seconds for Long Running
+    # Operations. Default value is 30.
+    attr_accessor :long_running_operation_retry_timeout
+
+    # @return [Boolean] Whether a unique x-ms-client-request-id should be
+    # generated. When set to true a unique x-ms-client-request-id value is
+    # generated and included in each request. Default is true.
+    attr_accessor :generate_client_request_id
+
+    #
+    # Creates initializes a new instance of the AutosuggestClient class.
+    # @param credentials [MsRest::ServiceClientCredentials] credentials to authorize HTTP requests made by the service client.
+    # @param options [Array] filters to be applied to the HTTP requests.
+    #
+    def initialize(credentials = nil, options = nil)
+      super(credentials, options)
+      @base_url = '{Endpoint}/bing/v7.0'
+
+      fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil?
+      @credentials = credentials
+
+      @endpoint = 'https://api.cognitive.microsoft.com'
+      @accept_language = 'en-US'
+      @long_running_operation_retry_timeout = 30
+      @generate_client_request_id = true
+      add_telemetry
+    end
+
+    #
+    # Makes a request and returns the body of the response.
+    # @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete.
+    # @param path [String] the path, relative to {base_url}.
+    # @param options [Hash{String=>String}] specifying any request options like :body.
+    # @return [Hash{String=>String}] containing the body of the response.
+    # Example:
+    #
+    #  request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
+    #  path = "/path"
+    #  options = {
+    #    body: request_content,
+    #    query_params: {'api-version' => '2016-02-01'}
+    #  }
+    #  result = @client.make_request(:put, path, options)
+    #
+    def make_request(method, path, options = {})
+      result = make_request_with_http_info(method, path, options)
+      result.body unless result.nil?
+    end
+
+    #
+    # Makes a request and returns the operation response.
+    # @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete.
+    # @param path [String] the path, relative to {base_url}.
+    # @param options [Hash{String=>String}] specifying any request options like :body.
+    # @return [MsRestAzure::AzureOperationResponse] Operation response containing the request, response and status.
+    #
+    def make_request_with_http_info(method, path, options = {})
+      result = make_request_async(method, path, options).value!
+      result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
+      result
+    end
+
+    #
+    # Makes a request asynchronously.
+    # @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete.
+    # @param path [String] the path, relative to {base_url}.
+    # @param options [Hash{String=>String}] specifying any request options like :body.
+    # @return [Concurrent::Promise] Promise object which holds the HTTP response.
+    #
+    def make_request_async(method, path, options = {})
+      fail ArgumentError, 'method is nil' if method.nil?
+      fail ArgumentError, 'path is nil' if path.nil?
+
+      request_url = options[:base_url] || @base_url
+      if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
+        @request_headers['Content-Type'] = options[:headers]['Content-Type']
+      end
+
+      request_headers = @request_headers
+      request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
+      options.merge!({headers: request_headers.merge(options[:headers] || {})})
+      options.merge!({credentials: @credentials}) unless @credentials.nil?
+
+      super(request_url, method, path, options)
+    end
+
+    #
+    # The AutoSuggest API lets you send a search query to Bing and get back a list
+    # of query suggestions. This section provides technical details about the query
+    # parameters and headers that you use to request suggestions and the JSON
+    # response objects that contain them.
+    #
+    # @param query [String] The user's search term.
+    # @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 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-autosuggest-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-autosuggest-api-v7-reference#mkt)
+    # and
+    # [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-autosuggest-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 pragma [String] By default, Bing returns cached content, if available.
+    # To prevent Bing from returning cached content, set the Pragma header to
+    # no-cache (for example, Pragma: no-cache).
+    # @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. 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 country_code [String] A 2-character country code of the country where
+    # the results come from. This API supports only the United States market. If
+    # you specify this query parameter, it must be set to us. If you set this
+    # parameter, you must also specify the Accept-Language header. Bing uses the
+    # first supported language it finds from the languages list, and combine that
+    # language with the country code that you specify to determine the market to
+    # return results for. If the languages list does not include a supported
+    # language, Bing finds the closest language and market that supports the
+    # request, or it may use an aggregated or default market for the results
+    # instead of a specified one. You should use this query parameter and the
+    # Accept-Language query parameter only if you specify multiple languages;
+    # otherwise, you should use the mkt and setLang query parameters. This
+    # parameter and the mkt query parameter are mutually exclusive—do not specify
+    # both.
+    # @param market [String] The market where the results come from. You are
+    # strongly encouraged to always specify the market, if known. Specifying the
+    # market helps Bing route the request and return an appropriate and optimal
+    # response. This parameter and the cc query parameter are mutually exclusive—do
+    # not specify both.
+    # @param safe_search [SafeSearch] Filter suggestions for adult content. The
+    # following are the possible filter values. Off: Return suggestions with adult
+    # text, images, or videos. Moderate: Return suggestion with adult text but not
+    # adult images or videos. Strict: Do not return news articles with adult text,
+    # images, or videos. 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: query operator, 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. This parameter and the
+    # Accept-Language header are mutually exclusive; do not specify both. 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 response_format [Array<ResponseFormat>] The media type to use for the
+    # response. The following are the possible case-insensitive values: JSON,
+    # JSONLD. The default is JSON. If you specify JSONLD, the response body
+    # includes JSON-LD objects that contain the search results.
+    # @param custom_headers [Hash{String => String}] A hash of custom headers that
+    # will be added to the HTTP request.
+    #
+    # @return [Suggestions] operation results.
+    #
+    def auto_suggest(query, accept_language:nil, pragma:nil, user_agent:nil, client_id:nil, client_ip:nil, location:nil, country_code:nil, market:'en-us', safe_search:nil, set_lang:nil, response_format:nil, custom_headers:nil)
+      response = auto_suggest_async(query, accept_language:accept_language, pragma:pragma, user_agent:user_agent, client_id:client_id, client_ip:client_ip, location:location, country_code:country_code, market:market, safe_search:safe_search, set_lang:set_lang, response_format:response_format, custom_headers:custom_headers).value!
+      response.body unless response.nil?
+    end
+
+    #
+    # The AutoSuggest API lets you send a search query to Bing and get back a list
+    # of query suggestions. This section provides technical details about the query
+    # parameters and headers that you use to request suggestions and the JSON
+    # response objects that contain them.
+    #
+    # @param query [String] The user's search term.
+    # @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 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-autosuggest-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-autosuggest-api-v7-reference#mkt)
+    # and
+    # [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-autosuggest-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 pragma [String] By default, Bing returns cached content, if available.
+    # To prevent Bing from returning cached content, set the Pragma header to
+    # no-cache (for example, Pragma: no-cache).
+    # @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. 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 country_code [String] A 2-character country code of the country where
+    # the results come from. This API supports only the United States market. If
+    # you specify this query parameter, it must be set to us. If you set this
+    # parameter, you must also specify the Accept-Language header. Bing uses the
+    # first supported language it finds from the languages list, and combine that
+    # language with the country code that you specify to determine the market to
+    # return results for. If the languages list does not include a supported
+    # language, Bing finds the closest language and market that supports the
+    # request, or it may use an aggregated or default market for the results
+    # instead of a specified one. You should use this query parameter and the
+    # Accept-Language query parameter only if you specify multiple languages;
+    # otherwise, you should use the mkt and setLang query parameters. This
+    # parameter and the mkt query parameter are mutually exclusive—do not specify
+    # both.
+    # @param market [String] The market where the results come from. You are
+    # strongly encouraged to always specify the market, if known. Specifying the
+    # market helps Bing route the request and return an appropriate and optimal
+    # response. This parameter and the cc query parameter are mutually exclusive—do
+    # not specify both.
+    # @param safe_search [SafeSearch] Filter suggestions for adult content. The
+    # following are the possible filter values. Off: Return suggestions with adult
+    # text, images, or videos. Moderate: Return suggestion with adult text but not
+    # adult images or videos. Strict: Do not return news articles with adult text,
+    # images, or videos. 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: query operator, 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. This parameter and the
+    # Accept-Language header are mutually exclusive; do not specify both. 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 response_format [Array<ResponseFormat>] The media type to use for the
+    # response. The following are the possible case-insensitive values: JSON,
+    # JSONLD. The default is JSON. If you specify JSONLD, the response body
+    # includes JSON-LD objects that contain the search results.
+    # @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 auto_suggest_with_http_info(query, accept_language:nil, pragma:nil, user_agent:nil, client_id:nil, client_ip:nil, location:nil, country_code:nil, market:'en-us', safe_search:nil, set_lang:nil, response_format:nil, custom_headers:nil)
+      auto_suggest_async(query, accept_language:accept_language, pragma:pragma, user_agent:user_agent, client_id:client_id, client_ip:client_ip, location:location, country_code:country_code, market:market, safe_search:safe_search, set_lang:set_lang, response_format:response_format, custom_headers:custom_headers).value!
+    end
+
+    #
+    # The AutoSuggest API lets you send a search query to Bing and get back a list
+    # of query suggestions. This section provides technical details about the query
+    # parameters and headers that you use to request suggestions and the JSON
+    # response objects that contain them.
+    #
+    # @param query [String] The user's search term.
+    # @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 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-autosuggest-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-autosuggest-api-v7-reference#mkt)
+    # and
+    # [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-autosuggest-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 pragma [String] By default, Bing returns cached content, if available.
+    # To prevent Bing from returning cached content, set the Pragma header to
+    # no-cache (for example, Pragma: no-cache).
+    # @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. 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 country_code [String] A 2-character country code of the country where
+    # the results come from. This API supports only the United States market. If
+    # you specify this query parameter, it must be set to us. If you set this
+    # parameter, you must also specify the Accept-Language header. Bing uses the
+    # first supported language it finds from the languages list, and combine that
+    # language with the country code that you specify to determine the market to
+    # return results for. If the languages list does not include a supported
+    # language, Bing finds the closest language and market that supports the
+    # request, or it may use an aggregated or default market for the results
+    # instead of a specified one. You should use this query parameter and the
+    # Accept-Language query parameter only if you specify multiple languages;
+    # otherwise, you should use the mkt and setLang query parameters. This
+    # parameter and the mkt query parameter are mutually exclusive—do not specify
+    # both.
+    # @param market [String] The market where the results come from. You are
+    # strongly encouraged to always specify the market, if known. Specifying the
+    # market helps Bing route the request and return an appropriate and optimal
+    # response. This parameter and the cc query parameter are mutually exclusive—do
+    # not specify both.
+    # @param safe_search [SafeSearch] Filter suggestions for adult content. The
+    # following are the possible filter values. Off: Return suggestions with adult
+    # text, images, or videos. Moderate: Return suggestion with adult text but not
+    # adult images or videos. Strict: Do not return news articles with adult text,
+    # images, or videos. 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: query operator, 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. This parameter and the
+    # Accept-Language header are mutually exclusive; do not specify both. 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 response_format [Array<ResponseFormat>] The media type to use for the
+    # response. The following are the possible case-insensitive values: JSON,
+    # JSONLD. The default is JSON. If you specify JSONLD, the response body
+    # includes JSON-LD objects that contain the search results.
+    # @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 auto_suggest_async(query, accept_language:nil, pragma:nil, user_agent:nil, client_id:nil, client_ip:nil, location:nil, country_code:nil, market:'en-us', safe_search:nil, set_lang:nil, response_format:nil, custom_headers:nil)
+      fail ArgumentError, 'endpoint is nil' if endpoint.nil?
+      x_bing_apis_sdk = 'true'
+      fail ArgumentError, 'query is nil' if query.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['Pragma'] = pragma unless pragma.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?
+      path_template = 'Suggestions'
+
+      request_url = @base_url || self.base_url
+    request_url = request_url.gsub('{Endpoint}', endpoint)
+
+      options = {
+          middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
+          query_params: {'cc' => country_code,'mkt' => market,'q' => query,'safeSearch' => safe_search,'setLang' => set_lang,'ResponseFormat' => response_format.nil? ? nil : response_format.join(',')},
+          headers: request_headers.merge(custom_headers || {}),
+          base_url: request_url
+      }
+      promise = self.make_request_async(:get, 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::Autosuggest::V1_0::Models::Suggestions.mapper()
+            result.body = self.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
+
+
+    private
+    #
+    # Adds telemetry information.
+    #
+    def add_telemetry
+        sdk_information = 'azure_cognitiveservices_autosuggest'
+        sdk_information = "#{sdk_information}/0.17.0"
+        add_user_agent_information(sdk_information)
+    end
+  end
+end