BambooAI

https://bambooai.org

BambooAI 是一个开源库，利用大型语言模型（LLMs）实现基于自然语言的数据分析。它既可以处理本地数据集，也能从外部来源和 API 获取数据。

目录

• 概述
• 功能
• 演示视频
• 安装
• 快速入门
• 工作原理
• 配置
  • 参数
  • 代理与模型配置
• 辅助数据集
• DataFrame 本体论（语义记忆）
• 向量数据库（情景记忆）
• 使用示例
• Web 应用程序设置
  • 使用 Docker（推荐）
  • 使用 pip 包
  • 使用完整仓库
• 模型支持
• 环境变量
• 日志记录
• 性能对比
• 贡献

概述

BambooAI 是一款实验性工具，通过允许用户以自然语言对话的方式与数据交互，使数据分析更加易于访问。它的设计目标是：

• 处理关于数据集的自然语言查询
• 生成并执行用于分析和可视化的 Python 代码
• 帮助用户在无需大量编程知识的情况下获得洞察
• 增强各层次数据分析师的能力
• 简化数据分析流程

功能

• 数据分析的自然语言界面
• 支持 Web UI 和 Jupyter Notebook
• 支持本地和外部数据集
• 集成互联网搜索和外部 API
• 流式过程中提供用户反馈
• 可选的复杂任务规划代理
• 集成自定义本体论
• 为数据分析和可视化生成代码
• 自我修复/错误纠正
• 自定义代码编辑和代码执行
• 通过向量数据库集成知识库
• 工作流保存和后续跟进
• 上下文相关及多模态查询

演示视频

机器学习示例（Jupyter Notebook）

演示如何创建一个预测泰坦尼克号乘客生存情况的机器学习模型：

https://github.com/user-attachments/assets/59ef810c-80d8-4ef1-8edf-82ba64178b85

体育数据分析（Web UI）

各种体育数据分析查询示例：

https://github.com/user-attachments/assets/7b9c9cd6-56e3-46ee-a6c6-c32324a0c5ef

安装

pip install bambooai

或者克隆仓库并安装依赖项：

git clone https://github.com/pgalko/BambooAI.git
pip install -r requirements.txt

快速入门

在 Google Colab 中尝试一个基本示例：

基本示例

1. 安装 BambooAI：

   pip install bambooai
   

2. 配置环境：

   cp .env.example .env
   # 编辑 .env 文件以适应您的设置
   

3. 配置代理/模型：

   cp LLM_CONFIG_sample.json LLM_CONFIG.json
   # 根据您希望使用的代理、模型和参数组合编辑 LLM_CONFIG.json 文件
   

4. 运行：

   import pandas as pd
   from bambooai import BambooAI
   
   import plotly.io as pio
   pio.renderers.default = 'jupyterlab'
   
   df = pd.read_csv('titanic.csv')
   bamboo = BambooAI(df=df, planning=True, vector_db=False, search_tool=True)
   bamboo.pd_agent_converse()
   

工作原理

BambooAI 的运行过程分为六个关键步骤：

1. 初始化

   • 以用户问题或提示开始
   • 在退出之前持续进行对话循环

2. 任务路由

   • 使用 LLM 对问题进行分类
   • 路由到适当的处理器（文本响应或代码生成）

3. 用户反馈

   • 如果指令模糊或不明确，模型会暂停并请求用户反馈
   • 如果在求解过程中遇到任何歧义，模型会暂停并提供几个选项供选择

4. 动态提示构建

   • 评估数据需求
   • 请求反馈或使用工具以获取更多上下文
   • 制定分析计划
   • 执行语义搜索以查找类似问题
   • 使用选定的 LLM 生成代码

5. 调试与执行

   • 执行生成的代码
   • 使用 LLM 进行错误纠正
   • 重试直至成功或达到限制

6. 结果与知识库

   • 对答案进行质量排序
   • 将高质量解决方案存储在向量数据库中
   • 展示格式化后的结果或可视化内容

流程图

配置

参数

BambooAI 接受以下初始化参数：

