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

Interface CitationLocation.Builder

All Superinterfaces:

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

Enclosing class:

CitationLocation

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

Method Summary

Modifier and Type	Method	Description
default CitationLocation.Builder	documentChar(Consumer<DocumentCharLocation.Builder> documentChar)	The character-level location within the document where the cited content is found.
CitationLocation.Builder	documentChar(DocumentCharLocation documentChar)	The character-level location within the document where the cited content is found.
default CitationLocation.Builder	documentChunk(Consumer<DocumentChunkLocation.Builder> documentChunk)	The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks.
CitationLocation.Builder	documentChunk(DocumentChunkLocation documentChunk)	The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks.
default CitationLocation.Builder	documentPage(Consumer<DocumentPageLocation.Builder> documentPage)	The page-level location within the document where the cited content is found.
CitationLocation.Builder	documentPage(DocumentPageLocation documentPage)	The page-level location within the document where the cited content is found.
default CitationLocation.Builder	searchResultLocation(Consumer<SearchResultLocation.Builder> searchResultLocation)	The search result location where the cited content is found, including the search result index and block positions within the content array.
CitationLocation.Builder	searchResultLocation(SearchResultLocation searchResultLocation)	The search result location where the cited content is found, including the search result index and block positions within the content array.
default CitationLocation.Builder	web(Consumer<WebLocation.Builder> web)	The web URL that was cited for this reference.
CitationLocation.Builder	web(WebLocation web)	The web URL that was cited for this reference.

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

web

CitationLocation.Builder web(WebLocation web)

The web URL that was cited for this reference.

Parameters:

web - The web URL that was cited for this reference.

Returns:

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

web

default CitationLocation.Builder web(Consumer<WebLocation.Builder> web)

The web URL that was cited for this reference.

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

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

Parameters:

web - a consumer that will call methods on WebLocation.Builder

Returns:

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

See Also:

• web(WebLocation)

documentChar

CitationLocation.Builder documentChar(DocumentCharLocation documentChar)

The character-level location within the document where the cited content is found.

Parameters:

documentChar - The character-level location within the document where the cited content is found.

Returns:

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

documentChar

default CitationLocation.Builder documentChar(Consumer<DocumentCharLocation.Builder> documentChar)

The character-level location within the document where the cited content is found.

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

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

Parameters:

documentChar - a consumer that will call methods on DocumentCharLocation.Builder

Returns:

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

See Also:

• documentChar(DocumentCharLocation)

documentPage

CitationLocation.Builder documentPage(DocumentPageLocation documentPage)

The page-level location within the document where the cited content is found.

Parameters:

documentPage - The page-level location within the document where the cited content is found.

Returns:

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

documentPage

default CitationLocation.Builder documentPage(Consumer<DocumentPageLocation.Builder> documentPage)

The page-level location within the document where the cited content is found.

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

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

Parameters:

documentPage - a consumer that will call methods on DocumentPageLocation.Builder

Returns:

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

See Also:

• documentPage(DocumentPageLocation)

documentChunk

CitationLocation.Builder documentChunk(DocumentChunkLocation documentChunk)

The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks.

Parameters:

documentChunk - The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks.

Returns:

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

documentChunk

default CitationLocation.Builder documentChunk(Consumer<DocumentChunkLocation.Builder> documentChunk)

The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks.

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

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

Parameters:

documentChunk - a consumer that will call methods on DocumentChunkLocation.Builder

Returns:

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

See Also:

• documentChunk(DocumentChunkLocation)

searchResultLocation

CitationLocation.Builder searchResultLocation(SearchResultLocation searchResultLocation)

The search result location where the cited content is found, including the search result index and block positions within the content array.

Parameters:

searchResultLocation - The search result location where the cited content is found, including the search result index and block positions within the content array.

Returns:

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

searchResultLocation

default CitationLocation.Builder searchResultLocation(Consumer<SearchResultLocation.Builder> searchResultLocation)

The search result location where the cited content is found, including the search result index and block positions within the content array.

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

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

Parameters:

searchResultLocation - a consumer that will call methods on SearchResultLocation.Builder

Returns:

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

See Also:

• searchResultLocation(SearchResultLocation)