Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSessionTurn

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

Overview

Represents a turn, including a query from the user and a answer from service.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaSessionTurn

Returns a new instance of GoogleCloudDiscoveryengineV1alphaSessionTurn.



17748
17749
17750
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17748

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

Instance Attribute Details

#answer ⇒ String

Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. Corresponds to the JSON property answer

Returns:

  • (String) 


17718
17719
17720
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17718

def answer
  @answer
end

#detailed_answer ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaAnswer

Defines an answer. Corresponds to the JSON property detailedAnswer

Returns:



17723
17724
17725
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17723

def detailed_answer
  @detailed_answer
end

#detailed_assist_answer ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaAssistAnswer

AssistAnswer resource, main part of AssistResponse. Corresponds to the JSON property detailedAssistAnswer

Returns:



17728
17729
17730
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17728

def detailed_assist_answer
  @detailed_assist_answer
end

#live ⇒ Boolean Also known as: live?

Optional. Indicates whether this turn is a live turn. Corresponds to the JSON property live

Returns:

  • (Boolean) 


17733
17734
17735
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17733

def live
  @live
end

#query ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaQuery

Defines a user inputed query. Corresponds to the JSON property query

Returns:



17739
17740
17741
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17739

def query
  @query
end

#query_config ⇒ Hash<String,String>

Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). The prefix "google." is reserved for Google-developed functionality. Corresponds to the JSON property queryConfig

Returns:

  • (Hash<String,String>) 


17746
17747
17748
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17746

def query_config
  @query_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



17753
17754
17755
17756
17757
17758
17759
17760
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17753

def update!(**args)
  @answer = args[:answer] if args.key?(:answer)
  @detailed_answer = args[:detailed_answer] if args.key?(:detailed_answer)
  @detailed_assist_answer = args[:detailed_assist_answer] if args.key?(:detailed_assist_answer)
  @live = args[:live] if args.key?(:live)
  @query = args[:query] if args.key?(:query)
  @query_config = args[:query_config] if args.key?(:query_config)
end