ragflow/docs/guides
SmartDever02 e300873288 feat: Add WebSocket API for streaming responses
- Add WebSocket endpoint at /v1/ws/chat for real-time streaming
- Support multiple authentication methods (API token, user session, query params)
- Enable bidirectional communication for platforms like WeChat Mini Programs
- Implement streaming chat completions with incremental responses
- Add comprehensive error handling and connection management
- Include extensive inline documentation and comments

New files:
- api/apps/websocket_app.py: Main WebSocket API implementation
- docs/guides/websocket_api.md: Complete API documentation
- example/websocket/python_client.py: Python example client
- example/websocket/index.html: Web-based demo client
- example/websocket/README.md: Examples documentation

Features:
- Persistent WebSocket connections for multi-turn conversations
- Session management for conversation continuity
- Real-time streaming with low latency
- Compatible with WeChat Mini Programs and mobile apps
- Health check endpoint for connectivity testing
- Backward compatible with existing SSE endpoints

Resolves: #11683
2025-12-03 06:49:36 -03:00
..
agent Minor style changes (#11554) 2025-11-27 09:42:06 +08:00
chat Minor style changes (#11554) 2025-11-27 09:42:06 +08:00
dataset Minor style changes (#11554) 2025-11-27 09:42:06 +08:00
migration Fix typos (#11208) 2025-11-12 14:20:04 +08:00
models Docs: deploying a local model using Jina not supported (#11624) 2025-12-01 11:24:29 +08:00
team Fix typos (#11208) 2025-11-12 14:20:04 +08:00
_category_.json Added release notes for v0.13.0 (#3691) 2024-11-27 19:26:03 +08:00
accessing_admin_ui.md Doc: style fix (#11295) 2025-11-17 11:16:34 +08:00
ai_search.md Docs: Knowledge base renamed to dataset. (#10269) 2025-09-25 09:45:27 +08:00
manage_files.md Update version info to v0.22.1 (#11346) 2025-11-19 09:50:23 +08:00
manage_users_and_services.md Update version info to v0.22.1 (#11346) 2025-11-19 09:50:23 +08:00
run_health_check.md Support server health check by http://localhost:<port>/v1/system/healthz (#10150) 2025-09-19 11:11:07 +08:00
tracing.mdx Docs: Update version references to v0.22.0 in READMEs and docs (#11211) 2025-11-12 14:54:28 +08:00
upgrade_ragflow.mdx Update upgrade guide: add stop server step and rename section (#11654) 2025-12-02 14:51:03 +08:00
websocket_api.md feat: Add WebSocket API for streaming responses 2025-12-03 06:49:36 -03:00