QBusiness / Client / get_retriever

get_retriever

QBusiness.Client.get_retriever(**kwargs)

Gets information about an existing retriever used by an Amazon Q Business application.

See also: AWS API Documentation

Request Syntax

response = client.get_retriever(
    applicationId='string',
    retrieverId='string'
)

Parameters:

• applicationId (string) –

  [REQUIRED]

  The identifier of the Amazon Q Business application using the retriever.

• retrieverId (string) –

  [REQUIRED]

  The identifier of the retriever.

Return type:

dict

Returns:

Response Syntax

{
    'applicationId': 'string',
    'retrieverId': 'string',
    'retrieverArn': 'string',
    'type': 'NATIVE_INDEX'|'KENDRA_INDEX',
    'status': 'CREATING'|'ACTIVE'|'FAILED',
    'displayName': 'string',
    'configuration': {
        'nativeIndexConfiguration': {
            'indexId': 'string',
            'boostingOverride': {
                'string': {
                    'numberConfiguration': {
                        'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH',
                        'boostingType': 'PRIORITIZE_LARGER_VALUES'|'PRIORITIZE_SMALLER_VALUES'
                    },
                    'stringConfiguration': {
                        'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH',
                        'attributeValueBoosting': {
                            'string': 'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'
                        }
                    },
                    'dateConfiguration': {
                        'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH',
                        'boostingDurationInSeconds': 123
                    },
                    'stringListConfiguration': {
                        'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'
                    }
                }
            }
        },
        'kendraIndexConfiguration': {
            'indexId': 'string'
        }
    },
    'roleArn': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • applicationId (string) –

    The identifier of the Amazon Q Business application using the retriever.

  • retrieverId (string) –

    The identifier of the retriever.

  • retrieverArn (string) –

    The Amazon Resource Name (ARN) of the IAM role associated with the retriever.

  • type (string) –

    The type of the retriever.

  • status (string) –

    The status of the retriever.

  • displayName (string) –

    The name of the retriever.

  • configuration (dict) –

    Provides information on how the retriever used for your Amazon Q Business application is configured.

    Note

    This is a Tagged Union structure. Only one of the following top level keys will be set: nativeIndexConfiguration, kendraIndexConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    

    • nativeIndexConfiguration (dict) –

      Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.

      • indexId (string) –

        The identifier for the Amazon Q Business index.

      • boostingOverride (dict) –

        Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.

        • (string) –

          • (dict) –

            Provides information on boosting supported Amazon Q Business document attribute types. When an end user chat query matches document attributes that have been boosted, Amazon Q Business prioritizes generating responses from content that matches the boosted document attributes.

            Note

            For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven’t enabled searching on these attributes, you can’t boost attributes of these data types on either the console or the API.

            For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: numberConfiguration, stringConfiguration, dateConfiguration, stringListConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
            

            • numberConfiguration (dict) –

              Provides information on boosting NUMBER type document attributes.

              • boostingLevel (string) –

                Specifies the duration, in seconds, of a boost applies to a NUMBER type document attribute.

              • boostingType (string) –

                Specifies how much a document attribute is boosted.

            • stringConfiguration (dict) –

              Provides information on boosting STRING type document attributes.

              • boostingLevel (string) –

                Specifies how much a document attribute is boosted.

              • attributeValueBoosting (dict) –

                Specifies specific values of a STRING type document attribute being boosted.

                • (string) –

                  • (string) –

            • dateConfiguration (dict) –

              Provides information on boosting DATE type document attributes.

              • boostingLevel (string) –

                Specifies how much a document attribute is boosted.

              • boostingDurationInSeconds (integer) –

                Specifies the duration, in seconds, of a boost applies to a DATE type document attribute.

            • stringListConfiguration (dict) –

              Provides information on boosting STRING_LIST type document attributes.

              • boostingLevel (string) –

                Specifies how much a document attribute is boosted.

    • kendraIndexConfiguration (dict) –

      Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.

      • indexId (string) –

        The identifier of the Amazon Kendra index.

  • roleArn (string) –

    The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.

  • createdAt (datetime) –

    The Unix timestamp when the retriever was created.

  • updatedAt (datetime) –

    The Unix timestamp when the retriever was last updated.

Exceptions

• QBusiness.Client.exceptions.ResourceNotFoundException

• QBusiness.Client.exceptions.InternalServerException

• QBusiness.Client.exceptions.ThrottlingException

• QBusiness.Client.exceptions.ValidationException

• QBusiness.Client.exceptions.AccessDeniedException