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 ExecuteToolRequestOrBuilder (0.9.0)

public interface ExecuteToolRequestOrBuilder 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 = 2 [(.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 = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`StructOrBuilder`

getContext()

public abstract Struct getContext()

Optional. The ToolCallContext to be passed to the Python tool.

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

Returns
Type	Description
`Struct`	The context.

getContextOrBuilder()

public abstract StructOrBuilder getContextOrBuilder()

Optional. The ToolCallContext to be passed to the Python tool.

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

Returns
Type	Description
`StructOrBuilder`

getMockConfig()

public abstract MockConfig getMockConfig()

Optional. Mock configuration for the tool execution. If this field is set, tools that call other tools will be mocked based on the provided patterns and responses.

.google.cloud.ces.v1beta.MockConfig mock_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`MockConfig`	The mockConfig.

getMockConfigOrBuilder()

public abstract MockConfigOrBuilder getMockConfigOrBuilder()

Optional. Mock configuration for the tool execution. If this field is set, tools that call other tools will be mocked based on the provided patterns and responses.

.google.cloud.ces.v1beta.MockConfig mock_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`MockConfigOrBuilder`

getParent()

public abstract String getParent()

Required. The resource name of the app which the tool/toolset belongs to. Format: projects/{project}/locations/{location}/apps/{app}

string parent = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. The resource name of the app which the tool/toolset belongs to. Format: projects/{project}/locations/{location}/apps/{app}

string parent = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for parent.

getTool()

public abstract String getTool()

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

string tool = 1 [(.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 = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for tool.

getToolExecutionContextCase()

public abstract ExecuteToolRequest.ToolExecutionContextCase getToolExecutionContextCase()

Returns
Type	Description
`ExecuteToolRequest.ToolExecutionContextCase`

getToolIdentifierCase()

public abstract ExecuteToolRequest.ToolIdentifierCase getToolIdentifierCase()

Returns
Type	Description
`ExecuteToolRequest.ToolIdentifierCase`

getToolsetTool()

public abstract ToolsetTool getToolsetTool()

Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

.google.cloud.ces.v1beta.ToolsetTool toolset_tool = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ToolsetTool`	The toolsetTool.

getToolsetToolOrBuilder()

public abstract ToolsetToolOrBuilder getToolsetToolOrBuilder()

Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

.google.cloud.ces.v1beta.ToolsetTool toolset_tool = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ToolsetToolOrBuilder`

getVariables()

public abstract Struct getVariables()

Optional. The variables that are available for the tool execution.

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

Returns
Type	Description
`Struct`	The variables.

getVariablesOrBuilder()

public abstract StructOrBuilder getVariablesOrBuilder()

Optional. The variables that are available for the tool execution.

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

Returns
Type	Description
`StructOrBuilder`

hasArgs()

public abstract boolean hasArgs()

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

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

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

hasContext()

public abstract boolean hasContext()

Optional. The ToolCallContext to be passed to the Python tool.

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

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

hasMockConfig()

public abstract boolean hasMockConfig()

Optional. Mock configuration for the tool execution. If this field is set, tools that call other tools will be mocked based on the provided patterns and responses.

.google.cloud.ces.v1beta.MockConfig mock_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the mockConfig 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 = 1 [(.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. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

.google.cloud.ces.v1beta.ToolsetTool toolset_tool = 3 [(.google.api.field_behavior) = OPTIONAL];

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

hasVariables()

public abstract boolean hasVariables()

Optional. The variables that are available for the tool execution.

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

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