@aigne/example-workflow-orchestrator 1.14.0-beta → 1.14.0-beta.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 (2) hide show
  1. package/README.md +41 -0
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -66,6 +66,47 @@ export GEMINI_API_KEY=YOUR_GEMINI_API_KEY # Or use Gemini
66
66
  npx -y @aigne/example-workflow-orchestrator
67
67
  ```
68
68
 
69
+ ### Connect to an AI Model
70
+
71
+ As an example, running `npx -y @aigne/example-workflow-orchestrator --chat` requires an AI model. If this is your first run, you need to connect one.
72
+
73
+ ![run example](./run-example.png)
74
+
75
+ - Connect via the official AIGNE Hub
76
+
77
+ Choose the first option and your browser will open the official AIGNE Hub page. Follow the prompts to complete the connection. If you're a new user, the system automatically grants 400,000 tokens for you to use.
78
+
79
+ ![connect to official aigne hub](../images/connect-to-aigne-hub.png)
80
+
81
+ - Connect via a self-hosted AIGNE Hub
82
+
83
+ Choose the second option, enter the URL of your self-hosted AIGNE Hub, and follow the prompts to complete the connection. If you need to set up a self-hosted AIGNE Hub, visit the Blocklet Store to install and deploy it: [Blocklet Store](https://store.blocklet.dev/blocklets/z8ia3xzq2tMq8CRHfaXj1BTYJyYnEcHbqP8cJ?utm_source=www.arcblock.io&utm_medium=blog_link&utm_campaign=default&utm_content=store.blocklet.dev#:~:text=%F0%9F%9A%80%20Get%20Started%20in%20Minutes).
84
+
85
+ ![connect to self hosted aigne hub](../images/connect-to-self-hosted-aigne-hub.png)
86
+
87
+ - Connect via a third-party model provider
88
+
89
+ Using OpenAI as an example, you can configure the provider's API key via environment variables. After configuration, run the example again:
90
+
91
+ ```bash
92
+ export OPENAI_API_KEY="" # Set your OpenAI API key here
93
+ ```
94
+ For more details on third-party model configuration (e.g., OpenAI, DeepSeek, Google Gemini), see [.env.local.example](./.env.local.example).
95
+
96
+ After configuration, run the example again.
97
+
98
+ ### Debugging
99
+
100
+ The `aigne observe` command starts a local web server to monitor and analyze agent execution data. It provides a user-friendly interface to inspect traces, view detailed call information, and understand your agent’s behavior during runtime. This tool is essential for debugging, performance tuning, and gaining insight into how your agent processes information and interacts with tools and models.
101
+
102
+ Start the observation server.
103
+
104
+ ![aigne-observe-execute](../images/aigne-observe-execute.png)
105
+
106
+ View a list of recent executions.
107
+
108
+ ![aigne-observe-list](../images/aigne-observe-list.png)
109
+
69
110
  ## Installation
70
111
 
71
112
  ### Clone the Repository
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aigne/example-workflow-orchestrator",
3
- "version": "1.14.0-beta",
3
+ "version": "1.14.0-beta.1",
4
4
  "description": "A demonstration of using AIGNE Framework to build a orchestrator 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-orchestrator",
@@ -16,12 +16,12 @@
16
16
  "README.md"
17
17
  ],
18
18
  "dependencies": {
19
- "@aigne/agent-library": "^1.23.0-beta",
20
- "@aigne/cli": "^1.58.0-beta"
19
+ "@aigne/agent-library": "^1.23.0-beta.1",
20
+ "@aigne/cli": "^1.58.0-beta.1"
21
21
  },
22
22
  "devDependencies": {
23
23
  "@types/bun": "^1.2.22",
24
- "@aigne/test-utils": "^0.5.68-beta"
24
+ "@aigne/test-utils": "^0.5.68-beta.1"
25
25
  },
26
26
  "scripts": {
27
27
  "start": "aigne run ."