search()
この操作は、オプションの scalar フィルタリング式を使用して vector 類似性検索を実行します。
await milvusClient.search(data)
Request Syntax
await milvusClient.search({
db_name?: string,
collection_name: string,
partition_names?: string[];
anns_field?: string;
data?: SearchDataType;
output_fields?: string[];
limit?: number;
offset?: number;
filter?: string;
exprValues?: keyValueObj;
params?: keyValueObj;
consistency_level?: ConsistencyLevelEnum;
ignore_growing?: boolean;
group_by_field?: string;
group_size?: number;
strict_group_size?: boolean;
hints?: string;
round_decimal?: number;
transformers?: OutputTransformers;
rerank?: RankerObj | FunctionObject | FunctionScore;
})
PARAMETERS:
-
db_name (string) -
対象の collection が属するデータベースの名前です。
-
collection_name (string) -
[REQUIRED]
検索対象の collection 名です
-
partition_names (string[]) -
検索対象の partition 名のリストです。
-
anns_field (string) -
この操作の対象 vector field の名前です。複数の vector field を持つ collection を検索する場合は必須です。
-
data (number[] | number[][]) -
vector 埋め込みのリストです。
Zilliz Cloud は、指定されたものに最も類似する vector 埋め込みを検索します。
-
output_fields (string[]) -
戻り値の各 entity に含める field 名のリストです。
デフォルト値は None です。指定しない場合は、primary field のみが含まれます。
-
limit (number) -
返す entity の総数です。
このパラメータは param 内の offset と組み合わせて使用し、ページネーションを有効にできます。
この値と param 内の offset の合計は 16,384 未満である必要があります。
ただし、grouping search では、
limitは個々の entity ではなく、返す group の最大数を指定します。各 group は、指定されたgroup_by_fieldに基づいて形成されます。 -
offset (number) -
検索結果でスキップするレコード数です。
このパラメータは
limitと組み合わせて使用し、ページネーションを有効にできます。この値と
limitの合計は 16,384 未満である必要があります。 -
filter (string) -
一致する entity を絞り込むための scalar フィルタリング条件です。
デフォルト値は空文字列で、条件が適用されないことを示します。
scalar フィルタリングをスキップするには、このパラメータを空文字列に設定できます。scalar フィルタリング条件の構築については、Boolean Expression Rules を参照してください。
-
exprValues (keyValueObj) -
Filtering Templating に記載されているように
filterでプレースホルダーを使用する場合、このパラメータの値として、それらのプレースホルダーに対する実際の値をキーと値のペアで指定できます。 -
params (KeyValueObj) -
追加の検索パラメータをキーと値のペアで指定します。
-
radius (number) -
類似度の下限しきい値を決定します。
metric_typeをL2に設定する場合、この値は range_filter より大きくする必要があります。それ以外の場合、この値は range_filter より小さくする必要があります。 -
range_filter (number) -
特定の類似度範囲内の vectors に検索を絞り込みます。
metric_typeをIPまたはCOSINEに設定する場合、この値は radius より大きくする必要があります。それ以外の場合、この値は radius より小さくする必要があります。 -
level (number)
Zilliz Cloud は、さまざまな index アルゴリズム固有の多数の検索パラメータを個別に調整する代わりに、検索パラメータのチューニングを簡素化するための統一パラメータを使用します。
デフォルト値は 1 で、範囲は 1 から 5 です。値を大きくすると再現率は高くなりますが、検索パフォーマンスは低下します。
-
page_retain_order (bool) -
offsetが指定されている場合に、検索結果の順序を保持するかどうかです。このパラメータは、
radiusも設定している場合にのみ適用されます。
-
-
consistency_level (ConsistencyLevelEnum) -
対象 collection の整合性レベルです。デフォルト値は Bounded (1) で、Strong (0)、Bounded (1)、Session (2)、Eventually (3) を指定できます。
-
ignore_growing (boolean) -
growing segment での検索をスキップするかどうかを示すブール値です。
-
group_by_field (string) -
検索結果を指定した field でグループ化し、多様性を確保して同じ group から複数の結果が返されることを防ぎます。
-
group_size (number) -
grouping search において、各 group 内で返す entity の目標数です。たとえば、
group_size=2を設定すると、各 group 内で最も類似する entity（例: ドキュメントの passage や vector 表現）を最大 2 件返すようシステムに指示します。group_sizeを設定しない場合、システムはデフォルトで各 group あたり 1 entity のみを返します。 -
strict_group_size (boolean) -
このブールパラメータは、
group_sizeを厳密に適用するかどうかを指定します。group_size=trueの場合、各 group 内に十分なデータが存在する限り、システムは各 group をちょうどgroup_size件の結果で埋めようとします。group 内の entity 数が不足している場合は、利用可能な entity のみを返しつつ、十分なデータがある group では指定されたgroup_sizeを満たすようにします。 -
hints (string) -
検索パフォーマンスを向上させるためのヒント文字列です。
-
round_decimal (number) -
最終結果で保持する小数点以下の桁数です。
-
transformers (OutputTransformers) -
以下のデータ型向けにデータを変換するカスタム関数です。
-
BFloat16Vector (
(bf16bytes: Uint8Array) => BFloat16Vector;) -
Float16Vector (
(f16: Uint8Array) => Float16Vector;) -
SparseFloatVector (
(sparse: SparseVectorDic) => SparseFloatVector;)
-
-
rerank (RerankerObj | FunctionObject \ FunctionScore) -
カスタムパラメータを持つ再ランキング戦略です。RerankerObj、FunctionObject、または FunctionScore のいずれかを使用できます。
RerankerObj には次のパラメータがあります。
-
strategy (string) -
再ランキング戦略です。指定可能な値は次のとおりです。
-
RRF ("rrf")
特定の強調ポイントがない場合に推奨される戦略です。RRF は各 vector field の重要性を効果的にバランスできます。
-
WEIGHTED ("weighted")
特定の vector field を重視した結果が必要な場合に推奨される戦略です。WeightedRanker では、特定の vector field に高い重みを割り当てて、それらをより強調できます。たとえば、multimodal 検索では、画像の色よりも画像のテキスト説明のほうが重要と見なされる場合があります。
-
-
params (keyValueObj) -
パラメータは再ランキング戦略ごとに異なります。
-
RRFRanker 戦略を使用する場合、RRFRanker にパラメータ値
kを入力する必要があります。kのデフォルト値は 60 です。このパラメータは、異なる ANN 検索の順位をどのように結合するかを決定するのに役立ち、すべての検索にわたる重要性のバランスと統合を目的としています。 -
WeightedRanker 戦略を使用する場合、
WeightedRanker関数に重みの値を入力する必要があります。Hybrid Search における基本 ANN 検索の数は、入力すべき値の数に対応します。入力値は [0,1] の範囲である必要があり、1 に近いほど重要度が高いことを示します。
-
FunctionObject は次の構造を持ちます。
-
name (string)
関数名です。この識別子は、クエリおよび collection 内で関数を参照するために使用されます。
-
description (string)
関数の目的の簡潔な説明です。大規模なプロジェクトではドキュメント化や明確化に役立ち、デフォルトは空文字列です。
-
type (FunctionType)
生データを処理する関数のタイプです。このパラメータに指定できる値は
FunctionType.RERANKです。 -
input_field_names (string[])
このパラメータの値は空配列のままにしてください。
FunctionScore は次の構造を持ちます。
-
functions (FunctionObject[]) -
FunctionObject オブジェクトのリストです。
-
params (keyValueObj) -
指定した関数がどのように連携するかを指定します。構造は次のとおりです。
-
boost_mode (string) -
指定した重みが一致した entity のスコアにどのように影響するかを指定します。指定可能な値は次のとおりです。
-
Multiply重み付けされた値が、一致した entity の元のスコアに指定した重みを掛けた値に等しいことを示します。
これがデフォルト値です。
-
Sum重み付けされた値が、一致した entity の元のスコアと指定した重みの合計に等しいことを示します
-
-
function_mode (string) -
複数の Boost Ranker からの重み付け値をどのように処理するかを指定します。指定可能な値は次のとおりです。
-
Multiply一致した entity の最終スコアが、すべての Boost Ranker からの重み付け値の積に等しいことを示します。
これがデフォルト値です。
-
Sum一致した entity の最終スコアが、すべての Boost Ranker からの重み付け値の合計に等しいことを示します。
-
-
-
-
order_by_fields (OrderByFields) -
検索結果の並び順に使用する fields です。オプションです。
RETURNS Promise<SearchResults<T>>
このメソッドは、SearchResults<T> オブジェクトに解決される promise を返します。
{
results: SearchResultData[] | SearchResultData[][],
recalls: number[],
session_ts: number,
collection_name: string,
all_search_count?: number,
status: ResStatus
}
PARAMETERS:
-
results (SearchResultData[] | SearchResultData[][]) -
各クエリ vector に対して返されたヒットです。単一のクエリ vector が指定された場合、これはフラットな SearchResultData[] です。クエリ vector のバッチが指定された場合、これはクエリごとに 1 つの内部リストを持つネストされた SearchResultData[][] です。-
id (string) -
一致した行の primary key です。
-
score (number) -
設定された metric type によってスケーリングされた類似度スコアです。
-
offset (number | string) -
クエリ group 内におけるこのヒットの 0 ベースのオフセットです。
-
group_by_field_values (Record<string, FieldData>) -
group_by_field が指定された場合に設定され、このヒットのグループ化 field の値を保持します。
-
highlight (HighlightResult) -
リクエストで highlighter が指定された場合に設定され、一致する fields のハイライトされた断片を保持します。
-
<output_field> (FieldData) -
リクエストされた各 output_fields エントリはヒット上のキーとして追加され、一致した行の値を保持します。
-
-
recalls (number[]) -
検索エンジンが生成した場合の、各クエリに対する推定再現率スコアです。 -
session_ts (number) -
検索の評価に Milvus が使用したセッションタイムスタンプです。 -
collection_name (string) -
検索された collection です。 -
all_search_count (number) -
オプションです。検索で調査した候補総数が報告される場合に設定されます。 -
ResStatus
ResStatus オブジェクトです。-
code (number) -
操作結果を示すコードです。この操作が成功した場合は 0 のままです。
-
error_code (string | number) -
発生したエラーを示すエラーコードです。この操作が成功した場合は Success のままです。
-
reason (string) -
報告されたエラーの理由を示す理由です。この操作が成功した場合は空文字列のままです。
-
Example
const milvusClient = new MilvusClient({
address: 'YOUR_CLUSTER_ENDPOINT',
token: 'YOUR_CLUSTER_TOKEN',
});
const searchResults = await milvusClient.search({
collection_name: 'my_collection',
vector: [1, 2, 3, 4],
});