Collection の詳細取得 (V2)

コレクションの詳細を取得します。

POST/v2/vectordb/collections/describe

接続エンドポイント

クラスターエンドポイントプロジェクトエンドポイント（オンデマンド）

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 key または username:password のようにコロンで連結した username と password の組み合わせである必要があります。project endpoint を使用している場合は、十分な権限を持つ有効な API key のみ使用できます。

値の例： Bearer {{TOKEN}}

リクエスト・ボディapplication/json

dbNamestring

collection が属する database の名前です。存在しない database に設定するとエラーになります。指定しない場合は、default database が適用されます。

collectionNamestring必要

対象の collection の名前です。存在しない collection に設定するとエラーになります。

partitionNamesarray

この操作の対象となる partition の名前。指定すると操作範囲がこれらの partition に限定され、指定しない場合は Collection 全体が対象になります。

[]partitionNamesstring

この操作の対象となる partition の名前。partition を指定すると操作範囲がそれらに限定され、指定しない場合は Collection 全体が対象になります。

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/describe" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "test_collection"
}'

レスポンス200 OK - application/json

指定したコレクションの詳細を返します。

Success

Collection の記述に成功したときに返されるレスポンスです。

codeinteger

レスポンスコード。

値の例： 0

dataobject

指定したコレクションの詳細情報を含むレスポンスペイロード。

aliasesarray

コレクションに割り当てられたエイリアスのリスト。

[]aliasesstring

コレクションのエイリアス。

autoIDboolean

このコレクションの主キーが自動的にインクリメントされるかどうか。

collectionIDinteger<int64>

作成時にコレクションに割り当てられる ID。

collectionNamestring

現在のコレクションの名前。

consistencyLevelstring

現在のコレクションの整合性レベル。

可能な値：

descriptionstring

コレクションの説明。

enableDynamicFieldboolean

$meta という名前の予約済み動的フィールドを有効にして、スキーマで定義されていないフィールドとその値をキーと値のペアとして保存するかどうか。

externalSourcestring

このコレクションが external collection の場合の、JSON エンコードされた外部ソース設定。Zilliz Cloud volume 内の object url が適用されます。

externalSpecstring

このコレクションが external collection の場合の、JSON エンコードされた external specification です。このフィールドの内容は connector type やソースデータ形式によって異なり、ファイル形式、フィールドマッピングなどが含まれる場合がありますが、それらに限定されません。

fieldsarray

配列内のコレクションフィールド

[]fieldsobject

フィールドオブジェクト。

namestring

現在のフィールドの名前。

primaryKeyboolean

現在のフィールドが主キーかどうかを示します。

partitionKeyboolean

現在のフィールドがパーティションキーかどうかを示します。

autoIdboolean

現在のフィールドが自動生成 ID かどうかを示します。

descriptionstring

現在のフィールドの説明。

nullableboolean

現在のフィールドが null 値を許可するかどうかを示します。

defaultValuestring

現在のフィールドのデフォルト値です。この値は、デフォルト値を持つフィールドでのみ使用できます。

isFunctionOutputboolean

現在のフィールドが関数の派生フィールドかどうかを示します。この値は、関数から派生したフィールドでのみ使用できます。

typestring

現在のフィールドのデータ型。

idstring

現在のフィールドの一意識別子。

paramsobject

現在のフィールドのパラメータです。この値は、パラメータを持つフィールドでのみ使用できます。

elementTypestring

現在のフィールド内の要素のデータ型です。この値は、配列であるフィールドでのみ使用できます。

functionsarray

配列内のコレクション関数

[]functionsobject

関数オブジェクト。

namestring

現在の関数の名前。

descriptionstring

現在の関数の説明。

typestring

現在の関数のタイプ。

idstring

現在の関数の ID。

inputFieldNamesarray

現在の関数の入力フィールド名。

[]inputFieldNamesstring

入力フィールドの名前。

outputFieldNamesarray

現在の関数の出力フィールド名。

[]outputFieldNamesstring

出力フィールドの名前。

paramsobject

