Delete

Permanently removes items from the index by ID, along with their contents and metadata.

async delete({ ids: string[] }): Promise<DeleteResponse>

Parameters

Parameter	Type	Default	Description
`ids`	`string[]`	-	IDs of the items to delete. An empty array is a no-op.

Returns

Promise<DeleteResponse> with status and message, e.g. { status: 'success', message: 'Deleted 2 vectors' }. The count is the number of IDs sent, including IDs that don’t exist.

Exceptions

CyborgDBValidationError

The service rejects the request (HTTP 422), for example when ids isn’t an array of strings.

CyborgDBAuthenticationError

The indexKey or apiKey is invalid, or a read-only user key is used (HTTP 401/403).

CyborgDBServiceError

The service returns 5xx.

See Errors for the full hierarchy.

Example Usage

const result = await index.delete({ ids: ['doc1', 'doc2'] });
console.log(result);
// Output: { status: 'success', message: 'Deleted 2 vectors' }

console.log((await index.listIds()).ids);
// Output: [ 'doc3' ]

Introduction

Client

Encrypted Index

Types & Helpers

Parameters

Returns

Exceptions

Example Usage

​Parameters

​Returns

​Exceptions

​Example Usage

Parameters

Returns

Exceptions

Example Usage