HUICHUAN-AI

command module
v1.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 16, 2026 License: AGPL-3.0 Imports: 35 Imported by: 0

README

HUICHUAN-AI

HUICHUAN-AI 是一个统一、可靠、可审计的 AI API 网关与数据快照平台。项目提供多模型供应商接入、渠道路由、令牌管理、用量计费、在线升级、数据快照留存、管理员授权与访问审计能力。

当前版本

  • 版本:v1.0.2
  • Go module:github.com/01121531/HUICHUAN-AI
  • 默认服务名:HUICHUAN.service
  • 默认前端:web/default

核心能力

  • 统一模型网关:兼容 OpenAI Chat/Responses、Anthropic Messages、Gemini、Claude、OpenRouter、Ollama、通义、智谱、火山、腾讯、百度等渠道。
  • 渠道路由与重试:支持优先级、权重、分组、模型映射、失败重试和渠道健康检测。
  • 令牌与权限管理:支持用户令牌、模型范围、额度、分组、管理员权限和 Root 特权。
  • 用量与计费:提供请求日志、Token 统计、模型倍率、分组倍率、余额、订阅、充值与账单能力。
  • 数据快照:可选择模型范围后,仅保存完整成功的模型调用样本,支持筛选、查看、导出和删除。
  • 访问审计:管理员查看、下载、删除数据快照都会记录操作人、时间、动作、目标记录和交付状态。
  • 在线升级:系统设置中支持检测 GitHub 新版本,并在网页端触发升级流程。
  • 多语言界面:支持简体中文、繁体中文、英文、法文、日文、俄文和越南文。
  • 容器化部署:支持 Docker、Docker Compose、systemd、Nginx/Caddy 反向代理等部署方式。

数据快照功能

数据快照默认关闭,可由 Root 在系统设置中开启,并选择全部模型或指定模型范围。采集逻辑以最终成功的上游请求与响应为准,失败重试、非 2xx、客户端取消、半截流或 Schema 校验失败的请求不会进入主数据集。

支持协议
  • OpenAI POST /v1/chat/completions
  • OpenAI POST /v1/responses
  • Anthropic POST /v1/messages
  • Gemini generateContent / streamGenerateContent

首版不保存 embedding、rerank、图像生成、音频转写和 WebSocket Realtime。

输出格式

导出的 JSONL 每行固定包含 11 个顶层字段:

session_id
user_id_hash
model
user_agent
system_prompt
tools
messages
response
created_at
cwd
_meta

归一化规则:

  • messages 统一为 Anthropic 风格 {role, content}。
  • 系统消息移入 system_prompt。
  • OpenAI function tools 转为 {name, description, input_schema}。
  • 工具调用和工具结果统一为 tool_use / tool_result 内容块。
  • URL、文件信息和内联 Base64 等多模态内容完整保留。
  • 认证 Header、Cookie、API Key、渠道密钥和客户端 IP 不进入数据集。
存储结构

每个用户、令牌和会话使用独立 JSONL 文件,便于隔离、删除和导出:

logs/datasets/
└── node-<node>/
    └── user-<user-id>/
        └── token-<token-id>/
            └── session-<session-id>.jsonl

页面不直接按 JSONL 文件展示,而是按用户名聚合,并支持按时间、模型、令牌、分组、渠道 ID、用户和内容关键字筛选。管理员可以勾选多条记录或多个用户,将结果合并导出为一个 JSONL 文件。

权限与审计

Root 可在用户管理中按管理员单独授权:

权限 能力
dataset_capture.view 查看用户聚合、筛选结果和完整记录详情
dataset_capture.download 导出选择结果,且必须同时具备查看权限

以下动作会进入审计:

  • 查看数据快照列表与详情
  • 下载数据快照 JSONL
  • 删除数据快照会话文件
  • 更新数据快照策略
  • 更新管理员数据快照权限

访问审计不保存提示词、回复正文、工具参数、内容搜索词、认证信息或绝对文件路径。删除原始快照后,审计定位信息仍会保留。

数据库结构变化

应用启动时通过 GORM AutoMigrate 自动创建或更新相关表。对话正文保存在 JSONL 文件中,不写入业务数据库。

dataset_capture_indices

可重建的数据快照元数据索引,用于用户聚合、筛选、分页、导出定位和删除定位。主要字段包括:

  • capture_id
  • node
  • file_id
  • row
  • user_id
  • token_id
  • token_scope
  • user_group
  • requested_model
  • effective_model
  • channel_id
  • session_id
  • captured_at
  • record_size

该表不保存提示词、回复正文、工具参数、认证信息、令牌密钥或绝对路径。

dataset_capture_access_audits

保存管理员访问事件,包括管理员 ID、用户名、认证方式、IP、操作类型、交付状态、记录数量、导出字节数和时间。

dataset_capture_access_audit_items

保存访问事件中的每条数据快照定位信息,包括 capture_id、用户名、令牌名、模型、分组、渠道 ID 和会话 ID。该表用于事后确认“谁在什么时候查看或下载了哪条数据”。

options

新增或使用以下系统配置项:

Key 说明
DatasetCaptureEnabled 是否开启数据快照
DatasetCaptureModelMode all 或 selected
DatasetCaptureModels 指定模型列表 JSON
DatasetCapturePermissionMigrated 旧版权限迁移标记
权限数据

数据快照权限复用现有 Casbin 与角色体系,不新增明文权限表。Root 隐式具备全部能力,普通管理员需要单独授权,普通用户不能访问数据快照管理页。

独立 Capture Proxy

其他项目可以只修改 API Base URL,通过独立代理复用同一套归一化器:

$env:CAPTURE_PROXY_UPSTREAM = "https://api.openai.com"
$env:CAPTURE_PROXY_LISTEN = ":8080"
$env:DATASET_CAPTURE_HMAC_KEY = "replace-with-a-stable-secret"
$env:DATASET_CAPTURE_PATH = ".\logs\datasets\sample-{date}-{node}.jsonl"
go run ./cmd/dataset-capture-proxy

健康检查:

GET /__capture/health

快速开始

Docker 开发环境
git clone https://github.com/01121531/HUICHUAN-AI.git
cd HUICHUAN-AI
docker compose -f docker-compose.dev.yml up -d --build

访问:

http://localhost:3000
本地开发
# 启动 PostgreSQL、Redis 和后端服务
make dev-api

# 启动默认前端
make dev-web

也可以单独启动前端:

cd web
bun install --frozen-lockfile
cd default
bun run dev

构建与验证

go vet ./...
go test ./... -count=1
go build -o .run/huichuan.exe .
cd web/default
bun run i18n:sync
bun run build

升级说明

  1. 升级前备份数据库和 logs/datasets。
  2. 拉取新版本或使用系统设置中的在线升级功能。
  3. 启动后等待数据库自动迁移完成。
  4. 使用 Root 检查数据快照开关、模型范围和管理员权限。
  5. 检查系统设置中的版本检测与数据快照访问审计页面。

v1.0.2 更新摘要

  • 项目命名全面迁移为 HUICHUAN-AI / HUICHUAN。
  • ??????? HUICHUAN.service?
  • Go module 迁移为 github.com/01121531/HUICHUAN-AI。
  • 删除 .agents/skills 以及不属于当前项目发布内容的设计文档。
  • 修复 Go vet 发现的返回值、SSE 渲染和地址拼接问题。
  • 修复数据快照访问审计,增强查看、下载和删除的留痕能力。
  • 更新 README,记录数据快照和数据库结构变化。

License

AGPL-3.0

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL