qbusiness/aws.sdk.kotlin.services.qbusiness.model/DocumentContent

DocumentContent

The contents of a document.

Documents have size limitations. The maximum file size for a document is 50 MB. The maximum amount of text that can be extracted from a single document is 5 MB. For more information, see Supported document formats in Amazon Q Business.

Inheritors

Blob

SdkUnknown

Types

Blob

data class Blob(val value: ByteArray) : DocumentContent

The contents of the document. Documents passed to the blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the Amazon Q Business endpoint directly using REST, you must base64 encode the contents before sending.

data class S3(val value: S3) : DocumentContent

The path to the document in an Amazon S3 bucket.

SdkUnknown

object SdkUnknown : DocumentContent

Functions

asBlob

fun asBlob(): ByteArray

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

asBlobOrNull

fun asBlobOrNull(): ByteArray?

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

asS3

fun asS3(): S3

Casts this DocumentContent as a S3 and retrieves its aws.sdk.kotlin.services.qbusiness.model.S3 value. Throws an exception if the DocumentContent is not a S3.

asS3OrNull

fun asS3OrNull(): S3?

Casts this DocumentContent as a S3 and retrieves its aws.sdk.kotlin.services.qbusiness.model.S3 value. Returns null if the DocumentContent is not a S3.