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 java.lang.Object
Builder forSearchParam
class.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SearchParam.Builder
addOutField(@NonNull java.lang.String fieldName)
Specifies an output field (Optional).SearchParam.Builder
addPartitionName(@NonNull java.lang.String partitionName)
Adds a partition to specify search scope (Optional).SearchParam
build()
Verifies parameters and creates a newSearchParam
instance.SearchParam.Builder
withCollectionName(@NonNull java.lang.String collectionName)
Sets the collection name.SearchParam.Builder
withConsistencyLevel(ConsistencyLevelEnum consistencyLevel)
ConsistencyLevel of consistency level.SearchParam.Builder
withExpr(@NonNull java.lang.String expr)
Sets expression to filter out entities before searching (Optional).SearchParam.Builder
withGracefulTime(java.lang.Long gracefulTime)
Deprecated.SearchParam.Builder
withGuaranteeTimestamp(@NonNull java.lang.Long ts)
Deprecated.SearchParam.Builder
withIgnoreGrowing(@NonNull java.lang.Boolean ignoreGrowing)
Ignore the growing segments to get best search performance.SearchParam.Builder
withMetricType(@NonNull MetricType metricType)
Sets metric type of ANN searching.SearchParam.Builder
withOutFields(@NonNull java.util.List<java.lang.String> outFields)
Specifies output fields (Optional).SearchParam.Builder
withParams(@NonNull java.lang.String params)
Sets the search parameters specific to the index type.SearchParam.Builder
withPartitionNames(@NonNull java.util.List<java.lang.String> partitionNames)
Sets partition names list to specify search scope (Optional).SearchParam.Builder
withRoundDecimal(@NonNull java.lang.Integer decimal)
Specifies the decimal place of the returned results.SearchParam.Builder
withTopK(@NonNull java.lang.Integer topK)
Sets topK value of ANN search.SearchParam.Builder
withTravelTimestamp(@NonNull java.lang.Long ts)
Deprecated.SearchParam.Builder
withVectorFieldName(@NonNull java.lang.String vectorFieldName)
Sets target vector field by name.SearchParam.Builder
withVectors(@NonNull java.util.List<?> vectors)
Sets the target vectors.
-
-
-
Method Detail
-
withCollectionName
public SearchParam.Builder withCollectionName(@NonNull @NonNull java.lang.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 java.util.List<java.lang.String> partitionNames)
Sets partition names list to specify search scope (Optional).- Parameters:
partitionNames
- partition names list- Returns:
Builder
-
withConsistencyLevel
public SearchParam.Builder withConsistencyLevel(ConsistencyLevelEnum consistencyLevel)
ConsistencyLevel of consistency level.- Parameters:
consistencyLevel
- consistency level- Returns:
Builder
-
withGracefulTime
@Deprecated public SearchParam.Builder withGracefulTime(java.lang.Long gracefulTime)
Deprecated.Graceful time for BOUNDED Consistency Level Note: This parameter is deprecated from Milvus v2.2.9, user only input consistency level to search. The time settings of different consistency levels are determined by the server side. For this reason, this method is marked as Deprecated in Java SDK v2.2.11- Parameters:
gracefulTime
- graceful time- Returns:
Builder
-
addPartitionName
public SearchParam.Builder addPartitionName(@NonNull @NonNull java.lang.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 java.lang.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 java.lang.Integer topK)
Sets topK value of ANN search.- Parameters:
topK
- topK value- Returns:
Builder
-
withExpr
public SearchParam.Builder withExpr(@NonNull @NonNull java.lang.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 java.util.List<java.lang.String> outFields)
Specifies output fields (Optional).- Parameters:
outFields
- output fields- Returns:
Builder
-
addOutField
public SearchParam.Builder addOutField(@NonNull @NonNull java.lang.String fieldName)
Specifies an output field (Optional).- Parameters:
fieldName
- filed name- Returns:
Builder
-
withVectors
public SearchParam.Builder withVectors(@NonNull @NonNull java.util.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
-
withRoundDecimal
public SearchParam.Builder withRoundDecimal(@NonNull @NonNull java.lang.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 java.lang.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
-
withTravelTimestamp
@Deprecated public SearchParam.Builder withTravelTimestamp(@NonNull @NonNull java.lang.Long ts)
Deprecated.Specify an absolute timestamp in a search to get results based on a data view at a specified point in time. Default value is 0, server executes search on a full data view.- Parameters:
ts
- a timestamp value- Returns:
Builder
-
withGuaranteeTimestamp
@Deprecated public SearchParam.Builder withGuaranteeTimestamp(@NonNull @NonNull java.lang.Long ts)
Deprecated.Instructs server to see insert/delete operations performed before a provided timestamp. If no such timestamp is specified, the server will wait for the latest operation to finish and search. Note: The timestamp is not an absolute timestamp, it is a hybrid value combined by UTC time and internal flags. We call it TSO, for more information please refer to: https://github.com/milvus-io/milvus/blob/master/docs/design_docs/milvus_hybrid_ts_en.md You can get a TSO from insert/delete operations, see theMutationResultWrapper
class. Use an operation's TSO to set this parameter, the server will execute search after this operation is finished. Default value is GUARANTEE_EVENTUALLY_TS, server executes search immediately. Note: This parameter is deprecated from Milvus v2.2.9, user only input consistency level to search. The time settings of different consistency levels are determined by the server side. For this reason, this method is marked as Deprecated in Java SDK v2.2.11- Parameters:
ts
- a timestamp value- Returns:
Builder
-
withIgnoreGrowing
public SearchParam.Builder withIgnoreGrowing(@NonNull @NonNull java.lang.Boolean ignoreGrowing)
Ignore the growing segments to get best search performance. Default is False. For the user case that don't require data visibility.- Parameters:
ignoreGrowing
-Boolean.TRUE
ignore, Boolean.FALSE is not- Returns:
Builder
-
build
public SearchParam build() throws ParamException
Verifies parameters and creates a newSearchParam
instance.- Returns:
SearchParam
- Throws:
ParamException
-
-