@flowrag/core 1.5.0 → 1.6.0

package/dist/index.d.mts

@@ -10,6 +10,21 @@ interface Embedder {
   embedBatch(texts: string[]): Promise<number[][]>;
 }
 //#endregion
+//#region src/interfaces/evaluator.d.ts
+/** Document passed to an evaluator */
+interface EvalDocument {
+  content: string;
+  score: number;
+}
+/** Evaluation result with named scores */
+interface EvalResult {
+  scores: Record<string, number>;
+}
+/** Pluggable evaluator for RAG quality metrics */
+interface Evaluator {
+  evaluate(query: string, documents: EvalDocument[], reference?: string): Promise<EvalResult>;
+}
+//#endregion
 //#region src/schema.d.ts
 /** Custom field definition */
 interface FieldDefinition {
@@ -131,10 +146,17 @@ interface ExtractedRelation {
   keywords: string[];
   fields?: Record<string, unknown>;
 }
+/** Token usage from LLM/embedding calls */
+interface TokenUsage {
+  promptTokens?: number;
+  completionTokens?: number;
+  totalTokens?: number;
+}
 /** Result of entity extraction */
 interface ExtractionResult {
   entities: ExtractedEntity[];
   relations: ExtractedRelation[];
+  usage?: TokenUsage;
 }
 /** Query modes */
 type QueryMode = "local" | "global" | "hybrid" | "naive";
@@ -145,6 +167,18 @@ interface LLMExtractor {
   extractEntities(content: string, knownEntities: string[], schema: Schema): Promise<ExtractionResult>;
 }
 //#endregion
+//#region src/interfaces/parser.d.ts
+/** Parsed document output from a DocumentParser */
+interface ParsedDocument {
+  content: string;
+  metadata: Record<string, unknown>;
+}
+/** Pluggable file parser for non-text documents (PDF, DOCX, images, etc.) */
+interface DocumentParser {
+  readonly supportedExtensions: string[];
+  parse(filePath: string): Promise<ParsedDocument>;
+}
+//#endregion
 //#region src/interfaces/reranker.d.ts
 /**
 * Reranker interface for FlowRAG
@@ -211,5 +245,5 @@ declare function withNamespace(storage: StorageSet, namespace: string): StorageS
 */
 declare function buildExtractionPrompt(content: string, knownEntities: string[], schema: Schema): string;
 //#endregion
-export { Chunk, Document, DocumentMetadata, Embedder, Entity, EntityFilter, ExtractedEntity, ExtractedRelation, ExtractionResult, FieldDefinition, GraphStorage, Id, KVStorage, LLMExtractor, QueryMode, Relation, RelationDirection, RerankDocument, RerankResult, Reranker, Schema, SchemaConfig, SearchResult, StorageSet, VectorFilter, VectorRecord, VectorStorage, buildExtractionPrompt, defineSchema, withNamespace };
+export { Chunk, Document, DocumentMetadata, DocumentParser, Embedder, Entity, EntityFilter, EvalDocument, EvalResult, Evaluator, ExtractedEntity, ExtractedRelation, ExtractionResult, FieldDefinition, GraphStorage, Id, KVStorage, LLMExtractor, ParsedDocument, QueryMode, Relation, RelationDirection, RerankDocument, RerankResult, Reranker, Schema, SchemaConfig, SearchResult, StorageSet, TokenUsage, VectorFilter, VectorRecord, VectorStorage, buildExtractionPrompt, defineSchema, withNamespace };
 //# sourceMappingURL=index.d.mts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowrag/core",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "📐 The heart of FlowRAG. Defines all TypeScript interfaces (Storage, Embedder, LLMExtractor), the Zod-based schema system for defining entity/relation types, and the orchestration pipeline that coordinates indexing and querying. This package contains only contracts and types, no concrete implementations.",
   "keywords": [
     "interfaces",