Updates the parameters of the specified collection.

Wait for operation commit timeout in seconds.
If timeout is reached - request will return with service error.

Map of vector data parameters to update for each named vector. To update parameters in a collection having a single unnamed vector, use an empty string as name.

Custom params for Optimizers.  If none - it is left unchanged. This operation is blocking, it will only proceed once all current optimizations are complete

Collection base params. If none - it is left unchanged.

HNSW parameters to update for the collection index. If none - it is left unchanged.

Quantization parameters to update. If none - it is left unchanged.

Map of sparse vector data parameters to update for each sparse vector.

Update collection parameters

List all collections

Delete a collection

BinaryQuantization

BinaryQuantizationConfig

CollectionParamsDiff

Minimal number successful responses from replicas to consider operation successful

Fan-out every read request to these many additional remote nodes (and return first available response)

If true - point's payload will not be stored in memory. It will be read from the disk every time it is requested. This setting saves RAM by (slightly) increasing the response time. Note: those payload values that are involved in filtering and are indexed - remain in RAM.

CompressionRatio

Datatype

Disabled

HnswConfigDiff

Number of edges per node in the index graph. Larger the value - more accurate the search, more space required.

Number of neighbours to consider during the index building. Larger the value - more accurate the search, more time required to build the index.

Number of parallel threads used for background index building. If 0 - automatically select from 8 to 16. Best to keep between 8 and 16 to prevent likelihood of building broken/inefficient HNSW graphs. On small CPUs, less threads are used.

Store HNSW index on disk. If set to false, the index will be stored in RAM. Default: false

Custom M param for additional payload-aware HNSW links. If not set, default M will be used.

If used, include weight modification, which will be applied to sparse vectors at query time: None - no modification (default) Idf - inverse document frequency, based on statistics of the collection

Modifier

OptimizersConfigDiff

The minimal fraction of deleted vectors in a segment, required to perform segment optimization

The minimal number of vectors in a segment, required to perform segment optimization

Maximum size (in kilobytes) of vectors allowed for plain index, exceeding this threshold will enable vector indexing

Default value is 20,000, based on <https://github.com/google-research/google-research/blob/master/scann/docs/algorithms.md>.

To disable vector indexing, set to `0`.

Note: 1kB = 1 vector of size 256.

ProductQuantization

ProductQuantizationConfig

QuantizationConfigDiff

ScalarQuantization

ScalarQuantizationConfig

Quantile for quantization. Expected value range in [0.5, 1.0]. If not set - use the whole range of values

If true - quantized vectors always will be stored in RAM, ignoring the config of main storage

ScalarType

SparseIndexParams

Store index on disk. If set to false, the index will be stored in RAM. Default: false

SparseIndexParamsDatatype

Params of single sparse vector data storage

SparseVectorParams

Custom params for index. If none - values from collection configuration are used.

Configures addition value modifications for sparse vectors. Default: none

SparseVectorParamsIndex

SparseVectorParamsModifier

SparseVectorsConfig

VectorParamsDiff

Update params for HNSW index. If empty object - it will be unset.

Update params for quantization. If none - it is left unchanged.

If true, vectors are served from disk, improving RAM usage at the cost of latency

VectorParamsDiffHnswConfig

VectorParamsDiffQuantizationConfig

Vector update params for multiple vectors

{ "vector_name": { "hnsw_config": { "m": 8 } } }

VectorsConfigDiff

UpdateCollectionHnswConfig

Custom params for Optimizers. If none - it is left unchanged. This operation is blocking, it will only proceed once all current optimizations are complete

1	curl -X PATCH \
2	'http://localhost:6333/collections/collection_name' \
3	--header 'api-key: <api-key-value>' \
4	--header 'Content-Type: application/json' \
5	--data-raw '{
6	"optimizers_config": {
7	"indexing_threshold": 10000
8	}
9	}'

Update collection parameters

Path parameters

Query parameters

Request

Response