OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-05-20 11:18:42 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add RAG feature page

Browse Source
This commit is contained in:
1dom 2024-03-23 18:32:09 +00:00 committed by GitHub
parent cc9ee5bb2b
commit 44178eac59
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/features/rag.md Normal file
View File

@ -0,0 +1,26 @@
# Retrieval Augmented Generation (RAG)
Retrieval Augmented Generation (RAG) allows context from other diverse sources to be included in chats. Text from different sources is combined with the RAG template and prefixed to the user's prompt.
## Including external sources in chats
Activate RAG by starting the prompt with a `#` symbol. A list of sources will appear.
Once selected, a document icon appears at the top of the prompt, indicating successful retrieval.
### Local sources
Local documents must first be uploaded via the Documents section.
### Sourcing from the Web
Remote sources acheived with `#` followed by the target URL. Open WebUI fetches and parses the URL.
> **Tip:** Webpages often include extraneous information such as navigation and footer. Link to a raw or reader-friendly version of the page for better results.
## Document parsing
Local and remote documents have content extract with a variety of parsers. For more, see [https://github.com/open-webui/open-webui/blob/2fa94956f4e500bf5c42263124c758d8613ee05e/backend/apps/rag/main.py#L328]
## RAG Template Customisation
Modify the RAG template by accessing the 'settings' icon housed within the 'Documents' section.