BuildingAI 帮助文档
BuildingAI 官网
  1. 插件与框架开发
  • 欢迎使用 BuildingAI
  • 演示环境
  • 用户社群
  • 企业版咨询
  • 产品线路图
  • 更新日志
  • API 赞助商
  • 积分获取方式
  • 应用安装教程「必看」
  • 部署教程
    • 宝塔面板部署
    • Windows 环境下 Docker 部署
    • Docker方式安装
  • 使用教程
    • 快速开始
      • 对话
      • 智能体
      • 知识库
      • 工作流
      • MCP 服务
      • 登录配置
      • 密钥配置
      • 模型计费
      • 积分充值
      • 会员订阅
      • 卡密兑换
      • DIY装修
    • 常见配置教程
      • 微信支付配置
      • 支付宝支付配置
      • 微信公众号配置
      • OSS存储配置
      • 短信配置
      • 谷歌登录配置
      • Ollama配置
    • 应用配置教程
      • 香蕉绘画-使用教程
      • Sora2短剧视频-使用教程
      • 即梦AI绘画-使用教程
    • 大模型申请教程
      • 即梦AI密钥-申请教程
      • 豆包大模型-申请教程
      • 通义千问-申请教程
    • 老版本教程
      • 功能使用教程
      • 智能体
      • MCP工具
      • DIY中心
  • 开发文档
    • 网络接口
      • 登录注册
        • 账号密码登录
        • 账号密码注册
      • 前台
        • 文件上传/下载
          • 单个上传
          • 多个上传
          • 列表
          • 详情
          • 下载
          • 删除
        • 用户
          • 算力明细
          • 登录配置
        • AI聊天
          • 对话(非流式)
          • 流式对话
          • 对话记录
          • 对话详情
          • 修改记录
          • 删除记录
          • 获取记录对话
        • MCP
          • 列表
          • 所有记录
          • 详情:id
          • 创建
          • 修改
          • 可见状态
          • 添加
          • 关联详情
          • 系统MCP
          • json导入
          • 移除
          • 删除
          • 获取快捷菜单
          • 系统MCP详情:id
          • 连通性
          • 批量连通性
        • 充值中心
          • 充值中心
          • 充值提交订单
          • 充值记录
          • 预支付
          • 获取支付结果
        • 模型厂商
          • 列表
          • 详情:id
          • 详情:code
        • AI模型
          • 列表
          • 详情:id
          • 默认模型
        • 数据分析
          • 数据记录
        • 会员中心
          • 会员中心信息
          • 获取套餐列表
          • 预支付
          • 订阅提交订单
      • 后台
        • 工作空间
          • MCP
            • 列表
            • 详情
            • 创建
            • 修改
            • 删除
            • 批量删除
            • 启用状态
            • json导入
            • 连通性
            • 批量连通性
            • 获取快捷菜单
            • 设置快捷菜单
          • AI模型
            • 厂商管理
              • 列表
              • 新增
              • 详情:id
              • 详情:provider
              • 修改
              • 删除
              • 状态
            • 模型管理
              • 列表
              • 新增
              • 详情:id
              • 修改
              • 删除:id
              • 批量删除
              • 设为默认
              • 模型类型
              • 模型支持能力
              • 父级模型类型
          • AI知识库
            • 知识库列表
            • 知识库详情
            • 转移知识库
            • 知识库删除
            • 知识库文档列表
            • 知识库文档详情
            • 知识库文档删除
            • 知识库分段列表
            • 知识库分段详情
            • 知识库分段删除
            • 数据列表接口
          • AI智能体
            • 智能体创建
            • 智能体列表
            • 智能体详情
            • 智能体对话记录列表
            • 智能体对话记录详情
            • 智能体对话
            • 智能体发布API接口对话
            • 智能体发布API获取对话列表
            • 智能体发布API获取对话消息
            • 智能体发布API更新对话
            • 智能体发布API删除对话
          • 密钥管理
            • 密钥模板
              • 列表
              • 全部列表
              • 详情
              • 创建
              • 修改
              • 删除
              • 批量删除
              • 修改状态
              • json导入
            • 密钥配置
              • 列表
              • 列表:templateId
              • 创建
              • 统计
              • 详情
              • 完整详情
              • 修改
              • 修改状态
              • 删除
              • 批量删除
        • 用户管理
          • 列表
          • 创建
          • 详情:id
          • 删除
          • 批量删除
          • 重置密码
          • 更新状态
          • 重置随机密码
          • 登录设置
          • 登录设置
        • 角色管理
          • 创建
          • 详情:id
          • 修改
          • 删除
          • 列表
        • 菜单管理
          • 创建
          • 详情:id
          • 修改
          • 删除
          • 列表
        • 插件管理
          • 我的插件
            • 列表
            • 修改
            • 详情:id
            • 创建
            • 启用列表
            • 批量删除
            • 删除:id
            • 批量状态
            • 禁用:id
            • 启用:id
            • 是否存在:identifier
            • 详情:identifier
            • 入库插件详情:identifier
            • 本地列表
            • 类型列表
            • 版本列表:identifier
            • 安装
            • 卸载
          • 插件操作
            • 下载
            • 安装
          • 平台密钥
            • 获取开发者密钥
            • 设置开发者密钥
        • 权限管理
          • 列表
          • 扫描权限
          • 同步到库
          • 扫描接口
          • 清理废弃权限
          • 详情:code
        • 字典配置
          • 列表
        • 系统操作
          • 支付配置
            • 列表
            • 详情:id
            • 状态
            • 更新
          • 系统信息
            • 安装状态
            • 安装状态
          • pm2
            • 进程列表
            • 日志
            • 重启
            • 重载
            • 停止进程
            • 进程详情
            • 进程状态
            • 清空日志
            • 保存进程
            • 健康检查
            • 删除进程
        • 套餐充值
          • 获取套餐充值配置
          • 获取套餐充值配置 Copy
        • 财务
          • 财务中心
          • 用户余额明细
        • 订单管理
          • 充值订单列表
          • 充值订单详情
          • 充值订单退款
          • 会员订单列表
        • 渠道管理
          • 公众号配置
            • 详情
            • 修改
        • 数据分析
          • 数据看板
        • VIP 会员
          • 会员等级
            • 新增会员等级
            • 会员等级列表
            • 修改会员等级
            • 会员等级详情
            • 删除会员等级
          • 订阅计划
            • 新增订阅计划
            • 订阅计划设置
            • 设置会员功能状态
            • 更改订阅计划状态
            • 订阅计划详情
            • 修改订阅计划
            • 删除订阅计划
            • 更新订阅计划排序
      • 插件
        • 文章插件
          • 前台
            • 列表
          • 后台
            • 文章
              • 列表
              • 创建
            • 分类
              • 列表
              • 创建
        • 智能体-企业微信插件
          • 对话接口
        • 配图大师
          • 后台
            • 配图记录
            • 获取配图插件
            • 插件设置
    • 插件与框架开发
      • 技术规范
      • 前置准备
      • 本地部署与开发
      • 目录结构
      • 项目配置
      • 应用开发
        • 介绍
        • 创建应用
        • 模板结构
        • 应用开发
        • 打包发布
        • 插件更新
      • PC 客户端
        • 开发文档
        • 构建文档
  • 设计资源
    • 官方素材库
  • 政策
    • 开源许可
    • 服务条款
    • 隐私政策
  1. 插件与框架开发

