sillytavern-api-reference

SillyTavern API リファレンス

共通のコミュニケーション

TW の平易な言葉とガイダンスのルールを適用してください。用語は初出時に説明し、ユーザーが選択した新人／入门／熟练／老手のレベルを維持し、どのレベルでも必要な変更やバグについて説明してください。ソウルモードや文章モードでも、この基本方針は無効になりません。

プラグインの実行環境

このスキルをプラグイン、クラウドホスト、またはリモートマシン経由で実行する場合は、実行開始時にプラグイン実行契約を読み、ホスト固有のコマンドを実行する前に、ホスト、ツール、永続化に関する確認事項を適用してください。このスキルの対象範囲、認可、受け入れ条件は維持してください。

$consult-tavernweave-library の sillytavern-api-reference ルートを使い、関連する最小限の ST ガイド一式を特定してから、特定した対象バージョンに照らして正確なシンボルを確認してください。ガイドルートは参照先を見つけるための手掛かりであり、インストール済みの実行環境や固定されたソースに代わるものではありません。タスクが書き込み可能になった場合に限り、A0 を追加してください。

このスキルは、対象の実行環境における信頼できる API ソースを見つけるために使います。変化し続ける API の固定仕様として扱わないでください。references/core-facts.md に記載された公開ベースラインは、日付付きの参照用スナップショットであり、最新リリースの説明を意図したものではありません。対象の実行環境を引き続き権威ある情報源としてください。

ワールドブック／テンプレートへの登録、明示的な読み取り、メッセージウィンドウ、または状態からプロンプトへの受け渡しに関する契約については、E03 バージョン検証を使用してください。ここでは固定ソースで確認された内容と、未検証の対象ホストとを分けて記録しています。選択した仕組みに必要な確認項目だけを読み込んでください。

実行環境の API を特定する

API を選ぶ前に、依頼された操作をすべて分類してください。

サーフェス	用途	主な参照元
SillyTavern コア	ホストコンテキスト、ネイティブイベント、レンダリング、拡張機能 API	インストール済みの SillyTavern リリースのソースとドキュメント
Tavern Helper / JS-Slash-Runner	メッセージ、変数、生成、注入、ワールドブック、iframe のヘルパー	インストール済み拡張機能に対応する宣言とドキュメント
STScript	スラッシュコマンドのパイプライン、クロージャー、Quick Replies、スコープ付き変数	実行中の SillyTavern インスタンスのコマンドヘルプ、または対応するコマンドリファレンス
マクロ	プロンプト生成時の置換と簡単な変数アクセス	実行中の SillyTavern インスタンスのマクロヘルプ、または対応するマクロリファレンス
ST-Prompt-Template	EJS 評価とプロンプトテンプレート機能	インストール済み拡張機能のバージョンと上流のドキュメント
MVU / MagVarUpdate	構造化された stat_data、更新の解析、置換、ライフサイクルイベント	インストール済みの MVU グローバル、対応する宣言、上流のソース

名前の似たグローバルが存在するという理由だけで、あるサーフェスのシンボルを別のサーフェスに流用しないでください。

検証ワークフロー

1. 対象のバージョンと機能を記録します。Tavern Helper のコンテキストでは、getTavernVersion() と getTavernHelperVersion() を優先します。省略可能な統合機能は、typeof、Object.keys、または文書化された初期化ヘルパーを使って確認します。

2. 各依存関係がホストから提供されるのか、カードに組み込まれているのか、リモートから読み込まれるのかを特定します。インポートされたヘルパーやグローバルシンボルから、インストール要件を推測してはいけません。

3. 対象バージョンに合致する情報源を調べます。実行時のソースまたは公式のバージョン付きドキュメントを優先し、次に対応する型宣言、最後に references/core-facts.md の公開相互運用性インデックスを参照します。

4. シンボルの正確な表記、パラメーターの形、戻り値の型、イベント定数、またはコマンド文法をそのまま転記します。記憶から再構成してはいけません。依頼に具体的なシンボル名またはインストール済みバージョンが記載されていない場合は、正確な値やシグネチャを提示する前に止めます。フックと実行時環境の情報を尋ね、変動するブランチの例を、対象の実行環境に関する回答であるかのように自発的に提示してはいけません。

5. バージョンに依存する作業では、次の簡潔な形式で出典を記録します。

   symbol: updateWorldbookWith
   surface: Tavern Helper
   applies_to: detected extension version or declaration snapshot
   provenance: public upstream URL plus commit/path, or identified runtime source
   confidence: high | medium | low
   runtime_check: performed check, or reason it remains pending
   

6. 対応が確認されている最小限の API を実装し、機能が利用できない場合の処理を追加します。非公開のホスト DOM、非推奨 API、または異なる永続化スコープへ、黙ってフォールバックしてはいけません。

7. 意図したコンテキストで呼び出しを検証します。ブラウザーのコンソールで確認できても、メッセージ iframe、スクリプト iframe、プロンプトテンプレート、または STScript パイプライン内で同じグローバルが利用できることの証明にはなりません。

信頼度のルール

