openkbs 0.0.34 → 0.0.36

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openkbs",
-  "version": "0.0.34",
+  "version": "0.0.36",
   "description": "OpenKBS - Command Line Interface",
   "main": "src/index.js",
   "scripts": {

package/src/actions.js

@@ -538,6 +538,119 @@ async function downloadModifyAction() {
     });
 }
 
+async function updateKnowledgeAction() {
+    try {
+        const knowledgeDir = path.join(process.cwd(), '.openkbs', 'knowledge');
+        const metadataPath = path.join(knowledgeDir, 'metadata.json');
+        
+        // Check if .openkbs/knowledge directory exists
+        if (!fs.existsSync(knowledgeDir)) {
+            console.red('Knowledge directory not found. Please ensure you are in an OpenKBS project directory.');
+            return;
+        }
+        
+        // Get local metadata version
+        let localVersion = null;
+        if (fs.existsSync(metadataPath)) {
+            try {
+                const localMetadata = JSON.parse(fs.readFileSync(metadataPath, 'utf8'));
+                localVersion = localMetadata.version;
+            } catch (error) {
+                console.red('Error reading local metadata.json:', error.message);
+                return;
+            }
+        }
+        
+        // Check remote version from S3
+        const { S3Client, GetObjectCommand } = require("@aws-sdk/client-s3");
+        const s3Client = new S3Client({ region: 'us-east-1' });
+        const bucket = 'openkbs-downloads';
+        const remoteMetadataKey = 'templates/.openkbs/knowledge/metadata.json';
+        
+        let remoteVersion = null;
+        try {
+            const response = await s3Client.send(new GetObjectCommand({
+                Bucket: bucket,
+                Key: remoteMetadataKey
+            }));
+            
+            const remoteMetadataContent = await response.Body.transformToString();
+            const remoteMetadata = JSON.parse(remoteMetadataContent);
+            remoteVersion = remoteMetadata.version;
+        } catch (error) {
+            console.red('Error fetching remote metadata:', error.message);
+            return;
+        }
+        
+        // Compare versions
+        if (localVersion === remoteVersion) {
+            console.green('Knowledge base is already up to date.');
+            return;
+        }
+        
+        console.log(`Updating knowledge base from version ${localVersion || 'unknown'} to ${remoteVersion}...`);
+        
+        // Download updated knowledge files from S3
+        await downloadKnowledgeFromS3(knowledgeDir);
+        
+        console.green('Knowledge base updated successfully!');
+        
+    } catch (error) {
+        console.red('Error updating knowledge base:', error.message);
+    }
+}
+
+async function downloadKnowledgeFromS3(targetDir) {
+    const { S3Client, ListObjectsV2Command, GetObjectCommand } = require("@aws-sdk/client-s3");
+    const s3Client = new S3Client({ region: 'us-east-1' });
+    const bucket = 'openkbs-downloads';
+    const prefix = 'templates/.openkbs/knowledge/';
+    
+    try {
+        // List all objects in knowledge folder
+        const listResponse = await s3Client.send(new ListObjectsV2Command({
+            Bucket: bucket,
+            Prefix: prefix
+        }));
+        
+        if (!listResponse.Contents || listResponse.Contents.length === 0) {
+            console.yellow('No knowledge files found in remote repository.');
+            return;
+        }
+        
+        // Download all files in parallel
+        const downloadPromises = listResponse.Contents.map(async (obj) => {
+            const key = obj.Key;
+            const relativePath = key.substring(prefix.length);
+            
+            // Skip if it's a directory marker
+            if (relativePath.endsWith('/') || relativePath === '') return;
+            
+            const localPath = path.join(targetDir, relativePath);
+            
+            // Ensure directory exists
+            await fs.ensureDir(path.dirname(localPath));
+            
+            // Download file
+            const response = await s3Client.send(new GetObjectCommand({
+                Bucket: bucket,
+                Key: key
+            }));
+            
+            const fileContent = await response.Body.transformToByteArray();
+            await fs.writeFile(localPath, fileContent);
+            
+            console.log(`Downloaded: ${relativePath}`);
+        });
+        
+        await Promise.all(downloadPromises);
+        
+    } catch (error) {
+        console.red('Error downloading knowledge files from S3:', error.message);
+        throw error;
+    }
+}
+
 module.exports = {
     signAction,
     loginAction,
@@ -554,5 +667,6 @@ module.exports = {
     logoutAction,
     installFrontendPackageAction,
     modifyAction,
-    downloadModifyAction
+    downloadModifyAction,
+    updateKnowledgeAction
 };

package/src/index.js

@@ -12,7 +12,8 @@ const {
     deleteKBAction,
     deleteFileAction,
     describeAction, deployAction, createByTemplateAction, initByTemplateAction,
-    logoutAction, installFrontendPackageAction, modifyAction, downloadModifyAction
+    logoutAction, installFrontendPackageAction, modifyAction, downloadModifyAction,
+    updateKnowledgeAction
 } = require('./actions');
 
 
@@ -153,4 +154,24 @@ This will download the MODIFY.md template file from the OpenKBS GitHub repositor
 This file will be automatically included when you run the 'openkbs modify' command.
 `);
 
+program
+    .command('update')
+    .argument('<target>', 'The target to update (currently supports: knowledge)')
+    .description('Update project components from remote repository')
+    .action((target) => {
+        if (target === 'knowledge') {
+            updateKnowledgeAction();
+        } else {
+            console.error(`Unknown update target: ${target}. Currently supported: knowledge`);
+            process.exit(1);
+        }
+    })
+    .addHelpText('after', `
+Examples:
+  $ openkbs update knowledge
+  
+This will check if your local .openkbs/knowledge directory is up to date with the remote repository
+and update it if necessary.
+`);
+
 program.parse(process.argv);

package/src/utils.js

@@ -970,8 +970,14 @@ async function uploadFiles(namespaces, kbId, kbToken, location = 'origin', targe
     const localDir = dist ? path.join(process.cwd(), 'cache') : path.join(process.cwd(), 'src');
     const filesMap = await buildLocalFilesMap(localDir, namespaces);
     let filesToUpload = [];
+    const isInOpenKBSFolder = (fileName) => fileName.startsWith('.openkbs/') || fileName.includes('/.openkbs/');
 
     if (targetFile) {
+        // Skip if target file is in .openkbs folder
+        if (isInOpenKBSFolder(targetFile)) {
+            console.log(`Skipping file in .openkbs folder: ${targetFile}`);
+            return false;
+        }
         const isDistFile = targetFile.startsWith('Events/dist') || targetFile.startsWith('Frontend/dist');
         if (filesMap[targetFile] && ((dist && isDistFile) || (!dist && !isDistFile))) {
             filesToUpload.push({ ...filesMap[targetFile], fileName: targetFile });
@@ -979,8 +985,10 @@ async function uploadFiles(namespaces, kbId, kbToken, location = 'origin', targe
             return false; // File not found locally or not in the correct folder
         }
     } else {
-        // No target file, upload all files based on the dist parameter
+        // No target file, upload all files based on the dist parameter, excluding .openkbs files
         filesToUpload = Object.keys(filesMap).filter(fileName => {
+            // Skip files in .openkbs folder
+            if (isInOpenKBSFolder(fileName)) return false;
             const isDistFile = fileName.startsWith('Events/dist') || fileName.startsWith('Frontend/dist');
             return dist ? isDistFile : !isDistFile;
         }).map(fileName => {
@@ -1077,6 +1085,15 @@ async function downloadTemplatesFromS3(targetDir) {
     
     // Wait for all downloads to complete
     await Promise.all(downloadPromises);
+    
+    // Add .openkbs/* to .gitignore
+    const gitignorePath = path.join(targetDir, '.gitignore');
+    if (await fs.pathExists(gitignorePath)) {
+        let content = await fs.readFile(gitignorePath, 'utf8');
+        if (!content.includes('.openkbs/*')) {
+            await fs.writeFile(gitignorePath, content.trim() + '\n.openkbs/*\n');
+        }
+    }
 }
 
 const generateKey = (passphrase) => {

package/templates/.openkbs/knowledge/README.md

@@ -0,0 +1,34 @@
+# OpenKBS Development Guidelines
+
+## Development Flow
+
+1. **Read existing code first:**
+   - `./app/` folder (settings, instructions, etc.)
+   - `./src/` folder (all Events and Frontend files)
+
+2. **Assess implementation requirements:**
+   - **Minor changes only**: Simple modifications to existing code that don't require framework knowledge
+   - **Framework implementation needed**: New features, new event handlers, new frontend components, or placeholder app development
+
+3. **For framework implementation:**
+   - Read all source code in `.openkbs/knowledge/examples/`
+   - Study complete working applications to understand OpenKBS patterns
+   - Never guess framework methods or variables - always reference examples
+
+## When Examples Are Required
+
+- New OpenKBS application development (placeholder app)
+- Adding new event handlers (onRequest, onResponse, etc.)
+- Creating new frontend components
+- Implementing OpenKBS-specific functionality
+- Any framework-related implementation
+
+## When Examples May Not Be Needed
+
+- Simple text changes to existing files
+- Minor bug fixes in existing code
+- Configuration adjustments that don't involve framework methods
+
+## Critical Rule
+
+**When in doubt, read the examples.** They contain all necessary framework knowledge for proper OpenKBS implementation.

package/templates/.openkbs/knowledge/examples/ai-copywriter/app/instructions.txt

@@ -0,0 +1,61 @@
+You are an autonomous agent for crafting intelligent, creative, and consistent content:
+
+Job:
+- Find and open at least one site that have correct, reliable and detailed information about the product
+- paraphrase and enrich it and generate a SEO friendly product description
+- Always search the official website of the manufacturer (Brand) and find information about the product from there.
+- If you see additional instructions in PROCESS_PRODUCT, execute them.
+- When you have obtained all the necessary information, output JOB_COMPLETED response.
+
+Guidelines:
+- use webpageToText command to read websites content in details
+- Always output one command per response and wait for the response before continuing
+- If an API call fails, so that you can't extract a required data, retry with different website or search query
+- When searching for product information, use the format: Product Name + Product Code.
+- Once all necessary information is obtained, deliver the final result using the following JSON format
+
+Output Format Success:
+{
+  "type": "JOB_COMPLETED",
+  "productID": "[productID]",
+  "productDescription": "[short plain text description]",
+  "metaDescription": "...",
+  "images": [{"url": "...", "title": "..."}, ...],
+  "attributes": {"size": "L", ...},
+  "videos": [
+    {"url": "[video1_url]", "title": "[video1_title]"},
+    {"url": "[video2_url]", "title": "[video2_title]"}
+  ]
+}
+
+Description: """
+Use this JSON format to output the final job response
+"""
+
+Output Format Failed:
+{"type": "JOB_FAILED", "reason": "fail reason summary"}
+Description: """
+Output this JSON format if you can't extract the required data
+"""
+
+List of API commands you can use to accomplish the Task:
+
+/googleSearch("query")
+Description: """
+Get results from Google Search API.
+"""
+
+/youtubeSearch("query")
+Description: """
+Get results from youtube Search API.
+"""
+
+/googleImageSearch("query")
+Description: """
+Get results from google Image Search
+"""
+
+/webpageToText("URL")
+Description: """
+Use this API to open/read a web pages like product pages.
+"""

package/templates/.openkbs/knowledge/examples/ai-copywriter/app/settings.json

@@ -0,0 +1,13 @@
+{
+  "chatVendor": "anthropic",
+  "kbDescription": "An autonomous AI powerhouse for content generation",
+  "kbTitle": "Copywriter",
+  "model": "claude-3-5-haiku-20241022",
+  "inputTools": [
+    "imageToText"
+  ],
+  "embeddingModel": "none",
+  "embeddingDimension": "none",
+  "searchEngine": "IndexedDB",
+  "itemTypes": {}
+}

package/templates/.openkbs/knowledge/examples/ai-copywriter/run_agent.js

@@ -0,0 +1,120 @@
+const https = require('https');
+const fs = require('fs');
+const readline = require('readline');
+const path = require('path');
+
+const settings = JSON.parse(fs.readFileSync('app/settings.json', 'utf8'));
+const secretsPath = path.join('.openkbs', 'secrets.json');
+let apiKey;
+
+const message = `PROCESS_PRODUCT:
+    Product Name: iPhone 14 Pro Max
+    Product Code: MQ9X3RX/A
+    ID: 97649
+    
+    find at least 2 images and 2 videos
+`;
+
+if (!settings.kbId) {
+    console.log('First use: "openkbs push" To create the agent')
+    return;
+}
+
+// Function to read the API key from secrets.json
+function getApiKey() {
+    if (fs.existsSync(secretsPath)) {
+        const secrets = JSON.parse(fs.readFileSync(secretsPath, 'utf8'));
+        return secrets.apiKey;
+    }
+    return null;
+}
+
+function promptForApiKey() {
+    return new Promise((resolve) => {
+        const rl = readline.createInterface({
+            input: process.stdin,
+            output: process.stdout
+        });
+
+        console.log(`Please generate an API key from: https://${settings.kbId}.apps.openkbs.com/?tab=access&createAPIKey=api-${+new Date()}`);
+
+        rl.question('Enter your API key: ', (key) => {
+            rl.close();
+            resolve(key);
+        });
+
+        rl._writeToOutput = (str) => rl.output.write(rl.line ? "*" : str);
+    });
+}
+
+function saveApiKey(key) {
+    if (!fs.existsSync('.openkbs')) {
+        fs.mkdirSync('.openkbs');
+    }
+    fs.writeFileSync(secretsPath, JSON.stringify({ apiKey: key }, null, 2));
+}
+
+async function main() {
+    apiKey = getApiKey();
+
+    if (!apiKey) {
+        apiKey = await promptForApiKey();
+        console.log('\n')
+        saveApiKey(apiKey);
+    }
+
+    const app = { kbId: settings.kbId, apiKey };
+
+    const chatTitle = "Task " + new Date().getTime();
+    startJob(chatTitle, message, app).then(chatId => {
+        console.log(`Job ${chatId} created.\nWorking ...`);
+        pollForMessages(chatId, app);
+    }).catch(console.error);
+}
+
+function startJob(chatTitle, data, app) {
+    return makeRequest('https://chat.openkbs.com/', { ...app, chatTitle, message: data })
+        .then(res => {
+            try {
+                return JSON.parse(res)[0].createdChatId;
+            } catch (error) {
+                fs.unlinkSync(secretsPath);
+                throw 'Authentication failed.';
+            }
+        });
+}
+
+function makeRequest(url, payload) {
+    return new Promise((resolve, reject) => {
+        const { hostname, pathname } = new URL(url);
+        const req = https.request({
+            hostname, path: pathname, method: 'POST',
+            headers: { 'Content-Type': 'application/json' }
+        }, res => {
+            let data = '';
+            res.on('data', chunk => data += chunk);
+            res.on('end', () => resolve(data));
+        }).on('error', reject);
+
+        req.write(JSON.stringify(payload));
+        req.end();
+    });
+}
+
+function pollForMessages(chatId, app) {
+    const payload = { ...app, action: 'getChatMessages', chatId, decryptContent: true };
+    const interval = setInterval(() => {
+        makeRequest('https://chat.openkbs.com/', payload).then(jsonString => {
+            const messages = JSON.parse(jsonString)[0].data.messages;
+            for (const message of messages) {
+                if (message.role === 'system' && /{"type"\s*:\s*"(JOB_COMPLETED|JOB_FAILED)".*?}/s.test(message.content)) {
+                    console.log(JSON.parse(message.content).data[0]);
+                    clearInterval(interval);
+                    return;
+                }
+            }
+        }).catch(console.error);
+    }, 1000);
+}
+
+main();

