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

InlineAgentResponseStream

sealed class InlineAgentResponseStream

The response from invoking the agent and associated citations and trace information.

Inheritors

Types

data class Chunk(val value: InlineAgentPayloadPart) : InlineAgentResponseStream

Contains a part of an agent response and citations for it.

data class Files(val value: InlineAgentFilePart) : InlineAgentResponseStream

Contains intermediate response for code interpreter if any files have been generated.

data class ReturnControl(val value: InlineAgentReturnControlPayload) : InlineAgentResponseStream

Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.

object SdkUnknown : InlineAgentResponseStream

data class Trace(val value: InlineAgentTracePart) : InlineAgentResponseStream

Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.

Functions

fun asChunk(): InlineAgentPayloadPart

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

fun asChunkOrNull(): InlineAgentPayloadPart?

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

fun asFiles(): InlineAgentFilePart

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

fun asFilesOrNull(): InlineAgentFilePart?

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

asReturnControl

fun asReturnControl(): InlineAgentReturnControlPayload

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

asReturnControlOrNull

fun asReturnControlOrNull(): InlineAgentReturnControlPayload?

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

fun asTrace(): InlineAgentTracePart

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

fun asTraceOrNull(): InlineAgentTracePart?

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