• 高：対象の実行環境に一致するソースコード、公式のバージョン付きドキュメント、または対象の実行環境で確認された型宣言から得た正確な情報です。
• 中：型宣言のみ、変更履歴のみ、単一の情報源、または近接したバージョンに基づく情報です。機能確認のためのプローブ、または実際の実行環境でのテストを追加します。
• 低：推測に基づく情報、矛盾する情報、またはバージョンが特定されていない情報です。それに基づいて実装せず、先に矛盾を解消します。

main、release、beta など、変更され続けるブランチ名はバージョンの識別情報ではありません。参照先としてのみ有用な場合は、その旨を明記します。正確なイベント値またはコールバックシグネチャを含む例には、不変のコミットまたは一致するインストール済みソースを必ず明記し、別の実行環境や特定されていない実行環境への回答として提示してはいけません。

型宣言から確認できることと、実行時に観測されたことを区別します。型宣言で表記と名目上の型は確認できますが、コールバックのタイミング、ライフサイクル、副作用、実際に利用できるかどうかは未検証のままです。

実装ルール

• 必要な操作に対応する Tavern Helper ラッパーがある場合は、それを優先してください。ラッパーでカバーされていないコア状態や API を扱う場合に限り、window.SillyTavern.getContext() を使用してください。
• 注入されたグローバル関数と window.TavernHelper のプロパティは、インストール済みバージョンを確認してから、同じヘルパー機能への 2 つのアクセス方法として扱ってください。
• 現行の WorldbookEntry API ファミリーである getWorldbook、replaceWorldbook、updateWorldbookWith、createWorldbookEntries、deleteWorldbookEntries を優先してください。新しいコードに非推奨の lorebook-entry API を導入しないでください。
• オブジェクト全体の置換よりも、アップデーター関数またはエントリーレベルのヘルパーを優先してください。不明なフィールド、エントリーの識別情報、無関係なユーザーコンテンツ、意図されたチャット／キャラクター／グローバルのスコープを保持してください。
• generate と generateRaw を区別してください。後者は順序を指定した独自のプロンプトを渡します。どちらも通常のチャットターンを作成したり、MVU の解析を自動実行したりするものと想定しないでください。
• メッセージのフロアとスワイプを明示的に扱ってください。別ページが重要な場合は include_swipes: true を指定して読み取り、書き込み後は最小限の refresh スコープを選択してください。
• Mvu などのオプショナルなグローバルが使えるようになるまで待ってください。エクスポートされたイベント定数を使って購読してください。特に、上流の文字列値に過去のスペルミスが含まれる場合は必ずそうしてください。
• API 識別子だけから、プロバイダー、インストール状態、または提供形態を推測しないでください。実際のカードスクリプト、インポート、マニフェスト宣言、ランタイム登録経路を追跡してください。
• 同梱された国内版／グローバル版の MVU Zod スクリプトはカードアセットとして扱い、その存在と有効状態がカードの契約と一致することを確認してください。それらのスクリプトがインポートする Git／CDN モジュールは、リモート経由で提供されるものとして扱ってください。この同梱された読み込み経路を、単独の Zod インストール手順に置き換えないでください。
• リモートインポートはランタイムでの提供として扱い、インストールや実行の証拠とは見なさないでください。URL／ref、フォールバック、準備完了の確認方法を記録してください。
• マクロは置換処理に使用してください。変数を書き込むマクロは、プレビュー、スワイプ、再レンダリング時に実行される可能性があります。タイミングが重要な場合は、明示的なトランザクションを使用してください。
• STScript のパイプ値、名前付き引数の構文、引用符、クロージャーの区切り文字は、ドキュメントに記載されたとおり正確に保持してください。/send はメッセージを追加しますが、それ自体で生成を開始するわけではありません。
• リスナー、プロンプト注入、タイマー、共有インターフェースのライフサイクルが現在の操作を超えて存続する可能性がある場合は、後始末を追加してください。
• API キー、認証データ、拡張機能の設定、プライベートなチャット内容をログや例で決して公開しないでください。

不一致の解決

情報源の記述が食い違う場合：

1. 同じインターフェースとリリースについて説明しているか確認します。
2. ガイドや宣言より、対象ランタイムの実装を優先します。
3. 正確な表記については、説明文の要約より、生の宣言またはコマンド／マクロのリファレンスを優先します。
4. 動作がまだ不明確な場合は確信度を下げ、最小限のランタイムプローブを提示します。
5. 推測したコードを実行可能なものとして提示するのではなく、未解決の事実を明記します。

出力仕様

API に依存する回答やパッチでは：

• ランタイムまたは拡張機能の依存関係をすべて明記します。
• 各依存関係がホスト提供、カード組み込み、リモート読み込み、オプショナル、地域別、開発専用のいずれであるかを示します。
• 検出されたバージョンまたは想定したバージョンを明記します。
• 重要なシンボルごとに、根拠として使用した正確な情報源を特定します。
• 正しい実行コンテキスト向けのコードを提示します。
• 追加で必要な機能プローブや実ランタイムでの確認には、その旨のラベルを付けます。
• 静的な調査だけでは、メッセージの作成、イベントのタイミング、iframe へのアクセス、MVU の永続化を証明できると主張しないでください。

ユーザーから正確な API の質問を解決するための情報が十分に提供されていない場合は、必要な証拠を簡潔に求め、安全なランタイムプローブの計画を提示するのが正しい出力です。バージョン不明の正確なシグネチャを加えて、回答を水増ししないでください。