Class AgentEngine (1.129.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

AgentEngine(
    *,
    apiClient: typing.Optional[typing.Any] = None,
    apiAsyncClient: typing.Optional[typing.Any] = None,
    apiResource: typing.Optional[vertexai._genai.types.common.ReasoningEngine] = None,
    **extra_data: typing.Any
)

An agent engine instance.

Methods

AgentEngine

AgentEngine(
    *,
    apiClient: typing.Optional[typing.Any] = None,
    apiAsyncClient: typing.Optional[typing.Any] = None,
    apiResource: typing.Optional[vertexai._genai.types.common.ReasoningEngine] = None,
    **extra_data: typing.Any
)

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

delete

delete(
    force: bool = False,
    config: typing.Optional[
        typing.Union[
            vertexai._genai.types.common.DeleteAgentEngineConfig,
            vertexai._genai.types.common.DeleteAgentEngineConfigDict,
        ]
    ] = None,
) -> None

Deletes the agent engine.

Parameters
Name	Description
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.

operation_schemas

operation_schemas() -> typing.Optional[list[typing.Dict[str, typing.Any]]]

Returns the schemas of all registered operations for the agent.