Skip to content

get_chat_controls_configuration

Operation

get_chat_controls_configuration

get_chat_controls_configuration(request: GetChatControlsConfigurationInput | GetChatControlsConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetChatControlsConfigurationInputDict]) -> GetChatControlsConfigurationOutput

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

Parameters:

Name Type Description Default
request GetChatControlsConfigurationInput | GetChatControlsConfigurationInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetChatControlsConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetChatControlsConfigurationOutput

An instance of GetChatControlsConfigurationOutput.

get_chat_controls_configuration async

get_chat_controls_configuration(request: GetChatControlsConfigurationInput | GetChatControlsConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetChatControlsConfigurationInputDict]) -> GetChatControlsConfigurationOutput

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

Parameters:

Name Type Description Default
request GetChatControlsConfigurationInput | GetChatControlsConfigurationInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetChatControlsConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetChatControlsConfigurationOutput

An instance of GetChatControlsConfigurationOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetChatControlsConfigurationInputDict

Bases: TypedDict

Dictionary form of GetChatControlsConfigurationInput.

Attributes

application_id instance-attribute
application_id: Required[str]

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

max_results instance-attribute
max_results: int | None

The maximum number of configured chat controls to return.

next_token instance-attribute
next_token: str | 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.

GetChatControlsConfigurationInput dataclass

Bases: _SerdeShape

Dataclass for GetChatControlsConfigurationInput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | None = ...

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

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of configured chat controls to return.

next_token class-attribute instance-attribute
next_token: str | 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

GetChatControlsConfigurationOutput dataclass

Bases: _SerdeShape

Dataclass for GetChatControlsConfigurationOutput structure.

Attributes

blocked_phrases class-attribute instance-attribute
blocked_phrases: BlockedPhrasesConfiguration | None = ...

The phrases blocked from chat by your chat control configuration.

creator_mode_configuration class-attribute instance-attribute
creator_mode_configuration: AppliedCreatorModeConfiguration | None = ...

The configuration details for CREATOR_MODE.

hallucination_reduction_configuration class-attribute instance-attribute
hallucination_reduction_configuration: HallucinationReductionConfiguration | None = ...

The hallucination reduction settings for your application.

next_token class-attribute instance-attribute
next_token: str | 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.

orchestration_configuration class-attribute instance-attribute
orchestration_configuration: AppliedOrchestrationConfiguration | 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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

response_scope class-attribute instance-attribute
response_scope: str | 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.

topic_configurations class-attribute instance-attribute
topic_configurations: list[TopicConfiguration] | None = ...

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