CreateCollectionRequest

@Serializable
data class CreateCollectionRequest(val vectors: VectorsConfig? = null, val sparseVectors: Map<String, SparseVectorParams>? = null, val hnswConfig: HnswConfig? = null, val onDiskPayload: Boolean? = null, val shardNumber: Int? = null, val replicationFactor: Int? = null, val optimizersConfig: OptimizersConfig? = null, val quantizationConfig: QuantizationConfig? = null)

Request body for PUT /collections/{name}.

Models the collection settings used day-to-day. Advanced options (optimizers, quantization, WAL) are not yet exposed; unknown fields are ignored, so the model can grow without breaking callers.

Constructors

Link copied to clipboard
constructor(vectors: VectorsConfig? = null, sparseVectors: Map<String, SparseVectorParams>? = null, hnswConfig: HnswConfig? = null, onDiskPayload: Boolean? = null, shardNumber: Int? = null, replicationFactor: Int? = null, optimizersConfig: OptimizersConfig? = null, quantizationConfig: QuantizationConfig? = null)

Properties

Link copied to clipboard
@SerialName(value = "hnsw_config")
val hnswConfig: HnswConfig?
Link copied to clipboard
@SerialName(value = "on_disk_payload")
val onDiskPayload: Boolean?

Store payloads on disk instead of RAM (distinct from vector/HNSW on-disk settings).

Link copied to clipboard
@SerialName(value = "optimizers_config")
val optimizersConfig: OptimizersConfig?
Link copied to clipboard
@SerialName(value = "quantization_config")
val quantizationConfig: QuantizationConfig?
Link copied to clipboard
@SerialName(value = "replication_factor")
val replicationFactor: Int?
Link copied to clipboard
@SerialName(value = "shard_number")
val shardNumber: Int?
Link copied to clipboard
@SerialName(value = "sparse_vectors")
val sparseVectors: Map<String, SparseVectorParams>?

Named sparse vectors, keyed by name.

Link copied to clipboard
@SerialName(value = "vectors")
val vectors: VectorsConfig?

Dense / named-dense vectors; may be null for a sparse-only collection.