@retrivora-ai/rag-engine 1.2.1 → 1.2.3

package/dist/DocumentChunker-BXOUMKoP.d.ts

@@ -0,0 +1,93 @@
+import { C as ChatMessage, c as ChatOptions } from './index-Cti1u0y1.js';
+
+/**
+ * Generic LLM Provider interface.
+ * Covers both chat completion and embedding generation so a single
+ * provider can handle both responsibilities when appropriate.
+ */
+
+interface EmbedOptions {
+    /** Override model for this specific embed call */
+    model?: string;
+    /** Specify the task type for models that require prefixes (e.g. nomic-embed-text) */
+    taskType?: 'query' | 'document';
+}
+interface ILLMProvider {
+    /**
+     * Send a chat completion request.
+     * @param messages – the full conversation history
+     * @param context  – retrieved RAG context to inject
+     * @param options  – optional per-call overrides
+     * @returns        – the assistant's reply text
+     */
+    chat(messages: ChatMessage[], context: string, options?: ChatOptions): Promise<string>;
+    /**
+     * Send a streaming chat completion request.
+     * @returns – an async iterable of text chunks
+     */
+    chatStream?(messages: ChatMessage[], context: string, options?: ChatOptions): AsyncIterable<string>;
+    /**
+     * Generate an embedding vector for the given text.
+     * @param text    – text to embed
+     * @param options – optional overrides
+     * @returns       – float array (the embedding)
+     */
+    embed(text: string, options?: EmbedOptions): Promise<number[]>;
+    /**
+     * Generate embedding vectors for multiple texts in a single batch.
+     * @param texts   – array of texts to embed
+     * @param options – optional overrides
+     * @returns       – array of float arrays
+     */
+    batchEmbed(texts: string[], options?: EmbedOptions): Promise<number[][]>;
+    /**
+     * Check if the provider endpoint is reachable.
+     */
+    ping(): Promise<boolean>;
+}
+
+/**
+ * DocumentChunker — splits long text into overlapping chunks
+ * suitable for vector embedding and retrieval.
+ *
+ * Strategy: sentence-aware sliding window
+ *   1. Split on sentence boundaries
+ *   2. Accumulate sentences into chunks up to `chunkSize` characters
+ *   3. Carry over `chunkOverlap` characters from the previous chunk
+ */
+interface Chunk {
+    id: string;
+    content: string;
+    metadata?: Record<string, unknown>;
+}
+interface ChunkOptions {
+    /** Target chunk size in characters (default 1000) */
+    chunkSize?: number;
+    /** Overlap between consecutive chunks in characters (default 200) */
+    chunkOverlap?: number;
+    /** Source document identifier used as ID prefix */
+    docId?: string | number;
+    /** Extra metadata to attach to every chunk */
+    metadata?: Record<string, unknown>;
+    /** Characters used to split text, in order of priority */
+    separators?: string[];
+}
+declare class DocumentChunker {
+    private readonly chunkSize;
+    private readonly chunkOverlap;
+    private readonly separators;
+    constructor(chunkSize?: number, chunkOverlap?: number, separators?: string[]);
+    /**
+     * Split a single text string into overlapping chunks using a recursive strategy.
+     * Preserves structural boundaries (Markdown headers) where possible.
+     */
+    chunk(text: string, options?: ChunkOptions): Chunk[];
+    private recursiveSplit;
+    chunkMany(documents: Array<{
+        content: string;
+        docId?: string | number;
+        metadata?: Record<string, unknown>;
+    }>): Chunk[];
+}
+
+export { type Chunk as C, DocumentChunker as D, type EmbedOptions as E, type ILLMProvider as I, type ChunkOptions as a };

package/dist/DocumentChunker-D1dg5iCi.d.mts

