com.amazonaws.services.bedrockruntime.model

Class ToolConfiguration

java.lang.Object

com.amazonaws.services.bedrockruntime.model.ToolConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ToolConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

Configuration information for the tools that you pass to a model. For more information, see Tool use (function calling) in the Amazon Bedrock User Guide.

This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ToolConfiguration()

Method Summary

Modifier and Type	Method and Description
ToolConfiguration	clone()
boolean	equals(Object obj)
ToolChoice	getToolChoice() If supported by model, forces the model to request a tool.
List<Tool>	getTools() An array of tools that you want to pass to a model.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setToolChoice(ToolChoice toolChoice) If supported by model, forces the model to request a tool.
void	setTools(Collection<Tool> tools) An array of tools that you want to pass to a model.
String	toString() Returns a string representation of this object.
ToolConfiguration	withToolChoice(ToolChoice toolChoice) If supported by model, forces the model to request a tool.
ToolConfiguration	withTools(Collection<Tool> tools) An array of tools that you want to pass to a model.
ToolConfiguration	withTools(Tool... tools) An array of tools that you want to pass to a model.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ToolConfiguration

public ToolConfiguration()

Method Detail

getTools

public List<Tool> getTools()

An array of tools that you want to pass to a model.

Returns:

An array of tools that you want to pass to a model.

setTools

public void setTools(Collection<Tool> tools)

An array of tools that you want to pass to a model.

Parameters:

tools - An array of tools that you want to pass to a model.

withTools

public ToolConfiguration withTools(Tool... tools)

An array of tools that you want to pass to a model.

NOTE: This method appends the values to the existing list (if any). Use setTools(java.util.Collection) or withTools(java.util.Collection) if you want to override the existing values.

Parameters:

tools - An array of tools that you want to pass to a model.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTools

public ToolConfiguration withTools(Collection<Tool> tools)

An array of tools that you want to pass to a model.

Parameters:

tools - An array of tools that you want to pass to a model.

Returns:

Returns a reference to this object so that method calls can be chained together.

setToolChoice

public void setToolChoice(ToolChoice toolChoice)

If supported by model, forces the model to request a tool.

Parameters:

toolChoice - If supported by model, forces the model to request a tool.

getToolChoice

public ToolChoice getToolChoice()

If supported by model, forces the model to request a tool.

Returns:

If supported by model, forces the model to request a tool.

withToolChoice

public ToolConfiguration withToolChoice(ToolChoice toolChoice)

If supported by model, forces the model to request a tool.

Parameters:

toolChoice - If supported by model, forces the model to request a tool.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ToolConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.