検索 (V2)
この操作は、オプションのスカラー フィルタリング式を使用してベクトル類似検索を実行します。
https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530
- serving clusters を使用している場合は、cluster endpoint を使用します。
Free & Serverless
https://{cluster-id}.serverless.{region}.vectordb.zillizcloud.comDedicated
https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530
${CLUSTER_ENDPOINT}を、あなたのZilliz Cloudクラスターのエンドポイントに置き換える必要があります。- エンドポイントを取得するには、Describe Cluster V2 APIを使用してレスポンスから値を抽出してください。
export CLUSTER_ENDPOINT="https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530"
認証トークンは、適切な権限を持つ API key または username:password のようにコロンで連結した username と password の組み合わせである必要があります。project endpoint を使用している場合は、十分な権限を持つ有効な API key のみが使用できます。
データベースの名前。
この操作が適用される collection の名前。
ベクトル埋め込みのリスト。
Zilliz Cloud は、指定されたベクトル埋め込みに最も類似したベクトル埋め込みを検索します。
このパラメータは ids と同時に指定できません。
ベクトル埋め込み
主キーのリスト。
Zilliz Cloud は、指定されたエンティティ内のベクトル埋め込みに最も類似したベクトル埋め込みを検索します。
このパラメータは data と同時に指定できません。
ベクトル フィールドの名前。
検索の一致対象を見つけるために使用するフィルタ。
検索結果を指定したフィールドでグループ化し、多様性を確保して同じグループから複数の結果が返されることを防ぎます。
各グループについて返すエンティティ数。このパラメータは、groupingField が指定されている場合にのみ有効です。
各グループについて top k エンティティのみを返すかどうか。このパラメータは、groupingField が指定されている場合にのみ有効です。
返されるエンティティの総数。 このパラメータは param 内の offset と組み合わせて使用し、ページネーションを有効にできます。 この値と param 内の offset の合計は 16,384 未満である必要があります。
検索結果でスキップするレコード数。 このパラメータは limit と組み合わせて使用し、ページネーションを有効にできます。 この値と limit の合計は 16,384 未満である必要があります。
検索結果とともに返すフィールドの配列。
フィールド名
この操作に固有のパラメータ設定。
現在の検索に適用される metric type の名前。値は対象 collection の metric type と同じである必要があります。
追加の検索パラメータ。
最小類似度のしきい値を決定します。metric_type を L2 に設定する場合、この値は range_filter の値より大きくする必要があります。それ以外の場合、この値は range_filter の値より小さくする必要があります。
特定の類似度範囲内のベクトルに検索を絞り込みます。metric_type を IP または COSINE に設定する場合、この値は radius の値より大きくする必要があります。それ以外の場合、この値は radius の値より小さくする必要があります。
この操作が適用される partitions の名前。このパラメータを設定すると、検索は指定した partitions 内で実行されます。設定しない場合、検索は collection 内のすべての partitions を対象に実行されます。
partition 名。
検索操作の一貫性レベル。値は対象 collection の一貫性レベルと同じである必要があります。
filter パラメータに埋め戻してフィルタ テンプレートを有効にできるキーと値のペアのセット。詳細については、Filter Templating を参照してください。
現在の検索リクエストに対する function 設定。
適用する function の名前。
適用する function の説明。
適用する function のタイプ。
function の入力として使用するスカラー フィールドのリスト。
function の入力として使用するスカラー フィールド。
function の出力として使用するベクトル フィールドのリスト。
function の出力として使用するベクトル フィールド。
キーと値のペアによる function の追加パラメータ。
キーと値のペアによる検索の追加パラメータ。
export TOKEN="db_admin:xxxxxxxxxxxxx"
curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/entities/search" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
"collectionName": "quick_setup",
"data": [
[
0.3580376395471989,
-0.6023495712049978,
0.18414012509913835,
-0.26286205330961354,
0.9029438446296592
]
],
"annsField": "vector",
"limit": 3,
"outputFields": [
"color"
]
}'
検索結果を返します。
レスポンス コード。
この操作のコスト。これは free および serverless clusters にのみ適用され、現在のリクエストの vCU 使用量を示します。
エンティティ オブジェクトのリスト。
エンティティ オブジェクト。
各検索結果グループの再現率の値。
各クエリ ベクトルに対して返される top-K 結果の数。
デプロイメントが tiered storage を使用し、usage tracking が有効で、かつ操作で remote/disk storage から読み取る場合に返されます。すべてのデータが local cache から提供される場合は省略されます。
デプロイメントが tiered storage を使用し、usage tracking が有効で、かつ操作で remote/disk storage から読み取る場合に返されます。すべてのデータが local cache から提供される場合は省略されます。
デプロイメントが tiered storage を使用し、usage tracking が有効で、かつ操作で remote/disk storage から読み取る場合に返されます。すべてのデータが local cache から提供される場合は省略されます。
エラー メッセージを返します。
レスポンス コード。
エラー メッセージ。
{
"code": 0,
"data": [
{
"color": "orange_6781",
"distance": 1,
"id": 448300048035776800
},
{
"color": "red_4794",
"distance": 0.9353201,
"id": 448300048035776800
},
{
"color": "grey_8510",
"distance": 0.7733054,
"id": 448300048035776800
}
]
}