Class: Google::Cloud::DiscoveryEngine::V1::Session

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

Overview

External session proto definition.

Defined Under Namespace

Modules: State Classes: Turn

Instance Attribute Summary collapse

Instance Attribute Details

#display_name ⇒ ::String

Returns Optional. The display name of the session.

This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session.

Returns:

  • (::String) —

    Optional. The display name of the session.

    This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/cloud/discoveryengine/v1/session.rb', line 54

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

  # Represents a turn, including a query from the user and a
  # answer from service.
  # @!attribute [rw] query
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Query]
  #     Optional. The user query. May not be set if this turn is merely
  #     regenerating an answer to a different turn
  # @!attribute [rw] answer
  #   @return [::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.
  # @!attribute [r] detailed_answer
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Answer]
  #     Output only. In
  #     {::Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Client#get_session ConversationalSearchService.GetSession}
  #     API, if
  #     {::Google::Cloud::DiscoveryEngine::V1::GetSessionRequest#include_answer_details GetSessionRequest.include_answer_details}
  #     is set to true, this field will be populated when getting answer query
  #     session.
  # @!attribute [rw] query_config
  #   @return [::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.
  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

  # Enumeration of the state of the session.
  module State
    # State is unspecified.
    STATE_UNSPECIFIED = 0

    # The session is currently open.
    IN_PROGRESS = 1
  end
end

#end_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time the session finished.

Returns:



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/cloud/discoveryengine/v1/session.rb', line 54

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

  # Represents a turn, including a query from the user and a
  # answer from service.
  # @!attribute [rw] query
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Query]
  #     Optional. The user query. May not be set if this turn is merely
  #     regenerating an answer to a different turn
  # @!attribute [rw] answer
  #   @return [::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.
  # @!attribute [r] detailed_answer
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Answer]
  #     Output only. In
  #     {::Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Client#get_session ConversationalSearchService.GetSession}
  #     API, if
  #     {::Google::Cloud::DiscoveryEngine::V1::GetSessionRequest#include_answer_details GetSessionRequest.include_answer_details}
  #     is set to true, this field will be populated when getting answer query
  #     session.
  # @!attribute [rw] query_config
  #   @return [::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.
  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

  # Enumeration of the state of the session.
  module State
    # State is unspecified.
    STATE_UNSPECIFIED = 0

    # The session is currently open.
    IN_PROGRESS = 1
  end
end

#is_pinned ⇒ ::Boolean

Returns Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.

Returns:

  • (::Boolean) —

    Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/cloud/discoveryengine/v1/session.rb', line 54

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

  # Represents a turn, including a query from the user and a
  # answer from service.
  # @!attribute [rw] query
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Query]
  #     Optional. The user query. May not be set if this turn is merely
  #     regenerating an answer to a different turn
  # @!attribute [rw] answer
  #   @return [::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.
  # @!attribute [r] detailed_answer
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Answer]
  #     Output only. In
  #     {::Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Client#get_session ConversationalSearchService.GetSession}
  #     API, if
  #     {::Google::Cloud::DiscoveryEngine::V1::GetSessionRequest#include_answer_details GetSessionRequest.include_answer_details}
  #     is set to true, this field will be populated when getting answer query
  #     session.
  # @!attribute [rw] query_config
  #   @return [::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.
  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

  # Enumeration of the state of the session.
  module State
    # State is unspecified.
    STATE_UNSPECIFIED = 0

    # The session is currently open.
    IN_PROGRESS = 1
  end
end

#name ⇒ ::String

Returns Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*.

Returns:

  • (::String) —

    Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/cloud/discoveryengine/v1/session.rb', line 54

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

  # Represents a turn, including a query from the user and a
  # answer from service.
  # @!attribute [rw] query
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Query]
  #     Optional. The user query. May not be set if this turn is merely
  #     regenerating an answer to a different turn
  # @!attribute [rw] answer
  #   @return [::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.
  # @!attribute [r] detailed_answer
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Answer]
  #     Output only. In
  #     {::Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Client#get_session ConversationalSearchService.GetSession}
  #     API, if
  #     {::Google::Cloud::DiscoveryEngine::V1::GetSessionRequest#include_answer_details GetSessionRequest.include_answer_details}
  #     is set to true, this field will be populated when getting answer query
  #     session.
  # @!attribute [rw] query_config
  #   @return [::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.
  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

  # Enumeration of the state of the session.
  module State
    # State is unspecified.
    STATE_UNSPECIFIED = 0

    # The session is currently open.
    IN_PROGRESS = 1
  end
