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:

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<MetadataAttributeSchema.Builder,MetadataAttributeSchema>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.