Skip to main content

updateSettings

client.vectorDb.updateSettings(id: string, data: UpdateVectorSettingsRequest): Promise<VectorCollectionSettings>

Updates settings for a vector collection.

Modifies the configuration parameters of a collection such as distance metric, index type, or other settings. Some settings may require index rebuild or have performance implications.

Parameters​

ParameterTypeRequiredDescription
idstringYesThe unique identifier of the collection to update
dataUpdateVectorSettingsRequestYesThe settings to update with new values

Returns​

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

Example​

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

const client = new CodeBoltClient();

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