Splite docs to developer and user and bring profile link back
This commit is contained in:
Xin Wang
53
docs-user/docs.json
Normal file
53
docs-user/docs.json
Normal file
@@ -0,0 +1,53 @@
|
||||
{
|
||||
"$schema": "https://mintlify.com/docs.json",
|
||||
"name": "AI 视频助手 · 用户文档",
|
||||
"theme": "mint",
|
||||
"colors": {
|
||||
"primary": "#1b2741",
|
||||
"light": "#3a4a6b",
|
||||
"dark": "#0c1426"
|
||||
},
|
||||
"logo": {
|
||||
"light": "/logo-light.svg",
|
||||
"dark": "/logo-dark.svg",
|
||||
"href": "/"
|
||||
},
|
||||
"appearance": {
|
||||
"default": "dark"
|
||||
},
|
||||
"fonts": {
|
||||
"family": "Inter",
|
||||
"weight": 400,
|
||||
"heading": {
|
||||
"family": "Cormorant Garamond",
|
||||
"weight": 300
|
||||
}
|
||||
},
|
||||
"icons": {
|
||||
"library": "lucide"
|
||||
},
|
||||
"background": {
|
||||
"decoration": "gradient",
|
||||
"color": {
|
||||
"light": "#f3f5fb",
|
||||
"dark": "#070b16"
|
||||
}
|
||||
},
|
||||
"styling": {
|
||||
"eyebrows": "breadcrumbs",
|
||||
"codeblocks": {
|
||||
"theme": {
|
||||
"light": "github-light",
|
||||
"dark": "github-dark"
|
||||
}
|
||||
}
|
||||
},
|
||||
"navigation": {
|
||||
"groups": [
|
||||
{
|
||||
"group": "产品",
|
||||
"pages": ["index", "features"]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
32
docs-user/features.mdx
Normal file
32
docs-user/features.mdx
Normal file
@@ -0,0 +1,32 @@
|
||||
---
|
||||
title: 核心功能
|
||||
description: 项目的主要能力与配置关系。
|
||||
icon: bot
|
||||
---
|
||||
|
||||
# 核心功能
|
||||
|
||||
## 助手配置
|
||||
|
||||
助手是运行时入口，支持提示词、工作流和外部托管三类大脑：
|
||||
|
||||
| 类型 | 用途 |
|
||||
| --- | --- |
|
||||
| `prompt` | 用提示词驱动的基础对话，可绑定工具。 |
|
||||
| `workflow` | 用节点图编排对话流程。 |
|
||||
| `dify` / `fastgpt` / `opencode` | 将对话处理交给外部 Agent 服务。 |
|
||||
|
||||
其中 `prompt` 和 `workflow` 支持 `pipeline` 与 `realtime`；外部托管 Agent 仅支持 `pipeline`。
|
||||
|
||||
## 模型与知识库
|
||||
|
||||
模型资源按具体协议注册，而不是按厂商名称猜测。当前支持 OpenAI 兼容的 LLM、ASR、TTS、Embedding、Realtime，也支持讯飞 ASR/TTS/SuperTTS、StepFun Realtime，以及 Dify、FastGPT、OpenCode Agent。
|
||||
|
||||
知识库可绑定一个 Embedding 模型资源。助手引用知识库后，需先解绑才能删除该知识库。
|
||||
|
||||
## 工具与历史
|
||||
|
||||
- 可复用工具分为 System、HTTP、Client 和 MCP；结束对话属于 System 类别。
|
||||
- HTTP 工具的 URL、请求头、参数和密钥独立管理。
|
||||
- Prompt 助手和 Workflow Agent 节点可开启内置系统工具：结束对话、更新状态、跳过本轮、请求人工接管；Workflow 还提供确定性的 Update State 节点。
|
||||
- 历史记录保留会话、通道、运行模式及消息序列，便于排查对话。
|
||||
22
docs-user/index.mdx
Normal file
22
docs-user/index.mdx
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
title: 产品概览
|
||||
description: 面向实时语音交互的助手管理与集成平台。
|
||||
icon: video
|
||||
---
|
||||
|
||||
# 产品概览
|
||||
|
||||
在一个界面中配置模型、知识库、工具和助手，并通过 WebRTC 或 WebSocket 接入实时语音对话。
|
||||
|
||||
## 平台组成
|
||||
|
||||
- **助手**：定义提示词、运行模式、模型绑定及可选工作流。
|
||||
- **组件库**：统一维护模型资源、知识库和可复用工具。
|
||||
- **语音引擎**：Pipecat 管线支持浏览器 WebRTC 与裸 WebSocket 音频流。
|
||||
|
||||
> 凭证只保存在模型资源或助手的服务端配置中；接口返回会自动打码。
|
||||
|
||||
## 下一步
|
||||
|
||||
- [核心功能](/features)：了解助手类型、模型、知识库与工具。
|
||||
- 本地启动与对接见仓库中的 `docs-developer/`（独立开发者文档站点）。
|
||||
18
docs-user/logo-dark.svg
Normal file
18
docs-user/logo-dark.svg
Normal file
@@ -0,0 +1,18 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 196 48" fill="none">
|
||||
<defs>
|
||||
<radialGradient id="sky" cx="0" cy="0" r="1" gradientTransform="matrix(31 0 0 31 14 10)" gradientUnits="userSpaceOnUse">
|
||||
<stop stop-color="#5F86B8" stop-opacity=".75"/>
|
||||
<stop offset="1" stop-color="#5F86B8" stop-opacity="0"/>
|
||||
</radialGradient>
|
||||
<radialGradient id="lavender" cx="0" cy="0" r="1" gradientTransform="matrix(28 0 0 28 38 39)" gradientUnits="userSpaceOnUse">
|
||||
<stop stop-color="#8A78AD" stop-opacity=".68"/>
|
||||
<stop offset="1" stop-color="#8A78AD" stop-opacity="0"/>
|
||||
</radialGradient>
|
||||
</defs>
|
||||
<circle cx="24" cy="24" r="24" fill="#E8EDF9"/>
|
||||
<circle cx="24" cy="24" r="24" fill="url(#sky)"/>
|
||||
<circle cx="24" cy="24" r="24" fill="url(#lavender)"/>
|
||||
<rect x="14" y="17.5" width="14" height="13" rx="2.25" stroke="#0C1426" stroke-width="2.5"/>
|
||||
<path d="m28 21.25 7-4v13.5l-7-4z" stroke="#0C1426" stroke-width="2.5" stroke-linejoin="round"/>
|
||||
<text x="61" y="31" fill="#E8EDF9" font-family="Cormorant Garamond, serif" font-size="24" font-weight="400">AI视频助手</text>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1.1 KiB |
18
docs-user/logo-light.svg
Normal file
18
docs-user/logo-light.svg
Normal file
@@ -0,0 +1,18 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 196 48" fill="none">
|
||||
<defs>
|
||||
<radialGradient id="sky" cx="0" cy="0" r="1" gradientTransform="matrix(31 0 0 31 14 10)" gradientUnits="userSpaceOnUse">
|
||||
<stop stop-color="#A8C8E8" stop-opacity=".8"/>
|
||||
<stop offset="1" stop-color="#A8C8E8" stop-opacity="0"/>
|
||||
</radialGradient>
|
||||
<radialGradient id="lavender" cx="0" cy="0" r="1" gradientTransform="matrix(28 0 0 28 38 39)" gradientUnits="userSpaceOnUse">
|
||||
<stop stop-color="#C8B8E0" stop-opacity=".72"/>
|
||||
<stop offset="1" stop-color="#C8B8E0" stop-opacity="0"/>
|
||||
</radialGradient>
|
||||
</defs>
|
||||
<circle cx="24" cy="24" r="24" fill="#E8EDF9"/>
|
||||
<circle cx="24" cy="24" r="24" fill="url(#sky)"/>
|
||||
<circle cx="24" cy="24" r="24" fill="url(#lavender)"/>
|
||||
<rect x="14" y="17.5" width="14" height="13" rx="2.25" stroke="#0C1426" stroke-width="2.5"/>
|
||||
<path d="m28 21.25 7-4v13.5l-7-4z" stroke="#0C1426" stroke-width="2.5" stroke-linejoin="round"/>
|
||||
<text x="61" y="31" fill="#0F1B33" font-family="Cormorant Garamond, serif" font-size="24" font-weight="400">AI视频助手</text>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1.1 KiB |
Reference in New Issue
Block a user