/AWS1/CL_QQB=>CHATSYNC()
¶
About ChatSync¶
Starts or continues a non-streaming Amazon Q Business conversation.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_APPLICATIONID
TYPE /AWS1/QQBAPPLICATIONID
/AWS1/QQBAPPLICATIONID
¶
The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.
Optional arguments:¶
IV_USERID
TYPE /AWS1/QQBUSERID
/AWS1/QQBUSERID
¶
The identifier of the user attached to the chat input.
IT_USERGROUPS
TYPE /AWS1/CL_QQBUSERGROUPS_W=>TT_USERGROUPS
TT_USERGROUPS
¶
The groups that a user associated with the chat input belongs to.
IV_USERMESSAGE
TYPE /AWS1/QQBUSERMESSAGE
/AWS1/QQBUSERMESSAGE
¶
A end user message in a conversation.
IT_ATTACHMENTS
TYPE /AWS1/CL_QQBATTACHMENTINPUT=>TT_ATTACHMENTSINPUT
TT_ATTACHMENTSINPUT
¶
A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.
IO_ACTIONEXECUTION
TYPE REF TO /AWS1/CL_QQBACTIONEXECUTION
/AWS1/CL_QQBACTIONEXECUTION
¶
A request from an end user to perform an Amazon Q Business plugin action.
IO_AUTHCHALLENGERESPONSE
TYPE REF TO /AWS1/CL_QQBAUTHCHALLENGERSP
/AWS1/CL_QQBAUTHCHALLENGERSP
¶
An authentication verification event response by a third party authentication server to Amazon Q Business.
IV_CONVERSATIONID
TYPE /AWS1/QQBCONVERSATIONID
/AWS1/QQBCONVERSATIONID
¶
The identifier of the Amazon Q Business conversation.
IV_PARENTMESSAGEID
TYPE /AWS1/QQBMESSAGEID
/AWS1/QQBMESSAGEID
¶
The identifier of the previous end user text input message in a conversation.
IO_ATTRIBUTEFILTER
TYPE REF TO /AWS1/CL_QQBATTRIBUTEFILTER
/AWS1/CL_QQBATTRIBUTEFILTER
¶
Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.
IV_CHATMODE
TYPE /AWS1/QQBCHATMODE
/AWS1/QQBCHATMODE
¶
The chat modes available to an Amazon Q Business end user.
RETRIEVAL_MODE
- The default chat mode for an Amazon Q Business application. When this mode is enabled, Amazon Q Business generates responses only from data sources connected to an Amazon Q Business application.
CREATOR_MODE
- By selecting this mode, users can choose to generate responses only from the LLM knowledge, without consulting connected data sources, for a chat request.
PLUGIN_MODE
- By selecting this mode, users can choose to use plugins in chat.For more information, see Admin controls and guardrails, Plugins, and Conversation settings.
IO_CHATMODECONFIGURATION
TYPE REF TO /AWS1/CL_QQBCHATMODECONF
/AWS1/CL_QQBCHATMODECONF
¶
The chat mode configuration for an Amazon Q Business application.
IV_CLIENTTOKEN
TYPE /AWS1/QQBCLIENTTOKEN
/AWS1/QQBCLIENTTOKEN
¶
A token that you provide to identify a chat request.