ConfigurationEvent¶
Structure Class¶
ConfigurationEvent
dataclass
¶
A configuration event activated by an end user request to select a specific chat mode.
Attributes¶
attribute_filter
class-attribute
instance-attribute
¶
attribute_filter: AttributeFilter | None = None
Enables filtering of responses based on document attributes or metadata fields.
chat_mode
class-attribute
instance-attribute
¶
chat_mode: ChatMode | None = None
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.
chat_mode_configuration
class-attribute
instance-attribute
¶
chat_mode_configuration: ChatModeConfiguration | None = None
Configuration information for Amazon Q Business conversation modes.
For more information, see Admin controls and guardrails and Conversation settings.