Class FlatQueryParams

java.lang.Object
org.zvec.binding.FlatQueryParams
All Implemented Interfaces:
AutoCloseable

public class FlatQueryParams extends Object implements AutoCloseable
High-level wrapper for zvec_flat_query_params_t (brute-force search parameters).

Ownership: passing an instance to VectorQuery.setFlatParams(FlatQueryParams), GroupByVectorQuery.setFlatParams(FlatQueryParams) or SubQuery.setFlatParams(FlatQueryParams) transfers ownership to the query (mirroring the C API), and the wrapper becomes inert; close() afterwards is a no-op.

  • Constructor Details

    • FlatQueryParams

      public FlatQueryParams()
      Create flat query parameters with the C API defaults.
    • FlatQueryParams

      public FlatQueryParams(boolean isUsingRefiner, float scaleFactor)
      Create flat query parameters.
      Parameters:
      isUsingRefiner - whether to use the refiner
      scaleFactor - candidate expansion factor used by the refiner
  • Method Details

    • setScaleFactor

      public void setScaleFactor(float scaleFactor)
      Set the candidate expansion factor used by the refiner.
    • getScaleFactor

      public float getScaleFactor()
      Get the candidate expansion factor used by the refiner.
    • setRadius

      public void setRadius(float radius)
    • getRadius

      public float getRadius()
    • setIsLinear

      public void setIsLinear(boolean isLinear)
    • getIsLinear

      public boolean getIsLinear()
    • setIsUsingRefiner

      public void setIsUsingRefiner(boolean isUsingRefiner)
    • getIsUsingRefiner

      public boolean getIsUsingRefiner()
    • destroy

      public void destroy()
    • close

      public void close()
      Specified by:
      close in interface AutoCloseable