OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-06-16 11:28:36 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

new: mention Literal to give choice to the user

Browse Source 
Signed-off-by: thiswillbeyourgithub <26625900+thiswillbeyourgithub@users.noreply.github.com>
This commit is contained in:
thiswillbeyourgithub 2025-05-09 10:35:20 +02:00
parent a5877409c2
commit 7253830b10
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/features/plugin/functions/tab-shared/Common.md
View File

@ -11,6 +11,7 @@ Valves are configurable by admins alone via the Tools or Functions menus. On the
``` ```
from pydantic import BaseModel, Field from pydantic import BaseModel, Field
from typing import Literal
# Define and Valves # Define and Valves
class Filter: class Filter:
@ -27,6 +28,11 @@ class Filter:
description="A valve controlling a numberical value" description="A valve controlling a numberical value"
# required=False, # you can enforce fields using True # required=False, # you can enforce fields using True
) )
# To give the user the choice between multiple strings, you can use Literal from typing:
choice_option: Literal["choiceA", "choiceB"] = Field(
default="choiceA",
description="An example of a multi choice valve",
)
priority: int = Field( priority: int = Field(
default=0, default=0,
description="Priority level for the filter operations. Lower values are passed through first" description="Priority level for the filter operations. Lower values are passed through first"