Class: Google::Cloud::DiscoveryEngine::V1beta::Session::Turn

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1beta/session.rb

Overview

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

Defined Under Namespace

Classes: QueryConfigEntry

Instance Attribute Summary collapse

Instance Attribute Details

#answer ⇒ ::String

Returns Optional. The resource name of the answer to the user query.

Only set if the answer generation (/answer API call) happened in this turn.

Returns:

  • (::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.



84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/session.rb', line 84

class Turn
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class QueryConfigEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#detailed_answer ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::Answer (readonly)

Returns Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/session.rb', line 84

class Turn
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class QueryConfigEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#query ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::Query

Returns Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn.

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/session.rb', line 84

class Turn
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class QueryConfigEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#query_config ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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.

Returns:

  • (::Google::Protobuf::Map{::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.



84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/session.rb', line 84

class Turn
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class QueryConfigEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end