Gemini Enterprise for Customer Experience V1BETA API - Class Google::Cloud::Ces::V1beta::Tool (v0.1.0)

Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1BETA API class Google::Cloud::Ces::V1beta::Tool.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#agent_tool

def agent_tool() -> ::Google::Cloud::Ces::V1beta::AgentTool
Returns
  • (::Google::Cloud::Ces::V1beta::AgentTool) — Optional. The agent tool.

    Note: The following fields are mutually exclusive: agent_tool, client_function, open_api_tool, google_search_tool, connector_tool, data_store_tool, python_function, mcp_tool, file_search_tool, system_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

#agent_tool=

def agent_tool=(value) -> ::Google::Cloud::Ces::V1beta::AgentTool
Parameter
  • value (::Google::Cloud::Ces::V1beta::AgentTool) — Optional. The agent tool.

    Note: The following fields are mutually exclusive: agent_tool, client_function, open_api_tool, google_search_tool, connector_tool, data_store_tool, python_function, mcp_tool, file_search_tool, system_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Ces::V1beta::AgentTool) — Optional. The agent tool.

    Note: The following fields are mutually exclusive: agent_tool, client_function, open_api_tool, google_search_tool, connector_tool, data_store_tool, python_function, mcp_tool, file_search_tool, system_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

#client_function

def client_function() -> ::Google::Cloud::Ces::V1beta::ClientFunction
Returns
  • (::Google::Cloud::Ces::V1beta::ClientFunction) — Optional. The client function.

    Note: The following fields are mutually exclusive: client_function, open_api_tool, google_search_tool, connector_tool, data_store_tool, python_function, mcp_tool, file_search_tool, system_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

#client_function=

def client_function=(value) -> ::Google::Cloud::Ces::V1beta::ClientFunction
Parameter
  • value (::Google::Cloud::Ces::V1beta::ClientFunction) — Optional. The client function.

    Note: The following fields are mutually exclusive: client_function, open_api_tool, google_search_tool, connector_tool, data_store_tool, python_function, mcp_tool, file_search_tool, system_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Ces::V1beta::ClientFunction) — Optional. The client function.

    Note: The following fields are mutually exclusive: client_function, open_api_tool, google_search_tool, connector_tool, data_store_tool, python_function, mcp_tool, file_search_tool, system_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

#connector_tool

def connector_tool() -> ::Google::Cloud::Ces::V1beta::ConnectorTool
Returns
  • (::Google::Cloud::Ces::V1beta::ConnectorTool) — Optional. The Integration Connector tool.

    Note: The following fields are mutually exclusive: connector_tool, client_function, open_api_tool, google_search_tool, data_store_tool, python_function, mcp_tool, file_search_tool, system_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

#connector_tool=

def connector_tool=(value) -> ::Google::Cloud::Ces::V1beta::ConnectorTool
Parameter
  • value (::Google::Cloud::Ces::V1beta::ConnectorTool) — Optional. The Integration Connector tool.

    Note: The following fields are mutually exclusive: connector_tool, client_function, open_api_tool, google_search_tool, data_store_tool, python_function, mcp_tool, file_search_tool, system_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Ces::V1beta::ConnectorTool) — Optional. The Integration Connector tool.

    Note: The following fields are mutually exclusive: connector_tool, client_function, open_api_tool, google_search_tool, data_store_tool, python_function, mcp_tool, file_search_tool, system_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#data_store_tool

def data_store_tool() -> ::Google::Cloud::Ces::V1beta::DataStoreTool
Returns
  • (::Google::Cloud::Ces::V1beta::DataStoreTool) — Optional. The data store tool.

    Note: The following fields are mutually exclusive: data_store_tool, client_function, open_api_tool, google_search_tool, connector_tool, python_function, mcp_tool, file_search_tool, system_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

#data_store_tool=

def data_store_tool=(value) -> ::Google::Cloud::Ces::V1beta::DataStoreTool
Parameter
  • value (::Google::Cloud::Ces::V1beta::DataStoreTool) — Optional. The data store tool.

    Note: The following fields are mutually exclusive: data_store_tool, client_function, open_api_tool, google_search_tool, connector_tool, python_function, mcp_tool, file_search_tool, system_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Ces::V1beta::DataStoreTool) — Optional. The data store tool.

    Note: The following fields are mutually exclusive: data_store_tool, client_function, open_api_tool, google_search_tool, connector_tool, python_function, mcp_tool, file_search_tool, system_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Output only. The display name of the tool, derived based on the tool's type. For example, display name of a [ClientFunction][Tool.ClientFunction] is derived from its name property.

