logo
0
0
WeChat Login
shentongmartin<shentong.martin@bytedance.com>
docs: add COOKBOOK.md and update README with structured example index (#162)

Eino Examples

English | 中文

概述

本仓库包含了 Eino 框架的示例和演示代码,提供了实用的示例来帮助开发者更好地理解和使用 Eino 的功能。

仓库结构

📦 ADK (Agent Development Kit)

目录名称说明
adk/helloworldHello World Agent最简单的 Agent 示例,展示如何创建一个基础的对话 Agent
adk/intro/chatmodelChatModel Agent展示如何使用 ChatModelAgent 并配合 Interrupt 机制
adk/intro/custom自定义 Agent展示如何实现符合 ADK 定义的自定义 Agent
adk/intro/workflowWorkflow AgentsLoop、Parallel、Sequential Agent 模式
adk/intro/sessionSession 管理展示如何通过 Session 在多个 Agent 之间传递数据和状态
adk/intro/transferAgent 转移展示 ChatModelAgent 的 Transfer 能力,实现 Agent 间的任务转移
adk/intro/http-sse-serviceHTTP SSE 服务展示如何将 ADK Runner 暴露为支持 Server-Sent Events 的 HTTP 服务
adk/human-in-the-loop人机协作8 个示例:审批、审核编辑、反馈循环、追问、Supervisor 等模式
adk/multiagent多 Agent 协作Supervisor、Plan-Execute-Replan、Deep Agents、Excel Agent 示例
adk/common/tool/graphtoolGraphTool将 Graph/Chain/Workflow 封装为 Agent 工具

🔗 Compose (编排)

目录名称说明
compose/chainChain使用 compose.Chain 进行顺序编排,包含 Prompt + ChatModel
compose/graphGraph图编排示例:状态图、工具调用 Agent、异步节点、中断机制
compose/workflowWorkflow工作流示例:字段映射、纯数据流、纯控制流、静态值、流式处理
compose/batchBatchNode批量处理组件,支持并发控制和中断恢复

🌊 Flow (流程模块)

目录名称说明
flow/agent/reactReAct AgentReAct Agent,包含记忆、动态选项、未知工具处理
flow/agent/multiagentMulti-AgentHost Multi-Agent(日记助手)、Plan-Execute 模式
flow/agent/manusManus Agent基于 Eino 实现的 Manus Agent,参考 OpenManus 项目
flow/agent/deer-goDeer-Go参考 deer-flow 的 Go 语言实现,支持研究团队协作

🧩 Components (组件)

目录名称说明
components/modelModelA/B 测试路由、cURL 风格的 HTTP 传输日志
components/retrieverRetriever多查询检索、路由检索
components/toolToolJSON Schema 工具、MCP 工具、中间件(错误移除、JSON 修复)
components/documentDocument自定义解析器、扩展解析器、文本解析器
components/promptPromptChat Prompt 模板示例
components/lambdaLambdaLambda 函数组件示例

🚀 QuickStart (快速开始)

目录名称说明
quickstart/chatChat 快速开始最基础的 LLM 对话示例,包含模板、生成、流式输出
quickstart/eino_assistantEino 助手完整的 RAG 应用示例,包含知识索引、Agent 服务、Web 界面
quickstart/todoagentTodo Agent简单的 Todo 管理 Agent 示例

🛠️ DevOps (开发运维)

目录名称说明
devops/debug调试工具展示如何使用 Eino 的调试功能,支持 Chain 和 Graph 调试
devops/visualize可视化工具将 Graph/Chain/Workflow 渲染为 Mermaid 图表

详细文档

每个示例的详细说明请参考 COOKBOOK.md

相关资源

安全

如果你在该项目中发现潜在的安全问题,或你认为可能发现了安全问题,请通过我们的安全中心漏洞报告邮箱通知字节跳动安全团队。

不要创建公开的 GitHub Issue。

开源许可证

本项目依据 Apache-2.0 许可证 授权。