Package io.milvus.param.dml

Class SearchParam.Builder

java.lang.Object

io.milvus.param.dml.SearchParam.Builder

Enclosing class:

SearchParam

public static class SearchParam.Builder
extends Object

Builder for SearchParam class.

Method Summary

Modifier and Type	Method	Description
SearchParam.Builder	addOutField(@NonNull String fieldName)	Specifies an output field (Optional).
SearchParam.Builder	addPartitionName(@NonNull String partitionName)	Adds a partition to specify search scope (Optional).
SearchParam	build()	Verifies parameters and creates a new SearchParam instance.
SearchParam.Builder	withCollectionName(@NonNull String collectionName)	Sets the collection name.
SearchParam.Builder	withExpr(@NonNull String expr)	Sets expression to filter out entities before searching (Optional).
SearchParam.Builder	withMetricType(@NonNull MetricType metricType)	Sets metric type of ANN searching.
SearchParam.Builder	withOutFields(@NonNull List<String> outFields)	Specifies output fields (Optional).
SearchParam.Builder	withParams(@NonNull String params)	Sets the search parameters specific to the index type.
SearchParam.Builder	withPartitionNames(@NonNull List<String> partitionNames)	Sets partition names list to specify search scope (Optional).
SearchParam.Builder	withRoundDecimal(@NonNull Integer decimal)	Specifies the decimal place of the returned results.
SearchParam.Builder	withTopK(@NonNull Integer topK)	Sets topK value of ANN search.
SearchParam.Builder	withVectorFieldName(@NonNull String vectorFieldName)	Sets target vector field by name.
SearchParam.Builder	withVectors(@NonNull 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 SearchParam.Builder withCollectionName(@NonNull
                                              @NonNull String collectionName)

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

Parameters:

collectionName - collection name

Returns:

Builder

withPartitionNames

public SearchParam.Builder withPartitionNames(@NonNull
                                              @NonNull List<String> partitionNames)

Sets partition names list to specify search scope (Optional).

Parameters:

partitionNames - partition names list

Returns:

Builder

addPartitionName

public SearchParam.Builder addPartitionName(@NonNull
                                            @NonNull String partitionName)

Adds a partition to specify search scope (Optional).

Parameters:

partitionName - partition name

Returns:

Builder

withMetricType

public SearchParam.Builder withMetricType(@NonNull
                                          @NonNull MetricType metricType)

Sets metric type of ANN searching.

Parameters:

metricType - metric type

Returns:

Builder

withVectorFieldName

public SearchParam.Builder withVectorFieldName(@NonNull
                                               @NonNull String vectorFieldName)

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

Parameters:

vectorFieldName - vector field name

Returns:

Builder

withTopK

public SearchParam.Builder withTopK(@NonNull
                                    @NonNull Integer topK)

Sets topK value of ANN search.

Parameters:

topK - topK value

Returns:

Builder

withExpr

public SearchParam.Builder withExpr(@NonNull
                                    @NonNull String expr)

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

Parameters:

expr - filtering expression

Returns:

Builder

See Also:

Boolean Expression Rules

withOutFields

public SearchParam.Builder withOutFields(@NonNull
                                         @NonNull List<String> outFields)

Specifies output fields (Optional).

Parameters:

outFields - output fields

Returns:

Builder

addOutField

public SearchParam.Builder addOutField(@NonNull
                                       @NonNull String fieldName)

Specifies an output field (Optional).

Parameters:

fieldName - filed name

Returns:

Builder

withVectors

public SearchParam.Builder withVectors(@NonNull
                                       @NonNull List<?> vectors)

Sets the target vectors.

Parameters:

vectors - list of target vectors: if vector type is FloatVector, vectors is List<List<Float>>; if vector type is BinaryVector, vectors is List<ByteBuffer>;

Returns:

Builder

withRoundDecimal

public SearchParam.Builder withRoundDecimal(@NonNull
                                            @NonNull Integer decimal)

Specifies the decimal place of the returned results.

Parameters:

decimal - how many digits after the decimal point

Returns:

Builder

withParams

public SearchParam.Builder withParams(@NonNull
                                      @NonNull 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 SearchParam build()
                  throws ParamException

Verifies parameters and creates a new SearchParam instance.

Returns:

SearchParam

Throws:

ParamException