byted-interactai-guide
volcengine/volcenginertc_cli
Guide for Volcano Engine InteractAI voice agent setup, configuration, and troubleshooting.
What is byted-interactai-guide?
This skill explains Volcano Engine's AI audio-video interaction product capabilities, boundaries, and official documentation. It helps generate or modify VoiceChat/Aibot configurations and guides users through building, running, and diagnosing minimal InteractAI VoiceChat Web demos.
- Explain product capabilities, applicable boundaries, and latest official documentation for Volcano Engine AI audio-video interaction
- Generate, modify, and validate VoiceChat/Aibot configuration using natural language
- Help users build and run minimal InteractAI VoiceChat Web Demo projects
- Diagnose and troubleshoot common issues: Agent not entering room, no audio, missing subtitles, ASR/LLM/TTS failures
- Query and retrieve RTC documentation with structured search and fetch workflows
- Interpret RTC and VoiceChat error codes with verified remediation guidance
How to install byted-interactai-guide
npx skills add https://github.com/volcengine/volcenginertc_cli --skill byted-interactai-guide- Node.js and npm (for CLI installation)
- Volcano Engine account with RTC service enabled
- Optional: @volcengine/rtc-cli installed globally for execution mode (`npm install -g @volcengine/rtc-cli`)
How to use byted-interactai-guide
- 1.Run `vertc version --format json` to verify CLI availability
- 2.Execute `vertc init --scene voice-agent --platform web --name my-agent` to scaffold a new project
- 3.Run `vertc auth login` to authenticate with your Volcano Engine account
- 4.Use `vertc dev` to start the development server and Web demo
- 5.Click **Start** in the web interface to enter the room and begin voice conversation
- 6.Run `vertc doctor` to diagnose environment and project readiness issues
- 7.Use `vertc explain-error <code>` to look up error code meanings and fixes
Use cases
- Building a conversational voice agent demo integrated with Volcano Engine RTC
- Generating or modifying StartVoiceChat configuration parameters for specific use cases
- Troubleshooting "AI didn't respond" or "Agent didn't enter room" failures with staged diagnosis
- Validating VoiceChat API fields and configuration compatibility with current product versions
- Searching official RTC documentation to verify feature support and API details
- Developers integrating Volcano Engine's InteractAI voice agent platform
- Teams building conversational AI applications with audio-video interaction
- Engineers troubleshooting voice agent deployment and runtime issues
- Product teams verifying feature support and API compatibility
byted-interactai-guide FAQ
No. Consultation mode (documentation queries, concept explanations, troubleshooting based on logs) works without CLI. Execution mode (creating projects, authentication, running demos, auto-diagnosis) requires the CLI; the skill will check availability and guide installation if needed.
First verify the user successfully entered the room and audio is publishing. Then check StartVoiceChat configuration, Agent credentials, and RTC subscription settings. Use `vertc doctor` for environment diagnostics and consult the voice-agent-runtime reference for detailed stage-by-stage diagnosis.
Describe your requirements in natural language (model, voice, language, etc.). The skill reads voice-agent-config.md and related references to generate or modify the configuration. Always verify field compatibility with the current product version and API documentation before deployment.
Yes. Provide the error code and the skill will use `vertc explain-error` to retrieve the meaning, source domain (web-sdk or voice-agent), and remediation steps. For verified codes, the guidance is based on official Volcano Engine documentation.
The skill will clearly state which operations require the CLI and which can proceed without it (documentation, troubleshooting, design review). You can continue consulting and diagnosing based on logs and symptoms. To enable execution, install the CLI with `npm install -g @volcengine/rtc-cli` and verify with `vertc version --format json`.
Full instructions (SKILL.md)
Source of truth, from volcengine/volcenginertc_cli.
name: byted-interactai-guide description: 解释火山 AI 音视频互动的产品能力、适用边界与最新官方文档;生成或修改 VoiceChat/Aibot 配置;并帮助用户搭建、运行和分阶段排查最小 InteractAI VoiceChat Web Demo。 version: "0.0.7"
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:
- 明确说明当前环境未安装或无法访问 CLI,并指出因此暂时不能执行哪些操作。
- 同时告诉用户仍可继续文档咨询、方案讨论和基于现有证据的人工排障,不要把 Skill 整体 判定为不可用,也不要把 CLI 缺失解释成 RTC、VoiceChat 或项目故障。
- 若用户希望继续实际执行,提供
npm install -g @volcengine/rtc-cli,安装后用vertc version --format json验证。上层 Runtime 提供自动初始化时,由上层脚本安装;其余环境 需要先征得用户同意。
最短可运行路径(公开命令)
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
轮询或重试,继续检查本任务后续每条
vertcJSON 输出即可。受控自动化可分别设置VERTC_NO_UPDATE_NOTIFIER=1、VERTC_NO_SKILLS_NOTIFIER=1。 agent/env/token等为内部/legacy 命令(默认隐藏),非默认快速路径;优先用 公开命令init/auth login/dev/doctor/docs/explain-error/skills。
权威来源
- 产品边界:AI 音视频互动方案产品简介
- 最新变化:AI 音视频互动方案发版说明
- 完整文档树:AI 音视频互动方案
Related skills
More from volcengine/volcenginertc_cli and the wider catalog.

vtex-io-react-apps
Build React components and store blocks for VTEX IO storefronts with interfaces, Site Editor schemas, and css-handles styling.

create-adaptable-composable
Create library-grade Vue composables that accept plain values, refs, or getters for maximum reusability.

vue-best-practices
Vue 3 best practices guide: Composition API, TypeScript, and component architecture patterns.

vue-debug-guides
Vue 3 debugging guides for runtime errors, warnings, async failures, and hydration issues.

vue-development-guides
Best practices and patterns for Vue 3+ and Nuxt 3+ development with composition API and SFC guidelines.

vue-jsx-best-practices
Master Vue JSX syntax and avoid React JSX pitfalls in Vue components.