com.amazonaws.services.bedrockruntime.model

Class ToolChoice

java.lang.Object

com.amazonaws.services.bedrockruntime.model.ToolChoice

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Determines which tools the model should request in a call to Converse or ConverseStream. ToolChoice is only supported by Anthropic Claude 3 models and by Mistral AI Mistral Large.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ToolChoice()

Method Summary

Modifier and Type	Method and Description
ToolChoice	clone()
boolean	equals(Object obj)
AnyToolChoice	getAny() The model must request at least one tool (no text is generated).
AutoToolChoice	getAuto() (Default).
SpecificToolChoice	getTool() The Model must request the specified tool.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAny(AnyToolChoice any) The model must request at least one tool (no text is generated).
void	setAuto(AutoToolChoice auto) (Default).
void	setTool(SpecificToolChoice tool) The Model must request the specified tool.
String	toString() Returns a string representation of this object.
ToolChoice	withAny(AnyToolChoice any) The model must request at least one tool (no text is generated).
ToolChoice	withAuto(AutoToolChoice auto) (Default).
ToolChoice	withTool(SpecificToolChoice tool) The Model must request the specified tool.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ToolChoice

public ToolChoice()

Method Detail

setAuto

public void setAuto(AutoToolChoice auto)

(Default). The Model automatically decides if a tool should be called or whether to generate text instead.

Parameters:

auto - (Default). The Model automatically decides if a tool should be called or whether to generate text instead.

getAuto

public AutoToolChoice getAuto()

(Default). The Model automatically decides if a tool should be called or whether to generate text instead.

Returns:

(Default). The Model automatically decides if a tool should be called or whether to generate text instead.

withAuto

public ToolChoice withAuto(AutoToolChoice auto)

(Default). The Model automatically decides if a tool should be called or whether to generate text instead.

Parameters:

auto - (Default). The Model automatically decides if a tool should be called or whether to generate text instead.

Returns:

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

setAny

public void setAny(AnyToolChoice any)

The model must request at least one tool (no text is generated).

Parameters:

any - The model must request at least one tool (no text is generated).

getAny

public AnyToolChoice getAny()

The model must request at least one tool (no text is generated).

Returns:

The model must request at least one tool (no text is generated).

withAny

public ToolChoice withAny(AnyToolChoice any)

The model must request at least one tool (no text is generated).

Parameters:

any - The model must request at least one tool (no text is generated).

Returns:

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

setTool

public void setTool(SpecificToolChoice tool)

The Model must request the specified tool. Only supported by Anthropic Claude 3 models.

Parameters:

tool - The Model must request the specified tool. Only supported by Anthropic Claude 3 models.

getTool

public SpecificToolChoice getTool()

The Model must request the specified tool. Only supported by Anthropic Claude 3 models.

Returns:

The Model must request the specified tool. Only supported by Anthropic Claude 3 models.

withTool

public ToolChoice withTool(SpecificToolChoice tool)

The Model must request the specified tool. Only supported by Anthropic Claude 3 models.

Parameters:

tool - The Model must request the specified tool. Only supported by Anthropic Claude 3 models.

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 ToolChoice 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.