Ultralytics Chat

` element (up to 5,000 characters), stripping navigation, scripts, SVGs, and elements marked with `data-chat-ignore`. This gives the AI full awareness of what the user is currently viewing. When disabled (default), the widget falls back to the page's `` tag. ### API Requirements Your backend should implement: ``` POST /api/chat Content-Type: application/json { "messages": [{"role": "user", "content": "Hello"}], "session_id": "optional-session-id", "context": { "url": "https://example.com/docs/widget", "title": "Docs page title", "description": "Visible page text or meta description", "path": "/docs/widget" }, "edit_index": 3 // optional when user edits a previous turn } Response: Server-Sent Events (SSE) data: {"content": "Hello! "} data: {"content": "How can "} data: {"content": "I help?"} data: [DONE] Headers: X-Session-ID: session-uuid (for persistence) Content-Type: text/event-stream ``` When the widget is switched to **Search** mode it will call the same base URL with `/search` replacing `/chat` via `POST /api/search` and expects a JSON body `{ "results": [{ title, url, text, score }] }`. ## 📱 Mobile Support ### iOS (Safari, Chrome, Firefox) - ✅ Safe area insets for notched devices - ✅ Keyboard handling with auto-resize - ✅ Home indicator padding - ✅ Smooth scrolling optimization ### Android (Chrome, Samsung Internet, Firefox) - ✅ Back button integration (History API) - ✅ Dynamic viewport height (address bar handling) - ✅ Touch action optimization - ✅ Gesture navigation support - ✅ Split-screen and multi-window modes ### Cross-Platform - ✅ Portrait/landscape orientation changes - ✅ Full-screen mobile modal (no horizontal scroll) - ✅ Background scroll lock when open - ✅ Keyboard shortcuts (desktop: Cmd/Ctrl+K, ESC) ## 🔧 Development ### Build Minified Version ```bash npm install -g terser terser js/chat.js -o js/chat.min.js -c -m ``` ### Local Testing ```bash # Serve examples locally python -m http.server 8000 # Open http://localhost:8000/examples/web/demo.html ``` ### Browser Compatibility Tested and working on: - ✅ Chrome/Edge 90+ (Blink) - ✅ Safari 14+ (WebKit) - ✅ Firefox 88+ (Gecko) - ✅ Mobile Safari (iOS 12+) - ✅ Chrome Mobile (Android 8+) - ✅ Samsung Internet (Android 8+) ## 🌟 Roadmap ### JavaScript Client (Current Focus) - [x] Chat widget with streaming - [x] Dark mode support - [x] Search mode - [x] Session persistence - [x] Production-ready security & performance - [x] Full mobile support (iOS & Android) - [x] Page content awareness (opt-in DOM scraping) - [ ] File upload support - [ ] Voice input - [ ] Multi-language support - [ ] Official v1.0.0 release ### Python Backend (Coming Soon) We plan to open-source our Python components once mature: - [ ] `LLMClient` class for Claude/OpenAI/etc. - [ ] FastAPI server implementation - [ ] Async streaming support - [ ] Tool/function calling - [ ] RAG integration with vector databases - [ ] Session management utilities - [ ] Rate limiting & caching ## 📖 Documentation - API reference for the widget and backend contracts: [`docs/API.md`](docs/API.md) - Product announcements and tutorials: [docs.ultralytics.com](https://docs.ultralytics.com) (LLM section rolling out alongside SDK updates) ## 💡 Contribute Ultralytics thrives on community collaboration! While this repo is currently experimental, we welcome: - **Bug Reports**: Found an issue? Report it on [GitHub Issues](https://github.com/ultralytics/llm/issues) - **Feature Requests**: Have an idea? Share it via [GitHub Issues](https://github.com/ultralytics/llm/issues) - **Pull Requests**: Want to contribute? Please read our [Contributing Guide](https://docs.ultralytics.com/help/contributing/) first - **Feedback**: Share your experience in our [Discord](https://discord.com/invite/ultralytics) or [Community Forums](https://community.ultralytics.com/) A heartfelt thank you 🙏 to all our contributors! [![Ultralytics open-source contributors](https://raw.githubusercontent.com/ultralytics/assets/main/im/image-contributors.png)](https://github.com/ultralytics/ultralytics/graphs/contributors) ## 📄 License Ultralytics offers two licensing options: - **AGPL-3.0 License**: Ideal for students, researchers, and enthusiasts passionate about open collaboration. This [OSI-approved](https://opensource.org/license/agpl-v3) open-source license promotes transparency and community involvement. See the [LICENSE](LICENSE) file for details. - **Enterprise License**: For commercial applications, this license permits seamless integration of Ultralytics software into commercial products, bypassing AGPL-3.0 copyleft requirements. Inquire about an [Ultralytics Enterprise License](https://www.ultralytics.com/license). ## 📮 Contact For bug reports or feature suggestions related to this repo or other Ultralytics projects, please use [GitHub Issues](https://github.com/ultralytics/llm/issues). For general questions, discussions, and community support, join our [Discord](https://discord.com/invite/ultralytics) server!