Package io.milvus.client

Class SearchParam.Builder

java.lang.Object

io.milvus.client.SearchParam.Builder

Enclosing class:

SearchParam

public static class SearchParam.Builder
extends Object

Builder for SearchParam

Constructor Summary

Constructors

Constructor	Description
Builder(String tableName, List<List<Float>> queryVectors)

Method Summary

Modifier and Type	Method	Description
SearchParam	build()
SearchParam.Builder	withDateRanges(List<DateRange> dateRanges)	Optional.
SearchParam.Builder	withNProbe(long nProbe)	Optional.
SearchParam.Builder	withTimeout(long timeout)	Optional.
SearchParam.Builder	withTopK(long topK)	Optional.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(@Nonnull
               String tableName,
               @Nonnull
               List<List<Float>> queryVectors)

Parameters:

tableName - table to search from

queryVectors - a List of vectors to be queried. Each inner List represents a vector.

Method Detail

withDateRanges

public SearchParam.Builder withDateRanges(@Nonnull
                                          List<DateRange> dateRanges)

Optional. Searches vectors in their corresponding date range. Default to an empty ArrayList

Parameters:

dateRanges - a List of DateRange objects

Returns:

Builder

See Also:

DateRange

withTopK

public SearchParam.Builder withTopK(long topK)

Optional. Limits search result to topK. Default to 1024.

Parameters:

topK - a topK number

Returns:

Builder

withNProbe

public SearchParam.Builder withNProbe(long nProbe)

Optional. Default to 20.

Parameters:

nProbe - a nProbe number

Returns:

Builder

withTimeout

public SearchParam.Builder withTimeout(long timeout)

Optional. Sets the deadline from when the client RPC is set to when the response is picked up by the client. Default to 86400s (1 day).

Parameters:

timeout - in seconds

Returns:

Builder

build

public SearchParam build()