mirror of
https://github.com/open-webui/docs
synced 2025-06-16 11:28:36 +00:00
refac
This commit is contained in:
Timothy Jaeryang Baek
parent
f69cd8d257
commit
dc65e77f7a
docs
features/plugin
tutorials
deployment
docker-install.mdhttps-nginx.mdimages.mdintegrations
_category_.jsonapachetika.mdbrowser-search-engine.mdcontinue-dev.mdcustom-ca.mdindex.mdxipex_llm.mdredis.md
text-to-speech
Kokoro-FastAPI-integration.md_category_.jsonindex.mdxopenai-edge-tts-integration.mdopenedai-speech-integration.md
tips
@ -5,9 +5,9 @@ title: "🧰 Functions"
|
||||
|
||||
## 🚀 What Are Functions?
|
||||
|
||||
Functions are like **plugins** for OpenWebUI. They help you **extend its capabilities**—whether it’s adding support for new AI model providers like Anthropic or Vertex AI, tweaking how messages are processed, or introducing custom buttons to the interface for better usability.
|
||||
Functions are like **plugins** for Open WebUI. They help you **extend its capabilities**—whether it’s adding support for new AI model providers like Anthropic or Vertex AI, tweaking how messages are processed, or introducing custom buttons to the interface for better usability.
|
||||
|
||||
Unlike external tools that may require complex integrations, **Functions are built-in and run within the OpenWebUI environment.** That means they are fast, modular, and don’t rely on external dependencies.
|
||||
Unlike external tools that may require complex integrations, **Functions are built-in and run within the Open WebUI environment.** That means they are fast, modular, and don’t rely on external dependencies.
|
||||
|
||||
Think of Functions as **modular building blocks** that let you enhance how the WebUI works, tailored exactly to what you need. They’re lightweight, highly customizable, and written in **pure Python**, so you have the freedom to create anything—from new AI-powered workflows to integrations with anything you use, like Google Search or Home Assistant.
|
||||
|
||||
@ -15,7 +15,7 @@ Think of Functions as **modular building blocks** that let you enhance how the W
|
||||
|
||||
## 🏗️ Types of Functions
|
||||
|
||||
There are **three types of Functions** in OpenWebUI, each with a specific purpose. Let’s break them down and explain exactly what they do:
|
||||
There are **three types of Functions** in Open WebUI, each with a specific purpose. Let’s break them down and explain exactly what they do:
|
||||
|
||||
---
|
||||
|
||||
@ -25,10 +25,10 @@ A **Pipe Function** is how you create **custom agents/models** or integrations,
|
||||
|
||||
**What does it do?**
|
||||
- Pipes let you define complex workflows. For instance, you could create a Pipe that sends data to **Model A** and **Model B**, processes their outputs, and combines the results into one finalized answer.
|
||||
- Pipes don’t even have to use AI! They can be setups for **search APIs**, **weather data**, or even systems like **Home Assistant**. Basically, anything you’d like to interact with can become part of OpenWebUI.
|
||||
- Pipes don’t even have to use AI! They can be setups for **search APIs**, **weather data**, or even systems like **Home Assistant**. Basically, anything you’d like to interact with can become part of Open WebUI.
|
||||
|
||||
**Use case example:**
|
||||
Imagine you want to query Google Search directly from OpenWebUI. You can create a Pipe Function that:
|
||||
Imagine you want to query Google Search directly from Open WebUI. You can create a Pipe Function that:
|
||||
1. Takes your message as the search query.
|
||||
2. Sends the query to Google Search’s API.
|
||||
3. Processes the response and returns it to you inside the WebUI like a normal "model" response.
|
||||
@ -79,10 +79,10 @@ Learn how to set them up in the [**Action Functions Guide**](./action.mdx).
|
||||
|
||||
## 🛠️ How to Use Functions
|
||||
|
||||
Here's how to put Functions to work in OpenWebUI:
|
||||
Here's how to put Functions to work in Open WebUI:
|
||||
|
||||
### 1. **Install Functions**
|
||||
You can install Functions via the OpenWebUI interface or by importing them manually. You can find community-created functions on the [OpenWebUI Community Site](https://openwebui.com/functions).
|
||||
You can install Functions via the Open WebUI interface or by importing them manually. You can find community-created functions on the [Open WebUI Community Site](https://openwebui.com/functions).
|
||||
|
||||
⚠️ **Be cautious.** Only install Functions from trusted sources. Running unknown code poses security risks.
|
||||
|
||||
@ -112,13 +112,13 @@ Once you’ve followed the setup process, Functions will seamlessly enhance your
|
||||
|
||||
## ✅ Why Use Functions?
|
||||
|
||||
Functions are designed for anyone who wants to **unlock new possibilities** with OpenWebUI:
|
||||
Functions are designed for anyone who wants to **unlock new possibilities** with Open WebUI:
|
||||
|
||||
- **Extend**: Add new models or integrate with non-AI tools like APIs, databases, or smart devices.
|
||||
- **Optimize**: Tweak inputs and outputs to fit your use case perfectly.
|
||||
- **Simplify**: Add buttons or shortcuts to make the interface intuitive and efficient.
|
||||
|
||||
Whether you’re customizing workflows for specific projects, integrating external data, or just making OpenWebUI easier to use, Functions are the key to taking control of your instance.
|
||||
Whether you’re customizing workflows for specific projects, integrating external data, or just making Open WebUI easier to use, Functions are the key to taking control of your instance.
|
||||
|
||||
---
|
||||
|
||||
@ -130,4 +130,4 @@ Whether you’re customizing workflows for specific projects, integrating extern
|
||||
- [Filter Functions Guide](./filter.mdx)
|
||||
- [Action Functions Guide](./action.mdx)
|
||||
|
||||
By leveraging Functions, you’ll bring entirely new capabilities to your OpenWebUI setup. Start experimenting today! 🚀
|
||||
By leveraging Functions, you’ll bring entirely new capabilities to your Open WebUI setup. Start experimenting today! 🚀
|
||||
@ -29,13 +29,13 @@ Navigate to the community site: https://openwebui.com/tools/
|
||||
1) Click on the Tool you wish to import
|
||||
2) Click the blue “Get” button in the top right-hand corner of the page
|
||||
3) Click “Download as JSON export”
|
||||
4) You can now upload the Tool into OpenWebUI by navigating to Workspace => Tools and clicking “Import Tools”
|
||||
4) You can now upload the Tool into Open WebUI by navigating to Workspace => Tools and clicking “Import Tools”
|
||||
|
||||
### Import via your OpenWebUI URL
|
||||
### Import via your Open WebUI URL
|
||||
1) Navigate to the community site: https://openwebui.com/tools/
|
||||
2) Click on the Tool you wish to import
|
||||
3) Click the blue “Get” button in the top right-hand corner of the page
|
||||
4) Enter the IP address of your OpenWebUI instance and click “Import to WebUI” which will automatically open your instance and allow you to import the Tool.
|
||||
4) Enter the IP address of your Open WebUI instance and click “Import to WebUI” which will automatically open your instance and allow you to import the Tool.
|
||||
|
||||
Note: You can install your own Tools and other Tools not tracked on the community site using the manual import method. Please do not import Tools you do not understand or are not from a trustworthy source. Running unknown code is ALWAYS a risk.
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ import { TopBanners } from "@site/src/components/TopBanners";
|
||||
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
:::info
|
||||
|
||||
@ -4,7 +4,7 @@ title: 🐳 Installing Docker
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
# Installing Docker
|
||||
|
||||
@ -4,7 +4,7 @@ title: "🔒 HTTPS using Nginx"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
# HTTPS using Nginx
|
||||
|
||||
@ -4,7 +4,7 @@ title: "🎨 Image Generation"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
# 🎨 Image Generation
|
||||
|
||||
7
docs/tutorials/integrations/_category_.json
Normal file
7
docs/tutorials/integrations/_category_.json
Normal file
@ -0,0 +1,7 @@
|
||||
{
|
||||
"label": "🔗 Integrations",
|
||||
"position": 2,
|
||||
"link": {
|
||||
"type": "generated-index"
|
||||
}
|
||||
}
|
||||
@ -4,7 +4,7 @@ title: "🪶 Apache Tika Extraction"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
## 🪶 Apache Tika Extraction
|
||||
|
||||
@ -4,7 +4,7 @@ title: "🌐 Browser Search Engine"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
# Browser Search Engine Integration
|
||||
|
||||
@ -4,7 +4,7 @@ title: "⚛️ Continue.dev VSCode Extension with Open WebUI"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
# Integrating Continue.dev VSCode Extension with Open WebUI
|
||||
|
||||
@ -4,7 +4,7 @@ title: "🛃 Setting up with Custom CA Store"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
If you get an `[SSL: CERTIFICATE_VERIFY_FAILED]` error when trying to run OI, most likely the issue is that you are on a network which intercepts HTTPS traffic (e.g. a corporate network).
|
||||
|
||||
@ -1,4 +0,0 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: "🔗 Integrations"
|
||||
---
|
||||
@ -4,7 +4,7 @@ title: "🖥️ Local LLM Setup with IPEX-LLM on Intel GPU"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
:::note
|
||||
|
||||
@ -4,7 +4,7 @@ title: "🔗 Redis Websocket Support"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
# 🔗 Redis Websocket Support
|
||||
|
||||
@ -4,7 +4,7 @@ title: "🗨️ Kokoro-FastAPI Using Docker"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
# Integrating `Kokoro-FastAPI` 🗣️ with Open WebUI
|
||||
|
||||
7
docs/tutorials/text-to-speech/_category_.json
Normal file
7
docs/tutorials/text-to-speech/_category_.json
Normal file
@ -0,0 +1,7 @@
|
||||
{
|
||||
"label": "🗨️ Text-to-Speech",
|
||||
"position": 5,
|
||||
"link": {
|
||||
"type": "generated-index"
|
||||
}
|
||||
}
|
||||
@ -1,4 +0,0 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
title: "🗨️ Text-to-Speech"
|
||||
---
|
||||
@ -4,7 +4,7 @@ title: "🗨️ Edge TTS Using Docker"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
# Integrating `openai-edge-tts` 🗣️ with Open WebUI
|
||||
|
||||
@ -4,7 +4,7 @@ title: "🗨️ Openedai-speech Using Docker"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
**Integrating `openedai-speech` into Open WebUI using Docker**
|
||||
|
||||
7
docs/tutorials/tips/_category_.json
Normal file
7
docs/tutorials/tips/_category_.json
Normal file
@ -0,0 +1,7 @@
|
||||
{
|
||||
"label": "💡 Tips & Tricks",
|
||||
"position": 900,
|
||||
"link": {
|
||||
"type": "generated-index"
|
||||
}
|
||||
}
|
||||
@ -4,7 +4,7 @@ title: "🤝 Contributing Tutorials"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
# Contributing Tutorials
|
||||
@ -98,7 +98,7 @@ Community-contributed tutorials must include the the following:
|
||||
|
||||
```
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
```
|
||||
|
||||
|
||||
@ -1,4 +0,0 @@
|
||||
---
|
||||
sidebar_position: 900
|
||||
title: "💡 Tips & Tricks"
|
||||
---
|
||||
@ -4,12 +4,12 @@ title: "🔎 Open WebUI RAG Tutorial"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
# Tutorial: Configuring RAG with OpenWebUI Documentation
|
||||
# Tutorial: Configuring RAG with Open WebUI Documentation
|
||||
|
||||
In this tutorial, you will learn how to use **Retrieval-Augmented Generation (RAG)** with OpenWebUI to load real-world documentation as a knowledge base. We will walk through how to use the latest **OpenWebUI Documentation** as an example for this setup.
|
||||
In this tutorial, you will learn how to use **Retrieval-Augmented Generation (RAG)** with Open WebUI to load real-world documentation as a knowledge base. We will walk through how to use the latest **Open WebUI Documentation** as an example for this setup.
|
||||
|
||||
---
|
||||
|
||||
@ -21,7 +21,7 @@ Retrieval-Augmented Generation (RAG) combines **LLMs** with **retrieved knowledg
|
||||
|
||||
This tutorial demonstrates how to:
|
||||
|
||||
- Upload the latest OpenWebUI Documentation as a knowledge base.
|
||||
- Upload the latest Open WebUI Documentation as a knowledge base.
|
||||
- Connect it to a custom model.
|
||||
- Query the knowledge base for enhanced assistance.
|
||||
|
||||
@ -29,9 +29,9 @@ This tutorial demonstrates how to:
|
||||
|
||||
## Setup
|
||||
|
||||
### Step-by-Step Setup: OpenWebUI Documentation as Knowledge Base
|
||||
### Step-by-Step Setup: Open WebUI Documentation as Knowledge Base
|
||||
|
||||
Follow these steps to set up RAG with **OpenWebUI Documentation**:
|
||||
Follow these steps to set up RAG with **Open WebUI Documentation**:
|
||||
|
||||
1. **Download the Documentation**:
|
||||
- Download the latest documentation:
|
||||
@ -45,13 +45,13 @@ Follow these steps to set up RAG with **OpenWebUI Documentation**:
|
||||
|
||||
4. **Create a Knowledge Base**:
|
||||
- Navigate to **Workspace** > **Knowledge** > **+ Create a Knowledge Base**.
|
||||
- Name it: `OpenWebUI Documentation`
|
||||
- Name it: `Open WebUI Documentation`
|
||||
- Purpose: **Assistance**
|
||||
|
||||
> Click **Create Knowledge**.
|
||||
|
||||
5. **Upload the Files**:
|
||||
- Drag and drop the `.md` and `.mdx` files from the extracted folder into the **OpenWebUI Documentation** knowledge base.
|
||||
- Drag and drop the `.md` and `.mdx` files from the extracted folder into the **Open WebUI Documentation** knowledge base.
|
||||
|
||||
---
|
||||
|
||||
@ -63,9 +63,9 @@ Follow these steps to set up RAG with **OpenWebUI Documentation**:
|
||||
- Go to **Workspace** > **Models** > **+ Add New Model**.
|
||||
|
||||
2. **Configure the Model**:
|
||||
- **Name**: `OpenWebUI`
|
||||
- **Name**: `Open WebUI`
|
||||
- **Base Model**: *(Select the appropriate Llama or other available model)*
|
||||
- **Knowledge Source**: Select **OpenWebUI Documentation** from the dropdown.
|
||||
- **Knowledge Source**: Select **Open WebUI Documentation** from the dropdown.
|
||||
|
||||
3. **Save the Model**.
|
||||
|
||||
@ -73,10 +73,10 @@ Follow these steps to set up RAG with **OpenWebUI Documentation**:
|
||||
|
||||
## Examples and Usage
|
||||
|
||||
### Query the OpenWebUI Documentation Model
|
||||
### Query the Open WebUI Documentation Model
|
||||
|
||||
1. **Start a New Chat**:
|
||||
- Navigate to **New Chat** and select the `OpenWebUI` model.
|
||||
- Navigate to **New Chat** and select the `Open WebUI` model.
|
||||
|
||||
2. **Example Queries**:
|
||||
|
||||
@ -86,7 +86,7 @@ Follow these steps to set up RAG with **OpenWebUI Documentation**:
|
||||
```
|
||||
|
||||
```
|
||||
User: "How do I update OpenWebUI using Docker?"
|
||||
User: "How do I update Open WebUI using Docker?"
|
||||
System: "Refer to `docker/updating.md`: Use `docker pull` and restart the container."
|
||||
```
|
||||
|
||||
@ -102,4 +102,4 @@ Follow these steps to set up RAG with **OpenWebUI Documentation**:
|
||||
|
||||
---
|
||||
|
||||
With this setup, you can effectively use the **OpenWebUI Documentation** to assist users by retrieving relevant information for their queries. Enjoy building and querying your custom knowledge-enhanced models!
|
||||
With this setup, you can effectively use the **Open WebUI Documentation** to assist users by retrieving relevant information for their queries. Enjoy building and querying your custom knowledge-enhanced models!
|
||||
|
||||
Loading…
Reference in New Issue
Block a user