OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-05-19 10:52:14 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

new: move valve to its own section

Browse Source 
Currently, the tabs-shared folder mechanism seems broken: the valve
documentation does not appear on the website. Additionaly, valves are
relevant to tools too.

Signed-off-by: thiswillbeyourgithub <26625900+thiswillbeyourgithub@users.noreply.github.com>
This commit is contained in:
thiswillbeyourgithub 2025-05-09 10:50:44 +02:00
parent de65056c07
commit dea3f578de
2 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/features/plugin/migration/index.mdx
View File

@ -1,5 +1,5 @@
--- ---
sidebar_position: 3 sidebar_position: 4
title: "🚚 Migrating Tools & Functions: 0.4 to 0.5" title: "🚚 Migrating Tools & Functions: 0.4 to 0.5"
--- ---

12
docs/features/plugin/functions/tab-shared/Common.md → docs/features/plugin/valves/index.mdx
View File

@ -1,8 +1,14 @@
## Shared Function Components ---
sidebar_position: 3
title: "🔄 Valves & UserValves"
---
### Valves and UserValves - (optional, but HIGHLY encouraged) ## Valves & UserValves
Valves and UserValves are used to allow users to provide dynamic details such as an API key or a configuration option. These will create a fillable field or a bool switch in the GUI menu for the given function.
Valves and UserValves are used to allow users to provide dynamic details such as an API key or a configuration option. These will create a fillable field or a bool switch in the GUI menu for the given function. They are always optional, but HIGHLY encouraged.
Hence, Valves and UserValves class can be defined in either a `Pipe`, `Pipeline`, `Filter` or `Tools` class.
Valves are configurable by admins alone via the Tools or Functions menus. On the other hand UserValves are configurable by any users directly from a chat session. Valves are configurable by admins alone via the Tools or Functions menus. On the other hand UserValves are configurable by any users directly from a chat session.