Class DPICustomEntity

java.lang.Object
com.sap.ai.sdk.prompt.registry.model.DPICustomEntity
All Implemented Interfaces:
DPIEntityConfig

public class DPICustomEntity extends Object implements DPIEntityConfig
DPICustomEntity
  • Constructor Details

    • DPICustomEntity

      protected DPICustomEntity()
      Default constructor for DPICustomEntity.
  • Method Details

    • regex

      @Nonnull public DPICustomEntity regex(@Nonnull String regex)
      Set the regex of this DPICustomEntity instance and return the same instance.
      Parameters:
      regex - Regular expression to match the entity
      Returns:
      The same instance of this DPICustomEntity class
    • getRegex

      @Nonnull public String getRegex()
      Regular expression to match the entity
      Returns:
      regex The regex of this DPICustomEntity instance.
    • setRegex

      public void setRegex(@Nonnull String regex)
      Set the regex of this DPICustomEntity instance.
      Parameters:
      regex - Regular expression to match the entity
    • replacementStrategy

      @Nonnull public DPICustomEntity replacementStrategy(@Nonnull DPIMethodConstant replacementStrategy)
      Set the replacementStrategy of this DPICustomEntity instance and return the same instance.
      Parameters:
      replacementStrategy - The replacementStrategy of this DPICustomEntity
      Returns:
      The same instance of this DPICustomEntity class
    • getReplacementStrategy

      @Nonnull public DPIMethodConstant getReplacementStrategy()
      Get replacementStrategy
      Returns:
      replacementStrategy The replacementStrategy of this DPICustomEntity instance.
    • setReplacementStrategy

      public void setReplacementStrategy(@Nonnull DPIMethodConstant replacementStrategy)
      Set the replacementStrategy of this DPICustomEntity instance.
      Parameters:
      replacementStrategy - The replacementStrategy of this DPICustomEntity
    • getCustomFieldNames

      @Nonnull public Set<String> getCustomFieldNames()
      Get the names of the unrecognizable properties of the DPICustomEntity.
      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 DPICustomEntity 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 DPICustomEntity 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 DPICustomEntity 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 DPICustomEntity.Builder create()
      Create a type-safe, fluent-api builder object to construct a new DPICustomEntity instance with all required arguments.