使用文档

快速上手

只需 3 分钟，即可将 QuizMind AI 集成到您的 OCS 题库中

首先安装 OCS 网课助手

您需要先安装 OCS 网课助手 - 全域名通用版，才能使用 QuizMind AI 题库服务：

油猴安装
GreasyFork 脚本站
脚本猫安装
ScriptCat 脚本站

1. 配置API

填写 OpenAI API Key

2. 生成配置

一键生成 OCS 配置

3. 添加到OCS

粘贴配置即可使用

生成配置

配置步骤

填写 API Key

访问 QuizMind AI 主页，在"配置生成器"中填写您的 OpenAI API Key。

获取 API Key：登录 OpenAI 控制台，创建新的 API Key。

选择模型

在"模型列表"中选择要使用的 AI 模型，支持多个模型轮询。

推荐配置：
gpt-4o-mini （速度快，成本低）
o3-mini （效果好，成本高）

高级选项

  • API Base URL：使用第三方服务时修改
  • 访问令牌：增加额外的安全验证
  • 缓存功能：避免重复调用，节省成本
  • 题库收集：自动构建本地题库

生成配置

点击"生成OCS配置"按钮，系统会自动生成加密的配置文件。

导入已有配置

如果您之前已经生成过配置，可以直接导入使用：

  1. 点击"导入配置"按钮
  2. 粘贴完整的 OCS 配置（JSON 格式）
  3. 系统会自动解析并填充表单
  4. 可以修改配置后重新生成

提示：导入配置后，您的 API Key 会自动解密并填充到表单中，方便修改。

OCS 集成教程

详细步骤

复制配置

生成配置后，点击"复制"按钮，复制完整的 JSON 配置。 

[{
    "name": "QuizMind AI智能题库",
    "homepage": "https://your-domain.com/quizmind-ai/",
    "url": "https://your-domain.com/quizmind-ai/api/search.php",
    "method": "get",
    "type": "GM_xmlhttpRequest",
    "contentType": "json",
    "data": {
        "title": "${title}",
        "type": "${type}",
        "options": "${options}",
        "config": "加密的配置字符串...",
        "allow_collection": "true"
    },
    "handler": "return (res)=> res.code === 1 ? [res.question, res.answer] : [res.msg, undefined]"
}]

打开 OCS 设置

在 OCS 扩展中，点击设置图标，找到"自定义题库"选项。

添加题库

将复制的配置粘贴到"自定义题库"文本框中，点击保存。

测试连接

使用 OCS 的测试功能，验证题库是否正常工作。

测试使用

网页测试

在 QuizMind AI 主页右侧的"在线测试"工具中：

  1. 输入问题内容
  2. 选择题目类型（可选）
  3. 输入选项内容（可选）
  4. 点击"获取答案"

OCS 测试

在 OCS 中使用快捷键或菜单：

  • 选中题目文本
  • 右键选择"搜索答案"
  • 选择"QuizMind AI智能题库"
  • 等待 AI 返回答案

快速测试：使用主页提供的示例题目，一键测试各种题型。

高级功能

题库管理

访问"统计面板"可以查看和管理题库：

  • 浏览所有收集的题目
  • 按类型和关键词搜索
  • 查看题型分布统计
  • 导出题库为 JSON 或 CSV 格式

性能优化

  • 启用缓存：相同问题 24 小时内不会重复调用 AI
  • 题库收集：已有答案的题目直接返回，响应时间 < 100ms
  • 多模型轮询：主模型失败时自动切换备用模型
  • 并发控制：文件锁机制确保高并发下的数据一致性

安全特性

  • 配置加密：API Key 使用 AES-256 加密传输
  • 访问令牌：可选的额外认证层
  • 请求验证：防止恶意请求和爬虫
  • 日志记录：完整的访问和错误日志

部署要求

系统要求

  • PHP 7.4 或更高版本
  • OpenSSL 扩展（用于加密）
  • cURL 扩展（用于 API 调用）
  • JSON 扩展（用于数据处理）
  • 可写的文件系统（用于缓存和题库）

