Class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2/classes.rb,
lib/google/apis/retail_v2/representations.rb,
lib/google/apis/retail_v2/representations.rb

Overview

Response message for SearchService.Search method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2SearchResponse

Returns a new instance of GoogleCloudRetailV2SearchResponse.



5353
5354
5355
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5353

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#applied_controls ⇒ Array<String>

The fully qualified resource name of applied controls. Corresponds to the JSON property appliedControls

Returns:

  • (Array<String>) 


5277
5278
5279
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5277

def applied_controls
  @applied_controls
end

#attribution_token ⇒ String

A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. Corresponds to the JSON property attributionToken

Returns:

  • (String) 


5284
5285
5286
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5284

def attribution_token
  @attribution_token
end

#conversational_search_result ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResult

This field specifies all related information that is needed on client side for UI rendering of conversational retail search. Corresponds to the JSON property conversationalSearchResult

Returns:



5290
5291
5292
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5290

def conversational_search_result
  @conversational_search_result
end

#corrected_query ⇒ String

Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search. Corresponds to the JSON property correctedQuery

Returns:

  • (String) 


5297
5298
5299
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5297

def corrected_query
  @corrected_query
end

#experiment_info ⇒ Array<Google::Apis::RetailV2::GoogleCloudRetailV2ExperimentInfo>

Metadata related to A/B testing Experiment associated with this response. Only exists when an experiment is triggered. Corresponds to the JSON property experimentInfo

Returns:



5303
5304
5305
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5303

def experiment_info
  @experiment_info
end

#facets ⇒ Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseFacet>

Results of facets requested by user. Corresponds to the JSON property facets

Returns:



5308
5309
5310
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5308

def facets
  @facets
end

#invalid_condition_boost_specs ⇒ Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec>

The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving. Corresponds to the JSON property invalidConditionBoostSpecs

Returns:



5314
5315
5316
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5314

def invalid_condition_boost_specs
  @invalid_condition_boost_specs
end

#next_page_token ⇒ String

A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. Corresponds to the JSON property nextPageToken

Returns:

  • (String) 


5320
5321
5322
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5320

def next_page_token
  @next_page_token
end

#query_expansion_info ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseQueryExpansionInfo

Information describing query expansion including whether expansion has occurred. Corresponds to the JSON property queryExpansionInfo

Returns:



5326
5327
5328
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5326

def query_expansion_info
  @query_expansion_info
end

#redirect_uri ⇒ String

The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response. Corresponds to the JSON property redirectUri

Returns:

  • (String) 


5333
5334
5335
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5333

def redirect_uri
  @redirect_uri
end

#results ⇒ Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseSearchResult>

A list of matched items. The order represents the ranking. Corresponds to the JSON property results

Returns:



5338
5339
5340
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5338

def results
  @results
end

#tile_navigation_result ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseTileNavigationResult

This field specifies all related information for tile navigation that will be used in client side. Corresponds to the JSON property tileNavigationResult

Returns:



5344
5345
5346
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5344

def tile_navigation_result
  @tile_navigation_result
end

#total_size ⇒ Fixnum

The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches. Corresponds to the JSON property totalSize

Returns:

  • (Fixnum) 


5351
5352
5353
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5351

def total_size
  @total_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5358

def update!(**args)
  @applied_controls = args[:applied_controls] if args.key?(:applied_controls)
  @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
  @conversational_search_result = args[:conversational_search_result] if args.key?(:conversational_search_result)
  @corrected_query = args[:corrected_query] if args.key?(:corrected_query)
  @experiment_info = args[:experiment_info] if args.key?(:experiment_info)
  @facets = args[:facets] if args.key?(:facets)
  @invalid_condition_boost_specs = args[:invalid_condition_boost_specs] if args.key?(:invalid_condition_boost_specs)
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
  @query_expansion_info = args[:query_expansion_info] if args.key?(:query_expansion_info)
  @redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri)
  @results = args[:results] if args.key?(:results)
  @tile_navigation_result = args[:tile_navigation_result] if args.key?(:tile_navigation_result)
  @total_size = args[:total_size] if args.key?(:total_size)
end