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

Search (V1)

ノート

コレクション内のベクトルフィールドに対して類似性検索を実行します。

POST/v1/vector/search
接続エンドポイント

https://${CLUSTER_ENDPOINT}

📘ノート
  • ${CLUSTER_ENDPOINT} を、あなたのZilliz Cloudクラスターのエンドポイントに置き換える必要があります。
  • エンドポイントを取得するには、Describe Cluster APIを使用してレスポンスから値を抽出してください。
shell
export CLUSTER_ENDPOINT=""
パラメータ
Authorizationstringheader必要

認証トークンは、適切な権限を持つAPIキー、またはコロンで連結したユーザー名とパスワードのペア(例: username:password)である必要があります。

値の例: Bearer {{TOKEN}}
リクエスト・ボディ
dbNamestring

データベースの名前。

collectionNamestring必要

この操作の対象となるコレクションの名前。

partitionNamesarray

この操作の対象となるパーティションの名前。このパラメーターを設定すると、検索範囲が指定したパーティションに限定されます。指定しない場合、検索範囲はコレクション全体です。

[]partitionNamesstring

partitionName

filterstring

検索に一致する結果を見つけるために使用するフィルター。

limitinteger

返すエンティティの最大数。 この値とoffsetの値の合計は、16,384 未満である必要があります。

値の範囲: ≥ 1≤ 16384
offsetinteger

検索結果でスキップするエンティティの数。
この値とlimitの値の合計は、16,384 を超えてはなりません。

値の範囲: 0≤ 16384
outputFieldsarray

検索結果とともに返すフィールドの配列。

[]outputFieldsstring

出力フィールド名。

vectorarray必要

浮動小数点数のリスト形式のクエリベクトル。クエリベクトルの長さは、コレクション内のベクトルフィールドの次元と一致している必要があります。

[]vectornumber<float32>

検索対象のベクトルの次元の1つを表す浮動小数点数。

paramsobject

検索パラメーターのリスト。

radiusnumber<float64>

類似度が最も低いベクトルが位置する角度。

range_filternumber<float64>必要

クエリベクトルに対する類似度が特定の範囲に収まるベクトルフィールドの値をフィルタリングするために、組み合わせて使用します。

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v1/vector/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"
]
}'
レスポンス

検索結果を返します。

codeinteger

レスポンスコード。

dataarray

検索結果を含むレスポンスペイロード。

[]dataobject

検索結果。デフォルトでは、各エンティティオブジェクトはidフィールドとdistanceフィールドを保持します。outputFieldsが指定されている場合、エンティティオブジェクトは指定されたフィールドも保持します。

idinteger

エンティティのID。

distancenumber<float32>

クエリベクトルに対するエンティティの類似度スコア。

エラーメッセージを返します。

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
"code": 200,
"data": [
{
"color": "pink_8682",
"distance": 1,
"id": 0
},
{
"color": "red_7025",
"distance": 0.6290165,
"id": 1
},
{
"color": "red_4794",
"distance": 0.5975797,
"id": 4
}
]
}
Ctrl I