#etag

def etag() -> ::String
Returns
  • (::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.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#execution_type

def execution_type() -> ::Google::Cloud::Ces::V1beta::ExecutionType
Returns

#execution_type=

def execution_type=(value) -> ::Google::Cloud::Ces::V1beta::ExecutionType
Parameter
Returns

#file_search_tool

def file_search_tool() -> ::Google::Cloud::Ces::V1beta::FileSearchTool
Returns
  • (::Google::Cloud::Ces::V1beta::FileSearchTool) — Optional. The file search tool.

    Note: The following fields are mutually exclusive: file_search_tool, client_function, open_api_tool, google_search_tool, connector_tool, data_store_tool, python_function, mcp_tool, system_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

#file_search_tool=

def file_search_tool=(value) -> ::Google::Cloud::Ces::V1beta::FileSearchTool
Parameter
  • value (::Google::Cloud::Ces::V1beta::FileSearchTool) — Optional. The file search tool.

    Note: The following fields are mutually exclusive: file_search_tool, client_function, open_api_tool, google_search_tool, connector_tool, data_store_tool, python_function, mcp_tool, system_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Ces::V1beta::FileSearchTool) — Optional. The file search tool.

    Note: The following fields are mutually exclusive: file_search_tool, client_function, open_api_tool, google_search_tool, connector_tool, data_store_tool, python_function, mcp_tool, system_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

#generated_summary

def generated_summary() -> ::String
Returns
  • (::String) — Output only. If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.

#google_search_tool

def google_search_tool() -> ::Google::Cloud::Ces::V1beta::GoogleSearchTool
Returns
  • (::Google::Cloud::Ces::V1beta::GoogleSearchTool) — Optional. The google search tool.

    Note: The following fields are mutually exclusive: google_search_tool, client_function, open_api_tool, connector_tool, data_store_tool, python_function, mcp_tool, file_search_tool, system_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

#google_search_tool=

def google_search_tool=(value) -> ::Google::Cloud::Ces::V1beta::GoogleSearchTool
Parameter
  • value (::Google::Cloud::Ces::V1beta::GoogleSearchTool) — Optional. The google search tool.

    Note: The following fields are mutually exclusive: google_search_tool, client_function, open_api_tool, connector_tool, data_store_tool, python_function, mcp_tool, file_search_tool, system_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Ces::V1beta::GoogleSearchTool) — Optional. The google search tool.

    Note: The following fields are mutually exclusive: google_search_tool, client_function, open_api_tool, connector_tool, data_store_tool, python_function, mcp_tool, file_search_tool, system_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

#mcp_tool

def mcp_tool() -> ::Google::Cloud::Ces::V1beta::McpTool
Returns
  • (::Google::Cloud::Ces::V1beta::McpTool) — Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.

    Note: The following fields are mutually exclusive: mcp_tool, client_function, open_api_tool, google_search_tool, connector_tool, data_store_tool, python_function, file_search_tool, system_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

#mcp_tool=

def mcp_tool=(value) -> ::Google::Cloud::Ces::V1beta::McpTool
Parameter
  • value (::Google::Cloud::Ces::V1beta::McpTool) — Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.

    Note: The following fields are mutually exclusive: mcp_tool, client_function, open_api_tool, google_search_tool, connector_tool, data_store_tool, python_function, file_search_tool, system_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Ces::V1beta::McpTool) — Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.

    Note: The following fields are mutually exclusive: mcp_tool, client_function, open_api_tool, google_search_tool, connector_tool, data_store_tool, python_function, file_search_tool, system_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

#name

def name() -> ::String
Returns
  • (::String) — Identifier. The resource name 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.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. The resource name 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.

Returns
  • (::String) — Identifier. The resource name 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.

#open_api_tool

def open_api_tool() -> ::Google::Cloud::Ces::V1beta::OpenApiTool
Returns
  • (::Google::Cloud::Ces::V1beta::OpenApiTool) — Optional. The open API tool.

    Note: The following fields are mutually exclusive: open_api_tool, client_function, google_search_tool, connector_tool, data_store_tool, python_function, mcp_tool, file_search_tool, system_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