end

#start_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time the session started.

Returns:



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/cloud/discoveryengine/v1/session.rb', line 54

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

  # Represents a turn, including a query from the user and a
  # answer from service.
  # @!attribute [rw] query
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Query]
  #     Optional. The user query. May not be set if this turn is merely
  #     regenerating an answer to a different turn
  # @!attribute [rw] answer
  #   @return [::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.
  # @!attribute [r] detailed_answer
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Answer]
  #     Output only. In
  #     {::Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Client#get_session ConversationalSearchService.GetSession}
  #     API, if
  #     {::Google::Cloud::DiscoveryEngine::V1::GetSessionRequest#include_answer_details GetSessionRequest.include_answer_details}
  #     is set to true, this field will be populated when getting answer query
  #     session.
  # @!attribute [rw] query_config
  #   @return [::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.
  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

  # Enumeration of the state of the session.
  module State
    # State is unspecified.
    STATE_UNSPECIFIED = 0

    # The session is currently open.
    IN_PROGRESS = 1
  end
end

#state ⇒ ::Google::Cloud::DiscoveryEngine::V1::Session::State

Returns The state of the session.

Returns:



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/cloud/discoveryengine/v1/session.rb', line 54

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

  # Represents a turn, including a query from the user and a
  # answer from service.
  # @!attribute [rw] query
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Query]
  #     Optional. The user query. May not be set if this turn is merely
  #     regenerating an answer to a different turn
  # @!attribute [rw] answer
  #   @return [::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.
  # @!attribute [r] detailed_answer
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Answer]
  #     Output only. In
  #     {::Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Client#get_session ConversationalSearchService.GetSession}
  #     API, if
  #     {::Google::Cloud::DiscoveryEngine::V1::GetSessionRequest#include_answer_details GetSessionRequest.include_answer_details}
  #     is set to true, this field will be populated when getting answer query
  #     session.
  # @!attribute [rw] query_config
  #   @return [::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.
  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

  # Enumeration of the state of the session.
  module State
    # State is unspecified.
    STATE_UNSPECIFIED = 0

    # The session is currently open.
    IN_PROGRESS = 1
  end
end

#turns ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::Session::Turn>

Returns Turns.

Returns:



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/cloud/discoveryengine/v1/session.rb', line 54

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

  # Represents a turn, including a query from the user and a
  # answer from service.
  # @!attribute [rw] query
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Query]
  #     Optional. The user query. May not be set if this turn is merely
  #     regenerating an answer to a different turn
  # @!attribute [rw] answer
  #   @return [::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.
  # @!attribute [r] detailed_answer
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Answer]
  #     Output only. In
  #     {::Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Client#get_session ConversationalSearchService.GetSession}
  #     API, if
  #     {::Google::Cloud::DiscoveryEngine::V1::GetSessionRequest#include_answer_details GetSessionRequest.include_answer_details}
  #     is set to true, this field will be populated when getting answer query
  #     session.
  # @!attribute [rw] query_config
  #   @return [::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.
  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

  # Enumeration of the state of the session.
  module State
    # State is unspecified.
    STATE_UNSPECIFIED = 0

    # The session is currently open.
    IN_PROGRESS = 1
  end
end

#user_pseudo_id ⇒ ::String

Returns A unique identifier for tracking users.

Returns:

  • (::String) —

    A unique identifier for tracking users.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/cloud/discoveryengine/v1/session.rb', line 54

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

  # Represents a turn, including a query from the user and a
  # answer from service.
  # @!attribute [rw] query
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Query]
  #     Optional. The user query. May not be set if this turn is merely
  #     regenerating an answer to a different turn
  # @!attribute [rw] answer
  #   @return [::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.
  # @!attribute [r] detailed_answer
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Answer]
  #     Output only. In
  #     {::Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Client#get_session ConversationalSearchService.GetSession}
  #     API, if
  #     {::Google::Cloud::DiscoveryEngine::V1::GetSessionRequest#include_answer_details GetSessionRequest.include_answer_details}
  #     is set to true, this field will be populated when getting answer query
  #     session.
  # @!attribute [rw] query_config
  #   @return [::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.
  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

  # Enumeration of the state of the session.
  module State
    # State is unspecified.
    STATE_UNSPECIFIED = 0

    # The session is currently open.
    IN_PROGRESS = 1
  end
end