bedrockagentruntime/aws.sdk.kotlin.services.bedrockagentruntime.model/FlowResponseStream

FlowResponseStream

sealed class FlowResponseStream

The output of the flow.

Inheritors

FlowCompletionEvent

FlowMultiTurnInputRequestEvent

FlowOutputEvent

Types

FlowCompletionEvent

data class FlowCompletionEvent(val value: FlowCompletionEvent) : FlowResponseStream

Contains information about why the flow completed.

FlowMultiTurnInputRequestEvent

data class FlowMultiTurnInputRequestEvent(val value: FlowMultiTurnInputRequestEvent) : FlowResponseStream

The event stream containing the multi-turn input request information from the flow.

FlowOutputEvent

data class FlowOutputEvent(val value: FlowOutputEvent) : FlowResponseStream

Contains information about an output from flow invocation.

data class FlowTraceEvent(val value: FlowTraceEvent) : FlowResponseStream

Contains information about a trace, which tracks an input or output for a node in the flow.

object SdkUnknown : FlowResponseStream

Functions

asFlowCompletionEvent

fun asFlowCompletionEvent(): FlowCompletionEvent

Casts this FlowResponseStream as a FlowCompletionEvent and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FlowCompletionEvent value. Throws an exception if the FlowResponseStream is not a FlowCompletionEvent.

asFlowCompletionEventOrNull

fun asFlowCompletionEventOrNull(): FlowCompletionEvent?

Casts this FlowResponseStream as a FlowCompletionEvent and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FlowCompletionEvent value. Returns null if the FlowResponseStream is not a FlowCompletionEvent.

asFlowMultiTurnInputRequestEvent

fun asFlowMultiTurnInputRequestEvent(): FlowMultiTurnInputRequestEvent

Casts this FlowResponseStream as a FlowMultiTurnInputRequestEvent and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FlowMultiTurnInputRequestEvent value. Throws an exception if the FlowResponseStream is not a FlowMultiTurnInputRequestEvent.

asFlowMultiTurnInputRequestEventOrNull

fun asFlowMultiTurnInputRequestEventOrNull(): FlowMultiTurnInputRequestEvent?

Casts this FlowResponseStream as a FlowMultiTurnInputRequestEvent and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FlowMultiTurnInputRequestEvent value. Returns null if the FlowResponseStream is not a FlowMultiTurnInputRequestEvent.

asFlowOutputEvent

fun asFlowOutputEvent(): FlowOutputEvent

Casts this FlowResponseStream as a FlowOutputEvent and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FlowOutputEvent value. Throws an exception if the FlowResponseStream is not a FlowOutputEvent.

asFlowOutputEventOrNull

fun asFlowOutputEventOrNull(): FlowOutputEvent?

Casts this FlowResponseStream as a FlowOutputEvent and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FlowOutputEvent value. Returns null if the FlowResponseStream is not a FlowOutputEvent.

asFlowTraceEvent

fun asFlowTraceEvent(): FlowTraceEvent

Casts this FlowResponseStream as a FlowTraceEvent and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FlowTraceEvent value. Throws an exception if the FlowResponseStream is not a FlowTraceEvent.

asFlowTraceEventOrNull

fun asFlowTraceEventOrNull(): FlowTraceEvent?

Casts this FlowResponseStream as a FlowTraceEvent and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FlowTraceEvent value. Returns null if the FlowResponseStream is not a FlowTraceEvent.