bedrockagentruntime/aws.sdk.kotlin.services.bedrockagentruntime.model/RerankingMetadataSelectiveModeConfiguration

RerankingMetadataSelectiveModeConfiguration

sealed class RerankingMetadataSelectiveModeConfiguration

Contains configurations for the metadata fields to include or exclude when considering reranking. If you include the fieldsToExclude field, the reranker ignores all the metadata fields that you specify. If you include the fieldsToInclude field, the reranker uses only the metadata fields that you specify and ignores all others. You can include only one of these fields.

Inheritors

FieldsToExclude

FieldsToInclude

Types

FieldsToExclude

data class FieldsToExclude(val value: List<FieldForReranking>) : RerankingMetadataSelectiveModeConfiguration

An array of objects, each of which specifies a metadata field to exclude from consideration when reranking.

FieldsToInclude

data class FieldsToInclude(val value: List<FieldForReranking>) : RerankingMetadataSelectiveModeConfiguration

An array of objects, each of which specifies a metadata field to include in consideration when reranking. The remaining metadata fields are ignored.

object SdkUnknown : RerankingMetadataSelectiveModeConfiguration

Functions

asFieldsToExclude

fun asFieldsToExclude(): List<FieldForReranking>

Casts this RerankingMetadataSelectiveModeConfiguration as a FieldsToExclude and retrieves its kotlin.collections.List value. Throws an exception if the RerankingMetadataSelectiveModeConfiguration is not a FieldsToExclude.

asFieldsToExcludeOrNull

fun asFieldsToExcludeOrNull(): List<FieldForReranking>?

Casts this RerankingMetadataSelectiveModeConfiguration as a FieldsToExclude and retrieves its kotlin.collections.List value. Returns null if the RerankingMetadataSelectiveModeConfiguration is not a FieldsToExclude.

asFieldsToInclude

fun asFieldsToInclude(): List<FieldForReranking>

Casts this RerankingMetadataSelectiveModeConfiguration as a FieldsToInclude and retrieves its kotlin.collections.List value. Throws an exception if the RerankingMetadataSelectiveModeConfiguration is not a FieldsToInclude.

asFieldsToIncludeOrNull

fun asFieldsToIncludeOrNull(): List<FieldForReranking>?

Casts this RerankingMetadataSelectiveModeConfiguration as a FieldsToInclude and retrieves its kotlin.collections.List value. Returns null if the RerankingMetadataSelectiveModeConfiguration is not a FieldsToInclude.