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

Interface Citation.Builder

All Superinterfaces:

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

Enclosing class:

Citation

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

Method Summary

Modifier and Type	Method	Description
default Citation.Builder	location(Consumer<CitationLocation.Builder> location)	The precise location within the source document where the cited content can be found, including character positions, page numbers, or chunk identifiers.
Citation.Builder	location(CitationLocation location)	The precise location within the source document where the cited content can be found, including character positions, page numbers, or chunk identifiers.
Citation.Builder	source(String source)	The source from the original search result that provided the cited content.
Citation.Builder	sourceContent(Collection<CitationSourceContent> sourceContent)	The specific content from the source document that was referenced or cited in the generated response.
Citation.Builder	sourceContent(Consumer<CitationSourceContent.Builder>... sourceContent)	The specific content from the source document that was referenced or cited in the generated response.
Citation.Builder	sourceContent(CitationSourceContent... sourceContent)	The specific content from the source document that was referenced or cited in the generated response.
Citation.Builder	title(String title)	The title or identifier of the source document being cited.

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 Detail

title

Citation.Builder title(String title)

The title or identifier of the source document being cited.

Parameters:

title - The title or identifier of the source document being cited.

Returns:

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

source

Citation.Builder source(String source)

The source from the original search result that provided the cited content.

Parameters:

source - The source from the original search result that provided the cited content.

Returns:

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

sourceContent

Citation.Builder sourceContent(Collection<CitationSourceContent> sourceContent)

The specific content from the source document that was referenced or cited in the generated response.

Parameters:

sourceContent - The specific content from the source document that was referenced or cited in the generated response.

Returns:

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

sourceContent

Citation.Builder sourceContent(CitationSourceContent... sourceContent)

The specific content from the source document that was referenced or cited in the generated response.

Parameters:

sourceContent - The specific content from the source document that was referenced or cited in the generated response.

Returns:

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

sourceContent

Citation.Builder sourceContent(Consumer<CitationSourceContent.Builder>... sourceContent)

The specific content from the source document that was referenced or cited in the generated response.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #sourceContent(List).

Parameters:

sourceContent - a consumer that will call methods on CitationSourceContent.Builder

Returns:

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

See Also:

#sourceContent(java.util.Collection)

location

Citation.Builder location(CitationLocation location)

The precise location within the source document where the cited content can be found, including character positions, page numbers, or chunk identifiers.

Parameters:

location - The precise location within the source document where the cited content can be found, including character positions, page numbers, or chunk identifiers.

Returns:

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

location

default Citation.Builder location(Consumer<CitationLocation.Builder> location)

The precise location within the source document where the cited content can be found, including character positions, page numbers, or chunk identifiers.

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

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

Parameters:

location - a consumer that will call methods on CitationLocation.Builder

Returns:

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

See Also:

location(CitationLocation)