@cogitator-ai/rag 0.1.0 → 0.1.3

package/dist/retrievers/similarity-retriever.js

@@ -0,0 +1,39 @@
+const DEFAULT_TOP_K = 10;
+const DEFAULT_THRESHOLD = 0.5;
+export class SimilarityRetriever {
+    adapter;
+    embedding;
+    defaultTopK;
+    defaultThreshold;
+    constructor(config) {
+        this.adapter = config.embeddingAdapter;
+        this.embedding = config.embeddingService;
+        this.defaultTopK = config.defaultTopK ?? DEFAULT_TOP_K;
+        this.defaultThreshold = config.defaultThreshold ?? DEFAULT_THRESHOLD;
+    }
+    async retrieve(query, options) {
+        const vector = await this.embedding.embed(query);
+        const result = await this.adapter.search({
+            vector,
+            query,
+            limit: options?.topK ?? this.defaultTopK,
+            threshold: options?.threshold ?? this.defaultThreshold,
+        });
+        if (!result.success) {
+            throw new Error(result.error);
+        }
+        return result.data.map((entry) => this.toRetrievalResult(entry));
+    }
+    toRetrievalResult(entry) {
+        const documentId = entry.metadata?.documentId ?? entry.sourceId;
+        return {
+            chunkId: entry.sourceId,
+            documentId,
+            content: entry.content,
+            score: entry.score,
+            source: entry.sourceType,
+            metadata: entry.metadata,
+        };
+    }
+}
+//# sourceMappingURL=similarity-retriever.js.map

package/dist/retrievers/similarity-retriever.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"similarity-retriever.js","sourceRoot":"","sources":["../../src/retrievers/similarity-retriever.ts"],"names":[],"mappings":"AAgBA,MAAM,aAAa,GAAG,EAAE,CAAC;AACzB,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAE9B,MAAM,OAAO,mBAAmB;IACb,OAAO,CAAmB;IAC1B,SAAS,CAAmB;IAC5B,WAAW,CAAS;IACpB,gBAAgB,CAAS;IAE1C,YAAY,MAAiC;QAC3C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,gBAAgB,CAAC;QACvC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,gBAAgB,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,IAAI,aAAa,CAAC;QACvD,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,IAAI,iBAAiB,CAAC;IACvE,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,KAAa,EAAE,OAAkC;QAC9D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAEjD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;YACvC,MAAM;YACN,KAAK;YACL,KAAK,EAAE,OAAO,EAAE,IAAI,IAAI,IAAI,CAAC,WAAW;YACxC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,IAAI,CAAC,gBAAgB;SACvD,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;QAED,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC;IACnE,CAAC;IAEO,iBAAiB,CAAC,KAAoC;QAC5D,MAAM,UAAU,GAAI,KAAK,CAAC,QAAQ,EAAE,UAAiC,IAAI,KAAK,CAAC,QAAQ,CAAC;QAExF,OAAO;YACL,OAAO,EAAE,KAAK,CAAC,QAAQ;YACvB,UAAU;YACV,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,MAAM,EAAE,KAAK,CAAC,UAAU;YACxB,QAAQ,EAAE,KAAK,CAAC,QAAQ;SACzB,CAAC;IACJ,CAAC;CACF"}

package/dist/schema.d.ts

