azure_cognitiveservices_customsearch 0.16.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f755857808aa6834c46b8e3cdb0a9a6c653a1668
+  data.tar.gz: f2a37a4f7aa161b317d9eb3f6a9795439d23cfac
+SHA512:
+  metadata.gz: 637dc198f2daa1fb9a4413c52c80cf90e1722a28e4b5d4e8ca675d2ebbe3f262c3029547c73f13303c702eeb2d51c7b5ed0fc4ce29bbbea3ff93f0d78f961dd1
+  data.tar.gz: 4495110d06bec862f1adb4f1ed7dfaf1aa0c7b0597b52e3ac6dcbf6da5c45205c022c26c60d423b9f836da26e3f38c7a6c214352e97759a63e8444b88c720b3e

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

@@ -0,0 +1,47 @@
+# 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_customsearch/module_definition'
+require 'ms_rest_azure'
+
+module Azure::CognitiveServices::CustomSearch::V1_0
+  autoload :CustomInstance,                                     '1.0/generated/azure_cognitiveservices_customsearch/custom_instance.rb'
+  autoload :CustomSearchClient,                                 '1.0/generated/azure_cognitiveservices_customsearch/custom_search_client.rb'
+
+  module Models
+    autoload :ResponseBase,                                       '1.0/generated/azure_cognitiveservices_customsearch/models/response_base.rb'
+    autoload :QueryContext,                                       '1.0/generated/azure_cognitiveservices_customsearch/models/query_context.rb'
+    autoload :Query,                                              '1.0/generated/azure_cognitiveservices_customsearch/models/query.rb'
+    autoload :Error,                                              '1.0/generated/azure_cognitiveservices_customsearch/models/error.rb'
+    autoload :WebMetaTag,                                         '1.0/generated/azure_cognitiveservices_customsearch/models/web_meta_tag.rb'
+    autoload :WebPage,                                            '1.0/generated/azure_cognitiveservices_customsearch/models/web_page.rb'
+    autoload :WebWebAnswer,                                       '1.0/generated/azure_cognitiveservices_customsearch/models/web_web_answer.rb'
+    autoload :SearchResponse,                                     '1.0/generated/azure_cognitiveservices_customsearch/models/search_response.rb'
+    autoload :SearchResultsAnswer,                                '1.0/generated/azure_cognitiveservices_customsearch/models/search_results_answer.rb'
+    autoload :Identifiable,                                       '1.0/generated/azure_cognitiveservices_customsearch/models/identifiable.rb'
+    autoload :Response,                                           '1.0/generated/azure_cognitiveservices_customsearch/models/response.rb'
+    autoload :ErrorResponse,                                      '1.0/generated/azure_cognitiveservices_customsearch/models/error_response.rb'
+    autoload :Answer,                                             '1.0/generated/azure_cognitiveservices_customsearch/models/answer.rb'
+    autoload :Thing,                                              '1.0/generated/azure_cognitiveservices_customsearch/models/thing.rb'
+    autoload :CreativeWork,                                       '1.0/generated/azure_cognitiveservices_customsearch/models/creative_work.rb'
+    autoload :ErrorCode,                                          '1.0/generated/azure_cognitiveservices_customsearch/models/error_code.rb'
+    autoload :ErrorSubCode,                                       '1.0/generated/azure_cognitiveservices_customsearch/models/error_sub_code.rb'
+    autoload :SafeSearch,                                         '1.0/generated/azure_cognitiveservices_customsearch/models/safe_search.rb'
+    autoload :TextFormat,                                         '1.0/generated/azure_cognitiveservices_customsearch/models/text_format.rb'
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_customsearch/custom_instance.rb

