Skip to content

/AWS1/CL_QQBCONFIGURATIONEVENT

A configuration event activated by an end user request to select a specific chat mode.

CONSTRUCTOR

IMPORTING

Optional arguments:

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

Configuration information for Amazon Q Business conversation modes.

For more information, see Admin controls and guardrails and Conversation settings.

io_attributefilter TYPE REF TO /AWS1/CL_QQBATTRIBUTEFILTER /AWS1/CL_QQBATTRIBUTEFILTER

Enables filtering of responses based on document attributes or metadata fields.

Queryable Attributes

chatMode

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.

Accessible with the following methods

Method Description
GET_CHATMODE() Getter for CHATMODE, with configurable default
ASK_CHATMODE() Getter for CHATMODE w/ exceptions if field has no value
HAS_CHATMODE() Determine if CHATMODE has a value

chatModeConfiguration

Configuration information for Amazon Q Business conversation modes.

For more information, see Admin controls and guardrails and Conversation settings.

Accessible with the following methods

Method Description
GET_CHATMODECONFIGURATION() Getter for CHATMODECONFIGURATION

attributeFilter

Enables filtering of responses based on document attributes or metadata fields.

Accessible with the following methods

Method Description
GET_ATTRIBUTEFILTER() Getter for ATTRIBUTEFILTER