ConfigurationEvent
A configuration event activated by an end user request to select a specific chat mode.
Contents
- attributeFilter
-
Enables filtering of responses based on document attributes or metadata fields.
Type: AttributeFilter object
Required: No
- 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.
Type: String
Valid Values:
RETRIEVAL_MODE | CREATOR_MODE | PLUGIN_MODE
Required: No
-
- chatModeConfiguration
-
Configuration information for Amazon Q Business conversation modes.
For more information, see Admin controls and guardrails and Conversation settings.
Type: ChatModeConfiguration object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: