QBusiness / Client / create_retriever

create_retriever#

QBusiness.Client.create_retriever(**kwargs)#

Adds a retriever to your Amazon Q Business application.

See also: AWS API Documentation

Request Syntax

response = client.create_retriever(
    applicationId='string',
    type='NATIVE_INDEX'|'KENDRA_INDEX',
    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',
    clientToken='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

    The identifier of your Amazon Q Business application.

  • type (string) –

    [REQUIRED]

    The type of retriever you are using.

  • displayName (string) –

    [REQUIRED]

    The name of your retriever.

  • configuration (dict) –

    [REQUIRED]

    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 can be set: nativeIndexConfiguration, kendraIndexConfiguration.

    • 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) – [REQUIRED]

        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 can be set: numberConfiguration, stringConfiguration, dateConfiguration, stringListConfiguration.

            • numberConfiguration (dict) –

              Provides information on boosting NUMBER type document attributes.

              • boostingLevel (string) – [REQUIRED]

                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) – [REQUIRED]

                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) – [REQUIRED]

                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) – [REQUIRED]

                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) – [REQUIRED]

        The identifier of the Amazon Kendra index.

  • roleArn (string) – The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

  • clientToken (string) –

    A token that you provide to identify the request to create your Amazon Q Business application retriever.

    This field is autopopulated if not provided.

  • tags (list) –

    A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

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

{
    'retrieverId': 'string',
    'retrieverArn': 'string'
}

Response Structure

  • (dict) –

    • retrieverId (string) –

      The identifier of the retriever you are using.

    • retrieverArn (string) –

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

Exceptions