Package software.amazon.awssdk.services.bedrockagentruntime.model

Interface RetrievalResultContent.Builder

All Superinterfaces:

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

Enclosing class:

RetrievalResultContent

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

Method Summary

Modifier and Type	Method	Description
default RetrievalResultContent.Builder	audio(Consumer<AudioSegment.Builder> audio)	Audio segment information when the retrieval result contains audio content.
RetrievalResultContent.Builder	audio(AudioSegment audio)	Audio segment information when the retrieval result contains audio content.
RetrievalResultContent.Builder	byteContent(String byteContent)	A data URI with base64-encoded content from the data source.
RetrievalResultContent.Builder	row(Collection<RetrievalResultContentColumn> row)	Specifies information about the rows with the cells to return in retrieval.
RetrievalResultContent.Builder	row(Consumer<RetrievalResultContentColumn.Builder>... row)	Specifies information about the rows with the cells to return in retrieval.
RetrievalResultContent.Builder	row(RetrievalResultContentColumn... row)	Specifies information about the rows with the cells to return in retrieval.
RetrievalResultContent.Builder	text(String text)	The cited text from the data source.
RetrievalResultContent.Builder	type(String type)	The type of content in the retrieval result.
RetrievalResultContent.Builder	type(RetrievalResultContentType type)	The type of content in the retrieval result.
default RetrievalResultContent.Builder	video(Consumer<VideoSegment.Builder> video)	Video segment information when the retrieval result contains video content.
RetrievalResultContent.Builder	video(VideoSegment video)	Video segment information when the retrieval result contains video content.

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

audio

RetrievalResultContent.Builder audio(AudioSegment audio)

Audio segment information when the retrieval result contains audio content.

Parameters:

audio - Audio segment information when the retrieval result contains audio content.

Returns:

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

audio

default RetrievalResultContent.Builder audio(Consumer<AudioSegment.Builder> audio)

Audio segment information when the retrieval result contains audio content.

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

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

Parameters:

audio - a consumer that will call methods on AudioSegment.Builder

Returns:

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

See Also:

• audio(AudioSegment)

byteContent

RetrievalResultContent.Builder byteContent(String byteContent)

A data URI with base64-encoded content from the data source. The URI is in the following format: returned in the following format: data:image/jpeg;base64,${base64-encoded string}.

Parameters:

byteContent - A data URI with base64-encoded content from the data source. The URI is in the following format: returned in the following format: data:image/jpeg;base64,${base64-encoded string}.

Returns:

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

row

RetrievalResultContent.Builder row(Collection<RetrievalResultContentColumn> row)

Specifies information about the rows with the cells to return in retrieval.

Parameters:

row - Specifies information about the rows with the cells to return in retrieval.

Returns:

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

row

RetrievalResultContent.Builder row(RetrievalResultContentColumn... row)

Specifies information about the rows with the cells to return in retrieval.

Parameters:

row - Specifies information about the rows with the cells to return in retrieval.

Returns:

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

row

RetrievalResultContent.Builder row(Consumer<RetrievalResultContentColumn.Builder>... row)

Specifies information about the rows with the cells to return in retrieval.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to row(List<RetrievalResultContentColumn>).

Parameters:

row - a consumer that will call methods on RetrievalResultContentColumn.Builder

Returns:

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

See Also:

• row(java.util.Collection<RetrievalResultContentColumn>)

text

RetrievalResultContent.Builder text(String text)

The cited text from the data source.

Parameters:

text - The cited text from the data source.

Returns:

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

type

RetrievalResultContent.Builder type(String type)

The type of content in the retrieval result.

Parameters:

type - The type of content in the retrieval result.

Returns:

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

See Also:

• RetrievalResultContentType
• RetrievalResultContentType

type

RetrievalResultContent.Builder type(RetrievalResultContentType type)

The type of content in the retrieval result.

Parameters:

type - The type of content in the retrieval result.

Returns:

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

See Also:

• RetrievalResultContentType
• RetrievalResultContentType

video

RetrievalResultContent.Builder video(VideoSegment video)

Video segment information when the retrieval result contains video content.

Parameters:

video - Video segment information when the retrieval result contains video content.

Returns:

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

video

default RetrievalResultContent.Builder video(Consumer<VideoSegment.Builder> video)

Video segment information when the retrieval result contains video content.

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

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

Parameters:

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

Returns:

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

See Also:

• video(VideoSegment)