BuildingAI 帮助文档
BuildingAI 官网
  1. 插件与框架开发
  • 欢迎使用 BuildingAI
  • 演示环境
  • 用户社群
  • 产品线路图
  • 更新日志
  • API 赞助商
  • 积分获取方式
  • 安装教程
    • 宝塔面板部署
    • Windows 环境下 Docker 部署
    • Docker方式安装
    • 手动安装
  • 使用教程
    • 功能使用教程
    • 智能体
    • DIY中心
    • 计费管理
    • 支付配置
    • 公众号配置
    • OSS存储配置
    • 应用安装教程
  • 开发文档
    • 网络接口
      • 登录注册
        • 账号密码登录
        • 账号密码注册
      • 前台
        • 文件上传/下载
          • 单个上传
          • 多个上传
          • 列表
          • 详情
          • 下载
          • 删除
        • 用户
          • 算力明细
          • 登录配置
        • 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 客户端
        • 开发文档
        • 构建文档
  • 设计资源
    • 官方素材库
  • 政策
    • 开源许可
    • 服务条款
    • 隐私政策
BuildingAI 官网
  1. 插件与框架开发

目录结构

截止于 v25.0.5 版本,项目目录结构如下所示:
/
├── assets/ 静态资源
├── docker/ Docker 配置
├── extensions/ 扩展应用
├── packages/ 包
│   ├── @buildingai/ (Core Shared Packages)
│   │   ├── ai-sdk/ AI SDK
│   │   ├── base/ 基础
│   │   ├── cache/ 缓存
│   │   ├── config/ 配置
│   │   ├── constants/ 常量
│   │   ├── db/ 数据库
│   │   ├── decorators/ 装饰器
│   │   ├── di/ 依赖注入
│   │   ├── dict/ 字典
│   │   ├── dto/ 数据传输对象
│   │   ├── errors/ 错误
│   │   ├── eslint-config/ ESLint 配置
│   │   ├── extension-sdk/ 扩展 SDK
│   │   ├── logger/ 日志
│   │   ├── pipe/ 管道
│   │   ├── types/ 类型
│   │   ├── typescript-config/ TypeScript 配置
│   │   ├── upgrade/ 升级
│   │   ├── utils/ 工具
│   │   └── wechat-sdk/ 微信 SDK
│   │
│   ├── api/ (Backend API Service)
│   │   ├── dist/ 编译后的文件
│   │   ├── src/ 源码
│   │   │   ├── assets/ 静态资源
│   │   │   ├── common/ 公共
│   │   │   │   ├── constants/ 常量
│   │   │   │   ├── decorators/ 装饰器
│   │   │   │   ├── filters/ 过滤器
│   │   │   │   ├── guards/ 保护
│   │   │   │   ├── interceptors/ 拦截器
│   │   │   │   ├── interfaces/ 接口
│   │   │   │   ├── modules/ 模块
│   │   │   │   └── utils/ 工具
│   │   │   ├── core/
│   │   │   │   ├── database/ 数据库
│   │   │   │   ├── logger/ 日志
│   │   │   │   └── queue/ 队列
│   │   │   ├── modules/
│   │   │   │   ├── ai/ AI
│   │   │   │   ├── analyse/ 分析
│   │   │   │   ├── auth/ 认证
│   │   │   │   ├── channel/ 渠道
│   │   │   │   ├── config/ 配置
│   │   │   │   ├── decorate/ 装饰
│   │   │   │   ├── extension/ 扩展
│   │   │   │   ├── finance/ 财务
│   │   │   │   ├── health/ 健康检查
│   │   │   │   ├── membership/ 会员
│   │   │   │   ├── menu/ 菜单
│   │   │   │   ├── pay/ 支付
│   │   │   │   ├── permission/ 权限
│   │   │   │   ├── pm2/ PM2
│   │   │   │   ├── recharge/ 充值
│   │   │   │   ├── role/ 角色
│   │   │   │   ├── schedule/ 定时任务
│   │   │   │   ├── system/ 系统
│   │   │   │   ├── tag/ 标签
│   │   │   │   └── upload/ 上传
│   │   │   └── main.ts
│   │   ├── package.json
│   │   └── tsconfig.json
│   │
│   ├── cli/ (Command Line Interface)
│   │   ├── bin/
│   │   ├── src/
│   │   │   ├── commands/ 命令
│   │   │   └── utils/ 工具
│   │   └── package.json
│   │
│   ├── core/ (Core Logic & Services)
│   │   ├── dist/
│   │   ├── src/
│   │   │   ├── @nestjs/ @nestjs
│   │   │   ├── decorators/ 装饰器
│   │   │   ├── interfaces/ 接口
│   │   │   ├── modules/
│   │   │   │   ├── billing/ 计费
│   │   │   │   ├── extension/ 扩展
│   │   │   │   ├── queue/ 队列
│   │   │   │   ├── secret/ 密钥
│   │   │   │   └── upload/ 上传
│   │   │   └── services/ 服务
│   │   └── package.json
│   │
│   ├── desktop/ (Desktop Application - Tauri)
│   │   ├── src-tauri/
│   │   │   ├── capabilities/ 能力
│   │   │   ├── gen/ 生成
│   │   │   ├── icons/ 图标
│   │   │   ├── src/ 源代码
│   │   │   └── tauri.conf.json
│   │   └── package.json
│   │
│   └── web/ (Web Frontend Packages)
│       ├── @buildingai/
│       │   ├── designer/ 设计器
│       │   ├── hooks/ 钩子
│       │   ├── http/ HTTP
│       │   ├── i18n-config/ 国际化配置
│       │   ├── layouts/ 布局
│       │   ├── nuxt/ nuxt配置
│       │   ├── service/ API服务
│       │   ├── stores/ 全局状态
│       │   ├── storybook/ storybook配置
│       │   ├── ui/ 组件库
│       │   └── web-config/ web配置
│       └── buildingai-ui/
│           ├── .nuxt/ 生成的 Nuxt 文件
│           ├── .output/ 构建输出
│           ├── .storybook/ Storybook 配置
│           ├── app/ 主应用源码
│           │   ├── assets/
│           │   ├── components/
│           │   ├── i18n/ 国际化
│           │   ├── layouts/ 布局
│           │   ├── middleware/ 路由中间件
│           │   ├── pages/ 基于文件的路由
│           │   ├── stores/ 状态管理
│           │   ├── types/ TypeScript 类型
│           │   ├── utils/ 工具函数
│           │   ├── app.config.presets.ts
│           │   ├── app.config.ts
│           │   └── app.vue
│           ├── modules/ Nuxt 模块
│           ├── public/ 静态资源
│           ├── server/ 服务端 API/中间件
│           ├── ai-rules.md
│           ├── eslint.config.mjs
│           ├── nuxt.config.ts (Nuxt Configuration)
│           ├── package.json
│           ├── README.md
│           └── tsconfig.json
├── public/ 静态资源
├── scripts/ 脚本
├── templates/ 模板
├── .dockerignore Docker 忽略
├── .editorconfig 编辑器配置
├── .env 环境变量
├── .gitignore Git 忽略
├── docker-compose.yml Docker Compose
├── ecosystem.config.js PM2 配置
├── LICENSE 许可证
├── package.json 包配置
├── pnpm-lock.yaml pnpm 锁
├── pnpm-workspace.yaml pnpm 工作区
├── README.md 项目说明
└── turbo.json turbo 配置
修改于 2026-01-05 09:16:17
上一页
本地部署与开发
下一页
项目配置
Built with