Package io.milvus.param

Class QueryNodeSingleSearch.Builder

java.lang.Object

io.milvus.param.QueryNodeSingleSearch.Builder

Enclosing class:

QueryNodeSingleSearch

public static class QueryNodeSingleSearch.Builder
extends Object

Builder for QueryNodeSingleSearch

Method Summary

Modifier and Type	Method	Description
QueryNodeSingleSearch	build()	Verifies parameters and creates a new QueryNodeSingleSearch instance.
QueryNodeSingleSearch.Builder	withCollectionName(String collectionName)	Sets the collection name.
QueryNodeSingleSearch.Builder	withMetricType(MetricType metricType)	Sets metric type of ANN searching.
QueryNodeSingleSearch.Builder	withParams(String params)	Sets the search parameters specific to the index type.
QueryNodeSingleSearch.Builder	withVectorFieldName(String vectorFieldName)	Sets target vector field by name.
QueryNodeSingleSearch.Builder	withVectors(List<?> vectors)	Sets the target vectors.

Methods inherited from class java.lang.Object

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

Method Detail

withCollectionName

public QueryNodeSingleSearch.Builder withCollectionName(String collectionName)

Sets the collection name. Collection name cannot be empty or null.

Parameters:

collectionName - collection name

Returns:

Builder

withMetricType

public QueryNodeSingleSearch.Builder withMetricType(MetricType metricType)

Sets metric type of ANN searching.

Parameters:

metricType - metric type

Returns:

Builder

withVectorFieldName

public QueryNodeSingleSearch.Builder withVectorFieldName(String vectorFieldName)

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

Parameters:

vectorFieldName - vector field name

Returns:

Builder

withVectors

public QueryNodeSingleSearch.Builder withVectors(List<?> vectors)

Sets the target vectors.

Parameters:

vectors - list of target vectors: if vector type is FloatVector, vectors is List of List Float if vector type is BinaryVector/Float16Vector/BFloat16Vector, vectors is List of ByteBuffer if vector type is SparseFloatVector, values is List of SortedMap[Long, Float]

Returns:

Builder

withParams

public QueryNodeSingleSearch.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 QueryNodeSingleSearch build()
                            throws ParamException

Verifies parameters and creates a new QueryNodeSingleSearch instance.

Returns:

QueryNodeSingleSearch

Throws:

ParamException