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.



45752
45753
45754
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 45752

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) 


45703
45704
45705
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 45703

def create_time
  @create_time
end

#display_name ⇒ String

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

Returns:

  • (String) 


45708
45709
45710
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 45708

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) 


45715
45716
45717
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 45715

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


45724
45725
45726
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 45724

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) 


45730
45731
45732
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 45730

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


45735
45736
45737
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 45735

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) 


45740
45741
45742
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 45740

def ttl
  @ttl
end

#update_time ⇒ String

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

Returns:

  • (String) 


45745
45746
45747
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 45745

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) 


45750
45751
45752
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 45750

def user_id
  @user_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



45757
45758
45759
45760
45761
45762
45763
45764
45765
45766
45767
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 45757

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