Package org.zvec.binding

Class SubQuery

java.lang.Object
org.zvec.binding.SubQuery
All Implemented Interfaces:
AutoCloseable
public class SubQuery extends Object implements AutoCloseable
High-level wrapper for zvec_sub_query_t.

A sub-query is a building block of MultiQuery. Each sub-query targets one field and can carry vector-search parameters or an FTS payload.

  • Constructor Details

    • SubQuery

      public SubQuery()

  • Method Details

    • setFieldName

      public void setFieldName(String fieldName)

    • getFieldName

      public String getFieldName()

    • setNumCandidates

      public void setNumCandidates(int numCandidates)

    • getNumCandidates

      public int getNumCandidates()

    • setQueryVector

      public void setQueryVector(float[] vector)
      Set the query vector (float32). The data is copied.

    • setSparseVector

      public void setSparseVector(int[] indices, float[] values)
      Set sparse vector entries in one call.

    • setSparseIndices

      public void setSparseIndices(int[] indices)

    • setSparseValues

      public void setSparseValues(float[] values)

    • setHNSWParams

      public void setHNSWParams(HnswQueryParams params)
      Set HNSW query parameters. Ownership transfers to this sub-query.

    • setIVFParams

      public void setIVFParams(IvfQueryParams params)
      Set IVF query parameters. Ownership transfers to this sub-query.

    • setFlatParams

      public void setFlatParams(FlatQueryParams params)
      Set flat (brute-force) query parameters. Ownership transfers to this sub-query.

    • setVamanaParams

      public void setVamanaParams(VamanaQueryParams params)
      Set Vamana query parameters. Ownership transfers to this sub-query.

    • setIvfRabitqParams

      public void setIvfRabitqParams(IvfRabitqQueryParams params)
      Set IVF RaBitQ query parameters (zvec ≥ v0.7.0). Ownership of the params transfers to this sub-query; the wrapper becomes inert.

    • setDiskAnnParams

      public void setDiskAnnParams(DiskAnnQueryParams params)
      Set DiskANN query parameters (zvec ≥ v0.7.0). Ownership of the params transfers to this sub-query; the wrapper becomes inert. Passing the handle without transferring it would leave the query pointing at memory that DiskAnnQueryParams.close() frees.

    • setFtsParams

      public void setFtsParams(FtsQueryParams ftsParams)
      Set FTS query parameters. Ownership transfers to this sub-query.

    • setFts

      public void setFts(FtsPayload fts)

    • close

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

    • destroy

      public void destroy()