qbusiness/aws.sdk.kotlin.services.qbusiness.model/ChatOutputStream

ChatOutputStream

sealed class ChatOutputStream

The streaming output for the Chat API.

Inheritors

ActionReviewEvent

AuthChallengeRequestEvent

FailedAttachmentEvent

MetadataEvent

TextEvent

SdkUnknown

Types

ActionReviewEvent

data class ActionReviewEvent(val value: ActionReviewEvent) : ChatOutputStream

A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.

AuthChallengeRequestEvent

data class AuthChallengeRequestEvent(val value: AuthChallengeRequestEvent) : ChatOutputStream

An authentication verification event activated by an end user request to use a custom plugin.

FailedAttachmentEvent

data class FailedAttachmentEvent(val value: FailedAttachmentEvent) : ChatOutputStream

A failed file upload event during a web experience chat.

MetadataEvent

data class MetadataEvent(val value: MetadataEvent) : ChatOutputStream

A metadata event for a AI-generated text output message in a Amazon Q Business conversation.

SdkUnknown

object SdkUnknown : ChatOutputStream

TextEvent

data class TextEvent(val value: TextOutputEvent) : ChatOutputStream

Information about the payload of the ChatOutputStream event containing the AI-generated message output.

Functions

asActionReviewEvent

fun asActionReviewEvent(): ActionReviewEvent

Casts this ChatOutputStream as a ActionReviewEvent and retrieves its aws.sdk.kotlin.services.qbusiness.model.ActionReviewEvent value. Throws an exception if the ChatOutputStream is not a ActionReviewEvent.

asActionReviewEventOrNull

fun asActionReviewEventOrNull(): ActionReviewEvent?

Casts this ChatOutputStream as a ActionReviewEvent and retrieves its aws.sdk.kotlin.services.qbusiness.model.ActionReviewEvent value. Returns null if the ChatOutputStream is not a ActionReviewEvent.

asAuthChallengeRequestEvent

fun asAuthChallengeRequestEvent(): AuthChallengeRequestEvent

Casts this ChatOutputStream as a AuthChallengeRequestEvent and retrieves its aws.sdk.kotlin.services.qbusiness.model.AuthChallengeRequestEvent value. Throws an exception if the ChatOutputStream is not a AuthChallengeRequestEvent.

asAuthChallengeRequestEventOrNull

fun asAuthChallengeRequestEventOrNull(): AuthChallengeRequestEvent?

Casts this ChatOutputStream as a AuthChallengeRequestEvent and retrieves its aws.sdk.kotlin.services.qbusiness.model.AuthChallengeRequestEvent value. Returns null if the ChatOutputStream is not a AuthChallengeRequestEvent.

asFailedAttachmentEvent

fun asFailedAttachmentEvent(): FailedAttachmentEvent

Casts this ChatOutputStream as a FailedAttachmentEvent and retrieves its aws.sdk.kotlin.services.qbusiness.model.FailedAttachmentEvent value. Throws an exception if the ChatOutputStream is not a FailedAttachmentEvent.

asFailedAttachmentEventOrNull

fun asFailedAttachmentEventOrNull(): FailedAttachmentEvent?

Casts this ChatOutputStream as a FailedAttachmentEvent and retrieves its aws.sdk.kotlin.services.qbusiness.model.FailedAttachmentEvent value. Returns null if the ChatOutputStream is not a FailedAttachmentEvent.

asMetadataEvent

fun asMetadataEvent(): MetadataEvent

Casts this ChatOutputStream as a MetadataEvent and retrieves its aws.sdk.kotlin.services.qbusiness.model.MetadataEvent value. Throws an exception if the ChatOutputStream is not a MetadataEvent.

asMetadataEventOrNull

fun asMetadataEventOrNull(): MetadataEvent?

Casts this ChatOutputStream as a MetadataEvent and retrieves its aws.sdk.kotlin.services.qbusiness.model.MetadataEvent value. Returns null if the ChatOutputStream is not a MetadataEvent.

asTextEvent

fun asTextEvent(): TextOutputEvent

Casts this ChatOutputStream as a TextEvent and retrieves its aws.sdk.kotlin.services.qbusiness.model.TextOutputEvent value. Throws an exception if the ChatOutputStream is not a TextEvent.

asTextEventOrNull

fun asTextEventOrNull(): TextOutputEvent?

Casts this ChatOutputStream as a TextEvent and retrieves its aws.sdk.kotlin.services.qbusiness.model.TextOutputEvent value. Returns null if the ChatOutputStream is not a TextEvent.