Class: Azure::CognitiveServices::LocalSearch::V1_0::Local

Inherits:

Object

Object
Azure::CognitiveServices::LocalSearch::V1_0::Local

show all

Includes:: MsRestAzure

Defined in:: lib/1.0/generated/azure_cognitiveservices_localsearch/local.rb

Overview

The Local Search client lets you send a search query to Bing and get back search results that include local businesses such as restaurants, hotels, retail stores, or other local businesses. The query can specify the name of the local business or it can ask for a list (for example, restaurants near me).

Instance Attribute Summary collapse

#client ⇒ LocalSearchClient readonly

Reference to the LocalSearchClient.

Instance Method Summary collapse

#initialize(client) ⇒ Local constructor

Creates and initializes a new instance of the Local class.
#search(query, accept_language: nil, pragma: nil, user_agent: nil, client_id: nil, client_ip: nil, location: nil, country_code: nil, market: 'en-us', local_categories: nil, local_circular_view: nil, local_map_view: nil, count: nil, first: nil, response_format: nil, safe_search: nil, set_lang: nil, custom_headers: nil) ⇒ SearchResponse

The Local Search API lets you send a search query to Bing and get back search results that include local businesses such as restaurants, hotels, retail stores, or other local businesses.
#search_async(query, accept_language: nil, pragma: nil, user_agent: nil, client_id: nil, client_ip: nil, location: nil, country_code: nil, market: 'en-us', local_categories: nil, local_circular_view: nil, local_map_view: nil, count: nil, first: nil, response_format: nil, safe_search: nil, set_lang: nil, custom_headers: nil) ⇒ Concurrent::Promise

The Local Search API lets you send a search query to Bing and get back search results that include local businesses such as restaurants, hotels, retail stores, or other local businesses.
#search_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', local_categories: nil, local_circular_view: nil, local_map_view: nil, count: nil, first: nil, response_format: nil, safe_search: nil, set_lang: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

The Local Search API lets you send a search query to Bing and get back search results that include local businesses such as restaurants, hotels, retail stores, or other local businesses.

Constructor Details

#initialize(client) ⇒ `Local`

Creates and initializes a new instance of the Local class.

Parameters:

client —

service class for accessing basic functionality.



21
22
23

# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/local.rb', line 21

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ `LocalSearchClient` (readonly)

Returns reference to the LocalSearchClient.

Returns:

(LocalSearchClient) —

reference to the LocalSearchClient



26
27
28

# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/local.rb', line 26

def client
  @client
end

Instance Method Details

#search(query, accept_language: nil, pragma: nil, user_agent: nil, client_id: nil, client_ip: nil, location: nil, country_code: nil, market: 'en-us', local_categories: nil, local_circular_view: nil, local_map_view: nil, count: nil, first: nil, response_format: nil, safe_search: nil, set_lang: nil, custom_headers: nil) ⇒ `SearchResponse`

The Local Search API lets you send a search query to Bing and get back search results that include local businesses such as restaurants, hotels, retail stores, or other local businesses. The query can specify the name of the local business or it can ask for a list (for example, restaurants near me).

languages to use for user interface strings. The list is in decreasing order of preference. For additional information, including expected format, see [RFC2616](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. To prevent Bing from returning cached content, set the Pragma header to no-cache (for example, Pragma: no-cache). 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](www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). 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. 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. 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. 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. 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. to search for. Supported categories can be high-level such as EatDrink, Shop, SeeDo. expressed as Latitude, longitude and radius in meters. For example 47.61503,-122.1719,5000. Note that circular view should only be used to indicate a search around a point on the map, not as an approximation for a view port of a map rectangle. in NW_latitude, NW_Longitude, SE_Latitude, SE_Longitude format. For example 47.64,-122.13,47.63,-122.12. These values are lat, long pairs for the Northwest corner and the Southeast corner of a rectangle. specified, then Bing returns 1-20 of the most relevant results. 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. 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’ 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. will be added to the HTTP request.

Parameters:

query (String) —

The user’s search term.
accept_language (String) (defaults to: nil) —

A comma-delimited list of one or more
pragma (String) (defaults to: nil) —

By default, Bing returns cached content, if available.
user_agent (String) (defaults to: nil) —

The user agent originating the request. Bing uses
client_id (String) (defaults to: nil) —

Bing uses this header to provide users with
client_ip (String) (defaults to: nil) —

The IPv4 or IPv6 address of the client device. The
location (String) (defaults to: nil) —

A semicolon-delimited list of key/value pairs that
country_code (String) (defaults to: nil) —

A 2-character country code of the country where
market (String) (defaults to: 'en-us') —

The market where the results come from. You are
local_categories (String) (defaults to: nil) —

comma-delimited list of business categories
local_circular_view (String) (defaults to: nil) —

Preferred location to search around,
local_map_view (String) (defaults to: nil) —

Preferred bounding box for results, specified
count (String) (defaults to: nil) —

Preferred number of results to return. If not
first (String) (defaults to: nil) —

First result to return. zero-based. default is 0.
response_format (Array<ResponseFormat>) (defaults to: nil) —

The media type to use for the
safe_search (SafeSearch) (defaults to: nil) —

A filter used to filter adult content. Off:
set_lang (String) (defaults to: nil) —

The language to use for user interface strings.
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(SearchResponse) —

operation results.

# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/local.rb', line 197

