@aigne/example-workflow-router 1.1.0-beta.8

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,122 @@
+# Workflow Router Demo
+
+This is a demonstration of using [AIGNE Framework](https://github.com/AIGNE-io/aigne-framework) to build a router workflow.
+
+## 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
+OPENAI_API_KEY=YOUR_OPENAI_API_KEY # setup your OpenAI API key
+
+npx -y @aigne/example-workflow-router # 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-router
+
+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 router workflow:
+
+```typescript
+import { AIAgent, ChatModelOpenAI, ExecutionEngine } from "@aigne/core";
+
+const model = new ChatModelOpenAI({
+  apiKey: process.env.OPENAI_API_KEY,
+});
+
+const productSupport = AIAgent.from({
+  enableHistory: true,
+  name: "product_support",
+  description: "Agent to assist with any product-related questions.",
+  instructions: `You are an agent capable of handling any product-related questions.
+  Your goal is to provide accurate and helpful information about the product.
+  Be polite, professional, and ensure the user feels supported.`,
+  outputKey: "product_support",
+});
+
+const feedback = AIAgent.from({
+  enableHistory: true,
+  name: "feedback",
+  description: "Agent to assist with any feedback-related questions.",
+  instructions: `You are an agent capable of handling any feedback-related questions.
+  Your goal is to listen to the user's feedback, acknowledge their input, and provide appropriate responses.
+  Be empathetic, understanding, and ensure the user feels heard.`,
+  outputKey: "feedback",
+});
+
+const other = AIAgent.from({
+  enableHistory: true,
+  name: "other",
+  description: "Agent to assist with any general questions.",
+  instructions: `You are an agent capable of handling any general questions.
+  Your goal is to provide accurate and helpful information on a wide range of topics.
+  Be friendly, knowledgeable, and ensure the user feels satisfied with the information provided.`,
+  outputKey: "other",
+});
+
+const triage = AIAgent.from({
+  name: "triage",
+  instructions: `You are an agent capable of routing questions to the appropriate agent.
+  Your goal is to understand the user's query and direct them to the agent best suited to assist them.
+  Be efficient, clear, and ensure the user is connected to the right resource quickly.`,
+  tools: [productSupport, feedback, other],
+  toolChoice: "router", // Set toolChoice to "router" to enable router mode
+});
+
+const engine = new ExecutionEngine({ model });
+
+const result1 = await engine.run("How to use this product?", triage);
+console.log(result1);
+// {
+//   product_support: "I’d be happy to help you with that! However, I need to know which specific product you’re referring to. Could you please provide me with the name or type of product you have in mind?",
+// }
+
+const result2 = await engine.run("I have feedback about the app.", triage);
+console.log(result2);
+// {
+//   feedback: "Thank you for sharing your feedback! I'm here to listen. Please go ahead and let me know what you’d like to share about the app.",
+// }
+
+const result3 = await engine.run("What is the weather today?", triage);
+console.log(result3);
+// {
+//   other: "I can't provide real-time weather updates. However, you can check a reliable weather website or a weather app on your phone for the current conditions in your area. If you tell me your location, I can suggest a few sources where you can find accurate weather information!",
+// }
+```
+
+## License
+
+This project is licensed under the MIT License.

package/index.ts

@@ -0,0 +1,63 @@
+#!/usr/bin/env npx -y bun
+
+import { AIAgent, ChatModelOpenAI, ExecutionEngine, runChatLoopInTerminal } from "@aigne/core";
+
+const model = new ChatModelOpenAI({
+  apiKey: process.env.OPENAI_API_KEY,
+});
+
+const productSupport = AIAgent.from({
+  enableHistory: true,
+  name: "product_support",
+  description: "Agent to assist with any product-related questions.",
+  instructions: `You are an agent capable of handling any product-related questions.
+  Your goal is to provide accurate and helpful information about the product.
+  Be polite, professional, and ensure the user feels supported.`,
+  outputKey: "product_support",
+});
+
+const feedback = AIAgent.from({
+  enableHistory: true,
+  name: "feedback",
+  description: "Agent to assist with any feedback-related questions.",
+  instructions: `You are an agent capable of handling any feedback-related questions.
+  Your goal is to listen to the user's feedback, acknowledge their input, and provide appropriate responses.
+  Be empathetic, understanding, and ensure the user feels heard.`,
+  outputKey: "feedback",
+});
+
+const other = AIAgent.from({
+  enableHistory: true,
+  name: "other",
+  description: "Agent to assist with any general questions.",
+  instructions: `You are an agent capable of handling any general questions.
+  Your goal is to provide accurate and helpful information on a wide range of topics.
+  Be friendly, knowledgeable, and ensure the user feels satisfied with the information provided.`,
+  outputKey: "other",
+});
+
+const triage = AIAgent.from({
+  name: "triage",
+  instructions: `You are an agent capable of routing questions to the appropriate agent.
+  Your goal is to understand the user's query and direct them to the agent best suited to assist them.
+  Be efficient, clear, and ensure the user is connected to the right resource quickly.`,
+  tools: [productSupport, feedback, other],
+  toolChoice: "router",
+});
+
+const engine = new ExecutionEngine({ model });
+
+const userAgent = await engine.run(triage);
+
+await runChatLoopInTerminal(userAgent, {
+  welcome: `Welcome to the support chat!
+
+I can help you with any questions you have, such as
+- product-related queries: "How do I use this product?"
+- feedback: "I have feedback about the app."
+- general questions: "What is the weather today?"
+
+How can I assist you today?
+`,
+  defaultQuestion: "How do I use this product?",
+});

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@aigne/example-workflow-router",
+  "version": "1.1.0-beta.8",
+  "description": "A demonstration of using AIGNE Framework to build a router workflow",
+  "author": "",
+  "license": "ISC",
+  "main": "index.js",
+  "bin": "index.ts",
+  "files": [
+    ".env.local.example",
+    "*.ts",
+    "README.md"
+  ],
+  "dependencies": {
+    "zod": "^3.24.2",
+    "@aigne/core-next": "^1.1.0-beta.8"
+  },
+  "scripts": {
+    "start": "npx -y bun run index.ts"
+  }
+}

