Interface ContentBlock.Builder

All Superinterfaces:

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

Enclosing class:

ContentBlock

@Mutable
@NotThreadSafe
public static interface ContentBlock.Builder
extends SdkPojo, CopyableBuilder<ContentBlock.Builder,ContentBlock>

Method Summary

Modifier and Type	Method	Description
default ContentBlock.Builder	cachePoint(Consumer<CachePointBlock.Builder> cachePoint)	CachePoint to include in the message.
ContentBlock.Builder	cachePoint(CachePointBlock cachePoint)	CachePoint to include in the message.
default ContentBlock.Builder	citationsContent(Consumer<CitationsContentBlock.Builder> citationsContent)	A content block that contains both generated text and associated citation information, providing traceability between the response and source documents.
ContentBlock.Builder	citationsContent(CitationsContentBlock citationsContent)	A content block that contains both generated text and associated citation information, providing traceability between the response and source documents.
default ContentBlock.Builder	document(Consumer<DocumentBlock.Builder> document)	A document to include in the message.
ContentBlock.Builder	document(DocumentBlock document)	A document to include in the message.
default ContentBlock.Builder	guardContent(Consumer<GuardrailConverseContentBlock.Builder> guardContent)	Contains the content to assess with the guardrail.
ContentBlock.Builder	guardContent(GuardrailConverseContentBlock guardContent)	Contains the content to assess with the guardrail.
default ContentBlock.Builder	image(Consumer<ImageBlock.Builder> image)	Image to include in the message.
ContentBlock.Builder	image(ImageBlock image)	Image to include in the message.
default ContentBlock.Builder	reasoningContent(Consumer<ReasoningContentBlock.Builder> reasoningContent)	Contains content regarding the reasoning that is carried out by the model.
ContentBlock.Builder	reasoningContent(ReasoningContentBlock reasoningContent)	Contains content regarding the reasoning that is carried out by the model.
default ContentBlock.Builder	searchResult(Consumer<SearchResultBlock.Builder> searchResult)	Search result to include in the message.
ContentBlock.Builder	searchResult(SearchResultBlock searchResult)	Search result to include in the message.
ContentBlock.Builder	text(String text)	Text to include in the message.
default ContentBlock.Builder	toolResult(Consumer<ToolResultBlock.Builder> toolResult)	The result for a tool request that a model makes.
ContentBlock.Builder	toolResult(ToolResultBlock toolResult)	The result for a tool request that a model makes.
default ContentBlock.Builder	toolUse(Consumer<ToolUseBlock.Builder> toolUse)	Information about a tool use request from a model.
ContentBlock.Builder	toolUse(ToolUseBlock toolUse)	Information about a tool use request from a model.
default ContentBlock.Builder	video(Consumer<VideoBlock.Builder> video)	Video to include in the message.
ContentBlock.Builder	video(VideoBlock video)	Video to include in the message.

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, sdkFieldNameToField, sdkFields

Method Details

text

ContentBlock.Builder text(String text)

Text to include in the message.

Parameters:

text - Text to include in the message.

Returns:

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

image

ContentBlock.Builder image(ImageBlock image)

Image to include in the message.

This field is only supported by Anthropic Claude 3 models.

Parameters:

image - Image to include in the message.

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 ContentBlock.Builder image(Consumer<ImageBlock.Builder> image)

Image to include in the message.

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

ContentBlock.Builder document(DocumentBlock document)

A document to include in the message.

Parameters:

document - A document to include in the message.

Returns:

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

document

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

A document to include in the message.

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)

video

ContentBlock.Builder video(VideoBlock video)

Video to include in the message.

Parameters:

video - Video to include in the message.

Returns:

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

video

default ContentBlock.Builder video(Consumer<VideoBlock.Builder> video)

Video to include in the message.

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

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

Parameters:

video - a consumer that will call methods on VideoBlock.Builder

Returns:

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

See Also:

• video(VideoBlock)

toolUse

ContentBlock.Builder toolUse(ToolUseBlock toolUse)

