@aigne/example-workflow-group-chat 1.2.0

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,79 @@
+# Workflow Group Chat Demo
+
+This is a demonstration of using [AIGNE Framework](https://github.com/AIGNE-io/aigne-framework) to build a group chat workflow.
+
+```mermaid
+flowchart LR
+
+manager(Group Manager)
+user(User)
+writer(Writer)
+editor(Editor)
+illustrator(Illustrator)
+
+manager ==2 request to speak==> writer
+manager --4 request to speak--> illustrator
+
+writer -.3 group message.-> manager
+writer -..-> editor
+writer -..-> illustrator
+writer -..-> user
+
+
+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 manager inputOutput
+class user processing
+class writer processing
+class editor processing
+class illustrator processing
+```
+
+## 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-group-chat # 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-group-chat
+
+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
+```
+
+## License
+
+This project is licensed under the MIT License.

package/index.ts

@@ -0,0 +1,158 @@
+#!/usr/bin/env npx -y bun
+
+import assert from "node:assert";
+import { randomUUID } from "node:crypto";
+import {
+  AIAgent,
+  ExecutionEngine,
+  FunctionAgent,
+  OpenAIChatModel,
+  PromptTemplate,
+  UserAgent,
+  createMessage,
+  getMessage,
+  logger,
+} from "@aigne/core";
+import inquirer from "inquirer";
+import { z } from "zod";
+
+const { OPENAI_API_KEY } = process.env;
+assert(OPENAI_API_KEY, "Please set the OPENAI_API_KEY environment variable");
+
+const gpt = new OpenAIChatModel({
+  apiKey: OPENAI_API_KEY,
+  model: "gpt-4o",
+});
+
+const DEFAULT_TOPIC = "DEFAULT_TOPIC";
+
+const writer = AIAgent.from({
+  name: "writer",
+  description: "Writer for creating any text content",
+  publishTopic: DEFAULT_TOPIC,
+  memory: { subscribeTopic: DEFAULT_TOPIC },
+  instructions: "You are a Writer. You produce good work.",
+});
+
+const editor = AIAgent.from({
+  name: "editor",
+  description: "Editor for planning and reviewing the content",
+  publishTopic: DEFAULT_TOPIC,
+  memory: { subscribeTopic: DEFAULT_TOPIC },
+  instructions: `\
+You are an Editor. Plan and guide the task given by the user.
+Provide critical feedbacks to the draft and illustration produced by Writer and Illustrator.
+Approve if the task is completed and the draft and illustration meets user's requirements.`,
+});
+
+const generateImage = FunctionAgent.from({
+  name: "generate_image",
+  description: "Generate an image",
+  inputSchema: z.object({
+    character_appearance: z.string(),
+    style_attributes: z.string(),
+    worn_and_carried: z.string(),
+    scenario: z.string(),
+  }),
+  fn: (input) => {
+    return { ...input, url: `https://example.com/${randomUUID()}.jpg` };
+  },
+});
+
+const illustrator = AIAgent.from({
+  name: "illustrator",
+  description: "An illustrator for creating images",
+  publishTopic: DEFAULT_TOPIC,
+  memory: { subscribeTopic: DEFAULT_TOPIC },
+  instructions: `\
+You are an Illustrator. You use the generate_image tool to create images given user's requirement.
+Make sure the images have consistent characters and style.`,
+  tools: [generateImage],
+  toolChoice: "auto",
+  outputSchema: z.object({
+    images: z
+      .array(
+        z.object({
+          url: z.string().describe("The URL of the image"),
+        }),
+      )
+      .describe("The images created by the illustrator"),
+  }),
+});
+
+let isFirstQuestion = true;
+
+const user = UserAgent.from({
+  name: "user",
+  description: "User for providing final approval",
+  publishTopic: DEFAULT_TOPIC,
+  memory: { subscribeTopic: DEFAULT_TOPIC },
+  async process() {
+    logger.globalSpinner.stop();
+    const { question } = await inquirer.prompt([
+      {
+        type: "input",
+        name: "question",
+        message: "💬",
+        required: true,
+        default: isFirstQuestion
+          ? "Please write a short story about the gingerbread man with up to 3 photo-realistic illustrations."
+          : undefined,
+      },
+    ]);
+    isFirstQuestion = false;
+    logger.globalSpinner.start();
+    return createMessage(question);
+  },
+});
+
+const roles = [writer, editor, illustrator, user];
+
+const manager = AIAgent.from({
+  name: "manager",
+  subscribeTopic: DEFAULT_TOPIC,
+  publishTopic: (output) => output.role,
+  memory: { subscribeTopic: DEFAULT_TOPIC },
+  instructions: PromptTemplate.from(`\
+  You are participating in a role-playing game. The available roles are:
+
+  <roles>
+  {{roles}}
+  </roles>
+
+  Instructions:
+  1. Read the following conversation history
+  2. Identify the last speaking role in the conversation.
+  3. If the last role is **not** "user," respond as "user" to approve and continue.
+  4. Otherwise, select the next role **logically** based on the context of the conversation (do not repeat the same role unless necessary).
+  5. Make sure responses align with the role’s personality and purpose in the game.
+  `).format({
+    roles: roles.map((i) => `${i.topic}: ${i.description}`).join("\n"),
+  }),
+  outputSchema: z.object({
+    role: z
+      .union(assertZodUnionArray(roles.map((i) => z.literal(i.topic))))
+      .describe("The next role to play"),
+  }),
+});
+
+const engine = new ExecutionEngine({
+  model: gpt,
+  agents: [user, manager, writer, editor, illustrator],
+});
+
+engine.subscribe(DEFAULT_TOPIC, (message) => {
+  console.log(
+    "------------- Received message -------------\n",
+    `${message.source}:`,
+    getMessage(message.message) || message.message,
+    "\n--------------------------------------------",
+  );
+});
+
+await engine.call(user, {});
+
+function assertZodUnionArray<T extends z.ZodType>(union: T[]): [T, T, ...T[]] {
+  if (!(union.length >= 2)) throw new Error("Union must have at least 2 items");
+  return union as [T, T, ...T[]];
+}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@aigne/example-workflow-group-chat",
+  "version": "1.2.0",
+  "description": "A demonstration of using AIGNE Framework to build a group chat workflow",
+  "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
+  "homepage": "https://github.com/AIGNE-io/aigne-framework/tree/main/examples/workflow-group-chat",
+  "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": {
+    "openai": "^4.89.0",
+    "zod": "^3.24.2",
+    "@aigne/core": "^1.3.0"
+  },
+  "scripts": {
+    "start": "npx -y bun run index.ts",
+    "lint": "tsc --noEmit"
+  }
+}