Package com.sap.ai.sdk.orchestration.model

Class FilteringStreamOptions

java.lang.Object
com.sap.ai.sdk.orchestration.model.FilteringStreamOptions
public class FilteringStreamOptions extends Object
Stream options for output filtering. Will be ignored if stream is false.

  • Constructor Details

    • FilteringStreamOptions

      protected FilteringStreamOptions()
      Default constructor for FilteringStreamOptions.

  • Method Details

    • overlap

      @Nonnull public FilteringStreamOptions overlap(@Nullable Integer overlap)
      Set the overlap of this FilteringStreamOptions instance and return the same instance.
      Parameters:
      overlap - Number of characters that should be additionally sent to content filtering services from previous chunks as additional context. Minimum: 0 Maximum: 10000
      Returns:
      The same instance of this FilteringStreamOptions class

    • getOverlap

      @Nonnull public Integer getOverlap()
      Number of characters that should be additionally sent to content filtering services from previous chunks as additional context. minimum: 0 maximum: 10000
      Returns:
      overlap The overlap of this FilteringStreamOptions instance.

    • setOverlap

      public void setOverlap(@Nullable Integer overlap)
      Set the overlap of this FilteringStreamOptions instance.
      Parameters:
      overlap - Number of characters that should be additionally sent to content filtering services from previous chunks as additional context. Minimum: 0 Maximum: 10000

    • getCustomFieldNames

      @Nonnull public Set<String> getCustomFieldNames()
      Get the names of the unrecognizable properties of the FilteringStreamOptions.
      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 FilteringStreamOptions 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 FilteringStreamOptions 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 FilteringStreamOptions 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 FilteringStreamOptions create()
      Create a new FilteringStreamOptions instance. No arguments are required.