@@ -0,0 +1,653 @@
+# 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::CustomSearch::V1_0
+  #
+  # The Bing Custom Search API lets you send a search query to Bing and get
+  # back search results customized to meet your custom search definition.
+  #
+  class CustomInstance
+    include MsRestAzure
+
+    #
+    # Creates and initializes a new instance of the CustomInstance class.
+    # @param client service class for accessing basic functionality.
+    #
+    def initialize(client)
+      @client = client
+    end
+
+    # @return [CustomSearchClient] reference to the CustomSearchClient
+    attr_reader :client
+
+    #
+    # The Custom Search API lets you send a search query to Bing and get back web
+    # pages found in your custom view of the web.
+    #
+    # @param custom_config [Integer] The identifier for the custom search
+    # configuration
+    # @param query [String] The user's search query term. The term may not be
+    # empty. The term may contain Bing Advanced Operators. For example, to limit
+    # results to a specific domain, use the site: operator.
+    # @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 query parameter.
+    # Bing will use the first supported language it finds from the list, and
+    # combine that language with the cc parameter value to determine the market to
+    # return results for. If the list does not include a supported language, Bing
+    # will find the closest language and market that supports the request, and may
+    # use an aggregated or default market for the results instead of a specified
+    # one. You should use this header and the cc query parameter only if you
+    # specify multiple languages; otherwise, you should use the mkt and setLang
+    # query parameters. A user interface string is a string that's used as a label
+    # in a user interface. There are very few user interface strings in the JSON
+    # response objects. Any links in the response objects to Bing.com properties
+    # will 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 strongly encouraged to always specify this header. The
+    # user-agent should be the same string that any commonly used browser would
+    # send. For information about user agents, see [RFC
+    # 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
+    # @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 count [Integer] The number of search results to return in the
+    # response. The default is 10 and the maximum value is 50. The actual number
+    # delivered may be less than requested.Use this parameter along with the offset
+    # parameter to page results.For example, if your user interface displays 10
+    # search results per page, set count to 10 and offset to 0 to get the first
+    # page of results. For each subsequent page, increment offset by 10 (for
+    # example, 0, 10, 20). It is possible for multiple pages to include some
+    # overlap in results.
+    # @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. 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, Bing uses a best fit
+    # market code based on an internal mapping that is subject to change. This
+    # parameter and the cc query parameter are mutually exclusive—do not specify
+    # both.
+    # @param offset [Integer] The zero-based offset that indicates the number of
+    # search results to skip before returning results. The default is 0. The offset
+    # should be less than (totalEstimatedMatches - count). Use this parameter along
+    # with the count parameter to page results. For example, if your user interface
+    # displays 10 search results per page, set count to 10 and offset to 0 to get
+    # the first page of results. For each subsequent page, increment offset by 10
+    # (for example, 0, 10, 20). it is possible for multiple pages to include some
+    # overlap in results.
+    # @param safe_search [SafeSearch] A filter used to filter adult content. Off:
+    # Return webpages with adult text, images, or videos. Moderate: Return webpages
+    # with adult text, but not adult images or videos. Strict: Do not return
+    # webpages with adult text, images, or videos. 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: 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 text_decorations [Boolean] A Boolean value that determines whether
+    # display strings should contain decoration markers such as hit highlighting
+    # characters. If true, the strings may include markers. The default is false.
+    # To specify whether to use Unicode characters or HTML tags as the markers, see
+    # the textFormat query parameter.
+    # @param text_format [TextFormat] The type of markers to use for text
+    # decorations (see the textDecorations query parameter). Possible values are
+    # Raw—Use Unicode characters to mark content that needs special formatting. The
+    # Unicode characters are in the range E000 through E019. For example, Bing uses
+    # E000 and E001 to mark the beginning and end of query terms for hit
+    # highlighting. HTML—Use HTML tags to mark content that needs special
+    # formatting. For example, use <b> tags to highlight query terms in display
+    # strings. The default is Raw. For display strings that contain escapable HTML
+    # characters such as <, >, and &, if textFormat is set to HTML, Bing escapes
+    # the characters as appropriate (for example, < is escaped to &lt;). Possible
+    # values include: 'Raw', 'Html'
+    # @param custom_headers [Hash{String => String}] A hash of custom headers that
+    # will be added to the HTTP request.
+    #
+    # @return [SearchResponse] operation results.
+    #
+    def search(custom_config, query, accept_language:nil, user_agent:nil, client_id:nil, client_ip:nil, location:nil, country_code:nil, count:nil, market:'en-us', offset:nil, safe_search:nil, set_lang:nil, text_decorations:nil, text_format:nil, custom_headers:nil)
+      response = search_async(custom_config, query, accept_language:accept_language, user_agent:user_agent, client_id:client_id, client_ip:client_ip, location:location, country_code:country_code, count:count, market:market, offset:offset, safe_search:safe_search, set_lang:set_lang, text_decorations:text_decorations, text_format:text_format, custom_headers:custom_headers).value!
+      response.body unless response.nil?
+    end
+
+    #
+    # The Custom Search API lets you send a search query to Bing and get back web
+    # pages found in your custom view of the web.
+    #
+    # @param custom_config [Integer] The identifier for the custom search
+    # configuration
+    # @param query [String] The user's search query term. The term may not be
+    # empty. The term may contain Bing Advanced Operators. For example, to limit
+    # results to a specific domain, use the site: operator.
+    # @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 query parameter.
+    # Bing will use the first supported language it finds from the list, and
+    # combine that language with the cc parameter value to determine the market to
+    # return results for. If the list does not include a supported language, Bing
+    # will find the closest language and market that supports the request, and may
+    # use an aggregated or default market for the results instead of a specified
+    # one. You should use this header and the cc query parameter only if you
+    # specify multiple languages; otherwise, you should use the mkt and setLang
+    # query parameters. A user interface string is a string that's used as a label
+    # in a user interface. There are very few user interface strings in the JSON
+    # response objects. Any links in the response objects to Bing.com properties
+    # will 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 strongly encouraged to always specify this header. The
+    # user-agent should be the same string that any commonly used browser would
+    # send. For information about user agents, see [RFC
+    # 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
+    # @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 count [Integer] The number of search results to return in the
+    # response. The default is 10 and the maximum value is 50. The actual number
+    # delivered may be less than requested.Use this parameter along with the offset
+    # parameter to page results.For example, if your user interface displays 10
+    # search results per page, set count to 10 and offset to 0 to get the first
+    # page of results. For each subsequent page, increment offset by 10 (for
+    # example, 0, 10, 20). It is possible for multiple pages to include some
+    # overlap in results.
+    # @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. 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, Bing uses a best fit
+    # market code based on an internal mapping that is subject to change. This
+    # parameter and the cc query parameter are mutually exclusive—do not specify
+    # both.
+    # @param offset [Integer] The zero-based offset that indicates the number of
+    # search results to skip before returning results. The default is 0. The offset
+    # should be less than (totalEstimatedMatches - count). Use this parameter along
+    # with the count parameter to page results. For example, if your user interface
+    # displays 10 search results per page, set count to 10 and offset to 0 to get
+    # the first page of results. For each subsequent page, increment offset by 10
+    # (for example, 0, 10, 20). it is possible for multiple pages to include some
+    # overlap in results.
+    # @param safe_search [SafeSearch] A filter used to filter adult content. Off:
+    # Return webpages with adult text, images, or videos. Moderate: Return webpages
+    # with adult text, but not adult images or videos. Strict: Do not return
+    # webpages with adult text, images, or videos. 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: 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 text_decorations [Boolean] A Boolean value that determines whether
+    # display strings should contain decoration markers such as hit highlighting
+    # characters. If true, the strings may include markers. The default is false.
+    # To specify whether to use Unicode characters or HTML tags as the markers, see
+    # the textFormat query parameter.
+    # @param text_format [TextFormat] The type of markers to use for text
+    # decorations (see the textDecorations query parameter). Possible values are
+    # Raw—Use Unicode characters to mark content that needs special formatting. The
+    # Unicode characters are in the range E000 through E019. For example, Bing uses
+    # E000 and E001 to mark the beginning and end of query terms for hit
+    # highlighting. HTML—Use HTML tags to mark content that needs special
+    # formatting. For example, use <b> tags to highlight query terms in display
+    # strings. The default is Raw. For display strings that contain escapable HTML
+    # characters such as <, >, and &, if textFormat is set to HTML, Bing escapes
+    # the characters as appropriate (for example, < is escaped to &lt;). Possible
+    # values include: 'Raw', 'Html'
+    # @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 search_with_http_info(custom_config, query, accept_language:nil, user_agent:nil, client_id:nil, client_ip:nil, location:nil, country_code:nil, count:nil, market:'en-us', offset:nil, safe_search:nil, set_lang:nil, text_decorations:nil, text_format:nil, custom_headers:nil)
+      search_async(custom_config, query, accept_language:accept_language, user_agent:user_agent, client_id:client_id, client_ip:client_ip, location:location, country_code:country_code, count:count, market:market, offset:offset, safe_search:safe_search, set_lang:set_lang, text_decorations:text_decorations, text_format:text_format, custom_headers:custom_headers).value!
+    end
+
+    #
+    # The Custom Search API lets you send a search query to Bing and get back web
+    # pages found in your custom view of the web.
+    #
+    # @param custom_config [Integer] The identifier for the custom search
+    # configuration
+    # @param query [String] The user's search query term. The term may not be
+    # empty. The term may contain Bing Advanced Operators. For example, to limit
+    # results to a specific domain, use the site: operator.
+    # @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 query parameter.
+    # Bing will use the first supported language it finds from the list, and
+    # combine that language with the cc parameter value to determine the market to
+    # return results for. If the list does not include a supported language, Bing
+    # will find the closest language and market that supports the request, and may
+    # use an aggregated or default market for the results instead of a specified
+    # one. You should use this header and the cc query parameter only if you
+    # specify multiple languages; otherwise, you should use the mkt and setLang
+    # query parameters. A user interface string is a string that's used as a label
+    # in a user interface. There are very few user interface strings in the JSON
+    # response objects. Any links in the response objects to Bing.com properties
+    # will 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 strongly encouraged to always specify this header. The
+    # user-agent should be the same string that any commonly used browser would
+    # send. For information about user agents, see [RFC
+    # 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
+    # @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 count [Integer] The number of search results to return in the
+    # response. The default is 10 and the maximum value is 50. The actual number
+    # delivered may be less than requested.Use this parameter along with the offset
+    # parameter to page results.For example, if your user interface displays 10
+    # search results per page, set count to 10 and offset to 0 to get the first
+    # page of results. For each subsequent page, increment offset by 10 (for
+    # example, 0, 10, 20). It is possible for multiple pages to include some
+    # overlap in results.
+    # @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. 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, Bing uses a best fit
+    # market code based on an internal mapping that is subject to change. This
+    # parameter and the cc query parameter are mutually exclusive—do not specify
+    # both.
+    # @param offset [Integer] The zero-based offset that indicates the number of
+    # search results to skip before returning results. The default is 0. The offset
+    # should be less than (totalEstimatedMatches - count). Use this parameter along
+    # with the count parameter to page results. For example, if your user interface
+    # displays 10 search results per page, set count to 10 and offset to 0 to get
+    # the first page of results. For each subsequent page, increment offset by 10
+    # (for example, 0, 10, 20). it is possible for multiple pages to include some
+    # overlap in results.
+    # @param safe_search [SafeSearch] A filter used to filter adult content. Off:
+    # Return webpages with adult text, images, or videos. Moderate: Return webpages
+    # with adult text, but not adult images or videos. Strict: Do not return
+    # webpages with adult text, images, or videos. 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: 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 text_decorations [Boolean] A Boolean value that determines whether
+    # display strings should contain decoration markers such as hit highlighting
+    # characters. If true, the strings may include markers. The default is false.
+    # To specify whether to use Unicode characters or HTML tags as the markers, see
+    # the textFormat query parameter.
+    # @param text_format [TextFormat] The type of markers to use for text
+    # decorations (see the textDecorations query parameter). Possible values are
+    # Raw—Use Unicode characters to mark content that needs special formatting. The
+    # Unicode characters are in the range E000 through E019. For example, Bing uses
+    # E000 and E001 to mark the beginning and end of query terms for hit
+    # highlighting. HTML—Use HTML tags to mark content that needs special
+    # formatting. For example, use <b> tags to highlight query terms in display
+    # strings. The default is Raw. For display strings that contain escapable HTML
+    # characters such as <, >, and &, if textFormat is set to HTML, Bing escapes
+    # the characters as appropriate (for example, < is escaped to &lt;). Possible
+    # values include: 'Raw', 'Html'
+    # @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 search_async(custom_config, query, accept_language:nil, user_agent:nil, client_id:nil, client_ip:nil, location:nil, country_code:nil, count:nil, market:'en-us', offset:nil, safe_search:nil, set_lang:nil, text_decorations:nil, text_format:nil, custom_headers:nil)
+      x_bing_apis_sdk = 'true'
+      fail ArgumentError, 'custom_config is nil' if custom_config.nil?
+      fail ArgumentError, "'custom_config' should satisfy the constraint - 'InclusiveMinimum': '0'" if !custom_config.nil? && custom_config < 0
+      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['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 = 'search'
+
+      request_url = @base_url || @client.base_url
+
+      options = {
+          middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
+          query_params: {'customConfig' => custom_config,'cc' => country_code,'count' => count,'mkt' => market,'offset' => offset,'q' => query,'safeSearch' => safe_search,'setLang' => set_lang,'textDecorations' => text_decorations,'textFormat' => text_format},
+          headers: request_headers.merge(custom_headers || {}),
+          base_url: request_url
+      }
+      promise = @client.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::CustomSearch::V1_0::Models::SearchResponse.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