API Reference

Complete API reference for QRVideoStoreEncoder, QRVideoStoreRetriever, and all adapter functions.

QRVideoStoreEncoder

Constructor

new QRVideoStoreEncoder(
  database: VectorDatabase,
  embedder: Embedder,
  config?: QRVideoStoreConfig
)

Methods

  • addDocument(documentId, text, outputPath, metadata?) - Encode document
  • addDocumentsBatch(documents) - Encode multiple documents
  • chunkText(text) - Split text into chunks
  • getStats(videoPath, originalText) - Get compression statistics

QRVideoStoreRetriever

Constructor

new QRVideoStoreRetriever(
  database: VectorDatabase,
  embedder: Embedder,
  options?: { verbose?: boolean; maxCacheSize?: number }
)

Methods

  • search(query, videoPath, matchCount?) - Main search method
  • searchMultiple(query, videoPaths, matchCount?) - Search multiple videos
  • retrieveChunks(query, matchCount?) - Get chunk metadata
  • clearCache() - Clear frame cache

Database Adapters

// Production-ready
createSupabaseAdapter(client, tableName?)

// Development/testing
createInMemoryAdapter()

// Simple storage
createFileAdapter(filePath)

// Custom implementation
createCustomAdapter(implementation)

Embedder Adapters

// Primary embedder
createGeminiEmbedder(apiKey, model?)

// Alternative providers
createGoogleAIEmbedder(apiKey, model?)
createCohereEmbedder(apiKey, model?)
createHuggingFaceEmbedder(apiKey, model?)

// Testing/performance
createMockEmbedder(dimension?)
createCachedEmbedder(embedder, maxCacheSize?)

createCustomEmbedder(embedFn, dimension?)
Encoding & RetrievalExamples