bedrockruntime/aws.sdk.kotlin.services.bedrockruntime.model/CitationLocation

CitationLocation

sealed class CitationLocation

Specifies the precise location within a source document where cited content can be found. This can include character-level positions, page numbers, or document chunks depending on the document type and indexing method.

Inheritors

SearchResultLocation

Types

data class DocumentChar(val value: DocumentCharLocation) : CitationLocation

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

data class DocumentChunk(val value: DocumentChunkLocation) : CitationLocation

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

data class DocumentPage(val value: DocumentPageLocation) : CitationLocation

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

object SdkUnknown : CitationLocation

SearchResultLocation

data class SearchResultLocation(val value: SearchResultLocation) : CitationLocation

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

data class Web(val value: WebLocation) : CitationLocation

The web URL that was cited for this reference.

Functions

fun asDocumentChar(): DocumentCharLocation

Casts this CitationLocation as a DocumentChar and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.DocumentCharLocation value. Throws an exception if the CitationLocation is not a DocumentChar.

asDocumentCharOrNull

fun asDocumentCharOrNull(): DocumentCharLocation?

Casts this CitationLocation as a DocumentChar and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.DocumentCharLocation value. Returns null if the CitationLocation is not a DocumentChar.

asDocumentChunk

fun asDocumentChunk(): DocumentChunkLocation

Casts this CitationLocation as a DocumentChunk and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.DocumentChunkLocation value. Throws an exception if the CitationLocation is not a DocumentChunk.

asDocumentChunkOrNull

fun asDocumentChunkOrNull(): DocumentChunkLocation?

Casts this CitationLocation as a DocumentChunk and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.DocumentChunkLocation value. Returns null if the CitationLocation is not a DocumentChunk.

fun asDocumentPage(): DocumentPageLocation

Casts this CitationLocation as a DocumentPage and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.DocumentPageLocation value. Throws an exception if the CitationLocation is not a DocumentPage.

asDocumentPageOrNull

fun asDocumentPageOrNull(): DocumentPageLocation?

Casts this CitationLocation as a DocumentPage and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.DocumentPageLocation value. Returns null if the CitationLocation is not a DocumentPage.

asSearchResultLocation

fun asSearchResultLocation(): SearchResultLocation

Casts this CitationLocation as a SearchResultLocation and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.SearchResultLocation value. Throws an exception if the CitationLocation is not a SearchResultLocation.

asSearchResultLocationOrNull

fun asSearchResultLocationOrNull(): SearchResultLocation?

Casts this CitationLocation as a SearchResultLocation and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.SearchResultLocation value. Returns null if the CitationLocation is not a SearchResultLocation.

fun asWeb(): WebLocation

Casts this CitationLocation as a Web and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.WebLocation value. Throws an exception if the CitationLocation is not a Web.

fun asWebOrNull(): WebLocation?

Casts this CitationLocation as a Web and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.WebLocation value. Returns null if the CitationLocation is not a Web.