-
Notifications
You must be signed in to change notification settings - Fork 114
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #28 from 1dom/feature-rag
Add RAG feature page
- Loading branch information
Showing
2 changed files
with
27 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |