Package com.sap.ai.sdk.grounding.model

Class MetadataItem

java.lang.Object
com.sap.ai.sdk.grounding.model.MetadataItem
public class MetadataItem extends Object
MetadataItem

  • Constructor Details

    • MetadataItem

      protected MetadataItem()
      Default constructor for MetadataItem.

  • Method Details

    • id

      @Nonnull public MetadataItem id(@Nonnull UUID id)
      Set the id of this MetadataItem instance and return the same instance.
      Parameters:
      id - ID of collection
      Returns:
      The same instance of this MetadataItem class

    • getId

      @Nonnull public UUID getId()
      ID of collection
      Returns:
      id The id of this MetadataItem instance.

    • setId

      public void setId(@Nonnull UUID id)
      Set the id of this MetadataItem instance.
      Parameters:
      id - ID of collection

    • metadata

      @Nonnull public MetadataItem metadata(@Nullable List<VectorKeyValueListPair> metadata)
      Set the metadata of this MetadataItem instance and return the same instance.
      Parameters:
      metadata - List of metadata of the collections or documents or chunks
      Returns:
      The same instance of this MetadataItem class

    • addMetadataItem

      @Nonnull public MetadataItem addMetadataItem(@Nonnull VectorKeyValueListPair metadataItem)
      Add one metadata instance to this MetadataItem.
      Parameters:
      metadataItem - The metadata that should be added
      Returns:
      The same instance of type MetadataItem

    • getMetadata

      @Nullable public List<VectorKeyValueListPair> getMetadata()
      List of metadata of the collections or documents or chunks
      Returns:
      metadata The metadata of this MetadataItem instance.

    • setMetadata

      public void setMetadata(@Nullable List<VectorKeyValueListPair> metadata)
      Set the metadata of this MetadataItem instance.
      Parameters:
      metadata - List of metadata of the collections or documents or chunks

    • getCustomFieldNames

      @Nonnull public Set<String> getCustomFieldNames()
      Get the names of the unrecognizable properties of the MetadataItem.
      Returns:
      The set of properties names

    • getCustomField

      @Nullable @Deprecated public Object getCustomField(@Nonnull String name) throws NoSuchElementException
      Deprecated.
      Use toMap() instead.
      Get the value of an unrecognizable property of this MetadataItem instance.
      Parameters:
      name - The name of the property
      Returns:
      The value of the property
      Throws:
      NoSuchElementException - If no property with the given name could be found.

    • toMap

      @Nonnull public Map<String,Object> toMap()
      Get the value of all properties of this MetadataItem instance including unrecognized properties.
      Returns:
      The map of all properties

    • setCustomField

      public void setCustomField(@Nonnull String customFieldName, @Nullable Object customFieldValue)
      Set an unrecognizable property of this MetadataItem instance. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      customFieldName - The name of the property
      customFieldValue - The value of the property

    • equals

      public boolean equals(@Nullable Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      @Nonnull public String toString()
      Overrides:
      toString in class Object

    • create

      public static MetadataItem.Builder create()
      Create a type-safe, fluent-api builder object to construct a new MetadataItem instance with all required arguments.