bamboo = BambooAI(
    df=None,                    # 用于分析的 DataFrame
    auxiliary_datasets=None,    # 辅助数据集路径列表
    max_conversations=4,        # 保留在内存中的对话对数量
    search_tool=False,          # 启用互联网搜索功能
    planning=False,             # 为复杂任务启用规划代理
    webui=False,                # 作为 Web 应用程序运行
    vector_db=False,            # 启用向量数据库以存储知识
    df_ontology=False,          # 使用自定义 DataFrame 本体
    exploratory=True,           # 启用专家选择来处理查询
    custom_prompt_file=None     # 允许使用自定义或修改后的提示模板
)

参数详细说明：

• df (pd.DataFrame, 可选)

  • 用于分析的输入 DataFrame
  • 如果未提供，BambooAI 将尝试从互联网或辅助数据集中获取数据

• auxiliary_datasets (list, 默认 None)

  • 辅助数据集的路径列表
  • 这些数据集将在需要时被纳入解决方案，并在代码执行时加载
  • 它们用于补充主 DataFrame

• max_conversations (int, 默认 4)

  • 在上下文中保持的用户与助手对话对数量
  • 影响上下文窗口大小和 token 使用量

• search_tool (bool, 默认 False)

  • 启用互联网搜索功能
  • 启用时需要提供相应的 API 密钥

• planning (bool, 默认 False)

  • 为复杂任务启用规划代理
  • 将任务分解为可管理的步骤
  • 提高复杂查询的解决方案质量

• webui (bool, 默认 False)

  • 将 BambooAI 作为 Web 应用程序运行
  • 使用 Flask API 提供 Web 界面

• vector_db (bool, 默认 False)

  • 启用向量数据库以存储知识和进行语义搜索
  • 存储高质量的解决方案供未来参考
  • 需要 Pinecone 的 API 密钥
  • 支持两种嵌入模型：text-embedding-3-small（OpenAI）和 all-MiniLM-L6-v2（HF）

• df_ontology (str, 默认 None)

  • 使用自定义 DataFrame 本体以提升理解能力
  • 需要 OWL 本体文件，格式为 .ttl。该参数接受 TTL 文件的路径。
  • 能显著提高解决方案的质量

• exploratory (bool, 默认 True)

  • 启用专家选择机制来处理查询
  • 在研究专家和数据分析员角色之间进行选择

• custom_prompt_file (str, 默认 None)

  • 允许用户提供自定义的提示模板
  • 需要提供包含模板的 YAML 文件路径

代理与模型配置

BambooAI 采用多代理系统，不同的专业代理负责数据分析过程中的特定环节。每个代理可以根据其具体需求配置不同的大语言模型及参数。

配置结构

LLM 配置存储在 LLM_CONFIG.json 文件中。以下是完整的配置结构：

