Qbusiness  >  Unions  >  ChatInputStream

ChatInputStream

Union Type

ChatInputStream module-attribute

ChatInputStream = Union[ChatInputStreamConfigurationEvent | ChatInputStreamTextEvent | ChatInputStreamAttachmentEvent | ChatInputStreamActionExecutionEvent | ChatInputStreamEndOfInputEvent | ChatInputStreamAuthChallengeResponseEvent | ChatInputStreamUnknown]

The streaming input for the Chat API.

Union Member Types

ChatInputStreamConfigurationEvent dataclass

A configuration event activated by an end user request to select a specific chat mode.

Attributes

value instance-attribute

value: ConfigurationEvent

ChatInputStreamTextEvent dataclass

Information about the payload of the ChatInputStream event containing the end user message input.

Attributes

value instance-attribute

value: TextInputEvent

ChatInputStreamAttachmentEvent dataclass

A request by an end user to upload a file during chat.

Attributes

value instance-attribute

value: AttachmentInputEvent

ChatInputStreamActionExecutionEvent dataclass

A request from an end user to perform an Amazon Q Business plugin action.

Attributes

value instance-attribute

value: ActionExecutionEvent

ChatInputStreamEndOfInputEvent dataclass

The end of the streaming input for the Chat API.

Attributes

value instance-attribute

value: EndOfInputEvent

ChatInputStreamAuthChallengeResponseEvent dataclass

An authentication verification event response by a third party authentication server to Amazon Q Business.

Attributes

value instance-attribute

value: AuthChallengeResponseEvent

ChatInputStreamUnknown 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