Vector Store Adapters

All six adapters intercept writes before secrets persist to the vector database. Each adapter runs guard.checkpoint() on every document before forwarding the write.

import { PineconeAdapter } from '@roadsidelab/keyspot-sdk/adapters';
 
const adapter = new PineconeAdapter(guard);
const safeIndex = adapter.wrap(pineconeIndex);
await safeIndex.upsert(records);  // documents sanitised before upsert

Supported Stores

How It Works

Each adapter extends BaseVectorStoreAdapter:

abstract class BaseVectorStoreAdapter implements VectorStoreAdapter {
  constructor(protected guard: KeySpot) {}
 
  abstract wrap(store: any): any;
 
  protected async sanitizeDocuments<T>(documents: T[]): Promise<T[]> {
    // Each document goes through guard.checkpoint() before write
    for (const doc of documents) {
      await this.guard.checkpoint(doc);
    }
  }
}

If a document contains a secret, the vault reference token is stored in the vector DB instead of the plaintext value.