Package io.milvus.param.dml

Class AnnSearchParam.Builder

java.lang.Object

io.milvus.param.dml.AnnSearchParam.Builder

Enclosing class:

AnnSearchParam

public static class AnnSearchParam.Builder
extends Object

Builder for AnnSearchParam class.

Method Summary

Modifier and Type	Method	Description
AnnSearchParam	build()	Verifies parameters and creates a new AnnSearchParam instance.
AnnSearchParam.Builder	withBFloat16Vectors(List<ByteBuffer> vectors)	Sets the target vectors to search on BFloat16Vector field.
AnnSearchParam.Builder	withBinaryVectors(List<ByteBuffer> vectors)	Sets the target vectors to search on BinaryVector field.
AnnSearchParam.Builder	withExpr(String expr)	Sets expression to filter out entities before searching (Optional).
AnnSearchParam.Builder	withFloat16Vectors(List<ByteBuffer> vectors)	Sets the target vectors to search on Float16Vector field.
AnnSearchParam.Builder	withFloatVectors(List<List<Float>> vectors)	Sets the target vectors to search on FloatVector field.
AnnSearchParam.Builder	withLimit(Long limit)
AnnSearchParam.Builder	withMetricType(MetricType metricType)	Sets metric type of ANN searching.
AnnSearchParam.Builder	withParams(String params)	Sets the search parameters specific to the index type.
AnnSearchParam.Builder	withSparseFloatVectors(List<SortedMap<Long,Float>> vectors)	Sets the target vectors to search on SparseFloatVector field.
AnnSearchParam.Builder	withTopK(Integer topK)	Deprecated.
AnnSearchParam.Builder	withVectorFieldName(String vectorFieldName)	Sets target vector field by name.

Methods inherited from class java.lang.Object

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

Method Detail

withMetricType

public AnnSearchParam.Builder withMetricType(MetricType metricType)

Sets metric type of ANN searching.

Parameters:

metricType - metric type

Returns:

Builder

withVectorFieldName

public AnnSearchParam.Builder withVectorFieldName(String vectorFieldName)

Sets target vector field by name. Field name cannot be empty or null.

Parameters:

vectorFieldName - vector field name

Returns:

Builder

withTopK

@Deprecated
public AnnSearchParam.Builder withTopK(Integer topK)

Deprecated.

Sets topK value of ANN search.

Parameters:

topK - topK value

Returns:

Builder

withLimit

public AnnSearchParam.Builder withLimit(Long limit)

withExpr

public AnnSearchParam.Builder withExpr(String expr)

Sets expression to filter out entities before searching (Optional).

Parameters:

expr - filtering expression

Returns:

Builder

See Also:

Boolean Expression Rules

withFloatVectors

public AnnSearchParam.Builder withFloatVectors(List<List<Float>> vectors)

Sets the target vectors to search on FloatVector field.

Parameters:

vectors - target vectors to search

Returns:

Builder

withBinaryVectors

public AnnSearchParam.Builder withBinaryVectors(List<ByteBuffer> vectors)

Sets the target vectors to search on BinaryVector field.

Parameters:

vectors - target vectors to search

Returns:

Builder

withFloat16Vectors

public AnnSearchParam.Builder withFloat16Vectors(List<ByteBuffer> vectors)

Sets the target vectors to search on Float16Vector field.

Parameters:

vectors - target vectors to search

Returns:

Builder

withBFloat16Vectors

public AnnSearchParam.Builder withBFloat16Vectors(List<ByteBuffer> vectors)

Sets the target vectors to search on BFloat16Vector field.

Parameters:

vectors - target vectors to search

Returns:

Builder

withSparseFloatVectors

public AnnSearchParam.Builder withSparseFloatVectors(List<SortedMap<Long,Float>> vectors)

Sets the target vectors to search on SparseFloatVector field.

Parameters:

vectors - target vectors to search

Returns:

Builder

withParams

public AnnSearchParam.Builder withParams(String params)

Sets the search parameters specific to the index type.

For example: IVF index, the search parameters can be "{\"nprobe\":10}" For more information: @see Index Selection

Parameters:

params - extra parameters in json format

Returns:

Builder

build

public AnnSearchParam build()
                     throws ParamException

Verifies parameters and creates a new AnnSearchParam instance.

Returns:

AnnSearchParam

Throws:

ParamException