Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Interface ToolCallOrBuilder (0.1.0)

public interface ToolCallOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getArgs()

public abstract Struct getArgs()

Optional. The input parameters and values for the tool in JSON object format.

.google.protobuf.Struct args = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Struct`	The args.

getArgsOrBuilder()

public abstract StructOrBuilder getArgsOrBuilder()

Optional. The input parameters and values for the tool in JSON object format.

.google.protobuf.Struct args = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`StructOrBuilder`

getDisplayName()

public abstract String getDisplayName()

Output only. Display name of the tool.

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

Returns
Type	Description
`String`	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Output only. Display name of the tool.

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

Returns
Type	Description
`ByteString`	The bytes for displayName.

getId()

public abstract String getId()

Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.

string id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The id.

getIdBytes()

public abstract ByteString getIdBytes()

Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.

string id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for id.

getTool()

public abstract String getTool()

Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

string tool = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The tool.

getToolBytes()

public abstract ByteString getToolBytes()

Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

string tool = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for tool.

getToolIdentifierCase()

public abstract ToolCall.ToolIdentifierCase getToolIdentifierCase()

Returns
Type	Description
`ToolCall.ToolIdentifierCase`

getToolsetTool()

public abstract ToolsetTool getToolsetTool()

Optional. The toolset tool to execute.

.google.cloud.ces.v1.ToolsetTool toolset_tool = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ToolsetTool`	The toolsetTool.

getToolsetToolOrBuilder()

public abstract ToolsetToolOrBuilder getToolsetToolOrBuilder()

Optional. The toolset tool to execute.

.google.cloud.ces.v1.ToolsetTool toolset_tool = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ToolsetToolOrBuilder`

hasArgs()

public abstract boolean hasArgs()

Optional. The input parameters and values for the tool in JSON object format.

.google.protobuf.Struct args = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the args field is set.

hasTool()

public abstract boolean hasTool()

Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

string tool = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`boolean`	Whether the tool field is set.

hasToolsetTool()

public abstract boolean hasToolsetTool()

Optional. The toolset tool to execute.

.google.cloud.ces.v1.ToolsetTool toolset_tool = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the toolsetTool field is set.