目录结构

截止于 v25.0.5 版本,项目目录结构如下所示:
/
├── assets/ 静态资源(项目级图片、图标等)
├── docker/  Docker 相关配置与镜像构建文件
├── extensions/ 扩展应用(可插拔扩展/示例扩展)
├── packages/ 包
│   ├── @buildingai/ (Core Shared Packages)
│   │   ├── ai-sdk/  AI SDK
│   │   ├── ai-sdk-new/ AI SDK(新版实现)
│   │   ├── ai-toolkit/ AI 工具集(上层工具/通用能力集合)
│   │   ├── alipay-sdk/ 支付宝 SDK(支付/签名等)
│   │   ├── base/ 基础能力(通用基类/约定/核心工具)
│   │   ├── cache/ 缓存
│   │   ├── config/ 配置
│   │   ├── constants/ 常量定义(跨包共享常量)
│   │   ├── db/ 数据库
│   │   ├── decorators/ 装饰器
│   │   ├── di/ 依赖注入
│   │   ├── dict/ 字典
│   │   ├── dto/ 数据传输对象
│   │   ├── errors/ 错误
│   │   ├── eslint-config/ ESLint 共享配置
│   │   ├── extension-sdk/ 扩展 SDK
│   │   ├── llm-file-parser/ LLM 文件解析
│   │   ├── logger/ 日志
│   │   ├── pipe/ 管道
│   │   ├── types/  类型声明
│   │   ├── typescript-config/ TS配置
│   │   ├── upgrade/ 升级框架
│   │   ├── utils/   工具函数
│   │   ├── web/  Web 共享包集合
│   │   │   ├── core/  Web 核心
│   │   │   ├── hooks/   通用 hooks
│   │   │   ├── http/   HTTP 客户端封装
│   │   │   ├── i18n/   国际化
│   │   │   ├── services/   API services
│   │   │   ├── stores/  全局状态
│   │   │   ├── types/  Web 侧类型
│   │   │   └── ui/   UI 组件库
│   │   └── wechat-sdk/   微信 SDK
│   │
│   ├── api/   Backend API Service
│   │   ├── dist/    编译产物
│   │   ├── src/     源码
│   │   │   ├── assets/   服务静态资源
│   │   │   ├── common/    公共层
│   │   │   ├── core/   核心基础设施
│   │   │   ├── migrations/   数据库迁移
│   │   │   ├── modules/    业务模块
│   │   │   └── main.ts    服务入口
│   │   ├── data/    运行数据
│   │   ├── storage/    服务运行时存储
│   │   ├── nest-cli.json    Nest CLI 配置
│   │   ├── eslint.config.mjs   ESLint 配置
│   │   ├── tsconfig*.json    TS 配置(build/编译配置)
│   │   └── package.json    包配置
│   │
│   ├── cli/    (Command Line Interface)
│   │   ├── bin/ 
│   │   ├── src/
│   │   │   ├── commands/  命令实现
│   │   │   ├── utils/   工具
│   │   │   └── index.ts    CLI 程序入口/导出
│   │   ├── eslint.config.mjs    ESLint 配置
│   │   ├── tsconfig*.json    TS 配置)
│   │   └── package.json     包配置
│   │
│   ├── client/   (Web Frontend Packages)
│   │   ├── dist/    构建产物
│   │   ├── public/    公共静态资源
│   │   ├── src/ 
│   │   │   ├── assets/   资源
│   │   │   ├── components/  通用组件
│   │   │   ├── hooks/   通用 hooks
│   │   │   ├── layouts/      布局
│   │   │   ├── locales/    国际化资源
│   │   │   ├── pages/    页面
│   │   │   ├── router/   路由配置
│   │   │   ├── styles/    全局样式/主题
│   │   │   ├── utils/     前端工具函数
│   │   │   ├── main.tsx    前端入口
│   │   │   └── vite-env.d.ts   Vite 类型声明
│   │   ├── index.html   Vite HTML 模板
│   │   ├── vite.config.ts      Vite 配置
│   │   ├── eslint.config.mjs       ESLint 配置
│   │   ├── tsconfig*.json          TS 配置
│   │   └── package.json            包配置
│   │
│   └── core/    ( Core Logic & Services)
│       ├── dist/        编译产物
│       ├── src/     源码
│       │   ├── @nestjs/            Nest 相关扩展/适配
│       │   ├── decorators/         装饰器
│       │   ├── interfaces/         接口定义
│       │   ├── modules/            核心模块
│       │   ├── services/           核心服务层
│       │   └── index.ts            导出入口
│       ├── eslint.config.mjs       ESLint 配置
│       ├── tsconfig*.json          TS 配置
│       └── package.json            包配置
├── public/                         项目级静态资源
├── scripts/                        工程脚本
├── skills/                         规则/技能资源
├── storage/                        项目级运行时存储
├── templates/                      模板
├── logs/                           日志目录
├── .dockerignore                   Docker 忽略
├── .editorconfig                   编辑器风格配置
├── .gitignore                      Git 忽略
├── docker-compose.yml              Docker Compose 编排
├── ecosystem.config.js             PM2 配置
├── LICENSE                         许可证
├── PRIVACY_NOTICE.md               隐私声明
├── README.md                       项目说明(英文)
├── README.zh-CN.md                 项目说明(中文)
├── package.json                    根包配置
├── pnpm-lock.yaml                  pnpm 锁文件
├── pnpm-workspace.yaml             pnpm 工作区配置
└── turbo.json                      TurboRepo 配置
修改于 2026-04-13 06:34:12
上一页
本地部署与开发
下一页
项目配置
Built with