config.py 41 KB

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