@aigne/example-workflow-handoff 1.6.2 → 1.8.0

package/LICENSE

@@ -0,0 +1,93 @@
+Elastic License 2.0
+
+URL: https://www.elastic.co/licensing/elastic-license
+
+## Acceptance
+
+By using the software, you agree to all of the terms and conditions below.
+
+## Copyright License
+
+The licensor grants you a non-exclusive, royalty-free, worldwide,
+non-sublicensable, non-transferable license to use, copy, distribute, make
+available, and prepare derivative works of the software, in each case subject to
+the limitations and conditions below.
+
+## Limitations
+
+You may not provide the software to third parties as a hosted or managed
+service, where the service provides users with access to any substantial set of
+the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality
+in the software, and you may not remove or obscure any functionality in the
+software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices
+of the licensor in the software. Any use of the licensor’s trademarks is subject
+to applicable law.
+
+## Patents
+
+The licensor grants you a license, under any patent claims the licensor can
+license, or becomes able to license, to make, have made, use, sell, offer for
+sale, import and have imported the software, in each case subject to the
+limitations and conditions in this license. This license does not cover any
+patent claims that you cause to be infringed by modifications or additions to
+the software. If you or your company make any written claim that the software
+infringes or contributes to infringement of any patent, your patent license for
+the software granted under these terms ends immediately. If your company makes
+such a claim, your patent license ends immediately for work on behalf of your
+company.
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you
+also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the
+software prominent notices stating that you have modified the software.
+
+## No Other Rights
+
+These terms do not imply any licenses other than those expressly granted in
+these terms.
+
+## Termination
+
+If you use the software in violation of these terms, such use is not licensed,
+and your licenses will automatically terminate. If the licensor provides you
+with a notice of your violation, and you cease all violation of this license no
+later than 30 days after you receive that notice, your licenses will be
+reinstated retroactively. However, if you violate these terms after such
+reinstatement, any additional violation of these terms will cause your licenses
+to terminate automatically and permanently.
+
+## No Liability
+
+*As far as the law allows, the software comes as is, without any warranty or
+condition, and the licensor will not be liable to you for any damages arising
+out of these terms or the use or nature of the software, under any kind of
+legal claim.*
+
+## Definitions
+
+The **licensor** is the entity offering these terms, and the **software** is the
+software the licensor makes available under these terms, including any portion
+of it.
+
+**you** refers to the individual or entity agreeing to these terms.
+
+**your company** is any legal entity, sole proprietorship, or other kind of
+organization that you work for, plus all organizations that have control over,
+are under the control of, or are under common control with that
+organization. **control** means ownership of substantially all the assets of an
+entity, or the power to direct its management and policies by vote, contract, or
+otherwise. Control can be direct or indirect.
+
+**your licenses** are all the licenses granted to you for the software under
+these terms.
+
+**use** means anything you do with the software requiring one of your licenses.
+
+**trademark** means trademarks, service marks, and similar rights.

package/README.md

@@ -92,7 +92,7 @@ The following example demonstrates how to build a handoff workflow:
 
 ```typescript
 import assert from "node:assert";
-import { AIAgent, ExecutionEngine } from "@aigne/core";
+import { AIAgent, AIGNE } from "@aigne/core";
 import { OpenAIChatModel } from "@aigne/core/models/openai-chat-model.js";
 
 const { OPENAI_API_KEY } = process.env;
@@ -110,7 +110,7 @@ const agentA = AIAgent.from({
   name: "AgentA",
   instructions: "You are a helpful agent.",
   outputKey: "A",
-  tools: [transfer_to_b],
+  skills: [transfer_to_b],
 });
 
 const agentB = AIAgent.from({
@@ -119,18 +119,18 @@ const agentB = AIAgent.from({
   outputKey: "B",
 });
 
-const engine = new ExecutionEngine({ model });
+const aigne = new AIGNE({ model });
 
-const userAgent = engine.call(agentA);
+const userAgent = aigne.invoke(agentA);
 
-const result1 = await userAgent.call("transfer to agent b");
+const result1 = await userAgent.invoke("transfer to agent b");
 console.log(result1);
 // Output:
 // {
 //   B: "Transfer now complete,  \nAgent B is here to help.  \nWhat do you need, friend?",
 // }
 
-const result2 = await userAgent.call("It's a beautiful day");
+const result2 = await userAgent.invoke("It's a beautiful day");
 console.log(result2);
 // Output:
 // {

package/index.test.ts

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

package/index.ts

@@ -1,7 +1,7 @@
 #!/usr/bin/env bunwrapper
 
 import { runChatLoopInTerminal } from "@aigne/cli/utils/run-chat-loop.js";
-import { AIAgent, type Agent, ExecutionEngine, FunctionAgent } from "@aigne/core";
+import { AIAgent, AIGNE, type Agent, FunctionAgent } from "@aigne/core";
 import { loadModel } from "@aigne/core/loader/index.js";
 import { z } from "zod";
 
@@ -97,7 +97,7 @@ Follow the following routine with the user:
 4. Only after everything, and if the user says yes,
 tell them a crazy caveat and execute their order.
 `,
