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

Class ToolUseBlock

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.ToolUseBlock

All Implemented Interfaces:

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

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

A tool use content block. Contains information about a tool that the model is requesting be run., The model uses the result from the tool to generate a response. For more information, see Call a tool with the Converse API in the Amazon Bedrock User Guide.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ToolUseBlock.Builder

Method Summary

Modifier and Type	Method	Description
static ToolUseBlock.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Document	input()	The input to pass to the tool.
final String	name()	The name of the tool that the model wants to use.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends ToolUseBlock.Builder>	serializableBuilderClass()
ToolUseBlock.Builder	toBuilder()
final String	toolUseId()	The ID for the tool request.
final String	toString()	Returns a string representation of this object.
final ToolUseType	type()	The type for the tool request.
final String	typeAsString()	The type for the tool request.

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 Details

toolUseId

public final String toolUseId()

The ID for the tool request.

Returns:

The ID for the tool request.

name

public final String name()

The name of the tool that the model wants to use.

Returns:

The name of the tool that the model wants to use.

input

public final Document input()

The input to pass to the tool.

Returns:

The input to pass to the tool.

type

public final ToolUseType type()

The type for the tool request.

If the service returns an enum value that is not available in the current SDK version, type will return ToolUseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type for the tool request.

See Also:

• ToolUseType

typeAsString

public final String typeAsString()

The type for the tool request.

If the service returns an enum value that is not available in the current SDK version, type will return ToolUseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type for the tool request.

See Also:

• ToolUseType

toBuilder

public ToolUseBlock.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ToolUseBlock.Builder,ToolUseBlock>

builder

public static ToolUseBlock.Builder builder()

serializableBuilderClass

public static Class<? extends ToolUseBlock.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