chore(i18n): refresh zh-CN translations
This commit is contained in:
parent
5003f1798d
commit
969e06fc81
@ -3,76 +3,78 @@ read_when:
|
||||
- 你看到了 `OPENCLAW_PLUGIN_SDK_COMPAT_DEPRECATED` 警告
|
||||
- 你看到了 `OPENCLAW_EXTENSION_API_DEPRECATED` 警告
|
||||
- 你在 OpenClaw 2026.4.25 之前使用了 `api.registerEmbeddedExtensionFactory`
|
||||
- 你正在将插件更新到现代插件架构
|
||||
- 你维护着一个外部 OpenClaw 插件
|
||||
- 你正在将一个插件更新为现代插件架构
|
||||
- 你维护一个外部 OpenClaw 插件
|
||||
sidebarTitle: Migrate to SDK
|
||||
summary: 从旧版向后兼容层迁移到现代插件 SDK
|
||||
title: 插件 SDK 迁移
|
||||
x-i18n:
|
||||
generated_at: "2026-04-26T09:19:32Z"
|
||||
generated_at: "2026-04-27T10:06:47Z"
|
||||
model: gpt-5.4
|
||||
provider: openai
|
||||
source_hash: ecff17f6be8bcbc310eac24bf53348ec0f7dfc06cc94de5e3a38967031737ccb
|
||||
source_hash: 2daef64eff08343e6c28293dbae02ed8f0641b63420a4717226d0de8a7b3232f
|
||||
source_path: plugins/sdk-migration.md
|
||||
workflow: 15
|
||||
---
|
||||
|
||||
OpenClaw 已从宽泛的向后兼容层迁移到采用聚焦、文档化导入路径的现代插件架构。如果你的插件构建于新架构之前,本指南将帮助你完成迁移。
|
||||
OpenClaw 已从宽泛的向后兼容层迁移到现代插件架构,提供更聚焦且有文档说明的导入方式。如果你的插件是在新架构之前构建的,本指南将帮助你迁移。
|
||||
|
||||
## 正在发生什么变化
|
||||
|
||||
旧版插件系统提供了两个开放范围很大的入口,使插件可以从单一入口点导入所需的任何内容:
|
||||
旧插件系统提供了两个高度开放的接口面,允许插件从单一入口点导入所需的任何内容:
|
||||
|
||||
- **`openclaw/plugin-sdk/compat`** — 一个单一导入入口,会重新导出数十个辅助工具。它最初的引入,是为了在构建新插件架构期间,让旧版基于钩子的插件继续工作。
|
||||
- **`openclaw/extension-api`** — 一个桥接层,让插件可以直接访问宿主端辅助工具,例如嵌入式智能体运行器。
|
||||
- **`api.registerEmbeddedExtensionFactory(...)`** — 一个已移除、仅限 Pi 的内置扩展钩子,可用于观察嵌入式运行器事件,例如 `tool_result`。
|
||||
- **`openclaw/plugin-sdk/compat`** —— 一个单一导入入口,重新导出了数十个辅助工具。它的引入是为了在构建新插件架构期间,让旧的基于钩子的插件继续工作。
|
||||
- **`openclaw/extension-api`** —— 一个桥接层,使插件能够直接访问宿主侧辅助工具,例如嵌入式智能体运行器。
|
||||
- **`api.registerEmbeddedExtensionFactory(...)`** —— 一个已移除的、仅限 Pi 的内置扩展钩子,可用于监听嵌入式运行器事件,例如 `tool_result`。
|
||||
|
||||
这些宽泛的导入入口现已被**弃用**。它们在运行时仍然可用,但新插件不得再使用它们,现有插件也应在下一个主版本移除它们之前完成迁移。仅限 Pi 的嵌入式扩展工厂注册 API 已被移除;请改用工具结果中间件。
|
||||
这些宽泛的导入接口面现已**弃用**。它们在运行时仍然可用,但新插件不得再使用它们,现有插件也应在下一个主要版本移除它们之前完成迁移。仅限 Pi 的嵌入式扩展工厂注册 API 已被移除;请改用工具结果中间件。
|
||||
|
||||
OpenClaw 不会在引入替代方案的同一项变更中,删除或重新解释已文档化的插件行为。破坏性合约变更必须先经过兼容适配器、诊断信息、文档说明以及弃用窗口。这同样适用于 SDK 导入、清单字段、设置 API、钩子和运行时注册行为。
|
||||
OpenClaw 不会在引入替代方案的同一次变更中移除或重新解释已有文档说明的插件行为。破坏性契约变更必须先经过兼容适配器、诊断、文档和弃用窗口。这适用于 SDK 导入、清单字段、设置 API、钩子以及运行时注册行为。
|
||||
|
||||
<Warning>
|
||||
向后兼容层将在未来的主版本中移除。届时,仍从这些入口导入的插件将会中断。
|
||||
仅限 Pi 的嵌入式扩展工厂注册现在已经不再加载。
|
||||
向后兼容层将在未来的主要版本中移除。仍然从这些接口面导入的插件届时将会失效。
|
||||
仅限 Pi 的嵌入式扩展工厂注册现已不再加载。
|
||||
</Warning>
|
||||
|
||||
## 为什么会有这项变更
|
||||
## 为什么会有这些变化
|
||||
|
||||
旧方法会带来一些问题:
|
||||
旧方法会导致一些问题:
|
||||
|
||||
- **启动缓慢** — 导入一个辅助工具会加载数十个无关模块
|
||||
- **循环依赖** — 宽泛的重新导出让导入环更容易出现
|
||||
- **API 表面不清晰** — 无法判断哪些导出是稳定的,哪些属于内部实现
|
||||
- **启动缓慢** —— 导入一个辅助工具会加载数十个无关模块
|
||||
- **循环依赖** —— 宽泛的重新导出使得创建导入循环变得很容易
|
||||
- **API 接口面不清晰** —— 无法分辨哪些导出是稳定的,哪些是内部实现
|
||||
|
||||
现代插件 SDK 修复了这些问题:每个导入路径(`openclaw/plugin-sdk/\<subpath\>`)都是一个小型、独立的模块,具有清晰用途和文档化合约。
|
||||
现代插件 SDK 解决了这些问题:每个导入路径(`openclaw/plugin-sdk/\<subpath\>`)都是一个小型、自包含模块,具有明确用途和文档化契约。
|
||||
|
||||
面向内置渠道的旧版 provider 便捷接缝也已移除。诸如 `openclaw/plugin-sdk/slack`、`openclaw/plugin-sdk/discord`、`openclaw/plugin-sdk/signal`、`openclaw/plugin-sdk/whatsapp`、带渠道品牌的辅助接缝,以及 `openclaw/plugin-sdk/telegram-core` 之类的导入,都是私有 monorepo 快捷方式,而不是稳定的插件合约。请改用更窄、更通用的 SDK 子路径。在内置插件工作区内部,应将 provider 自有辅助工具保留在该插件自己的 `api.ts` 或 `runtime-api.ts` 中。
|
||||
针对内置渠道的旧版 provider 便捷接口也已移除。
|
||||
带有渠道品牌的辅助接口属于私有单仓库快捷方式,而不是稳定的插件契约。请改用更窄、更通用的 SDK 子路径。在内置插件工作区内,请将 provider 自有的辅助工具保留在该插件自己的 `api.ts` 或 `runtime-api.ts` 中。
|
||||
|
||||
当前内置 provider 示例:
|
||||
|
||||
- Anthropic 将 Claude 专用的流辅助工具保留在它自己的 `api.ts` / `contract-api.ts` 接缝中
|
||||
- OpenAI 将 provider 构建器、默认模型辅助工具和 realtime provider 构建器保留在它自己的 `api.ts` 中
|
||||
- OpenRouter 将 provider 构建器以及新手引导 / 配置辅助工具保留在它自己的 `api.ts` 中
|
||||
- Anthropic 将 Claude 专用流辅助工具保留在自己的 `api.ts` / `contract-api.ts` 接口中
|
||||
- OpenAI 将 provider 构建器、默认模型辅助工具以及实时 provider 构建器保留在自己的 `api.ts` 中
|
||||
- OpenRouter 将 provider 构建器以及新手引导/配置辅助工具保留在自己的 `api.ts` 中
|
||||
|
||||
## 兼容性策略
|
||||
|
||||
对于外部插件,兼容性工作遵循以下顺序:
|
||||
|
||||
1. 添加新合约
|
||||
2. 通过兼容适配器保持旧行为继续可用
|
||||
3. 发出诊断信息或警告,明确指出旧路径及其替代方案
|
||||
4. 在测试中覆盖两条路径
|
||||
5. 记录弃用说明和迁移路径
|
||||
6. 仅在已宣布的迁移窗口结束后移除,通常是在主版本中
|
||||
1. 添加新契约
|
||||
2. 通过兼容适配器保留旧行为
|
||||
3. 发出诊断或警告,指出旧路径及替代方案
|
||||
4. 在测试中覆盖这两条路径
|
||||
5. 记录弃用信息和迁移路径
|
||||
6. 仅在已公布的迁移窗口结束后移除,通常是在主要版本中
|
||||
|
||||
如果某个清单字段仍被接受,插件作者就可以继续使用它,直到文档和诊断信息另有说明为止。新代码应优先使用文档化的替代方案,但现有插件不应在普通次版本发布期间被破坏。
|
||||
如果某个清单字段仍被接受,插件作者就可以继续使用它,直到文档和诊断另有说明。新代码应优先使用文档说明的替代方案,但现有插件不应在普通的次要版本中被破坏。
|
||||
|
||||
## 如何迁移
|
||||
|
||||
<Steps>
|
||||
<Step title="将 Pi 工具结果扩展迁移到中间件">
|
||||
内置插件必须将仅限 Pi 的
|
||||
`api.registerEmbeddedExtensionFactory(...)` 工具结果处理器替换为与运行时无关的中间件。
|
||||
`api.registerEmbeddedExtensionFactory(...)` 工具结果处理器替换为
|
||||
运行时无关的中间件。
|
||||
|
||||
```typescript
|
||||
// Pi 和 Codex 运行时动态工具
|
||||
@ -93,7 +95,7 @@ OpenClaw 不会在引入替代方案的同一项变更中,删除或重新解
|
||||
}
|
||||
```
|
||||
|
||||
外部插件不能注册工具结果中间件,因为它可能会在模型看到高信任工具输出之前对其进行重写。
|
||||
外部插件不能注册工具结果中间件,因为它可以在模型看到高信任工具输出之前对其进行改写。
|
||||
|
||||
</Step>
|
||||
|
||||
@ -103,23 +105,30 @@ OpenClaw 不会在引入替代方案的同一项变更中,删除或重新解
|
||||
|
||||
关键变化:
|
||||
|
||||
- 将 `approvalCapability.handler.loadRuntime(...)` 替换为
|
||||
`approvalCapability.nativeRuntime`
|
||||
- 将审批专用的认证 / 交付逻辑从旧版 `plugin.auth` /
|
||||
`plugin.approvals` 线路迁移到 `approvalCapability`
|
||||
- `ChannelPlugin.approvals` 已从公开的渠道插件合约中移除;请将 delivery / native / render 字段迁移到 `approvalCapability`
|
||||
- `plugin.auth` 仅继续用于渠道登录 / 登出流程;其中的审批认证钩子不再被核心读取
|
||||
- 通过 `openclaw/plugin-sdk/channel-runtime-context` 注册渠道自有运行时对象,例如客户端、令牌或 Bolt 应用
|
||||
- 不要从原生审批处理器发送插件自有的改道通知;核心现在根据实际交付结果统一负责“已路由到其他位置”的通知
|
||||
- 将 `channelRuntime` 传入 `createChannelManager(...)` 时,必须提供真实的 `createPluginRuntime().channel` 表面。部分桩实现将被拒绝。
|
||||
- 用 `approvalCapability.nativeRuntime` 替换 `approvalCapability.handler.loadRuntime(...)`
|
||||
- 将审批专用的认证/投递逻辑从旧版 `plugin.auth` /
|
||||
`plugin.approvals` 绑定迁移到 `approvalCapability`
|
||||
- `ChannelPlugin.approvals` 已从公开的渠道插件契约中移除;
|
||||
请将 delivery/native/render 字段迁移到 `approvalCapability`
|
||||
- `plugin.auth` 仍仅用于渠道登录/登出流程;其中的审批认证
|
||||
钩子不再被核心读取
|
||||
- 通过 `openclaw/plugin-sdk/channel-runtime-context`
|
||||
注册渠道自有运行时对象,例如客户端、令牌或 Bolt
|
||||
应用
|
||||
- 不要从原生审批处理器发送插件自有的重定向通知;
|
||||
核心现在根据实际投递结果统一处理“已路由到其他位置”的通知
|
||||
- 当把 `channelRuntime` 传入 `createChannelManager(...)` 时,
|
||||
请提供一个真实的 `createPluginRuntime().channel` 接口。
|
||||
不完整的桩实现会被拒绝。
|
||||
|
||||
当前审批能力布局请参见 `/plugins/sdk-channel-plugins`。
|
||||
有关当前审批能力布局,请参见 `/plugins/sdk-channel-plugins`。
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="审查 Windows 包装器回退行为">
|
||||
如果你的插件使用 `openclaw/plugin-sdk/windows-spawn`,
|
||||
那么现在在 Windows 上无法解析的 `.cmd` / `.bat` 包装器会默认失败关闭,除非你显式传入 `allowShellFallback: true`。
|
||||
那么在 Windows 上,无法解析的 `.cmd`/`.bat` 包装器现在会默认失败关闭,
|
||||
除非你显式传入 `allowShellFallback: true`。
|
||||
|
||||
```typescript
|
||||
// 之前
|
||||
@ -128,18 +137,19 @@ OpenClaw 不会在引入替代方案的同一项变更中,删除或重新解
|
||||
// 之后
|
||||
const program = applyWindowsSpawnProgramPolicy({
|
||||
candidate,
|
||||
// 仅对那些有意接受 shell 中介回退的受信任兼容调用方设置此项。
|
||||
// 仅对受信任的兼容性调用方设置此项,这些调用方是有意
|
||||
// 接受通过 shell 介导的回退行为。
|
||||
allowShellFallback: true,
|
||||
});
|
||||
```
|
||||
|
||||
如果你的调用方并不有意依赖 shell 回退,请不要设置
|
||||
如果你的调用方并非有意依赖 shell 回退,请不要设置
|
||||
`allowShellFallback`,而应改为处理抛出的错误。
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="查找已弃用的导入">
|
||||
在你的插件中搜索任一已弃用入口的导入:
|
||||
在你的插件中搜索是否从任一已弃用接口面导入内容:
|
||||
|
||||
```bash
|
||||
grep -r "plugin-sdk/compat" my-plugin/
|
||||
@ -149,7 +159,7 @@ OpenClaw 不会在引入替代方案的同一项变更中,删除或重新解
|
||||
</Step>
|
||||
|
||||
<Step title="替换为聚焦导入">
|
||||
旧入口中的每个导出都映射到一个特定的现代导入路径:
|
||||
旧接口面的每个导出都映射到一个特定的现代导入路径:
|
||||
|
||||
```typescript
|
||||
// 之前(已弃用的向后兼容层)
|
||||
@ -165,20 +175,20 @@ OpenClaw 不会在引入替代方案的同一项变更中,删除或重新解
|
||||
import { resolveControlCommandGate } from "openclaw/plugin-sdk/command-auth";
|
||||
```
|
||||
|
||||
对于宿主端辅助工具,请使用注入的插件运行时,而不是直接导入:
|
||||
对于宿主侧辅助工具,请使用注入的插件运行时,而不是直接导入:
|
||||
|
||||
```typescript
|
||||
// 之前(已弃用的 extension-api 桥接)
|
||||
// 之前(已弃用的 extension-api 桥接层)
|
||||
import { runEmbeddedPiAgent } from "openclaw/extension-api";
|
||||
const result = await runEmbeddedPiAgent({ sessionId, prompt });
|
||||
|
||||
// 之后(注入式运行时)
|
||||
// 之后(注入的运行时)
|
||||
const result = await api.runtime.agent.runEmbeddedPiAgent({ sessionId, prompt });
|
||||
```
|
||||
|
||||
同样的模式也适用于其他旧版桥接辅助工具:
|
||||
|
||||
| 旧导入 | 现代等价项 |
|
||||
| 旧导入 | 现代等价方式 |
|
||||
| --- | --- |
|
||||
| `resolveAgentDir` | `api.runtime.agent.resolveAgentDir` |
|
||||
| `resolveAgentWorkspaceDir` | `api.runtime.agent.resolveAgentWorkspaceDir` |
|
||||
@ -186,7 +196,7 @@ OpenClaw 不会在引入替代方案的同一项变更中,删除或重新解
|
||||
| `resolveThinkingDefault` | `api.runtime.agent.resolveThinkingDefault` |
|
||||
| `resolveAgentTimeoutMs` | `api.runtime.agent.resolveAgentTimeoutMs` |
|
||||
| `ensureAgentWorkspace` | `api.runtime.agent.ensureAgentWorkspace` |
|
||||
| session store helpers | `api.runtime.agent.session.*` |
|
||||
| 会话存储辅助工具 | `api.runtime.agent.session.*` |
|
||||
|
||||
</Step>
|
||||
|
||||
@ -203,210 +213,213 @@ OpenClaw 不会在引入替代方案的同一项变更中,删除或重新解
|
||||
<Accordion title="常见导入路径表">
|
||||
| 导入路径 | 用途 | 关键导出 |
|
||||
| --- | --- | --- |
|
||||
| `plugin-sdk/plugin-entry` | 规范插件入口辅助工具 | `definePluginEntry` |
|
||||
| `plugin-sdk/core` | 用于渠道入口定义 / 构建器的旧版总括重新导出 | `defineChannelPluginEntry`, `createChatChannelPlugin` |
|
||||
| `plugin-sdk/plugin-entry` | 规范的插件入口辅助工具 | `definePluginEntry` |
|
||||
| `plugin-sdk/core` | 用于渠道入口定义/构建器的旧版聚合重新导出 | `defineChannelPluginEntry`, `createChatChannelPlugin` |
|
||||
| `plugin-sdk/config-schema` | 根配置 schema 导出 | `OpenClawSchema` |
|
||||
| `plugin-sdk/provider-entry` | 单 provider 入口辅助工具 | `defineSingleProviderPluginEntry` |
|
||||
| `plugin-sdk/channel-core` | 聚焦的渠道入口定义与构建器 | `defineChannelPluginEntry`, `defineSetupPluginEntry`, `createChatChannelPlugin`, `createChannelPluginBase` |
|
||||
| `plugin-sdk/setup` | 共享设置向导辅助工具 | Allowlist 提示、设置状态构建器 |
|
||||
| `plugin-sdk/setup-runtime` | 设置阶段运行时辅助工具 | 可安全导入的设置补丁适配器、查找说明辅助工具、`promptResolvedAllowFrom`、`splitSetupEntries`、委托设置代理 |
|
||||
| `plugin-sdk/provider-entry` | 单一 provider 入口辅助工具 | `defineSingleProviderPluginEntry` |
|
||||
| `plugin-sdk/channel-core` | 聚焦的渠道入口定义和构建器 | `defineChannelPluginEntry`, `defineSetupPluginEntry`, `createChatChannelPlugin`, `createChannelPluginBase` |
|
||||
| `plugin-sdk/setup` | 共享的设置向导辅助工具 | Allowlist 提示、设置状态构建器 |
|
||||
| `plugin-sdk/setup-runtime` | 设置阶段运行时辅助工具 | 可安全导入的设置补丁适配器、查找说明辅助工具、`promptResolvedAllowFrom`、`splitSetupEntries`、委托式设置代理 |
|
||||
| `plugin-sdk/setup-adapter-runtime` | 设置适配器辅助工具 | `createEnvPatchedAccountSetupAdapter` |
|
||||
| `plugin-sdk/setup-tools` | 设置工具辅助工具 | `formatCliCommand`, `detectBinary`, `extractArchive`, `resolveBrewExecutable`, `formatDocsLink`, `CONFIG_DIR` |
|
||||
| `plugin-sdk/account-core` | 多账户辅助工具 | 账户列表 / 配置 / 操作门控辅助工具 |
|
||||
| `plugin-sdk/account-core` | 多账户辅助工具 | 账户列表/配置/操作门控辅助工具 |
|
||||
| `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` | 私信配对基础组件 | `createChannelPairingController` |
|
||||
| `plugin-sdk/channel-reply-pipeline` | 回复前缀 + 输入中状态线路 | `createChannelReplyPipeline` |
|
||||
| `plugin-sdk/account-helpers` | 精简账户辅助工具 | 账户列表/账户操作辅助工具 |
|
||||
| `plugin-sdk/channel-setup` | 设置向导适配器 | `createOptionalChannelSetupSurface`, `createOptionalChannelSetupAdapter`, `createOptionalChannelSetupWizard`,以及 `DEFAULT_ACCOUNT_ID`, `createTopLevelChannelDmPolicy`, `setSetupChannelEnabled`, `splitSetupEntries` |
|
||||
| `plugin-sdk/channel-pairing` | 私信配对原语 | `createChannelPairingController` |
|
||||
| `plugin-sdk/channel-reply-pipeline` | 回复前缀 + 正在输入状态绑定 | `createChannelReplyPipeline` |
|
||||
| `plugin-sdk/channel-config-helpers` | 配置适配器工厂 | `createHybridChannelConfigAdapter` |
|
||||
| `plugin-sdk/channel-config-schema` | 配置 schema 构建器 | 共享渠道配置 schema 基元;以内置渠道命名的 schema 导出仅用于旧版兼容 |
|
||||
| `plugin-sdk/telegram-command-config` | Telegram 命令配置辅助工具 | 命令名规范化、描述裁剪、重复 / 冲突校验 |
|
||||
| `plugin-sdk/channel-policy` | 群组 / 私信策略解析 | `resolveChannelGroupRequireMention` |
|
||||
| `plugin-sdk/channel-lifecycle` | 账户 Status 和草稿流生命周期辅助工具 | `createAccountStatusSink`、草稿预览最终化辅助工具 |
|
||||
| `plugin-sdk/inbound-envelope` | 入站 envelope 辅助工具 | 共享路由 + envelope 构建器辅助工具 |
|
||||
| `plugin-sdk/inbound-reply-dispatch` | 入站回复辅助工具 | 共享记录与分发辅助工具 |
|
||||
| `plugin-sdk/messaging-targets` | 消息目标解析 | 目标解析 / 匹配辅助工具 |
|
||||
| `plugin-sdk/channel-config-schema` | 配置 schema 构建器 | 共享渠道配置 schema 原语;按内置渠道命名的 schema 导出仅用于旧版兼容 |
|
||||
| `plugin-sdk/telegram-command-config` | Telegram 命令配置辅助工具 | 命令名规范化、描述裁剪、重复/冲突校验 |
|
||||
| `plugin-sdk/channel-policy` | 群组/私信策略解析 | `resolveChannelGroupRequireMention` |
|
||||
| `plugin-sdk/channel-lifecycle` | 账户状态和草稿流生命周期辅助工具 | `createAccountStatusSink`、草稿预览最终化辅助工具 |
|
||||
| `plugin-sdk/inbound-envelope` | 入站 envelope 辅助工具 | 共享 route + envelope 构建器辅助工具 |
|
||||
| `plugin-sdk/inbound-reply-dispatch` | 入站回复辅助工具 | 共享记录并分发辅助工具 |
|
||||
| `plugin-sdk/messaging-targets` | 消息目标解析 | 目标解析/匹配辅助工具 |
|
||||
| `plugin-sdk/outbound-media` | 出站媒体辅助工具 | 共享出站媒体加载 |
|
||||
| `plugin-sdk/outbound-send-deps` | 出站发送依赖辅助工具 | 轻量级 `resolveOutboundSendDep` 查找,无需导入完整出站运行时 |
|
||||
| `plugin-sdk/outbound-runtime` | 出站运行时辅助工具 | 出站投递、身份 / 发送委托、会话、格式化和负载规划辅助工具 |
|
||||
| `plugin-sdk/thread-bindings-runtime` | 线程绑定辅助工具 | 线程绑定生命周期与适配器辅助工具 |
|
||||
| `plugin-sdk/outbound-send-deps` | 出站发送依赖辅助工具 | 轻量级 `resolveOutboundSendDep` 查找,无需导入完整的出站运行时 |
|
||||
| `plugin-sdk/outbound-runtime` | 出站运行时辅助工具 | 出站投递、身份/发送委托、会话、格式化和负载规划辅助工具 |
|
||||
| `plugin-sdk/thread-bindings-runtime` | 线程绑定辅助工具 | 线程绑定生命周期和适配器辅助工具 |
|
||||
| `plugin-sdk/agent-media-payload` | 旧版媒体负载辅助工具 | 面向旧字段布局的智能体媒体负载构建器 |
|
||||
| `plugin-sdk/channel-runtime` | 已弃用的兼容性 shim | 仅保留旧版渠道运行时工具 |
|
||||
| `plugin-sdk/channel-runtime` | 已弃用的兼容性 shim | 仅包含旧版渠道运行时工具 |
|
||||
| `plugin-sdk/channel-send-result` | 发送结果类型 | 回复结果类型 |
|
||||
| `plugin-sdk/runtime-store` | 持久化插件存储 | `createPluginRuntimeStore` |
|
||||
| `plugin-sdk/runtime` | 宽范围运行时辅助工具 | 运行时 / 日志 / 备份 / 插件安装辅助工具 |
|
||||
| `plugin-sdk/runtime-env` | 窄范围运行时环境辅助工具 | 日志器 / 运行时环境、超时、重试和退避辅助工具 |
|
||||
| `plugin-sdk/plugin-runtime` | 共享插件运行时辅助工具 | 插件命令 / 钩子 / http / 交互式辅助工具 |
|
||||
| `plugin-sdk/hook-runtime` | 钩子流水线辅助工具 | 共享 webhook / 内部钩子流水线辅助工具 |
|
||||
| `plugin-sdk/runtime` | 宽泛运行时辅助工具 | 运行时/日志/备份/插件安装辅助工具 |
|
||||
| `plugin-sdk/runtime-env` | 精简运行时环境辅助工具 | 日志记录器/运行时环境、超时、重试和退避辅助工具 |
|
||||
| `plugin-sdk/plugin-runtime` | 共享插件运行时辅助工具 | 插件命令/钩子/http/交互辅助工具 |
|
||||
| `plugin-sdk/hook-runtime` | 钩子管线辅助工具 | 共享 webhook/内部钩子管线辅助工具 |
|
||||
| `plugin-sdk/lazy-runtime` | 惰性运行时辅助工具 | `createLazyRuntimeModule`, `createLazyRuntimeMethod`, `createLazyRuntimeMethodBinder`, `createLazyRuntimeNamedExport`, `createLazyRuntimeSurface` |
|
||||
| `plugin-sdk/process-runtime` | 进程辅助工具 | 共享 exec 辅助工具 |
|
||||
| `plugin-sdk/cli-runtime` | CLI 运行时辅助工具 | 命令格式化、等待、版本辅助工具 |
|
||||
| `plugin-sdk/gateway-runtime` | Gateway 网关辅助工具 | Gateway 网关客户端和渠道 Status 补丁辅助工具 |
|
||||
| `plugin-sdk/config-runtime` | 配置辅助工具 | 配置加载 / 写入辅助工具 |
|
||||
| `plugin-sdk/telegram-command-config` | Telegram 命令辅助工具 | 当内置 Telegram 合约表面不可用时,提供具备稳定回退能力的 Telegram 命令校验辅助工具 |
|
||||
| `plugin-sdk/approval-runtime` | 审批提示辅助工具 | exec / 插件审批负载、审批能力 / 配置文件辅助工具、原生审批路由 / 运行时辅助工具,以及结构化审批显示路径格式化 |
|
||||
| `plugin-sdk/approval-auth-runtime` | 审批认证辅助工具 | 审批人解析、同聊天操作认证 |
|
||||
| `plugin-sdk/approval-client-runtime` | 审批客户端辅助工具 | 原生 exec 审批配置文件 / 过滤器辅助工具 |
|
||||
| `plugin-sdk/approval-delivery-runtime` | 审批投递辅助工具 | 原生审批能力 / 投递适配器 |
|
||||
| `plugin-sdk/gateway-runtime` | Gateway 网关辅助工具 | Gateway 网关客户端和渠道状态补丁辅助工具 |
|
||||
| `plugin-sdk/config-runtime` | 配置辅助工具 | 配置加载/写入辅助工具 |
|
||||
| `plugin-sdk/telegram-command-config` | Telegram 命令辅助工具 | 当内置 Telegram 契约接口不可用时,提供具备稳定回退的 Telegram 命令校验辅助工具 |
|
||||
| `plugin-sdk/approval-runtime` | 审批提示辅助工具 | exec/插件审批负载、审批能力/profile 辅助工具、原生审批路由/运行时辅助工具,以及结构化审批显示路径格式化 |
|
||||
| `plugin-sdk/approval-auth-runtime` | 审批认证辅助工具 | approver 解析、同聊天操作认证 |
|
||||
| `plugin-sdk/approval-client-runtime` | 审批客户端辅助工具 | 原生 exec 审批 profile/过滤辅助工具 |
|
||||
| `plugin-sdk/approval-delivery-runtime` | 审批投递辅助工具 | 原生审批能力/投递适配器 |
|
||||
| `plugin-sdk/approval-gateway-runtime` | 审批 Gateway 网关辅助工具 | 共享审批 Gateway 网关解析辅助工具 |
|
||||
| `plugin-sdk/approval-handler-adapter-runtime` | 审批适配器辅助工具 | 面向高热渠道入口点的轻量级原生审批适配器加载辅助工具 |
|
||||
| `plugin-sdk/approval-handler-runtime` | 审批处理器辅助工具 | 更宽范围的审批处理器运行时辅助工具;若较窄的 adapter / gateway 接缝已足够,应优先使用它们 |
|
||||
| `plugin-sdk/approval-native-runtime` | 审批目标辅助工具 | 原生审批目标 / 账户绑定辅助工具 |
|
||||
| `plugin-sdk/approval-reply-runtime` | 审批回复辅助工具 | exec / 插件审批回复负载辅助工具 |
|
||||
| `plugin-sdk/channel-runtime-context` | 渠道运行时上下文辅助工具 | 通用渠道运行时上下文 register / get / watch 辅助工具 |
|
||||
| `plugin-sdk/security-runtime` | 安全辅助工具 | 共享信任、私信门控、外部内容和 secret 收集辅助工具 |
|
||||
| `plugin-sdk/approval-handler-adapter-runtime` | 审批适配器辅助工具 | 面向热渠道入口点的轻量级原生审批适配器加载辅助工具 |
|
||||
| `plugin-sdk/approval-handler-runtime` | 审批处理器辅助工具 | 更宽泛的审批处理器运行时辅助工具;若更精简的 adapter/gateway 接口已足够,优先使用它们 |
|
||||
| `plugin-sdk/approval-native-runtime` | 审批目标辅助工具 | 原生审批目标/账户绑定辅助工具 |
|
||||
| `plugin-sdk/approval-reply-runtime` | 审批回复辅助工具 | exec/插件审批回复负载辅助工具 |
|
||||
| `plugin-sdk/channel-runtime-context` | 渠道运行时上下文辅助工具 | 通用渠道运行时上下文 register/get/watch 辅助工具 |
|
||||
| `plugin-sdk/security-runtime` | 安全辅助工具 | 共享 trust、私信门控、外部内容和敏感信息收集辅助工具 |
|
||||
| `plugin-sdk/ssrf-policy` | SSRF 策略辅助工具 | 主机 allowlist 和私有网络策略辅助工具 |
|
||||
| `plugin-sdk/ssrf-runtime` | SSRF 运行时辅助工具 | 固定 dispatcher、受保护 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/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/command-status` | 命令 Status / 帮助渲染器 | `buildCommandsMessage`, `buildCommandsMessagePaginated`, `buildHelpMessage` |
|
||||
| `plugin-sdk/secret-input` | secret 输入解析 | secret 输入辅助工具 |
|
||||
| `plugin-sdk/allow-from` | Allowlist 格式化 | `formatAllowFromLowercase` |
|
||||
| `plugin-sdk/allowlist-resolution` | Allowlist 输入映射 | `mapAllowlistResolutionInputs` |
|
||||
| `plugin-sdk/command-auth` | 命令门控和命令接口辅助工具 | `resolveControlCommandGate`、发送者认证辅助工具、命令注册表辅助工具(包括动态参数菜单格式化) |
|
||||
| `plugin-sdk/command-status` | 命令 Status/帮助渲染器 | `buildCommandsMessage`, `buildCommandsMessagePaginated`, `buildHelpMessage` |
|
||||
| `plugin-sdk/secret-input` | 敏感信息输入解析 | 敏感信息输入辅助工具 |
|
||||
| `plugin-sdk/webhook-ingress` | webhook 请求辅助工具 | webhook 目标工具 |
|
||||
| `plugin-sdk/webhook-request-guards` | webhook 请求体保护辅助工具 | 请求体读取 / 限制辅助工具 |
|
||||
| `plugin-sdk/reply-runtime` | 共享回复运行时 | 入站分发、心跳、回复规划器、分块 |
|
||||
| `plugin-sdk/reply-dispatch-runtime` | 窄范围回复分发辅助工具 | 最终化、provider 分发和会话标签辅助工具 |
|
||||
| `plugin-sdk/webhook-request-guards` | webhook 请求体守卫辅助工具 | 请求体读取/限制辅助工具 |
|
||||
| `plugin-sdk/reply-runtime` | 共享回复运行时 | 入站分发、心跳、回复规划、分块 |
|
||||
| `plugin-sdk/reply-dispatch-runtime` | 精简回复分发辅助工具 | 最终化、provider 分发和会话标签辅助工具 |
|
||||
| `plugin-sdk/reply-history` | 回复历史辅助工具 | `buildHistoryContext`, `buildPendingHistoryContextFromMap`, `recordPendingHistoryEntry`, `clearHistoryEntriesIfEnabled` |
|
||||
| `plugin-sdk/reply-reference` | 回复引用规划 | `createReplyReferencePlanner` |
|
||||
| `plugin-sdk/reply-chunking` | 回复分块辅助工具 | 文本 / markdown 分块辅助工具 |
|
||||
| `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 摘要构建器、运行时状态默认值、问题元数据辅助工具 |
|
||||
| `plugin-sdk/routing` | 路由/会话键辅助工具 | `resolveAgentRoute`, `buildAgentSessionKey`, `resolveDefaultAgentBoundAccountId`、会话键规范化辅助工具 |
|
||||
| `plugin-sdk/status-helpers` | 渠道 Status 辅助工具 | 渠道/账户状态摘要构建器、运行时状态默认值、问题元数据辅助工具 |
|
||||
| `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` | 参数读取器 | 通用工具 / CLI 参数读取器 |
|
||||
| `plugin-sdk/string-normalization-runtime` | 字符串规范化辅助工具 | slug/字符串规范化辅助工具 |
|
||||
| `plugin-sdk/request-url` | 请求 URL 辅助工具 | 从类似请求的输入中提取字符串 URL |
|
||||
| `plugin-sdk/run-command` | 定时命令辅助工具 | 带标准化 stdout/stderr 的定时命令运行器 |
|
||||
| `plugin-sdk/param-readers` | 参数读取器 | 常用工具/CLI 参数读取器 |
|
||||
| `plugin-sdk/tool-payload` | 工具负载提取 | 从工具结果对象中提取规范化负载 |
|
||||
| `plugin-sdk/tool-send` | 工具发送提取 | 从工具参数中提取规范发送目标字段 |
|
||||
| `plugin-sdk/tool-send` | 工具发送提取 | 从工具参数中提取规范的发送目标字段 |
|
||||
| `plugin-sdk/temp-path` | 临时路径辅助工具 | 共享临时下载路径辅助工具 |
|
||||
| `plugin-sdk/logging-core` | 日志辅助工具 | 子系统日志器和脱敏辅助工具 |
|
||||
| `plugin-sdk/logging-core` | 日志辅助工具 | 子系统日志记录器和脱敏辅助工具 |
|
||||
| `plugin-sdk/markdown-table-runtime` | Markdown 表格辅助工具 | Markdown 表格模式辅助工具 |
|
||||
| `plugin-sdk/reply-payload` | 消息回复类型 | 回复负载类型 |
|
||||
| `plugin-sdk/provider-setup` | 精选的本地 / 自托管 provider 设置辅助工具 | 自托管 provider 发现 / 配置辅助工具 |
|
||||
| `plugin-sdk/self-hosted-provider-setup` | 聚焦 OpenAI 兼容自托管 provider 设置辅助工具 | 同样的自托管 provider 发现 / 配置辅助工具 |
|
||||
| `plugin-sdk/provider-auth-runtime` | provider 运行时认证辅助工具 | 运行时 API 密钥解析辅助工具 |
|
||||
| `plugin-sdk/provider-auth-api-key` | provider API 密钥设置辅助工具 | API 密钥新手引导 / 配置文件写入辅助工具 |
|
||||
| `plugin-sdk/provider-setup` | 精选的本地/自托管 provider 设置辅助工具 | 自托管 provider 发现/配置辅助工具 |
|
||||
| `plugin-sdk/self-hosted-provider-setup` | 聚焦的 OpenAI 兼容自托管 provider 设置辅助工具 | 同一套自托管 provider 发现/配置辅助工具 |
|
||||
| `plugin-sdk/provider-auth-runtime` | provider 运行时认证辅助工具 | 运行时 API key 解析辅助工具 |
|
||||
| `plugin-sdk/provider-auth-api-key` | provider API key 设置辅助工具 | API key 新手引导/profile 写入辅助工具 |
|
||||
| `plugin-sdk/provider-auth-result` | provider 认证结果辅助工具 | 标准 OAuth 认证结果构建器 |
|
||||
| `plugin-sdk/provider-auth-login` | provider 交互式登录辅助工具 | 共享交互式登录辅助工具 |
|
||||
| `plugin-sdk/provider-selection-runtime` | provider 选择辅助工具 | 已配置或自动 provider 选择,以及原始 provider 配置合并 |
|
||||
| `plugin-sdk/provider-selection-runtime` | provider 选择辅助工具 | 已配置或自动 provider 选择,以及原始 provider 配置合并辅助工具 |
|
||||
| `plugin-sdk/provider-env-vars` | Provider 环境变量辅助工具 | Provider 认证环境变量查找辅助工具 |
|
||||
| `plugin-sdk/provider-model-shared` | 共享 provider 模型 / replay 辅助工具 | `ProviderReplayFamily`, `buildProviderReplayFamilyHooks`, `normalizeModelCompat`、共享 replay-policy 构建器、provider 端点辅助工具,以及 model-id 规范化辅助工具 |
|
||||
| `plugin-sdk/provider-catalog-shared` | 共享 provider catalog 辅助工具 | `findCatalogTemplate`, `buildSingleProviderApiKeyCatalog`, `supportsNativeStreamingUsageCompat`, `applyProviderNativeStreamingUsageCompat` |
|
||||
| `plugin-sdk/provider-onboard` | Provider 新手引导补丁 | 新手引导配置辅助工具 |
|
||||
| `plugin-sdk/provider-http` | Provider HTTP 辅助工具 | 通用 provider HTTP / 端点能力辅助工具,包括音频转录 multipart form 辅助工具 |
|
||||
| `plugin-sdk/provider-web-fetch` | Provider web-fetch 辅助工具 | Web-fetch provider 注册 / 缓存辅助工具 |
|
||||
| `plugin-sdk/provider-web-search-config-contract` | Provider web-search 配置辅助工具 | 面向不需要插件启用线路的 provider 的窄范围 web-search 配置 / 凭证辅助工具 |
|
||||
| `plugin-sdk/provider-web-search-contract` | Provider web-search 合约辅助工具 | 窄范围 web-search 配置 / 凭证合约辅助工具,例如 `createWebSearchProviderContractFields`、`enablePluginInConfig`、`resolveProviderWebSearchPluginConfig` 以及带作用域的凭证 setter / getter |
|
||||
| `plugin-sdk/provider-web-search` | Provider web-search 辅助工具 | Web-search provider 注册 / 缓存 / 运行时辅助工具 |
|
||||
| `plugin-sdk/provider-tools` | Provider 工具 / schema 兼容辅助工具 | `ProviderToolCompatFamily`, `buildProviderToolCompatFamilyHooks`, Gemini schema 清理 + 诊断,以及 xAI 兼容辅助工具,例如 `resolveXaiModelCompatPatch` / `applyXaiModelCompat` |
|
||||
| `plugin-sdk/provider-usage` | Provider 用量辅助工具 | `fetchClaudeUsage`, `fetchGeminiUsage`, `fetchGithubCopilotUsage` 以及其他 provider 用量辅助工具 |
|
||||
| `plugin-sdk/provider-stream` | Provider 流包装辅助工具 | `ProviderStreamFamily`, `buildProviderStreamFamilyHooks`, `composeProviderStreamWrappers`、流包装类型,以及共享的 Anthropic / Bedrock / DeepSeek V4 / Google / Kilocode / Moonshot / OpenAI / OpenRouter / Z.A.I / MiniMax / Copilot 包装辅助工具 |
|
||||
| `plugin-sdk/provider-transport-runtime` | Provider 传输辅助工具 | 原生 provider 传输辅助工具,例如受保护 fetch、传输消息转换和可写传输事件流 |
|
||||
| `plugin-sdk/provider-model-shared` | 共享 provider 模型/重放辅助工具 | `ProviderReplayFamily`, `buildProviderReplayFamilyHooks`, `normalizeModelCompat`、共享重放策略构建器、provider 端点辅助工具,以及 model-id 规范化辅助工具 |
|
||||
| `plugin-sdk/provider-catalog-shared` | 共享 provider 目录辅助工具 | `findCatalogTemplate`, `buildSingleProviderApiKeyCatalog`, `supportsNativeStreamingUsageCompat`, `applyProviderNativeStreamingUsageCompat` |
|
||||
| `plugin-sdk/provider-onboard` | provider onboarding 补丁 | onboarding 配置辅助工具 |
|
||||
| `plugin-sdk/provider-http` | provider HTTP 辅助工具 | 通用 provider HTTP/端点能力辅助工具,包括音频转录 multipart 表单辅助工具 |
|
||||
| `plugin-sdk/provider-web-fetch` | provider web-fetch 辅助工具 | web-fetch provider 注册/缓存辅助工具 |
|
||||
| `plugin-sdk/provider-web-search-config-contract` | provider web-search 配置辅助工具 | 面向不需要插件启用绑定的 provider 的精简 web-search 配置/凭证辅助工具 |
|
||||
| `plugin-sdk/provider-web-search-contract` | provider web-search 契约辅助工具 | 精简的 web-search 配置/凭证契约辅助工具,例如 `createWebSearchProviderContractFields`, `enablePluginInConfig`, `resolveProviderWebSearchPluginConfig`,以及作用域化凭证 setter/getter |
|
||||
| `plugin-sdk/provider-web-search` | provider web-search 辅助工具 | web-search provider 注册/缓存/运行时辅助工具 |
|
||||
| `plugin-sdk/provider-tools` | provider 工具/schema 兼容辅助工具 | `ProviderToolCompatFamily`, `buildProviderToolCompatFamilyHooks`、Gemini schema 清理 + 诊断,以及 xAI 兼容辅助工具,例如 `resolveXaiModelCompatPatch` / `applyXaiModelCompat` |
|
||||
| `plugin-sdk/provider-usage` | provider 用量辅助工具 | `fetchClaudeUsage`, `fetchGeminiUsage`, `fetchGithubCopilotUsage` 以及其他 provider 用量辅助工具 |
|
||||
| `plugin-sdk/provider-stream` | provider 流包装辅助工具 | `ProviderStreamFamily`, `buildProviderStreamFamilyHooks`, `composeProviderStreamWrappers`、流包装器类型,以及共享的 Anthropic/Bedrock/DeepSeek V4/Google/Kilocode/Moonshot/OpenAI/OpenRouter/Z.A.I/MiniMax/Copilot 包装辅助工具 |
|
||||
| `plugin-sdk/provider-transport-runtime` | provider 传输辅助工具 | 原生 provider 传输辅助工具,例如受保护的 fetch、传输消息转换,以及可写的传输事件流 |
|
||||
| `plugin-sdk/keyed-async-queue` | 有序异步队列 | `KeyedAsyncQueue` |
|
||||
| `plugin-sdk/media-runtime` | 共享媒体辅助工具 | 媒体获取 / 转换 / 存储辅助工具,以及媒体负载构建器 |
|
||||
| `plugin-sdk/media-generation-runtime` | 共享媒体生成辅助工具 | 面向图像 / 视频 / 音乐生成的共享故障转移辅助工具、候选项选择和缺失模型消息 |
|
||||
| `plugin-sdk/media-understanding` | 媒体理解辅助工具 | 媒体理解 provider 类型,以及面向 provider 的图像 / 音频辅助导出 |
|
||||
| `plugin-sdk/text-runtime` | 共享文本辅助工具 | 面向助手可见文本剥离、markdown 渲染 / 分块 / 表格辅助工具、脱敏辅助工具、directive-tag 辅助工具、安全文本工具,以及相关文本 / 日志辅助工具 |
|
||||
| `plugin-sdk/media-runtime` | 共享媒体辅助工具 | 媒体获取/转换/存储辅助工具,以及媒体负载构建器 |
|
||||
| `plugin-sdk/media-generation-runtime` | 共享媒体生成辅助工具 | 用于图像/视频/音乐生成的共享故障转移辅助工具、候选项选择和缺失模型提示 |
|
||||
| `plugin-sdk/media-understanding` | 媒体理解辅助工具 | 媒体理解 provider 类型,以及面向 provider 的图像/音频辅助工具导出 |
|
||||
| `plugin-sdk/text-runtime` | 共享文本辅助工具 | 面向助手可见文本剥离、markdown 渲染/分块/表格辅助工具、脱敏辅助工具、directive-tag 辅助工具、安全文本工具,以及相关文本/日志辅助工具 |
|
||||
| `plugin-sdk/text-chunking` | 文本分块辅助工具 | 出站文本分块辅助工具 |
|
||||
| `plugin-sdk/speech` | 语音辅助工具 | 语音 provider 类型,以及面向 provider 的指令、注册表和校验辅助工具 |
|
||||
| `plugin-sdk/speech-core` | 共享语音核心 | 语音 provider 类型、注册表、指令、规范化 |
|
||||
| `plugin-sdk/realtime-transcription` | 实时转录辅助工具 | provider 类型、注册表辅助工具和共享 WebSocket 会话辅助工具 |
|
||||
| `plugin-sdk/realtime-voice` | 实时语音辅助工具 | provider 类型、注册表 / 解析辅助工具和桥接会话辅助工具 |
|
||||
| `plugin-sdk/realtime-transcription` | 实时转录辅助工具 | provider 类型、注册表辅助工具,以及共享 WebSocket 会话辅助工具 |
|
||||
| `plugin-sdk/realtime-voice` | 实时语音辅助工具 | provider 类型、注册表/解析辅助工具,以及桥接会话辅助工具 |
|
||||
| `plugin-sdk/image-generation-core` | 共享图像生成核心 | 图像生成类型、故障转移、认证和注册表辅助工具 |
|
||||
| `plugin-sdk/music-generation` | 音乐生成辅助工具 | 音乐生成 provider / 请求 / 结果类型 |
|
||||
| `plugin-sdk/music-generation-core` | 共享音乐生成核心 | 音乐生成类型、故障转移辅助工具、provider 查找和 model-ref 解析 |
|
||||
| `plugin-sdk/video-generation` | 视频生成辅助工具 | 视频生成 provider / 请求 / 结果类型 |
|
||||
| `plugin-sdk/video-generation-core` | 共享视频生成核心 | 视频生成类型、故障转移辅助工具、provider 查找和 model-ref 解析 |
|
||||
| `plugin-sdk/interactive-runtime` | 交互式回复辅助工具 | 交互式回复负载规范化 / 归约 |
|
||||
| `plugin-sdk/channel-config-primitives` | 渠道配置基元 | 窄范围渠道 config-schema 基元 |
|
||||
| `plugin-sdk/music-generation` | 音乐生成辅助工具 | 音乐生成 provider/请求/结果类型 |
|
||||
| `plugin-sdk/music-generation-core` | 共享音乐生成核心 | 音乐生成类型、故障转移辅助工具、provider 查找,以及 model-ref 解析 |
|
||||
| `plugin-sdk/video-generation` | 视频生成辅助工具 | 视频生成 provider/请求/结果类型 |
|
||||
| `plugin-sdk/video-generation-core` | 共享视频生成核心 | 视频生成类型、故障转移辅助工具、provider 查找,以及 model-ref 解析 |
|
||||
| `plugin-sdk/interactive-runtime` | 交互式回复辅助工具 | 交互式回复负载规范化/归并 |
|
||||
| `plugin-sdk/channel-config-primitives` | 渠道配置原语 | 精简的渠道 config-schema 原语 |
|
||||
| `plugin-sdk/channel-config-writes` | 渠道配置写入辅助工具 | 渠道配置写入授权辅助工具 |
|
||||
| `plugin-sdk/channel-plugin-common` | 共享渠道前导模块 | 共享渠道插件前导导出 |
|
||||
| `plugin-sdk/channel-status` | 渠道状态辅助工具 | 共享渠道状态快照 / 摘要辅助工具 |
|
||||
| `plugin-sdk/allowlist-config-edit` | allowlist 配置辅助工具 | allowlist 配置编辑 / 读取辅助工具 |
|
||||
| `plugin-sdk/channel-status` | 渠道状态辅助工具 | 共享渠道状态快照/摘要辅助工具 |
|
||||
| `plugin-sdk/allowlist-config-edit` | Allowlist 配置辅助工具 | Allowlist 配置编辑/读取辅助工具 |
|
||||
| `plugin-sdk/group-access` | 群组访问辅助工具 | 共享群组访问决策辅助工具 |
|
||||
| `plugin-sdk/direct-dm` | 直连私信辅助工具 | 共享直连私信认证 / 保护辅助工具 |
|
||||
| `plugin-sdk/extension-shared` | 共享扩展辅助工具 | 被动渠道 / Status 和环境代理辅助基元 |
|
||||
| `plugin-sdk/direct-dm` | 直接私信辅助工具 | 共享直接私信认证/守卫辅助工具 |
|
||||
| `plugin-sdk/extension-shared` | 共享扩展辅助工具 | 被动渠道/Status 和环境代理辅助原语 |
|
||||
| `plugin-sdk/webhook-targets` | webhook 目标辅助工具 | webhook 目标注册表和路由安装辅助工具 |
|
||||
| `plugin-sdk/webhook-path` | webhook 路径辅助工具 | webhook 路径规范化辅助工具 |
|
||||
| `plugin-sdk/web-media` | 共享 Web 媒体辅助工具 | 远程 / 本地媒体加载辅助工具 |
|
||||
| `plugin-sdk/zod` | Zod 重新导出 | 面向插件 SDK 使用者重新导出的 `zod` |
|
||||
| `plugin-sdk/memory-core` | 内置 memory-core 辅助工具 | 内存管理器 / 配置 / 文件 / CLI 辅助表面 |
|
||||
| `plugin-sdk/memory-core-engine-runtime` | Memory 引擎运行时门面 | Memory 索引 / 搜索运行时门面 |
|
||||
| `plugin-sdk/web-media` | 共享 Web 媒体辅助工具 | 远程/本地媒体加载辅助工具 |
|
||||
| `plugin-sdk/zod` | Zod 重新导出 | 为插件 SDK 使用方重新导出的 `zod` |
|
||||
| `plugin-sdk/memory-core` | 内置 memory-core 辅助工具 | 内存管理器/配置/文件/CLI 辅助接口 |
|
||||
| `plugin-sdk/memory-core-engine-runtime` | Memory 引擎运行时门面 | Memory 索引/搜索运行时门面 |
|
||||
| `plugin-sdk/memory-core-host-engine-foundation` | Memory 宿主基础引擎 | Memory 宿主基础引擎导出 |
|
||||
| `plugin-sdk/memory-core-host-engine-embeddings` | Memory 宿主嵌入引擎 | Memory 嵌入合约、注册表访问、本地 provider 和通用批处理 / 远程辅助工具;具体远程 provider 位于各自所属插件中 |
|
||||
| `plugin-sdk/memory-core-host-engine-embeddings` | Memory 宿主嵌入引擎 | Memory 嵌入契约、注册表访问、本地 provider 和通用批处理/远程辅助工具;具体远程 provider 位于各自所属插件中 |
|
||||
| `plugin-sdk/memory-core-host-engine-qmd` | Memory 宿主 QMD 引擎 | Memory 宿主 QMD 引擎导出 |
|
||||
| `plugin-sdk/memory-core-host-engine-storage` | Memory 宿主存储引擎 | Memory 宿主存储引擎导出 |
|
||||
| `plugin-sdk/memory-core-host-multimodal` | Memory 宿主多模态辅助工具 | Memory 宿主多模态辅助工具 |
|
||||
| `plugin-sdk/memory-core-host-query` | Memory 宿主查询辅助工具 | Memory 宿主查询辅助工具 |
|
||||
| `plugin-sdk/memory-core-host-secret` | Memory 宿主 secret 辅助工具 | Memory 宿主 secret 辅助工具 |
|
||||
| `plugin-sdk/memory-core-host-secret` | Memory 宿主敏感信息辅助工具 | Memory 宿主敏感信息辅助工具 |
|
||||
| `plugin-sdk/memory-core-host-events` | Memory 宿主事件日志辅助工具 | Memory 宿主事件日志辅助工具 |
|
||||
| `plugin-sdk/memory-core-host-status` | Memory 宿主 Status 辅助工具 | Memory 宿主 Status 辅助工具 |
|
||||
| `plugin-sdk/memory-core-host-status` | Memory 宿主状态辅助工具 | Memory 宿主状态辅助工具 |
|
||||
| `plugin-sdk/memory-core-host-runtime-cli` | Memory 宿主 CLI 运行时 | Memory 宿主 CLI 运行时辅助工具 |
|
||||
| `plugin-sdk/memory-core-host-runtime-core` | Memory 宿主核心运行时 | Memory 宿主核心运行时辅助工具 |
|
||||
| `plugin-sdk/memory-core-host-runtime-files` | Memory 宿主文件 / 运行时辅助工具 | Memory 宿主文件 / 运行时辅助工具 |
|
||||
| `plugin-sdk/memory-host-core` | Memory 宿主核心运行时别名 | 面向供应商中立的 memory 宿主核心运行时辅助工具别名 |
|
||||
| `plugin-sdk/memory-host-events` | Memory 宿主事件日志别名 | 面向供应商中立的 memory 宿主事件日志辅助工具别名 |
|
||||
| `plugin-sdk/memory-host-files` | Memory 宿主文件 / 运行时别名 | 面向供应商中立的 memory 宿主文件 / 运行时辅助工具别名 |
|
||||
| `plugin-sdk/memory-host-markdown` | 托管 markdown 辅助工具 | 面向 memory 邻近插件的共享托管 markdown 辅助工具 |
|
||||
| `plugin-sdk/memory-host-search` | 活跃 memory 搜索门面 | 惰性活跃 memory 搜索管理器运行时门面 |
|
||||
| `plugin-sdk/memory-host-status` | Memory 宿主 Status 别名 | 面向供应商中立的 memory 宿主 Status 辅助工具别名 |
|
||||
| `plugin-sdk/memory-lancedb` | 内置 memory-lancedb 辅助工具 | Memory-lancedb 辅助表面 |
|
||||
| `plugin-sdk/testing` | 测试工具 | 测试辅助工具和 mocks |
|
||||
| `plugin-sdk/memory-core-host-runtime-files` | Memory 宿主文件/运行时辅助工具 | Memory 宿主文件/运行时辅助工具 |
|
||||
| `plugin-sdk/memory-host-core` | Memory 宿主核心运行时别名 | 面向 vendor 中立的 Memory 宿主核心运行时辅助工具别名 |
|
||||
| `plugin-sdk/memory-host-events` | Memory 宿主事件日志别名 | 面向 vendor 中立的 Memory 宿主事件日志辅助工具别名 |
|
||||
| `plugin-sdk/memory-host-files` | Memory 宿主文件/运行时别名 | 面向 vendor 中立的 Memory 宿主文件/运行时辅助工具别名 |
|
||||
| `plugin-sdk/memory-host-markdown` | 托管 markdown 辅助工具 | 用于 Memory 邻近插件的共享托管 markdown 辅助工具 |
|
||||
| `plugin-sdk/memory-host-search` | 活跃 Memory 搜索门面 | 惰性活跃 Memory 搜索管理器运行时门面 |
|
||||
| `plugin-sdk/memory-host-status` | Memory 宿主状态别名 | 面向 vendor 中立的 Memory 宿主状态辅助工具别名 |
|
||||
| `plugin-sdk/memory-lancedb` | 内置 memory-lancedb 辅助工具 | Memory-lancedb 辅助接口 |
|
||||
| `plugin-sdk/testing` | 测试工具 | 测试辅助工具和 mock |
|
||||
</Accordion>
|
||||
|
||||
此表有意仅包含常见迁移子集,而不是完整的 SDK 表面。完整的 200 多个入口点列表位于
|
||||
这个表格刻意只包含常见迁移子集,而不是完整的 SDK
|
||||
接口面。完整的 200+ 入口点列表位于
|
||||
`scripts/lib/plugin-sdk-entrypoints.json`。
|
||||
|
||||
该列表仍包含一些内置插件辅助接缝,例如
|
||||
该列表仍包含一些内置插件辅助接口,例如
|
||||
`plugin-sdk/feishu`、`plugin-sdk/feishu-setup`、`plugin-sdk/zalo`、
|
||||
`plugin-sdk/zalo-setup` 和 `plugin-sdk/matrix*`。这些入口仍会继续导出,
|
||||
用于内置插件维护和兼容性,但它们被有意排除在常见迁移表之外,也不是
|
||||
新插件代码推荐使用的目标。
|
||||
`plugin-sdk/zalo-setup` 和 `plugin-sdk/matrix*`。这些接口仍然会为了
|
||||
内置插件维护和兼容性而继续导出,但它们被有意省略在常见迁移表之外,
|
||||
也不是新插件代码的推荐目标。
|
||||
|
||||
同样的规则也适用于其他内置辅助工具族,例如:
|
||||
同样的规则也适用于其他内置辅助工具家族,例如:
|
||||
|
||||
- 浏览器支持辅助工具:`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/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/diagnostics-prometheus`、
|
||||
`plugin-sdk/diffs`、`plugin-sdk/llm-task`、`plugin-sdk/thread-ownership`,
|
||||
`plugin-sdk/diffs`、`plugin-sdk/llm-task`、`plugin-sdk/thread-ownership`、
|
||||
以及 `plugin-sdk/voice-call`
|
||||
|
||||
`plugin-sdk/github-copilot-token` 当前暴露的是窄范围 token 辅助工具表面:
|
||||
`DEFAULT_COPILOT_API_BASE_URL`、
|
||||
`plugin-sdk/github-copilot-token` 当前暴露了精简的 token 辅助工具
|
||||
接口 `DEFAULT_COPILOT_API_BASE_URL`、
|
||||
`deriveCopilotApiBaseUrlFromToken` 和 `resolveCopilotApiToken`。
|
||||
|
||||
请使用与任务最匹配的最窄导入路径。如果你找不到某个导出,
|
||||
请查看 `src/plugin-sdk/` 中的源码,或在 Discord 中提问。
|
||||
请查看 `src/plugin-sdk/` 中的源代码,或在 Discord 中提问。
|
||||
|
||||
## 当前弃用项
|
||||
|
||||
这些是适用于整个插件 SDK、provider 合约、运行时表面和清单的更窄范围弃用项。它们目前仍然可用,但会在未来的主版本中移除。每个条目下方都给出了旧 API 到规范替代方案的映射。
|
||||
适用于整个插件 SDK、provider 契约、
|
||||
运行时接口面和清单的更精细弃用项。它们目前仍然可用,但将在未来的主要版本中移除。
|
||||
每个条目下方都给出了旧 API 到其规范替代方案的映射。
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="command-auth help builders → command-status">
|
||||
<Accordion title="command-auth 帮助构建器 → command-status">
|
||||
**旧版(`openclaw/plugin-sdk/command-auth`)**:`buildCommandsMessage`、
|
||||
`buildCommandsMessagePaginated`、`buildHelpMessage`。
|
||||
|
||||
**新版(`openclaw/plugin-sdk/command-status`)**:签名相同、导出相同——
|
||||
只是改为从更窄的子路径导入。`command-auth`
|
||||
会将它们作为兼容 stub 重新导出。
|
||||
只是改为从更精简的子路径导入。`command-auth`
|
||||
会将它们作为兼容性存根重新导出。
|
||||
|
||||
```typescript
|
||||
// 之前
|
||||
@ -418,93 +431,95 @@ OpenClaw 不会在引入替代方案的同一项变更中,删除或重新解
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Mention gating helpers → resolveInboundMentionDecision">
|
||||
<Accordion title="提及门控辅助工具 → resolveInboundMentionDecision">
|
||||
**旧版**:`resolveInboundMentionRequirement({ facts, policy })` 和
|
||||
来自 `openclaw/plugin-sdk/channel-inbound` 或
|
||||
`openclaw/plugin-sdk/channel-mention-gating` 的
|
||||
`shouldDropInboundForMention(...)`。
|
||||
`shouldDropInboundForMention(...)`,来自
|
||||
`openclaw/plugin-sdk/channel-inbound` 或
|
||||
`openclaw/plugin-sdk/channel-mention-gating`。
|
||||
|
||||
**新版**:`resolveInboundMentionDecision({ facts, policy })`——返回一个
|
||||
单一决策对象,而不是拆分成两个调用。
|
||||
**新版**:`resolveInboundMentionDecision({ facts, policy })` —— 返回的是
|
||||
单个决策对象,而不是拆分成两个调用。
|
||||
|
||||
下游渠道插件(Slack、Discord、Matrix、Microsoft Teams)已经完成切换。
|
||||
下游渠道插件(Slack、Discord、Matrix、Microsoft Teams)已全部完成切换。
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Channel runtime shim 和 channel actions helpers">
|
||||
<Accordion title="渠道运行时 shim 和渠道动作辅助工具">
|
||||
`openclaw/plugin-sdk/channel-runtime` 是面向旧版
|
||||
渠道插件的兼容性 shim。新代码不要导入它;请使用
|
||||
渠道插件的兼容性 shim。不要在新代码中导入它;请使用
|
||||
`openclaw/plugin-sdk/channel-runtime-context` 来注册运行时
|
||||
对象。
|
||||
|
||||
`openclaw/plugin-sdk/channel-actions` 中的 `channelActions*`
|
||||
辅助工具会随着原始 “actions” 渠道导出一起弃用。请改为通过语义化的
|
||||
`presentation` 表面暴露能力——渠道插件应声明它们能渲染什么
|
||||
(cards、buttons、selects),而不是声明它们接受哪些原始 action 名称。
|
||||
辅助工具会与原始 “actions” 渠道导出一起弃用。请改为通过具备语义的
|
||||
`presentation` 接口来暴露能力——渠道插件应声明它们渲染什么
|
||||
(卡片、按钮、选择器),而不是声明它们接受哪些原始
|
||||
动作名称。
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Web search provider tool() helper → createTool() on the plugin">
|
||||
**旧版**:来自 `openclaw/plugin-sdk/provider-web-search` 的 `tool()`
|
||||
工厂。
|
||||
<Accordion title="Web 搜索 provider tool() 辅助工具 → 插件上的 createTool()">
|
||||
**旧版**:`openclaw/plugin-sdk/provider-web-search` 中的 `tool()` 工厂。
|
||||
|
||||
**新版**:直接在 provider 插件上实现 `createTool(...)`。
|
||||
OpenClaw 不再需要 SDK 辅助工具来注册该工具包装器。
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Plaintext channel envelopes → BodyForAgent">
|
||||
<Accordion title="纯文本渠道 envelope → BodyForAgent">
|
||||
**旧版**:`formatInboundEnvelope(...)`(以及
|
||||
`ChannelMessageForAgent.channelEnvelope`),用于从入站渠道消息构建扁平纯文本提示
|
||||
`ChannelMessageForAgent.channelEnvelope`),用于从入站渠道消息构建平面纯文本提示
|
||||
envelope。
|
||||
|
||||
**新版**:`BodyForAgent` 加结构化用户上下文块。渠道
|
||||
插件会以类型化字段附加路由元数据(thread、topic、reply-to、reactions),
|
||||
而不是将这些内容拼接进提示字符串中。
|
||||
**新版**:`BodyForAgent` 加上结构化用户上下文块。渠道
|
||||
插件会将路由元数据(线程、主题、回复目标、表情反应)附加为
|
||||
类型化字段,而不是把它们拼接进提示字符串中。
|
||||
`formatAgentEnvelope(...)` 辅助工具仍然支持用于合成的、
|
||||
面向助手的 envelope,但入站纯文本 envelope 正在逐步淘汰。
|
||||
|
||||
受影响区域:`inbound_claim`、`message_received`,以及任何对
|
||||
`channelEnvelope` 文本进行后处理的自定义渠道插件。
|
||||
`channelEnvelope` 文本做后处理的自定义渠道插件。
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Provider discovery types → provider catalog types">
|
||||
四个 discovery 类型别名现在只是 catalog 时代类型上的薄包装:
|
||||
<Accordion title="Provider 发现类型 → provider 目录类型">
|
||||
现在有四个发现类型别名只是目录时代类型的薄包装:
|
||||
|
||||
| 旧别名 | 新类型 |
|
||||
| ------------------------- | ------------------------- |
|
||||
| `ProviderDiscoveryOrder` | `ProviderCatalogOrder` |
|
||||
| `ProviderDiscoveryContext`| `ProviderCatalogContext` |
|
||||
| `ProviderDiscoveryResult` | `ProviderCatalogResult` |
|
||||
| `ProviderPluginDiscovery` | `ProviderPluginCatalog` |
|
||||
| `ProviderDiscoveryOrder` | `ProviderCatalogOrder` |
|
||||
| `ProviderDiscoveryContext`| `ProviderCatalogContext` |
|
||||
| `ProviderDiscoveryResult` | `ProviderCatalogResult` |
|
||||
| `ProviderPluginDiscovery` | `ProviderPluginCatalog` |
|
||||
|
||||
以及旧版的 `ProviderCapabilities` 静态集合——provider 插件
|
||||
应通过 provider 运行时合约附加能力事实,而不是通过静态对象。
|
||||
此外,还有旧版的 `ProviderCapabilities` 静态集合——provider 插件
|
||||
应通过 provider 运行时契约附加能力事实,
|
||||
而不是通过静态对象。
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Thinking policy hooks → resolveThinkingProfile">
|
||||
<Accordion title="Thinking 策略钩子 → resolveThinkingProfile">
|
||||
**旧版**(`ProviderThinkingPolicy` 上的三个独立钩子):
|
||||
`isBinaryThinking(ctx)`、`supportsXHighThinking(ctx)` 和
|
||||
`resolveDefaultThinkingLevel(ctx)`。
|
||||
|
||||
**新版**:一个统一的 `resolveThinkingProfile(ctx)`,返回
|
||||
`ProviderThinkingProfile`,其中包含规范的 `id`、可选的 `label` 和
|
||||
按优先级排序的级别列表。OpenClaw 会按 profile 排名自动降级过期的已存储值。
|
||||
**新版**:使用单个 `resolveThinkingProfile(ctx)`,返回一个
|
||||
`ProviderThinkingProfile`,其中包含规范的 `id`、可选的 `label`,
|
||||
以及按等级排序的级别列表。OpenClaw 会按 profile 排名
|
||||
自动降级过时的已存储值。
|
||||
|
||||
现在只需实现一个钩子,而不是三个。旧版钩子在弃用窗口期间仍可继续使用,
|
||||
只需实现一个钩子,而不是三个。旧版钩子在弃用窗口期间仍可使用,
|
||||
但不会与 profile 结果进行组合。
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="External OAuth provider fallback → contracts.externalAuthProviders">
|
||||
**旧版**:实现 `resolveExternalOAuthProfiles(...)`,但
|
||||
不在插件清单中声明该 provider。
|
||||
<Accordion title="外部 OAuth provider 回退 → contracts.externalAuthProviders">
|
||||
**旧版**:实现 `resolveExternalOAuthProfiles(...)`,
|
||||
但不在插件清单中声明该 provider。
|
||||
|
||||
**新版**:在插件清单中声明 `contracts.externalAuthProviders`
|
||||
**并且** 实现 `resolveExternalAuthProfiles(...)`。旧版的“认证回退”
|
||||
路径会在运行时发出警告,并将在未来移除。
|
||||
**新版**:在插件清单中声明 `contracts.externalAuthProviders`,
|
||||
**并且** 实现 `resolveExternalAuthProfiles(...)`。旧的 “auth
|
||||
fallback” 路径会在运行时发出警告,并将在未来被移除。
|
||||
|
||||
```json
|
||||
{
|
||||
@ -516,51 +531,52 @@ OpenClaw 不会在引入替代方案的同一项变更中,删除或重新解
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Provider env-var lookup → setup.providers[].envVars">
|
||||
<Accordion title="Provider 环境变量查找 → setup.providers[].envVars">
|
||||
**旧版**清单字段:`providerAuthEnvVars: { anthropic: ["ANTHROPIC_API_KEY"] }`。
|
||||
|
||||
**新版**:将相同的环境变量查找镜像到清单中的
|
||||
`setup.providers[].envVars`。这样可将设置 / Status 环境变量元数据集中到同一个
|
||||
位置,并避免仅为了响应环境变量查找而启动插件运行时。
|
||||
**新版**:将同样的环境变量查找信息同步到清单中的 `setup.providers[].envVars`。
|
||||
这样可以将 setup/Status 环境变量元数据集中到一个位置,
|
||||
并避免仅为了回答环境变量查找而启动插件运行时。
|
||||
|
||||
`providerAuthEnvVars` 会继续通过兼容适配器获得支持,
|
||||
`providerAuthEnvVars` 仍会通过兼容适配器继续支持,
|
||||
直到弃用窗口结束。
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Memory plugin registration → registerMemoryCapability">
|
||||
<Accordion title="Memory 插件注册 → registerMemoryCapability">
|
||||
**旧版**:三个独立调用——
|
||||
`api.registerMemoryPromptSection(...)`、
|
||||
`api.registerMemoryFlushPlan(...)`、
|
||||
`api.registerMemoryRuntime(...)`。
|
||||
|
||||
**新版**:在 memory-state API 上调用一次——
|
||||
**新版**:在 memory-state API 上使用一次调用——
|
||||
`registerMemoryCapability(pluginId, { promptBuilder, flushPlanResolver, runtime })`。
|
||||
|
||||
相同的槽位,单次注册调用。增量式 Memory 辅助工具
|
||||
插槽相同,注册调用合并为一次。附加型 Memory 辅助工具
|
||||
(`registerMemoryPromptSupplement`、`registerMemoryCorpusSupplement`、
|
||||
`registerMemoryEmbeddingProvider`)不受影响。
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Subagent session messages types renamed">
|
||||
仍从 `src/plugins/runtime/types.ts` 导出的两个旧类型别名:
|
||||
<Accordion title="Subagent 会话消息类型已重命名">
|
||||
仍然从 `src/plugins/runtime/types.ts` 导出的两个旧类型别名:
|
||||
|
||||
| 旧版 | 新版 |
|
||||
| ----------------------------- | ------------------------------- |
|
||||
| `SubagentReadSessionParams` | `SubagentGetSessionMessagesParams` |
|
||||
| `SubagentReadSessionResult` | `SubagentGetSessionMessagesResult` |
|
||||
| `SubagentReadSessionParams` | `SubagentGetSessionMessagesParams` |
|
||||
| `SubagentReadSessionResult` | `SubagentGetSessionMessagesResult` |
|
||||
|
||||
运行时方法 `readSession` 已弃用,替代方案为
|
||||
`getSessionMessages`。签名相同;旧方法会直接调用新方法。
|
||||
运行时方法 `readSession` 已弃用,改为使用
|
||||
`getSessionMessages`。签名相同;旧方法会透传调用到
|
||||
新方法。
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="runtime.tasks.flow → runtime.tasks.flows">
|
||||
**旧版**:`runtime.tasks.flow`(单数)返回一个实时 task-flow 访问器。
|
||||
**旧版**:`runtime.tasks.flow`(单数)返回实时任务流访问器。
|
||||
|
||||
**新版**:`runtime.tasks.flows`(复数)返回基于 DTO 的 TaskFlow 访问,
|
||||
这种方式可安全导入,并且不需要加载完整任务运行时。
|
||||
其导入是安全的,并且不需要加载完整任务运行时。
|
||||
|
||||
```typescript
|
||||
// 之前
|
||||
@ -571,17 +587,18 @@ OpenClaw 不会在引入替代方案的同一项变更中,删除或重新解
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Embedded extension factories → agent tool-result middleware">
|
||||
上文“如何迁移 → 将 Pi 工具结果扩展迁移到中间件”中已介绍。
|
||||
为完整起见,这里再次说明:已移除、仅限 Pi 的
|
||||
<Accordion title="嵌入式扩展工厂 → 智能体工具结果中间件">
|
||||
上文“如何迁移 → 将 Pi 工具结果扩展迁移到
|
||||
中间件”中已覆盖。这里出于完整性再次列出:已移除的、仅限 Pi 的
|
||||
`api.registerEmbeddedExtensionFactory(...)` 路径现由
|
||||
`api.registerAgentToolResultMiddleware(...)` 替代,并需在
|
||||
`contracts.agentToolResultMiddleware` 中显式声明运行时列表。
|
||||
`contracts.agentToolResultMiddleware` 中显式声明运行时
|
||||
列表。
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="OpenClawSchemaType alias → OpenClawConfig">
|
||||
从 `openclaw/plugin-sdk` 重新导出的 `OpenClawSchemaType`
|
||||
现在只是 `OpenClawConfig` 的一行别名。请优先使用规范名称。
|
||||
<Accordion title="OpenClawSchemaType 别名 → OpenClawConfig">
|
||||
从 `openclaw/plugin-sdk` 重新导出的 `OpenClawSchemaType` 现在只是
|
||||
`OpenClawConfig` 的单行别名。请优先使用规范名称。
|
||||
|
||||
```typescript
|
||||
// 之前
|
||||
@ -594,38 +611,38 @@ OpenClaw 不会在引入替代方案的同一项变更中,删除或重新解
|
||||
</AccordionGroup>
|
||||
|
||||
<Note>
|
||||
`extensions/` 下内置渠道 / provider 插件中的扩展级弃用项,
|
||||
扩展级弃用项(位于 `extensions/` 下的内置渠道/provider 插件内部)
|
||||
会在它们各自的 `api.ts` 和 `runtime-api.ts`
|
||||
barrel 中单独跟踪。它们不影响第三方插件合约,因此未在此列出。
|
||||
如果你直接使用某个内置插件的本地 barrel,请在升级前先阅读该
|
||||
barrel 中的弃用注释。
|
||||
barrel 中跟踪。它们不会影响第三方插件契约,因此未在此列出。
|
||||
如果你直接使用了某个内置插件的本地 barrel,请在升级前先阅读
|
||||
该 barrel 中的弃用注释。
|
||||
</Note>
|
||||
|
||||
## 移除时间线
|
||||
|
||||
| 时间 | 将发生什么 |
|
||||
| 时间 | 会发生什么 |
|
||||
| ---------------------- | ----------------------------------------------------------------------- |
|
||||
| **现在** | 已弃用表面会发出运行时警告 |
|
||||
| **下一个主版本** | 已弃用表面将被移除;仍在使用它们的插件将会失败 |
|
||||
| **现在** | 已弃用接口面会发出运行时警告 |
|
||||
| **下一个主要版本** | 已弃用接口面将被移除;仍在使用它们的插件将会失效 |
|
||||
|
||||
所有核心插件都已完成迁移。外部插件应在下一个主版本发布前完成迁移。
|
||||
所有核心插件都已经完成迁移。外部插件应在下一个主要版本之前完成迁移。
|
||||
|
||||
## 临时抑制警告
|
||||
|
||||
在你进行迁移时,可设置以下环境变量:
|
||||
在你进行迁移期间,可设置以下环境变量:
|
||||
|
||||
```bash
|
||||
OPENCLAW_SUPPRESS_PLUGIN_SDK_COMPAT_WARNING=1 openclaw gateway run
|
||||
OPENCLAW_SUPPRESS_EXTENSION_API_WARNING=1 openclaw gateway run
|
||||
```
|
||||
|
||||
这只是临时逃生口,而不是永久解决方案。
|
||||
这是一个临时逃生口,而不是永久解决方案。
|
||||
|
||||
## 相关内容
|
||||
|
||||
- [入门指南](/zh-CN/plugins/building-plugins) — 构建你的第一个插件
|
||||
- [SDK 概览](/zh-CN/plugins/sdk-overview) — 完整子路径导入参考
|
||||
- [渠道插件](/zh-CN/plugins/sdk-channel-plugins) — 构建渠道插件
|
||||
- [提供商插件](/zh-CN/plugins/sdk-provider-plugins) — 构建提供商插件
|
||||
- [插件内部机制](/zh-CN/plugins/architecture) — 架构深入解析
|
||||
- [提供商插件](/zh-CN/plugins/sdk-provider-plugins) — 构建 provider 插件
|
||||
- [插件内部机制](/zh-CN/plugins/architecture) — 架构深度解析
|
||||
- [插件清单](/zh-CN/plugins/manifest) — 清单 schema 参考
|
||||
|
||||
Loading…
Reference in New Issue
Block a user