{
  "agent_configs": [
    {"agent": "专家选择器", "details": {"model": "gpt-4.1", "provider":"openai","max_tokens": 2000, "temperature": 0}},
    {"agent": "分析师选择器", "details": {"model": "claude-3-7-sonnet-20250219", "provider":"anthropic","max_tokens": 2000, "temperature": 0}},
    {"agent": "理论家", "details": {"model": "gemini-2.5-pro-preview-03-25", "provider":"gemini","max_tokens": 4000, "temperature": 0}},
    {"agent": "数据框检查器", "details": {"model": "gemini-2.0-flash", "provider":"gemini","max_tokens": 8000, "temperature": 0}},
    {"agent": "规划者", "details": {"model": "gemini-2.5-pro-preview-03-25", "provider":"gemini","max_tokens": 8000, "temperature": 0}},
    {"agent": "代码生成器", "details": {"model": "claude-3-5-sonnet-20241022", "provider":"anthropic","max_tokens": 8000, "temperature": 0}},
    {"agent": "错误修正器", "details": {"model": "claude-3-5-sonnet-20241022", "provider":"anthropic","max_tokens": 8000, "temperature": 0}},
    {"agent": "评审员", "details": {"model": "gemini-2.5-pro-preview-03-25", "provider":"gemini","max_tokens": 8000, "temperature": 0}},
    {"agent": "解决方案总结器", "details": {"model": "gemini-2.5-flash-preview-04-17", "provider":"gemini","max_tokens": 4000, "temperature": 0}},
    {"agent": "谷歌搜索执行器", "details": {"model": "gemini-2.5-flash-preview-04-17", "provider":"gemini","max_tokens": 4000, "temperature": 0}},
    {"agent": "谷歌搜索总结器", "details": {"model": "gemini-2.5-flash-preview-04-17", "provider":"gemini","max_tokens": 4000, "temperature": 0}}
  ],
  "model_properties": {
    "gpt-4o": {"capability":"base","multimodal":"true", "templ_formating":"text", "prompt_tokens": 0.0025, "completion_tokens": 0.010},
    "gpt-4.1": {"capability":"base","multimodal":"true", "templ_formating":"text", "prompt_tokens": 0.002, "completion_tokens": 0.008},
    "gpt-4o-mini": {"capability":"base", "multimodal":"true","templ_formating":"text", "prompt_tokens": 0.00015, "completion_tokens": 0.0006},
    "gpt-4.1-mini": {"capability":"base", "multimodal":"true","templ_formating":"text", "prompt_tokens": 0.0004, "completion_tokens": 0.0016},
    "o1-mini": {"capability":"reasoning", "multimodal":"false","templ_formating":"text", "prompt_tokens": 0.003, "completion_tokens": 0.012},
    "o3-mini": {"capability":"reasoning", "multimodal":"false","templ_formating":"text", "prompt_tokens": 0.0011, "completion_tokens": 0.0044},
    "o1": {"capability":"reasoning", "multimodal":"false","templ_formating":"text", "prompt_tokens": 0.015, "completion_tokens": 0.06},
    "gemini-2.0-flash": {"capability":"base", "multimodal":"true","templ_formating":"text", "prompt_tokens": 0.0001, "completion_tokens": 0.0004},
    "gemini-2.5-flash-preview-04-17": {"capability":"reasoning", "multimodal":"true","templ_formating":"text", "prompt_tokens": 0.00015, "completion_tokens": 0.0035},
    "gemini-2.0-flash-thinking-exp-01-21": {"capability":"reasoning", "multimodal":"false","templ_formating":"text", "prompt_tokens": 0.0, "completion_tokens": 0.0},
    "gemini-2.5-pro-exp-03-25": {"capability":"reasoning", "multimodal":"true","templ_formating":"text", "prompt_tokens": 0.0, "completion_tokens": 0.0},
    "gemini-2.5-pro-preview-03-25": {"capability":"reasoning", "multimodal":"true","templ_formating":"text", "prompt_tokens": 0.00125, "completion_tokens": 0.01},
    "claude-3-5-haiku-20241022": {"capability":"base", "multimodal":"true","templ_formating":"xml", "prompt_tokens": 0.0008, "completion_tokens": 0.004},
    "claude-3-5-sonnet-20241022": {"capability":"base", "multimodal":"true","templ_formating":"xml", "prompt_tokens": 0.003, "completion_tokens": 0.015},
    "claude-3-7-sonnet-20250219": {"capability":"base", "multimodal":"true","templ_formating":"xml", "prompt_tokens": 0.003, "completion_tokens": 0.015},
    "open-mixtral-8x7b": {"capability":"base", "multimodal":"false","templ_formating":"text", "prompt_tokens": 0.0007, "completion_tokens": 0.0007},
    "mistral-small-latest": {"capability":"base", "multimodal":"false","templ_formating":"text", "prompt_tokens": 0.001, "completion_tokens": 0.003},
    "codestral-latest": {"capability":"base", "multimodal":"false","templ_formating":"text", "prompt_tokens": 0.001, "completion_tokens": 0.003},
    "open-mixtral-8x22b": {"capability":"base", "multimodal":"false","templ_formating":"text", "prompt_tokens": 0.002, "completion_tokens": 0.006},
    "mistral-large-2407": {"capability":"base", "multimodal":"false","templ_formating":"text", "prompt_tokens": 0.003, "completion_tokens": 0.009},
    "deepseek-chat": {"capability":"base", "multimodal":"false","templ_formating":"text", "prompt_tokens": 0.00014, "completion_tokens": 0.00028},
    "deepseek-reasoner": {"capability":"reasoning", "multimodal":"false","templ_formating":"text", "prompt_tokens": 0.00055, "completion_tokens": 0.00219},
    "/mnt/c/Users/pgalk/vllm/models/DeepSeek-R1-Distill-Qwen-14B": {"capability":"reasoning", "multimodal":"false","templ_formating":"text", "prompt_tokens": 0.00, "completion_tokens": 0.00},
    "deepseek-r1-distill-llama-70b": {"capability":"reasoning", "multimodal":"false","templ_formating":"text", "prompt_tokens": 0.00, "completion_tokens": 0.00},
    "deepseek-r1:32b": {"capability":"reasoning", "multimodal":"false","templ_formating":"text", "prompt_tokens": 0.00, "completion_tokens": 0.00},
    "deepseek-ai/deepseek-r1": {"capability":"reasoning", "multimodal":"false","templ_formating":"text", "prompt_tokens": 0.00, "completion_tokens": 0.00},
    "MiniMax-M2.7": {"capability":"base", "multimodal":"false","templ_formating":"text", "prompt_tokens": 0.001, "completion_tokens": 0.005},
    "MiniMax-M2.7-highspeed": {"capability":"base", "multimodal":"false","templ_formating":"text", "prompt_tokens": 0.001, "completion_tokens": 0.005}
  }
}

