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:
@@ -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 回复。
|
发送文本输入,跳过 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 / 播放队列)。
|
客户端回执音频已在本地播放完成(含本地 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 音频。
|
在 `session.started` 之后可持续发送二进制 PCM 音频。
|
||||||
|
|
||||||
|
|||||||
@@ -120,7 +120,7 @@ flowchart LR
|
|||||||
| **后端** | FastAPI (Python 3.10+) |
|
| **后端** | FastAPI (Python 3.10+) |
|
||||||
| **引擎** | Python, WebSocket, asyncio |
|
| **引擎** | Python, WebSocket, asyncio |
|
||||||
| **数据库** | SQLite / PostgreSQL |
|
| **数据库** | SQLite / PostgreSQL |
|
||||||
| **知识库** | |
|
| **知识库** | chroma |
|
||||||
| **部署** | Docker, Nginx |
|
| **部署** | Docker, Nginx |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
Reference in New Issue
Block a user