package/templates/.openkbs/knowledge/examples/ai-copywriter/src/Events/actions.js

@@ -0,0 +1,152 @@
+const extractJSONFromText = (text) => {
+    let braceCount = 0, startIndex = text.indexOf('{');
+    if (startIndex === -1) return null;
+
+    for (let i = startIndex; i < text.length; i++) {
+        if (text[i] === '{') braceCount++;
+        if (text[i] === '}' && --braceCount === 0) {
+            try {
+                return JSON.parse(text.slice(startIndex, i + 1));
+            } catch {
+                return null;
+            }
+        }
+    }
+    return null;
+}
+
+export const getActions = () => [
+    [/[\s\S]*"type"\s*:\s*"JOB_COMPLETED"[\s\S]*/, async (match, event) => {
+        const parsedData = extractJSONFromText(match[0]);
+        if (parsedData && parsedData.type === "JOB_COMPLETED") {
+            await openkbs.chats({
+                action: "updateChat",
+                title: await openkbs.encrypt(parsedData?.name),
+                chatIcon: '🟢',
+                chatId: event?.payload?.chatId
+            })
+
+            return parsedData;
+        }
+    }],
+
+
+    [/[\s\S]*"type"\s*:\s*"JOB_FAILED"[\s\S]*/, async (match, event) => {
+        const json = extractJSONFromText(match[0]);
+        if (json && json.type === "JOB_FAILED") {
+            await openkbs.chats({
+                action: "updateChat",
+                title: await openkbs.encrypt(json.reason),
+                chatIcon: '🔴',
+                chatId: event?.payload?.chatId
+            })
+        }
+    }],
+
+    [/\/?googleSearch\("(.*?)"(?:,\s*(\d+))?\)/, async (match) => {
+        const q = match[1];
+        const limit = match[2] ? parseInt(match[2]) : 5;
+
+        try {
+            const response = await openkbs.googleSearch(q, {});
+            const data = response?.map(({ title, link, snippet, pagemap }) => ({
+                title, link, snippet, image: pagemap?.metatags?.[0]?.["og:image"]
+            })).slice(0, limit);
+
+            if(!data?.length) return { data: { error: "No results found" } };
+            return { data };
+        } catch (e) {
+            return { error: e.message };
+        }
+    }],
+
+    [/\/?youtubeSearch\("(.*?)"(?:,\s*(\d+))?\)/, async (match) => {
+        const q = match[1];
+        const limit = match[2] ? parseInt(match[2]) : 5;
+        try {
+            const response = await openkbs.googleSearch(q + ' site:youtube.com', { videoOnly: true });
+            const data = response?.map(({ title, link, snippet, pagemap }) => ({
+                title,
+                link: link.replace('www.youtube.com/watch?v=', 'youtu.be/'),
+                snippet,
+                thumbnail: pagemap?.videoobject?.[0]?.thumbnailurl || pagemap?.metatags?.[0]?.["og:image"],
+                duration: pagemap?.videoobject?.[0]?.duration,
+                channel: pagemap?.metatags?.[0]?.["og:site_name"],
+            })).filter(item => item.link.includes('youtu')).slice(0, limit);
+
+            if(!data?.length) return { data: { error: "No YouTube videos found" } };
+            return { data };
+        } catch (e) {
+            return { error: e.message };
+        }
+    }],
+
+    [/\/?googleImageSearch\("(.*?)"(?:,\s*(\d+))?\)/, async (match) => {
+        const q = match[1];
+        const limit = match[2] ? parseInt(match[2]) : 10;
+
+        try {
+            const response = await openkbs.googleSearch(q, { searchType: 'image' });
+            const data = response?.map(({ title, link, snippet, pagemap }) => {
+                const imageObj = pagemap?.cse_image?.[0];
+                const thumbnail = imageObj?.src || pagemap?.metatags?.[0]?.["og:image"] || link;
+                return {
+                    title,
+                    link: link,
+                    snippet,
+                    image: thumbnail
+                };
+            })?.slice(0, limit);
+
+            if (!data?.length) return { data: { error: "No image results found" } };
+            return { data };
+
+        } catch (e) {
+            return { error: e.message };
+        }
+    }],
+
+    [/\/?webpageToText\("(.*)"\)/, async (match) => {
+        try {
+            let response = await openkbs.webpageToText(match[1]);
+
+            // limit output length
+            if (response?.content?.length > 5000) {
+                response.content = response.content.substring(0, 5000);
+            }
+            if(!response?.url) return { data: { error: "Unable to read website" } };
+            return { data: response };
+        } catch (e) {
+            return { error: e.response?.data || e };
+        }
+    }],
+
+    [/\/?documentToText\("(.*)"\)/, async (match) => {
+        try {
+            let response = await openkbs.documentToText(match[1]);
+
+            // limit output length
+            if (response?.text?.length > 5000) {
+                response.text = response.text.substring(0, 5000);
+            }
+
+            return { data: response };
+        } catch (e) {
+            return { error: e.response.data };
+        }
+    }],
+
+    [/\/?imageToText\("(.*)"\)/, async (match) => {
+        try {
+            let response = await openkbs.imageToText(match[1]);
+
+            if (response?.detections?.[0]?.txt) {
+                response = { detections: response?.detections?.[0]?.txt };
+            }
+
+            return { data: response };
+        } catch (e) {
+            return { error: e.response.data };
+        }
+    }],
+];

