actrone-memory
    Preparing search index...

    Interface Embedder

    Embedding seam. MemoryManager.create() picks the best local embedder available (buildLocalEmbedder): FastEmbedEmbedder (bge-small-en-v1.5, semantic) when the optional fastembed package is installed, otherwise the dependency-free LocalEmbedder, which hashes words into a bag-of-words vector so cosine similarity reflects shared keywords only. The lexical embedder is deterministic and offline, which also makes the test suite run anywhere.

    To use a hosted model, pass your own Embedder (for example one backed by OpenAI text-embedding-3-small) and set relevanceThreshold for it.

    interface Embedder {
        dimensions: number;
        relevanceThreshold?: number;
        embed(text: string): Promise<number[]>;
    }

    Implemented by

    Index
    dimensions: number

    The dimensionality of vectors this embedder produces.

    relevanceThreshold?: number

    The cosine similarity at which this model's results turn from unrelated to relevant, used as the admission threshold when MemoryConfig.relevanceThreshold is not set. Declare it for a custom embedder once you have measured it; leave it out to use the library default.

    • Embed a single text into a dense vector.

      Parameters

      • text: string

      Returns Promise<number[]>