ragflow/docs
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
..
contribution Docs: Added contribution guidelines and sandbox-related tips (#7685) 2025-05-16 16:28:21 +08:00
develop Update version info to v0.22.1 (#11346) 2025-11-19 09:50:23 +08:00
guides feat: Add WebSocket API for streaming responses 2025-12-03 06:49:36 -03:00
references Docs: How to specify an ingestion pipeline when creating a dataset (#11670) 2025-12-03 09:35:52 +08:00
_category_.json Reorganized docs for docusaurus publish (#860) 2024-05-21 20:53:55 +08:00
configurations.md feat: add Redis username support (#11608) 2025-12-01 11:26:20 +08:00
faq.mdx Feat: add mineru auto installer (#11649) 2025-12-02 17:29:26 +08:00
quickstart.mdx Minor style changes (#11554) 2025-11-27 09:42:06 +08:00
release_notes.md Docs: minor (#11385) 2025-11-19 19:41:21 +08:00