@aigne/agent-library 1.5.0 → 1.6.1

package/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 - chore: release 1.2.0
 
+## [1.6.1](https://github.com/AIGNE-io/aigne-framework/compare/agent-library-v1.6.0...agent-library-v1.6.1) (2025-04-23)
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @aigne/core bumped to 1.11.0
+
+## [1.6.0](https://github.com/AIGNE-io/aigne-framework/compare/agent-library-v1.5.0...agent-library-v1.6.0) (2025-04-22)
+
+
+### Features
+
+* **stream:** add streaming output support for agent ([#73](https://github.com/AIGNE-io/aigne-framework/issues/73)) ([5f3ea4b](https://github.com/AIGNE-io/aigne-framework/commit/5f3ea4bccda7c8c457d6e9518b3d6a8b254ec041))
+
 ## [1.5.0](https://github.com/AIGNE-io/aigne-framework/compare/agent-library-v1.4.0...agent-library-v1.5.0) (2025-04-15)
 
 

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

@@ -0,0 +1,133 @@
+# @aigne/agent-library
+
+[![GitHub star chart](https://img.shields.io/github/stars/AIGNE-io/aigne-framework?style=flat-square)](https://star-history.com/#AIGNE-io/aigne-framework)
+[![Open Issues](https://img.shields.io/github/issues-raw/AIGNE-io/aigne-framework?style=flat-square)](https://github.com/AIGNE-io/aigne-framework/issues)
+[![codecov](https://codecov.io/gh/AIGNE-io/aigne-framework/graph/badge.svg?token=DO07834RQL)](https://codecov.io/gh/AIGNE-io/aigne-framework)
+[![NPM Version](https://img.shields.io/npm/v/@aigne/agent-library)](https://www.npmjs.com/package/@aigne/agent-library)
+[![Elastic-2.0 licensed](https://img.shields.io/npm/l/@aigne/agent-library)](https://github.com/AIGNE-io/aigne-framework/blob/main/LICENSE)
+
+**English** | [中文](README.zh.md)
+
+Collection of agent libraries for [AIGNE Framework](https://github.com/AIGNE-io/aigne-framework), providing pre-built agent implementations.
+
+## Introduction
+
+`@aigne/agent-library` is a collection of agent libraries for [AIGNE Framework](https://github.com/AIGNE-io/aigne-framework), providing pre-built agent implementations for developers. The library is built on top of [@aigne/core](https://github.com/AIGNE-io/aigne-framework/tree/main/packages/core), extending the core functionality to simplify complex workflow orchestration.
+
+## Features
+
+- **Orchestrator Agent**: Provides OrchestratorAgent implementation for coordinating workflows between multiple agents
+- **Task Concurrency**: Supports parallel execution of multiple tasks to improve processing efficiency
+- **Planning & Execution**: Automatically generates execution plans and executes them step by step
+- **Result Synthesis**: Intelligently synthesizes results from multiple steps and tasks
+- **TypeScript Support**: Complete type definitions providing an excellent development experience
+
+## Installation
+
+```bash
+# Using npm
+npm install @aigne/agent-library @aigne/core
+
+# Using yarn
+yarn add @aigne/agent-library @aigne/core
+
+# Using pnpm
+pnpm add @aigne/agent-library @aigne/core
+```
+
+## Basic Usage
+
+```typescript
+import { ExecutionEngine } from "@aigne/core";
+import { OpenAIChatModel } from "@aigne/core/models/openai-chat-model.js";
+import { OrchestratorAgent } from "@aigne/agent-library/orchestrator";
+
+// Create AI model instance
+const model = new OpenAIChatModel({
+  apiKey: process.env.OPENAI_API_KEY,
+  model: "gpt-4-turbo",
+});
+
+// Create execution engine
+const engine = new ExecutionEngine({ model });
+
+// Create orchestrator agent
+const orchestrator = new OrchestratorAgent({
+  name: "MainOrchestrator",
+  instructions: "You are a task orchestrator responsible for coordinating multiple specialized agents to complete complex tasks.",
+  // Configure sub-agents and tools...
+});
+
+// Execute orchestration task
+const userAgent = await engine.call(orchestrator);
+const result = await userAgent.call("Analyze this article and generate a summary and keywords");
+console.log(result);
+```
+
+## Provided Agent Types
+
+The library currently provides one specialized agent implementation:
+
+- **Orchestrator Agent (OrchestratorAgent)**: Responsible for coordinating work between multiple agents and managing complex workflows. It can automatically plan task steps, distribute and execute tasks across multiple agents, and finally synthesize the results.
+
+## Advanced Usage
+
+### Creating an Orchestration Workflow
+
+```typescript
+import { AIAgent, ExecutionEngine } from "@aigne/core";
+import { OpenAIChatModel } from "@aigne/core/models/openai-chat-model.js";
+import { OrchestratorAgent } from "@aigne/agent-library/orchestrator";
+
+const model = new OpenAIChatModel({
+  apiKey: process.env.OPENAI_API_KEY,
+  model: "gpt-4-turbo",
+});
+
+// Create specialized sub-agents
+const researchAgent = AIAgent.from({
+  name: "Researcher",
+  instructions: "You are a professional researcher responsible for collecting and analyzing information.",
+  outputKey: "research",
+});
+
+const writerAgent = AIAgent.from({
+  name: "Writer",
+  instructions: "You are a professional writer responsible for creating high-quality content.",
+  outputKey: "content",
+});
+
+const editorAgent = AIAgent.from({
+  name: "Editor",
+  instructions: "You are a strict editor responsible for checking content quality and formatting.",
+  outputKey: "edited",
+});
+
+// Create orchestrator agent
+const orchestrator = new OrchestratorAgent({
+  name: "WorkflowOrchestrator",
+  instructions: "You are responsible for coordinating research, writing, and editing processes.",
+  tools: [researchAgent, writerAgent, editorAgent],
+  // Optional configuration
+  maxIterations: 30,      // Maximum number of iterations
+  tasksConcurrency: 5,    // Task concurrency
+});
+
+// Use the orchestrator agent
+const engine = new ExecutionEngine({ model });
+const userAgent = await engine.call(orchestrator);
+const result = await userAgent.call("Applications of artificial intelligence in healthcare");
+console.log(result);
+```
+
+## Documentation
+
+For more detailed API documentation and usage guides, please refer to:
+
+- [Agent Development Guide](../../docs/agent-development.md)
+- [Agent API](../../docs/apis/agent-api.md)
+- [AI Agent API](../../docs/apis/ai-agent-api.md)
+
+## License
+
+Elastic-2.0

package/README.zh.md

@@ -0,0 +1,133 @@
+# @aigne/agent-library
+
+[![GitHub star chart](https://img.shields.io/github/stars/AIGNE-io/aigne-framework?style=flat-square)](https://star-history.com/#AIGNE-io/aigne-framework)
+[![Open Issues](https://img.shields.io/github/issues-raw/AIGNE-io/aigne-framework?style=flat-square)](https://github.com/AIGNE-io/aigne-framework/issues)
+[![codecov](https://codecov.io/gh/AIGNE-io/aigne-framework/graph/badge.svg?token=DO07834RQL)](https://codecov.io/gh/AIGNE-io/aigne-framework)
+[![NPM Version](https://img.shields.io/npm/v/@aigne/agent-library)](https://www.npmjs.com/package/@aigne/agent-library)
+[![Elastic-2.0 licensed](https://img.shields.io/npm/l/@aigne/agent-library)](https://github.com/AIGNE-io/aigne-framework/blob/main/LICENSE)
+
+[English](README.md) | **中文**
+
+[AIGNE 框架](https://github.com/AIGNE-io/aigne-framework)的代理库集合，提供预构建的代理实现。
+
+## 简介
+
+`@aigne/agent-library` 是 [AIGNE 框架](https://github.com/AIGNE-io/aigne-framework)的代理库集合，为开发者提供预构建的代理实现。该库是基于 [@aigne/core](https://github.com/AIGNE-io/aigne-framework/tree/main/packages/core) 构建的，扩展了核心功能，使复杂工作流的编排更加简便。
+
+## 特性
+
+- **编排代理**：提供 OrchestratorAgent 实现，用于协调多个代理之间的工作流
+- **任务并发**：支持并行执行多个任务，提高处理效率
+- **计划与执行**：自动生成执行计划并逐步执行
+- **结果合成**：智能合成多个步骤和任务的结果
+- **TypeScript 支持**：完整的类型定义，提供优秀的开发体验
+
+## 安装
+
+```bash
+# 使用 npm
+npm install @aigne/agent-library @aigne/core
+
+# 使用 yarn
+yarn add @aigne/agent-library @aigne/core
+
+# 使用 pnpm
+pnpm add @aigne/agent-library @aigne/core
+```
+
+## 基本用法
+
+```typescript
+import { ExecutionEngine } from "@aigne/core";
+import { OpenAIChatModel } from "@aigne/core/models/openai-chat-model.js";
+import { OrchestratorAgent } from "@aigne/agent-library/orchestrator";
+
+// 创建 AI 模型实例
+const model = new OpenAIChatModel({
+  apiKey: process.env.OPENAI_API_KEY,
+  model: "gpt-4-turbo",
+});
+
+// 创建执行引擎
+const engine = new ExecutionEngine({ model });
+
+// 创建编排代理
+const orchestrator = new OrchestratorAgent({
+  name: "主编排器",
+  instructions: "你是一个任务编排器，负责协调多个专业代理完成复杂任务。",
+  // 配置子代理和工具...
+});
+
+// 执行编排任务
+const userAgent = await engine.call(orchestrator);
+const result = await userAgent.call("分析这篇文章并生成摘要和关键词");
+console.log(result);
+```
+
+## 提供的代理类型
+
+该库目前提供了一种专业化的代理实现：
+
+- **编排代理（OrchestratorAgent）**：负责协调多个代理之间的工作，管理复杂工作流。它能够自动规划任务步骤，并在多个代理之间分配和执行任务，最后合成结果。
+
+## 高级用法
+
+### 创建编排工作流
+
+```typescript
+import { AIAgent, ExecutionEngine } from "@aigne/core";
+import { OpenAIChatModel } from "@aigne/core/models/openai-chat-model.js";
+import { OrchestratorAgent } from "@aigne/agent-library/orchestrator";
+
+const model = new OpenAIChatModel({
+  apiKey: process.env.OPENAI_API_KEY,
+  model: "gpt-4-turbo",
+});
+
+// 创建专业子代理
+const researchAgent = AIAgent.from({
+  name: "研究员",
+  instructions: "你是一位专业研究员，负责收集和分析信息。",
+  outputKey: "research",
+});
+
+const writerAgent = AIAgent.from({
+  name: "作家",
+  instructions: "你是一位专业作家，负责创作高质量内容。",
+  outputKey: "content",
+});
+
+const editorAgent = AIAgent.from({
+  name: "编辑",
+  instructions: "你是一位严格的编辑，负责检查内容质量和格式。",
+  outputKey: "edited",
+});
+
+// 创建编排代理
+const orchestrator = new OrchestratorAgent({
+  name: "工作流编排器",
+  instructions: "你负责协调研究、写作和编辑流程。",
+  tools: [researchAgent, writerAgent, editorAgent],
+  // 可选配置
+  maxIterations: 30,      // 最大迭代次数
+  tasksConcurrency: 5,    // 任务并发数
+});
+
+// 使用编排代理
+const engine = new ExecutionEngine({ model });
+const userAgent = await engine.call(orchestrator);
+const result = await userAgent.call("关于人工智能在医疗领域的应用");
+console.log(result);
+```
+
+## 文档
+
+更多详细的 API 文档和使用指南，请参考：
+
+- [代理开发指南](../../docs/agent-development.zh.md)
+- [Agent API](../../docs/apis/agent-api.zh.md)
+- [AI Agent API](../../docs/apis/ai-agent-api.zh.md)
+
+## 协议
+
+Elastic-2.0

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@aigne/agent-library",
-  "version": "1.5.0",
+  "version": "1.6.1",
   "description": "Collection of agent libraries for AIGNE framework",
   "publishConfig": {
     "access": "public"
   },
   "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
   "homepage": "https://github.com/AIGNE-io/aigne-framework/tree/main/packages/agent-library",
-  "license": "ISC",
+  "license": "Elastic-2.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/AIGNE-io/aigne-framework"
@@ -41,7 +41,7 @@
   "dependencies": {
     "fastq": "^1.19.1",
     "zod": "^3.24.2",
-    "@aigne/core": "^1.7.0"
+    "@aigne/core": "^1.11.0"
   },
   "devDependencies": {
     "@types/bun": "^1.2.9",