QBusiness / Client / update_retriever

update_retriever

QBusiness.Client.update_retriever(**kwargs)

Updates the retriever used for your Amazon Q Business application.

See also: AWS API Documentation

Request Syntax

response = client.update_retriever(
    applicationId='string',
    retrieverId='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'
        }
    },
    displayName='string',
    roleArn='string'
)

Parameters:

• applicationId (string) –

  [REQUIRED]

  The identifier of your Amazon Q Business application.

• retrieverId (string) –

  [REQUIRED]

  The identifier of your 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 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.

• displayName (string) – The name of your retriever.

• roleArn (string) – The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

Exceptions

• QBusiness.Client.exceptions.ResourceNotFoundException

• QBusiness.Client.exceptions.InternalServerException

• QBusiness.Client.exceptions.ConflictException

• QBusiness.Client.exceptions.ThrottlingException

• QBusiness.Client.exceptions.ValidationException

• QBusiness.Client.exceptions.AccessDeniedException

• QBusiness.Client.exceptions.ServiceQuotaExceededException