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

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.

The following example would return data sources with an animal attribute starts with ca (for example, cat or camel).

"startsWith": { "key": "animal", "value": "ca" }

Constructors

StartsWith

constructor(value: FilterAttribute)

Properties

value

val value: FilterAttribute

Functions

toString

open override fun toString(): String

Inherited 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.