openkbs 0.0.20 → 0.0.21

package/Docs.md

@@ -77,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) {
@@ -393,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.
 

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/README.md

@@ -1,75 +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.20-orange.svg)](https://www.npmjs.com/package/openkbs)
 
-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 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.
 
-### Table of Contents
+## Table of Contents
 
 - [Install CLI](#install-cli)
-- [Create new Application](#create-new-application)
-- [Deploy Your Application](#deploy-your-application)
-- [Enhance Your Application](#enhance-your-application)
-- [Local Development](#local-development)
-- [Use Built-in MUI Components](#use-built-in-mui-components)
+- [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)
 
-## Creating Your First AI Agent Manually
-
-Follow these steps to create and deploy your first OpenKBS app using React and Node.js, 
-
-### 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
-    ```
-
-
-
-### 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
 ```
 
-### Deploy Your Application
-
-You have two options for deployment: OpenKBS Cloud or LocalStack.
-
-#### Deploy to OpenKBS Cloud
+## Deploy
 
 1. Log in to OpenKBS:
 
@@ -77,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
@@ -87,9 +53,9 @@ You have two options for deployment: OpenKBS Cloud or LocalStack.
 
 3. Open the provided URL and interact with your application.
 
-### 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:
 
@@ -122,7 +88,7 @@ To improve your application's rendering, you can use libraries like `react-markd
    openkbs push
    ```
 
-### Local Development
+### Setup Local Development
 
 For faster frontend development, run the OpenKBS UI dev server locally:
 
@@ -148,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 />
@@ -166,7 +132,7 @@ 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 

package/package.json

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

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,