config.py 104 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422
  1. import json
  2. import logging
  3. import os
  4. import shutil
  5. import base64
  6. import redis
  7. from datetime import datetime
  8. from pathlib import Path
  9. from typing import Generic, Union, Optional, TypeVar
  10. from urllib.parse import urlparse
  11. import requests
  12. from pydantic import BaseModel
  13. from sqlalchemy import JSON, Column, DateTime, Integer, func
  14. from authlib.integrations.starlette_client import OAuth
  15. from open_webui.env import (
  16. DATA_DIR,
  17. DATABASE_URL,
  18. ENV,
  19. REDIS_URL,
  20. REDIS_KEY_PREFIX,
  21. REDIS_SENTINEL_HOSTS,
  22. REDIS_SENTINEL_PORT,
  23. FRONTEND_BUILD_DIR,
  24. OFFLINE_MODE,
  25. OPEN_WEBUI_DIR,
  26. WEBUI_AUTH,
  27. WEBUI_FAVICON_URL,
  28. WEBUI_NAME,
  29. log,
  30. )
  31. from open_webui.internal.db import Base, get_db
  32. from open_webui.utils.redis import get_redis_connection
  33. class EndpointFilter(logging.Filter):
  34. def filter(self, record: logging.LogRecord) -> bool:
  35. return record.getMessage().find("/health") == -1
  36. # Filter out /endpoint
  37. logging.getLogger("uvicorn.access").addFilter(EndpointFilter())
  38. ####################################
  39. # Config helpers
  40. ####################################
  41. # Function to run the alembic migrations
  42. def run_migrations():
  43. log.info("Running migrations")
  44. try:
  45. from alembic import command
  46. from alembic.config import Config
  47. alembic_cfg = Config(OPEN_WEBUI_DIR / "alembic.ini")
  48. # Set the script location dynamically
  49. migrations_path = OPEN_WEBUI_DIR / "migrations"
  50. alembic_cfg.set_main_option("script_location", str(migrations_path))
  51. command.upgrade(alembic_cfg, "head")
  52. except Exception as e:
  53. log.exception(f"Error running migrations: {e}")
  54. run_migrations()
  55. class Config(Base):
  56. __tablename__ = "config"
  57. id = Column(Integer, primary_key=True)
  58. data = Column(JSON, nullable=False)
  59. version = Column(Integer, nullable=False, default=0)
  60. created_at = Column(DateTime, nullable=False, server_default=func.now())
  61. updated_at = Column(DateTime, nullable=True, onupdate=func.now())
  62. def load_json_config():
  63. with open(f"{DATA_DIR}/config.json", "r") as file:
  64. return json.load(file)
  65. def save_to_db(data):
  66. with get_db() as db:
  67. existing_config = db.query(Config).first()
  68. if not existing_config:
  69. new_config = Config(data=data, version=0)
  70. db.add(new_config)
  71. else:
  72. existing_config.data = data
  73. existing_config.updated_at = datetime.now()
  74. db.add(existing_config)
  75. db.commit()
  76. def reset_config():
  77. with get_db() as db:
  78. db.query(Config).delete()
  79. db.commit()
  80. # When initializing, check if config.json exists and migrate it to the database
  81. if os.path.exists(f"{DATA_DIR}/config.json"):
  82. data = load_json_config()
  83. save_to_db(data)
  84. os.rename(f"{DATA_DIR}/config.json", f"{DATA_DIR}/old_config.json")
  85. DEFAULT_CONFIG = {
  86. "version": 0,
  87. "ui": {},
  88. }
  89. def get_config():
  90. with get_db() as db:
  91. config_entry = db.query(Config).order_by(Config.id.desc()).first()
  92. return config_entry.data if config_entry else DEFAULT_CONFIG
  93. CONFIG_DATA = get_config()
  94. def get_config_value(config_path: str):
  95. path_parts = config_path.split(".")
  96. cur_config = CONFIG_DATA
  97. for key in path_parts:
  98. if key in cur_config:
  99. cur_config = cur_config[key]
  100. else:
  101. return None
  102. return cur_config
  103. PERSISTENT_CONFIG_REGISTRY = []
  104. def save_config(config):
  105. global CONFIG_DATA
  106. global PERSISTENT_CONFIG_REGISTRY
  107. try:
  108. save_to_db(config)
  109. CONFIG_DATA = config
  110. # Trigger updates on all registered PersistentConfig entries
  111. for config_item in PERSISTENT_CONFIG_REGISTRY:
  112. config_item.update()
  113. except Exception as e:
  114. log.exception(e)
  115. return False
  116. return True
  117. T = TypeVar("T")
  118. ENABLE_PERSISTENT_CONFIG = (
  119. os.environ.get("ENABLE_PERSISTENT_CONFIG", "True").lower() == "true"
  120. )
  121. class PersistentConfig(Generic[T]):
  122. def __init__(self, env_name: str, config_path: str, env_value: T):
  123. self.env_name = env_name
  124. self.config_path = config_path
  125. self.env_value = env_value
  126. self.config_value = get_config_value(config_path)
  127. if self.config_value is not None and ENABLE_PERSISTENT_CONFIG:
  128. if (
  129. self.config_path.startswith("oauth.")
  130. and not ENABLE_OAUTH_PERSISTENT_CONFIG
  131. ):
  132. log.info(
  133. f"Skipping loading of '{env_name}' as OAuth persistent config is disabled"
  134. )
  135. self.value = env_value
  136. else:
  137. log.info(f"'{env_name}' loaded from the latest database entry")
  138. self.value = self.config_value
  139. else:
  140. self.value = env_value
  141. PERSISTENT_CONFIG_REGISTRY.append(self)
  142. def __str__(self):
  143. return str(self.value)
  144. @property
  145. def __dict__(self):
  146. raise TypeError(
  147. "PersistentConfig object cannot be converted to dict, use config_get or .value instead."
  148. )
  149. def __getattribute__(self, item):
  150. if item == "__dict__":
  151. raise TypeError(
  152. "PersistentConfig object cannot be converted to dict, use config_get or .value instead."
  153. )
  154. return super().__getattribute__(item)
  155. def update(self):
  156. new_value = get_config_value(self.config_path)
  157. if new_value is not None:
  158. self.value = new_value
  159. log.info(f"Updated {self.env_name} to new value {self.value}")
  160. def save(self):
  161. log.info(f"Saving '{self.env_name}' to the database")
  162. path_parts = self.config_path.split(".")
  163. sub_config = CONFIG_DATA
  164. for key in path_parts[:-1]:
  165. if key not in sub_config:
  166. sub_config[key] = {}
  167. sub_config = sub_config[key]
  168. sub_config[path_parts[-1]] = self.value
  169. save_to_db(CONFIG_DATA)
  170. self.config_value = self.value
  171. class AppConfig:
  172. _state: dict[str, PersistentConfig]
  173. _redis: Union[redis.Redis, redis.cluster.RedisCluster] = None
  174. _redis_key_prefix: str
  175. def __init__(
  176. self,
  177. redis_url: Optional[str] = None,
  178. redis_sentinels: Optional[list] = [],
  179. redis_cluster: Optional[bool] = False,
  180. redis_key_prefix: str = "open-webui",
  181. ):
  182. super().__setattr__("_state", {})
  183. super().__setattr__("_redis_key_prefix", redis_key_prefix)
  184. if redis_url:
  185. super().__setattr__(
  186. "_redis",
  187. get_redis_connection(
  188. redis_url,
  189. redis_sentinels,
  190. redis_cluster,
  191. decode_responses=True,
  192. ),
  193. )
  194. def __setattr__(self, key, value):
  195. if isinstance(value, PersistentConfig):
  196. self._state[key] = value
  197. else:
  198. self._state[key].value = value
  199. self._state[key].save()
  200. if self._redis:
  201. redis_key = f"{self._redis_key_prefix}:config:{key}"
  202. self._redis.set(redis_key, json.dumps(self._state[key].value))
  203. def __getattr__(self, key):
  204. if key not in self._state:
  205. raise AttributeError(f"Config key '{key}' not found")
  206. # If Redis is available, check for an updated value
  207. if self._redis:
  208. redis_key = f"{self._redis_key_prefix}:config:{key}"
  209. redis_value = self._redis.get(redis_key)
  210. if redis_value is not None:
  211. try:
  212. decoded_value = json.loads(redis_value)
  213. # Update the in-memory value if different
  214. if self._state[key].value != decoded_value:
  215. self._state[key].value = decoded_value
  216. log.info(f"Updated {key} from Redis: {decoded_value}")
  217. except json.JSONDecodeError:
  218. log.error(f"Invalid JSON format in Redis for {key}: {redis_value}")
  219. return self._state[key].value
  220. ####################################
  221. # WEBUI_AUTH (Required for security)
  222. ####################################
  223. ENABLE_API_KEY = PersistentConfig(
  224. "ENABLE_API_KEY",
  225. "auth.api_key.enable",
  226. os.environ.get("ENABLE_API_KEY", "True").lower() == "true",
  227. )
  228. ENABLE_API_KEY_ENDPOINT_RESTRICTIONS = PersistentConfig(
  229. "ENABLE_API_KEY_ENDPOINT_RESTRICTIONS",
  230. "auth.api_key.endpoint_restrictions",
  231. os.environ.get("ENABLE_API_KEY_ENDPOINT_RESTRICTIONS", "False").lower() == "true",
  232. )
  233. API_KEY_ALLOWED_ENDPOINTS = PersistentConfig(
  234. "API_KEY_ALLOWED_ENDPOINTS",
  235. "auth.api_key.allowed_endpoints",
  236. os.environ.get("API_KEY_ALLOWED_ENDPOINTS", ""),
  237. )
  238. JWT_EXPIRES_IN = PersistentConfig(
  239. "JWT_EXPIRES_IN", "auth.jwt_expiry", os.environ.get("JWT_EXPIRES_IN", "-1")
  240. )
  241. ####################################
  242. # OAuth config
  243. ####################################
  244. ENABLE_OAUTH_PERSISTENT_CONFIG = (
  245. os.environ.get("ENABLE_OAUTH_PERSISTENT_CONFIG", "True").lower() == "true"
  246. )
  247. ENABLE_OAUTH_SIGNUP = PersistentConfig(
  248. "ENABLE_OAUTH_SIGNUP",
  249. "oauth.enable_signup",
  250. os.environ.get("ENABLE_OAUTH_SIGNUP", "False").lower() == "true",
  251. )
  252. OAUTH_MERGE_ACCOUNTS_BY_EMAIL = PersistentConfig(
  253. "OAUTH_MERGE_ACCOUNTS_BY_EMAIL",
  254. "oauth.merge_accounts_by_email",
  255. os.environ.get("OAUTH_MERGE_ACCOUNTS_BY_EMAIL", "False").lower() == "true",
  256. )
  257. OAUTH_PROVIDERS = {}
  258. GOOGLE_CLIENT_ID = PersistentConfig(
  259. "GOOGLE_CLIENT_ID",
  260. "oauth.google.client_id",
  261. os.environ.get("GOOGLE_CLIENT_ID", ""),
  262. )
  263. GOOGLE_CLIENT_SECRET = PersistentConfig(
  264. "GOOGLE_CLIENT_SECRET",
  265. "oauth.google.client_secret",
  266. os.environ.get("GOOGLE_CLIENT_SECRET", ""),
  267. )
  268. GOOGLE_OAUTH_SCOPE = PersistentConfig(
  269. "GOOGLE_OAUTH_SCOPE",
  270. "oauth.google.scope",
  271. os.environ.get("GOOGLE_OAUTH_SCOPE", "openid email profile"),
  272. )
  273. GOOGLE_REDIRECT_URI = PersistentConfig(
  274. "GOOGLE_REDIRECT_URI",
  275. "oauth.google.redirect_uri",
  276. os.environ.get("GOOGLE_REDIRECT_URI", ""),
  277. )
  278. MICROSOFT_CLIENT_ID = PersistentConfig(
  279. "MICROSOFT_CLIENT_ID",
  280. "oauth.microsoft.client_id",
  281. os.environ.get("MICROSOFT_CLIENT_ID", ""),
  282. )
  283. MICROSOFT_CLIENT_SECRET = PersistentConfig(
  284. "MICROSOFT_CLIENT_SECRET",
  285. "oauth.microsoft.client_secret",
  286. os.environ.get("MICROSOFT_CLIENT_SECRET", ""),
  287. )
  288. MICROSOFT_CLIENT_TENANT_ID = PersistentConfig(
  289. "MICROSOFT_CLIENT_TENANT_ID",
  290. "oauth.microsoft.tenant_id",
  291. os.environ.get("MICROSOFT_CLIENT_TENANT_ID", ""),
  292. )
  293. MICROSOFT_CLIENT_LOGIN_BASE_URL = PersistentConfig(
  294. "MICROSOFT_CLIENT_LOGIN_BASE_URL",
  295. "oauth.microsoft.login_base_url",
  296. os.environ.get(
  297. "MICROSOFT_CLIENT_LOGIN_BASE_URL", "https://login.microsoftonline.com"
  298. ),
  299. )
  300. MICROSOFT_CLIENT_PICTURE_URL = PersistentConfig(
  301. "MICROSOFT_CLIENT_PICTURE_URL",
  302. "oauth.microsoft.picture_url",
  303. os.environ.get(
  304. "MICROSOFT_CLIENT_PICTURE_URL",
  305. "https://graph.microsoft.com/v1.0/me/photo/$value",
  306. ),
  307. )
  308. MICROSOFT_OAUTH_SCOPE = PersistentConfig(
  309. "MICROSOFT_OAUTH_SCOPE",
  310. "oauth.microsoft.scope",
  311. os.environ.get("MICROSOFT_OAUTH_SCOPE", "openid email profile"),
  312. )
  313. MICROSOFT_REDIRECT_URI = PersistentConfig(
  314. "MICROSOFT_REDIRECT_URI",
  315. "oauth.microsoft.redirect_uri",
  316. os.environ.get("MICROSOFT_REDIRECT_URI", ""),
  317. )
  318. GITHUB_CLIENT_ID = PersistentConfig(
  319. "GITHUB_CLIENT_ID",
  320. "oauth.github.client_id",
  321. os.environ.get("GITHUB_CLIENT_ID", ""),
  322. )
  323. GITHUB_CLIENT_SECRET = PersistentConfig(
  324. "GITHUB_CLIENT_SECRET",
  325. "oauth.github.client_secret",
  326. os.environ.get("GITHUB_CLIENT_SECRET", ""),
  327. )
  328. GITHUB_CLIENT_SCOPE = PersistentConfig(
  329. "GITHUB_CLIENT_SCOPE",
  330. "oauth.github.scope",
  331. os.environ.get("GITHUB_CLIENT_SCOPE", "user:email"),
  332. )
  333. GITHUB_CLIENT_REDIRECT_URI = PersistentConfig(
  334. "GITHUB_CLIENT_REDIRECT_URI",
  335. "oauth.github.redirect_uri",
  336. os.environ.get("GITHUB_CLIENT_REDIRECT_URI", ""),
  337. )
  338. OAUTH_CLIENT_ID = PersistentConfig(
  339. "OAUTH_CLIENT_ID",
  340. "oauth.oidc.client_id",
  341. os.environ.get("OAUTH_CLIENT_ID", ""),
  342. )
  343. OAUTH_CLIENT_SECRET = PersistentConfig(
  344. "OAUTH_CLIENT_SECRET",
  345. "oauth.oidc.client_secret",
  346. os.environ.get("OAUTH_CLIENT_SECRET", ""),
  347. )
  348. OPENID_PROVIDER_URL = PersistentConfig(
  349. "OPENID_PROVIDER_URL",
  350. "oauth.oidc.provider_url",
  351. os.environ.get("OPENID_PROVIDER_URL", ""),
  352. )
  353. OPENID_REDIRECT_URI = PersistentConfig(
  354. "OPENID_REDIRECT_URI",
  355. "oauth.oidc.redirect_uri",
  356. os.environ.get("OPENID_REDIRECT_URI", ""),
  357. )
  358. OAUTH_SCOPES = PersistentConfig(
  359. "OAUTH_SCOPES",
  360. "oauth.oidc.scopes",
  361. os.environ.get("OAUTH_SCOPES", "openid email profile"),
  362. )
  363. OAUTH_TIMEOUT = PersistentConfig(
  364. "OAUTH_TIMEOUT",
  365. "oauth.oidc.oauth_timeout",
  366. os.environ.get("OAUTH_TIMEOUT", ""),
  367. )
  368. OAUTH_TOKEN_ENDPOINT_AUTH_METHOD = PersistentConfig(
  369. "OAUTH_TOKEN_ENDPOINT_AUTH_METHOD",
  370. "oauth.oidc.token_endpoint_auth_method",
  371. os.environ.get("OAUTH_TOKEN_ENDPOINT_AUTH_METHOD", None),
  372. )
  373. OAUTH_CODE_CHALLENGE_METHOD = PersistentConfig(
  374. "OAUTH_CODE_CHALLENGE_METHOD",
  375. "oauth.oidc.code_challenge_method",
  376. os.environ.get("OAUTH_CODE_CHALLENGE_METHOD", None),
  377. )
  378. OAUTH_PROVIDER_NAME = PersistentConfig(
  379. "OAUTH_PROVIDER_NAME",
  380. "oauth.oidc.provider_name",
  381. os.environ.get("OAUTH_PROVIDER_NAME", "SSO"),
  382. )
  383. OAUTH_SUB_CLAIM = PersistentConfig(
  384. "OAUTH_SUB_CLAIM",
  385. "oauth.oidc.sub_claim",
  386. os.environ.get("OAUTH_SUB_CLAIM", None),
  387. )
  388. OAUTH_USERNAME_CLAIM = PersistentConfig(
  389. "OAUTH_USERNAME_CLAIM",
  390. "oauth.oidc.username_claim",
  391. os.environ.get("OAUTH_USERNAME_CLAIM", "name"),
  392. )
  393. OAUTH_PICTURE_CLAIM = PersistentConfig(
  394. "OAUTH_PICTURE_CLAIM",
  395. "oauth.oidc.avatar_claim",
  396. os.environ.get("OAUTH_PICTURE_CLAIM", "picture"),
  397. )
  398. OAUTH_EMAIL_CLAIM = PersistentConfig(
  399. "OAUTH_EMAIL_CLAIM",
  400. "oauth.oidc.email_claim",
  401. os.environ.get("OAUTH_EMAIL_CLAIM", "email"),
  402. )
  403. OAUTH_GROUPS_CLAIM = PersistentConfig(
  404. "OAUTH_GROUPS_CLAIM",
  405. "oauth.oidc.group_claim",
  406. os.environ.get("OAUTH_GROUPS_CLAIM", os.environ.get("OAUTH_GROUP_CLAIM", "groups")),
  407. )
  408. ENABLE_OAUTH_ROLE_MANAGEMENT = PersistentConfig(
  409. "ENABLE_OAUTH_ROLE_MANAGEMENT",
  410. "oauth.enable_role_mapping",
  411. os.environ.get("ENABLE_OAUTH_ROLE_MANAGEMENT", "False").lower() == "true",
  412. )
  413. ENABLE_OAUTH_GROUP_MANAGEMENT = PersistentConfig(
  414. "ENABLE_OAUTH_GROUP_MANAGEMENT",
  415. "oauth.enable_group_mapping",
  416. os.environ.get("ENABLE_OAUTH_GROUP_MANAGEMENT", "False").lower() == "true",
  417. )
  418. ENABLE_OAUTH_GROUP_CREATION = PersistentConfig(
  419. "ENABLE_OAUTH_GROUP_CREATION",
  420. "oauth.enable_group_creation",
  421. os.environ.get("ENABLE_OAUTH_GROUP_CREATION", "False").lower() == "true",
  422. )
  423. OAUTH_BLOCKED_GROUPS = PersistentConfig(
  424. "OAUTH_BLOCKED_GROUPS",
  425. "oauth.blocked_groups",
  426. os.environ.get("OAUTH_BLOCKED_GROUPS", "[]"),
  427. )
  428. OAUTH_ROLES_CLAIM = PersistentConfig(
  429. "OAUTH_ROLES_CLAIM",
  430. "oauth.roles_claim",
  431. os.environ.get("OAUTH_ROLES_CLAIM", "roles"),
  432. )
  433. OAUTH_ALLOWED_ROLES = PersistentConfig(
  434. "OAUTH_ALLOWED_ROLES",
  435. "oauth.allowed_roles",
  436. [
  437. role.strip()
  438. for role in os.environ.get("OAUTH_ALLOWED_ROLES", "user,admin").split(",")
  439. ],
  440. )
  441. OAUTH_ADMIN_ROLES = PersistentConfig(
  442. "OAUTH_ADMIN_ROLES",
  443. "oauth.admin_roles",
  444. [role.strip() for role in os.environ.get("OAUTH_ADMIN_ROLES", "admin").split(",")],
  445. )
  446. OAUTH_ALLOWED_DOMAINS = PersistentConfig(
  447. "OAUTH_ALLOWED_DOMAINS",
  448. "oauth.allowed_domains",
  449. [
  450. domain.strip()
  451. for domain in os.environ.get("OAUTH_ALLOWED_DOMAINS", "*").split(",")
  452. ],
  453. )
  454. OAUTH_UPDATE_PICTURE_ON_LOGIN = PersistentConfig(
  455. "OAUTH_UPDATE_PICTURE_ON_LOGIN",
  456. "oauth.update_picture_on_login",
  457. os.environ.get("OAUTH_UPDATE_PICTURE_ON_LOGIN", "False").lower() == "true",
  458. )
  459. def load_oauth_providers():
  460. OAUTH_PROVIDERS.clear()
  461. if GOOGLE_CLIENT_ID.value and GOOGLE_CLIENT_SECRET.value:
  462. def google_oauth_register(client: OAuth):
  463. client.register(
  464. name="google",
  465. client_id=GOOGLE_CLIENT_ID.value,
  466. client_secret=GOOGLE_CLIENT_SECRET.value,
  467. server_metadata_url="https://accounts.google.com/.well-known/openid-configuration",
  468. client_kwargs={
  469. "scope": GOOGLE_OAUTH_SCOPE.value,
  470. **(
  471. {"timeout": int(OAUTH_TIMEOUT.value)}
  472. if OAUTH_TIMEOUT.value
  473. else {}
  474. ),
  475. },
  476. redirect_uri=GOOGLE_REDIRECT_URI.value,
  477. )
  478. OAUTH_PROVIDERS["google"] = {
  479. "redirect_uri": GOOGLE_REDIRECT_URI.value,
  480. "register": google_oauth_register,
  481. }
  482. if (
  483. MICROSOFT_CLIENT_ID.value
  484. and MICROSOFT_CLIENT_SECRET.value
  485. and MICROSOFT_CLIENT_TENANT_ID.value
  486. ):
  487. def microsoft_oauth_register(client: OAuth):
  488. client.register(
  489. name="microsoft",
  490. client_id=MICROSOFT_CLIENT_ID.value,
  491. client_secret=MICROSOFT_CLIENT_SECRET.value,
  492. server_metadata_url=f"{MICROSOFT_CLIENT_LOGIN_BASE_URL.value}/{MICROSOFT_CLIENT_TENANT_ID.value}/v2.0/.well-known/openid-configuration?appid={MICROSOFT_CLIENT_ID.value}",
  493. client_kwargs={
  494. "scope": MICROSOFT_OAUTH_SCOPE.value,
  495. **(
  496. {"timeout": int(OAUTH_TIMEOUT.value)}
  497. if OAUTH_TIMEOUT.value
  498. else {}
  499. ),
  500. },
  501. redirect_uri=MICROSOFT_REDIRECT_URI.value,
  502. )
  503. OAUTH_PROVIDERS["microsoft"] = {
  504. "redirect_uri": MICROSOFT_REDIRECT_URI.value,
  505. "picture_url": MICROSOFT_CLIENT_PICTURE_URL.value,
  506. "register": microsoft_oauth_register,
  507. }
  508. if GITHUB_CLIENT_ID.value and GITHUB_CLIENT_SECRET.value:
  509. def github_oauth_register(client: OAuth):
  510. client.register(
  511. name="github",
  512. client_id=GITHUB_CLIENT_ID.value,
  513. client_secret=GITHUB_CLIENT_SECRET.value,
  514. access_token_url="https://github.com/login/oauth/access_token",
  515. authorize_url="https://github.com/login/oauth/authorize",
  516. api_base_url="https://api.github.com",
  517. userinfo_endpoint="https://api.github.com/user",
  518. client_kwargs={
  519. "scope": GITHUB_CLIENT_SCOPE.value,
  520. **(
  521. {"timeout": int(OAUTH_TIMEOUT.value)}
  522. if OAUTH_TIMEOUT.value
  523. else {}
  524. ),
  525. },
  526. redirect_uri=GITHUB_CLIENT_REDIRECT_URI.value,
  527. )
  528. OAUTH_PROVIDERS["github"] = {
  529. "redirect_uri": GITHUB_CLIENT_REDIRECT_URI.value,
  530. "register": github_oauth_register,
  531. "sub_claim": "id",
  532. }
  533. if (
  534. OAUTH_CLIENT_ID.value
  535. and OAUTH_CLIENT_SECRET.value
  536. and OPENID_PROVIDER_URL.value
  537. ):
  538. def oidc_oauth_register(client: OAuth):
  539. client_kwargs = {
  540. "scope": OAUTH_SCOPES.value,
  541. **(
  542. {
  543. "token_endpoint_auth_method": OAUTH_TOKEN_ENDPOINT_AUTH_METHOD.value
  544. }
  545. if OAUTH_TOKEN_ENDPOINT_AUTH_METHOD.value
  546. else {}
  547. ),
  548. **(
  549. {"timeout": int(OAUTH_TIMEOUT.value)} if OAUTH_TIMEOUT.value else {}
  550. ),
  551. }
  552. if (
  553. OAUTH_CODE_CHALLENGE_METHOD.value
  554. and OAUTH_CODE_CHALLENGE_METHOD.value == "S256"
  555. ):
  556. client_kwargs["code_challenge_method"] = "S256"
  557. elif OAUTH_CODE_CHALLENGE_METHOD.value:
  558. raise Exception(
  559. 'Code challenge methods other than "%s" not supported. Given: "%s"'
  560. % ("S256", OAUTH_CODE_CHALLENGE_METHOD.value)
  561. )
  562. client.register(
  563. name="oidc",
  564. client_id=OAUTH_CLIENT_ID.value,
  565. client_secret=OAUTH_CLIENT_SECRET.value,
  566. server_metadata_url=OPENID_PROVIDER_URL.value,
  567. client_kwargs=client_kwargs,
  568. redirect_uri=OPENID_REDIRECT_URI.value,
  569. )
  570. OAUTH_PROVIDERS["oidc"] = {
  571. "name": OAUTH_PROVIDER_NAME.value,
  572. "redirect_uri": OPENID_REDIRECT_URI.value,
  573. "register": oidc_oauth_register,
  574. }
  575. configured_providers = []
  576. if GOOGLE_CLIENT_ID.value:
  577. configured_providers.append("Google")
  578. if MICROSOFT_CLIENT_ID.value:
  579. configured_providers.append("Microsoft")
  580. if GITHUB_CLIENT_ID.value:
  581. configured_providers.append("GitHub")
  582. if configured_providers and not OPENID_PROVIDER_URL.value:
  583. provider_list = ", ".join(configured_providers)
  584. log.warning(
  585. f"⚠️ OAuth providers configured ({provider_list}) but OPENID_PROVIDER_URL not set - logout will not work!"
  586. )
  587. log.warning(
  588. f"Set OPENID_PROVIDER_URL to your OAuth provider's OpenID Connect discovery endpoint to fix logout functionality."
  589. )
  590. load_oauth_providers()
  591. ####################################
  592. # Static DIR
  593. ####################################
  594. STATIC_DIR = Path(os.getenv("STATIC_DIR", OPEN_WEBUI_DIR / "static")).resolve()
  595. try:
  596. if STATIC_DIR.exists():
  597. for item in STATIC_DIR.iterdir():
  598. if item.is_file() or item.is_symlink():
  599. try:
  600. item.unlink()
  601. except Exception as e:
  602. pass
  603. except Exception as e:
  604. pass
  605. for file_path in (FRONTEND_BUILD_DIR / "static").glob("**/*"):
  606. if file_path.is_file():
  607. target_path = STATIC_DIR / file_path.relative_to(
  608. (FRONTEND_BUILD_DIR / "static")
  609. )
  610. target_path.parent.mkdir(parents=True, exist_ok=True)
  611. try:
  612. shutil.copyfile(file_path, target_path)
  613. except Exception as e:
  614. logging.error(f"An error occurred: {e}")
  615. frontend_favicon = FRONTEND_BUILD_DIR / "static" / "favicon.png"
  616. if frontend_favicon.exists():
  617. try:
  618. shutil.copyfile(frontend_favicon, STATIC_DIR / "favicon.png")
  619. except Exception as e:
  620. logging.error(f"An error occurred: {e}")
  621. frontend_splash = FRONTEND_BUILD_DIR / "static" / "splash.png"
  622. if frontend_splash.exists():
  623. try:
  624. shutil.copyfile(frontend_splash, STATIC_DIR / "splash.png")
  625. except Exception as e:
  626. logging.error(f"An error occurred: {e}")
  627. frontend_loader = FRONTEND_BUILD_DIR / "static" / "loader.js"
  628. if frontend_loader.exists():
  629. try:
  630. shutil.copyfile(frontend_loader, STATIC_DIR / "loader.js")
  631. except Exception as e:
  632. logging.error(f"An error occurred: {e}")
  633. ####################################
  634. # CUSTOM_NAME (Legacy)
  635. ####################################
  636. CUSTOM_NAME = os.environ.get("CUSTOM_NAME", "")
  637. if CUSTOM_NAME:
  638. try:
  639. r = requests.get(f"https://api.openwebui.com/api/v1/custom/{CUSTOM_NAME}")
  640. data = r.json()
  641. if r.ok:
  642. if "logo" in data:
  643. WEBUI_FAVICON_URL = url = (
  644. f"https://api.openwebui.com{data['logo']}"
  645. if data["logo"][0] == "/"
  646. else data["logo"]
  647. )
  648. r = requests.get(url, stream=True)
  649. if r.status_code == 200:
  650. with open(f"{STATIC_DIR}/favicon.png", "wb") as f:
  651. r.raw.decode_content = True
  652. shutil.copyfileobj(r.raw, f)
  653. if "splash" in data:
  654. url = (
  655. f"https://api.openwebui.com{data['splash']}"
  656. if data["splash"][0] == "/"
  657. else data["splash"]
  658. )
  659. r = requests.get(url, stream=True)
  660. if r.status_code == 200:
  661. with open(f"{STATIC_DIR}/splash.png", "wb") as f:
  662. r.raw.decode_content = True
  663. shutil.copyfileobj(r.raw, f)
  664. WEBUI_NAME = data["name"]
  665. except Exception as e:
  666. log.exception(e)
  667. pass
  668. ####################################
  669. # STORAGE PROVIDER
  670. ####################################
  671. STORAGE_PROVIDER = os.environ.get("STORAGE_PROVIDER", "local") # defaults to local, s3
  672. S3_ACCESS_KEY_ID = os.environ.get("S3_ACCESS_KEY_ID", None)
  673. S3_SECRET_ACCESS_KEY = os.environ.get("S3_SECRET_ACCESS_KEY", None)
  674. S3_REGION_NAME = os.environ.get("S3_REGION_NAME", None)
  675. S3_BUCKET_NAME = os.environ.get("S3_BUCKET_NAME", None)
  676. S3_KEY_PREFIX = os.environ.get("S3_KEY_PREFIX", None)
  677. S3_ENDPOINT_URL = os.environ.get("S3_ENDPOINT_URL", None)
  678. S3_USE_ACCELERATE_ENDPOINT = (
  679. os.environ.get("S3_USE_ACCELERATE_ENDPOINT", "false").lower() == "true"
  680. )
  681. S3_ADDRESSING_STYLE = os.environ.get("S3_ADDRESSING_STYLE", None)
  682. S3_ENABLE_TAGGING = os.getenv("S3_ENABLE_TAGGING", "false").lower() == "true"
  683. GCS_BUCKET_NAME = os.environ.get("GCS_BUCKET_NAME", None)
  684. GOOGLE_APPLICATION_CREDENTIALS_JSON = os.environ.get(
  685. "GOOGLE_APPLICATION_CREDENTIALS_JSON", None
  686. )
  687. AZURE_STORAGE_ENDPOINT = os.environ.get("AZURE_STORAGE_ENDPOINT", None)
  688. AZURE_STORAGE_CONTAINER_NAME = os.environ.get("AZURE_STORAGE_CONTAINER_NAME", None)
  689. AZURE_STORAGE_KEY = os.environ.get("AZURE_STORAGE_KEY", None)
  690. ####################################
  691. # File Upload DIR
  692. ####################################
  693. UPLOAD_DIR = DATA_DIR / "uploads"
  694. UPLOAD_DIR.mkdir(parents=True, exist_ok=True)
  695. ####################################
  696. # Cache DIR
  697. ####################################
  698. CACHE_DIR = DATA_DIR / "cache"
  699. CACHE_DIR.mkdir(parents=True, exist_ok=True)
  700. ####################################
  701. # DIRECT CONNECTIONS
  702. ####################################
  703. ENABLE_DIRECT_CONNECTIONS = PersistentConfig(
  704. "ENABLE_DIRECT_CONNECTIONS",
  705. "direct.enable",
  706. os.environ.get("ENABLE_DIRECT_CONNECTIONS", "False").lower() == "true",
  707. )
  708. ####################################
  709. # OLLAMA_BASE_URL
  710. ####################################
  711. ENABLE_OLLAMA_API = PersistentConfig(
  712. "ENABLE_OLLAMA_API",
  713. "ollama.enable",
  714. os.environ.get("ENABLE_OLLAMA_API", "True").lower() == "true",
  715. )
  716. OLLAMA_API_BASE_URL = os.environ.get(
  717. "OLLAMA_API_BASE_URL", "http://localhost:11434/api"
  718. )
  719. OLLAMA_BASE_URL = os.environ.get("OLLAMA_BASE_URL", "")
  720. if OLLAMA_BASE_URL:
  721. # Remove trailing slash
  722. OLLAMA_BASE_URL = (
  723. OLLAMA_BASE_URL[:-1] if OLLAMA_BASE_URL.endswith("/") else OLLAMA_BASE_URL
  724. )
  725. K8S_FLAG = os.environ.get("K8S_FLAG", "")
  726. USE_OLLAMA_DOCKER = os.environ.get("USE_OLLAMA_DOCKER", "false")
  727. if OLLAMA_BASE_URL == "" and OLLAMA_API_BASE_URL != "":
  728. OLLAMA_BASE_URL = (
  729. OLLAMA_API_BASE_URL[:-4]
  730. if OLLAMA_API_BASE_URL.endswith("/api")
  731. else OLLAMA_API_BASE_URL
  732. )
  733. if ENV == "prod":
  734. if OLLAMA_BASE_URL == "/ollama" and not K8S_FLAG:
  735. if USE_OLLAMA_DOCKER.lower() == "true":
  736. # if you use all-in-one docker container (Open WebUI + Ollama)
  737. # with the docker build arg USE_OLLAMA=true (--build-arg="USE_OLLAMA=true") this only works with http://localhost:11434
  738. OLLAMA_BASE_URL = "http://localhost:11434"
  739. else:
  740. OLLAMA_BASE_URL = "http://host.docker.internal:11434"
  741. elif K8S_FLAG:
  742. OLLAMA_BASE_URL = "http://ollama-service.open-webui.svc.cluster.local:11434"
  743. OLLAMA_BASE_URLS = os.environ.get("OLLAMA_BASE_URLS", "")
  744. OLLAMA_BASE_URLS = OLLAMA_BASE_URLS if OLLAMA_BASE_URLS != "" else OLLAMA_BASE_URL
  745. OLLAMA_BASE_URLS = [url.strip() for url in OLLAMA_BASE_URLS.split(";")]
  746. OLLAMA_BASE_URLS = PersistentConfig(
  747. "OLLAMA_BASE_URLS", "ollama.base_urls", OLLAMA_BASE_URLS
  748. )
  749. OLLAMA_API_CONFIGS = PersistentConfig(
  750. "OLLAMA_API_CONFIGS",
  751. "ollama.api_configs",
  752. {},
  753. )
  754. ####################################
  755. # OPENAI_API
  756. ####################################
  757. ENABLE_OPENAI_API = PersistentConfig(
  758. "ENABLE_OPENAI_API",
  759. "openai.enable",
  760. os.environ.get("ENABLE_OPENAI_API", "True").lower() == "true",
  761. )
  762. OPENAI_API_KEY = os.environ.get("OPENAI_API_KEY", "")
  763. OPENAI_API_BASE_URL = os.environ.get("OPENAI_API_BASE_URL", "")
  764. GEMINI_API_KEY = os.environ.get("GEMINI_API_KEY", "")
  765. GEMINI_API_BASE_URL = os.environ.get("GEMINI_API_BASE_URL", "")
  766. if OPENAI_API_BASE_URL == "":
  767. OPENAI_API_BASE_URL = "https://api.openai.com/v1"
  768. else:
  769. if OPENAI_API_BASE_URL.endswith("/"):
  770. OPENAI_API_BASE_URL = OPENAI_API_BASE_URL[:-1]
  771. OPENAI_API_KEYS = os.environ.get("OPENAI_API_KEYS", "")
  772. OPENAI_API_KEYS = OPENAI_API_KEYS if OPENAI_API_KEYS != "" else OPENAI_API_KEY
  773. OPENAI_API_KEYS = [url.strip() for url in OPENAI_API_KEYS.split(";")]
  774. OPENAI_API_KEYS = PersistentConfig(
  775. "OPENAI_API_KEYS", "openai.api_keys", OPENAI_API_KEYS
  776. )
  777. OPENAI_API_BASE_URLS = os.environ.get("OPENAI_API_BASE_URLS", "")
  778. OPENAI_API_BASE_URLS = (
  779. OPENAI_API_BASE_URLS if OPENAI_API_BASE_URLS != "" else OPENAI_API_BASE_URL
  780. )
  781. OPENAI_API_BASE_URLS = [
  782. url.strip() if url != "" else "https://api.openai.com/v1"
  783. for url in OPENAI_API_BASE_URLS.split(";")
  784. ]
  785. OPENAI_API_BASE_URLS = PersistentConfig(
  786. "OPENAI_API_BASE_URLS", "openai.api_base_urls", OPENAI_API_BASE_URLS
  787. )
  788. OPENAI_API_CONFIGS = PersistentConfig(
  789. "OPENAI_API_CONFIGS",
  790. "openai.api_configs",
  791. {},
  792. )
  793. # Get the actual OpenAI API key based on the base URL
  794. OPENAI_API_KEY = ""
  795. try:
  796. OPENAI_API_KEY = OPENAI_API_KEYS.value[
  797. OPENAI_API_BASE_URLS.value.index("https://api.openai.com/v1")
  798. ]
  799. except Exception:
  800. pass
  801. OPENAI_API_BASE_URL = "https://api.openai.com/v1"
  802. ####################################
  803. # MODELS
  804. ####################################
  805. ENABLE_BASE_MODELS_CACHE = PersistentConfig(
  806. "ENABLE_BASE_MODELS_CACHE",
  807. "models.base_models_cache",
  808. os.environ.get("ENABLE_BASE_MODELS_CACHE", "False").lower() == "true",
  809. )
  810. ####################################
  811. # TOOL_SERVERS
  812. ####################################
  813. try:
  814. tool_server_connections = json.loads(
  815. os.environ.get("TOOL_SERVER_CONNECTIONS", "[]")
  816. )
  817. except Exception as e:
  818. log.exception(f"Error loading TOOL_SERVER_CONNECTIONS: {e}")
  819. tool_server_connections = []
  820. TOOL_SERVER_CONNECTIONS = PersistentConfig(
  821. "TOOL_SERVER_CONNECTIONS",
  822. "tool_server.connections",
  823. tool_server_connections,
  824. )
  825. ####################################
  826. # WEBUI
  827. ####################################
  828. WEBUI_URL = PersistentConfig("WEBUI_URL", "webui.url", os.environ.get("WEBUI_URL", ""))
  829. ENABLE_SIGNUP = PersistentConfig(
  830. "ENABLE_SIGNUP",
  831. "ui.enable_signup",
  832. (
  833. False
  834. if not WEBUI_AUTH
  835. else os.environ.get("ENABLE_SIGNUP", "True").lower() == "true"
  836. ),
  837. )
  838. ENABLE_LOGIN_FORM = PersistentConfig(
  839. "ENABLE_LOGIN_FORM",
  840. "ui.ENABLE_LOGIN_FORM",
  841. os.environ.get("ENABLE_LOGIN_FORM", "True").lower() == "true",
  842. )
  843. DEFAULT_LOCALE = PersistentConfig(
  844. "DEFAULT_LOCALE",
  845. "ui.default_locale",
  846. os.environ.get("DEFAULT_LOCALE", ""),
  847. )
  848. DEFAULT_MODELS = PersistentConfig(
  849. "DEFAULT_MODELS", "ui.default_models", os.environ.get("DEFAULT_MODELS", None)
  850. )
  851. try:
  852. default_prompt_suggestions = json.loads(
  853. os.environ.get("DEFAULT_PROMPT_SUGGESTIONS", "[]")
  854. )
  855. except Exception as e:
  856. log.exception(f"Error loading DEFAULT_PROMPT_SUGGESTIONS: {e}")
  857. default_prompt_suggestions = []
  858. if default_prompt_suggestions == []:
  859. default_prompt_suggestions = [
  860. {
  861. "title": ["Help me study", "vocabulary for a college entrance exam"],
  862. "content": "Help me study vocabulary: write a sentence for me to fill in the blank, and I'll try to pick the correct option.",
  863. },
  864. {
  865. "title": ["Give me ideas", "for what to do with my kids' art"],
  866. "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.",
  867. },
  868. {
  869. "title": ["Tell me a fun fact", "about the Roman Empire"],
  870. "content": "Tell me a random fun fact about the Roman Empire",
  871. },
  872. {
  873. "title": ["Show me a code snippet", "of a website's sticky header"],
  874. "content": "Show me a code snippet of a website's sticky header in CSS and JavaScript.",
  875. },
  876. {
  877. "title": [
  878. "Explain options trading",
  879. "if I'm familiar with buying and selling stocks",
  880. ],
  881. "content": "Explain options trading in simple terms if I'm familiar with buying and selling stocks.",
  882. },
  883. {
  884. "title": ["Overcome procrastination", "give me tips"],
  885. "content": "Could you start by asking me about instances when I procrastinate the most and then give me some suggestions to overcome it?",
  886. },
  887. ]
  888. DEFAULT_PROMPT_SUGGESTIONS = PersistentConfig(
  889. "DEFAULT_PROMPT_SUGGESTIONS",
  890. "ui.prompt_suggestions",
  891. default_prompt_suggestions,
  892. )
  893. MODEL_ORDER_LIST = PersistentConfig(
  894. "MODEL_ORDER_LIST",
  895. "ui.model_order_list",
  896. [],
  897. )
  898. DEFAULT_USER_ROLE = PersistentConfig(
  899. "DEFAULT_USER_ROLE",
  900. "ui.default_user_role",
  901. os.getenv("DEFAULT_USER_ROLE", "pending"),
  902. )
  903. PENDING_USER_OVERLAY_TITLE = PersistentConfig(
  904. "PENDING_USER_OVERLAY_TITLE",
  905. "ui.pending_user_overlay_title",
  906. os.environ.get("PENDING_USER_OVERLAY_TITLE", ""),
  907. )
  908. PENDING_USER_OVERLAY_CONTENT = PersistentConfig(
  909. "PENDING_USER_OVERLAY_CONTENT",
  910. "ui.pending_user_overlay_content",
  911. os.environ.get("PENDING_USER_OVERLAY_CONTENT", ""),
  912. )
  913. RESPONSE_WATERMARK = PersistentConfig(
  914. "RESPONSE_WATERMARK",
  915. "ui.watermark",
  916. os.environ.get("RESPONSE_WATERMARK", ""),
  917. )
  918. USER_PERMISSIONS_WORKSPACE_MODELS_ACCESS = (
  919. os.environ.get("USER_PERMISSIONS_WORKSPACE_MODELS_ACCESS", "False").lower()
  920. == "true"
  921. )
  922. USER_PERMISSIONS_WORKSPACE_KNOWLEDGE_ACCESS = (
  923. os.environ.get("USER_PERMISSIONS_WORKSPACE_KNOWLEDGE_ACCESS", "False").lower()
  924. == "true"
  925. )
  926. USER_PERMISSIONS_WORKSPACE_PROMPTS_ACCESS = (
  927. os.environ.get("USER_PERMISSIONS_WORKSPACE_PROMPTS_ACCESS", "False").lower()
  928. == "true"
  929. )
  930. USER_PERMISSIONS_WORKSPACE_TOOLS_ACCESS = (
  931. os.environ.get("USER_PERMISSIONS_WORKSPACE_TOOLS_ACCESS", "False").lower() == "true"
  932. )
  933. USER_PERMISSIONS_WORKSPACE_MODELS_ALLOW_PUBLIC_SHARING = (
  934. os.environ.get(
  935. "USER_PERMISSIONS_WORKSPACE_MODELS_ALLOW_PUBLIC_SHARING", "False"
  936. ).lower()
  937. == "true"
  938. )
  939. USER_PERMISSIONS_WORKSPACE_KNOWLEDGE_ALLOW_PUBLIC_SHARING = (
  940. os.environ.get(
  941. "USER_PERMISSIONS_WORKSPACE_KNOWLEDGE_ALLOW_PUBLIC_SHARING", "False"
  942. ).lower()
  943. == "true"
  944. )
  945. USER_PERMISSIONS_WORKSPACE_PROMPTS_ALLOW_PUBLIC_SHARING = (
  946. os.environ.get(
  947. "USER_PERMISSIONS_WORKSPACE_PROMPTS_ALLOW_PUBLIC_SHARING", "False"
  948. ).lower()
  949. == "true"
  950. )
  951. USER_PERMISSIONS_WORKSPACE_TOOLS_ALLOW_PUBLIC_SHARING = (
  952. os.environ.get(
  953. "USER_PERMISSIONS_WORKSPACE_TOOLS_ALLOW_PUBLIC_SHARING", "False"
  954. ).lower()
  955. == "true"
  956. )
  957. USER_PERMISSIONS_CHAT_CONTROLS = (
  958. os.environ.get("USER_PERMISSIONS_CHAT_CONTROLS", "True").lower() == "true"
  959. )
  960. USER_PERMISSIONS_CHAT_VALVES = (
  961. os.environ.get("USER_PERMISSIONS_CHAT_VALVES", "True").lower() == "true"
  962. )
  963. USER_PERMISSIONS_CHAT_SYSTEM_PROMPT = (
  964. os.environ.get("USER_PERMISSIONS_CHAT_SYSTEM_PROMPT", "True").lower() == "true"
  965. )
  966. USER_PERMISSIONS_CHAT_PARAMS = (
  967. os.environ.get("USER_PERMISSIONS_CHAT_PARAMS", "True").lower() == "true"
  968. )
  969. USER_PERMISSIONS_CHAT_FILE_UPLOAD = (
  970. os.environ.get("USER_PERMISSIONS_CHAT_FILE_UPLOAD", "True").lower() == "true"
  971. )
  972. USER_PERMISSIONS_CHAT_DELETE = (
  973. os.environ.get("USER_PERMISSIONS_CHAT_DELETE", "True").lower() == "true"
  974. )
  975. USER_PERMISSIONS_CHAT_DELETE_MESSAGE = (
  976. os.environ.get("USER_PERMISSIONS_CHAT_DELETE_MESSAGE", "True").lower() == "true"
  977. )
  978. USER_PERMISSIONS_CHAT_CONTINUE_RESPONSE = (
  979. os.environ.get("USER_PERMISSIONS_CHAT_CONTINUE_RESPONSE", "True").lower() == "true"
  980. )
  981. USER_PERMISSIONS_CHAT_REGENERATE_RESPONSE = (
  982. os.environ.get("USER_PERMISSIONS_CHAT_REGENERATE_RESPONSE", "True").lower()
  983. == "true"
  984. )
  985. USER_PERMISSIONS_CHAT_RATE_RESPONSE = (
  986. os.environ.get("USER_PERMISSIONS_CHAT_RATE_RESPONSE", "True").lower() == "true"
  987. )
  988. USER_PERMISSIONS_CHAT_EDIT = (
  989. os.environ.get("USER_PERMISSIONS_CHAT_EDIT", "True").lower() == "true"
  990. )
  991. USER_PERMISSIONS_CHAT_SHARE = (
  992. os.environ.get("USER_PERMISSIONS_CHAT_SHARE", "True").lower() == "true"
  993. )
  994. USER_PERMISSIONS_CHAT_EXPORT = (
  995. os.environ.get("USER_PERMISSIONS_CHAT_EXPORT", "True").lower() == "true"
  996. )
  997. USER_PERMISSIONS_CHAT_STT = (
  998. os.environ.get("USER_PERMISSIONS_CHAT_STT", "True").lower() == "true"
  999. )
  1000. USER_PERMISSIONS_CHAT_TTS = (
  1001. os.environ.get("USER_PERMISSIONS_CHAT_TTS", "True").lower() == "true"
  1002. )
  1003. USER_PERMISSIONS_CHAT_CALL = (
  1004. os.environ.get("USER_PERMISSIONS_CHAT_CALL", "True").lower() == "true"
  1005. )
  1006. USER_PERMISSIONS_CHAT_MULTIPLE_MODELS = (
  1007. os.environ.get("USER_PERMISSIONS_CHAT_MULTIPLE_MODELS", "True").lower() == "true"
  1008. )
  1009. USER_PERMISSIONS_CHAT_TEMPORARY = (
  1010. os.environ.get("USER_PERMISSIONS_CHAT_TEMPORARY", "True").lower() == "true"
  1011. )
  1012. USER_PERMISSIONS_CHAT_TEMPORARY_ENFORCED = (
  1013. os.environ.get("USER_PERMISSIONS_CHAT_TEMPORARY_ENFORCED", "False").lower()
  1014. == "true"
  1015. )
  1016. USER_PERMISSIONS_FEATURES_DIRECT_TOOL_SERVERS = (
  1017. os.environ.get("USER_PERMISSIONS_FEATURES_DIRECT_TOOL_SERVERS", "False").lower()
  1018. == "true"
  1019. )
  1020. USER_PERMISSIONS_FEATURES_WEB_SEARCH = (
  1021. os.environ.get("USER_PERMISSIONS_FEATURES_WEB_SEARCH", "True").lower() == "true"
  1022. )
  1023. USER_PERMISSIONS_FEATURES_IMAGE_GENERATION = (
  1024. os.environ.get("USER_PERMISSIONS_FEATURES_IMAGE_GENERATION", "True").lower()
  1025. == "true"
  1026. )
  1027. USER_PERMISSIONS_FEATURES_CODE_INTERPRETER = (
  1028. os.environ.get("USER_PERMISSIONS_FEATURES_CODE_INTERPRETER", "True").lower()
  1029. == "true"
  1030. )
  1031. USER_PERMISSIONS_FEATURES_NOTES = (
  1032. os.environ.get("USER_PERMISSIONS_FEATURES_NOTES", "True").lower() == "true"
  1033. )
  1034. DEFAULT_USER_PERMISSIONS = {
  1035. "workspace": {
  1036. "models": USER_PERMISSIONS_WORKSPACE_MODELS_ACCESS,
  1037. "knowledge": USER_PERMISSIONS_WORKSPACE_KNOWLEDGE_ACCESS,
  1038. "prompts": USER_PERMISSIONS_WORKSPACE_PROMPTS_ACCESS,
  1039. "tools": USER_PERMISSIONS_WORKSPACE_TOOLS_ACCESS,
  1040. },
  1041. "sharing": {
  1042. "public_models": USER_PERMISSIONS_WORKSPACE_MODELS_ALLOW_PUBLIC_SHARING,
  1043. "public_knowledge": USER_PERMISSIONS_WORKSPACE_KNOWLEDGE_ALLOW_PUBLIC_SHARING,
  1044. "public_prompts": USER_PERMISSIONS_WORKSPACE_PROMPTS_ALLOW_PUBLIC_SHARING,
  1045. "public_tools": USER_PERMISSIONS_WORKSPACE_TOOLS_ALLOW_PUBLIC_SHARING,
  1046. },
  1047. "chat": {
  1048. "controls": USER_PERMISSIONS_CHAT_CONTROLS,
  1049. "valves": USER_PERMISSIONS_CHAT_VALVES,
  1050. "system_prompt": USER_PERMISSIONS_CHAT_SYSTEM_PROMPT,
  1051. "params": USER_PERMISSIONS_CHAT_PARAMS,
  1052. "file_upload": USER_PERMISSIONS_CHAT_FILE_UPLOAD,
  1053. "delete": USER_PERMISSIONS_CHAT_DELETE,
  1054. "delete_message": USER_PERMISSIONS_CHAT_DELETE_MESSAGE,
  1055. "continue_response": USER_PERMISSIONS_CHAT_CONTINUE_RESPONSE,
  1056. "regenerate_response": USER_PERMISSIONS_CHAT_REGENERATE_RESPONSE,
  1057. "rate_response": USER_PERMISSIONS_CHAT_RATE_RESPONSE,
  1058. "edit": USER_PERMISSIONS_CHAT_EDIT,
  1059. "share": USER_PERMISSIONS_CHAT_SHARE,
  1060. "export": USER_PERMISSIONS_CHAT_EXPORT,
  1061. "stt": USER_PERMISSIONS_CHAT_STT,
  1062. "tts": USER_PERMISSIONS_CHAT_TTS,
  1063. "call": USER_PERMISSIONS_CHAT_CALL,
  1064. "multiple_models": USER_PERMISSIONS_CHAT_MULTIPLE_MODELS,
  1065. "temporary": USER_PERMISSIONS_CHAT_TEMPORARY,
  1066. "temporary_enforced": USER_PERMISSIONS_CHAT_TEMPORARY_ENFORCED,
  1067. },
  1068. "features": {
  1069. "direct_tool_servers": USER_PERMISSIONS_FEATURES_DIRECT_TOOL_SERVERS,
  1070. "web_search": USER_PERMISSIONS_FEATURES_WEB_SEARCH,
  1071. "image_generation": USER_PERMISSIONS_FEATURES_IMAGE_GENERATION,
  1072. "code_interpreter": USER_PERMISSIONS_FEATURES_CODE_INTERPRETER,
  1073. "notes": USER_PERMISSIONS_FEATURES_NOTES,
  1074. },
  1075. }
  1076. USER_PERMISSIONS = PersistentConfig(
  1077. "USER_PERMISSIONS",
  1078. "user.permissions",
  1079. DEFAULT_USER_PERMISSIONS,
  1080. )
  1081. ENABLE_CHANNELS = PersistentConfig(
  1082. "ENABLE_CHANNELS",
  1083. "channels.enable",
  1084. os.environ.get("ENABLE_CHANNELS", "False").lower() == "true",
  1085. )
  1086. ENABLE_NOTES = PersistentConfig(
  1087. "ENABLE_NOTES",
  1088. "notes.enable",
  1089. os.environ.get("ENABLE_NOTES", "True").lower() == "true",
  1090. )
  1091. ENABLE_EVALUATION_ARENA_MODELS = PersistentConfig(
  1092. "ENABLE_EVALUATION_ARENA_MODELS",
  1093. "evaluation.arena.enable",
  1094. os.environ.get("ENABLE_EVALUATION_ARENA_MODELS", "True").lower() == "true",
  1095. )
  1096. EVALUATION_ARENA_MODELS = PersistentConfig(
  1097. "EVALUATION_ARENA_MODELS",
  1098. "evaluation.arena.models",
  1099. [],
  1100. )
  1101. DEFAULT_ARENA_MODEL = {
  1102. "id": "arena-model",
  1103. "name": "Arena Model",
  1104. "meta": {
  1105. "profile_image_url": "/favicon.png",
  1106. "description": "Submit your questions to anonymous AI chatbots and vote on the best response.",
  1107. "model_ids": None,
  1108. },
  1109. }
  1110. WEBHOOK_URL = PersistentConfig(
  1111. "WEBHOOK_URL", "webhook_url", os.environ.get("WEBHOOK_URL", "")
  1112. )
  1113. ENABLE_ADMIN_EXPORT = os.environ.get("ENABLE_ADMIN_EXPORT", "True").lower() == "true"
  1114. ENABLE_ADMIN_WORKSPACE_CONTENT_ACCESS = (
  1115. os.environ.get("ENABLE_ADMIN_WORKSPACE_CONTENT_ACCESS", "True").lower() == "true"
  1116. )
  1117. BYPASS_ADMIN_ACCESS_CONTROL = (
  1118. os.environ.get(
  1119. "BYPASS_ADMIN_ACCESS_CONTROL",
  1120. os.environ.get("ENABLE_ADMIN_WORKSPACE_CONTENT_ACCESS", "True"),
  1121. ).lower()
  1122. == "true"
  1123. )
  1124. ENABLE_ADMIN_CHAT_ACCESS = (
  1125. os.environ.get("ENABLE_ADMIN_CHAT_ACCESS", "True").lower() == "true"
  1126. )
  1127. ENABLE_COMMUNITY_SHARING = PersistentConfig(
  1128. "ENABLE_COMMUNITY_SHARING",
  1129. "ui.enable_community_sharing",
  1130. os.environ.get("ENABLE_COMMUNITY_SHARING", "True").lower() == "true",
  1131. )
  1132. ENABLE_MESSAGE_RATING = PersistentConfig(
  1133. "ENABLE_MESSAGE_RATING",
  1134. "ui.enable_message_rating",
  1135. os.environ.get("ENABLE_MESSAGE_RATING", "True").lower() == "true",
  1136. )
  1137. ENABLE_USER_WEBHOOKS = PersistentConfig(
  1138. "ENABLE_USER_WEBHOOKS",
  1139. "ui.enable_user_webhooks",
  1140. os.environ.get("ENABLE_USER_WEBHOOKS", "True").lower() == "true",
  1141. )
  1142. # FastAPI / AnyIO settings
  1143. THREAD_POOL_SIZE = os.getenv("THREAD_POOL_SIZE", None)
  1144. if THREAD_POOL_SIZE is not None and isinstance(THREAD_POOL_SIZE, str):
  1145. try:
  1146. THREAD_POOL_SIZE = int(THREAD_POOL_SIZE)
  1147. except ValueError:
  1148. log.warning(
  1149. f"THREAD_POOL_SIZE is not a valid integer: {THREAD_POOL_SIZE}. Defaulting to None."
  1150. )
  1151. THREAD_POOL_SIZE = None
  1152. def validate_cors_origin(origin):
  1153. parsed_url = urlparse(origin)
  1154. # Check if the scheme is either http or https, or a custom scheme
  1155. schemes = ["http", "https"] + CORS_ALLOW_CUSTOM_SCHEME
  1156. if parsed_url.scheme not in schemes:
  1157. raise ValueError(
  1158. f"Invalid scheme in CORS_ALLOW_ORIGIN: '{origin}'. Only 'http' and 'https' and CORS_ALLOW_CUSTOM_SCHEME are allowed."
  1159. )
  1160. # Ensure that the netloc (domain + port) is present, indicating it's a valid URL
  1161. if not parsed_url.netloc:
  1162. raise ValueError(f"Invalid URL structure in CORS_ALLOW_ORIGIN: '{origin}'.")
  1163. # For production, you should only need one host as
  1164. # fastapi serves the svelte-kit built frontend and backend from the same host and port.
  1165. # To test CORS_ALLOW_ORIGIN locally, you can set something like
  1166. # CORS_ALLOW_ORIGIN=http://localhost:5173;http://localhost:8080
  1167. # in your .env file depending on your frontend port, 5173 in this case.
  1168. CORS_ALLOW_ORIGIN = os.environ.get("CORS_ALLOW_ORIGIN", "*").split(";")
  1169. # Allows custom URL schemes (e.g., app://) to be used as origins for CORS.
  1170. # Useful for local development or desktop clients with schemes like app:// or other custom protocols.
  1171. # Provide a semicolon-separated list of allowed schemes in the environment variable CORS_ALLOW_CUSTOM_SCHEMES.
  1172. CORS_ALLOW_CUSTOM_SCHEME = os.environ.get("CORS_ALLOW_CUSTOM_SCHEME", "").split(";")
  1173. if CORS_ALLOW_ORIGIN == ["*"]:
  1174. log.warning(
  1175. "\n\nWARNING: CORS_ALLOW_ORIGIN IS SET TO '*' - NOT RECOMMENDED FOR PRODUCTION DEPLOYMENTS.\n"
  1176. )
  1177. else:
  1178. # You have to pick between a single wildcard or a list of origins.
  1179. # Doing both will result in CORS errors in the browser.
  1180. for origin in CORS_ALLOW_ORIGIN:
  1181. validate_cors_origin(origin)
  1182. class BannerModel(BaseModel):
  1183. id: str
  1184. type: str
  1185. title: Optional[str] = None
  1186. content: str
  1187. dismissible: bool
  1188. timestamp: int
  1189. try:
  1190. banners = json.loads(os.environ.get("WEBUI_BANNERS", "[]"))
  1191. banners = [BannerModel(**banner) for banner in banners]
  1192. except Exception as e:
  1193. log.exception(f"Error loading WEBUI_BANNERS: {e}")
  1194. banners = []
  1195. WEBUI_BANNERS = PersistentConfig("WEBUI_BANNERS", "ui.banners", banners)
  1196. SHOW_ADMIN_DETAILS = PersistentConfig(
  1197. "SHOW_ADMIN_DETAILS",
  1198. "auth.admin.show",
  1199. os.environ.get("SHOW_ADMIN_DETAILS", "true").lower() == "true",
  1200. )
  1201. ADMIN_EMAIL = PersistentConfig(
  1202. "ADMIN_EMAIL",
  1203. "auth.admin.email",
  1204. os.environ.get("ADMIN_EMAIL", None),
  1205. )
  1206. ####################################
  1207. # TASKS
  1208. ####################################
  1209. TASK_MODEL = PersistentConfig(
  1210. "TASK_MODEL",
  1211. "task.model.default",
  1212. os.environ.get("TASK_MODEL", ""),
  1213. )
  1214. TASK_MODEL_EXTERNAL = PersistentConfig(
  1215. "TASK_MODEL_EXTERNAL",
  1216. "task.model.external",
  1217. os.environ.get("TASK_MODEL_EXTERNAL", ""),
  1218. )
  1219. TITLE_GENERATION_PROMPT_TEMPLATE = PersistentConfig(
  1220. "TITLE_GENERATION_PROMPT_TEMPLATE",
  1221. "task.title.prompt_template",
  1222. os.environ.get("TITLE_GENERATION_PROMPT_TEMPLATE", ""),
  1223. )
  1224. DEFAULT_TITLE_GENERATION_PROMPT_TEMPLATE = """### Task:
  1225. Generate a concise, 3-5 word title with an emoji summarizing the chat history.
  1226. ### Guidelines:
  1227. - The title should clearly represent the main theme or subject of the conversation.
  1228. - Use emojis that enhance understanding of the topic, but avoid quotation marks or special formatting.
  1229. - Write the title in the chat's primary language; default to English if multilingual.
  1230. - Prioritize accuracy over excessive creativity; keep it clear and simple.
  1231. - Your entire response must consist solely of the JSON object, without any introductory or concluding text.
  1232. - The output must be a single, raw JSON object, without any markdown code fences or other encapsulating text.
  1233. - Ensure no conversational text, affirmations, or explanations precede or follow the raw JSON output, as this will cause direct parsing failure.
  1234. ### Output:
  1235. JSON format: { "title": "your concise title here" }
  1236. ### Examples:
  1237. - { "title": "📉 Stock Market Trends" },
  1238. - { "title": "🍪 Perfect Chocolate Chip Recipe" },
  1239. - { "title": "Evolution of Music Streaming" },
  1240. - { "title": "Remote Work Productivity Tips" },
  1241. - { "title": "Artificial Intelligence in Healthcare" },
  1242. - { "title": "🎮 Video Game Development Insights" }
  1243. ### Chat History:
  1244. <chat_history>
  1245. {{MESSAGES:END:2}}
  1246. </chat_history>"""
  1247. TAGS_GENERATION_PROMPT_TEMPLATE = PersistentConfig(
  1248. "TAGS_GENERATION_PROMPT_TEMPLATE",
  1249. "task.tags.prompt_template",
  1250. os.environ.get("TAGS_GENERATION_PROMPT_TEMPLATE", ""),
  1251. )
  1252. DEFAULT_TAGS_GENERATION_PROMPT_TEMPLATE = """### Task:
  1253. Generate 1-3 broad tags categorizing the main themes of the chat history, along with 1-3 more specific subtopic tags.
  1254. ### Guidelines:
  1255. - Start with high-level domains (e.g. Science, Technology, Philosophy, Arts, Politics, Business, Health, Sports, Entertainment, Education)
  1256. - Consider including relevant subfields/subdomains if they are strongly represented throughout the conversation
  1257. - If content is too short (less than 3 messages) or too diverse, use only ["General"]
  1258. - Use the chat's primary language; default to English if multilingual
  1259. - Prioritize accuracy over specificity
  1260. ### Output:
  1261. JSON format: { "tags": ["tag1", "tag2", "tag3"] }
  1262. ### Chat History:
  1263. <chat_history>
  1264. {{MESSAGES:END:6}}
  1265. </chat_history>"""
  1266. IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE = PersistentConfig(
  1267. "IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE",
  1268. "task.image.prompt_template",
  1269. os.environ.get("IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE", ""),
  1270. )
  1271. DEFAULT_IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE = """### Task:
  1272. Generate a detailed prompt for am image generation task based on the given language and context. Describe the image as if you were explaining it to someone who cannot see it. Include relevant details, colors, shapes, and any other important elements.
  1273. ### Guidelines:
  1274. - Be descriptive and detailed, focusing on the most important aspects of the image.
  1275. - Avoid making assumptions or adding information not present in the image.
  1276. - Use the chat's primary language; default to English if multilingual.
  1277. - If the image is too complex, focus on the most prominent elements.
  1278. ### Output:
  1279. Strictly return in JSON format:
  1280. {
  1281. "prompt": "Your detailed description here."
  1282. }
  1283. ### Chat History:
  1284. <chat_history>
  1285. {{MESSAGES:END:6}}
  1286. </chat_history>"""
  1287. FOLLOW_UP_GENERATION_PROMPT_TEMPLATE = PersistentConfig(
  1288. "FOLLOW_UP_GENERATION_PROMPT_TEMPLATE",
  1289. "task.follow_up.prompt_template",
  1290. os.environ.get("FOLLOW_UP_GENERATION_PROMPT_TEMPLATE", ""),
  1291. )
  1292. DEFAULT_FOLLOW_UP_GENERATION_PROMPT_TEMPLATE = """### Task:
  1293. Suggest 3-5 relevant follow-up questions or prompts that the user might naturally ask next in this conversation as a **user**, based on the chat history, to help continue or deepen the discussion.
  1294. ### Guidelines:
  1295. - Write all follow-up questions from the user’s point of view, directed to the assistant.
  1296. - Make questions concise, clear, and directly related to the discussed topic(s).
  1297. - Only suggest follow-ups that make sense given the chat content and do not repeat what was already covered.
  1298. - If the conversation is very short or not specific, suggest more general (but relevant) follow-ups the user might ask.
  1299. - Use the conversation's primary language; default to English if multilingual.
  1300. - Response must be a JSON array of strings, no extra text or formatting.
  1301. ### Output:
  1302. JSON format: { "follow_ups": ["Question 1?", "Question 2?", "Question 3?"] }
  1303. ### Chat History:
  1304. <chat_history>
  1305. {{MESSAGES:END:6}}
  1306. </chat_history>"""
  1307. ENABLE_FOLLOW_UP_GENERATION = PersistentConfig(
  1308. "ENABLE_FOLLOW_UP_GENERATION",
  1309. "task.follow_up.enable",
  1310. os.environ.get("ENABLE_FOLLOW_UP_GENERATION", "True").lower() == "true",
  1311. )
  1312. ENABLE_TAGS_GENERATION = PersistentConfig(
  1313. "ENABLE_TAGS_GENERATION",
  1314. "task.tags.enable",
  1315. os.environ.get("ENABLE_TAGS_GENERATION", "True").lower() == "true",
  1316. )
  1317. ENABLE_TITLE_GENERATION = PersistentConfig(
  1318. "ENABLE_TITLE_GENERATION",
  1319. "task.title.enable",
  1320. os.environ.get("ENABLE_TITLE_GENERATION", "True").lower() == "true",
  1321. )
  1322. ENABLE_SEARCH_QUERY_GENERATION = PersistentConfig(
  1323. "ENABLE_SEARCH_QUERY_GENERATION",
  1324. "task.query.search.enable",
  1325. os.environ.get("ENABLE_SEARCH_QUERY_GENERATION", "True").lower() == "true",
  1326. )
  1327. ENABLE_RETRIEVAL_QUERY_GENERATION = PersistentConfig(
  1328. "ENABLE_RETRIEVAL_QUERY_GENERATION",
  1329. "task.query.retrieval.enable",
  1330. os.environ.get("ENABLE_RETRIEVAL_QUERY_GENERATION", "True").lower() == "true",
  1331. )
  1332. QUERY_GENERATION_PROMPT_TEMPLATE = PersistentConfig(
  1333. "QUERY_GENERATION_PROMPT_TEMPLATE",
  1334. "task.query.prompt_template",
  1335. os.environ.get("QUERY_GENERATION_PROMPT_TEMPLATE", ""),
  1336. )
  1337. DEFAULT_QUERY_GENERATION_PROMPT_TEMPLATE = """### Task:
  1338. Analyze the chat history to determine the necessity of generating search queries, in the given language. By default, **prioritize generating 1-3 broad and relevant search queries** unless it is absolutely certain that no additional information is required. The aim is to retrieve comprehensive, updated, and valuable information even with minimal uncertainty. If no search is unequivocally needed, return an empty list.
  1339. ### Guidelines:
  1340. - Respond **EXCLUSIVELY** with a JSON object. Any form of extra commentary, explanation, or additional text is strictly prohibited.
  1341. - When generating search queries, respond in the format: { "queries": ["query1", "query2"] }, ensuring each query is distinct, concise, and relevant to the topic.
  1342. - If and only if it is entirely certain that no useful results can be retrieved by a search, return: { "queries": [] }.
  1343. - Err on the side of suggesting search queries if there is **any chance** they might provide useful or updated information.
  1344. - Be concise and focused on composing high-quality search queries, avoiding unnecessary elaboration, commentary, or assumptions.
  1345. - Today's date is: {{CURRENT_DATE}}.
  1346. - Always prioritize providing actionable and broad queries that maximize informational coverage.
  1347. ### Output:
  1348. Strictly return in JSON format:
  1349. {
  1350. "queries": ["query1", "query2"]
  1351. }
  1352. ### Chat History:
  1353. <chat_history>
  1354. {{MESSAGES:END:6}}
  1355. </chat_history>
  1356. """
  1357. ENABLE_AUTOCOMPLETE_GENERATION = PersistentConfig(
  1358. "ENABLE_AUTOCOMPLETE_GENERATION",
  1359. "task.autocomplete.enable",
  1360. os.environ.get("ENABLE_AUTOCOMPLETE_GENERATION", "False").lower() == "true",
  1361. )
  1362. AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH = PersistentConfig(
  1363. "AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH",
  1364. "task.autocomplete.input_max_length",
  1365. int(os.environ.get("AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH", "-1")),
  1366. )
  1367. AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE = PersistentConfig(
  1368. "AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE",
  1369. "task.autocomplete.prompt_template",
  1370. os.environ.get("AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE", ""),
  1371. )
  1372. DEFAULT_AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE = """### Task:
  1373. You are an autocompletion system. Continue the text in `<text>` based on the **completion type** in `<type>` and the given language.
  1374. ### **Instructions**:
  1375. 1. Analyze `<text>` for context and meaning.
  1376. 2. Use `<type>` to guide your output:
  1377. - **General**: Provide a natural, concise continuation.
  1378. - **Search Query**: Complete as if generating a realistic search query.
  1379. 3. Start as if you are directly continuing `<text>`. Do **not** repeat, paraphrase, or respond as a model. Simply complete the text.
  1380. 4. Ensure the continuation:
  1381. - Flows naturally from `<text>`.
  1382. - Avoids repetition, overexplaining, or unrelated ideas.
  1383. 5. If unsure, return: `{ "text": "" }`.
  1384. ### **Output Rules**:
  1385. - Respond only in JSON format: `{ "text": "<your_completion>" }`.
  1386. ### **Examples**:
  1387. #### Example 1:
  1388. Input:
  1389. <type>General</type>
  1390. <text>The sun was setting over the horizon, painting the sky</text>
  1391. Output:
  1392. { "text": "with vibrant shades of orange and pink." }
  1393. #### Example 2:
  1394. Input:
  1395. <type>Search Query</type>
  1396. <text>Top-rated restaurants in</text>
  1397. Output:
  1398. { "text": "New York City for Italian cuisine." }
  1399. ---
  1400. ### Context:
  1401. <chat_history>
  1402. {{MESSAGES:END:6}}
  1403. </chat_history>
  1404. <type>{{TYPE}}</type>
  1405. <text>{{PROMPT}}</text>
  1406. #### Output:
  1407. """
  1408. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = PersistentConfig(
  1409. "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE",
  1410. "task.tools.prompt_template",
  1411. os.environ.get("TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE", ""),
  1412. )
  1413. DEFAULT_TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = """Available Tools: {{TOOLS}}
  1414. Your task is to choose and return the correct tool(s) from the list of available tools based on the query. Follow these guidelines:
  1415. - Return only the JSON object, without any additional text or explanation.
  1416. - If no tools match the query, return an empty array:
  1417. {
  1418. "tool_calls": []
  1419. }
  1420. - If one or more tools match the query, construct a JSON response containing a "tool_calls" array with objects that include:
  1421. - "name": The tool's name.
  1422. - "parameters": A dictionary of required parameters and their corresponding values.
  1423. The format for the JSON response is strictly:
  1424. {
  1425. "tool_calls": [
  1426. {"name": "toolName1", "parameters": {"key1": "value1"}},
  1427. {"name": "toolName2", "parameters": {"key2": "value2"}}
  1428. ]
  1429. }"""
  1430. DEFAULT_EMOJI_GENERATION_PROMPT_TEMPLATE = """Your task is to reflect the speaker's likely facial expression through a fitting emoji. Interpret emotions from the message and reflect their facial expression using fitting, diverse emojis (e.g., 😊, 😢, 😡, 😱).
  1431. Message: ```{{prompt}}```"""
  1432. DEFAULT_MOA_GENERATION_PROMPT_TEMPLATE = """You have been provided with a set of responses from various models to the latest user query: "{{prompt}}"
  1433. Your task is to synthesize these responses into a single, high-quality response. It is crucial to critically evaluate the information provided in these responses, recognizing that some of it may be biased or incorrect. Your response should not simply replicate the given answers but should offer a refined, accurate, and comprehensive reply to the instruction. Ensure your response is well-structured, coherent, and adheres to the highest standards of accuracy and reliability.
  1434. Responses from models: {{responses}}"""
  1435. ####################################
  1436. # Code Interpreter
  1437. ####################################
  1438. ENABLE_CODE_EXECUTION = PersistentConfig(
  1439. "ENABLE_CODE_EXECUTION",
  1440. "code_execution.enable",
  1441. os.environ.get("ENABLE_CODE_EXECUTION", "True").lower() == "true",
  1442. )
  1443. CODE_EXECUTION_ENGINE = PersistentConfig(
  1444. "CODE_EXECUTION_ENGINE",
  1445. "code_execution.engine",
  1446. os.environ.get("CODE_EXECUTION_ENGINE", "pyodide"),
  1447. )
  1448. CODE_EXECUTION_JUPYTER_URL = PersistentConfig(
  1449. "CODE_EXECUTION_JUPYTER_URL",
  1450. "code_execution.jupyter.url",
  1451. os.environ.get("CODE_EXECUTION_JUPYTER_URL", ""),
  1452. )
  1453. CODE_EXECUTION_JUPYTER_AUTH = PersistentConfig(
  1454. "CODE_EXECUTION_JUPYTER_AUTH",
  1455. "code_execution.jupyter.auth",
  1456. os.environ.get("CODE_EXECUTION_JUPYTER_AUTH", ""),
  1457. )
  1458. CODE_EXECUTION_JUPYTER_AUTH_TOKEN = PersistentConfig(
  1459. "CODE_EXECUTION_JUPYTER_AUTH_TOKEN",
  1460. "code_execution.jupyter.auth_token",
  1461. os.environ.get("CODE_EXECUTION_JUPYTER_AUTH_TOKEN", ""),
  1462. )
  1463. CODE_EXECUTION_JUPYTER_AUTH_PASSWORD = PersistentConfig(
  1464. "CODE_EXECUTION_JUPYTER_AUTH_PASSWORD",
  1465. "code_execution.jupyter.auth_password",
  1466. os.environ.get("CODE_EXECUTION_JUPYTER_AUTH_PASSWORD", ""),
  1467. )
  1468. CODE_EXECUTION_JUPYTER_TIMEOUT = PersistentConfig(
  1469. "CODE_EXECUTION_JUPYTER_TIMEOUT",
  1470. "code_execution.jupyter.timeout",
  1471. int(os.environ.get("CODE_EXECUTION_JUPYTER_TIMEOUT", "60")),
  1472. )
  1473. ENABLE_CODE_INTERPRETER = PersistentConfig(
  1474. "ENABLE_CODE_INTERPRETER",
  1475. "code_interpreter.enable",
  1476. os.environ.get("ENABLE_CODE_INTERPRETER", "True").lower() == "true",
  1477. )
  1478. CODE_INTERPRETER_ENGINE = PersistentConfig(
  1479. "CODE_INTERPRETER_ENGINE",
  1480. "code_interpreter.engine",
  1481. os.environ.get("CODE_INTERPRETER_ENGINE", "pyodide"),
  1482. )
  1483. CODE_INTERPRETER_PROMPT_TEMPLATE = PersistentConfig(
  1484. "CODE_INTERPRETER_PROMPT_TEMPLATE",
  1485. "code_interpreter.prompt_template",
  1486. os.environ.get("CODE_INTERPRETER_PROMPT_TEMPLATE", ""),
  1487. )
  1488. CODE_INTERPRETER_JUPYTER_URL = PersistentConfig(
  1489. "CODE_INTERPRETER_JUPYTER_URL",
  1490. "code_interpreter.jupyter.url",
  1491. os.environ.get(
  1492. "CODE_INTERPRETER_JUPYTER_URL", os.environ.get("CODE_EXECUTION_JUPYTER_URL", "")
  1493. ),
  1494. )
  1495. CODE_INTERPRETER_JUPYTER_AUTH = PersistentConfig(
  1496. "CODE_INTERPRETER_JUPYTER_AUTH",
  1497. "code_interpreter.jupyter.auth",
  1498. os.environ.get(
  1499. "CODE_INTERPRETER_JUPYTER_AUTH",
  1500. os.environ.get("CODE_EXECUTION_JUPYTER_AUTH", ""),
  1501. ),
  1502. )
  1503. CODE_INTERPRETER_JUPYTER_AUTH_TOKEN = PersistentConfig(
  1504. "CODE_INTERPRETER_JUPYTER_AUTH_TOKEN",
  1505. "code_interpreter.jupyter.auth_token",
  1506. os.environ.get(
  1507. "CODE_INTERPRETER_JUPYTER_AUTH_TOKEN",
  1508. os.environ.get("CODE_EXECUTION_JUPYTER_AUTH_TOKEN", ""),
  1509. ),
  1510. )
  1511. CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD = PersistentConfig(
  1512. "CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD",
  1513. "code_interpreter.jupyter.auth_password",
  1514. os.environ.get(
  1515. "CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD",
  1516. os.environ.get("CODE_EXECUTION_JUPYTER_AUTH_PASSWORD", ""),
  1517. ),
  1518. )
  1519. CODE_INTERPRETER_JUPYTER_TIMEOUT = PersistentConfig(
  1520. "CODE_INTERPRETER_JUPYTER_TIMEOUT",
  1521. "code_interpreter.jupyter.timeout",
  1522. int(
  1523. os.environ.get(
  1524. "CODE_INTERPRETER_JUPYTER_TIMEOUT",
  1525. os.environ.get("CODE_EXECUTION_JUPYTER_TIMEOUT", "60"),
  1526. )
  1527. ),
  1528. )
  1529. CODE_INTERPRETER_BLOCKED_MODULES = [
  1530. library.strip()
  1531. for library in os.environ.get("CODE_INTERPRETER_BLOCKED_MODULES", "").split(",")
  1532. if library.strip()
  1533. ]
  1534. DEFAULT_CODE_INTERPRETER_PROMPT = """
  1535. #### Tools Available
  1536. 1. **Code Interpreter**: `<code_interpreter type="code" lang="python"></code_interpreter>`
  1537. - You have access to a Python shell that runs directly in the user's browser, enabling fast execution of code for analysis, calculations, or problem-solving. Use it in this response.
  1538. - The Python code you write can incorporate a wide array of libraries, handle data manipulation or visualization, perform API calls for web-related tasks, or tackle virtually any computational challenge. Use this flexibility to **think outside the box, craft elegant solutions, and harness Python's full potential**.
  1539. - To use it, **you must enclose your code within `<code_interpreter type="code" lang="python">` XML tags** and stop right away. If you don't, the code won't execute.
  1540. - When writing code in the code_interpreter XML tag, Do NOT use the triple backticks code block for markdown formatting, example: ```py # python code ``` will cause an error because it is markdown formatting, it is not python code.
  1541. - When coding, **always aim to print meaningful outputs** (e.g., results, tables, summaries, or visuals) to better interpret and verify the findings. Avoid relying on implicit outputs; prioritize explicit and clear print statements so the results are effectively communicated to the user.
  1542. - After obtaining the printed output, **always provide a concise analysis, interpretation, or next steps to help the user understand the findings or refine the outcome further.**
  1543. - If the results are unclear, unexpected, or require validation, refine the code and execute it again as needed. Always aim to deliver meaningful insights from the results, iterating if necessary.
  1544. - **If a link to an image, audio, or any file is provided in markdown format in the output, ALWAYS regurgitate word for word, explicitly display it as part of the response to ensure the user can access it easily, do NOT change the link.**
  1545. - All responses should be communicated in the chat's primary language, ensuring seamless understanding. If the chat is multilingual, default to English for clarity.
  1546. Ensure that the tools are effectively utilized to achieve the highest-quality analysis for the user."""
  1547. ####################################
  1548. # Vector Database
  1549. ####################################
  1550. VECTOR_DB = os.environ.get("VECTOR_DB", "chroma")
  1551. # Chroma
  1552. CHROMA_DATA_PATH = f"{DATA_DIR}/vector_db"
  1553. if VECTOR_DB == "chroma":
  1554. import chromadb
  1555. CHROMA_TENANT = os.environ.get("CHROMA_TENANT", chromadb.DEFAULT_TENANT)
  1556. CHROMA_DATABASE = os.environ.get("CHROMA_DATABASE", chromadb.DEFAULT_DATABASE)
  1557. CHROMA_HTTP_HOST = os.environ.get("CHROMA_HTTP_HOST", "")
  1558. CHROMA_HTTP_PORT = int(os.environ.get("CHROMA_HTTP_PORT", "8000"))
  1559. CHROMA_CLIENT_AUTH_PROVIDER = os.environ.get("CHROMA_CLIENT_AUTH_PROVIDER", "")
  1560. CHROMA_CLIENT_AUTH_CREDENTIALS = os.environ.get(
  1561. "CHROMA_CLIENT_AUTH_CREDENTIALS", ""
  1562. )
  1563. # Comma-separated list of header=value pairs
  1564. CHROMA_HTTP_HEADERS = os.environ.get("CHROMA_HTTP_HEADERS", "")
  1565. if CHROMA_HTTP_HEADERS:
  1566. CHROMA_HTTP_HEADERS = dict(
  1567. [pair.split("=") for pair in CHROMA_HTTP_HEADERS.split(",")]
  1568. )
  1569. else:
  1570. CHROMA_HTTP_HEADERS = None
  1571. CHROMA_HTTP_SSL = os.environ.get("CHROMA_HTTP_SSL", "false").lower() == "true"
  1572. # 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)
  1573. # Milvus
  1574. MILVUS_URI = os.environ.get("MILVUS_URI", f"{DATA_DIR}/vector_db/milvus.db")
  1575. MILVUS_DB = os.environ.get("MILVUS_DB", "default")
  1576. MILVUS_TOKEN = os.environ.get("MILVUS_TOKEN", None)
  1577. MILVUS_INDEX_TYPE = os.environ.get("MILVUS_INDEX_TYPE", "HNSW")
  1578. MILVUS_METRIC_TYPE = os.environ.get("MILVUS_METRIC_TYPE", "COSINE")
  1579. MILVUS_HNSW_M = int(os.environ.get("MILVUS_HNSW_M", "16"))
  1580. MILVUS_HNSW_EFCONSTRUCTION = int(os.environ.get("MILVUS_HNSW_EFCONSTRUCTION", "100"))
  1581. MILVUS_IVF_FLAT_NLIST = int(os.environ.get("MILVUS_IVF_FLAT_NLIST", "128"))
  1582. # Qdrant
  1583. QDRANT_URI = os.environ.get("QDRANT_URI", None)
  1584. QDRANT_API_KEY = os.environ.get("QDRANT_API_KEY", None)
  1585. QDRANT_ON_DISK = os.environ.get("QDRANT_ON_DISK", "false").lower() == "true"
  1586. QDRANT_PREFER_GRPC = os.environ.get("QDRANT_PREFER_GRPC", "false").lower() == "true"
  1587. QDRANT_GRPC_PORT = int(os.environ.get("QDRANT_GRPC_PORT", "6334"))
  1588. QDRANT_TIMEOUT = int(os.environ.get("QDRANT_TIMEOUT", "5"))
  1589. QDRANT_HNSW_M = int(os.environ.get("QDRANT_HNSW_M", "16"))
  1590. ENABLE_QDRANT_MULTITENANCY_MODE = (
  1591. os.environ.get("ENABLE_QDRANT_MULTITENANCY_MODE", "true").lower() == "true"
  1592. )
  1593. QDRANT_COLLECTION_PREFIX = os.environ.get("QDRANT_COLLECTION_PREFIX", "open-webui")
  1594. # OpenSearch
  1595. OPENSEARCH_URI = os.environ.get("OPENSEARCH_URI", "https://localhost:9200")
  1596. OPENSEARCH_SSL = os.environ.get("OPENSEARCH_SSL", "true").lower() == "true"
  1597. OPENSEARCH_CERT_VERIFY = (
  1598. os.environ.get("OPENSEARCH_CERT_VERIFY", "false").lower() == "true"
  1599. )
  1600. OPENSEARCH_USERNAME = os.environ.get("OPENSEARCH_USERNAME", None)
  1601. OPENSEARCH_PASSWORD = os.environ.get("OPENSEARCH_PASSWORD", None)
  1602. # ElasticSearch
  1603. ELASTICSEARCH_URL = os.environ.get("ELASTICSEARCH_URL", "https://localhost:9200")
  1604. ELASTICSEARCH_CA_CERTS = os.environ.get("ELASTICSEARCH_CA_CERTS", None)
  1605. ELASTICSEARCH_API_KEY = os.environ.get("ELASTICSEARCH_API_KEY", None)
  1606. ELASTICSEARCH_USERNAME = os.environ.get("ELASTICSEARCH_USERNAME", None)
  1607. ELASTICSEARCH_PASSWORD = os.environ.get("ELASTICSEARCH_PASSWORD", None)
  1608. ELASTICSEARCH_CLOUD_ID = os.environ.get("ELASTICSEARCH_CLOUD_ID", None)
  1609. SSL_ASSERT_FINGERPRINT = os.environ.get("SSL_ASSERT_FINGERPRINT", None)
  1610. ELASTICSEARCH_INDEX_PREFIX = os.environ.get(
  1611. "ELASTICSEARCH_INDEX_PREFIX", "open_webui_collections"
  1612. )
  1613. # Pgvector
  1614. PGVECTOR_DB_URL = os.environ.get("PGVECTOR_DB_URL", DATABASE_URL)
  1615. if VECTOR_DB == "pgvector" and not PGVECTOR_DB_URL.startswith("postgres"):
  1616. raise ValueError(
  1617. "Pgvector requires setting PGVECTOR_DB_URL or using Postgres with vector extension as the primary database."
  1618. )
  1619. PGVECTOR_INITIALIZE_MAX_VECTOR_LENGTH = int(
  1620. os.environ.get("PGVECTOR_INITIALIZE_MAX_VECTOR_LENGTH", "1536")
  1621. )
  1622. PGVECTOR_PGCRYPTO = os.getenv("PGVECTOR_PGCRYPTO", "false").lower() == "true"
  1623. PGVECTOR_PGCRYPTO_KEY = os.getenv("PGVECTOR_PGCRYPTO_KEY", None)
  1624. if PGVECTOR_PGCRYPTO and not PGVECTOR_PGCRYPTO_KEY:
  1625. raise ValueError(
  1626. "PGVECTOR_PGCRYPTO is enabled but PGVECTOR_PGCRYPTO_KEY is not set. Please provide a valid key."
  1627. )
  1628. PGVECTOR_POOL_SIZE = os.environ.get("PGVECTOR_POOL_SIZE", None)
  1629. if PGVECTOR_POOL_SIZE != None:
  1630. try:
  1631. PGVECTOR_POOL_SIZE = int(PGVECTOR_POOL_SIZE)
  1632. except Exception:
  1633. PGVECTOR_POOL_SIZE = None
  1634. PGVECTOR_POOL_MAX_OVERFLOW = os.environ.get("PGVECTOR_POOL_MAX_OVERFLOW", 0)
  1635. if PGVECTOR_POOL_MAX_OVERFLOW == "":
  1636. PGVECTOR_POOL_MAX_OVERFLOW = 0
  1637. else:
  1638. try:
  1639. PGVECTOR_POOL_MAX_OVERFLOW = int(PGVECTOR_POOL_MAX_OVERFLOW)
  1640. except Exception:
  1641. PGVECTOR_POOL_MAX_OVERFLOW = 0
  1642. PGVECTOR_POOL_TIMEOUT = os.environ.get("PGVECTOR_POOL_TIMEOUT", 30)
  1643. if PGVECTOR_POOL_TIMEOUT == "":
  1644. PGVECTOR_POOL_TIMEOUT = 30
  1645. else:
  1646. try:
  1647. PGVECTOR_POOL_TIMEOUT = int(PGVECTOR_POOL_TIMEOUT)
  1648. except Exception:
  1649. PGVECTOR_POOL_TIMEOUT = 30
  1650. PGVECTOR_POOL_RECYCLE = os.environ.get("PGVECTOR_POOL_RECYCLE", 3600)
  1651. if PGVECTOR_POOL_RECYCLE == "":
  1652. PGVECTOR_POOL_RECYCLE = 3600
  1653. else:
  1654. try:
  1655. PGVECTOR_POOL_RECYCLE = int(PGVECTOR_POOL_RECYCLE)
  1656. except Exception:
  1657. PGVECTOR_POOL_RECYCLE = 3600
  1658. # Pinecone
  1659. PINECONE_API_KEY = os.environ.get("PINECONE_API_KEY", None)
  1660. PINECONE_ENVIRONMENT = os.environ.get("PINECONE_ENVIRONMENT", None)
  1661. PINECONE_INDEX_NAME = os.getenv("PINECONE_INDEX_NAME", "open-webui-index")
  1662. PINECONE_DIMENSION = int(os.getenv("PINECONE_DIMENSION", 1536)) # or 3072, 1024, 768
  1663. PINECONE_METRIC = os.getenv("PINECONE_METRIC", "cosine")
  1664. PINECONE_CLOUD = os.getenv("PINECONE_CLOUD", "aws") # or "gcp" or "azure"
  1665. # ORACLE23AI (Oracle23ai Vector Search)
  1666. ORACLE_DB_USE_WALLET = os.environ.get("ORACLE_DB_USE_WALLET", "false").lower() == "true"
  1667. ORACLE_DB_USER = os.environ.get("ORACLE_DB_USER", None) #
  1668. ORACLE_DB_PASSWORD = os.environ.get("ORACLE_DB_PASSWORD", None) #
  1669. ORACLE_DB_DSN = os.environ.get("ORACLE_DB_DSN", None) #
  1670. ORACLE_WALLET_DIR = os.environ.get("ORACLE_WALLET_DIR", None)
  1671. ORACLE_WALLET_PASSWORD = os.environ.get("ORACLE_WALLET_PASSWORD", None)
  1672. ORACLE_VECTOR_LENGTH = os.environ.get("ORACLE_VECTOR_LENGTH", 768)
  1673. ORACLE_DB_POOL_MIN = int(os.environ.get("ORACLE_DB_POOL_MIN", 2))
  1674. ORACLE_DB_POOL_MAX = int(os.environ.get("ORACLE_DB_POOL_MAX", 10))
  1675. ORACLE_DB_POOL_INCREMENT = int(os.environ.get("ORACLE_DB_POOL_INCREMENT", 1))
  1676. if VECTOR_DB == "oracle23ai":
  1677. if not ORACLE_DB_USER or not ORACLE_DB_PASSWORD or not ORACLE_DB_DSN:
  1678. raise ValueError(
  1679. "Oracle23ai requires setting ORACLE_DB_USER, ORACLE_DB_PASSWORD, and ORACLE_DB_DSN."
  1680. )
  1681. if ORACLE_DB_USE_WALLET and (not ORACLE_WALLET_DIR or not ORACLE_WALLET_PASSWORD):
  1682. raise ValueError(
  1683. "Oracle23ai requires setting ORACLE_WALLET_DIR and ORACLE_WALLET_PASSWORD when using wallet authentication."
  1684. )
  1685. log.info(f"VECTOR_DB: {VECTOR_DB}")
  1686. # S3 Vector
  1687. S3_VECTOR_BUCKET_NAME = os.environ.get("S3_VECTOR_BUCKET_NAME", None)
  1688. S3_VECTOR_REGION = os.environ.get("S3_VECTOR_REGION", None)
  1689. ####################################
  1690. # Information Retrieval (RAG)
  1691. ####################################
  1692. # If configured, Google Drive will be available as an upload option.
  1693. ENABLE_GOOGLE_DRIVE_INTEGRATION = PersistentConfig(
  1694. "ENABLE_GOOGLE_DRIVE_INTEGRATION",
  1695. "google_drive.enable",
  1696. os.getenv("ENABLE_GOOGLE_DRIVE_INTEGRATION", "False").lower() == "true",
  1697. )
  1698. GOOGLE_DRIVE_CLIENT_ID = PersistentConfig(
  1699. "GOOGLE_DRIVE_CLIENT_ID",
  1700. "google_drive.client_id",
  1701. os.environ.get("GOOGLE_DRIVE_CLIENT_ID", ""),
  1702. )
  1703. GOOGLE_DRIVE_API_KEY = PersistentConfig(
  1704. "GOOGLE_DRIVE_API_KEY",
  1705. "google_drive.api_key",
  1706. os.environ.get("GOOGLE_DRIVE_API_KEY", ""),
  1707. )
  1708. ENABLE_ONEDRIVE_INTEGRATION = PersistentConfig(
  1709. "ENABLE_ONEDRIVE_INTEGRATION",
  1710. "onedrive.enable",
  1711. os.getenv("ENABLE_ONEDRIVE_INTEGRATION", "False").lower() == "true",
  1712. )
  1713. ONEDRIVE_CLIENT_ID = PersistentConfig(
  1714. "ONEDRIVE_CLIENT_ID",
  1715. "onedrive.client_id",
  1716. os.environ.get("ONEDRIVE_CLIENT_ID", ""),
  1717. )
  1718. ONEDRIVE_SHAREPOINT_URL = PersistentConfig(
  1719. "ONEDRIVE_SHAREPOINT_URL",
  1720. "onedrive.sharepoint_url",
  1721. os.environ.get("ONEDRIVE_SHAREPOINT_URL", ""),
  1722. )
  1723. ONEDRIVE_SHAREPOINT_TENANT_ID = PersistentConfig(
  1724. "ONEDRIVE_SHAREPOINT_TENANT_ID",
  1725. "onedrive.sharepoint_tenant_id",
  1726. os.environ.get("ONEDRIVE_SHAREPOINT_TENANT_ID", ""),
  1727. )
  1728. # RAG Content Extraction
  1729. CONTENT_EXTRACTION_ENGINE = PersistentConfig(
  1730. "CONTENT_EXTRACTION_ENGINE",
  1731. "rag.CONTENT_EXTRACTION_ENGINE",
  1732. os.environ.get("CONTENT_EXTRACTION_ENGINE", "").lower(),
  1733. )
  1734. DATALAB_MARKER_API_KEY = PersistentConfig(
  1735. "DATALAB_MARKER_API_KEY",
  1736. "rag.datalab_marker_api_key",
  1737. os.environ.get("DATALAB_MARKER_API_KEY", ""),
  1738. )
  1739. DATALAB_MARKER_API_BASE_URL = PersistentConfig(
  1740. "DATALAB_MARKER_API_BASE_URL",
  1741. "rag.datalab_marker_api_base_url",
  1742. os.environ.get("DATALAB_MARKER_API_BASE_URL", ""),
  1743. )
  1744. DATALAB_MARKER_ADDITIONAL_CONFIG = PersistentConfig(
  1745. "DATALAB_MARKER_ADDITIONAL_CONFIG",
  1746. "rag.datalab_marker_additional_config",
  1747. os.environ.get("DATALAB_MARKER_ADDITIONAL_CONFIG", ""),
  1748. )
  1749. DATALAB_MARKER_USE_LLM = PersistentConfig(
  1750. "DATALAB_MARKER_USE_LLM",
  1751. "rag.DATALAB_MARKER_USE_LLM",
  1752. os.environ.get("DATALAB_MARKER_USE_LLM", "false").lower() == "true",
  1753. )
  1754. DATALAB_MARKER_SKIP_CACHE = PersistentConfig(
  1755. "DATALAB_MARKER_SKIP_CACHE",
  1756. "rag.datalab_marker_skip_cache",
  1757. os.environ.get("DATALAB_MARKER_SKIP_CACHE", "false").lower() == "true",
  1758. )
  1759. DATALAB_MARKER_FORCE_OCR = PersistentConfig(
  1760. "DATALAB_MARKER_FORCE_OCR",
  1761. "rag.datalab_marker_force_ocr",
  1762. os.environ.get("DATALAB_MARKER_FORCE_OCR", "false").lower() == "true",
  1763. )
  1764. DATALAB_MARKER_PAGINATE = PersistentConfig(
  1765. "DATALAB_MARKER_PAGINATE",
  1766. "rag.datalab_marker_paginate",
  1767. os.environ.get("DATALAB_MARKER_PAGINATE", "false").lower() == "true",
  1768. )
  1769. DATALAB_MARKER_STRIP_EXISTING_OCR = PersistentConfig(
  1770. "DATALAB_MARKER_STRIP_EXISTING_OCR",
  1771. "rag.datalab_marker_strip_existing_ocr",
  1772. os.environ.get("DATALAB_MARKER_STRIP_EXISTING_OCR", "false").lower() == "true",
  1773. )
  1774. DATALAB_MARKER_DISABLE_IMAGE_EXTRACTION = PersistentConfig(
  1775. "DATALAB_MARKER_DISABLE_IMAGE_EXTRACTION",
  1776. "rag.datalab_marker_disable_image_extraction",
  1777. os.environ.get("DATALAB_MARKER_DISABLE_IMAGE_EXTRACTION", "false").lower()
  1778. == "true",
  1779. )
  1780. DATALAB_MARKER_FORMAT_LINES = PersistentConfig(
  1781. "DATALAB_MARKER_FORMAT_LINES",
  1782. "rag.datalab_marker_format_lines",
  1783. os.environ.get("DATALAB_MARKER_FORMAT_LINES", "false").lower() == "true",
  1784. )
  1785. DATALAB_MARKER_OUTPUT_FORMAT = PersistentConfig(
  1786. "DATALAB_MARKER_OUTPUT_FORMAT",
  1787. "rag.datalab_marker_output_format",
  1788. os.environ.get("DATALAB_MARKER_OUTPUT_FORMAT", "markdown"),
  1789. )
  1790. EXTERNAL_DOCUMENT_LOADER_URL = PersistentConfig(
  1791. "EXTERNAL_DOCUMENT_LOADER_URL",
  1792. "rag.external_document_loader_url",
  1793. os.environ.get("EXTERNAL_DOCUMENT_LOADER_URL", ""),
  1794. )
  1795. EXTERNAL_DOCUMENT_LOADER_API_KEY = PersistentConfig(
  1796. "EXTERNAL_DOCUMENT_LOADER_API_KEY",
  1797. "rag.external_document_loader_api_key",
  1798. os.environ.get("EXTERNAL_DOCUMENT_LOADER_API_KEY", ""),
  1799. )
  1800. TIKA_SERVER_URL = PersistentConfig(
  1801. "TIKA_SERVER_URL",
  1802. "rag.tika_server_url",
  1803. os.getenv("TIKA_SERVER_URL", "http://tika:9998"), # Default for sidecar deployment
  1804. )
  1805. DOCLING_SERVER_URL = PersistentConfig(
  1806. "DOCLING_SERVER_URL",
  1807. "rag.docling_server_url",
  1808. os.getenv("DOCLING_SERVER_URL", "http://docling:5001"),
  1809. )
  1810. DOCLING_DO_OCR = PersistentConfig(
  1811. "DOCLING_DO_OCR",
  1812. "rag.docling_do_ocr",
  1813. os.getenv("DOCLING_DO_OCR", "True").lower() == "true",
  1814. )
  1815. DOCLING_FORCE_OCR = PersistentConfig(
  1816. "DOCLING_FORCE_OCR",
  1817. "rag.docling_force_ocr",
  1818. os.getenv("DOCLING_FORCE_OCR", "False").lower() == "true",
  1819. )
  1820. DOCLING_OCR_ENGINE = PersistentConfig(
  1821. "DOCLING_OCR_ENGINE",
  1822. "rag.docling_ocr_engine",
  1823. os.getenv("DOCLING_OCR_ENGINE", "tesseract"),
  1824. )
  1825. DOCLING_OCR_LANG = PersistentConfig(
  1826. "DOCLING_OCR_LANG",
  1827. "rag.docling_ocr_lang",
  1828. os.getenv("DOCLING_OCR_LANG", "eng,fra,deu,spa"),
  1829. )
  1830. DOCLING_PDF_BACKEND = PersistentConfig(
  1831. "DOCLING_PDF_BACKEND",
  1832. "rag.docling_pdf_backend",
  1833. os.getenv("DOCLING_PDF_BACKEND", "dlparse_v4"),
  1834. )
  1835. DOCLING_TABLE_MODE = PersistentConfig(
  1836. "DOCLING_TABLE_MODE",
  1837. "rag.docling_table_mode",
  1838. os.getenv("DOCLING_TABLE_MODE", "accurate"),
  1839. )
  1840. DOCLING_PIPELINE = PersistentConfig(
  1841. "DOCLING_PIPELINE",
  1842. "rag.docling_pipeline",
  1843. os.getenv("DOCLING_PIPELINE", "standard"),
  1844. )
  1845. DOCLING_DO_PICTURE_DESCRIPTION = PersistentConfig(
  1846. "DOCLING_DO_PICTURE_DESCRIPTION",
  1847. "rag.docling_do_picture_description",
  1848. os.getenv("DOCLING_DO_PICTURE_DESCRIPTION", "False").lower() == "true",
  1849. )
  1850. DOCLING_PICTURE_DESCRIPTION_MODE = PersistentConfig(
  1851. "DOCLING_PICTURE_DESCRIPTION_MODE",
  1852. "rag.docling_picture_description_mode",
  1853. os.getenv("DOCLING_PICTURE_DESCRIPTION_MODE", ""),
  1854. )
  1855. docling_picture_description_local = os.getenv("DOCLING_PICTURE_DESCRIPTION_LOCAL", "")
  1856. try:
  1857. docling_picture_description_local = json.loads(docling_picture_description_local)
  1858. except json.JSONDecodeError:
  1859. docling_picture_description_local = {}
  1860. DOCLING_PICTURE_DESCRIPTION_LOCAL = PersistentConfig(
  1861. "DOCLING_PICTURE_DESCRIPTION_LOCAL",
  1862. "rag.docling_picture_description_local",
  1863. docling_picture_description_local,
  1864. )
  1865. docling_picture_description_api = os.getenv("DOCLING_PICTURE_DESCRIPTION_API", "")
  1866. try:
  1867. docling_picture_description_api = json.loads(docling_picture_description_api)
  1868. except json.JSONDecodeError:
  1869. docling_picture_description_api = {}
  1870. DOCLING_PICTURE_DESCRIPTION_API = PersistentConfig(
  1871. "DOCLING_PICTURE_DESCRIPTION_API",
  1872. "rag.docling_picture_description_api",
  1873. docling_picture_description_api,
  1874. )
  1875. DOCUMENT_INTELLIGENCE_ENDPOINT = PersistentConfig(
  1876. "DOCUMENT_INTELLIGENCE_ENDPOINT",
  1877. "rag.document_intelligence_endpoint",
  1878. os.getenv("DOCUMENT_INTELLIGENCE_ENDPOINT", ""),
  1879. )
  1880. DOCUMENT_INTELLIGENCE_KEY = PersistentConfig(
  1881. "DOCUMENT_INTELLIGENCE_KEY",
  1882. "rag.document_intelligence_key",
  1883. os.getenv("DOCUMENT_INTELLIGENCE_KEY", ""),
  1884. )
  1885. MISTRAL_OCR_API_KEY = PersistentConfig(
  1886. "MISTRAL_OCR_API_KEY",
  1887. "rag.mistral_ocr_api_key",
  1888. os.getenv("MISTRAL_OCR_API_KEY", ""),
  1889. )
  1890. BYPASS_EMBEDDING_AND_RETRIEVAL = PersistentConfig(
  1891. "BYPASS_EMBEDDING_AND_RETRIEVAL",
  1892. "rag.bypass_embedding_and_retrieval",
  1893. os.environ.get("BYPASS_EMBEDDING_AND_RETRIEVAL", "False").lower() == "true",
  1894. )
  1895. RAG_TOP_K = PersistentConfig(
  1896. "RAG_TOP_K", "rag.top_k", int(os.environ.get("RAG_TOP_K", "3"))
  1897. )
  1898. RAG_TOP_K_RERANKER = PersistentConfig(
  1899. "RAG_TOP_K_RERANKER",
  1900. "rag.top_k_reranker",
  1901. int(os.environ.get("RAG_TOP_K_RERANKER", "3")),
  1902. )
  1903. RAG_RELEVANCE_THRESHOLD = PersistentConfig(
  1904. "RAG_RELEVANCE_THRESHOLD",
  1905. "rag.relevance_threshold",
  1906. float(os.environ.get("RAG_RELEVANCE_THRESHOLD", "0.0")),
  1907. )
  1908. RAG_HYBRID_BM25_WEIGHT = PersistentConfig(
  1909. "RAG_HYBRID_BM25_WEIGHT",
  1910. "rag.hybrid_bm25_weight",
  1911. float(os.environ.get("RAG_HYBRID_BM25_WEIGHT", "0.5")),
  1912. )
  1913. ENABLE_RAG_HYBRID_SEARCH = PersistentConfig(
  1914. "ENABLE_RAG_HYBRID_SEARCH",
  1915. "rag.enable_hybrid_search",
  1916. os.environ.get("ENABLE_RAG_HYBRID_SEARCH", "").lower() == "true",
  1917. )
  1918. RAG_FULL_CONTEXT = PersistentConfig(
  1919. "RAG_FULL_CONTEXT",
  1920. "rag.full_context",
  1921. os.getenv("RAG_FULL_CONTEXT", "False").lower() == "true",
  1922. )
  1923. RAG_FILE_MAX_COUNT = PersistentConfig(
  1924. "RAG_FILE_MAX_COUNT",
  1925. "rag.file.max_count",
  1926. (
  1927. int(os.environ.get("RAG_FILE_MAX_COUNT"))
  1928. if os.environ.get("RAG_FILE_MAX_COUNT")
  1929. else None
  1930. ),
  1931. )
  1932. RAG_FILE_MAX_SIZE = PersistentConfig(
  1933. "RAG_FILE_MAX_SIZE",
  1934. "rag.file.max_size",
  1935. (
  1936. int(os.environ.get("RAG_FILE_MAX_SIZE"))
  1937. if os.environ.get("RAG_FILE_MAX_SIZE")
  1938. else None
  1939. ),
  1940. )
  1941. FILE_IMAGE_COMPRESSION_WIDTH = PersistentConfig(
  1942. "FILE_IMAGE_COMPRESSION_WIDTH",
  1943. "file.image_compression_width",
  1944. (
  1945. int(os.environ.get("FILE_IMAGE_COMPRESSION_WIDTH"))
  1946. if os.environ.get("FILE_IMAGE_COMPRESSION_WIDTH")
  1947. else None
  1948. ),
  1949. )
  1950. FILE_IMAGE_COMPRESSION_HEIGHT = PersistentConfig(
  1951. "FILE_IMAGE_COMPRESSION_HEIGHT",
  1952. "file.image_compression_height",
  1953. (
  1954. int(os.environ.get("FILE_IMAGE_COMPRESSION_HEIGHT"))
  1955. if os.environ.get("FILE_IMAGE_COMPRESSION_HEIGHT")
  1956. else None
  1957. ),
  1958. )
  1959. RAG_ALLOWED_FILE_EXTENSIONS = PersistentConfig(
  1960. "RAG_ALLOWED_FILE_EXTENSIONS",
  1961. "rag.file.allowed_extensions",
  1962. [
  1963. ext.strip()
  1964. for ext in os.environ.get("RAG_ALLOWED_FILE_EXTENSIONS", "").split(",")
  1965. if ext.strip()
  1966. ],
  1967. )
  1968. RAG_EMBEDDING_ENGINE = PersistentConfig(
  1969. "RAG_EMBEDDING_ENGINE",
  1970. "rag.embedding_engine",
  1971. os.environ.get("RAG_EMBEDDING_ENGINE", ""),
  1972. )
  1973. PDF_EXTRACT_IMAGES = PersistentConfig(
  1974. "PDF_EXTRACT_IMAGES",
  1975. "rag.pdf_extract_images",
  1976. os.environ.get("PDF_EXTRACT_IMAGES", "False").lower() == "true",
  1977. )
  1978. RAG_EMBEDDING_MODEL = PersistentConfig(
  1979. "RAG_EMBEDDING_MODEL",
  1980. "rag.embedding_model",
  1981. os.environ.get("RAG_EMBEDDING_MODEL", "sentence-transformers/all-MiniLM-L6-v2"),
  1982. )
  1983. log.info(f"Embedding model set: {RAG_EMBEDDING_MODEL.value}")
  1984. RAG_EMBEDDING_MODEL_AUTO_UPDATE = (
  1985. not OFFLINE_MODE
  1986. and os.environ.get("RAG_EMBEDDING_MODEL_AUTO_UPDATE", "True").lower() == "true"
  1987. )
  1988. RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE = (
  1989. os.environ.get("RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE", "True").lower() == "true"
  1990. )
  1991. RAG_EMBEDDING_BATCH_SIZE = PersistentConfig(
  1992. "RAG_EMBEDDING_BATCH_SIZE",
  1993. "rag.embedding_batch_size",
  1994. int(
  1995. os.environ.get("RAG_EMBEDDING_BATCH_SIZE")
  1996. or os.environ.get("RAG_EMBEDDING_OPENAI_BATCH_SIZE", "1")
  1997. ),
  1998. )
  1999. RAG_EMBEDDING_QUERY_PREFIX = os.environ.get("RAG_EMBEDDING_QUERY_PREFIX", None)
  2000. RAG_EMBEDDING_CONTENT_PREFIX = os.environ.get("RAG_EMBEDDING_CONTENT_PREFIX", None)
  2001. RAG_EMBEDDING_PREFIX_FIELD_NAME = os.environ.get(
  2002. "RAG_EMBEDDING_PREFIX_FIELD_NAME", None
  2003. )
  2004. RAG_RERANKING_ENGINE = PersistentConfig(
  2005. "RAG_RERANKING_ENGINE",
  2006. "rag.reranking_engine",
  2007. os.environ.get("RAG_RERANKING_ENGINE", ""),
  2008. )
  2009. RAG_RERANKING_MODEL = PersistentConfig(
  2010. "RAG_RERANKING_MODEL",
  2011. "rag.reranking_model",
  2012. os.environ.get("RAG_RERANKING_MODEL", ""),
  2013. )
  2014. if RAG_RERANKING_MODEL.value != "":
  2015. log.info(f"Reranking model set: {RAG_RERANKING_MODEL.value}")
  2016. RAG_RERANKING_MODEL_AUTO_UPDATE = (
  2017. not OFFLINE_MODE
  2018. and os.environ.get("RAG_RERANKING_MODEL_AUTO_UPDATE", "True").lower() == "true"
  2019. )
  2020. RAG_RERANKING_MODEL_TRUST_REMOTE_CODE = (
  2021. os.environ.get("RAG_RERANKING_MODEL_TRUST_REMOTE_CODE", "True").lower() == "true"
  2022. )
  2023. RAG_EXTERNAL_RERANKER_URL = PersistentConfig(
  2024. "RAG_EXTERNAL_RERANKER_URL",
  2025. "rag.external_reranker_url",
  2026. os.environ.get("RAG_EXTERNAL_RERANKER_URL", ""),
  2027. )
  2028. RAG_EXTERNAL_RERANKER_API_KEY = PersistentConfig(
  2029. "RAG_EXTERNAL_RERANKER_API_KEY",
  2030. "rag.external_reranker_api_key",
  2031. os.environ.get("RAG_EXTERNAL_RERANKER_API_KEY", ""),
  2032. )
  2033. RAG_TEXT_SPLITTER = PersistentConfig(
  2034. "RAG_TEXT_SPLITTER",
  2035. "rag.text_splitter",
  2036. os.environ.get("RAG_TEXT_SPLITTER", ""),
  2037. )
  2038. TIKTOKEN_CACHE_DIR = os.environ.get("TIKTOKEN_CACHE_DIR", f"{CACHE_DIR}/tiktoken")
  2039. TIKTOKEN_ENCODING_NAME = PersistentConfig(
  2040. "TIKTOKEN_ENCODING_NAME",
  2041. "rag.tiktoken_encoding_name",
  2042. os.environ.get("TIKTOKEN_ENCODING_NAME", "cl100k_base"),
  2043. )
  2044. CHUNK_SIZE = PersistentConfig(
  2045. "CHUNK_SIZE", "rag.chunk_size", int(os.environ.get("CHUNK_SIZE", "1000"))
  2046. )
  2047. CHUNK_OVERLAP = PersistentConfig(
  2048. "CHUNK_OVERLAP",
  2049. "rag.chunk_overlap",
  2050. int(os.environ.get("CHUNK_OVERLAP", "100")),
  2051. )
  2052. DEFAULT_RAG_TEMPLATE = """### Task:
  2053. Respond to the user query using the provided context, incorporating inline citations in the format [id] **only when the <source> tag includes an explicit id attribute** (e.g., <source id="1">).
  2054. ### Guidelines:
  2055. - If you don't know the answer, clearly state that.
  2056. - If uncertain, ask the user for clarification.
  2057. - Respond in the same language as the user's query.
  2058. - If the context is unreadable or of poor quality, inform the user and provide the best possible answer.
  2059. - If the answer isn't present in the context but you possess the knowledge, explain this to the user and provide the answer using your own understanding.
  2060. - **Only include inline citations using [id] (e.g., [1], [2]) when the <source> tag includes an id attribute.**
  2061. - Do not cite if the <source> tag does not contain an id attribute.
  2062. - Do not use XML tags in your response.
  2063. - Ensure citations are concise and directly related to the information provided.
  2064. ### Example of Citation:
  2065. If the user asks about a specific topic and the information is found in a source with a provided id attribute, the response should include the citation like in the following example:
  2066. * "According to the study, the proposed method increases efficiency by 20% [1]."
  2067. ### Output:
  2068. Provide a clear and direct response to the user's query, including inline citations in the format [id] only when the <source> tag with id attribute is present in the context.
  2069. <context>
  2070. {{CONTEXT}}
  2071. </context>
  2072. <user_query>
  2073. {{QUERY}}
  2074. </user_query>
  2075. """
  2076. RAG_TEMPLATE = PersistentConfig(
  2077. "RAG_TEMPLATE",
  2078. "rag.template",
  2079. os.environ.get("RAG_TEMPLATE", DEFAULT_RAG_TEMPLATE),
  2080. )
  2081. RAG_OPENAI_API_BASE_URL = PersistentConfig(
  2082. "RAG_OPENAI_API_BASE_URL",
  2083. "rag.openai_api_base_url",
  2084. os.getenv("RAG_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  2085. )
  2086. RAG_OPENAI_API_KEY = PersistentConfig(
  2087. "RAG_OPENAI_API_KEY",
  2088. "rag.openai_api_key",
  2089. os.getenv("RAG_OPENAI_API_KEY", OPENAI_API_KEY),
  2090. )
  2091. RAG_AZURE_OPENAI_BASE_URL = PersistentConfig(
  2092. "RAG_AZURE_OPENAI_BASE_URL",
  2093. "rag.azure_openai.base_url",
  2094. os.getenv("RAG_AZURE_OPENAI_BASE_URL", ""),
  2095. )
  2096. RAG_AZURE_OPENAI_API_KEY = PersistentConfig(
  2097. "RAG_AZURE_OPENAI_API_KEY",
  2098. "rag.azure_openai.api_key",
  2099. os.getenv("RAG_AZURE_OPENAI_API_KEY", ""),
  2100. )
  2101. RAG_AZURE_OPENAI_API_VERSION = PersistentConfig(
  2102. "RAG_AZURE_OPENAI_API_VERSION",
  2103. "rag.azure_openai.api_version",
  2104. os.getenv("RAG_AZURE_OPENAI_API_VERSION", ""),
  2105. )
  2106. RAG_OLLAMA_BASE_URL = PersistentConfig(
  2107. "RAG_OLLAMA_BASE_URL",
  2108. "rag.ollama.url",
  2109. os.getenv("RAG_OLLAMA_BASE_URL", OLLAMA_BASE_URL),
  2110. )
  2111. RAG_OLLAMA_API_KEY = PersistentConfig(
  2112. "RAG_OLLAMA_API_KEY",
  2113. "rag.ollama.key",
  2114. os.getenv("RAG_OLLAMA_API_KEY", ""),
  2115. )
  2116. ENABLE_RAG_LOCAL_WEB_FETCH = (
  2117. os.getenv("ENABLE_RAG_LOCAL_WEB_FETCH", "False").lower() == "true"
  2118. )
  2119. YOUTUBE_LOADER_LANGUAGE = PersistentConfig(
  2120. "YOUTUBE_LOADER_LANGUAGE",
  2121. "rag.youtube_loader_language",
  2122. os.getenv("YOUTUBE_LOADER_LANGUAGE", "en").split(","),
  2123. )
  2124. YOUTUBE_LOADER_PROXY_URL = PersistentConfig(
  2125. "YOUTUBE_LOADER_PROXY_URL",
  2126. "rag.youtube_loader_proxy_url",
  2127. os.getenv("YOUTUBE_LOADER_PROXY_URL", ""),
  2128. )
  2129. ####################################
  2130. # Web Search (RAG)
  2131. ####################################
  2132. ENABLE_WEB_SEARCH = PersistentConfig(
  2133. "ENABLE_WEB_SEARCH",
  2134. "rag.web.search.enable",
  2135. os.getenv("ENABLE_WEB_SEARCH", "False").lower() == "true",
  2136. )
  2137. WEB_SEARCH_ENGINE = PersistentConfig(
  2138. "WEB_SEARCH_ENGINE",
  2139. "rag.web.search.engine",
  2140. os.getenv("WEB_SEARCH_ENGINE", ""),
  2141. )
  2142. BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL = PersistentConfig(
  2143. "BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL",
  2144. "rag.web.search.bypass_embedding_and_retrieval",
  2145. os.getenv("BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL", "False").lower() == "true",
  2146. )
  2147. BYPASS_WEB_SEARCH_WEB_LOADER = PersistentConfig(
  2148. "BYPASS_WEB_SEARCH_WEB_LOADER",
  2149. "rag.web.search.bypass_web_loader",
  2150. os.getenv("BYPASS_WEB_SEARCH_WEB_LOADER", "False").lower() == "true",
  2151. )
  2152. WEB_SEARCH_RESULT_COUNT = PersistentConfig(
  2153. "WEB_SEARCH_RESULT_COUNT",
  2154. "rag.web.search.result_count",
  2155. int(os.getenv("WEB_SEARCH_RESULT_COUNT", "3")),
  2156. )
  2157. # You can provide a list of your own websites to filter after performing a web search.
  2158. # This ensures the highest level of safety and reliability of the information sources.
  2159. WEB_SEARCH_DOMAIN_FILTER_LIST = PersistentConfig(
  2160. "WEB_SEARCH_DOMAIN_FILTER_LIST",
  2161. "rag.web.search.domain.filter_list",
  2162. [
  2163. # "wikipedia.com",
  2164. # "wikimedia.org",
  2165. # "wikidata.org",
  2166. ],
  2167. )
  2168. WEB_SEARCH_CONCURRENT_REQUESTS = PersistentConfig(
  2169. "WEB_SEARCH_CONCURRENT_REQUESTS",
  2170. "rag.web.search.concurrent_requests",
  2171. int(os.getenv("WEB_SEARCH_CONCURRENT_REQUESTS", "10")),
  2172. )
  2173. WEB_LOADER_ENGINE = PersistentConfig(
  2174. "WEB_LOADER_ENGINE",
  2175. "rag.web.loader.engine",
  2176. os.environ.get("WEB_LOADER_ENGINE", ""),
  2177. )
  2178. WEB_LOADER_CONCURRENT_REQUESTS = PersistentConfig(
  2179. "WEB_LOADER_CONCURRENT_REQUESTS",
  2180. "rag.web.loader.concurrent_requests",
  2181. int(os.getenv("WEB_LOADER_CONCURRENT_REQUESTS", "10")),
  2182. )
  2183. ENABLE_WEB_LOADER_SSL_VERIFICATION = PersistentConfig(
  2184. "ENABLE_WEB_LOADER_SSL_VERIFICATION",
  2185. "rag.web.loader.ssl_verification",
  2186. os.environ.get("ENABLE_WEB_LOADER_SSL_VERIFICATION", "True").lower() == "true",
  2187. )
  2188. WEB_SEARCH_TRUST_ENV = PersistentConfig(
  2189. "WEB_SEARCH_TRUST_ENV",
  2190. "rag.web.search.trust_env",
  2191. os.getenv("WEB_SEARCH_TRUST_ENV", "False").lower() == "true",
  2192. )
  2193. SEARXNG_QUERY_URL = PersistentConfig(
  2194. "SEARXNG_QUERY_URL",
  2195. "rag.web.search.searxng_query_url",
  2196. os.getenv("SEARXNG_QUERY_URL", ""),
  2197. )
  2198. YACY_QUERY_URL = PersistentConfig(
  2199. "YACY_QUERY_URL",
  2200. "rag.web.search.yacy_query_url",
  2201. os.getenv("YACY_QUERY_URL", ""),
  2202. )
  2203. YACY_USERNAME = PersistentConfig(
  2204. "YACY_USERNAME",
  2205. "rag.web.search.yacy_username",
  2206. os.getenv("YACY_USERNAME", ""),
  2207. )
  2208. YACY_PASSWORD = PersistentConfig(
  2209. "YACY_PASSWORD",
  2210. "rag.web.search.yacy_password",
  2211. os.getenv("YACY_PASSWORD", ""),
  2212. )
  2213. GOOGLE_PSE_API_KEY = PersistentConfig(
  2214. "GOOGLE_PSE_API_KEY",
  2215. "rag.web.search.google_pse_api_key",
  2216. os.getenv("GOOGLE_PSE_API_KEY", ""),
  2217. )
  2218. GOOGLE_PSE_ENGINE_ID = PersistentConfig(
  2219. "GOOGLE_PSE_ENGINE_ID",
  2220. "rag.web.search.google_pse_engine_id",
  2221. os.getenv("GOOGLE_PSE_ENGINE_ID", ""),
  2222. )
  2223. BRAVE_SEARCH_API_KEY = PersistentConfig(
  2224. "BRAVE_SEARCH_API_KEY",
  2225. "rag.web.search.brave_search_api_key",
  2226. os.getenv("BRAVE_SEARCH_API_KEY", ""),
  2227. )
  2228. KAGI_SEARCH_API_KEY = PersistentConfig(
  2229. "KAGI_SEARCH_API_KEY",
  2230. "rag.web.search.kagi_search_api_key",
  2231. os.getenv("KAGI_SEARCH_API_KEY", ""),
  2232. )
  2233. MOJEEK_SEARCH_API_KEY = PersistentConfig(
  2234. "MOJEEK_SEARCH_API_KEY",
  2235. "rag.web.search.mojeek_search_api_key",
  2236. os.getenv("MOJEEK_SEARCH_API_KEY", ""),
  2237. )
  2238. BOCHA_SEARCH_API_KEY = PersistentConfig(
  2239. "BOCHA_SEARCH_API_KEY",
  2240. "rag.web.search.bocha_search_api_key",
  2241. os.getenv("BOCHA_SEARCH_API_KEY", ""),
  2242. )
  2243. SERPSTACK_API_KEY = PersistentConfig(
  2244. "SERPSTACK_API_KEY",
  2245. "rag.web.search.serpstack_api_key",
  2246. os.getenv("SERPSTACK_API_KEY", ""),
  2247. )
  2248. SERPSTACK_HTTPS = PersistentConfig(
  2249. "SERPSTACK_HTTPS",
  2250. "rag.web.search.serpstack_https",
  2251. os.getenv("SERPSTACK_HTTPS", "True").lower() == "true",
  2252. )
  2253. SERPER_API_KEY = PersistentConfig(
  2254. "SERPER_API_KEY",
  2255. "rag.web.search.serper_api_key",
  2256. os.getenv("SERPER_API_KEY", ""),
  2257. )
  2258. SERPLY_API_KEY = PersistentConfig(
  2259. "SERPLY_API_KEY",
  2260. "rag.web.search.serply_api_key",
  2261. os.getenv("SERPLY_API_KEY", ""),
  2262. )
  2263. JINA_API_KEY = PersistentConfig(
  2264. "JINA_API_KEY",
  2265. "rag.web.search.jina_api_key",
  2266. os.getenv("JINA_API_KEY", ""),
  2267. )
  2268. SEARCHAPI_API_KEY = PersistentConfig(
  2269. "SEARCHAPI_API_KEY",
  2270. "rag.web.search.searchapi_api_key",
  2271. os.getenv("SEARCHAPI_API_KEY", ""),
  2272. )
  2273. SEARCHAPI_ENGINE = PersistentConfig(
  2274. "SEARCHAPI_ENGINE",
  2275. "rag.web.search.searchapi_engine",
  2276. os.getenv("SEARCHAPI_ENGINE", ""),
  2277. )
  2278. SERPAPI_API_KEY = PersistentConfig(
  2279. "SERPAPI_API_KEY",
  2280. "rag.web.search.serpapi_api_key",
  2281. os.getenv("SERPAPI_API_KEY", ""),
  2282. )
  2283. SERPAPI_ENGINE = PersistentConfig(
  2284. "SERPAPI_ENGINE",
  2285. "rag.web.search.serpapi_engine",
  2286. os.getenv("SERPAPI_ENGINE", ""),
  2287. )
  2288. BING_SEARCH_V7_ENDPOINT = PersistentConfig(
  2289. "BING_SEARCH_V7_ENDPOINT",
  2290. "rag.web.search.bing_search_v7_endpoint",
  2291. os.environ.get(
  2292. "BING_SEARCH_V7_ENDPOINT", "https://api.bing.microsoft.com/v7.0/search"
  2293. ),
  2294. )
  2295. BING_SEARCH_V7_SUBSCRIPTION_KEY = PersistentConfig(
  2296. "BING_SEARCH_V7_SUBSCRIPTION_KEY",
  2297. "rag.web.search.bing_search_v7_subscription_key",
  2298. os.environ.get("BING_SEARCH_V7_SUBSCRIPTION_KEY", ""),
  2299. )
  2300. EXA_API_KEY = PersistentConfig(
  2301. "EXA_API_KEY",
  2302. "rag.web.search.exa_api_key",
  2303. os.getenv("EXA_API_KEY", ""),
  2304. )
  2305. PERPLEXITY_API_KEY = PersistentConfig(
  2306. "PERPLEXITY_API_KEY",
  2307. "rag.web.search.perplexity_api_key",
  2308. os.getenv("PERPLEXITY_API_KEY", ""),
  2309. )
  2310. PERPLEXITY_MODEL = PersistentConfig(
  2311. "PERPLEXITY_MODEL",
  2312. "rag.web.search.perplexity_model",
  2313. os.getenv("PERPLEXITY_MODEL", "sonar"),
  2314. )
  2315. PERPLEXITY_SEARCH_CONTEXT_USAGE = PersistentConfig(
  2316. "PERPLEXITY_SEARCH_CONTEXT_USAGE",
  2317. "rag.web.search.perplexity_search_context_usage",
  2318. os.getenv("PERPLEXITY_SEARCH_CONTEXT_USAGE", "medium"),
  2319. )
  2320. SOUGOU_API_SID = PersistentConfig(
  2321. "SOUGOU_API_SID",
  2322. "rag.web.search.sougou_api_sid",
  2323. os.getenv("SOUGOU_API_SID", ""),
  2324. )
  2325. SOUGOU_API_SK = PersistentConfig(
  2326. "SOUGOU_API_SK",
  2327. "rag.web.search.sougou_api_sk",
  2328. os.getenv("SOUGOU_API_SK", ""),
  2329. )
  2330. TAVILY_API_KEY = PersistentConfig(
  2331. "TAVILY_API_KEY",
  2332. "rag.web.search.tavily_api_key",
  2333. os.getenv("TAVILY_API_KEY", ""),
  2334. )
  2335. TAVILY_EXTRACT_DEPTH = PersistentConfig(
  2336. "TAVILY_EXTRACT_DEPTH",
  2337. "rag.web.search.tavily_extract_depth",
  2338. os.getenv("TAVILY_EXTRACT_DEPTH", "basic"),
  2339. )
  2340. PLAYWRIGHT_WS_URL = PersistentConfig(
  2341. "PLAYWRIGHT_WS_URL",
  2342. "rag.web.loader.playwright_ws_url",
  2343. os.environ.get("PLAYWRIGHT_WS_URL", ""),
  2344. )
  2345. PLAYWRIGHT_TIMEOUT = PersistentConfig(
  2346. "PLAYWRIGHT_TIMEOUT",
  2347. "rag.web.loader.playwright_timeout",
  2348. int(os.environ.get("PLAYWRIGHT_TIMEOUT", "10000")),
  2349. )
  2350. FIRECRAWL_API_KEY = PersistentConfig(
  2351. "FIRECRAWL_API_KEY",
  2352. "rag.web.loader.firecrawl_api_key",
  2353. os.environ.get("FIRECRAWL_API_KEY", ""),
  2354. )
  2355. FIRECRAWL_API_BASE_URL = PersistentConfig(
  2356. "FIRECRAWL_API_BASE_URL",
  2357. "rag.web.loader.firecrawl_api_url",
  2358. os.environ.get("FIRECRAWL_API_BASE_URL", "https://api.firecrawl.dev"),
  2359. )
  2360. EXTERNAL_WEB_SEARCH_URL = PersistentConfig(
  2361. "EXTERNAL_WEB_SEARCH_URL",
  2362. "rag.web.search.external_web_search_url",
  2363. os.environ.get("EXTERNAL_WEB_SEARCH_URL", ""),
  2364. )
  2365. EXTERNAL_WEB_SEARCH_API_KEY = PersistentConfig(
  2366. "EXTERNAL_WEB_SEARCH_API_KEY",
  2367. "rag.web.search.external_web_search_api_key",
  2368. os.environ.get("EXTERNAL_WEB_SEARCH_API_KEY", ""),
  2369. )
  2370. EXTERNAL_WEB_LOADER_URL = PersistentConfig(
  2371. "EXTERNAL_WEB_LOADER_URL",
  2372. "rag.web.loader.external_web_loader_url",
  2373. os.environ.get("EXTERNAL_WEB_LOADER_URL", ""),
  2374. )
  2375. EXTERNAL_WEB_LOADER_API_KEY = PersistentConfig(
  2376. "EXTERNAL_WEB_LOADER_API_KEY",
  2377. "rag.web.loader.external_web_loader_api_key",
  2378. os.environ.get("EXTERNAL_WEB_LOADER_API_KEY", ""),
  2379. )
  2380. ####################################
  2381. # Images
  2382. ####################################
  2383. IMAGE_GENERATION_ENGINE = PersistentConfig(
  2384. "IMAGE_GENERATION_ENGINE",
  2385. "image_generation.engine",
  2386. os.getenv("IMAGE_GENERATION_ENGINE", "openai"),
  2387. )
  2388. ENABLE_IMAGE_GENERATION = PersistentConfig(
  2389. "ENABLE_IMAGE_GENERATION",
  2390. "image_generation.enable",
  2391. os.environ.get("ENABLE_IMAGE_GENERATION", "").lower() == "true",
  2392. )
  2393. ENABLE_IMAGE_PROMPT_GENERATION = PersistentConfig(
  2394. "ENABLE_IMAGE_PROMPT_GENERATION",
  2395. "image_generation.prompt.enable",
  2396. os.environ.get("ENABLE_IMAGE_PROMPT_GENERATION", "true").lower() == "true",
  2397. )
  2398. AUTOMATIC1111_BASE_URL = PersistentConfig(
  2399. "AUTOMATIC1111_BASE_URL",
  2400. "image_generation.automatic1111.base_url",
  2401. os.getenv("AUTOMATIC1111_BASE_URL", ""),
  2402. )
  2403. AUTOMATIC1111_API_AUTH = PersistentConfig(
  2404. "AUTOMATIC1111_API_AUTH",
  2405. "image_generation.automatic1111.api_auth",
  2406. os.getenv("AUTOMATIC1111_API_AUTH", ""),
  2407. )
  2408. AUTOMATIC1111_CFG_SCALE = PersistentConfig(
  2409. "AUTOMATIC1111_CFG_SCALE",
  2410. "image_generation.automatic1111.cfg_scale",
  2411. (
  2412. float(os.environ.get("AUTOMATIC1111_CFG_SCALE"))
  2413. if os.environ.get("AUTOMATIC1111_CFG_SCALE")
  2414. else None
  2415. ),
  2416. )
  2417. AUTOMATIC1111_SAMPLER = PersistentConfig(
  2418. "AUTOMATIC1111_SAMPLER",
  2419. "image_generation.automatic1111.sampler",
  2420. (
  2421. os.environ.get("AUTOMATIC1111_SAMPLER")
  2422. if os.environ.get("AUTOMATIC1111_SAMPLER")
  2423. else None
  2424. ),
  2425. )
  2426. AUTOMATIC1111_SCHEDULER = PersistentConfig(
  2427. "AUTOMATIC1111_SCHEDULER",
  2428. "image_generation.automatic1111.scheduler",
  2429. (
  2430. os.environ.get("AUTOMATIC1111_SCHEDULER")
  2431. if os.environ.get("AUTOMATIC1111_SCHEDULER")
  2432. else None
  2433. ),
  2434. )
  2435. COMFYUI_BASE_URL = PersistentConfig(
  2436. "COMFYUI_BASE_URL",
  2437. "image_generation.comfyui.base_url",
  2438. os.getenv("COMFYUI_BASE_URL", ""),
  2439. )
  2440. COMFYUI_API_KEY = PersistentConfig(
  2441. "COMFYUI_API_KEY",
  2442. "image_generation.comfyui.api_key",
  2443. os.getenv("COMFYUI_API_KEY", ""),
  2444. )
  2445. COMFYUI_DEFAULT_WORKFLOW = """
  2446. {
  2447. "3": {
  2448. "inputs": {
  2449. "seed": 0,
  2450. "steps": 20,
  2451. "cfg": 8,
  2452. "sampler_name": "euler",
  2453. "scheduler": "normal",
  2454. "denoise": 1,
  2455. "model": [
  2456. "4",
  2457. 0
  2458. ],
  2459. "positive": [
  2460. "6",
  2461. 0
  2462. ],
  2463. "negative": [
  2464. "7",
  2465. 0
  2466. ],
  2467. "latent_image": [
  2468. "5",
  2469. 0
  2470. ]
  2471. },
  2472. "class_type": "KSampler",
  2473. "_meta": {
  2474. "title": "KSampler"
  2475. }
  2476. },
  2477. "4": {
  2478. "inputs": {
  2479. "ckpt_name": "model.safetensors"
  2480. },
  2481. "class_type": "CheckpointLoaderSimple",
  2482. "_meta": {
  2483. "title": "Load Checkpoint"
  2484. }
  2485. },
  2486. "5": {
  2487. "inputs": {
  2488. "width": 512,
  2489. "height": 512,
  2490. "batch_size": 1
  2491. },
  2492. "class_type": "EmptyLatentImage",
  2493. "_meta": {
  2494. "title": "Empty Latent Image"
  2495. }
  2496. },
  2497. "6": {
  2498. "inputs": {
  2499. "text": "Prompt",
  2500. "clip": [
  2501. "4",
  2502. 1
  2503. ]
  2504. },
  2505. "class_type": "CLIPTextEncode",
  2506. "_meta": {
  2507. "title": "CLIP Text Encode (Prompt)"
  2508. }
  2509. },
  2510. "7": {
  2511. "inputs": {
  2512. "text": "",
  2513. "clip": [
  2514. "4",
  2515. 1
  2516. ]
  2517. },
  2518. "class_type": "CLIPTextEncode",
  2519. "_meta": {
  2520. "title": "CLIP Text Encode (Prompt)"
  2521. }
  2522. },
  2523. "8": {
  2524. "inputs": {
  2525. "samples": [
  2526. "3",
  2527. 0
  2528. ],
  2529. "vae": [
  2530. "4",
  2531. 2
  2532. ]
  2533. },
  2534. "class_type": "VAEDecode",
  2535. "_meta": {
  2536. "title": "VAE Decode"
  2537. }
  2538. },
  2539. "9": {
  2540. "inputs": {
  2541. "filename_prefix": "ComfyUI",
  2542. "images": [
  2543. "8",
  2544. 0
  2545. ]
  2546. },
  2547. "class_type": "SaveImage",
  2548. "_meta": {
  2549. "title": "Save Image"
  2550. }
  2551. }
  2552. }
  2553. """
  2554. COMFYUI_WORKFLOW = PersistentConfig(
  2555. "COMFYUI_WORKFLOW",
  2556. "image_generation.comfyui.workflow",
  2557. os.getenv("COMFYUI_WORKFLOW", COMFYUI_DEFAULT_WORKFLOW),
  2558. )
  2559. COMFYUI_WORKFLOW_NODES = PersistentConfig(
  2560. "COMFYUI_WORKFLOW",
  2561. "image_generation.comfyui.nodes",
  2562. [],
  2563. )
  2564. IMAGES_OPENAI_API_BASE_URL = PersistentConfig(
  2565. "IMAGES_OPENAI_API_BASE_URL",
  2566. "image_generation.openai.api_base_url",
  2567. os.getenv("IMAGES_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  2568. )
  2569. IMAGES_OPENAI_API_KEY = PersistentConfig(
  2570. "IMAGES_OPENAI_API_KEY",
  2571. "image_generation.openai.api_key",
  2572. os.getenv("IMAGES_OPENAI_API_KEY", OPENAI_API_KEY),
  2573. )
  2574. IMAGES_GEMINI_API_BASE_URL = PersistentConfig(
  2575. "IMAGES_GEMINI_API_BASE_URL",
  2576. "image_generation.gemini.api_base_url",
  2577. os.getenv("IMAGES_GEMINI_API_BASE_URL", GEMINI_API_BASE_URL),
  2578. )
  2579. IMAGES_GEMINI_API_KEY = PersistentConfig(
  2580. "IMAGES_GEMINI_API_KEY",
  2581. "image_generation.gemini.api_key",
  2582. os.getenv("IMAGES_GEMINI_API_KEY", GEMINI_API_KEY),
  2583. )
  2584. IMAGE_SIZE = PersistentConfig(
  2585. "IMAGE_SIZE", "image_generation.size", os.getenv("IMAGE_SIZE", "512x512")
  2586. )
  2587. IMAGE_STEPS = PersistentConfig(
  2588. "IMAGE_STEPS", "image_generation.steps", int(os.getenv("IMAGE_STEPS", 50))
  2589. )
  2590. IMAGE_GENERATION_MODEL = PersistentConfig(
  2591. "IMAGE_GENERATION_MODEL",
  2592. "image_generation.model",
  2593. os.getenv("IMAGE_GENERATION_MODEL", ""),
  2594. )
  2595. ####################################
  2596. # Audio
  2597. ####################################
  2598. # Transcription
  2599. WHISPER_MODEL = PersistentConfig(
  2600. "WHISPER_MODEL",
  2601. "audio.stt.whisper_model",
  2602. os.getenv("WHISPER_MODEL", "base"),
  2603. )
  2604. WHISPER_MODEL_DIR = os.getenv("WHISPER_MODEL_DIR", f"{CACHE_DIR}/whisper/models")
  2605. WHISPER_MODEL_AUTO_UPDATE = (
  2606. not OFFLINE_MODE
  2607. and os.environ.get("WHISPER_MODEL_AUTO_UPDATE", "").lower() == "true"
  2608. )
  2609. WHISPER_VAD_FILTER = PersistentConfig(
  2610. "WHISPER_VAD_FILTER",
  2611. "audio.stt.whisper_vad_filter",
  2612. os.getenv("WHISPER_VAD_FILTER", "False").lower() == "true",
  2613. )
  2614. WHISPER_LANGUAGE = os.getenv("WHISPER_LANGUAGE", "").lower() or None
  2615. # Add Deepgram configuration
  2616. DEEPGRAM_API_KEY = PersistentConfig(
  2617. "DEEPGRAM_API_KEY",
  2618. "audio.stt.deepgram.api_key",
  2619. os.getenv("DEEPGRAM_API_KEY", ""),
  2620. )
  2621. AUDIO_STT_OPENAI_API_BASE_URL = PersistentConfig(
  2622. "AUDIO_STT_OPENAI_API_BASE_URL",
  2623. "audio.stt.openai.api_base_url",
  2624. os.getenv("AUDIO_STT_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  2625. )
  2626. AUDIO_STT_OPENAI_API_KEY = PersistentConfig(
  2627. "AUDIO_STT_OPENAI_API_KEY",
  2628. "audio.stt.openai.api_key",
  2629. os.getenv("AUDIO_STT_OPENAI_API_KEY", OPENAI_API_KEY),
  2630. )
  2631. AUDIO_STT_ENGINE = PersistentConfig(
  2632. "AUDIO_STT_ENGINE",
  2633. "audio.stt.engine",
  2634. os.getenv("AUDIO_STT_ENGINE", ""),
  2635. )
  2636. AUDIO_STT_MODEL = PersistentConfig(
  2637. "AUDIO_STT_MODEL",
  2638. "audio.stt.model",
  2639. os.getenv("AUDIO_STT_MODEL", ""),
  2640. )
  2641. AUDIO_STT_SUPPORTED_CONTENT_TYPES = PersistentConfig(
  2642. "AUDIO_STT_SUPPORTED_CONTENT_TYPES",
  2643. "audio.stt.supported_content_types",
  2644. [
  2645. content_type.strip()
  2646. for content_type in os.environ.get(
  2647. "AUDIO_STT_SUPPORTED_CONTENT_TYPES", ""
  2648. ).split(",")
  2649. if content_type.strip()
  2650. ],
  2651. )
  2652. AUDIO_STT_AZURE_API_KEY = PersistentConfig(
  2653. "AUDIO_STT_AZURE_API_KEY",
  2654. "audio.stt.azure.api_key",
  2655. os.getenv("AUDIO_STT_AZURE_API_KEY", ""),
  2656. )
  2657. AUDIO_STT_AZURE_REGION = PersistentConfig(
  2658. "AUDIO_STT_AZURE_REGION",
  2659. "audio.stt.azure.region",
  2660. os.getenv("AUDIO_STT_AZURE_REGION", ""),
  2661. )
  2662. AUDIO_STT_AZURE_LOCALES = PersistentConfig(
  2663. "AUDIO_STT_AZURE_LOCALES",
  2664. "audio.stt.azure.locales",
  2665. os.getenv("AUDIO_STT_AZURE_LOCALES", ""),
  2666. )
  2667. AUDIO_STT_AZURE_BASE_URL = PersistentConfig(
  2668. "AUDIO_STT_AZURE_BASE_URL",
  2669. "audio.stt.azure.base_url",
  2670. os.getenv("AUDIO_STT_AZURE_BASE_URL", ""),
  2671. )
  2672. AUDIO_STT_AZURE_MAX_SPEAKERS = PersistentConfig(
  2673. "AUDIO_STT_AZURE_MAX_SPEAKERS",
  2674. "audio.stt.azure.max_speakers",
  2675. os.getenv("AUDIO_STT_AZURE_MAX_SPEAKERS", ""),
  2676. )
  2677. AUDIO_TTS_OPENAI_API_BASE_URL = PersistentConfig(
  2678. "AUDIO_TTS_OPENAI_API_BASE_URL",
  2679. "audio.tts.openai.api_base_url",
  2680. os.getenv("AUDIO_TTS_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  2681. )
  2682. AUDIO_TTS_OPENAI_API_KEY = PersistentConfig(
  2683. "AUDIO_TTS_OPENAI_API_KEY",
  2684. "audio.tts.openai.api_key",
  2685. os.getenv("AUDIO_TTS_OPENAI_API_KEY", OPENAI_API_KEY),
  2686. )
  2687. AUDIO_TTS_API_KEY = PersistentConfig(
  2688. "AUDIO_TTS_API_KEY",
  2689. "audio.tts.api_key",
  2690. os.getenv("AUDIO_TTS_API_KEY", ""),
  2691. )
  2692. AUDIO_TTS_ENGINE = PersistentConfig(
  2693. "AUDIO_TTS_ENGINE",
  2694. "audio.tts.engine",
  2695. os.getenv("AUDIO_TTS_ENGINE", ""),
  2696. )
  2697. AUDIO_TTS_MODEL = PersistentConfig(
  2698. "AUDIO_TTS_MODEL",
  2699. "audio.tts.model",
  2700. os.getenv("AUDIO_TTS_MODEL", "tts-1"), # OpenAI default model
  2701. )
  2702. AUDIO_TTS_VOICE = PersistentConfig(
  2703. "AUDIO_TTS_VOICE",
  2704. "audio.tts.voice",
  2705. os.getenv("AUDIO_TTS_VOICE", "alloy"), # OpenAI default voice
  2706. )
  2707. AUDIO_TTS_SPLIT_ON = PersistentConfig(
  2708. "AUDIO_TTS_SPLIT_ON",
  2709. "audio.tts.split_on",
  2710. os.getenv("AUDIO_TTS_SPLIT_ON", "punctuation"),
  2711. )
  2712. AUDIO_TTS_AZURE_SPEECH_REGION = PersistentConfig(
  2713. "AUDIO_TTS_AZURE_SPEECH_REGION",
  2714. "audio.tts.azure.speech_region",
  2715. os.getenv("AUDIO_TTS_AZURE_SPEECH_REGION", ""),
  2716. )
  2717. AUDIO_TTS_AZURE_SPEECH_BASE_URL = PersistentConfig(
  2718. "AUDIO_TTS_AZURE_SPEECH_BASE_URL",
  2719. "audio.tts.azure.speech_base_url",
  2720. os.getenv("AUDIO_TTS_AZURE_SPEECH_BASE_URL", ""),
  2721. )
  2722. AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT = PersistentConfig(
  2723. "AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT",
  2724. "audio.tts.azure.speech_output_format",
  2725. os.getenv(
  2726. "AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT", "audio-24khz-160kbitrate-mono-mp3"
  2727. ),
  2728. )
  2729. ####################################
  2730. # LDAP
  2731. ####################################
  2732. ENABLE_LDAP = PersistentConfig(
  2733. "ENABLE_LDAP",
  2734. "ldap.enable",
  2735. os.environ.get("ENABLE_LDAP", "false").lower() == "true",
  2736. )
  2737. LDAP_SERVER_LABEL = PersistentConfig(
  2738. "LDAP_SERVER_LABEL",
  2739. "ldap.server.label",
  2740. os.environ.get("LDAP_SERVER_LABEL", "LDAP Server"),
  2741. )
  2742. LDAP_SERVER_HOST = PersistentConfig(
  2743. "LDAP_SERVER_HOST",
  2744. "ldap.server.host",
  2745. os.environ.get("LDAP_SERVER_HOST", "localhost"),
  2746. )
  2747. LDAP_SERVER_PORT = PersistentConfig(
  2748. "LDAP_SERVER_PORT",
  2749. "ldap.server.port",
  2750. int(os.environ.get("LDAP_SERVER_PORT", "389")),
  2751. )
  2752. LDAP_ATTRIBUTE_FOR_MAIL = PersistentConfig(
  2753. "LDAP_ATTRIBUTE_FOR_MAIL",
  2754. "ldap.server.attribute_for_mail",
  2755. os.environ.get("LDAP_ATTRIBUTE_FOR_MAIL", "mail"),
  2756. )
  2757. LDAP_ATTRIBUTE_FOR_USERNAME = PersistentConfig(
  2758. "LDAP_ATTRIBUTE_FOR_USERNAME",
  2759. "ldap.server.attribute_for_username",
  2760. os.environ.get("LDAP_ATTRIBUTE_FOR_USERNAME", "uid"),
  2761. )
  2762. LDAP_APP_DN = PersistentConfig(
  2763. "LDAP_APP_DN", "ldap.server.app_dn", os.environ.get("LDAP_APP_DN", "")
  2764. )
  2765. LDAP_APP_PASSWORD = PersistentConfig(
  2766. "LDAP_APP_PASSWORD",
  2767. "ldap.server.app_password",
  2768. os.environ.get("LDAP_APP_PASSWORD", ""),
  2769. )
  2770. LDAP_SEARCH_BASE = PersistentConfig(
  2771. "LDAP_SEARCH_BASE", "ldap.server.users_dn", os.environ.get("LDAP_SEARCH_BASE", "")
  2772. )
  2773. LDAP_SEARCH_FILTERS = PersistentConfig(
  2774. "LDAP_SEARCH_FILTER",
  2775. "ldap.server.search_filter",
  2776. os.environ.get("LDAP_SEARCH_FILTER", os.environ.get("LDAP_SEARCH_FILTERS", "")),
  2777. )
  2778. LDAP_USE_TLS = PersistentConfig(
  2779. "LDAP_USE_TLS",
  2780. "ldap.server.use_tls",
  2781. os.environ.get("LDAP_USE_TLS", "True").lower() == "true",
  2782. )
  2783. LDAP_CA_CERT_FILE = PersistentConfig(
  2784. "LDAP_CA_CERT_FILE",
  2785. "ldap.server.ca_cert_file",
  2786. os.environ.get("LDAP_CA_CERT_FILE", ""),
  2787. )
  2788. LDAP_VALIDATE_CERT = PersistentConfig(
  2789. "LDAP_VALIDATE_CERT",
  2790. "ldap.server.validate_cert",
  2791. os.environ.get("LDAP_VALIDATE_CERT", "True").lower() == "true",
  2792. )
  2793. LDAP_CIPHERS = PersistentConfig(
  2794. "LDAP_CIPHERS", "ldap.server.ciphers", os.environ.get("LDAP_CIPHERS", "ALL")
  2795. )
  2796. # For LDAP Group Management
  2797. ENABLE_LDAP_GROUP_MANAGEMENT = PersistentConfig(
  2798. "ENABLE_LDAP_GROUP_MANAGEMENT",
  2799. "ldap.group.enable_management",
  2800. os.environ.get("ENABLE_LDAP_GROUP_MANAGEMENT", "False").lower() == "true",
  2801. )
  2802. ENABLE_LDAP_GROUP_CREATION = PersistentConfig(
  2803. "ENABLE_LDAP_GROUP_CREATION",
  2804. "ldap.group.enable_creation",
  2805. os.environ.get("ENABLE_LDAP_GROUP_CREATION", "False").lower() == "true",
  2806. )
  2807. LDAP_ATTRIBUTE_FOR_GROUPS = PersistentConfig(
  2808. "LDAP_ATTRIBUTE_FOR_GROUPS",
  2809. "ldap.server.attribute_for_groups",
  2810. os.environ.get("LDAP_ATTRIBUTE_FOR_GROUPS", "memberOf"),
  2811. )