QBusiness / Client / get_chat_response_configuration

get_chat_response_configuration

QBusiness.Client.get_chat_response_configuration(**kwargs)

Retrieves detailed information about a specific chat response configuration from an Amazon Q Business application. This operation returns the complete configuration settings and metadata.

See also: AWS API Documentation

Request Syntax

response = client.get_chat_response_configuration(
    applicationId='string',
    chatResponseConfigurationId='string'
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

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

  • chatResponseConfigurationId (string) –

    [REQUIRED]

    The unique identifier of the chat response configuration to retrieve from the specified application.

Return type:

dict

Returns:

Response Syntax

{
    'chatResponseConfigurationId': 'string',
    'chatResponseConfigurationArn': 'string',
    'displayName': 'string',
    'createdAt': datetime(2015, 1, 1),
    'inUseConfiguration': {
        'responseConfigurations': {
            'string': {
                'instructionCollection': {
                    'responseLength': 'string',
                    'targetAudience': 'string',
                    'perspective': 'string',
                    'outputStyle': 'string',
                    'identity': 'string',
                    'tone': 'string',
                    'customInstructions': 'string',
                    'examples': 'string'
                }
            }
        },
        'responseConfigurationSummary': 'string',
        'status': 'CREATING'|'UPDATING'|'FAILED'|'ACTIVE',
        'error': {
            'errorMessage': 'string',
            'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound'
        },
        'updatedAt': datetime(2015, 1, 1)
    },
    'lastUpdateConfiguration': {
        'responseConfigurations': {
            'string': {
                'instructionCollection': {
                    'responseLength': 'string',
                    'targetAudience': 'string',
                    'perspective': 'string',
                    'outputStyle': 'string',
                    'identity': 'string',
                    'tone': 'string',
                    'customInstructions': 'string',
                    'examples': 'string'
                }
            }
        },
        'responseConfigurationSummary': 'string',
        'status': 'CREATING'|'UPDATING'|'FAILED'|'ACTIVE',
        'error': {
            'errorMessage': 'string',
            'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound'
        },
        'updatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • chatResponseConfigurationId (string) –

      The unique identifier of the retrieved chat response configuration.

    • chatResponseConfigurationArn (string) –

      The Amazon Resource Name (ARN) of the retrieved chat response configuration, which uniquely identifies the resource across all Amazon Web Services services.

    • displayName (string) –

      The human-readable name of the retrieved chat response configuration, making it easier to identify among multiple configurations.

    • createdAt (datetime) –

      The timestamp indicating when the chat response configuration was initially created.

    • inUseConfiguration (dict) –

      The currently active configuration settings that are being used to generate responses in the Amazon Q Business application.

      • responseConfigurations (dict) –

        A collection of specific response configuration settings that collectively define how responses are generated, formatted, and presented to users 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.

      • responseConfigurationSummary (string) –

        A summary of the response configuration details, providing a concise overview of the key parameters and settings that define the response generation behavior.

      • status (string) –

        The current status of the chat response configuration, indicating whether it is active, pending, or in another state that affects its availability for use.

      • error (dict) –

        Provides information about a Amazon Q Business request error.

        • errorMessage (string) –

          The message explaining the Amazon Q Business request error.

        • errorCode (string) –

          The code associated with the Amazon Q Business request error.

      • updatedAt (datetime) –

        The timestamp indicating when the detailed chat response configuration was last modified, helping administrators track changes and maintain version awareness.

    • lastUpdateConfiguration (dict) –

      Information about the most recent update to the configuration, including timestamp and modification details.

      • responseConfigurations (dict) –

        A collection of specific response configuration settings that collectively define how responses are generated, formatted, and presented to users 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.

      • responseConfigurationSummary (string) –

        A summary of the response configuration details, providing a concise overview of the key parameters and settings that define the response generation behavior.

      • status (string) –

        The current status of the chat response configuration, indicating whether it is active, pending, or in another state that affects its availability for use.

      • error (dict) –

        Provides information about a Amazon Q Business request error.

        • errorMessage (string) –

          The message explaining the Amazon Q Business request error.

        • errorCode (string) –

          The code associated with the Amazon Q Business request error.

      • updatedAt (datetime) –

        The timestamp indicating when the detailed chat response configuration was last modified, helping administrators track changes and maintain version awareness.

Exceptions