@flowrag/presets

Opinionated presets for FlowRAG to get started quickly.

Installation

npm install @flowrag/presets

Usage

Local Development

import { createFlowRAG, defineSchema } from '@flowrag/core';
import { createLocalStorage } from '@flowrag/presets';

const schema = defineSchema({
  entityTypes: ['SERVICE', 'DATABASE'],
  relationTypes: ['USES', 'PRODUCES'],
});

const rag = await createFlowRAG({
  schema,
  ...createLocalStorage(), // Uses './data' by default
});

Custom Path

const rag = await createFlowRAG({
  schema,
  ...createLocalStorage({ path: './my-data' }),
});

Override Components

import { GeminiEmbedder } from '@flowrag/embedder-gemini';

const rag = await createFlowRAG({
  schema,
  ...createLocalStorage({
    path: './data',
    embedder: new GeminiEmbedder(), // Use Gemini instead of local ONNX
  }),
});

What's Included

createLocalStorage() provides:

• KV Storage: JSON files (./data/kv/)
• Vector Storage: LanceDB (./data/vectors/)
• Graph Storage: SQLite (./data/graph.db)
• Embedder: Local ONNX (Xenova/e5-small-v2)
• Extractor: Gemini (gemini-2.0-flash-exp)

API

createLocalStorage(options?)

| Option | Type | Default | Description | |--------|------|---------|-------------| | path | string | './data' | Base path for storage | | kv | KVStorage | JsonKVStorage | Override KV storage | | vector | VectorStorage | LanceDBVectorStorage | Override vector storage | | graph | GraphStorage | SQLiteGraphStorage | Override graph storage | | embedder | Embedder | LocalEmbedder | Override embedder | | extractor | LLMExtractor | GeminiExtractor | Override extractor |