Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Session

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

Overview

A session contains a set of actions between users and Vertex agents.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1Session

Returns a new instance of GoogleCloudAiplatformV1beta1Session.



58159
58160
58161
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 58159

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

Instance Attribute Details

#create_time ⇒ String

Output only. Timestamp when the session was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


58110
58111
58112
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 58110

def create_time
  @create_time
end

#display_name ⇒ String

Optional. The display name of the session. Corresponds to the JSON property displayName

Returns:

  • (String) 


58115
58116
58117
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 58115

def display_name
  @display_name
end

#expire_time ⇒ String

Optional. Timestamp of when this session is considered expired. This is * always* provided on output, regardless of what was sent on input. The minimum value is 24 hours from the time of creation. Corresponds to the JSON property expireTime

Returns:

  • (String) 


58122
58123
58124
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 58122

def expire_time
  @expire_time
end

#labels ⇒ Hash<String,String>

The labels with user-defined metadata to organize your Sessions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


58131
58132
58133
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 58131

def labels
  @labels
end

#name ⇒ String

Identifier. The resource name of the session. Format: 'projects/project/ locations/location/reasoningEngines/reasoning_engine/sessions/session'. Corresponds to the JSON property name

Returns:

  • (String) 


58137
58138
58139
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 58137

def name
  @name
end

#session_state ⇒ Hash<String,Object>

Optional. Session specific memory which stores key conversation points. Corresponds to the JSON property sessionState

Returns:

  • (Hash<String,Object>) 


58142
58143
58144
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 58142

def session_state
  @session_state
end

#ttl ⇒ String

Optional. Input only. The TTL for this session. The minimum value is 24 hours. Corresponds to the JSON property ttl

Returns:

  • (String) 


58147
58148
58149
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 58147

def ttl
  @ttl
end

#update_time ⇒ String

Output only. Timestamp when the session was updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


58152
58153
58154
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 58152

def update_time
  @update_time
end

#user_id ⇒ String

Required. Immutable. String id provided by the user Corresponds to the JSON property userId

Returns:

  • (String) 


58157
58158
58159
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 58157

def user_id
  @user_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



58164
58165
58166
58167
58168
58169
58170
58171
58172
58173
58174
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 58164

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @expire_time = args[:expire_time] if args.key?(:expire_time)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @session_state = args[:session_state] if args.key?(:session_state)
  @ttl = args[:ttl] if args.key?(:ttl)
  @update_time = args[:update_time] if args.key?(:update_time)
  @user_id = args[:user_id] if args.key?(:user_id)
end