QBusiness / Client / update_chat_response_configuration

update_chat_response_configuration

QBusiness.Client.update_chat_response_configuration(**kwargs)

Updates an existing chat response configuration in an Amazon Q Business application. This operation allows administrators to modify configuration settings, display name, and response parameters to refine how the system generates responses.

See also: AWS API Documentation

Request Syntax

response = client.update_chat_response_configuration(
    applicationId='string',
    chatResponseConfigurationId='string',
    displayName='string',
    responseConfigurations={
        'string': {
            'instructionCollection': {
                'responseLength': 'string',
                'targetAudience': 'string',
                'perspective': 'string',
                'outputStyle': 'string',
                'identity': 'string',
                'tone': 'string',
                'customInstructions': 'string',
                'examples': 'string'
            }
        }
    },
    clientToken='string'
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

    The unique identifier of the Amazon Q Business application containing the chat response configuration to update.

  • chatResponseConfigurationId (string) –

    [REQUIRED]

    The unique identifier of the chat response configuration to update within the specified application.

  • displayName (string) – The new human-readable name to assign to the chat response configuration, making it easier to identify among multiple configurations.

  • responseConfigurations (dict) –

    [REQUIRED]

    The updated collection of response configuration settings that define how Amazon Q Business generates and formats responses to user queries.

    • (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.

  • clientToken (string) –

    A unique, case-sensitive identifier to ensure idempotency of the request. This helps prevent the same update from being processed multiple times if retries occur.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions