Skip to navigation
API ReferenceCollections

Update collection parameters

Updates the parameters of the specified collection.

Authentication

api-keystring

Authorization key, either read-write or read-only

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

collection_namestringRequired
Name of the collection to update

Query parameters

timeoutintegerOptional>=1

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

Request

New parameters
vectorsmap from strings to objects or anyOptional
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.
optimizers_configobject or anyOptional

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

paramsobject or anyOptional

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

hnsw_configobject or anyOptional

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

quantization_configobject or enum or anyOptional

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

sparse_vectorsmap from strings to objects or anyOptional
Map of sparse vector data parameters to update for each sparse vector.
strict_mode_configobject or anyOptional
metadatamap from strings to any or anyOptional

Metadata to update for the collection. If provided, this will merge with existing metadata. Individual keys can be removed by setting their value to null.

Response

successful operation
usageobject or anyOptional
timefloatOptional
Time spent to process this request
statusstringOptional
resultbooleanOptional

Errors

4XX
Client Request Error