Skip to content

Commit

Permalink
Merge pull request #28 from 1dom/feature-rag
Browse files Browse the repository at this point in the history
Add RAG feature page
  • Loading branch information
tjbck authored Mar 31, 2024
2 parents a33743e + 7717038 commit 655ba6d
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 2 deletions.
3 changes: 1 addition & 2 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,7 @@ hide_title: true
- πŸš€ **Effortless Setup**: Install seamlessly using Docker or Kubernetes (kubectl, kustomize or helm) for a hassle-free experience.
- πŸ’» **Code Syntax Highlighting**: Enjoy enhanced code readability with our syntax highlighting feature.
- βœ’οΈπŸ”’ **Full Markdown and LaTeX Support**: Elevate your LLM experience with comprehensive Markdown and LaTeX capabilities for enriched interaction.
- πŸ“š **Local RAG Integration**: Dive into the future of chat interactions with the groundbreaking Retrieval Augmented Generation (RAG) support. This feature seamlessly integrates document interactions into your chat experience. You can load documents directly into the chat or add files to your document library, effortlessly accessing them using `#` command in the prompt. In its alpha phase, occasional issues may arise as we actively refine and enhance this feature to ensure optimal performance and reliability.
- 🌐 **Web Browsing Capability**: Seamlessly integrate websites into your chat experience using the `#` command followed by the URL. This feature allows you to incorporate web content directly into your conversations, enhancing the richness and depth of your interactions.
- πŸ“šπŸŒ **[Local and remote RAG Integration](tutorial/rag)**: Dive into the future of chat interactions with the groundbreaking Retrieval Augmented Generation (RAG) support. Seamlessly integrate local and web based content into your chats by starting a prompt with `#`. This feature is still in its alpha phase, occasional issues may arise!
- πŸ“œ **Prompt Preset Support**: Instantly access preset prompts using the `/` command in the chat input. Load predefined conversation starters effortlessly and expedite your interactions. Effortlessly import prompts through [Open WebUI Community](https://openwebui.com/) integration.
- πŸ‘πŸ‘Ž **RLHF Annotation**: Empower your messages by rating them with thumbs up and thumbs down, facilitating the creation of datasets for Reinforcement Learning from Human Feedback (RLHF). Utilize your messages to train or fine-tune models, all while ensuring the confidentiality of locally saved data.
- 🏷️ **Conversation Tagging**: Effortlessly categorize and locate specific chats for quick reference and streamlined data collection.
Expand Down
26 changes: 26 additions & 0 deletions docs/tutorial/rag.md
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.

0 comments on commit 655ba6d

Please sign in to comment.