You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: ensure accuracy and remove unverifiable claims from v2.3.1 documentation
- Remove fabricated performance benchmarks and replace with general guidance
- Remove all emojis from code examples and documentation
- Remove unverifiable "Since: vX.X.X" version tags from API methods
- Simplify CHANGELOG to only list verifiable v2.3.1 features
- Remove future timeline predictions and deprecation warnings
All documentation now reflects only verified, honest information about v2.3.1.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
Creates a RAG pipeline instance with the specified plugins.
14
14
15
-
> **Since:** v2.0.0
16
-
> **Behavior:** Factory function that initializes a complete RAG pipeline by composing loader, embedder, retriever, and LLM components. Supports both plugin instances and string references to registered plugins.
15
+
**Behavior:** Factory function that initializes a complete RAG pipeline by composing loader, embedder, retriever, and LLM components. Supports both plugin instances and string references to registered plugins.
17
16
18
17
**Signature:**
19
18
@@ -38,7 +37,6 @@ function createRagPipeline(config: PipelineConfig): Pipeline;
> **Behavior:** Processes natural language queries through the complete RAG flow: embeds query → retrieves relevant documents → generates contextual response using LLM. Supports both standard and streaming response modes.
62
+
**Behavior:** Processes natural language queries through the complete RAG flow: embeds query, retrieves relevant documents, and generates contextual response using LLM. Supports both standard and streaming response modes.
68
63
69
64
**Signature:**
70
65
@@ -110,7 +105,6 @@ console.log(result.sources);
110
105
**Streaming Example:**
111
106
112
107
```javascript
113
-
// 🌊 Streaming support added in v2.0.0
114
108
conststream=awaitpipeline.query("Explain the benefits", {
115
109
stream:true,
116
110
});
@@ -126,8 +120,7 @@ for await (const chunk of stream) {
126
120
127
121
Ingests documents into the RAG pipeline.
128
122
129
-
> **Since:** v2.0.0
130
-
> **Behavior:** Loads documents from file paths or directories, chunks content, generates embeddings, and stores them in the vector database. Supports batch processing with configurable concurrency and retry logic.
123
+
**Behavior:** Loads documents from file paths or directories, chunks content, generates embeddings, and stores them in the vector database. Supports batch processing with configurable concurrency and retry logic.
131
124
132
125
**Signature:**
133
126
@@ -215,8 +208,7 @@ function normalizeConfig(config: Partial<RagConfig>): RagConfig;
215
208
216
209
Enterprise-grade JWT validation with replay protection.
217
210
218
-
> **Since:** v2.2.0
219
-
> **Behavior:** Provides cryptographically secure JWT signing and verification with built-in replay attack detection, algorithm confusion prevention, and race condition mitigation. Supports both self-signed (reusable) and external (single-use) token validation.
211
+
**Behavior:** Provides cryptographically secure JWT signing and verification with built-in replay attack detection, algorithm confusion prevention, and race condition mitigation. Supports both self-signed (reusable) and external (single-use) token validation.
Multi-layer input sanitization with path traversal defense.
310
301
311
-
> **Since:** v2.2.0
312
-
> **Behavior:** Protects against XSS, SQL injection, command injection, and path traversal attacks through multi-layer validation. Uses iterative URL decoding (up to 5 iterations) to detect sophisticated encoding-based attacks.
302
+
**Behavior:** Protects against XSS, SQL injection, command injection, and path traversal attacks through multi-layer validation. Uses iterative URL decoding (up to 5 iterations) to detect sophisticated encoding-based attacks.
313
303
314
304
**Constructor:**
315
305
@@ -385,8 +375,7 @@ try {
385
375
386
376
Process text, images, audio, and video content with unified embedding pipelines.
387
377
388
-
> **Since:** v2.2.0 (Enterprise Edition)
389
-
> **Behavior:** Handles multi-modal content (text, images, audio, video) through unified embedding generation. Automatically selects appropriate models based on content type and normalizes embeddings for cross-modal retrieval.
378
+
**Behavior:** Handles multi-modal content (text, images, audio, video) through unified embedding generation. Automatically selects appropriate models based on content type and normalizes embeddings for cross-modal retrieval.
390
379
391
380
**Constructor:**
392
381
@@ -461,8 +450,7 @@ await engine.learn({
461
450
462
451
Execute complex RAG workflows as directed acyclic graphs.
463
452
464
-
> **Since:** v2.1.0
465
-
> **Behavior:** Orchestrates complex multi-step workflows as directed acyclic graphs with automatic dependency resolution, parallel execution of independent tasks, and comprehensive error handling with retry logic.
453
+
**Behavior:** Orchestrates complex multi-step workflows as directed acyclic graphs with automatic dependency resolution, parallel execution of independent tasks, and comprehensive error handling with retry logic.
0 commit comments