package/templates/.openkbs/knowledge/examples/ai-copywriter/src/Events/onResponse.js

@@ -0,0 +1,59 @@
+import {getActions} from './actions.js';
+
+export const handler = async (event) => {
+    const maxSelfInvokeMessagesCount = 60;
+    const lastMessage = event.payload.messages[event.payload.messages.length - 1].content;
+    
+    // Check if this is a JOB_COMPLETED or JOB_FAILED event
+    const isJobCompleted = /"type"\s*:\s*"JOB_COMPLETED"/.test(lastMessage);
+    const isJobFailed = /"type"\s*:\s*"JOB_FAILED"/.test(lastMessage);
+
+    const actions = getActions();
+
+    const matchingActions = actions.reduce((acc, [regex, action]) => {
+        const matches = [...lastMessage.matchAll(new RegExp(regex, 'g'))];
+        matches.forEach(match => {
+            acc.push(action(match, event));
+        });
+        return acc;
+    }, []);
+
+    const isJobFinished = isJobCompleted || isJobFailed;
+
+    const meta = {
+        _meta_actions:
+            (
+                event?.payload?.messages?.length > maxSelfInvokeMessagesCount ||
+                isJobFinished && (matchingActions.length === 1 || lastMessage.role === 'system')
+            )
+                ? []
+                : ["REQUEST_CHAT_MODEL"]
+    }
+
+    if (matchingActions.length > 0) {
+        try {
+            const results = await Promise.all(matchingActions);
+
+            if (results?.[0]?.data?.some?.(o => o?.type === 'image_url')) {
+                return {
+                    ...results[0],
+                    ...meta
+                };
+            }
+
+            return {
+                type: 'RESPONSE',
+                data: results,
+                ...meta
+            };
+        } catch (error) {
+            return {
+                type: 'ERROR',
+                error: error.message,
+                ...meta
+            };
+        }
+    }
+
+    return { type: 'CONTINUE' };
+};

