@aigne/example-chat-bot 1.1.0

package/.env.local.example

@@ -0,0 +1,3 @@
+# Change the name of this file to .env.local and fill in the following values
+
+OPENAI_API_KEY="" # Your OpenAI API key

package/README.md

@@ -0,0 +1,17 @@
+# Chatbot Example
+
+This is a demonstration of using [AIGNE Framework](https://github.com/AIGNE-io/aigne-framework) and [AIGNE CLI](https://github.com/AIGNE-io/aigne-framework/blob/main/docs/cli.md) to create and run a agent-based chatbot.
+
+## Prerequisites
+
+- [Node.js](https://nodejs.org) and npm installed on your machine
+- [OpenAI API key](https://platform.openai.com/api-keys) used to interact with OpenAI API
+- [Pnpm](https://pnpm.io) [Optional] if you want to run the example from source code
+
+## Try without Installation
+
+```bash
+export OPENAI_API_KEY=YOUR_OPENAI_API_KEY # Setup your OpenAI API key
+
+npx -y @aigne/example-chat-bot # Run the example
+```

package/agents/README.md

@@ -0,0 +1,32 @@
+# Aigne Default Template
+
+This is the default project template for the Aigne framework, providing a basic chat agent and JavaScript code execution functionality.
+
+## Template Structure
+
+- `aigne.yaml` - Project configuration file that defines the chat model used and references to agents
+- `chat.yaml` - Chat agent configuration, including agent instructions and tools used
+- `sandbox.js` - JavaScript code execution tool for running JavaScript code within conversations
+- `sandbox.test.js` - Test file to verify the functionality of the code execution tool
+
+## Quick Start
+
+### Install AIGNE CLI
+
+```bash
+npm install -g aigne
+```
+
+### Start the Project
+
+```bash
+aigne run
+```
+
+## Testing
+
+Run the following command to execute test cases:
+
+```bash
+aigne test
+```

package/agents/aigne.yaml

@@ -0,0 +1,7 @@
+chat_model:
+  name: gpt-4o-mini
+  temperature: 0.8
+agents:
+  - chat.yaml
+tools:
+  - sandbox.js

package/agents/chat.yaml

@@ -0,0 +1,7 @@
+name: chat
+description: Chat agent
+instructions: |
+  You are a helpful assistant that can answer questions and provide information on a wide range of topics.
+  Your goal is to assist users in finding the information they need and to engage in friendly conversation.
+tools:
+  - sandbox.js

package/agents/sandbox.js

@@ -0,0 +1,26 @@
+import vm from "node:vm";
+
+export default async function evaluateJs({ code }) {
+  const sandbox = {};
+  const context = vm.createContext(sandbox);
+  const result = vm.runInContext(code, context, { displayErrors: true });
+  return { result };
+}
+
+evaluateJs.description = "This agent evaluates JavaScript code.";
+
+evaluateJs.input_schema = {
+  type: "object",
+  properties: {
+    code: { type: "string", description: "JavaScript code to evaluate" },
+  },
+  required: ["code"],
+};
+
+evaluateJs.output_schema = {
+  type: "object",
+  properties: {
+    result: { type: "any", description: "Result of the evaluated code" },
+  },
+  required: ["result"],
+};

package/agents/sandbox.test.js

@@ -0,0 +1,7 @@
+import assert from "node:assert";
+import test from "node:test";
+import evaluateJs from "./sandbox.js";
+
+test("evaluateJs should execute script correctly", async () => {
+  assert.deepEqual(await evaluateJs({ code: "1 + 2" }), { result: 3 });
+});

package/index.ts

@@ -0,0 +1,12 @@
+#!/usr/bin/env npx -y bun
+
+import assert from "node:assert";
+import { spawnSync } from "node:child_process";
+import { join } from "node:path";
+
+const { OPENAI_API_KEY } = process.env;
+assert(OPENAI_API_KEY, "Please set the OPENAI_API_KEY environment variable");
+
+spawnSync("npx", ["-y", "@aigne/cli", "run", join(import.meta.dirname, "agents")], {
+  stdio: "inherit",
+});

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@aigne/example-chat-bot",
+  "version": "1.1.0",
+  "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",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AIGNE-io/aigne-framework"
+  },
+  "type": "module",
+  "bin": "index.ts",
+  "files": [
+    "agents",
+    ".env.local.example",
+    "*.ts",
+    "README.md"
+  ],
+  "dependencies": {
+    "@aigne/cli": "^1.1.0"
+  },
+  "scripts": {
+    "start": "npx -y bun run index.ts",
+    "lint": "tsc --noEmit"
+  }
+}