events

Creates, updates, deletes, gets or lists an events resource.

Overview

Name	events
Type	Resource
Id	google.aiplatform.events

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
name	string	Identifier. The resource name of the event. Format:projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}.
actions	object	Optional. Actions executed by the agent. (id: GoogleCloudAiplatformV1EventActions)
author	string	Required. The name of the agent that sent the event, or user.
content	object	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. (id: GoogleCloudAiplatformV1Content)
errorCode	string	Optional. Error code if the response is an error. Code varies by model.
errorMessage	string	Optional. Error message if the response is an error.
eventMetadata	object	Optional. Metadata relating to this event. (id: GoogleCloudAiplatformV1EventMetadata)
invocationId	string	Required. The invocation id of the event, multiple events can have the same invocation id.
timestamp	string (google-datetime)	Required. Timestamp when the event was created on client side.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	projectsId, locationsId, reasoningEnginesId, sessionsId	orderBy, pageToken, pageSize, filter	Lists Events in a given session.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
reasoningEnginesId	string
sessionsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

list

Lists Events in a given session.

SELECT
name,
actions,
author,
content,
errorCode,
errorMessage,
eventMetadata,
invocationId,
timestamp
FROM google.aiplatform.events
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND reasoningEnginesId = '{{ reasoningEnginesId }}' -- required
AND sessionsId = '{{ sessionsId }}' -- required
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND filter = '{{ filter }}'
;