Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSessionTurn

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) ⇒ GoogleCloudDiscoveryengineV1betaSessionTurn

Returns a new instance of GoogleCloudDiscoveryengineV1betaSessionTurn.



33419
33420
33421
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 33419

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) 


33389
33390
33391
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 33389

def answer
  @answer
end

#detailed_answer ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswer

Defines an answer. Corresponds to the JSON property detailedAnswer

Returns:



33394
33395
33396
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 33394

def detailed_answer
  @detailed_answer
end

#detailed_assist_answer ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistAnswer

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

Returns:



33399
33400
33401
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 33399

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) 


33404
33405
33406
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 33404

def live
  @live
end

#query ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaQuery

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

Returns:



33410
33411
33412
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 33410

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>) 


33417
33418
33419
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 33417

def query_config
  @query_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



33424
33425
33426
33427
33428
33429
33430
33431
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 33424

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