mirror of
https://github.com/open-webui/docs
synced 2025-05-20 19:26:22 +00:00
More adjustments; laying groundwork
More adjustments; laying groundwork
This commit is contained in:
parent
ff1a6d71c2
commit
9b457e6e0c
8
docs/features/PWA.md
Normal file
8
docs/features/PWA.md
Normal file
@ -0,0 +1,8 @@
|
||||
---
|
||||
sidebar_position: 18
|
||||
title: "📱 Progressive Web App"
|
||||
---
|
||||
|
||||
📱 Progressive Web App for Mobile: Enjoy a native progressive web application experience on your mobile device with offline access on localhost or a personal domain, and a smooth user interface. In order for our PWA to be installable on your device, it must be delivered in a secure context. This usually means that it must be served over HTTPS.
|
||||
|
||||
To set up a PWA, you'll need some understanding of technologies like Linux, Docker, and reverse proxies such as Nginx, Caddy, or Traefik. Using these tools can help streamline the process of building and deploying a PWA tailored to your needs. While there's no "one-click install" option available, and your available option to securely deploy your Open WebUI instance over HTTPS requires user experience, using these resources can make it easier to create and deploy a PWA tailored to your needs.
|
7
docs/features/chat-overview/artifacts.md
Normal file
7
docs/features/chat-overview/artifacts.md
Normal file
@ -0,0 +1,7 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: "🏺 Artifacts"
|
||||
---
|
||||
|
||||
|
||||
Test
|
7
docs/features/chat-overview/favorite.md
Normal file
7
docs/features/chat-overview/favorite.md
Normal file
@ -0,0 +1,7 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: "⭐ Favorite Response"
|
||||
---
|
||||
|
||||
|
||||
Test
|
4
docs/features/chat-overview/index.mdx
Normal file
4
docs/features/chat-overview/index.mdx
Normal file
@ -0,0 +1,4 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: "😏 Chat Overview"
|
||||
---
|
8
docs/features/chatshare.md
Normal file
8
docs/features/chatshare.md
Normal file
@ -0,0 +1,8 @@
|
||||
---
|
||||
sidebar_position: 19
|
||||
title: "🗨️ Chat Sharing"
|
||||
---
|
||||
|
||||
|
||||
|
||||
🗨️ Local Chat Sharing: Generate and share chat links between users in an efficient and seamless manner, thereby enhancing collaboration and communication.
|
@ -2,3 +2,5 @@
|
||||
sidebar_position: 15
|
||||
title: "🧠 Memory (Experimental)"
|
||||
---
|
||||
|
||||
🧠 Memory Feature: Manually add information you want your LLMs to remember via the Settings > Personalization > Memory menu. Memories can be added, edited, and deleted.
|
||||
|
8
docs/features/mermaid.md
Normal file
8
docs/features/mermaid.md
Normal file
@ -0,0 +1,8 @@
|
||||
---
|
||||
sidebar_position: 17
|
||||
title: "🌊 MermaidJS Rendering"
|
||||
---
|
||||
|
||||
|
||||
|
||||
Create visually appealing diagrams and flowcharts directly within Open WebUI using the Mermaid Diagramming and charting tool, which supports Mermaid syntax rendering.
|
@ -2,3 +2,5 @@
|
||||
sidebar_position: 0
|
||||
title: "💬 Chat"
|
||||
---
|
||||
|
||||
Test
|
@ -2,3 +2,6 @@
|
||||
sidebar_position: 1
|
||||
title: "✅ Completions"
|
||||
---
|
||||
|
||||
|
||||
Test
|
@ -6,3 +6,5 @@ title: "🛝 Playground (Beta)"
|
||||
import { TopBanners } from "@site/src/components/TopBanners";
|
||||
|
||||
<TopBanners />
|
||||
|
||||
Test
|
8
docs/features/python.md
Normal file
8
docs/features/python.md
Normal file
@ -0,0 +1,8 @@
|
||||
---
|
||||
sidebar_position: 16
|
||||
title: "🐍 Python Code Execution"
|
||||
---
|
||||
|
||||
|
||||
|
||||
Python Code Execution: Execute Python code locally in the browser via Pyodide with a range of libraries supported by Pyodide.
|
@ -3,7 +3,7 @@ sidebar_position: 8
|
||||
title: "🔎 Retrieval Augmented Generation (RAG)"
|
||||
---
|
||||
|
||||
Retrieval Augmented Generation (RAG) is a a cutting-edge technology that enhances the conversational capabilities of chatbots by incorporating context from diverse sources. It works by retrieving relevant information from a wide range of sources such as local and remote documents, web content, and even multimedia sources like YouTube videos. The retrieved text is then combined with a predefined RAG template and prefixed to the user's prompt, providing a more informed and contextually relevant response.
|
||||
Retrieval Augmented Generation (RAG) is a cutting-edge technology that enhances the conversational capabilities of chatbots by incorporating context from diverse sources. It works by retrieving relevant information from a wide range of sources such as local and remote documents, web content, and even multimedia sources like YouTube videos. The retrieved text is then combined with a predefined RAG template and prefixed to the user's prompt, providing a more informed and contextually relevant response.
|
||||
|
||||
One of the key advantages of RAG is its ability to access and integrate information from a variety of sources, making it an ideal solution for complex conversational scenarios. For instance, when a user asks a question related to a specific document or web page, RAG can retrieve and incorporate the relevant information from that source into the chat response. RAG can also retrieve and incorporate information from multimedia sources like YouTube videos. By analyzing the transcripts or captions of these videos, RAG can extract relevant information and incorporate it into the chat response.
|
||||
|
||||
@ -11,6 +11,8 @@ One of the key advantages of RAG is its ability to access and integrate informat
|
||||
|
||||
Local documents must first be uploaded via the Documents section of the Workspace area to access them using the `#` symbol before a query. Click on the formatted URL in the that appears above the chat box. Once selected, a document icon appears above `Send a message`, indicating successful retrieval.
|
||||
|
||||
You can also load documents into the workspace area with their access by starting a prompt with `#`, followed by a URL. This can help incorporate web content directly into your conversations.
|
||||
|
||||
## Web Search for RAG
|
||||
|
||||
For web content integration, start a query in a chat with `#`, followed by the target URL. Click on the formatted URL in the box that appears above the chat box. Once selected, a document icon appears above `Send a message`, indicating successful retrieval. Open WebUI fetches and parses information from the URL if it can.
|
||||
|
@ -1,4 +1,4 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: "👨👧👦 Assign Users to Usergroup"
|
||||
title: "👥 Assign Users to Usergroup"
|
||||
---
|
@ -1,4 +1,4 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: "👨👧👦 Provide User Group Access"
|
||||
title: "✅ Provide User Group Access"
|
||||
---
|
@ -1,4 +1,4 @@
|
||||
---
|
||||
sidebar_position: 0
|
||||
title: "👨👧👦 User Group Permissions"
|
||||
title: "☑️ User Group Permissions"
|
||||
---
|
8
docs/features/videocall.md
Normal file
8
docs/features/videocall.md
Normal file
@ -0,0 +1,8 @@
|
||||
---
|
||||
sidebar_position: 21
|
||||
title: "📹 Video Call"
|
||||
---
|
||||
|
||||
📹 Video Call Feature: Enable video calls with supported vision models like LlaVA and GPT-4o, adding a visual dimension to your communications.
|
||||
|
||||
Both Camera & Microphone access is required using a secure connection over HTTPS for this feature to work.
|
9
docs/features/voicecall.md
Normal file
9
docs/features/voicecall.md
Normal file
@ -0,0 +1,9 @@
|
||||
---
|
||||
sidebar_position: 20
|
||||
title: "🎙️ Hands-Free Voice Call"
|
||||
---
|
||||
|
||||
|
||||
🎙️ Hands-Free Voice Call Feature: Initiate voice calls without needing to use your hands, making interactions more seamless.
|
||||
|
||||
Microphone access is required using a secure connection over HTTPS for this feature to work.
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: Installing Docker
|
||||
title: 🐳 Installing Docker
|
||||
---
|
||||
|
||||
:::warning
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
title: "Hosting UI and Models separately"
|
||||
title: "🗄️ Hosting UI and Models separately"
|
||||
---
|
||||
|
||||
:::warning
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 16
|
||||
title: "Browser Search Engine"
|
||||
title: "🌐 Browser Search Engine"
|
||||
---
|
||||
|
||||
:::warning
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 13
|
||||
title: "Continue.dev VSCode Extension with Open WebUI"
|
||||
title: "⚛️ Continue.dev VSCode Extension with Open WebUI"
|
||||
---
|
||||
|
||||
:::warning
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 14
|
||||
title: Setting up with custom CA store
|
||||
title: "🛃 Setting up with custom CA store"
|
||||
---
|
||||
|
||||
:::warning
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: HTTPS using Nginx
|
||||
title: "🔒 HTTPS using Nginx"
|
||||
---
|
||||
|
||||
:::warning
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 11
|
||||
title: "Local LLM Setup with IPEX-LLM on Intel GPU"
|
||||
title: "🖥️ Local LLM Setup with IPEX-LLM on Intel GPU"
|
||||
---
|
||||
|
||||
:::warning
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 20
|
||||
title: "Monitoring and debugging with Langfuse"
|
||||
title: "💥 Monitoring and debugging with Langfuse"
|
||||
---
|
||||
|
||||
# Langfuse Integration with OpenWebUI
|
||||
|
4
docs/tutorials/stateless/index.mdx
Normal file
4
docs/tutorials/stateless/index.mdx
Normal file
@ -0,0 +1,4 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
title: "⚖️ Stateless Load Balancing"
|
||||
---
|
4
docs/tutorials/text-to-speech/index.mdx
Normal file
4
docs/tutorials/text-to-speech/index.mdx
Normal file
@ -0,0 +1,4 @@
|
||||
---
|
||||
sidebar_position: 0
|
||||
title: "🗨️ Text-to-Speech"
|
||||
---
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 18
|
||||
title: "Edge TTS"
|
||||
sidebar_position: 1
|
||||
title: "🗨️ Openai-edge-tts using Docker"
|
||||
---
|
||||
|
||||
:::warning
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 12
|
||||
title: "TTS - OpenedAI-Speech using Docker"
|
||||
sidebar_position: 2
|
||||
title: "🗨️ Openedai-speech using Docker"
|
||||
---
|
||||
|
||||
:::warning
|
Loading…
Reference in New Issue
Block a user