@elsium-ai/rag 0.1.6 → 0.1.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +42 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# @elsium-ai/rag
|
|
2
|
+
|
|
3
|
+
RAG pipeline, document processing, embeddings, and vector stores for [ElsiumAI](https://github.com/elsium-ai/elsium-ai).
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/@elsium-ai/rag)
|
|
6
|
+
[](https://github.com/elsium-ai/elsium-ai/blob/main/LICENSE)
|
|
7
|
+
|
|
8
|
+
## Install
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
npm install @elsium-ai/rag @elsium-ai/core
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## What's Inside
|
|
15
|
+
|
|
16
|
+
- **Document Loading** — Load documents from various sources
|
|
17
|
+
- **Chunking** — Split documents with configurable strategies (fixed-size, recursive, semantic)
|
|
18
|
+
- **Embeddings** — Generate embeddings with pluggable providers
|
|
19
|
+
- **Vector Search** — In-memory vector store with cosine similarity search
|
|
20
|
+
- **RAG Pipeline** — End-to-end retrieval-augmented generation
|
|
21
|
+
|
|
22
|
+
## Usage
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
import { createRAGPipeline, createVectorStore, createChunker } from '@elsium-ai/rag'
|
|
26
|
+
|
|
27
|
+
const store = createVectorStore()
|
|
28
|
+
const chunker = createChunker({ strategy: 'recursive', chunkSize: 512 })
|
|
29
|
+
|
|
30
|
+
const chunks = chunker.chunk(document)
|
|
31
|
+
await store.add(chunks)
|
|
32
|
+
|
|
33
|
+
const results = await store.search('What is ElsiumAI?', { topK: 5 })
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Part of ElsiumAI
|
|
37
|
+
|
|
38
|
+
This package is the RAG layer of the [ElsiumAI](https://github.com/elsium-ai/elsium-ai) framework. See the [full documentation](https://github.com/elsium-ai/elsium-ai) for guides and examples.
|
|
39
|
+
|
|
40
|
+
## License
|
|
41
|
+
|
|
42
|
+
[MIT](https://github.com/elsium-ai/elsium-ai/blob/main/LICENSE)
|
package/package.json
CHANGED