Skip to content

MetadataEvent

Source code in docs_src/capo_qbusiness/types/metadata_event.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
class MetadataEvent(TypedDict, closed=True):
    conversation_id: NotRequired["capo_qbusiness.types.conversation_id.ConversationId"]
    """<p>The identifier of the conversation with which the generated metadata is associated.</p>"""
    user_message_id: NotRequired["capo_qbusiness.types.message_id.MessageId"]
    """<p>The identifier of an Amazon Q Business end user text input message within the conversation.</p>"""
    system_message_id: NotRequired["capo_qbusiness.types.message_id.MessageId"]
    """<p>The identifier of an Amazon Q Business AI generated message within the conversation.</p>"""
    source_attributions: NotRequired[
        "capo_qbusiness.types.source_attributions.SourceAttributions"
    ]
    """<p>The source documents used to generate the conversation response.</p>"""
    final_text_message: NotRequired["capo_qbusiness.types.string.String"]
    """<p>The final text output message generated by the system.</p>"""

conversation_id instance-attribute 

conversation_id: NotRequired[ConversationId]

The identifier of the conversation with which the generated metadata is associated.

final_text_message instance-attribute 

final_text_message: NotRequired[String]

The final text output message generated by the system.

source_attributions instance-attribute 

source_attributions: NotRequired[SourceAttributions]

The source documents used to generate the conversation response.

system_message_id instance-attribute 

system_message_id: NotRequired[MessageId]

The identifier of an Amazon Q Business AI generated message within the conversation.

user_message_id instance-attribute 

user_message_id: NotRequired[MessageId]

The identifier of an Amazon Q Business end user text input message within the conversation.