config.py 42 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496
  1. import json
  2. import logging
  3. import os
  4. import shutil
  5. from datetime import datetime
  6. from pathlib import Path
  7. from typing import Generic, Optional, TypeVar
  8. from urllib.parse import urlparse
  9. import chromadb
  10. import requests
  11. import yaml
  12. from apps.webui.internal.db import Base, get_db
  13. from chromadb import Settings
  14. from env import (
  15. BACKEND_DIR,
  16. CONFIG_DATA,
  17. DATA_DIR,
  18. ENV,
  19. FRONTEND_BUILD_DIR,
  20. WEBUI_AUTH,
  21. WEBUI_FAVICON_URL,
  22. WEBUI_NAME,
  23. log,
  24. )
  25. from pydantic import BaseModel
  26. from sqlalchemy import JSON, Column, DateTime, Integer, func
  27. class EndpointFilter(logging.Filter):
  28. def filter(self, record: logging.LogRecord) -> bool:
  29. return record.getMessage().find("/health") == -1
  30. # Filter out /endpoint
  31. logging.getLogger("uvicorn.access").addFilter(EndpointFilter())
  32. ####################################
  33. # Config helpers
  34. ####################################
  35. # Function to run the alembic migrations
  36. def run_migrations():
  37. print("Running migrations")
  38. try:
  39. from alembic import command
  40. from alembic.config import Config
  41. alembic_cfg = Config(BACKEND_DIR / "alembic.ini")
  42. command.upgrade(alembic_cfg, "head")
  43. except Exception as e:
  44. print(f"Error: {e}")
  45. run_migrations()
  46. class Config(Base):
  47. __tablename__ = "config"
  48. id = Column(Integer, primary_key=True)
  49. data = Column(JSON, nullable=False)
  50. version = Column(Integer, nullable=False, default=0)
  51. created_at = Column(DateTime, nullable=False, server_default=func.now())
  52. updated_at = Column(DateTime, nullable=True, onupdate=func.now())
  53. def load_json_config():
  54. with open(f"{DATA_DIR}/config.json", "r") as file:
  55. return json.load(file)
  56. def save_to_db(data):
  57. with get_db() as db:
  58. existing_config = db.query(Config).first()
  59. if not existing_config:
  60. new_config = Config(data=data, version=0)
  61. db.add(new_config)
  62. else:
  63. existing_config.data = data
  64. existing_config.updated_at = datetime.now()
  65. db.add(existing_config)
  66. db.commit()
  67. # When initializing, check if config.json exists and migrate it to the database
  68. if os.path.exists(f"{DATA_DIR}/config.json"):
  69. data = load_json_config()
  70. save_to_db(data)
  71. os.rename(f"{DATA_DIR}/config.json", f"{DATA_DIR}/old_config.json")
  72. def save_config():
  73. try:
  74. with open(f"{DATA_DIR}/config.json", "w") as f:
  75. json.dump(CONFIG_DATA, f, indent="\t")
  76. except Exception as e:
  77. log.exception(e)
  78. DEFAULT_CONFIG = {
  79. "version": 0,
  80. "ui": {
  81. "default_locale": "",
  82. "prompt_suggestions": [
  83. {
  84. "title": [
  85. "Help me study",
  86. "vocabulary for a college entrance exam",
  87. ],
  88. "content": "Help me study vocabulary: write a sentence for me to fill in the blank, and I'll try to pick the correct option.",
  89. },
  90. {
  91. "title": [
  92. "Give me ideas",
  93. "for what to do with my kids' art",
  94. ],
  95. "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.",
  96. },
  97. {
  98. "title": ["Tell me a fun fact", "about the Roman Empire"],
  99. "content": "Tell me a random fun fact about the Roman Empire",
  100. },
  101. {
  102. "title": [
  103. "Show me a code snippet",
  104. "of a website's sticky header",
  105. ],
  106. "content": "Show me a code snippet of a website's sticky header in CSS and JavaScript.",
  107. },
  108. {
  109. "title": [
  110. "Explain options trading",
  111. "if I'm familiar with buying and selling stocks",
  112. ],
  113. "content": "Explain options trading in simple terms if I'm familiar with buying and selling stocks.",
  114. },
  115. {
  116. "title": ["Overcome procrastination", "give me tips"],
  117. "content": "Could you start by asking me about instances when I procrastinate the most and then give me some suggestions to overcome it?",
  118. },
  119. {
  120. "title": [
  121. "Grammar check",
  122. "rewrite it for better readability ",
  123. ],
  124. "content": 'Check the following sentence for grammar and clarity: "[sentence]". Rewrite it for better readability while maintaining its original meaning.',
  125. },
  126. ],
  127. },
  128. }
  129. def get_config():
  130. with get_db() as db:
  131. config_entry = db.query(Config).order_by(Config.id.desc()).first()
  132. return config_entry.data if config_entry else DEFAULT_CONFIG
  133. CONFIG_DATA = get_config()
  134. def get_config_value(config_path: str):
  135. path_parts = config_path.split(".")
  136. cur_config = CONFIG_DATA
  137. for key in path_parts:
  138. if key in cur_config:
  139. cur_config = cur_config[key]
  140. else:
  141. return None
  142. return cur_config
  143. T = TypeVar("T")
  144. class PersistentConfig(Generic[T]):
  145. def __init__(self, env_name: str, config_path: str, env_value: T):
  146. self.env_name = env_name
  147. self.config_path = config_path
  148. self.env_value = env_value
  149. self.config_value = get_config_value(config_path)
  150. if self.config_value is not None:
  151. log.info(f"'{env_name}' loaded from the latest database entry")
  152. self.value = self.config_value
  153. else:
  154. self.value = env_value
  155. def __str__(self):
  156. return str(self.value)
  157. @property
  158. def __dict__(self):
  159. raise TypeError(
  160. "PersistentConfig object cannot be converted to dict, use config_get or .value instead."
  161. )
  162. def __getattribute__(self, item):
  163. if item == "__dict__":
  164. raise TypeError(
  165. "PersistentConfig object cannot be converted to dict, use config_get or .value instead."
  166. )
  167. return super().__getattribute__(item)
  168. def save(self):
  169. log.info(f"Saving '{self.env_name}' to the database")
  170. path_parts = self.config_path.split(".")
  171. sub_config = CONFIG_DATA
  172. for key in path_parts[:-1]:
  173. if key not in sub_config:
  174. sub_config[key] = {}
  175. sub_config = sub_config[key]
  176. sub_config[path_parts[-1]] = self.value
  177. save_to_db(CONFIG_DATA)
  178. self.config_value = self.value
  179. class AppConfig:
  180. _state: dict[str, PersistentConfig]
  181. def __init__(self):
  182. super().__setattr__("_state", {})
  183. def __setattr__(self, key, value):
  184. if isinstance(value, PersistentConfig):
  185. self._state[key] = value
  186. else:
  187. self._state[key].value = value
  188. self._state[key].save()
  189. def __getattr__(self, key):
  190. return self._state[key].value
  191. ####################################
  192. # WEBUI_AUTH (Required for security)
  193. ####################################
  194. JWT_EXPIRES_IN = PersistentConfig(
  195. "JWT_EXPIRES_IN", "auth.jwt_expiry", os.environ.get("JWT_EXPIRES_IN", "-1")
  196. )
  197. ####################################
  198. # OAuth config
  199. ####################################
  200. ENABLE_OAUTH_SIGNUP = PersistentConfig(
  201. "ENABLE_OAUTH_SIGNUP",
  202. "oauth.enable_signup",
  203. os.environ.get("ENABLE_OAUTH_SIGNUP", "False").lower() == "true",
  204. )
  205. OAUTH_MERGE_ACCOUNTS_BY_EMAIL = PersistentConfig(
  206. "OAUTH_MERGE_ACCOUNTS_BY_EMAIL",
  207. "oauth.merge_accounts_by_email",
  208. os.environ.get("OAUTH_MERGE_ACCOUNTS_BY_EMAIL", "False").lower() == "true",
  209. )
  210. OAUTH_PROVIDERS = {}
  211. GOOGLE_CLIENT_ID = PersistentConfig(
  212. "GOOGLE_CLIENT_ID",
  213. "oauth.google.client_id",
  214. os.environ.get("GOOGLE_CLIENT_ID", ""),
  215. )
  216. GOOGLE_CLIENT_SECRET = PersistentConfig(
  217. "GOOGLE_CLIENT_SECRET",
  218. "oauth.google.client_secret",
  219. os.environ.get("GOOGLE_CLIENT_SECRET", ""),
  220. )
  221. GOOGLE_OAUTH_SCOPE = PersistentConfig(
  222. "GOOGLE_OAUTH_SCOPE",
  223. "oauth.google.scope",
  224. os.environ.get("GOOGLE_OAUTH_SCOPE", "openid email profile"),
  225. )
  226. GOOGLE_REDIRECT_URI = PersistentConfig(
  227. "GOOGLE_REDIRECT_URI",
  228. "oauth.google.redirect_uri",
  229. os.environ.get("GOOGLE_REDIRECT_URI", ""),
  230. )
  231. MICROSOFT_CLIENT_ID = PersistentConfig(
  232. "MICROSOFT_CLIENT_ID",
  233. "oauth.microsoft.client_id",
  234. os.environ.get("MICROSOFT_CLIENT_ID", ""),
  235. )
  236. MICROSOFT_CLIENT_SECRET = PersistentConfig(
  237. "MICROSOFT_CLIENT_SECRET",
  238. "oauth.microsoft.client_secret",
  239. os.environ.get("MICROSOFT_CLIENT_SECRET", ""),
  240. )
  241. MICROSOFT_CLIENT_TENANT_ID = PersistentConfig(
  242. "MICROSOFT_CLIENT_TENANT_ID",
  243. "oauth.microsoft.tenant_id",
  244. os.environ.get("MICROSOFT_CLIENT_TENANT_ID", ""),
  245. )
  246. MICROSOFT_OAUTH_SCOPE = PersistentConfig(
  247. "MICROSOFT_OAUTH_SCOPE",
  248. "oauth.microsoft.scope",
  249. os.environ.get("MICROSOFT_OAUTH_SCOPE", "openid email profile"),
  250. )
  251. MICROSOFT_REDIRECT_URI = PersistentConfig(
  252. "MICROSOFT_REDIRECT_URI",
  253. "oauth.microsoft.redirect_uri",
  254. os.environ.get("MICROSOFT_REDIRECT_URI", ""),
  255. )
  256. OAUTH_CLIENT_ID = PersistentConfig(
  257. "OAUTH_CLIENT_ID",
  258. "oauth.oidc.client_id",
  259. os.environ.get("OAUTH_CLIENT_ID", ""),
  260. )
  261. OAUTH_CLIENT_SECRET = PersistentConfig(
  262. "OAUTH_CLIENT_SECRET",
  263. "oauth.oidc.client_secret",
  264. os.environ.get("OAUTH_CLIENT_SECRET", ""),
  265. )
  266. OPENID_PROVIDER_URL = PersistentConfig(
  267. "OPENID_PROVIDER_URL",
  268. "oauth.oidc.provider_url",
  269. os.environ.get("OPENID_PROVIDER_URL", ""),
  270. )
  271. OPENID_REDIRECT_URI = PersistentConfig(
  272. "OPENID_REDIRECT_URI",
  273. "oauth.oidc.redirect_uri",
  274. os.environ.get("OPENID_REDIRECT_URI", ""),
  275. )
  276. OAUTH_SCOPES = PersistentConfig(
  277. "OAUTH_SCOPES",
  278. "oauth.oidc.scopes",
  279. os.environ.get("OAUTH_SCOPES", "openid email profile"),
  280. )
  281. OAUTH_PROVIDER_NAME = PersistentConfig(
  282. "OAUTH_PROVIDER_NAME",
  283. "oauth.oidc.provider_name",
  284. os.environ.get("OAUTH_PROVIDER_NAME", "SSO"),
  285. )
  286. OAUTH_USERNAME_CLAIM = PersistentConfig(
  287. "OAUTH_USERNAME_CLAIM",
  288. "oauth.oidc.username_claim",
  289. os.environ.get("OAUTH_USERNAME_CLAIM", "name"),
  290. )
  291. OAUTH_PICTURE_CLAIM = PersistentConfig(
  292. "OAUTH_USERNAME_CLAIM",
  293. "oauth.oidc.avatar_claim",
  294. os.environ.get("OAUTH_PICTURE_CLAIM", "picture"),
  295. )
  296. OAUTH_EMAIL_CLAIM = PersistentConfig(
  297. "OAUTH_EMAIL_CLAIM",
  298. "oauth.oidc.email_claim",
  299. os.environ.get("OAUTH_EMAIL_CLAIM", "email"),
  300. )
  301. def load_oauth_providers():
  302. OAUTH_PROVIDERS.clear()
  303. if GOOGLE_CLIENT_ID.value and GOOGLE_CLIENT_SECRET.value:
  304. OAUTH_PROVIDERS["google"] = {
  305. "client_id": GOOGLE_CLIENT_ID.value,
  306. "client_secret": GOOGLE_CLIENT_SECRET.value,
  307. "server_metadata_url": "https://accounts.google.com/.well-known/openid-configuration",
  308. "scope": GOOGLE_OAUTH_SCOPE.value,
  309. "redirect_uri": GOOGLE_REDIRECT_URI.value,
  310. }
  311. if (
  312. MICROSOFT_CLIENT_ID.value
  313. and MICROSOFT_CLIENT_SECRET.value
  314. and MICROSOFT_CLIENT_TENANT_ID.value
  315. ):
  316. OAUTH_PROVIDERS["microsoft"] = {
  317. "client_id": MICROSOFT_CLIENT_ID.value,
  318. "client_secret": MICROSOFT_CLIENT_SECRET.value,
  319. "server_metadata_url": f"https://login.microsoftonline.com/{MICROSOFT_CLIENT_TENANT_ID.value}/v2.0/.well-known/openid-configuration",
  320. "scope": MICROSOFT_OAUTH_SCOPE.value,
  321. "redirect_uri": MICROSOFT_REDIRECT_URI.value,
  322. }
  323. if (
  324. OAUTH_CLIENT_ID.value
  325. and OAUTH_CLIENT_SECRET.value
  326. and OPENID_PROVIDER_URL.value
  327. ):
  328. OAUTH_PROVIDERS["oidc"] = {
  329. "client_id": OAUTH_CLIENT_ID.value,
  330. "client_secret": OAUTH_CLIENT_SECRET.value,
  331. "server_metadata_url": OPENID_PROVIDER_URL.value,
  332. "scope": OAUTH_SCOPES.value,
  333. "name": OAUTH_PROVIDER_NAME.value,
  334. "redirect_uri": OPENID_REDIRECT_URI.value,
  335. }
  336. load_oauth_providers()
  337. ####################################
  338. # Static DIR
  339. ####################################
  340. STATIC_DIR = Path(os.getenv("STATIC_DIR", BACKEND_DIR / "static")).resolve()
  341. frontend_favicon = FRONTEND_BUILD_DIR / "static" / "favicon.png"
  342. if frontend_favicon.exists():
  343. try:
  344. shutil.copyfile(frontend_favicon, STATIC_DIR / "favicon.png")
  345. except Exception as e:
  346. logging.error(f"An error occurred: {e}")
  347. else:
  348. logging.warning(f"Frontend favicon not found at {frontend_favicon}")
  349. frontend_splash = FRONTEND_BUILD_DIR / "static" / "splash.png"
  350. if frontend_splash.exists():
  351. try:
  352. shutil.copyfile(frontend_splash, STATIC_DIR / "splash.png")
  353. except Exception as e:
  354. logging.error(f"An error occurred: {e}")
  355. else:
  356. logging.warning(f"Frontend splash not found at {frontend_splash}")
  357. ####################################
  358. # CUSTOM_NAME
  359. ####################################
  360. CUSTOM_NAME = os.environ.get("CUSTOM_NAME", "")
  361. if CUSTOM_NAME:
  362. try:
  363. r = requests.get(f"https://api.openwebui.com/api/v1/custom/{CUSTOM_NAME}")
  364. data = r.json()
  365. if r.ok:
  366. if "logo" in data:
  367. WEBUI_FAVICON_URL = url = (
  368. f"https://api.openwebui.com{data['logo']}"
  369. if data["logo"][0] == "/"
  370. else data["logo"]
  371. )
  372. r = requests.get(url, stream=True)
  373. if r.status_code == 200:
  374. with open(f"{STATIC_DIR}/favicon.png", "wb") as f:
  375. r.raw.decode_content = True
  376. shutil.copyfileobj(r.raw, f)
  377. if "splash" in data:
  378. url = (
  379. f"https://api.openwebui.com{data['splash']}"
  380. if data["splash"][0] == "/"
  381. else data["splash"]
  382. )
  383. r = requests.get(url, stream=True)
  384. if r.status_code == 200:
  385. with open(f"{STATIC_DIR}/splash.png", "wb") as f:
  386. r.raw.decode_content = True
  387. shutil.copyfileobj(r.raw, f)
  388. WEBUI_NAME = data["name"]
  389. except Exception as e:
  390. log.exception(e)
  391. pass
  392. ####################################
  393. # File Upload DIR
  394. ####################################
  395. UPLOAD_DIR = f"{DATA_DIR}/uploads"
  396. Path(UPLOAD_DIR).mkdir(parents=True, exist_ok=True)
  397. ####################################
  398. # Cache DIR
  399. ####################################
  400. CACHE_DIR = f"{DATA_DIR}/cache"
  401. Path(CACHE_DIR).mkdir(parents=True, exist_ok=True)
  402. ####################################
  403. # Docs DIR
  404. ####################################
  405. DOCS_DIR = os.getenv("DOCS_DIR", f"{DATA_DIR}/docs")
  406. Path(DOCS_DIR).mkdir(parents=True, exist_ok=True)
  407. ####################################
  408. # Tools DIR
  409. ####################################
  410. TOOLS_DIR = os.getenv("TOOLS_DIR", f"{DATA_DIR}/tools")
  411. Path(TOOLS_DIR).mkdir(parents=True, exist_ok=True)
  412. ####################################
  413. # Functions DIR
  414. ####################################
  415. FUNCTIONS_DIR = os.getenv("FUNCTIONS_DIR", f"{DATA_DIR}/functions")
  416. Path(FUNCTIONS_DIR).mkdir(parents=True, exist_ok=True)
  417. ####################################
  418. # LITELLM_CONFIG
  419. ####################################
  420. def create_config_file(file_path):
  421. directory = os.path.dirname(file_path)
  422. # Check if directory exists, if not, create it
  423. if not os.path.exists(directory):
  424. os.makedirs(directory)
  425. # Data to write into the YAML file
  426. config_data = {
  427. "general_settings": {},
  428. "litellm_settings": {},
  429. "model_list": [],
  430. "router_settings": {},
  431. }
  432. # Write data to YAML file
  433. with open(file_path, "w") as file:
  434. yaml.dump(config_data, file)
  435. LITELLM_CONFIG_PATH = f"{DATA_DIR}/litellm/config.yaml"
  436. # if not os.path.exists(LITELLM_CONFIG_PATH):
  437. # log.info("Config file doesn't exist. Creating...")
  438. # create_config_file(LITELLM_CONFIG_PATH)
  439. # log.info("Config file created successfully.")
  440. ####################################
  441. # OLLAMA_BASE_URL
  442. ####################################
  443. ENABLE_OLLAMA_API = PersistentConfig(
  444. "ENABLE_OLLAMA_API",
  445. "ollama.enable",
  446. os.environ.get("ENABLE_OLLAMA_API", "True").lower() == "true",
  447. )
  448. OLLAMA_API_BASE_URL = os.environ.get(
  449. "OLLAMA_API_BASE_URL", "http://localhost:11434/api"
  450. )
  451. OLLAMA_BASE_URL = os.environ.get("OLLAMA_BASE_URL", "")
  452. AIOHTTP_CLIENT_TIMEOUT = os.environ.get("AIOHTTP_CLIENT_TIMEOUT", "")
  453. if AIOHTTP_CLIENT_TIMEOUT == "":
  454. AIOHTTP_CLIENT_TIMEOUT = None
  455. else:
  456. try:
  457. AIOHTTP_CLIENT_TIMEOUT = int(AIOHTTP_CLIENT_TIMEOUT)
  458. except Exception:
  459. AIOHTTP_CLIENT_TIMEOUT = 300
  460. K8S_FLAG = os.environ.get("K8S_FLAG", "")
  461. USE_OLLAMA_DOCKER = os.environ.get("USE_OLLAMA_DOCKER", "false")
  462. if OLLAMA_BASE_URL == "" and OLLAMA_API_BASE_URL != "":
  463. OLLAMA_BASE_URL = (
  464. OLLAMA_API_BASE_URL[:-4]
  465. if OLLAMA_API_BASE_URL.endswith("/api")
  466. else OLLAMA_API_BASE_URL
  467. )
  468. if ENV == "prod":
  469. if OLLAMA_BASE_URL == "/ollama" and not K8S_FLAG:
  470. if USE_OLLAMA_DOCKER.lower() == "true":
  471. # if you use all-in-one docker container (Open WebUI + Ollama)
  472. # with the docker build arg USE_OLLAMA=true (--build-arg="USE_OLLAMA=true") this only works with http://localhost:11434
  473. OLLAMA_BASE_URL = "http://localhost:11434"
  474. else:
  475. OLLAMA_BASE_URL = "http://host.docker.internal:11434"
  476. elif K8S_FLAG:
  477. OLLAMA_BASE_URL = "http://ollama-service.open-webui.svc.cluster.local:11434"
  478. OLLAMA_BASE_URLS = os.environ.get("OLLAMA_BASE_URLS", "")
  479. OLLAMA_BASE_URLS = OLLAMA_BASE_URLS if OLLAMA_BASE_URLS != "" else OLLAMA_BASE_URL
  480. OLLAMA_BASE_URLS = [url.strip() for url in OLLAMA_BASE_URLS.split(";")]
  481. OLLAMA_BASE_URLS = PersistentConfig(
  482. "OLLAMA_BASE_URLS", "ollama.base_urls", OLLAMA_BASE_URLS
  483. )
  484. ####################################
  485. # OPENAI_API
  486. ####################################
  487. ENABLE_OPENAI_API = PersistentConfig(
  488. "ENABLE_OPENAI_API",
  489. "openai.enable",
  490. os.environ.get("ENABLE_OPENAI_API", "True").lower() == "true",
  491. )
  492. OPENAI_API_KEY = os.environ.get("OPENAI_API_KEY", "")
  493. OPENAI_API_BASE_URL = os.environ.get("OPENAI_API_BASE_URL", "")
  494. if OPENAI_API_BASE_URL == "":
  495. OPENAI_API_BASE_URL = "https://api.openai.com/v1"
  496. OPENAI_API_KEYS = os.environ.get("OPENAI_API_KEYS", "")
  497. OPENAI_API_KEYS = OPENAI_API_KEYS if OPENAI_API_KEYS != "" else OPENAI_API_KEY
  498. OPENAI_API_KEYS = [url.strip() for url in OPENAI_API_KEYS.split(";")]
  499. OPENAI_API_KEYS = PersistentConfig(
  500. "OPENAI_API_KEYS", "openai.api_keys", OPENAI_API_KEYS
  501. )
  502. OPENAI_API_BASE_URLS = os.environ.get("OPENAI_API_BASE_URLS", "")
  503. OPENAI_API_BASE_URLS = (
  504. OPENAI_API_BASE_URLS if OPENAI_API_BASE_URLS != "" else OPENAI_API_BASE_URL
  505. )
  506. OPENAI_API_BASE_URLS = [
  507. url.strip() if url != "" else "https://api.openai.com/v1"
  508. for url in OPENAI_API_BASE_URLS.split(";")
  509. ]
  510. OPENAI_API_BASE_URLS = PersistentConfig(
  511. "OPENAI_API_BASE_URLS", "openai.api_base_urls", OPENAI_API_BASE_URLS
  512. )
  513. OPENAI_API_KEY = ""
  514. try:
  515. OPENAI_API_KEY = OPENAI_API_KEYS.value[
  516. OPENAI_API_BASE_URLS.value.index("https://api.openai.com/v1")
  517. ]
  518. except Exception:
  519. pass
  520. OPENAI_API_BASE_URL = "https://api.openai.com/v1"
  521. ####################################
  522. # WEBUI
  523. ####################################
  524. ENABLE_SIGNUP = PersistentConfig(
  525. "ENABLE_SIGNUP",
  526. "ui.enable_signup",
  527. (
  528. False
  529. if not WEBUI_AUTH
  530. else os.environ.get("ENABLE_SIGNUP", "True").lower() == "true"
  531. ),
  532. )
  533. ENABLE_LOGIN_FORM = PersistentConfig(
  534. "ENABLE_LOGIN_FORM",
  535. "ui.ENABLE_LOGIN_FORM",
  536. os.environ.get("ENABLE_LOGIN_FORM", "True").lower() == "true",
  537. )
  538. DEFAULT_LOCALE = PersistentConfig(
  539. "DEFAULT_LOCALE",
  540. "ui.default_locale",
  541. os.environ.get("DEFAULT_LOCALE", ""),
  542. )
  543. DEFAULT_MODELS = PersistentConfig(
  544. "DEFAULT_MODELS", "ui.default_models", os.environ.get("DEFAULT_MODELS", None)
  545. )
  546. DEFAULT_PROMPT_SUGGESTIONS = PersistentConfig(
  547. "DEFAULT_PROMPT_SUGGESTIONS",
  548. "ui.prompt_suggestions",
  549. [
  550. {
  551. "title": ["Help me study", "vocabulary for a college entrance exam"],
  552. "content": "Help me study vocabulary: write a sentence for me to fill in the blank, and I'll try to pick the correct option.",
  553. },
  554. {
  555. "title": ["Give me ideas", "for what to do with my kids' art"],
  556. "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.",
  557. },
  558. {
  559. "title": ["Tell me a fun fact", "about the Roman Empire"],
  560. "content": "Tell me a random fun fact about the Roman Empire",
  561. },
  562. {
  563. "title": ["Show me a code snippet", "of a website's sticky header"],
  564. "content": "Show me a code snippet of a website's sticky header in CSS and JavaScript.",
  565. },
  566. {
  567. "title": [
  568. "Explain options trading",
  569. "if I'm familiar with buying and selling stocks",
  570. ],
  571. "content": "Explain options trading in simple terms if I'm familiar with buying and selling stocks.",
  572. },
  573. {
  574. "title": ["Overcome procrastination", "give me tips"],
  575. "content": "Could you start by asking me about instances when I procrastinate the most and then give me some suggestions to overcome it?",
  576. },
  577. ],
  578. )
  579. DEFAULT_USER_ROLE = PersistentConfig(
  580. "DEFAULT_USER_ROLE",
  581. "ui.default_user_role",
  582. os.getenv("DEFAULT_USER_ROLE", "pending"),
  583. )
  584. USER_PERMISSIONS_CHAT_DELETION = (
  585. os.environ.get("USER_PERMISSIONS_CHAT_DELETION", "True").lower() == "true"
  586. )
  587. USER_PERMISSIONS_CHAT_EDITING = (
  588. os.environ.get("USER_PERMISSIONS_CHAT_EDITING", "True").lower() == "true"
  589. )
  590. USER_PERMISSIONS_CHAT_TEMPORARY = (
  591. os.environ.get("USER_PERMISSIONS_CHAT_TEMPORARY", "True").lower() == "true"
  592. )
  593. USER_PERMISSIONS = PersistentConfig(
  594. "USER_PERMISSIONS",
  595. "ui.user_permissions",
  596. {
  597. "chat": {
  598. "deletion": USER_PERMISSIONS_CHAT_DELETION,
  599. "editing": USER_PERMISSIONS_CHAT_EDITING,
  600. "temporary": USER_PERMISSIONS_CHAT_TEMPORARY,
  601. }
  602. },
  603. )
  604. ENABLE_MODEL_FILTER = PersistentConfig(
  605. "ENABLE_MODEL_FILTER",
  606. "model_filter.enable",
  607. os.environ.get("ENABLE_MODEL_FILTER", "False").lower() == "true",
  608. )
  609. MODEL_FILTER_LIST = os.environ.get("MODEL_FILTER_LIST", "")
  610. MODEL_FILTER_LIST = PersistentConfig(
  611. "MODEL_FILTER_LIST",
  612. "model_filter.list",
  613. [model.strip() for model in MODEL_FILTER_LIST.split(";")],
  614. )
  615. WEBHOOK_URL = PersistentConfig(
  616. "WEBHOOK_URL", "webhook_url", os.environ.get("WEBHOOK_URL", "")
  617. )
  618. ENABLE_ADMIN_EXPORT = os.environ.get("ENABLE_ADMIN_EXPORT", "True").lower() == "true"
  619. ENABLE_ADMIN_CHAT_ACCESS = (
  620. os.environ.get("ENABLE_ADMIN_CHAT_ACCESS", "True").lower() == "true"
  621. )
  622. ENABLE_COMMUNITY_SHARING = PersistentConfig(
  623. "ENABLE_COMMUNITY_SHARING",
  624. "ui.enable_community_sharing",
  625. os.environ.get("ENABLE_COMMUNITY_SHARING", "True").lower() == "true",
  626. )
  627. ENABLE_MESSAGE_RATING = PersistentConfig(
  628. "ENABLE_MESSAGE_RATING",
  629. "ui.enable_message_rating",
  630. os.environ.get("ENABLE_MESSAGE_RATING", "True").lower() == "true",
  631. )
  632. def validate_cors_origins(origins):
  633. for origin in origins:
  634. if origin != "*":
  635. validate_cors_origin(origin)
  636. def validate_cors_origin(origin):
  637. parsed_url = urlparse(origin)
  638. # Check if the scheme is either http or https
  639. if parsed_url.scheme not in ["http", "https"]:
  640. raise ValueError(
  641. f"Invalid scheme in CORS_ALLOW_ORIGIN: '{origin}'. Only 'http' and 'https' are allowed."
  642. )
  643. # Ensure that the netloc (domain + port) is present, indicating it's a valid URL
  644. if not parsed_url.netloc:
  645. raise ValueError(f"Invalid URL structure in CORS_ALLOW_ORIGIN: '{origin}'.")
  646. # For production, you should only need one host as
  647. # fastapi serves the svelte-kit built frontend and backend from the same host and port.
  648. # To test CORS_ALLOW_ORIGIN locally, you can set something like
  649. # CORS_ALLOW_ORIGIN=http://localhost:5173;http://localhost:8080
  650. # in your .env file depending on your frontend port, 5173 in this case.
  651. CORS_ALLOW_ORIGIN = os.environ.get("CORS_ALLOW_ORIGIN", "*").split(";")
  652. if "*" in CORS_ALLOW_ORIGIN:
  653. log.warning(
  654. "\n\nWARNING: CORS_ALLOW_ORIGIN IS SET TO '*' - NOT RECOMMENDED FOR PRODUCTION DEPLOYMENTS.\n"
  655. )
  656. validate_cors_origins(CORS_ALLOW_ORIGIN)
  657. class BannerModel(BaseModel):
  658. id: str
  659. type: str
  660. title: Optional[str] = None
  661. content: str
  662. dismissible: bool
  663. timestamp: int
  664. try:
  665. banners = json.loads(os.environ.get("WEBUI_BANNERS", "[]"))
  666. banners = [BannerModel(**banner) for banner in banners]
  667. except Exception as e:
  668. print(f"Error loading WEBUI_BANNERS: {e}")
  669. banners = []
  670. WEBUI_BANNERS = PersistentConfig("WEBUI_BANNERS", "ui.banners", banners)
  671. SHOW_ADMIN_DETAILS = PersistentConfig(
  672. "SHOW_ADMIN_DETAILS",
  673. "auth.admin.show",
  674. os.environ.get("SHOW_ADMIN_DETAILS", "true").lower() == "true",
  675. )
  676. ADMIN_EMAIL = PersistentConfig(
  677. "ADMIN_EMAIL",
  678. "auth.admin.email",
  679. os.environ.get("ADMIN_EMAIL", None),
  680. )
  681. ####################################
  682. # TASKS
  683. ####################################
  684. TASK_MODEL = PersistentConfig(
  685. "TASK_MODEL",
  686. "task.model.default",
  687. os.environ.get("TASK_MODEL", ""),
  688. )
  689. TASK_MODEL_EXTERNAL = PersistentConfig(
  690. "TASK_MODEL_EXTERNAL",
  691. "task.model.external",
  692. os.environ.get("TASK_MODEL_EXTERNAL", ""),
  693. )
  694. TITLE_GENERATION_PROMPT_TEMPLATE = PersistentConfig(
  695. "TITLE_GENERATION_PROMPT_TEMPLATE",
  696. "task.title.prompt_template",
  697. os.environ.get(
  698. "TITLE_GENERATION_PROMPT_TEMPLATE",
  699. """Create a concise, 3-5 word title with an emoji as a title for the prompt in the given language. Suitable Emojis for the summary can be used to enhance understanding but avoid quotation marks or special formatting. RESPOND ONLY WITH THE TITLE TEXT.
  700. Examples of titles:
  701. 📉 Stock Market Trends
  702. 🍪 Perfect Chocolate Chip Recipe
  703. Evolution of Music Streaming
  704. Remote Work Productivity Tips
  705. Artificial Intelligence in Healthcare
  706. 🎮 Video Game Development Insights
  707. Prompt: {{prompt:middletruncate:8000}}""",
  708. ),
  709. )
  710. SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE = PersistentConfig(
  711. "SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE",
  712. "task.search.prompt_template",
  713. os.environ.get(
  714. "SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE",
  715. """You are tasked with generating web search queries. Give me an appropriate query to answer my question for google search. Answer with only the query. Today is {{CURRENT_DATE}}.
  716. Question:
  717. {{prompt:end:4000}}""",
  718. ),
  719. )
  720. SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD = PersistentConfig(
  721. "SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD",
  722. "task.search.prompt_length_threshold",
  723. int(
  724. os.environ.get(
  725. "SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD",
  726. 100,
  727. )
  728. ),
  729. )
  730. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = PersistentConfig(
  731. "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE",
  732. "task.tools.prompt_template",
  733. os.environ.get(
  734. "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE",
  735. """Available Tools: {{TOOLS}}\nReturn an empty string if no tools match the query. If a function tool matches, construct and return a JSON object in the format {\"name\": \"functionName\", \"parameters\": {\"requiredFunctionParamKey\": \"requiredFunctionParamValue\"}} using the appropriate tool and its parameters. Only return the object and limit the response to the JSON object without additional text.""",
  736. ),
  737. )
  738. ####################################
  739. # RAG document content extraction
  740. ####################################
  741. CONTENT_EXTRACTION_ENGINE = PersistentConfig(
  742. "CONTENT_EXTRACTION_ENGINE",
  743. "rag.CONTENT_EXTRACTION_ENGINE",
  744. os.environ.get("CONTENT_EXTRACTION_ENGINE", "").lower(),
  745. )
  746. TIKA_SERVER_URL = PersistentConfig(
  747. "TIKA_SERVER_URL",
  748. "rag.tika_server_url",
  749. os.getenv("TIKA_SERVER_URL", "http://tika:9998"), # Default for sidecar deployment
  750. )
  751. ####################################
  752. # RAG
  753. ####################################
  754. CHROMA_DATA_PATH = f"{DATA_DIR}/vector_db"
  755. CHROMA_TENANT = os.environ.get("CHROMA_TENANT", chromadb.DEFAULT_TENANT)
  756. CHROMA_DATABASE = os.environ.get("CHROMA_DATABASE", chromadb.DEFAULT_DATABASE)
  757. CHROMA_HTTP_HOST = os.environ.get("CHROMA_HTTP_HOST", "")
  758. CHROMA_HTTP_PORT = int(os.environ.get("CHROMA_HTTP_PORT", "8000"))
  759. # Comma-separated list of header=value pairs
  760. CHROMA_HTTP_HEADERS = os.environ.get("CHROMA_HTTP_HEADERS", "")
  761. if CHROMA_HTTP_HEADERS:
  762. CHROMA_HTTP_HEADERS = dict(
  763. [pair.split("=") for pair in CHROMA_HTTP_HEADERS.split(",")]
  764. )
  765. else:
  766. CHROMA_HTTP_HEADERS = None
  767. CHROMA_HTTP_SSL = os.environ.get("CHROMA_HTTP_SSL", "false").lower() == "true"
  768. # 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)
  769. RAG_TOP_K = PersistentConfig(
  770. "RAG_TOP_K", "rag.top_k", int(os.environ.get("RAG_TOP_K", "5"))
  771. )
  772. RAG_RELEVANCE_THRESHOLD = PersistentConfig(
  773. "RAG_RELEVANCE_THRESHOLD",
  774. "rag.relevance_threshold",
  775. float(os.environ.get("RAG_RELEVANCE_THRESHOLD", "0.0")),
  776. )
  777. ENABLE_RAG_HYBRID_SEARCH = PersistentConfig(
  778. "ENABLE_RAG_HYBRID_SEARCH",
  779. "rag.enable_hybrid_search",
  780. os.environ.get("ENABLE_RAG_HYBRID_SEARCH", "").lower() == "true",
  781. )
  782. RAG_FILE_MAX_COUNT = PersistentConfig(
  783. "RAG_FILE_MAX_COUNT",
  784. "rag.file.max_count",
  785. (
  786. int(os.environ.get("RAG_FILE_MAX_COUNT"))
  787. if os.environ.get("RAG_FILE_MAX_COUNT")
  788. else None
  789. ),
  790. )
  791. RAG_FILE_MAX_SIZE = PersistentConfig(
  792. "RAG_FILE_MAX_SIZE",
  793. "rag.file.max_size",
  794. (
  795. int(os.environ.get("RAG_FILE_MAX_SIZE"))
  796. if os.environ.get("RAG_FILE_MAX_SIZE")
  797. else None
  798. ),
  799. )
  800. ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION = PersistentConfig(
  801. "ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION",
  802. "rag.enable_web_loader_ssl_verification",
  803. os.environ.get("ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION", "True").lower() == "true",
  804. )
  805. RAG_EMBEDDING_ENGINE = PersistentConfig(
  806. "RAG_EMBEDDING_ENGINE",
  807. "rag.embedding_engine",
  808. os.environ.get("RAG_EMBEDDING_ENGINE", ""),
  809. )
  810. PDF_EXTRACT_IMAGES = PersistentConfig(
  811. "PDF_EXTRACT_IMAGES",
  812. "rag.pdf_extract_images",
  813. os.environ.get("PDF_EXTRACT_IMAGES", "False").lower() == "true",
  814. )
  815. RAG_EMBEDDING_MODEL = PersistentConfig(
  816. "RAG_EMBEDDING_MODEL",
  817. "rag.embedding_model",
  818. os.environ.get("RAG_EMBEDDING_MODEL", "sentence-transformers/all-MiniLM-L6-v2"),
  819. )
  820. log.info(f"Embedding model set: {RAG_EMBEDDING_MODEL.value}")
  821. RAG_EMBEDDING_MODEL_AUTO_UPDATE = (
  822. os.environ.get("RAG_EMBEDDING_MODEL_AUTO_UPDATE", "").lower() == "true"
  823. )
  824. RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE = (
  825. os.environ.get("RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE", "").lower() == "true"
  826. )
  827. RAG_EMBEDDING_OPENAI_BATCH_SIZE = PersistentConfig(
  828. "RAG_EMBEDDING_OPENAI_BATCH_SIZE",
  829. "rag.embedding_openai_batch_size",
  830. int(os.environ.get("RAG_EMBEDDING_OPENAI_BATCH_SIZE", "1")),
  831. )
  832. RAG_RERANKING_MODEL = PersistentConfig(
  833. "RAG_RERANKING_MODEL",
  834. "rag.reranking_model",
  835. os.environ.get("RAG_RERANKING_MODEL", ""),
  836. )
  837. if RAG_RERANKING_MODEL.value != "":
  838. log.info(f"Reranking model set: {RAG_RERANKING_MODEL.value}")
  839. RAG_RERANKING_MODEL_AUTO_UPDATE = (
  840. os.environ.get("RAG_RERANKING_MODEL_AUTO_UPDATE", "").lower() == "true"
  841. )
  842. RAG_RERANKING_MODEL_TRUST_REMOTE_CODE = (
  843. os.environ.get("RAG_RERANKING_MODEL_TRUST_REMOTE_CODE", "").lower() == "true"
  844. )
  845. if CHROMA_HTTP_HOST != "":
  846. CHROMA_CLIENT = chromadb.HttpClient(
  847. host=CHROMA_HTTP_HOST,
  848. port=CHROMA_HTTP_PORT,
  849. headers=CHROMA_HTTP_HEADERS,
  850. ssl=CHROMA_HTTP_SSL,
  851. tenant=CHROMA_TENANT,
  852. database=CHROMA_DATABASE,
  853. settings=Settings(allow_reset=True, anonymized_telemetry=False),
  854. )
  855. else:
  856. CHROMA_CLIENT = chromadb.PersistentClient(
  857. path=CHROMA_DATA_PATH,
  858. settings=Settings(allow_reset=True, anonymized_telemetry=False),
  859. tenant=CHROMA_TENANT,
  860. database=CHROMA_DATABASE,
  861. )
  862. # device type embedding models - "cpu" (default), "cuda" (nvidia gpu required) or "mps" (apple silicon) - choosing this right can lead to better performance
  863. USE_CUDA = os.environ.get("USE_CUDA_DOCKER", "false")
  864. if USE_CUDA.lower() == "true":
  865. DEVICE_TYPE = "cuda"
  866. else:
  867. DEVICE_TYPE = "cpu"
  868. CHUNK_SIZE = PersistentConfig(
  869. "CHUNK_SIZE", "rag.chunk_size", int(os.environ.get("CHUNK_SIZE", "1500"))
  870. )
  871. CHUNK_OVERLAP = PersistentConfig(
  872. "CHUNK_OVERLAP",
  873. "rag.chunk_overlap",
  874. int(os.environ.get("CHUNK_OVERLAP", "100")),
  875. )
  876. DEFAULT_RAG_TEMPLATE = """Use the following context as your learned knowledge, inside <context></context> XML tags.
  877. <context>
  878. [context]
  879. </context>
  880. When answer to user:
  881. - If you don't know, just say that you don't know.
  882. - If you don't know when you are not sure, ask for clarification.
  883. Avoid mentioning that you obtained the information from the context.
  884. And answer according to the language of the user's question.
  885. Given the context information, answer the query.
  886. Query: [query]"""
  887. RAG_TEMPLATE = PersistentConfig(
  888. "RAG_TEMPLATE",
  889. "rag.template",
  890. os.environ.get("RAG_TEMPLATE", DEFAULT_RAG_TEMPLATE),
  891. )
  892. RAG_OPENAI_API_BASE_URL = PersistentConfig(
  893. "RAG_OPENAI_API_BASE_URL",
  894. "rag.openai_api_base_url",
  895. os.getenv("RAG_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  896. )
  897. RAG_OPENAI_API_KEY = PersistentConfig(
  898. "RAG_OPENAI_API_KEY",
  899. "rag.openai_api_key",
  900. os.getenv("RAG_OPENAI_API_KEY", OPENAI_API_KEY),
  901. )
  902. ENABLE_RAG_LOCAL_WEB_FETCH = (
  903. os.getenv("ENABLE_RAG_LOCAL_WEB_FETCH", "False").lower() == "true"
  904. )
  905. YOUTUBE_LOADER_LANGUAGE = PersistentConfig(
  906. "YOUTUBE_LOADER_LANGUAGE",
  907. "rag.youtube_loader_language",
  908. os.getenv("YOUTUBE_LOADER_LANGUAGE", "en").split(","),
  909. )
  910. ENABLE_RAG_WEB_SEARCH = PersistentConfig(
  911. "ENABLE_RAG_WEB_SEARCH",
  912. "rag.web.search.enable",
  913. os.getenv("ENABLE_RAG_WEB_SEARCH", "False").lower() == "true",
  914. )
  915. RAG_WEB_SEARCH_ENGINE = PersistentConfig(
  916. "RAG_WEB_SEARCH_ENGINE",
  917. "rag.web.search.engine",
  918. os.getenv("RAG_WEB_SEARCH_ENGINE", ""),
  919. )
  920. # You can provide a list of your own websites to filter after performing a web search.
  921. # This ensures the highest level of safety and reliability of the information sources.
  922. RAG_WEB_SEARCH_DOMAIN_FILTER_LIST = PersistentConfig(
  923. "RAG_WEB_SEARCH_DOMAIN_FILTER_LIST",
  924. "rag.rag.web.search.domain.filter_list",
  925. [
  926. # "wikipedia.com",
  927. # "wikimedia.org",
  928. # "wikidata.org",
  929. ],
  930. )
  931. SEARXNG_QUERY_URL = PersistentConfig(
  932. "SEARXNG_QUERY_URL",
  933. "rag.web.search.searxng_query_url",
  934. os.getenv("SEARXNG_QUERY_URL", ""),
  935. )
  936. GOOGLE_PSE_API_KEY = PersistentConfig(
  937. "GOOGLE_PSE_API_KEY",
  938. "rag.web.search.google_pse_api_key",
  939. os.getenv("GOOGLE_PSE_API_KEY", ""),
  940. )
  941. GOOGLE_PSE_ENGINE_ID = PersistentConfig(
  942. "GOOGLE_PSE_ENGINE_ID",
  943. "rag.web.search.google_pse_engine_id",
  944. os.getenv("GOOGLE_PSE_ENGINE_ID", ""),
  945. )
  946. BRAVE_SEARCH_API_KEY = PersistentConfig(
  947. "BRAVE_SEARCH_API_KEY",
  948. "rag.web.search.brave_search_api_key",
  949. os.getenv("BRAVE_SEARCH_API_KEY", ""),
  950. )
  951. SERPSTACK_API_KEY = PersistentConfig(
  952. "SERPSTACK_API_KEY",
  953. "rag.web.search.serpstack_api_key",
  954. os.getenv("SERPSTACK_API_KEY", ""),
  955. )
  956. SERPSTACK_HTTPS = PersistentConfig(
  957. "SERPSTACK_HTTPS",
  958. "rag.web.search.serpstack_https",
  959. os.getenv("SERPSTACK_HTTPS", "True").lower() == "true",
  960. )
  961. SERPER_API_KEY = PersistentConfig(
  962. "SERPER_API_KEY",
  963. "rag.web.search.serper_api_key",
  964. os.getenv("SERPER_API_KEY", ""),
  965. )
  966. SERPLY_API_KEY = PersistentConfig(
  967. "SERPLY_API_KEY",
  968. "rag.web.search.serply_api_key",
  969. os.getenv("SERPLY_API_KEY", ""),
  970. )
  971. TAVILY_API_KEY = PersistentConfig(
  972. "TAVILY_API_KEY",
  973. "rag.web.search.tavily_api_key",
  974. os.getenv("TAVILY_API_KEY", ""),
  975. )
  976. SEARCHAPI_API_KEY = PersistentConfig(
  977. "SEARCHAPI_API_KEY",
  978. "rag.web.search.searchapi_api_key",
  979. os.getenv("SEARCHAPI_API_KEY", ""),
  980. )
  981. SEARCHAPI_ENGINE = PersistentConfig(
  982. "SEARCHAPI_ENGINE",
  983. "rag.web.search.searchapi_engine",
  984. os.getenv("SEARCHAPI_ENGINE", ""),
  985. )
  986. RAG_WEB_SEARCH_RESULT_COUNT = PersistentConfig(
  987. "RAG_WEB_SEARCH_RESULT_COUNT",
  988. "rag.web.search.result_count",
  989. int(os.getenv("RAG_WEB_SEARCH_RESULT_COUNT", "3")),
  990. )
  991. RAG_WEB_SEARCH_CONCURRENT_REQUESTS = PersistentConfig(
  992. "RAG_WEB_SEARCH_CONCURRENT_REQUESTS",
  993. "rag.web.search.concurrent_requests",
  994. int(os.getenv("RAG_WEB_SEARCH_CONCURRENT_REQUESTS", "10")),
  995. )
  996. ####################################
  997. # Transcribe
  998. ####################################
  999. WHISPER_MODEL = os.getenv("WHISPER_MODEL", "base")
  1000. WHISPER_MODEL_DIR = os.getenv("WHISPER_MODEL_DIR", f"{CACHE_DIR}/whisper/models")
  1001. WHISPER_MODEL_AUTO_UPDATE = (
  1002. os.environ.get("WHISPER_MODEL_AUTO_UPDATE", "").lower() == "true"
  1003. )
  1004. ####################################
  1005. # Images
  1006. ####################################
  1007. IMAGE_GENERATION_ENGINE = PersistentConfig(
  1008. "IMAGE_GENERATION_ENGINE",
  1009. "image_generation.engine",
  1010. os.getenv("IMAGE_GENERATION_ENGINE", "openai"),
  1011. )
  1012. ENABLE_IMAGE_GENERATION = PersistentConfig(
  1013. "ENABLE_IMAGE_GENERATION",
  1014. "image_generation.enable",
  1015. os.environ.get("ENABLE_IMAGE_GENERATION", "").lower() == "true",
  1016. )
  1017. AUTOMATIC1111_BASE_URL = PersistentConfig(
  1018. "AUTOMATIC1111_BASE_URL",
  1019. "image_generation.automatic1111.base_url",
  1020. os.getenv("AUTOMATIC1111_BASE_URL", ""),
  1021. )
  1022. AUTOMATIC1111_API_AUTH = PersistentConfig(
  1023. "AUTOMATIC1111_API_AUTH",
  1024. "image_generation.automatic1111.api_auth",
  1025. os.getenv("AUTOMATIC1111_API_AUTH", ""),
  1026. )
  1027. COMFYUI_BASE_URL = PersistentConfig(
  1028. "COMFYUI_BASE_URL",
  1029. "image_generation.comfyui.base_url",
  1030. os.getenv("COMFYUI_BASE_URL", ""),
  1031. )
  1032. COMFYUI_DEFAULT_WORKFLOW = """
  1033. {
  1034. "3": {
  1035. "inputs": {
  1036. "seed": 0,
  1037. "steps": 20,
  1038. "cfg": 8,
  1039. "sampler_name": "euler",
  1040. "scheduler": "normal",
  1041. "denoise": 1,
  1042. "model": [
  1043. "4",
  1044. 0
  1045. ],
  1046. "positive": [
  1047. "6",
  1048. 0
  1049. ],
  1050. "negative": [
  1051. "7",
  1052. 0
  1053. ],
  1054. "latent_image": [
  1055. "5",
  1056. 0
  1057. ]
  1058. },
  1059. "class_type": "KSampler",
  1060. "_meta": {
  1061. "title": "KSampler"
  1062. }
  1063. },
  1064. "4": {
  1065. "inputs": {
  1066. "ckpt_name": "model.safetensors"
  1067. },
  1068. "class_type": "CheckpointLoaderSimple",
  1069. "_meta": {
  1070. "title": "Load Checkpoint"
  1071. }
  1072. },
  1073. "5": {
  1074. "inputs": {
  1075. "width": 512,
  1076. "height": 512,
  1077. "batch_size": 1
  1078. },
  1079. "class_type": "EmptyLatentImage",
  1080. "_meta": {
  1081. "title": "Empty Latent Image"
  1082. }
  1083. },
  1084. "6": {
  1085. "inputs": {
  1086. "text": "Prompt",
  1087. "clip": [
  1088. "4",
  1089. 1
  1090. ]
  1091. },
  1092. "class_type": "CLIPTextEncode",
  1093. "_meta": {
  1094. "title": "CLIP Text Encode (Prompt)"
  1095. }
  1096. },
  1097. "7": {
  1098. "inputs": {
  1099. "text": "",
  1100. "clip": [
  1101. "4",
  1102. 1
  1103. ]
  1104. },
  1105. "class_type": "CLIPTextEncode",
  1106. "_meta": {
  1107. "title": "CLIP Text Encode (Prompt)"
  1108. }
  1109. },
  1110. "8": {
  1111. "inputs": {
  1112. "samples": [
  1113. "3",
  1114. 0
  1115. ],
  1116. "vae": [
  1117. "4",
  1118. 2
  1119. ]
  1120. },
  1121. "class_type": "VAEDecode",
  1122. "_meta": {
  1123. "title": "VAE Decode"
  1124. }
  1125. },
  1126. "9": {
  1127. "inputs": {
  1128. "filename_prefix": "ComfyUI",
  1129. "images": [
  1130. "8",
  1131. 0
  1132. ]
  1133. },
  1134. "class_type": "SaveImage",
  1135. "_meta": {
  1136. "title": "Save Image"
  1137. }
  1138. }
  1139. }
  1140. """
  1141. COMFYUI_WORKFLOW = PersistentConfig(
  1142. "COMFYUI_WORKFLOW",
  1143. "image_generation.comfyui.workflow",
  1144. os.getenv("COMFYUI_WORKFLOW", COMFYUI_DEFAULT_WORKFLOW),
  1145. )
  1146. COMFYUI_WORKFLOW_NODES = PersistentConfig(
  1147. "COMFYUI_WORKFLOW",
  1148. "image_generation.comfyui.nodes",
  1149. [],
  1150. )
  1151. IMAGES_OPENAI_API_BASE_URL = PersistentConfig(
  1152. "IMAGES_OPENAI_API_BASE_URL",
  1153. "image_generation.openai.api_base_url",
  1154. os.getenv("IMAGES_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  1155. )
  1156. IMAGES_OPENAI_API_KEY = PersistentConfig(
  1157. "IMAGES_OPENAI_API_KEY",
  1158. "image_generation.openai.api_key",
  1159. os.getenv("IMAGES_OPENAI_API_KEY", OPENAI_API_KEY),
  1160. )
  1161. IMAGE_SIZE = PersistentConfig(
  1162. "IMAGE_SIZE", "image_generation.size", os.getenv("IMAGE_SIZE", "512x512")
  1163. )
  1164. IMAGE_STEPS = PersistentConfig(
  1165. "IMAGE_STEPS", "image_generation.steps", int(os.getenv("IMAGE_STEPS", 50))
  1166. )
  1167. IMAGE_GENERATION_MODEL = PersistentConfig(
  1168. "IMAGE_GENERATION_MODEL",
  1169. "image_generation.model",
  1170. os.getenv("IMAGE_GENERATION_MODEL", ""),
  1171. )
  1172. ####################################
  1173. # Audio
  1174. ####################################
  1175. AUDIO_STT_OPENAI_API_BASE_URL = PersistentConfig(
  1176. "AUDIO_STT_OPENAI_API_BASE_URL",
  1177. "audio.stt.openai.api_base_url",
  1178. os.getenv("AUDIO_STT_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  1179. )
  1180. AUDIO_STT_OPENAI_API_KEY = PersistentConfig(
  1181. "AUDIO_STT_OPENAI_API_KEY",
  1182. "audio.stt.openai.api_key",
  1183. os.getenv("AUDIO_STT_OPENAI_API_KEY", OPENAI_API_KEY),
  1184. )
  1185. AUDIO_STT_ENGINE = PersistentConfig(
  1186. "AUDIO_STT_ENGINE",
  1187. "audio.stt.engine",
  1188. os.getenv("AUDIO_STT_ENGINE", ""),
  1189. )
  1190. AUDIO_STT_MODEL = PersistentConfig(
  1191. "AUDIO_STT_MODEL",
  1192. "audio.stt.model",
  1193. os.getenv("AUDIO_STT_MODEL", "whisper-1"),
  1194. )
  1195. AUDIO_TTS_OPENAI_API_BASE_URL = PersistentConfig(
  1196. "AUDIO_TTS_OPENAI_API_BASE_URL",
  1197. "audio.tts.openai.api_base_url",
  1198. os.getenv("AUDIO_TTS_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  1199. )
  1200. AUDIO_TTS_OPENAI_API_KEY = PersistentConfig(
  1201. "AUDIO_TTS_OPENAI_API_KEY",
  1202. "audio.tts.openai.api_key",
  1203. os.getenv("AUDIO_TTS_OPENAI_API_KEY", OPENAI_API_KEY),
  1204. )
  1205. AUDIO_TTS_API_KEY = PersistentConfig(
  1206. "AUDIO_TTS_API_KEY",
  1207. "audio.tts.api_key",
  1208. os.getenv("AUDIO_TTS_API_KEY", ""),
  1209. )
  1210. AUDIO_TTS_ENGINE = PersistentConfig(
  1211. "AUDIO_TTS_ENGINE",
  1212. "audio.tts.engine",
  1213. os.getenv("AUDIO_TTS_ENGINE", ""),
  1214. )
  1215. AUDIO_TTS_MODEL = PersistentConfig(
  1216. "AUDIO_TTS_MODEL",
  1217. "audio.tts.model",
  1218. os.getenv("AUDIO_TTS_MODEL", "tts-1"), # OpenAI default model
  1219. )
  1220. AUDIO_TTS_VOICE = PersistentConfig(
  1221. "AUDIO_TTS_VOICE",
  1222. "audio.tts.voice",
  1223. os.getenv("AUDIO_TTS_VOICE", "alloy"), # OpenAI default voice
  1224. )
  1225. AUDIO_TTS_SPLIT_ON = PersistentConfig(
  1226. "AUDIO_TTS_SPLIT_ON",
  1227. "audio.tts.split_on",
  1228. os.getenv("AUDIO_TTS_SPLIT_ON", "punctuation"),
  1229. )