Skip to content

ConfigurationEvent

Source code in docs_src/capo_qbusiness/types/configuration_event.py
class ConfigurationEvent(TypedDict, closed=True):
    chat_mode: NotRequired["capo_qbusiness.types.chat_mode.ChatMode"]
    """<p>The chat modes available to an Amazon Q Business end user.</p> <ul> <li> <p> <code>RETRIEVAL_MODE</code> - 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.</p> </li> <li> <p> <code>CREATOR_MODE</code> - By selecting this mode, users can choose to generate responses only from the LLM knowledge, without consulting connected data sources, for a chat request.</p> </li> <li> <p> <code>PLUGIN_MODE</code> - By selecting this mode, users can choose to use plugins in chat.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a>, <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html">Plugins</a>, and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>"""
    chat_mode_configuration: NotRequired[
        "capo_qbusiness.types.chat_mode_configuration.ChatModeConfiguration"
    ]
    attribute_filter: NotRequired[
        "capo_qbusiness.types.attribute_filter.AttributeFilter"
    ]

attribute_filter instance-attribute

attribute_filter: NotRequired[AttributeFilter]

chat_mode instance-attribute

chat_mode: NotRequired[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.

chat_mode_configuration instance-attribute

chat_mode_configuration: NotRequired[ChatModeConfiguration]