Interface ToolResultContentBlock.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ToolResultContentBlock.Builder,ToolResultContentBlock>, SdkBuilder<ToolResultContentBlock.Builder,ToolResultContentBlock>, SdkPojo

Enclosing class:

ToolResultContentBlock

public static interface ToolResultContentBlock.Builder
extends SdkPojo, CopyableBuilder<ToolResultContentBlock.Builder,ToolResultContentBlock>

Method Summary

Modifier and Type	Method	Description
default ToolResultContentBlock.Builder	document(Consumer<DocumentBlock.Builder> document)	A tool result that is a document.
ToolResultContentBlock.Builder	document(DocumentBlock document)	A tool result that is a document.
default ToolResultContentBlock.Builder	image(Consumer<ImageBlock.Builder> image)	A tool result that is an image.
ToolResultContentBlock.Builder	image(ImageBlock image)	A tool result that is an image.
ToolResultContentBlock.Builder	json(Document json)	A tool result that is JSON format data.
ToolResultContentBlock.Builder	text(String text)	A tool result that is text.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

json

ToolResultContentBlock.Builder json(Document json)

A tool result that is JSON format data.

Parameters:

json - A tool result that is JSON format data.

Returns:

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

text

ToolResultContentBlock.Builder text(String text)

A tool result that is text.

Parameters:

text - A tool result that is text.

Returns:

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

image

ToolResultContentBlock.Builder image(ImageBlock image)

A tool result that is an image.

This field is only supported by Anthropic Claude 3 models.

Parameters:

image - A tool result that is an image.

This field is only supported by Anthropic Claude 3 models.

Returns:

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

image

default ToolResultContentBlock.Builder image(Consumer<ImageBlock.Builder> image)

A tool result that is an image.

This field is only supported by Anthropic Claude 3 models.

This is a convenience method that creates an instance of the ImageBlock.Builder avoiding the need to create one manually via ImageBlock.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to image(ImageBlock).

Parameters:

image - a consumer that will call methods on ImageBlock.Builder

Returns:

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

See Also:

• image(ImageBlock)

document

ToolResultContentBlock.Builder document(DocumentBlock document)

A tool result that is a document.

Parameters:

document - A tool result that is a document.

Returns:

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

document

default ToolResultContentBlock.Builder document(Consumer<DocumentBlock.Builder> document)

A tool result that is a document.

This is a convenience method that creates an instance of the DocumentBlock.Builder avoiding the need to create one manually via DocumentBlock.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to document(DocumentBlock).

Parameters:

document - a consumer that will call methods on DocumentBlock.Builder

Returns:

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

See Also:

• document(DocumentBlock)