Class AsyncAgentEngines (1.121.0)

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

API documentation for AsyncAgentEngines class.

Properties

memories

API documentation for memories property.

sessions

API documentation for sessions property.

Methods

append_session_event

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

Deprecated. Use agent_engines.sessions.events.append instead.

delete

delete(
 *,
 name: str,
 force: typing.Optional[bool] = None,
 config: typing.Optional[
 typing.Union[
 vertexai._genai.types.DeleteAgentEngineConfig,
 vertexai._genai.types.DeleteAgentEngineConfigDict,
 ]
 ] = None
) -> vertexai._genai.types.DeleteAgentEngineOperation

Delete an Agent Engine resource.

Parameters
Name Description
name str

Required. The name of the Agent Engine to be deleted. Format: projects/{project}/locations/{location}/reasoningEngines/{resource_id} or reasoningEngines/{resource_id}.

force bool

Optional. If set to True, child resources will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the Agent Engine has undeleted child resources. Defaults to False.

config DeleteAgentEngineConfig

Optional. Additional configurations for deleting the Agent Engine.

delete_memory

delete_memory(
 *,
 name: str,
 config: typing.Optional[
 typing.Union[
 vertexai._genai.types.DeleteAgentEngineMemoryConfig,
 vertexai._genai.types.DeleteAgentEngineMemoryConfigDict,
 ]
 ] = None
) -> vertexai._genai.types.DeleteAgentEngineMemoryOperation

Deprecated. Use agent_engines.memories.delete instead.

delete_session

delete_session(
 *,
 name: str,
 config: typing.Optional[
 typing.Union[
 vertexai._genai.types.DeleteAgentEngineSessionConfig,
 vertexai._genai.types.DeleteAgentEngineSessionConfigDict,
 ]
 ] = None
) -> vertexai._genai.types.DeleteAgentEngineSessionOperation

Deprecated. Use agent_engines.sessions.delete instead.

get_memory

get_memory(
 *,
 name: str,
 config: typing.Optional[
 typing.Union[
 vertexai._genai.types.GetAgentEngineMemoryConfig,
 vertexai._genai.types.GetAgentEngineMemoryConfigDict,
 ]
 ] = None
) -> vertexai._genai.types.Memory

Deprecated. Use agent_engines.memories.get instead.

get_session

get_session(
 *,
 name: str,
 config: typing.Optional[
 typing.Union[
 vertexai._genai.types.GetAgentEngineSessionConfig,
 vertexai._genai.types.GetAgentEngineSessionConfigDict,
 ]
 ] = None
) -> vertexai._genai.types.Session

Deprecated. Use agent_engines.sessions.get instead.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月15日 UTC.