com.lancedb.lance.ipc

Class Query.Builder

java.lang.Object

com.lancedb.lance.ipc.Query.Builder

Enclosing class:

Query

public static class Query.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Query	build() Builds the Query object.
Query.Builder	setColumn(String column) Sets the column to be searched.
Query.Builder	setDistanceType(DistanceType distanceType) Sets the distance metric type.
Query.Builder	setEf(int ef) Sets the number of candidates to reserve while searching.
Query.Builder	setK(int k) Sets the number of top results to return.
Query.Builder	setKey(float[] key) Sets the vector to be searched.
Query.Builder	setMaximumNprobes(int maximumNprobes) Sets the maximum number of partitions to search.
Query.Builder	setMinimumNprobes(int minimumNprobes) Sets the minimum number of partitions to search.
Query.Builder	setNprobes(int nprobes) Sets the number of probes to load and search.
Query.Builder	setRefineFactor(int refineFactor) Sets the refine factor for applying a refine step.
Query.Builder	setUseIndex(boolean useIndex) Sets whether to use an ANN index if available.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

setColumn

public Query.Builder setColumn(String column)

Sets the column to be searched.

Parameters:

column - The name of the column to search in.

Returns:

The Builder instance for method chaining.

setKey

public Query.Builder setKey(float[] key)

Sets the vector to be searched.

Parameters:

key - The search vector.

Returns:

The Builder instance for method chaining.

setK

public Query.Builder setK(int k)

Sets the number of top results to return.

Parameters:

k - The number of top results to return.

Returns:

The Builder instance for method chaining.

setNprobes

public Query.Builder setNprobes(int nprobes)

Sets the number of probes to load and search.

This is a convenience method that sets both the minimum and maximum number of probes to the same value.

Parameters:

nprobes - The number of probes.

Returns:

The Builder instance for method chaining.

setMinimumNprobes

public Query.Builder setMinimumNprobes(int minimumNprobes)

Sets the minimum number of partitions to search.

This many partitions will always be loaded and searched on the query. Increasing this number can improve recall at the cost of latency.

Parameters:

minimumNprobes - The minimum number of partitions to search.

Returns:

The Builder instance for method chaining.

setMaximumNprobes

public Query.Builder setMaximumNprobes(int maximumNprobes)

Sets the maximum number of partitions to search.

These partitions will only be loaded and searched if we have not found the desired number of results after searching the minimum number of partitions. Increasing this number can avoid false negatives on queries with a highly selective prefilter. This setting does not affect the recall of the query and will only affect the latency if the prefilter is highly selective.

Parameters:

maximumNprobes - The maximum number of partitions to search.

Returns:

The Builder instance for method chaining.

setEf

public Query.Builder setEf(int ef)

Sets the number of candidates to reserve while searching. This is an optional parameter for HNSW related index types.

Parameters:

ef - The number of candidates to reserve.

Returns:

The Builder instance for method chaining.

setRefineFactor

public Query.Builder setRefineFactor(int refineFactor)

Sets the refine factor for applying a refine step.

Parameters:

refineFactor - The refine factor.

Returns:

The Builder instance for method chaining.

setDistanceType

public Query.Builder setDistanceType(DistanceType distanceType)

Sets the distance metric type.

Parameters:

distanceType - The DistanceType to use for the query.

Returns:

The Builder instance for method chaining.

setUseIndex

public Query.Builder setUseIndex(boolean useIndex)

Sets whether to use an ANN index if available.

Parameters:

useIndex - True to use the index, false otherwise.

Returns:

The Builder instance for method chaining.

build

public Query build()

Builds the Query object.

Returns:

A new immutable Query instance.

Throws:

IllegalStateException - if any required fields are not set or have invalid values.