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

RetrievalFilter

Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see Query configurations. See the examples below to see how to use these filters.

This data type is used in the following API operations:

Retrieve request – in the filter field
RetrieveAndGenerate request – in the filter field

Inheritors

Types

AndAll

data class AndAll(val value: List<RetrievalFilter>) : RetrievalFilter

Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.

Equals

data class Equals(val value: FilterAttribute) : RetrievalFilter

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value matches the value in this object.

GreaterThan

data class GreaterThan(val value: FilterAttribute) : RetrievalFilter

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than the value in this object.

GreaterThanOrEquals

data class GreaterThanOrEquals(val value: FilterAttribute) : RetrievalFilter

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object.

data class In(val value: FilterAttribute) : RetrievalFilter

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object.

LessThan

data class LessThan(val value: FilterAttribute) : RetrievalFilter

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than the value in this object.

LessThanOrEquals

data class LessThanOrEquals(val value: FilterAttribute) : RetrievalFilter

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object.

ListContains

data class ListContains(val value: FilterAttribute) : RetrievalFilter

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is a list that contains the value as one of its members.

NotEquals

data class NotEquals(val value: FilterAttribute) : RetrievalFilter

Knowledge base data sources are returned when:

NotIn

data class NotIn(val value: FilterAttribute) : RetrievalFilter

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object.

OrAll

data class OrAll(val value: List<RetrievalFilter>) : RetrievalFilter

Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.

SdkUnknown

object SdkUnknown : RetrievalFilter

StartsWith

data class StartsWith(val value: FilterAttribute) : RetrievalFilter

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value starts with the value in this object. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.

StringContains

data class StringContains(val value: FilterAttribute) : RetrievalFilter

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is one of the following:

Functions

asAndAll

fun asAndAll(): List<RetrievalFilter>

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

asAndAllOrNull

fun asAndAllOrNull(): List<RetrievalFilter>?

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

asEquals

fun asEquals(): FilterAttribute

Casts this RetrievalFilter as a Equals and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FilterAttribute value. Throws an exception if the RetrievalFilter is not a Equals.

asEqualsOrNull

fun asEqualsOrNull(): FilterAttribute?

Casts this RetrievalFilter as a Equals and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FilterAttribute value. Returns null if the RetrievalFilter is not a Equals.

asGreaterThan

fun asGreaterThan(): FilterAttribute

Casts this RetrievalFilter as a GreaterThan and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FilterAttribute value. Throws an exception if the RetrievalFilter is not a GreaterThan.

asGreaterThanOrEquals

fun asGreaterThanOrEquals(): FilterAttribute

Casts this RetrievalFilter as a GreaterThanOrEquals and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FilterAttribute value. Throws an exception if the RetrievalFilter is not a GreaterThanOrEquals.

asGreaterThanOrEqualsOrNull

fun asGreaterThanOrEqualsOrNull(): FilterAttribute?

Casts this RetrievalFilter as a GreaterThanOrEquals and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FilterAttribute value. Returns null if the RetrievalFilter is not a GreaterThanOrEquals.

asGreaterThanOrNull

fun asGreaterThanOrNull(): FilterAttribute?

Casts this RetrievalFilter as a GreaterThan and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FilterAttribute value. Returns null if the RetrievalFilter is not a GreaterThan.

asIn

fun asIn(): FilterAttribute

Casts this RetrievalFilter as a In and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FilterAttribute value. Throws an exception if the RetrievalFilter is not a In.

asInOrNull

fun asInOrNull(): FilterAttribute?

Casts this RetrievalFilter as a In and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FilterAttribute value. Returns null if the RetrievalFilter is not a In.

asLessThan

fun asLessThan(): FilterAttribute

Casts this RetrievalFilter as a LessThan and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FilterAttribute value. Throws an exception if the RetrievalFilter is not a LessThan.

asLessThanOrEquals

fun asLessThanOrEquals(): FilterAttribute

Casts this RetrievalFilter as a LessThanOrEquals and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FilterAttribute value. Throws an exception if the RetrievalFilter is not a LessThanOrEquals.

asLessThanOrEqualsOrNull

fun asLessThanOrEqualsOrNull(): FilterAttribute?

Casts this RetrievalFilter as a LessThanOrEquals and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FilterAttribute value. Returns null if the RetrievalFilter is not a LessThanOrEquals.

asLessThanOrNull

fun asLessThanOrNull(): FilterAttribute?

Casts this RetrievalFilter as a LessThan and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FilterAttribute value. Returns null if the RetrievalFilter is not a LessThan.

asListContains

fun asListContains(): FilterAttribute

Casts this RetrievalFilter as a ListContains and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FilterAttribute value. Throws an exception if the RetrievalFilter is not a ListContains.

asListContainsOrNull

fun asListContainsOrNull(): FilterAttribute?

Casts this RetrievalFilter as a ListContains and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FilterAttribute value. Returns null if the RetrievalFilter is not a ListContains.

asNotEquals

fun asNotEquals(): FilterAttribute

Casts this RetrievalFilter as a NotEquals and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FilterAttribute value. Throws an exception if the RetrievalFilter is not a NotEquals.

asNotEqualsOrNull

fun asNotEqualsOrNull(): FilterAttribute?

Casts this RetrievalFilter as a NotEquals and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FilterAttribute value. Returns null if the RetrievalFilter is not a NotEquals.

asNotIn

fun asNotIn(): FilterAttribute

Casts this RetrievalFilter as a NotIn and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FilterAttribute value. Throws an exception if the RetrievalFilter is not a NotIn.

asNotInOrNull

fun asNotInOrNull(): FilterAttribute?

Casts this RetrievalFilter as a NotIn and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FilterAttribute value. Returns null if the RetrievalFilter is not a NotIn.

asOrAll

fun asOrAll(): List<RetrievalFilter>

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

asOrAllOrNull

fun asOrAllOrNull(): List<RetrievalFilter>?

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

asStartsWith

fun asStartsWith(): FilterAttribute

Casts this RetrievalFilter as a StartsWith and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FilterAttribute value. Throws an exception if the RetrievalFilter is not a StartsWith.

asStartsWithOrNull

fun asStartsWithOrNull(): FilterAttribute?

Casts this RetrievalFilter as a StartsWith and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FilterAttribute value. Returns null if the RetrievalFilter is not a StartsWith.

asStringContains

fun asStringContains(): FilterAttribute

Casts this RetrievalFilter as a StringContains and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FilterAttribute value. Throws an exception if the RetrievalFilter is not a StringContains.

asStringContainsOrNull

fun asStringContainsOrNull(): FilterAttribute?

Casts this RetrievalFilter as a StringContains and retrieves its aws.sdk.kotlin.services.bedrockagentruntime.model.FilterAttribute value. Returns null if the RetrievalFilter is not a StringContains.