コレクションの作成 (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キー、またはコロンで結合されたユーザー名とパスワードのペア(例:username:password)である必要があります。プロジェクトエンドポイントを使用している場合は、十分な権限を持つ有効なAPIキーのみが適用されます。
データベースの名前。
作成するコレクションの名前。
ベクトル値が持つべき次元数。 このフィールドの idType が DataType.FLOAT_VECTOR または DataType.Binary_VECTOR に設定されている場合に必須です。
この操作に適用されるメトリックタイプ。
プライマリフィールドのデータ型。このパラメーターはコレクションのクイックセットアップ用に設計されており、schema が定義されている場合は無視されます。
プライマリフィールドが自動的にインクリメントされるかどうか。このパラメーターはコレクションのクイックセットアップ用に設計されており、schema が定義されている場合は無視されます。
プライマリフィールドの名前。このパラメーターはコレクションのクイックセットアップ用に設計されており、schema が定義されている場合は無視されます。
ベクトルフィールドの名前。このパラメーターはコレクションのクイックセットアップ用に設計されており、schema が定義されている場合は無視されます。
現在のコレクションの説明。
コレクションの追加パラメーター。
プライマリフィールドで許可される最大バイト数。このパラメーターは、プライマリフィールドが文字列フィールドの場合にのみ使用できます。
動的フィールド機能を有効にするかどうか。
コレクションの整合性レベル。
コレクションの有効期間 (TTL)。設定されている場合、期間が終了するとコレクションは削除されます。
コレクションのメモリマッピングを有効にするかどうかを指定します。
TTLベースの有効期限に使用するフィールドの名前。
ロード時にスカラーフィールドデータをメモリにプリロードするかどうか。
ロード時にスカラーインデックスデータをメモリにプリロードするかどうか。
ロード時にベクトルフィールドデータをメモリにプリロードするかどうか。
ロード時にベクトルインデックスデータをメモリにプリロードするかどうか。
データベースの名前。
作成するコレクションの名前。
スキーマは、ターゲットコレクション内のデータを整理する役割を担います。有効なスキーマには複数のフィールドが必要であり、プライマリキー、ベクトルフィールド、およびいくつかのスカラーフィールドを含める必要があります。このパラメーターを設定すると、dimension、idType、autoID、primaryFieldName、および vectorFieldName は無視されます。
インデックス構築プロセスに適用されるパラメータ。
インデックススキーマオブジェクト。
インデックスの構築に使用される類似度メトリクスタイプ。詳細については、Similarity Metrics Explained](/docs/search-metrics-explained) を参照してください。
インデックスを作成する対象フィールドの名前。
作成するインデックスの名前。値はデフォルトで対象フィールド名になります。
インデックスタイプと関連設定。Zilliz Cloud クラスターの場合は、常に index_type を AUTOINDEX に設定する必要があります。
作成するインデックスのタイプ
コレクションの追加パラメータ。
コレクションの整合性レベル。
現在のコレクションとともに作成するパーティションの数。コレクションのいずれかのフィールドがパーティションキーとして指定されている場合、このパラメータは必須です。
コレクションの有効期間(TTL)。設定されている場合、期間終了後にコレクションは削除されます。
コレクションのパーティションキー分離を有効にするかどうかを指定します。
コレクションのメモリマッピングを有効にするかどうかを指定します。
TTL ベースの有効期限に使用するフィールドの名前。
ロード時にスカラーフィールドデータをメモリにプリロードするかどうか。
ロード時にスカラーインデックスデータをメモリにプリロードするかどうか。
ロード時にベクトルフィールドデータをメモリにプリロードするかどうか。
ロード時にベクトルインデックスデータをメモリにプリロードするかどうか。
現在のコレクションの説明。
データベースの名前。
作成するコレクションの名前。
外部コレクションのスキーマ。externalField マッピングを持つフィールドに加えて、externalSource と externalSpec を含める必要があります。
インデックス構築プロセスに適用されるパラメータ。
インデックススキーマオブジェクト。
インデックスの構築に使用される類似度メトリックタイプ。詳細については、類似度メトリクスの説明](/docs/search-metrics-explained) を参照してください。
インデックスを作成する対象フィールドの名前。
作成するインデックスの名前。値はデフォルトで対象フィールド名になります。
インデックスタイプと関連設定。Zilliz Cloud クラスターの場合、常に index_type を AUTOINDEX に設定する必要があります。
作成するインデックスのタイプ
コレクションの追加パラメータ。
コレクションの整合性レベル。
現在のコレクションとともに作成するパーティションの数。コレクションのいずれかのフィールドがパーティションキーとして指定されている場合、このパラメータは必須です。
コレクションの有効期間(TTL)。設定されている場合、期間が終了するとコレクションは削除されます。
コレクションのパーティションキー分離を有効にするかどうかを指定します。
コレクションのメモリマッピングを有効にするかどうかを指定します。
TTL ベースの有効期限に使用するフィールドの名前。
ロード時にスカラーフィールドデータをメモリにプリロードするかどうか。
ロード時にスカラーインデックスデータをメモリにプリロードするかどうか。
ロード時にベクトルフィールドデータをメモリにプリロードするかどうか。
ロード時にベクトルインデックスデータをメモリにプリロードするかどうか。
現在のコレクションの説明。
export TOKEN="db_admin:xxxxxxxxxxxxx"
curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/create" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
"collectionName": "test_collection",
"dimension": 5
}'
export TOKEN="db_admin:xxxxxxxxxxxxx"
curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/create" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
"collectionName": "custom_quick_setup",
"dimension": 5,
"primaryFieldName": "my_id",
"idType": "VarChar",
"vectorFieldName": "my_vector",
"metric_type": "L2",
"autoId": true,
"params": {
"max_length": "512"
}
}'
コレクションオブジェクトを返します。
レスポンスコード。
エラーメッセージを返します。
レスポンスコード。
エラーメッセージ。
{
"code": 0,
"data": {}
}