TextOutputEvent¶
Structure Class¶
dataclass
¶
An output event for an AI-generated response in an Amazon Q Business web experience.
Attributes¶
class-attribute
instance-attribute
¶
conversation_id: str | None = None
The identifier of the conversation with which the text output event is associated.
class-attribute
instance-attribute
¶
system_message: str | None = None
An AI-generated message in a TextOutputEvent.
class-attribute
instance-attribute
¶
system_message_id: str | None = None
The identifier of an AI-generated message in a TextOutputEvent.
class-attribute
instance-attribute
¶
system_message_type: SystemMessageType | None = None
The type of AI-generated message in a TextOutputEvent. Amazon Q
Business currently supports two types of messages:
-
RESPONSE- The Amazon Q Business system response. -
GROUNDED_RESPONSE- The corrected, hallucination-reduced, response returned by Amazon Q Business. Available only if hallucination reduction is supported and configured for the application and detected in the end user chat query by Amazon Q Business.
class-attribute
instance-attribute
¶
user_message_id: str | None = None
The identifier of an end user message in a TextOutputEvent.