@@ -0,0 +1,93 @@
+import { C as ChatMessage, c as ChatOptions } from './index-Cti1u0y1.mjs';
+
+/**
+ * Generic LLM Provider interface.
+ * Covers both chat completion and embedding generation so a single
+ * provider can handle both responsibilities when appropriate.
+ */
+
+interface EmbedOptions {
+    /** Override model for this specific embed call */
+    model?: string;
+    /** Specify the task type for models that require prefixes (e.g. nomic-embed-text) */
+    taskType?: 'query' | 'document';
+}
+interface ILLMProvider {
+    /**
+     * Send a chat completion request.
+     * @param messages – the full conversation history
+     * @param context  – retrieved RAG context to inject
+     * @param options  – optional per-call overrides
+     * @returns        – the assistant's reply text
+     */
+    chat(messages: ChatMessage[], context: string, options?: ChatOptions): Promise<string>;
+    /**
+     * Send a streaming chat completion request.
+     * @returns – an async iterable of text chunks
+     */
+    chatStream?(messages: ChatMessage[], context: string, options?: ChatOptions): AsyncIterable<string>;
+    /**
+     * Generate an embedding vector for the given text.
+     * @param text    – text to embed
+     * @param options – optional overrides
+     * @returns       – float array (the embedding)
+     */
+    embed(text: string, options?: EmbedOptions): Promise<number[]>;
+    /**
+     * Generate embedding vectors for multiple texts in a single batch.
+     * @param texts   – array of texts to embed
+     * @param options – optional overrides
+     * @returns       – array of float arrays
+     */
+    batchEmbed(texts: string[], options?: EmbedOptions): Promise<number[][]>;
+    /**
+     * Check if the provider endpoint is reachable.
+     */
+    ping(): Promise<boolean>;
+}
+
+/**
+ * DocumentChunker — splits long text into overlapping chunks
+ * suitable for vector embedding and retrieval.
+ *
+ * Strategy: sentence-aware sliding window
+ *   1. Split on sentence boundaries
+ *   2. Accumulate sentences into chunks up to `chunkSize` characters
+ *   3. Carry over `chunkOverlap` characters from the previous chunk
+ */
+interface Chunk {
+    id: string;
+    content: string;
+    metadata?: Record<string, unknown>;
+}
+interface ChunkOptions {
+    /** Target chunk size in characters (default 1000) */
+    chunkSize?: number;
+    /** Overlap between consecutive chunks in characters (default 200) */
+    chunkOverlap?: number;
+    /** Source document identifier used as ID prefix */
+    docId?: string | number;
+    /** Extra metadata to attach to every chunk */
+    metadata?: Record<string, unknown>;
+    /** Characters used to split text, in order of priority */
+    separators?: string[];
+}
+declare class DocumentChunker {
+    private readonly chunkSize;
+    private readonly chunkOverlap;
+    private readonly separators;
+    constructor(chunkSize?: number, chunkOverlap?: number, separators?: string[]);
+    /**
+     * Split a single text string into overlapping chunks using a recursive strategy.
+     * Preserves structural boundaries (Markdown headers) where possible.
+     */
+    chunk(text: string, options?: ChunkOptions): Chunk[];
+    private recursiveSplit;
+    chunkMany(documents: Array<{
+        content: string;
+        docId?: string | number;
+        metadata?: Record<string, unknown>;
+    }>): Chunk[];
+}
+
+export { type Chunk as C, DocumentChunker as D, type EmbedOptions as E, type ILLMProvider as I, type ChunkOptions as a };

package/dist/{chunk-GCPPRD2G.mjs → chunk-WGPNEAK3.mjs}

