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

クエリ (V1)

ノート

コレクション内のスカラー フィールドに対してクエリを実行します。

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

https://${CLUSTER_ENDPOINT}

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

認証トークンには、適切な権限を持つ API key または username:password のようにコロンで結合したユーザー名とパスワードのペアを使用する必要があります。

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

データベースの名前。

collectionNamestring必要

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

partitionNamesarray

この操作が適用されるパーティションの名前。

[]partitionNamesstring

PartitionName

filterstring必要

クエリの一致結果を見つけるために使用するフィルター。

limitinteger

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

値の範囲： ≥ 1≤ 16384
offsetinteger

検索結果でスキップするエンティティ数。
この値と limit の値の合計は 16384 未満である必要があります。

値の範囲： 0≤ 16384
outputFieldsarray

検索結果とともに返すフィールドの配列。これを count(*) に設定する場合、フィルターに一致するエンティティの総数を取得するには limit を 0 に設定する必要があります。

[]outputFieldsstring

出力フィールド名。

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v1/vector/query" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "medium_articles",
    "outputFields": [
        "id",
        "title",
        "link"
    ],
    "filter": "id in [443300716234671427, 443300716234671426]",
    "limit": 100,
    "offset": 0
}'
レスポンス200 OK - application/json

クエリ結果を返します。

codeinteger

レスポンスコード。

dataarray

指定された出力フィールドとそれに対応する値を含むオブジェクトの配列であるレスポンス ペイロード。

[]dataobject

指定された出力フィールドとそれに対応する値を含むオブジェクトであるレスポンス ペイロード。

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 200,
    "data": [
        {
            "color": "red_7025",
            "id": 1
        },
        {
            "color": "red_4794",
            "id": 4
        },
        {
            "color": "red_9392",
            "id": 6
        }
    ]
}
Ctrl I