-  tools: [transfer_back_to_triage, execute_order_tool],
+  skills: [transfer_back_to_triage, execute_order_tool],
   outputKey: "sales",
   memory: true,
 });
@@ -114,7 +114,7 @@ Follow the following routine with the user:
 3. ONLY if not satisfied, offer a refund.
 4. If accepted, search for the ID and then execute refund.
 `,
-  tools: [transfer_back_to_triage, execute_refund_tool, look_up_item_tool],
+  skills: [transfer_back_to_triage, execute_refund_tool, look_up_item_tool],
   outputKey: "issuesAndRepairs",
   memory: true,
 });
@@ -127,7 +127,7 @@ You are a human manager for ACME Inc.
 Just chat with the user and help them with their problem.
 Only transfer to another agent if user explicitly asks for it.
 `,
-  tools: [transfer_back_to_triage, transfer_to_sales_agent, transfer_to_issues_and_repairs],
+  skills: [transfer_back_to_triage, transfer_to_sales_agent, transfer_to_issues_and_repairs],
   outputKey: "human",
   memory: true,
 });
@@ -140,14 +140,14 @@ Introduce yourself. Always be very brief.
 Gather information to direct the customer to the right department.
 But make your questions subtle and natural.
 `,
-  tools: [transfer_to_issues_and_repairs, transfer_to_sales_agent, transfer_to_human_manager],
+  skills: [transfer_to_issues_and_repairs, transfer_to_sales_agent, transfer_to_human_manager],
   outputKey: "triage",
   memory: true,
 });
 
-const engine = new ExecutionEngine({ model });
+const aigne = new AIGNE({ model });
 
-const userAgent = engine.call(triage);
+const userAgent = aigne.invoke(triage);
 
 await runChatLoopInTerminal(userAgent, {
   welcome: `Hello, I'm a customer service bot for ACME Inc. How can I help you today?`,

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@aigne/example-workflow-handoff",
-  "version": "1.6.2",
+  "version": "1.8.0",
   "description": "A demonstration of using AIGNE Framework to build a handoff workflow",
   "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
   "homepage": "https://github.com/AIGNE-io/aigne-framework/tree/main/examples/workflow-handoff",
-  "license": "ISC",
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/AIGNE-io/aigne-framework"
@@ -18,11 +18,15 @@
   "dependencies": {
     "openai": "^4.94.0",
     "zod": "^3.24.2",
-    "@aigne/cli": "^1.6.0",
-    "@aigne/core": "^1.10.0"
+    "@aigne/cli": "^1.8.0",
+    "@aigne/core": "^1.12.0"
+  },
+  "devDependencies": {
+    "@aigne/test-utils": "^0.1.0"
   },
   "scripts": {
     "start": "bun run index.ts",
-    "lint": "tsc --noEmit"
+    "lint": "tsc --noEmit",
+    "test:llm": "bun test"
   }
 }

package/usages.ts

@@ -1,5 +1,5 @@
 import assert from "node:assert";
-import { AIAgent, ExecutionEngine } from "@aigne/core";
+import { AIAgent, AIGNE } from "@aigne/core";
 import { OpenAIChatModel } from "@aigne/core/models/openai-chat-model.js";
 
 const { OPENAI_API_KEY } = process.env;
@@ -17,7 +17,7 @@ const agentA = AIAgent.from({
   name: "AgentA",
   instructions: "You are a helpful agent.",
   outputKey: "A",
-  tools: [transfer_to_b],
+  skills: [transfer_to_b],
 });
 
 const agentB = AIAgent.from({
@@ -26,18 +26,18 @@ const agentB = AIAgent.from({
   outputKey: "B",
 });
 
-const engine = new ExecutionEngine({ model });
+const aigne = new AIGNE({ model });
 
-const userAgent = engine.call(agentA);
+const userAgent = aigne.invoke(agentA);
 
-const result1 = await userAgent.call("transfer to agent b");
+const result1 = await userAgent.invoke("transfer to agent b");
 console.log(result1);
 // Output:
 // {
 //   B: "Transfer now complete,  \nAgent B is here to help.  \nWhat do you need, friend?",
 // }
 
-const result2 = await userAgent.call("It's a beautiful day");
+const result2 = await userAgent.invoke("It's a beautiful day");
 console.log(result2);
 // Output:
 // {