@aigne/example-workflow-reflection 1.12.6 → 1.13.0

package/.env.local.example

@@ -1,5 +1,44 @@
 # Change the name of this file to .env.local and fill in the following values
 
-DEBUG=aigne:mcp
+# Uncomment the lines below to enable debug logging
+# DEBUG="aigne:*"
 
-OPENAI_API_KEY="" # Your OpenAI API key
+# Use different Models
+
+# OpenAI
+MODEL="openai:gpt-4.1"
+OPENAI_API_KEY="YOUR_OPENAI_API_KEY"
+
+# Anthropic claude
+# MODEL="anthropic:claude-3-7-sonnet-latest"
+# ANTHROPIC_API_KEY=""
+
+# Gemini
+# MODEL="gemini:gemini-2.0-flash"
+# GEMINI_API_KEY=""
+
+# Bedrock nova
+# MODEL=bedrock:us.amazon.nova-premier-v1:0
+# AWS_ACCESS_KEY_ID=""
+# AWS_SECRET_ACCESS_KEY=""
+# AWS_REGION=us-west-2
+
+# DeepSeek
+# MODEL="deepseek:deepseek-chat"
+# DEEPSEEK_API_KEY=""
+
+# OpenRouter
+# MODEL="openrouter:openai/gpt-4o"
+# OPEN_ROUTER_API_KEY=""
+
+# xAI
+# MODEL="xai:grok-2-latest"
+# XAI_API_KEY=""
+
+# Ollama
+# MODEL="ollama:llama3.2"
+# OLLAMA_DEFAULT_BASE_URL="http://localhost:11434/v1";
+
+
+# Setup proxy if needed
+# HTTPS_PROXY=http://localhost:7890

package/README.md

@@ -23,11 +23,11 @@ class reviewer processing
 
 ## Prerequisites
 
-- [Node.js](https://nodejs.org) and npm installed on your machine
-- An [OpenAI API key](https://platform.openai.com/api-keys) for interacting with OpenAI's services
-- Optional dependencies (if running the example from source code):
-  - [Bun](https://bun.sh) for running unit tests & examples
-  - [Pnpm](https://pnpm.io) for package management
+* [Node.js](https://nodejs.org) and npm installed on your machine
+* An [OpenAI API key](https://platform.openai.com/api-keys) for interacting with OpenAI's services
+* Optional dependencies (if running the example from source code):
+  * [Bun](https://bun.sh) for running unit tests & examples
+  * [Pnpm](https://pnpm.io) for package management
 
 ## Quick Start (No Installation Required)
 
@@ -68,6 +68,21 @@ Setup your OpenAI API key in the `.env.local` file:
 OPENAI_API_KEY="" # Set your OpenAI API key here
 ```
 
+#### Using Different Models
+
+You can use different AI models by setting the `MODEL` environment variable along with the corresponding API key. The framework supports multiple providers:
+
+* **OpenAI**: `MODEL="openai:gpt-4.1"` with `OPENAI_API_KEY`
+* **Anthropic**: `MODEL="anthropic:claude-3-7-sonnet-latest"` with `ANTHROPIC_API_KEY`
+* **Google Gemini**: `MODEL="gemini:gemini-2.0-flash"` with `GEMINI_API_KEY`
+* **AWS Bedrock**: `MODEL="bedrock:us.amazon.nova-premier-v1:0"` with AWS credentials
+* **DeepSeek**: `MODEL="deepseek:deepseek-chat"` with `DEEPSEEK_API_KEY`
+* **OpenRouter**: `MODEL="openrouter:openai/gpt-4o"` with `OPEN_ROUTER_API_KEY`
+* **xAI**: `MODEL="xai:grok-2-latest"` with `XAI_API_KEY`
+* **Ollama**: `MODEL="ollama:llama3.2"` with `OLLAMA_DEFAULT_BASE_URL`
+
+For detailed configuration examples, please refer to the `.env.local.example` file in this directory.
+
 ### Run the Example
 
 ```bash
@@ -87,7 +102,7 @@ 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 |
+| `--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 |
@@ -113,13 +128,11 @@ echo "Write a function to validate email addresses" | pnpm start
 The following example demonstrates how to build a reflection workflow:
 
 ```typescript
-import assert from "node:assert";
 import { AIAgent, AIGNE, UserInputTopic, UserOutputTopic } from "@aigne/core";
 import { OpenAIChatModel } from "@aigne/core/models/openai-chat-model.js";
 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 OpenAIChatModel({
   apiKey: OPENAI_API_KEY,
@@ -156,7 +169,8 @@ User's question:
 
 const reviewer = AIAgent.from({
   subscribeTopic: "review_request",
-  publishTopic: (output) => (output.approval ? UserOutputTopic : "rewrite_request"),
+  publishTopic: (output) =>
+    output.approval ? UserOutputTopic : "rewrite_request",
   instructions: `\
 You are a code reviewer. You focus on correctness, efficiency and safety of the code.
 
@@ -177,14 +191,19 @@ Please review the code. If previous feedback was provided, see if it was address
       correctness: z.string().describe("Your comments on correctness"),
       efficiency: z.string().describe("Your comments on efficiency"),
       safety: z.string().describe("Your comments on safety"),
-      suggested_changes: z.string().describe("Your comments on suggested changes"),
+      suggested_changes: z
+        .string()
+        .describe("Your comments on suggested changes"),
     }),
   }),
   includeInputInOutput: true,
 });
 
 const aigne = new AIGNE({ model, agents: [coder, reviewer] });
-aigne.publish(UserInputTopic, "Write a function to find the sum of all even numbers in a list.");
+aigne.publish(
+  UserInputTopic,
+  "Write a function to find the sum of all even numbers in a list.",
+);
 
 const { message } = await aigne.subscribe(UserOutputTopic);
 console.log(message);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/example-workflow-reflection",
-  "version": "1.12.6",
+  "version": "1.13.0",
   "description": "A demonstration of using AIGNE Framework to build a reflection workflow",
   "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
   "homepage": "https://github.com/AIGNE-io/aigne-framework/tree/main/examples/workflow-reflection",
@@ -17,18 +17,18 @@
   ],
   "dependencies": {
     "zod": "^3.24.4",
-    "@aigne/cli": "^1.16.0",
-    "@aigne/agent-library": "^1.17.3",
-    "@aigne/openai": "^0.4.3",
-    "@aigne/core": "^1.26.0"
+    "@aigne/cli": "^1.18.0",
+    "@aigne/core": "^1.28.0",
+    "@aigne/agent-library": "^1.17.5",
+    "@aigne/openai": "^0.6.0"
   },
   "devDependencies": {
     "@types/bun": "^1.2.9",
-    "@aigne/test-utils": "^0.4.10"
+    "@aigne/test-utils": "^0.4.12"
   },
   "scripts": {
     "start": "bun run index.ts",
     "lint": "tsc --noEmit",
-    "test:llm": "bun test"
+    "test:llm": "bun run index.ts"
   }
 }

package/index.test.ts

@@ -1,10 +0,0 @@
-import { expect, test } from "bun:test";
-import { runExampleTest } from "@aigne/test-utils/run-example-test.js";
-test(
-  "should successfully run the workflow-reflection",
-  async () => {
-    const { code } = await runExampleTest();
-    expect(code).toBe(0);
-  },
-  { timeout: 600000 },
-);