Skip to content

ChatInput

Source code in docs_src/capo_qbusiness/types/chat_input.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class ChatInput(TypedDict, closed=True):
    application_id: "capo_qbusiness.types.application_id.ApplicationId"
    """<p>The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business conversation.</p>"""
    user_id: NotRequired["capo_qbusiness.types.user_id.UserId"]
    """<p>The identifier of the user attached to the chat input. </p>"""
    user_groups: NotRequired["capo_qbusiness.types.user_groups.UserGroups"]
    """<p>The group names that a user associated with the chat input belongs to.</p>"""
    conversation_id: NotRequired["capo_qbusiness.types.conversation_id.ConversationId"]
    """<p>The identifier of the Amazon Q Business conversation.</p>"""
    parent_message_id: NotRequired["capo_qbusiness.types.message_id.MessageId"]
    """<p>The identifier used to associate a user message with a AI generated response.</p>"""
    client_token: NotRequired["capo_qbusiness.types.client_token.ClientToken"]
    """<p>A token that you provide to identify the chat input.</p>"""
    input_stream: NotRequired["capo_qbusiness.types.chat_input_stream.ChatInputStream"]
    """<p>The streaming input for the <code>Chat</code> API.</p>"""

application_id instance-attribute 

application_id: ApplicationId

The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business conversation.

client_token instance-attribute 

client_token: NotRequired[ClientToken]

A token that you provide to identify the chat input.

conversation_id instance-attribute 

conversation_id: NotRequired[ConversationId]

The identifier of the Amazon Q Business conversation.

input_stream instance-attribute 

input_stream: NotRequired[ChatInputStream]

The streaming input for the Chat API.

parent_message_id instance-attribute 

parent_message_id: NotRequired[MessageId]

The identifier used to associate a user message with a AI generated response.

user_groups instance-attribute 

user_groups: NotRequired[UserGroups]

The group names that a user associated with the chat input belongs to.

user_id instance-attribute 

user_id: NotRequired[UserId]

The identifier of the user attached to the chat input.