@absolutejs/rag 0.0.28 → 0.0.29

package/dist/manifest.json

@@ -0,0 +1,515 @@
+{
+	"contract": 1,
+	"identity": {
+		"accent": "#10b981",
+		"category": "ai",
+		"description": "Retrieval-augmented generation for AbsoluteJS: ingest documents, URLs, and uploads into a pluggable vector store (`rag/vector-store`), embed with any provider (`rag/embedding-provider`), search with hybrid vector + lexical retrieval, optionally rerank (`rag/reranker`), and mount the `ragChat` Elysia plugin for grounded answers with citations. Evaluation suites, sync sources, and admin surfaces included.",
+		"docsUrl": "https://github.com/absolutejs/rag",
+		"name": "@absolutejs/rag",
+		"tagline": "Answer questions from your own content."
+	},
+	"implements": [
+		{
+			"contract": "rag/vector-store",
+			"factory": "createInMemoryRAGStore",
+			"from": "@absolutejs/rag",
+			"settings": {
+				"type": "object",
+				"properties": {
+					"dimensions": {
+						"description": "Vector size used by the built-in fallback embedding. Match your embedding provider's output size.",
+						"maximum": 8192,
+						"minimum": 1,
+						"title": "Vector dimensions",
+						"type": "integer"
+					}
+				}
+			},
+			"title": "In memory (development only — content is lost on restart)",
+			"wiring": {
+				"code": "createInMemoryRAGStore(${settings})",
+				"imports": [
+					{
+						"from": "@absolutejs/rag",
+						"names": [
+							"createInMemoryRAGStore"
+						]
+					}
+				]
+			}
+		},
+		{
+			"contract": "rag/embedding-provider",
+			"factory": "openaiEmbeddings",
+			"from": "@absolutejs/rag",
+			"requires": {
+				"env": [
+					{
+						"description": "OpenAI API key",
+						"docsUrl": "https://platform.openai.com/api-keys",
+						"example": "sk-xxxxxxxxx",
+						"key": "OPENAI_API_KEY",
+						"secret": true
+					}
+				]
+			},
+			"settings": {
+				"type": "object",
+				"properties": {
+					"defaultModel": {
+						"description": "Embedding model used when a request doesn't name one.",
+						"examples": [
+							"text-embedding-3-small"
+						],
+						"title": "Embedding model",
+						"type": "string"
+					},
+					"dimensions": {
+						"description": "Vector size to request from the model. Must match your vector store's configured size.",
+						"maximum": 8192,
+						"minimum": 1,
+						"title": "Vector dimensions",
+						"type": "integer"
+					}
+				}
+			},
+			"title": "OpenAI embeddings",
+			"wiring": {
+				"code": "openaiEmbeddings({ apiKey: ${env.OPENAI_API_KEY} ?? \"\", ...${settings} })",
+				"imports": [
+					{
+						"from": "@absolutejs/rag",
+						"names": [
+							"openaiEmbeddings"
+						]
+					}
+				]
+			}
+		},
+		{
+			"contract": "rag/embedding-provider",
+			"factory": "geminiEmbeddings",
+			"from": "@absolutejs/rag",
+			"requires": {
+				"env": [
+					{
+						"description": "Google AI Studio API key for Gemini",
+						"docsUrl": "https://aistudio.google.com/apikey",
+						"example": "AIzaXXXXXXXX",
+						"key": "GEMINI_API_KEY",
+						"secret": true
+					}
+				]
+			},
+			"settings": {
+				"type": "object",
+				"properties": {
+					"defaultModel": {
+						"description": "Embedding model used when a request doesn't name one.",
+						"examples": [
+							"gemini-embedding-001"
+						],
+						"title": "Embedding model",
+						"type": "string"
+					},
+					"dimensions": {
+						"description": "Vector size to request from the model. Must match your vector store's configured size.",
+						"maximum": 8192,
+						"minimum": 1,
+						"title": "Vector dimensions",
+						"type": "integer"
+					}
+				}
+			},
+			"title": "Gemini embeddings",
+			"wiring": {
+				"code": "geminiEmbeddings({ apiKey: ${env.GEMINI_API_KEY} ?? \"\", ...${settings} })",
+				"imports": [
+					{
+						"from": "@absolutejs/rag",
+						"names": [
+							"geminiEmbeddings"
+						]
+					}
+				]
+			}
+		},
+		{
+			"contract": "rag/embedding-provider",
+			"factory": "ollamaEmbeddings",
+			"from": "@absolutejs/rag",
+			"settings": {
+				"type": "object",
+				"properties": {
+					"baseUrl": {
+						"description": "Where your Ollama server is reachable.",
+						"examples": [
+							"http://localhost:11434"
+						],
+						"format": "uri",
+						"title": "Ollama server URL",
+						"type": "string"
+					},
+					"defaultModel": {
+						"description": "Embedding model used when a request doesn't name one.",
+						"examples": [
+							"nomic-embed-text"
+						],
+						"title": "Embedding model",
+						"type": "string"
+					}
+				}
+			},
+			"title": "Ollama (runs on your own machine, no API key)",
+			"wiring": {
+				"code": "ollamaEmbeddings(${settings})",
+				"imports": [
+					{
+						"from": "@absolutejs/rag",
+						"names": [
+							"ollamaEmbeddings"
+						]
+					}
+				]
+			}
+		},
+		{
+			"contract": "rag/reranker",
+			"factory": "createHeuristicRAGReranker",
+			"from": "@absolutejs/rag",
+			"title": "Built-in heuristic (no API key, keyword overlap scoring)",
+			"wiring": {
+				"code": "createHeuristicRAGReranker()",
+				"imports": [
+					{
+						"from": "@absolutejs/rag",
+						"names": [
+							"createHeuristicRAGReranker"
+						]
+					}
+				]
+			}
+		},
+		{
+			"contract": "rag/reranker",
+			"factory": "createCohereRAGReranker",
+			"from": "@absolutejs/rag",
+			"requires": {
+				"env": [
+					{
+						"description": "Cohere API key",
+						"docsUrl": "https://dashboard.cohere.com/api-keys",
+						"key": "COHERE_API_KEY",
+						"secret": true
+					}
+				]
+			},
+			"settings": {
+				"type": "object",
+				"properties": {
+					"defaultModel": {
+						"description": "Rerank model used when a request doesn't name one.",
+						"examples": [
+							"rerank-v3.5"
+						],
+						"title": "Rerank model",
+						"type": "string"
+					}
+				}
+			},
+			"title": "Cohere reranker",
+			"wiring": {
+				"code": "createCohereRAGReranker({ apiKey: ${env.COHERE_API_KEY} ?? \"\", ...${settings} })",
+				"imports": [
+					{
+						"from": "@absolutejs/rag",
+						"names": [
+							"createCohereRAGReranker"
+						]
+					}
+				]
+			}
+		},
+		{
+			"contract": "rag/reranker",
+			"factory": "createVoyageRAGReranker",
+			"from": "@absolutejs/rag",
+			"requires": {
+				"env": [
+					{
+						"description": "Voyage AI API key",
+						"docsUrl": "https://dashboard.voyageai.com",
+						"key": "VOYAGE_API_KEY",
+						"secret": true
+					}
+				]
+			},
+			"settings": {
+				"type": "object",
+				"properties": {
+					"defaultModel": {
+						"description": "Rerank model used when a request doesn't name one.",
+						"examples": [
+							"rerank-2"
+						],
+						"title": "Rerank model",
+						"type": "string"
+					}
+				}
+			},
+			"title": "Voyage AI reranker",
+			"wiring": {
+				"code": "createVoyageRAGReranker({ apiKey: ${env.VOYAGE_API_KEY} ?? \"\", ...${settings} })",
+				"imports": [
+					{
+						"from": "@absolutejs/rag",
+						"names": [
+							"createVoyageRAGReranker"
+						]
+					}
+				]
+			}
+		},
+		{
+			"contract": "rag/reranker",
+			"factory": "createJinaRAGReranker",
+			"from": "@absolutejs/rag",
+			"requires": {
+				"env": [
+					{
+						"description": "Jina AI API key",
+						"docsUrl": "https://jina.ai/api-dashboard",
+						"key": "JINA_API_KEY",
+						"secret": true
+					}
+				]
+			},
+			"settings": {
+				"type": "object",
+				"properties": {
+					"defaultModel": {
+						"description": "Rerank model used when a request doesn't name one.",
+						"examples": [
+							"jina-reranker-v2-base-multilingual"
+						],
+						"title": "Rerank model",
+						"type": "string"
+					}
+				}
+			},
+			"title": "Jina AI reranker",
+			"wiring": {
+				"code": "createJinaRAGReranker({ apiKey: ${env.JINA_API_KEY} ?? \"\", ...${settings} })",
+				"imports": [
+					{
+						"from": "@absolutejs/rag",
+						"names": [
+							"createJinaRAGReranker"
+						]
+					}
+				]
+			}
+		}
+	],
+	"requires": {
+		"peers": [
+			{
+				"name": "elysia",
+				"range": ">= 1.4.18",
+				"reason": "HTTP host for the ragChat routes"
+			}
+		]
+	},
+	"settings": {
+		"type": "object",
+		"properties": {
+			"defaultCandidateMultiplier": {
+				"description": "How many extra candidates to fetch before reranking narrows them down. Higher finds more but costs more.",
+				"maximum": 20,
+				"minimum": 1,
+				"title": "Candidate multiplier",
+				"type": "integer"
+			},
+			"defaultModel": {
+				"description": "Embedding model requested when a search doesn't name one. Leave empty to use the embedding provider's default.",
+				"title": "Default embedding model",
+				"type": "string"
+			},
+			"defaultTopK": {
+				"description": "How many matching passages a search returns by default. Default is 5.",
+				"maximum": 100,
+				"minimum": 1,
+				"title": "Results per search",
+				"type": "integer"
+			}
+		}
+	},
+	"slots": {
+		"embedding": {
+			"configPath": "embedding",
+			"contract": "rag/embedding-provider",
+			"description": "Which AI service turns your text into search vectors. Without one, a deterministic fallback is used — fine for demos, not for real semantic search.",
+			"known": [
+				"@absolutejs/rag#openai",
+				"@absolutejs/rag#gemini",
+				"@absolutejs/rag#ollama"
+			]
+		},
+		"rerank": {
+			"configPath": "rerank",
+			"contract": "rag/reranker",
+			"description": "Optional second pass that reorders search results by relevance before they are used.",
+			"known": [
+				"@absolutejs/rag#heuristic",
+				"@absolutejs/rag#cohere",
+				"@absolutejs/rag#voyage",
+				"@absolutejs/rag#jina"
+			]
+		},
+		"store": {
+			"configPath": "store",
+			"contract": "rag/vector-store",
+			"description": "Where your content's search index lives",
+			"known": [
+				"@absolutejs/rag#memory",
+				"@absolutejs/rag-pinecone",
+				"@absolutejs/rag-postgres",
+				"@absolutejs/rag-sqlite"
+			],
+			"required": true
+		}
+	},
+	"wiring": [
+		{
+			"description": "Create a searchable collection from a vector store and an embedding provider, then mount the chat routes.",
+			"id": "default",
+			"server": {
+				"code": "const ragCollection = createRAGCollection({\n\tembedding: ${slot.embedding},\n\tstore: ${slot.store},\n\t...${settings}\n});\n\n// Mount grounded chat + admin routes with: app.use(ragChat({ collection: ragCollection }))",
+				"imports": [
+					{
+						"from": "@absolutejs/rag",
+						"names": [
+							"createRAGCollection",
+							"ragChat"
+						]
+					}
+				],
+				"placement": "module-scope"
+			},
+			"title": "Create the RAG collection"
+		},
+		{
+			"description": "Same as the default recipe plus a reranking pass that reorders results by relevance before use.",
+			"id": "reranked",
+			"server": {
+				"code": "const ragCollection = createRAGCollection({\n\tembedding: ${slot.embedding},\n\trerank: ${slot.rerank},\n\tstore: ${slot.store},\n\t...${settings}\n});",
+				"imports": [
+					{
+						"from": "@absolutejs/rag",
+						"names": [
+							"createRAGCollection"
+						]
+					}
+				],
+				"placement": "module-scope"
+			},
+			"title": "Collection with reranking"
+		}
+	],
+	"tools": {
+		"ingest_status": {
+			"annotations": {
+				"readOnlyHint": true
+			},
+			"description": "Report the vector store backing this collection: backend, vector mode, dimensions, and capabilities (persistence, native vector search, server-side filtering). Not every store reports status.",
+			"input": {
+				"type": "object",
+				"properties": {}
+			},
+			"kind": "runtime"
+		},
+		"ingest_text": {
+			"annotations": {
+				"idempotentHint": true
+			},
+			"description": "Add (or replace) one text document in the search index under a stable sourceId. Re-ingesting the same sourceId replaces its previous chunks, so it is safe to repeat.",
+			"input": {
+				"type": "object",
+				"required": [
+					"sourceId",
+					"text"
+				],
+				"properties": {
+					"sourceId": {
+						"description": "Stable identifier for this document — reuse it to update, pass it to remove_source to delete.",
+						"minLength": 1,
+						"type": "string"
+					},
+					"text": {
+						"minLength": 1,
+						"type": "string"
+					},
+					"title": {
+						"type": "string"
+					}
+				}
+			},
+			"kind": "runtime"
+		},
+		"remove_source": {
+			"annotations": {
+				"destructiveHint": true,
+				"idempotentHint": true
+			},
+			"description": "Delete every indexed chunk previously ingested under a sourceId. Removing an unknown sourceId deletes nothing and succeeds.",
+			"input": {
+				"type": "object",
+				"required": [
+					"sourceId"
+				],
+				"properties": {
+					"chunkCount": {
+						"description": "Chunk count from the original ingest — needed on stores that cannot delete by metadata filter.",
+						"minimum": 0,
+						"type": "integer"
+					},
+					"sourceId": {
+						"minLength": 1,
+						"type": "string"
+					}
+				}
+			},
+			"kind": "runtime"
+		},
+		"search_content": {
+			"annotations": {
+				"readOnlyHint": true
+			},
+			"description": "Search the indexed content and return the best-matching passages with scores, titles, and sources. Use this to ground answers in the site's own content.",
+			"input": {
+				"type": "object",
+				"required": [
+					"query"
+				],
+				"properties": {
+					"query": {
+						"minLength": 1,
+						"type": "string"
+					},
+					"scoreThreshold": {
+						"description": "Drop results scoring below this value.",
+						"maximum": 1,
+						"minimum": 0,
+						"type": "number"
+					},
+					"topK": {
+						"maximum": 100,
+						"minimum": 1,
+						"type": "integer"
+					}
+				}
+			},
+			"kind": "runtime"
+		}
+	}
+}

package/dist/presentation/ui.js

@@ -1,4 +1,19 @@
 // @bun
+var __defProp = Object.defineProperty;
+var __returnValue = (v) => v;
+function __exportSetter(name, newValue) {
+  this[name] = __returnValue.bind(null, newValue);
+}
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, {
+      get: all[name],
+      enumerable: true,
+      configurable: true,
+      set: __exportSetter.bind(all, name)
+    });
+};
+
 // src/quality/quality.ts
 import { mkdir, readFile } from "fs/promises";
 
@@ -11735,5 +11750,5 @@ export {
   buildCitationGroups
 };
 
-//# debugId=6E3D7C908D19A9A964756E2164756E21
+//# debugId=9C08DC51B9E6188964756E2164756E21
 //# sourceMappingURL=ui.js.map