Skip to content

UpdateChatControlsConfigurationRequest

Source code in docs_src/capo_qbusiness/types/update_chat_controls_configuration_request.py
class UpdateChatControlsConfigurationRequest(TypedDict, closed=True):
    application_id: "capo_qbusiness.types.application_id.ApplicationId"
    """<p>The identifier of the application for which the chat controls are configured.</p>"""
    client_token: NotRequired["capo_qbusiness.types.client_token.ClientToken"]
    """<p>A token that you provide to identify the request to update a Amazon Q Business application chat configuration.</p>"""
    response_scope: NotRequired["capo_qbusiness.types.response_scope.ResponseScope"]
    """<p>The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.</p>"""
    orchestration_configuration: NotRequired[
        "capo_qbusiness.types.orchestration_configuration.OrchestrationConfiguration"
    ]
    """<p> The chat response orchestration settings for your application.</p>"""
    blocked_phrases_configuration_update: NotRequired[
        "capo_qbusiness.types.blocked_phrases_configuration_update.BlockedPhrasesConfigurationUpdate"
    ]
    """<p>The phrases blocked from chat by your chat control configuration.</p>"""
    topic_configurations_to_create_or_update: NotRequired[
        "capo_qbusiness.types.topic_configurations.TopicConfigurations"
    ]
    """<p>The configured topic specific chat controls you want to update.</p>"""
    topic_configurations_to_delete: NotRequired[
        "capo_qbusiness.types.topic_configurations.TopicConfigurations"
    ]
    """<p>The configured topic specific chat controls you want to delete.</p>"""
    creator_mode_configuration: NotRequired[
        "capo_qbusiness.types.creator_mode_configuration.CreatorModeConfiguration"
    ]
    """<p>The configuration details for <code>CREATOR_MODE</code>.</p>"""
    hallucination_reduction_configuration: NotRequired[
        "capo_qbusiness.types.hallucination_reduction_configuration.HallucinationReductionConfiguration"
    ]
    """<p> The hallucination reduction settings for your application.</p>"""

application_id instance-attribute

application_id: ApplicationId

The identifier of the application for which the chat controls are configured.

blocked_phrases_configuration_update instance-attribute

blocked_phrases_configuration_update: NotRequired[BlockedPhrasesConfigurationUpdate]

The phrases blocked from chat by your chat control configuration.

client_token instance-attribute

client_token: NotRequired[ClientToken]

A token that you provide to identify the request to update a Amazon Q Business application chat configuration.

creator_mode_configuration instance-attribute

creator_mode_configuration: NotRequired[CreatorModeConfiguration]

The configuration details for CREATOR_MODE.

hallucination_reduction_configuration instance-attribute

hallucination_reduction_configuration: NotRequired[HallucinationReductionConfiguration]

The hallucination reduction settings for your application.

orchestration_configuration instance-attribute

orchestration_configuration: NotRequired[OrchestrationConfiguration]

The chat response orchestration settings for your application.

response_scope instance-attribute

response_scope: NotRequired[ResponseScope]

The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.

topic_configurations_to_create_or_update instance-attribute

topic_configurations_to_create_or_update: NotRequired[TopicConfigurations]

The configured topic specific chat controls you want to update.

topic_configurations_to_delete instance-attribute

topic_configurations_to_delete: NotRequired[TopicConfigurations]

The configured topic specific chat controls you want to delete.