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

ConverseStreamOutput

sealed class ConverseStreamOutput

The messages output stream

Inheritors

ContentBlockDelta

ContentBlockStart

ContentBlockStop

Types

ContentBlockDelta

data class ContentBlockDelta(val value: ContentBlockDeltaEvent) : ConverseStreamOutput

The messages output content block delta.

ContentBlockStart

data class ContentBlockStart(val value: ContentBlockStartEvent) : ConverseStreamOutput

Start information for a content block.

ContentBlockStop

data class ContentBlockStop(val value: ContentBlockStopEvent) : ConverseStreamOutput

Stop information for a content block.

data class MessageStart(val value: MessageStartEvent) : ConverseStreamOutput

Message start information.

data class MessageStop(val value: MessageStopEvent) : ConverseStreamOutput

Message stop information.

data class Metadata(val value: ConverseStreamMetadataEvent) : ConverseStreamOutput

Metadata for the converse output stream.

object SdkUnknown : ConverseStreamOutput

Functions

asContentBlockDelta

fun asContentBlockDelta(): ContentBlockDeltaEvent

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

asContentBlockDeltaOrNull

fun asContentBlockDeltaOrNull(): ContentBlockDeltaEvent?

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

asContentBlockStart

fun asContentBlockStart(): ContentBlockStartEvent

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

asContentBlockStartOrNull

fun asContentBlockStartOrNull(): ContentBlockStartEvent?

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

asContentBlockStop

fun asContentBlockStop(): ContentBlockStopEvent

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

asContentBlockStopOrNull

fun asContentBlockStopOrNull(): ContentBlockStopEvent?

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

fun asMessageStart(): MessageStartEvent

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

asMessageStartOrNull

fun asMessageStartOrNull(): MessageStartEvent?

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

fun asMessageStop(): MessageStopEvent

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

asMessageStopOrNull

fun asMessageStopOrNull(): MessageStopEvent?

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

fun asMetadata(): ConverseStreamMetadataEvent

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

asMetadataOrNull

fun asMetadataOrNull(): ConverseStreamMetadataEvent?

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