快速参考文档
一、5分钟框架搭建
1.1 创建项目
cd d:\8nscsai\SCSAI\n8n\packages\frontend\plm
npx create-next-app@latest bossagents --typescript
cd bossagents
pnpm add better-sqlite3
1.2 目录结构
bossagents/
├── app/
│ ├── api/
│ │ ├── auth/ # 登录注册
│ │ ├── objects/ # 统一对象API
│ │ ├── models/ # 大模型配置
│ │ └── ai-proxy/ # AI代理
│ ├── lib/
│ │ ├── SCSAI/ # SCSAI集成
│ │ ├── aml/ # AML模板
│ │ ├── db/ # 数据库
│ │ └── llm/ # 大模型
│ └── (功能页面)/
├── components/
└── docs/
二、关键文件速查
| 功能 | 文件 | 关键代码 |
|------|------|----------|
| 数据库 | /app/lib/db/index.ts | getDatabase() |
| SCSAI初始化 | /app/lib/SCSAI/client.ts | initSCSAI() |
| AML执行 | /app/lib/SCSAI/aml.ts | executeAml(aml) |
| AML模板 | /app/lib/aml/index.ts | queryItems(), createItem() |
| 大模型调用 | /app/lib/llm/index.ts | getDefaultModel() |
| AI代理 | /app/api/ai-proxy/route.ts | POST /api/ai-proxy |
| 统一对象API | /app/api/objects/route.ts | GET/POST/PUT/DELETE |
| 登录 | /app/api/auth/login/route.ts | POST /api/auth/login |
| 注册 | /app/api/auth/register/route.ts | POST /api/auth/register |
三、大模型默认配置
讯飞星火
{
name: '讯飞星火',
provider: 'spark',
model: 'astron-code-latest',
apiKey: process.env.SPARK_API_KEY,
baseURL: 'https://maas-coding-api.cn-huabei-1.xf-yun.com/v2'
}
DeepSeek
{
name: 'DeepSeek',
provider: 'deepseek',
model: 'deepseek-chat',
apiKey: process.env.DEEPSEEK_API_KEY,
baseURL: 'https://api.deepseek.com/v1'
}
四、AML操作速查
4.1 查询
// 查询ECR列表
const aml = `<AML><Item type="ECR" action="get" select="id,change_number,title,status"></Item></AML>`;
// 按状态查询
const aml = `<AML><Item type="ECR" action="get"><status>pending_approval</status></Item></AML>`;
4.2 创建
const aml = `<AML>
<Item type="ECR" action="add">
<change_number>ECR-2026-0001</change_number>
<title>修改电机功率</title>
<description>客户要求降低功率</description>
<status>new</status>
</Item>
</AML>`;
4.3 编辑
const aml = `<AML>
<Item type="ECR" action="edit" id="${id}">
<status>approved</status>
</Item>
</AML>`;
4.4 删除
const aml = `<AML><Item type="ECR" action="delete" id="${id}"></Item></AML>`;
五、对象类型速查
| 对象类型 | 说明 | 主要字段 |
|----------|------|----------|
| ECR | 工程变更请求 | change_number, title, status |
| ECO | 工程变更指令 | change_number, title, status |
| Part | 零件 | part_number, name, description |
| BOM | 物料清单 | part_id, item_id, quantity |
| Vendor | 供应商 | name, contact, phone |
| Inventory | 库存 | part_id, quantity, location |
六、状态流转
ECR状态:
new → pending_approval → approved → in_progress → completed
↓
rejected
ECO状态:
new → pending_approval → approved → in_progress → completed
↓
rejected
七、快速使用示例
7.1 前端调用
// 查询数据
const res = await fetch('/api/objects?type=ECR&status=pending_approval');
const data = await res.json();
// 创建数据
const res = await fetch('/api/objects', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ type: 'ECR', data: { changeNumber: 'ECR-001', title: '测试' } })
});
// 调用大模型
const res = await fetch('/api/ai-proxy', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
messages: [{ role: 'user', content: '你好' }]
})
});
7.2 创建汽车对象
// 用户输入:创建一个汽车零件
// 大模型生成AML → 执行 → 保存
八、环境变量
文件位置:/app/.env.local
SCSAI_SERVER=https://ylxt.chat/scplm
SPARK_API_KEY=<已脱敏-请从.env读取>
DEEPSEEK_API_KEY=your-deepseek-api-key
九、文档位置
| 文档 | 位置 |
|------|------|
| SCSAI调用流程 | /docs/01_SCSAI_CALL_FLOW.md |
| AML操作方法 | /docs/02_AML_OPERATIONS.md |
| 系统框架 | /docs/03_SYSTEM_FRAMEWORK.md |
| AML模板管理 | /docs/04_AML_TEMPLATE_MANAGEMENT.md |
| 功能规划 | /docs/05_FEATURE_PLANNING.md |
| 快速参考 | /docs/QUICK_REFERENCE.md |
BossAgents