简介

幕间 JS-SDK 通过 NPM 包的方式进行了发布:@mujian/js-sdk

两个版本

  • 原生 JavaScript 版本:主要用于不依赖框架的项目,可以支持 React、Vue、三方游戏引擎 等等
  • React 版本:只适用于 React 框架项目

能力简介

  • ai 相关
    • 对话补全相关
    • 发送请求
    • 项目信息
    • 人设信息
    • 模型设置
    • ...
    • 文字补全相关
    • ...
  • game 相关(筹备)
  • 移动端跨端相关(筹备)
  • 玩家相关(筹备)
  • UI 相关(筹备)
  • 工具函数(筹备)

API 模块结构

AI 模块 (ai)

对话相关 (ai.chat)

对话补全
  • complete(): 发送消息并获取 AI 回复
  • continue(): 继续生成
  • regenerate(): 重新生成
  • applyRegex(): 对消息应用正则表达式
消息管理 (ai.chat.message)
  • getAll(): 获取所有消息
  • deleteOne(): 删除单条消息
  • editOne(): 编辑消息
  • swipe(): 滑动切换消息版本
  • getPrompt(): 获取消息提示词
项目信息 (ai.chat.project)
  • getInfo(): 获取项目信息(返回 ProjectInfo
设置 (ai.chat.settings)
  • 模型设置 (ai.chat.settings.model)
    • getAll(): 获取所有可用模型
    • getActive(): 获取当前激活的模型
    • setActive(): 设置激活的模型
  • 人设设置 (ai.chat.settings.persona)
    • getActive(): 获取当前激活的人设
    • setActive(): 设置激活的人设

文本生成 (ai.text)

  • complete(): 文本补全(筹备中)

游戏模块 (game)

存档管理 (game.saves)

  • saveGame(): 保存游戏(筹备中)
  • loadGame(): 加载游戏(筹备中)

其他模块(筹备中)

  • ui: UI 相关功能
  • util: 工具函数
  • hybrid: 跨端相关
  • player: 玩家相关