コレクションを作成 (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 のみ使用できます。
データベースの名前。
作成するコレクションの名前。
ベクトル値が持つべき次元数。 このフィールドの 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 データをメモリへ事前ロードするかどうか。
データベースの名前。
作成するコレクションの名前。
schema は対象コレクション内のデータを整理する役割を担います。有効な schema には複数のフィールドが必要であり、primary key、vector field、および複数の scalar field を含める必要があります。このパラメーターを設定すると、dimension、idType、autoID、primaryFieldName、vectorFieldName は無視されます。
インデックス構築プロセスに適用されるパラメータです。
インデックス 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 の名前です。
external collection 用のスキーマです。externalField マッピングを持つフィールドに加えて、externalSource と externalSpec を含める必要があります。
インデックス構築プロセスに適用されるパラメーターです。
インデックス 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 ベースの有効期限に使用するフィールド名です。
ロード時にスカラーフィールドデータをメモリへ事前ロードするかどうかです。
ロード時にスカラーインデックスデータをメモリへ事前ロードするかどうかです。
ロード時にベクトルフィールドデータをメモリへ事前ロードするかどうかです。
ロード時にベクトルインデックスデータをメモリへ事前ロードするかどうかです。
現在のコレクションの説明です。
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": {}
}