Interface ToolUseOrBuilder (0.89.0)

Version latest

• 0.89.0 (latest)
• 0.87.0
• 0.86.0
• 0.85.0
• 0.84.0
• 0.83.0
• 0.81.0
• 0.79.0
• 0.78.0
• 0.75.0
• 0.74.0
• 0.73.0
• 0.71.0
• 0.70.0
• 0.69.0
• 0.68.0
• 0.67.0
• 0.66.0
• 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.

getDataStoreToolTrace()

public abstract ToolUse.DataStoreToolTrace getDataStoreToolTrace()

Optional. Data store tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.DataStoreToolTrace data_store_tool_trace = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ToolUse.DataStoreToolTrace	The dataStoreToolTrace.

getDataStoreToolTraceOrBuilder()

public abstract ToolUse.DataStoreToolTraceOrBuilder getDataStoreToolTraceOrBuilder()

Optional. Data store tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.DataStoreToolTrace data_store_tool_trace = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ToolUse.DataStoreToolTraceOrBuilder

getDisplayName()

public abstract String getDisplayName()

Output only. The display name of the tool.

string display_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Output only. The display name of the tool.

string display_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for displayName.

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.

getToolTraceCase()

public abstract ToolUse.ToolTraceCase getToolTraceCase()

Returns
Type	Description
ToolUse.ToolTraceCase

getWebhookToolTrace()

public abstract ToolUse.WebhookToolTrace getWebhookToolTrace()

Optional. Webhook tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.WebhookToolTrace webhook_tool_trace = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ToolUse.WebhookToolTrace	The webhookToolTrace.

getWebhookToolTraceOrBuilder()

public abstract ToolUse.WebhookToolTraceOrBuilder getWebhookToolTraceOrBuilder()

Optional. Webhook tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.WebhookToolTrace webhook_tool_trace = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ToolUse.WebhookToolTraceOrBuilder

hasDataStoreToolTrace()

public abstract boolean hasDataStoreToolTrace()

Optional. Data store tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.DataStoreToolTrace data_store_tool_trace = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the dataStoreToolTrace field is set.

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.

hasWebhookToolTrace()

public abstract boolean hasWebhookToolTrace()

Optional. Webhook tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.WebhookToolTrace webhook_tool_trace = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the webhookToolTrace field is set.