create_chat_response_configuration¶
Operation¶
create_chat_response_configuration
¶
create_chat_response_configuration(request: CreateChatResponseConfigurationInput | CreateChatResponseConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateChatResponseConfigurationInputDict]) -> 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 |
|---|---|---|---|
request
|
CreateChatResponseConfigurationInput | CreateChatResponseConfigurationInputDict | 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[CreateChatResponseConfigurationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateChatResponseConfigurationOutput
|
An instance of |
create_chat_response_configuration
async
¶
create_chat_response_configuration(request: CreateChatResponseConfigurationInput | CreateChatResponseConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateChatResponseConfigurationInputDict]) -> 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 |
|---|---|---|---|
request
|
CreateChatResponseConfigurationInput | CreateChatResponseConfigurationInputDict | 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[CreateChatResponseConfigurationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateChatResponseConfigurationOutput
|
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.
CreateChatResponseConfigurationInputDict
¶
Bases: TypedDict
Dictionary form of CreateChatResponseConfigurationInput.
Attributes¶
application_id
instance-attribute
¶
The unique identifier of the Amazon Q Business application for which to create the new chat response configuration.
client_token
instance-attribute
¶
client_token: str | 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.
This field is autopopulated if not provided.
display_name
instance-attribute
¶
A human-readable name for the new chat response configuration, making it easier to identify and manage among multiple configurations.
response_configurations
instance-attribute
¶
response_configurations: Required[Mapping[str, ResponseConfiguration | ResponseConfigurationDict]]
A collection of response configuration settings that define how Amazon Q Business will generate and format responses to user queries in chat interactions.
CreateChatResponseConfigurationInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateChatResponseConfigurationInput structure.
Attributes¶
application_id
class-attribute
instance-attribute
¶
application_id: str | None = ...
The unique identifier of the Amazon Q Business application for which to create the new chat response configuration.
client_token
class-attribute
instance-attribute
¶
client_token: str | 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.
This field is autopopulated if not provided.
display_name
class-attribute
instance-attribute
¶
display_name: str | None = ...
A human-readable name for the new chat response configuration, making it easier to identify and manage among multiple configurations.
response_configurations
class-attribute
instance-attribute
¶
response_configurations: dict[str, ResponseConfiguration] | 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¶
CreateChatResponseConfigurationOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateChatResponseConfigurationOutput structure.
Attributes¶
chat_response_configuration_arn
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.
chat_response_configuration_id
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.
response_metadata
class-attribute
instance-attribute
¶
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.