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

Query (V2)

この操作は、指定されたブール式を使用してスカラーフィールドのフィルタリングを実行します。

POST/v2/vectordb/entities/query
接続エンドポイント

https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530

📘ノート
  • サービングクラスターを使用している場合は、クラスターエンドポイントを使用してください。

    • Free & Serverless

      https://{cluster-id}.serverless.{region}.vectordb.zillizcloud.com

    • Dedicated

      https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530

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

認証トークンは、適切な権限を持つAPIキー、またはユーザー名とパスワードをコロンで連結したペア（username:passwordなど）である必要があります。プロジェクトエンドポイントを使用する場合、十分な権限を持つ有効なAPIキーのみが適用されます。

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

データベースの名前。

collectionNamestring必要

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

filterstring

検索で一致するエンティティを見つけるために使用するフィルター。

outputFieldsarray

クエリ結果とともに返すフィールドの配列。

[]outputFieldsstring

出力フィールド名。

partitionNamesarray

この操作の対象となるパーティションの名前。このパラメーターを設定すると、操作は指定したパーティションに限定されます。設定しない場合、操作はコレクション内のすべてのパーティションに適用されます。

[]partitionNamesstring

パーティション名。

limitinteger

返すエンティティの総数。 ページネーションを有効にするには、このパラメーターを param 内の offset と組み合わせて使用できます。 この値と param 内の offset の合計は 16,384 未満である必要があります。

offsetinteger

検索結果でスキップするレコード数。 このパラメーターは limit と組み合わせてページネーションを有効にするために使用できます。 この値と limit の合計は 16,384 未満である必要があります。

exprParamsobject

パラメーター化されたフィルター式の式テンプレートパラメーター値。

consistencyLevelstring

整合性レベル。指定可能な値は Strong、Session、Bounded、Eventually です。

orderByFieldsarray

クエリ結果の並べ替えに使用するスカラーフィールド。各項目は、フィールド名、fieldName:asc、またはfieldName:descです。既定の並べ替え方向は昇順です。

[]orderByFieldsstring

スカラーフィールドと任意の並べ替え方向。

値の例： word_count:desc
bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/entities/query" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "quick_setup",
    "filter": "color like \"red_%\"",
    "outputFields": [
        "color"
    ],
    "limit": 3,
    "orderByFields": [
        "color:asc"
    ]
}'
レスポンス200 OK - application/json

クエリされたエンティティを表す辞書のリスト。

codeinteger

レスポンスコード。

costinteger

この操作のコスト。これは Free および Serverless クラスターにのみ適用され、現在のリクエストの vCU 使用量を示します。

dataarray

クエリされたエンティティを表す辞書のリスト。

[]dataobject

エンティティオブジェクト。

scanned_remote_bytesinteger

デプロイメントで使用状況の追跡が有効な階層型ストレージを使用し、操作がリモート/diskストレージから読み取る場合に返されます。すべてのデータがローカルキャッシュから提供される場合は省略されます。

scanned_total_bytesinteger

デプロイメントで使用状況の追跡が有効な階層型ストレージを使用し、操作がリモート/diskストレージから読み取る場合に返されます。すべてのデータがローカルキャッシュから提供される場合は省略されます。

cache_hit_rationumber

デプロイメントで使用状況の追跡が有効な階層型ストレージを使用し、操作がリモート/diskストレージから読み取る場合に返されます。すべてのデータがローカルキャッシュから提供される場合は省略されます。

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

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