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

AgenticRetrieveStreamResponseOutput

sealed class AgenticRetrieveStreamResponseOutput

The streaming output for agentic retrieval, containing results, traces, and errors.

Inheritors

Types

data class ResponseEvent(val value: AgenticRetrieveResponseEvent) : AgenticRetrieveStreamResponseOutput

A chunk of the generated answer. Emitted only when generateResponse is true.

data class Result(val value: AgenticRetrieveResultEvent) : AgenticRetrieveStreamResponseOutput

A retrieval result event containing the retrieved items.

object SdkUnknown : AgenticRetrieveStreamResponseOutput

data class TraceEvent(val value: AgenticRetrieveTraceEvent) : AgenticRetrieveStreamResponseOutput

A trace event providing visibility into the retrieval process.

Functions

asResponseEvent

fun asResponseEvent(): AgenticRetrieveResponseEvent

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

asResponseEventOrNull

fun asResponseEventOrNull(): AgenticRetrieveResponseEvent?

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

fun asResult(): AgenticRetrieveResultEvent

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

fun asResultOrNull(): AgenticRetrieveResultEvent?

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

fun asTraceEvent(): AgenticRetrieveTraceEvent

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

asTraceEventOrNull

fun asTraceEventOrNull(): AgenticRetrieveTraceEvent?

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