Collection の詳細取得 (V2)
コレクションの詳細を取得します。
https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530
- サービングクラスターを使用している場合は、クラスターエンドポイントを使用してください。
Free & Serverless
https://{cluster-id}.serverless.{region}.vectordb.zillizcloud.comDedicated
https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530
${CLUSTER_ENDPOINT}を、あなたのZilliz Cloudクラスターのエンドポイントに置き換える必要があります。- エンドポイントを取得するには、Describe Cluster V2 APIを使用してレスポンスから値を抽出してください。
export CLUSTER_ENDPOINT="https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530"
認証トークンは、適切な権限を持つ API key または username:password のようにコロンで連結した username と password の組み合わせである必要があります。project endpoint を使用している場合は、十分な権限を持つ有効な API key のみ使用できます。
collection が属する database の名前です。存在しない database に設定するとエラーになります。指定しない場合は、default database が適用されます。
対象の collection の名前です。 存在しない collection に設定するとエラーになります。
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"
}'
指定したコレクションの詳細を返します。
レスポンスコード。
指定したコレクションの詳細情報を含むレスポンスペイロード。
コレクションに割り当てられたエイリアスのリスト。
コレクションのエイリアス。
このコレクションの主キーが自動的にインクリメントされるかどうか。
作成時にコレクションに割り当てられる ID。
現在のコレクションの名前。
現在のコレクションの整合性レベル。
コレクションの説明。
$meta という名前の予約済み動的フィールドを有効にして、スキーマで定義されていないフィールドとその値をキーと値のペアとして保存するかどうか。
このコレクションが external collection の場合の、JSON エンコードされた外部ソース設定。Zilliz Cloud volume 内の object url が適用されます。
このコレクションが external collection の場合の、JSON エンコードされた external specification です。このフィールドの内容は connector type やソースデータ形式によって異なり、ファイル形式、フィールドマッピングなどが含まれる場合がありますが、それらに限定されません。
配列内のコレクションフィールド
フィールドオブジェクト。
現在のフィールドの名前。
現在のフィールドが主キーかどうかを示します。
現在のフィールドがパーティションキーかどうかを示します。
現在のフィールドが自動生成 ID かどうかを示します。
現在のフィールドの説明。
現在のフィールドが null 値を許可するかどうかを示します。
現在のフィールドのデフォルト値です。この値は、デフォルト値を持つフィールドでのみ使用できます。
現在のフィールドが関数の派生フィールドかどうかを示します。この値は、関数から派生したフィールドでのみ使用できます。
現在のフィールドのデータ型。
現在のフィールドの一意識別子。
現在のフィールドのパラメータです。この値は、パラメータを持つフィールドでのみ使用できます。
現在のフィールド内の要素のデータ型です。この値は、配列であるフィールドでのみ使用できます。
配列内のコレクション関数
関数オブジェクト。
現在の関数の名前。
現在の関数の説明。
現在の関数のタイプ。
現在の関数の ID。
現在の関数の入力フィールド名。
入力フィールドの名前。
現在の関数の出力フィールド名。
出力フィールドの名前。
現在の関数のパラメータ。
配列内の作成済みインデックス
インデックスオブジェクト。
現在のインデックスの名前。
現在のインデックスに関連付けられたフィールドの名前。
現在のインデックスの metric type。
現在のコレクションのロード状態。
コレクション内のパーティション数。
配列内の追加のコレクションプロパティ。
キーと値のペアからなるコレクションプロパティオブジェクト。
プロパティ名
The property value.
コレクション内の struct array フィールド。
struct array フィールドの詳細。
struct array フィールドの名前。
struct array フィールドの一意の識別子。
struct array フィールドの説明。
フィールドのデータ型。
ネストされたサブフィールドです。各 type は struct フィールドのスカラーまたはベクトルタイプです。
struct array 内のサブフィールドの詳細。
サブフィールドの名前。
サブフィールドの一意の識別子。
struct フィールドのスカラーまたはベクトルタイプ。
要素タイプのパラメータ。
追加のフィールドパラメータ。
エラーメッセージを返します。
レスポンスコード。
エラーメッセージ。
{
"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": []
}
}
{
"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": []
}
}