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

Enum Class Filter.ScopeEnum

java.lang.Object
java.lang.Enum<Filter.ScopeEnum>
com.sap.ai.sdk.grounding.model.Filter.ScopeEnum
All Implemented Interfaces:
Serializable, Comparable<Filter.ScopeEnum>, Constable
Enclosing class:
Filter
public static enum Filter.ScopeEnum extends Enum<Filter.ScopeEnum>
Scope of the metadata filter (e.g., collection, document, chunk)

  • Enum Constant Details

    • COLLECTION

      public static final Filter.ScopeEnum COLLECTION
      The COLLECTION option of this Filter

    • DOCUMENT

      public static final Filter.ScopeEnum DOCUMENT
      The DOCUMENT option of this Filter

    • CHUNK

      public static final Filter.ScopeEnum CHUNK
      The CHUNK option of this Filter

    • UNKNOWN_DEFAULT_OPEN_API

      public static final Filter.ScopeEnum UNKNOWN_DEFAULT_OPEN_API
      The UNKNOWN_DEFAULT_OPEN_API option of this Filter

  • Method Details

    • values

      public static Filter.ScopeEnum[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Filter.ScopeEnum valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getValue

      @Nonnull public String getValue()
      Get the value of the enum
      Returns:
      The enum value

    • toString

      @Nonnull public String toString()
      Get the String value of the enum value.
      Overrides:
      toString in class Enum<Filter.ScopeEnum>
      Returns:
      The enum value as String

    • fromValue

      @Nonnull public static Filter.ScopeEnum fromValue(@Nonnull String value)
      Get the enum value from a String value
      Parameters:
      value - The String value
      Returns:
      The enum value of type Filter