Skip to content

ChatSyncOutput

Source code in docs_src/capo_qbusiness/types/chat_sync_output.py
class ChatSyncOutput(TypedDict, closed=True):
    conversation_id: NotRequired["capo_qbusiness.types.conversation_id.ConversationId"]
    """<p>The identifier of the Amazon Q Business conversation.</p>"""
    system_message: NotRequired["capo_qbusiness.types.string.String"]
    """<p>An AI-generated message in a 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>"""
    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>"""
    action_review: NotRequired["capo_qbusiness.types.action_review.ActionReview"]
    """<p>A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.</p>"""
    auth_challenge_request: NotRequired[
        "capo_qbusiness.types.auth_challenge_request.AuthChallengeRequest"
    ]
    """<p>An authentication verification event activated by an end user request to use a custom plugin.</p>"""
    source_attributions: NotRequired[
        "capo_qbusiness.types.source_attributions.SourceAttributions"
    ]
    """<p>The source documents used to generate the conversation response.</p>"""
    failed_attachments: NotRequired[
        "capo_qbusiness.types.attachments_output.AttachmentsOutput"
    ]
    """<p>A list of files which failed to upload during chat.</p>"""

action_review instance-attribute

action_review: NotRequired[ActionReview]

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

auth_challenge_request instance-attribute

auth_challenge_request: NotRequired[AuthChallengeRequest]

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

conversation_id instance-attribute

conversation_id: NotRequired[ConversationId]

The identifier of the Amazon Q Business conversation.

failed_attachments instance-attribute

failed_attachments: NotRequired[AttachmentsOutput]

A list of files which failed to upload during chat.

source_attributions instance-attribute

source_attributions: NotRequired[SourceAttributions]

The source documents used to generate the conversation response.

system_message instance-attribute

system_message: NotRequired[String]

An AI-generated message in a conversation.

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.