get_chat_controls_configuration¶
Operation¶
async
¶
get_chat_controls_configuration(input: GetChatControlsConfigurationInput, plugins: list[Plugin] | None = None) -> GetChatControlsConfigurationOutput
Gets information about chat controls configured for an existing Amazon Q Business application.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetChatControlsConfigurationInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
GetChatControlsConfigurationOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for GetChatControlsConfigurationInput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of the application for which the chat controls are configured.
class-attribute
instance-attribute
¶
max_results: int | None = None
The maximum number of configured chat controls to return.
class-attribute
instance-attribute
¶
next_token: str | None = None
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.
Output¶
dataclass
¶
Dataclass for GetChatControlsConfigurationOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
blocked_phrases: BlockedPhrasesConfiguration | None = None
The phrases blocked from chat by your chat control configuration.
class-attribute
instance-attribute
¶
creator_mode_configuration: AppliedCreatorModeConfiguration | None = None
The configuration details for CREATOR_MODE.
class-attribute
instance-attribute
¶
hallucination_reduction_configuration: HallucinationReductionConfiguration | None = None
The hallucination reduction settings for your application.
class-attribute
instance-attribute
¶
next_token: str | None = None
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.
class-attribute
instance-attribute
¶
orchestration_configuration: AppliedOrchestrationConfiguration | None = None
The chat response orchestration settings for your application.
Note
Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see Supported languages.
class-attribute
instance-attribute
¶
response_scope: ResponseScope | None = None
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.
class-attribute
instance-attribute
¶
topic_configurations: list[TopicConfiguration] | None = None
The topic specific controls configured for a Amazon Q Business application.