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

# GET /applications/{applicationId}/chatcontrols

`GET /applications/{applicationId}/chatcontrols`

Gets information about chat controls configured for an existing Amazon Q Business application.

## Path parameters

- `applicationId` string, required

## Query parameters

- `maxResults` integer
- `nextToken` string

## Response `200`

Success

- GetChatControlsConfigurationResponse
  - `responseScope` 'ENTERPRISE_CONTENT_ONLY' | 'EXTENDED_KNOWLEDGE_ENABLED' — 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.
  - `orchestrationConfiguration` object — <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>
    - `control` 'ENABLED' | 'DISABLED', required — Information about whether chat orchestration is enabled or disabled for an Amazon Q Business application.
  - `blockedPhrases` object — The phrases blocked from chat by your chat control configuration.
    - `blockedPhrases` BlockedPhrase[] — <p>A list of phrases blocked from a Amazon Q Business web experience chat.</p> <note> <p>Each phrase can contain a maximum of 36 characters. The list can contain a maximum of 20 phrases.</p> </note>
    - `systemMessageOverride` string — The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.
  - `topicConfigurations` TopicConfiguration[] — The topic specific controls configured for a Amazon Q Business application.
    - `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 — The configuration details for <code>CREATOR_MODE</code>.
    - `creatorModeControl` 'ENABLED' | 'DISABLED', required — Information about whether creator mode is enabled or disabled for an Amazon Q Business application.
  - `nextToken` string — 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.
  - `hallucinationReductionConfiguration` object — The hallucination reduction settings for your application.
    - `hallucinationReductionControl` 'ENABLED' | 'DISABLED' — Controls whether hallucination reduction has been enabled or disabled for your application. The default status is <code>DISABLED</code>.

## Other responses

- `480` — InternalServerException
- `481` — ResourceNotFoundException
- `482` — ThrottlingException
- `483` — ValidationException
- `484` — AccessDeniedException

---

[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)