Skip to content

Qbusiness  >  Unions  >  ChatOutputStream

ChatOutputStream

Union Type

ChatOutputStream module-attribute 

ChatOutputStream = Union[ChatOutputStreamTextEvent | ChatOutputStreamMetadataEvent | ChatOutputStreamActionReviewEvent | ChatOutputStreamFailedAttachmentEvent | ChatOutputStreamAuthChallengeRequestEvent | ChatOutputStreamUnknown]

The streaming output for the Chat API.

Union Member Types

ChatOutputStreamTextEvent dataclass

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

Attributes

value instance-attribute 
value: TextOutputEvent

ChatOutputStreamMetadataEvent dataclass

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

Attributes

value instance-attribute 
value: MetadataEvent

ChatOutputStreamActionReviewEvent dataclass

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

Attributes

value instance-attribute 
value: ActionReviewEvent

ChatOutputStreamFailedAttachmentEvent dataclass

A failed file upload event during a web experience chat.

Attributes

value instance-attribute 
value: FailedAttachmentEvent

ChatOutputStreamAuthChallengeRequestEvent dataclass

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

Attributes

value instance-attribute 
value: AuthChallengeRequestEvent

ChatOutputStreamUnknown dataclass

Represents an unknown variant.

If you receive this value, you will need to update your library to receive the parsed value.

This value may not be deliberately sent.

Attributes

tag instance-attribute 
tag: str