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

DocumentSource

sealed class DocumentSource

Contains the content of a document.

Inheritors

Types

Bytes

data class Bytes(val value: ByteArray) : DocumentSource

The raw bytes for the document. If you use an Amazon Web Services SDK, you don't need to encode the bytes in base64.

Content

data class Content(val value: List<DocumentContentBlock>) : DocumentSource

The structured content of the document source, which may include various content blocks such as text, images, or other document elements.

S3Location

data class S3Location(val value: S3Location) : DocumentSource

The location of a document object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.

SdkUnknown

object SdkUnknown : DocumentSource

Text

data class Text(val value: String) : DocumentSource

The text content of the document source.

Functions

asBytes

fun asBytes(): ByteArray

Casts this DocumentSource as a Bytes and retrieves its kotlin.ByteArray value. Throws an exception if the DocumentSource is not a Bytes.

asBytesOrNull

fun asBytesOrNull(): ByteArray?

Casts this DocumentSource as a Bytes and retrieves its kotlin.ByteArray value. Returns null if the DocumentSource is not a Bytes.

asContent

fun asContent(): List<DocumentContentBlock>

Casts this DocumentSource as a Content and retrieves its kotlin.collections.List value. Throws an exception if the DocumentSource is not a Content.

asContentOrNull

fun asContentOrNull(): List<DocumentContentBlock>?

Casts this DocumentSource as a Content and retrieves its kotlin.collections.List value. Returns null if the DocumentSource is not a Content.

asS3Location

fun asS3Location(): S3Location

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

asS3LocationOrNull

fun asS3LocationOrNull(): S3Location?

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

asText

fun asText(): String

Casts this DocumentSource as a Text and retrieves its kotlin.String value. Throws an exception if the DocumentSource is not a Text.

asTextOrNull

fun asTextOrNull(): String?

Casts this DocumentSource as a Text and retrieves its kotlin.String value. Returns null if the DocumentSource is not a Text.