package/templates/.openkbs/knowledge/examples/ai-copywriter/src/Events/onResponse.json

@@ -0,0 +1,4 @@
+{
+    "dependencies": {
+    }
+}

package/templates/.openkbs/knowledge/examples/ai-copywriter/src/Frontend/contentRender.js

@@ -0,0 +1,26 @@
+import React, { useEffect } from "react";
+
+const onRenderChatMessage = async (params) => {
+    return;
+};
+
+const Header = ({ setRenderSettings }) => {
+    useEffect(() => {
+        setRenderSettings({
+            inputLabelsQuickSend: true,
+            disableBalanceView: false,
+            disableSentLabel: false,
+            disableChatAvatar: false,
+            disableChatModelsSelect: false,
+            disableContextItems: false,
+            disableCopyButton: false,
+            disableEmojiButton: false,
+            disableTextToSpeechButton: false,
+            disableMobileLeftButton: false,
+        });
+    }, [setRenderSettings]);
+}
+
+const exports = { onRenderChatMessage, Header };
+window.contentRender = exports;
+export default exports;

package/templates/.openkbs/knowledge/examples/ai-copywriter/src/Frontend/contentRender.json

@@ -0,0 +1,10 @@
+{
+  "dependencies": {
+    "react": "^18.2.0 (fixed)",
+    "react-dom": "^18.2.0 (fixed)",
+    "@mui/material": "^5.16.1 (fixed)",
+    "@mui/icons-material": "^5.16.1 (fixed)",
+    "@emotion/react": "^11.10.6 (fixed)",
+    "@emotion/styled": "^11.10.6 (fixed)"
+  }
+}

package/templates/.openkbs/knowledge/metadata.json

@@ -0,0 +1,3 @@
+{
+  "version": "0.0.1"
+}

package/templates/CLAUDE.md

