create_chat_response_configuration¶
Operation¶
async
¶
create_chat_response_configuration(input: CreateChatResponseConfigurationInput, plugins: list[Plugin] | None = None) -> CreateChatResponseConfigurationOutput
Creates a new chat response configuration for an Amazon Q Business application. This operation establishes a set of parameters that define how the system generates and formats responses to user queries in chat interactions.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateChatResponseConfigurationInput
|
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 |
|---|---|
CreateChatResponseConfigurationOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for CreateChatResponseConfigurationInput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The unique identifier of the Amazon Q Business application for which to create the new chat response configuration.
class-attribute
instance-attribute
¶
client_token: str | None = None
A unique, case-sensitive identifier to ensure idempotency of the request. This helps prevent the same configuration from being created multiple times if retries occur.
class-attribute
instance-attribute
¶
display_name: str | None = None
A human-readable name for the new chat response configuration, making it easier to identify and manage among multiple configurations.
class-attribute
instance-attribute
¶
response_configurations: dict[str, ResponseConfiguration] | None = None
A collection of response configuration settings that define how Amazon Q Business will generate and format responses to user queries in chat interactions.
Output¶
dataclass
¶
Dataclass for CreateChatResponseConfigurationOutput structure.
Attributes¶
instance-attribute
¶
chat_response_configuration_arn: str
The Amazon Resource Name (ARN) of the newly created chat response configuration, which uniquely identifies the resource across all Amazon Web Services services.
instance-attribute
¶
chat_response_configuration_id: str
The unique identifier assigned to a newly created chat response configuration, used for subsequent operations on this resource.