Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::SessionEvent (v1.40.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::SessionEvent.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#actions

def actions() -> ::Google::Cloud::AIPlatform::V1::EventActions
Returns

#actions=

def actions=(value) -> ::Google::Cloud::AIPlatform::V1::EventActions
Parameter
Returns

#author

def author() -> ::String
Returns
  • (::String) — Required. The name of the agent that sent the event, or user.

#author=

def author=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the agent that sent the event, or user.
Returns
  • (::String) — Required. The name of the agent that sent the event, or user.

#content

def content() -> ::Google::Cloud::AIPlatform::V1::Content
Returns

#content=

def content=(value) -> ::Google::Cloud::AIPlatform::V1::Content
Parameter
Returns

#error_code

def error_code() -> ::String
Returns
  • (::String) — Optional. Error code if the response is an error. Code varies by model.

#error_code=

def error_code=(value) -> ::String
Parameter
  • value (::String) — Optional. Error code if the response is an error. Code varies by model.
Returns
  • (::String) — Optional. Error code if the response is an error. Code varies by model.

#error_message

def error_message() -> ::String
Returns
  • (::String) — Optional. Error message if the response is an error.

#error_message=

def error_message=(value) -> ::String
Parameter
  • value (::String) — Optional. Error message if the response is an error.
Returns
  • (::String) — Optional. Error message if the response is an error.

#event_metadata

def event_metadata() -> ::Google::Cloud::AIPlatform::V1::EventMetadata
Returns

#event_metadata=

def event_metadata=(value) -> ::Google::Cloud::AIPlatform::V1::EventMetadata
Parameter
Returns

#invocation_id

def invocation_id() -> ::String
Returns
  • (::String) — Required. The invocation id of the event, multiple events can have the same invocation id.

#invocation_id=

def invocation_id=(value) -> ::String
Parameter
  • value (::String) — Required. The invocation id of the event, multiple events can have the same invocation id.
Returns
  • (::String) — Required. The invocation id of the event, multiple events can have the same invocation id.

#name

def name() -> ::String
Returns
  • (::String) — Identifier. The resource name of the event. Format:projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. The resource name of the event. Format:projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}.
Returns
  • (::String) — Identifier. The resource name of the event. Format:projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}.

#raw_event

def raw_event() -> ::Google::Protobuf::Struct
Returns

#raw_event=

def raw_event=(value) -> ::Google::Protobuf::Struct
Parameter
Returns

#timestamp

def timestamp() -> ::Google::Protobuf::Timestamp
Returns

#timestamp=

def timestamp=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns