io.milvus.param.highlevel.dml.SearchSimpleParam Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of milvus-sdk-java Show documentation
Show all versions of milvus-sdk-java Show documentation
Java SDK for Milvus, a distributed high-performance vector database.
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package io.milvus.param.highlevel.dml;
import com.google.common.collect.Lists;
import io.milvus.common.clientenum.ConsistencyLevelEnum;
import io.milvus.exception.ParamException;
import io.milvus.param.Constant;
import io.milvus.param.ParamUtils;
import io.milvus.param.dml.SearchParam;
import lombok.Getter;
import lombok.NonNull;
import lombok.ToString;
import org.apache.commons.collections4.CollectionUtils;
import org.jetbrains.annotations.NotNull;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* Parameters for search interface.
*/
@Getter
public class SearchSimpleParam {
private final String collectionName;
private final List vectors;
private final List outputFields;
private final String filter;
private final Long offset;
private final int limit;
private final Map params;
private final ConsistencyLevelEnum consistencyLevel;
private SearchSimpleParam(@NotNull Builder builder) {
this.collectionName = builder.collectionName;
this.vectors = builder.vectors;
this.outputFields = builder.outputFields;
this.filter = builder.filter;
this.offset = builder.offset;
this.limit = builder.limit;
this.params = builder.params;
this.consistencyLevel = builder.consistencyLevel;
}
public static Builder newBuilder() {
return new Builder();
}
/**
* Builder for {@link SearchSimpleParam} class.
*/
public static class Builder {
private String collectionName;
private List vectors;
private final List outputFields = Lists.newArrayList();
private String filter = "";
private Long offset = 0L;
private int limit = 10;
private ConsistencyLevelEnum consistencyLevel = null;
private final Map params = new HashMap<>();
Builder() {
}
/**
* Sets the collection name. Collection name cannot be empty or null.
*
* @param collectionName collection name
* @return Builder
*/
public Builder withCollectionName(@NonNull String collectionName) {
this.collectionName = collectionName;
return this;
}
/**
* Sets expression to filter out entities before searching (Optional).
*
* @param filter filtering expression
* @return Builder
* @see Boolean Expression Rules
*/
public Builder withFilter(@NonNull String filter) {
this.filter = filter;
return this;
}
/**
* Specifies output fields (Optional).
*
* @param outputFields output fields
* @return Builder
*/
public Builder withOutputFields(@NonNull List outputFields) {
this.outputFields.addAll(outputFields);
return this;
}
/**
* Sets the target vectors.
*
* @param vectors list of target vectors: List of List Float;
* @return Builder
*/
public Builder withVectors(@NonNull List vectors) {
this.vectors = vectors;
return this;
}
/**
* Specify a position to return results. Only take effect when the 'limit' value is specified.
* Default value is 0, start from begin.
*
* @param offset a value to define the position
* @return Builder
*/
public Builder withOffset(@NonNull Long offset) {
this.offset = offset;
return this;
}
/**
* Specify a value to control the returned number of entities. Must be a positive value.
* Default value is 10, will return without limit.
* To maintain consistency with the parameter type of the query interface, the field is declared as Long. In reality, the field is of type int.
*
* @param limit a value to define the limit of returned entities
* @return Builder
*/
public Builder withLimit(@NonNull Long limit) {
this.limit = Math.toIntExact(limit);
return this;
}
/**
* ConsistencyLevel of consistency level.
*
* @param consistencyLevel consistency level
* @return Builder
*/
public Builder withConsistencyLevel(ConsistencyLevelEnum consistencyLevel) {
this.consistencyLevel = consistencyLevel;
return this;
}
/**
* Verifies parameters and creates a new {@link SearchSimpleParam} instance.
*
* @return {@link SearchSimpleParam}
*/
public SearchSimpleParam build() throws ParamException {
ParamUtils.CheckNullEmptyString(collectionName, "Collection name");
if (CollectionUtils.isEmpty(vectors)) {
throw new ParamException("vector cannot be empty");
}
if (offset < 0) {
throw new ParamException("The offset value cannot be less than 0");
}
if (limit < 0) {
throw new ParamException("The limit value cannot be less than 0");
}
params.put(Constant.OFFSET, offset);
return new SearchSimpleParam(this);
}
}
/**
*
* Warning: don't use lombok@ToString to annotate this class
* because large number of vectors will waste time in toString() method.
*
*/
@Override
public String toString() {
return "SearchSimpleParam{" +
"collectionName='" + collectionName + '\'' +
", params='" + params + '\'' +
", filter='" + filter + '\'' +
", NQ=" + vectors.size() +
", limit=" + limit +
", offset=" + offset +
", outputFields=" + outputFields +
", consistencyLevel='" + consistencyLevel + '\'' +
'}';
}
}