@aigne/example-workflow-code-execution 1.1.0-beta.13

package/.env.local.example

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

package/README.md

@@ -0,0 +1,138 @@
+# Workflow code-execution Demo
+
+This is a demonstration of using [AIGNE Framework](https://github.com/AIGNE-io/aigne-framework) to build a code-execution workflow.
+
+```mermaid
+flowchart LR
+
+in(In)
+out(Out)
+coder(Coder)
+sandbox(Sandbox)
+
+coder -.-> sandbox
+sandbox -.-> coder
+in ==> coder ==> out
+
+
+classDef inputOutput fill:#f9f0ed,stroke:#debbae,stroke-width:2px,color:#b35b39,font-weight:bolder;
+classDef processing fill:#F0F4EB,stroke:#C2D7A7,stroke-width:2px,color:#6B8F3C,font-weight:bolder;
+
+class in inputOutput
+class out inputOutput
+class coder processing
+class sandbox processing
+```
+
+Workflow of a code-execution between user and coder using a sandbox:
+
+
+```mermaid
+sequenceDiagram
+
+participant User
+participant Coder as Agent Coder
+participant Sandbox as Agent Sandbox
+
+User ->> Coder: 10! = ?
+Coder ->> Sandbox: "function factorial(n) { return n <= 1 ? 1 : n * factorial(n - 1) } factorial(10)"
+Sandbox ->> Coder: { result: 3628800 }
+Coder ->> User: The value of \(10!\) (10 factorial) is 3,628,800.
+```
+
+## 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-workflow-code-execution # run the example
+```
+
+## Installation
+
+### Clone the Repository
+
+```bash
+git clone https://github.com/AIGNE-io/aigne-framework
+```
+
+### Install Dependencies
+
+```bash
+cd aigne-framework/examples/workflow-code-execution
+
+pnpm install
+```
+
+### Setup Environment Variables
+
+Setup your OpenAI API key in the `.env.local` file:
+
+```bash
+OPENAI_API_KEY="" # setup your OpenAI API key here
+```
+
+### Run the Example
+
+```bash
+pnpm start
+```
+
+## Example
+
+The following example demonstrates how to build a code-execution workflow:
+
+```typescript
+import assert from "node:assert";
+import { AIAgent, ChatModelOpenAI, ExecutionEngine, FunctionAgent } from "@aigne/core-next";
+import { z } from "zod";
+
+const { OPENAI_API_KEY } = process.env;
+assert(OPENAI_API_KEY, "Please set the OPENAI_API_KEY environment variable");
+
+const model = new ChatModelOpenAI({
+  apiKey: OPENAI_API_KEY,
+});
+
+const sandbox = FunctionAgent.from({
+  name: "js-sandbox",
+  description: "A js sandbox for running javascript code",
+  inputSchema: z.object({
+    code: z.string().describe("The code to run"),
+  }),
+  fn: async (input: { code: string }) => {
+    const { code } = input;
+    // biome-ignore lint/security/noGlobalEval: <explanation>
+    const result = eval(code);
+    return { result };
+  },
+});
+
+const coder = AIAgent.from({
+  name: "coder",
+  instructions: `\
+You are a proficient coder. You write code to solve problems.
+Work with the sandbox to execute your code.
+`,
+  tools: [sandbox],
+});
+
+const engine = new ExecutionEngine({ model });
+
+const result = await engine.run("10! = ?", coder);
+console.log(result);
+// Output:
+// {
+//   text: "The value of \\(10!\\) (10 factorial) is 3,628,800.",
+// }
+```
+
+## License
+
+This project is licensed under the MIT License.

package/index.ts

@@ -0,0 +1,51 @@
+#!/usr/bin/env npx -y bun
+
+import assert from "node:assert";
+import {
+  AIAgent,
+  ChatModelOpenAI,
+  ExecutionEngine,
+  FunctionAgent,
+  runChatLoopInTerminal,
+} from "@aigne/core-next";
+import { z } from "zod";
+
+const { OPENAI_API_KEY } = process.env;
+assert(OPENAI_API_KEY, "Please set the OPENAI_API_KEY environment variable");
+
+const model = new ChatModelOpenAI({
+  apiKey: OPENAI_API_KEY,
+});
+
+const sandbox = FunctionAgent.from({
+  name: "js-sandbox",
+  description: "A js sandbox for running javascript code",
+  inputSchema: z.object({
+    code: z.string().describe("The code to run"),
+  }),
+  fn: async (input: { code: string }) => {
+    const { code } = input;
+    // biome-ignore lint/security/noGlobalEval: <explanation>
+    const result = eval(code);
+    return { result };
+  },
+});
+
+const coder = AIAgent.from({
+  name: "coder",
+  instructions: `\
+You are a proficient coder. You write code to solve problems.
+Work with the sandbox to execute your code.
+`,
+  tools: [sandbox],
+});
+
+const engine = new ExecutionEngine({ model });
+
+const userAgent = await engine.run(coder);
+
+await runChatLoopInTerminal(userAgent, {
+  welcome:
+    "Welcome to the code execution workflow! you can ask me anything can be resolved by running code.",
+  defaultQuestion: "10! = ?",
+});

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@aigne/example-workflow-code-execution",
+  "version": "1.1.0-beta.13",
+  "description": "A demonstration of using AIGNE Framework to build a code-execution workflow",
+  "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
+  "homepage": "https://github.com/AIGNE-io/aigne-framework/tree/main/examples/workflow-code-execution",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AIGNE-io/aigne-framework"
+  },
+  "bin": "index.ts",
+  "files": [
+    ".env.local.example",
+    "*.ts",
+    "README.md"
+  ],
+  "dependencies": {
+    "zod": "^3.24.2",
+    "@aigne/core-next": "^1.1.0-beta.13"
+  },
+  "scripts": {
+    "start": "npx -y bun run index.ts"
+  }
+}

package/usage.ts

@@ -0,0 +1,44 @@
+#!/usr/bin/env npx -y bun
+
+import assert from "node:assert";
+import { AIAgent, ChatModelOpenAI, ExecutionEngine, FunctionAgent } from "@aigne/core-next";
+import { z } from "zod";
+
+const { OPENAI_API_KEY } = process.env;
+assert(OPENAI_API_KEY, "Please set the OPENAI_API_KEY environment variable");
+
+const model = new ChatModelOpenAI({
+  apiKey: OPENAI_API_KEY,
+});
+
+const sandbox = FunctionAgent.from({
+  name: "js-sandbox",
+  description: "A js sandbox for running javascript code",
+  inputSchema: z.object({
+    code: z.string().describe("The code to run"),
+  }),
+  fn: async (input: { code: string }) => {
+    const { code } = input;
+    // biome-ignore lint/security/noGlobalEval: <explanation>
+    const result = eval(code);
+    return { result };
+  },
+});
+
+const coder = AIAgent.from({
+  name: "coder",
+  instructions: `\
+You are a proficient coder. You write code to solve problems.
+Work with the sandbox to execute your code.
+`,
+  tools: [sandbox],
+});
+
+const engine = new ExecutionEngine({ model });
+
+const result = await engine.run("10! = ?", coder);
+console.log(result);
+// Output:
+// {
+//   text: "The value of \\(10!\\) (10 factorial) is 3,628,800.",
+// }