Interface CreateConfig

interface CreateConfig {
    embedder?: CustomEmbedderConfig | TransformersEmbedderConfig;
    namespace?: string;
    onWarn?: (code: WarnCode, message: string) => void;
    store: MemoryStoreConfig | OpfsStoreConfig;
}

Index

Properties

embedder? namespace? onWarn? store

Properties

`Optional`embedder

embedder?: CustomEmbedderConfig | TransformersEmbedderConfig

Embedder. Required for ingest() and query().

embedders.custom() — deterministic, no network (tests and dev)
embedders.transformers() — lazy-loads transformers.js on first use (default path) Omitting creates a lifecycle-only instance (close() works; ingest/query reject).

`Optional`namespace

namespace?: string

Corpus namespace. Must match /^[a-zA-Z0-9_-]{1,64}$/. Defaults to "default".

`Optional`onWarn

onWarn?: (code: WarnCode, message: string) => void

Optional callback for non-fatal warnings (e.g. StoreFallback when OPFS is unavailable and the store falls back to IndexedDB).

store

store: MemoryStoreConfig | OpfsStoreConfig

Backing store. Use stores.memory() for tests; stores.opfs() for persistence.