文档

集成

简介

使用 TypeScript 为 LM Studio 插件添加自定义配置

测试版功能

插件支持目前处于内部测试阶段。在此加入测试

LM Studio 插件支持自定义配置。也就是说,你可以定义一个配置 schema,LM Studio 会向用户呈现一个 UI,以便他们无需编辑任何代码即可配置你的插件。

配置有两种类型

  • 按聊天配置:与特定聊天绑定。不同的聊天可以有不同的配置。大多数影响插件行为的配置都应属于此类型。
  • 全局配置:适用于所有聊天,并在整个应用程序中共享。这对于 API 密钥等全局设置非常有用。

配置类型

你可以使用 @lmstudio/sdk 包中的 createConfigSchematics 函数在 TypeScript 中定义配置。此函数允许你定义具有各种类型和选项的字段。

支持的类型包括

  • string: 文本输入字段。
  • numeric: 带可选验证和滑块 UI 的数字输入字段。
  • boolean: 复选框或切换输入字段。
  • stringArray: 具有可配置约束的字符串值数组。
  • select: 带有预定义选项的下拉选择字段。

有关如何定义这些字段的更多详细信息,请参阅定义新字段部分。

示例

以下是一些使用自定义配置的插件

本页面源码可在 GitHub 上查看