From a8fa66e9cccbc59a97532017d0c73ed6065d5d3b Mon Sep 17 00:00:00 2001 From: Xin Wang Date: Wed, 4 Mar 2026 10:32:56 +0800 Subject: [PATCH] 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. --- docs/content/api-reference/websocket.md | 14 +++++++------- docs/content/index.md | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/content/api-reference/websocket.md b/docs/content/api-reference/websocket.md index 66b2924..6c1f4c0 100644 --- a/docs/content/api-reference/websocket.md +++ b/docs/content/api-reference/websocket.md @@ -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 音频。 diff --git a/docs/content/index.md b/docs/content/index.md index 6c82d06..2445f85 100644 --- a/docs/content/index.md +++ b/docs/content/index.md @@ -120,7 +120,7 @@ flowchart LR | **后端** | FastAPI (Python 3.10+) | | **引擎** | Python, WebSocket, asyncio | | **数据库** | SQLite / PostgreSQL | -| **知识库** | | +| **知识库** | chroma | | **部署** | Docker, Nginx | ---