Class AsyncSessionEvents (1.135.0)

AsyncSessionEvents(api_client_: google.genai._api_client.BaseApiClient)

API documentation for AsyncSessionEvents class.

Methods

append

append(
    *,
    name: str,
    author: str,
    invocation_id: str,
    timestamp: datetime.datetime,
    config: typing.Optional[
        typing.Union[
            vertexai._genai.types.common.AppendAgentEngineSessionEventConfig,
            vertexai._genai.types.common.AppendAgentEngineSessionEventConfigDict,
        ]
    ] = None
) -> vertexai._genai.types.common.AppendAgentEngineSessionEventResponse

Appends Agent Engine session event.

Parameters
Name Description
name str

Required. The name of the Agent Engine session to append the event to. Format: projects/{project}/locations/{location}/reasoningEngines/{resource_id}/sessions/{session_id}.

author str

Required. The author of the Agent Engine session event.

invocation_id str

Required. The invocation ID of the Agent Engine session event.

timestamp datetime.datetime

Required. The timestamp of the Agent Engine session event.

config AppendAgentEngineSessionEventConfig

Optional. Additional configurations for appending the Agent Engine session event.

Returns
Type Description
AppendAgentEngineSessionEventResponse The requested Agent Engine session event.

list

list(
    *,
    name: str,
    config: typing.Optional[
        typing.Union[
            vertexai._genai.types.common.ListAgentEngineSessionEventsConfig,
            vertexai._genai.types.common.ListAgentEngineSessionEventsConfigDict,
        ]
    ] = None
) -> google.genai.pagers.AsyncPager[vertexai._genai.types.common.SessionEvent]

Lists Agent Engine session events.

Parameters
Name Description
name str

Required. The name of the agent engine to list session events for.

config ListAgentEngineSessionEventsConfig

Optional. The configuration for the session events to list. Currently, the filter field in config only supports filtering by timestamp. The timestamp value must be enclosed in double quotes and include the time zone information. For example: config={'filter': 'timestamp>="2025-08-07T19:44:38.4Z"'}.

Returns
Type Description
AsyncPager[SessionEvent] An async pager of session events.