匡优AI出题API文档
2024/11/1 09:43:43
匡优AI出题API接口文档
注: 接口默认共享10QPS,接口不能使用'不限题数日包'
请求鉴权
匡优AI出题会对每一个API请求进行身份验证,用户需要使用 密钥(SK) 经过特定方法生成 管理凭证 access_token 并在请求头部使用Authorization 字段传入该管理凭证,形式如下:
Authorization: <access_token>
1、获取access_token
准备工作.获取密钥(SK)
您需要联系客服取得密钥
注意: 密钥(SecretKey)是非常重要且隐私的信息,泄露可能会造成严重的后果,请不要直接放在客户端。
获取题目生成授权access_token 生成的access_token一次有效,生成使用后会失效
GET https://aiapi.kyou.ltd/api/v2/get-token?secret=sk&count=4&grant_type=gen
参数说明:
- secret:凭证密钥,即 SK 密钥
- count:生成题目数量
- grant_type:授权类型,gen:生成试题,query:查询生成接口
返回数据示例 正常返回
{
"access_token":"ACCESS_TOKEN",
"expires_in":300
}
参数 | 说明 |
---|---|
access_token | 获取到的凭证 |
expires_in | 凭证有效时间,单位:秒 |
错误时返回
{"status": "error","errmsg":"invalid appid"}
errmsg值 | 说明 |
---|---|
question_limit | 生成题数限制,账号剩余题数不足以生成请求count题数 |
2、知识点生成接口
请求url:
https://aiapi.kyou.ltd/api/v2/gen-question-by-desc/multiple-types
监听示例:
let aiServer = new SSE(url, {
headers: {
Authorization: 'access_token',
'Content-Type': 'application/x-www-form-urlencoded'
},
payload: 'description=请生成单选题&language=zh-cn&questions=[{"name":"单选题","questionType":"multiplechoise","count":1,"dfficulty":"easy"}]',
method: 'POST'
})
//流式返回
ai_gen_source.addEventListener('message', function (e) {
let data = decodeURIComponent(escape(atob(e.data)))
console.log(data)
})
// 结束
ai_gen_source.addEventListener('generate_count', function (e) {
})
//生成错误信息
ai_gen_source.addEventListener('error', function (e) {
let error = JSON.parse((e.data))
console.log(error)
})
授权凭证
Authorization: <access_token>
payload 参数说明
参数 | 必填 | 说明 |
---|---|---|
description | 是 | 知识点描述 |
language | 是 | 生成试题语言,参数可选:zh-cn(简体中文)、zh-hk(繁体中文)、en(英语)、ja(日语)、fr(法语)、de(德语)、ru(俄语) |
questions | 是 | json数组, {"questionType":"multiplechoise","count":1,"dfficulty":"easy"} |
生成questions参数说明:可传多个题型
参数 | 必填 | 说明 |
---|---|---|
questionType | 是 | 可选:multiplechoise(单选题)、multipleresponse(多选题)、truefalse(判断题)、fillblank(填空题)、essay(问答题) |
count | 是 | 生成题目数量 |
dfficulty | 是 | 生成题目简单、中等、困难参数可选: easy、medium、hard |
返回体:流式返回
3、资料生成接口
请求url:
https://aiapi.kyou.ltd/api/v2/gen-question-by-content-direct/multiple-types
监听示例:
let aiServer = new SSE(url, {
headers: {
Authorization: 'access_token',
'Content-Type': 'application/x-www-form-urlencoded'
},
payload: 'content=请生成单选题&language=zh-cn&questions=[{"name":"单选题","questionType":"multiplechoise","count":1,"dfficulty":"easy"}]',
method: 'POST'
})
//流式返回
ai_gen_source.addEventListener('message', function (e) {
let data = decodeURIComponent(escape(atob(e.data)))
console.log(data)
})
// 结束
ai_gen_source.addEventListener('generate_count', function (e) {
})
//生成错误信息
ai_gen_source.addEventListener('error', function (e) {
let error = JSON.parse((e.data))
console.log(error)
})
授权凭证
Authorization: <access_token>
payload 参数说明
参数 | 必填 | 说明 |
---|---|---|
content | 是 | 生成资料文本,文本字数限制不得超过5万字 |
language | 是 | 生成试题语言,参数可选:zh-cn(简体中文)、zh-hk(繁体中文)、en(英语)、ja(日语)、fr(法语)、de(德语)、ru(俄语) |
questions | 是 | json数组,{"questionType":"multiplechoise","count":1,"dfficulty":"easy"} |
生成questions参数说明:可传多个题型
参数 | 必填 | 说明 |
---|---|---|
questionType | 是 | 可选:multiplechoise(单选题)、multipleresponse(多选题)、truefalse(判断题)、fillblank(填空题)、essay(问答题) |
count | 是 | 生成题目数量 |
dfficulty | 是 | 生成题目简单、中等、困难参数可选: easy、medium、hard |
返回体:流式返回
上一篇 :
一个视频教你如何使用匡优AI出题
下一篇 :
从零到一:30天深度应用AI出题的震撼成果