@elizaos/plugin-knowledge 1.5.10 → 1.5.12

package/README.md

@@ -2,6 +2,67 @@
 
 Give your AI agent the ability to learn from documents and answer questions based on that knowledge. Works out of the box with zero configuration!
 
+## 📦 Installation Modes
+
+The Knowledge plugin supports multiple deployment modes to fit your use case:
+
+### **Full Mode** (Default - With UI & Routes)
+
+Perfect for standard deployments with the full web interface:
+
+```typescript
+import { knowledgePlugin } from '@elizaos/plugin-knowledge';
+// or
+import knowledgePlugin from '@elizaos/plugin-knowledge';
+
+export const character = {
+  plugins: [knowledgePlugin],
+};
+```
+
+### **Headless Mode** (Service + Provider + Actions, No UI)
+
+For server deployments without frontend:
+
+```typescript
+import { knowledgePluginHeadless } from '@elizaos/plugin-knowledge';
+
+export const character = {
+  plugins: [knowledgePluginHeadless],
+};
+```
+
+### **Core Mode** (Service + Provider Only)
+
+For cloud runtimes or minimal deployments (no routes, no UI, no actions):
+
+```typescript
+import { knowledgePluginCore } from '@elizaos/plugin-knowledge';
+
+export const character = {
+  plugins: [knowledgePluginCore],
+};
+```
+
+### **Custom Configuration**
+
+Create your own configuration:
+
+```typescript
+import { createKnowledgePlugin } from '@elizaos/plugin-knowledge';
+
+const customPlugin = createKnowledgePlugin({
+  enableUI: false, // Disable frontend UI
+  enableRoutes: false, // Disable HTTP routes
+  enableActions: true, // Keep actions enabled
+  enableTests: false, // Disable tests
+});
+
+export const character = {
+  plugins: [customPlugin],
+};
+```
+
 ## 🚀 Getting Started (Beginner-Friendly)
 
 ### Step 1: Add the Plugin
@@ -14,7 +75,7 @@ export const character = {
   name: 'MyAgent',
   plugins: [
     '@elizaos/plugin-openai', // ← Make sure you have this
-    '@elizaos/plugin-knowledge', // ← Add this line
+    '@elizaos/plugin-knowledge', // ← Add this line (full mode)
     // ... your other plugins
   ],
   // ... rest of your character config
@@ -192,28 +253,68 @@ MAX_OUTPUT_TOKENS=4096             # Response size limit
 ```typescript
 import { KnowledgeService } from '@elizaos/plugin-knowledge';
 
+// Get the service from runtime
+const knowledgeService = runtime.getService<KnowledgeService>(KnowledgeService.serviceType);
+
 // Add knowledge programmatically
 const result = await knowledgeService.addKnowledge({
-  clientDocumentId: 'unique-doc-id',
+  agentId: runtime.agentId,
+  clientDocumentId: '' as UUID, // Auto-generated based on content
   content: documentContent, // Base64 for PDFs, plain text for others
   contentType: 'application/pdf',
   originalFilename: 'document.pdf',
-  worldId: runtime.worldId,
-  roomId: runtime.roomId,
-  entityId: runtime.entityId,
+  worldId: runtime.agentId,
+  roomId: runtime.agentId,
+  entityId: runtime.agentId,
   metadata: {
-    // Optional
+    // Optional custom metadata
     source: 'upload',
     author: 'John Doe',
   },
 });
 
-// Search knowledge
-const searchResults = await knowledgeService.searchKnowledge({
-  query: 'quantum computing',
+// The provider automatically retrieves relevant knowledge during conversations
+// But you can also search directly:
+const knowledgeItems = await knowledgeService.getKnowledge(
+  message, // The message/query
+  {
+    roomId: runtime.agentId,
+    worldId: runtime.agentId,
+    entityId: runtime.agentId,
+  }
+);
+```
+
+### Cloud/Custom Runtime Usage
+
+For cloud deployments or custom runtimes, use the core mode and access the service directly:
+
+```typescript
+import { knowledgePluginCore, KnowledgeService } from '@elizaos/plugin-knowledge';
+
+// In your cloud runtime setup
+const runtime = await createRuntime({
+  // ... your runtime config
+  plugins: [knowledgePluginCore], // Core mode: no routes, no UI
+});
+
+// Access the service
+const knowledgeService = runtime.getService<KnowledgeService>(KnowledgeService.serviceType);
+
+// Add documents
+await knowledgeService.addKnowledge({
   agentId: runtime.agentId,
-  limit: 10,
+  clientDocumentId: '' as UUID,
+  content: base64Content,
+  contentType: 'application/pdf',
+  originalFilename: 'company-docs.pdf',
+  worldId: runtime.agentId,
+  roomId: runtime.agentId,
+  entityId: runtime.agentId,
 });
+
+// The knowledge provider will automatically inject relevant context
+// into the agent's conversations based on the query
 ```
 
 </details>

package/dist/.vite/manifest.json

@@ -1,11 +1,11 @@
 {
   "index.html": {
-    "file": "assets/index-C_sAxTPC.js",
+    "file": "assets/index-DtOcbZ9V.js",
     "name": "index",
     "src": "index.html",
     "isEntry": true,
     "css": [
-      "assets/index-B5VEkqpw.css"
+      "assets/index-crC0VS8M.css"
     ]
   }
 }