Package org.redisson.api.search.index

Interface HNSWVectorOptionalArgs

All Superinterfaces:
FieldIndex
All Known Implementing Classes:
HNSWVectorIndexParams
public interface HNSWVectorOptionalArgs extends FieldIndex
Optional options object for vector field index which uses HNSW indexing method.
Author:
Nikita Koksharov

  • Method Details

    • initialCapacity

      HNSWVectorOptionalArgs initialCapacity(int value)
      Defines initial vector capacity.
      Parameters:
      value - initial vector capacity
      Returns:
      vector options

    • m

      HNSWVectorOptionalArgs m(int value)
      Defines number of maximum allowed outgoing edges for each node.
      Parameters:
      value - number of maximum allowed outgoing edges
      Returns:
      vector options

    • efConstruction

      HNSWVectorOptionalArgs efConstruction(int value)
      Defines number of maximum allowed potential outgoing edges candidates for each node.
      Parameters:
      value - number of maximum allowed potential outgoing edges
      Returns:
      vector options

    • efRuntime

      HNSWVectorOptionalArgs efRuntime(int value)
      Defines number of maximum top candidates to hold during the KNN search.
      Parameters:
      value - number of maximum top candidates
      Returns:
      vector options

    • epsilon

      HNSWVectorOptionalArgs epsilon(double value)
      Defines relative factor that sets the boundaries in which a range query may search for candidates
      Parameters:
      value - relative factor
      Returns: