Interface ToolUseOrBuilder (0.66.0)

public interface ToolUseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAction()

public abstract String getAction()

Optional. Name of the action to be called during the tool use.

string action = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The action.

getActionBytes()

public abstract ByteString getActionBytes()

Optional. Name of the action to be called during the tool use.

string action = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for action.

getInputActionParameters()

public abstract Struct getInputActionParameters()

Optional. A list of input parameters for the action.

.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The inputActionParameters.

getInputActionParametersOrBuilder()

public abstract StructOrBuilder getInputActionParametersOrBuilder()

Optional. A list of input parameters for the action.

.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

getOutputActionParameters()

public abstract Struct getOutputActionParameters()

Optional. A list of output parameters generated by the action.

.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The outputActionParameters.

getOutputActionParametersOrBuilder()

public abstract StructOrBuilder getOutputActionParametersOrBuilder()

Optional. A list of output parameters generated by the action.

.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

getTool()

public abstract String getTool()

Required. The tool that should be used. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.

string tool = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The tool.

getToolBytes()

public abstract ByteString getToolBytes()

Required. The tool that should be used. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.

string tool = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for tool.

hasInputActionParameters()

public abstract boolean hasInputActionParameters()

Optional. A list of input parameters for the action.

.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the inputActionParameters field is set.

hasOutputActionParameters()

public abstract boolean hasOutputActionParameters()

Optional. A list of output parameters generated by the action.

.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the outputActionParameters field is set.