Skip to content

GetChatControlsConfigurationResponse

Source code in docs_src/capo_qbusiness/types/get_chat_controls_configuration_response.py
class GetChatControlsConfigurationResponse(TypedDict, closed=True):
    response_scope: NotRequired["capo_qbusiness.types.response_scope.ResponseScope"]
    """<p>The response scope configured for a Amazon Q Business 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.applied_orchestration_configuration.AppliedOrchestrationConfiguration"
    ]
    """<p> The chat response orchestration settings for your application.</p> <note> <p>Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/supported-languages.html">Supported languages</a>.</p> </note>"""
    blocked_phrases: NotRequired[
        "capo_qbusiness.types.blocked_phrases_configuration.BlockedPhrasesConfiguration"
    ]
    """<p>The phrases blocked from chat by your chat control configuration.</p>"""
    topic_configurations: NotRequired[
        "capo_qbusiness.types.topic_configurations.TopicConfigurations"
    ]
    """<p>The topic specific controls configured for a Amazon Q Business application.</p>"""
    creator_mode_configuration: NotRequired[
        "capo_qbusiness.types.applied_creator_mode_configuration.AppliedCreatorModeConfiguration"
    ]
    """<p>The configuration details for <code>CREATOR_MODE</code>.</p>"""
    next_token: NotRequired["capo_qbusiness.types.next_token.NextToken"]
    """<p>If the <code>maxResults</code> response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.</p>"""
    hallucination_reduction_configuration: NotRequired[
        "capo_qbusiness.types.hallucination_reduction_configuration.HallucinationReductionConfiguration"
    ]
    """<p> The hallucination reduction settings for your application.</p>"""

blocked_phrases instance-attribute

blocked_phrases: NotRequired[BlockedPhrasesConfiguration]

The phrases blocked from chat by your chat control configuration.

creator_mode_configuration instance-attribute

creator_mode_configuration: NotRequired[AppliedCreatorModeConfiguration]

The configuration details for CREATOR_MODE.

hallucination_reduction_configuration instance-attribute

hallucination_reduction_configuration: NotRequired[HallucinationReductionConfiguration]

The hallucination reduction settings for your application.

next_token instance-attribute

next_token: NotRequired[NextToken]

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.

orchestration_configuration instance-attribute

orchestration_configuration: NotRequired[AppliedOrchestrationConfiguration]

The chat response orchestration settings for your application.

Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see Supported languages.

response_scope instance-attribute

response_scope: NotRequired[ResponseScope]

The response scope configured for a Amazon Q Business 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 instance-attribute

topic_configurations: NotRequired[TopicConfigurations]

The topic specific controls configured for a Amazon Q Business application.