Package org.redisson.api.vector

Class VectorSimilarParams

java.lang.Object
org.redisson.api.vector.VectorSimilarParams
All Implemented Interfaces:
VectorSimilarArgs
public final class VectorSimilarParams extends Object implements VectorSimilarArgs
Vector similarity arguments implementation
Author:
Nikita Koksharov

  • Method Details

    • count

      public VectorSimilarArgs count(int count)
      Description copied from interface: VectorSimilarArgs
      Defines the count parameter.
      Specified by:
      count in interface VectorSimilarArgs
      Parameters:
      count - count value
      Returns:
      arguments object

    • epsilon

      public VectorSimilarArgs epsilon(double value)
      Description copied from interface: VectorSimilarArgs
      Defines the distance that is no further than the specified delta.
      Specified by:
      epsilon in interface VectorSimilarArgs
      Parameters:
      value - a floating point number between 0 and 1.
      Returns:
      arguments object

    • explorationFactor

      public VectorSimilarArgs explorationFactor(int effort)
      Description copied from interface: VectorSimilarArgs
      Defines the exploration factor (EF).
      Specified by:
      explorationFactor in interface VectorSimilarArgs
      Parameters:
      effort - exploration factor value
      Returns:
      arguments object

    • filter

      public VectorSimilarArgs filter(String filter)
      Description copied from interface: VectorSimilarArgs
      Defines the filter expression to restrict matching elements.
      Specified by:
      filter in interface VectorSimilarArgs
      Parameters:
      filter - expression value
      Returns:
      arguments object

    • filterEffort

      public VectorSimilarArgs filterEffort(int filterEffort)
      Description copied from interface: VectorSimilarArgs
      Defines the limit of filtering attempts for the filter expression.
      Specified by:
      filterEffort in interface VectorSimilarArgs
      Parameters:
      filterEffort - - filter effort value
      Returns:
      arguments object

    • useLinearScan

      public VectorSimilarArgs useLinearScan()
      Description copied from interface: VectorSimilarArgs
      Defines whether a linear scan is used to obtain exact results.
      Specified by:
      useLinearScan in interface VectorSimilarArgs
      Returns:
      arguments object

    • useMainThread

      public VectorSimilarArgs useMainThread()
      Description copied from interface: VectorSimilarArgs
      Defines whether the search is executed in the main thread or a background thread.
      Specified by:
      useMainThread in interface VectorSimilarArgs
      Returns:
      arguments object

    • getElement

      public String getElement()

    • getVectorBytes

      public byte[] getVectorBytes()

    • getVectorDoubles

      public Double[] getVectorDoubles()

    • getCount

      public Integer getCount()

    • getEpsilon

      public Double getEpsilon()

    • getEffort

      public Integer getEffort()

    • getFilter

      public String getFilter()

    • getFilterEffort

      public Integer getFilterEffort()

    • isUseLinearScan

      public boolean isUseLinearScan()

    • isUseMainThread

      public boolean isUseMainThread()