<script> import { getContext, createEventDispatcher, onMount, tick } from 'svelte'; import { goto } from '$app/navigation'; const dispatch = createEventDispatcher(); const i18n = getContext('i18n'); import CodeEditor from '$lib/components/common/CodeEditor.svelte'; import ConfirmDialog from '$lib/components/common/ConfirmDialog.svelte'; import Badge from '$lib/components/common/Badge.svelte'; import Tooltip from '$lib/components/common/Tooltip.svelte'; import ChevronLeft from '$lib/components/icons/ChevronLeft.svelte'; let formElement = null; let loading = false; let showConfirm = false; export let edit = false; export let clone = false; export let id = ''; export let name = ''; export let meta = { description: '' }; export let content = ''; let _content = ''; $: if (content) { updateContent(); } const updateContent = () => { _content = content; }; $: if (name && !edit && !clone) { id = name.replace(/\s+/g, '_').toLowerCase(); } let codeEditor; let boilerplate = `""" title: Example Filter author: open-webui author_url: https://github.com/open-webui funding_url: https://github.com/open-webui version: 0.1 """ from pydantic import BaseModel, Field from typing import Optional class Filter: class Valves(BaseModel): priority: int = Field( default=0, description="Priority level for the filter operations." ) max_turns: int = Field( default=8, description="Maximum allowable conversation turns for a user." ) pass class UserValves(BaseModel): max_turns: int = Field( default=4, description="Maximum allowable conversation turns for a user." ) pass def __init__(self): # Indicates custom file handling logic. This flag helps disengage default routines in favor of custom # implementations, informing the WebUI to defer file-related operations to designated methods within this class. # Alternatively, you can remove the files directly from the body in from the inlet hook # self.file_handler = True # Initialize 'valves' with specific configurations. Using 'Valves' instance helps encapsulate settings, # which ensures settings are managed cohesively and not confused with operational flags like 'file_handler'. self.valves = self.Valves() pass def inlet(self, body: dict, __user__: Optional[dict] = None) -> dict: # Modify the request body or validate it before processing by the chat completion API. # This function is the pre-processor for the API where various checks on the input can be performed. # It can also modify the request before sending it to the API. print(f"inlet:{__name__}") print(f"inlet:body:{body}") print(f"inlet:user:{__user__}") if __user__.get("role", "admin") in ["user", "admin"]: messages = body.get("messages", []) max_turns = min(__user__["valves"].max_turns, self.valves.max_turns) if len(messages) > max_turns: raise Exception( f"Conversation turn limit exceeded. Max turns: {max_turns}" ) return body def outlet(self, body: dict, __user__: Optional[dict] = None) -> dict: # Modify or analyze the response body after processing by the API. # This function is the post-processor for the API, which can be used to modify the response # or perform additional checks and analytics. print(f"outlet:{__name__}") print(f"outlet:body:{body}") print(f"outlet:user:{__user__}") return body `; const _boilerplate = `from pydantic import BaseModel from typing import Optional, Union, Generator, Iterator from open_webui.utils.misc import get_last_user_message import os import requests # Filter Class: This class is designed to serve as a pre-processor and post-processor # for request and response modifications. It checks and transforms requests and responses # to ensure they meet specific criteria before further processing or returning to the user. class Filter: class Valves(BaseModel): max_turns: int = 4 pass def __init__(self): # Indicates custom file handling logic. This flag helps disengage default routines in favor of custom # implementations, informing the WebUI to defer file-related operations to designated methods within this class. # Alternatively, you can remove the files directly from the body in from the inlet hook self.file_handler = True # Initialize 'valves' with specific configurations. Using 'Valves' instance helps encapsulate settings, # which ensures settings are managed cohesively and not confused with operational flags like 'file_handler'. self.valves = self.Valves(**{"max_turns": 2}) pass def inlet(self, body: dict, user: Optional[dict] = None) -> dict: # Modify the request body or validate it before processing by the chat completion API. # This function is the pre-processor for the API where various checks on the input can be performed. # It can also modify the request before sending it to the API. print(f"inlet:{__name__}") print(f"inlet:body:{body}") print(f"inlet:user:{user}") if user.get("role", "admin") in ["user", "admin"]: messages = body.get("messages", []) if len(messages) > self.valves.max_turns: raise Exception( f"Conversation turn limit exceeded. Max turns: {self.valves.max_turns}" ) return body def outlet(self, body: dict, user: Optional[dict] = None) -> dict: # Modify or analyze the response body after processing by the API. # This function is the post-processor for the API, which can be used to modify the response # or perform additional checks and analytics. print(f"outlet:{__name__}") print(f"outlet:body:{body}") print(f"outlet:user:{user}") messages = [ { **message, "content": f"{message['content']} - @@Modified from Filter Outlet", } for message in body.get("messages", []) ] return {"messages": messages} # Pipe Class: This class functions as a customizable pipeline. # It can be adapted to work with any external or internal models, # making it versatile for various use cases outside of just OpenAI models. class Pipe: class Valves(BaseModel): OPENAI_API_BASE_URL: str = "https://api.openai.com/v1" OPENAI_API_KEY: str = "your-key" pass def __init__(self): self.type = "manifold" self.valves = self.Valves() self.pipes = self.get_openai_models() pass def get_openai_models(self): if self.valves.OPENAI_API_KEY: try: headers = {} headers["Authorization"] = f"Bearer {self.valves.OPENAI_API_KEY}" headers["Content-Type"] = "application/json" r = requests.get( f"{self.valves.OPENAI_API_BASE_URL}/models", headers=headers ) models = r.json() return [ { "id": model["id"], "name": model["name"] if "name" in model else model["id"], } for model in models["data"] if "gpt" in model["id"] ] except Exception as e: print(f"Error: {e}") return [ { "id": "error", "name": "Could not fetch models from OpenAI, please update the API Key in the valves.", }, ] else: return [] def pipe(self, body: dict) -> Union[str, Generator, Iterator]: # This is where you can add your custom pipelines like RAG. print(f"pipe:{__name__}") if "user" in body: print(body["user"]) del body["user"] headers = {} headers["Authorization"] = f"Bearer {self.valves.OPENAI_API_KEY}" headers["Content-Type"] = "application/json" model_id = body["model"][body["model"].find(".") + 1 :] payload = {**body, "model": model_id} print(payload) try: r = requests.post( url=f"{self.valves.OPENAI_API_BASE_URL}/chat/completions", json=payload, headers=headers, stream=True, ) r.raise_for_status() if body["stream"]: return r.iter_lines() else: return r.json() except Exception as e: return f"Error: {e}" `; const saveHandler = async () => { loading = true; dispatch('save', { id, name, meta, content }); }; const submitHandler = async () => { if (codeEditor) { content = _content; await tick(); const res = await codeEditor.formatPythonCodeHandler(); await tick(); content = _content; await tick(); if (res) { console.log('Code formatted successfully'); saveHandler(); } } }; </script> <div class=" flex flex-col justify-between w-full overflow-y-auto h-full"> <div class="mx-auto w-full md:px-0 h-full"> <form bind:this={formElement} class=" flex flex-col max-h-[100dvh] h-full" on:submit|preventDefault={() => { if (edit) { submitHandler(); } else { showConfirm = true; } }} > <div class="flex flex-col flex-1 overflow-auto h-0 rounded-lg"> <div class="w-full mb-2 flex flex-col gap-0.5"> <div class="flex w-full items-center"> <div class=" flex-shrink-0 mr-2"> <Tooltip content={$i18n.t('Back')}> <button class="w-full text-left text-sm py-1.5 px-1 rounded-lg dark:text-gray-300 dark:hover:text-white hover:bg-black/5 dark:hover:bg-gray-850" on:click={() => { goto('/workspace/functions'); }} type="button" > <ChevronLeft strokeWidth="2.5" /> </button> </Tooltip> </div> <div class="flex-1"> <input class="w-full text-2xl font-medium bg-transparent outline-none font-primary" type="text" placeholder={$i18n.t('Function Name (e.g. My Filter)')} bind:value={name} required /> </div> <div> <Badge type="muted" content={$i18n.t('Function')} /> </div> </div> <div class=" flex gap-2 px-1"> {#if edit} <div class="text-sm text-gray-500 flex-shrink-0"> {id} </div> {:else} <input class="w-full text-sm disabled:text-gray-500 bg-transparent outline-none" type="text" placeholder={$i18n.t('Function ID (e.g. my_filter)')} bind:value={id} required disabled={edit} /> {/if} <input class="w-full text-sm bg-transparent outline-none" type="text" placeholder={$i18n.t( 'Function Description (e.g. A filter to remove profanity from text)' )} bind:value={meta.description} required /> </div> </div> <div class="mb-2 flex-1 overflow-auto h-0 rounded-lg"> <CodeEditor bind:this={codeEditor} value={content} lang="python" {boilerplate} on:change={(e) => { _content = e.detail.value; }} on:save={async () => { if (formElement) { formElement.requestSubmit(); } }} /> </div> <div class="pb-3 flex justify-between"> <div class="flex-1 pr-3"> <div class="text-xs text-gray-500 line-clamp-2"> <span class=" font-semibold dark:text-gray-200">{$i18n.t('Warning:')}</span> {$i18n.t('Functions allow arbitrary code execution')} <br />— <span class=" font-medium dark:text-gray-400" >{$i18n.t(`don't install random functions from sources you don't trust.`)}</span > </div> </div> <button class="px-3.5 py-1.5 text-sm font-medium bg-black hover:bg-gray-900 text-white dark:bg-white dark:text-black dark:hover:bg-gray-100 transition rounded-full" type="submit" > {$i18n.t('Save')} </button> </div> </div> </form> </div> </div> <ConfirmDialog bind:show={showConfirm} on:confirm={() => { submitHandler(); }} > <div class="text-sm text-gray-500"> <div class=" bg-yellow-500/20 text-yellow-700 dark:text-yellow-200 rounded-lg px-4 py-3"> <div>{$i18n.t('Please carefully review the following warnings:')}</div> <ul class=" mt-1 list-disc pl-4 text-xs"> <li>{$i18n.t('Functions allow arbitrary code execution.')}</li> <li>{$i18n.t('Do not install functions from sources you do not fully trust.')}</li> </ul> </div> <div class="my-3"> {$i18n.t( 'I acknowledge that I have read and I understand the implications of my action. I am aware of the risks associated with executing arbitrary code and I have verified the trustworthiness of the source.' )} </div> </div> </ConfirmDialog>