@aigne/example-chat-bot 1.8.1 → 1.9.1

package/README.md

@@ -1,6 +1,6 @@
 # Chatbot Example
 
-This example demonstrates how to create and run an agent-based chatbot using the [AIGNE Framework](https://github.com/AIGNE-io/aigne-framework) and [AIGNE CLI](https://github.com/AIGNE-io/aigne-framework/blob/main/docs/cli.md).
+This example demonstrates how to create and run an agent-based chatbot using the [AIGNE Framework](https://github.com/AIGNE-io/aigne-framework) and [AIGNE CLI](https://github.com/AIGNE-io/aigne-framework/blob/main/docs/cli.md). The example now supports both one-shot and interactive chat modes, along with customizable model settings and pipeline input/output.
 
 ## Prerequisites
 
@@ -15,5 +15,76 @@ This example demonstrates how to create and run an agent-based chatbot using the
 ```bash
 export OPENAI_API_KEY=YOUR_OPENAI_API_KEY # Set your OpenAI API key
 
-npx -y @aigne/example-chat-bot # Run the example
+# Run in one-shot mode (default)
+npx -y @aigne/example-chat-bot
+
+# Run in interactive chat mode
+npx -y @aigne/example-chat-bot --chat
+
+# Use pipeline input
+echo "Tell me about AIGNE Framework" | npx -y @aigne/example-chat-bot
+```
+
+## Installation
+
+### Clone the Repository
+
+```bash
+git clone https://github.com/AIGNE-io/aigne-framework
+```
+
+### Install Dependencies
+
+```bash
+cd aigne-framework/examples/chat-bot
+
+pnpm install
+```
+
+### Setup Environment Variables
+
+Setup your OpenAI API key in the `.env.local` file:
+
+```bash
+OPENAI_API_KEY="" # Set your OpenAI API key here
+```
+
+### Run the Example
+
+```bash
+pnpm start # Run in one-shot mode (default)
+
+# Run in interactive chat mode
+pnpm start -- --chat
+
+# Use pipeline input
+echo "Tell me about AIGNE Framework" | pnpm start
+```
+
+### Run Options
+
+The example supports the following command-line parameters:
+
+| Parameter | Description | Default |
+|-----------|-------------|---------|
+| `--chat` | Run in interactive chat mode | Disabled (one-shot mode) |
+| `--model <provider[:model]>` | AI model to use in format 'provider[:model]' where model is optional. Examples: 'openai' or 'openai:gpt-4o-mini' | openai |
+| `--temperature <value>` | Temperature for model generation | Provider default |
+| `--top-p <value>` | Top-p sampling value | Provider default |
+| `--presence-penalty <value>` | Presence penalty value | Provider default |
+| `--frequency-penalty <value>` | Frequency penalty value | Provider default |
+| `--log-level <level>` | Set logging level (ERROR, WARN, INFO, DEBUG, TRACE) | INFO |
+| `--input`, `-i <input>` | Specify input directly | None |
+
+#### Examples
+
+```bash
+# Run in chat mode (interactive)
+pnpm start -- --chat
+
+# Set logging level
+pnpm start -- --log-level DEBUG
+
+# Use pipeline input
+echo "Tell me about AIGNE Framework" | pnpm start
 ```

package/index.ts

@@ -2,7 +2,8 @@
 
 import { spawnSync } from "node:child_process";
 import { join } from "node:path";
+import { argv } from "node:process";
 
 const path = join(import.meta.dirname, "agents");
 
-spawnSync("aigne", ["run", path], { stdio: "inherit" });
+spawnSync("aigne", ["run", path, ...argv.slice(2)], { stdio: "inherit" });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/example-chat-bot",
-  "version": "1.8.1",
+  "version": "1.9.1",
   "description": "A demonstration of using AIGNE Framework to build a chat bot",
   "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
   "homepage": "https://github.com/AIGNE-io/aigne-framework/tree/main/examples/chat-bot",
@@ -18,10 +18,11 @@
     "README.md"
   ],
   "dependencies": {
-    "@aigne/cli": "^1.9.1"
+    "@aigne/cli": "^1.10.1"
   },
   "devDependencies": {
-    "@aigne/test-utils": "^0.2.0"
+    "@types/bun": "^1.2.9",
+    "@aigne/test-utils": "^0.3.1"
   },
   "scripts": {
     "start": "bun run index.ts",