Skip to main content

updateCollection

client.vectorDb.updateCollection(id: string, data: UpdateVectorCollectionRequest): Promise<VectorCollection>

Updates a vector collection.

Modifies the configuration of an existing collection such as name, metadata, or other configurable properties. The collection ID must be valid and the collection must exist.

Parameters​

ParameterTypeRequiredDescription
idstringYesThe unique identifier of the collection to update
dataUpdateVectorCollectionRequestYesThe update data with fields to modify

Returns​

Promise<VectorCollection> — A promise that resolves to the updated VectorCollection object

Example​

import { CodeBoltClient } from '@codebolt/clientsdk';

const client = new CodeBoltClient();

const result = await client.vectorDb.updateCollection('id', /* UpdateVectorCollectionRequest */);
console.log(result);