qbusiness/aws.sdk.kotlin.services.qbusiness.model/DocumentAttributeBoostingConfiguration

DocumentAttributeBoostingConfiguration

sealed class DocumentAttributeBoostingConfiguration

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.

In version 2, boosting uses numeric values (ONE, TWO) to indicate priority tiers that establish clear hierarchical relationships between boosted attributes. This allows for more precise control over how different attributes influence search results.

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.

Inheritors

DateConfiguration

NumberConfiguration

StringConfiguration

StringListConfiguration

Types

DateConfiguration

data class DateConfiguration(val value: DateAttributeBoostingConfiguration) : DocumentAttributeBoostingConfiguration

Provides information on boosting DATE type document attributes.

NumberConfiguration

data class NumberConfiguration(val value: NumberAttributeBoostingConfiguration) : DocumentAttributeBoostingConfiguration

Provides information on boosting NUMBER type document attributes.

object SdkUnknown : DocumentAttributeBoostingConfiguration

StringConfiguration

data class StringConfiguration(val value: StringAttributeBoostingConfiguration) : DocumentAttributeBoostingConfiguration

Provides information on boosting STRING type document attributes.

StringListConfiguration

data class StringListConfiguration(val value: StringListAttributeBoostingConfiguration) : DocumentAttributeBoostingConfiguration

Provides information on boosting STRING_LIST type document attributes.

Functions

asDateConfiguration

fun asDateConfiguration(): DateAttributeBoostingConfiguration

Casts this DocumentAttributeBoostingConfiguration as a DateConfiguration and retrieves its aws.sdk.kotlin.services.qbusiness.model.DateAttributeBoostingConfiguration value. Throws an exception if the DocumentAttributeBoostingConfiguration is not a DateConfiguration.

asDateConfigurationOrNull

fun asDateConfigurationOrNull(): DateAttributeBoostingConfiguration?

Casts this DocumentAttributeBoostingConfiguration as a DateConfiguration and retrieves its aws.sdk.kotlin.services.qbusiness.model.DateAttributeBoostingConfiguration value. Returns null if the DocumentAttributeBoostingConfiguration is not a DateConfiguration.

asNumberConfiguration

fun asNumberConfiguration(): NumberAttributeBoostingConfiguration

Casts this DocumentAttributeBoostingConfiguration as a NumberConfiguration and retrieves its aws.sdk.kotlin.services.qbusiness.model.NumberAttributeBoostingConfiguration value. Throws an exception if the DocumentAttributeBoostingConfiguration is not a NumberConfiguration.

asNumberConfigurationOrNull

fun asNumberConfigurationOrNull(): NumberAttributeBoostingConfiguration?

Casts this DocumentAttributeBoostingConfiguration as a NumberConfiguration and retrieves its aws.sdk.kotlin.services.qbusiness.model.NumberAttributeBoostingConfiguration value. Returns null if the DocumentAttributeBoostingConfiguration is not a NumberConfiguration.

asStringConfiguration

fun asStringConfiguration(): StringAttributeBoostingConfiguration

Casts this DocumentAttributeBoostingConfiguration as a StringConfiguration and retrieves its aws.sdk.kotlin.services.qbusiness.model.StringAttributeBoostingConfiguration value. Throws an exception if the DocumentAttributeBoostingConfiguration is not a StringConfiguration.

asStringConfigurationOrNull

fun asStringConfigurationOrNull(): StringAttributeBoostingConfiguration?

Casts this DocumentAttributeBoostingConfiguration as a StringConfiguration and retrieves its aws.sdk.kotlin.services.qbusiness.model.StringAttributeBoostingConfiguration value. Returns null if the DocumentAttributeBoostingConfiguration is not a StringConfiguration.

asStringListConfiguration

fun asStringListConfiguration(): StringListAttributeBoostingConfiguration

Casts this DocumentAttributeBoostingConfiguration as a StringListConfiguration and retrieves its aws.sdk.kotlin.services.qbusiness.model.StringListAttributeBoostingConfiguration value. Throws an exception if the DocumentAttributeBoostingConfiguration is not a StringListConfiguration.

asStringListConfigurationOrNull

fun asStringListConfigurationOrNull(): StringListAttributeBoostingConfiguration?

Casts this DocumentAttributeBoostingConfiguration as a StringListConfiguration and retrieves its aws.sdk.kotlin.services.qbusiness.model.StringListAttributeBoostingConfiguration value. Returns null if the DocumentAttributeBoostingConfiguration is not a StringListConfiguration.