LLM_CONFIG.json 配置文件需要位于 BambooAI 工作目录中，例如 /Users/palogalko/AI_Experiments/Bamboo_AI/web_app/LLM_CONFIG.json，且所有指定模型的 API 密钥都需要存在于同样位于工作目录中的 .env 文件中。 根据我们在 2025 年 4 月 22 日使用体育和绩效数据集进行的测试结果，上述代理/模型组合是性能最佳的。我强烈建议您尝试不同的设置，以找到最适合您特定用例的组合。

代理角色

• 专家选择器：确定处理查询的最佳专家类型
• 分析师选择器：选择具体的分析方法
• 理论家：提供理论背景和方法论
• 数据框检查器：分析并理解数据结构。（需要本体文件）
• 规划者：创建逐步的分析计划
• 代码生成器：编写用于分析的Python代码
• 错误纠正器：调试并修复代码问题
• 评审员：评估解决方案的质量，并相应地调整计划
• 解决方案总结器：创建简洁的结果摘要
• 谷歌搜索执行器：优化并执行搜索查询
• 谷歌搜索总结器：综合搜索结果

配置字段

• agent_configs：智能体配置

  • agent：智能体类型
  • details：
    • model：模型标识符
    • provider：服务提供商（openai、anthropic、gemini等）
    • max_tokens：完成时的最大令牌数
    • temperature：创造力参数（0-1）

• model_properties：模型属性

  • capability：基础模型或推理模型
  • multimodal：多模态或仅文本
  • templ_formating：提示格式化。XML或文本
  • prompt_tokens：输入成本（1K）
  • completion_tokens：输出成本（1K）

如果在agent_configs中为某个智能体指定了模型，请确保该模型已在model_properties中定义。

示例替代配置

1. 使用Ollama：

{
  "agent": "Planner",
  "details": {
    "model": "llama3:70b",
    "provider": "ollama",
    "max_tokens": 2000,
    "temperature": 0
  }
}

2. 使用VLLM：

{
  "agent": "Code Generator",
  "details": {
    "model": "/path/to/model/DeepSeek-R1-Distill-14B",
    "provider": "vllm",
    "max_tokens": 2000,
    "temperature": 0
  }
}

3. 使用MiniMax：

{
  "agent": "Code Generator",
  "details": {
    "model": "MiniMax-M2.7",
    "provider": "minimax",
    "max_tokens": 8000,
    "temperature": 0.1
  }
}

辅助数据集