Information about a tool use request from a model.

Parameters:

toolUse - Information about a tool use request from a model.

Returns:

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

toolUse

default ContentBlock.Builder toolUse(Consumer<ToolUseBlock.Builder> toolUse)

Information about a tool use request from a model.

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

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

Parameters:

toolUse - a consumer that will call methods on ToolUseBlock.Builder

Returns:

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

See Also:

• toolUse(ToolUseBlock)

toolResult

ContentBlock.Builder toolResult(ToolResultBlock toolResult)

The result for a tool request that a model makes.

Parameters:

toolResult - The result for a tool request that a model makes.

Returns:

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

toolResult

default ContentBlock.Builder toolResult(Consumer<ToolResultBlock.Builder> toolResult)

The result for a tool request that a model makes.

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

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

Parameters:

toolResult - a consumer that will call methods on ToolResultBlock.Builder

Returns:

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

See Also:

• toolResult(ToolResultBlock)

guardContent

ContentBlock.Builder guardContent(GuardrailConverseContentBlock guardContent)

Contains the content to assess with the guardrail. If you don't specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.

For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.

Parameters:

guardContent - Contains the content to assess with the guardrail. If you don't specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.

For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.

Returns:

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

guardContent

default ContentBlock.Builder guardContent(Consumer<GuardrailConverseContentBlock.Builder> guardContent)

Contains the content to assess with the guardrail. If you don't specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.

For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.

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

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

Parameters:

guardContent - a consumer that will call methods on GuardrailConverseContentBlock.Builder

Returns:

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

See Also:

• guardContent(GuardrailConverseContentBlock)

cachePoint

ContentBlock.Builder cachePoint(CachePointBlock cachePoint)

CachePoint to include in the message.

Parameters:

cachePoint - CachePoint to include in the message.

Returns:

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

cachePoint

default ContentBlock.Builder cachePoint(Consumer<CachePointBlock.Builder> cachePoint)

CachePoint to include in the message.

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

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

Parameters:

cachePoint - a consumer that will call methods on CachePointBlock.Builder

Returns:

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

See Also:

• cachePoint(CachePointBlock)

reasoningContent

ContentBlock.Builder reasoningContent(ReasoningContentBlock reasoningContent)

Contains content regarding the reasoning that is carried out by the model. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.

Parameters:

reasoningContent - Contains content regarding the reasoning that is carried out by the model. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.

Returns:

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

reasoningContent

default ContentBlock.Builder reasoningContent(Consumer<ReasoningContentBlock.Builder> reasoningContent)

Contains content regarding the reasoning that is carried out by the model. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.

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

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

Parameters:

reasoningContent - a consumer that will call methods on ReasoningContentBlock.Builder

Returns:

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

See Also:

• reasoningContent(ReasoningContentBlock)

citationsContent

ContentBlock.Builder citationsContent(CitationsContentBlock citationsContent)

A content block that contains both generated text and associated citation information, providing traceability between the response and source documents.

Parameters:

citationsContent - A content block that contains both generated text and associated citation information, providing traceability between the response and source documents.

Returns:

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

citationsContent

default ContentBlock.Builder citationsContent(Consumer<CitationsContentBlock.Builder> citationsContent)

A content block that contains both generated text and associated citation information, providing traceability between the response and source documents.

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

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

Parameters:

citationsContent - a consumer that will call methods on CitationsContentBlock.Builder

Returns:

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

See Also:

• citationsContent(CitationsContentBlock)

searchResult

ContentBlock.Builder searchResult(SearchResultBlock searchResult)

Search result to include in the message.

Parameters:

searchResult - Search result to include in the message.

Returns:

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

searchResult

default ContentBlock.Builder searchResult(Consumer<SearchResultBlock.Builder> searchResult)

Search result to include in the message.

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

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

Parameters:

searchResult - a consumer that will call methods on SearchResultBlock.Builder

Returns:

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

See Also:

• searchResult(SearchResultBlock)