Interface ToolUseOrBuilder (0.53.0)

Version 0.53.0

• 0.66.0 (latest)
• 0.65.0
• 0.64.0
• 0.63.0
• 0.62.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.7
• 0.13.1
• 0.12.1
• 0.11.5

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.

getInputParameters(int index)

public abstract ActionParameter getInputParameters(int index)

A list of input parameters for the action.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
ActionParameter

getInputParametersCount()

public abstract int getInputParametersCount()

A list of input parameters for the action.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 3;

Returns
Type	Description
int

getInputParametersList()

public abstract List<ActionParameter> getInputParametersList()

A list of input parameters for the action.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 3;

Returns
Type	Description
List<ActionParameter>

getInputParametersOrBuilder(int index)

public abstract ActionParameterOrBuilder getInputParametersOrBuilder(int index)

A list of input parameters for the action.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
ActionParameterOrBuilder

getInputParametersOrBuilderList()

public abstract List<? extends ActionParameterOrBuilder> getInputParametersOrBuilderList()

A list of input parameters for the action.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 3;

Returns
Type	Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.ActionParameterOrBuilder>

getOutputParameters(int index)

public abstract ActionParameter getOutputParameters(int index)

A list of output parameters generated by the action.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
ActionParameter

getOutputParametersCount()

public abstract int getOutputParametersCount()

A list of output parameters generated by the action.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 4;

Returns
Type	Description
int

getOutputParametersList()

public abstract List<ActionParameter> getOutputParametersList()

A list of output parameters generated by the action.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 4;

Returns
Type	Description
List<ActionParameter>

getOutputParametersOrBuilder(int index)

public abstract ActionParameterOrBuilder getOutputParametersOrBuilder(int index)

A list of output parameters generated by the action.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
ActionParameterOrBuilder

getOutputParametersOrBuilderList()

public abstract List<? extends ActionParameterOrBuilder> getOutputParametersOrBuilderList()

A list of output parameters generated by the action.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 4;

Returns
Type	Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.ActionParameterOrBuilder>

getTool()

public abstract String getTool()

Required. The tool that should be used. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/tools/<Tool ID>.

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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/tools/<Tool ID>.

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

Returns
Type	Description
ByteString	The bytes for tool.