Class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseConversationalSearchResult

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

Overview

This field specifies all related information that is needed on client side for UI rendering of conversational retail search.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2alphaSearchResponseConversationalSearchResult

Returns a new instance of GoogleCloudRetailV2alphaSearchResponseConversationalSearchResult.



7763
7764
7765
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 7763

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

Instance Attribute Details

#additional_filter ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultAdditionalFilter

Additional filter that client side need to apply. Corresponds to the JSON property additionalFilter

Returns:



7726
7727
7728
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 7726

def additional_filter
  @additional_filter
end

#additional_filters ⇒ Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultAdditionalFilter>

This field is deprecated but will be kept for backward compatibility. There is expected to have only one additional filter and the value will be the same to the same as field additional_filter. Corresponds to the JSON property additionalFilters

Returns:



7733
7734
7735
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 7733

def additional_filters
  @additional_filters
end

#conversation_id ⇒ String

Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's SearchRequest.ConversationalSearchSpec.conversation_id to restore conversation state in server. Corresponds to the JSON property conversationId

Returns:

  • (String) 


7741
7742
7743
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 7741

def conversation_id
  @conversation_id
end

#followup_question ⇒ String

The follow-up question. e.g., What is the color? Corresponds to the JSON property followupQuestion

Returns:

  • (String) 


7746
7747
7748
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 7746

def followup_question
  @followup_question
end

#refined_query ⇒ String

The current refined query for the conversational search. This field will be used in customer UI that the query in the search bar should be replaced with the refined query. For example, if SearchRequest.query is dress and next SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer is red color, which does not match any product attribute value filters, the refined query will be dress, red color. Corresponds to the JSON property refinedQuery

Returns:

  • (String) 


7756
7757
7758
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 7756

def refined_query
  @refined_query
end

#suggested_answers ⇒ Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultSuggestedAnswer>

The answer options provided to client for the follow-up question. Corresponds to the JSON property suggestedAnswers

Returns:



7761
7762
7763
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 7761

def suggested_answers
  @suggested_answers
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7768
7769
7770
7771
7772
7773
7774
7775
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 7768

def update!(**args)
  @additional_filter = args[:additional_filter] if args.key?(:additional_filter)
  @additional_filters = args[:additional_filters] if args.key?(:additional_filters)
  @conversation_id = args[:conversation_id] if args.key?(:conversation_id)
  @followup_question = args[:followup_question] if args.key?(:followup_question)
  @refined_query = args[:refined_query] if args.key?(:refined_query)
  @suggested_answers = args[:suggested_answers] if args.key?(:suggested_answers)
end