メインコンテンツまでスキップ

searchIterator()

searchIterator()

このメソッドは、検索結果を反復処理するための search iterator を返します。

java
public SearchIterator searchIterator(SearchIteratorReq request)

Request Syntax​

java
searchIterator(SearchIteratorReq.builder()
    .databaseName(String databaseName)
    .collectionName(String collectionName)
    .clusterId(String clusterId)
    .partitionNames(List<String> partitionNames)
    .vectorFieldName(String vectorFieldName)
    .topK(int topK)
    .limit(long limit)
    .expr(String expr)
    .outputFields(List<String> outputFields)
    .vectors(List<BaseVector> vectors)
    .roundDecimal(int roundDecimal)
    .params(String params)
    .consistencyLevel(ConsistencyLevel consistencyLevel)
    .ignoreGrowing(boolean ignoreGrowing)
    .groupByFieldName(String groupByFieldName)
    .batchSize(long batchSize)
    .build()
);

BUILDER METHODS:

  • databaseName(String databaseName)

    データベース名です。指定しない場合は現在のデータベースがデフォルトで使用されます。

  • collectionName(String collectionName)

    対象の collection 名です。

  • clusterId(String clusterId)

    この vector 読み取りリクエストの対象 cluster ID です。複数のリクエストで同じ cluster ID を共有する場合は session(String clusterId) を使用します。

  • partitionNames(List<String> partitionNames)

    対象とする partition 名のリストです。

  • vectorFieldName(String vectorFieldName)

    vector フィールドの名前です。

  • topK(int topK)

    返す上位結果の件数です。

  • limit(long limit)

    返す結果の最大件数です。

  • expr(String expr)

    結果をフィルタリングするためのブール式です。

  • outputFields(List<String> outputFields)

    出力に含めるフィールド名のリストです。

  • vectors(List<BaseVector> vectors)

    検索に使用する vector のリストです。

  • roundDecimal(int roundDecimal)

    distance/score の丸めに使用する小数点以下の桁数です。

  • params(String params)

    JSON 文字列として指定する追加の検索パラメータです。

  • consistencyLevel(ConsistencyLevel consistencyLevel)

    操作の整合性レベルです。

  • ignoreGrowing(boolean ignoreGrowing)

    操作中に growing segment を無視するかどうかです。

  • groupByFieldName(String groupByFieldName)

    検索結果をグループ化するフィールド名です。

  • batchSize(long batchSize)

    iterator 操作の batch size です。

RETURNS:

SearchIterator

検索結果を反復処理するための SearchIterator オブジェクトで、以下のメソッドを提供します。

EXCEPTIONS:

  • MilvusClientException

    この操作中に何らかのエラーが発生した場合、この例外が発生します。

Example​

java
import io.milvus.orm.iterator.SearchIterator;
import io.milvus.response.QueryResultsWrapper;
import io.milvus.v2.client.ConnectConfig;
import io.milvus.v2.client.MilvusClientV2;
import io.milvus.v2.common.ConsistencyLevel;
import io.milvus.v2.common.IndexParam;
import io.milvus.v2.service.vector.request.SearchIteratorReq;
import io.milvus.v2.service.vector.request.data.FloatVec;

// 1. Set up a client
ConnectConfig connectConfig = ConnectConfig.builder()
        .uri("YOUR_CLUSTER_ENDPOINT")
        .token("YOUR_CLUSTER_TOKEN")
        .build();
        
MilvusClientV2 client = new MilvusClientV2(connectConfig);

// 2. Iterator search
List<Float> vector = generateFloatVector();
SearchIterator searchIterator = client.searchIterator(SearchIteratorReq.builder()
        .collectionName("test")
        .outputFields(Lists.newArrayList("vector"))
        .batchSize(50L)
        .vectorFieldName("vector")
        .vectors(Collections.singletonList(new FloatVec(vector)))
        .expr("id > 100")
        .params("{\"range_filter\": 15.0, \"radius\": 20.0}")
        .topK(300)
        .metricType(IndexParam.MetricType.L2)
        .consistencyLevel(ConsistencyLevel.BOUNDED)
        .build());

System.out.println("SearchIteratorV1 results:");
while (true) {
    List<QueryResultsWrapper.RowRecord> res = searchIterator.next();
    if (res.isEmpty()) {
        System.out.println("Search iteration finished, close");
        searchIterator.close();
        break;
    }

    for (QueryResultsWrapper.RowRecord record : res) {
        System.out.println(record);
    }
}
Ctrl I