Class ToolResponse (0.3.0)

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

The execution result of a specific tool from the client or the agent.

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_v1.types.ToolsetTool
Optional. The toolset tool that got executed. This field is a member of oneof_ tool_identifier.
id str
Optional. The matching ID of the [tool call][google.cloud.ces.v1.ToolCall] the response is for.
display_name str
Output only. Display name of the tool.
response google.protobuf.struct_pb2.Struct
Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.