コレクションを作成 (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 を定義します。collectionName と dimension は必須です。
データベースの名前。
作成するコレクションの名前。
ベクトル値が持つべき次元数。 このフィールドの idType が FloatVector または BinaryVector に設定されている場合に必須です。
この操作に適用される metric type。
primary field のデータ型。このパラメーターはコレクションのクイックセットアップ用に設計されており、schema が定義されている場合は無視されます。
primary field を自動インクリメントするかどうか。このパラメーターはコレクションのクイックセットアップ用に設計されており、schema が定義されている場合は無視されます。
primary field の名前。このパラメーターはコレクションのクイックセットアップ用に設計されており、schema が定義されている場合は無視されます。
vector field の名前。このパラメーターはコレクションのクイックセットアップ用に設計されており、schema が定義されている場合は無視されます。
現在のコレクションの説明。
コレクションの追加パラメーター。
primary field に許可される最大バイト数。このパラメーターは、primary field が文字列フィールドである場合にのみ使用できます。
dynamic field 機能を有効にするかどうか。
コレクションの整合性レベル。
コレクションの time-to-live (TTL) 期間。設定した場合、期間終了後にコレクションは削除されます。
コレクションに対して memory mapping を有効にするかどうかを指定します。
TTL ベースの期限切れに使用するフィールドの名前。
ロード時に scalar field データをメモリへ事前ロードするかどうか。
ロード時に scalar index データをメモリへ事前ロードするかどうか。
ロード時に vector field データをメモリへ事前ロードするかどうか。
ロード時に vector index データをメモリへ事前ロードするかどうか。
この設定で記述される Collection に適用される整合性レベル。Collection をクエリする際に使用される整合性保証を決定します。
Collection の追加プロパティです。Collection に追加の設定を指定するために使用します。
クイックセットアップで作成される Collection のベクトルフィールドに使用するベクトルデータ型。
設定を明示的に指定する Collection セットアップ。必須の collectionName を含みます。
データベースの名前。
作成するコレクションの名前。
schema は対象コレクション内のデータを整理する役割を担います。有効な schema には複数のフィールドが必要であり、primary key、vector field、および複数の scalar field を含める必要があります。このパラメーターを設定すると、dimension、idType、autoID、primaryFieldName、vectorFieldName は無視されます。
primary field の自動インクリメントを許可するかどうか。これを True に設定すると、primary field は自動インクリメントされます。この場合、エラーを避けるため、挿入するデータに primary field を含めないでください。このパラメーターは、is_primary が True に設定されているフィールドで設定してください。
予約済みの $meta フィールドを使用して、schema で定義されていないフィールドをキーと値のペアで保持できるようにするかどうか。
フィールドオブジェクトのリスト。
フィールド schema オブジェクト。
対象コレクションに作成するフィールドの名前
フィールド値のデータ型です。
配列フィールド内の要素のデータ型です。現在のフィールドが配列型の場合は必須です。
フィールドで null を許可するかどうかです。true に設定すると、フィールドに null 値を含めることができます。
フィールドのデフォルト値。現在のフィールドが VarChar 型の場合に必須です。
現在のフィールドが主フィールドかどうかです。これを True に設定すると、現在のフィールドが主フィールドになります。
現在のフィールドが partition key として機能するかどうか。これを True に設定すると、現在のフィールドが partition key として機能します。この場合、Zilliz Cloud が現在のコレクション内のすべての partition を管理します。
フィールドの追加パラメータです。
現在のフィールドにおける値の最大長を決定する、VarChar 値用のオプションパラメータです。
ベクトル次元を決定する、FloatVector または BinaryVector フィールド用のオプションパラメータです。
現在の配列フィールド内の要素の最大数を決定する、Array フィールド値用のオプションパラメータです。
関数のリスト。
関数 schema オブジェクト。
作成する function の名前。
作成する function の説明。
作成する function のタイプ。
作成する function の入力フィールド名。
フィールド名。
作成する function の出力フィールド名。
フィールド名。
現在の function に固有の構成パラメータ。function type が BM25 に設定されている場合、パラメータは不要です。TEXTEMBEDDING または RERANK の function に適用可能なパラメータについては、Embedding Functions および Reranking Functions を参照してください。
struct array フィールドのリスト。
複数のサブフィールドをグループ化する struct array フィールド。
struct array フィールドの名前。
struct array フィールドの説明。
struct array 内のサブフィールドです。各 dataType は struct フィールドのスカラーまたはベクトルタイプを指します。
struct array 内のサブフィールド定義です。dataType は各 struct フィールドのスカラーまたはベクトルタイプを指します。
サブフィールドの名前。
struct フィールドのスカラーまたはベクトルタイプ。
要素タイプのパラメータ。たとえば、VarChar の場合は max_length、ベクトルタイプの場合は dim を指定します。
struct array フィールドのパラメータです。max_capacity は必須で、エンティティごとに許可される struct 要素の最大数を指定します。
エンティティごとに許可される struct 要素の最大数。
インデックス構築プロセスに適用されるパラメータです。
インデックス Schema オブジェクトです。
インデックスの構築に使用する類似度メトリックのタイプです。詳細については、Similarity Metrics Explained](/docs/search-metrics-explained) を参照してください。
インデックスを作成する対象フィールドの名前です。
作成するインデックスの名前です。デフォルトでは対象フィールド名が使用されます。
インデックスタイプおよび関連設定です。Zilliz Cloud クラスターでは、index_type を常に AUTOINDEX に設定する必要があります。
作成するインデックスのタイプです
collection の追加パラメータです。
collection の一貫性レベルです。
現在の collection とともに作成するパーティション数です。collection のいずれかのフィールドがパーティションキーとして指定されている場合、このパラメータは必須です。
collection の time-to-live (TTL) 期間です。設定した場合、この期間の終了時に collection は削除されます。
collection に対して partition key isolation を有効にするかどうかを指定します。
collection に対して memory mapping を有効にするかどうかを指定します。
TTL ベースの有効期限に使用するフィールド名です。
ロード時にスカラーフィールドデータをメモリへ事前ロードするかどうかです。
ロード時にスカラーインデックスデータをメモリへ事前ロードするかどうかです。
ロード時にベクトルフィールドデータをメモリへ事前ロードするかどうかです。
ロード時にベクトルインデックスデータをメモリへ事前ロードするかどうかです。
現在の collection の説明です。
この設定で記述される Collection に適用される整合性レベル。Collection をクエリする際に使用される整合性保証を決定します。
キーと値のペアで指定する Collection の追加プロパティ。
既存の外部 Collection を参照する Collection セットアップ。必須の collectionName で識別します。
データベース名です。
作成する collection の名前です。
external collection 用のスキーマです。externalField マッピングを持つフィールドに加えて、externalSource を含める必要があります。externalSpec は省略可能です。milvus:// ソースの場合、省略すると format はデフォルトの milvus-table になります。
primary field の自動インクリメントを許可するかどうか。これを True に設定すると、primary field は自動インクリメントされます。この場合、エラーを避けるため、挿入するデータに primary field を含めないでください。このパラメーターは、is_primary が True に設定されているフィールドで設定してください。
予約済みの $meta フィールドを使用して、schema で定義されていないフィールドをキーと値のペアで保持できるようにするかどうか。
フィールドオブジェクトのリスト。
フィールド schema オブジェクト。
対象コレクションに作成するフィールドの名前
フィールド値のデータ型です。
配列フィールド内の要素のデータ型です。現在のフィールドが配列型の場合は必須です。
フィールドで null を許可するかどうかです。true に設定すると、フィールドに null 値を含めることができます。
フィールドのデフォルト値。現在のフィールドが VarChar 型の場合に必須です。
現在のフィールドが主フィールドかどうかです。これを True に設定すると、現在のフィールドが主フィールドになります。
現在のフィールドが partition key として機能するかどうか。これを True に設定すると、現在のフィールドが partition key として機能します。この場合、Zilliz Cloud が現在のコレクション内のすべての partition を管理します。
フィールドの追加パラメータです。
現在のフィールドにおける値の最大長を決定する、VarChar 値用のオプションパラメータです。
ベクトル次元を決定する、FloatVector または BinaryVector フィールド用のオプションパラメータです。
現在の配列フィールド内の要素の最大数を決定する、Array フィールド値用のオプションパラメータです。
外部ソース内の対応する列の名前。external collection を作成する場合に必須です。
関数のリスト。
関数 schema オブジェクト。
作成する function の名前。
作成する function の説明。
作成する function のタイプ。
作成する function の入力フィールド名。
フィールド名。
作成する function の出力フィールド名。
フィールド名。
現在の function に固有の構成パラメータ。function type が BM25 に設定されている場合、パラメータは不要です。TEXTEMBEDDING または RERANK の function に適用可能なパラメータについては、Embedding Functions および Reranking Functions を参照してください。
外部データソース識別子です。Zilliz Cloud では、externalSource は volume://<volume_name>/<path> と milvus://<instance_id>/<db_name>/<collection_name> の 2 つのスキームを受け付けます。milvus:// スキームは、同じプロジェクトおよびリージョン内の別の Milvus v3.0.x 互換のクラスター上のコレクションを指します。スキームは小文字でなければならず、3 つのセグメント（データベース名としての default を含む）はすべて必須で、末尾に 1 つの / は許容されます。 external collection を作成する場合に必須です。
外部ソースの接続パラメータを記述する JSON エンコード文字列です。format キーは parquet、vortex、lance-table、iceberg-table、および milvus-table を受け付けます。external collection の作成時には省略可能です。milvus:// ソースの場合、省略すると format はデフォルトの milvus-table になります。
struct array フィールドのリスト。
複数のサブフィールドをグループ化する struct array フィールド。
struct array フィールドの名前。
struct array フィールドの説明。
struct array 内のサブフィールドです。各 dataType は struct フィールドのスカラーまたはベクトルタイプを指します。
struct array 内のサブフィールド定義です。dataType は各 struct フィールドのスカラーまたはベクトルタイプを指します。
サブフィールドの名前。
struct フィールドのスカラーまたはベクトルタイプ。
要素タイプのパラメータ。たとえば、VarChar の場合は max_length、ベクトルタイプの場合は dim を指定します。
struct array フィールドのパラメータです。max_capacity は必須で、エンティティごとに許可される struct 要素の最大数を指定します。
エンティティごとに許可される struct 要素の最大数。
インデックス構築プロセスに適用されるパラメーターです。
インデックス Schema オブジェクトです。
インデックスの構築に使用する類似度メトリックのタイプです。詳細については、Similarity Metrics Explained](/docs/search-metrics-explained) を参照してください。
インデックスを作成する対象フィールドの名前です。
作成するインデックスの名前です。デフォルトでは対象フィールド名が使用されます。
インデックスタイプおよび関連設定です。Zilliz Cloud クラスターでは、index_type を常に AUTOINDEX に設定する必要があります。
作成するインデックスのタイプです
コレクションの追加パラメーターです。
collection の一貫性レベルです。
現在の collection とともに作成するパーティション数です。collection のいずれかのフィールドがパーティションキーとして指定されている場合、このパラメータは必須です。
collection の time-to-live (TTL) 期間です。設定した場合、この期間の終了時に collection は削除されます。
collection に対して partition key isolation を有効にするかどうかを指定します。
collection に対して memory mapping を有効にするかどうかを指定します。
TTL ベースの有効期限に使用するフィールド名です。
ロード時にスカラーフィールドデータをメモリへ事前ロードするかどうかです。
ロード時にスカラーインデックスデータをメモリへ事前ロードするかどうかです。
ロード時にベクトルフィールドデータをメモリへ事前ロードするかどうかです。
ロード時にベクトルインデックスデータをメモリへ事前ロードするかどうかです。
現在のコレクションの説明です。
この設定で記述される Collection に適用される整合性レベル。Collection をクエリする際に使用される整合性保証を決定します。
Collection に適用する追加のプロパティ。
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"
}
}'
コレクションオブジェクトを返します。
操作固有の結果データを持たない操作が返す汎用レスポンスエンベロープです。data オブジェクトを含みます。
レスポンスコード。
レスポンスのペイロードオブジェクトです。内容はそれを返す操作によって異なります。
エラーメッセージを返します。
レスポンスコード。
エラーメッセージ。
{
"code": 0,
"data": {}
}