@aigne/example-workflow-sequential 1.5.0 → 1.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +8 -6
  2. package/index.ts +3 -9
  3. package/package.json +5 -5
package/README.md CHANGED
@@ -25,15 +25,17 @@ class formatProof processing
25
25
  ## Prerequisites
26
26
 
27
27
  - [Node.js](https://nodejs.org) and npm installed on your machine
28
- - [OpenAI API key](https://platform.openai.com/api-keys) used to interact with OpenAI API
29
- - [Pnpm](https://pnpm.io) [Optional] if you want to run the example from source code
28
+ - An [OpenAI API key](https://platform.openai.com/api-keys) for interacting with OpenAI's services
29
+ - Optional dependencies (if running the example from source code):
30
+ - [Bun](https://bun.sh) for running unit tests & examples
31
+ - [Pnpm](https://pnpm.io) for package management
30
32
 
31
- ## Try without Installation
33
+ ## Quick Start (No Installation Required)
32
34
 
33
35
  ```bash
34
- export OPENAI_API_KEY=YOUR_OPENAI_API_KEY # setup your OpenAI API key
36
+ export OPENAI_API_KEY=YOUR_OPENAI_API_KEY # Set your OpenAI API key
35
37
 
36
- npx -y @aigne/example-workflow-sequential # run the example
38
+ npx -y @aigne/example-workflow-sequential # Run the example
37
39
  ```
38
40
 
39
41
  ## Installation
@@ -57,7 +59,7 @@ pnpm install
57
59
  Setup your OpenAI API key in the `.env.local` file:
58
60
 
59
61
  ```bash
60
- OPENAI_API_KEY="" # setup your OpenAI API key here
62
+ OPENAI_API_KEY="" # Set your OpenAI API key here
61
63
  ```
62
64
 
63
65
  ### Run the Example
package/index.ts CHANGED
@@ -1,16 +1,10 @@
1
- #!/usr/bin/env npx -y bun
1
+ #!/usr/bin/env bunwrapper
2
2
 
3
- import assert from "node:assert";
4
3
  import { runChatLoopInTerminal } from "@aigne/cli/utils/run-chat-loop.js";
5
4
  import { AIAgent, ExecutionEngine, sequential } from "@aigne/core";
6
- import { OpenAIChatModel } from "@aigne/core/models/openai-chat-model.js";
5
+ import { loadModel } from "@aigne/core/loader/index.js";
7
6
 
8
- const { OPENAI_API_KEY } = process.env;
9
- assert(OPENAI_API_KEY, "Please set the OPENAI_API_KEY environment variable");
10
-
11
- const model = new OpenAIChatModel({
12
- apiKey: OPENAI_API_KEY,
13
- });
7
+ const model = await loadModel();
14
8
 
15
9
  const conceptExtractor = AIAgent.from({
16
10
  instructions: `\
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aigne/example-workflow-sequential",
3
- "version": "1.5.0",
3
+ "version": "1.7.1",
4
4
  "description": "A demonstration of using AIGNE Framework to build a sequential workflow",
5
5
  "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
6
6
  "homepage": "https://github.com/AIGNE-io/aigne-framework/tree/main/examples/workflow-sequential",
@@ -16,13 +16,13 @@
16
16
  "README.md"
17
17
  ],
18
18
  "dependencies": {
19
- "openai": "^4.93.0",
19
+ "openai": "^4.94.0",
20
20
  "zod": "^3.24.2",
21
- "@aigne/cli": "^1.2.0",
22
- "@aigne/core": "^1.7.0"
21
+ "@aigne/cli": "^1.5.1",
22
+ "@aigne/core": "^1.10.0"
23
23
  },
24
24
  "scripts": {
25
- "start": "npx -y bun run index.ts",
25
+ "start": "bun run index.ts",
26
26
  "lint": "tsc --noEmit"
27
27
  }
28
28
  }