chore(i18n): refresh ja-JP translations
This commit is contained in:
parent
1685bbb6cf
commit
fbb95e1f0d
File diff suppressed because it is too large
Load Diff
@ -1,106 +1,106 @@
|
||||
---
|
||||
read_when:
|
||||
- メモリ昇格を自動的に実行したい
|
||||
- 各 Dreaming フェーズの役割を理解したい
|
||||
- MEMORY.md を汚さずに統合を調整したい
|
||||
summary: ライト、ディープ、REM フェーズと Dream Diary によるバックグラウンドメモリ統合
|
||||
- 各Dreamingフェーズの役割を理解したい
|
||||
- MEMORY.mdを汚さずに統合を調整したい
|
||||
summary: 軽い睡眠、深い睡眠、REMの各フェーズとDream Diaryを備えたバックグラウンドメモリ統合
|
||||
title: Dreaming(実験的)
|
||||
x-i18n:
|
||||
generated_at: "2026-04-06T03:06:13Z"
|
||||
generated_at: "2026-04-06T04:43:36Z"
|
||||
model: gpt-5.4
|
||||
provider: openai
|
||||
source_hash: f27da718176bebf59fe8a80fddd4fb5b6d814ac5647f6c1e8344bcfb328db9de
|
||||
source_hash: 36c4b1e70801d662090dc8ce20608c2f141c23cd7ce53c54e3dcf332c801fd4e
|
||||
source_path: concepts/dreaming.md
|
||||
workflow: 15
|
||||
---
|
||||
|
||||
# Dreaming(実験的)
|
||||
|
||||
Dreaming は `memory-core` のバックグラウンドメモリ統合システムです。
|
||||
これにより OpenClaw は、強い短期シグナルを耐久性のあるメモリへ移しつつ、
|
||||
そのプロセスを説明可能かつレビュー可能な状態に保てます。
|
||||
Dreamingは、`memory-core`のバックグラウンドメモリ統合システムです。
|
||||
これによりOpenClawは、短期的な強いシグナルを永続的なメモリへ移しつつ、
|
||||
そのプロセスを説明可能でレビュー可能な状態に保てます。
|
||||
|
||||
Dreaming は **オプトイン** で、デフォルトでは無効です。
|
||||
Dreamingは**オプトイン**で、デフォルトでは無効です。
|
||||
|
||||
## Dreaming が書き込むもの
|
||||
## Dreamingが書き込む内容
|
||||
|
||||
Dreaming は 2 種類の出力を保持します。
|
||||
Dreamingは2種類の出力を保持します。
|
||||
|
||||
- `memory/.dreams/` 内の **マシン状態**(リコールストア、フェーズシグナル、取り込みチェックポイント、ロック)。
|
||||
- `DREAMS.md`(または既存の `dreams.md`)内の **人が読める出力** と、`memory/dreaming/<phase>/YYYY-MM-DD.md` 配下の任意のフェーズレポートファイル。
|
||||
- `memory/.dreams/`内の**マシン状態**(リコールストア、フェーズシグナル、取り込みチェックポイント、ロック)。
|
||||
- `DREAMS.md`(または既存の`dreams.md`)内の**人が読める出力**と、`memory/dreaming/<phase>/YYYY-MM-DD.md`配下の任意のフェーズレポートファイル。
|
||||
|
||||
長期昇格は引き続き `MEMORY.md` にのみ書き込まれます。
|
||||
長期メモリへの昇格は引き続き`MEMORY.md`にのみ書き込まれます。
|
||||
|
||||
## フェーズモデル
|
||||
|
||||
Dreaming は協調して動作する 3 つのフェーズを使用します。
|
||||
Dreamingは、協調して動作する3つのフェーズを使用します。
|
||||
|
||||
| フェーズ | 目的 | 永続的な書き込み |
|
||||
| フェーズ | 目的 | 永続書き込み |
|
||||
| ----- | ----------------------------------------- | ----------------- |
|
||||
| Light | 最近の短期マテリアルを整理してステージングする | いいえ |
|
||||
| Deep | 耐久性のある候補をスコアリングして昇格する | はい(`MEMORY.md`) |
|
||||
| REM | テーマと繰り返し現れるアイデアを振り返る | いいえ |
|
||||
| Light | 最近の短期メモリ素材を整理してステージングする | なし |
|
||||
| Deep | 永続化候補をスコア付けして昇格する | あり(`MEMORY.md`) |
|
||||
| REM | テーマや繰り返し現れるアイデアを振り返る | なし |
|
||||
|
||||
これらのフェーズは内部実装の詳細であり、ユーザーが個別に設定する
|
||||
「モード」ではありません。
|
||||
これらのフェーズは内部実装の詳細であり、ユーザーが個別に設定する「モード」ではありません。
|
||||
|
||||
### Light フェーズ
|
||||
### Light phase
|
||||
|
||||
Light フェーズは、最近のデイリーメモリシグナルとリコールトレースを取り込み、
|
||||
重複排除し、候補行をステージングします。
|
||||
Light phaseは、最近の日次メモリシグナルとリコールトレースを取り込み、
|
||||
それらを重複排除し、候補行としてステージングします。
|
||||
|
||||
- 短期リコール状態と最近のデイリーメモリファイルから読み取ります。
|
||||
- ストレージにインライン出力が含まれる場合、管理された `## Light Sleep` ブロックを書き込みます。
|
||||
- 後続の Deep ランキング用に強化シグナルを記録します。
|
||||
- `MEMORY.md` には決して書き込みません。
|
||||
- 短期リコール状態と最近の日次メモリファイルから読み取ります。
|
||||
- ストレージにインライン出力が含まれる場合、管理された`## Light Sleep`ブロックを書き込みます。
|
||||
- 後でDeep rankingに使う強化シグナルを記録します。
|
||||
- `MEMORY.md`には決して書き込みません。
|
||||
|
||||
### Deep フェーズ
|
||||
### Deep phase
|
||||
|
||||
Deep フェーズは、何を長期メモリにするかを決定します。
|
||||
Deep phaseは、何を長期メモリにするかを決定します。
|
||||
|
||||
- 重み付きスコアリングとしきい値ゲートを使って候補をランク付けします。
|
||||
- `minScore`、`minRecallCount`、`minUniqueQueries` を満たす必要があります。
|
||||
- 書き込み前にライブのデイリーファイルからスニペットを再取得するため、古くなったスニペットや削除されたスニペットはスキップされます。
|
||||
- 昇格されたエントリを `MEMORY.md` に追記します。
|
||||
- `DREAMS.md` に `## Deep Sleep` の要約を書き込み、必要に応じて `memory/dreaming/deep/YYYY-MM-DD.md` にも書き込みます。
|
||||
- 重み付きスコアリングとしきい値ゲートを使って候補を順位付けします。
|
||||
- 通過には`minScore`、`minRecallCount`、`minUniqueQueries`が必要です。
|
||||
- 書き込み前に生きた日次ファイルからスニペットを再取得するため、古い/削除済みのスニペットはスキップされます。
|
||||
- 昇格されたエントリを`MEMORY.md`に追記します。
|
||||
- `DREAMS.md`に`## Deep Sleep`の要約を書き込み、必要に応じて`memory/dreaming/deep/YYYY-MM-DD.md`にも書き込みます。
|
||||
|
||||
### REM フェーズ
|
||||
### REM phase
|
||||
|
||||
REM フェーズは、パターンと内省的シグナルを抽出します。
|
||||
REM phaseは、パターンと内省的なシグナルを抽出します。
|
||||
|
||||
- 最近の短期トレースからテーマと内省の要約を構築します。
|
||||
- ストレージにインライン出力が含まれる場合、管理された `## REM Sleep` ブロックを書き込みます。
|
||||
- Deep ランキングで使用される REM 強化シグナルを記録します。
|
||||
- `MEMORY.md` には決して書き込みません。
|
||||
- 最近の短期トレースからテーマと内省の要約を作成します。
|
||||
- ストレージにインライン出力が含まれる場合、管理された`## REM Sleep`ブロックを書き込みます。
|
||||
- Deep rankingで使用されるREM強化シグナルを記録します。
|
||||
- `MEMORY.md`には決して書き込みません。
|
||||
|
||||
## Dream Diary
|
||||
|
||||
Dreaming は `DREAMS.md` に物語風の **Dream Diary** も保持します。
|
||||
各フェーズに十分なマテリアルが集まると、`memory-core` はベストエフォートのバックグラウンド
|
||||
サブエージェントターン(デフォルトのランタイムモデルを使用)を実行し、短い日記エントリを追記します。
|
||||
Dreamingは、`DREAMS.md`に物語形式の**Dream Diary**も保持します。
|
||||
各フェーズに十分な素材がそろうと、`memory-core`はベストエフォートのバックグラウンド
|
||||
サブエージェントターン(デフォルトのランタイムモデルを使用)を実行し、
|
||||
短い日記エントリを追記します。
|
||||
|
||||
この日記は Dreams UI で人が読むためのものであり、昇格元ではありません。
|
||||
この日記はDreams UIで人が読むためのものであり、昇格元にはなりません。
|
||||
|
||||
## Deep ランキングシグナル
|
||||
## Deep rankingシグナル
|
||||
|
||||
Deep ランキングは、6 つの重み付き基本シグナルとフェーズ強化を使用します。
|
||||
Deep rankingでは、6つの重み付き基本シグナルにフェーズ強化を加えて使用します。
|
||||
|
||||
| シグナル | 重み | 説明 |
|
||||
| ------------------- | ------ | ------------------------------------------------- |
|
||||
| 頻度 | 0.24 | そのエントリが蓄積した短期シグナルの数 |
|
||||
| 関連性 | 0.30 | そのエントリの平均取得品質 |
|
||||
| クエリ多様性 | 0.15 | そのエントリが現れた個別のクエリ/日コンテキスト |
|
||||
| クエリ多様性 | 0.15 | それが現れた個別のクエリ/日コンテキスト |
|
||||
| 新しさ | 0.15 | 時間減衰する鮮度スコア |
|
||||
| 統合 | 0.10 | 複数日にわたる再出現の強さ |
|
||||
| 概念的豊かさ | 0.06 | スニペット/パス由来の概念タグ密度 |
|
||||
| 概念的豊かさ | 0.06 | スニペット/パス由来の概念タグ密度 |
|
||||
|
||||
Light と REM フェーズでのヒットは、
|
||||
`memory/.dreams/phase-signals.json` から時間減衰する小さなブーストを追加します。
|
||||
Light phaseとREM phaseのヒットは、
|
||||
`memory/.dreams/phase-signals.json`から小さな時間減衰ブーストを追加します。
|
||||
|
||||
## スケジューリング
|
||||
|
||||
有効にすると、`memory-core` は完全な Dreaming
|
||||
スイープ用の cron ジョブを 1 つ自動管理します。各スイープでは、フェーズが light -> REM -> deep の順で実行されます。
|
||||
有効にすると、`memory-core`は完全なDreamingスイープ用のcronジョブを1つ自動管理します。
|
||||
各スイープは、light -> REM -> deepの順でフェーズを実行します。
|
||||
|
||||
デフォルトの実行間隔の動作:
|
||||
|
||||
@ -110,7 +110,7 @@ Light と REM フェーズでのヒットは、
|
||||
|
||||
## クイックスタート
|
||||
|
||||
Dreaming を有効にする:
|
||||
Dreamingを有効にする:
|
||||
|
||||
```json
|
||||
{
|
||||
@ -128,7 +128,7 @@ Dreaming を有効にする:
|
||||
}
|
||||
```
|
||||
|
||||
カスタムスイープ間隔で Dreaming を有効にする:
|
||||
カスタムスイープ間隔でDreamingを有効にする:
|
||||
|
||||
```json
|
||||
{
|
||||
@ -157,9 +157,9 @@ Dreaming を有効にする:
|
||||
/dreaming help
|
||||
```
|
||||
|
||||
## CLI ワークフロー
|
||||
## CLIワークフロー
|
||||
|
||||
プレビューまたは手動適用には CLI 昇格を使用します。
|
||||
プレビューまたは手動適用にはCLIの昇格を使用します。
|
||||
|
||||
```bash
|
||||
openclaw memory promote
|
||||
@ -168,37 +168,51 @@ openclaw memory promote --limit 5
|
||||
openclaw memory status --deep
|
||||
```
|
||||
|
||||
手動の `memory promote` は、CLI フラグで上書きしない限り、デフォルトで Deep フェーズのしきい値を使用します。
|
||||
手動の`memory promote`は、CLIフラグで上書きしない限り、デフォルトでdeep-phaseのしきい値を使用します。
|
||||
|
||||
特定の候補が昇格する、または昇格しない理由を説明する:
|
||||
|
||||
```bash
|
||||
openclaw memory promote-explain "router vlan"
|
||||
openclaw memory promote-explain "router vlan" --json
|
||||
```
|
||||
|
||||
何も書き込まずに、REMの内省、候補となる真実、deep promotion出力をプレビューする:
|
||||
|
||||
```bash
|
||||
openclaw memory rem-harness
|
||||
openclaw memory rem-harness --json
|
||||
```
|
||||
|
||||
## 主なデフォルト値
|
||||
|
||||
すべての設定は `plugins.entries.memory-core.config.dreaming` 配下にあります。
|
||||
すべての設定は`plugins.entries.memory-core.config.dreaming`配下にあります。
|
||||
|
||||
| キー | デフォルト |
|
||||
| ----------- | ----------- |
|
||||
| `enabled` | `false` |
|
||||
| `frequency` | `0 3 * * *` |
|
||||
|
||||
フェーズポリシー、しきい値、ストレージ動作は内部実装の詳細
|
||||
であり、ユーザー向け設定ではありません。
|
||||
フェーズポリシー、しきい値、ストレージ動作は内部実装の詳細であり、
|
||||
ユーザー向け設定ではありません。
|
||||
|
||||
完全なキー一覧については、
|
||||
[メモリ設定リファレンス](/ja-JP/reference/memory-config#dreaming-experimental)
|
||||
[Memory configuration reference](/ja-JP/reference/memory-config#dreaming-experimental)
|
||||
を参照してください。
|
||||
|
||||
## Dreams UI
|
||||
|
||||
有効にすると、Gateway の **Dreams** タブには次が表示されます。
|
||||
有効にすると、Gatewayの**Dreams**タブに次が表示されます。
|
||||
|
||||
- 現在の Dreaming 有効状態
|
||||
- フェーズレベルの状態と管理対象スイープの有無
|
||||
- 短期、長期、および今日昇格された件数
|
||||
- 次回のスケジュール実行時刻
|
||||
- `doctor.memory.dreamDiary` をバックエンドに持つ、展開可能な Dream Diary リーダー
|
||||
- 現在のDreaming有効状態
|
||||
- フェーズレベルの状態と管理スイープの有無
|
||||
- 短期、長期、当日昇格済みの件数
|
||||
- 次回予定実行の時刻
|
||||
- `doctor.memory.dreamDiary`を基盤とする、展開可能なDream Diaryリーダー
|
||||
|
||||
## 関連
|
||||
|
||||
- [メモリ](/ja-JP/concepts/memory)
|
||||
- [メモリ検索](/ja-JP/concepts/memory-search)
|
||||
- [Memory](/ja-JP/concepts/memory)
|
||||
- [Memory Search](/ja-JP/concepts/memory-search)
|
||||
- [memory CLI](/cli/memory)
|
||||
- [メモリ設定リファレンス](/ja-JP/reference/memory-config)
|
||||
- [Memory configuration reference](/ja-JP/reference/memory-config)
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,80 +1,64 @@
|
||||
---
|
||||
read_when:
|
||||
- OPENCLAW_PLUGIN_SDK_COMPAT_DEPRECATED 警告が表示されたとき
|
||||
- OPENCLAW_EXTENSION_API_DEPRECATED 警告が表示されたとき
|
||||
- プラグインを最新のプラグインアーキテクチャへ更新しているとき
|
||||
- 外部のOpenClawプラグインを保守しているとき
|
||||
- OPENCLAW_PLUGIN_SDK_COMPAT_DEPRECATED 警告が表示された場合
|
||||
- OPENCLAW_EXTENSION_API_DEPRECATED 警告が表示された場合
|
||||
- plugin をモダンな plugin アーキテクチャへ更新している場合
|
||||
- 外部の OpenClaw plugin をメンテナンスしている場合
|
||||
sidebarTitle: Migrate to SDK
|
||||
summary: レガシーな後方互換レイヤーから最新のプラグインSDKへ移行する
|
||||
title: プラグインSDK移行
|
||||
summary: レガシーな後方互換レイヤーからモダンな plugin SDK へ移行する
|
||||
title: Plugin SDK 移行
|
||||
x-i18n:
|
||||
generated_at: "2026-04-06T03:10:43Z"
|
||||
generated_at: "2026-04-06T04:44:33Z"
|
||||
model: gpt-5.4
|
||||
provider: openai
|
||||
source_hash: b71ce69b30c3bb02da1b263b1d11dc3214deae5f6fc708515e23b5a1c7bb7c8f
|
||||
source_hash: 94f12d1376edd8184714cc4dbea4a88fa8ed652f65e9365ede6176f3bf441b33
|
||||
source_path: plugins/sdk-migration.md
|
||||
workflow: 15
|
||||
---
|
||||
|
||||
# プラグインSDK移行
|
||||
# Plugin SDK 移行
|
||||
|
||||
OpenClawは、広範な後方互換レイヤーから、焦点を絞った文書化済みのimportを持つ最新のプラグイン
|
||||
アーキテクチャへ移行しました。新しいアーキテクチャ以前にプラグインを構築した場合、このガイドが移行に役立ちます。
|
||||
OpenClaw は、広範な後方互換レイヤーから、目的が明確で文書化された import を備えたモダンな plugin アーキテクチャへ移行しました。あなたの plugin が新しいアーキテクチャ以前に作られたものであれば、このガイドが移行の助けになります。
|
||||
|
||||
## 何が変わるのか
|
||||
|
||||
古いプラグインシステムでは、プラグインが単一のエントリポイントから必要なものを何でもimportできる、
|
||||
非常に広い2つのサーフェスが提供されていました。
|
||||
古い plugin システムでは、単一のエントリポイントから必要なものを何でも import できる、非常に広い 2 つのサーフェスが提供されていました。
|
||||
|
||||
- **`openclaw/plugin-sdk/compat`** — 数十個の
|
||||
ヘルパーを再エクスポートする単一import。新しい
|
||||
プラグインアーキテクチャの構築中に、古いフックベースのプラグインを動作させ続けるために導入されました。
|
||||
- **`openclaw/extension-api`** — 埋め込みエージェントランナーのような
|
||||
ホスト側ヘルパーへプラグインが直接アクセスできるようにするブリッジ。
|
||||
- **`openclaw/plugin-sdk/compat`** — 数十のヘルパーを再エクスポートする単一の import。新しい plugin アーキテクチャの構築中に、古い hook ベースの plugin を動かし続けるために導入されました。
|
||||
- **`openclaw/extension-api`** — 埋め込みエージェントランナーのような host 側ヘルパーへ plugin から直接アクセスできるようにするブリッジ。
|
||||
|
||||
これら2つのサーフェスは現在 **非推奨** です。ランタイムではまだ動作しますが、新しい
|
||||
プラグインは使用してはいけません。また既存のプラグインも、次のメジャーリリースで削除される前に移行する必要があります。
|
||||
これら 2 つのサーフェスは現在どちらも**非推奨**です。実行時には引き続き動作しますが、新しい plugin では使用してはいけません。また、既存の plugin は、次のメジャーリリースで削除される前に移行する必要があります。
|
||||
|
||||
<Warning>
|
||||
この後方互換レイヤーは、将来のメジャーリリースで削除されます。
|
||||
これらのサーフェスからまだimportしているプラグインは、その時点で壊れます。
|
||||
これらのサーフェスから import している plugin は、その時点で動作しなくなります。
|
||||
</Warning>
|
||||
|
||||
## なぜ変更されたのか
|
||||
|
||||
古いアプローチには問題がありました。
|
||||
|
||||
- **起動が遅い** — 1つのヘルパーをimportするだけで、無関係な数十のモジュールが読み込まれていました
|
||||
- **循環依存** — 広範な再エクスポートによってimportサイクルが簡単に生じていました
|
||||
- **不明確なAPIサーフェス** — どのexportが安定していて、どれが内部実装なのか判別する方法がありませんでした
|
||||
- **起動が遅い** — 1 つのヘルパーを import すると、無関係な数十の module が読み込まれる
|
||||
- **循環依存** — 広範な再エクスポートにより、import サイクルが簡単に発生する
|
||||
- **不明確な API サーフェス** — どの export が安定していて、どれが内部用なのか判別できない
|
||||
|
||||
最新のプラグインSDKはこれを解決します。各importパス(`openclaw/plugin-sdk/\<subpath\>`)
|
||||
は、小さく自己完結したモジュールであり、明確な目的と文書化された契約を持ちます。
|
||||
モダンな plugin SDK はこれを解決します。各 import path(`openclaw/plugin-sdk/\<subpath\>`)は、小さく自己完結した module であり、明確な目的と文書化された契約を持っています。
|
||||
|
||||
バンドルされたチャンネル向けのレガシーprovider便宜シームもなくなりました。
|
||||
`openclaw/plugin-sdk/slack`、`openclaw/plugin-sdk/discord`、
|
||||
`openclaw/plugin-sdk/signal`、`openclaw/plugin-sdk/whatsapp`、
|
||||
チャンネル名付きのヘルパーシーム、および
|
||||
`openclaw/plugin-sdk/telegram-core` のようなimportは、安定した
|
||||
プラグイン契約ではなく、プライベートなモノレポ用ショートカットでした。代わりに、細い汎用SDK subpathを使ってください。バンドルされたプラグインworkspace内では、provider所有ヘルパーはそのプラグイン自身の
|
||||
`api.ts` または `runtime-api.ts` に置いてください。
|
||||
バンドルされた channel 向けのレガシーな provider 便利 seam も廃止されました。`openclaw/plugin-sdk/slack`、`openclaw/plugin-sdk/discord`、`openclaw/plugin-sdk/signal`、`openclaw/plugin-sdk/whatsapp`、channel ブランド付きヘルパー seam、`openclaw/plugin-sdk/telegram-core` のような import は、安定した plugin 契約ではなく、mono-repo 内部向けのプライベートなショートカットでした。代わりに、汎用の狭い SDK subpath を使ってください。バンドルされた plugin workspace 内では、provider が所有するヘルパーはその plugin 自身の `api.ts` または `runtime-api.ts` に保持してください。
|
||||
|
||||
現在のバンドルproviderの例:
|
||||
現在のバンドル済み provider の例:
|
||||
|
||||
- Anthropicは、Claude固有のstreamヘルパーを自身の `api.ts` /
|
||||
`contract-api.ts` シームに保持しています
|
||||
- OpenAIは、providerビルダー、デフォルトモデルヘルパー、realtime provider
|
||||
ビルダーを自身の `api.ts` に保持しています
|
||||
- OpenRouterは、providerビルダーとオンボーディング/configヘルパーを自身の
|
||||
`api.ts` に保持しています
|
||||
- Anthropic は Claude 固有の stream ヘルパーを自身の `api.ts` / `contract-api.ts` seam に保持
|
||||
- OpenAI は provider builder、default-model ヘルパー、realtime provider builder を自身の `api.ts` に保持
|
||||
- OpenRouter は provider builder と onboarding/config ヘルパーを自身の `api.ts` に保持
|
||||
|
||||
## 移行方法
|
||||
|
||||
<Steps>
|
||||
<Step title="Windowsラッパーのフォールバック動作を監査する">
|
||||
プラグインが `openclaw/plugin-sdk/windows-spawn` を使っている場合、解決できないWindows
|
||||
`.cmd`/`.bat` ラッパーは、明示的に
|
||||
`allowShellFallback: true` を渡さない限り、現在はfail closedになります。
|
||||
<Step title="Windows wrapper の fallback 動作を監査する">
|
||||
あなたの plugin が `openclaw/plugin-sdk/windows-spawn` を使っている場合、解決できない Windows の
|
||||
`.cmd`/`.bat` wrapper は、明示的に
|
||||
`allowShellFallback: true` を渡さない限り、fail closed するようになりました。
|
||||
|
||||
```typescript
|
||||
// Before
|
||||
@ -83,18 +67,18 @@ OpenClawは、広範な後方互換レイヤーから、焦点を絞った文書
|
||||
// After
|
||||
const program = applyWindowsSpawnProgramPolicy({
|
||||
candidate,
|
||||
// シェル経由のフォールバックを意図的に受け入れる、信頼された互換呼び出し元にのみ設定します。
|
||||
// シェルを介した fallback を意図的に受け入れる、信頼された互換呼び出し元でのみ設定してください。
|
||||
allowShellFallback: true,
|
||||
});
|
||||
```
|
||||
|
||||
呼び出し元が意図的にシェルフォールバックへ依存していない場合は、
|
||||
`allowShellFallback` を設定せず、代わりに投げられるエラーを処理してください。
|
||||
呼び出し元が意図的に shell fallback に依存していない場合は、
|
||||
`allowShellFallback` を設定せず、代わりに投げられた error を処理してください。
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="非推奨importを見つける">
|
||||
プラグイン内で、いずれかの非推奨サーフェスからのimportを検索します。
|
||||
<Step title="非推奨 import を見つける">
|
||||
あなたの plugin 内で、いずれかの非推奨サーフェスからの import を検索してください。
|
||||
|
||||
```bash
|
||||
grep -r "plugin-sdk/compat" my-plugin/
|
||||
@ -103,37 +87,37 @@ OpenClawは、広範な後方互換レイヤーから、焦点を絞った文書
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="焦点を絞ったimportに置き換える">
|
||||
古いサーフェスの各exportは、特定の最新importパスへ対応しています。
|
||||
<Step title="目的別の import に置き換える">
|
||||
古いサーフェスの各 export は、特定のモダンな import path に対応しています。
|
||||
|
||||
```typescript
|
||||
// Before (deprecated backwards-compatibility layer)
|
||||
// Before(非推奨の後方互換レイヤー)
|
||||
import {
|
||||
createChannelReplyPipeline,
|
||||
createPluginRuntimeStore,
|
||||
resolveControlCommandGate,
|
||||
} from "openclaw/plugin-sdk/compat";
|
||||
|
||||
// After (modern focused imports)
|
||||
// After(モダンで目的別の import)
|
||||
import { createChannelReplyPipeline } from "openclaw/plugin-sdk/channel-reply-pipeline";
|
||||
import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store";
|
||||
import { resolveControlCommandGate } from "openclaw/plugin-sdk/command-auth";
|
||||
```
|
||||
|
||||
ホスト側ヘルパーについては、直接importする代わりに注入されたプラグインランタイムを使用します。
|
||||
host 側ヘルパーについては、直接 import するのではなく、注入された plugin runtime を使ってください。
|
||||
|
||||
```typescript
|
||||
// Before (deprecated extension-api bridge)
|
||||
// Before(非推奨の extension-api ブリッジ)
|
||||
import { runEmbeddedPiAgent } from "openclaw/extension-api";
|
||||
const result = await runEmbeddedPiAgent({ sessionId, prompt });
|
||||
|
||||
// After (injected runtime)
|
||||
// After(注入された runtime)
|
||||
const result = await api.runtime.agent.runEmbeddedPiAgent({ sessionId, prompt });
|
||||
```
|
||||
|
||||
同じパターンは、他のレガシーブリッジヘルパーにも適用されます。
|
||||
同じパターンは、他のレガシーな bridge ヘルパーにも当てはまります。
|
||||
|
||||
| Old import | 最新の対応先 |
|
||||
| 古い import | モダンな同等物 |
|
||||
| --- | --- |
|
||||
| `resolveAgentDir` | `api.runtime.agent.resolveAgentDir` |
|
||||
| `resolveAgentWorkspaceDir` | `api.runtime.agent.resolveAgentWorkspaceDir` |
|
||||
@ -153,208 +137,215 @@ OpenClawは、広範な後方互換レイヤーから、焦点を絞った文書
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
## importパスリファレンス
|
||||
## import path リファレンス
|
||||
|
||||
<Accordion title="よく使うimportパステーブル">
|
||||
| Import path | 目的 | 主なexport |
|
||||
<Accordion title="一般的な import path 一覧">
|
||||
| Import path | 用途 | 主な export |
|
||||
| --- | --- | --- |
|
||||
| `plugin-sdk/plugin-entry` | 正式なプラグインエントリヘルパー | `definePluginEntry` |
|
||||
| `plugin-sdk/core` | チャンネルエントリ定義/ビルダー向けのレガシーなアンブレラ再エクスポート | `defineChannelPluginEntry`, `createChatChannelPlugin` |
|
||||
| `plugin-sdk/config-schema` | ルートconfigスキーマexport | `OpenClawSchema` |
|
||||
| `plugin-sdk/provider-entry` | 単一providerエントリヘルパー | `defineSingleProviderPluginEntry` |
|
||||
| `plugin-sdk/channel-core` | 焦点を絞ったチャンネルエントリ定義とビルダー | `defineChannelPluginEntry`, `defineSetupPluginEntry`, `createChatChannelPlugin`, `createChannelPluginBase` |
|
||||
| `plugin-sdk/setup` | 共通セットアップウィザードヘルパー | Allowlistプロンプト、セットアップステータスビルダー |
|
||||
| `plugin-sdk/setup-runtime` | セットアップ時ランタイムヘルパー | import-safeなセットアップpatchアダプター、lookup-noteヘルパー、`promptResolvedAllowFrom`, `splitSetupEntries`, 委譲セットアッププロキシ |
|
||||
| `plugin-sdk/setup-adapter-runtime` | セットアップアダプターヘルパー | `createEnvPatchedAccountSetupAdapter` |
|
||||
| `plugin-sdk/setup-tools` | セットアップtoolingヘルパー | `formatCliCommand`, `detectBinary`, `extractArchive`, `resolveBrewExecutable`, `formatDocsLink`, `CONFIG_DIR` |
|
||||
| `plugin-sdk/account-core` | マルチアカウントヘルパー | アカウント一覧/config/アクションゲートヘルパー |
|
||||
| `plugin-sdk/account-id` | account-id ヘルパー | `DEFAULT_ACCOUNT_ID`, account-id 正規化 |
|
||||
| `plugin-sdk/account-resolution` | アカウント参照ヘルパー | アカウント参照 + デフォルトフォールバックヘルパー |
|
||||
| `plugin-sdk/account-helpers` | 細いアカウントヘルパー | アカウント一覧/アカウントアクションヘルパー |
|
||||
| `plugin-sdk/channel-setup` | セットアップウィザードアダプター | `createOptionalChannelSetupSurface`, `createOptionalChannelSetupAdapter`, `createOptionalChannelSetupWizard`, および `DEFAULT_ACCOUNT_ID`, `createTopLevelChannelDmPolicy`, `setSetupChannelEnabled`, `splitSetupEntries` |
|
||||
| `plugin-sdk/channel-pairing` | DMペアリング基本要素 | `createChannelPairingController` |
|
||||
| `plugin-sdk/channel-reply-pipeline` | 返信プレフィックス + typing 配線 | `createChannelReplyPipeline` |
|
||||
| `plugin-sdk/channel-config-helpers` | Configアダプターファクトリー | `createHybridChannelConfigAdapter` |
|
||||
| `plugin-sdk/channel-config-schema` | Configスキーマビルダー | チャンネルconfigスキーマ型 |
|
||||
| `plugin-sdk/telegram-command-config` | Telegramコマンドconfigヘルパー | コマンド名正規化、説明トリミング、重複/競合検証 |
|
||||
| `plugin-sdk/channel-policy` | グループ/DMポリシー解決 | `resolveChannelGroupRequireMention` |
|
||||
| `plugin-sdk/channel-lifecycle` | アカウントステータス追跡 | `createAccountStatusSink` |
|
||||
| `plugin-sdk/inbound-envelope` | 受信envelopeヘルパー | 共通ルート + envelopeビルダーヘルパー |
|
||||
| `plugin-sdk/inbound-reply-dispatch` | 受信返信ヘルパー | 共通の記録とディスパッチヘルパー |
|
||||
| `plugin-sdk/messaging-targets` | メッセージングターゲット解析 | ターゲット解析/照合ヘルパー |
|
||||
| `plugin-sdk/outbound-media` | 送信メディアヘルパー | 共通の送信メディア読み込み |
|
||||
| `plugin-sdk/outbound-runtime` | 送信ランタイムヘルパー | 送信アイデンティティ/送信delegateヘルパー |
|
||||
| `plugin-sdk/thread-bindings-runtime` | スレッドbindingヘルパー | スレッドbindingライフサイクルとアダプターヘルパー |
|
||||
| `plugin-sdk/agent-media-payload` | レガシーメディアペイロードヘルパー | レガシーフィールドレイアウト向けエージェントメディアペイロードビルダー |
|
||||
| `plugin-sdk/channel-runtime` | 非推奨の互換shim | レガシーチャンネルランタイムユーティリティのみ |
|
||||
| `plugin-sdk/channel-send-result` | 送信結果型 | 返信結果型 |
|
||||
| `plugin-sdk/runtime-store` | 永続プラグインストレージ | `createPluginRuntimeStore` |
|
||||
| `plugin-sdk/runtime` | 広範なランタイムヘルパー | ランタイム/ロギング/バックアップ/プラグインインストールヘルパー |
|
||||
| `plugin-sdk/runtime-env` | 細いランタイムenvヘルパー | ロガー/ランタイムenv、タイムアウト、再試行、バックオフヘルパー |
|
||||
| `plugin-sdk/plugin-runtime` | 共通プラグインランタイムヘルパー | プラグインコマンド/フック/http/インタラクティブヘルパー |
|
||||
| `plugin-sdk/hook-runtime` | フックパイプラインヘルパー | 共通webhook/internal hookパイプラインヘルパー |
|
||||
| `plugin-sdk/lazy-runtime` | 遅延ランタイムヘルパー | `createLazyRuntimeModule`, `createLazyRuntimeMethod`, `createLazyRuntimeMethodBinder`, `createLazyRuntimeNamedExport`, `createLazyRuntimeSurface` |
|
||||
| `plugin-sdk/process-runtime` | processヘルパー | 共通execヘルパー |
|
||||
| `plugin-sdk/cli-runtime` | CLIランタイムヘルパー | コマンド整形、待機、バージョンヘルパー |
|
||||
| `plugin-sdk/gateway-runtime` | Gatewayヘルパー | Gatewayクライアントとchannel-status patchヘルパー |
|
||||
| `plugin-sdk/config-runtime` | Configヘルパー | Config読み込み/書き込みヘルパー |
|
||||
| `plugin-sdk/telegram-command-config` | Telegramコマンドヘルパー | バンドルされたTelegram契約サーフェスが使えない場合の、フォールバックで安定したTelegramコマンド検証ヘルパー |
|
||||
| `plugin-sdk/approval-runtime` | 承認プロンプトヘルパー | Exec/plugin 承認ペイロード、承認capability/profileヘルパー、ネイティブ承認ルーティング/ランタイムヘルパー |
|
||||
| `plugin-sdk/approval-auth-runtime` | 承認authヘルパー | 承認者解決、同一チャットアクションauth |
|
||||
| `plugin-sdk/approval-client-runtime` | 承認クライアントヘルパー | ネイティブexec承認profile/filterヘルパー |
|
||||
| `plugin-sdk/approval-delivery-runtime` | 承認配信ヘルパー | ネイティブ承認capability/配信アダプター |
|
||||
| `plugin-sdk/approval-native-runtime` | 承認ターゲットヘルパー | ネイティブ承認ターゲット/アカウントbindingヘルパー |
|
||||
| `plugin-sdk/approval-reply-runtime` | 承認返信ヘルパー | Exec/plugin 承認返信ペイロードヘルパー |
|
||||
| `plugin-sdk/security-runtime` | セキュリティヘルパー | 共通の信頼、DMゲート、外部コンテンツ、secret収集ヘルパー |
|
||||
| `plugin-sdk/ssrf-policy` | SSRFポリシーヘルパー | ホストallowlistとプライベートネットワークポリシーヘルパー |
|
||||
| `plugin-sdk/ssrf-runtime` | SSRFランタイムヘルパー | pinned-dispatcher、guarded fetch、SSRFポリシーヘルパー |
|
||||
| `plugin-sdk/collection-runtime` | 境界付きキャッシュヘルパー | `pruneMapToMaxSize` |
|
||||
| `plugin-sdk/diagnostic-runtime` | 診断ゲートヘルパー | `isDiagnosticFlagEnabled`, `isDiagnosticsEnabled` |
|
||||
| `plugin-sdk/error-runtime` | エラー整形ヘルパー | `formatUncaughtError`, `isApprovalNotFoundError`, エラーグラフヘルパー |
|
||||
| `plugin-sdk/fetch-runtime` | ラップ済みfetch/プロキシヘルパー | `resolveFetch`, プロキシヘルパー |
|
||||
| `plugin-sdk/host-runtime` | ホスト正規化ヘルパー | `normalizeHostname`, `normalizeScpRemoteHost` |
|
||||
| `plugin-sdk/retry-runtime` | 再試行ヘルパー | `RetryConfig`, `retryAsync`, ポリシーランナー |
|
||||
| `plugin-sdk/allow-from` | Allowlist整形 | `formatAllowFromLowercase` |
|
||||
| `plugin-sdk/allowlist-resolution` | Allowlist入力マッピング | `mapAllowlistResolutionInputs` |
|
||||
| `plugin-sdk/command-auth` | コマンドゲートとコマンドサーフェスヘルパー | `resolveControlCommandGate`, 送信者認可ヘルパー, コマンドレジストリヘルパー |
|
||||
| `plugin-sdk/secret-input` | secret入力解析 | secret入力ヘルパー |
|
||||
| `plugin-sdk/webhook-ingress` | webhookリクエストヘルパー | webhookターゲットユーティリティ |
|
||||
| `plugin-sdk/webhook-request-guards` | webhook本文ガードヘルパー | リクエスト本文読み取り/制限ヘルパー |
|
||||
| `plugin-sdk/reply-runtime` | 共通返信ランタイム | 受信ディスパッチ、heartbeat、返信プランナー、チャンク化 |
|
||||
| `plugin-sdk/reply-dispatch-runtime` | 細い返信ディスパッチヘルパー | finalize + provider dispatchヘルパー |
|
||||
| `plugin-sdk/reply-history` | 返信履歴ヘルパー | `buildHistoryContext`, `buildPendingHistoryContextFromMap`, `recordPendingHistoryEntry`, `clearHistoryEntriesIfEnabled` |
|
||||
| `plugin-sdk/reply-reference` | 返信参照プランニング | `createReplyReferencePlanner` |
|
||||
| `plugin-sdk/reply-chunking` | 返信チャンクヘルパー | テキスト/markdown チャンクヘルパー |
|
||||
| `plugin-sdk/session-store-runtime` | セッションストアヘルパー | ストアパス + updated-at ヘルパー |
|
||||
| `plugin-sdk/state-paths` | 状態パスヘルパー | 状態ディレクトリとOAuthディレクトリヘルパー |
|
||||
| `plugin-sdk/routing` | ルーティング/セッションキーヘルパー | `resolveAgentRoute`, `buildAgentSessionKey`, `resolveDefaultAgentBoundAccountId`, セッションキー正規化ヘルパー |
|
||||
| `plugin-sdk/status-helpers` | チャンネルstatusヘルパー | チャンネル/アカウントstatusサマリービルダー、runtime-state デフォルト、issueメタデータヘルパー |
|
||||
| `plugin-sdk/target-resolver-runtime` | ターゲットリゾルバーヘルパー | 共通ターゲットリゾルバーヘルパー |
|
||||
| `plugin-sdk/string-normalization-runtime` | 文字列正規化ヘルパー | slug/文字列正規化ヘルパー |
|
||||
| `plugin-sdk/request-url` | リクエストURLヘルパー | リクエスト風入力から文字列URLを抽出 |
|
||||
| `plugin-sdk/run-command` | 時間付きコマンドヘルパー | stdout/stderr を正規化した時間付きコマンドランナー |
|
||||
| `plugin-sdk/param-readers` | パラメーターリーダー | 共通tool/CLIパラメーターリーダー |
|
||||
| `plugin-sdk/tool-send` | tool送信抽出 | tool引数から正規の送信ターゲットフィールドを抽出 |
|
||||
| `plugin-sdk/temp-path` | 一時パスヘルパー | 共通一時ダウンロードパスヘルパー |
|
||||
| `plugin-sdk/logging-core` | ロギングヘルパー | サブシステムロガーとredactionヘルパー |
|
||||
| `plugin-sdk/markdown-table-runtime` | Markdownテーブルヘルパー | Markdownテーブルモードヘルパー |
|
||||
| `plugin-sdk/reply-payload` | メッセージ返信型 | 返信ペイロード型 |
|
||||
| `plugin-sdk/provider-setup` | 厳選されたローカル/セルフホストproviderセットアップヘルパー | セルフホストprovider検出/configヘルパー |
|
||||
| `plugin-sdk/self-hosted-provider-setup` | 焦点を絞ったOpenAI互換セルフホストproviderセットアップヘルパー | 同じセルフホストprovider検出/configヘルパー |
|
||||
| `plugin-sdk/provider-auth-runtime` | providerランタイムauthヘルパー | ランタイムAPIキー解決ヘルパー |
|
||||
| `plugin-sdk/provider-auth-api-key` | provider APIキーセットアップヘルパー | APIキーオンボーディング/profile書き込みヘルパー |
|
||||
| `plugin-sdk/provider-auth-result` | provider auth-result ヘルパー | 標準OAuth auth-result ビルダー |
|
||||
| `plugin-sdk/provider-auth-login` | providerインタラクティブログインヘルパー | 共通インタラクティブログインヘルパー |
|
||||
| `plugin-sdk/provider-env-vars` | provider環境変数ヘルパー | provider auth環境変数参照ヘルパー |
|
||||
| `plugin-sdk/provider-model-shared` | 共通provider model/replay ヘルパー | `ProviderReplayFamily`, `buildProviderReplayFamilyHooks`, `normalizeModelCompat`, 共通replay-policyビルダー、provider endpointヘルパー、model-id 正規化ヘルパー |
|
||||
| `plugin-sdk/provider-catalog-shared` | 共通providerカタログヘルパー | `findCatalogTemplate`, `buildSingleProviderApiKeyCatalog`, `supportsNativeStreamingUsageCompat`, `applyProviderNativeStreamingUsageCompat` |
|
||||
| `plugin-sdk/provider-onboard` | providerオンボーディングpatch | オンボーディングconfigヘルパー |
|
||||
| `plugin-sdk/provider-http` | provider HTTPヘルパー | 汎用provider HTTP/endpoint capabilityヘルパー |
|
||||
| `plugin-sdk/provider-web-fetch` | provider web-fetch ヘルパー | web-fetch provider登録/キャッシュヘルパー |
|
||||
| `plugin-sdk/provider-web-search` | provider web-search ヘルパー | web-search provider登録/キャッシュ/configヘルパー |
|
||||
| `plugin-sdk/provider-tools` | provider tool/スキーマ互換ヘルパー | `ProviderToolCompatFamily`, `buildProviderToolCompatFamilyHooks`, Geminiスキーマクリーンアップ + diagnostics、および `resolveXaiModelCompatPatch` / `applyXaiModelCompat` などのxAI互換ヘルパー |
|
||||
| `plugin-sdk/provider-usage` | provider使用量ヘルパー | `fetchClaudeUsage`, `fetchGeminiUsage`, `fetchGithubCopilotUsage` などのprovider使用量ヘルパー |
|
||||
| `plugin-sdk/provider-stream` | provider streamラッパーヘルパー | `ProviderStreamFamily`, `buildProviderStreamFamilyHooks`, `composeProviderStreamWrappers`, streamラッパー型、および共通Anthropic/Bedrock/Google/Kilocode/Moonshot/OpenAI/OpenRouter/Z.A.I/MiniMax/Copilot ラッパーヘルパー |
|
||||
| `plugin-sdk/keyed-async-queue` | 順序付きasyncキュー | `KeyedAsyncQueue` |
|
||||
| `plugin-sdk/media-runtime` | 共通メディアヘルパー | メディア取得/変換/保存ヘルパー、およびメディアペイロードビルダー |
|
||||
| `plugin-sdk/media-understanding` | media-understanding ヘルパー | media-understanding provider型、およびprovider向け画像/音声ヘルパーexport |
|
||||
| `plugin-sdk/text-runtime` | 共通テキストヘルパー | アシスタント可視テキストの除去、markdown描画/チャンク化/テーブルヘルパー、redactionヘルパー、directive-tagヘルパー、安全なテキストユーティリティ、および関連するテキスト/ロギングヘルパー |
|
||||
| `plugin-sdk/text-chunking` | テキストチャンク化ヘルパー | 送信テキストチャンク化ヘルパー |
|
||||
| `plugin-sdk/speech` | Speechヘルパー | Speech provider型、およびprovider向けdirective、registry、検証ヘルパー |
|
||||
| `plugin-sdk/speech-core` | 共通Speechコア | Speech provider型、registry、directive、正規化 |
|
||||
| `plugin-sdk/realtime-transcription` | realtime transcription ヘルパー | provider型とregistryヘルパー |
|
||||
| `plugin-sdk/realtime-voice` | realtime voice ヘルパー | provider型とregistryヘルパー |
|
||||
| `plugin-sdk/image-generation-core` | 共通image-generation コア | image-generation 型、フェイルオーバー、auth、registryヘルパー |
|
||||
| `plugin-sdk/music-generation` | music-generation ヘルパー | music-generation provider/request/result 型 |
|
||||
| `plugin-sdk/music-generation-core` | 共通music-generation コア | music-generation 型、フェイルオーバーヘルパー、provider参照、model-ref解析 |
|
||||
| `plugin-sdk/video-generation` | video-generation ヘルパー | video-generation provider/request/result 型 |
|
||||
| `plugin-sdk/video-generation-core` | 共通video-generation コア | video-generation 型、フェイルオーバーヘルパー、provider参照、model-ref解析 |
|
||||
| `plugin-sdk/interactive-runtime` | インタラクティブ返信ヘルパー | インタラクティブ返信ペイロード正規化/縮約 |
|
||||
| `plugin-sdk/channel-config-primitives` | チャンネルconfig基本要素 | 細いチャンネルconfig-schema 基本要素 |
|
||||
| `plugin-sdk/channel-config-writes` | チャンネルconfig書き込みヘルパー | チャンネルconfig書き込み認可ヘルパー |
|
||||
| `plugin-sdk/channel-plugin-common` | 共通チャンネルプレリュード | 共通チャンネルプラグインプレリュードexport |
|
||||
| `plugin-sdk/channel-status` | チャンネルstatusヘルパー | 共通チャンネルstatusスナップショット/サマリーヘルパー |
|
||||
| `plugin-sdk/allowlist-config-edit` | Allowlist configヘルパー | Allowlist config編集/読み取りヘルパー |
|
||||
| `plugin-sdk/group-access` | グループアクセスヘルパー | 共通グループアクセス判定ヘルパー |
|
||||
| `plugin-sdk/direct-dm` | ダイレクトDMヘルパー | 共通ダイレクトDM auth/ガードヘルパー |
|
||||
| `plugin-sdk/extension-shared` | 共通拡張ヘルパー | passive-channel/status ヘルパー基本要素 |
|
||||
| `plugin-sdk/webhook-targets` | webhookターゲットヘルパー | webhookターゲットregistryとroute-installヘルパー |
|
||||
| `plugin-sdk/webhook-path` | webhookパスヘルパー | webhookパス正規化ヘルパー |
|
||||
| `plugin-sdk/web-media` | 共通webメディアヘルパー | リモート/ローカルメディア読み込みヘルパー |
|
||||
| `plugin-sdk/zod` | Zod再エクスポート | プラグインSDK利用者向けに再エクスポートされた `zod` |
|
||||
| `plugin-sdk/memory-core` | バンドルされたmemory-core ヘルパー | Memory manager/config/file/CLI ヘルパーサーフェス |
|
||||
| `plugin-sdk/memory-core-engine-runtime` | Memory engine ランタイムファサード | Memory index/search ランタイムファサード |
|
||||
| `plugin-sdk/memory-core-host-engine-foundation` | Memory host foundation engine | Memory host foundation engine export |
|
||||
| `plugin-sdk/memory-core-host-engine-embeddings` | Memory host embedding engine | Memory host embedding engine export |
|
||||
| `plugin-sdk/memory-core-host-engine-qmd` | Memory host QMD engine | Memory host QMD engine export |
|
||||
| `plugin-sdk/memory-core-host-engine-storage` | Memory host storage engine | Memory host storage engine export |
|
||||
| `plugin-sdk/memory-core-host-multimodal` | Memory host multimodal ヘルパー | Memory host multimodal ヘルパー |
|
||||
| `plugin-sdk/memory-core-host-query` | Memory host query ヘルパー | Memory host query ヘルパー |
|
||||
| `plugin-sdk/memory-core-host-secret` | Memory host secret ヘルパー | Memory host secret ヘルパー |
|
||||
| `plugin-sdk/memory-core-host-status` | Memory host status ヘルパー | Memory host status ヘルパー |
|
||||
| `plugin-sdk/memory-core-host-runtime-cli` | Memory host CLIランタイム | Memory host CLIランタイムヘルパー |
|
||||
| `plugin-sdk/memory-core-host-runtime-core` | Memory host coreランタイム | Memory host coreランタイムヘルパー |
|
||||
| `plugin-sdk/memory-core-host-runtime-files` | Memory host file/runtime ヘルパー | Memory host file/runtime ヘルパー |
|
||||
| `plugin-sdk/memory-lancedb` | バンドルされたmemory-lancedb ヘルパー | Memory-lancedb ヘルパーサーフェス |
|
||||
| `plugin-sdk/testing` | テストユーティリティ | テストヘルパーとモック |
|
||||
| `plugin-sdk/plugin-entry` | 正式な plugin entry ヘルパー | `definePluginEntry` |
|
||||
| `plugin-sdk/core` | channel entry 定義 / builder 向けのレガシー umbrella 再エクスポート | `defineChannelPluginEntry`, `createChatChannelPlugin` |
|
||||
| `plugin-sdk/config-schema` | ルート config schema export | `OpenClawSchema` |
|
||||
| `plugin-sdk/provider-entry` | 単一 provider entry ヘルパー | `defineSingleProviderPluginEntry` |
|
||||
| `plugin-sdk/channel-core` | 目的別の channel entry 定義と builder | `defineChannelPluginEntry`, `defineSetupPluginEntry`, `createChatChannelPlugin`, `createChannelPluginBase` |
|
||||
| `plugin-sdk/setup` | 共有 setup ウィザードヘルパー | Allowlist prompt、setup status builder |
|
||||
| `plugin-sdk/setup-runtime` | setup 時 runtime ヘルパー | import-safe な setup patch adapter、lookup-note ヘルパー、`promptResolvedAllowFrom`、`splitSetupEntries`、委譲 setup proxy |
|
||||
| `plugin-sdk/setup-adapter-runtime` | setup adapter ヘルパー | `createEnvPatchedAccountSetupAdapter` |
|
||||
| `plugin-sdk/setup-tools` | setup tooling ヘルパー | `formatCliCommand`, `detectBinary`, `extractArchive`, `resolveBrewExecutable`, `formatDocsLink`, `CONFIG_DIR` |
|
||||
| `plugin-sdk/account-core` | 複数 account ヘルパー | account list/config/action-gate ヘルパー |
|
||||
| `plugin-sdk/account-id` | account-id ヘルパー | `DEFAULT_ACCOUNT_ID`、account-id 正規化 |
|
||||
| `plugin-sdk/account-resolution` | account lookup ヘルパー | account lookup と default-fallback ヘルパー |
|
||||
| `plugin-sdk/account-helpers` | 狭い account ヘルパー | account list / account-action ヘルパー |
|
||||
| `plugin-sdk/channel-setup` | setup ウィザード adapter | `createOptionalChannelSetupSurface`, `createOptionalChannelSetupAdapter`, `createOptionalChannelSetupWizard`、および `DEFAULT_ACCOUNT_ID`、`createTopLevelChannelDmPolicy`、`setSetupChannelEnabled`、`splitSetupEntries` |
|
||||
| `plugin-sdk/channel-pairing` | DM pairing プリミティブ | `createChannelPairingController` |
|
||||
| `plugin-sdk/channel-reply-pipeline` | 返信 prefix と typing の配線 | `createChannelReplyPipeline` |
|
||||
| `plugin-sdk/channel-config-helpers` | config adapter factory | `createHybridChannelConfigAdapter` |
|
||||
| `plugin-sdk/channel-config-schema` | config schema builder | channel config schema 型 |
|
||||
| `plugin-sdk/telegram-command-config` | Telegram command config ヘルパー | command 名の正規化、description のトリミング、重複 / 競合の検証 |
|
||||
| `plugin-sdk/channel-policy` | group / DM policy 解決 | `resolveChannelGroupRequireMention` |
|
||||
| `plugin-sdk/channel-lifecycle` | account status 追跡 | `createAccountStatusSink` |
|
||||
| `plugin-sdk/inbound-envelope` | inbound envelope ヘルパー | 共有 route と envelope builder ヘルパー |
|
||||
| `plugin-sdk/inbound-reply-dispatch` | inbound reply ヘルパー | 共有 record-and-dispatch ヘルパー |
|
||||
| `plugin-sdk/messaging-targets` | messaging target 解析 | target の解析 / 照合ヘルパー |
|
||||
| `plugin-sdk/outbound-media` | outbound media ヘルパー | 共有 outbound media 読み込み |
|
||||
| `plugin-sdk/outbound-runtime` | outbound runtime ヘルパー | outbound identity / send delegate ヘルパー |
|
||||
| `plugin-sdk/thread-bindings-runtime` | thread-binding ヘルパー | thread-binding lifecycle と adapter ヘルパー |
|
||||
| `plugin-sdk/agent-media-payload` | レガシー media payload ヘルパー | レガシー field レイアウト向け agent media payload builder |
|
||||
| `plugin-sdk/channel-runtime` | 非推奨の互換 shim | レガシー channel runtime utility のみ |
|
||||
| `plugin-sdk/channel-send-result` | send result 型 | reply result 型 |
|
||||
| `plugin-sdk/runtime-store` | 永続的な plugin storage | `createPluginRuntimeStore` |
|
||||
| `plugin-sdk/runtime` | 広範な runtime ヘルパー | runtime / logging / backup / plugin-install ヘルパー |
|
||||
| `plugin-sdk/runtime-env` | 狭い runtime env ヘルパー | logger / runtime env、timeout、retry、backoff ヘルパー |
|
||||
| `plugin-sdk/plugin-runtime` | 共有 plugin runtime ヘルパー | plugin commands / hooks / http / interactive ヘルパー |
|
||||
| `plugin-sdk/hook-runtime` | hook pipeline ヘルパー | 共有 webhook / internal hook pipeline ヘルパー |
|
||||
| `plugin-sdk/lazy-runtime` | lazy runtime ヘルパー | `createLazyRuntimeModule`, `createLazyRuntimeMethod`, `createLazyRuntimeMethodBinder`, `createLazyRuntimeNamedExport`, `createLazyRuntimeSurface` |
|
||||
| `plugin-sdk/process-runtime` | process ヘルパー | 共有 exec ヘルパー |
|
||||
| `plugin-sdk/cli-runtime` | CLI runtime ヘルパー | command formatting、wait、version ヘルパー |
|
||||
| `plugin-sdk/gateway-runtime` | Gateway ヘルパー | Gateway client と channel-status patch ヘルパー |
|
||||
| `plugin-sdk/config-runtime` | config ヘルパー | config load / write ヘルパー |
|
||||
| `plugin-sdk/telegram-command-config` | Telegram command ヘルパー | バンドルされた Telegram 契約サーフェスが使えない場合の、fallback-stable な Telegram command 検証ヘルパー |
|
||||
| `plugin-sdk/approval-runtime` | approval prompt ヘルパー | exec / plugin approval payload、approval capability / profile ヘルパー、native approval routing / runtime ヘルパー |
|
||||
| `plugin-sdk/approval-auth-runtime` | approval auth ヘルパー | approver 解決、同一 chat action auth |
|
||||
| `plugin-sdk/approval-client-runtime` | approval client ヘルパー | native exec approval profile / filter ヘルパー |
|
||||
| `plugin-sdk/approval-delivery-runtime` | approval delivery ヘルパー | native approval capability / delivery adapter |
|
||||
| `plugin-sdk/approval-native-runtime` | approval target ヘルパー | native approval target / account binding ヘルパー |
|
||||
| `plugin-sdk/approval-reply-runtime` | approval reply ヘルパー | exec / plugin approval reply payload ヘルパー |
|
||||
| `plugin-sdk/security-runtime` | security ヘルパー | 共有 trust、DM gating、external-content、secret-collection ヘルパー |
|
||||
| `plugin-sdk/ssrf-policy` | SSRF policy ヘルパー | host allowlist と private-network policy ヘルパー |
|
||||
| `plugin-sdk/ssrf-runtime` | SSRF runtime ヘルパー | pinned-dispatcher、guarded fetch、SSRF policy ヘルパー |
|
||||
| `plugin-sdk/collection-runtime` | 制限付き cache ヘルパー | `pruneMapToMaxSize` |
|
||||
| `plugin-sdk/diagnostic-runtime` | diagnostic gating ヘルパー | `isDiagnosticFlagEnabled`, `isDiagnosticsEnabled` |
|
||||
| `plugin-sdk/error-runtime` | error formatting ヘルパー | `formatUncaughtError`, `isApprovalNotFoundError`, error graph ヘルパー |
|
||||
| `plugin-sdk/fetch-runtime` | wrapped fetch / proxy ヘルパー | `resolveFetch`、proxy ヘルパー |
|
||||
| `plugin-sdk/host-runtime` | host 正規化ヘルパー | `normalizeHostname`, `normalizeScpRemoteHost` |
|
||||
| `plugin-sdk/retry-runtime` | retry ヘルパー | `RetryConfig`, `retryAsync`, policy runner |
|
||||
| `plugin-sdk/allow-from` | allowlist formatting | `formatAllowFromLowercase` |
|
||||
| `plugin-sdk/allowlist-resolution` | allowlist input mapping | `mapAllowlistResolutionInputs` |
|
||||
| `plugin-sdk/command-auth` | command gating と command-surface ヘルパー | `resolveControlCommandGate`、sender-authorization ヘルパー、command registry ヘルパー |
|
||||
| `plugin-sdk/secret-input` | secret input 解析 | secret input ヘルパー |
|
||||
| `plugin-sdk/webhook-ingress` | webhook request ヘルパー | webhook target utility |
|
||||
| `plugin-sdk/webhook-request-guards` | webhook body guard ヘルパー | request body read / limit ヘルパー |
|
||||
| `plugin-sdk/reply-runtime` | 共有 reply runtime | inbound dispatch、heartbeat、reply planner、chunking |
|
||||
| `plugin-sdk/reply-dispatch-runtime` | 狭い reply dispatch ヘルパー | finalize と provider dispatch ヘルパー |
|
||||
| `plugin-sdk/reply-history` | reply-history ヘルパー | `buildHistoryContext`, `buildPendingHistoryContextFromMap`, `recordPendingHistoryEntry`, `clearHistoryEntriesIfEnabled` |
|
||||
| `plugin-sdk/reply-reference` | reply reference planning | `createReplyReferencePlanner` |
|
||||
| `plugin-sdk/reply-chunking` | reply chunk ヘルパー | text / markdown chunking ヘルパー |
|
||||
| `plugin-sdk/session-store-runtime` | session store ヘルパー | store path と updated-at ヘルパー |
|
||||
| `plugin-sdk/state-paths` | state path ヘルパー | state と OAuth dir ヘルパー |
|
||||
| `plugin-sdk/routing` | routing / session-key ヘルパー | `resolveAgentRoute`, `buildAgentSessionKey`, `resolveDefaultAgentBoundAccountId`、session-key 正規化ヘルパー |
|
||||
| `plugin-sdk/status-helpers` | channel status ヘルパー | channel / account status summary builder、runtime-state default、issue metadata ヘルパー |
|
||||
| `plugin-sdk/target-resolver-runtime` | target resolver ヘルパー | 共有 target resolver ヘルパー |
|
||||
| `plugin-sdk/string-normalization-runtime` | 文字列正規化ヘルパー | slug / 文字列正規化ヘルパー |
|
||||
| `plugin-sdk/request-url` | request URL ヘルパー | request のような入力から文字列 URL を抽出 |
|
||||
| `plugin-sdk/run-command` | 時間制限付き command ヘルパー | stdout / stderr を正規化した timed command runner |
|
||||
| `plugin-sdk/param-readers` | param reader | 一般的な tool / CLI param reader |
|
||||
| `plugin-sdk/tool-send` | tool send 抽出 | tool 引数から canonical send target field を抽出 |
|
||||
| `plugin-sdk/temp-path` | temp path ヘルパー | 共有 temp-download path ヘルパー |
|
||||
| `plugin-sdk/logging-core` | logging ヘルパー | subsystem logger と redaction ヘルパー |
|
||||
| `plugin-sdk/markdown-table-runtime` | markdown-table ヘルパー | markdown table mode ヘルパー |
|
||||
| `plugin-sdk/reply-payload` | message reply 型 | reply payload 型 |
|
||||
| `plugin-sdk/provider-setup` | 厳選された local / self-hosted provider setup ヘルパー | self-hosted provider discovery / config ヘルパー |
|
||||
| `plugin-sdk/self-hosted-provider-setup` | 目的別の OpenAI-compatible self-hosted provider setup ヘルパー | 同じ self-hosted provider discovery / config ヘルパー |
|
||||
| `plugin-sdk/provider-auth-runtime` | provider runtime auth ヘルパー | runtime API-key 解決ヘルパー |
|
||||
| `plugin-sdk/provider-auth-api-key` | provider API-key setup ヘルパー | API-key onboarding / profile-write ヘルパー |
|
||||
| `plugin-sdk/provider-auth-result` | provider auth-result ヘルパー | 標準 OAuth auth-result builder |
|
||||
| `plugin-sdk/provider-auth-login` | provider interactive login ヘルパー | 共有 interactive login ヘルパー |
|
||||
| `plugin-sdk/provider-env-vars` | provider env-var ヘルパー | provider auth env-var lookup ヘルパー |
|
||||
| `plugin-sdk/provider-model-shared` | 共有 provider model / replay ヘルパー | `ProviderReplayFamily`, `buildProviderReplayFamilyHooks`, `normalizeModelCompat`、共有 replay-policy builder、provider-endpoint ヘルパー、model-id 正規化ヘルパー |
|
||||
| `plugin-sdk/provider-catalog-shared` | 共有 provider catalog ヘルパー | `findCatalogTemplate`, `buildSingleProviderApiKeyCatalog`, `supportsNativeStreamingUsageCompat`, `applyProviderNativeStreamingUsageCompat` |
|
||||
| `plugin-sdk/provider-onboard` | provider onboarding patch | onboarding config ヘルパー |
|
||||
| `plugin-sdk/provider-http` | provider HTTP ヘルパー | 汎用 provider HTTP / endpoint capability ヘルパー |
|
||||
| `plugin-sdk/provider-web-fetch` | provider web-fetch ヘルパー | web-fetch provider registration / cache ヘルパー |
|
||||
| `plugin-sdk/provider-web-search` | provider web-search ヘルパー | web-search provider registration / cache / config ヘルパー |
|
||||
| `plugin-sdk/provider-tools` | provider tool / schema compat ヘルパー | `ProviderToolCompatFamily`, `buildProviderToolCompatFamilyHooks`, Gemini schema cleanup と diagnostics、`resolveXaiModelCompatPatch` / `applyXaiModelCompat` のような xAI compat ヘルパー |
|
||||
| `plugin-sdk/provider-usage` | provider usage ヘルパー | `fetchClaudeUsage`, `fetchGeminiUsage`, `fetchGithubCopilotUsage`、その他の provider usage ヘルパー |
|
||||
| `plugin-sdk/provider-stream` | provider stream wrapper ヘルパー | `ProviderStreamFamily`, `buildProviderStreamFamilyHooks`, `composeProviderStreamWrappers`、stream wrapper 型、および共有 Anthropic / Bedrock / Google / Kilocode / Moonshot / OpenAI / OpenRouter / Z.A.I / MiniMax / Copilot wrapper ヘルパー |
|
||||
| `plugin-sdk/keyed-async-queue` | 順序付き async queue | `KeyedAsyncQueue` |
|
||||
| `plugin-sdk/media-runtime` | 共有 media ヘルパー | media fetch / transform / store ヘルパーと media payload builder |
|
||||
| `plugin-sdk/media-generation-runtime` | 共有 media-generation ヘルパー | image / video / music generation 向けの共有 failover ヘルパー、candidate 選択、不足 model メッセージ |
|
||||
| `plugin-sdk/media-understanding` | media-understanding ヘルパー | media understanding provider 型と、provider 向け image / audio ヘルパー export |
|
||||
| `plugin-sdk/text-runtime` | 共有 text ヘルパー | assistant-visible-text の除去、markdown render / chunking / table ヘルパー、redaction ヘルパー、directive-tag ヘルパー、安全な text utility、関連する text / logging ヘルパー |
|
||||
| `plugin-sdk/text-chunking` | text chunking ヘルパー | outbound text chunking ヘルパー |
|
||||
| `plugin-sdk/speech` | speech ヘルパー | speech provider 型と、provider 向け directive、registry、validation ヘルパー |
|
||||
| `plugin-sdk/speech-core` | 共有 speech core | speech provider 型、registry、directive、正規化 |
|
||||
| `plugin-sdk/realtime-transcription` | realtime transcription ヘルパー | provider 型と registry ヘルパー |
|
||||
| `plugin-sdk/realtime-voice` | realtime voice ヘルパー | provider 型と registry ヘルパー |
|
||||
| `plugin-sdk/image-generation-core` | 共有 image-generation core | image-generation 型、failover、auth、registry ヘルパー |
|
||||
| `plugin-sdk/music-generation` | music-generation ヘルパー | music-generation provider / request / result 型 |
|
||||
| `plugin-sdk/music-generation-core` | 共有 music-generation core | music-generation 型、failover ヘルパー、provider lookup、model-ref 解析 |
|
||||
| `plugin-sdk/video-generation` | video-generation ヘルパー | video-generation provider / request / result 型 |
|
||||
| `plugin-sdk/video-generation-core` | 共有 video-generation core | video-generation 型、failover ヘルパー、provider lookup、model-ref 解析 |
|
||||
| `plugin-sdk/interactive-runtime` | interactive reply ヘルパー | interactive reply payload の正規化 / 縮約 |
|
||||
| `plugin-sdk/channel-config-primitives` | channel config プリミティブ | 狭い channel config-schema プリミティブ |
|
||||
| `plugin-sdk/channel-config-writes` | channel config-write ヘルパー | channel config-write authorization ヘルパー |
|
||||
| `plugin-sdk/channel-plugin-common` | 共有 channel prelude | 共有 channel plugin prelude export |
|
||||
| `plugin-sdk/channel-status` | channel status ヘルパー | 共有 channel status snapshot / summary ヘルパー |
|
||||
| `plugin-sdk/allowlist-config-edit` | allowlist config ヘルパー | allowlist config edit / read ヘルパー |
|
||||
| `plugin-sdk/group-access` | group access ヘルパー | 共有 group-access decision ヘルパー |
|
||||
| `plugin-sdk/direct-dm` | Direct-DM ヘルパー | 共有 direct-DM auth / guard ヘルパー |
|
||||
| `plugin-sdk/extension-shared` | 共有 extension ヘルパー | passive-channel / status helper プリミティブ |
|
||||
| `plugin-sdk/webhook-targets` | webhook target ヘルパー | webhook target registry と route-install ヘルパー |
|
||||
| `plugin-sdk/webhook-path` | webhook path ヘルパー | webhook path 正規化ヘルパー |
|
||||
| `plugin-sdk/web-media` | 共有 web media ヘルパー | remote / local media 読み込みヘルパー |
|
||||
| `plugin-sdk/zod` | Zod 再エクスポート | plugin SDK 利用者向けに再エクスポートされた `zod` |
|
||||
| `plugin-sdk/memory-core` | バンドルされた memory-core ヘルパー | Memory manager / config / file / CLI helper surface |
|
||||
| `plugin-sdk/memory-core-engine-runtime` | memory engine runtime facade | Memory index / search runtime facade |
|
||||
| `plugin-sdk/memory-core-host-engine-foundation` | memory host foundation engine | Memory host foundation engine export |
|
||||
| `plugin-sdk/memory-core-host-engine-embeddings` | memory host embedding engine | Memory host embedding engine export |
|
||||
| `plugin-sdk/memory-core-host-engine-qmd` | memory host QMD engine | Memory host QMD engine export |
|
||||
| `plugin-sdk/memory-core-host-engine-storage` | memory host storage engine | Memory host storage engine export |
|
||||
| `plugin-sdk/memory-core-host-multimodal` | memory host multimodal ヘルパー | Memory host multimodal ヘルパー |
|
||||
| `plugin-sdk/memory-core-host-query` | memory host query ヘルパー | Memory host query ヘルパー |
|
||||
| `plugin-sdk/memory-core-host-secret` | memory host secret ヘルパー | Memory host secret ヘルパー |
|
||||
| `plugin-sdk/memory-core-host-events` | memory host event journal ヘルパー | Memory host event journal ヘルパー |
|
||||
| `plugin-sdk/memory-core-host-status` | memory host status ヘルパー | Memory host status ヘルパー |
|
||||
| `plugin-sdk/memory-core-host-runtime-cli` | memory host CLI runtime | Memory host CLI runtime ヘルパー |
|
||||
| `plugin-sdk/memory-core-host-runtime-core` | memory host core runtime | Memory host core runtime ヘルパー |
|
||||
| `plugin-sdk/memory-core-host-runtime-files` | memory host file / runtime ヘルパー | Memory host file / runtime ヘルパー |
|
||||
| `plugin-sdk/memory-host-core` | memory host core runtime alias | memory host core runtime ヘルパー向けの vendor-neutral alias |
|
||||
| `plugin-sdk/memory-host-events` | memory host event journal alias | memory host event journal ヘルパー向けの vendor-neutral alias |
|
||||
| `plugin-sdk/memory-host-files` | memory host file / runtime alias | memory host file / runtime ヘルパー向けの vendor-neutral alias |
|
||||
| `plugin-sdk/memory-host-markdown` | managed markdown ヘルパー | memory 隣接 plugin 向けの共有 managed-markdown ヘルパー |
|
||||
| `plugin-sdk/memory-host-search` | active memory search facade | lazy な active-memory search-manager runtime facade |
|
||||
| `plugin-sdk/memory-host-status` | memory host status alias | memory host status ヘルパー向けの vendor-neutral alias |
|
||||
| `plugin-sdk/memory-lancedb` | バンドルされた memory-lancedb ヘルパー | Memory-lancedb helper surface |
|
||||
| `plugin-sdk/testing` | テスト utility | テストヘルパーと mock |
|
||||
</Accordion>
|
||||
|
||||
この表は意図的に、完全なSDK
|
||||
サーフェスではなく、一般的な移行向けサブセットです。200以上のエントリポイントを含む完全な一覧は
|
||||
`scripts/lib/plugin-sdk-entrypoints.json` にあります。
|
||||
この表は、完全な SDK サーフェスではなく、意図的に一般的な移行向けのサブセットに絞っています。200 を超える entrypoint の完全な一覧は
|
||||
`scripts/lib/plugin-sdk-entrypoints.json`
|
||||
にあります。
|
||||
|
||||
その一覧には、`plugin-sdk/feishu`、`plugin-sdk/feishu-setup`、`plugin-sdk/zalo`、
|
||||
`plugin-sdk/zalo-setup`、`plugin-sdk/matrix*` のような、バンドルプラグイン用ヘルパーシームもまだ含まれています。これらはバンドルプラグイン保守と互換性のために引き続きexportされていますが、一般的な移行テーブルからは意図的に省かれており、新しいプラグインコードの推奨ターゲットではありません。
|
||||
その一覧には、`plugin-sdk/feishu`、`plugin-sdk/feishu-setup`、`plugin-sdk/zalo`、`plugin-sdk/zalo-setup`、`plugin-sdk/matrix*` のような、一部のバンドル plugin 用 helper seam も引き続き含まれています。これらはバンドル plugin の保守と互換性のために引き続き export されていますが、一般的な移行一覧には意図的に含めておらず、新しい plugin code の推奨先でもありません。
|
||||
|
||||
同じルールは、他のバンドルヘルパーファミリーにも適用されます。たとえば:
|
||||
同じルールは、次のような他の bundled-helper ファミリーにも当てはまります。
|
||||
|
||||
- browserサポートヘルパー: `plugin-sdk/browser-cdp`, `plugin-sdk/browser-config-runtime`, `plugin-sdk/browser-config-support`, `plugin-sdk/browser-control-auth`, `plugin-sdk/browser-node-runtime`, `plugin-sdk/browser-profiles`, `plugin-sdk/browser-security-runtime`, `plugin-sdk/browser-setup-tools`, `plugin-sdk/browser-support`
|
||||
- browser support ヘルパー: `plugin-sdk/browser-cdp`, `plugin-sdk/browser-config-runtime`, `plugin-sdk/browser-config-support`, `plugin-sdk/browser-control-auth`, `plugin-sdk/browser-node-runtime`, `plugin-sdk/browser-profiles`, `plugin-sdk/browser-security-runtime`, `plugin-sdk/browser-setup-tools`, `plugin-sdk/browser-support`
|
||||
- Matrix: `plugin-sdk/matrix*`
|
||||
- LINE: `plugin-sdk/line*`
|
||||
- IRC: `plugin-sdk/irc*`
|
||||
- `plugin-sdk/googlechat`、
|
||||
`plugin-sdk/zalouser`, `plugin-sdk/bluebubbles*`,
|
||||
`plugin-sdk/mattermost*`, `plugin-sdk/msteams`,
|
||||
`plugin-sdk/nextcloud-talk`, `plugin-sdk/nostr`, `plugin-sdk/tlon`,
|
||||
`plugin-sdk/twitch`,
|
||||
`plugin-sdk/github-copilot-login`, `plugin-sdk/github-copilot-token`,
|
||||
`plugin-sdk/diagnostics-otel`, `plugin-sdk/diffs`, `plugin-sdk/llm-task`,
|
||||
`plugin-sdk/thread-ownership`, `plugin-sdk/voice-call` のような
|
||||
バンドルヘルパー/プラグインサーフェス
|
||||
`plugin-sdk/zalouser`、`plugin-sdk/bluebubbles*`、
|
||||
`plugin-sdk/mattermost*`、`plugin-sdk/msteams`、
|
||||
`plugin-sdk/nextcloud-talk`、`plugin-sdk/nostr`、`plugin-sdk/tlon`、
|
||||
`plugin-sdk/twitch`、
|
||||
`plugin-sdk/github-copilot-login`、`plugin-sdk/github-copilot-token`、
|
||||
`plugin-sdk/diagnostics-otel`、`plugin-sdk/diffs`、`plugin-sdk/llm-task`、
|
||||
`plugin-sdk/thread-ownership`、`plugin-sdk/voice-call` のような、バンドル helper / plugin サーフェス
|
||||
|
||||
`plugin-sdk/github-copilot-token` は現在、細いトークンヘルパー
|
||||
サーフェス `DEFAULT_COPILOT_API_BASE_URL`、
|
||||
`deriveCopilotApiBaseUrlFromToken`、`resolveCopilotApiToken` を公開しています。
|
||||
`plugin-sdk/github-copilot-token` は現在、
|
||||
`DEFAULT_COPILOT_API_BASE_URL`、
|
||||
`deriveCopilotApiBaseUrlFromToken`、`resolveCopilotApiToken`
|
||||
という狭い token-helper サーフェスを公開しています。
|
||||
|
||||
用途に合う最も細いimportを使用してください。exportが見つからない場合は、
|
||||
`src/plugin-sdk/` のソースを確認するか、Discordで質問してください。
|
||||
作業に合った、最も狭い import を使ってください。export が見つからない場合は、
|
||||
`src/plugin-sdk/`
|
||||
の source を確認するか、Discord で質問してください。
|
||||
|
||||
## 削除タイムライン
|
||||
|
||||
| いつ | 何が起きるか |
|
||||
| 時期 | 何が起きるか |
|
||||
| ---------------------- | ----------------------------------------------------------------------- |
|
||||
| **現在** | 非推奨サーフェスはランタイム警告を出します |
|
||||
| **次のメジャーリリース** | 非推奨サーフェスは削除され、それらをまだ使っているプラグインは動作しなくなります |
|
||||
| **今** | 非推奨サーフェスが実行時 warning を出す |
|
||||
| **次のメジャーリリース** | 非推奨サーフェスは削除され、それらを使い続けている plugin は失敗する |
|
||||
|
||||
すべてのコアプラグインはすでに移行済みです。外部プラグインは、
|
||||
次のメジャーリリース前に移行する必要があります。
|
||||
すべての core plugin はすでに移行済みです。外部 plugin は、次のメジャーリリース前に移行してください。
|
||||
|
||||
## 一時的に警告を抑制する
|
||||
## warning を一時的に抑制する
|
||||
|
||||
移行作業中は、これらの環境変数を設定してください。
|
||||
移行作業中は、これらの environment variable を設定してください。
|
||||
|
||||
```bash
|
||||
OPENCLAW_SUPPRESS_PLUGIN_SDK_COMPAT_WARNING=1 openclaw gateway run
|
||||
OPENCLAW_SUPPRESS_EXTENSION_API_WARNING=1 openclaw gateway run
|
||||
```
|
||||
|
||||
これは一時的な回避策であり、恒久的な解決策ではありません。
|
||||
これは一時的な回避手段であり、恒久的な解決策ではありません。
|
||||
|
||||
## 関連
|
||||
|
||||
- [はじめに](/ja-JP/plugins/building-plugins) — 最初のプラグインを作る
|
||||
- [SDK Overview](/ja-JP/plugins/sdk-overview) — subpath importの完全なリファレンス
|
||||
- [Channel Plugins](/ja-JP/plugins/sdk-channel-plugins) — チャンネルプラグインの構築
|
||||
- [Provider Plugins](/ja-JP/plugins/sdk-provider-plugins) — providerプラグインの構築
|
||||
- [Plugin Internals](/ja-JP/plugins/architecture) — アーキテクチャの詳細
|
||||
- [Plugin Manifest](/ja-JP/plugins/manifest) — manifestスキーマリファレンス
|
||||
- [はじめに](/ja-JP/plugins/building-plugins) — 最初の plugin を作成する
|
||||
- [SDK Overview](/ja-JP/plugins/sdk-overview) — subpath import の完全なリファレンス
|
||||
- [Channel Plugins](/ja-JP/plugins/sdk-channel-plugins) — channel plugin の作成
|
||||
- [Provider Plugins](/ja-JP/plugins/sdk-provider-plugins) — provider plugin の作成
|
||||
- [Plugin Internals](/ja-JP/plugins/architecture) — アーキテクチャの詳細解説
|
||||
- [Plugin Manifest](/ja-JP/plugins/manifest) — manifest schema リファレンス
|
||||
|
||||
@ -1,336 +1,348 @@
|
||||
---
|
||||
read_when:
|
||||
- どの SDK subpath から import するべきか知りたい場合
|
||||
- OpenClawPluginApi 上のすべての registration method のリファレンスが欲しい場合
|
||||
- 特定の SDK export を調べている場合
|
||||
- どのSDKサブパスからインポートするかを知る必要がある場合
|
||||
- OpenClawPluginApiのすべての登録メソッドのリファレンスが必要な場合
|
||||
- 特定のSDKエクスポートを調べている場合
|
||||
sidebarTitle: SDK Overview
|
||||
summary: import map、registration API リファレンス、SDK アーキテクチャ
|
||||
title: Plugin SDK の概要
|
||||
summary: インポートマップ、登録APIリファレンス、およびSDKアーキテクチャ
|
||||
title: Plugin SDKの概要
|
||||
x-i18n:
|
||||
generated_at: "2026-04-06T03:11:11Z"
|
||||
generated_at: "2026-04-06T04:45:02Z"
|
||||
model: gpt-5.4
|
||||
provider: openai
|
||||
source_hash: d801641f26f39dc21490d2a69a337ff1affb147141360916b8b58a267e9f822a
|
||||
source_hash: acd2887ef52c66b2f234858d812bb04197ecd0bfb3e4f7bf3622f8fdc765acad
|
||||
source_path: plugins/sdk-overview.md
|
||||
workflow: 15
|
||||
---
|
||||
|
||||
# Plugin SDK の概要
|
||||
# Plugin SDKの概要
|
||||
|
||||
plugin SDK は、plugins と core の間の型付き契約です。このページは、
|
||||
**何を import するか** と **何を登録できるか** のリファレンスです。
|
||||
plugin SDKは、プラグインとコアの間の型付きコントラクトです。このページは、
|
||||
**何をインポートするか** と **何を登録できるか** のリファレンスです。
|
||||
|
||||
<Tip>
|
||||
**ハウツーガイドを探していますか?**
|
||||
- 最初の plugin ですか? [はじめに](/ja-JP/plugins/building-plugins) から始めてください
|
||||
- channel plugin ですか? [Channel Plugins](/ja-JP/plugins/sdk-channel-plugins) を参照してください
|
||||
- provider plugin ですか? [Provider Plugins](/ja-JP/plugins/sdk-provider-plugins) を参照してください
|
||||
- 最初のプラグインですか? [はじめに](/ja-JP/plugins/building-plugins) から始めてください
|
||||
- チャンネルプラグインですか? [Channel Plugins](/ja-JP/plugins/sdk-channel-plugins) を参照してください
|
||||
- プロバイダープラグインですか? [Provider Plugins](/ja-JP/plugins/sdk-provider-plugins) を参照してください
|
||||
</Tip>
|
||||
|
||||
## import 規約
|
||||
## インポート規約
|
||||
|
||||
必ず特定の subpath から import してください:
|
||||
必ず特定のサブパスからインポートしてください。
|
||||
|
||||
```typescript
|
||||
import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry";
|
||||
import { defineChannelPluginEntry } from "openclaw/plugin-sdk/channel-core";
|
||||
```
|
||||
|
||||
各 subpath は小さく自己完結した module です。これにより起動を高速に保ち、
|
||||
循環依存の問題を防げます。channel 固有の entry/build helper には、
|
||||
`openclaw/plugin-sdk/channel-core` を優先して使用してください。より広い umbrella surface と
|
||||
`buildChannelConfigSchema` のような共有 helper には
|
||||
`openclaw/plugin-sdk/core` を使ってください。
|
||||
各サブパスは、小さく自己完結したモジュールです。これにより起動を高速に保ち、
|
||||
循環依存の問題を防ぎます。チャンネル固有のエントリ/ビルドヘルパーには、
|
||||
`openclaw/plugin-sdk/channel-core` を優先し、より広いアンブレラサーフェスや
|
||||
`buildChannelConfigSchema` のような共有ヘルパーには `openclaw/plugin-sdk/core` を使ってください。
|
||||
|
||||
`openclaw/plugin-sdk/slack`、`openclaw/plugin-sdk/discord`、
|
||||
`openclaw/plugin-sdk/signal`、`openclaw/plugin-sdk/whatsapp` のような
|
||||
provider 名付き convenience seam や channel ブランド付き helper seam を追加したり、
|
||||
依存したりしないでください。バンドル plugin は汎用的な
|
||||
SDK subpath を自分自身の `api.ts` または `runtime-api.ts` barrel の中で構成すべきであり、core はそれらの plugin ローカル barrel を使うか、
|
||||
必要が本当に channel 横断である場合のみ、狭く汎用的な SDK
|
||||
契約を追加するべきです。
|
||||
プロバイダー名付きの便利な境界や、チャンネルブランド付きのヘルパー境界を追加したり、
|
||||
依存したりしないでください。バンドルされたプラグインは、自身の `api.ts` または
|
||||
`runtime-api.ts` バレル内で汎用的なSDKサブパスを組み合わせるべきであり、コアは
|
||||
それらのプラグインローカルなバレルを使うか、本当にチャンネル横断の必要がある場合にのみ
|
||||
狭い汎用SDKコントラクトを追加するべきです。
|
||||
|
||||
生成された export map には、`plugin-sdk/feishu`、`plugin-sdk/feishu-setup`、
|
||||
`plugin-sdk/zalo`、`plugin-sdk/zalo-setup`、`plugin-sdk/matrix*` など、
|
||||
少数のバンドル plugin helper seam がまだ含まれています。これらの
|
||||
subpath は、バンドル plugin の保守と互換性のためだけに存在します。以下の一般的な表では意図的に省略されており、新しいサードパーティ plugin に推奨される import path ではありません。
|
||||
生成されたエクスポートマップには、`plugin-sdk/feishu`、`plugin-sdk/feishu-setup`、
|
||||
`plugin-sdk/zalo`、`plugin-sdk/zalo-setup`、`plugin-sdk/matrix*` のような、
|
||||
バンドルプラグイン用の小規模なヘルパー境界が引き続き含まれています。これらの
|
||||
サブパスは、バンドルプラグインの保守と互換性のためだけに存在します。意図的に
|
||||
以下の一般的なテーブルからは除外されており、新しいサードパーティプラグインに
|
||||
推奨されるインポートパスではありません。
|
||||
|
||||
## subpath リファレンス
|
||||
## サブパスリファレンス
|
||||
|
||||
目的別にグループ化した、最もよく使われる subpath です。200 を超える
|
||||
subpath の生成済み完全一覧は `scripts/lib/plugin-sdk-entrypoints.json` にあります。
|
||||
目的別にまとめた、最もよく使われるサブパスです。生成される完全な200以上の
|
||||
サブパス一覧は `scripts/lib/plugin-sdk-entrypoints.json` にあります。
|
||||
|
||||
予約済みのバンドル plugin helper subpath は、その生成一覧には引き続き表示されます。
|
||||
ドキュメントページで明示的に公開 API として案内されていない限り、これらは
|
||||
実装詳細/互換性 surface として扱ってください。
|
||||
予約済みのバンドルプラグイン用ヘルパーサブパスも、その生成リストには引き続き表示されます。
|
||||
ドキュメントページで明示的に公開サーフェスとして案内されていない限り、
|
||||
それらは実装詳細/互換性サーフェスとして扱ってください。
|
||||
|
||||
### Plugin entry
|
||||
### プラグインエントリ
|
||||
|
||||
| Subpath | 主な export |
|
||||
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `plugin-sdk/plugin-entry` | `definePluginEntry` |
|
||||
| サブパス | 主なエクスポート |
|
||||
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `plugin-sdk/plugin-entry` | `definePluginEntry` |
|
||||
| `plugin-sdk/core` | `defineChannelPluginEntry`, `createChatChannelPlugin`, `createChannelPluginBase`, `defineSetupPluginEntry`, `buildChannelConfigSchema` |
|
||||
| `plugin-sdk/config-schema` | `OpenClawSchema` |
|
||||
| `plugin-sdk/provider-entry` | `defineSingleProviderPluginEntry` |
|
||||
| `plugin-sdk/config-schema` | `OpenClawSchema` |
|
||||
| `plugin-sdk/provider-entry` | `defineSingleProviderPluginEntry` |
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="Channel subpaths">
|
||||
| Subpath | 主な export |
|
||||
<Accordion title="チャンネルサブパス">
|
||||
| サブパス | 主なエクスポート |
|
||||
| --- | --- |
|
||||
| `plugin-sdk/channel-core` | `defineChannelPluginEntry`, `defineSetupPluginEntry`, `createChatChannelPlugin`, `createChannelPluginBase` |
|
||||
| `plugin-sdk/config-schema` | ルート `openclaw.json` Zod スキーマ export(`OpenClawSchema`) |
|
||||
| `plugin-sdk/channel-setup` | `createOptionalChannelSetupSurface`, `createOptionalChannelSetupAdapter`, `createOptionalChannelSetupWizard`、および `DEFAULT_ACCOUNT_ID`, `createTopLevelChannelDmPolicy`, `setSetupChannelEnabled`, `splitSetupEntries` |
|
||||
| `plugin-sdk/setup` | 共有 setup wizard helper、allowlist prompt、setup status builder |
|
||||
| `plugin-sdk/config-schema` | ルート `openclaw.json` Zodスキーマエクスポート (`OpenClawSchema`) |
|
||||
| `plugin-sdk/channel-setup` | `createOptionalChannelSetupSurface`, `createOptionalChannelSetupAdapter`, `createOptionalChannelSetupWizard`, および `DEFAULT_ACCOUNT_ID`, `createTopLevelChannelDmPolicy`, `setSetupChannelEnabled`, `splitSetupEntries` |
|
||||
| `plugin-sdk/setup` | 共有セットアップウィザードヘルパー、allowlist プロンプト、セットアップステータスビルダー |
|
||||
| `plugin-sdk/setup-runtime` | `createPatchedAccountSetupAdapter`, `createEnvPatchedAccountSetupAdapter`, `createSetupInputPresenceValidator`, `noteChannelLookupFailure`, `noteChannelLookupSummary`, `promptResolvedAllowFrom`, `splitSetupEntries`, `createAllowlistSetupWizardProxy`, `createDelegatedSetupWizardProxy` |
|
||||
| `plugin-sdk/setup-adapter-runtime` | `createEnvPatchedAccountSetupAdapter` |
|
||||
| `plugin-sdk/setup-tools` | `formatCliCommand`, `detectBinary`, `extractArchive`, `resolveBrewExecutable`, `formatDocsLink`, `CONFIG_DIR` |
|
||||
| `plugin-sdk/account-core` | マルチアカウント設定/アクションゲート helper、デフォルトアカウントフォールバック helper |
|
||||
| `plugin-sdk/account-id` | `DEFAULT_ACCOUNT_ID`、account-id 正規化 helper |
|
||||
| `plugin-sdk/account-resolution` | アカウント検索 + デフォルトフォールバック helper |
|
||||
| `plugin-sdk/account-helpers` | 狭い account-list/account-action helper |
|
||||
| `plugin-sdk/account-core` | マルチアカウント設定/アクションゲートヘルパー、デフォルトアカウントのフォールバックヘルパー |
|
||||
| `plugin-sdk/account-id` | `DEFAULT_ACCOUNT_ID`、account-id 正規化ヘルパー |
|
||||
| `plugin-sdk/account-resolution` | アカウント検索 + デフォルトフォールバックヘルパー |
|
||||
| `plugin-sdk/account-helpers` | 狭い用途のアカウント一覧/アカウントアクションヘルパー |
|
||||
| `plugin-sdk/channel-pairing` | `createChannelPairingController` |
|
||||
| `plugin-sdk/channel-reply-pipeline` | `createChannelReplyPipeline` |
|
||||
| `plugin-sdk/channel-config-helpers` | `createHybridChannelConfigAdapter` |
|
||||
| `plugin-sdk/channel-config-schema` | channel 設定スキーマ型 |
|
||||
| `plugin-sdk/telegram-command-config` | バンドル契約フォールバック付き Telegram カスタムコマンド正規化/検証 helper |
|
||||
| `plugin-sdk/channel-config-schema` | チャンネル設定スキーマ型 |
|
||||
| `plugin-sdk/telegram-command-config` | バンドルコントラクトのフォールバック付きTelegramカスタムコマンド正規化/検証ヘルパー |
|
||||
| `plugin-sdk/channel-policy` | `resolveChannelGroupRequireMention` |
|
||||
| `plugin-sdk/channel-lifecycle` | `createAccountStatusSink` |
|
||||
| `plugin-sdk/inbound-envelope` | 共有 inbound route + envelope builder helper |
|
||||
| `plugin-sdk/inbound-reply-dispatch` | 共有 inbound record-and-dispatch helper |
|
||||
| `plugin-sdk/messaging-targets` | ターゲット解析/一致 helper |
|
||||
| `plugin-sdk/outbound-media` | 共有 outbound media 読み込み helper |
|
||||
| `plugin-sdk/outbound-runtime` | outbound identity/send delegate helper |
|
||||
| `plugin-sdk/thread-bindings-runtime` | thread-binding lifecycle と adapter helper |
|
||||
| `plugin-sdk/agent-media-payload` | レガシー agent media payload builder |
|
||||
| `plugin-sdk/conversation-runtime` | 会話/thread binding、pairing、設定済み binding helper |
|
||||
| `plugin-sdk/runtime-config-snapshot` | runtime config snapshot helper |
|
||||
| `plugin-sdk/runtime-group-policy` | runtime group-policy 解決 helper |
|
||||
| `plugin-sdk/channel-status` | 共有 channel status snapshot/summary helper |
|
||||
| `plugin-sdk/channel-config-primitives` | 狭い channel config-schema primitives |
|
||||
| `plugin-sdk/channel-config-writes` | channel config-write 認可 helper |
|
||||
| `plugin-sdk/channel-plugin-common` | 共有 channel plugin prelude export |
|
||||
| `plugin-sdk/allowlist-config-edit` | allowlist 設定編集/読み取り helper |
|
||||
| `plugin-sdk/group-access` | 共有 group-access 決定 helper |
|
||||
| `plugin-sdk/direct-dm` | 共有 direct-DM auth/guard helper |
|
||||
| `plugin-sdk/interactive-runtime` | インタラクティブ reply payload 正規化/reduction helper |
|
||||
| `plugin-sdk/channel-inbound` | debounce、mention 一致、envelope helper |
|
||||
| `plugin-sdk/channel-send-result` | reply result 型 |
|
||||
| `plugin-sdk/inbound-envelope` | 共有の受信ルート + エンベロープビルダーヘルパー |
|
||||
| `plugin-sdk/inbound-reply-dispatch` | 共有の受信記録およびディスパッチヘルパー |
|
||||
| `plugin-sdk/messaging-targets` | ターゲットの解析/照合ヘルパー |
|
||||
| `plugin-sdk/outbound-media` | 共有の送信メディア読み込みヘルパー |
|
||||
| `plugin-sdk/outbound-runtime` | 送信元アイデンティティ/送信デリゲートヘルパー |
|
||||
| `plugin-sdk/thread-bindings-runtime` | スレッドバインディングのライフサイクルおよびアダプターヘルパー |
|
||||
| `plugin-sdk/agent-media-payload` | レガシーのエージェントメディアペイロードビルダー |
|
||||
| `plugin-sdk/conversation-runtime` | 会話/スレッドバインディング、ペアリング、および設定済みバインディングのヘルパー |
|
||||
| `plugin-sdk/runtime-config-snapshot` | ランタイム設定スナップショットヘルパー |
|
||||
| `plugin-sdk/runtime-group-policy` | ランタイムのグループポリシー解決ヘルパー |
|
||||
| `plugin-sdk/channel-status` | 共有のチャンネルステータススナップショット/サマリーヘルパー |
|
||||
| `plugin-sdk/channel-config-primitives` | 狭い用途のチャンネル設定スキーマプリミティブ |
|
||||
| `plugin-sdk/channel-config-writes` | チャンネル設定書き込みの認可ヘルパー |
|
||||
| `plugin-sdk/channel-plugin-common` | 共有のチャンネルプラグイン前提エクスポート |
|
||||
| `plugin-sdk/allowlist-config-edit` | allowlist 設定の編集/読み取りヘルパー |
|
||||
| `plugin-sdk/group-access` | 共有のグループアクセス判定ヘルパー |
|
||||
| `plugin-sdk/direct-dm` | 共有のダイレクトDM認証/ガードヘルパー |
|
||||
| `plugin-sdk/interactive-runtime` | 対話型返信ペイロードの正規化/削減ヘルパー |
|
||||
| `plugin-sdk/channel-inbound` | デバウンス、メンション照合、エンベロープヘルパー |
|
||||
| `plugin-sdk/channel-send-result` | 返信結果型 |
|
||||
| `plugin-sdk/channel-actions` | `createMessageToolButtonsSchema`, `createMessageToolCardSchema` |
|
||||
| `plugin-sdk/channel-targets` | ターゲット解析/一致 helper |
|
||||
| `plugin-sdk/channel-contract` | channel 契約型 |
|
||||
| `plugin-sdk/channel-feedback` | feedback/reaction 配線 |
|
||||
| `plugin-sdk/channel-targets` | ターゲットの解析/照合ヘルパー |
|
||||
| `plugin-sdk/channel-contract` | チャンネルコントラクト型 |
|
||||
| `plugin-sdk/channel-feedback` | フィードバック/リアクション接続 |
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Provider subpaths">
|
||||
| Subpath | 主な export |
|
||||
<Accordion title="プロバイダーサブパス">
|
||||
| サブパス | 主なエクスポート |
|
||||
| --- | --- |
|
||||
| `plugin-sdk/provider-entry` | `defineSingleProviderPluginEntry` |
|
||||
| `plugin-sdk/provider-setup` | 厳選された local/self-hosted provider setup helper |
|
||||
| `plugin-sdk/self-hosted-provider-setup` | OpenAI 互換 self-hosted provider 向けの集中的な setup helper |
|
||||
| `plugin-sdk/provider-auth-runtime` | provider plugins 向け runtime API-key 解決 helper |
|
||||
| `plugin-sdk/provider-auth-api-key` | API-key オンボーディング/profile-write helper |
|
||||
| `plugin-sdk/provider-auth-result` | 標準 OAuth auth-result builder |
|
||||
| `plugin-sdk/provider-auth-login` | provider plugins 向け共有対話ログイン helper |
|
||||
| `plugin-sdk/provider-env-vars` | provider auth env-var 検索 helper |
|
||||
| `plugin-sdk/provider-setup` | 厳選されたローカル/セルフホスト型プロバイダーのセットアップヘルパー |
|
||||
| `plugin-sdk/self-hosted-provider-setup` | OpenAI互換のセルフホスト型プロバイダーに特化したセットアップヘルパー |
|
||||
| `plugin-sdk/provider-auth-runtime` | プロバイダープラグイン向けのランタイムAPIキー解決ヘルパー |
|
||||
| `plugin-sdk/provider-auth-api-key` | APIキーのオンボーディング/プロファイル書き込みヘルパー |
|
||||
| `plugin-sdk/provider-auth-result` | 標準OAuth auth-result ビルダー |
|
||||
| `plugin-sdk/provider-auth-login` | プロバイダープラグイン向け共有対話型ログインヘルパー |
|
||||
| `plugin-sdk/provider-env-vars` | プロバイダー認証用環境変数の検索ヘルパー |
|
||||
| `plugin-sdk/provider-auth` | `createProviderApiKeyAuthMethod`, `ensureApiKeyFromOptionEnvOrPrompt`, `upsertAuthProfile` |
|
||||
| `plugin-sdk/provider-model-shared` | `ProviderReplayFamily`, `buildProviderReplayFamilyHooks`, `normalizeModelCompat`、共有 replay-policy builder、provider-endpoint helper、および `normalizeNativeXaiModelId` のような model-id 正規化 helper |
|
||||
| `plugin-sdk/provider-model-shared` | `ProviderReplayFamily`, `buildProviderReplayFamilyHooks`, `normalizeModelCompat`, 共有 replay-policy ビルダー、provider-endpoint ヘルパー、および `normalizeNativeXaiModelId` のような model-id 正規化ヘルパー |
|
||||
| `plugin-sdk/provider-catalog-shared` | `findCatalogTemplate`, `buildSingleProviderApiKeyCatalog`, `supportsNativeStreamingUsageCompat`, `applyProviderNativeStreamingUsageCompat` |
|
||||
| `plugin-sdk/provider-http` | 汎用 provider HTTP/endpoint capability helper |
|
||||
| `plugin-sdk/provider-web-fetch` | web-fetch provider 登録/cache helper |
|
||||
| `plugin-sdk/provider-web-search` | web-search provider 登録/cache/config helper |
|
||||
| `plugin-sdk/provider-tools` | `ProviderToolCompatFamily`, `buildProviderToolCompatFamilyHooks`, Gemini スキーマクリーンアップ + diagnostics、および `resolveXaiModelCompatPatch` / `applyXaiModelCompat` のような xAI compat helper |
|
||||
| `plugin-sdk/provider-http` | 汎用プロバイダーHTTP/endpoint capability ヘルパー |
|
||||
| `plugin-sdk/provider-web-fetch` | web-fetch プロバイダーの登録/キャッシュヘルパー |
|
||||
| `plugin-sdk/provider-web-search` | web-search プロバイダーの登録/キャッシュ/設定ヘルパー |
|
||||
| `plugin-sdk/provider-tools` | `ProviderToolCompatFamily`, `buildProviderToolCompatFamilyHooks`, Gemini スキーマクリーンアップ + 診断、および `resolveXaiModelCompatPatch` / `applyXaiModelCompat` のような xAI 互換ヘルパー |
|
||||
| `plugin-sdk/provider-usage` | `fetchClaudeUsage` など |
|
||||
| `plugin-sdk/provider-stream` | `ProviderStreamFamily`, `buildProviderStreamFamilyHooks`, `composeProviderStreamWrappers`、stream wrapper 型、および共有 Anthropic/Bedrock/Google/Kilocode/Moonshot/OpenAI/OpenRouter/Z.A.I/MiniMax/Copilot wrapper helper |
|
||||
| `plugin-sdk/provider-onboard` | オンボーディング設定パッチ helper |
|
||||
| `plugin-sdk/global-singleton` | プロセスローカル singleton/map/cache helper |
|
||||
| `plugin-sdk/provider-stream` | `ProviderStreamFamily`, `buildProviderStreamFamilyHooks`, `composeProviderStreamWrappers`, ストリームラッパー型、および共有の Anthropic/Bedrock/Google/Kilocode/Moonshot/OpenAI/OpenRouter/Z.A.I/MiniMax/Copilot ラッパーヘルパー |
|
||||
| `plugin-sdk/provider-onboard` | オンボーディング設定パッチヘルパー |
|
||||
| `plugin-sdk/global-singleton` | プロセスローカルな singleton/map/cache ヘルパー |
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="認証とセキュリティの subpaths">
|
||||
| Subpath | 主な export |
|
||||
<Accordion title="認証とセキュリティのサブパス">
|
||||
| サブパス | 主なエクスポート |
|
||||
| --- | --- |
|
||||
| `plugin-sdk/command-auth` | `resolveControlCommandGate`, command registry helper, sender-authorization helper |
|
||||
| `plugin-sdk/approval-auth-runtime` | approver 解決と same-chat action-auth helper |
|
||||
| `plugin-sdk/approval-client-runtime` | ネイティブ exec approval profile/filter helper |
|
||||
| `plugin-sdk/approval-delivery-runtime` | ネイティブ approval capability/delivery adapter |
|
||||
| `plugin-sdk/approval-native-runtime` | ネイティブ approval target + account-binding helper |
|
||||
| `plugin-sdk/approval-reply-runtime` | exec/plugin approval reply payload helper |
|
||||
| `plugin-sdk/command-auth-native` | ネイティブ command auth + ネイティブ session-target helper |
|
||||
| `plugin-sdk/command-detection` | 共有 command 検出 helper |
|
||||
| `plugin-sdk/command-surface` | command-body 正規化と command-surface helper |
|
||||
| `plugin-sdk/command-auth` | `resolveControlCommandGate`, コマンドレジストリヘルパー、送信者認可ヘルパー |
|
||||
| `plugin-sdk/approval-auth-runtime` | 承認者解決および同一チャット action-auth ヘルパー |
|
||||
| `plugin-sdk/approval-client-runtime` | ネイティブ実行承認プロファイル/フィルターヘルパー |
|
||||
| `plugin-sdk/approval-delivery-runtime` | ネイティブ承認 capability/delivery アダプター |
|
||||
| `plugin-sdk/approval-native-runtime` | ネイティブ承認ターゲット + account-binding ヘルパー |
|
||||
| `plugin-sdk/approval-reply-runtime` | exec/plugin 承認返信ペイロードヘルパー |
|
||||
| `plugin-sdk/command-auth-native` | ネイティブコマンド認証 + ネイティブ session-target ヘルパー |
|
||||
| `plugin-sdk/command-detection` | 共有コマンド検出ヘルパー |
|
||||
| `plugin-sdk/command-surface` | コマンド本文の正規化と command-surface ヘルパー |
|
||||
| `plugin-sdk/allow-from` | `formatAllowFromLowercase` |
|
||||
| `plugin-sdk/security-runtime` | 共有 trust、DM gating、external-content、secret-collection helper |
|
||||
| `plugin-sdk/ssrf-policy` | ホスト allowlist とプライベートネットワーク SSRF policy helper |
|
||||
| `plugin-sdk/ssrf-runtime` | pinned-dispatcher、SSRF 保護付き fetch、および SSRF policy helper |
|
||||
| `plugin-sdk/secret-input` | secret input 解析 helper |
|
||||
| `plugin-sdk/webhook-ingress` | webhook request/target helper |
|
||||
| `plugin-sdk/webhook-request-guards` | request body サイズ/timeout helper |
|
||||
| `plugin-sdk/security-runtime` | 共有の信頼、DMゲーティング、外部コンテンツ、およびシークレット収集ヘルパー |
|
||||
| `plugin-sdk/ssrf-policy` | ホスト allowlist およびプライベートネットワークSSRFポリシーヘルパー |
|
||||
| `plugin-sdk/ssrf-runtime` | pinned-dispatcher、SSRF保護付き fetch、および SSRFポリシーヘルパー |
|
||||
| `plugin-sdk/secret-input` | シークレット入力解析ヘルパー |
|
||||
| `plugin-sdk/webhook-ingress` | webhook リクエスト/ターゲットヘルパー |
|
||||
| `plugin-sdk/webhook-request-guards` | リクエストボディサイズ/タイムアウトヘルパー |
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Runtime とストレージの subpaths">
|
||||
| Subpath | 主な export |
|
||||
<Accordion title="ランタイムとストレージのサブパス">
|
||||
| サブパス | 主なエクスポート |
|
||||
| --- | --- |
|
||||
| `plugin-sdk/runtime` | 広範な runtime/logging/backup/plugin-install helper |
|
||||
| `plugin-sdk/runtime-env` | 狭い runtime env、logger、timeout、retry、backoff helper |
|
||||
| `plugin-sdk/runtime` | 広範なランタイム/ロギング/バックアップ/プラグインインストールヘルパー |
|
||||
| `plugin-sdk/runtime-env` | 狭い用途のランタイム env、logger、timeout、retry、および backoff ヘルパー |
|
||||
| `plugin-sdk/runtime-store` | `createPluginRuntimeStore` |
|
||||
| `plugin-sdk/plugin-runtime` | 共有 plugin command/hook/http/interactive helper |
|
||||
| `plugin-sdk/hook-runtime` | 共有 webhook/internal hook pipeline helper |
|
||||
| `plugin-sdk/lazy-runtime` | `createLazyRuntimeModule`, `createLazyRuntimeMethod`, `createLazyRuntimeSurface` のような lazy runtime import/binding helper |
|
||||
| `plugin-sdk/process-runtime` | process exec helper |
|
||||
| `plugin-sdk/cli-runtime` | CLI formatting、wait、version helper |
|
||||
| `plugin-sdk/gateway-runtime` | Gateway client と channel-status patch helper |
|
||||
| `plugin-sdk/config-runtime` | 設定 load/write helper |
|
||||
| `plugin-sdk/telegram-command-config` | バンドル Telegram 契約 surface が利用できない場合でも、Telegram command-name/description の正規化と重複/競合チェック |
|
||||
| `plugin-sdk/approval-runtime` | exec/plugin approval helper、approval-capability builder、auth/profile helper、ネイティブルーティング/runtime helper |
|
||||
| `plugin-sdk/reply-runtime` | 共有 inbound/reply runtime helper、chunking、dispatch、heartbeat、reply planner |
|
||||
| `plugin-sdk/reply-dispatch-runtime` | 狭い reply dispatch/finalize helper |
|
||||
| `plugin-sdk/reply-history` | `buildHistoryContext`, `recordPendingHistoryEntry`, `clearHistoryEntriesIfEnabled` などの共有 short-window reply-history helper |
|
||||
| `plugin-sdk/plugin-runtime` | 共有のプラグイン command/hook/http/interactive ヘルパー |
|
||||
| `plugin-sdk/hook-runtime` | 共有の webhook/internal hook パイプラインヘルパー |
|
||||
| `plugin-sdk/lazy-runtime` | `createLazyRuntimeModule`, `createLazyRuntimeMethod`, `createLazyRuntimeSurface` のような遅延ランタイム import/binding ヘルパー |
|
||||
| `plugin-sdk/process-runtime` | プロセス実行ヘルパー |
|
||||
| `plugin-sdk/cli-runtime` | CLI整形、待機、およびバージョンヘルパー |
|
||||
| `plugin-sdk/gateway-runtime` | Gatewayクライアントおよびチャンネルステータスパッチヘルパー |
|
||||
| `plugin-sdk/config-runtime` | 設定の読み込み/書き込みヘルパー |
|
||||
| `plugin-sdk/telegram-command-config` | バンドルされたTelegramコントラクトサーフェスが利用できない場合でも、Telegramコマンド名/説明の正規化と重複/競合チェックを行う |
|
||||
| `plugin-sdk/approval-runtime` | exec/plugin 承認ヘルパー、approval-capability ビルダー、auth/profile ヘルパー、ネイティブルーティング/ランタイムヘルパー |
|
||||
| `plugin-sdk/reply-runtime` | 共有の受信/返信ランタイムヘルパー、チャンク化、ディスパッチ、heartbeat、返信プランナー |
|
||||
| `plugin-sdk/reply-dispatch-runtime` | 狭い用途の返信ディスパッチ/完了ヘルパー |
|
||||
| `plugin-sdk/reply-history` | `buildHistoryContext`, `recordPendingHistoryEntry`, `clearHistoryEntriesIfEnabled` のような共有の短時間ウィンドウ reply-history ヘルパー |
|
||||
| `plugin-sdk/reply-reference` | `createReplyReferencePlanner` |
|
||||
| `plugin-sdk/reply-chunking` | 狭い text/markdown chunking helper |
|
||||
| `plugin-sdk/session-store-runtime` | session store path + updated-at helper |
|
||||
| `plugin-sdk/state-paths` | state/OAuth dir path helper |
|
||||
| `plugin-sdk/routing` | `resolveAgentRoute`, `buildAgentSessionKey`, `resolveDefaultAgentBoundAccountId` などの route/session-key/account binding helper |
|
||||
| `plugin-sdk/status-helpers` | 共有 channel/account status summary helper、runtime-state defaults、issue metadata helper |
|
||||
| `plugin-sdk/target-resolver-runtime` | 共有 target resolver helper |
|
||||
| `plugin-sdk/string-normalization-runtime` | slug/string 正規化 helper |
|
||||
| `plugin-sdk/request-url` | fetch/request 風 input から文字列 URL を抽出 |
|
||||
| `plugin-sdk/run-command` | 正規化された stdout/stderr result を返す timed command runner |
|
||||
| `plugin-sdk/param-readers` | 共通 tool/CLI param reader |
|
||||
| `plugin-sdk/tool-send` | tool args から正規の send target field を抽出 |
|
||||
| `plugin-sdk/temp-path` | 共有 temp-download path helper |
|
||||
| `plugin-sdk/logging-core` | subsystem logger と redaction helper |
|
||||
| `plugin-sdk/markdown-table-runtime` | Markdown table mode helper |
|
||||
| `plugin-sdk/json-store` | 小規模 JSON state 読み書き helper |
|
||||
| `plugin-sdk/file-lock` | 再入可能な file-lock helper |
|
||||
| `plugin-sdk/persistent-dedupe` | ディスクバックの dedupe cache helper |
|
||||
| `plugin-sdk/acp-runtime` | ACP runtime/session と reply-dispatch helper |
|
||||
| `plugin-sdk/agent-config-primitives` | 狭い agent runtime config-schema primitives |
|
||||
| `plugin-sdk/boolean-param` | 緩い boolean param reader |
|
||||
| `plugin-sdk/dangerous-name-runtime` | dangerous-name 一致解決 helper |
|
||||
| `plugin-sdk/device-bootstrap` | デバイス bootstrap と pairing token helper |
|
||||
| `plugin-sdk/extension-shared` | 共有 passive-channel と status helper primitives |
|
||||
| `plugin-sdk/models-provider-runtime` | `/models` command/provider reply helper |
|
||||
| `plugin-sdk/skill-commands-runtime` | skill command 一覧 helper |
|
||||
| `plugin-sdk/native-command-registry` | ネイティブ command registry/build/serialize helper |
|
||||
| `plugin-sdk/provider-zai-endpoint` | Z.A.I endpoint 検出 helper |
|
||||
| `plugin-sdk/infra-runtime` | system event/heartbeat helper |
|
||||
| `plugin-sdk/collection-runtime` | 小規模な上限付き cache helper |
|
||||
| `plugin-sdk/diagnostic-runtime` | diagnostic flag と event helper |
|
||||
| `plugin-sdk/error-runtime` | error graph、formatting、共有 error 分類 helper、`isApprovalNotFoundError` |
|
||||
| `plugin-sdk/fetch-runtime` | wrapped fetch、proxy、pinned lookup helper |
|
||||
| `plugin-sdk/host-runtime` | ホスト名と SCP ホスト正規化 helper |
|
||||
| `plugin-sdk/retry-runtime` | retry 設定と retry runner helper |
|
||||
| `plugin-sdk/agent-runtime` | agent dir/identity/workspace helper |
|
||||
| `plugin-sdk/directory-runtime` | 設定ベース directory query/dedup |
|
||||
| `plugin-sdk/reply-chunking` | 狭い用途のテキスト/markdown チャンク化ヘルパー |
|
||||
| `plugin-sdk/session-store-runtime` | セッションストアのパス + updated-at ヘルパー |
|
||||
| `plugin-sdk/state-paths` | State/OAuth ディレクトリパスヘルパー |
|
||||
| `plugin-sdk/routing` | `resolveAgentRoute`, `buildAgentSessionKey`, `resolveDefaultAgentBoundAccountId` のようなルート/session-key/account binding ヘルパー |
|
||||
| `plugin-sdk/status-helpers` | 共有のチャンネル/アカウントステータスサマリーヘルパー、runtime-state デフォルト、および issue メタデータヘルパー |
|
||||
| `plugin-sdk/target-resolver-runtime` | 共有ターゲットリゾルバーヘルパー |
|
||||
| `plugin-sdk/string-normalization-runtime` | Slug/文字列正規化ヘルパー |
|
||||
| `plugin-sdk/request-url` | fetch/request 風入力から文字列URLを抽出 |
|
||||
| `plugin-sdk/run-command` | 正規化された stdout/stderr 結果を伴う時間制限付きコマンドランナー |
|
||||
| `plugin-sdk/param-readers` | 共通の tool/CLI パラメーターリーダー |
|
||||
| `plugin-sdk/tool-send` | ツール引数から正規の送信ターゲットフィールドを抽出 |
|
||||
| `plugin-sdk/temp-path` | 共有の一時ダウンロードパスヘルパー |
|
||||
| `plugin-sdk/logging-core` | サブシステム logger とリダクションヘルパー |
|
||||
| `plugin-sdk/markdown-table-runtime` | Markdownテーブルモードヘルパー |
|
||||
| `plugin-sdk/json-store` | 小規模JSON state の読み書きヘルパー |
|
||||
| `plugin-sdk/file-lock` | 再入可能 file-lock ヘルパー |
|
||||
| `plugin-sdk/persistent-dedupe` | ディスクバックアップ付き dedupe cache ヘルパー |
|
||||
| `plugin-sdk/acp-runtime` | ACP runtime/session および reply-dispatch ヘルパー |
|
||||
| `plugin-sdk/agent-config-primitives` | 狭い用途のエージェントランタイム設定スキーマプリミティブ |
|
||||
| `plugin-sdk/boolean-param` | 緩い boolean パラメーターリーダー |
|
||||
| `plugin-sdk/dangerous-name-runtime` | 危険な名前の照合解決ヘルパー |
|
||||
| `plugin-sdk/device-bootstrap` | デバイスbootstrap およびペアリングトークンヘルパー |
|
||||
| `plugin-sdk/extension-shared` | 共有の passive-channel および status ヘルパープリミティブ |
|
||||
| `plugin-sdk/models-provider-runtime` | `/models` コマンド/プロバイダー返信ヘルパー |
|
||||
| `plugin-sdk/skill-commands-runtime` | Skills コマンド一覧ヘルパー |
|
||||
| `plugin-sdk/native-command-registry` | ネイティブコマンドレジストリの build/serialize ヘルパー |
|
||||
| `plugin-sdk/provider-zai-endpoint` | Z.AI endpoint 検出ヘルパー |
|
||||
| `plugin-sdk/infra-runtime` | システムイベント/heartbeat ヘルパー |
|
||||
| `plugin-sdk/collection-runtime` | 小規模の有界 cache ヘルパー |
|
||||
| `plugin-sdk/diagnostic-runtime` | 診断フラグおよびイベントヘルパー |
|
||||
| `plugin-sdk/error-runtime` | エラーグラフ、整形、共有エラー分類ヘルパー、`isApprovalNotFoundError` |
|
||||
| `plugin-sdk/fetch-runtime` | ラップされた fetch、proxy、および pinned lookup ヘルパー |
|
||||
| `plugin-sdk/host-runtime` | ホスト名およびSCPホスト正規化ヘルパー |
|
||||
| `plugin-sdk/retry-runtime` | retry 設定および retry ランナーヘルパー |
|
||||
| `plugin-sdk/agent-runtime` | エージェントディレクトリ/アイデンティティ/workspace ヘルパー |
|
||||
| `plugin-sdk/directory-runtime` | 設定に基づくディレクトリ照会/dedup |
|
||||
| `plugin-sdk/keyed-async-queue` | `KeyedAsyncQueue` |
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Capability とテストの subpaths">
|
||||
| Subpath | 主な export |
|
||||
<Accordion title="機能とテストのサブパス">
|
||||
| サブパス | 主なエクスポート |
|
||||
| --- | --- |
|
||||
| `plugin-sdk/media-runtime` | 共有 media fetch/transform/store helper と media payload builder |
|
||||
| `plugin-sdk/media-understanding` | media understanding provider 型と provider 向け image/audio helper export |
|
||||
| `plugin-sdk/text-runtime` | assistant-visible-text の除去、markdown render/chunking/table helper、redaction helper、directive-tag helper、安全な text utility などの共有 text/markdown/logging helper |
|
||||
| `plugin-sdk/text-chunking` | outbound text chunking helper |
|
||||
| `plugin-sdk/speech` | speech provider 型と provider 向け directive、registry、validation helper |
|
||||
| `plugin-sdk/speech-core` | 共有 speech provider 型、registry、directive、正規化 helper |
|
||||
| `plugin-sdk/realtime-transcription` | realtime transcription provider 型と registry helper |
|
||||
| `plugin-sdk/realtime-voice` | realtime voice provider 型と registry helper |
|
||||
| `plugin-sdk/image-generation` | image generation provider 型 |
|
||||
| `plugin-sdk/image-generation-core` | 共有 image-generation 型、failover、auth、registry helper |
|
||||
| `plugin-sdk/music-generation` | music generation provider/request/result 型 |
|
||||
| `plugin-sdk/music-generation-core` | 共有 music-generation 型、failover helper、provider lookup、model-ref 解析 |
|
||||
| `plugin-sdk/video-generation` | video generation provider/request/result 型 |
|
||||
| `plugin-sdk/video-generation-core` | 共有 video-generation 型、failover helper、provider lookup、model-ref 解析 |
|
||||
| `plugin-sdk/webhook-targets` | webhook target registry と route-install helper |
|
||||
| `plugin-sdk/webhook-path` | webhook path 正規化 helper |
|
||||
| `plugin-sdk/web-media` | 共有 remote/local media 読み込み helper |
|
||||
| `plugin-sdk/zod` | plugin SDK 利用者向けに再 export された `zod` |
|
||||
| `plugin-sdk/media-runtime` | 共有のメディア取得/変換/保存ヘルパーに加え、メディアペイロードビルダー |
|
||||
| `plugin-sdk/media-generation-runtime` | 共有のメディア生成フェイルオーバーヘルパー、候補選択、およびモデル未指定メッセージング |
|
||||
| `plugin-sdk/media-understanding` | Media understanding プロバイダー型に加え、プロバイダー向け画像/音声ヘルパーエクスポート |
|
||||
| `plugin-sdk/text-runtime` | assistant-visible-text の除去、markdown のレンダリング/チャンク化/テーブルヘルパー、リダクションヘルパー、directive-tag ヘルパー、安全なテキストユーティリティなどの共有テキスト/markdown/ロギングヘルパー |
|
||||
| `plugin-sdk/text-chunking` | 送信テキストチャンク化ヘルパー |
|
||||
| `plugin-sdk/speech` | 音声プロバイダー型に加え、プロバイダー向け directive、registry、および検証ヘルパー |
|
||||
| `plugin-sdk/speech-core` | 共有の音声プロバイダー型、registry、directive、および正規化ヘルパー |
|
||||
| `plugin-sdk/realtime-transcription` | リアルタイム文字起こしプロバイダー型およびレジストリヘルパー |
|
||||
| `plugin-sdk/realtime-voice` | リアルタイム音声プロバイダー型およびレジストリヘルパー |
|
||||
| `plugin-sdk/image-generation` | 画像生成プロバイダー型 |
|
||||
| `plugin-sdk/image-generation-core` | 共有の画像生成型、フェイルオーバー、認証、およびレジストリヘルパー |
|
||||
| `plugin-sdk/music-generation` | 音楽生成プロバイダー/リクエスト/結果型 |
|
||||
| `plugin-sdk/music-generation-core` | 共有の音楽生成型、フェイルオーバーヘルパー、プロバイダー検索、および model-ref 解析 |
|
||||
| `plugin-sdk/video-generation` | 動画生成プロバイダー/リクエスト/結果型 |
|
||||
| `plugin-sdk/video-generation-core` | 共有の動画生成型、フェイルオーバーヘルパー、プロバイダー検索、および model-ref 解析 |
|
||||
| `plugin-sdk/webhook-targets` | Webhookターゲットレジストリおよび route-install ヘルパー |
|
||||
| `plugin-sdk/webhook-path` | Webhookパス正規化ヘルパー |
|
||||
| `plugin-sdk/web-media` | 共有のリモート/ローカルメディア読み込みヘルパー |
|
||||
| `plugin-sdk/zod` | プラグインSDK利用者向けに再エクスポートされた `zod` |
|
||||
| `plugin-sdk/testing` | `installCommonResolveTargetErrorCases`, `shouldAckReaction` |
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Memory subpaths">
|
||||
| Subpath | 主な export |
|
||||
<Accordion title="メモリサブパス">
|
||||
| サブパス | 主なエクスポート |
|
||||
| --- | --- |
|
||||
| `plugin-sdk/memory-core` | manager/config/file/CLI helper 向けバンドル memory-core helper surface |
|
||||
| `plugin-sdk/memory-core-engine-runtime` | memory index/search runtime facade |
|
||||
| `plugin-sdk/memory-core-host-engine-foundation` | memory host foundation engine export |
|
||||
| `plugin-sdk/memory-core-host-engine-embeddings` | memory host embedding engine export |
|
||||
| `plugin-sdk/memory-core-host-engine-qmd` | memory host QMD engine export |
|
||||
| `plugin-sdk/memory-core-host-engine-storage` | memory host storage engine export |
|
||||
| `plugin-sdk/memory-core-host-multimodal` | memory host multimodal helper |
|
||||
| `plugin-sdk/memory-core-host-query` | memory host query helper |
|
||||
| `plugin-sdk/memory-core-host-secret` | memory host secret helper |
|
||||
| `plugin-sdk/memory-core-host-status` | memory host status helper |
|
||||
| `plugin-sdk/memory-core-host-runtime-cli` | memory host CLI runtime helper |
|
||||
| `plugin-sdk/memory-core-host-runtime-core` | memory host core runtime helper |
|
||||
| `plugin-sdk/memory-core-host-runtime-files` | memory host file/runtime helper |
|
||||
| `plugin-sdk/memory-lancedb` | バンドル memory-lancedb helper surface |
|
||||
| `plugin-sdk/memory-core` | manager/config/file/CLI ヘルパー用のバンドルされた memory-core ヘルパーサーフェス |
|
||||
| `plugin-sdk/memory-core-engine-runtime` | メモリインデックス/検索ランタイムファサード |
|
||||
| `plugin-sdk/memory-core-host-engine-foundation` | メモリホスト foundation engine エクスポート |
|
||||
| `plugin-sdk/memory-core-host-engine-embeddings` | メモリホスト embedding engine エクスポート |
|
||||
| `plugin-sdk/memory-core-host-engine-qmd` | メモリホスト QMD engine エクスポート |
|
||||
| `plugin-sdk/memory-core-host-engine-storage` | メモリホスト storage engine エクスポート |
|
||||
| `plugin-sdk/memory-core-host-multimodal` | メモリホスト multimodal ヘルパー |
|
||||
| `plugin-sdk/memory-core-host-query` | メモリホスト query ヘルパー |
|
||||
| `plugin-sdk/memory-core-host-secret` | メモリホスト secret ヘルパー |
|
||||
| `plugin-sdk/memory-core-host-events` | メモリホスト event journal ヘルパー |
|
||||
| `plugin-sdk/memory-core-host-status` | メモリホスト status ヘルパー |
|
||||
| `plugin-sdk/memory-core-host-runtime-cli` | メモリホスト CLI ランタイムヘルパー |
|
||||
| `plugin-sdk/memory-core-host-runtime-core` | メモリホスト core ランタイムヘルパー |
|
||||
| `plugin-sdk/memory-core-host-runtime-files` | メモリホスト file/runtime ヘルパー |
|
||||
| `plugin-sdk/memory-host-core` | メモリホスト core ランタイムヘルパーのベンダー中立エイリアス |
|
||||
| `plugin-sdk/memory-host-events` | メモリホスト event journal ヘルパーのベンダー中立エイリアス |
|
||||
| `plugin-sdk/memory-host-files` | メモリホスト file/runtime ヘルパーのベンダー中立エイリアス |
|
||||
| `plugin-sdk/memory-host-markdown` | メモリ周辺プラグイン向けの共有 managed-markdown ヘルパー |
|
||||
| `plugin-sdk/memory-host-search` | search-manager アクセス用のアクティブメモリランタイムファサード |
|
||||
| `plugin-sdk/memory-host-status` | メモリホスト status ヘルパーのベンダー中立エイリアス |
|
||||
| `plugin-sdk/memory-lancedb` | バンドルされた memory-lancedb ヘルパーサーフェス |
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="予約済みバンドル helper subpaths">
|
||||
| Family | 現在の subpaths | 想定用途 |
|
||||
<Accordion title="予約済みバンドルヘルパーサブパス">
|
||||
| ファミリー | 現在のサブパス | 想定用途 |
|
||||
| --- | --- | --- |
|
||||
| Browser | `plugin-sdk/browser-cdp`, `plugin-sdk/browser-config-runtime`, `plugin-sdk/browser-config-support`, `plugin-sdk/browser-control-auth`, `plugin-sdk/browser-node-runtime`, `plugin-sdk/browser-profiles`, `plugin-sdk/browser-security-runtime`, `plugin-sdk/browser-setup-tools`, `plugin-sdk/browser-support` | バンドル browser plugin サポート helper(`browser-support` は互換性 barrel のままです) |
|
||||
| Matrix | `plugin-sdk/matrix`, `plugin-sdk/matrix-helper`, `plugin-sdk/matrix-runtime-heavy`, `plugin-sdk/matrix-runtime-shared`, `plugin-sdk/matrix-runtime-surface`, `plugin-sdk/matrix-surface`, `plugin-sdk/matrix-thread-bindings` | バンドル Matrix helper/runtime surface |
|
||||
| Line | `plugin-sdk/line`, `plugin-sdk/line-core`, `plugin-sdk/line-runtime`, `plugin-sdk/line-surface` | バンドル LINE helper/runtime surface |
|
||||
| IRC | `plugin-sdk/irc`, `plugin-sdk/irc-surface` | バンドル IRC helper surface |
|
||||
| channel 固有 helper | `plugin-sdk/googlechat`, `plugin-sdk/zalouser`, `plugin-sdk/bluebubbles`, `plugin-sdk/bluebubbles-policy`, `plugin-sdk/mattermost`, `plugin-sdk/mattermost-policy`, `plugin-sdk/feishu-conversation`, `plugin-sdk/msteams`, `plugin-sdk/nextcloud-talk`, `plugin-sdk/nostr`, `plugin-sdk/tlon`, `plugin-sdk/twitch` | バンドル channel の互換性/helper seam |
|
||||
| auth/plugin 固有 helper | `plugin-sdk/github-copilot-login`, `plugin-sdk/github-copilot-token`, `plugin-sdk/diagnostics-otel`, `plugin-sdk/diffs`, `plugin-sdk/llm-task`, `plugin-sdk/thread-ownership`, `plugin-sdk/voice-call` | バンドル機能/plugin helper seam。`plugin-sdk/github-copilot-token` は現在 `DEFAULT_COPILOT_API_BASE_URL`, `deriveCopilotApiBaseUrlFromToken`, `resolveCopilotApiToken` を export します |
|
||||
| Browser | `plugin-sdk/browser-cdp`, `plugin-sdk/browser-config-runtime`, `plugin-sdk/browser-config-support`, `plugin-sdk/browser-control-auth`, `plugin-sdk/browser-node-runtime`, `plugin-sdk/browser-profiles`, `plugin-sdk/browser-security-runtime`, `plugin-sdk/browser-setup-tools`, `plugin-sdk/browser-support` | バンドルされたブラウザプラグイン支援ヘルパー (`browser-support` は互換性バレルのまま) |
|
||||
| Matrix | `plugin-sdk/matrix`, `plugin-sdk/matrix-helper`, `plugin-sdk/matrix-runtime-heavy`, `plugin-sdk/matrix-runtime-shared`, `plugin-sdk/matrix-runtime-surface`, `plugin-sdk/matrix-surface`, `plugin-sdk/matrix-thread-bindings` | バンドルされたMatrixヘルパー/ランタイムサーフェス |
|
||||
| Line | `plugin-sdk/line`, `plugin-sdk/line-core`, `plugin-sdk/line-runtime`, `plugin-sdk/line-surface` | バンドルされたLINEヘルパー/ランタイムサーフェス |
|
||||
| IRC | `plugin-sdk/irc`, `plugin-sdk/irc-surface` | バンドルされたIRCヘルパーサーフェス |
|
||||
| チャンネル固有ヘルパー | `plugin-sdk/googlechat`, `plugin-sdk/zalouser`, `plugin-sdk/bluebubbles`, `plugin-sdk/bluebubbles-policy`, `plugin-sdk/mattermost`, `plugin-sdk/mattermost-policy`, `plugin-sdk/feishu-conversation`, `plugin-sdk/msteams`, `plugin-sdk/nextcloud-talk`, `plugin-sdk/nostr`, `plugin-sdk/tlon`, `plugin-sdk/twitch` | バンドルされたチャンネル互換性/ヘルパー境界 |
|
||||
| 認証/プラグイン固有ヘルパー | `plugin-sdk/github-copilot-login`, `plugin-sdk/github-copilot-token`, `plugin-sdk/diagnostics-otel`, `plugin-sdk/diffs`, `plugin-sdk/llm-task`, `plugin-sdk/thread-ownership`, `plugin-sdk/voice-call` | バンドルされた機能/プラグインヘルパー境界; `plugin-sdk/github-copilot-token` は現在 `DEFAULT_COPILOT_API_BASE_URL`, `deriveCopilotApiBaseUrlFromToken`, `resolveCopilotApiToken` をエクスポート |
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
## Registration API
|
||||
## 登録API
|
||||
|
||||
`register(api)` コールバックは、次の method を持つ `OpenClawPluginApi` オブジェクトを受け取ります:
|
||||
`register(api)` コールバックは、以下のメソッドを持つ `OpenClawPluginApi` オブジェクトを受け取ります。
|
||||
|
||||
### Capability の登録
|
||||
### 機能の登録
|
||||
|
||||
| Method | 登録するもの |
|
||||
| ------------------------------------------------ | ------------------------------- |
|
||||
| `api.registerProvider(...)` | text inference(LLM) |
|
||||
| `api.registerChannel(...)` | メッセージング channel |
|
||||
| `api.registerSpeechProvider(...)` | text-to-speech / STT synthesis |
|
||||
| `api.registerRealtimeTranscriptionProvider(...)` | ストリーミング realtime transcription |
|
||||
| `api.registerRealtimeVoiceProvider(...)` | duplex realtime voice sessions |
|
||||
| `api.registerMediaUnderstandingProvider(...)` | 画像/音声/動画の解析 |
|
||||
| `api.registerImageGenerationProvider(...)` | 画像生成 |
|
||||
| `api.registerMusicGenerationProvider(...)` | 音楽生成 |
|
||||
| `api.registerVideoGenerationProvider(...)` | 動画生成 |
|
||||
| `api.registerWebFetchProvider(...)` | Web fetch / スクレイプ provider |
|
||||
| `api.registerWebSearchProvider(...)` | Web search |
|
||||
| メソッド | 登録するもの |
|
||||
| ------------------------------------------------ | ----------------------------- |
|
||||
| `api.registerProvider(...)` | テキスト推論 (LLM) |
|
||||
| `api.registerChannel(...)` | メッセージングチャンネル |
|
||||
| `api.registerSpeechProvider(...)` | 音声合成 / STT synthesis |
|
||||
| `api.registerRealtimeTranscriptionProvider(...)` | ストリーミングのリアルタイム文字起こし |
|
||||
| `api.registerRealtimeVoiceProvider(...)` | 双方向リアルタイム音声セッション |
|
||||
| `api.registerMediaUnderstandingProvider(...)` | 画像/音声/動画の解析 |
|
||||
| `api.registerImageGenerationProvider(...)` | 画像生成 |
|
||||
| `api.registerMusicGenerationProvider(...)` | 音楽生成 |
|
||||
| `api.registerVideoGenerationProvider(...)` | 動画生成 |
|
||||
| `api.registerWebFetchProvider(...)` | Web fetch / scrape プロバイダー |
|
||||
| `api.registerWebSearchProvider(...)` | Web検索 |
|
||||
|
||||
### Tools と commands
|
||||
### ツールとコマンド
|
||||
|
||||
| Method | 登録するもの |
|
||||
| ------------------------------- | ---------------------------------------------- |
|
||||
| `api.registerTool(tool, opts?)` | agent tool(必須、または `{ optional: true }`) |
|
||||
| `api.registerCommand(def)` | カスタム command(LLM を経由しない) |
|
||||
| メソッド | 登録するもの |
|
||||
| ------------------------------- | ------------------------------------------ |
|
||||
| `api.registerTool(tool, opts?)` | エージェントツール(必須、または `{ optional: true }`) |
|
||||
| `api.registerCommand(def)` | カスタムコマンド(LLMをバイパス) |
|
||||
|
||||
### インフラ
|
||||
### インフラストラクチャ
|
||||
|
||||
| Method | 登録するもの |
|
||||
| ---------------------------------------------- | --------------------- |
|
||||
| `api.registerHook(events, handler, opts?)` | event hook |
|
||||
| `api.registerHttpRoute(params)` | Gateway HTTP endpoint |
|
||||
| `api.registerGatewayMethod(name, handler)` | Gateway RPC method |
|
||||
| `api.registerCli(registrar, opts?)` | CLI subcommand |
|
||||
| `api.registerService(service)` | バックグラウンド service |
|
||||
| `api.registerInteractiveHandler(registration)` | インタラクティブ handler |
|
||||
| メソッド | 登録するもの |
|
||||
| ---------------------------------------------- | ---------------------------------------- |
|
||||
| `api.registerHook(events, handler, opts?)` | イベントフック |
|
||||
| `api.registerHttpRoute(params)` | Gateway HTTPエンドポイント |
|
||||
| `api.registerGatewayMethod(name, handler)` | Gateway RPCメソッド |
|
||||
| `api.registerCli(registrar, opts?)` | CLIサブコマンド |
|
||||
| `api.registerService(service)` | バックグラウンドサービス |
|
||||
| `api.registerInteractiveHandler(registration)` | 対話型ハンドラー |
|
||||
| `api.registerMemoryPromptSupplement(builder)` | 加算的なメモリ隣接プロンプトセクション |
|
||||
| `api.registerMemoryCorpusSupplement(adapter)` | 加算的なメモリ検索/読み取りコーパス |
|
||||
|
||||
予約済みコア管理 namespace(`config.*`, `exec.approvals.*`, `wizard.*`,
|
||||
`update.*`)は、plugin がより狭い gateway method scope を割り当てようとしても、
|
||||
常に `operator.admin` のままです。plugin 所有の method には
|
||||
plugin 固有の prefix を優先してください。
|
||||
予約済みのコア管理名前空間(`config.*`, `exec.approvals.*`, `wizard.*`,
|
||||
`update.*`)は、プラグインがより狭いGatewayメソッドスコープを割り当てようとしても、
|
||||
常に `operator.admin` のままです。プラグイン所有メソッドには、
|
||||
プラグイン固有のプレフィックスを使ってください。
|
||||
|
||||
### CLI 登録メタデータ
|
||||
### CLI登録メタデータ
|
||||
|
||||
`api.registerCli(registrar, opts?)` は 2 種類のトップレベルメタデータを受け取ります:
|
||||
`api.registerCli(registrar, opts?)` は、2種類のトップレベルメタデータを受け付けます。
|
||||
|
||||
- `commands`: registrar が所有する明示的な command root
|
||||
- `descriptors`: ルート CLI ヘルプ、ルーティング、遅延 plugin CLI 登録に使う parse-time command descriptor
|
||||
- `commands`: registrar が所有する明示的なコマンドルート
|
||||
- `descriptors`: ルートCLIヘルプ、ルーティング、および遅延プラグインCLI登録に使われる
|
||||
解析時コマンドディスクリプター
|
||||
|
||||
plugin command を通常のルート CLI パスで遅延ロードのまま保ちたい場合は、
|
||||
その registrar が公開するすべてのトップレベル command root をカバーする
|
||||
プラグインコマンドを通常のルートCLIパスで遅延ロードのままにしたい場合は、
|
||||
その registrar が公開するすべてのトップレベルコマンドルートをカバーする
|
||||
`descriptors` を指定してください。
|
||||
|
||||
```typescript
|
||||
@ -343,7 +355,7 @@ api.registerCli(
|
||||
descriptors: [
|
||||
{
|
||||
name: "matrix",
|
||||
description: "Manage Matrix accounts, verification, devices, and profile state",
|
||||
description: "Matrixアカウント、検証、デバイス、およびプロファイル状態を管理します",
|
||||
hasSubcommands: true,
|
||||
},
|
||||
],
|
||||
@ -351,114 +363,118 @@ api.registerCli(
|
||||
);
|
||||
```
|
||||
|
||||
通常のルート CLI 登録で遅延ロードが不要な場合にのみ、`commands` 単独を使ってください。
|
||||
その eager 互換パスは引き続きサポートされますが、parse-time 遅延ロード用の
|
||||
descriptor ベース placeholder はインストールされません。
|
||||
遅延ルートCLI登録が不要な場合にのみ、`commands` を単独で使用してください。
|
||||
その即時互換パスは引き続きサポートされていますが、解析時の遅延ロード用に
|
||||
descriptor に裏付けられたプレースホルダーはインストールされません。
|
||||
|
||||
### 排他的スロット
|
||||
|
||||
| Method | 登録するもの |
|
||||
| ------------------------------------------ | ------------------------------------- |
|
||||
| `api.registerContextEngine(id, factory)` | context engine(一度に 1 つだけ有効) |
|
||||
| `api.registerMemoryPromptSection(builder)` | memory prompt section builder |
|
||||
| `api.registerMemoryFlushPlan(resolver)` | memory flush plan resolver |
|
||||
| `api.registerMemoryRuntime(runtime)` | memory runtime adapter |
|
||||
| メソッド | 登録するもの |
|
||||
| ------------------------------------------ | ---------------------------------- |
|
||||
| `api.registerContextEngine(id, factory)` | コンテキストエンジン(一度に1つのみアクティブ) |
|
||||
| `api.registerMemoryPromptSection(builder)` | メモリプロンプトセクションビルダー |
|
||||
| `api.registerMemoryFlushPlan(resolver)` | メモリフラッシュプランリゾルバー |
|
||||
| `api.registerMemoryRuntime(runtime)` | メモリランタイムアダプター |
|
||||
|
||||
### Memory 埋め込み adapter
|
||||
### メモリ埋め込みアダプター
|
||||
|
||||
| Method | 登録するもの |
|
||||
| ---------------------------------------------- | --------------------------------------------- |
|
||||
| `api.registerMemoryEmbeddingProvider(adapter)` | アクティブ plugin 用の memory embedding adapter |
|
||||
| メソッド | 登録するもの |
|
||||
| ---------------------------------------------- | ------------------------------------------- |
|
||||
| `api.registerMemoryEmbeddingProvider(adapter)` | アクティブなプラグイン用のメモリ埋め込みアダプター |
|
||||
|
||||
- `registerMemoryPromptSection`, `registerMemoryFlushPlan`,
|
||||
`registerMemoryRuntime` は memory plugins 専用です。
|
||||
- `registerMemoryEmbeddingProvider` により、アクティブな memory plugin は 1 つ以上の embedding adapter id(たとえば `openai`、`gemini`、または plugin 定義のカスタム id)を登録できます。
|
||||
- `registerMemoryPromptSection`, `registerMemoryFlushPlan`, および
|
||||
`registerMemoryRuntime` は、メモリプラグイン専用です。
|
||||
- `registerMemoryEmbeddingProvider` により、アクティブなメモリプラグインは
|
||||
1つ以上の埋め込みアダプターID(たとえば `openai`、`gemini`、または
|
||||
プラグイン定義のカスタムID)を登録できます。
|
||||
- `agents.defaults.memorySearch.provider` や
|
||||
`agents.defaults.memorySearch.fallback` のようなユーザー設定は、
|
||||
それらの登録済み adapter id に対して解決されます。
|
||||
それらの登録済みアダプターIDに対して解決されます。
|
||||
|
||||
### Events とライフサイクル
|
||||
### イベントとライフサイクル
|
||||
|
||||
| Method | 役割 |
|
||||
| -------------------------------------------- | ----------------------------- |
|
||||
| `api.on(hookName, handler, opts?)` | 型付きライフサイクル hook |
|
||||
| `api.onConversationBindingResolved(handler)` | 会話 binding コールバック |
|
||||
| メソッド | 動作内容 |
|
||||
| -------------------------------------------- | ------------------------- |
|
||||
| `api.on(hookName, handler, opts?)` | 型付きライフサイクルフック |
|
||||
| `api.onConversationBindingResolved(handler)` | 会話バインディングコールバック |
|
||||
|
||||
### Hook decision の意味論
|
||||
### フック判定セマンティクス
|
||||
|
||||
- `before_tool_call`: `{ block: true }` を返すと終端になります。いずれかの handler がこれを設定すると、より低優先度の handler はスキップされます。
|
||||
- `before_tool_call`: `{ block: false }` を返すと、上書きではなく未決定(`block` を省略した場合と同じ)として扱われます。
|
||||
- `before_install`: `{ block: true }` を返すと終端になります。いずれかの handler がこれを設定すると、より低優先度の handler はスキップされます。
|
||||
- `before_install`: `{ block: false }` を返すと、上書きではなく未決定(`block` を省略した場合と同じ)として扱われます。
|
||||
- `reply_dispatch`: `{ handled: true, ... }` を返すと終端になります。いずれかの handler が dispatch を引き受けると、より低優先度の handler とデフォルトの model dispatch パスはスキップされます。
|
||||
- `message_sending`: `{ cancel: true }` を返すと終端になります。いずれかの handler がこれを設定すると、より低優先度の handler はスキップされます。
|
||||
- `message_sending`: `{ cancel: false }` を返すと、上書きではなく未決定(`cancel` を省略した場合と同じ)として扱われます。
|
||||
- `before_tool_call`: `{ block: true }` を返すと終端です。いずれかのハンドラーがこれを設定すると、より低優先度のハンドラーはスキップされます。
|
||||
- `before_tool_call`: `{ block: false }` を返しても判定なしとして扱われます(`block` を省略した場合と同じ)であり、上書きではありません。
|
||||
- `before_install`: `{ block: true }` を返すと終端です。いずれかのハンドラーがこれを設定すると、より低優先度のハンドラーはスキップされます。
|
||||
- `before_install`: `{ block: false }` を返しても判定なしとして扱われます(`block` を省略した場合と同じ)であり、上書きではありません。
|
||||
- `reply_dispatch`: `{ handled: true, ... }` を返すと終端です。いずれかのハンドラーがディスパッチを引き受けると、より低優先度のハンドラーとデフォルトのモデルディスパッチパスはスキップされます。
|
||||
- `message_sending`: `{ cancel: true }` を返すと終端です。いずれかのハンドラーがこれを設定すると、より低優先度のハンドラーはスキップされます。
|
||||
- `message_sending`: `{ cancel: false }` を返しても判定なしとして扱われます(`cancel` を省略した場合と同じ)であり、上書きではありません。
|
||||
|
||||
### API オブジェクトのフィールド
|
||||
### APIオブジェクトのフィールド
|
||||
|
||||
| Field | Type | 説明 |
|
||||
| フィールド | 型 | 説明 |
|
||||
| ------------------------ | ------------------------- | ------------------------------------------------------------------------------------------ |
|
||||
| `api.id` | `string` | plugin id |
|
||||
| `api.name` | `string` | 表示名 |
|
||||
| `api.version` | `string?` | plugin バージョン(任意) |
|
||||
| `api.description` | `string?` | plugin 説明(任意) |
|
||||
| `api.source` | `string` | plugin ソースパス |
|
||||
| `api.rootDir` | `string?` | plugin ルートディレクトリ(任意) |
|
||||
| `api.config` | `OpenClawConfig` | 現在の設定スナップショット(利用可能な場合はアクティブなインメモリ runtime snapshot) |
|
||||
| `api.pluginConfig` | `Record<string, unknown>` | `plugins.entries.<id>.config` からの plugin 固有設定 |
|
||||
| `api.runtime` | `PluginRuntime` | [Runtime Helpers](/ja-JP/plugins/sdk-runtime) |
|
||||
| `api.logger` | `PluginLogger` | スコープ付き logger(`debug`, `info`, `warn`, `error`) |
|
||||
| `api.registrationMode` | `PluginRegistrationMode` | 現在の load mode。`"setup-runtime"` は full-entry 前の軽量な起動/setup ウィンドウです |
|
||||
| `api.resolvePath(input)` | `(string) => string` | plugin ルートからの相対パスを解決 |
|
||||
| `api.id` | `string` | プラグインID |
|
||||
| `api.name` | `string` | 表示名 |
|
||||
| `api.version` | `string?` | プラグインバージョン(任意) |
|
||||
| `api.description` | `string?` | プラグインの説明(任意) |
|
||||
| `api.source` | `string` | プラグインのソースパス |
|
||||
| `api.rootDir` | `string?` | プラグインのルートディレクトリ(任意) |
|
||||
| `api.config` | `OpenClawConfig` | 現在の設定スナップショット(利用可能な場合はアクティブなインメモリランタイムスナップショット) |
|
||||
| `api.pluginConfig` | `Record<string, unknown>` | `plugins.entries.<id>.config` から取得したプラグイン固有設定 |
|
||||
| `api.runtime` | `PluginRuntime` | [ランタイムヘルパー](/ja-JP/plugins/sdk-runtime) |
|
||||
| `api.logger` | `PluginLogger` | スコープ付き logger (`debug`, `info`, `warn`, `error`) |
|
||||
| `api.registrationMode` | `PluginRegistrationMode` | 現在のロードモード。`"setup-runtime"` は、軽量なフルエントリ前の起動/セットアップウィンドウです |
|
||||
| `api.resolvePath(input)` | `(string) => string` | プラグインルートからの相対パスを解決 |
|
||||
|
||||
## 内部 module 規約
|
||||
## 内部モジュール規約
|
||||
|
||||
plugin 内では、内部 import にローカル barrel file を使ってください:
|
||||
プラグイン内では、内部インポートにローカルのバレルファイルを使用してください。
|
||||
|
||||
```
|
||||
my-plugin/
|
||||
api.ts # 外部 consumer 向け公開 export
|
||||
runtime-api.ts # 内部専用 runtime export
|
||||
index.ts # plugin entry point
|
||||
setup-entry.ts # 軽量な setup 専用 entry(任意)
|
||||
api.ts # 外部利用者向けの公開エクスポート
|
||||
runtime-api.ts # 内部専用ランタイムエクスポート
|
||||
index.ts # プラグインエントリポイント
|
||||
setup-entry.ts # 軽量のセットアップ専用エントリ(任意)
|
||||
```
|
||||
|
||||
<Warning>
|
||||
本番コードから、自分自身の plugin を `openclaw/plugin-sdk/<your-plugin>`
|
||||
経由で import してはいけません。内部 import は `./api.ts` または
|
||||
`./runtime-api.ts` を通してください。SDK path は外部契約専用です。
|
||||
本番コード内で、自分自身のプラグインを `openclaw/plugin-sdk/<your-plugin>`
|
||||
経由でインポートしてはいけません。内部インポートは `./api.ts` または
|
||||
`./runtime-api.ts` を経由してください。SDKパスは外部コントラクト専用です。
|
||||
</Warning>
|
||||
|
||||
facade 経由で読み込まれるバンドル plugin の公開 surface(`api.ts`, `runtime-api.ts`,
|
||||
`index.ts`, `setup-entry.ts`、および類似の公開 entry file)は、
|
||||
OpenClaw がすでに実行中であればアクティブな runtime config snapshot を優先するようになりました。まだ runtime snapshot が存在しない場合は、
|
||||
ファサード読み込みされたバンドルプラグインの公開サーフェス(`api.ts`、
|
||||
`runtime-api.ts`、`index.ts`、`setup-entry.ts`、および類似の公開エントリファイル)は、
|
||||
OpenClaw がすでに実行中であれば、アクティブなランタイム設定スナップショットを
|
||||
優先するようになりました。まだランタイムスナップショットが存在しない場合は、
|
||||
ディスク上で解決された設定ファイルにフォールバックします。
|
||||
|
||||
provider plugins は、helper が意図的に provider 固有であり、
|
||||
まだ汎用的な SDK subpath に属さない場合、狭い plugin ローカル契約 barrel を公開することもできます。現在のバンドル例: Anthropic provider は、
|
||||
Anthropic の beta-header や `service_tier` ロジックを汎用
|
||||
`plugin-sdk/*` 契約へ昇格させる代わりに、自身の公開 `api.ts` / `contract-api.ts`
|
||||
seam に Claude stream helper を保持しています。
|
||||
プロバイダープラグインは、ヘルパーが意図的にプロバイダー固有であり、まだ汎用SDK
|
||||
サブパスに属さない場合、狭い用途のプラグインローカルなコントラクトバレルを
|
||||
公開することもできます。現在のバンドル例: Anthropicプロバイダーは、
|
||||
Anthropic beta-header と `service_tier` ロジックを汎用の `plugin-sdk/*`
|
||||
コントラクトに昇格させる代わりに、自身の公開 `api.ts` / `contract-api.ts`
|
||||
境界に Claude ストリームヘルパーを保持しています。
|
||||
|
||||
その他の現在のバンドル例:
|
||||
|
||||
- `@openclaw/openai-provider`: `api.ts` は provider builder、
|
||||
default-model helper、および realtime provider builder を export します
|
||||
- `@openclaw/openrouter-provider`: `api.ts` は provider builder と
|
||||
onboarding/config helper を export します
|
||||
- `@openclaw/openai-provider`: `api.ts` はプロバイダービルダー、
|
||||
default-model ヘルパー、およびリアルタイムプロバイダービルダーをエクスポート
|
||||
- `@openclaw/openrouter-provider`: `api.ts` はプロバイダービルダーに加え、
|
||||
オンボーディング/設定ヘルパーをエクスポート
|
||||
|
||||
<Warning>
|
||||
extension の本番コードでは、`openclaw/plugin-sdk/<other-plugin>`
|
||||
import も避けるべきです。helper が本当に共有されるべきなら、2 つの plugin を結合させるのではなく、
|
||||
`openclaw/plugin-sdk/speech`、`.../provider-model-shared`、または
|
||||
その他の capability 指向 surface のような中立な SDK subpath へ昇格させてください。
|
||||
拡張機能の本番コードも、`openclaw/plugin-sdk/<other-plugin>` のインポートを避けるべきです。
|
||||
ヘルパーが本当に共有されるべきものなら、2つのプラグインを結合するのではなく、
|
||||
`openclaw/plugin-sdk/speech`、`.../provider-model-shared`、または他の
|
||||
capability 指向サーフェスのような中立的なSDKサブパスへ昇格させてください。
|
||||
</Warning>
|
||||
|
||||
## 関連
|
||||
|
||||
- [Entry Points](/ja-JP/plugins/sdk-entrypoints) — `definePluginEntry` と `defineChannelPluginEntry` のオプション
|
||||
- [Runtime Helpers](/ja-JP/plugins/sdk-runtime) — `api.runtime` namespace 全体のリファレンス
|
||||
- [Setup and Config](/ja-JP/plugins/sdk-setup) — パッケージング、manifest、設定スキーマ
|
||||
- [Testing](/ja-JP/plugins/sdk-testing) — テストユーティリティと lint ルール
|
||||
- [SDK Migration](/ja-JP/plugins/sdk-migration) — 非推奨 surface からの移行
|
||||
- [Plugin Internals](/ja-JP/plugins/architecture) — 詳細なアーキテクチャと capability モデル
|
||||
- [Runtime Helpers](/ja-JP/plugins/sdk-runtime) — `api.runtime` 名前空間の完全なリファレンス
|
||||
- [Setup and Config](/ja-JP/plugins/sdk-setup) — パッケージ化、マニフェスト、設定スキーマ
|
||||
- [Testing](/ja-JP/plugins/sdk-testing) — テストユーティリティとlintルール
|
||||
- [SDK Migration](/ja-JP/plugins/sdk-migration) — 非推奨サーフェスからの移行
|
||||
- [Plugin Internals](/ja-JP/plugins/architecture) — 詳細なアーキテクチャと機能モデル
|
||||
|
||||
@ -1,31 +1,31 @@
|
||||
---
|
||||
read_when:
|
||||
- エージェント経由で画像を生成するとき
|
||||
- 画像生成providerとmodelを設定するとき
|
||||
- image_generate toolのパラメーターを理解したいとき
|
||||
summary: 設定済みprovider(OpenAI、Google Gemini、fal、MiniMax、ComfyUI、Vydra)を使って画像を生成・編集する
|
||||
- エージェント経由で画像を生成する場合
|
||||
- 画像生成プロバイダーとモデルを設定する場合
|
||||
- image_generateツールのパラメーターを理解する場合
|
||||
summary: 設定されたプロバイダー(OpenAI、Google Gemini、fal、MiniMax、ComfyUI、Vydra)を使って画像を生成・編集します
|
||||
title: 画像生成
|
||||
x-i18n:
|
||||
generated_at: "2026-04-06T03:13:32Z"
|
||||
generated_at: "2026-04-06T04:43:37Z"
|
||||
model: gpt-5.4
|
||||
provider: openai
|
||||
source_hash: dde416dd1441a06605db85b5813cf61ccfc525813d6db430b7b7dfa53d6a3134
|
||||
source_hash: 903cc522c283a8da2cbd449ae3e25f349a74d00ecfdaf0f323fd8aa3f2107aea
|
||||
source_path: tools/image-generation.md
|
||||
workflow: 15
|
||||
---
|
||||
|
||||
# 画像生成
|
||||
|
||||
`image_generate` toolを使うと、設定済みのproviderを使ってエージェントが画像を生成・編集できます。生成された画像は、エージェントの返信内でメディア添付として自動的に配信されます。
|
||||
`image_generate`ツールを使うと、設定済みのプロバイダーを使用してエージェントが画像を作成・編集できます。生成された画像は、エージェントの返信内でメディア添付として自動的に配信されます。
|
||||
|
||||
<Note>
|
||||
このtoolは、少なくとも1つの画像生成providerが利用可能な場合にのみ表示されます。エージェントのtoolsに `image_generate` が表示されない場合は、`agents.defaults.imageGenerationModel` を設定するか、provider APIキーを設定してください。
|
||||
このツールは、少なくとも1つの画像生成プロバイダーが利用可能な場合にのみ表示されます。エージェントのツールに`image_generate`が表示されない場合は、`agents.defaults.imageGenerationModel`を設定するか、プロバイダーのAPIキーを設定してください。
|
||||
</Note>
|
||||
|
||||
## クイックスタート
|
||||
|
||||
1. 少なくとも1つのproviderにAPIキーを設定します(たとえば `OPENAI_API_KEY` または `GEMINI_API_KEY`)。
|
||||
2. 必要に応じて、優先するmodelを設定します。
|
||||
1. 少なくとも1つのプロバイダーのAPIキーを設定します(例: `OPENAI_API_KEY`または`GEMINI_API_KEY`)。
|
||||
2. 必要に応じて、優先するモデルを設定します。
|
||||
|
||||
```json5
|
||||
{
|
||||
@ -39,47 +39,47 @@ x-i18n:
|
||||
}
|
||||
```
|
||||
|
||||
3. エージェントにこう依頼します: _「親しみやすいロブスターマスコットの画像を生成して。」_
|
||||
3. エージェントに次のように依頼します: _「親しみやすいロブスターのマスコット画像を生成して」_
|
||||
|
||||
エージェントは自動的に `image_generate` を呼び出します。toolの許可リスト設定は不要です。providerが利用可能ならデフォルトで有効になります。
|
||||
エージェントは自動的に`image_generate`を呼び出します。ツールの許可リスト登録は不要です。プロバイダーが利用可能であれば、デフォルトで有効になります。
|
||||
|
||||
## サポートされるprovider
|
||||
## サポートされているプロバイダー
|
||||
|
||||
| Provider | デフォルトmodel | 編集対応 | APIキー |
|
||||
| -------- | ---------------------------------- | -------------------------------- | ----------------------------------------------------- |
|
||||
| OpenAI | `gpt-image-1` | はい(最大5画像) | `OPENAI_API_KEY` |
|
||||
| Google | `gemini-3.1-flash-image-preview` | はい | `GEMINI_API_KEY` または `GOOGLE_API_KEY` |
|
||||
| fal | `fal-ai/flux/dev` | はい | `FAL_KEY` |
|
||||
| MiniMax | `image-01` | はい(被写体参照) | `MINIMAX_API_KEY` または MiniMax OAuth (`minimax-portal`) |
|
||||
| ComfyUI | `workflow` | はい(1画像、workflow設定依存) | クラウドでは `COMFY_API_KEY` または `COMFY_CLOUD_API_KEY` |
|
||||
| Vydra | `grok-imagine` | いいえ | `VYDRA_API_KEY` |
|
||||
| プロバイダー | デフォルトモデル | 編集対応 | APIキー |
|
||||
| ------------ | -------------------------------- | ---------------------------------- | ------------------------------------------------------ |
|
||||
| OpenAI | `gpt-image-1` | はい(最大5画像) | `OPENAI_API_KEY` |
|
||||
| Google | `gemini-3.1-flash-image-preview` | はい | `GEMINI_API_KEY`または`GOOGLE_API_KEY` |
|
||||
| fal | `fal-ai/flux/dev` | はい | `FAL_KEY` |
|
||||
| MiniMax | `image-01` | はい(被写体参照) | `MINIMAX_API_KEY`またはMiniMax OAuth(`minimax-portal`) |
|
||||
| ComfyUI | `workflow` | はい(1画像、ワークフローで設定) | クラウドでは`COMFY_API_KEY`または`COMFY_CLOUD_API_KEY` |
|
||||
| Vydra | `grok-imagine` | いいえ | `VYDRA_API_KEY` |
|
||||
|
||||
実行時に利用可能なproviderとmodelを確認するには、`action: "list"` を使ってください。
|
||||
実行時に利用可能なプロバイダーとモデルを確認するには、`action: "list"`を使用します。
|
||||
|
||||
```
|
||||
/tool image_generate action=list
|
||||
```
|
||||
|
||||
## toolパラメーター
|
||||
## ツールのパラメーター
|
||||
|
||||
| Parameter | Type | 説明 |
|
||||
| ------------- | -------- | ---- |
|
||||
| `prompt` | string | 画像生成プロンプト(`action: "generate"` で必須) |
|
||||
| `action` | string | `"generate"`(デフォルト)またはproviderを確認するための `"list"` |
|
||||
| `model` | string | provider/model の上書き。例: `openai/gpt-image-1` |
|
||||
| `image` | string | 編集モード用の単一参照画像パスまたはURL |
|
||||
| `images` | string[] | 編集モード用の複数参照画像(最大5枚) |
|
||||
| `size` | string | サイズヒント: `1024x1024`, `1536x1024`, `1024x1536`, `1024x1792`, `1792x1024` |
|
||||
| パラメーター | 型 | 説明 |
|
||||
| ------------ | -------- | ------------------------------------------------------------------------------------- |
|
||||
| `prompt` | string | 画像生成プロンプト(`action: "generate"`の場合は必須) |
|
||||
| `action` | string | `"generate"`(デフォルト)または、プロバイダーを確認するための`"list"` |
|
||||
| `model` | string | プロバイダー/モデルの上書き。例: `openai/gpt-image-1` |
|
||||
| `image` | string | 編集モード用の単一の参照画像パスまたはURL |
|
||||
| `images` | string[] | 編集モード用の複数の参照画像(最大5つ) |
|
||||
| `size` | string | サイズ指定: `1024x1024`, `1536x1024`, `1024x1536`, `1024x1792`, `1792x1024` |
|
||||
| `aspectRatio` | string | アスペクト比: `1:1`, `2:3`, `3:2`, `3:4`, `4:3`, `4:5`, `5:4`, `9:16`, `16:9`, `21:9` |
|
||||
| `resolution` | string | 解像度ヒント: `1K`, `2K`, または `4K` |
|
||||
| `count` | number | 生成する画像数(1–4) |
|
||||
| `filename` | string | 出力ファイル名ヒント |
|
||||
| `resolution` | string | 解像度指定: `1K`, `2K`, または`4K` |
|
||||
| `count` | number | 生成する画像数(1〜4) |
|
||||
| `filename` | string | 出力ファイル名のヒント |
|
||||
|
||||
すべてのproviderがすべてのパラメーターをサポートしているわけではありません。toolは各providerがサポートするものだけを渡し、それ以外は無視し、除外された上書き内容をtool結果で報告します。
|
||||
すべてのプロバイダーがすべてのパラメーターをサポートしているわけではありません。このツールは各プロバイダーがサポートする内容を渡し、それ以外は無視し、適用されなかった上書き指定をツール結果で報告します。
|
||||
|
||||
## 設定
|
||||
|
||||
### model選択
|
||||
### モデル選択
|
||||
|
||||
```json5
|
||||
{
|
||||
@ -94,57 +94,61 @@ x-i18n:
|
||||
}
|
||||
```
|
||||
|
||||
### provider選択順序
|
||||
### プロバイダー選択順序
|
||||
|
||||
画像を生成するとき、OpenClawは次の順序でproviderを試します。
|
||||
画像を生成する際、OpenClawは次の順序でプロバイダーを試します。
|
||||
|
||||
1. tool call 内の **`model` パラメーター**(エージェントが指定した場合)
|
||||
2. config内の **`imageGenerationModel.primary`**
|
||||
3. 順番通りの **`imageGenerationModel.fallbacks`**
|
||||
4. **自動検出** — 認証可能なproviderデフォルトのみを使用:
|
||||
- 現在のデフォルトproviderを最初に
|
||||
- 残りの登録済み画像生成providerをprovider-id順で
|
||||
1. ツール呼び出しの**`model`パラメーター**(エージェントが指定した場合)
|
||||
2. 設定内の**`imageGenerationModel.primary`**
|
||||
3. 順番どおりの**`imageGenerationModel.fallbacks`**
|
||||
4. **自動検出** — 認証で利用可能なプロバイダーデフォルトのみを使用:
|
||||
- 現在のデフォルトプロバイダーを先に使用
|
||||
- 残りの登録済み画像生成プロバイダーをprovider-id順で使用
|
||||
|
||||
providerが失敗した場合(認証エラー、レート制限など)、次の候補が自動的に試されます。すべて失敗した場合、エラーには各試行の詳細が含まれます。
|
||||
プロバイダーが失敗した場合(認証エラー、レート制限など)、次の候補が自動的に試されます。すべて失敗した場合、エラーには各試行の詳細が含まれます。
|
||||
|
||||
メモ:
|
||||
注意:
|
||||
|
||||
- 自動検出は認証を考慮します。providerデフォルトが候補リストに入るのは、OpenClawが実際にそのproviderで認証できる場合のみです。
|
||||
- 現在登録されているprovider、デフォルトmodel、および認証用env var のヒントを確認するには、`action: "list"` を使ってください。
|
||||
- 自動検出は認証状態を考慮します。プロバイダーのデフォルトは、
|
||||
OpenClawがそのプロバイダーで実際に認証できる場合にのみ
|
||||
候補リストに入ります。
|
||||
- 現在登録されているプロバイダー、その
|
||||
デフォルトモデル、および認証用env varのヒントを確認するには、
|
||||
`action: "list"`を使用してください。
|
||||
|
||||
### 画像編集
|
||||
|
||||
OpenAI、Google、fal、MiniMax、ComfyUI は参照画像の編集をサポートしています。参照画像パスまたはURLを渡してください。
|
||||
OpenAI、Google、fal、MiniMax、ComfyUIは参照画像の編集をサポートしています。参照画像のパスまたはURLを渡します。
|
||||
|
||||
```
|
||||
「この写真を水彩画風にして」 + image: "/path/to/photo.jpg"
|
||||
"この写真を水彩画風に生成して" + image: "/path/to/photo.jpg"
|
||||
```
|
||||
|
||||
OpenAIとGoogleは `images` パラメーターで最大5枚の参照画像をサポートします。fal、MiniMax、ComfyUI は1枚をサポートします。
|
||||
OpenAIとGoogleは、`images`パラメーターによって最大5つの参照画像をサポートします。fal、MiniMax、ComfyUIは1つをサポートします。
|
||||
|
||||
MiniMax画像生成は、両方のバンドル済みMiniMax認証パスから利用できます。
|
||||
MiniMax画像生成は、バンドルされている両方のMiniMax認証パスで利用できます。
|
||||
|
||||
- APIキーセットアップ用の `minimax/image-01`
|
||||
- OAuthセットアップ用の `minimax-portal/image-01`
|
||||
- APIキー設定用の`minimax/image-01`
|
||||
- OAuth設定用の`minimax-portal/image-01`
|
||||
|
||||
## provider機能
|
||||
## プロバイダーの機能
|
||||
|
||||
| Capability | OpenAI | Google | fal | MiniMax | ComfyUI | Vydra |
|
||||
| --------------------- | ----------------- | ------------------ | ---------------- | ------------------------ | ------------------------------------ | ----- |
|
||||
| 生成 | はい(最大4枚) | はい(最大4枚) | はい(最大4枚) | はい(最大9枚) | はい(workflow定義の出力) | はい(1枚) |
|
||||
| 編集/参照 | はい(最大5画像) | はい(最大5画像) | はい(1画像) | はい(1画像、被写体参照) | はい(1画像、workflow設定依存) | いいえ |
|
||||
| サイズ制御 | はい | はい | はい | いいえ | いいえ | いいえ |
|
||||
| アスペクト比 | いいえ | はい | はい(生成のみ) | はい | いいえ | いいえ |
|
||||
| 解像度(1K/2K/4K) | いいえ | はい | はい | いいえ | いいえ | いいえ |
|
||||
| 機能 | OpenAI | Google | fal | MiniMax | ComfyUI | Vydra |
|
||||
| --------------------- | -------------------- | -------------------- | ------------------- | -------------------------- | ---------------------------------- | ------- |
|
||||
| 生成 | はい(最大4つ) | はい(最大4つ) | はい(最大4つ) | はい(最大9つ) | はい(ワークフロー定義の出力) | はい(1つ) |
|
||||
| 編集/参照 | はい(最大5画像) | はい(最大5画像) | はい(1画像) | はい(1画像、被写体参照) | はい(1画像、ワークフローで設定) | いいえ |
|
||||
| サイズ指定 | はい | はい | はい | いいえ | いいえ | いいえ |
|
||||
| アスペクト比 | いいえ | はい | はい(生成のみ) | はい | いいえ | いいえ |
|
||||
| 解像度(1K/2K/4K) | いいえ | はい | はい | いいえ | いいえ | いいえ |
|
||||
|
||||
## 関連
|
||||
|
||||
- [Tools Overview](/ja-JP/tools) — 利用可能なすべてのエージェントtool
|
||||
- [fal](/providers/fal) — fal画像/動画providerセットアップ
|
||||
- [ComfyUI](/providers/comfy) — ローカルComfyUIおよびComfy Cloud workflowセットアップ
|
||||
- [Google (Gemini)](/ja-JP/providers/google) — Gemini画像providerセットアップ
|
||||
- [MiniMax](/ja-JP/providers/minimax) — MiniMax画像providerセットアップ
|
||||
- [OpenAI](/ja-JP/providers/openai) — OpenAI Images providerセットアップ
|
||||
- [Vydra](/providers/vydra) — Vydra画像、動画、音声セットアップ
|
||||
- [Configuration Reference](/ja-JP/gateway/configuration-reference#agent-defaults) — `imageGenerationModel` config
|
||||
- [Models](/ja-JP/concepts/models) — model設定とフェイルオーバー
|
||||
- [ツール概要](/ja-JP/tools) — 利用可能なすべてのエージェントツール
|
||||
- [fal](/ja-JP/providers/fal) — fal画像・動画プロバイダーの設定
|
||||
- [ComfyUI](/ja-JP/providers/comfy) — ローカルComfyUIとComfy Cloudワークフローの設定
|
||||
- [Google (Gemini)](/ja-JP/providers/google) — Gemini画像プロバイダーの設定
|
||||
- [MiniMax](/ja-JP/providers/minimax) — MiniMax画像プロバイダーの設定
|
||||
- [OpenAI](/ja-JP/providers/openai) — OpenAI Imagesプロバイダーの設定
|
||||
- [Vydra](/ja-JP/providers/vydra) — Vydra画像・動画・音声の設定
|
||||
- [設定リファレンス](/ja-JP/gateway/configuration-reference#agent-defaults) — `imageGenerationModel`設定
|
||||
- [モデル](/ja-JP/concepts/models) — モデル設定とフェイルオーバー
|
||||
|
||||
@ -1,133 +1,133 @@
|
||||
---
|
||||
read_when:
|
||||
- エージェント経由で動画を生成している
|
||||
- 動画生成プロバイダーとモデルを設定している
|
||||
- video_generate ツールのパラメーターを理解している
|
||||
summary: 12個のプロバイダーバックエンドを使って、テキスト、画像、既存動画から動画を生成する
|
||||
- エージェント経由で動画を生成する場合
|
||||
- 動画生成のプロバイダーとモデルを設定する場合
|
||||
- video_generateツールのパラメータを理解する場合
|
||||
summary: 12のプロバイダーバックエンドを使用して、テキスト、画像、または既存の動画から動画を生成します
|
||||
title: 動画生成
|
||||
x-i18n:
|
||||
generated_at: "2026-04-06T03:14:20Z"
|
||||
generated_at: "2026-04-06T04:43:50Z"
|
||||
model: gpt-5.4
|
||||
provider: openai
|
||||
source_hash: 4afec87368232221db1aa5a3980254093d6a961b17271b2dcbf724e6bd455b16
|
||||
source_hash: 90d8a392b35adbd899232b02c55c10895b9d7ffc9858d6ca448f2e4e4a57f12f
|
||||
source_path: tools/video-generation.md
|
||||
workflow: 15
|
||||
---
|
||||
|
||||
# 動画生成
|
||||
|
||||
OpenClaw エージェントは、テキストプロンプト、参照画像、または既存動画から動画を生成できます。12個のプロバイダーバックエンドがサポートされており、それぞれ異なるモデルオプション、入力モード、機能セットを持っています。エージェントは、設定と利用可能なAPIキーに基づいて適切なプロバイダーを自動的に選択します。
|
||||
OpenClawエージェントは、テキストプロンプト、参照画像、または既存の動画から動画を生成できます。12のプロバイダーバックエンドに対応しており、それぞれモデルオプション、入力モード、機能セットが異なります。エージェントは、設定と利用可能なAPIキーに基づいて適切なプロバイダーを自動的に選択します。
|
||||
|
||||
<Note>
|
||||
`video_generate` ツールは、少なくとも1つの動画生成プロバイダーが利用可能な場合にのみ表示されます。エージェントツールに表示されない場合は、プロバイダーのAPIキーを設定するか、`agents.defaults.videoGenerationModel` を構成してください。
|
||||
`video_generate`ツールは、少なくとも1つの動画生成プロバイダーが利用可能な場合にのみ表示されます。エージェントツールに表示されない場合は、プロバイダーのAPIキーを設定するか、`agents.defaults.videoGenerationModel`を構成してください。
|
||||
</Note>
|
||||
|
||||
## クイックスタート
|
||||
|
||||
1. サポートされているいずれかのプロバイダーのAPIキーを設定します:
|
||||
1. 対応している任意のプロバイダーのAPIキーを設定します。
|
||||
|
||||
```bash
|
||||
export GEMINI_API_KEY="your-key"
|
||||
```
|
||||
|
||||
2. 必要に応じてデフォルトモデルを固定します:
|
||||
2. 必要に応じてデフォルトモデルを固定します。
|
||||
|
||||
```bash
|
||||
openclaw config set agents.defaults.videoGenerationModel.primary "google/veo-3.1-fast-generate-preview"
|
||||
```
|
||||
|
||||
3. エージェントに依頼します:
|
||||
3. エージェントに依頼します。
|
||||
|
||||
> 夕焼けの中でフレンドリーなロブスターがサーフィンする、5秒のシネマティックな動画を生成して。
|
||||
> 夕暮れの中、フレンドリーなロブスターがサーフィンをしている5秒間のシネマティックな動画を生成して。
|
||||
|
||||
エージェントは自動的に `video_generate` を呼び出します。ツールの allowlist 設定は不要です。
|
||||
エージェントは自動的に`video_generate`を呼び出します。ツールの許可リスト設定は不要です。
|
||||
|
||||
## 動画を生成するときに何が起こるか
|
||||
## 動画を生成するときの動作
|
||||
|
||||
動画生成は非同期です。セッション内でエージェントが `video_generate` を呼び出すと、次のように動作します。
|
||||
動画生成は非同期です。セッション内でエージェントが`video_generate`を呼び出すと、次のように動作します。
|
||||
|
||||
1. OpenClaw はリクエストをプロバイダーに送信し、すぐにタスクIDを返します。
|
||||
2. プロバイダーはバックグラウンドでジョブを処理します(通常はプロバイダーと解像度に応じて30秒から5分)。
|
||||
3. 動画の準備ができると、OpenClaw は同じセッションを内部完了イベントで起こします。
|
||||
4. エージェントは完成した動画を元の会話に投稿します。
|
||||
1. OpenClawがプロバイダーにリクエストを送信し、ただちにタスクIDを返します。
|
||||
2. プロバイダーがバックグラウンドでジョブを処理します(通常はプロバイダーと解像度に応じて30秒から5分)。
|
||||
3. 動画の準備ができると、OpenClawが同じセッションを内部完了イベントで再開します。
|
||||
4. エージェントが完成した動画を元の会話に投稿します。
|
||||
|
||||
ジョブの実行中は、同じセッションで重複する `video_generate` 呼び出しを行っても、新しい生成は開始されず、現在のタスク状態が返されます。CLI から進行状況を確認するには、`openclaw tasks list` または `openclaw tasks show <taskId>` を使用してください。
|
||||
ジョブの実行中に同じセッションで重複した`video_generate`呼び出しを行うと、新しい生成を開始する代わりに現在のタスクステータスが返されます。CLIから進行状況を確認するには、`openclaw tasks list`または`openclaw tasks show <taskId>`を使用します。
|
||||
|
||||
セッションに紐づくエージェント実行の外側では(たとえば直接のツール呼び出しなど)、ツールはインライン生成にフォールバックし、同じターン内で最終的なメディアパスを返します。
|
||||
セッションに紐づいたエージェント実行の外部(たとえば、ツールの直接呼び出し)では、ツールはインライン生成にフォールバックし、同じターンで最終的なメディアパスを返します。
|
||||
|
||||
## サポートされているプロバイダー
|
||||
## 対応プロバイダー
|
||||
|
||||
| Provider | デフォルトモデル | テキスト | 画像参照 | 動画参照 | APIキー |
|
||||
| -------- | ------------------------------- | -------- | ---------------- | ---------------- | ---------------------------------------- |
|
||||
| Alibaba | `wan2.6-t2v` | Yes | Yes(リモートURL) | Yes(リモートURL) | `MODELSTUDIO_API_KEY` |
|
||||
| BytePlus | `seedance-1-0-lite-t2v-250428` | Yes | 画像1枚 | No | `BYTEPLUS_API_KEY` |
|
||||
| ComfyUI | `workflow` | Yes | 画像1枚 | No | `COMFY_API_KEY` または `COMFY_CLOUD_API_KEY` |
|
||||
| fal | `fal-ai/minimax/video-01-live` | Yes | 画像1枚 | No | `FAL_KEY` |
|
||||
| Google | `veo-3.1-fast-generate-preview` | Yes | 画像1枚 | 動画1本 | `GEMINI_API_KEY` |
|
||||
| MiniMax | `MiniMax-Hailuo-2.3` | Yes | 画像1枚 | No | `MINIMAX_API_KEY` |
|
||||
| OpenAI | `sora-2` | Yes | 画像1枚 | 動画1本 | `OPENAI_API_KEY` |
|
||||
| Qwen | `wan2.6-t2v` | Yes | Yes(リモートURL) | Yes(リモートURL) | `QWEN_API_KEY` |
|
||||
| Runway | `gen4.5` | Yes | 画像1枚 | 動画1本 | `RUNWAYML_API_SECRET` |
|
||||
| Together | `Wan-AI/Wan2.2-T2V-A14B` | Yes | 画像1枚 | No | `TOGETHER_API_KEY` |
|
||||
| Vydra | `veo3` | Yes | 画像1枚(`kling`) | No | `VYDRA_API_KEY` |
|
||||
| xAI | `grok-imagine-video` | Yes | 画像1枚 | 動画1本 | `XAI_API_KEY` |
|
||||
| Provider | デフォルトモデル | テキスト | 画像参照 | 動画参照 | APIキー |
|
||||
| -------- | ------------------------------- | ---- | --------------- | --------------- | ---------------------------------------- |
|
||||
| Alibaba | `wan2.6-t2v` | Yes | Yes (リモートURL) | Yes (リモートURL) | `MODELSTUDIO_API_KEY` |
|
||||
| BytePlus | `seedance-1-0-lite-t2v-250428` | Yes | 画像1枚 | No | `BYTEPLUS_API_KEY` |
|
||||
| ComfyUI | `workflow` | Yes | 画像1枚 | No | `COMFY_API_KEY` or `COMFY_CLOUD_API_KEY` |
|
||||
| fal | `fal-ai/minimax/video-01-live` | Yes | 画像1枚 | No | `FAL_KEY` |
|
||||
| Google | `veo-3.1-fast-generate-preview` | Yes | 画像1枚 | 動画1本 | `GEMINI_API_KEY` |
|
||||
| MiniMax | `MiniMax-Hailuo-2.3` | Yes | 画像1枚 | No | `MINIMAX_API_KEY` |
|
||||
| OpenAI | `sora-2` | Yes | 画像1枚 | 動画1本 | `OPENAI_API_KEY` |
|
||||
| Qwen | `wan2.6-t2v` | Yes | Yes (リモートURL) | Yes (リモートURL) | `QWEN_API_KEY` |
|
||||
| Runway | `gen4.5` | Yes | 画像1枚 | 動画1本 | `RUNWAYML_API_SECRET` |
|
||||
| Together | `Wan-AI/Wan2.2-T2V-A14B` | Yes | 画像1枚 | No | `TOGETHER_API_KEY` |
|
||||
| Vydra | `veo3` | Yes | 画像1枚 (`kling`) | No | `VYDRA_API_KEY` |
|
||||
| xAI | `grok-imagine-video` | Yes | 画像1枚 | 動画1本 | `XAI_API_KEY` |
|
||||
|
||||
一部のプロバイダーは、追加または代替のAPIキー環境変数を受け付けます。詳細は各 [provider pages](#related) を参照してください。
|
||||
一部のプロバイダーは、追加または代替のAPIキー環境変数にも対応しています。詳しくは各[プロバイダーページ](#related)を参照してください。
|
||||
|
||||
ランタイム時に利用可能なプロバイダーとモデルを確認するには、`video_generate action=list` を実行してください。
|
||||
実行時に利用可能なプロバイダーとモデルを確認するには、`video_generate action=list`を実行します。
|
||||
|
||||
## ツールパラメーター
|
||||
## ツールパラメータ
|
||||
|
||||
### 必須
|
||||
|
||||
| Parameter | Type | 説明 |
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ------ | ----------------------------------------------------------------------------- |
|
||||
| `prompt` | string | 生成する動画のテキスト説明(`action: "generate"` では必須) |
|
||||
| `prompt` | string | 動画生成のテキスト説明(`action: "generate"`に必須) |
|
||||
|
||||
### コンテンツ入力
|
||||
|
||||
| Parameter | Type | 説明 |
|
||||
| --------- | -------- | ------------------------------------ |
|
||||
| `image` | string | 単一の参照画像(パスまたはURL) |
|
||||
| `images` | string[] | 複数の参照画像(最大5枚) |
|
||||
| `video` | string | 単一の参照動画(パスまたはURL) |
|
||||
| `videos` | string[] | 複数の参照動画(最大4本) |
|
||||
| Parameter | Type | Description |
|
||||
| --------- | -------- | -------------------------------- |
|
||||
| `image` | string | 単一の参照画像(パスまたはURL) |
|
||||
| `images` | string[] | 複数の参照画像(最大5枚) |
|
||||
| `video` | string | 単一の参照動画(パスまたはURL) |
|
||||
| `videos` | string[] | 複数の参照動画(最大4本) |
|
||||
|
||||
### スタイル制御
|
||||
|
||||
| Parameter | Type | 説明 |
|
||||
| ----------------- | ------- | --------------------------------------------------------------------------- |
|
||||
| `aspectRatio` | string | `1:1`, `2:3`, `3:2`, `3:4`, `4:3`, `4:5`, `5:4`, `9:16`, `16:9`, `21:9` |
|
||||
| `resolution` | string | `480P`、`720P`、または `1080P` |
|
||||
| `durationSeconds` | number | 目標の長さ(秒)。最も近いプロバイダー対応値に丸められます |
|
||||
| `size` | string | プロバイダーが対応している場合のサイズヒント |
|
||||
| `audio` | boolean | 対応している場合に生成音声を有効化 |
|
||||
| `watermark` | boolean | 対応している場合にプロバイダーの透かしを切り替え |
|
||||
| Parameter | Type | Description |
|
||||
| ----------------- | ------- | ---------------------------------------------------------------------- |
|
||||
| `aspectRatio` | string | `1:1`, `2:3`, `3:2`, `3:4`, `4:3`, `4:5`, `5:4`, `9:16`, `16:9`, `21:9` |
|
||||
| `resolution` | string | `480P`, `720P`, または `1080P` |
|
||||
| `durationSeconds` | number | 目標の長さ(秒、最も近いプロバイダー対応値に丸められます) |
|
||||
| `size` | string | プロバイダーが対応している場合のサイズ指定 |
|
||||
| `audio` | boolean | 対応している場合に生成音声を有効化 |
|
||||
| `watermark` | boolean | 対応している場合にプロバイダーの透かしを切り替え |
|
||||
|
||||
### 高度な設定
|
||||
|
||||
| Parameter | Type | 説明 |
|
||||
| Parameter | Type | Description |
|
||||
| ---------- | ------ | ----------------------------------------------- |
|
||||
| `action` | string | `"generate"`(デフォルト)、`"status"`、または `"list"` |
|
||||
| `model` | string | プロバイダー/モデルの上書き(例: `runway/gen4.5`) |
|
||||
| `filename` | string | 出力ファイル名のヒント |
|
||||
| `filename` | string | 出力ファイル名のヒント |
|
||||
|
||||
すべてのプロバイダーがすべてのパラメーターに対応しているわけではありません。未対応の上書きはベストエフォートで無視され、その旨がツール結果に警告として報告されます。厳密な機能制限(参照入力が多すぎるなど)は、送信前に失敗します。
|
||||
すべてのプロバイダーがすべてのパラメータに対応しているわけではありません。未対応の上書き指定はベストエフォートで無視され、ツール結果で警告として報告されます。厳密な機能制限(参照入力が多すぎる場合など)は、送信前に失敗します。
|
||||
|
||||
## アクション
|
||||
|
||||
- **generate**(デフォルト) -- 指定したプロンプトと任意の参照入力から動画を生成します。
|
||||
- **status** -- 現在のセッションで実行中の動画タスクの状態を、新しい生成を開始せずに確認します。
|
||||
- **status** -- 現在のセッションで実行中の動画タスクの状態を確認します。新しい生成は開始しません。
|
||||
- **list** -- 利用可能なプロバイダー、モデル、およびその機能を表示します。
|
||||
|
||||
## モデル選択
|
||||
|
||||
動画を生成するとき、OpenClaw は次の順序でモデルを解決します。
|
||||
動画を生成する際、OpenClawは次の順序でモデルを解決します。
|
||||
|
||||
1. **`model` ツールパラメーター** -- エージェントが呼び出し内で指定した場合。
|
||||
2. **`videoGenerationModel.primary`** -- 設定から取得。
|
||||
1. **`model`ツールパラメータ** -- エージェントが呼び出しで指定した場合。
|
||||
2. **`videoGenerationModel.primary`** -- configから。
|
||||
3. **`videoGenerationModel.fallbacks`** -- 順番に試行。
|
||||
4. **自動検出** -- 現在のデフォルトプロバイダーから始め、続いて残りのプロバイダーをアルファベット順で使用します。対象は有効な認証があるプロバイダーです。
|
||||
4. **自動検出** -- 有効な認証があるプロバイダーを使用し、現在のデフォルトプロバイダーから開始し、その後は残りのプロバイダーをアルファベット順で試します。
|
||||
|
||||
プロバイダーが失敗した場合、次の候補が自動的に試されます。すべての候補が失敗した場合、エラーには各試行の詳細が含まれます。
|
||||
|
||||
@ -144,26 +144,26 @@ openclaw config set agents.defaults.videoGenerationModel.primary "google/veo-3.1
|
||||
}
|
||||
```
|
||||
|
||||
## プロバイダーに関する注記
|
||||
## プロバイダーに関する注意
|
||||
|
||||
| Provider | 注記 |
|
||||
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Alibaba | DashScope/Model Studio の非同期エンドポイントを使用します。参照画像と動画はリモートの `http(s)` URL である必要があります。 |
|
||||
| BytePlus | 単一の参照画像のみ対応。 |
|
||||
| ComfyUI | ワークフロー駆動のローカルまたはクラウド実行。設定されたグラフを通じて text-to-video と image-to-video をサポートします。 |
|
||||
| fal | 長時間実行ジョブにはキューベースのフローを使用します。単一の参照画像のみ対応。 |
|
||||
| Google | Gemini/Veo を使用します。画像1枚または動画1本の参照に対応します。 |
|
||||
| MiniMax | 単一の参照画像のみ対応。 |
|
||||
| OpenAI | `size` 上書きのみ転送されます。他のスタイル上書き(`aspectRatio`、`resolution`、`audio`、`watermark`)は無視され、警告が出ます。 |
|
||||
| Qwen | Alibaba と同じ DashScope バックエンドです。参照入力はリモートの `http(s)` URL である必要があり、ローカルファイルは事前に拒否されます。 |
|
||||
| Runway | data URI 経由でローカルファイルをサポートします。video-to-video には `runway/gen4_aleph` が必要です。テキストのみの実行では `16:9` と `9:16` のアスペクト比が公開されます。 |
|
||||
| Together | 単一の参照画像のみ対応。 |
|
||||
| Vydra | 認証が落ちるリダイレクトを避けるため、`https://www.vydra.ai/api/v1` を直接使用します。`veo3` は text-to-video 専用として同梱され、`kling` にはリモート画像URLが必要です。 |
|
||||
| xAI | text-to-video、image-to-video、リモート動画の編集/延長フローをサポートします。 |
|
||||
| Provider | Notes |
|
||||
| -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Alibaba | DashScope/Model Studioの非同期エンドポイントを使用します。参照画像と動画はリモートの`http(s)` URLである必要があります。 |
|
||||
| BytePlus | 参照画像は1枚のみ対応です。 |
|
||||
| ComfyUI | ワークフロー駆動のローカルまたはクラウド実行です。設定されたグラフを通じてテキストから動画、画像から動画に対応します。 |
|
||||
| fal | 長時間実行ジョブにキュー対応フローを使用します。参照画像は1枚のみ対応です。 |
|
||||
| Google | Gemini/Veoを使用します。画像1枚または動画1本の参照に対応します。 |
|
||||
| MiniMax | 参照画像は1枚のみ対応です。 |
|
||||
| OpenAI | 転送されるのは`size`上書きのみです。その他のスタイル上書き(`aspectRatio`、`resolution`、`audio`、`watermark`)は警告付きで無視されます。 |
|
||||
| Qwen | Alibabaと同じDashScopeバックエンドです。参照入力はリモートの`http(s)` URLである必要があり、ローカルファイルは事前に拒否されます。 |
|
||||
| Runway | data URI経由でローカルファイルに対応します。動画から動画への変換には`runway/gen4_aleph`が必要です。テキストのみの実行では`16:9`と`9:16`のアスペクト比が使えます。 |
|
||||
| Together | 参照画像は1枚のみ対応です。 |
|
||||
| Vydra | 認証が失われるリダイレクトを避けるため、`https://www.vydra.ai/api/v1`を直接使用します。`veo3`はテキストから動画専用として含まれており、`kling`にはリモート画像URLが必要です。 |
|
||||
| xAI | テキストから動画、画像から動画、およびリモート動画の編集/延長フローに対応します。 |
|
||||
|
||||
## 設定
|
||||
|
||||
OpenClaw 設定でデフォルトの動画生成モデルを設定します。
|
||||
OpenClaw configでデフォルトの動画生成モデルを設定します。
|
||||
|
||||
```json5
|
||||
{
|
||||
@ -178,7 +178,7 @@ OpenClaw 設定でデフォルトの動画生成モデルを設定します。
|
||||
}
|
||||
```
|
||||
|
||||
またはCLI経由で設定します。
|
||||
またはCLIから設定します。
|
||||
|
||||
```bash
|
||||
openclaw config set agents.defaults.videoGenerationModel.primary "qwen/wan2.6-t2v"
|
||||
@ -186,19 +186,19 @@ openclaw config set agents.defaults.videoGenerationModel.primary "qwen/wan2.6-t2
|
||||
|
||||
## 関連
|
||||
|
||||
- [Tools Overview](/ja-JP/tools)
|
||||
- [Background Tasks](/ja-JP/automation/tasks) -- 非同期動画生成のためのタスク追跡
|
||||
- [Alibaba Model Studio](/providers/alibaba)
|
||||
- [BytePlus](/providers/byteplus)
|
||||
- [ComfyUI](/providers/comfy)
|
||||
- [fal](/providers/fal)
|
||||
- [ツール概要](/ja-JP/tools)
|
||||
- [バックグラウンドタスク](/ja-JP/automation/tasks) -- 非同期動画生成のタスク追跡
|
||||
- [Alibaba Model Studio](/ja-JP/providers/alibaba)
|
||||
- [BytePlus](/ja-JP/concepts/model-providers#byteplus-international)
|
||||
- [ComfyUI](/ja-JP/providers/comfy)
|
||||
- [fal](/ja-JP/providers/fal)
|
||||
- [Google (Gemini)](/ja-JP/providers/google)
|
||||
- [MiniMax](/ja-JP/providers/minimax)
|
||||
- [OpenAI](/ja-JP/providers/openai)
|
||||
- [Qwen](/ja-JP/providers/qwen)
|
||||
- [Runway](/providers/runway)
|
||||
- [Runway](/ja-JP/providers/runway)
|
||||
- [Together AI](/ja-JP/providers/together)
|
||||
- [Vydra](/providers/vydra)
|
||||
- [Vydra](/ja-JP/providers/vydra)
|
||||
- [xAI](/ja-JP/providers/xai)
|
||||
- [Configuration Reference](/ja-JP/gateway/configuration-reference#agent-defaults)
|
||||
- [Models](/ja-JP/concepts/models)
|
||||
- [設定リファレンス](/ja-JP/gateway/configuration-reference#agent-defaults)
|
||||
- [モデル](/ja-JP/concepts/models)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user