Class: Google::Apis::CesV1::Tool

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/ces_v1/classes.rb,
lib/google/apis/ces_v1/representations.rb,
lib/google/apis/ces_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Tool

Returns a new instance of Tool.



6452
6453
6454
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6452

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#agent_tool ⇒ Google::Apis::CesV1::AgentTool

Represents a tool that allows the agent to call another agent. Corresponds to the JSON property agentTool

Returns:



6336
6337
6338
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6336

def agent_tool
  @agent_tool
end

#client_function ⇒ Google::Apis::CesV1::ClientFunction

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. Corresponds to the JSON property clientFunction

Returns:



6344
6345
6346
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6344

def client_function
  @client_function
end

#connector_tool ⇒ Google::Apis::CesV1::ConnectorTool

A ConnectorTool allows connections to different integrations. See: https:// cloud.google.com/integration-connectors/docs/overview. Corresponds to the JSON property connectorTool

Returns:



6350
6351
6352
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6350

def connector_tool
  @connector_tool
end

#create_time ⇒ String

Output only. Timestamp when the tool was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


6355
6356
6357
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6355

def create_time
  @create_time
end

#data_store_tool ⇒ Google::Apis::CesV1::DataStoreTool

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. Corresponds to the JSON property dataStoreTool

Returns:



6363
6364
6365
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6363

def data_store_tool
  @data_store_tool
end

#display_name ⇒ String

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. Corresponds to the JSON property displayName

Returns:

  • (String) 


6370
6371
6372
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6370

def display_name
  @display_name
end

#etag ⇒ String

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. Corresponds to the JSON property etag

Returns:

  • (String) 


6377
6378
6379
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6377

def etag
  @etag
end

#execution_type ⇒ String

Optional. The execution type of the tool. Corresponds to the JSON property executionType

Returns:

  • (String) 


6382
6383
6384
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6382

def execution_type
  @execution_type
end

#file_search_tool ⇒ Google::Apis::CesV1::FileSearchTool

The file search tool allows the agent to search across the files uploaded by the app/agent developer. It has presets to give relatively good quality search over the uploaded files and summarization of the retrieved results. Corresponds to the JSON property fileSearchTool

Returns:



6389
6390
6391
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6389

def file_search_tool
  @file_search_tool
end

#generated_summary ⇒ String

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

Returns:

  • (String) 


6395
6396
6397
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6395

def generated_summary
  @generated_summary
end

#google_search_tool ⇒ Google::Apis::CesV1::GoogleSearchTool

Represents a tool to perform Google web searches for grounding. See https:// cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google- search. Corresponds to the JSON property googleSearchTool

Returns:



6402
6403
6404
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6402

def google_search_tool
  @google_search_tool
end

#mcp_tool ⇒ Google::Apis::CesV1::McpTool

An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/ server/tools for more details. Corresponds to the JSON property mcpTool

Returns:



6408
6409
6410
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6408

def mcp_tool
  @mcp_tool
end

#name ⇒ String

Identifier. The resource name of the tool. Format: * projects/project/ locations/location/apps/app/tools/toolfor 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. Corresponds to the JSON property name

Returns:

  • (String) 


6417
6418
6419
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6417

def name
  @name
end

#open_api_tool ⇒ Google::Apis::CesV1::OpenApiTool

A remote API tool defined by an OpenAPI schema. Corresponds to the JSON property openApiTool

Returns:



6422
6423
6424
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6422

def open_api_tool
  @open_api_tool
end

#python_function ⇒ Google::Apis::CesV1::PythonFunction

A Python function tool. Corresponds to the JSON property pythonFunction

Returns:



6427
6428
6429
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6427

def python_function
  @python_function
end

#system_tool ⇒ Google::Apis::CesV1::SystemTool

Pre-defined system tool. Corresponds to the JSON property systemTool

Returns:



6432
6433
6434
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6432

def system_tool
  @system_tool
end

#tool_fake_config ⇒ Google::Apis::CesV1::ToolFakeConfig

Configuration for tool behavior in fake mode. Corresponds to the JSON property toolFakeConfig

Returns:



6437
6438
6439
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6437

def tool_fake_config
  @tool_fake_config
end

#update_time ⇒ String

Output only. Timestamp when the tool was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


6442
6443
6444
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6442

def update_time
  @update_time
end

#widget_tool ⇒ Google::Apis::CesV1::WidgetTool

Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. Corresponds to the JSON property widgetTool

Returns:



6450
6451
6452
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6450

def widget_tool
  @widget_tool
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6457

def update!(**args)
  @agent_tool = args[:agent_tool] if args.key?(:agent_tool)
  @client_function = args[:client_function] if args.key?(:client_function)
  @connector_tool = args[:connector_tool] if args.key?(:connector_tool)
  @create_time = args[:create_time] if args.key?(:create_time)
  @data_store_tool = args[:data_store_tool] if args.key?(:data_store_tool)
  @display_name = args[:display_name] if args.key?(:display_name)
  @etag = args[:etag] if args.key?(:etag)
  @execution_type = args[:execution_type] if args.key?(:execution_type)
  @file_search_tool = args[:file_search_tool] if args.key?(:file_search_tool)
  @generated_summary = args[:generated_summary] if args.key?(:generated_summary)
  @google_search_tool = args[:google_search_tool] if args.key?(:google_search_tool)
  @mcp_tool = args[:mcp_tool] if args.key?(:mcp_tool)
  @name = args[:name] if args.key?(:name)
  @open_api_tool = args[:open_api_tool] if args.key?(:open_api_tool)
  @python_function = args[:python_function] if args.key?(:python_function)
  @system_tool = args[:system_tool] if args.key?(:system_tool)
  @tool_fake_config = args[:tool_fake_config] if args.key?(:tool_fake_config)
  @update_time = args[:update_time] if args.key?(:update_time)
  @widget_tool = args[:widget_tool] if args.key?(:widget_tool)
end