package/usages.ts

@@ -0,0 +1,64 @@
+import { AIAgent, ChatModelOpenAI, ExecutionEngine } from "@aigne/core";
+
+const model = new ChatModelOpenAI({
+  apiKey: process.env.OPENAI_API_KEY,
+});
+
+const productSupport = AIAgent.from({
+  enableHistory: true,
+  name: "product_support",
+  description: "Agent to assist with any product-related questions.",
+  instructions: `You are an agent capable of handling any product-related questions.
+  Your goal is to provide accurate and helpful information about the product.
+  Be polite, professional, and ensure the user feels supported.`,
+  outputKey: "product_support",
+});
+
+const feedback = AIAgent.from({
+  enableHistory: true,
+  name: "feedback",
+  description: "Agent to assist with any feedback-related questions.",
+  instructions: `You are an agent capable of handling any feedback-related questions.
+  Your goal is to listen to the user's feedback, acknowledge their input, and provide appropriate responses.
+  Be empathetic, understanding, and ensure the user feels heard.`,
+  outputKey: "feedback",
+});
+
+const other = AIAgent.from({
+  enableHistory: true,
+  name: "other",
+  description: "Agent to assist with any general questions.",
+  instructions: `You are an agent capable of handling any general questions.
+  Your goal is to provide accurate and helpful information on a wide range of topics.
+  Be friendly, knowledgeable, and ensure the user feels satisfied with the information provided.`,
+  outputKey: "other",
+});
+
+const triage = AIAgent.from({
+  name: "triage",
+  instructions: `You are an agent capable of routing questions to the appropriate agent.
+  Your goal is to understand the user's query and direct them to the agent best suited to assist them.
+  Be efficient, clear, and ensure the user is connected to the right resource quickly.`,
+  tools: [productSupport, feedback, other],
+  toolChoice: "router", // Set toolChoice to "router" to enable router mode
+});
+
+const engine = new ExecutionEngine({ model });
+
+const result1 = await engine.run("How to use this product?", triage);
+console.log(result1);
+// {
+//   product_support: "I’d be happy to help you with that! However, I need to know which specific product you’re referring to. Could you please provide me with the name or type of product you have in mind?",
+// }
+
+const result2 = await engine.run("I have feedback about the app.", triage);
+console.log(result2);
+// {
+//   feedback: "Thank you for sharing your feedback! I'm here to listen. Please go ahead and let me know what you’d like to share about the app.",
+// }
+
+const result3 = await engine.run("What is the weather today?", triage);
+console.log(result3);
+// {
+//   other: "I can't provide real-time weather updates. However, you can check a reliable weather website or a weather app on your phone for the current conditions in your area. If you tell me your location, I can suggest a few sources where you can find accurate weather information!",
+// }