npm install kaibanjs

// 对于 NextJS、React 等，使用 ES6 导入语法
import { Agent, Task, Team } from 'kaibanjs';

// 对于 Node.js，使用 CommonJS 语法
const { Agent, Task, Team } = require('kaibanjs');

// 定义一个智能体
const researchAgent = new Agent({
  name: 'Researcher',
  role: 'Information Gatherer',
  goal: 'Find relevant information on a given topic',
});

// 创建一个任务
const researchTask = new Task({
  description: 'Research recent AI developments',
  agent: researchAgent,
});

// 组建一个团队
const team = new Team({
  name: 'AI Research Team',
  agents: [researchAgent],
  tasks: [researchTask],
  env: { OPENAI_API_KEY: 'your-api-key-here' },
});

// 启动工作流
team
  .start()
  .then((output) => {
    console.log('Workflow completed:', output.result);
  })
  .catch((error) => {
    console.error('Workflow error:', error);
  });

看板是展示团队工作流的绝佳工具，能够实时提供清晰且交互式的成员进度快照。

我们已将这一概念应用于 AI 智能体。

现在，你可以像观察团队成员一样可视化 AI 智能体的工作流，任务会从“待办”移动到“已完成”，尽在你的眼前。这种可视化方式简化了对复杂 AI 操作的理解和管理，使任何人都能在任何地方轻松掌握。

通过配置 AI 智能体在项目中擅长不同的关键职能，发挥专业化的强大优势。这种方法可以提升每项任务的有效性和效率，突破通用 AI 的局限性。

在这个示例中，我们的软件开发团队由三个专业化的AI智能体组成：戴夫、艾拉和奎因。每个智能体都根据其特定角色进行了精心配置，从而确保高效的任务处理和协同效应，加速开发周期。

import { Agent } from 'kaibanjs';

const daveLoper = new Agent({
  name: 'Dave Loper',
  role: '开发者',
  goal: '编写并审查代码',
  background: '精通JavaScript、React和Node.js',
});

const ella = new Agent({
  name: 'Ella',
  role: '产品经理',
  goal: '定义产品愿景并管理路线图',
  background: '擅长市场分析和产品战略',
});

const quinn = new Agent({
  name: 'Quinn',
  role: '质量保证专家',
  goal: '确保质量和一致性',
  background: '测试、自动化和缺陷跟踪方面的专家',
});

正如专业人士会使用特定工具来出色完成工作一样，您也可以让AI智能体利用搜索引擎、计算器等工具，以更高的精度和效率执行专业任务。 在这个示例中，其中一个AI智能体彼得·阿特拉斯借助Tavily搜索结果工具，增强了他选择最佳旅行城市的能力。该工具使彼得能够综合考虑天气、价格和季节性等因素来分析旅行数据，从而提供最合适的建议。

import { Agent, Tool } from 'kaibanjs';

const tavilySearchResults = new Tool({
  name: 'Tavily Search Results',
  maxResults: 1,
  apiKey: 'ENV_TRAVILY_API_KEY',
});

const peterAtlas = new Agent({
  name: 'Peter Atlas',
  role: '城市选择员',
  goal: '基于全面的旅行数据选择最佳城市',
  background: '具有地理数据分析和旅行趋势经验',
  tools: [tavilySearchResults],
});

KaibanJS支持所有与LangchainJS兼容的工具，为工具集成提供了灵活的方式。更多详情请参阅文档。

通过在任务之间传递结果，实现复杂的流程，使智能体能够在此基础上继续工作。这一功能对于创建多步骤的复杂流程至关重要，其中每个任务的输出都会成为后续任务的输入。 在这个示例中，内容创作团队展示了如何通过任务共享和叠加结果，从研究到最终内容制作形成无缝的工作流。

import { Agent, Task, Team } from 'kaibanjs';

// 定义带有结果传递的任务
const researchTask = new Task({
  description: '研究主题：{topic}',
  expectedOutput: '以JSON格式呈现的关键研究点',
  agent: researcher,
});

const writingTask = new Task({
  description: `使用此研究数据撰写文章：{taskResult:task1}
               聚焦关键见解，并保持专业语气。`,
  expectedOutput: '以Markdown格式呈现的文章草稿',
  agent: writer,
});

const editingTask = new Task({
  description: `编辑并改进这篇文章：{taskResult:task2}
               提升清晰度和吸引力。`,
  expectedOutput: '最终润色后的文章',
  agent: editor,
});

// 创建包含这些任务的团队
const team = new Team({
  name: '内容创作团队',
  agents: [researcher、writer、editor],
  tasks: [researchTask、writingTask、editingTask],
  inputs: { topic: '2024年人工智能趋势' },
});

任务结果会自动通过{taskResult:taskN}语法在任务间传递，其中N代表任务在工作流中的位置（从1开始计数）。更多细节及高级用法，请参阅我们的任务结果传递指南。

KaibanJS在团队层面提供了先进的内存管理功能，让您能够控制任务结果在工作流中的流动方式。这一特性有助于优化性能，并在复杂的多智能体系统中有效管理上下文。 以下是一个配置团队内存的示例：

const team = new Team({
  name: '内容创作团队',
  agents: [researcher、writer、editor],
  tasks: [researchTask、writingTask、editingTask],
  memory: true, // 启用自动访问所有先前任务的结果
});

// 或者禁用内存以进行显式结果管理
const performanceTeam = new Team({
  name: '高性能团队',
  agents: [analyst、processor],
  tasks: [analysisTask、processingTask],
  memory: false, // 需要显式引用结果
});

有关内存管理的详细信息，请参阅我们的文档。

通过集成一系列专门的AI模型，您可以优化AI解决方案，每种模型都针对项目的不同方面进行优化。 在这个示例中，艾玛、卢卡斯和米娅这三个智能体使用不同的AI模型来处理功能规格制定的不同阶段。这种有针对性地使用AI模型不仅最大限度地提高了效率，还确保每个任务都能匹配最经济高效且最适合的AI资源。

import { Agent } from 'kaibanjs';

const emma = new Agent({
  name: 'Emma',
  role: '初始草拟',
  goal: '概述核心功能',
  llmConfig: {
    provider: 'google',
    model: 'gemini-1.5-pro',
  },
});

const lucas = new Agent({
  name: 'Lucas',
  role: '技术规格制定',
  goal: '起草详细的技术规格',
  llmConfig: {
    provider: 'anthropic',
    model: 'claude-3-5-sonnet-20240620',
  },
});

const mia = new Agent({
  name: 'Mia',
  role: '最终审核',
  goal: '确保最终文档的准确性和完整性',
  llmConfig: {
    provider: 'openai',
    model: 'gpt-4o',
  },
});

有关如何将各种AI模型与KaibanJS集成的更多信息，请参阅文档。

KaibanJS采用受Redux启发的架构，能够以统一的方式管理AI智能体、任务以及应用程序整体流程的状态。这种方法确保在复杂的智能体交互中实现一致的状态管理，从而提供更高的清晰度和控制力。 以下是一个简化的示例，演示如何将KaibanJS与React应用中的状态管理相结合：

import myAgentsTeam from './agenticTeam';

const KaibanJSComponent = () => {
  const useTeamStore = myAgentsTeam.useStore();

  const { agents, workflowResult } = useTeamStore((state) => ({
    agents: state.agents,
    workflowResult: state.workflowResult,
  }));

  return (
    <div>
      <button onClick={myAgentsTeam.start}>启动团队工作流</button>
      <p>工作流结果：{workflowResult}</p>
      <div>
        <h2>🕵️‍♂️ 代理</h2>
        {agents.map((agent) => (
          <p key={agent.id}>
            {agent.name} - {agent.role} - 状态：({agent.status})
          </p>
        ))}
      </div>
    </div>
  );
};

export default KaibanJSComponent;

欲深入了解 KaibanJS 的状态管理，请访问文档。

轻松为您的 NextJS、React、Vue、Angular 和 Node.js 项目添加 AI 功能。

KaibanJS 专为在各种 JavaScript 环境中实现无缝集成而设计。无论您是在 React、Vue 或 Angular 中增强用户界面，使用 NextJS 构建可扩展的应用程序，还是在 Node.js 中实施服务器端解决方案，该框架都能顺利融入您现有的工作流程。

