Package software.amazon.awssdk.services.bedrock.model

Class ImplicitFilterConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrock.model.ImplicitFilterConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ImplicitFilterConfiguration.Builder,ImplicitFilterConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class ImplicitFilterConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ImplicitFilterConfiguration.Builder,ImplicitFilterConfiguration>

Configuration for implicit filtering in Knowledge Base vector searches. Implicit filtering allows you to automatically filter search results based on metadata attributes without requiring explicit filter expressions in each query.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ImplicitFilterConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static ImplicitFilterConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMetadataAttributes()	For responses, this returns true if the service returned a value for the MetadataAttributes property.
List<MetadataAttributeSchema>	metadataAttributes()	A list of metadata attribute schemas that define the structure and properties of metadata fields used for implicit filtering.
String	modelArn()	The Amazon Resource Name (ARN) of the foundation model used for implicit filtering.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ImplicitFilterConfiguration.Builder>	serializableBuilderClass()
ImplicitFilterConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasMetadataAttributes

public final boolean hasMetadataAttributes()

For responses, this returns true if the service returned a value for the MetadataAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

metadataAttributes

public final List<MetadataAttributeSchema> metadataAttributes()

A list of metadata attribute schemas that define the structure and properties of metadata fields used for implicit filtering. Each attribute defines a key, type, and optional description.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetadataAttributes() method.

Returns:

A list of metadata attribute schemas that define the structure and properties of metadata fields used for implicit filtering. Each attribute defines a key, type, and optional description.

modelArn

public final String modelArn()

The Amazon Resource Name (ARN) of the foundation model used for implicit filtering. This model processes the query to extract relevant filtering criteria.

Returns:

The Amazon Resource Name (ARN) of the foundation model used for implicit filtering. This model processes the query to extract relevant filtering criteria.

toBuilder

public ImplicitFilterConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ImplicitFilterConfiguration.Builder,ImplicitFilterConfiguration>

builder

public static ImplicitFilterConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends ImplicitFilterConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo