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.



55397
55398
55399
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 55397

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) 


55348
55349
55350
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 55348

def create_time
  @create_time
end

#display_name ⇒ String

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

Returns:

  • (String) 


55353
55354
55355
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 55353

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) 


55360
55361
55362
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 55360

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


55369
55370
55371
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 55369

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) 


55375
55376
55377
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 55375

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


55380
55381
55382
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 55380

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) 


55385
55386
55387
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 55385

def ttl
  @ttl
end

#update_time ⇒ String

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

Returns:

  • (String) 


55390
55391
55392
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 55390

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) 


55395
55396
55397
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 55395

def user_id
  @user_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



55402
55403
55404
55405
55406
55407
55408
55409
55410
55411
55412
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 55402

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