diff --git a/docs/zh-CN/tools/music-generation.md b/docs/zh-CN/tools/music-generation.md index 8e3630d76..2d7acd706 100644 --- a/docs/zh-CN/tools/music-generation.md +++ b/docs/zh-CN/tools/music-generation.md @@ -2,26 +2,26 @@ read_when: - 通过智能体生成音乐或音频 - 配置音乐生成提供商和模型 - - 了解 `music_generate` 工具参数 + - 理解 `music_generate` 工具参数 summary: 使用共享提供商生成音乐，包括基于工作流的插件 title: 音乐生成 x-i18n: - generated_at: "2026-04-06T01:07:11Z" + generated_at: "2026-04-06T01:46:14Z" model: gpt-5.4 provider: openai - source_hash: 7e5dc234b14aee2f5ef766985479b0ba262cceb4510596f6b1cc343a3732838c + source_hash: a03de8aa75cfb7248eb0c1d969fb2a6da06117967d097e6f6e95771d0f017ae1 source_path: tools/music-generation.md workflow: 15 --- # 音乐生成 -`music_generate` 工具让智能体能够通过共享音乐生成能力，结合已配置的提供商（例如 Google、MiniMax 和基于工作流配置的 ComfyUI）创建音乐或音频。 +`music_generate` 工具让智能体能够通过共享音乐生成能力，使用已配置的提供商来创建音乐或音频，例如 Google、MiniMax 和通过工作流配置的 ComfyUI。 对于由共享提供商支持的智能体会话，OpenClaw 会将音乐生成作为后台任务启动，在任务账本中跟踪它，然后在音轨准备就绪时再次唤醒智能体，以便智能体将完成的音频发布回原始渠道。 -只有在至少有一个音乐生成提供商可用时，内置共享工具才会显示。如果你在智能体工具中看不到 `music_generate`，请配置 `agents.defaults.musicGenerationModel` 或设置提供商 API 密钥。 +仅当至少有一个音乐生成提供商可用时，内置共享工具才会显示。如果你在智能体工具中看不到 `music_generate`，请配置 `agents.defaults.musicGenerationModel` 或设置提供商 API 密钥。 ## 快速开始 @@ -29,7 +29,7 @@ x-i18n: ### 由共享提供商支持的生成 1. 为至少一个提供商设置 API 密钥，例如 `GEMINI_API_KEY` 或 `MINIMAX_API_KEY`。 -2. 可选：设置你偏好的模型： +2. 你也可以选择设置首选模型： ```json5 { @@ -43,11 +43,11 @@ x-i18n: } ``` -3. 向智能体发出请求：_“生成一段欢快的 synthpop 音轨，主题是在霓虹都市中夜间驾车。”_ +3. 向智能体发出请求：_“生成一首关于夜间驾车穿越霓虹城市的欢快 synthpop 音轨。”_ -智能体会自动调用 `music_generate`。不需要工具允许列表。 +智能体会自动调用 `music_generate`。无需配置工具允许列表。 -对于没有会话支持的智能体运行的直接同步上下文，内置工具仍会回退为内联生成，并在工具结果中返回最终媒体路径。 +对于没有会话支持智能体运行的直接同步上下文，内置工具仍会回退到内联生成，并在工具结果中返回最终媒体路径。 示例提示词： @@ -63,7 +63,7 @@ Generate an energetic chiptune loop about launching a rocket at sunrise. 内置的 `comfy` 插件通过音乐生成提供商注册表接入共享 `music_generate` 工具。 -1. 为 `models.providers.comfy.music` 配置工作流 JSON 以及提示词/输出节点。 +1. 使用工作流 JSON 以及提示词/输出节点配置 `models.providers.comfy.music`。 2. 如果你使用 Comfy Cloud，请设置 `COMFY_API_KEY` 或 `COMFY_CLOUD_API_KEY`。 3. 请求智能体生成音乐，或直接调用该工具。 @@ -77,9 +77,9 @@ Generate an energetic chiptune loop about launching a rocket at sunrise. | 提供商 | 默认模型 | 参考输入 | 支持的控制项 | API 密钥 | | ------ | ---------------------- | -------------- | --------------------------------------------------------- | -------------------------------------- | -| ComfyUI | `workflow` | 最多 1 张图片 | 由工作流定义的音乐或音频 | `COMFY_API_KEY`, `COMFY_CLOUD_API_KEY` | -| Google | `lyria-3-clip-preview` | 最多 10 张图片 | `lyrics`、`instrumental`、`format` | `GEMINI_API_KEY`, `GOOGLE_API_KEY` | -| MiniMax | `music-2.5+` | 无 | `lyrics`、`instrumental`、`durationSeconds`、`format=mp3` | `MINIMAX_API_KEY` | +| ComfyUI | `workflow` | 最多 1 张图像 | 由工作流定义的音乐或音频 | `COMFY_API_KEY`, `COMFY_CLOUD_API_KEY` | +| Google | `lyria-3-clip-preview` | 最多 10 张图像 | `lyrics`、`instrumental`、`format` | `GEMINI_API_KEY`, `GOOGLE_API_KEY` | +| MiniMax | `music-2.5+` | 无 | `lyrics`、`instrumental`、`durationSeconds`、`format=mp3` | `MINIMAX_API_KEY` | 使用 `action: "list"` 可在运行时查看可用的共享提供商和模型： @@ -87,7 +87,7 @@ Generate an energetic chiptune loop about launching a rocket at sunrise. /tool music_generate action=list ``` -使用 `action: "status"` 可检查当前由会话支持的活动音乐任务： +使用 `action: "status"` 可查看当前由会话支持的活动音乐任务： ```text /tool music_generate action=status @@ -101,30 +101,30 @@ Generate an energetic chiptune loop about launching a rocket at sunrise. ## 内置工具参数 -| 参数 | 类型 | 描述 | +| 参数 | 类型 | 说明 | | ----------------- | -------- | ------------------------------------------------------------------------------------------------- | | `prompt` | string | 音乐生成提示词（`action: "generate"` 时必填） | -| `action` | string | `"generate"`（默认）、用于当前会话任务的 `"status"`，或用于查看提供商的 `"list"` | -| `model` | string | 提供商/模型覆盖，例如 `google/lyria-3-pro-preview` 或 `comfy/workflow` | -| `lyrics` | string | 当提供商支持显式歌词输入时可选填写歌词 | -| `instrumental` | boolean | 当提供商支持时，请求仅器乐输出 | -| `image` | string | 单个参考图片路径或 URL | -| `images` | string[] | 多个参考图片（最多 10 张） | -| `durationSeconds` | number | 当提供商支持时长提示时，以秒为单位的目标时长 | -| `format` | string | 当提供商支持时的输出格式提示（`mp3` 或 `wav`） | +| `action` | string | `"generate"`（默认）、用于当前会话任务的 `"status"`，或用于查看提供商的 `"list"` | +| `model` | string | 提供商/模型覆盖值，例如 `google/lyria-3-pro-preview` 或 `comfy/workflow` | +| `lyrics` | string | 当提供商支持显式歌词输入时，可选的歌词内容 | +| `instrumental` | boolean | 当提供商支持时，请求仅器乐输出 | +| `image` | string | 单个参考图像路径或 URL | +| `images` | string[] | 多个参考图像（最多 10 张） | +| `durationSeconds` | number | 当提供商支持时，目标时长（秒）提示 | +| `format` | string | 当提供商支持时，输出格式提示（`mp3` 或 `wav`） | | `filename` | string | 输出文件名提示 | -并非所有提供商都支持所有参数。共享工具会在提交请求前验证提供商能力限制。 +并非所有提供商都支持所有参数。OpenClaw 仍会在提交前验证硬性限制，例如输入数量，但对于所选提供商或模型无法满足的不受支持可选提示，会在发出警告后忽略。 ## 共享提供商支持路径的异步行为 -- 由会话支持的智能体运行：`music_generate` 会创建后台任务，立即返回 started/task 响应，并在稍后的智能体跟进消息中发布完成的音轨。 -- 防止重复：当该后台任务仍处于 `queued` 或 `running` 状态时，同一会话中后续的 `music_generate` 调用会返回任务状态，而不是再次启动生成。 -- 状态查询：使用 `action: "status"` 可检查当前由会话支持的活动音乐任务，而不会启动新任务。 -- 任务跟踪：使用 `openclaw tasks list` 或 `openclaw tasks show ` 可检查生成任务的排队、运行中和终态状态。 -- 完成唤醒：OpenClaw 会将内部完成事件注入回同一会话，以便模型自行编写面向用户的后续消息。 -- 提示词提示：当音乐任务已在处理中时，同一会话中后续的用户/手动轮次会收到一个小型运行时提示，这样模型就不会盲目再次调用 `music_generate`。 -- 无会话回退：在没有真实智能体会话的直接/本地上下文中，仍会以内联方式运行，并在同一轮中返回最终音频结果。 +- 由会话支持的智能体运行：`music_generate` 会创建一个后台任务，立即返回 started/task 响应，并在稍后的智能体跟进消息中发布完成的音轨。 +- 防止重复：当该后台任务仍处于 `queued` 或 `running` 状态时，同一会话中后续的 `music_generate` 调用会返回任务状态，而不是启动新的生成。 +- 状态查询：使用 `action: "status"` 可在不启动新任务的情况下查看当前由会话支持的活动音乐任务。 +- 任务跟踪：使用 `openclaw tasks list` 或 `openclaw tasks show ` 可查看该生成任务的排队中、运行中和终态状态。 +- 完成唤醒：OpenClaw 会将一个内部完成事件注入回同一会话，以便模型自行编写面向用户的跟进内容。 +- 提示词提示：当音乐任务已在进行中时，同一会话中的后续用户/手动轮次会收到一个较小的运行时提示，这样模型就不会盲目再次调用 `music_generate`。 +- 无会话回退：没有真实智能体会话的直接/本地上下文仍会以内联方式运行，并在同一轮中返回最终音频结果。 ## 配置 @@ -149,24 +149,24 @@ Generate an energetic chiptune loop about launching a rocket at sunrise. 1. 工具调用中的 `model` 参数（如果智能体指定了） 2. 配置中的 `musicGenerationModel.primary` -3. 按顺序尝试 `musicGenerationModel.fallbacks` +3. 按顺序使用 `musicGenerationModel.fallbacks` 4. 仅使用基于凭证的提供商默认值进行自动检测： - - 先尝试当前默认提供商 - - 再按 provider-id 顺序尝试其余已注册的音乐生成提供商 + - 先使用当前默认提供商 + - 再按提供商 ID 顺序使用其余已注册的音乐生成提供商 如果某个提供商失败，会自动尝试下一个候选项。如果全部失败，错误信息会包含每次尝试的详细信息。 ## 提供商说明 -- Google 使用 Lyria 3 批量生成。当前内置流程支持提示词、可选歌词文本和可选参考图片。 -- MiniMax 使用批量 `music_generation` 端点。当前内置流程支持提示词、可选歌词、器乐模式、时长控制以及 mp3 输出。 -- ComfyUI 支持由工作流驱动，具体取决于已配置的图形以及提示词/输出字段的节点映射。 +- Google 使用 Lyria 3 批量生成。当前内置流程支持提示词、可选歌词文本和可选参考图像。 +- MiniMax 使用批量 `music_generation` 端点。当前内置流程支持提示词、可选歌词、器乐模式、时长控制和 mp3 输出。 +- ComfyUI 支持由工作流驱动，并取决于已配置的图以及提示词/输出字段的节点映射。 ## 选择合适的路径 -- 如果你希望使用模型选择、提供商故障切换和内置的异步任务/状态流程，请使用由共享提供商支持的路径。 -- 如果你需要自定义工作流图，或需要使用不属于共享内置音乐能力的提供商，请使用插件路径，例如 ComfyUI。 -- 如果你正在调试 ComfyUI 特定行为，请参见 [ComfyUI](/zh-CN/providers/comfy)。如果你正在调试共享提供商行为，请先查看 [Google (Gemini)](/zh-CN/providers/google) 或 [MiniMax](/zh-CN/providers/minimax)。 +- 当你需要模型选择、提供商故障转移以及内置异步任务/状态流程时，请使用共享提供商支持路径。 +- 当你需要自定义工作流图，或需要不属于共享内置音乐能力的提供商时，请使用插件路径，例如 ComfyUI。 +- 如果你正在调试 ComfyUI 特定行为，请参阅 [ComfyUI](/zh-CN/providers/comfy)。如果你正在调试共享提供商行为，请先查看 [Google（Gemini）](/zh-CN/providers/google) 或 [MiniMax](/zh-CN/providers/minimax)。 ## 实时测试 @@ -182,14 +182,14 @@ OPENCLAW_LIVE_TEST=1 pnpm test:live -- extensions/music-generation-providers.liv OPENCLAW_LIVE_TEST=1 COMFY_LIVE_TEST=1 pnpm test:live -- extensions/comfy/comfy.live.test.ts ``` -当这些部分已配置时，Comfy 实时文件也涵盖 comfy 图片和视频工作流。 +当这些部分已配置时，Comfy 实时文件还会覆盖 comfy 图像和视频工作流。 ## 相关内容 - [后台任务](/zh-CN/automation/tasks) - 用于分离式 `music_generate` 运行的任务跟踪 - [配置参考](/zh-CN/gateway/configuration-reference#agent-defaults) - `musicGenerationModel` 配置 - [ComfyUI](/zh-CN/providers/comfy) -- [Google (Gemini)](/zh-CN/providers/google) +- [Google（Gemini）](/zh-CN/providers/google) - [MiniMax](/zh-CN/providers/minimax) -- [模型](/zh-CN/concepts/models) - 模型配置和故障切换 +- [模型](/zh-CN/concepts/models) - 模型配置和故障转移 - [工具概览](/zh-CN/tools)