Skip to content

api_docs.md

Latest commit

 

History

History
136 lines (96 loc) · 3.17 KB

api_docs.md

File metadata and controls

136 lines (96 loc) · 3.17 KB

AI题库服务API文档

概述

AI题库服务是一个基于OpenAI API的问题解答服务，专为OCS (Online Course Script)设计，可以通过AI自动回答题目。此服务实现了与OCS AnswererWrapper兼容的API接口，方便用户将AI能力整合到OCS题库搜索中。

接口详情

搜索接口

URL: /api/search

方法: GET 或 POST

参数:

参数名 类型 必填 说明
title string 是 题目内容
type string 否 题目类型 (single-单选, multiple-多选, judgement-判断, completion-填空)
options string 否 选项内容，通常是A、B、C、D选项的文本

成功响应:

{
  "code": 1,
  "question": "问题内容",
  "answer": "AI生成的答案"
}

失败响应:

{
  "code": 0,
  "msg": "错误信息"
}

健康检查接口

URL: /api/health

方法: GET

响应:

{
  "status": "ok",
  "message": "AI题库服务运行正常",
  "version": "1.0.0",
  "cache_enabled": true,
  "model": "gpt-3.5-turbo"
}

缓存清理接口

URL: /api/cache/clear

方法: POST

响应:

{
  "success": true,
  "message": "缓存已清除"
}

统计信息接口

URL: /api/stats

方法: GET

响应:

{
  "version": "1.0.0",
  "uptime": 1621234567.89,
  "model": "gpt-3.5-turbo",
  "cache_enabled": true,
  "cache_size": 123
}

OCS配置示例

在OCS的自定义题库配置中添加如下配置：

[
  {
    "name": "AI智能题库",
    "homepage": "https://github.com/yourusername/ai-answer-service",
    "url": "http://localhost:5000/api/search",
    "method": "get",
    "contentType": "json",
    "data": {
      "title": "${title}",
      "type": "${type}",
      "options": "${options}"
    },
    "handler": "return (res)=> res.code === 1 ? [res.question, res.answer] : [res.msg, undefined]"
  }
]

安全设置

如果你想增加安全性，可以在.env文件中设置访问令牌：

ACCESS_TOKEN=your_secret_token_here

设置后，所有API请求都需要包含此令牌，可以通过以下两种方式之一传递：

  1. HTTP头部: X-Access-Token: your_secret_token_here
  2. URL参数: ?token=your_secret_token_here

注意事项

  1. 多选题答案格式: 对于多选题，OCS期望的答案格式是用#分隔的选项，例如A#B#C。本服务会自动处理这个格式，将OpenAI返回的多选答案转换为此格式。

  2. API请求限制: 注意OpenAI API有使用限制和费用。确保你的账户有足够的额度来处理预期的请求量。

  3. 网络连接: 确保部署此服务的服务器能够访问OpenAI API（api.openai.com）。某些地区可能需要代理服务。

  4. 题库域名: 根据OCS文档说明，需要将题库配置中homepage以及url所涉及到的域名，在脚本头部元信息@connect中新增，否则无法请求到数据。