Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Session

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1/classes.rb,
lib/google/apis/aiplatform_v1/representations.rb,
lib/google/apis/aiplatform_v1/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) ⇒ GoogleCloudAiplatformV1Session

Returns a new instance of GoogleCloudAiplatformV1Session.



42593
42594
42595
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 42593

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) 


42544
42545
42546
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 42544

def create_time
  @create_time
end

#display_name ⇒ String

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

Returns:

  • (String) 


42549
42550
42551
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 42549

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) 


42556
42557
42558
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 42556

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


42565
42566
42567
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 42565

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) 


42571
42572
42573
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 42571

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


42576
42577
42578
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 42576

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) 


42581
42582
42583
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 42581

def ttl
  @ttl
end

#update_time ⇒ String

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

Returns:

  • (String) 


42586
42587
42588
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 42586

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) 


42591
42592
42593
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 42591

def user_id
  @user_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



42598
42599
42600
42601
42602
42603
42604
42605
42606
42607
42608
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 42598

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