​

声明 AI 任务

{
  "id": "u-hello",
  "name": "你好世界",
  "aiTasks": [
    {
      "id": "explain",
      "title": "解释一下",
      "trigger": "user",
      "scope": "word_sentence",
      "tier": 1,
      "output": { "reply": "string" },
      "required": ["reply"],
      "prompt": "用一句中文解释给定的词或短语在学习笔记语境下的意思。reply 写那一句话，不要罗列义项、不要加原文里没有的信息。"
    }
  ]
}

• id：任务的标识，依据该字段指定要调用的任务。
• title：显示给用户的任务名称。
• trigger：说明该任务的发起方式。默认值 "user"。
  • "user" 表示仅在用户触发之后发出
  • "auto" 表示允许插件自行发起。需要先取得一次同意。
• scope：发送出去的材料的范围。
  • word_sentence 允许插件提供一个词语和该词语所在的句子。词语不超过 80 个字符，句子不超过 600 个字符。
  • card_text MN 从卡片中取出标题与正文，插件传入的内容不予采用。
  • attempt_ink 用于读取卡上书写内容的场合：手写、文本框与公式框合并为一张图片发送，交由识别手写的模型处理，卡上没有书写内容时该次调用会被拒绝。
• prompt：提示词。
• output：返回值的 JSON Schema，取值只能是 "string"、"number" 与 "bool"。
• required：output 中必须有值的字段。
• tier：所用的模型级别，0 最快，2 最强，默认值 0。

​

调用 AI

• word_sentence 的材料由插件放进参数，需提供 word 与 sentence。
• card_text 的材料由 MN 从卡片上取出，参数不会发送出去，参数 中填写的内容不予采用。
• attempt_ink 的图片由 MN 从卡上合成，图片之外的材料由插件放进参数，例如题干与参考答案。

// word_sentence
var r = await mn.ai(noteid, "explain", { word: word, sentence: sentence });
if (r && r.ok) {
  show(r.json.reply);
}
// card_text
var r = await mn.ai(noteid, "make_summary", {});
// attempt_ink
// TODO: 补充示例

• 成功时返回 { ok: true, text, json }。
  • json：按任务的 output 解析出来的对象
  • text：模型返回的原文。
• 失败时返回 { ok: false, error }，error 包括：
  • bad_args 表示材料不符合要求，或该任务的声明不合格。
  • bad_output 表示模型返回的字段结构不对，卡片上没有写入任何内容。
  • task_used 表示同一张卡上的该任务 MN 只发送一次，重复请求会被拒绝。
  • declined 表示用户在弹出的提示中选择了拒绝。
  • consent_required 表示自动发起的任务尚未取得同意。
  • max_required 表示该任务需要 MAX 订阅。
  • no_service 表示 App 中尚未配置 AI 服务。
  • rate_limited 表示请求过于频繁。
  • no_ticket 表示该卡没有交给本插件的 AI。
  • not_owner 表示该卡上的 AI 交给了别的插件。
  • network 表示请求没有送达。
  • no_ink 表示作答区域中没有可以取用的内容。

​

指定 AI 交给的插件

{
  "excerptShortcuts": [
    {
      "title": "收进生词本",
      "hashtag": "#Pending",
      "ai_addon": "mn.hello"
    }
  ]
}

​

从模板读取任务列表

var t = await mn.api("/immersive/template");
var tasks = (t && t.aiTasks) || [];
tasks.forEach(function (task) {
  addButton(task.title || task.id, function () { runAI(task.id); });
});