@@ -0,0 +1,15 @@
+# Claude Code Instructions
+
+## Initial Setup
+1. First, update the knowledge base to ensure you have the latest information:
+   ```bash
+   openkbs update knowledge
+   ```
+
+2. Then read the project contribution guidelines:
+   ```bash
+   # Read the knowledge base README for detailed instructions
+   .openkbs/knowledge/README.md
+   ```
+
+This file contains comprehensive instructions on how to contribute to this OpenKBS project.

package/ON_PREMISES.md

@@ -1,215 +0,0 @@
-
-### Running the Backend Locally (On-Premises)
-
-To run the backend services of your AI application locally, follow these steps. This allows you to manage chat services, code execution, and AI LLM services on your own infrastructure.
-
-#### Running the Chat Service Locally
-
-1. **Start the Chat Service**:
-   - Open a new terminal and navigate to the root folder of your application.
-   - Run the following command:
-
-     ```bash
-     npm run chat
-     ```
-
-   - If LocalStack is not installed, you will receive instructions on how to install it based on your platform.
-   - Open another terminal, navigate to `/tmp`, and install LocalStack using the suggested commands and retrun `npm run chat`
-
-
-4. **Configure OpenAI Key**:
-   - Enter your `OPENAI_KEY` when prompted. This key will be stored at `~/.openkbs/.env`.
-
-5. **Access the Local Chat Service**:
-   - Refresh your browser at `http://{kbId}.apps.localhost:38593/chat`.
-   - You will see "On-Premises" in green text, indicating that your OpenKBS instance is using the local chat server to communicate with the OpenAI streaming API.
-   - You can remove the cloud models options by setting `"enableCloudModels": false` in `config.json`
-
-#### Running the Code Execution Service Locally
-
-1. **Start the Code Execution Service**:
-   - Open another terminal tab, navigate to the root folder of your KB app, and run:
-
-     ```bash
-     npm run code
-     ```
-
-2. **Enter Secrets**:
-   - You may be prompted to enter any secret placeholders in your `./src/Events/actions.js`. By default, this includes `googlesearch_api_key` and `googlesearch_engine_id`.
-   - You can press enter to skip, but for using Google Search as an AI tool, it's recommended to fill them. Google provides 100 free searches per day.
-
-Congratulations! The LLM can now execute NodeJS code directly on your machine!
-
-#### Enhancing Your Application with Code Execution
-
-To utilize the code execution feature, follow these steps:
-
-1. **Update `contentRender.js`**:
-    - Modify your local `contentRender.js` file to match the version found at [contentRender.js](./examples/cloud-master/contentRender.js). This update will provide the necessary UI components for local code execution and response rendering.
-
-2. **Update `instructions.txt`**:
-    - Edit your local `instructions.txt` file to include the instructions found at [instructions.txt](./examples/cloud-master/instructions.txt). These instructions will guide the LLM on how to output code and other API commands for execution by the OpenKBS framework.
-   
-3. **Push the new instructions**:
-   - we have to push the instructions which are stored encrypted at OpenKBS registry:
-     ```bash
-     openkbs push origin app/instructions.txt 
-     ```
-   - push to localstack to build and deploy all Node.js events - ./src/Events
-     ```bash
-     openkbs push localstack
-     ```
-4. **Requesting the AI to Perform Tasks on Your PC and AWS Cloud**:
-   - Instruct the AI to list your desktop files, review the code, click `execute`, and click `send`:
-        ```
-        List my desktop files
-        ```
-   - Instruct the AI to create an S3 bucket and backup your desktop images to it:
-        ```
-        Create an S3 bucket and back up my desktop images to it
-        ```
-![backup.png](examples%2Fcloud-master%2Fbackup.png)
----
-
-## Installing openkbs-ai-server and Integrating Llama 3.1 and Stable Diffusion 3 Locally
-
-![llama-loaded.png](examples%2Fcloud-master%2Fllama-loaded.png)
-
-To set up the `openkbs-ai-server` and integrate advanced AI models like Llama 3.1 and Stable Diffusion 3 on your local machine, follow the steps outlined below.
-
-### Prerequisites
-
-Ensure you have the following prerequisites installed and configured:
-
-- Ubuntu 22.04 or a compatible Linux distribution.
-- Python 3.10 and virtual environment tools.
-- Node.js and npm.
-- NVIDIA or AMD GPU drivers, depending on your hardware.
-
-Please follow the installation on [GitHub](https://github.com/open-kbs/openkbs-ai-server).
-
-### Step 1: Checkout, Build, and Run
-
-Clone the `openkbs-ai-server` repository and set up the environment:
-
-```bash
-git clone git@github.com:open-kbs/openkbs-ai-server.git
-cd openkbs-ai-server/cluster
-npm i
-cd ..
-python -m venv .env
-source .env/bin/activate
-```
-
-**IMPORTANT: SELECT THE CORRECT GPU INSTRUCTIONS BELOW. DO NOT EXECUTE BOTH.**
-
-#### **FOR AMD GPUS:**
-
-**ONLY FOLLOW THESE INSTRUCTIONS IF YOU HAVE AN AMD GPU.**
-
-Install necessary libraries and Python packages:
-
-```bash
-sudo apt-get install -y libjpeg-dev libpng-dev
-pip install wheel setuptools
-pip install --pre torch torchvision torchaudio --index-url https://download.pytorch.org/whl/nightly/rocm6.1/
-pip install -r ./models/requirements_AMD.txt
-```
-
-#### **FOR NVIDIA GPUS:**
-
-**ONLY FOLLOW THESE INSTRUCTIONS IF YOU HAVE AN NVIDIA GPU.**
-
-Install the required Python packages:
-
-```bash
-pip install torch
-pip install -r ./models/requirements_NVIDIA.txt
-```
-
-### Step 2: Configure Hugging Face Authentication
-
-Log in to Hugging Face to access the AI models:
-
-```bash
-huggingface-cli login
-```
-
-Enter your Hugging Face token when prompted.
-
-### Step 3: Install Global Node.js Packages
-
-Install global Node.js packages required for running the server:
-
-```bash
-npm install -g pm2 nodemon react-scripts
-```
-
-### Step 4: Start the AI Server
-
-Launch the AI server using the provided script:
-
-```bash
-./start.sh
-```
-
-This command will start both the frontend and backend services using pm2. Your default web browser should automatically open to [http://localhost:7080/register](http://localhost:7080/register), where you can register the admin account for the AI server.
-
-### Step 5: Install AI Models
-
-In the AI server admin panel, search for and install the following models:
-
-- **Llama-3.1-8B-Instruct**: Ensure you have access to [Llama-3.1-8B-Instruct](https://huggingface.co/meta-llama/Llama-3.1-8B-Instruct) on Hugging Face.
-- **Stable Diffusion 3**: Ensure you have access to [Stable Diffusion 3](https://huggingface.co/stabilityai/stable-diffusion-3-medium) on Hugging Face.
-
-After installation, restart your chat server to apply the changes.
-
-### Step 6: Integrate Stable Diffusion under Events actions, so that Llama can call it
-
-Go to your app root folder
-```bash
-cd my-pc-agent
-```
-
-Add to `./src/Events/actions.js`
-```javascript
-    [/\/?textToImage\("(.*)"\)/, async (match) => {
-        try {
-            const response = await axios.get(`http://localhost:8080/pipe/stabilityai--stable-diffusion-3-medium-diffusers--default?prompt=${encodeURIComponent(match[1])}`, {
-                responseType: 'arraybuffer'
-            });
-
-            const base64Data = Buffer.from(response.data, 'binary').toString('base64');
-            const contentType = response.headers['content-type'];
-            const imageSrc = `data:${contentType};base64,${base64Data}`;
-
-            return { type: 'SAVED_CHAT_IMAGE', imageSrc, ...meta };
-        } catch (error) {
-            console.error('Error fetching image:', error);
-            throw error; // or handle the error as needed
-        }
-    }]
-```
-
-Push the changes:
-```bash
-openkbs push localstack
-```
-### Step 7: Test Llama agent
-
-Once the models are installed and the server is running, select `Llama-3.1-8B-Inst` in your Chat Models selection and type in the chat:
-
-```
-Hey Llama, search Google for the latest AI news and wait, then generate news image. Finally, use a template function to create an HTML page hosted on the S3 bucket 'ai-news-openkbs'.
-```
-
-![ai1.png](examples%2Fcloud-master%2Fai1.png)
-
-![llama-loaded.png](examples%2Fcloud-master%2Fllama-loaded.png)
-
-![sd3-loaded.png](examples%2Fcloud-master%2Fsd3-loaded.png)
-
-![ai2.png](examples%2Fcloud-master%2Fai2.png)
-
-![ai3.png](examples%2Fcloud-master%2Fai3.png)
-Have fun!

package/examples/cloud-master/actions.js

@@ -1,34 +0,0 @@
-export const getActions = (meta) => [
-    [/\/?googleSearch\("(.*)"\)/, async (match) => {
-        const q = match[1];
-        try {
-            const noSecrets = '{{secrets.googlesearch_api_key}}'.includes('secrets.googlesearch_api_key');
-            const params = { q, ...(noSecrets ? {} : { key: '{{secrets.googlesearch_api_key}}', cx: '{{secrets.googlesearch_engine_id}}' }) };
-            const response = noSecrets
-                ? await openkbs.googleSearch(params.q, params)
-                : (await axios.get('https://www.googleapis.com/customsearch/v1', { params }))?.data?.items;
-            const data = response?.map(({ title, link, snippet, pagemap }) => ({
-                title, link, snippet, image: pagemap?.metatags?.[0]?.["og:image"]
-            }));
-            return { data, ...meta };
-        } catch (e) {
-            return { error: e.response.data, ...meta };
-        }
-    }],
-    [/\/?textToImage\("(.*)"\)/, async (match) => {
-        try {
-            const response = await axios.get(`http://localhost:8080/pipe/stabilityai--stable-diffusion-3-medium-diffusers--default?prompt=${encodeURIComponent(match[1])}`, {
-                responseType: 'arraybuffer'
-            });
-
-            const base64Data = Buffer.from(response.data, 'binary').toString('base64');
-            const contentType = response.headers['content-type'];
-            const imageSrc = `data:${contentType};base64,${base64Data}`;
-
-            return { type: 'SAVED_CHAT_IMAGE', imageSrc, ...meta };
-        } catch (error) {
-            console.error('Error fetching image:', error);
-            throw error; // or handle the error as needed
-        }
-    }]
-];

package/examples/cloud-master/contentRender.js

@@ -1,255 +0,0 @@
-import React, { useState, useEffect, useRef } from "react";
-import { IconButton, Tooltip, LinearProgress } from '@mui/material';
-import CloseIcon from "@mui/icons-material/Close";
-import SendIcon from "@mui/icons-material/Send";
-import { FileCopy, PlayArrow } from "@mui/icons-material";
-import { AppBar, Toolbar, Typography } from '@mui/material';
-import { MoreVert as MenuIcon, AccountCircle as AccountIcon } from '@mui/icons-material';
-
-// Inject custom styles
-const style = document.createElement('style');
-style.innerHTML = `
-    .codeContainer, .codeContainer code {
-        background-color: #0d0d0d !important;
-        color: white !important;
-        text-shadow: none !important;
-        border-radius: 10px !important;
-        font-size: 13px !important;
-    }
-    .codeContainer * {
-        background-color: #0d0d0d !important;
-    }
-    @keyframes pulseButton {
-        0% { transform: scale(1); }
-        50% { transform: scale(1.5); }
-        100% { transform: scale(1); }
-    }
-    .pulseButton {
-        animation: 0.7s pulse 2;
-    }
-`;
-document.head.appendChild(style);
-
-// Utility function to parse JSON safely
-function parseJSON(str) {
-    try {
-        if (str && typeof str === 'string' && (str[0] === '{' || str[0] === '[')) {
-            return JSON.parse(str);
-        }
-    } catch {}
-}
-
-// Check if code contains ES6 syntax or JSX
-export const containsES6SyntaxOrJSX = (code) => {
-    const es6Patterns = [/\bimport\b/, /\bexport\b/];
-    const jsxPattern = /<([A-Za-z][A-Za-z0-9]*)(\s+[A-Za-z0-9\-]+(\s*=\s*{[^}]*}|="[^"]*"|='[^']*'|=[^>\s]+)?)*\s*\/?>/;
-    return es6Patterns.some(pattern => pattern.test(code)) || jsxPattern.test(code);
-};
-
-const isMobile = window.innerWidth < 960;
-
-export function CodeViewer(props) {
-    const [response, setResponse] = useState(null);
-    const [codeRunLoading, setCodeRunLoading] = useState(false);
-    const [isLongContent, setIsLongContent] = useState(false);
-    const [prismHeight, setPrismHeight] = useState(0);
-    const responseRef = useRef(null);
-    const prismRef = useRef(null);
-    const [tooltipOpen, setTooltipOpen] = useState(true);
-
-    const handleTooltipClose = () => setTooltipOpen(false);
-    const handleTooltipOpen = () => setTooltipOpen(true);
-
-    const { source, onClose, styleCopy, noCopy, limitedWidth, styleClose, execute, ...restProps } = props;
-    const { ReactPrismjs, APIResponseComponent, CopyToClipboard } = props.params;
-    const { RequestChatAPI, kbUserData, generateMsgId, msgIndex, messages, setSystemAlert, KB, axios } = props.params;
-
-    const isLastMessage = msgIndex >= (messages?.filter(msg => msg?.content)?.length - 1);
-    const canExecute = execute && props?.language?.includes('javascript') && !containsES6SyntaxOrJSX(source);
-
-    useEffect(() => {
-        const lineCount = source ? source.split('\n').length : 0;
-        setIsLongContent(lineCount > 25);
-    }, [source]);
-
-    useEffect(() => {
-        if (response && responseRef.current) {
-            responseRef.current.scrollIntoView({ behavior: 'smooth' });
-        }
-    }, [response]);
-
-    useEffect(() => {
-        if (prismRef.current) {
-            setPrismHeight(prismRef.current.clientHeight);
-        }
-    }, [source]);
-
-    const runCode = async () => {
-        try {
-            const code = source.includes('module.exports')
-                ? source
-                : `const handler = async (event) => { ${source} }; module.exports = { handler };`;
-            setCodeRunLoading(true);
-            const response = await axios.post(`http://localhost:38595`, {
-                walletPrivateKey: KB?.walletPrivateKey,
-                walletPublicKey: KB?.walletPublicKey,
-                accountId: KB?.accountId,
-                userCode:code,
-                AESKey: KB?.key
-            });
-
-            setCodeRunLoading(false);
-            setResponse(response?.data?.error ? JSON.stringify(response.data) : JSON.stringify(response.data));
-        } catch (error) {
-            setCodeRunLoading(false);
-            setResponse(`Error: ${error?.response?.status || error.message}`);
-        }
-    };
-
-    const preStyle = {
-        whiteSpace: limitedWidth ? 'pre-wrap' : undefined,
-        wordBreak: limitedWidth ? 'break-all' : undefined,
-        ...restProps.style
-    };
-    const colorIcon = '#e7e7e7';
-    const oneliner = !(source?.split?.('\n')?.length > 1);
-
-    const handleOnCopy = () => {
-        setSystemAlert && setSystemAlert({ msg: 'Copied to clipboard', type: 'success', duration: 1500 });
-        props?.onCopy && props.onCopy();
-    };
-
-    const formattedResponse = parseJSON(response) || { response }
-
-    return (
-        <div style={{ paddingBottom: 2, position: 'relative', display: 'inline-block', maxWidth: '100%', minWidth: '350px', overflowX: 'auto' }}>
-            {oneliner && <div style={{ height: '40px' }}></div>}
-            {onClose && (
-                <IconButton onClick={onClose} style={styleClose}>
-                    <CloseIcon style={{ opacity: 0.7, fontSize: '1rem', color: colorIcon }} />
-                </IconButton>
-            )}
-            <div ref={prismRef}>
-                <ReactPrismjs {...{ source, style: preStyle, ...restProps }} />
-            </div>
-            {!codeRunLoading && (
-                <>
-                    <CopyToClipboard text={source || ''}>
-                        <IconButton onClick={handleOnCopy} style={{ position: 'absolute', top: `${prismHeight - 30}px`, right: '0px', zIndex: 10, color: 'rgba(11, 11, 11, 0.54)' }}>
-                            {!noCopy && <FileCopy style={{ opacity: 0.7, color: colorIcon }} />}
-                        </IconButton>
-                    </CopyToClipboard>
-                    {canExecute && (
-                        <Tooltip title="Execute" arrow onMouseEnter={handleTooltipClose} onMouseLeave={handleTooltipOpen} open={isLastMessage && !response && !codeRunLoading && tooltipOpen} placement={"top"}>
-                            <IconButton onClick={runCode} style={{ position: 'absolute', top: `${prismHeight - 30}px`, right: '36px', animation: isLastMessage && !response && !codeRunLoading && 'pulseButton 1.5s infinite', ...styleCopy }}>
-                                <PlayArrow style={{ color: '#e7e7e7' }} />
-                            </IconButton>
-                        </Tooltip>
-                    )}
-                </>
-            )}
-            {codeRunLoading ? (
-                <LinearProgress />
-            ) : (
-                response && (
-                    <div ref={responseRef} style={{ position: 'relative', paddingTop: '30px' }}>
-                        <APIResponseComponent open={false} showResponseSize={true} JSONData={formattedResponse} enableClipboard={true} />
-                        <>
-                            <CopyToClipboard text={response || ''}>
-                                <IconButton onClick={handleOnCopy} style={{ position: 'absolute', top: '35px', right: '0px' }}>
-                                    <FileCopy style={{ opacity: 0.7, color: '#3D86C9' }} />
-                                </IconButton>
-                            </CopyToClipboard>
-                            {isLastMessage && (
-                                <Tooltip title="Send Response" arrow open={isLastMessage} placement={"top"}>
-                                    <IconButton onClick={async () => {
-                                        await RequestChatAPI([...messages, {
-                                            role: 'user',
-                                            content: typeof response === 'number' ? response.toString() : response,
-                                            userId: kbUserData().chatUsername,
-                                            msgId: generateMsgId()
-                                        }]);
-                                    }} style={{ position: 'absolute', top: '35px', right: '36px', animation: 'pulseButton 1.5s infinite' }}>
-                                        <SendIcon style={{ opacity: 0.9, color: '#3D86C9' }} />
-                                    </IconButton>
-                                </Tooltip>
-                            )}
-                        </>
-                    </div>
-                )
-            )}
-        </div>
-    );
-}
-
-const onRenderChatMessage = async (params) => {
-    const { content } = params.messages[params.msgIndex];
-    if (content.match(/```/)) {
-        let language = null;
-        const output = [];
-
-        content.split('\n').forEach(line => {
-            if (!language) {
-                language = /```(?<language>\w+)/g.exec(line)?.groups?.language;
-                output.push(language ? { language, code: '' } : line);
-            } else if (line.match(/```/)) {
-                language = null;
-            } else {
-                output[output.length - 1].code += line + '\n';
-            }
-        });
-
-        return output.map((o, i) =>
-            typeof o === 'string'
-                ? <p key={`a${i}`} style={{ marginTop: '0px', marginBottom: '0px' }}>{o}</p>
-                : <div key={`a${i}`}>
-                    <CodeViewer
-                        key={`ab${i}`}
-                        params={{ ...params, i }}
-                        limitedWidth={isMobile}
-                        execute={true}
-                        className="codeContainer"
-                        language={o.language}
-                        source={o.code}
-                    />
-                </div>
-        );
-    }
-}
-
-const Header = ({ setRenderSettings}) => {
-    useEffect(() => {
-        setRenderSettings({
-            disableShareButton: true,
-            disableBalanceView: true,
-            disableSentLabel: false,
-            disableChatAvatar: false,
-            disableChatModelsSelect: false,
-            disableContextItems: false,
-            disableCopyButton: false,
-            disableEmojiButton: false,
-            disableTextToSpeechButton: false,
-            disableMobileLeftButton: false,
-        });
-    }, [setRenderSettings]);
-
-    return (
-        <AppBar position="absolute" style={{ zIndex: 2000, flexGrow: 1, textAlign: 'left' }}>
-            <Toolbar>
-                <IconButton edge="start" color="inherit" aria-label="menu" style={{ marginRight: '16px' }}>
-                    <MenuIcon />
-                </IconButton>
-                <Typography variant="h6" style={{ flexGrow: 1 }}>
-                    My PC Agent
-                </Typography>
-                <IconButton edge="end" color="inherit" aria-label="account">
-                    <AccountIcon />
-                </IconButton>
-            </Toolbar>
-        </AppBar>
-    );
-}
-
-const exports = { onRenderChatMessage, Header };
-window.contentRender = exports;
-export default exports;

package/examples/cloud-master/instructions.txt

@@ -1,77 +0,0 @@
-You are an AI assistant, assist users with their inquiries and tasks efficiently.
-- Always output one action per message and wait for a response before continuing.
-- When asked to generate HTML, always enclose the response in `<html>{your implementation}</html>` tags.
-
-API_COMMANDS_INSTRUCTIONS:
-
-Guidelines:
-- always ouput any commands on by one, and wait for the response
-
-Here are some API commands you can use to assist users:
-
-/googleSearch("query")
-Description: """
-Get results from Google Search API.
-"""
-$InputLabel = """Let me Search in Google!"""
-$InputValue = """Search in google for the latest news"""
-
-/textToImage("image prompt")
-Description: """
-Generates  images by text prompt (English only supported).
-
- A good prompt needs to be detailed and specific.
- A good process is to look through a list of keyword categories and decide whether you want to use any of them.
- The keyword categories are:
-
- Subject - The subject is what you want to see in the image. A common mistake is not writing enough about the subjects. (e.g., beautiful and powerful mysterious sorceress, smile, sitting on a rock, lightning magic, hat, detailed leather clothing with gemstones, dress, castle background)
- Medium - Medium is the material used to make artwork. Some examples are illustration, oil painting, 3D rendering, and photography. Medium has a strong effect because one keyword alone can dramatically change the style. (e.g., digital art)
- Style - The style refers to the artistic style of the image. Examples include impressionist, surrealist, pop art, etc. (e.g., impressionist, surrealist, pop art)
- Resolution - Resolution represents how sharp and detailed the image is. Let’s add keywords highly detailed and sharp focus. (e.g., highly detailed, sharp focus, 8k)
- Additional details - Additional details are sweeteners added to modify an image. We will add sci-fi and dystopian to add some vibe to the image. (e.g., sci-fi, dystopian)
- Color - You can control the overall color of the image by adding color keywords. The colors you specified may appear as a tone or in objects. (e.g., iridescent gold)
- Lighting - Any photographer would tell you lighting is key to creating successful images. Lighting keywords can have a huge effect on how the image looks. Let’s add studio lighting to make it studio photo-like. (e.g., studio lighting)
- Remarks - You may have noticed the images are already pretty good with only a few keywords added. More is not always better when building a prompt. You often don’t need many keywords to get good images.
-"""
-$InputLabel = """Let me Generate Image!"""
-$InputValue = """Generate a cover image for a health and weight loss campaign"""
-
-
-FUNCTION_EXECUTION_INSTRUCTIONS:
-
-You can also use Node.js code to perform tasks on the user's local PC or perform AWS code using the provided template functions.
-
-Guidelines:
-
-- Output only one Template Function per message.
-- Functions always export the handler function at the end.
-- Once you output a function, it will be executed (as it is) on the user's PC and you will get the response.
-- Before performing any specific operations, first explore the available resources to understand their structure and contents. This could involve listing available items, such as tables in a database, files in a directory, or objects in a cloud storage bucket.
-- Once the resources are identified, gather detailed information about their structure and attributes. This might include describing the schema of a database table, examining metadata of files, or reviewing properties of cloud resources.
-- If the initial exploration does not provide sufficient information, inspect a sample of the resource to gain a deeper understanding of its structure and contents. This could involve selecting a few records from a database, opening a few files, or downloading a few objects from cloud storage.
-- Avoid using placeholder variables in the code. Instead, request the necessary information from the user to generate fully functional and executable code.
-- Common env variables process.env.HOME
-
-By following these steps, you can ensure a comprehensive understanding of the resources you are working with
-
-Template Functions:
-
-```javascript
-const AWS = require('aws-sdk'); // require example 1
-const dns = require('dns'); // require example 2
-const { promisify } = require('util'); // require example 3
-
-AWS.config.update({ region: 'us-east-1' });
-
-const handler = async () => {
-    // Generate code here to perform the desired operations and get a response.
-
-
-    // code Examples:
-    // return await new AWS.S3().listBuckets().promise();
-    // return await promisify(dns.resolveAny)('example.net')
-
-};
-
-module.exports = { handler };
-```