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.



5567
5568
5569
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5567

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>) 


5485
5486
5487
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5485

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) 


5492
5493
5494
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5492

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:



5498
5499
5500
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5498

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) 


5505
5506
5507
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5505

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:



5511
5512
5513
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5511

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:



5516
5517
5518
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5516

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:



5522
5523
5524
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5522

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) 


5528
5529
5530
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5528

def next_page_token
  @next_page_token
end

#pin_control_metadata ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2PinControlMetadata

Metadata for pinning to be returned in the response. This is used for distinguishing between applied vs dropped pins. Corresponds to the JSON property pinControlMetadata

Returns:



5534
5535
5536
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5534

def pin_control_metadata
  @pin_control_metadata
end

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

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

Returns:



5540
5541
5542
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5540

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) 


5547
5548
5549
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5547

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:



5552
5553
5554
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5552

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:



5558
5559
5560
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5558

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) 


5565
5566
5567
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5565

def total_size
  @total_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5572

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)
  @pin_control_metadata = args[:pin_control_metadata] if args.key?(:pin_control_metadata)
  @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