Package org.zvec.binding

Class GroupByVectorQuery

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

  • Constructor Details

    • GroupByVectorQuery

      public GroupByVectorQuery()

  • Method Details

    • setFieldName

      public void setFieldName(String fieldName)

    • getFieldName

      public String getFieldName()

    • setGroupByFieldName

      public void setGroupByFieldName(String fieldName)

    • getGroupByFieldName

      public String getGroupByFieldName()

    • setGroupCount

      public void setGroupCount(int count)

    • getGroupCount

      public int getGroupCount()

    • setTopkPerGroup

      public void setTopkPerGroup(int topkPerGroup)
      Set the maximum number of results per group.

      Named after zvec_group_by_vector_query_set_topk_per_group (renamed from set_group_topk in zvec v0.7.0).

    • getTopkPerGroup

      public int getTopkPerGroup()
      Get the maximum number of results per group.

    • setQueryVector

      public void setQueryVector(float[] vector)

    • setFilter

      public void setFilter(String filter)

    • getFilter

      public String getFilter()

    • setIncludeVector

      public void setIncludeVector(boolean include)

    • getIncludeVector

      public boolean getIncludeVector()

    • setOutputFields

      public void setOutputFields(String[] fields)
      Set the scalar fields to return.
      Parameters:
      fields - field names; null returns all fields, an empty array returns only the primary key / system columns

    • setHNSWParams

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

    • setIVFParams

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

    • setFlatParams

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

    • setVamanaParams

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

    • setIvfRabitqParams

      public void setIvfRabitqParams(IvfRabitqQueryParams params)
      Set IVF RaBitQ query parameters (zvec ≥ v0.7.0). Ownership of the params transfers to this 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 query; the wrapper becomes inert.

    • close

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

    • destroy

      public void destroy()