SessionEvent

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

Fields
name string

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

author string

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

content object (Content)

Optional. Content of the event provided by the author.

invocationId string

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

actions object (EventActions)

Optional. Actions executed by the agent.

timestamp string (Timestamp format)

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

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

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

Optional. metadata relating to this event.

JSON representation 
{
  "name": string,
  "author": string,
  "content": {
    object (Content)
  },
  "invocationId": string,
  "actions": {
    object (EventActions)
  },
  "timestamp": string,
  "errorCode": string,
  "errorMessage": string,
  "eventMetadata": {
    object (EventMetadata)
  }
}

EventActions

Actions are parts of events that are executed by the agent.

Fields
skipSummarization boolean

Optional. If true, it won't call model to summarize function response. Only used for functionResponse event.

stateDelta object (Struct format)

Optional. Indicates that the event is updating the state with the given delta.

artifactDelta map (key: string, value: integer)

Optional. Indicates that the event is updating an artifact. key is the filename, value is the version.

transferToAgent
(deprecated) boolean

Deprecated. If set, the event transfers to the specified agent.

escalate boolean

Optional. The agent is escalating to a higher level agent.

requestedAuthConfigs object (Struct format)

Optional. Will only be set by a tool response indicating tool request euc. Struct key is the function call id since one function call response (from model) could correspond to multiple function calls. Struct value is the required auth config, which can be another struct.

transferAgent string

Optional. If set, the event transfers to the specified agent.

JSON representation 
{
  "skipSummarization": boolean,
  "stateDelta": {
    object
  },
  "artifactDelta": {
    string: integer,
    ...
  },
  "transferToAgent": boolean,
  "escalate": boolean,
  "requestedAuthConfigs": {
    object
  },
  "transferAgent": string
}

EventMetadata

metadata relating to a LLM response event.

Fields
groundingMetadata object (GroundingMetadata)

Optional. metadata returned to client when grounding is enabled.

partial boolean

Optional. Indicates whether the text content is part of a unfinished text stream. Only used for streaming mode and when the content is plain text.

turnComplete boolean

Optional. Indicates whether the response from the model is complete. Only used for streaming mode.

interrupted boolean

Optional. Flag indicating that LLM was interrupted when generating the content. Usually it's due to user interruption during a bidi streaming.

longRunningToolIds[] string

Optional. Set of ids of the long running function calls. Agent client will know from this field about which function call is long running. Only valid for function call event.

branch string

Optional. The branch of the event. The format is like agent_1.agent_2.agent_3, where agent_1 is the parent of agent_2, and agent_2 is the parent of agent_3. Branch is used when multiple child agents shouldn't see their siblings' conversation history.

customMetadata object (Struct format)

The custom metadata of the LlmResponse.

JSON representation 
{
  "groundingMetadata": {
    object (GroundingMetadata)
  },
  "partial": boolean,
  "turnComplete": boolean,
  "interrupted": boolean,
  "longRunningToolIds": [
    string
  ],
  "branch": string,
  "customMetadata": {
    object
  }
}