Update documentation to reflect changes in WebSocket API message formatting and knowledge base

- Updated the WebSocket API reference to improve clarity by removing unnecessary headings and emphasizing message types.
- Revised the index.md to specify 'chroma' as the knowledge base, enhancing the overview of the platform's architecture.
This commit is contained in:
Xin Wang
2026-03-04 10:32:56 +08:00
parent aaef370d70
commit a8fa66e9cc
2 changed files with 8 additions and 8 deletions

View File

@@ -39,7 +39,7 @@ Server <- session.stopped
## 客户端 -> 服务端消息
### 1. Session Start: `session.start`
`session.start`
客户端连接后发送的第一个消息,用于启动对话会话。
@@ -108,7 +108,7 @@ Server <- session.stopped
---
### 2. Text Input: `input.text`
`input.text`
发送文本输入,跳过 ASR 识别,直接触发 LLM 回复。
@@ -126,7 +126,7 @@ Server <- session.stopped
---
### 3. Response Cancel: `response.cancel`
`response.cancel`
请求中断当前回答。
@@ -144,7 +144,7 @@ Server <- session.stopped
---
### 4. Output Audio Played: `output.audio.played`
`output.audio.played`
客户端回执音频已在本地播放完成(含本地 jitter buffer / 播放队列)。
@@ -170,7 +170,7 @@ Server <- session.stopped
---
### 5. Tool Call Results: `tool_call.results`
`tool_call.results`
回传客户端执行的工具结果。
@@ -201,7 +201,7 @@ Server <- session.stopped
---
### 6. Session Stop: `session.stop`
`session.stop`
结束对话会话。
@@ -219,7 +219,7 @@ Server <- session.stopped
---
### 7. Binary Audio
`Binary Audio`
`session.started` 之后可持续发送二进制 PCM 音频。

View File

@@ -120,7 +120,7 @@ flowchart LR
| **后端** | FastAPI (Python 3.10+) |
| **引擎** | Python, WebSocket, asyncio |
| **数据库** | SQLite / PostgreSQL |
| **知识库** | |
| **知识库** | chroma |
| **部署** | Docker, Nginx |
---