OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-05-20 03:08:56 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

refac

Browse Source
This commit is contained in:
Timothy J. Baek 2024-09-25 01:56:52 +02:00
parent eb8a26d47c
commit a4e1fa502e
7 changed files with 14 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/pipelines/functions.md
View File

@ -1,17 +0,0 @@
---
sidebar_position: 4
title: "Functions"
---
# Functions
Functions enable you to utilize filters (middleware) and pipe (model) functions directly within the WebUI. While largely compatible with Pipelines, these native functions can be executed easily within Open WebUI. Example use cases for filter functions include usage monitoring, real-time translation, moderation, and automemory. For pipe functions, the scope ranges from Cohere and Anthropic integration directly within Open WebUI, enabling "Valves" for per-user OpenAI API key usage, and much more.
Many Functions are available to use on the [Community Website](https://openwebui.com/functions) and can easily be imported into your Open WebUI instance.
<p align="center">
<a href="#">
<img src="/img/pipelines/community-functions.png" alt="Community Functions" />
</a>
</p>
While many Pipes and Filters that run on a Pipelines server can be executed as Functions, the main limitation is that Functions are unable to install new Python dependencies that are not already packaged into Open WebUI. As a result, Pipelines are more extensible than Functions, while Functions have the added benefit of executing directly on the Open WebUI server without needing a separate Pipelines server for execution.

7
docs/pipelines/index.mdx
View File

@ -1,6 +1,7 @@
import { TopBanners } from "@site/src/components/TopBanners";
<TopBanners />
---
sidebar_position: 1
title: "⚡ Pipelines"
---
<p align="center">
<a href="#">

9
docs/pipelines/tools.md
View File

@ -1,9 +0,0 @@
---
sidebar_position: 5
title: "Tools"
---
# Tools
Tools enable many use cases for chats, including web search, web scraping, and API interactions within the chat.
Many Tools are available to use on the [Community Website](https://openwebui.com/tools) and can easily be imported into your Open WebUI instance.

0
docs/pipelines/actions.md → docs/tutorial/plugin/functions/actions.md
View File

2
docs/tutorial/functions.md → docs/tutorial/plugin/functions/index.mdx
View File

@ -1,5 +1,5 @@
---
sidebar_position: 2
sidebar_position: 1
title: "Functions"
---

4
docs/tutorial/plugin/index.mdx Normal file
View File

@ -0,0 +1,4 @@
---
sidebar_position: 0
title: "Tools & Fuctions"
---

6
docs/tutorial/tools.md → docs/tutorial/plugin/tools/index.mdx
View File

@ -1,11 +1,15 @@
---
sidebar_position: 5
sidebar_position: 0
title: "Tools"
---
## What are Tools?
Tools are python scripts that are provided to an LLM at the time of the request. Tools allow LLMs to perform actions and receive additional context as a result. Generally speaking, your LLM of choice will need to support function calling for tools to be reliably utilized.
Tools enable many use cases for chats, including web search, web scraping, and API interactions within the chat.
Many Tools are available to use on the [Community Website](https://openwebui.com/tools) and can easily be imported into your Open WebUI instance.
## How can I use Tools?
[Once installed](#how-to-install-tools), Tools can be used by assigning them to any LLM that supports function calling and then enabling that Tool. To assign a Tool to a model, you need to navigate to Workspace => Models. Here you can select the model for which you’d like to enable any Tools.