BambooAI支持同时处理多个数据集，从而实现更全面和更具上下文的分析。辅助数据集功能使您能够在主要数据集之外引用和整合其他数据源。

当您提出可能受益于辅助数据的问题时，BambooAI会：

1. 分析哪些数据集包含相关信息
2. 只加载必要的数据集
3. 根据需要进行数据连接或交叉引用
4. 生成并执行能够正确处理多数据集操作的代码

使用方法

from bambooai import BambooAI
import pandas as pd

# 加载主数据集
main_df = pd.read_csv('main_data.csv')

# 指定辅助数据集路径
auxiliary_paths = [
    'path/to/supporting_data1.csv',
    'path/to/supporting_data2.parquet',
    'path/to/reference_data.csv'
]

# 初始化带有辅助数据集的BambooAI
bamboo = BambooAI(
    df=main_df,
    auxiliary_datasets=auxiliary_paths,
)

数据框本体（语义记忆）

BambooAI支持自定义本体，以将智能体置于感兴趣的特定领域中。

本体集成维基

Medium博客文章

使用方法

from bambooai import BambooAI
import pandas as pd

# 使用本体文件路径初始化
bamboo = BambooAI(
    df=your_dataframe,
    df_ontology="path/to/ontology.ttl"
)

它的作用

本体文件使用RDF/OWL表示法定义您的数据结构，包括：

• 对象属性（关系）
• 数据属性（属性）
• 类（数据类型）
• 个体（具体实例）

这有助于BambooAI理解复杂的数据关系，并生成更准确的代码。

向量数据库（情景记忆）

BambooAI支持与向量数据库的集成。其主要目的是允许存储和检索成功的分析结果，从而使系统能够随着时间的推移不断进化和学习。

Medium博客文章

使用方法

from bambooai import BambooAI
import pandas as pd

# 使用本体文件路径初始化
bamboo = BambooAI(
    df=your_dataframe,
    vector_db=True
)

支持Pinecone和Qdrant两种向量数据库。通过环境变量配置您选择的数据库：

对于Pinecone： 需要一个Pinecone账户（免费），并将API密钥存储在.env文件中：

VECTOR_DB_TYPE=pinecone
PINECONE_API_KEY=<YOUR API KEY HERE>
PINECONE_CLOUD=aws
PINECONE_REGION=us-east-1

对于Qdrant： 可以使用本地Qdrant实例或Qdrant云服务。在.env文件中配置：

VECTOR_DB_TYPE=qdrant
QDRANT_URL=http://localhost:6333  # 用于本地Qdrant
QDRANT_API_KEY=<YOUR API KEY HERE>  # 本地可选，云端必填

它的作用

成功完成分析后，用户可以对解决方案进行排名并存储。

• 排名较高的解决方案（>6）将使用所选模型进行向量化，并连同解决方案元数据一起存储到配置的向量数据库中（Pinecone或Qdrant）。
• 元数据包括：
  • 数据模型
  • 计划
  • 编写的代码
  • 排名
• 当有新任务到来时，系统会查询向量索引，检索出相似度高于阈值（0.8）的最接近匹配项。
• 存储的解决方案将作为后续类似任务的参考，指导相关智能体完成求解过程。

使用示例

交互模式（Jupyter Notebook或CLI）

import pandas as pd
from bambooai import BambooAI

import plotly.io as pio
pio.renderers.default = 'jupyterlab'

df = pd.read_csv('training_activity_data.csv')
aux_data = [
    'path/to/wellness_data.csv',
    'path/to/nutrition_data.parquet',
]

bamboo = BambooAI(df=df, search_tool=True, planning=True)
bamboo.pd_agent_converse()

单次查询模式（Jupyter Notebook或CLI）

bamboo.pd_agent_converse("计算心率列的30%、50%、75%和90%分位数")

Web应用程序设置

Web UI截图（交互式工作流图）：

选项 1：使用 Docker（推荐）

BambooAI 可以通过 Docker 轻松部署，Docker 提供了一致的运行环境，不受您的操作系统或本地配置的影响。

有关详细的 Docker 设置和使用说明，请参阅我们的 Docker 设置 Wiki。

