Class: Google::Apis::RetailV2::GoogleCloudRetailV2CompleteQueryResponse

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 of the auto-complete query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2CompleteQueryResponse

Returns a new instance of GoogleCloudRetailV2CompleteQueryResponse.



581
582
583
 
# File 'lib/google/apis/retail_v2/classes.rb', line 581

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

Instance Attribute Details

#attribution_token ⇒ String

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

Returns:

  • (String) 


560
561
562
 
# File 'lib/google/apis/retail_v2/classes.rb', line 560

def attribution_token
  @attribution_token
end

#completion_results ⇒ Array<Google::Apis::RetailV2::GoogleCloudRetailV2CompleteQueryResponseCompletionResult>

Results of the matching suggestions. The result list is ordered and the first result is top suggestion. Corresponds to the JSON property completionResults

Returns:



566
567
568
 
# File 'lib/google/apis/retail_v2/classes.rb', line 566

def completion_results
  @completion_results
end

#recent_search_results ⇒ Array<Google::Apis::RetailV2::GoogleCloudRetailV2CompleteQueryResponseRecentSearchResult>

Matched recent searches of this user. The maximum number of recent searches is

  1. This field is a restricted feature. Contact Retail Search support team if you are interested in enabling it. This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The recent searches satisfy the follow rules: * They are ordered from latest to oldest. * They are matched with CompleteQueryRequest.query case insensitively.
  2. They are transformed to lower cases. * They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens. Corresponds to the JSON property recentSearchResults

Returns:



579
580
581
 
# File 'lib/google/apis/retail_v2/classes.rb', line 579

def recent_search_results
  @recent_search_results
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



586
587
588
589
590
 
# File 'lib/google/apis/retail_v2/classes.rb', line 586

def update!(**args)
  @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
  @completion_results = args[:completion_results] if args.key?(:completion_results)
  @recent_search_results = args[:recent_search_results] if args.key?(:recent_search_results)
end