QBusiness / Client / create_chat_response_configuration

create_chat_response_configuration¶

QBusiness.Client.create_chat_response_configuration(**kwargs)¶

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.

Request Syntax

response = client.create_chat_response_configuration(
    applicationId='string',
    displayName='string',
    clientToken='string',
    responseConfigurations={
        'string': {
            'instructionCollection': {
                'responseLength': 'string',
                'targetAudience': 'string',
                'perspective': 'string',
                'outputStyle': 'string',
                'identity': 'string',
                'tone': 'string',
                'customInstructions': 'string',
                'examples': 'string'
            }
        }
    },
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

Parameters:

applicationId (string) –
[REQUIRED]

The unique identifier of the Amazon Q Business application for which to create the new chat response configuration.
displayName (string) –
[REQUIRED]

A human-readable name for the new chat response configuration, making it easier to identify and manage among multiple configurations.
clientToken (string) –
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.
responseConfigurations (dict) –
[REQUIRED]

A collection of response configuration settings that define how Amazon Q Business will generate and format responses to user queries in chat interactions.
- (string) –
  - (dict) –
    
    Configuration settings to define how Amazon Q Business generates and formats responses to user queries. This includes customization options for response style, tone, length, and other characteristics.
    - instructionCollection (dict) –
      
      A collection of instructions that guide how Amazon Q Business generates responses, including parameters for response length, target audience, perspective, output style, identity, tone, and custom instructions.
      - responseLength (string) –
        
        Specifies the desired length of responses generated by Amazon Q Business. This parameter allows administrators to control whether responses are concise and brief or more detailed and comprehensive.
      - targetAudience (string) –
        
        Defines the intended audience for the responses, allowing Amazon Q Business to tailor its language, terminology, and explanations appropriately. This could range from technical experts to general users with varying levels of domain knowledge.
      - perspective (string) –
        
        Determines the point of view or perspective from which Amazon Q Business generates responses, such as first-person, second-person, or third-person perspective, affecting how information is presented to users.
      - outputStyle (string) –
        
        Specifies the formatting and structural style of responses, such as bullet points, paragraphs, step-by-step instructions, or other organizational formats that enhance readability and comprehension.
      - identity (string) –
        
        Defines the persona or identity that Amazon Q Business should adopt when responding to users, allowing for customization of the assistant’s character, role, or representation within an organization.
      - tone (string) –
        
        Controls the emotional tone and communication style of responses, such as formal, casual, technical, friendly, or professional, to align with organizational communication standards and user expectations.
      - customInstructions (string) –
        
        Allows administrators to provide specific, custom instructions that guide how Amazon Q Business should respond in particular scenarios or to certain types of queries, enabling fine-grained control over response generation.
      - examples (string) –
        
        Provides sample responses or templates that Amazon Q Business can reference when generating responses, helping to establish consistent patterns and formats for different types of user queries.
tags (list) –
A list of key-value pairs to apply as tags to the new chat response configuration, enabling categorization and management of resources across Amazon Web Services services.
- (dict) –
  
  A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
  - key (string) – [REQUIRED]
    
    The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.
  - value (string) – [REQUIRED]
    
    The value associated with the tag. The value may be an empty string but it can’t be null.

Return type:

dict

Returns:

Response Syntax

{
    'chatResponseConfigurationId': 'string',
    'chatResponseConfigurationArn': 'string'
}

Response Structure

(dict) –
- chatResponseConfigurationId (string) –
  
  The unique identifier assigned to a newly created chat response configuration, used for subsequent operations on this resource.
- chatResponseConfigurationArn (string) –
  
  The Amazon Resource Name (ARN) of the newly created chat response configuration, which uniquely identifies the resource across all Amazon Web Services services.

Exceptions

QBusiness.Client.exceptions.InternalServerException
QBusiness.Client.exceptions.ResourceNotFoundException
QBusiness.Client.exceptions.ConflictException
QBusiness.Client.exceptions.ThrottlingException
QBusiness.Client.exceptions.ValidationException
QBusiness.Client.exceptions.AccessDeniedException
QBusiness.Client.exceptions.ServiceQuotaExceededException