update_chat_controls_configuration¶
Operation¶
update_chat_controls_configuration
¶
update_chat_controls_configuration(request: UpdateChatControlsConfigurationInput | UpdateChatControlsConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateChatControlsConfigurationInputDict]) -> UpdateChatControlsConfigurationOutput
Updates a set of chat controls configured for an existing Amazon Q Business application.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateChatControlsConfigurationInput | UpdateChatControlsConfigurationInputDict | 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[UpdateChatControlsConfigurationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateChatControlsConfigurationOutput
|
An instance of |
update_chat_controls_configuration
async
¶
update_chat_controls_configuration(request: UpdateChatControlsConfigurationInput | UpdateChatControlsConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateChatControlsConfigurationInputDict]) -> UpdateChatControlsConfigurationOutput
Updates a set of chat controls configured for an existing Amazon Q Business application.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateChatControlsConfigurationInput | UpdateChatControlsConfigurationInputDict | 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[UpdateChatControlsConfigurationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateChatControlsConfigurationOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
UpdateChatControlsConfigurationInputDict
¶
Bases: TypedDict
Dictionary form of UpdateChatControlsConfigurationInput.
Attributes¶
application_id
instance-attribute
¶
The identifier of the application for which the chat controls are configured.
blocked_phrases_configuration_update
instance-attribute
¶
blocked_phrases_configuration_update: BlockedPhrasesConfigurationUpdate | BlockedPhrasesConfigurationUpdateDict | None
The phrases blocked from chat by your chat control configuration.
client_token
instance-attribute
¶
client_token: str | None
A token that you provide to identify the request to update a Amazon Q Business application chat configuration.
This field is autopopulated if not provided.
creator_mode_configuration
instance-attribute
¶
creator_mode_configuration: CreatorModeConfiguration | CreatorModeConfigurationDict | None
The configuration details for CREATOR_MODE.
hallucination_reduction_configuration
instance-attribute
¶
hallucination_reduction_configuration: HallucinationReductionConfiguration | HallucinationReductionConfigurationDict | None
The hallucination reduction settings for your application.
orchestration_configuration
instance-attribute
¶
orchestration_configuration: OrchestrationConfiguration | OrchestrationConfigurationDict | None
The chat response orchestration settings for your application.
response_scope
instance-attribute
¶
response_scope: str | None
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.
topic_configurations_to_create_or_update
instance-attribute
¶
topic_configurations_to_create_or_update: Sequence[TopicConfiguration | TopicConfigurationDict] | None
The configured topic specific chat controls you want to update.
topic_configurations_to_delete
instance-attribute
¶
topic_configurations_to_delete: Sequence[TopicConfiguration | TopicConfigurationDict] | None
The configured topic specific chat controls you want to delete.
UpdateChatControlsConfigurationInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateChatControlsConfigurationInput structure.
Attributes¶
application_id
class-attribute
instance-attribute
¶
application_id: str | None = ...
The identifier of the application for which the chat controls are configured.
blocked_phrases_configuration_update
class-attribute
instance-attribute
¶
blocked_phrases_configuration_update: BlockedPhrasesConfigurationUpdate | None = ...
The phrases blocked from chat by your chat control configuration.
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
A token that you provide to identify the request to update a Amazon Q Business application chat configuration.
This field is autopopulated if not provided.
creator_mode_configuration
class-attribute
instance-attribute
¶
creator_mode_configuration: CreatorModeConfiguration | 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.
orchestration_configuration
class-attribute
instance-attribute
¶
orchestration_configuration: OrchestrationConfiguration | None = ...
The chat response orchestration settings for your application.
response_scope
class-attribute
instance-attribute
¶
response_scope: str | None = ...
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.
topic_configurations_to_create_or_update
class-attribute
instance-attribute
¶
topic_configurations_to_create_or_update: list[TopicConfiguration] | None = ...
The configured topic specific chat controls you want to update.
topic_configurations_to_delete
class-attribute
instance-attribute
¶
topic_configurations_to_delete: list[TopicConfiguration] | None = ...
The configured topic specific chat controls you want to delete.
Output¶
UpdateChatControlsConfigurationOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateChatControlsConfigurationOutput structure.