openkbs 0.0.19 → 0.0.21

package/Docs.md

@@ -9,9 +9,11 @@ src/
 │   ├── onRequest.js            // Handles incoming user messages
 │   ├── onResponse.js           // Handles outgoing LLM messages
 │   ├── onPublicAPIRequest.js   // Handles public API requests
+│   ├── onAddMessages.js         // Handles messages added to the chat (NEW)
 │   ├── onRequest.json          // Dependencies for onRequest handler
 │   ├── onResponse.json          // Dependencies for onResponse handler
-│   └── onPublicAPIRequest.json // Dependencies for onPublicAPIRequest handler
+│   ├── onPublicAPIRequest.json // Dependencies for onPublicAPIRequest handler
+│   └── onAddMessages.json       // Dependencies for onAddMessages handler (NEW)
 │── Frontend/
 │   ├── contentRender.js        // Custom rendering logic for chat messages
 │   └── contentRender.json      // Dependencies for the contentRender module
@@ -75,7 +77,7 @@ export const handler = async (event) => {
     const actions = getActions({
         _meta_actions: event?.payload?.messages?.length > maxSelfInvokeMessagesCount
             ? ["REQUEST_CHAT_MODEL_EXCEEDED"]
-            : []
+            : ["REQUEST_CHAT_MODEL"]
     });
 
     for (let [regex, action] of actions) {
@@ -220,7 +222,6 @@ module.exports = {
         if (!kbId) return { error: "kbId is not provided" }
 
         try {
-            // Encrypt specific fields if needed
             const myItem = {};
             for (const attribute of attributes) {
                 const { attrName, encrypted } = attribute;
@@ -248,52 +249,98 @@ module.exports = {
 
 ```javascript
 // Example creating a "feedback" item
-const kbId = 'your-kb-id';  // Replace with your actual kbId
-const data = {
-    action: "createItem",
-    kbId: kbId, // knowledge base ID
-    itemType: "feedback",
-    attributes: [
-        { attrType: "keyword1", attrName: "name", encrypted: true },
-        { attrType: "text1", attrName: "feedbackText", encrypted: false }
-    ],
-    item: {
-        name: "John Doe",
-        feedbackText: "Great product!"
-    }
-};
+const createFeedback = async (kbId, name, text) => (
+        await fetch('https://chat.openkbs.com/publicAPIRequest', {
+          method: 'POST',
+          headers: { 'Content-Type': 'application/json' },
+          body: JSON.stringify({
+            action: "createItem",
+            kbId,
+            itemType: "feedback",
+            attributes: [
+              { attrType: "keyword1", attrName: "name", encrypted: true },
+              { attrType: "text1", attrName: "feedbackText", encrypted: false }
+            ],
+            item: { name, feedbackText: text }
+          })
+        })
+).json();
+```
 
-fetch('https://chat.openkbs.com/publicAPIRequest', { // Call the public API endpoint
-    method: 'POST',
-    headers: { 'Content-Type': 'application/json' },
-    body: JSON.stringify(data)
-})
-.then(response => response.json())
-.then(data => {
-    if (data.error) {
-        console.error("Error creating item:", data.error);
-        // Handle error (e.g., display error message)
-    } else {
-        console.log("Item created successfully:", data);
-        // Handle success (e.g., update UI)
-    }
-})
-.catch(error => {
-    console.error("Network error:", error);
-    // Handle network errors
-});
+By utilizing `onPublicAPIRequest` and `openkbs.items`, you can build powerful integrations that allow external systems to store and manage data within your OpenKBS application without compromising security. This approach is especially valuable for scenarios like form submissions, webhooks, or any situation where direct, unauthenticated access to data storage is required.  Remember to carefully consider security implications and implement necessary precautions.
+
+### `onAddMessages` Event Handler:
 
+The `onAddMessages` handler allows you to intercept and process messages *as they are added to the chat*. This handler is triggered *after* the `onRequest` handler but *before* the message is sent to the LLM. It's particularly useful for scenarios where a third-party system or service sends messages directly to your OpenKBS application to perform an action.
 
+**Example: User moderation:**
+
+**1. Third-Party Service API request:**
+
+```javascript
+// Example of a third-party system sending a chat message to OpenKBS
+axios.post('https://chat.openkbs.com/', {
+    action: "chatAddMessages",
+    chatId: 'NSFW_CHAT_ID', // the chat id created to log and process NSFW message
+    messages: [{
+        role: "system",
+        content: JSON.stringify({
+            labels: ['adult', 'explicit'],
+            fileName: 'image.jpg',
+            path: '/uploads/image.jpg'
+        }),
+        msgId: `${Date.now()}-000000`
+    }],
+    apiKey: "YOUR_API_KEY",
+    kbId: "YOUR_KB_ID"
+}, {
+    headers: { 'Content-Type': 'application/json' }
+});
 ```
 
-By utilizing `onPublicAPIRequest` and `openkbs.items`, you can build powerful integrations that allow external systems to store and manage data within your OpenKBS application without compromising security. This approach is especially valuable for scenarios like form submissions, webhooks, or any situation where direct, unauthenticated access to data storage is required.  Remember to carefully consider security implications and implement necessary precautions.
+**2. `onAddMessages` Handler:**
+
+```javascript
+// src/Events/onAddMessages.js
+import * as actions from './actions.js';
+
+export const handler = async (event) => {
+    const { messages, chatId } = event.payload;
+    let msgData;
+
+    // NSFW Chat Handler
+    if (chatId === 'NSFW_CHAT_ID') {  // Check if the message is for the NSFW chat
+        try {
+            msgData = JSON.parse(messages[0].content); // Parse the message content (expecting JSON)
+            const { data } = await actions.getUser([null, msgData.kbId]); // Get user information
+            await actions.warnAccount([null, data.user.accountId, msgData?.labels]); // Issue a warning
+            await actions.deleteFile([null, msgData.path]); // Delete the offending file
+
+            // Return a system message confirming the action
+            return [
+                ...messages,
+                {
+                    role: 'system',
+                    msgId: Date.now() + '000000',
+                    content: `### 👮‍♀️ System Actions:\nWarning issued and content removed`
+                }
+            ];
+        } catch (e) {
+            console.error("Error processing NSFW content:", e);
+        }
+    }
+
+    return messages; // Return messages unchanged if no action is taken
+};
+
+```
 
-**Dependencies (onRequest.json, onResponse.json, onPublicAPIRequest.json):**
+**Dependencies (onRequest.json, onResponse.json, etc.):**
 
 These files specify the NPM package dependencies required for the respective event handlers. They follow the standard `package.json` format.
 
 ```json
-// src/Events/onRequest.json, src/Events/onResponse.json, src/Events/onPublicAPIRequest.json
+// src/Events/*.json
 {
   "dependencies": {
     "your-package": "^1.0.0"
@@ -346,7 +393,7 @@ The `openkbs` object provides a set of utility functions and services to interac
 
 * **`openkbs.detectLanguage(text, params)`:** Detects the language of the provided text.
 
-* **`openkbs.textToSpeech(text, params)`:** Converts text to speech.
+* **`openkbs.textToSpeech(text, params)`:** Converts text to speech. Returns `response.audioContent` which automatically plays in the chat interface.
 
 * **`openkbs.encrypt(plaintext)`:** Encrypts data using the provided AES key.
 
@@ -550,7 +597,7 @@ The dependencies marked as `(fixed)` are not installed as additional dependencie
 
 These components and utilities are accessible directly within your `onRenderChatMessage` function, streamlining your custom development process.
 
-### `msgIndex`
+### msgIndex
 ```javascript
 const onRenderChatMessage = async (params) => {
     const { msgIndex, messages } = params;
@@ -560,7 +607,7 @@ const onRenderChatMessage = async (params) => {
 };
 ```
 
-### `messages`
+### messages
 ```javascript
 const onRenderChatMessage = async (params) => {
     const { messages } = params;
@@ -571,7 +618,7 @@ const onRenderChatMessage = async (params) => {
 };
 ```
 
-### `setMessages`
+### setMessages
 ```javascript
 const onRenderChatMessage = async (params) => {
     const { setMessages, messages } = params;
@@ -580,7 +627,7 @@ const onRenderChatMessage = async (params) => {
 };
 ```
 
-### `KB`
+### KB
 ```javascript
 const onRenderChatMessage = async (params) => {
     const { KB } = params;
@@ -589,7 +636,7 @@ const onRenderChatMessage = async (params) => {
 };
 ```
 
-### `chatContainerRef`
+### chatContainerRef
 ```javascript
 const onRenderChatMessage = async (params) => {
     const { chatContainerRef } = params;
@@ -599,7 +646,7 @@ const onRenderChatMessage = async (params) => {
 };
 ```
 
-### `RequestChatAPI`
+### RequestChatAPI
 ```javascript
 const onRenderChatMessage = async (params) => {
     const { RequestChatAPI, messages } = params;
@@ -608,7 +655,7 @@ const onRenderChatMessage = async (params) => {
 };
 ```
 
-### `setSystemAlert`
+### setSystemAlert
 ```javascript
 const onRenderChatMessage = async (params) => {
     const { setSystemAlert } = params;
@@ -616,7 +663,7 @@ const onRenderChatMessage = async (params) => {
 };
 ```
 
-### `setBlockingLoading`
+### setBlockingLoading
 ```javascript
 const onRenderChatMessage = async (params) => {
     const { setBlockingLoading } = params;
@@ -626,7 +673,7 @@ const onRenderChatMessage = async (params) => {
 };
 ```
 
-### `blockingLoading`
+### blockingLoading
 ```javascript
 const onRenderChatMessage = async (params) => {
     const { blockingLoading } = params;
@@ -636,7 +683,7 @@ const onRenderChatMessage = async (params) => {
 };
 ```
 
-### `sendButtonRef`
+### sendButtonRef
 ```javascript
 const onRenderChatMessage = async (params) => {
     const { sendButtonRef } = params;
@@ -646,7 +693,7 @@ const onRenderChatMessage = async (params) => {
 };
 ```
 
-### `sendButtonRippleRef`
+### sendButtonRippleRef
 ```javascript
 const onRenderChatMessage = async (params) => {
     const { sendButtonRippleRef } = params;
@@ -656,7 +703,7 @@ const onRenderChatMessage = async (params) => {
 };
 ```
 
-### `setInputValue`
+### setInputValue
 ```javascript
 const onRenderChatMessage = async (params) => {
     const { setInputValue } = params;
@@ -664,7 +711,7 @@ const onRenderChatMessage = async (params) => {
 };
 ```
 
-### `renderSettings`
+### renderSettings
 ```javascript
 const onRenderChatMessage = async (params) => {
     const { renderSettings } = params;
@@ -672,7 +719,7 @@ const onRenderChatMessage = async (params) => {
 };
 ```
 
-### `axios`
+### axios
 ```javascript
 const onRenderChatMessage = async (params) => {
     const { axios } = params;
@@ -681,7 +728,7 @@ const onRenderChatMessage = async (params) => {
 };
 ```
 
-### `itemsAPI`
+### itemsAPI
 ```javascript
 const onRenderChatMessage = async (params) => {
     const { itemsAPI } = params;
@@ -690,7 +737,7 @@ const onRenderChatMessage = async (params) => {
 };
 ```
 
-### `indexedDB`
+### indexedDB
 ```javascript
 const onRenderChatMessage = async (params) => {
     const { indexedDB } = params;
@@ -699,7 +746,7 @@ const onRenderChatMessage = async (params) => {
 };
 ```
 
-### `generateMsgId`
+### generateMsgId
 ```javascript
 const onRenderChatMessage = async (params) => {
     const { generateMsgId } = params;
@@ -708,7 +755,7 @@ const onRenderChatMessage = async (params) => {
 };
 ```
 
-### `kbUserData`
+### kbUserData
 ```javascript
 const onRenderChatMessage = async (params) => {
     const { kbUserData } = params;

package/INSTALL.md

@@ -0,0 +1,36 @@
+- **Download CLI Binary**
+
+  - **Linux (x64):**
+
+    ```bash
+
+    wget -O ~/Downloads/openkbs https://downloads.openkbs.com/cli/linux/openkbs && chmod +x ~/Downloads/openkbs && sudo mv ~/Downloads/openkbs /usr/local/bin/openkbs
+
+    ```
+
+  - **Windows (x64):**
+
+    ```powershell
+
+    Invoke-WebRequest -Uri "https://downloads.openkbs.com/cli/windows/openkbs.exe" -OutFile "$Env:USERPROFILE\Downloads\openkbs.exe"
+
+    $Env:Path += ";$Env:USERPROFILE\Downloads"
+
+    ```
+
+    
+  - **Mac (new M series):**
+
+    ```bash
+
+    curl -o ~/Downloads/openkbs https://downloads.openkbs.com/cli/macos/openkbs && mkdir -p /usr/local/bin && chmod +x ~/Downloads/openkbs && sudo mv ~/Downloads/openkbs /usr/local/bin/openkbs
+
+    ```
+
+  - **Mac (old models):**
+
+    ```bash
+
+    curl -o ~/Downloads/openkbs https://downloads.openkbs.com/cli/macos/openkbs-x64 && mkdir -p /usr/local/bin && chmod +x ~/Downloads/openkbs && sudo mv ~/Downloads/openkbs /usr/local/bin/openkbs
+
+    ```

package/ON_PREMISES.md

@@ -0,0 +1,215 @@
+
+### 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/README.md

@@ -1,115 +1,41 @@
-# OpenKBS · [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/open-kbs/openkbs-chat/blob/main/LICENSE) [![npm version](https://img.shields.io/badge/npm-v0.0.10-orange.svg)](https://www.npmjs.com/package/openkbs)
+# OpenKBS · [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/open-kbs/openkbs-chat/blob/main/LICENSE) [![npm version](https://img.shields.io/badge/npm-v0.0.20-orange.svg)](https://www.npmjs.com/package/openkbs)
 
-OpenKBS is an open-source platform for building and deploying AI agents and applications. Our mission is to provide developers with a flexible and powerful framework that empowers them to create advanced AI agents with ease, using simple text prompts to specify requirements.
+OpenKBS is an extendable open-source platform designed to build, deploy and integrate AI agents anywhere, from websites to IoT devices. Its event-driven architecture enables full customization of backend and frontend components, while the LLM abstraction layer allows seamless switching between language models.
 
-### Last Updates
-- openkbs-ai-server: added support for stable-diffusion-3.5-large
+## Table of Contents
 
-### Table of Contents
-
-
-- [Creating Your First AI Agent Manually](#creating-your-first-ai-agent-manually)
-    - [Step 1: Install CLI](#step-1-install-cli)
-    - [Step 2: Create new Application](#step-2-create-new-application)
-    - [Step 3: Understand the Project Structure](#step-3-understand-the-project-structure)
-    - [Step 4: Deploy Your Application](#step-4-deploy-your-application)
-    - [Step 5: Enhance Your Application](#step-5-enhance-your-application)
-    - [Step 6: Local Development](#step-6-local-development)
-    - [Step 7: Use Built-in MUI Components](#step-7-use-built-in-mui-components)
-    - [Step 8: Running the Backend Locally (On-Premises)](#step-8-running-the-backend-locally-on-premises)
-- [Installing openkbs-ai-server and Integrating Llama 3.1 and Stable Diffusion 3 Locally](#installing-openkbs-ai-server-and-integrating-llama-31-and-stable-diffusion-3-locally)
+- [Install CLI](#install-cli)
+- [Create App](#create-app)
+- [Deploy](#deploy)
+- [Extend Frontend](#extend-frontend)
+   - [Setup Local Development](#setup-local-development)
+   - [Use Built-in MUI Components](#use-built-in-mui-components)
+   - [AI-Powered Generation](#ai-powered-frontend-generation)
+- [Extend Backend](#extend-backend)
+- [Framework Documentation](#framework-documentation)
 - [License](#license)
 - [Contributing](#contributing)
 - [Contact](#contact)
 
-## Installation
-
-This module needs to be installed globally, so use the `-g` flag when installing:
-
-```bash
-npm install -g openkbs
-```
-![ai1.png](examples%2Fcloud-master%2Fai1.png)
-
-## Key Features
-
-[//]: # (- **Generative AI First**: An intuitive development interface designed for human beings. Employs generative AI tools to streamline the development life cycle, enabling rapid requirements gathering, system design, and deployment.)
-- **Seamless LLM Integration**: LLM abstraction layer providing a unified interface for various LLM vendors, such as OpenAI, Anthropic, and open-source models like LLaMA and Mistral. This layer allows one-click switching between LLMs without modifying source code, enabling seamless testing across models.
-- **Extensive Tooling**: Utilize a broad range of AI tools and services to build robust, scalable AI agents. This includes code execution, database engines, web browsing, image generation, embedding models, speech synthesis, and recognition. These tools enable LLMs to operate autonomously, with more resources continually being added.
-- **Open Source**: Provides developers with the freedom to customize, modify, and distribute the software freely.
-
----
-
-
-## Creating Your First AI Agent Manually
-
-Follow these steps to create and deploy your first OpenKBS app using React and Node.js, 
-
-### Step 1: Install CLI
+## Install CLI
 
 First, ensure you have the OpenKBS CLI installed globally:
 
-- **Option 1: using NPM**
 ```bash
 npm install -g openkbs
 ```
 
-- **Option 2: Download Binary**
-
-  - **Linux (x64):**
-    ```bash
-    wget -O ~/Downloads/openkbs https://downloads.openkbs.com/cli/linux/openkbs && chmod +x ~/Downloads/openkbs && sudo mv ~/Downloads/openkbs /usr/local/bin/openkbs
-    ```
-  - **Windows (x64):**
-    ```powershell
-    Invoke-WebRequest -Uri "https://downloads.openkbs.com/cli/windows/openkbs.exe" -OutFile "$Env:USERPROFILE\Downloads\openkbs.exe"
-    $Env:Path += ";$Env:USERPROFILE\Downloads"
-    ```
-    
-  - **Mac (new M series):**
-    ```bash
-    curl -o ~/Downloads/openkbs https://downloads.openkbs.com/cli/macos/openkbs && mkdir -p /usr/local/bin && chmod +x ~/Downloads/openkbs && sudo mv ~/Downloads/openkbs /usr/local/bin/openkbs
-    ```
-  - **Mac (old models):**
-    ```bash
-    curl -o ~/Downloads/openkbs https://downloads.openkbs.com/cli/macos/openkbs-x64 && mkdir -p /usr/local/bin && chmod +x ~/Downloads/openkbs && sudo mv ~/Downloads/openkbs /usr/local/bin/openkbs
-    ```
-
-
-
-### Step 2: Create New Application
+## Create App
 
 Create a new application using the OpenKBS CLI:
 
 ```bash
-openkbs create my-pc-agent
-```
-
-Navigate into your newly created application directory:
+openkbs create my-agent
 
-```bash
-cd my-pc-agent
+cd my-agent
 ```
 
-### Step 3: Understand the Project Structure
-
-Your application will have the following structure:
-
-- `./app/icon.png`: Application icon.
-- `./app/settings.json`: Application settings.
-- `./app/instructions.txt`: Agent instructions.
-- `./src/Events/actions.js`: Contains all backend actions (LLM commands).
-- `./src/Events/onRequest.js`: Event handler that executes a command on user input.
-- `./src/Events/onRequest.json`: Contains all npm package dependencies for onRequest module.
-- `./src/Events/onResponse.js`: Similar to `onRequest.js`, but executed against LLM output.
-- `./src/Events/onResponse.json`: Contains all npm package dependencies for onResponse module.
-- `./src/Frontend/contentRender.js`: Contains frontend components of your application.
-- `./src/Frontend/contentRender.json`: Contains all npm package dependencies for contentRender module.
-### Step 4: Deploy Your Application
-
-You have two options for deployment: OpenKBS Cloud or LocalStack.
-
-#### Deploy to OpenKBS Cloud
+## Deploy
 
 1. Log in to OpenKBS:
 
@@ -117,7 +43,7 @@ You have two options for deployment: OpenKBS Cloud or LocalStack.
    openkbs login
    ```
 
-2. Push your application to OpenKBS Cloud:
+2. Push your application to OpenKBS:
 
    ```bash
    openkbs push
@@ -127,9 +53,9 @@ You have two options for deployment: OpenKBS Cloud or LocalStack.
 
 3. Open the provided URL and interact with your application.
 
-### Step 5: Enhance Your Application
+## Extend Frontend
 
-To improve your application's rendering, you can use libraries like `react-markdown` for example.
+To improve your application's user interface, you can use libraries like `react-markdown` for example.
 
 1. Add `react-markdown` to your dependencies:
 
@@ -162,7 +88,7 @@ To improve your application's rendering, you can use libraries like `react-markd
    openkbs push
    ```
 
-### Step 6: Local Development
+### Setup Local Development
 
 For faster frontend development, run the OpenKBS UI dev server locally:
 
@@ -173,7 +99,7 @@ For faster frontend development, run the OpenKBS UI dev server locally:
 
 This command opens a browser pointing to `localhost`, allowing automatic rebuilds of your frontend code locally.
 
-### Step 7: Use Built-in MUI Components
+### Use Built-in MUI Components
 
 Enhance your UI with Material-UI components:
 
@@ -188,13 +114,13 @@ Enhance your UI with Material-UI components:
 
    ```js
     return (
-        <AppBar position="absolute" style={{ zIndex: 2000, flexGrow: 1, textAlign: 'left' }}>
+        <AppBar position="absolute" style={{ zIndex: 1300, 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
+                    My Agent
                 </Typography>
                 <IconButton edge="end" color="inherit" aria-label="account">
                     <AccountIcon />
@@ -206,231 +132,12 @@ Enhance your UI with Material-UI components:
 
 3. Observe real-time rendering by refreshing your browser at http://{kbId}.apps.localhost:38593/
 
-4. Push the changes to your remote KB:
+4. Push the changes to your remote app instance:
 
    ```bash
    openkbs push 
    ```
 
----
-
-### Step 8: 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!
-
----
-
 ## License
 
 This project is licensed under the MIT License. For more details, please refer to the [LICENSE](https://github.com/open-kbs/openkbs-chat/blob/main/LICENSE) file.

package/package.json

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

package/src/index.js

@@ -119,15 +119,15 @@ Examples:
   $ openkbs deploy contentRender
 `);
 
-program
-    .command('sign')
-    .description('Signs a transaction to request OpenKBS service')
-    .requiredOption('-a, --toAccountId <toAccountId>', 'Receiver account ID')
-    .option('-e, --expires <expiresInSeconds>', 'Expiration time in seconds', '60')
-    .option('-m, --maxAmount <maxAmount>', 'Maximum authorized charge', '300000')
-    .option('-r, --resourceId <resourceId>', 'Resource ID', 'credits')
-    .option('-p, --payload <payload>', 'Payload')
-    .action(signAction);
+// program
+//     .command('sign')
+//     .description('Signs a transaction to request OpenKBS service')
+//     .requiredOption('-a, --toAccountId <toAccountId>', 'Receiver account ID')
+//     .option('-e, --expires <expiresInSeconds>', 'Expiration time in seconds', '60')
+//     .option('-m, --maxAmount <maxAmount>', 'Maximum authorized charge', '300000')
+//     .option('-r, --resourceId <resourceId>', 'Resource ID', 'credits')
+//     .option('-p, --payload <payload>', 'Payload')
+//     .action(signAction);
 
 // Set up the CLI program
 program
@@ -141,13 +141,4 @@ program
     .description('Log out from OpenKBS by deleting the locally stored session token.')
     .action(logoutAction);
 
-// program
-//     .command('evolve <featureDescription>')
-//     .description('Evolve the application by providing additional feature requirements before deployment.')
-//     .action(evolveApplication)
-//     .addHelpText('after', `
-// Examples:
-//   $ openkbs evolve "Add water tracking feature"
-// `);
-
 program.parse(process.argv);

package/src/utils.js

@@ -370,7 +370,7 @@ async function modifyKB(kbToken, kbData, prompt, files, options) {
 
         const sendMessage = async (message) => {
             return makePostRequest(url, {
-                rootToken: kbToken,
+                token: kbToken,
                 message: encrypt(message, key),
                 chatId: createdChatId,
                 encrypted: true,