Google Cloud Ai Platform V1 Client - Class SessionEvent (1.60.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class SessionEvent.

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

Generated from protobuf message google.cloud.aiplatform.v1.SessionEvent

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Identifier. The resource name of the event. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event} .

↳ author
string

Required. The name of the agent that sent the event, or user.

↳ content
Content

Optional. Content of the event provided by the author.

↳ invocation_id
string

Required. The invocation id of the event, multiple events can have the same invocation id.

↳ actions
EventActions

Optional. Actions executed by the agent.

↳ timestamp
Google\Protobuf\Timestamp

Required. Timestamp when the event was created on client side.

↳ error_code
string

Optional. Error code if the response is an error. Code varies by model.

↳ error_message
string

Optional. Error message if the response is an error.

↳ event_metadata
EventMetadata

Optional. Metadata relating to this event.

↳ raw_event
Google\Protobuf\Struct

Optional. Weakly typed raw event data in proto struct format.

getName

Identifier. The resource name of the event.

Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event} .

Returns
Type
Description
string

setName

Identifier. The resource name of the event.

Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event} .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getAuthor

Required. The name of the agent that sent the event, or user.

Returns
Type
Description
string

setAuthor

Required. The name of the agent that sent the event, or user.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getContent

Optional. Content of the event provided by the author.

Returns
Type
Description
Content |null

hasContent

clearContent

setContent

Optional. Content of the event provided by the author.

Parameter
Name
Description
var
Returns
Type
Description
$this

getInvocationId

Required. The invocation id of the event, multiple events can have the same invocation id.

Returns
Type
Description
string

setInvocationId

Required. The invocation id of the event, multiple events can have the same invocation id.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getActions

Optional. Actions executed by the agent.

Returns
Type
Description
EventActions |null

hasActions

clearActions

setActions

Optional. Actions executed by the agent.

Parameter
Name
Description
Returns
Type
Description
$this

getTimestamp

Required. Timestamp when the event was created on client side.

Returns
Type
Description

hasTimestamp

clearTimestamp

setTimestamp

Required. Timestamp when the event was created on client side.

Parameter
Name
Description
Returns
Type
Description
$this

getErrorCode

Optional. Error code if the response is an error. Code varies by model.

Returns
Type
Description
string

setErrorCode

Optional. Error code if the response is an error. Code varies by model.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getErrorMessage

Optional. Error message if the response is an error.

Returns
Type
Description
string

setErrorMessage

Optional. Error message if the response is an error.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

Optional. Metadata relating to this event.

Returns
Type
Description

Optional. Metadata relating to this event.

Parameter
Name
Description
Returns
Type
Description
$this

getRawEvent

Optional. Weakly typed raw event data in proto struct format.

Returns
Type
Description

hasRawEvent

clearRawEvent

setRawEvent

Optional. Weakly typed raw event data in proto struct format.

Parameter
Name
Description
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: