开源项目教程：BeeAI Framework

开源项目教程：BeeAI Framework

bee-agent-framework Framework for building scalable agentic applications. 项目地址: https://gitcode.com/gh_mirrors/be/bee-agent-framework

1. 项目的目录结构及介绍

BeeAI Framework 是一个用于构建生产级别的多智能体系统的开源框架，支持 Python 和 TypeScript 两种语言。以下是项目的目录结构及其简要介绍：

beeai-framework/
├── .githooks/
├── .gitignore
├── CITATION.cff
├── CODE_OF_CONDUCT.md
├── LICENSE
├── README.md
├── SECURITY.md
├── docs/
│   ├── ... (文档文件)
├── python/
│   ├── ... (Python 代码文件)
├── typescript/
│   ├── ... (TypeScript 代码文件)

• .githooks/: Git 钩子目录，用于自动化某些Git操作。
• .gitignore: Git 忽略文件，指定Git应该忽略的文件和目录。
• CITATION.cff: 用于引用此项目的CITATION文件。
• CODE_OF_CONDUCT.md: 项目行为准则文件。
• LICENSE: 项目许可证文件，本项目采用Apache-2.0许可证。
• README.md: 项目自述文件，包含项目介绍、安装指南和使用示例。
• SECURITY.md: 项目安全政策文件。
• docs/: 文档目录，包含项目文档。
• python/: Python 代码目录，包含Python实现的智能体框架代码。
• typescript/: TypeScript 代码目录，包含TypeScript实现的智能体框架代码。

2. 项目的启动文件介绍

项目的启动文件通常位于项目的根目录或特定的子目录中。以下是Python和TypeScript的启动文件介绍：

Python 启动文件

Python 启动文件通常是一个名为 main.py 的Python脚本，它包含了一个简单的多智能体工作流示例。

# main.py
import asyncio
from beeai_framework.backend.chat import ChatModel
from beeai_framework.tools.search.wikipedia import WikipediaTool
from beeai_framework.tools.weather.openmeteo import OpenMeteoTool
from beeai_framework.workflows.agent import AgentWorkflow, AgentWorkflowInput

async def main():
    # 创建聊天模型实例
    llm = ChatModel.from_name("ollama:granite3.1-dense:8b")
    # 创建智能体工作流
    workflow = AgentWorkflow(name="Smart assistant")
    # 添加智能体到工作流
    # ...
    # 运行工作流
    response = await workflow.run(inputs=[
        # ...
    ])
    # 输出结果
    print("==== Final Answer ====\n", response.result.final_answer)

if __name__ == "__main__":
    asyncio.run(main())

TypeScript 启动文件

TypeScript 启动文件可能是一个名为 main.ts 的TypeScript脚本，它同样包含了一个多智能体工作流的示例。

// main.ts
import { ChatModel } from 'beeai-framework/backend/chat';
import { WikipediaTool } from 'beeai-framework/tools/search/wikipedia';
import { OpenMeteoTool } from 'beeai-framework/tools/weather/openmeteo';
import { AgentWorkflow, AgentWorkflowInput } from 'beeai-framework/workflows/agent';

async function main() {
    // 创建聊天模型实例
    const llm = new ChatModel("ollama:granite3.1-dense:8b");
    // 创建智能体工作流
    const workflow = new AgentWorkflow("Smart assistant");
    // 添加智能体到工作流
    // ...
    // 运行工作流
    const response = await workflow.run([
        // ...
    ]);
    // 输出结果
    console.log("==== Final Answer ====\n", response.result.final_answer);
}

main();

3. 项目的配置文件介绍

项目的配置文件通常包含项目的设置和参数，可能包括但不限于以下文件：

• config.py 或 config.ts: 包含项目全局配置的Python或TypeScript文件。
• settings.json: 包含项目设置和参数的JSON文件。

例如，一个简单的 config.py 文件可能如下所示：

# config.py
# 项目配置
class Config:
    # 模型名称
    MODEL_NAME = "ollama:granite3.1-dense:8b"
    # 其他配置项
    # ...

# 实例化配置
config = Config()

这些配置文件在项目启动时被加载，并用于初始化项目的各个组件。

以上就是BeeAI Framework开源项目的目录结构、启动文件和配置文件的简要介绍。希望对您有所帮助！

bee-agent-framework Framework for building scalable agentic applications. 项目地址: https://gitcode.com/gh_mirrors/be/bee-agent-framework