Package io.milvus.param.highlevel.dml

Class SearchSimpleParam.Builder

java.lang.Object

io.milvus.param.highlevel.dml.SearchSimpleParam.Builder

Enclosing class:

SearchSimpleParam

public static class SearchSimpleParam.Builder
extends Object

Builder for SearchSimpleParam class.

Method Summary

Modifier and Type	Method	Description
SearchSimpleParam	build()	Verifies parameters and creates a new SearchSimpleParam instance.
SearchSimpleParam.Builder	withCollectionName(@NonNull String collectionName)	Sets the collection name.
SearchSimpleParam.Builder	withFilter(@NonNull String filter)	Sets expression to filter out entities before searching (Optional).
SearchSimpleParam.Builder	withLimit(int limit)	Specify a value to control the returned number of entities.
SearchSimpleParam.Builder	withOffset(@NonNull Long offset)	Specify a position to return results.
SearchSimpleParam.Builder	withOutputFields(@NonNull List<String> outputFields)	Specifies output fields (Optional).
SearchSimpleParam.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 SearchSimpleParam.Builder withCollectionName(@NonNull
                                                    @NonNull String collectionName)

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

Parameters:

collectionName - collection name

Returns:

Builder

withFilter

public SearchSimpleParam.Builder withFilter(@NonNull
                                            @NonNull String filter)

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

Parameters:

filter - filtering expression

Returns:

Builder

See Also:

Boolean Expression Rules

withOutputFields

public SearchSimpleParam.Builder withOutputFields(@NonNull
                                                  @NonNull List<String> outputFields)

Specifies output fields (Optional).

Parameters:

outputFields - output fields

Returns:

Builder

withVectors

public SearchSimpleParam.Builder withVectors(@NonNull
                                             @NonNull 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, vectors is List of ByteBuffer;

Returns:

Builder

withOffset

public SearchSimpleParam.Builder withOffset(@NonNull
                                            @NonNull Long offset)

Specify a position to return results. Only take effect when the 'limit' value is specified. Default value is 0, start from begin.

Parameters:

offset - a value to define the position

Returns:

Builder

withLimit

public SearchSimpleParam.Builder withLimit(int limit)

Specify a value to control the returned number of entities. Must be a positive value. Default value is 0, will return without limit.

Parameters:

limit - a value to define the limit of returned entities

Returns:

Builder

build

public SearchSimpleParam build()
                        throws ParamException

Verifies parameters and creates a new SearchSimpleParam instance.

Returns:

SearchSimpleParam

Throws:

ParamException