Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.
Before submitting, make sure you've checked the following:
Target branch: Please verify that the pull request targets the dev branch.
Description: Provide a concise description of the changes made in this pull request.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Documentation: Have you updated relevant documentation Open WebUI Docs, or other documentation sources?
Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
Testing: Have you written and run sufficient tests to validate the changes?
Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
Prefix: To clearly categorize this pull request, prefix the pull request title using one of the following:
BREAKING CHANGE: Significant changes that may affect compatibility
build: Changes that affect the build system or external dependencies
ci: Changes to our continuous integration processes or workflows
chore: Refactor, cleanup, or other non-functional code changes
docs: Documentation update or addition
feat: Introduces a new feature or enhancement to the codebase
fix: Bug fix or error correction
i18n: Internationalization or localization changes
perf: Performance improvement
refactor: Code restructuring for better maintainability, readability, or scalability
style: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
test: Adding missing tests or correcting existing tests
WIP: Work in progress, a temporary label for incomplete or ongoing work
Implemented lazy loading of file content in the Knowledge Base to improve performance and reduce initial load time. File content is only loaded when a user clicks on a file, rather than loading all file contents simultaneously.
Added
New getFileById API endpoint integration for fetching file content on demand
New handleFileClick function in KnowledgeBase component to manage lazy loading of file content
Changed
Modified file content loading strategy from eager to lazy loading
Updated file metadata handling in the backend to use FileMetadataResponse instead of FileModel
Fixed
Potential performance issues with large knowledge bases by deferring file content loading
Memory usage optimization by not loading all file contents at once
Breaking Changes
Additional Information
This change significantly improves the performance of the Knowledge Base, especially when dealing with large numbers of files
The implementation maintains all existing functionality while optimizing resource usage
File content is now loaded asynchronously when needed, providing a better user experience
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.
## 📋 Pull Request Information
**Original PR:** https://github.com/open-webui/open-webui/pull/12997
**Author:** [@Elmolesto](https://github.com/Elmolesto)
**Created:** 4/17/2025
**Status:** ✅ Merged
**Merged:** 4/18/2025
**Merged by:** [@tjbck](https://github.com/tjbck)
**Base:** `dev` ← **Head:** `feat/knowledge-lazy-load-content`
---
### 📝 Commits (3)
- [`0577dc2`](https://github.com/open-webui/open-webui/commit/0577dc299066374934d37311d7a6a719d8db6821) feat: Lazy load file content on click
- [`88f9737`](https://github.com/open-webui/open-webui/commit/88f97372d9cbbe8315bd19002eb742c4368c6cfc) fix: Show content on upload file
- [`14fa7d1`](https://github.com/open-webui/open-webui/commit/14fa7d16f9a8623e41c150e1611fb7a0b5538e9b) feat: Cache file content
### 📊 Changes
**2 files changed** (+43 additions, -14 deletions)
<details>
<summary>View changed files</summary>
📝 `backend/open_webui/routers/knowledge.py` (+8 -8)
📝 `src/lib/components/workspace/Knowledge/KnowledgeBase.svelte` (+35 -6)
</details>
### 📄 Description
# Pull Request Checklist
### Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/open-webui/open-webui/discussions) and describe your changes before submitting a pull request.
**Before submitting, make sure you've checked the following:**
- [x] **Target branch:** Please verify that the pull request targets the `dev` branch.
- [x] **Description:** Provide a concise description of the changes made in this pull request.
- [x] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description.
- [x] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources?
- [x] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation?
- [x] **Testing:** Have you written and run sufficient tests to validate the changes?
- [x] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
- [x] **Prefix:** To clearly categorize this pull request, prefix the pull request title using one of the following:
- **BREAKING CHANGE**: Significant changes that may affect compatibility
- **build**: Changes that affect the build system or external dependencies
- **ci**: Changes to our continuous integration processes or workflows
- **chore**: Refactor, cleanup, or other non-functional code changes
- **docs**: Documentation update or addition
- **feat**: Introduces a new feature or enhancement to the codebase
- **fix**: Bug fix or error correction
- **i18n**: Internationalization or localization changes
- **perf**: Performance improvement
- **refactor**: Code restructuring for better maintainability, readability, or scalability
- **style**: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
- **test**: Adding missing tests or correcting existing tests
- **WIP**: Work in progress, a temporary label for incomplete or ongoing work
# Changelog Entry
### Description
- Already commented on the issue here: https://github.com/open-webui/open-webui/discussions/12697, this is the first PR.
- Implemented lazy loading of file content in the Knowledge Base to improve performance and reduce initial load time. File content is only loaded when a user clicks on a file, rather than loading all file contents simultaneously.
### Added
- New `getFileById` API endpoint integration for fetching file content on demand
- New `handleFileClick` function in KnowledgeBase component to manage lazy loading of file content
### Changed
- Modified file content loading strategy from eager to lazy loading
- Updated file metadata handling in the backend to use `FileMetadataResponse` instead of `FileModel`
### Fixed
- Potential performance issues with large knowledge bases by deferring file content loading
- Memory usage optimization by not loading all file contents at once
### Breaking Changes
---
### Additional Information
- This change significantly improves the performance of the Knowledge Base, especially when dealing with large numbers of files
- The implementation maintains all existing functionality while optimizing resource usage
- File content is now loaded asynchronously when needed, providing a better user experience
Video:
https://github.com/user-attachments/assets/0fbb53af-8edc-4d52-a22d-616e43faedfe
---
<sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
📋 Pull Request Information
Original PR: https://github.com/open-webui/open-webui/pull/12997
Author: @Elmolesto
Created: 4/17/2025
Status: ✅ Merged
Merged: 4/18/2025
Merged by: @tjbck
Base:
dev← Head:feat/knowledge-lazy-load-content📝 Commits (3)
0577dc2feat: Lazy load file content on click88f9737fix: Show content on upload file14fa7d1feat: Cache file content📊 Changes
2 files changed (+43 additions, -14 deletions)
View changed files
📝
backend/open_webui/routers/knowledge.py(+8 -8)📝
src/lib/components/workspace/Knowledge/KnowledgeBase.svelte(+35 -6)📄 Description
Pull Request Checklist
Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.
Before submitting, make sure you've checked the following:
devbranch.Changelog Entry
Description
Added
getFileByIdAPI endpoint integration for fetching file content on demandhandleFileClickfunction in KnowledgeBase component to manage lazy loading of file contentChanged
FileMetadataResponseinstead ofFileModelFixed
Breaking Changes
Additional Information
Video:
https://github.com/user-attachments/assets/0fbb53af-8edc-4d52-a22d-616e43faedfe
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.