queryIterator()

この操作は vector 類似検索を反復的に実行し、結果をバッチ単位で返します。大量の結果セットを段階的に処理する必要がある場合や、単一のクエリで返せる総結果数を超える場合は、単一の search() 呼び出しの代わりにこれを使用します。

javascript
await milvusClient.searchIterator(data: SearchIteratorReq)

リクエスト構文

javascript
await milvusClient.searchIterator({
    collection_name: string,
    data: SearchData | SearchData[],
    batchSize: number,
    limit?: number,
    filter?: string,
    anns_field?: string,
    output_fields?: string[],
    partition_names?: string[],
    params?: keyValueObj,
    metric_type?: string,
    consistency_level?: ConsistencyLevelEnum,
    ignore_growing?: boolean,
    group_by_field?: string,
    exprValues?: keyValueObj,
    rerank?: RerankerObj | FunctionObject | FunctionScore,
    transformers?: OutputTransformers,
    external_filter_fn?: (row: SearchResultData) => boolean,
    db_name?: string,
})

パラメーター:

collection_name (string) -

[必須]

検索対象の collection の名前。
data (SearchData | SearchData[]) -

[必須]

クエリ vector。サポートされる型には、FloatVector (number[])、BFloat16Vector (Uint8Array)、Float16Vector (Uint8Array)、BinaryVector (number[])、および SparseFloatVector が含まれます。
batchSize (number) -

[必須]

反復ごとに返される結果数。16,384 を超えることはできません。
limit (number) -

すべての反復にわたる結果の総最大数。デフォルトは一致する entity の総数です（制限なし）。
filter (string) -

検索前に一致する entity を絞り込むための scalar フィルタリング条件。デフォルトは空文字列です（フィルタなし）。
anns_field (string) -

対象 vector フィールドの名前。collection に複数の vector フィールドがある場合は必須です。
output_fields (string[]) -

返される各 entity に含めるフィールド名のリスト。デフォルトでは primary フィールドのみが含まれます。
partition_names (string[]) -

検索対象の partition の名前。
params (keyValueObj) -

radius や範囲検索用の range_filter など、キーと値のペアで指定する追加の検索パラメーター。
metric_type (string) -

vector 間の類似度を測定するために使用される metric タイプ。デフォルトでは、index が作成されたフィールドの metric タイプが使用されます。
consistency_level (ConsistencyLevelEnum) -

この操作の整合性レベル。オプション: Strong (0)、Bounded (1)、Session (2)、Eventually (3)。デフォルトは Bounded です。
ignore_growing (boolean) -

検索中に growing segment をスキップするかどうか。
group_by_field (string) -

指定したフィールドで検索結果をグループ化し、多様性を確保します。
exprValues (keyValueObj) -

テンプレート化されたフィルタ式のプレースホルダー値。
rerank (RerankerObj | FunctionObject | FunctionScore) -

再ランキング戦略とそのパラメーター。サポートされる reranker タイプの詳細については search() を参照してください。
transformers (OutputTransformers) -

BFloat16Vector や Float16Vector などの特殊な vector データ型向けのカスタム transformer。
external_filter_fn ((row: SearchResultData) => boolean) -

各結果バッチに適用される任意のクライアント側フィルター関数。この関数が false を返した entity は、yield されるバッチから除外されます。
db_name (string) -

collection を含むデータベースの名前。
element_indices (ElementIndices[]) -

クエリ iterator の element index。任意です。

戻り値:

Promise<AsyncIterable<SearchResultData[]>>

非同期 iterable を返します。各反復では、そのバッチに対応する一致 entity の配列が yield されます。総結果数が limit に達した時点、または一致するすべての entity を使い切った時点で反復は終了します。

例外:

MilvusError

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

例

javascript
import { MilvusClient } from '@zilliz/milvus2-sdk-node';

const milvusClient = new MilvusClient({
    address: 'YOUR_CLUSTER_ENDPOINT',
    token: 'YOUR_CLUSTER_TOKEN',
});

const iterator = await milvusClient.searchIterator({
    collection_name: 'my_collection',
    data: [0.1, 0.2, 0.3, 0.4, 0.5],
    batchSize: 100,
    limit: 500,
    output_fields: ['id', 'text'],
    filter: 'age > 18',
});

for await (const batch of iterator) {
    console.log(`Batch of ${batch.length} results:`, batch);
}

リクエスト構文​

例​

リクエスト構文

例