Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SessionEvent

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

An event represents a message from either the user or agent.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1SessionEvent

Returns a new instance of GoogleCloudAiplatformV1SessionEvent.



44788
44789
44790
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 44788

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

Instance Attribute Details

#actions ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EventActions

Actions are parts of events that are executed by the agent. Corresponds to the JSON property actions

Returns:



44736
44737
44738
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 44736

def actions
  @actions
end

#author ⇒ String

Required. The name of the agent that sent the event, or user. Corresponds to the JSON property author

Returns:

  • (String) 


44741
44742
44743
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 44741

def author
  @author
end

#content ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content

The structured data content of a message. A Content message contains a role field, which indicates the producer of the content, and a parts field, which contains the multi-part data of the message. Corresponds to the JSON property content

Returns:



44748
44749
44750
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 44748

def content
  @content
end

#error_code ⇒ String

Optional. Error code if the response is an error. Code varies by model. Corresponds to the JSON property errorCode

Returns:

  • (String) 


44753
44754
44755
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 44753

def error_code
  @error_code
end

#error_message ⇒ String

Optional. Error message if the response is an error. Corresponds to the JSON property errorMessage

Returns:

  • (String) 


44758
44759
44760
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 44758

def error_message
  @error_message
end

#event_metadata ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EventMetadata

Metadata relating to a LLM response event. Corresponds to the JSON property eventMetadata

Returns:



44763
44764
44765
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 44763

def event_metadata
  @event_metadata
end

#invocation_id ⇒ String

Required. The invocation id of the event, multiple events can have the same invocation id. Corresponds to the JSON property invocationId

Returns:

  • (String) 


44769
44770
44771
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 44769

def invocation_id
  @invocation_id
end

#name ⇒ String

Identifier. The resource name of the event. Format:projects/project/ locations/location/reasoningEngines/reasoning_engine/sessions/session/ events/event`. Corresponds to the JSON propertyname`

Returns:

  • (String) 


44776
44777
44778
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 44776

def name
  @name
end

#raw_event ⇒ Hash<String,Object>

Optional. Weakly typed raw event data in proto struct format. Corresponds to the JSON property rawEvent

Returns:

  • (Hash<String,Object>) 


44781
44782
44783
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 44781

def raw_event
  @raw_event
end

#timestamp ⇒ String

Required. Timestamp when the event was created on client side. Corresponds to the JSON property timestamp

Returns:

  • (String) 


44786
44787
44788
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 44786

def timestamp
  @timestamp
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



44793
44794
44795
44796
44797
44798
44799
44800
44801
44802
44803
44804
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 44793

def update!(**args)
  @actions = args[:actions] if args.key?(:actions)
  @author = args[:author] if args.key?(:author)
  @content = args[:content] if args.key?(:content)
  @error_code = args[:error_code] if args.key?(:error_code)
  @error_message = args[:error_message] if args.key?(:error_message)
  @event_metadata = args[:event_metadata] if args.key?(:event_metadata)
  @invocation_id = args[:invocation_id] if args.key?(:invocation_id)
  @name = args[:name] if args.key?(:name)
  @raw_event = args[:raw_event] if args.key?(:raw_event)
  @timestamp = args[:timestamp] if args.key?(:timestamp)
end