Tool

import type { Tool } from "https://googleapis.deno.dev/v1/ces:v1.ts";

A tool represents an action that the CES agent can take to achieve certain goals.

interface Tool {

clientFunction?: ClientFunction;

connectorTool?: ConnectorTool;

readonly createTime?: Date;

dataStoreTool?: DataStoreTool;

readonly displayName?: string;

etag?: string;

executionType?: "EXECUTION_TYPE_UNSPECIFIED" | "SYNCHRONOUS" | "ASYNCHRONOUS";

fileSearchTool?: FileSearchTool;

readonly generatedSummary?: string;

googleSearchTool?: GoogleSearchTool;

mcpTool?: McpTool;

name?: string;

openApiTool?: OpenApiTool;

pythonFunction?: PythonFunction;

systemTool?: SystemTool;

toolFakeConfig?: ToolFakeConfig;

readonly updateTime?: Date;

widgetTool?: WidgetTool;

}

§Properties

clientFunction?: ClientFunction

[src]

Optional. The client function.

connectorTool?: ConnectorTool

[src]

Optional. The Integration Connector tool.

readonly createTime?: Date

[src]

Output only. Timestamp when the tool was created.

dataStoreTool?: DataStoreTool

[src]

Optional. The data store tool.

readonly displayName?: string

[src]

Output only. The display name of the tool, derived based on the tool's type. For example, display name of a ClientFunction is derived from its name property.

etag?: string

[src]

Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

executionType?: "EXECUTION_TYPE_UNSPECIFIED" | "SYNCHRONOUS" | "ASYNCHRONOUS"

[src]

Optional. The execution type of the tool.

fileSearchTool?: FileSearchTool

[src]

Optional. The file search tool.

readonly generatedSummary?: string

[src]

Output only. If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.

googleSearchTool?: GoogleSearchTool

[src]

Optional. The google search tool.

mcpTool?: McpTool

[src]

Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.

name?: string

[src]

Identifier. The unique identifier of the tool. Format: - projects/{project}/locations/{location}/apps/{app}/tools/{tool} for ## standalone tools. projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool} for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected.

openApiTool?: OpenApiTool

[src]

Optional. The open API tool.

pythonFunction?: PythonFunction

[src]

Optional. The python function tool.

systemTool?: SystemTool

[src]

Optional. The system tool.

toolFakeConfig?: ToolFakeConfig

[src]

Optional. Configuration for tool behavior in fake mode.

readonly updateTime?: Date

[src]

Output only. Timestamp when the tool was last updated.

widgetTool?: WidgetTool

[src]

Optional. The widget tool.