Collections

Update collection parameters

PATCH
Updates the parameters of the specified collection.

Path parameters

collection_namestringRequired
Name of the collection to update

Query parameters

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

Request

This endpoint expects an object.
vectors
unionOptional
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_config
unionOptional
Custom params for Optimizers. If none - it is left unchanged. This operation is blocking, it will only proceed once all current optimizations are complete
params
unionOptional
Collection base params. If none - it is left unchanged.
hnsw_config
unionOptional
HNSW parameters to update for the collection index. If none - it is left unchanged.
quantization_config
unionOptional
Quantization parameters to update. If none - it is left unchanged.
sparse_vectors
unionOptional
Map of sparse vector data parameters to update for each sparse vector.

Response

This endpoint returns an object
time
doubleOptional
Time spent to process this request
status
stringOptional
result
booleanOptional
PATCH
1curl -X PATCH http://localhost:6333/collections/collection_name \
2     -H "api-key: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{}'
200Updated
1{
2  "time": 1.1,
3  "status": "status",
4  "result": true
5}
Built with