ドキュメント

インテグレーション

はじめに

TypeScript を使用して LM Studio プラグインにカスタム構成を追加する

ベータ版機能

プラグインサポートは現在プライベートベータ版です。こちらからベータ版に参加してください。

LM Studio プラグインはカスタム構成をサポートしています。つまり、構成スキーマを定義すると、LM Studio はコードを編集することなく、ユーザーにプラグインを構成するための UI を表示します。

設定には2種類あります。

  • チャットごとの構成: 特定のチャットに紐づきます。異なるチャットで異なる構成を持つことができます。プラグインの動作に影響するほとんどの設定はこのタイプであるべきです。
  • グローバル構成: すべてのチャットに適用され、アプリケーション全体で共有されます。API キーなどのグローバル設定に便利です。

設定のタイプ

@lmstudio/sdk パッケージの createConfigSchematics 関数を使用して、TypeScript で構成を定義できます。この関数を使用すると、さまざまなタイプとオプションを持つフィールドを定義できます。

サポートされているタイプは次のとおりです。

  • string: テキスト入力フィールド。
  • numeric: オプションの検証とスライダー UI を備えた数値入力フィールド。
  • boolean: チェックボックスまたはトグル入力フィールド。
  • stringArray: 設定可能な制約を持つ文字列値の配列。
  • select: 事前定義されたオプションを持つドロップダウン選択フィールド。

これらのフィールドの定義方法の詳細については、新規フィールドの定義 セクションを参照してください。

カスタム構成を使用するプラグインの例を以下に示します。

このページのソースは GitHub で利用可能です。