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

Class MetadataAttributeSchema

java.lang.Object

software.amazon.awssdk.services.bedrock.model.MetadataAttributeSchema

All Implemented Interfaces:

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

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

Defines the schema for a metadata attribute used in Knowledge Base vector searches. Metadata attributes provide additional context for documents and can be used for filtering and reranking search results.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MetadataAttributeSchema.Builder

Method Summary

Modifier and Type	Method	Description
static MetadataAttributeSchema.Builder	builder()
String	description()	An optional description of the metadata attribute that provides additional context about its purpose and usage.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key()	The unique identifier for the metadata attribute.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends MetadataAttributeSchema.Builder>	serializableBuilderClass()
MetadataAttributeSchema.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
AttributeType	type()	The data type of the metadata attribute.
String	typeAsString()	The data type of the metadata attribute.

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

key

public final String key()

The unique identifier for the metadata attribute. This key is used to reference the attribute in filter expressions and reranking configurations.

Returns:

The unique identifier for the metadata attribute. This key is used to reference the attribute in filter expressions and reranking configurations.

type

public final AttributeType type()

The data type of the metadata attribute. The type determines how the attribute can be used in filter expressions and reranking.

If the service returns an enum value that is not available in the current SDK version, type will return AttributeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The data type of the metadata attribute. The type determines how the attribute can be used in filter expressions and reranking.

See Also:

AttributeType

typeAsString

public final String typeAsString()

The data type of the metadata attribute. The type determines how the attribute can be used in filter expressions and reranking.

If the service returns an enum value that is not available in the current SDK version, type will return AttributeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The data type of the metadata attribute. The type determines how the attribute can be used in filter expressions and reranking.

See Also:

AttributeType

description

public final String description()

An optional description of the metadata attribute that provides additional context about its purpose and usage.

Returns:

An optional description of the metadata attribute that provides additional context about its purpose and usage.

toBuilder

public MetadataAttributeSchema.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MetadataAttributeSchema.Builder,MetadataAttributeSchema>

builder

public static MetadataAttributeSchema.Builder builder()

serializableBuilderClass

public static Class<? extends MetadataAttributeSchema.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