A content block that contains both generated text and associated citation information, providing traceability between the response and source documents.

Document

data class Document(val value: DocumentBlock) : ContentBlock

A document to include in the message.

GuardContent

data class GuardContent(val value: GuardrailConverseContentBlock) : ContentBlock

Contains the content to assess with the guardrail. If you don't specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.

Image

data class Image(val value: ImageBlock) : ContentBlock

Image to include in the message.

ReasoningContent

data class ReasoningContent(val value: ReasoningContentBlock) : ContentBlock

Contains content regarding the reasoning that is carried out by the model. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.

SdkUnknown

object SdkUnknown : ContentBlock

SearchResult

data class SearchResult(val value: SearchResultBlock) : ContentBlock

Search result to include in the message.

Text

data class Text(val value: String) : ContentBlock

Text to include in the message.

ToolResult

data class ToolResult(val value: ToolResultBlock) : ContentBlock

The result for a tool request that a model makes.

ToolUse

data class ToolUse(val value: ToolUseBlock) : ContentBlock

Information about a tool use request from a model.

Video

data class Video(val value: VideoBlock) : ContentBlock

Video to include in the message.

Functions

asAudio

fun asAudio(): AudioBlock

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

asAudioOrNull

fun asAudioOrNull(): AudioBlock?

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

asCachePoint

fun asCachePoint(): CachePointBlock

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

asCachePointOrNull

fun asCachePointOrNull(): CachePointBlock?

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

asCitationsContent

fun asCitationsContent(): CitationsContentBlock

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

asCitationsContentOrNull

fun asCitationsContentOrNull(): CitationsContentBlock?

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

asDocument

fun asDocument(): DocumentBlock

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

asDocumentOrNull

fun asDocumentOrNull(): DocumentBlock?

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

asGuardContent

fun asGuardContent(): GuardrailConverseContentBlock

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

asGuardContentOrNull

fun asGuardContentOrNull(): GuardrailConverseContentBlock?

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

asImage

fun asImage(): ImageBlock

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

asImageOrNull

fun asImageOrNull(): ImageBlock?

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

asReasoningContent

fun asReasoningContent(): ReasoningContentBlock

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

asReasoningContentOrNull

fun asReasoningContentOrNull(): ReasoningContentBlock?

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

asSearchResult

fun asSearchResult(): SearchResultBlock

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

asSearchResultOrNull

fun asSearchResultOrNull(): SearchResultBlock?

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

asText

fun asText(): String

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

asTextOrNull

fun asTextOrNull(): String?

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

asToolResult

fun asToolResult(): ToolResultBlock

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

asToolResultOrNull

fun asToolResultOrNull(): ToolResultBlock?

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

asToolUse

fun asToolUse(): ToolUseBlock

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

asToolUseOrNull

fun asToolUseOrNull(): ToolUseBlock?

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

asVideo

fun asVideo(): VideoBlock

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

asVideoOrNull

fun asVideoOrNull(): VideoBlock?

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