Class ExecuteToolRequest (0.3.0)

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

Request message for ToolService.ExecuteTool.

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
tool str
Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool} This field is a member of oneof_ tool_identifier.
toolset_tool google.cloud.ces_v1beta.types.ToolsetTool
Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned. This field is a member of oneof_ tool_identifier.
variables google.protobuf.struct_pb2.Struct
Optional. The variables that are available for the tool execution. This field is a member of oneof_ tool_execution_context.
context google.protobuf.struct_pb2.Struct
Optional. The [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment for details) to be passed to the Python tool. This field is a member of oneof_ tool_execution_context.
parent str
Required. The resource name of the app which the tool/toolset belongs to. Format: projects/{project}/locations/{location}/apps/{app}
args google.protobuf.struct_pb2.Struct
Optional. The input parameters and values for the tool in JSON object format.