使用 Docker 的方法具有以下优势：

• 无需在本地管理 Python 依赖项
• 在不同机器上保持一致的运行环境
• 通过挂载卷轻松进行配置
• 支持基于仓库和独立部署
• 沙箱式代码执行，提升安全性

先决条件：

• 已在您的系统上安装 Docker
• 已在您的系统上安装 Docker Compose

选项 2：使用 pip 包

1. 安装 BambooAI：

   pip install bambooai
   

2. 从仓库下载 web_app 文件夹

3. 配置环境：

   cp .env.example <web_app路径>/.env
   # 编辑 .env 文件以设置您的参数
   

4. 配置 LLM 代理、模型和参数：

   cp LLM_CONFIG_sample.json <web_app路径>/LLM_CONFIG.json
   

   • 编辑 web_app 目录下的 web_app/LLM_CONFIG.json
   • 为每个代理配置所需的模型：

   {
      "agent_configs": [
        {
          "agent": "代码生成器",
          "details": {
            "model": "您首选的模型",
            "provider": "提供商名称",
            "max_tokens": 4000,
            "temperature": 0
          }
        }
      ]
   }
   

   • 如果未提供配置，程序将无法运行，并会显示错误信息。

5. 运行应用程序：

   cd <web_app路径>
   python app.py
   

选项 3：使用完整仓库

1. 克隆仓库：

   git clone https://github.com/pgalko/BambooAI.git
   cd BambooAI
   

2. 安装依赖项：

   pip install -r requirements.txt
   

3. 配置环境：

   cp .env.example web_app/.env
   # 编辑 .env 文件以设置您的参数
   

4. 配置 LLM 代理、模型和参数：

   cp LLM_CONFIG_sample.json web_app/LLM_CONFIG.json
   

   • 编辑 web_app 目录下的 web_app/LLM_CONFIG.json
   • 为每个代理配置所需的模型：

   {
      "agent_configs": [
        {
          "agent": "代码生成器",
          "details": {
            "model": "您首选的模型",
            "provider": "提供商名称",
            "max_tokens": 4000,
            "temperature": 0
          }
        }
      ]
   }
   

   • 如果未提供配置，程序将无法运行，并会显示错误信息。

5. 运行应用程序：

   cd web_app
   python app.py
   

访问 Web 界面：http://localhost:5000（如果使用 Docker，则为 5001）。

模型支持

基于 API 的模型

• OpenAI
• Google（Gemini）
• Anthropic
• Groq
• Mistral
• DeepSeek
• OpenRouter
• MiniMax

本地模型

• Ollama（所有模型）
• VLLM（所有模型）
• 各种本地模型

环境变量

.env 文件中需要的变量：

模型 API 密钥。请指定您想要使用且拥有访问权限的模型的 API 密钥。

• <厂商名称>_API_KEY：选定提供商的 API 密钥
• GEMINI_API_KEY：如果您想使用原生 Gemini 网络搜索工具（Grounding），则需要设置此密钥。您也可以选择使用 Selenium，但其速度较慢且集成度较低。

搜索和向量数据库 API 密钥（可选）

• PINECONE_API_KEY：用于向量数据库的可选密钥
• SERPER_API_KEY：用于 Selenium 搜索的必需密钥。

远程 API 端点（可选）

• REMOTE_OLLAMA：远程 Ollama 服务器的可选 URL
• REMOTE_VLLM：远程 VLLM 服务器的可选 URL。

应用程序配置

• FLASK_SECRET：用于对 WebApp 的会话 Cookie 进行签名
• WEB_SEARCH_MODE：'google_ai' 表示使用 Gemini 原生搜索工具，'selenium' 表示使用 Selenium Web 驱动程序
• SELENIUM_WEBDRIVER_PATH：Selenium Web 驱动程序的路径。如果您使用 'selenium' 搜索模式，则必须设置此路径。
• EXECUTION_MODE：'local' 表示在本地运行代码执行器，'api' 表示在远程服务器或容器上运行代码执行器。
• EXECUTOR_API_BASE_URL：远程代码执行器 API 的 URL。如果您使用 'api' 执行模式，则需要设置此参数，例如 http://192.168.1.201:5000。