def search(query, accept_language:nil, pragma:nil, user_agent:nil, client_id:nil, client_ip:nil, location:nil, country_code:nil, market:'en-us', local_categories:nil, local_circular_view:nil, local_map_view:nil, count:nil, first:nil, response_format:nil, safe_search:nil, set_lang:nil, custom_headers:nil)
  response = search_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, local_categories:local_categories, local_circular_view:local_circular_view, local_map_view:local_map_view, count:count, first:first, response_format:response_format, safe_search:safe_search, set_lang:set_lang, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#search_async(query, accept_language: nil, pragma: nil, user_agent: nil, client_id: nil, client_ip: nil, location: nil, country_code: nil, market: 'en-us', local_categories: nil, local_circular_view: nil, local_map_view: nil, count: nil, first: nil, response_format: nil, safe_search: nil, set_lang: nil, custom_headers: nil) ⇒ `Concurrent::Promise`

Parameters:

query (String) —

The user’s search term.
accept_language (String) (defaults to: nil) —

A comma-delimited list of one or more
pragma (String) (defaults to: nil) —

By default, Bing returns cached content, if available.
user_agent (String) (defaults to: nil) —

The user agent originating the request. Bing uses
client_id (String) (defaults to: nil) —

Bing uses this header to provide users with
client_ip (String) (defaults to: nil) —

The IPv4 or IPv6 address of the client device. The
location (String) (defaults to: nil) —

A semicolon-delimited list of key/value pairs that
country_code (String) (defaults to: nil) —

A 2-character country code of the country where
market (String) (defaults to: 'en-us') —

The market where the results come from. You are
local_categories (String) (defaults to: nil) —

comma-delimited list of business categories
local_circular_view (String) (defaults to: nil) —

Preferred location to search around,
local_map_view (String) (defaults to: nil) —

Preferred bounding box for results, specified
count (String) (defaults to: nil) —

Preferred number of results to return. If not
first (String) (defaults to: nil) —

First result to return. zero-based. default is 0.
response_format (Array<ResponseFormat>) (defaults to: nil) —

The media type to use for the
safe_search (SafeSearch) (defaults to: nil) —

A filter used to filter adult content. Off:
set_lang (String) (defaults to: nil) —

The language to use for user interface strings.
A (Hash{String => String}) —

hash of custom headers that will be added

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/local.rb', line 544

def search_async(query, accept_language:nil, pragma:nil, user_agent:nil, client_id:nil, client_ip:nil, location:nil, country_code:nil, market:'en-us', local_categories:nil, local_circular_view:nil, local_map_view:nil, count:nil, first:nil, response_format:nil, safe_search:nil, set_lang:nil, custom_headers: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 = 'localbusinesses/v7.0/search'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'cc' => country_code,'mkt' => market,'q' => query,'localcategories' => local_categories,'localcircularview' => local_circular_view,'localmapview' => local_map_view,'count' => count,'first' => first,'ResponseFormat' => response_format.nil? ? nil : response_format.join(','),'SafeSearch' => safe_search,'SetLang' => set_lang},
      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::LocalSearch::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

#search_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', local_categories: nil, local_circular_view: nil, local_map_view: nil, count: nil, first: nil, response_format: nil, safe_search: nil, set_lang: nil, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

Parameters:

query (String) —

The user’s search term.
accept_language (String) (defaults to: nil) —

A comma-delimited list of one or more
pragma (String) (defaults to: nil) —

By default, Bing returns cached content, if available.
user_agent (String) (defaults to: nil) —

The user agent originating the request. Bing uses
client_id (String) (defaults to: nil) —

Bing uses this header to provide users with
client_ip (String) (defaults to: nil) —

The IPv4 or IPv6 address of the client device. The
location (String) (defaults to: nil) —

A semicolon-delimited list of key/value pairs that
country_code (String) (defaults to: nil) —

A 2-character country code of the country where
market (String) (defaults to: 'en-us') —

The market where the results come from. You are
local_categories (String) (defaults to: nil) —

comma-delimited list of business categories
local_circular_view (String) (defaults to: nil) —

Preferred location to search around,
local_map_view (String) (defaults to: nil) —

Preferred bounding box for results, specified
count (String) (defaults to: nil) —

Preferred number of results to return. If not
first (String) (defaults to: nil) —

First result to return. zero-based. default is 0.
response_format (Array<ResponseFormat>) (defaults to: nil) —

The media type to use for the
safe_search (SafeSearch) (defaults to: nil) —

A filter used to filter adult content. Off:
set_lang (String) (defaults to: nil) —

The language to use for user interface strings.
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(MsRestAzure::AzureOperationResponse) —

HTTP response information.



371
372
373

# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/local.rb', line 371

def search_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', local_categories:nil, local_circular_view:nil, local_map_view:nil, count:nil, first:nil, response_format:nil, safe_search:nil, set_lang:nil, custom_headers:nil)
  search_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, local_categories:local_categories, local_circular_view:local_circular_view, local_map_view:local_map_view, count:count, first:first, response_format:response_format, safe_search:safe_search, set_lang:set_lang, custom_headers:custom_headers).value!
end

Class: Azure::CognitiveServices::LocalSearch::V1_0::Local

Overview

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Local

Instance Attribute Details

#client ⇒ LocalSearchClient (readonly)

Instance Method Details

#initialize(client) ⇒ `Local`

#client ⇒ `LocalSearchClient` (readonly)