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

取得 (V1)

ノート

指定した ID によってエンティティを取得します。以下の 4 種類のリクエストボディに示すように、ID には文字列または整数を設定でき、文字列のリストまたは整数のリストとして複数の ID を設定することもできます。

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

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

パーティション名。

outputFieldsarray

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

[]outputFieldsstring

フィールド名。

idoneOf必要
(近日追加予定)
string

取得対象のエンティティの ID

取得対象のエンティティの ID 配列

integer

取得対象のエンティティの ID

取得対象のエンティティの ID 配列

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v1/vector/get" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "quick_setup",
    "id": [
        1,
        3,
        5
    ],
    "outputFields": [
        "color"
    ]
}'
レスポンス200 OK - application/json

クエリ結果を返します。

codeinteger

レスポンスコード。

dataarray

クエリ結果。

[]dataobject

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

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 200,
    "data": [
        {
            "color": "red_7025",
            "id": 1
        },
        {
            "color": "pink_9298",
            "id": 3
        },
        {
            "color": "yellow_4222",
            "id": 5
        }
    ]
}
Ctrl I