日志记录

每次运行/线程的日志都存储在 logs/bambooai_run_log.json 中。当新线程开始时，该文件会被覆盖。

汇总日志存储在 logs/bambooai_consolidated_log.json 中，文件大小限制为 5MB，最多保留 3 个文件。日志信息包括：

• 链 ID
• LLM 调用详情（代理、时间戳、模型、提示、响应）
• 令牌使用情况和费用
• 性能指标
• 每个模型的统计摘要

性能对比

有关详细评估报告，请参阅：客观评估报告

贡献

欢迎通过拉取请求贡献代码。请注重代码的可读性和简洁性。

该项目已被 Cognition Labs 的 DeepWiki 索引，为开发者提供：

• AI 生成的全面文档
• 交互式代码探索
• 上下文感知开发指导
• 项目工作流可视化

访问项目的完整交互式文档： DeepWiki pgalko/BambooAI

注意事项

• 支持多种模型提供商和本地执行
• 代码执行需谨慎
• 请监控令牌使用情况
• 开发仍在进行中

联系方式

palo@bambooai.io

待办事项

• 计划进行未来改进

BambooAI 快速上手指南

BambooAI 是一个开源库，旨在通过大语言模型（LLM）实现基于自然语言的数据分析。它支持本地数据集，也能从外部源和 API 获取数据，帮助用户无需深厚编码功底即可洞察数据价值。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Linux, macOS 或 Windows
• Python 版本：推荐 Python 3.9 及以上版本
• 前置依赖：
  • pandas：用于数据处理
  • plotly：用于数据可视化（可选，但推荐）
• API 密钥：
  • 需配置至少一个大模型提供商的 API Key（如 OpenAI, Anthropic, Google Gemini 等）。
  • 若启用联网搜索或向量数据库功能，需额外配置相应服务的 API Key。

安装步骤

您可以选择通过 pip 直接安装，或克隆源码进行安装。

方式一：使用 pip 安装（推荐）

pip install bambooai

提示：国内用户若下载缓慢，可使用清华或阿里镜像源加速：

pip install bambooai -i https://pypi.tuna.tsinghua.edu.cn/simple

方式二：源码安装

git clone https://github.com/pgalko/BambooAI.git
cd BambooAI
pip install -r requirements.txt

基本使用

以下是使用 BambooAI 进行数据分析的最简流程。

1. 配置文件与环境变量

在使用前，需要复制示例配置文件并填入您的 API 密钥。

配置环境变量 (.env)：

cp .env.example .env
# 请使用文本编辑器打开 .env 文件，填入您的 LLM API KEY 等设置

配置模型与代理 (LLM_CONFIG.json)：

cp LLM_CONFIG_sample.json LLM_CONFIG.json
# 编辑 LLM_CONFIG.json，根据您的需求选择具体的模型（如 gpt-4, claude-3-5-sonnet 等）和参数

2. 代码示例

创建一个 Python 脚本（例如 demo.py），放入您的数据文件（如 titanic.csv），然后运行以下代码：

import pandas as pd
from bambooai import BambooAI

# 设置 Plotly 渲染器（如果在 Jupyter Lab 中使用）
import plotly.io as pio
pio.renderers.default = 'jupyterlab'

# 加载数据
df = pd.read_csv('titanic.csv')

# 初始化 BambooAI
# planning=True: 启用规划代理处理复杂任务
# search_tool=True: 启用联网搜索能力
# vector_db=False: 暂不启用向量数据库
bamboo = BambooAI(df=df, planning=True, vector_db=False, search_tool=True)

# 开始自然语言对话交互
bamboo.pd_agent_converse()

运行后，终端将进入交互模式，您可以直接输入自然语言问题（例如：“预测泰坦尼克号乘客的生存率”或“绘制男女乘客生存比例图”），BambooAI 将自动生成代码、执行分析并返回结果或图表。

3. 在线体验

如果您希望先在不配置本地环境的情况下尝试，可以使用 Google Colab 快速体验：