2024-01-06 22:59:22 -08:00
import os
2024-03-20 17:11:36 -06:00
import sys
import logging
2024-05-20 11:12:03 +08:00
import importlib . metadata
import pkgutil
2024-01-06 22:59:22 -08:00
import chromadb
2024-01-07 01:40:36 -08:00
from chromadb import Settings
2023-11-18 16:47:12 -08:00
from base64 import b64encode
2024-02-23 17:12:19 -08:00
from bs4 import BeautifulSoup
2024-05-10 13:36:10 +08:00
from typing import TypeVar , Generic , Union
2024-05-26 12:18:43 -07:00
from pydantic import BaseModel
from typing import Optional
2024-02-23 17:12:19 -08:00
2024-01-07 01:40:36 -08:00
from pathlib import Path
2024-02-19 18:54:22 -08:00
import json
2024-02-24 22:35:11 -08:00
import yaml
2024-02-23 00:36:53 -08:00
import markdown
2024-02-23 17:12:19 -08:00
import requests
import shutil
from secrets import token_bytes
from constants import ERROR_MESSAGES
2024-02-19 18:54:22 -08:00
2024-05-06 16:08:04 -07:00
####################################
# Load .env file
####################################
2024-05-14 11:53:46 +08:00
BACKEND_DIR = Path ( __file__ ) . parent # the path containing this file
BASE_DIR = BACKEND_DIR . parent # the path containing the backend/
2024-05-25 15:46:22 -07:00
print ( BASE_DIR )
2024-05-06 16:08:04 -07:00
try :
from dotenv import load_dotenv , find_dotenv
2024-05-14 11:53:46 +08:00
load_dotenv ( find_dotenv ( str ( BASE_DIR / " .env " ) ) )
2024-05-06 16:08:04 -07:00
except ImportError :
print ( " dotenv not installed, skipping... " )
2024-04-12 17:27:40 +08:00
####################################
# LOGGING
####################################
log_levels = [ " CRITICAL " , " ERROR " , " WARNING " , " INFO " , " DEBUG " ]
GLOBAL_LOG_LEVEL = os . environ . get ( " GLOBAL_LOG_LEVEL " , " " ) . upper ( )
if GLOBAL_LOG_LEVEL in log_levels :
logging . basicConfig ( stream = sys . stdout , level = GLOBAL_LOG_LEVEL , force = True )
else :
GLOBAL_LOG_LEVEL = " INFO "
log = logging . getLogger ( __name__ )
log . info ( f " GLOBAL_LOG_LEVEL: { GLOBAL_LOG_LEVEL } " )
log_sources = [
" AUDIO " ,
" COMFYUI " ,
" CONFIG " ,
" DB " ,
" IMAGES " ,
" MAIN " ,
" MODELS " ,
" OLLAMA " ,
" OPENAI " ,
" RAG " ,
" WEBHOOK " ,
]
SRC_LOG_LEVELS = { }
for source in log_sources :
log_env_var = source + " _LOG_LEVEL "
SRC_LOG_LEVELS [ source ] = os . environ . get ( log_env_var , " " ) . upper ( )
if SRC_LOG_LEVELS [ source ] not in log_levels :
SRC_LOG_LEVELS [ source ] = GLOBAL_LOG_LEVEL
log . info ( f " { log_env_var } : { SRC_LOG_LEVELS [ source ] } " )
log . setLevel ( SRC_LOG_LEVELS [ " CONFIG " ] )
2024-04-03 20:45:23 -07:00
WEBUI_NAME = os . environ . get ( " WEBUI_NAME " , " Open WebUI " )
2024-04-26 17:00:25 -04:00
if WEBUI_NAME != " Open WebUI " :
WEBUI_NAME + = " (Open WebUI) "
2024-05-06 17:29:16 -07:00
WEBUI_URL = os . environ . get ( " WEBUI_URL " , " http://localhost:3000 " )
2024-03-26 15:45:36 +08:00
WEBUI_FAVICON_URL = " https://openwebui.com/favicon.png "
2024-04-03 21:24:57 -07:00
2024-05-06 17:29:16 -07:00
2024-01-07 01:40:36 -08:00
####################################
2024-01-25 00:40:19 -08:00
# ENV (dev,test,prod)
2024-01-07 01:40:36 -08:00
####################################
2024-01-25 00:40:19 -08:00
ENV = os . environ . get ( " ENV " , " dev " )
2024-01-07 01:40:36 -08:00
2024-02-23 00:30:26 -08:00
try :
2024-05-14 11:53:46 +08:00
PACKAGE_DATA = json . loads ( ( BASE_DIR / " package.json " ) . read_text ( ) )
2024-02-23 00:30:26 -08:00
except :
2024-05-20 11:12:03 +08:00
try :
PACKAGE_DATA = { " version " : importlib . metadata . version ( " open-webui " ) }
except importlib . metadata . PackageNotFoundError :
PACKAGE_DATA = { " version " : " 0.0.0 " }
2024-02-23 00:30:26 -08:00
VERSION = PACKAGE_DATA [ " version " ]
2024-02-23 00:36:53 -08:00
# Function to parse each section
def parse_section ( section ) :
items = [ ]
for li in section . find_all ( " li " ) :
# Extract raw HTML string
raw_html = str ( li )
# Extract text without HTML tags
text = li . get_text ( separator = " " , strip = True )
# Split into title and content
parts = text . split ( " : " , 1 )
title = parts [ 0 ] . strip ( ) if len ( parts ) > 1 else " "
content = parts [ 1 ] . strip ( ) if len ( parts ) > 1 else text
items . append ( { " title " : title , " content " : content , " raw " : raw_html } )
return items
try :
2024-05-25 15:54:00 -07:00
changelog_path = BASE_DIR / " CHANGELOG.md "
2024-05-25 15:56:47 -07:00
with open ( str ( changelog_path . absolute ( ) ) , " r " , encoding = " utf8 " ) as file :
2024-05-25 15:46:22 -07:00
changelog_content = file . read ( )
2024-02-23 00:36:53 -08:00
except :
2024-05-20 11:12:03 +08:00
changelog_content = ( pkgutil . get_data ( " open_webui " , " CHANGELOG.md " ) or b " " ) . decode ( )
2024-02-23 00:36:53 -08:00
# Convert markdown content to HTML
html_content = markdown . markdown ( changelog_content )
# Parse the HTML content
soup = BeautifulSoup ( html_content , " html.parser " )
# Initialize JSON structure
changelog_json = { }
# Iterate over each version
for version in soup . find_all ( " h2 " ) :
version_number = version . get_text ( ) . strip ( ) . split ( " - " ) [ 0 ] [ 1 : - 1 ] # Remove brackets
date = version . get_text ( ) . strip ( ) . split ( " - " ) [ 1 ]
version_data = { " date " : date }
# Find the next sibling that is a h3 tag (section title)
current = version . find_next_sibling ( )
while current and current . name != " h2 " :
if current . name == " h3 " :
section_title = current . get_text ( ) . lower ( ) # e.g., "added", "fixed"
section_items = parse_section ( current . find_next_sibling ( " ul " ) )
version_data [ section_title ] = section_items
# Move to the next element
current = current . find_next_sibling ( )
changelog_json [ version_number ] = version_data
CHANGELOG = changelog_json
2024-05-08 16:33:34 -07:00
####################################
2024-05-26 08:49:30 +01:00
# WEBUI_BUILD_HASH
2024-05-08 16:33:34 -07:00
####################################
2024-05-26 08:49:30 +01:00
WEBUI_BUILD_HASH = os . environ . get ( " WEBUI_BUILD_HASH " , " dev-build " )
2024-05-08 16:33:34 -07:00
2024-04-09 16:02:28 +05:30
####################################
# DATA/FRONTEND BUILD DIR
####################################
2024-05-14 11:53:46 +08:00
DATA_DIR = Path ( os . getenv ( " DATA_DIR " , BACKEND_DIR / " data " ) ) . resolve ( )
FRONTEND_BUILD_DIR = Path ( os . getenv ( " FRONTEND_BUILD_DIR " , BASE_DIR / " build " ) ) . resolve ( )
2024-04-09 16:02:28 +05:30
try :
2024-05-14 11:53:46 +08:00
CONFIG_DATA = json . loads ( ( DATA_DIR / " config.json " ) . read_text ( ) )
2024-04-09 16:02:28 +05:30
except :
CONFIG_DATA = { }
2024-05-10 13:36:10 +08:00
####################################
# Config helpers
####################################
def save_config ( ) :
try :
with open ( f " { DATA_DIR } /config.json " , " w " ) as f :
json . dump ( CONFIG_DATA , f , indent = " \t " )
except Exception as e :
log . exception ( e )
def get_config_value ( config_path : str ) :
path_parts = config_path . split ( " . " )
cur_config = CONFIG_DATA
for key in path_parts :
if key in cur_config :
cur_config = cur_config [ key ]
else :
return None
return cur_config
T = TypeVar ( " T " )
2024-05-13 11:32:21 -10:00
class PersistentConfig ( Generic [ T ] ) :
2024-05-10 13:36:10 +08:00
def __init__ ( self , env_name : str , config_path : str , env_value : T ) :
self . env_name = env_name
self . config_path = config_path
self . env_value = env_value
self . config_value = get_config_value ( config_path )
if self . config_value is not None :
log . info ( f " ' { env_name } ' loaded from config.json " )
self . value = self . config_value
else :
self . value = env_value
def __str__ ( self ) :
return str ( self . value )
2024-05-10 14:18:39 +08:00
@property
def __dict__ ( self ) :
raise TypeError (
2024-05-13 11:32:21 -10:00
" PersistentConfig object cannot be converted to dict, use config_get or .value instead. "
2024-05-10 14:18:39 +08:00
)
def __getattribute__ ( self , item ) :
if item == " __dict__ " :
raise TypeError (
2024-05-13 11:32:21 -10:00
" PersistentConfig object cannot be converted to dict, use config_get or .value instead. "
2024-05-10 14:18:39 +08:00
)
return super ( ) . __getattribute__ ( item )
2024-05-10 13:36:10 +08:00
def save ( self ) :
# Don't save if the value is the same as the env value and the config value
if self . env_value == self . value :
if self . config_value == self . value :
return
log . info ( f " Saving ' { self . env_name } ' to config.json " )
path_parts = self . config_path . split ( " . " )
config = CONFIG_DATA
for key in path_parts [ : - 1 ] :
if key not in config :
config [ key ] = { }
config = config [ key ]
config [ path_parts [ - 1 ] ] = self . value
save_config ( )
self . config_value = self . value
2024-05-10 15:03:24 +08:00
class AppConfig :
2024-05-13 11:32:21 -10:00
_state : dict [ str , PersistentConfig ]
2024-05-10 15:03:24 +08:00
def __init__ ( self ) :
super ( ) . __setattr__ ( " _state " , { } )
def __setattr__ ( self , key , value ) :
2024-05-13 11:32:21 -10:00
if isinstance ( value , PersistentConfig ) :
2024-05-10 15:03:24 +08:00
self . _state [ key ] = value
else :
self . _state [ key ] . value = value
self . _state [ key ] . save ( )
def __getattr__ ( self , key ) :
return self . _state [ key ] . value
2024-05-10 13:36:10 +08:00
####################################
# WEBUI_AUTH (Required for security)
####################################
WEBUI_AUTH = os . environ . get ( " WEBUI_AUTH " , " True " ) . lower ( ) == " true "
WEBUI_AUTH_TRUSTED_EMAIL_HEADER = os . environ . get (
" WEBUI_AUTH_TRUSTED_EMAIL_HEADER " , None
)
2024-05-13 11:32:21 -10:00
JWT_EXPIRES_IN = PersistentConfig (
2024-05-10 13:36:10 +08:00
" JWT_EXPIRES_IN " , " auth.jwt_expiry " , os . environ . get ( " JWT_EXPIRES_IN " , " -1 " )
)
2024-04-09 16:02:28 +05:30
####################################
# Static DIR
####################################
2024-05-14 11:53:46 +08:00
STATIC_DIR = Path ( os . getenv ( " STATIC_DIR " , BACKEND_DIR / " static " ) ) . resolve ( )
2024-04-09 16:02:28 +05:30
2024-05-14 11:53:46 +08:00
frontend_favicon = FRONTEND_BUILD_DIR / " favicon.png "
if frontend_favicon . exists ( ) :
shutil . copyfile ( frontend_favicon , STATIC_DIR / " favicon.png " )
2024-04-28 16:03:30 +01:00
else :
logging . warning ( f " Frontend favicon not found at { frontend_favicon } " )
2024-02-23 17:12:19 -08:00
####################################
# CUSTOM_NAME
####################################
CUSTOM_NAME = os . environ . get ( " CUSTOM_NAME " , " " )
2024-04-03 21:24:57 -07:00
2024-02-23 17:12:19 -08:00
if CUSTOM_NAME :
2024-02-23 17:36:38 -08:00
try :
r = requests . get ( f " https://api.openwebui.com/api/v1/custom/ { CUSTOM_NAME } " )
data = r . json ( )
if r . ok :
if " logo " in data :
2024-03-26 15:45:36 +08:00
WEBUI_FAVICON_URL = url = (
2024-02-23 17:36:38 -08:00
f " https://api.openwebui.com { data [ ' logo ' ] } "
if data [ " logo " ] [ 0 ] == " / "
else data [ " logo " ]
)
r = requests . get ( url , stream = True )
if r . status_code == 200 :
2024-04-09 16:02:28 +05:30
with open ( f " { STATIC_DIR } /favicon.png " , " wb " ) as f :
2024-02-23 17:36:38 -08:00
r . raw . decode_content = True
shutil . copyfileobj ( r . raw , f )
WEBUI_NAME = data [ " name " ]
except Exception as e :
2024-03-20 17:11:36 -06:00
log . exception ( e )
2024-02-23 17:36:38 -08:00
pass
2024-02-23 17:12:19 -08:00
2024-02-19 18:54:22 -08:00
2023-11-18 16:47:12 -08:00
####################################
2024-01-25 00:40:19 -08:00
# File Upload DIR
2023-11-18 16:47:12 -08:00
####################################
2024-01-25 00:40:19 -08:00
UPLOAD_DIR = f " { DATA_DIR } /uploads "
Path ( UPLOAD_DIR ) . mkdir ( parents = True , exist_ok = True )
2023-11-14 16:28:51 -08:00
2024-02-05 22:51:08 -08:00
####################################
# Cache DIR
####################################
CACHE_DIR = f " { DATA_DIR } /cache "
Path ( CACHE_DIR ) . mkdir ( parents = True , exist_ok = True )
2024-02-17 21:06:08 -08:00
####################################
# Docs DIR
####################################
2024-04-25 00:40:39 +02:00
DOCS_DIR = os . getenv ( " DOCS_DIR " , f " { DATA_DIR } /docs " )
2024-02-17 21:06:08 -08:00
Path ( DOCS_DIR ) . mkdir ( parents = True , exist_ok = True )
2024-02-05 22:51:08 -08:00
2024-02-24 22:35:11 -08:00
####################################
# LITELLM_CONFIG
####################################
def create_config_file ( file_path ) :
directory = os . path . dirname ( file_path )
# Check if directory exists, if not, create it
if not os . path . exists ( directory ) :
os . makedirs ( directory )
# Data to write into the YAML file
config_data = {
" general_settings " : { } ,
" litellm_settings " : { } ,
" model_list " : [ ] ,
" router_settings " : { } ,
}
# Write data to YAML file
with open ( file_path , " w " ) as file :
yaml . dump ( config_data , file )
LITELLM_CONFIG_PATH = f " { DATA_DIR } /litellm/config.yaml "
2024-05-25 14:43:35 -07:00
# if not os.path.exists(LITELLM_CONFIG_PATH):
# log.info("Config file doesn't exist. Creating...")
# create_config_file(LITELLM_CONFIG_PATH)
# log.info("Config file created successfully.")
2024-02-24 22:35:11 -08:00
2023-11-18 16:47:12 -08:00
####################################
2024-03-06 11:51:51 -08:00
# OLLAMA_BASE_URL
2023-11-18 16:47:12 -08:00
####################################
2024-05-21 23:58:42 -07:00
ENABLE_OLLAMA_API = PersistentConfig (
" ENABLE_OLLAMA_API " ,
" ollama.enable " ,
os . environ . get ( " ENABLE_OLLAMA_API " , " True " ) . lower ( ) == " true " ,
)
2024-01-06 22:59:22 -08:00
OLLAMA_API_BASE_URL = os . environ . get (
" OLLAMA_API_BASE_URL " , " http://localhost:11434/api "
)
2023-11-14 16:28:51 -08:00
2024-03-06 11:44:00 -08:00
OLLAMA_BASE_URL = os . environ . get ( " OLLAMA_BASE_URL " , " " )
2024-03-27 13:08:43 -07:00
K8S_FLAG = os . environ . get ( " K8S_FLAG " , " " )
2024-04-02 14:47:52 +02:00
USE_OLLAMA_DOCKER = os . environ . get ( " USE_OLLAMA_DOCKER " , " false " )
2024-04-02 11:28:04 +02:00
2024-03-06 11:44:00 -08:00
if OLLAMA_BASE_URL == " " and OLLAMA_API_BASE_URL != " " :
2024-03-02 18:16:02 -08:00
OLLAMA_BASE_URL = (
OLLAMA_API_BASE_URL [ : - 4 ]
if OLLAMA_API_BASE_URL . endswith ( " /api " )
else OLLAMA_API_BASE_URL
)
2024-03-10 19:26:06 -07:00
if ENV == " prod " :
2024-04-03 11:34:25 +02:00
if OLLAMA_BASE_URL == " /ollama " and not K8S_FLAG :
2024-04-02 14:47:52 +02:00
if USE_OLLAMA_DOCKER . lower ( ) == " true " :
2024-04-03 11:43:13 +02:00
# if you use all-in-one docker container (Open WebUI + Ollama)
2024-04-02 14:47:52 +02:00
# with the docker build arg USE_OLLAMA=true (--build-arg="USE_OLLAMA=true") this only works with http://localhost:11434
2024-03-22 09:31:35 +01:00
OLLAMA_BASE_URL = " http://localhost:11434 "
2024-04-03 11:43:13 +02:00
else :
2024-03-22 09:31:35 +01:00
OLLAMA_BASE_URL = " http://host.docker.internal:11434 "
2024-03-27 13:08:43 -07:00
elif K8S_FLAG :
2024-03-25 21:21:32 +01:00
OLLAMA_BASE_URL = " http://ollama-service.open-webui.svc.cluster.local:11434 "
2024-03-10 19:26:06 -07:00
2024-03-06 11:44:00 -08:00
OLLAMA_BASE_URLS = os . environ . get ( " OLLAMA_BASE_URLS " , " " )
OLLAMA_BASE_URLS = OLLAMA_BASE_URLS if OLLAMA_BASE_URLS != " " else OLLAMA_BASE_URL
2024-03-06 12:42:14 -08:00
OLLAMA_BASE_URLS = [ url . strip ( ) for url in OLLAMA_BASE_URLS . split ( " ; " ) ]
2024-05-13 11:32:21 -10:00
OLLAMA_BASE_URLS = PersistentConfig (
2024-05-10 13:36:10 +08:00
" OLLAMA_BASE_URLS " , " ollama.base_urls " , OLLAMA_BASE_URLS
)
2024-03-02 18:16:02 -08:00
2024-01-04 16:49:34 -08:00
####################################
# OPENAI_API
####################################
2024-05-17 10:30:22 -07:00
ENABLE_OPENAI_API = PersistentConfig (
" ENABLE_OPENAI_API " ,
" openai.enable " ,
os . environ . get ( " ENABLE_OPENAI_API " , " True " ) . lower ( ) == " true " ,
)
2024-01-04 16:49:34 -08:00
OPENAI_API_KEY = os . environ . get ( " OPENAI_API_KEY " , " " )
2024-01-04 18:38:03 -08:00
OPENAI_API_BASE_URL = os . environ . get ( " OPENAI_API_BASE_URL " , " " )
2024-03-06 20:25:24 -08:00
2024-01-04 18:38:03 -08:00
if OPENAI_API_BASE_URL == " " :
OPENAI_API_BASE_URL = " https://api.openai.com/v1 "
2024-01-04 16:49:34 -08:00
2024-03-06 13:18:17 -08:00
OPENAI_API_KEYS = os . environ . get ( " OPENAI_API_KEYS " , " " )
OPENAI_API_KEYS = OPENAI_API_KEYS if OPENAI_API_KEYS != " " else OPENAI_API_KEY
2024-03-06 16:13:25 -08:00
OPENAI_API_KEYS = [ url . strip ( ) for url in OPENAI_API_KEYS . split ( " ; " ) ]
2024-05-13 11:32:21 -10:00
OPENAI_API_KEYS = PersistentConfig (
" OPENAI_API_KEYS " , " openai.api_keys " , OPENAI_API_KEYS
)
2024-03-06 13:18:17 -08:00
OPENAI_API_BASE_URLS = os . environ . get ( " OPENAI_API_BASE_URLS " , " " )
OPENAI_API_BASE_URLS = (
OPENAI_API_BASE_URLS if OPENAI_API_BASE_URLS != " " else OPENAI_API_BASE_URL
)
2024-03-18 01:11:48 -07:00
OPENAI_API_BASE_URLS = [
url . strip ( ) if url != " " else " https://api.openai.com/v1 "
for url in OPENAI_API_BASE_URLS . split ( " ; " )
]
2024-05-13 11:32:21 -10:00
OPENAI_API_BASE_URLS = PersistentConfig (
2024-05-10 13:36:10 +08:00
" OPENAI_API_BASE_URLS " , " openai.api_base_urls " , OPENAI_API_BASE_URLS
)
2024-01-22 21:07:40 -08:00
2024-04-20 15:15:59 -05:00
OPENAI_API_KEY = " "
2024-04-20 20:37:18 -05:00
try :
2024-05-10 13:36:10 +08:00
OPENAI_API_KEY = OPENAI_API_KEYS . value [
OPENAI_API_BASE_URLS . value . index ( " https://api.openai.com/v1 " )
2024-04-20 20:37:18 -05:00
]
except :
pass
2024-04-20 15:15:59 -05:00
OPENAI_API_BASE_URL = " https://api.openai.com/v1 "
2024-01-22 21:07:40 -08:00
####################################
# WEBUI
####################################
2024-05-13 11:32:21 -10:00
ENABLE_SIGNUP = PersistentConfig (
2024-05-10 13:36:10 +08:00
" ENABLE_SIGNUP " ,
" ui.enable_signup " ,
(
False
if not WEBUI_AUTH
else os . environ . get ( " ENABLE_SIGNUP " , " True " ) . lower ( ) == " true "
) ,
)
2024-05-13 11:32:21 -10:00
DEFAULT_MODELS = PersistentConfig (
2024-05-10 13:36:10 +08:00
" DEFAULT_MODELS " , " ui.default_models " , os . environ . get ( " DEFAULT_MODELS " , None )
2024-05-08 16:33:34 -07:00
)
2024-02-19 18:54:22 -08:00
2024-05-13 11:32:21 -10:00
DEFAULT_PROMPT_SUGGESTIONS = PersistentConfig (
2024-05-10 13:36:10 +08:00
" DEFAULT_PROMPT_SUGGESTIONS " ,
" ui.prompt_suggestions " ,
[
2024-01-22 21:07:40 -08:00
{
" title " : [ " Help me study " , " vocabulary for a college entrance exam " ] ,
" content " : " Help me study vocabulary: write a sentence for me to fill in the blank, and I ' ll try to pick the correct option. " ,
} ,
{
" title " : [ " Give me ideas " , " for what to do with my kids ' art " ] ,
" content " : " What are 5 creative things I could do with my kids ' art? I don ' t want to throw them away, but it ' s also so much clutter. " ,
} ,
{
" title " : [ " Tell me a fun fact " , " about the Roman Empire " ] ,
" content " : " Tell me a random fun fact about the Roman Empire " ,
} ,
{
" title " : [ " Show me a code snippet " , " of a website ' s sticky header " ] ,
" content " : " Show me a code snippet of a website ' s sticky header in CSS and JavaScript. " ,
} ,
2024-05-02 00:23:32 -07:00
{
" title " : [
" Explain options trading " ,
" if I ' m familiar with buying and selling stocks " ,
] ,
" content " : " Explain options trading in simple terms if I ' m familiar with buying and selling stocks. " ,
} ,
{
" title " : [ " Overcome procrastination " , " give me tips " ] ,
" content " : " Could you start by asking me about instances when I procrastinate the most and then give me some suggestions to overcome it? " ,
} ,
2024-05-10 13:36:10 +08:00
] ,
2024-01-22 21:07:40 -08:00
)
2024-02-19 18:54:22 -08:00
2024-05-13 11:32:21 -10:00
DEFAULT_USER_ROLE = PersistentConfig (
2024-05-10 13:36:10 +08:00
" DEFAULT_USER_ROLE " ,
" ui.default_user_role " ,
os . getenv ( " DEFAULT_USER_ROLE " , " pending " ) ,
)
2024-03-13 23:17:22 +08:00
2024-03-19 14:21:46 -07:00
USER_PERMISSIONS_CHAT_DELETION = (
os . environ . get ( " USER_PERMISSIONS_CHAT_DELETION " , " True " ) . lower ( ) == " true "
)
2024-03-14 00:01:46 +08:00
2024-05-13 11:32:21 -10:00
USER_PERMISSIONS = PersistentConfig (
2024-05-10 13:36:10 +08:00
" USER_PERMISSIONS " ,
" ui.user_permissions " ,
{ " chat " : { " deletion " : USER_PERMISSIONS_CHAT_DELETION } } ,
)
2024-02-14 01:17:43 -08:00
2024-05-13 11:32:21 -10:00
ENABLE_MODEL_FILTER = PersistentConfig (
2024-05-10 13:36:10 +08:00
" ENABLE_MODEL_FILTER " ,
" model_filter.enable " ,
os . environ . get ( " ENABLE_MODEL_FILTER " , " False " ) . lower ( ) == " true " ,
)
2024-03-09 21:47:01 -08:00
MODEL_FILTER_LIST = os . environ . get ( " MODEL_FILTER_LIST " , " " )
2024-05-13 11:32:21 -10:00
MODEL_FILTER_LIST = PersistentConfig (
2024-05-10 13:36:10 +08:00
" MODEL_FILTER_LIST " ,
" model_filter.list " ,
[ model . strip ( ) for model in MODEL_FILTER_LIST . split ( " ; " ) ] ,
)
2024-03-09 21:47:01 -08:00
2024-05-13 11:32:21 -10:00
WEBHOOK_URL = PersistentConfig (
2024-05-10 13:36:10 +08:00
" WEBHOOK_URL " , " webhook_url " , os . environ . get ( " WEBHOOK_URL " , " " )
)
2024-03-09 21:47:01 -08:00
2024-04-22 19:55:46 +01:00
ENABLE_ADMIN_EXPORT = os . environ . get ( " ENABLE_ADMIN_EXPORT " , " True " ) . lower ( ) == " true "
2024-04-17 09:33:22 +01:00
2024-05-26 17:10:25 +01:00
ENABLE_COMMUNITY_SHARING = PersistentConfig (
" ENABLE_COMMUNITY_SHARING " ,
" ui.enable_community_sharing " ,
os . environ . get ( " ENABLE_COMMUNITY_SHARING " , " True " ) . lower ( ) == " true " ,
)
2024-05-27 12:48:08 -07:00
2024-05-26 12:18:43 -07:00
class BannerModel ( BaseModel ) :
id : str
type : str
title : Optional [ str ] = None
content : str
dismissible : bool
timestamp : int
WEBUI_BANNERS = PersistentConfig (
" WEBUI_BANNERS " ,
" ui.banners " ,
[ BannerModel ( * * banner ) for banner in json . loads ( " [] " ) ] ,
)
2023-11-20 16:22:43 -08:00
####################################
2024-02-01 13:40:59 -06:00
# WEBUI_SECRET_KEY
2023-11-20 16:22:43 -08:00
####################################
2024-02-01 13:40:59 -06:00
WEBUI_SECRET_KEY = os . environ . get (
" WEBUI_SECRET_KEY " ,
2024-02-03 17:42:08 -08:00
os . environ . get (
" WEBUI_JWT_SECRET_KEY " , " t0p-s3cr3t "
) , # DEPRECATED: remove at next major version
2024-02-01 13:40:59 -06:00
)
2023-11-18 16:47:12 -08:00
2024-02-01 13:40:59 -06:00
if WEBUI_AUTH and WEBUI_SECRET_KEY == " " :
2023-11-20 16:22:43 -08:00
raise ValueError ( ERROR_MESSAGES . ENV_VAR_NOT_FOUND )
2024-01-06 22:59:22 -08:00
####################################
# RAG
####################################
2024-01-22 01:47:07 -08:00
CHROMA_DATA_PATH = f " { DATA_DIR } /vector_db "
2024-04-27 18:52:35 +01:00
CHROMA_TENANT = os . environ . get ( " CHROMA_TENANT " , chromadb . DEFAULT_TENANT )
CHROMA_DATABASE = os . environ . get ( " CHROMA_DATABASE " , chromadb . DEFAULT_DATABASE )
CHROMA_HTTP_HOST = os . environ . get ( " CHROMA_HTTP_HOST " , " " )
CHROMA_HTTP_PORT = int ( os . environ . get ( " CHROMA_HTTP_PORT " , " 8000 " ) )
# Comma-separated list of header=value pairs
CHROMA_HTTP_HEADERS = os . environ . get ( " CHROMA_HTTP_HEADERS " , " " )
if CHROMA_HTTP_HEADERS :
CHROMA_HTTP_HEADERS = dict (
[ pair . split ( " = " ) for pair in CHROMA_HTTP_HEADERS . split ( " , " ) ]
)
else :
CHROMA_HTTP_HEADERS = None
CHROMA_HTTP_SSL = os . environ . get ( " CHROMA_HTTP_SSL " , " false " ) . lower ( ) == " true "
2024-04-22 13:27:43 -05:00
# this uses the model defined in the Dockerfile ENV variable. If you dont use docker or docker based deployments such as k8s, the default embedding model will be used (sentence-transformers/all-MiniLM-L6-v2)
2024-04-14 17:55:00 -04:00
2024-05-13 11:32:21 -10:00
RAG_TOP_K = PersistentConfig (
2024-05-10 13:36:10 +08:00
" RAG_TOP_K " , " rag.top_k " , int ( os . environ . get ( " RAG_TOP_K " , " 5 " ) )
)
2024-05-13 11:32:21 -10:00
RAG_RELEVANCE_THRESHOLD = PersistentConfig (
2024-05-10 13:36:10 +08:00
" RAG_RELEVANCE_THRESHOLD " ,
" rag.relevance_threshold " ,
float ( os . environ . get ( " RAG_RELEVANCE_THRESHOLD " , " 0.0 " ) ) ,
2024-04-26 14:41:39 -04:00
)
2024-04-22 18:36:46 -05:00
2024-05-13 11:32:21 -10:00
ENABLE_RAG_HYBRID_SEARCH = PersistentConfig (
2024-05-10 13:36:10 +08:00
" ENABLE_RAG_HYBRID_SEARCH " ,
" rag.enable_hybrid_search " ,
os . environ . get ( " ENABLE_RAG_HYBRID_SEARCH " , " " ) . lower ( ) == " true " ,
)
2024-05-06 13:12:08 -07:00
2024-05-13 11:32:21 -10:00
ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION = PersistentConfig (
2024-05-10 13:36:10 +08:00
" ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION " ,
" rag.enable_web_loader_ssl_verification " ,
os . environ . get ( " ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION " , " True " ) . lower ( ) == " true " ,
2024-05-06 13:12:08 -07:00
)
2024-05-13 11:32:21 -10:00
RAG_EMBEDDING_ENGINE = PersistentConfig (
2024-05-10 13:36:10 +08:00
" RAG_EMBEDDING_ENGINE " ,
" rag.embedding_engine " ,
os . environ . get ( " RAG_EMBEDDING_ENGINE " , " " ) ,
)
2024-04-14 17:55:00 -04:00
2024-05-13 11:32:21 -10:00
PDF_EXTRACT_IMAGES = PersistentConfig (
2024-05-10 13:36:10 +08:00
" PDF_EXTRACT_IMAGES " ,
" rag.pdf_extract_images " ,
os . environ . get ( " PDF_EXTRACT_IMAGES " , " False " ) . lower ( ) == " true " ,
)
2024-04-28 06:54:26 +08:00
2024-05-13 11:32:21 -10:00
RAG_EMBEDDING_MODEL = PersistentConfig (
2024-05-10 13:36:10 +08:00
" RAG_EMBEDDING_MODEL " ,
" rag.embedding_model " ,
os . environ . get ( " RAG_EMBEDDING_MODEL " , " sentence-transformers/all-MiniLM-L6-v2 " ) ,
2024-04-22 13:27:43 -05:00
)
2024-05-10 13:36:10 +08:00
log . info ( f " Embedding model set: { RAG_EMBEDDING_MODEL . value } " ) ,
2024-04-09 23:54:20 -07:00
2024-04-25 07:49:59 -05:00
RAG_EMBEDDING_MODEL_AUTO_UPDATE = (
os . environ . get ( " RAG_EMBEDDING_MODEL_AUTO_UPDATE " , " " ) . lower ( ) == " true "
)
2024-04-22 13:27:43 -05:00
RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE = (
os . environ . get ( " RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE " , " " ) . lower ( ) == " true "
2024-04-22 15:49:58 -05:00
)
2024-05-13 11:32:21 -10:00
RAG_RERANKING_MODEL = PersistentConfig (
2024-05-10 13:36:10 +08:00
" RAG_RERANKING_MODEL " ,
" rag.reranking_model " ,
os . environ . get ( " RAG_RERANKING_MODEL " , " " ) ,
)
if RAG_RERANKING_MODEL . value != " " :
log . info ( f " Reranking model set: { RAG_RERANKING_MODEL . value } " ) ,
2024-04-22 15:49:58 -05:00
2024-04-25 07:49:59 -05:00
RAG_RERANKING_MODEL_AUTO_UPDATE = (
os . environ . get ( " RAG_RERANKING_MODEL_AUTO_UPDATE " , " " ) . lower ( ) == " true "
)
2024-04-22 15:49:58 -05:00
RAG_RERANKING_MODEL_TRUST_REMOTE_CODE = (
os . environ . get ( " RAG_RERANKING_MODEL_TRUST_REMOTE_CODE " , " " ) . lower ( ) == " true "
2024-04-09 23:54:20 -07:00
)
2024-04-08 14:57:54 -06:00
2024-03-22 12:48:48 +01:00
2024-04-27 18:52:35 +01:00
if CHROMA_HTTP_HOST != " " :
CHROMA_CLIENT = chromadb . HttpClient (
host = CHROMA_HTTP_HOST ,
port = CHROMA_HTTP_PORT ,
headers = CHROMA_HTTP_HEADERS ,
ssl = CHROMA_HTTP_SSL ,
tenant = CHROMA_TENANT ,
database = CHROMA_DATABASE ,
settings = Settings ( allow_reset = True , anonymized_telemetry = False ) ,
)
else :
CHROMA_CLIENT = chromadb . PersistentClient (
path = CHROMA_DATA_PATH ,
settings = Settings ( allow_reset = True , anonymized_telemetry = False ) ,
tenant = CHROMA_TENANT ,
database = CHROMA_DATABASE ,
)
2024-02-11 00:17:50 -08:00
2024-05-08 10:51:29 -07:00
# device type embedding models - "cpu" (default), "cuda" (nvidia gpu required) or "mps" (apple silicon) - choosing this right can lead to better performance
USE_CUDA = os . environ . get ( " USE_CUDA_DOCKER " , " false " )
if USE_CUDA . lower ( ) == " true " :
DEVICE_TYPE = " cuda "
else :
DEVICE_TYPE = " cpu "
2024-05-13 11:32:21 -10:00
CHUNK_SIZE = PersistentConfig (
2024-05-10 13:36:10 +08:00
" CHUNK_SIZE " , " rag.chunk_size " , int ( os . environ . get ( " CHUNK_SIZE " , " 1500 " ) )
)
2024-05-13 11:32:21 -10:00
CHUNK_OVERLAP = PersistentConfig (
2024-05-10 13:36:10 +08:00
" CHUNK_OVERLAP " ,
" rag.chunk_overlap " ,
int ( os . environ . get ( " CHUNK_OVERLAP " , " 100 " ) ) ,
)
2024-02-17 22:41:03 -08:00
2024-04-22 18:36:46 -05:00
DEFAULT_RAG_TEMPLATE = """ Use the following context as your learned knowledge, inside <context></context> XML tags.
2024-02-17 22:41:03 -08:00
< context >
[ context ]
< / context >
When answer to user :
- If you don ' t know, just say that you don ' t know .
- If you don ' t know when you are not sure, ask for clarification.
Avoid mentioning that you obtained the information from the context .
And answer according to the language of the user ' s question.
2024-04-25 00:40:39 +02:00
2024-02-17 22:41:03 -08:00
Given the context information , answer the query .
Query : [ query ] """
2024-05-13 11:32:21 -10:00
RAG_TEMPLATE = PersistentConfig (
2024-05-10 13:36:10 +08:00
" RAG_TEMPLATE " ,
" rag.template " ,
os . environ . get ( " RAG_TEMPLATE " , DEFAULT_RAG_TEMPLATE ) ,
)
2024-04-22 18:36:46 -05:00
2024-05-13 11:32:21 -10:00
RAG_OPENAI_API_BASE_URL = PersistentConfig (
2024-05-10 13:36:10 +08:00
" RAG_OPENAI_API_BASE_URL " ,
" rag.openai_api_base_url " ,
os . getenv ( " RAG_OPENAI_API_BASE_URL " , OPENAI_API_BASE_URL ) ,
)
2024-05-13 11:32:21 -10:00
RAG_OPENAI_API_KEY = PersistentConfig (
2024-05-10 13:36:10 +08:00
" RAG_OPENAI_API_KEY " ,
" rag.openai_api_key " ,
os . getenv ( " RAG_OPENAI_API_KEY " , OPENAI_API_KEY ) ,
)
2024-04-20 15:15:59 -05:00
2024-05-06 13:12:08 -07:00
ENABLE_RAG_LOCAL_WEB_FETCH = (
os . getenv ( " ENABLE_RAG_LOCAL_WEB_FETCH " , " False " ) . lower ( ) == " true "
)
2024-04-29 20:55:17 +01:00
2024-05-13 11:32:21 -10:00
YOUTUBE_LOADER_LANGUAGE = PersistentConfig (
2024-05-10 13:36:10 +08:00
" YOUTUBE_LOADER_LANGUAGE " ,
" rag.youtube_loader_language " ,
os . getenv ( " YOUTUBE_LOADER_LANGUAGE " , " en " ) . split ( " , " ) ,
)
2024-05-08 10:51:29 -07:00
2024-05-27 12:48:08 -07:00
2024-06-01 19:03:56 -07:00
ENABLE_RAG_WEB_SEARCH = PersistentConfig (
" ENABLE_RAG_WEB_SEARCH " ,
" rag.web.search.enable " ,
os . getenv ( " ENABLE_RAG_WEB_SEARCH " , " False " ) . lower ( ) == " true " ,
)
2024-06-01 19:40:48 -07:00
RAG_WEB_SEARCH_ENGINE = PersistentConfig (
" RAG_WEB_SEARCH_ENGINE " ,
" rag.web.search.engine " ,
os . getenv ( " RAG_WEB_SEARCH_ENGINE " , " " ) ,
)
2024-06-01 19:03:56 -07:00
SEARXNG_QUERY_URL = PersistentConfig (
" SEARXNG_QUERY_URL " ,
" rag.web.search.searxng_query_url " ,
os . getenv ( " SEARXNG_QUERY_URL " , " " ) ,
)
GOOGLE_PSE_API_KEY = PersistentConfig (
" GOOGLE_PSE_API_KEY " ,
" rag.web.search.google_pse_api_key " ,
os . getenv ( " GOOGLE_PSE_API_KEY " , " " ) ,
)
GOOGLE_PSE_ENGINE_ID = PersistentConfig (
" GOOGLE_PSE_ENGINE_ID " ,
" rag.web.search.google_pse_engine_id " ,
os . getenv ( " GOOGLE_PSE_ENGINE_ID " , " " ) ,
)
BRAVE_SEARCH_API_KEY = PersistentConfig (
" BRAVE_SEARCH_API_KEY " ,
" rag.web.search.brave_search_api_key " ,
os . getenv ( " BRAVE_SEARCH_API_KEY " , " " ) ,
)
SERPSTACK_API_KEY = PersistentConfig (
" SERPSTACK_API_KEY " ,
" rag.web.search.serpstack_api_key " ,
os . getenv ( " SERPSTACK_API_KEY " , " " ) ,
)
2024-05-27 12:48:08 -07:00
2024-06-01 19:03:56 -07:00
SERPSTACK_HTTPS = PersistentConfig (
" SERPSTACK_HTTPS " ,
" rag.web.search.serpstack_https " ,
os . getenv ( " SERPSTACK_HTTPS " , " True " ) . lower ( ) == " true " ,
2024-05-12 15:19:52 +08:00
)
2024-05-27 12:48:08 -07:00
2024-06-01 19:03:56 -07:00
SERPER_API_KEY = PersistentConfig (
" SERPER_API_KEY " ,
" rag.web.search.serper_api_key " ,
os . getenv ( " SERPER_API_KEY " , " " ) ,
2024-05-11 23:12:52 +08:00
)
2024-05-06 12:27:46 +08:00
2024-06-01 19:03:56 -07:00
RAG_WEB_SEARCH_RESULT_COUNT = PersistentConfig (
" RAG_WEB_SEARCH_RESULT_COUNT " ,
" rag.web.search.result_count " ,
int ( os . getenv ( " RAG_WEB_SEARCH_RESULT_COUNT " , " 3 " ) ) ,
)
RAG_WEB_SEARCH_CONCURRENT_REQUESTS = PersistentConfig (
" RAG_WEB_SEARCH_CONCURRENT_REQUESTS " ,
" rag.web.search.concurrent_requests " ,
int ( os . getenv ( " RAG_WEB_SEARCH_CONCURRENT_REQUESTS " , " 10 " ) ) ,
)
2024-02-11 00:17:50 -08:00
####################################
# Transcribe
####################################
2024-02-14 23:32:54 -08:00
WHISPER_MODEL = os . getenv ( " WHISPER_MODEL " , " base " )
WHISPER_MODEL_DIR = os . getenv ( " WHISPER_MODEL_DIR " , f " { CACHE_DIR } /whisper/models " )
2024-04-10 20:30:00 -06:00
WHISPER_MODEL_AUTO_UPDATE = (
os . environ . get ( " WHISPER_MODEL_AUTO_UPDATE " , " " ) . lower ( ) == " true "
)
2024-02-21 18:12:01 -08:00
####################################
# Images
####################################
2024-05-13 11:32:21 -10:00
IMAGE_GENERATION_ENGINE = PersistentConfig (
2024-05-10 13:36:10 +08:00
" IMAGE_GENERATION_ENGINE " ,
" image_generation.engine " ,
os . getenv ( " IMAGE_GENERATION_ENGINE " , " " ) ,
)
2024-04-28 06:54:26 +08:00
2024-05-13 11:32:21 -10:00
ENABLE_IMAGE_GENERATION = PersistentConfig (
2024-05-10 13:36:10 +08:00
" ENABLE_IMAGE_GENERATION " ,
" image_generation.enable " ,
os . environ . get ( " ENABLE_IMAGE_GENERATION " , " " ) . lower ( ) == " true " ,
)
2024-05-13 11:32:21 -10:00
AUTOMATIC1111_BASE_URL = PersistentConfig (
2024-05-10 13:36:10 +08:00
" AUTOMATIC1111_BASE_URL " ,
" image_generation.automatic1111.base_url " ,
os . getenv ( " AUTOMATIC1111_BASE_URL " , " " ) ,
2024-04-10 23:21:12 -06:00
)
2024-04-20 16:04:16 -05:00
2024-05-13 11:32:21 -10:00
COMFYUI_BASE_URL = PersistentConfig (
2024-05-10 13:36:10 +08:00
" COMFYUI_BASE_URL " ,
" image_generation.comfyui.base_url " ,
os . getenv ( " COMFYUI_BASE_URL " , " " ) ,
)
2024-04-20 16:04:16 -05:00
2024-05-13 11:32:21 -10:00
IMAGES_OPENAI_API_BASE_URL = PersistentConfig (
2024-05-10 13:36:10 +08:00
" IMAGES_OPENAI_API_BASE_URL " ,
" image_generation.openai.api_base_url " ,
os . getenv ( " IMAGES_OPENAI_API_BASE_URL " , OPENAI_API_BASE_URL ) ,
)
2024-05-13 11:32:21 -10:00
IMAGES_OPENAI_API_KEY = PersistentConfig (
2024-05-10 13:36:10 +08:00
" IMAGES_OPENAI_API_KEY " ,
" image_generation.openai.api_key " ,
os . getenv ( " IMAGES_OPENAI_API_KEY " , OPENAI_API_KEY ) ,
2024-04-23 06:58:57 -04:00
)
2024-04-23 06:53:04 -04:00
2024-05-13 11:32:21 -10:00
IMAGE_SIZE = PersistentConfig (
2024-05-10 13:36:10 +08:00
" IMAGE_SIZE " , " image_generation.size " , os . getenv ( " IMAGE_SIZE " , " 512x512 " )
)
2024-04-28 06:54:26 +08:00
2024-05-13 11:32:21 -10:00
IMAGE_STEPS = PersistentConfig (
2024-05-10 13:36:10 +08:00
" IMAGE_STEPS " , " image_generation.steps " , int ( os . getenv ( " IMAGE_STEPS " , 50 ) )
)
2024-04-28 06:54:26 +08:00
2024-05-13 11:32:21 -10:00
IMAGE_GENERATION_MODEL = PersistentConfig (
2024-05-10 13:36:10 +08:00
" IMAGE_GENERATION_MODEL " ,
" image_generation.model " ,
os . getenv ( " IMAGE_GENERATION_MODEL " , " " ) ,
)
2024-04-23 06:53:04 -04:00
2024-04-20 16:04:16 -05:00
####################################
# Audio
####################################
2024-05-13 11:32:21 -10:00
AUDIO_OPENAI_API_BASE_URL = PersistentConfig (
2024-05-10 13:36:10 +08:00
" AUDIO_OPENAI_API_BASE_URL " ,
" audio.openai.api_base_url " ,
os . getenv ( " AUDIO_OPENAI_API_BASE_URL " , OPENAI_API_BASE_URL ) ,
)
2024-05-13 11:32:21 -10:00
AUDIO_OPENAI_API_KEY = PersistentConfig (
2024-05-10 13:36:10 +08:00
" AUDIO_OPENAI_API_KEY " ,
" audio.openai.api_key " ,
os . getenv ( " AUDIO_OPENAI_API_KEY " , OPENAI_API_KEY ) ,
)
2024-05-13 11:32:21 -10:00
AUDIO_OPENAI_API_MODEL = PersistentConfig (
2024-05-10 13:36:10 +08:00
" AUDIO_OPENAI_API_MODEL " ,
" audio.openai.api_model " ,
os . getenv ( " AUDIO_OPENAI_API_MODEL " , " tts-1 " ) ,
)
2024-05-13 11:32:21 -10:00
AUDIO_OPENAI_API_VOICE = PersistentConfig (
2024-05-10 13:36:10 +08:00
" AUDIO_OPENAI_API_VOICE " ,
" audio.openai.api_voice " ,
os . getenv ( " AUDIO_OPENAI_API_VOICE " , " alloy " ) ,
)
2024-04-23 19:14:01 +01:00
2024-04-24 18:10:18 +01:00
####################################
# Database
####################################
DATABASE_URL = os . environ . get ( " DATABASE_URL " , f " sqlite:/// { DATA_DIR } /webui.db " )