Class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpec

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 conversational related parameters addition to traditional retail search.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpec

Returns a new instance of GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpec.



7930
7931
7932
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 7930

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

Instance Attribute Details

#conversation_id ⇒ String

This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous SearchResponse.ConversationalSearchResult.conversation_id. For the initial request, this should be empty. Corresponds to the JSON property conversationId

Returns:

  • (String) 


7912
7913
7914
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 7912

def conversation_id
  @conversation_id
end

#followup_conversation_requested ⇒ Boolean Also known as: followup_conversation_requested?

This field specifies whether the customer would like to do conversational search. If this field is set to true, conversational related extra information will be returned from server side, including follow-up question, answer options, etc. Corresponds to the JSON property followupConversationRequested

Returns:

  • (Boolean) 


7920
7921
7922
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 7920

def followup_conversation_requested
  @followup_conversation_requested
end

#user_answer ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpecUserAnswer

This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text. Corresponds to the JSON property userAnswer

Returns:



7928
7929
7930
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 7928

def user_answer
  @user_answer
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7935
7936
7937
7938
7939
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 7935

def update!(**args)
  @conversation_id = args[:conversation_id] if args.key?(:conversation_id)
  @followup_conversation_requested = args[:followup_conversation_requested] if args.key?(:followup_conversation_requested)
  @user_answer = args[:user_answer] if args.key?(:user_answer)
end