Class Tool (0.3.0)

Tool(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name Description
client_function google.cloud.ces_v1beta.types.ClientFunction
Optional. The client function. This field is a member of oneof_ tool_type.
open_api_tool google.cloud.ces_v1beta.types.OpenApiTool
Optional. The open API tool. This field is a member of oneof_ tool_type.
google_search_tool google.cloud.ces_v1beta.types.GoogleSearchTool
Optional. The google search tool. This field is a member of oneof_ tool_type.
connector_tool google.cloud.ces_v1beta.types.ConnectorTool
Optional. The Integration Connector tool. This field is a member of oneof_ tool_type.
data_store_tool google.cloud.ces_v1beta.types.DataStoreTool
Optional. The data store tool. This field is a member of oneof_ tool_type.
python_function google.cloud.ces_v1beta.types.PythonFunction
Optional. The python function tool. This field is a member of oneof_ tool_type.
mcp_tool google.cloud.ces_v1beta.types.McpTool
Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset. This field is a member of oneof_ tool_type.
file_search_tool google.cloud.ces_v1beta.types.FileSearchTool
Optional. The file search tool. This field is a member of oneof_ tool_type.
system_tool google.cloud.ces_v1beta.types.SystemTool
Optional. The system tool. This field is a member of oneof_ tool_type.
agent_tool google.cloud.ces_v1beta.types.AgentTool
Optional. The agent tool. This field is a member of oneof_ tool_type.
widget_tool google.cloud.ces_v1beta.types.WidgetTool
Optional. The widget tool. This field is a member of oneof_ tool_type.
name str
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.
display_name str
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.
execution_type google.cloud.ces_v1beta.types.ExecutionType
Optional. The execution type of the tool.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when the tool was created.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when the tool was last updated.
etag str
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.
generated_summary str
Output only. If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
tool_fake_config google.cloud.ces_v1beta.types.ToolFakeConfig
Optional. Configuration for tool behavior in fake mode.