Package software.amazon.awssdk.services.bedrockruntime.model

Class ToolConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.ToolConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ToolConfiguration.Builder,ToolConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class ToolConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ToolConfiguration.Builder,ToolConfiguration>

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ToolConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static ToolConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTools()	For responses, this returns true if the service returned a value for the Tools property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ToolConfiguration.Builder>	serializableBuilderClass()
ToolConfiguration.Builder	toBuilder()
ToolChoice	toolChoice()	If supported by model, forces the model to request a tool.
List<Tool>	tools()	An array of tools that you want to pass to a model.
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasTools

public final boolean hasTools()

For responses, this returns true if the service returned a value for the Tools property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tools

public final List<Tool> tools()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTools() method.

Returns:

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

toolChoice

public final ToolChoice toolChoice()

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

Returns:

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

toBuilder

public ToolConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ToolConfiguration.Builder,ToolConfiguration>

builder

public static ToolConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends ToolConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo