From d0897aca929a36993e9659a49825cb5c6a12f59a Mon Sep 17 00:00:00 2001 From: Xin Wang Date: Mon, 2 Mar 2026 15:11:33 +0800 Subject: [PATCH] Update documentation to reflect rebranding from AI Video Assistant to Realtime Agent Studio (RAS) - Changed site name and description in mkdocs.yml. - Revised content in index.md to provide a comprehensive overview of RAS features and capabilities. - Updated API reference and error documentation to replace AI Video Assistant with RAS. - Modified deployment and getting started guides to align with the new branding. - Enhanced quickstart instructions to specify RAS service requirements. --- docs/content/api-reference/errors.md | 2 +- docs/content/api-reference/index.md | 4 +- docs/content/assistants/index.md | 2 +- docs/content/deployment/index.md | 2 +- docs/content/deployment/production.md | 2 +- docs/content/getting-started/index.md | 4 +- docs/content/index.md | 57 ++++++++++++++++++++++++++- docs/content/quickstart/index.md | 2 +- docs/mkdocs.yml | 6 +-- 9 files changed, 67 insertions(+), 14 deletions(-) diff --git a/docs/content/api-reference/errors.md b/docs/content/api-reference/errors.md index 6863e6b..b1b09dd 100644 --- a/docs/content/api-reference/errors.md +++ b/docs/content/api-reference/errors.md @@ -1,6 +1,6 @@ # 错误码 -本文档列出 AI Video Assistant API 的所有错误码及其说明。 +本文档列出 Realtime Agent Studio (RAS) API 的所有错误码及其说明。 ## 协议错误 diff --git a/docs/content/api-reference/index.md b/docs/content/api-reference/index.md index 516d837..527377a 100644 --- a/docs/content/api-reference/index.md +++ b/docs/content/api-reference/index.md @@ -1,10 +1,10 @@ # API 参考 -本节提供 AI Video Assistant 的完整 API 文档。 +本节提供 Realtime Agent Studio (RAS) 的完整 API 文档。 ## API 概览 -AI Video Assistant 提供两种类型的 API： +Realtime Agent Studio (RAS) 提供两种类型的 API： | API 类型 | 用途 | 协议 | |---------|------|------| diff --git a/docs/content/assistants/index.md b/docs/content/assistants/index.md index c8b6191..110a8dd 100644 --- a/docs/content/assistants/index.md +++ b/docs/content/assistants/index.md @@ -1,6 +1,6 @@ # 助手管理 -助手是 AI Video Assistant 的核心模块，用于创建和配置智能对话机器人。每个助手都可以独立配置提示词、语音、知识库和工具。 +助手是 Realtime Agent Studio (RAS) 的核心模块，用于创建和配置智能对话机器人。每个助手都可以独立配置提示词、语音、知识库和工具。 ## 概述 diff --git a/docs/content/deployment/index.md b/docs/content/deployment/index.md index 77652f6..9342b33 100644 --- a/docs/content/deployment/index.md +++ b/docs/content/deployment/index.md @@ -1,6 +1,6 @@ # 部署指南 -本章节介绍如何将 AI Video Assistant 部署到生产环境。 +本章节介绍如何将 Realtime Agent Studio (RAS) 部署到生产环境。 ## 部署方式 diff --git a/docs/content/deployment/production.md b/docs/content/deployment/production.md index cfd8163..a105d9d 100644 --- a/docs/content/deployment/production.md +++ b/docs/content/deployment/production.md @@ -1,6 +1,6 @@ # 生产环境部署 -本文档介绍如何将 AI Video Assistant 部署到生产环境，包括 Nginx 配置、SSL 证书、性能优化等。 +本文档介绍如何将 Realtime Agent Studio (RAS) 部署到生产环境，包括 Nginx 配置、SSL 证书、性能优化等。 ## Nginx 部署 diff --git a/docs/content/getting-started/index.md b/docs/content/getting-started/index.md index 09d6201..ffc496c 100644 --- a/docs/content/getting-started/index.md +++ b/docs/content/getting-started/index.md @@ -1,10 +1,10 @@ # 安装部署 -本章节介绍如何安装和配置 AI Video Assistant 开发环境。 +本章节介绍如何安装和配置 Realtime Agent Studio (RAS) 开发环境。 ## 概述 -AI Video Assistant 由以下组件构成： +Realtime Agent Studio (RAS) 由以下组件构成： | 组件 | 说明 | |------|------| diff --git a/docs/content/index.md b/docs/content/index.md index fcc0aeb..be0b631 100644 --- a/docs/content/index.md +++ b/docs/content/index.md @@ -1,6 +1,59 @@ -# AI Video Assistant +# 实时交互智能体工作平台 -AI Video Assistant 是一款基于大语言模型的智能对话与工作流管理平台，支持多模型集成、语音合成、自动化测试等功能，帮助企业快速构建智能客服系统。 +实时交互智能体工作平台（Realtime Agent Studio，简称 RAS）是一款构建实时交互音视频智能体的工作平台。支持管线式的全双工交互引擎和原生多模态模型两种核心，覆盖实时交互智能体构建过程中的配置、测试、发布、监控流程环节，平台包含大模型集成、语音识别、语音合成、自动化测试等功能，帮助用户快速构建实时交互智能体。 + +可以将该平台看作Vapi，Retell，ElevenAgents的开源替代。 + +## 功能特色 + +### 实时交互引擎 + +平台的核心是一个低延迟、高并发的实时交互引擎，支持两种架构模式： + +- **管线式全双工引擎**：将语音识别（ASR）、大语言模型（LLM）、语音合成（TTS）串联成流水线，支持语音打断，实现自然的对话体验 +- **原生多模态模型支持**：直接接入 GPT-4o Realtime、Gemini Live 等端到端多模态模型，获得更低延迟和更自然的语音交互 +- **智能打断处理**：支持基于声音活动和语义的turn-detection模型，引擎自动处理音频截断和状态同步 + +### 智能体配置管理 + +提供可视化的智能体配置界面，无需编码即可创建和调整智能体： + +- **系统提示词编辑**：支持角色设定，会话动态变量 +- **模型选择与参数调优**：灵活切换 LLM/ASR/TTS 供应商，调整温度、采样等参数 +- **工具/函数调用配置**：定义 +- **知识库关联**：接入 RAG 系统，让智能体基于私有文档回答问题 +- **工作流编辑**：使用可视化流程编辑器构建包含多个环节的交互助手及其上下文切换 + +### 交互测试工具 + +内置完整的测试工具链，保障智能体上线质量： + +- **实时调试控制台**：，在线测试体验智能体交互 ASR/LLM/TTS 各环节的输入输出 +- **自动化测试工具**：导入测试用例集或者构建对话测试智能体，自动执行并生成测试报告 + +### 开放接口 + +提供标准化的 API 接口，便于集成到现有系统： + +- **WebSocket 实时协议**：支持音视频流式传输、双向通信 +- **RESTful 管理接口**：助手 CRUD、会话管理、配置导入导出 +- **Webhook 回调**：会话开始/结束、工具调用、异常告警等事件通知 +- **SDK 支持**：提供 JavaScript、Python、移动端 SDK，简化客户端集成 + +### 交互历史监控 + +全面的会话记录和数据分析能力： + +- **完整会话回放**：保存音频、转写文本、LLM 响应、工具调用的完整链路 +- **实时仪表盘**：并发会话数、平均响应时间、错误率等关键指标可视化 +- **会话检索与筛选**：按时间、助手、用户、关键词等维度快速定位会话 + +### 自主部署 + +支持私有化部署，数据安全可控： + +- **Docker 一键部署**：提供 docker-compose 配置，一行命令启动完整平台 +- **模型本地化**：支持云端模型和本地私有化模型两种方案 ![仪表盘](images/dashboard.png) diff --git a/docs/content/quickstart/index.md b/docs/content/quickstart/index.md index ae6d7b8..32c0ce1 100644 --- a/docs/content/quickstart/index.md +++ b/docs/content/quickstart/index.md @@ -8,7 +8,7 @@ ## 前提条件 -- 已部署 AI Video Assistant 服务 +- 已部署 Realtime Agent Studio (RAS) 服务 - 已配置至少一个 LLM 模型 - 已配置至少一个 TTS 语音 diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 9ebac79..24b9c2a 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,7 +1,7 @@ -site_name: "AI Video Assistant" -site_description: "AI 视频助手 - 智能对话与工作流管理平台" +site_name: "实时交互智能体工作平台 (RAS)" +site_description: "实时交互智能体工作平台 (Realtime Agent Studio) - 智能对话与工作流管理平台" copyright: "2025" -site_author: "AI Video Assistant Team" +site_author: "RAS Team" docs_dir: "content" site_dir: "site"