推荐配置

  • PHP 8.0+（更好的性能）
  • HTTPS 证书（安全传输）
  • Redis/Memcached（可选，高级缓存）
  • CDN 加速（可选，静态资源）

安装步骤

  1. 下载代码 
    git clone https://github.com/yourusername/quizmind-ai.git
cd quizmind-ai
  2. 设置权限 
    chmod -R 755 .
chmod -R 777 cache/ data/ logs/
  3. 配置 Web 服务器

    Apache 已包含 .htaccess，Nginx 需要添加重写规则。

  4. 访问安装

    打开浏览器访问您的域名即可开始使用。

配置说明

主要配置文件位于 lib/config.php：

基础配置

$defaultConfig = [
    'version' => '2.2.0',          // 版本号
    'base_path' => '/quizmind-ai', // 部署路径
    'debug' => false,              // 调试模式
    'cache_expiration' => 86400,   // 缓存时间（秒）
    'log_level' => 'INFO',         // 日志级别
];

高级配置

  • timeout：API 请求超时时间
  • max_retries：失败重试次数
  • rate_limit：请求频率限制

安全设置

重要：生产环境部署前，请务必修改默认的加密密钥！

修改加密密钥

编辑 lib/config.php 文件： 

function encryptConfig($config) {
    $key = 'YOUR_NEW_32_CHAR_SECRET_KEY_HERE'; // 32位密钥
    // ...
}

function decryptConfig($encryptedData) {
    $key = 'YOUR_NEW_32_CHAR_SECRET_KEY_HERE'; // 保持一致
    // ...
}

其他安全建议

  • 使用 HTTPS 协议部署
  • 设置强密码的访问令牌
  • 定期备份题库数据
  • 限制文件上传权限
  • 启用 Web 应用防火墙
  • 定期更新 PHP 和依赖库

API 文档

搜索接口

GET /api/search.php

请求参数

参数 类型 必需 说明
title string 是 问题内容
type string 否 题目类型
options string 否 选项内容
config string 是 加密配置

响应示例

{
    "code": 1,
    "question": "中国的首都是哪个城市？",
    "answer": "北京"
}

其他接口

  • GET /api/stats.php - 获取系统统计信息
  • GET /api/export.php - 导出题库数据
  • POST /api/encrypt_config.php - 加密配置
  • POST /api/decrypt_config.php - 解密配置

常见问题

Q: API Key 安全吗？

A: API Key 在传输和存储时都经过 AES-256 加密，项目为社区提供便利，我们并不盈利，请合理使用。

我部署在https://whx1216.top/ocs_ai_api上的可以放心使用不储存任何隐私信息，承诺隐私安全。

Q: 如何降低 API 成本？

A: 启用缓存和题库收集功能，相同问题不会重复调用 AI。使用 gpt-3.5-turbo 模型成本更低。

Q: 支持哪些题目类型？

A: 支持单选题、多选题、判断题、填空题。系统会自动识别题型，也可以手动指定。

Q: 如何备份题库？

A: 访问统计面板，使用导出功能可以下载 JSON 或 CSV 格式的题库备份。

Q: 可以使用其他 AI 模型吗？

A: 可以，只要兼容 OpenAI API 格式即可。修改 API Base URL 为第三方服务地址。

故障排除

常见错误及解决方案

API 调用失败

  • 检查 API Key 是否正确
  • 确认余额充足
  • 验证网络连接
  • 查看错误日志：logs/error.log

配置无法保存

  • 检查目录权限：chmod 777 data/
  • 确认磁盘空间充足
  • 验证 PHP 配置

OCS 无法连接

  • 确认 URL 地址正确
  • 检查访问令牌设置
  • 查看浏览器控制台错误
  • 测试 API 端点：curl YOUR_URL/api/search.php

调试模式：修改 config.php 中的 'debug' => true 可以查看详细错误信息。