Package org.redisson.api.vector

Interface VectorSimilarArgs

All Known Implementing Classes:
VectorSimilarParams
public interface VectorSimilarArgs
Arguments object for RVectorSet.getSimilar() method
Author:
Nikita Koksharov

  • Method Details

    • element

      static VectorSimilarArgs element(String element)
      Defines element name.
      Parameters:
      element - element name
      Returns:
      arguments object

    • vector

      static VectorSimilarArgs vector(byte[] vector)
      Defines vector as byte array (32-bit floating point blob of values).
      Parameters:
      vector - as byte array
      Returns:
      arguments object

    • vector

      static VectorSimilarArgs vector(Double... vector)
      Defines vector as array of floating point numbers.
      Parameters:
      vector - vector as array of doubles
      Returns:
      arguments object

    • count

      VectorSimilarArgs count(int count)
      Defines the count parameter.
      Parameters:
      count - count value
      Returns:
      arguments object

    • epsilon

      VectorSimilarArgs epsilon(double value)
      Defines the distance that is no further than the specified delta.
      Parameters:
      value - a floating point number between 0 and 1.
      Returns:
      arguments object

    • explorationFactor

      VectorSimilarArgs explorationFactor(int value)
      Defines the exploration factor (EF).
      Parameters:
      value - exploration factor value
      Returns:
      arguments object

    • filter

      VectorSimilarArgs filter(String expression)
      Defines the filter expression to restrict matching elements.
      Parameters:
      expression - expression value
      Returns:
      arguments object

    • filterEffort

      VectorSimilarArgs filterEffort(int filterEffort)
      Defines the limit of filtering attempts for the filter expression.
      Parameters:
      filterEffort - - filter effort value
      Returns:
      arguments object

    • useLinearScan

      VectorSimilarArgs useLinearScan()
      Defines whether a linear scan is used to obtain exact results.
      Returns:
      arguments object

    • useMainThread

      VectorSimilarArgs useMainThread()
      Defines whether the search is executed in the main thread or a background thread.
      Returns:
      arguments object