@@ -1692,11 +1692,29 @@ Sources Used: ${JSON.stringify(
           )}`;
         }
       });
+      const defaultAgentPrompt = "You are a helpful AI assistant with access to a document search tool.";
+      let finalSystemPrompt = this.config.llm.systemPrompt || defaultAgentPrompt;
+      const chartInstruction = `
+
+When presenting structured data, statistics, or comparisons, decide if it is best presented as a table or a chart.
+- For tables: use standard Markdown tables.
+- For charts (bar, line, pie): Output a JSON code block with language 'chart' matching this schema:
+\`\`\`chart
+{
+  "type": "bar" | "line" | "pie",
+  "xAxisKey": "name",
+  "dataKeys": ["value"],
+  "data": [{"name": "A", "value": 10}]
+}
+\`\`\``;
+      if (!finalSystemPrompt.includes("chart")) {
+        finalSystemPrompt += chartInstruction;
+      }
       this.agent = createAgent({
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         model: chatModel,
         tools: [searchTool],
-        systemPrompt: this.config.llm.systemPrompt || "You are a helpful AI assistant with access to a document search tool."
+        systemPrompt: finalSystemPrompt
       });
       void HumanMessage;
     } catch (error) {
@@ -2231,8 +2249,24 @@ var Pipeline = class {
     this.reranker = new Reranker();
   }
   async initialize() {
-    var _a;
+    var _a, _b;
     if (this.initialised) return;
+    const chartInstruction = `
+
+When presenting structured data, statistics, or comparisons, decide if it is best presented as a table or a chart.
+- For tables: use standard Markdown tables.
+- For charts (bar, line, pie): Output a JSON code block with language 'chart' matching this schema:
+\`\`\`chart
+{
+  "type": "bar" | "line" | "pie",
+  "xAxisKey": "name",
+  "dataKeys": ["value"],
+  "data": [{"name": "A", "value": 10}]
+}
+\`\`\``;
+    if (!((_a = this.config.llm.systemPrompt) == null ? void 0 : _a.includes("chart"))) {
+      this.config.llm.systemPrompt = (this.config.llm.systemPrompt || "") + chartInstruction;
+    }
     console.log(`[Pipeline] Initializing with provider: ${this.config.vectorDb.provider}...`);
     this.vectorDB = await ProviderRegistry.createVectorProvider(this.config.vectorDb);
     const { llmProvider, embeddingProvider } = await EmbeddingStrategyResolver.resolve(
@@ -2247,7 +2281,7 @@ var Pipeline = class {
       this.entityExtractor = new EntityExtractor(this.llmProvider);
     }
     await this.vectorDB.initialize();
-    if (((_a = this.config.rag) == null ? void 0 : _a.architecture) === "agentic") {
+    if (((_b = this.config.rag) == null ? void 0 : _b.architecture) === "agentic") {
       this.agent = new LangChainAgent(this, this.config);
       await this.agent.initialize(this.llmProvider);
     }

package/dist/handlers/index.d.mts

@@ -1,3 +1,3 @@
-import '../RagConfig-BOLOz0_O.mjs';
-export { c as createChatHandler, d as createHealthHandler, e as createIngestHandler, f as createStreamHandler, k as createSuggestionsHandler, g as createUploadHandler, s as sseErrorFrame, h as sseFrame, i as sseMetaFrame, j as sseTextFrame } from '../index-64BDupW3.mjs';
+import '../index-Cti1u0y1.mjs';
+export { c as createChatHandler, d as createHealthHandler, e as createIngestHandler, f as createStreamHandler, k as createSuggestionsHandler, g as createUploadHandler, s as sseErrorFrame, h as sseFrame, i as sseMetaFrame, j as sseTextFrame } from '../index-kUXnRvuI.mjs';
 import 'next/server';

package/dist/handlers/index.d.ts

@@ -1,3 +1,3 @@
-import '../RagConfig-BOLOz0_O.js';
-export { c as createChatHandler, d as createHealthHandler, e as createIngestHandler, f as createStreamHandler, k as createSuggestionsHandler, g as createUploadHandler, s as sseErrorFrame, h as sseFrame, i as sseMetaFrame, j as sseTextFrame } from '../index-DbtE8wLM.js';
+import '../index-Cti1u0y1.js';
+export { c as createChatHandler, d as createHealthHandler, e as createIngestHandler, f as createStreamHandler, k as createSuggestionsHandler, g as createUploadHandler, s as sseErrorFrame, h as sseFrame, i as sseMetaFrame, j as sseTextFrame } from '../index-B67KQ9NN.js';
 import 'next/server';

package/dist/handlers/index.js

@@ -3261,11 +3261,29 @@ Sources Used: ${JSON.stringify(
           )}`;
         }
       });
+      const defaultAgentPrompt = "You are a helpful AI assistant with access to a document search tool.";
+      let finalSystemPrompt = this.config.llm.systemPrompt || defaultAgentPrompt;
+      const chartInstruction = `
+
+When presenting structured data, statistics, or comparisons, decide if it is best presented as a table or a chart.
+- For tables: use standard Markdown tables.
+- For charts (bar, line, pie): Output a JSON code block with language 'chart' matching this schema:
+\`\`\`chart
+{
+  "type": "bar" | "line" | "pie",
+  "xAxisKey": "name",
+  "dataKeys": ["value"],
+  "data": [{"name": "A", "value": 10}]
+}
+\`\`\``;
+      if (!finalSystemPrompt.includes("chart")) {
+        finalSystemPrompt += chartInstruction;
+      }
       this.agent = createAgent({
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         model: chatModel,
         tools: [searchTool],
-        systemPrompt: this.config.llm.systemPrompt || "You are a helpful AI assistant with access to a document search tool."
+        systemPrompt: finalSystemPrompt
       });
       void HumanMessage;
     } catch (error) {
@@ -3794,8 +3812,24 @@ var Pipeline = class {
     this.reranker = new Reranker();
   }
   async initialize() {
-    var _a;
+    var _a, _b;
     if (this.initialised) return;
+    const chartInstruction = `
+
+When presenting structured data, statistics, or comparisons, decide if it is best presented as a table or a chart.
+- For tables: use standard Markdown tables.
+- For charts (bar, line, pie): Output a JSON code block with language 'chart' matching this schema:
+\`\`\`chart
+{
+  "type": "bar" | "line" | "pie",
+  "xAxisKey": "name",
+  "dataKeys": ["value"],
+  "data": [{"name": "A", "value": 10}]
+}
+\`\`\``;
+    if (!((_a = this.config.llm.systemPrompt) == null ? void 0 : _a.includes("chart"))) {
+      this.config.llm.systemPrompt = (this.config.llm.systemPrompt || "") + chartInstruction;
+    }
     console.log(`[Pipeline] Initializing with provider: ${this.config.vectorDb.provider}...`);
     this.vectorDB = await ProviderRegistry.createVectorProvider(this.config.vectorDb);
     const { llmProvider, embeddingProvider } = await EmbeddingStrategyResolver.resolve(
@@ -3810,7 +3844,7 @@ var Pipeline = class {
       this.entityExtractor = new EntityExtractor(this.llmProvider);
     }
     await this.vectorDB.initialize();
-    if (((_a = this.config.rag) == null ? void 0 : _a.architecture) === "agentic") {
+    if (((_b = this.config.rag) == null ? void 0 : _b.architecture) === "agentic") {
       this.agent = new LangChainAgent(this, this.config);
       await this.agent.initialize(this.llmProvider);
     }

package/dist/handlers/index.mjs

@@ -9,7 +9,7 @@ import {
   sseFrame,
   sseMetaFrame,
   sseTextFrame
-} from "../chunk-GCPPRD2G.mjs";
+} from "../chunk-WGPNEAK3.mjs";
 import "../chunk-YLTMFW4M.mjs";
 import "../chunk-X4TOT24V.mjs";
 export {

package/dist/{index-DbtE8wLM.d.ts → index-B67KQ9NN.d.ts}

@@ -1,4 +1,4 @@
-import { g as RagConfig, C as ChatMessage, b as ChatResponse, e as IngestDocument } from './RagConfig-BOLOz0_O.js';
+import { h as RagConfig, C as ChatMessage, d as ChatResponse, I as IngestDocument } from './index-Cti1u0y1.js';
 import { NextRequest, NextResponse } from 'next/server';
 
 interface ValidationError {

package/dist/{RagConfig-BOLOz0_O.d.mts → index-Cti1u0y1.d.mts}

@@ -1,62 +1,12 @@
-interface VectorMatch {
-    id: string | number;
-    score: number;
-    content: string;
-    metadata?: Record<string, unknown>;
-}
-interface UpsertDocument {
-    id: string | number;
-    vector: number[];
+type MessageRole = 'user' | 'assistant' | 'system';
+interface ChatMessage {
+    role: MessageRole;
     content: string;
-    metadata?: Record<string, unknown>;
 }
-interface IngestDocument {
-    docId: string | number;
-    content: string;
-    metadata?: Record<string, unknown>;
-}
-interface ChatResponse {
-    reply: string;
-    sources: VectorMatch[];
-    graphData?: GraphSearchResult;
-}
-interface GraphNode {
+interface RagMessage extends ChatMessage {
     id: string;
-    label: string;
-    properties?: Record<string, unknown>;
-}
-interface Edge {
-    source: string;
-    target: string;
-    type: string;
-    properties?: Record<string, unknown>;
-}
-interface GraphSearchResult {
-    nodes: GraphNode[];
-    edges: Edge[];
-}
-interface RetrievalResult {
-    sources: VectorMatch[];
-    graphData?: GraphSearchResult;
-}
-interface Product {
-    id: string | number;
-    name: string;
-    brand?: string;
-    price?: string | number;
-    image?: string;
-    link?: string;
-    description?: string;
-}
-
-/**
- * Generic LLM Provider interface.
- * Covers both chat completion and embedding generation so a single
- * provider can handle both responsibilities when appropriate.
- */
-interface ChatMessage {
-    role: 'user' | 'assistant' | 'system';
-    content: string;
+    sources?: VectorMatch[];
+    createdAt: string;
 }
 interface ChatOptions {
     /** Override max tokens for this specific call */
@@ -66,44 +16,33 @@ interface ChatOptions {
     /** Stop sequences */
     stop?: string[];
 }
-interface EmbedOptions {
-    /** Override model for this specific embed call */
-    model?: string;
-    /** Specify the task type for models that require prefixes (e.g. nomic-embed-text) */
-    taskType?: 'query' | 'document';
+interface UseRagChatOptions {
+    /** Override the chat API endpoint (default: /api/chat) */
+    apiUrl?: string;
+    /** Override project namespace */
+    namespace?: string;
+    /** Persist chat history to localStorage (default: true) */
+    persist?: boolean;
+    /** Called after each successful assistant reply */
+    onReply?: (message: RagMessage) => void;
+    /** Called on error */
+    onError?: (error: string) => void;
 }
-interface ILLMProvider {
-    /**
-     * Send a chat completion request.
-     * @param messages – the full conversation history
-     * @param context  – retrieved RAG context to inject
-     * @param options  – optional per-call overrides
-     * @returns        – the assistant's reply text
-     */
-    chat(messages: ChatMessage[], context: string, options?: ChatOptions): Promise<string>;
-    /**
-     * Send a streaming chat completion request.
-     * @returns – an async iterable of text chunks
-     */
-    chatStream?(messages: ChatMessage[], context: string, options?: ChatOptions): AsyncIterable<string>;
-    /**
-     * Generate an embedding vector for the given text.
-     * @param text    – text to embed
-     * @param options – optional overrides
-     * @returns       – float array (the embedding)
-     */
-    embed(text: string, options?: EmbedOptions): Promise<number[]>;
-    /**
-     * Generate embedding vectors for multiple texts in a single batch.
-     * @param texts   – array of texts to embed
-     * @param options – optional overrides
-     * @returns       – array of float arrays
-     */
-    batchEmbed(texts: string[], options?: EmbedOptions): Promise<number[][]>;
-    /**
-     * Check if the provider endpoint is reachable.
-     */
-    ping(): Promise<boolean>;
+interface UseRagChatReturn {
+    /** All messages in the current conversation */
+    messages: RagMessage[];
+    /** Whether a response is in flight */
+    isLoading: boolean;
+    /** Current error message, or null */
+    error: string | null;
+    /** Send a user message */
+    send: (text: string) => Promise<void>;
+    /** Clear the conversation (and localStorage if persist=true) */
+    clear: () => void;
+    /** Retry the last failed send */
+    retry: () => Promise<void>;
+    /** Programmatically set the conversation (e.g. to restore from a DB) */
+    setMessages: React.Dispatch<React.SetStateAction<RagMessage[]>>;
 }
 
 /**
@@ -233,6 +172,8 @@ interface UIConfig {
     allowUpload?: boolean;
     /** Whether to allow manual resizing of the chat window. Defaults to true. */
     allowResize?: boolean;
+    /** Whether to enable voice search input. Defaults to true. */
+    enableVoiceInput?: boolean;
 }
 interface RAGConfig {
     /** Number of top-K chunks retrieved per query */
@@ -280,4 +221,55 @@ interface RagConfig {
     graphDb?: GraphDBConfig;
 }
 
-export type { ChatMessage as C, EmbedOptions as E, GraphDBConfig as G, ILLMProvider as I, LLMConfig as L, Product as P, RAGConfig as R, UIConfig as U, VectorMatch as V, ChatOptions as a, ChatResponse as b, EmbeddingConfig as c, EmbeddingProvider as d, IngestDocument as e, LLMProvider as f, RagConfig as g, UpsertDocument as h, VectorDBConfig as i, VectorDBProvider as j, RetrievalResult as k, GraphNode as l, Edge as m, GraphSearchResult as n };
+interface VectorMatch {
+    id: string | number;
+    score: number;
+    content: string;
+    metadata?: Record<string, unknown>;
+}
+interface UpsertDocument {
+    id: string | number;
+    vector: number[];
+    content: string;
+    metadata?: Record<string, unknown>;
+}
+interface IngestDocument {
+    docId: string | number;
+    content: string;
+    metadata?: Record<string, unknown>;
+}
+interface ChatResponse {
+    reply: string;
+    sources: VectorMatch[];
+    graphData?: GraphSearchResult;
+}
+interface GraphNode {
+    id: string;
+    label: string;
+    properties?: Record<string, unknown>;
+}
+interface Edge {
+    source: string;
+    target: string;
+    type: string;
+    properties?: Record<string, unknown>;
+}
+interface GraphSearchResult {
+    nodes: GraphNode[];
+    edges: Edge[];
+}
+interface RetrievalResult {
+    sources: VectorMatch[];
+    graphData?: GraphSearchResult;
+}
+interface Product {
+    id: string | number;
+    name: string;
+    brand?: string;
+    price?: string | number;
+    image?: string;
+    link?: string;
+    description?: string;
+}
+
+export type { ChatMessage as C, EmbeddingConfig as E, GraphDBConfig as G, IngestDocument as I, LLMConfig as L, Product as P, RagMessage as R, UIConfig as U, VectorMatch as V, UseRagChatOptions as a, UseRagChatReturn as b, ChatOptions as c, ChatResponse as d, EmbeddingProvider as e, LLMProvider as f, RAGConfig as g, RagConfig as h, UpsertDocument as i, VectorDBConfig as j, VectorDBProvider as k, RetrievalResult as l, GraphNode as m, Edge as n, GraphSearchResult as o };