#open_api_tool=

def open_api_tool=(value) -> ::Google::Cloud::Ces::V1beta::OpenApiTool
Parameter
  • value (::Google::Cloud::Ces::V1beta::OpenApiTool) — Optional. The open API tool.

    Note: The following fields are mutually exclusive: open_api_tool, client_function, google_search_tool, connector_tool, data_store_tool, python_function, mcp_tool, file_search_tool, system_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Ces::V1beta::OpenApiTool) — Optional. The open API tool.

    Note: The following fields are mutually exclusive: open_api_tool, client_function, google_search_tool, connector_tool, data_store_tool, python_function, mcp_tool, file_search_tool, system_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

#python_function

def python_function() -> ::Google::Cloud::Ces::V1beta::PythonFunction
Returns
  • (::Google::Cloud::Ces::V1beta::PythonFunction) — Optional. The python function tool.

    Note: The following fields are mutually exclusive: python_function, client_function, open_api_tool, google_search_tool, connector_tool, data_store_tool, mcp_tool, file_search_tool, system_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

#python_function=

def python_function=(value) -> ::Google::Cloud::Ces::V1beta::PythonFunction
Parameter
  • value (::Google::Cloud::Ces::V1beta::PythonFunction) — Optional. The python function tool.

    Note: The following fields are mutually exclusive: python_function, client_function, open_api_tool, google_search_tool, connector_tool, data_store_tool, mcp_tool, file_search_tool, system_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Ces::V1beta::PythonFunction) — Optional. The python function tool.

    Note: The following fields are mutually exclusive: python_function, client_function, open_api_tool, google_search_tool, connector_tool, data_store_tool, mcp_tool, file_search_tool, system_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

#system_tool

def system_tool() -> ::Google::Cloud::Ces::V1beta::SystemTool
Returns
  • (::Google::Cloud::Ces::V1beta::SystemTool) — Optional. The system tool.

    Note: The following fields are mutually exclusive: system_tool, client_function, open_api_tool, google_search_tool, connector_tool, data_store_tool, python_function, mcp_tool, file_search_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

#system_tool=

def system_tool=(value) -> ::Google::Cloud::Ces::V1beta::SystemTool
Parameter
  • value (::Google::Cloud::Ces::V1beta::SystemTool) — Optional. The system tool.

    Note: The following fields are mutually exclusive: system_tool, client_function, open_api_tool, google_search_tool, connector_tool, data_store_tool, python_function, mcp_tool, file_search_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Ces::V1beta::SystemTool) — Optional. The system tool.

    Note: The following fields are mutually exclusive: system_tool, client_function, open_api_tool, google_search_tool, connector_tool, data_store_tool, python_function, mcp_tool, file_search_tool, agent_tool, widget_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

#tool_fake_config

def tool_fake_config() -> ::Google::Cloud::Ces::V1beta::ToolFakeConfig
Returns

#tool_fake_config=

def tool_fake_config=(value) -> ::Google::Cloud::Ces::V1beta::ToolFakeConfig
Parameter
Returns

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns

#widget_tool

def widget_tool() -> ::Google::Cloud::Ces::V1beta::WidgetTool
Returns
  • (::Google::Cloud::Ces::V1beta::WidgetTool) — Optional. The widget tool.

    Note: The following fields are mutually exclusive: widget_tool, client_function, open_api_tool, google_search_tool, connector_tool, data_store_tool, python_function, mcp_tool, file_search_tool, system_tool, agent_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

#widget_tool=

def widget_tool=(value) -> ::Google::Cloud::Ces::V1beta::WidgetTool
Parameter
  • value (::Google::Cloud::Ces::V1beta::WidgetTool) — Optional. The widget tool.

    Note: The following fields are mutually exclusive: widget_tool, client_function, open_api_tool, google_search_tool, connector_tool, data_store_tool, python_function, mcp_tool, file_search_tool, system_tool, agent_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Ces::V1beta::WidgetTool) — Optional. The widget tool.

    Note: The following fields are mutually exclusive: widget_tool, client_function, open_api_tool, google_search_tool, connector_tool, data_store_tool, python_function, mcp_tool, file_search_tool, system_tool, agent_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.