Class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestConversationalSearchSpec

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

This field specifies all conversational related parameters addition to traditional retail search.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2SearchRequestConversationalSearchSpec

Returns a new instance of GoogleCloudRetailV2SearchRequestConversationalSearchSpec.



5090
5091
5092
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5090

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 ConversationalSearchResult.conversation_id. For the initial request, this should be empty. Corresponds to the JSON property conversationId

Returns:

  • (String) 


5072
5073
5074
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5072

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) 


5080
5081
5082
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5080

def followup_conversation_requested
  @followup_conversation_requested
end

#user_answer ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswer

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:



5088
5089
5090
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5088

def user_answer
  @user_answer
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5095
5096
5097
5098
5099
 
# File 'lib/google/apis/retail_v2/classes.rb', line 5095

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