import React from 'react';
import myAgentsTeam from './agenticTeam';

const TaskStatusComponent = () => {
  const useTeamStore = myAgentsTeam.useStore();

  const { tasks } = useTeamStore((state) => ({
    tasks: state.tasks.map((task) => ({
      id: task.id,
      description: task.description,
      status: task.status,
    })),
  }));

  return (
    <div>
      <h1>任务状态</h1>
      <ul>
        {tasks.map((task) => (
          <li key={task.id}>
            {task.description}: 状态 - {task.status}
          </li>
        ))}
      </ul>
    </div>
  );
};

export default TaskStatusComponent;

欲深入了解，请访问文档。

KaibanJS 内置的可观测性功能使您能够通过详细的统计信息和日志跟踪每一次状态变化，从而确保完全透明和可控。此功能可提供有关令牌使用情况、运营成本及状态变化的实时洞察，提升系统可靠性，并通过全面的数据可见性支持明智决策。

以下代码片段展示了如何利用状态管理方法来监控并响应工作流日志中的变化，从而对 AI 代理的运行动态实现精细控制和深入洞察：

const useStore = myAgentsTeam.useStore();

useStore.subscribe(
  (state) => state.workflowLogs,
  (newLogs, previousLogs) => {
    if (newLogs.length > previousLogs.length) {
      const { task, agent, metadata } = newLogs[newLogs.length - 1];
      if (newLogs[newLogs.length - 1].logType === 'TaskStatusUpdate') {
        switch (task.status) {
          case TASK_STATUS_enum.DONE:
            console.log('任务已完成', {
              taskDescription: task.description,
              agentName: agent.name,
              agentModel: agent.llmConfig.model,
              duration: metadata.duration,
              llmUsageStats: metadata.llmUsageStats,
              costDetails: metadata.costDetails,
            });
            break;
          case TASK_STATUS_enum.DOING:
          case TASK_STATUS_enum.BLOCKED:
          case TASK_STATUS_enum.REVISE:
          case TASK_STATUS_enum.TODO:
            console.log('任务状态更新', {
              taskDescription: task.description,
              taskStatus: task.status,
              agentName: agent.name,
            });
            break;
          default:
            console.warn('遇到意外的任务状态：', task.status);
            break;
        }
      }
    }
  }
);

如需了解更多关于如何在 KaibanJS 中使用可观测性功能的信息，请访问文档。

`WorkflowDrivenAgent` 是一种专门用于执行工作流而非基于 LLM 进行推理的代理。该代理会维护工作流状态，并能处理长时间运行的工作流的暂停与恢复操作，从而提供一种确定性的任务执行方式。

在本示例中，创建了一个 WorkflowDrivenAgent 来执行一个通过定义步骤处理数据的工作流，允许在无需调用 LLM 的情况下完成复杂的多步操作。

import { Agent } from 'kaibanjs';
import { createStep, createWorkflow } from '@kaibanjs/workflow';
import { z } from 'zod';

// 创建工作流步骤
const processStep = createStep({
  id: 'process',
  inputSchema: z.object({ data: z.string() }),
  outputSchema: z.object({ result: z.string() }),
  execute: async ({ inputData }) => {
    const { data } = inputData as { data: string };
    return { result: data.toUpperCase() };
  },
});

// 创建工作流
const workflow = createWorkflow({
  id: 'example-workflow',
  inputSchema: z.object({ data: z.string() }),
  outputSchema: z.object({ result: z.string() }),
});

workflow.then(processStep);
workflow.commit();

// 使用 Agent 包装器创建代理
const agent = new Agent({
  type: 'WorkflowDrivenAgent',
  name: '工作流代理',
  workflow: workflow,
});

// 在团队中使用该代理
const team = new Team({
  name: '工作流团队',
  agents: [agent],
  tasks: [
    new Task({
      description: '使用工作流处理输入数据',
      expectedOutput: '处理后的数据结果',
      agent: agent,
    }),
  ],
});

WorkflowDrivenAgent 可与现有团队系统无缝集成，支持带有暂停功能的工作流以供人工干预，并为工作流事件提供详细日志记录。更多信息请访问WorkflowDrivenAgent 文档。