byted-interactai-guide

# InteractAI Guide — 能力、配置、接入与排障薄路由 这是对外 Skill 入口，负责识别用户意图和运行阶段，再加载 `references/` 中对应的专题知识。 API 字段、配置细节、错误码和完整排障步骤均放在 references 中。 ## 触发条件 - 「搭一个能对话的语音智能体 / 语音 Demo」「跑通火山 RTC 语音对话」等接入诉求。 - 询问产品支持情况、能力清单、某项能力的工作方式或适用边界。 - 询问当前支持模型、接口版本、计费、公测状态或近期新增能力，需要核对最新官方文档。 - 用自然语言生成、修改或校验 StartVoiceChat / AibotCreate / AibotUpdate 配置。 - 运行中出现「AI 没回答」「Agent 没进房」「能进房但没声音」「没有字幕」等故障。 - 需要解释某个 RTC / VoiceChat 错误码。 ## 工作模式与 CLI 可用性 先区分用户需要的是咨询还是实际执行，因为本 Skill 的知识内容可以独立使用，只有自动化操作 依赖 CLI： - **咨询模式**：文档/API 查询、概念解释、接入方案，以及基于用户提供的日志和现象进行 人工排障。直接回答并按需读取 `references/`；不要仅因未安装 CLI 而要求用户安装。 - **执行模式**：创建项目、登录鉴权、获取 App/Bot 配置、启动 Demo、运行自动诊断或调用 CLI 离线错误码查询。当前任务首次执行 CLI 前，先运行 `vertc version --format json` 检查可用性；无需在后续每一步重复检查。 本 Skill 实际执行的每条 `vertc` 命令都必须在调用执行工具时注入进程级 Skill 标识； 值必须由当前 `SKILL.md` frontmatter 的 `name` 和 `version` 组成，不允许有 `@`。不得 export、持久化或写入配置。这是内部调用元数据：不要在面向用户展示的命令、说明或最终 回复中展开该前缀。 VE_SKILL_ID=<name>/<version> vertc <command> 若命令不存在或环境无法找到 `vertc`： 1. 明确说明当前环境未安装或无法访问 CLI，并指出因此暂时不能执行哪些操作。 2. 同时告诉用户仍可继续文档咨询、方案讨论和基于现有证据的人工排障，不要把 Skill 整体 判定为不可用，也不要把 CLI 缺失解释成 RTC、VoiceChat 或项目故障。 3. 若用户希望继续实际执行，提供 `npm install -g @volcengine/rtc-cli`，安装后用 `vertc version --format json` 验证。上层 Runtime 提供自动初始化时，由上层脚本安装；其余环境 需要先征得用户同意。 ## 最短可运行路径（公开命令） ```bash vertc init --scene voice-agent --platform web --name my-agent cd my-agent vertc auth login vertc dev ``` 需要用户从有限候选中选择时，必须优先调用当前环境已提供的结构化提问工具（如 `request_user_input` 或 `AskUserQuestion`），等待用户选择后再继续。没有可用的结构化 提问工具时，再降级为简短的编号文本选项；不要调用当前环境未提供的工具。 - `vertc auth login`：需要授权时先询问浏览器/手动登录方式，并默认将可刷新的 Signin 凭证保存到受保护的用户级文件，不读取或修改当前项目。Agent/非 TTY 必须先获得用户 同意，再显式使用 `--browser=open`；若浏览器不在 CLI 所在设备，第一轮运行 `vertc auth login --browser=manual --start` 并把返回的 `authorization_url` 交给用户， 用户回传授权码后，第二轮将该码经 stdin 传给 `vertc auth login --resume`。收到授权码时 **不得**重新运行 `--browser=manual` 或 `--start`，否则会生成不同 state，旧授权码必然 失败。仅在用户选择 `--store=keyring` 后访问系统凭据存储。 - `vertc dev`：缺少 RTC 配置时，唯一 App 自动选择；存在 Bot 时要求用户选择并写入场景 JSON，确认零 Bot 时使用内置默认 Scene，随后一次启动 Web 与 Server。非 TTY 若收到 `vertc.dev.selection_required`，只从 `error.details` 读取公开候选，再用 `--app-id` 或 可重复的 `--bot-id` 重试。Bot 候选超过结构化提问工具的选项上限时，不要截断或分页 展示；告知候选总数并提供 `https://console.volcengine.com/conversational-ai/agentManage` 供用户查看，再将用户返回的 Bot 名称或 ID 从 `error.details.bots` 解析为唯一 Bot ID； 名称不唯一时只展示同名候选。需要重新选择时使用 `--reconfigure`。 启动后在页面点击 **Start** 进房对话。若 `dev` 未发现可用 RTC 应用，直接让用户打开 `https://console.volcengine.com/rtc?from=doc` 完成实名认证并开通 RTC 服务。 - 失败先跑 `vertc doctor`（只读定位），再按下方路由表处理。 ## 意图 / 阶段 → references 路由 | 用户意图 / 症状 | 运行阶段 | 路由 | |------------------|----------|------| | 产品能力概览 / 是否支持 / 最新能力 | 咨询 | `references/capabilities.md`（快变事实查当前官方文档） | | RTC 文档搜索 / 精确正文核验 | 咨询 | `references/topic-doc-catalog.md` → `documentation-retrieval.md`（精确 list → fetch；无路由再 search） | | VoiceChat API 字段 / 调用方式 | 配置 | `references/voicechat-api.md`（官方链接优先）| | 生成 / 修改 / 校验 VoiceChat 配置 | 配置 | `references/voice-agent-config.md` → 按需加载 model / validation / output | | 进房失败 / 无媒体 / 有声但播不出 | 进房·采集·发布·播放 | `references/web-sdk-diagnosis.md` | | Agent 未进房 / 无字幕 / ASR·LLM·TTS 异常 | StartVoiceChat 之后 | `references/voice-agent-runtime.md` | | 单个事件能证明什么 / 当前证据边界 | 快判 | `references/integration-flow.md` | | 「AI 没回答」（症状模糊） | 全链路 | `references/integration-flow.md`；不能收敛时再读 `integration-stages.md` | | CLI 命令自身报错 | — | 读 `error.code` + `vertc doctor` | 用 `vertc skills read byted-interactai-guide/references/integration-flow.md` 可直接读取任一 reference。 配置请求先读 `voice-agent-config.md`，再加载它指向的 reference。字段范围、枚举以及 Provider/Model/Resource 兼容性会随产品变化，确定结论前需核对当前产品、接口和 API 版本的 官方正文。控制台配置验证遵循 `voice-agent-config-validation.md` 中限定的 `docs search → fetch` 流程：同一分区沿用原 query，证据不足时保留 `unknown`。 咨询涉及当前 RTC 文档时，先按 `references/documentation-retrieval.md` 使用公开只读 命令检索并获取原文；不要把搜索摘要当正文，也不要在服务不可用时静默改用过期资料。 ## 能力回答边界 必须区分：**产品支持**、**受模型/版本/配置限制**、**当前 Demo/CLI 未覆盖**、**尚未核验**。 Demo 未实现、本地 reference 未覆盖或无法联网，都不能推导为产品不支持；确定性“不支持”必须 有当前官方文档依据。当前能力、精确 API、模型兼容、计费、配额和公测状态等快变事实，按 `references/capabilities.md` 先查官方正文；无法查询时说明本地 `verified_at` 和未核验边界。 ## 运行阶段识别 端到端链路：鉴权 → Demo 配置 → Web SDK 初始化 → 用户进房 → 麦克风采集与发布 → StartVoiceChat → Agent 进房 → Agent 订阅用户音频 → ASR/VAD → LLM → TTS → 用户订阅并播放 Agent 音频。快判证据见 `references/integration-flow.md`；完整阶段与深挖路由见 `references/integration-stages.md`。 ## 「AI 没回答」不要给泛化清单 先读 `integration-flow.md`，确认上一步成功再前进，命中首个失败/缺证据阶段即停止。只有快判 无法收敛且用户要求完整定位时，才读取 `integration-stages.md` 和一个相关 domain reference。 ## 诊断工具 - `vertc doctor`：**只读**两级体检（CLI 自检 + 项目就绪），逐项 PASS/WARN/SKIP/UNKNOWN/FAIL。 它**不写入凭证、不修改配置、不联网补全项目**；登录态由 `vertc auth login` 修复， 缺少 RTC App/Bot 配置时再运行 `vertc dev` 或 `vertc dev --reconfigure`。 - `vertc explain-error <code>`：离线反查 RTC/VoiceChat 错误码的含义与修复建议，输出标注 `domain`（`web-sdk`/`voice-agent`）、`source` 与 `verified` 可信状态。VoiceChat 运行态与 OpenAPI 公共码已对官方「事件和错误码」「公共错误码」核验（`verified`）；无逐项公开来源的 登录凭证与签名排障条目标为 `curated-seed`，会显式提示以官方为准，勿当确定事实。 - `vertc docs search/fetch/list`：只读查询 RTC 文档，无需项目或登录；先 search 得到精确 `results[].id`，再 fetch 原文核验，目录浏览才使用 list。参数模板和停止条件见 `references/documentation-retrieval.md`。 ## 安全边界与提醒 - AppKey 等密钥只走环境变量、绝不写入配置或日志；不要在文档/命令中粘贴真实密钥。 - 遇到 `vertc.dev.selection_required` 或缺少凭证时，**禁止向用户索取、复述或记录 AppKey**；只让用户从 `error.details` 选择公开 App/Bot ID。确认没有 Bot 时使用内置 默认 Scene，并可引导用户访问 `https://console.volcengine.com/conversational-ai/agentManage` 定制。人工回退仅 指向本地编辑器或密钥管理工作流。 - Voice Agent 错误知识已按火山官方「事件和错误码」「公共错误码」核验为 `verified`；无逐项 公开来源的登录凭证与签名排障条目标为 `curated-seed`，输出会显式提示以官方为准。 - 每次读取 `vertc --format json` 的成功或失败输出时都检查顶层 `_notice`。用户询问 Runtime、 CLI 安装、版本或更新时，提示 `_notice.update` / `_notice.skills` 及对应命令。产品咨询、配置和 诊断场景忽略这些生命周期 notice。更新或同步仍需用户明确授权。 - 生命周期 notice 来自 24 小时本地缓存，不得打断当前任务或给正常命令增加同步网络等待。 冷缓存首次调用可能没有 notice，只触发后台刷新；这不代表已是最新版。不要为了等待 notice 轮询或重试，继续检查本任务后续每条 `vertc` JSON 输出即可。受控自动化可分别设置 `VERTC_NO_UPDATE_NOTIFIER=1`、`VERTC_NO_SKILLS_NOTIFIER=1`。 - `agent` / `env` / `token` 等为内部/legacy 命令（默认隐藏），非默认快速路径；优先用 公开命令 `init` / `auth login` / `dev` / `doctor` / `docs` / `explain-error` / `skills`。 ## 权威来源 - 产品边界：[AI 音视频互动方案产品简介](https://www.volcengine.com/docs/6348/1310537) - 最新变化：[AI 音视频互动方案发版说明](https://www.volcengine.com/docs/6348/1544162) - 完整文档树：[AI 音视频互动方案](https://www.volcengine.com/docs/6348/1310445)