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

検索 (V1)

ノート

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

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

https://${CLUSTER_ENDPOINT}

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

認証トークンは、適切な権限を持つ API key または username:password のようにコロンで連結した username と password の組である必要があります。

値の例： Bearer {{TOKEN}}
リクエスト・ボディapplication/json
dbNamestring

データベース名。

collectionNamestring必要

この操作が適用されるコレクションの名前。

partitionNamesarray

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

[]partitionNamesstring

partitionName

filterstring

検索の一致を見つけるために使用されるフィルター

limitinteger

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

値の範囲： ≥ 1≤ 16384
offsetinteger

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

値の範囲： 0≤ 16384
outputFieldsarray

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

[]outputFieldsstring

出力フィールド名。

vectorarray必要

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

[]vectornumber<float32>

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

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"
    ]
}'
レスポンス200 OK - application/json

検索結果を返します。

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