@@ -0,0 +1,70 @@
+import { z } from 'zod';
+export declare const ChunkingStrategySchema: z.ZodEnum<{
+    fixed: "fixed";
+    recursive: "recursive";
+    semantic: "semantic";
+}>;
+export declare const ChunkingConfigSchema: z.ZodObject<{
+    strategy: z.ZodEnum<{
+        fixed: "fixed";
+        recursive: "recursive";
+        semantic: "semantic";
+    }>;
+    chunkSize: z.ZodNumber;
+    chunkOverlap: z.ZodDefault<z.ZodNumber>;
+    separators: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
+export declare const RetrievalStrategySchema: z.ZodEnum<{
+    similarity: "similarity";
+    mmr: "mmr";
+    hybrid: "hybrid";
+    "multi-query": "multi-query";
+}>;
+export declare const RetrievalConfigSchema: z.ZodObject<{
+    strategy: z.ZodDefault<z.ZodEnum<{
+        similarity: "similarity";
+        mmr: "mmr";
+        hybrid: "hybrid";
+        "multi-query": "multi-query";
+    }>>;
+    topK: z.ZodDefault<z.ZodNumber>;
+    threshold: z.ZodDefault<z.ZodNumber>;
+    mmrLambda: z.ZodOptional<z.ZodNumber>;
+    multiQueryCount: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export declare const RerankingConfigSchema: z.ZodObject<{
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    topN: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export declare const RAGPipelineConfigSchema: z.ZodObject<{
+    chunking: z.ZodObject<{
+        strategy: z.ZodEnum<{
+            fixed: "fixed";
+            recursive: "recursive";
+            semantic: "semantic";
+        }>;
+        chunkSize: z.ZodNumber;
+        chunkOverlap: z.ZodDefault<z.ZodNumber>;
+        separators: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>;
+    retrieval: z.ZodDefault<z.ZodObject<{
+        strategy: z.ZodDefault<z.ZodEnum<{
+            similarity: "similarity";
+            mmr: "mmr";
+            hybrid: "hybrid";
+            "multi-query": "multi-query";
+        }>>;
+        topK: z.ZodDefault<z.ZodNumber>;
+        threshold: z.ZodDefault<z.ZodNumber>;
+        mmrLambda: z.ZodOptional<z.ZodNumber>;
+        multiQueryCount: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    reranking: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodDefault<z.ZodBoolean>;
+        topN: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type ChunkingConfigInput = z.input<typeof ChunkingConfigSchema>;
+export type RetrievalConfigInput = z.input<typeof RetrievalConfigSchema>;
+export type RAGPipelineConfigInput = z.input<typeof RAGPipelineConfigSchema>;
+//# sourceMappingURL=schema.d.ts.map

package/dist/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,sBAAsB;;;;EAA6C,CAAC;AAEjF,eAAO,MAAM,oBAAoB;;;;;;;;;iBAK/B,CAAC;AAEH,eAAO,MAAM,uBAAuB;;;;;EAAyD,CAAC;AAE9F,eAAO,MAAM,qBAAqB;;;;;;;;;;;iBAMhC,CAAC;AAIH,eAAO,MAAM,qBAAqB;;;iBAGhC,CAAC;AAEH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAIlC,CAAC;AAEH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AACvE,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACzE,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC"}

package/dist/schema.js

@@ -0,0 +1,27 @@
+import { z } from 'zod';
+export const ChunkingStrategySchema = z.enum(['fixed', 'recursive', 'semantic']);
+export const ChunkingConfigSchema = z.object({
+    strategy: ChunkingStrategySchema,
+    chunkSize: z.number().int().positive(),
+    chunkOverlap: z.number().int().nonnegative().default(0),
+    separators: z.array(z.string()).optional(),
+});
+export const RetrievalStrategySchema = z.enum(['similarity', 'mmr', 'hybrid', 'multi-query']);
+export const RetrievalConfigSchema = z.object({
+    strategy: RetrievalStrategySchema.default('similarity'),
+    topK: z.number().int().positive().default(10),
+    threshold: z.number().min(0).max(1).default(0.0),
+    mmrLambda: z.number().min(0).max(1).optional(),
+    multiQueryCount: z.number().int().positive().optional(),
+});
+const retrievalDefaults = RetrievalConfigSchema.parse({});
+export const RerankingConfigSchema = z.object({
+    enabled: z.boolean().default(false),
+    topN: z.number().int().positive().optional(),
+});
+export const RAGPipelineConfigSchema = z.object({
+    chunking: ChunkingConfigSchema,
+    retrieval: RetrievalConfigSchema.default(retrievalDefaults),
+    reranking: RerankingConfigSchema.optional(),
+});
+//# sourceMappingURL=schema.js.map

package/dist/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC;AAEjF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,QAAQ,EAAE,sBAAsB;IAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACtC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IACvD,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC3C,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,KAAK,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC;AAE9F,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,QAAQ,EAAE,uBAAuB,CAAC,OAAO,CAAC,YAAY,CAAC;IACvD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IAC7C,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC;IAChD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC9C,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CACxD,CAAC,CAAC;AAEH,MAAM,iBAAiB,GAAG,qBAAqB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;AAE1D,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IACnC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC7C,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,QAAQ,EAAE,oBAAoB;IAC9B,SAAS,EAAE,qBAAqB,CAAC,OAAO,CAAC,iBAAiB,CAAC;IAC3D,SAAS,EAAE,qBAAqB,CAAC,QAAQ,EAAE;CAC5C,CAAC,CAAC"}

package/dist/tools.d.ts

@@ -0,0 +1,23 @@
+import { z } from 'zod';
+import type { RAGPipeline } from './rag-pipeline';
+export interface RAGTool<TParams = unknown> {
+    name: string;
+    description: string;
+    parameters: z.ZodType<TParams>;
+    execute: (params: TParams) => Promise<unknown>;
+}
+declare const SearchParamsSchema: z.ZodObject<{
+    query: z.ZodString;
+    limit: z.ZodOptional<z.ZodNumber>;
+    threshold: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+type SearchParams = z.infer<typeof SearchParamsSchema>;
+declare const IngestParamsSchema: z.ZodObject<{
+    source: z.ZodString;
+}, z.core.$strip>;
+type IngestParams = z.infer<typeof IngestParamsSchema>;
+export declare function createSearchTool(pipeline: RAGPipeline): RAGTool<SearchParams>;
+export declare function createIngestTool(pipeline: RAGPipeline): RAGTool<IngestParams>;
+export declare function ragTools(pipeline: RAGPipeline): [RAGTool<SearchParams>, RAGTool<IngestParams>];
+export {};
+//# sourceMappingURL=tools.d.ts.map

package/dist/tools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tools.d.ts","sourceRoot":"","sources":["../src/tools.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAElD,MAAM,WAAW,OAAO,CAAC,OAAO,GAAG,OAAO;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/B,OAAO,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CAChD;AAED,QAAA,MAAM,kBAAkB;;;;iBAItB,CAAC;AAEH,KAAK,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAEvD,QAAA,MAAM,kBAAkB;;iBAEtB,CAAC;AAEH,KAAK,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAEvD,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,CAc7E;AAED,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,CAc7E;AAED,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,WAAW,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC,CAE9F"}

package/dist/tools.js

@@ -0,0 +1,45 @@
+import { z } from 'zod';
+const SearchParamsSchema = z.object({
+    query: z.string(),
+    limit: z.number().int().positive().optional(),
+    threshold: z.number().min(0).max(1).optional(),
+});
+const IngestParamsSchema = z.object({
+    source: z.string(),
+});
+export function createSearchTool(pipeline) {
+    return {
+        name: 'rag_search',
+        description: 'Search the knowledge base using semantic search',
+        parameters: SearchParamsSchema,
+        execute: async ({ query, limit, threshold }) => {
+            try {
+                const results = await pipeline.query(query, { topK: limit, threshold });
+                return { success: true, query, results, count: results.length };
+            }
+            catch (err) {
+                return { success: false, error: err instanceof Error ? err.message : String(err) };
+            }
+        },
+    };
+}
+export function createIngestTool(pipeline) {
+    return {
+        name: 'rag_ingest',
+        description: 'Ingest documents into the knowledge base',
+        parameters: IngestParamsSchema,
+        execute: async ({ source }) => {
+            try {
+                const { documents, chunks } = await pipeline.ingest(source);
+                return { success: true, source, documents, chunks };
+            }
+            catch (err) {
+                return { success: false, error: err instanceof Error ? err.message : String(err) };
+            }
+        },
+    };
+}
+export function ragTools(pipeline) {
+    return [createSearchTool(pipeline), createIngestTool(pipeline)];
+}
+//# sourceMappingURL=tools.js.map

package/dist/tools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tools.js","sourceRoot":"","sources":["../src/tools.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAUxB,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IAClC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC7C,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;CAC/C,CAAC,CAAC;AAIH,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IAClC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;CACnB,CAAC,CAAC;AAIH,MAAM,UAAU,gBAAgB,CAAC,QAAqB;IACpD,OAAO;QACL,IAAI,EAAE,YAAY;QAClB,WAAW,EAAE,iDAAiD;QAC9D,UAAU,EAAE,kBAAkB;QAC9B,OAAO,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE;YAC7C,IAAI,CAAC;gBACH,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;gBACxE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;YAClE,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YACrF,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,QAAqB;IACpD,OAAO;QACL,IAAI,EAAE,YAAY;QAClB,WAAW,EAAE,0CAA0C;QACvD,UAAU,EAAE,kBAAkB;QAC9B,OAAO,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;YAC5B,IAAI,CAAC;gBACH,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBAC5D,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC;YACtD,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YACrF,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,QAAqB;IAC5C,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC;AAClE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cogitator-ai/rag",
-  "version": "0.1.0",
+  "version": "0.1.3",
   "description": "Retrieval Augmented Generation for Cogitator AI agents",
   "type": "module",
   "main": "./dist/index.js",