現在の関数のパラメータ。

indexesarray

配列内の作成済みインデックス

[]indexesobject

インデックスオブジェクト。

indexNamestring

現在のインデックスの名前。

fieldNamestring

現在のインデックスに関連付けられたフィールドの名前。

metricTypestring

現在のインデックスの metric type。

loadstring

現在のコレクションのロード状態。

partitionsNuminteger

コレクション内のパーティション数。

propertiesarray

配列内の追加のコレクションプロパティ。

[]propertiesobject

キーと値のペアからなるコレクションプロパティオブジェクト。

keystring

プロパティ名

valuestring

The property value.

structFieldsarray

コレクション内の struct array フィールド。

[]structFieldsobject

struct array フィールドの詳細。

namestring

struct array フィールドの名前。

idstring

struct array フィールドの一意の識別子。

descriptionstring

struct array フィールドの説明。

typestring

フィールドのデータ型。

可能な値：

fieldsarray

ネストされたサブフィールドです。各 type は struct フィールドのスカラーまたはベクトルタイプです。

[]fieldsobject

struct array 内のサブフィールドの詳細。

namestring

サブフィールドの名前。

idstring

サブフィールドの一意の識別子。

typestring

struct フィールドのスカラーまたはベクトルタイプ。

可能な値：

paramsarray

要素タイプのパラメータ。

[]paramsobject

サブフィールドの追加パラメータをキーと値のペアで 1 つ指定します。

keystring

追加パラメータの名前。value と組み合わせて 1 つのキーと値のペアを構成します。

valuestring

key で指定されたパラメータに設定する値。

paramsarray

追加のフィールドパラメータ。

[]paramsobject

struct 配列フィールドの追加パラメータをキーと値のペアで 1 つ指定します。

keystring

追加パラメータの名前。value と組み合わせて 1 つのキーと値のペアを構成します。

valuestring

key で指定されたパラメータに設定する値。

Failure

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Managed Collection

json
{
    "code": 0,
    "data": {
        "aliases": [],
        "autoId": false,
        "collectionID": 448707763883002000,
        "collectionName": "test_collection",
        "consistencyLevel": "Bounded",
        "description": "",
        "enableDynamicField": true,
        "fields": [
            {
                "autoId": false,
                "description": "",
                "id": 100,
                "name": "id",
                "partitionKey": false,
                "primaryKey": true,
                "type": "Int64"
            },
            {
                "autoId": false,
                "description": "",
                "id": 101,
                "name": "vector",
                "params": [
                    {
                        "key": "dim",
                        "value": "5"
                    }
                ],
                "partitionKey": false,
                "primaryKey": false,
                "type": "FloatVector"
            }
        ],
        "indexes": [
            {
                "fieldName": "vector",
                "indexName": "vector",
                "metricType": "COSINE"
            }
        ],
        "load": "LoadStateLoaded",
        "partitionsNum": 1,
        "properties": []
    }
}

External Collection

json
{
    "code": 0,
    "data": {
        "aliases": [],
        "autoId": false,
        "collectionID": 448707763883002000,
        "collectionName": "test_collection",
        "consistencyLevel": "Bounded",
        "description": "",
        "enableDynamicField": true,
        "externalSource": "volume://volume-vdc/demo_lance/",
        "externalSpec": "{\"format\":\"lance-table\"}",
        "fields": [
            {
                "autoId": false,
                "description": "",
                "id": 100,
                "name": "id",
                "partitionKey": false,
                "primaryKey": true,
                "type": "Int64"
            },
            {
                "autoId": false,
                "description": "",
                "id": 101,
                "name": "vector",
                "params": [
                    {
                        "key": "dim",
                        "value": "5"
                    }
                ],
                "partitionKey": false,
                "primaryKey": false,
                "type": "FloatVector"
            }
        ],
        "indexes": [
            {
                "fieldName": "vector",
                "indexName": "vector",
                "metricType": "COSINE"
            }
        ],
        "load": "LoadStateLoaded",
        "partitionsNum": 1,
        "properties": []
    }
}