---
title: "PATCH /applications/{applicationId}/chatcontrols"
method: PATCH
path: "/applications/{applicationId}/chatcontrols"
---

# PATCH /applications/{applicationId}/chatcontrols

`PATCH /applications/{applicationId}/chatcontrols`

Updates a set of chat controls configured for an existing Amazon Q Business application.

## Path parameters

- `applicationId` string, required

## Request body

- object
  - `clientToken` string — A token that you provide to identify the request to update a Amazon Q Business application chat configuration.
  - `responseScope` 'ENTERPRISE_CONTENT_ONLY' | 'EXTENDED_KNOWLEDGE_ENABLED' — 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.
  - `orchestrationConfiguration` object — <p>Configuration information required to enable chat orchestration for your Amazon Q Business 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>
    - `control` 'ENABLED' | 'DISABLED' — Status information about whether chat orchestration is activated or deactivated for your Amazon Q Business application.
  - `blockedPhrasesConfigurationUpdate` object — Updates a blocked phrases configuration in your Amazon Q Business application.
    - `blockedPhrasesToCreateOrUpdate` BlockedPhrase[] — Creates or updates a blocked phrases configuration in your Amazon Q Business application.
    - `blockedPhrasesToDelete` BlockedPhrase[] — Deletes a blocked phrases configuration in your Amazon Q Business application.
    - `systemMessageOverride` string — The configured custom message displayed to your end user when they use blocked phrase during chat.
  - `topicConfigurationsToCreateOrUpdate` TopicConfiguration[] — The configured topic specific chat controls you want to update.
    - `name` string, required — A name for your topic control configuration.
    - `description` string — A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration.
    - `exampleChatMessages` ExampleChatMessage[] — A list of example phrases that you expect the end user to use in relation to the topic.
    - `rules` Rule[], required — Rules defined for a topic configuration.
      - `includedUsersAndGroups` object — Users and groups to be included in a rule.
        - `userIds` String[] — The user ids associated with a topic control rule.
        - `userGroups` String[] — The user group names associated with a topic control rule.
      - `excludedUsersAndGroups` object — Users and groups to be excluded from a rule.
        - `userIds` String[] — The user ids associated with a topic control rule.
        - `userGroups` String[] — The user group names associated with a topic control rule.
      - `ruleType` 'CONTENT_BLOCKER_RULE' | 'CONTENT_RETRIEVAL_RULE', required — The type of rule.
      - `ruleConfiguration` object — The configuration information for a rule.
        - `contentBlockerRule` object — A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.
          - `systemMessageOverride` string — The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.
        - `contentRetrievalRule` ContentRetrievalRule — Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.
          - `eligibleDataSources` EligibleDataSource[] — Specifies data sources in a Amazon Q Business application to use for content generation.
            - `indexId` string — The identifier of the index the data source is attached to.
            - `dataSourceId` string — The identifier of the data source.
  - `topicConfigurationsToDelete` TopicConfiguration[] — The configured topic specific chat controls you want to delete.
    - `name` string, required — A name for your topic control configuration.
    - `description` string — A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration.
    - `exampleChatMessages` ExampleChatMessage[] — A list of example phrases that you expect the end user to use in relation to the topic.
    - `rules` Rule[], required — Rules defined for a topic configuration.
      - `includedUsersAndGroups` object — Users and groups to be included in a rule.
        - `userIds` String[] — The user ids associated with a topic control rule.
        - `userGroups` String[] — The user group names associated with a topic control rule.
      - `excludedUsersAndGroups` object — Users and groups to be excluded from a rule.
        - `userIds` String[] — The user ids associated with a topic control rule.
        - `userGroups` String[] — The user group names associated with a topic control rule.
      - `ruleType` 'CONTENT_BLOCKER_RULE' | 'CONTENT_RETRIEVAL_RULE', required — The type of rule.
      - `ruleConfiguration` object — The configuration information for a rule.
        - `contentBlockerRule` object — A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.
          - `systemMessageOverride` string — The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.
        - `contentRetrievalRule` ContentRetrievalRule — Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.
          - `eligibleDataSources` EligibleDataSource[] — Specifies data sources in a Amazon Q Business application to use for content generation.
            - `indexId` string — The identifier of the index the data source is attached to.
            - `dataSourceId` string — The identifier of the data source.
  - `creatorModeConfiguration` object — <p>Configuration information required to invoke chat in <code>CREATOR_MODE</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</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>
    - `creatorModeControl` 'ENABLED' | 'DISABLED' — Status information about whether <code>CREATOR_MODE</code> has been enabled or disabled. The default status is <code>DISABLED</code>.
  - `hallucinationReductionConfiguration` object — <p>Configuration information required to setup hallucination reduction. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/hallucination-reduction.html"> hallucination reduction</a>.</p> <note> <p>The hallucination reduction feature won't work if chat orchestration controls are enabled for your application.</p> </note>
    - `hallucinationReductionControl` 'ENABLED' | 'DISABLED' — Controls whether hallucination reduction has been enabled or disabled for your application. The default status is <code>DISABLED</code>.

## Response `200`

Success

- UpdateChatControlsConfigurationResponse

## Other responses

- `480` — InternalServerException
- `481` — ResourceNotFoundException
- `482` — ConflictException
- `483` — ThrottlingException
- `484` — ValidationException
- `485` — AccessDeniedException
- `486` — ServiceQuotaExceededException

---

[API](https://skmtc.net/aws/apis/qbusiness.md) · [All operations](https://skmtc.net/aws/apis/qbusiness/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/qbusiness/versions/82966d6c4053/schema)