Skip to content

TextOutputEvent

Source code in docs_src/capo_qbusiness/types/text_output_event.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
class TextOutputEvent(TypedDict, closed=True):
    system_message_type: NotRequired[
        "capo_qbusiness.types.system_message_type.SystemMessageType"
    ]
    """<p>The type of AI-generated message in a <code>TextOutputEvent</code>. Amazon Q Business currently supports two types of messages:</p> <ul> <li> <p> <code>RESPONSE</code> - The Amazon Q Business system response.</p> </li> <li> <p> <code>GROUNDED_RESPONSE</code> - 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.</p> </li> </ul>"""
    conversation_id: NotRequired["capo_qbusiness.types.conversation_id.ConversationId"]
    """<p>The identifier of the conversation with which the text output event is associated.</p>"""
    user_message_id: NotRequired["capo_qbusiness.types.message_id.MessageId"]
    """<p>The identifier of an end user message in a <code>TextOutputEvent</code>.</p>"""
    system_message_id: NotRequired["capo_qbusiness.types.message_id.MessageId"]
    """<p>The identifier of an AI-generated message in a <code>TextOutputEvent</code>.</p>"""
    system_message: NotRequired["capo_qbusiness.types.string.String"]
    """<p>An AI-generated message in a <code>TextOutputEvent</code>.</p>"""

conversation_id instance-attribute 

conversation_id: NotRequired[ConversationId]

The identifier of the conversation with which the text output event is associated.

system_message instance-attribute 

system_message: NotRequired[String]

An AI-generated message in a TextOutputEvent.

system_message_id instance-attribute 

system_message_id: NotRequired[MessageId]

The identifier of an AI-generated message in a TextOutputEvent.

system_message_type instance-attribute 

system_message_type: NotRequired[SystemMessageType]

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.

user_message_id instance-attribute 

user_message_id: NotRequired[MessageId]

The identifier of an end user message in a TextOutputEvent.