khanh.pndc/open-webui-docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs.git synced 2026-01-02 01:39:43 +07:00
Code Issues Packages Projects Releases Wiki Activity

refac

Browse Source
This commit is contained in:
Timothy Jaeryang Baek
2025-01-31 00:34:00 -08:00
parent f69cd8d257
commit dc65e77f7a
23 changed files with 63 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/features/plugin/functions/index.mdx
View File

@@ -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! 🚀