Class AsyncAgentEngines (1.122.0)

Version latest

• 1.122.0 (latest)
• 1.121.0
• 1.120.0
• 1.119.0
• 1.118.0
• 1.117.0
• 1.95.1
• 1.94.0
• 1.93.1
• 1.92.0
• 1.91.0
• 1.90.0
• 1.89.0
• 1.88.0
• 1.87.0
• 1.86.0
• 1.85.0
• 1.84.0
• 1.83.0
• 1.82.0
• 1.81.0
• 1.80.0
• 1.79.0
• 1.78.0
• 1.77.0
• 1.76.0
• 1.75.0
• 1.74.0
• 1.73.0
• 1.72.0
• 1.71.1
• 1.70.0
• 1.69.0
• 1.68.0
• 1.67.1
• 1.66.0
• 1.65.0
• 1.63.0
• 1.62.0
• 1.60.0
• 1.59.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.