メインコンテンツまでスキップ

コレクションの作成 (V2)

この操作は、指定されたクラスターにコレクションを作成します。

POST/v2/vectordb/collections/create
接続エンドポイント

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キー、またはコロンで結合されたユーザー名とパスワードのペア(例:username:password)である必要があります。プロジェクトエンドポイントを使用している場合は、十分な権限を持つ有効なAPIキーのみが適用されます。

値の例: Bearer {{TOKEN}}
リクエスト・ボディ
dbNamestring

データベースの名前。

collectionNamestring必要

作成するコレクションの名前。

dimensioninteger必要

ベクトル値が持つべき次元数。 このフィールドの idTypeDataType.FLOAT_VECTOR または DataType.Binary_VECTOR に設定されている場合に必須です。

metricTypestring

この操作に適用されるメトリックタイプ。

idTypestring

プライマリフィールドのデータ型。このパラメーターはコレクションのクイックセットアップ用に設計されており、schema が定義されている場合は無視されます。

autoIDboolean

プライマリフィールドが自動的にインクリメントされるかどうか。このパラメーターはコレクションのクイックセットアップ用に設計されており、schema が定義されている場合は無視されます。

primaryFieldNamestring

プライマリフィールドの名前。このパラメーターはコレクションのクイックセットアップ用に設計されており、schema が定義されている場合は無視されます。

vectorFieldNamestring

ベクトルフィールドの名前。このパラメーターはコレクションのクイックセットアップ用に設計されており、schema が定義されている場合は無視されます。

descriptionstring

現在のコレクションの説明。

paramsobject

コレクションの追加パラメーター。

max_lengthinteger

プライマリフィールドで許可される最大バイト数。このパラメーターは、プライマリフィールドが文字列フィールドの場合にのみ使用できます。

enableDynamicFieldboolean

動的フィールド機能を有効にするかどうか。

consistencyLevelstring

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

ttlSecondsinteger

コレクションの有効期間 (TTL)。設定されている場合、期間が終了するとコレクションは削除されます。

mmap.enabledboolean

コレクションのメモリマッピングを有効にするかどうかを指定します。

ttlFieldstring

TTLベースの有効期限に使用するフィールドの名前。

warmup.scalarFieldboolean

ロード時にスカラーフィールドデータをメモリにプリロードするかどうか。

warmup.scalarIndexboolean

ロード時にスカラーインデックスデータをメモリにプリロードするかどうか。

warmup.vectorFieldboolean

ロード時にベクトルフィールドデータをメモリにプリロードするかどうか。

warmup.vectorIndexboolean

ロード時にベクトルインデックスデータをメモリにプリロードするかどうか。

dbNamestring

データベースの名前。

collectionNamestring

作成するコレクションの名前。

schemaundefined

スキーマは、ターゲットコレクション内のデータを整理する役割を担います。有効なスキーマには複数のフィールドが必要であり、プライマリキー、ベクトルフィールド、およびいくつかのスカラーフィールドを含める必要があります。このパラメーターを設定すると、dimensionidTypeautoIDprimaryFieldName、および vectorFieldName は無視されます。

indexParamsarray

インデックス構築プロセスに適用されるパラメータ。

[]indexParamsobject

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

metricTypestring必要

インデックスの構築に使用される類似度メトリクスタイプ。詳細については、Similarity Metrics Explained](/docs/search-metrics-explained) を参照してください。

fieldNamestring必要

インデックスを作成する対象フィールドの名前。

indexNamestring必要

作成するインデックスの名前。値はデフォルトで対象フィールド名になります。

paramsobject

インデックスタイプと関連設定。Zilliz Cloud クラスターの場合は、常に index_typeAUTOINDEX に設定する必要があります。

index_typestring必要

作成するインデックスのタイプ

paramsobject

コレクションの追加パラメータ。

consistencyLevelstring

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

partitionsNuminteger

現在のコレクションとともに作成するパーティションの数。コレクションのいずれかのフィールドがパーティションキーとして指定されている場合、このパラメータは必須です。

ttlSecondsinteger

コレクションの有効期間(TTL)。設定されている場合、期間終了後にコレクションは削除されます。

partitionKeyIsolationboolean

コレクションのパーティションキー分離を有効にするかどうかを指定します。

mmap.enabledboolean

コレクションのメモリマッピングを有効にするかどうかを指定します。

ttlFieldstring

TTL ベースの有効期限に使用するフィールドの名前。

warmup.scalarFieldboolean

ロード時にスカラーフィールドデータをメモリにプリロードするかどうか。

warmup.scalarIndexboolean

ロード時にスカラーインデックスデータをメモリにプリロードするかどうか。

warmup.vectorFieldboolean

ロード時にベクトルフィールドデータをメモリにプリロードするかどうか。

warmup.vectorIndexboolean

ロード時にベクトルインデックスデータをメモリにプリロードするかどうか。

descriptionstring

現在のコレクションの説明。

dbNamestring

データベースの名前。

collectionNamestring

作成するコレクションの名前。

schemaundefined

外部コレクションのスキーマ。externalField マッピングを持つフィールドに加えて、externalSource と externalSpec を含める必要があります。

indexParamsarray

インデックス構築プロセスに適用されるパラメータ。

[]indexParamsobject

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

metricTypestring必要

インデックスの構築に使用される類似度メトリックタイプ。詳細については、類似度メトリクスの説明](/docs/search-metrics-explained) を参照してください。

fieldNamestring必要

インデックスを作成する対象フィールドの名前。

indexNamestring必要

作成するインデックスの名前。値はデフォルトで対象フィールド名になります。

paramsobject

インデックスタイプと関連設定。Zilliz Cloud クラスターの場合、常に index_typeAUTOINDEX に設定する必要があります。

index_typestring必要

作成するインデックスのタイプ

paramsobject

コレクションの追加パラメータ。

consistencyLevelstring

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

partitionsNuminteger

現在のコレクションとともに作成するパーティションの数。コレクションのいずれかのフィールドがパーティションキーとして指定されている場合、このパラメータは必須です。

ttlSecondsinteger

コレクションの有効期間(TTL)。設定されている場合、期間が終了するとコレクションは削除されます。

partitionKeyIsolationboolean

コレクションのパーティションキー分離を有効にするかどうかを指定します。

mmap.enabledboolean

コレクションのメモリマッピングを有効にするかどうかを指定します。

ttlFieldstring

TTL ベースの有効期限に使用するフィールドの名前。

warmup.scalarFieldboolean

ロード時にスカラーフィールドデータをメモリにプリロードするかどうか。

warmup.scalarIndexboolean

ロード時にスカラーインデックスデータをメモリにプリロードするかどうか。

warmup.vectorFieldboolean

ロード時にベクトルフィールドデータをメモリにプリロードするかどうか。

warmup.vectorIndexboolean

ロード時にベクトルインデックスデータをメモリにプリロードするかどうか。

descriptionstring

現在のコレクションの説明。

bash
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
}'
bash
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"
}
}'
レスポンス

コレクションオブジェクトを返します。

codeinteger

レスポンスコード。

dataobject

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
"code": 0,
"data": {}
}
Ctrl I