ToolArgs class

The set of arguments for Tool. The set of arguments for Tool.

Constructors

ToolArgs({Input<ToolAgentTool?>? agentTool, required Input<String> app, Input<ToolClientFunction?>? clientFunction, Input<ToolDataStoreTool?>? dataStoreTool, Input<String?>? deletionPolicy, Input<String?>? executionType, Input<ToolFileSearchTool?>? fileSearchTool, Input<ToolGoogleSearchTool?>? googleSearchTool, required Input<String> location, Input<String?>? project, Input<ToolPythonFunction?>? pythonFunction, Input<String?>? timeout, Input<ToolToolFakeConfig?>? toolFakeConfig, required Input<String> toolId, Input<ToolWidgetTool?>? widgetTool})

Creates a new ToolArgs. agentTool Represents a tool that allows the agent to call another agent. app Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. clientFunction Represents a client-side function that the agent can invoke. When the dataStoreTool Tool to retrieve from Vertex AI Search datastore or engine for grounding. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. executionType Possible values: fileSearchTool The file search tool allows the agent to search across the files uploaded by the googleSearchTool Represents a tool to perform Google web searches for grounding. location Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. project The ID of the project in which the resource belongs. pythonFunction A Python function tool. timeout The timeout for the tool execution. If not set, the default timeout is 30 toolFakeConfig Configuration for tool behavior in fake mode. toolId The ID to use for the tool, which will become the final component of widgetTool Represents a widget tool that the agent can invoke.

const

ToolArgs.fromMap(Map<String, dynamic> map)

factory

Properties

agentTool → Input<ToolAgentTool?>?

Represents a tool that allows the agent to call another agent. Structure is documented below.

final

app → Input<String>

Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.

final

clientFunction → Input<ToolClientFunction?>?

Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. Structure is documented below.

final

dataStoreTool → Input<ToolDataStoreTool?>?

Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction. Structure is documented below.

final

deletionPolicy → Input<String?>?

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

final

executionType → Input<String?>?

Possible values: SYNCHRONOUS ASYNCHRONOUS

final

fileSearchTool → Input<ToolFileSearchTool?>?

The file search tool allows the agent to search across the files uploaded by the app/agent developer. Structure is documented below.

final

googleSearchTool → Input<ToolGoogleSearchTool?>?

Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/vertex-ai/generative-ai/docs/grounding/grounding-with-google-search. Structure is documented below.

final

hashCode → int

The hash code for this object.

no setter, inherited

location → Input<String>

Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.

final

project → Input<String?>?

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

final

pythonFunction → Input<ToolPythonFunction?>?

A Python function tool. Structure is documented below.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

timeout → Input<String?>?

The timeout for the tool execution. If not set, the default timeout is 30 seconds for SYNCHRONOUS tools and 60 seconds for ASYNCHRONOUS tools.

final

toolFakeConfig → Input<ToolToolFakeConfig?>?

Configuration for tool behavior in fake mode. Structure is documented below.

final

toolId → Input<String>

The ID to use for the tool, which will become the final component of the tool's resource name. If not provided, a unique ID will be automatically assigned for the tool.

final

widgetTool → Input<ToolWidgetTool?>?

Represents a widget tool that the agent can invoke. Structure is documented below.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited