config.py 62 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140
  1. import json
  2. import logging
  3. import os
  4. import shutil
  5. from datetime import datetime
  6. from pathlib import Path
  7. from typing import Generic, Optional, TypeVar
  8. from urllib.parse import urlparse
  9. import chromadb
  10. import requests
  11. from pydantic import BaseModel
  12. from sqlalchemy import JSON, Column, DateTime, Integer, func
  13. from open_webui.env import (
  14. DATA_DIR,
  15. DATABASE_URL,
  16. ENV,
  17. FRONTEND_BUILD_DIR,
  18. OFFLINE_MODE,
  19. OPEN_WEBUI_DIR,
  20. WEBUI_AUTH,
  21. WEBUI_FAVICON_URL,
  22. WEBUI_NAME,
  23. log,
  24. )
  25. from open_webui.internal.db import Base, get_db
  26. class EndpointFilter(logging.Filter):
  27. def filter(self, record: logging.LogRecord) -> bool:
  28. return record.getMessage().find("/health") == -1
  29. # Filter out /endpoint
  30. logging.getLogger("uvicorn.access").addFilter(EndpointFilter())
  31. ####################################
  32. # Config helpers
  33. ####################################
  34. # Function to run the alembic migrations
  35. def run_migrations():
  36. print("Running migrations")
  37. try:
  38. from alembic import command
  39. from alembic.config import Config
  40. alembic_cfg = Config(OPEN_WEBUI_DIR / "alembic.ini")
  41. # Set the script location dynamically
  42. migrations_path = OPEN_WEBUI_DIR / "migrations"
  43. alembic_cfg.set_main_option("script_location", str(migrations_path))
  44. command.upgrade(alembic_cfg, "head")
  45. except Exception as e:
  46. print(f"Error: {e}")
  47. run_migrations()
  48. class Config(Base):
  49. __tablename__ = "config"
  50. id = Column(Integer, primary_key=True)
  51. data = Column(JSON, nullable=False)
  52. version = Column(Integer, nullable=False, default=0)
  53. created_at = Column(DateTime, nullable=False, server_default=func.now())
  54. updated_at = Column(DateTime, nullable=True, onupdate=func.now())
  55. def load_json_config():
  56. with open(f"{DATA_DIR}/config.json", "r") as file:
  57. return json.load(file)
  58. def save_to_db(data):
  59. with get_db() as db:
  60. existing_config = db.query(Config).first()
  61. if not existing_config:
  62. new_config = Config(data=data, version=0)
  63. db.add(new_config)
  64. else:
  65. existing_config.data = data
  66. existing_config.updated_at = datetime.now()
  67. db.add(existing_config)
  68. db.commit()
  69. def reset_config():
  70. with get_db() as db:
  71. db.query(Config).delete()
  72. db.commit()
  73. # When initializing, check if config.json exists and migrate it to the database
  74. if os.path.exists(f"{DATA_DIR}/config.json"):
  75. data = load_json_config()
  76. save_to_db(data)
  77. os.rename(f"{DATA_DIR}/config.json", f"{DATA_DIR}/old_config.json")
  78. DEFAULT_CONFIG = {
  79. "version": 0,
  80. "ui": {
  81. "default_locale": "",
  82. "prompt_suggestions": [
  83. {
  84. "title": [
  85. "Help me study",
  86. "vocabulary for a college entrance exam",
  87. ],
  88. "content": "Help me study vocabulary: write a sentence for me to fill in the blank, and I'll try to pick the correct option.",
  89. },
  90. {
  91. "title": [
  92. "Give me ideas",
  93. "for what to do with my kids' art",
  94. ],
  95. "content": "What are 5 creative things I could do with my kids' art? I don't want to throw them away, but it's also so much clutter.",
  96. },
  97. {
  98. "title": ["Tell me a fun fact", "about the Roman Empire"],
  99. "content": "Tell me a random fun fact about the Roman Empire",
  100. },
  101. {
  102. "title": [
  103. "Show me a code snippet",
  104. "of a website's sticky header",
  105. ],
  106. "content": "Show me a code snippet of a website's sticky header in CSS and JavaScript.",
  107. },
  108. {
  109. "title": [
  110. "Explain options trading",
  111. "if I'm familiar with buying and selling stocks",
  112. ],
  113. "content": "Explain options trading in simple terms if I'm familiar with buying and selling stocks.",
  114. },
  115. {
  116. "title": ["Overcome procrastination", "give me tips"],
  117. "content": "Could you start by asking me about instances when I procrastinate the most and then give me some suggestions to overcome it?",
  118. },
  119. {
  120. "title": [
  121. "Grammar check",
  122. "rewrite it for better readability ",
  123. ],
  124. "content": 'Check the following sentence for grammar and clarity: "[sentence]". Rewrite it for better readability while maintaining its original meaning.',
  125. },
  126. ],
  127. },
  128. }
  129. def get_config():
  130. with get_db() as db:
  131. config_entry = db.query(Config).order_by(Config.id.desc()).first()
  132. return config_entry.data if config_entry else DEFAULT_CONFIG
  133. CONFIG_DATA = get_config()
  134. def get_config_value(config_path: str):
  135. path_parts = config_path.split(".")
  136. cur_config = CONFIG_DATA
  137. for key in path_parts:
  138. if key in cur_config:
  139. cur_config = cur_config[key]
  140. else:
  141. return None
  142. return cur_config
  143. PERSISTENT_CONFIG_REGISTRY = []
  144. def save_config(config):
  145. global CONFIG_DATA
  146. global PERSISTENT_CONFIG_REGISTRY
  147. try:
  148. save_to_db(config)
  149. CONFIG_DATA = config
  150. # Trigger updates on all registered PersistentConfig entries
  151. for config_item in PERSISTENT_CONFIG_REGISTRY:
  152. config_item.update()
  153. except Exception as e:
  154. log.exception(e)
  155. return False
  156. return True
  157. T = TypeVar("T")
  158. class PersistentConfig(Generic[T]):
  159. def __init__(self, env_name: str, config_path: str, env_value: T):
  160. self.env_name = env_name
  161. self.config_path = config_path
  162. self.env_value = env_value
  163. self.config_value = get_config_value(config_path)
  164. if self.config_value is not None:
  165. log.info(f"'{env_name}' loaded from the latest database entry")
  166. self.value = self.config_value
  167. else:
  168. self.value = env_value
  169. PERSISTENT_CONFIG_REGISTRY.append(self)
  170. def __str__(self):
  171. return str(self.value)
  172. @property
  173. def __dict__(self):
  174. raise TypeError(
  175. "PersistentConfig object cannot be converted to dict, use config_get or .value instead."
  176. )
  177. def __getattribute__(self, item):
  178. if item == "__dict__":
  179. raise TypeError(
  180. "PersistentConfig object cannot be converted to dict, use config_get or .value instead."
  181. )
  182. return super().__getattribute__(item)
  183. def update(self):
  184. new_value = get_config_value(self.config_path)
  185. if new_value is not None:
  186. self.value = new_value
  187. log.info(f"Updated {self.env_name} to new value {self.value}")
  188. def save(self):
  189. log.info(f"Saving '{self.env_name}' to the database")
  190. path_parts = self.config_path.split(".")
  191. sub_config = CONFIG_DATA
  192. for key in path_parts[:-1]:
  193. if key not in sub_config:
  194. sub_config[key] = {}
  195. sub_config = sub_config[key]
  196. sub_config[path_parts[-1]] = self.value
  197. save_to_db(CONFIG_DATA)
  198. self.config_value = self.value
  199. class AppConfig:
  200. _state: dict[str, PersistentConfig]
  201. def __init__(self):
  202. super().__setattr__("_state", {})
  203. def __setattr__(self, key, value):
  204. if isinstance(value, PersistentConfig):
  205. self._state[key] = value
  206. else:
  207. self._state[key].value = value
  208. self._state[key].save()
  209. def __getattr__(self, key):
  210. return self._state[key].value
  211. ####################################
  212. # WEBUI_AUTH (Required for security)
  213. ####################################
  214. ENABLE_API_KEY = PersistentConfig(
  215. "ENABLE_API_KEY",
  216. "auth.api_key.enable",
  217. os.environ.get("ENABLE_API_KEY", "True").lower() == "true",
  218. )
  219. ENABLE_API_KEY_ENDPOINT_RESTRICTIONS = PersistentConfig(
  220. "ENABLE_API_KEY_ENDPOINT_RESTRICTIONS",
  221. "auth.api_key.endpoint_restrictions",
  222. os.environ.get("ENABLE_API_KEY_ENDPOINT_RESTRICTIONS", "False").lower() == "true",
  223. )
  224. API_KEY_ALLOWED_ENDPOINTS = PersistentConfig(
  225. "API_KEY_ALLOWED_ENDPOINTS",
  226. "auth.api_key.allowed_endpoints",
  227. os.environ.get("API_KEY_ALLOWED_ENDPOINTS", ""),
  228. )
  229. JWT_EXPIRES_IN = PersistentConfig(
  230. "JWT_EXPIRES_IN", "auth.jwt_expiry", os.environ.get("JWT_EXPIRES_IN", "-1")
  231. )
  232. ####################################
  233. # OAuth config
  234. ####################################
  235. ENABLE_OAUTH_SIGNUP = PersistentConfig(
  236. "ENABLE_OAUTH_SIGNUP",
  237. "oauth.enable_signup",
  238. os.environ.get("ENABLE_OAUTH_SIGNUP", "False").lower() == "true",
  239. )
  240. OAUTH_MERGE_ACCOUNTS_BY_EMAIL = PersistentConfig(
  241. "OAUTH_MERGE_ACCOUNTS_BY_EMAIL",
  242. "oauth.merge_accounts_by_email",
  243. os.environ.get("OAUTH_MERGE_ACCOUNTS_BY_EMAIL", "False").lower() == "true",
  244. )
  245. OAUTH_PROVIDERS = {}
  246. GOOGLE_CLIENT_ID = PersistentConfig(
  247. "GOOGLE_CLIENT_ID",
  248. "oauth.google.client_id",
  249. os.environ.get("GOOGLE_CLIENT_ID", ""),
  250. )
  251. GOOGLE_CLIENT_SECRET = PersistentConfig(
  252. "GOOGLE_CLIENT_SECRET",
  253. "oauth.google.client_secret",
  254. os.environ.get("GOOGLE_CLIENT_SECRET", ""),
  255. )
  256. GOOGLE_OAUTH_SCOPE = PersistentConfig(
  257. "GOOGLE_OAUTH_SCOPE",
  258. "oauth.google.scope",
  259. os.environ.get("GOOGLE_OAUTH_SCOPE", "openid email profile"),
  260. )
  261. GOOGLE_REDIRECT_URI = PersistentConfig(
  262. "GOOGLE_REDIRECT_URI",
  263. "oauth.google.redirect_uri",
  264. os.environ.get("GOOGLE_REDIRECT_URI", ""),
  265. )
  266. MICROSOFT_CLIENT_ID = PersistentConfig(
  267. "MICROSOFT_CLIENT_ID",
  268. "oauth.microsoft.client_id",
  269. os.environ.get("MICROSOFT_CLIENT_ID", ""),
  270. )
  271. MICROSOFT_CLIENT_SECRET = PersistentConfig(
  272. "MICROSOFT_CLIENT_SECRET",
  273. "oauth.microsoft.client_secret",
  274. os.environ.get("MICROSOFT_CLIENT_SECRET", ""),
  275. )
  276. MICROSOFT_CLIENT_TENANT_ID = PersistentConfig(
  277. "MICROSOFT_CLIENT_TENANT_ID",
  278. "oauth.microsoft.tenant_id",
  279. os.environ.get("MICROSOFT_CLIENT_TENANT_ID", ""),
  280. )
  281. MICROSOFT_OAUTH_SCOPE = PersistentConfig(
  282. "MICROSOFT_OAUTH_SCOPE",
  283. "oauth.microsoft.scope",
  284. os.environ.get("MICROSOFT_OAUTH_SCOPE", "openid email profile"),
  285. )
  286. MICROSOFT_REDIRECT_URI = PersistentConfig(
  287. "MICROSOFT_REDIRECT_URI",
  288. "oauth.microsoft.redirect_uri",
  289. os.environ.get("MICROSOFT_REDIRECT_URI", ""),
  290. )
  291. GITHUB_CLIENT_ID = PersistentConfig(
  292. "GITHUB_CLIENT_ID",
  293. "oauth.github.client_id",
  294. os.environ.get("GITHUB_CLIENT_ID", ""),
  295. )
  296. GITHUB_CLIENT_SECRET = PersistentConfig(
  297. "GITHUB_CLIENT_SECRET",
  298. "oauth.github.client_secret",
  299. os.environ.get("GITHUB_CLIENT_SECRET", ""),
  300. )
  301. GITHUB_CLIENT_SCOPE = PersistentConfig(
  302. "GITHUB_CLIENT_SCOPE",
  303. "oauth.github.scope",
  304. os.environ.get("GITHUB_CLIENT_SCOPE", "user:email"),
  305. )
  306. GITHUB_CLIENT_REDIRECT_URI = PersistentConfig(
  307. "GITHUB_CLIENT_REDIRECT_URI",
  308. "oauth.github.redirect_uri",
  309. os.environ.get("GITHUB_CLIENT_REDIRECT_URI", ""),
  310. )
  311. OAUTH_CLIENT_ID = PersistentConfig(
  312. "OAUTH_CLIENT_ID",
  313. "oauth.oidc.client_id",
  314. os.environ.get("OAUTH_CLIENT_ID", ""),
  315. )
  316. OAUTH_CLIENT_SECRET = PersistentConfig(
  317. "OAUTH_CLIENT_SECRET",
  318. "oauth.oidc.client_secret",
  319. os.environ.get("OAUTH_CLIENT_SECRET", ""),
  320. )
  321. OPENID_PROVIDER_URL = PersistentConfig(
  322. "OPENID_PROVIDER_URL",
  323. "oauth.oidc.provider_url",
  324. os.environ.get("OPENID_PROVIDER_URL", ""),
  325. )
  326. OPENID_REDIRECT_URI = PersistentConfig(
  327. "OPENID_REDIRECT_URI",
  328. "oauth.oidc.redirect_uri",
  329. os.environ.get("OPENID_REDIRECT_URI", ""),
  330. )
  331. OAUTH_SCOPES = PersistentConfig(
  332. "OAUTH_SCOPES",
  333. "oauth.oidc.scopes",
  334. os.environ.get("OAUTH_SCOPES", "openid email profile"),
  335. )
  336. OAUTH_PROVIDER_NAME = PersistentConfig(
  337. "OAUTH_PROVIDER_NAME",
  338. "oauth.oidc.provider_name",
  339. os.environ.get("OAUTH_PROVIDER_NAME", "SSO"),
  340. )
  341. OAUTH_USERNAME_CLAIM = PersistentConfig(
  342. "OAUTH_USERNAME_CLAIM",
  343. "oauth.oidc.username_claim",
  344. os.environ.get("OAUTH_USERNAME_CLAIM", "name"),
  345. )
  346. OAUTH_PICTURE_CLAIM = PersistentConfig(
  347. "OAUTH_PICTURE_CLAIM",
  348. "oauth.oidc.avatar_claim",
  349. os.environ.get("OAUTH_PICTURE_CLAIM", "picture"),
  350. )
  351. OAUTH_EMAIL_CLAIM = PersistentConfig(
  352. "OAUTH_EMAIL_CLAIM",
  353. "oauth.oidc.email_claim",
  354. os.environ.get("OAUTH_EMAIL_CLAIM", "email"),
  355. )
  356. OAUTH_GROUPS_CLAIM = PersistentConfig(
  357. "OAUTH_GROUPS_CLAIM",
  358. "oauth.oidc.group_claim",
  359. os.environ.get("OAUTH_GROUP_CLAIM", "groups"),
  360. )
  361. ENABLE_OAUTH_ROLE_MANAGEMENT = PersistentConfig(
  362. "ENABLE_OAUTH_ROLE_MANAGEMENT",
  363. "oauth.enable_role_mapping",
  364. os.environ.get("ENABLE_OAUTH_ROLE_MANAGEMENT", "False").lower() == "true",
  365. )
  366. ENABLE_OAUTH_GROUP_MANAGEMENT = PersistentConfig(
  367. "ENABLE_OAUTH_GROUP_MANAGEMENT",
  368. "oauth.enable_group_mapping",
  369. os.environ.get("ENABLE_OAUTH_GROUP_MANAGEMENT", "False").lower() == "true",
  370. )
  371. OAUTH_ROLES_CLAIM = PersistentConfig(
  372. "OAUTH_ROLES_CLAIM",
  373. "oauth.roles_claim",
  374. os.environ.get("OAUTH_ROLES_CLAIM", "roles"),
  375. )
  376. OAUTH_ALLOWED_ROLES = PersistentConfig(
  377. "OAUTH_ALLOWED_ROLES",
  378. "oauth.allowed_roles",
  379. [
  380. role.strip()
  381. for role in os.environ.get("OAUTH_ALLOWED_ROLES", "user,admin").split(",")
  382. ],
  383. )
  384. OAUTH_ADMIN_ROLES = PersistentConfig(
  385. "OAUTH_ADMIN_ROLES",
  386. "oauth.admin_roles",
  387. [role.strip() for role in os.environ.get("OAUTH_ADMIN_ROLES", "admin").split(",")],
  388. )
  389. OAUTH_ALLOWED_DOMAINS = PersistentConfig(
  390. "OAUTH_ALLOWED_DOMAINS",
  391. "oauth.allowed_domains",
  392. [
  393. domain.strip()
  394. for domain in os.environ.get("OAUTH_ALLOWED_DOMAINS", "*").split(",")
  395. ],
  396. )
  397. def load_oauth_providers():
  398. OAUTH_PROVIDERS.clear()
  399. if GOOGLE_CLIENT_ID.value and GOOGLE_CLIENT_SECRET.value:
  400. def google_oauth_register(client):
  401. client.register(
  402. name="google",
  403. client_id=GOOGLE_CLIENT_ID.value,
  404. client_secret=GOOGLE_CLIENT_SECRET.value,
  405. server_metadata_url="https://accounts.google.com/.well-known/openid-configuration",
  406. client_kwargs={"scope": GOOGLE_OAUTH_SCOPE.value},
  407. redirect_uri=GOOGLE_REDIRECT_URI.value,
  408. )
  409. OAUTH_PROVIDERS["google"] = {
  410. "redirect_uri": GOOGLE_REDIRECT_URI.value,
  411. "register": google_oauth_register,
  412. }
  413. if (
  414. MICROSOFT_CLIENT_ID.value
  415. and MICROSOFT_CLIENT_SECRET.value
  416. and MICROSOFT_CLIENT_TENANT_ID.value
  417. ):
  418. def microsoft_oauth_register(client):
  419. client.register(
  420. name="microsoft",
  421. client_id=MICROSOFT_CLIENT_ID.value,
  422. client_secret=MICROSOFT_CLIENT_SECRET.value,
  423. server_metadata_url=f"https://login.microsoftonline.com/{MICROSOFT_CLIENT_TENANT_ID.value}/v2.0/.well-known/openid-configuration",
  424. client_kwargs={
  425. "scope": MICROSOFT_OAUTH_SCOPE.value,
  426. },
  427. redirect_uri=MICROSOFT_REDIRECT_URI.value,
  428. )
  429. OAUTH_PROVIDERS["microsoft"] = {
  430. "redirect_uri": MICROSOFT_REDIRECT_URI.value,
  431. "picture_url": "https://graph.microsoft.com/v1.0/me/photo/$value",
  432. "register": microsoft_oauth_register,
  433. }
  434. if GITHUB_CLIENT_ID.value and GITHUB_CLIENT_SECRET.value:
  435. def github_oauth_register(client):
  436. client.register(
  437. name="github",
  438. client_id=GITHUB_CLIENT_ID.value,
  439. client_secret=GITHUB_CLIENT_SECRET.value,
  440. access_token_url="https://github.com/login/oauth/access_token",
  441. authorize_url="https://github.com/login/oauth/authorize",
  442. api_base_url="https://api.github.com",
  443. userinfo_endpoint="https://api.github.com/user",
  444. client_kwargs={"scope": GITHUB_CLIENT_SCOPE.value},
  445. redirect_uri=GITHUB_CLIENT_REDIRECT_URI.value,
  446. )
  447. OAUTH_PROVIDERS["github"] = {
  448. "redirect_uri": GITHUB_CLIENT_REDIRECT_URI.value,
  449. "register": github_oauth_register,
  450. "sub_claim": "id",
  451. }
  452. if (
  453. OAUTH_CLIENT_ID.value
  454. and OAUTH_CLIENT_SECRET.value
  455. and OPENID_PROVIDER_URL.value
  456. ):
  457. def oidc_oauth_register(client):
  458. client.register(
  459. name="oidc",
  460. client_id=OAUTH_CLIENT_ID.value,
  461. client_secret=OAUTH_CLIENT_SECRET.value,
  462. server_metadata_url=OPENID_PROVIDER_URL.value,
  463. client_kwargs={
  464. "scope": OAUTH_SCOPES.value,
  465. },
  466. redirect_uri=OPENID_REDIRECT_URI.value,
  467. )
  468. OAUTH_PROVIDERS["oidc"] = {
  469. "name": OAUTH_PROVIDER_NAME.value,
  470. "redirect_uri": OPENID_REDIRECT_URI.value,
  471. "register": oidc_oauth_register,
  472. }
  473. load_oauth_providers()
  474. ####################################
  475. # Static DIR
  476. ####################################
  477. STATIC_DIR = Path(os.getenv("STATIC_DIR", OPEN_WEBUI_DIR / "static")).resolve()
  478. frontend_favicon = FRONTEND_BUILD_DIR / "static" / "favicon.png"
  479. if frontend_favicon.exists():
  480. try:
  481. shutil.copyfile(frontend_favicon, STATIC_DIR / "favicon.png")
  482. except Exception as e:
  483. logging.error(f"An error occurred: {e}")
  484. else:
  485. logging.warning(f"Frontend favicon not found at {frontend_favicon}")
  486. frontend_splash = FRONTEND_BUILD_DIR / "static" / "splash.png"
  487. if frontend_splash.exists():
  488. try:
  489. shutil.copyfile(frontend_splash, STATIC_DIR / "splash.png")
  490. except Exception as e:
  491. logging.error(f"An error occurred: {e}")
  492. else:
  493. logging.warning(f"Frontend splash not found at {frontend_splash}")
  494. ####################################
  495. # CUSTOM_NAME
  496. ####################################
  497. CUSTOM_NAME = os.environ.get("CUSTOM_NAME", "")
  498. if CUSTOM_NAME:
  499. try:
  500. r = requests.get(f"https://api.openwebui.com/api/v1/custom/{CUSTOM_NAME}")
  501. data = r.json()
  502. if r.ok:
  503. if "logo" in data:
  504. WEBUI_FAVICON_URL = url = (
  505. f"https://api.openwebui.com{data['logo']}"
  506. if data["logo"][0] == "/"
  507. else data["logo"]
  508. )
  509. r = requests.get(url, stream=True)
  510. if r.status_code == 200:
  511. with open(f"{STATIC_DIR}/favicon.png", "wb") as f:
  512. r.raw.decode_content = True
  513. shutil.copyfileobj(r.raw, f)
  514. if "splash" in data:
  515. url = (
  516. f"https://api.openwebui.com{data['splash']}"
  517. if data["splash"][0] == "/"
  518. else data["splash"]
  519. )
  520. r = requests.get(url, stream=True)
  521. if r.status_code == 200:
  522. with open(f"{STATIC_DIR}/splash.png", "wb") as f:
  523. r.raw.decode_content = True
  524. shutil.copyfileobj(r.raw, f)
  525. WEBUI_NAME = data["name"]
  526. except Exception as e:
  527. log.exception(e)
  528. pass
  529. ####################################
  530. # STORAGE PROVIDER
  531. ####################################
  532. STORAGE_PROVIDER = os.environ.get("STORAGE_PROVIDER", "local") # defaults to local, s3
  533. S3_ACCESS_KEY_ID = os.environ.get("S3_ACCESS_KEY_ID", None)
  534. S3_SECRET_ACCESS_KEY = os.environ.get("S3_SECRET_ACCESS_KEY", None)
  535. S3_REGION_NAME = os.environ.get("S3_REGION_NAME", None)
  536. S3_BUCKET_NAME = os.environ.get("S3_BUCKET_NAME", None)
  537. S3_ENDPOINT_URL = os.environ.get("S3_ENDPOINT_URL", None)
  538. GCS_BUCKET_NAME = os.environ.get("GCS_BUCKET_NAME", None)
  539. GOOGLE_APPLICATION_CREDENTIALS_JSON = os.environ.get(
  540. "GOOGLE_APPLICATION_CREDENTIALS_JSON", None
  541. )
  542. ####################################
  543. # File Upload DIR
  544. ####################################
  545. UPLOAD_DIR = f"{DATA_DIR}/uploads"
  546. Path(UPLOAD_DIR).mkdir(parents=True, exist_ok=True)
  547. ####################################
  548. # Cache DIR
  549. ####################################
  550. CACHE_DIR = f"{DATA_DIR}/cache"
  551. Path(CACHE_DIR).mkdir(parents=True, exist_ok=True)
  552. ####################################
  553. # OLLAMA_BASE_URL
  554. ####################################
  555. ENABLE_OLLAMA_API = PersistentConfig(
  556. "ENABLE_OLLAMA_API",
  557. "ollama.enable",
  558. os.environ.get("ENABLE_OLLAMA_API", "True").lower() == "true",
  559. )
  560. OLLAMA_API_BASE_URL = os.environ.get(
  561. "OLLAMA_API_BASE_URL", "http://localhost:11434/api"
  562. )
  563. OLLAMA_BASE_URL = os.environ.get("OLLAMA_BASE_URL", "")
  564. if OLLAMA_BASE_URL:
  565. # Remove trailing slash
  566. OLLAMA_BASE_URL = (
  567. OLLAMA_BASE_URL[:-1] if OLLAMA_BASE_URL.endswith("/") else OLLAMA_BASE_URL
  568. )
  569. K8S_FLAG = os.environ.get("K8S_FLAG", "")
  570. USE_OLLAMA_DOCKER = os.environ.get("USE_OLLAMA_DOCKER", "false")
  571. if OLLAMA_BASE_URL == "" and OLLAMA_API_BASE_URL != "":
  572. OLLAMA_BASE_URL = (
  573. OLLAMA_API_BASE_URL[:-4]
  574. if OLLAMA_API_BASE_URL.endswith("/api")
  575. else OLLAMA_API_BASE_URL
  576. )
  577. if ENV == "prod":
  578. if OLLAMA_BASE_URL == "/ollama" and not K8S_FLAG:
  579. if USE_OLLAMA_DOCKER.lower() == "true":
  580. # if you use all-in-one docker container (Open WebUI + Ollama)
  581. # with the docker build arg USE_OLLAMA=true (--build-arg="USE_OLLAMA=true") this only works with http://localhost:11434
  582. OLLAMA_BASE_URL = "http://localhost:11434"
  583. else:
  584. OLLAMA_BASE_URL = "http://host.docker.internal:11434"
  585. elif K8S_FLAG:
  586. OLLAMA_BASE_URL = "http://ollama-service.open-webui.svc.cluster.local:11434"
  587. OLLAMA_BASE_URLS = os.environ.get("OLLAMA_BASE_URLS", "")
  588. OLLAMA_BASE_URLS = OLLAMA_BASE_URLS if OLLAMA_BASE_URLS != "" else OLLAMA_BASE_URL
  589. OLLAMA_BASE_URLS = [url.strip() for url in OLLAMA_BASE_URLS.split(";")]
  590. OLLAMA_BASE_URLS = PersistentConfig(
  591. "OLLAMA_BASE_URLS", "ollama.base_urls", OLLAMA_BASE_URLS
  592. )
  593. OLLAMA_API_CONFIGS = PersistentConfig(
  594. "OLLAMA_API_CONFIGS",
  595. "ollama.api_configs",
  596. {},
  597. )
  598. ####################################
  599. # OPENAI_API
  600. ####################################
  601. ENABLE_OPENAI_API = PersistentConfig(
  602. "ENABLE_OPENAI_API",
  603. "openai.enable",
  604. os.environ.get("ENABLE_OPENAI_API", "True").lower() == "true",
  605. )
  606. OPENAI_API_KEY = os.environ.get("OPENAI_API_KEY", "")
  607. OPENAI_API_BASE_URL = os.environ.get("OPENAI_API_BASE_URL", "")
  608. if OPENAI_API_BASE_URL == "":
  609. OPENAI_API_BASE_URL = "https://api.openai.com/v1"
  610. OPENAI_API_KEYS = os.environ.get("OPENAI_API_KEYS", "")
  611. OPENAI_API_KEYS = OPENAI_API_KEYS if OPENAI_API_KEYS != "" else OPENAI_API_KEY
  612. OPENAI_API_KEYS = [url.strip() for url in OPENAI_API_KEYS.split(";")]
  613. OPENAI_API_KEYS = PersistentConfig(
  614. "OPENAI_API_KEYS", "openai.api_keys", OPENAI_API_KEYS
  615. )
  616. OPENAI_API_BASE_URLS = os.environ.get("OPENAI_API_BASE_URLS", "")
  617. OPENAI_API_BASE_URLS = (
  618. OPENAI_API_BASE_URLS if OPENAI_API_BASE_URLS != "" else OPENAI_API_BASE_URL
  619. )
  620. OPENAI_API_BASE_URLS = [
  621. url.strip() if url != "" else "https://api.openai.com/v1"
  622. for url in OPENAI_API_BASE_URLS.split(";")
  623. ]
  624. OPENAI_API_BASE_URLS = PersistentConfig(
  625. "OPENAI_API_BASE_URLS", "openai.api_base_urls", OPENAI_API_BASE_URLS
  626. )
  627. OPENAI_API_CONFIGS = PersistentConfig(
  628. "OPENAI_API_CONFIGS",
  629. "openai.api_configs",
  630. {},
  631. )
  632. # Get the actual OpenAI API key based on the base URL
  633. OPENAI_API_KEY = ""
  634. try:
  635. OPENAI_API_KEY = OPENAI_API_KEYS.value[
  636. OPENAI_API_BASE_URLS.value.index("https://api.openai.com/v1")
  637. ]
  638. except Exception:
  639. pass
  640. OPENAI_API_BASE_URL = "https://api.openai.com/v1"
  641. ####################################
  642. # WEBUI
  643. ####################################
  644. WEBUI_URL = PersistentConfig(
  645. "WEBUI_URL", "webui.url", os.environ.get("WEBUI_URL", "http://localhost:3000")
  646. )
  647. ENABLE_SIGNUP = PersistentConfig(
  648. "ENABLE_SIGNUP",
  649. "ui.enable_signup",
  650. (
  651. False
  652. if not WEBUI_AUTH
  653. else os.environ.get("ENABLE_SIGNUP", "True").lower() == "true"
  654. ),
  655. )
  656. ENABLE_LOGIN_FORM = PersistentConfig(
  657. "ENABLE_LOGIN_FORM",
  658. "ui.ENABLE_LOGIN_FORM",
  659. os.environ.get("ENABLE_LOGIN_FORM", "True").lower() == "true",
  660. )
  661. DEFAULT_LOCALE = PersistentConfig(
  662. "DEFAULT_LOCALE",
  663. "ui.default_locale",
  664. os.environ.get("DEFAULT_LOCALE", ""),
  665. )
  666. DEFAULT_MODELS = PersistentConfig(
  667. "DEFAULT_MODELS", "ui.default_models", os.environ.get("DEFAULT_MODELS", None)
  668. )
  669. DEFAULT_PROMPT_SUGGESTIONS = PersistentConfig(
  670. "DEFAULT_PROMPT_SUGGESTIONS",
  671. "ui.prompt_suggestions",
  672. [
  673. {
  674. "title": ["Help me study", "vocabulary for a college entrance exam"],
  675. "content": "Help me study vocabulary: write a sentence for me to fill in the blank, and I'll try to pick the correct option.",
  676. },
  677. {
  678. "title": ["Give me ideas", "for what to do with my kids' art"],
  679. "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.",
  680. },
  681. {
  682. "title": ["Tell me a fun fact", "about the Roman Empire"],
  683. "content": "Tell me a random fun fact about the Roman Empire",
  684. },
  685. {
  686. "title": ["Show me a code snippet", "of a website's sticky header"],
  687. "content": "Show me a code snippet of a website's sticky header in CSS and JavaScript.",
  688. },
  689. {
  690. "title": [
  691. "Explain options trading",
  692. "if I'm familiar with buying and selling stocks",
  693. ],
  694. "content": "Explain options trading in simple terms if I'm familiar with buying and selling stocks.",
  695. },
  696. {
  697. "title": ["Overcome procrastination", "give me tips"],
  698. "content": "Could you start by asking me about instances when I procrastinate the most and then give me some suggestions to overcome it?",
  699. },
  700. ],
  701. )
  702. MODEL_ORDER_LIST = PersistentConfig(
  703. "MODEL_ORDER_LIST",
  704. "ui.model_order_list",
  705. [],
  706. )
  707. DEFAULT_USER_ROLE = PersistentConfig(
  708. "DEFAULT_USER_ROLE",
  709. "ui.default_user_role",
  710. os.getenv("DEFAULT_USER_ROLE", "pending"),
  711. )
  712. USER_PERMISSIONS_WORKSPACE_MODELS_ACCESS = (
  713. os.environ.get("USER_PERMISSIONS_WORKSPACE_MODELS_ACCESS", "False").lower()
  714. == "true"
  715. )
  716. USER_PERMISSIONS_WORKSPACE_KNOWLEDGE_ACCESS = (
  717. os.environ.get("USER_PERMISSIONS_WORKSPACE_KNOWLEDGE_ACCESS", "False").lower()
  718. == "true"
  719. )
  720. USER_PERMISSIONS_WORKSPACE_PROMPTS_ACCESS = (
  721. os.environ.get("USER_PERMISSIONS_WORKSPACE_PROMPTS_ACCESS", "False").lower()
  722. == "true"
  723. )
  724. USER_PERMISSIONS_WORKSPACE_TOOLS_ACCESS = (
  725. os.environ.get("USER_PERMISSIONS_WORKSPACE_TOOLS_ACCESS", "False").lower() == "true"
  726. )
  727. USER_PERMISSIONS_CHAT_CONTROLS = (
  728. os.environ.get("USER_PERMISSIONS_CHAT_CONTROLS", "True").lower() == "true"
  729. )
  730. USER_PERMISSIONS_CHAT_FILE_UPLOAD = (
  731. os.environ.get("USER_PERMISSIONS_CHAT_FILE_UPLOAD", "True").lower() == "true"
  732. )
  733. USER_PERMISSIONS_CHAT_DELETE = (
  734. os.environ.get("USER_PERMISSIONS_CHAT_DELETE", "True").lower() == "true"
  735. )
  736. USER_PERMISSIONS_CHAT_EDIT = (
  737. os.environ.get("USER_PERMISSIONS_CHAT_EDIT", "True").lower() == "true"
  738. )
  739. USER_PERMISSIONS_CHAT_TEMPORARY = (
  740. os.environ.get("USER_PERMISSIONS_CHAT_TEMPORARY", "True").lower() == "true"
  741. )
  742. USER_PERMISSIONS_FEATURES_WEB_SEARCH = (
  743. os.environ.get("USER_PERMISSIONS_FEATURES_WEB_SEARCH", "True").lower() == "true"
  744. )
  745. USER_PERMISSIONS_FEATURES_IMAGE_GENERATION = (
  746. os.environ.get("USER_PERMISSIONS_FEATURES_IMAGE_GENERATION", "True").lower()
  747. == "true"
  748. )
  749. DEFAULT_USER_PERMISSIONS = {
  750. "workspace": {
  751. "models": USER_PERMISSIONS_WORKSPACE_MODELS_ACCESS,
  752. "knowledge": USER_PERMISSIONS_WORKSPACE_KNOWLEDGE_ACCESS,
  753. "prompts": USER_PERMISSIONS_WORKSPACE_PROMPTS_ACCESS,
  754. "tools": USER_PERMISSIONS_WORKSPACE_TOOLS_ACCESS,
  755. },
  756. "chat": {
  757. "controls": USER_PERMISSIONS_CHAT_CONTROLS,
  758. "file_upload": USER_PERMISSIONS_CHAT_FILE_UPLOAD,
  759. "delete": USER_PERMISSIONS_CHAT_DELETE,
  760. "edit": USER_PERMISSIONS_CHAT_EDIT,
  761. "temporary": USER_PERMISSIONS_CHAT_TEMPORARY,
  762. },
  763. "features": {
  764. "web_search": USER_PERMISSIONS_FEATURES_WEB_SEARCH,
  765. "image_generation": USER_PERMISSIONS_FEATURES_IMAGE_GENERATION,
  766. },
  767. }
  768. USER_PERMISSIONS = PersistentConfig(
  769. "USER_PERMISSIONS",
  770. "user.permissions",
  771. DEFAULT_USER_PERMISSIONS,
  772. )
  773. ENABLE_CHANNELS = PersistentConfig(
  774. "ENABLE_CHANNELS",
  775. "channels.enable",
  776. os.environ.get("ENABLE_CHANNELS", "False").lower() == "true",
  777. )
  778. ENABLE_EVALUATION_ARENA_MODELS = PersistentConfig(
  779. "ENABLE_EVALUATION_ARENA_MODELS",
  780. "evaluation.arena.enable",
  781. os.environ.get("ENABLE_EVALUATION_ARENA_MODELS", "True").lower() == "true",
  782. )
  783. EVALUATION_ARENA_MODELS = PersistentConfig(
  784. "EVALUATION_ARENA_MODELS",
  785. "evaluation.arena.models",
  786. [],
  787. )
  788. DEFAULT_ARENA_MODEL = {
  789. "id": "arena-model",
  790. "name": "Arena Model",
  791. "meta": {
  792. "profile_image_url": "/favicon.png",
  793. "description": "Submit your questions to anonymous AI chatbots and vote on the best response.",
  794. "model_ids": None,
  795. },
  796. }
  797. WEBHOOK_URL = PersistentConfig(
  798. "WEBHOOK_URL", "webhook_url", os.environ.get("WEBHOOK_URL", "")
  799. )
  800. ENABLE_ADMIN_EXPORT = os.environ.get("ENABLE_ADMIN_EXPORT", "True").lower() == "true"
  801. ENABLE_ADMIN_CHAT_ACCESS = (
  802. os.environ.get("ENABLE_ADMIN_CHAT_ACCESS", "True").lower() == "true"
  803. )
  804. ENABLE_COMMUNITY_SHARING = PersistentConfig(
  805. "ENABLE_COMMUNITY_SHARING",
  806. "ui.enable_community_sharing",
  807. os.environ.get("ENABLE_COMMUNITY_SHARING", "True").lower() == "true",
  808. )
  809. ENABLE_MESSAGE_RATING = PersistentConfig(
  810. "ENABLE_MESSAGE_RATING",
  811. "ui.enable_message_rating",
  812. os.environ.get("ENABLE_MESSAGE_RATING", "True").lower() == "true",
  813. )
  814. def validate_cors_origins(origins):
  815. for origin in origins:
  816. if origin != "*":
  817. validate_cors_origin(origin)
  818. def validate_cors_origin(origin):
  819. parsed_url = urlparse(origin)
  820. # Check if the scheme is either http or https
  821. if parsed_url.scheme not in ["http", "https"]:
  822. raise ValueError(
  823. f"Invalid scheme in CORS_ALLOW_ORIGIN: '{origin}'. Only 'http' and 'https' are allowed."
  824. )
  825. # Ensure that the netloc (domain + port) is present, indicating it's a valid URL
  826. if not parsed_url.netloc:
  827. raise ValueError(f"Invalid URL structure in CORS_ALLOW_ORIGIN: '{origin}'.")
  828. # For production, you should only need one host as
  829. # fastapi serves the svelte-kit built frontend and backend from the same host and port.
  830. # To test CORS_ALLOW_ORIGIN locally, you can set something like
  831. # CORS_ALLOW_ORIGIN=http://localhost:5173;http://localhost:8080
  832. # in your .env file depending on your frontend port, 5173 in this case.
  833. CORS_ALLOW_ORIGIN = os.environ.get("CORS_ALLOW_ORIGIN", "*").split(";")
  834. if "*" in CORS_ALLOW_ORIGIN:
  835. log.warning(
  836. "\n\nWARNING: CORS_ALLOW_ORIGIN IS SET TO '*' - NOT RECOMMENDED FOR PRODUCTION DEPLOYMENTS.\n"
  837. )
  838. validate_cors_origins(CORS_ALLOW_ORIGIN)
  839. class BannerModel(BaseModel):
  840. id: str
  841. type: str
  842. title: Optional[str] = None
  843. content: str
  844. dismissible: bool
  845. timestamp: int
  846. try:
  847. banners = json.loads(os.environ.get("WEBUI_BANNERS", "[]"))
  848. banners = [BannerModel(**banner) for banner in banners]
  849. except Exception as e:
  850. print(f"Error loading WEBUI_BANNERS: {e}")
  851. banners = []
  852. WEBUI_BANNERS = PersistentConfig("WEBUI_BANNERS", "ui.banners", banners)
  853. SHOW_ADMIN_DETAILS = PersistentConfig(
  854. "SHOW_ADMIN_DETAILS",
  855. "auth.admin.show",
  856. os.environ.get("SHOW_ADMIN_DETAILS", "true").lower() == "true",
  857. )
  858. ADMIN_EMAIL = PersistentConfig(
  859. "ADMIN_EMAIL",
  860. "auth.admin.email",
  861. os.environ.get("ADMIN_EMAIL", None),
  862. )
  863. ####################################
  864. # TASKS
  865. ####################################
  866. TASK_MODEL = PersistentConfig(
  867. "TASK_MODEL",
  868. "task.model.default",
  869. os.environ.get("TASK_MODEL", ""),
  870. )
  871. TASK_MODEL_EXTERNAL = PersistentConfig(
  872. "TASK_MODEL_EXTERNAL",
  873. "task.model.external",
  874. os.environ.get("TASK_MODEL_EXTERNAL", ""),
  875. )
  876. TITLE_GENERATION_PROMPT_TEMPLATE = PersistentConfig(
  877. "TITLE_GENERATION_PROMPT_TEMPLATE",
  878. "task.title.prompt_template",
  879. os.environ.get("TITLE_GENERATION_PROMPT_TEMPLATE", ""),
  880. )
  881. DEFAULT_TITLE_GENERATION_PROMPT_TEMPLATE = """### Task:
  882. Generate a concise, 3-5 word title with an emoji summarizing the chat history.
  883. ### Guidelines:
  884. - The title should clearly represent the main theme or subject of the conversation.
  885. - Use emojis that enhance understanding of the topic, but avoid quotation marks or special formatting.
  886. - Write the title in the chat's primary language; default to English if multilingual.
  887. - Prioritize accuracy over excessive creativity; keep it clear and simple.
  888. ### Output:
  889. JSON format: { "title": "your concise title here" }
  890. ### Examples:
  891. - { "title": "📉 Stock Market Trends" },
  892. - { "title": "🍪 Perfect Chocolate Chip Recipe" },
  893. - { "title": "Evolution of Music Streaming" },
  894. - { "title": "Remote Work Productivity Tips" },
  895. - { "title": "Artificial Intelligence in Healthcare" },
  896. - { "title": "🎮 Video Game Development Insights" }
  897. ### Chat History:
  898. <chat_history>
  899. {{MESSAGES:END:2}}
  900. </chat_history>"""
  901. TAGS_GENERATION_PROMPT_TEMPLATE = PersistentConfig(
  902. "TAGS_GENERATION_PROMPT_TEMPLATE",
  903. "task.tags.prompt_template",
  904. os.environ.get("TAGS_GENERATION_PROMPT_TEMPLATE", ""),
  905. )
  906. DEFAULT_TAGS_GENERATION_PROMPT_TEMPLATE = """### Task:
  907. Generate 1-3 broad tags categorizing the main themes of the chat history, along with 1-3 more specific subtopic tags.
  908. ### Guidelines:
  909. - Start with high-level domains (e.g. Science, Technology, Philosophy, Arts, Politics, Business, Health, Sports, Entertainment, Education)
  910. - Consider including relevant subfields/subdomains if they are strongly represented throughout the conversation
  911. - If content is too short (less than 3 messages) or too diverse, use only ["General"]
  912. - Use the chat's primary language; default to English if multilingual
  913. - Prioritize accuracy over specificity
  914. ### Output:
  915. JSON format: { "tags": ["tag1", "tag2", "tag3"] }
  916. ### Chat History:
  917. <chat_history>
  918. {{MESSAGES:END:6}}
  919. </chat_history>"""
  920. IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE = PersistentConfig(
  921. "IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE",
  922. "task.image.prompt_template",
  923. os.environ.get("IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE", ""),
  924. )
  925. DEFAULT_IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE = """### Task:
  926. 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.
  927. ### Guidelines:
  928. - Be descriptive and detailed, focusing on the most important aspects of the image.
  929. - Avoid making assumptions or adding information not present in the image.
  930. - Use the chat's primary language; default to English if multilingual.
  931. - If the image is too complex, focus on the most prominent elements.
  932. ### Output:
  933. Strictly return in JSON format:
  934. {
  935. "prompt": "Your detailed description here."
  936. }
  937. ### Chat History:
  938. <chat_history>
  939. {{MESSAGES:END:6}}
  940. </chat_history>"""
  941. ENABLE_TAGS_GENERATION = PersistentConfig(
  942. "ENABLE_TAGS_GENERATION",
  943. "task.tags.enable",
  944. os.environ.get("ENABLE_TAGS_GENERATION", "True").lower() == "true",
  945. )
  946. ENABLE_SEARCH_QUERY_GENERATION = PersistentConfig(
  947. "ENABLE_SEARCH_QUERY_GENERATION",
  948. "task.query.search.enable",
  949. os.environ.get("ENABLE_SEARCH_QUERY_GENERATION", "True").lower() == "true",
  950. )
  951. ENABLE_RETRIEVAL_QUERY_GENERATION = PersistentConfig(
  952. "ENABLE_RETRIEVAL_QUERY_GENERATION",
  953. "task.query.retrieval.enable",
  954. os.environ.get("ENABLE_RETRIEVAL_QUERY_GENERATION", "True").lower() == "true",
  955. )
  956. QUERY_GENERATION_PROMPT_TEMPLATE = PersistentConfig(
  957. "QUERY_GENERATION_PROMPT_TEMPLATE",
  958. "task.query.prompt_template",
  959. os.environ.get("QUERY_GENERATION_PROMPT_TEMPLATE", ""),
  960. )
  961. DEFAULT_QUERY_GENERATION_PROMPT_TEMPLATE = """### Task:
  962. 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.
  963. ### Guidelines:
  964. - Respond **EXCLUSIVELY** with a JSON object. Any form of extra commentary, explanation, or additional text is strictly prohibited.
  965. - When generating search queries, respond in the format: { "queries": ["query1", "query2"] }, ensuring each query is distinct, concise, and relevant to the topic.
  966. - If and only if it is entirely certain that no useful results can be retrieved by a search, return: { "queries": [] }.
  967. - Err on the side of suggesting search queries if there is **any chance** they might provide useful or updated information.
  968. - Be concise and focused on composing high-quality search queries, avoiding unnecessary elaboration, commentary, or assumptions.
  969. - Today's date is: {{CURRENT_DATE}}.
  970. - Always prioritize providing actionable and broad queries that maximize informational coverage.
  971. ### Output:
  972. Strictly return in JSON format:
  973. {
  974. "queries": ["query1", "query2"]
  975. }
  976. ### Chat History:
  977. <chat_history>
  978. {{MESSAGES:END:6}}
  979. </chat_history>
  980. """
  981. ENABLE_AUTOCOMPLETE_GENERATION = PersistentConfig(
  982. "ENABLE_AUTOCOMPLETE_GENERATION",
  983. "task.autocomplete.enable",
  984. os.environ.get("ENABLE_AUTOCOMPLETE_GENERATION", "True").lower() == "true",
  985. )
  986. AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH = PersistentConfig(
  987. "AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH",
  988. "task.autocomplete.input_max_length",
  989. int(os.environ.get("AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH", "-1")),
  990. )
  991. AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE = PersistentConfig(
  992. "AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE",
  993. "task.autocomplete.prompt_template",
  994. os.environ.get("AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE", ""),
  995. )
  996. DEFAULT_AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE = """### Task:
  997. You are an autocompletion system. Continue the text in `<text>` based on the **completion type** in `<type>` and the given language.
  998. ### **Instructions**:
  999. 1. Analyze `<text>` for context and meaning.
  1000. 2. Use `<type>` to guide your output:
  1001. - **General**: Provide a natural, concise continuation.
  1002. - **Search Query**: Complete as if generating a realistic search query.
  1003. 3. Start as if you are directly continuing `<text>`. Do **not** repeat, paraphrase, or respond as a model. Simply complete the text.
  1004. 4. Ensure the continuation:
  1005. - Flows naturally from `<text>`.
  1006. - Avoids repetition, overexplaining, or unrelated ideas.
  1007. 5. If unsure, return: `{ "text": "" }`.
  1008. ### **Output Rules**:
  1009. - Respond only in JSON format: `{ "text": "<your_completion>" }`.
  1010. ### **Examples**:
  1011. #### Example 1:
  1012. Input:
  1013. <type>General</type>
  1014. <text>The sun was setting over the horizon, painting the sky</text>
  1015. Output:
  1016. { "text": "with vibrant shades of orange and pink." }
  1017. #### Example 2:
  1018. Input:
  1019. <type>Search Query</type>
  1020. <text>Top-rated restaurants in</text>
  1021. Output:
  1022. { "text": "New York City for Italian cuisine." }
  1023. ---
  1024. ### Context:
  1025. <chat_history>
  1026. {{MESSAGES:END:6}}
  1027. </chat_history>
  1028. <type>{{TYPE}}</type>
  1029. <text>{{PROMPT}}</text>
  1030. #### Output:
  1031. """
  1032. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = PersistentConfig(
  1033. "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE",
  1034. "task.tools.prompt_template",
  1035. os.environ.get("TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE", ""),
  1036. )
  1037. DEFAULT_TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = """Available Tools: {{TOOLS}}
  1038. Your task is to choose and return the correct tool(s) from the list of available tools based on the query. Follow these guidelines:
  1039. - Return only the JSON object, without any additional text or explanation.
  1040. - If no tools match the query, return an empty array:
  1041. {
  1042. "tool_calls": []
  1043. }
  1044. - If one or more tools match the query, construct a JSON response containing a "tool_calls" array with objects that include:
  1045. - "name": The tool's name.
  1046. - "parameters": A dictionary of required parameters and their corresponding values.
  1047. The format for the JSON response is strictly:
  1048. {
  1049. "tool_calls": [
  1050. {"name": "toolName1", "parameters": {"key1": "value1"}},
  1051. {"name": "toolName2", "parameters": {"key2": "value2"}}
  1052. ]
  1053. }"""
  1054. 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., 😊, 😢, 😡, 😱).
  1055. Message: ```{{prompt}}```"""
  1056. DEFAULT_MOA_GENERATION_PROMPT_TEMPLATE = """You have been provided with a set of responses from various models to the latest user query: "{{prompt}}"
  1057. 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.
  1058. Responses from models: {{responses}}"""
  1059. ####################################
  1060. # Vector Database
  1061. ####################################
  1062. VECTOR_DB = os.environ.get("VECTOR_DB", "chroma")
  1063. # Chroma
  1064. CHROMA_DATA_PATH = f"{DATA_DIR}/vector_db"
  1065. CHROMA_TENANT = os.environ.get("CHROMA_TENANT", chromadb.DEFAULT_TENANT)
  1066. CHROMA_DATABASE = os.environ.get("CHROMA_DATABASE", chromadb.DEFAULT_DATABASE)
  1067. CHROMA_HTTP_HOST = os.environ.get("CHROMA_HTTP_HOST", "")
  1068. CHROMA_HTTP_PORT = int(os.environ.get("CHROMA_HTTP_PORT", "8000"))
  1069. CHROMA_CLIENT_AUTH_PROVIDER = os.environ.get("CHROMA_CLIENT_AUTH_PROVIDER", "")
  1070. CHROMA_CLIENT_AUTH_CREDENTIALS = os.environ.get("CHROMA_CLIENT_AUTH_CREDENTIALS", "")
  1071. # Comma-separated list of header=value pairs
  1072. CHROMA_HTTP_HEADERS = os.environ.get("CHROMA_HTTP_HEADERS", "")
  1073. if CHROMA_HTTP_HEADERS:
  1074. CHROMA_HTTP_HEADERS = dict(
  1075. [pair.split("=") for pair in CHROMA_HTTP_HEADERS.split(",")]
  1076. )
  1077. else:
  1078. CHROMA_HTTP_HEADERS = None
  1079. CHROMA_HTTP_SSL = os.environ.get("CHROMA_HTTP_SSL", "false").lower() == "true"
  1080. # 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)
  1081. # Milvus
  1082. MILVUS_URI = os.environ.get("MILVUS_URI", f"{DATA_DIR}/vector_db/milvus.db")
  1083. MILVUS_DB = os.environ.get("MILVUS_DB", "default")
  1084. # Qdrant
  1085. QDRANT_URI = os.environ.get("QDRANT_URI", None)
  1086. QDRANT_API_KEY = os.environ.get("QDRANT_API_KEY", None)
  1087. # OpenSearch
  1088. OPENSEARCH_URI = os.environ.get("OPENSEARCH_URI", "https://localhost:9200")
  1089. OPENSEARCH_SSL = os.environ.get("OPENSEARCH_SSL", True)
  1090. OPENSEARCH_CERT_VERIFY = os.environ.get("OPENSEARCH_CERT_VERIFY", False)
  1091. OPENSEARCH_USERNAME = os.environ.get("OPENSEARCH_USERNAME", None)
  1092. OPENSEARCH_PASSWORD = os.environ.get("OPENSEARCH_PASSWORD", None)
  1093. # Pgvector
  1094. PGVECTOR_DB_URL = os.environ.get("PGVECTOR_DB_URL", DATABASE_URL)
  1095. if VECTOR_DB == "pgvector" and not PGVECTOR_DB_URL.startswith("postgres"):
  1096. raise ValueError(
  1097. "Pgvector requires setting PGVECTOR_DB_URL or using Postgres with vector extension as the primary database."
  1098. )
  1099. PGVECTOR_INITIALIZE_MAX_VECTOR_LENGTH = int(
  1100. os.environ.get("PGVECTOR_INITIALIZE_MAX_VECTOR_LENGTH", "1536")
  1101. )
  1102. ####################################
  1103. # Information Retrieval (RAG)
  1104. ####################################
  1105. # If configured, Google Drive will be available as an upload option.
  1106. ENABLE_GOOGLE_DRIVE_INTEGRATION = PersistentConfig(
  1107. "ENABLE_GOOGLE_DRIVE_INTEGRATION",
  1108. "google_drive.enable",
  1109. os.getenv("ENABLE_GOOGLE_DRIVE_INTEGRATION", "False").lower() == "true",
  1110. )
  1111. GOOGLE_DRIVE_CLIENT_ID = PersistentConfig(
  1112. "GOOGLE_DRIVE_CLIENT_ID",
  1113. "google_drive.client_id",
  1114. os.environ.get("GOOGLE_DRIVE_CLIENT_ID", ""),
  1115. )
  1116. GOOGLE_DRIVE_API_KEY = PersistentConfig(
  1117. "GOOGLE_DRIVE_API_KEY",
  1118. "google_drive.api_key",
  1119. os.environ.get("GOOGLE_DRIVE_API_KEY", ""),
  1120. )
  1121. # RAG Content Extraction
  1122. CONTENT_EXTRACTION_ENGINE = PersistentConfig(
  1123. "CONTENT_EXTRACTION_ENGINE",
  1124. "rag.CONTENT_EXTRACTION_ENGINE",
  1125. os.environ.get("CONTENT_EXTRACTION_ENGINE", "").lower(),
  1126. )
  1127. TIKA_SERVER_URL = PersistentConfig(
  1128. "TIKA_SERVER_URL",
  1129. "rag.tika_server_url",
  1130. os.getenv("TIKA_SERVER_URL", "http://tika:9998"), # Default for sidecar deployment
  1131. )
  1132. RAG_TOP_K = PersistentConfig(
  1133. "RAG_TOP_K", "rag.top_k", int(os.environ.get("RAG_TOP_K", "3"))
  1134. )
  1135. RAG_RELEVANCE_THRESHOLD = PersistentConfig(
  1136. "RAG_RELEVANCE_THRESHOLD",
  1137. "rag.relevance_threshold",
  1138. float(os.environ.get("RAG_RELEVANCE_THRESHOLD", "0.0")),
  1139. )
  1140. ENABLE_RAG_HYBRID_SEARCH = PersistentConfig(
  1141. "ENABLE_RAG_HYBRID_SEARCH",
  1142. "rag.enable_hybrid_search",
  1143. os.environ.get("ENABLE_RAG_HYBRID_SEARCH", "").lower() == "true",
  1144. )
  1145. RAG_FILE_MAX_COUNT = PersistentConfig(
  1146. "RAG_FILE_MAX_COUNT",
  1147. "rag.file.max_count",
  1148. (
  1149. int(os.environ.get("RAG_FILE_MAX_COUNT"))
  1150. if os.environ.get("RAG_FILE_MAX_COUNT")
  1151. else None
  1152. ),
  1153. )
  1154. RAG_FILE_MAX_SIZE = PersistentConfig(
  1155. "RAG_FILE_MAX_SIZE",
  1156. "rag.file.max_size",
  1157. (
  1158. int(os.environ.get("RAG_FILE_MAX_SIZE"))
  1159. if os.environ.get("RAG_FILE_MAX_SIZE")
  1160. else None
  1161. ),
  1162. )
  1163. ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION = PersistentConfig(
  1164. "ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION",
  1165. "rag.enable_web_loader_ssl_verification",
  1166. os.environ.get("ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION", "True").lower() == "true",
  1167. )
  1168. RAG_EMBEDDING_ENGINE = PersistentConfig(
  1169. "RAG_EMBEDDING_ENGINE",
  1170. "rag.embedding_engine",
  1171. os.environ.get("RAG_EMBEDDING_ENGINE", ""),
  1172. )
  1173. PDF_EXTRACT_IMAGES = PersistentConfig(
  1174. "PDF_EXTRACT_IMAGES",
  1175. "rag.pdf_extract_images",
  1176. os.environ.get("PDF_EXTRACT_IMAGES", "False").lower() == "true",
  1177. )
  1178. RAG_EMBEDDING_MODEL = PersistentConfig(
  1179. "RAG_EMBEDDING_MODEL",
  1180. "rag.embedding_model",
  1181. os.environ.get("RAG_EMBEDDING_MODEL", "sentence-transformers/all-MiniLM-L6-v2"),
  1182. )
  1183. log.info(f"Embedding model set: {RAG_EMBEDDING_MODEL.value}")
  1184. RAG_EMBEDDING_MODEL_AUTO_UPDATE = (
  1185. not OFFLINE_MODE
  1186. and os.environ.get("RAG_EMBEDDING_MODEL_AUTO_UPDATE", "True").lower() == "true"
  1187. )
  1188. RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE = (
  1189. os.environ.get("RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE", "True").lower() == "true"
  1190. )
  1191. RAG_EMBEDDING_BATCH_SIZE = PersistentConfig(
  1192. "RAG_EMBEDDING_BATCH_SIZE",
  1193. "rag.embedding_batch_size",
  1194. int(
  1195. os.environ.get("RAG_EMBEDDING_BATCH_SIZE")
  1196. or os.environ.get("RAG_EMBEDDING_OPENAI_BATCH_SIZE", "1")
  1197. ),
  1198. )
  1199. RAG_RERANKING_MODEL = PersistentConfig(
  1200. "RAG_RERANKING_MODEL",
  1201. "rag.reranking_model",
  1202. os.environ.get("RAG_RERANKING_MODEL", ""),
  1203. )
  1204. if RAG_RERANKING_MODEL.value != "":
  1205. log.info(f"Reranking model set: {RAG_RERANKING_MODEL.value}")
  1206. RAG_RERANKING_MODEL_AUTO_UPDATE = (
  1207. not OFFLINE_MODE
  1208. and os.environ.get("RAG_RERANKING_MODEL_AUTO_UPDATE", "True").lower() == "true"
  1209. )
  1210. RAG_RERANKING_MODEL_TRUST_REMOTE_CODE = (
  1211. os.environ.get("RAG_RERANKING_MODEL_TRUST_REMOTE_CODE", "True").lower() == "true"
  1212. )
  1213. RAG_TEXT_SPLITTER = PersistentConfig(
  1214. "RAG_TEXT_SPLITTER",
  1215. "rag.text_splitter",
  1216. os.environ.get("RAG_TEXT_SPLITTER", ""),
  1217. )
  1218. TIKTOKEN_CACHE_DIR = os.environ.get("TIKTOKEN_CACHE_DIR", f"{CACHE_DIR}/tiktoken")
  1219. TIKTOKEN_ENCODING_NAME = PersistentConfig(
  1220. "TIKTOKEN_ENCODING_NAME",
  1221. "rag.tiktoken_encoding_name",
  1222. os.environ.get("TIKTOKEN_ENCODING_NAME", "cl100k_base"),
  1223. )
  1224. CHUNK_SIZE = PersistentConfig(
  1225. "CHUNK_SIZE", "rag.chunk_size", int(os.environ.get("CHUNK_SIZE", "1000"))
  1226. )
  1227. CHUNK_OVERLAP = PersistentConfig(
  1228. "CHUNK_OVERLAP",
  1229. "rag.chunk_overlap",
  1230. int(os.environ.get("CHUNK_OVERLAP", "100")),
  1231. )
  1232. DEFAULT_RAG_TEMPLATE = """### Task:
  1233. Respond to the user query using the provided context, incorporating inline citations in the format [source_id] **only when the <source_id> tag is explicitly provided** in the context.
  1234. ### Guidelines:
  1235. - If you don't know the answer, clearly state that.
  1236. - If uncertain, ask the user for clarification.
  1237. - Respond in the same language as the user's query.
  1238. - If the context is unreadable or of poor quality, inform the user and provide the best possible answer.
  1239. - 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.
  1240. - **Only include inline citations using [source_id] when a <source_id> tag is explicitly provided in the context.**
  1241. - Do not cite if the <source_id> tag is not provided in the context.
  1242. - Do not use XML tags in your response.
  1243. - Ensure citations are concise and directly related to the information provided.
  1244. ### Example of Citation:
  1245. If the user asks about a specific topic and the information is found in "whitepaper.pdf" with a provided <source_id>, the response should include the citation like so:
  1246. * "According to the study, the proposed method increases efficiency by 20% [whitepaper.pdf]."
  1247. If no <source_id> is present, the response should omit the citation.
  1248. ### Output:
  1249. Provide a clear and direct response to the user's query, including inline citations in the format [source_id] only when the <source_id> tag is present in the context.
  1250. <context>
  1251. {{CONTEXT}}
  1252. </context>
  1253. <user_query>
  1254. {{QUERY}}
  1255. </user_query>
  1256. """
  1257. RAG_TEMPLATE = PersistentConfig(
  1258. "RAG_TEMPLATE",
  1259. "rag.template",
  1260. os.environ.get("RAG_TEMPLATE", DEFAULT_RAG_TEMPLATE),
  1261. )
  1262. RAG_OPENAI_API_BASE_URL = PersistentConfig(
  1263. "RAG_OPENAI_API_BASE_URL",
  1264. "rag.openai_api_base_url",
  1265. os.getenv("RAG_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  1266. )
  1267. RAG_OPENAI_API_KEY = PersistentConfig(
  1268. "RAG_OPENAI_API_KEY",
  1269. "rag.openai_api_key",
  1270. os.getenv("RAG_OPENAI_API_KEY", OPENAI_API_KEY),
  1271. )
  1272. RAG_OLLAMA_BASE_URL = PersistentConfig(
  1273. "RAG_OLLAMA_BASE_URL",
  1274. "rag.ollama.url",
  1275. os.getenv("RAG_OLLAMA_BASE_URL", OLLAMA_BASE_URL),
  1276. )
  1277. RAG_OLLAMA_API_KEY = PersistentConfig(
  1278. "RAG_OLLAMA_API_KEY",
  1279. "rag.ollama.key",
  1280. os.getenv("RAG_OLLAMA_API_KEY", ""),
  1281. )
  1282. ENABLE_RAG_LOCAL_WEB_FETCH = (
  1283. os.getenv("ENABLE_RAG_LOCAL_WEB_FETCH", "False").lower() == "true"
  1284. )
  1285. YOUTUBE_LOADER_LANGUAGE = PersistentConfig(
  1286. "YOUTUBE_LOADER_LANGUAGE",
  1287. "rag.youtube_loader_language",
  1288. os.getenv("YOUTUBE_LOADER_LANGUAGE", "en").split(","),
  1289. )
  1290. YOUTUBE_LOADER_PROXY_URL = PersistentConfig(
  1291. "YOUTUBE_LOADER_PROXY_URL",
  1292. "rag.youtube_loader_proxy_url",
  1293. os.getenv("YOUTUBE_LOADER_PROXY_URL", ""),
  1294. )
  1295. ENABLE_RAG_WEB_SEARCH = PersistentConfig(
  1296. "ENABLE_RAG_WEB_SEARCH",
  1297. "rag.web.search.enable",
  1298. os.getenv("ENABLE_RAG_WEB_SEARCH", "False").lower() == "true",
  1299. )
  1300. RAG_WEB_SEARCH_ENGINE = PersistentConfig(
  1301. "RAG_WEB_SEARCH_ENGINE",
  1302. "rag.web.search.engine",
  1303. os.getenv("RAG_WEB_SEARCH_ENGINE", ""),
  1304. )
  1305. # You can provide a list of your own websites to filter after performing a web search.
  1306. # This ensures the highest level of safety and reliability of the information sources.
  1307. RAG_WEB_SEARCH_DOMAIN_FILTER_LIST = PersistentConfig(
  1308. "RAG_WEB_SEARCH_DOMAIN_FILTER_LIST",
  1309. "rag.rag.web.search.domain.filter_list",
  1310. [
  1311. # "wikipedia.com",
  1312. # "wikimedia.org",
  1313. # "wikidata.org",
  1314. ],
  1315. )
  1316. SEARXNG_QUERY_URL = PersistentConfig(
  1317. "SEARXNG_QUERY_URL",
  1318. "rag.web.search.searxng_query_url",
  1319. os.getenv("SEARXNG_QUERY_URL", ""),
  1320. )
  1321. GOOGLE_PSE_API_KEY = PersistentConfig(
  1322. "GOOGLE_PSE_API_KEY",
  1323. "rag.web.search.google_pse_api_key",
  1324. os.getenv("GOOGLE_PSE_API_KEY", ""),
  1325. )
  1326. GOOGLE_PSE_ENGINE_ID = PersistentConfig(
  1327. "GOOGLE_PSE_ENGINE_ID",
  1328. "rag.web.search.google_pse_engine_id",
  1329. os.getenv("GOOGLE_PSE_ENGINE_ID", ""),
  1330. )
  1331. BRAVE_SEARCH_API_KEY = PersistentConfig(
  1332. "BRAVE_SEARCH_API_KEY",
  1333. "rag.web.search.brave_search_api_key",
  1334. os.getenv("BRAVE_SEARCH_API_KEY", ""),
  1335. )
  1336. KAGI_SEARCH_API_KEY = PersistentConfig(
  1337. "KAGI_SEARCH_API_KEY",
  1338. "rag.web.search.kagi_search_api_key",
  1339. os.getenv("KAGI_SEARCH_API_KEY", ""),
  1340. )
  1341. MOJEEK_SEARCH_API_KEY = PersistentConfig(
  1342. "MOJEEK_SEARCH_API_KEY",
  1343. "rag.web.search.mojeek_search_api_key",
  1344. os.getenv("MOJEEK_SEARCH_API_KEY", ""),
  1345. )
  1346. SERPSTACK_API_KEY = PersistentConfig(
  1347. "SERPSTACK_API_KEY",
  1348. "rag.web.search.serpstack_api_key",
  1349. os.getenv("SERPSTACK_API_KEY", ""),
  1350. )
  1351. SERPSTACK_HTTPS = PersistentConfig(
  1352. "SERPSTACK_HTTPS",
  1353. "rag.web.search.serpstack_https",
  1354. os.getenv("SERPSTACK_HTTPS", "True").lower() == "true",
  1355. )
  1356. SERPER_API_KEY = PersistentConfig(
  1357. "SERPER_API_KEY",
  1358. "rag.web.search.serper_api_key",
  1359. os.getenv("SERPER_API_KEY", ""),
  1360. )
  1361. SERPLY_API_KEY = PersistentConfig(
  1362. "SERPLY_API_KEY",
  1363. "rag.web.search.serply_api_key",
  1364. os.getenv("SERPLY_API_KEY", ""),
  1365. )
  1366. TAVILY_API_KEY = PersistentConfig(
  1367. "TAVILY_API_KEY",
  1368. "rag.web.search.tavily_api_key",
  1369. os.getenv("TAVILY_API_KEY", ""),
  1370. )
  1371. JINA_API_KEY = PersistentConfig(
  1372. "JINA_API_KEY",
  1373. "rag.web.search.jina_api_key",
  1374. os.getenv("JINA_API_KEY", ""),
  1375. )
  1376. SEARCHAPI_API_KEY = PersistentConfig(
  1377. "SEARCHAPI_API_KEY",
  1378. "rag.web.search.searchapi_api_key",
  1379. os.getenv("SEARCHAPI_API_KEY", ""),
  1380. )
  1381. SEARCHAPI_ENGINE = PersistentConfig(
  1382. "SEARCHAPI_ENGINE",
  1383. "rag.web.search.searchapi_engine",
  1384. os.getenv("SEARCHAPI_ENGINE", ""),
  1385. )
  1386. BING_SEARCH_V7_ENDPOINT = PersistentConfig(
  1387. "BING_SEARCH_V7_ENDPOINT",
  1388. "rag.web.search.bing_search_v7_endpoint",
  1389. os.environ.get(
  1390. "BING_SEARCH_V7_ENDPOINT", "https://api.bing.microsoft.com/v7.0/search"
  1391. ),
  1392. )
  1393. BING_SEARCH_V7_SUBSCRIPTION_KEY = PersistentConfig(
  1394. "BING_SEARCH_V7_SUBSCRIPTION_KEY",
  1395. "rag.web.search.bing_search_v7_subscription_key",
  1396. os.environ.get("BING_SEARCH_V7_SUBSCRIPTION_KEY", ""),
  1397. )
  1398. RAG_WEB_SEARCH_RESULT_COUNT = PersistentConfig(
  1399. "RAG_WEB_SEARCH_RESULT_COUNT",
  1400. "rag.web.search.result_count",
  1401. int(os.getenv("RAG_WEB_SEARCH_RESULT_COUNT", "3")),
  1402. )
  1403. RAG_WEB_SEARCH_CONCURRENT_REQUESTS = PersistentConfig(
  1404. "RAG_WEB_SEARCH_CONCURRENT_REQUESTS",
  1405. "rag.web.search.concurrent_requests",
  1406. int(os.getenv("RAG_WEB_SEARCH_CONCURRENT_REQUESTS", "10")),
  1407. )
  1408. ####################################
  1409. # Images
  1410. ####################################
  1411. IMAGE_GENERATION_ENGINE = PersistentConfig(
  1412. "IMAGE_GENERATION_ENGINE",
  1413. "image_generation.engine",
  1414. os.getenv("IMAGE_GENERATION_ENGINE", "openai"),
  1415. )
  1416. ENABLE_IMAGE_GENERATION = PersistentConfig(
  1417. "ENABLE_IMAGE_GENERATION",
  1418. "image_generation.enable",
  1419. os.environ.get("ENABLE_IMAGE_GENERATION", "").lower() == "true",
  1420. )
  1421. ENABLE_IMAGE_PROMPT_GENERATION = PersistentConfig(
  1422. "ENABLE_IMAGE_PROMPT_GENERATION",
  1423. "image_generation.prompt.enable",
  1424. os.environ.get("ENABLE_IMAGE_PROMPT_GENERATION", "true").lower() == "true",
  1425. )
  1426. AUTOMATIC1111_BASE_URL = PersistentConfig(
  1427. "AUTOMATIC1111_BASE_URL",
  1428. "image_generation.automatic1111.base_url",
  1429. os.getenv("AUTOMATIC1111_BASE_URL", ""),
  1430. )
  1431. AUTOMATIC1111_API_AUTH = PersistentConfig(
  1432. "AUTOMATIC1111_API_AUTH",
  1433. "image_generation.automatic1111.api_auth",
  1434. os.getenv("AUTOMATIC1111_API_AUTH", ""),
  1435. )
  1436. AUTOMATIC1111_CFG_SCALE = PersistentConfig(
  1437. "AUTOMATIC1111_CFG_SCALE",
  1438. "image_generation.automatic1111.cfg_scale",
  1439. (
  1440. float(os.environ.get("AUTOMATIC1111_CFG_SCALE"))
  1441. if os.environ.get("AUTOMATIC1111_CFG_SCALE")
  1442. else None
  1443. ),
  1444. )
  1445. AUTOMATIC1111_SAMPLER = PersistentConfig(
  1446. "AUTOMATIC1111_SAMPLER",
  1447. "image_generation.automatic1111.sampler",
  1448. (
  1449. os.environ.get("AUTOMATIC1111_SAMPLER")
  1450. if os.environ.get("AUTOMATIC1111_SAMPLER")
  1451. else None
  1452. ),
  1453. )
  1454. AUTOMATIC1111_SCHEDULER = PersistentConfig(
  1455. "AUTOMATIC1111_SCHEDULER",
  1456. "image_generation.automatic1111.scheduler",
  1457. (
  1458. os.environ.get("AUTOMATIC1111_SCHEDULER")
  1459. if os.environ.get("AUTOMATIC1111_SCHEDULER")
  1460. else None
  1461. ),
  1462. )
  1463. COMFYUI_BASE_URL = PersistentConfig(
  1464. "COMFYUI_BASE_URL",
  1465. "image_generation.comfyui.base_url",
  1466. os.getenv("COMFYUI_BASE_URL", ""),
  1467. )
  1468. COMFYUI_API_KEY = PersistentConfig(
  1469. "COMFYUI_API_KEY",
  1470. "image_generation.comfyui.api_key",
  1471. os.getenv("COMFYUI_API_KEY", ""),
  1472. )
  1473. COMFYUI_DEFAULT_WORKFLOW = """
  1474. {
  1475. "3": {
  1476. "inputs": {
  1477. "seed": 0,
  1478. "steps": 20,
  1479. "cfg": 8,
  1480. "sampler_name": "euler",
  1481. "scheduler": "normal",
  1482. "denoise": 1,
  1483. "model": [
  1484. "4",
  1485. 0
  1486. ],
  1487. "positive": [
  1488. "6",
  1489. 0
  1490. ],
  1491. "negative": [
  1492. "7",
  1493. 0
  1494. ],
  1495. "latent_image": [
  1496. "5",
  1497. 0
  1498. ]
  1499. },
  1500. "class_type": "KSampler",
  1501. "_meta": {
  1502. "title": "KSampler"
  1503. }
  1504. },
  1505. "4": {
  1506. "inputs": {
  1507. "ckpt_name": "model.safetensors"
  1508. },
  1509. "class_type": "CheckpointLoaderSimple",
  1510. "_meta": {
  1511. "title": "Load Checkpoint"
  1512. }
  1513. },
  1514. "5": {
  1515. "inputs": {
  1516. "width": 512,
  1517. "height": 512,
  1518. "batch_size": 1
  1519. },
  1520. "class_type": "EmptyLatentImage",
  1521. "_meta": {
  1522. "title": "Empty Latent Image"
  1523. }
  1524. },
  1525. "6": {
  1526. "inputs": {
  1527. "text": "Prompt",
  1528. "clip": [
  1529. "4",
  1530. 1
  1531. ]
  1532. },
  1533. "class_type": "CLIPTextEncode",
  1534. "_meta": {
  1535. "title": "CLIP Text Encode (Prompt)"
  1536. }
  1537. },
  1538. "7": {
  1539. "inputs": {
  1540. "text": "",
  1541. "clip": [
  1542. "4",
  1543. 1
  1544. ]
  1545. },
  1546. "class_type": "CLIPTextEncode",
  1547. "_meta": {
  1548. "title": "CLIP Text Encode (Prompt)"
  1549. }
  1550. },
  1551. "8": {
  1552. "inputs": {
  1553. "samples": [
  1554. "3",
  1555. 0
  1556. ],
  1557. "vae": [
  1558. "4",
  1559. 2
  1560. ]
  1561. },
  1562. "class_type": "VAEDecode",
  1563. "_meta": {
  1564. "title": "VAE Decode"
  1565. }
  1566. },
  1567. "9": {
  1568. "inputs": {
  1569. "filename_prefix": "ComfyUI",
  1570. "images": [
  1571. "8",
  1572. 0
  1573. ]
  1574. },
  1575. "class_type": "SaveImage",
  1576. "_meta": {
  1577. "title": "Save Image"
  1578. }
  1579. }
  1580. }
  1581. """
  1582. COMFYUI_WORKFLOW = PersistentConfig(
  1583. "COMFYUI_WORKFLOW",
  1584. "image_generation.comfyui.workflow",
  1585. os.getenv("COMFYUI_WORKFLOW", COMFYUI_DEFAULT_WORKFLOW),
  1586. )
  1587. COMFYUI_WORKFLOW_NODES = PersistentConfig(
  1588. "COMFYUI_WORKFLOW",
  1589. "image_generation.comfyui.nodes",
  1590. [],
  1591. )
  1592. IMAGES_OPENAI_API_BASE_URL = PersistentConfig(
  1593. "IMAGES_OPENAI_API_BASE_URL",
  1594. "image_generation.openai.api_base_url",
  1595. os.getenv("IMAGES_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  1596. )
  1597. IMAGES_OPENAI_API_KEY = PersistentConfig(
  1598. "IMAGES_OPENAI_API_KEY",
  1599. "image_generation.openai.api_key",
  1600. os.getenv("IMAGES_OPENAI_API_KEY", OPENAI_API_KEY),
  1601. )
  1602. IMAGE_SIZE = PersistentConfig(
  1603. "IMAGE_SIZE", "image_generation.size", os.getenv("IMAGE_SIZE", "512x512")
  1604. )
  1605. IMAGE_STEPS = PersistentConfig(
  1606. "IMAGE_STEPS", "image_generation.steps", int(os.getenv("IMAGE_STEPS", 50))
  1607. )
  1608. IMAGE_GENERATION_MODEL = PersistentConfig(
  1609. "IMAGE_GENERATION_MODEL",
  1610. "image_generation.model",
  1611. os.getenv("IMAGE_GENERATION_MODEL", ""),
  1612. )
  1613. ####################################
  1614. # Audio
  1615. ####################################
  1616. # Transcription
  1617. WHISPER_MODEL = PersistentConfig(
  1618. "WHISPER_MODEL",
  1619. "audio.stt.whisper_model",
  1620. os.getenv("WHISPER_MODEL", "base"),
  1621. )
  1622. WHISPER_MODEL_DIR = os.getenv("WHISPER_MODEL_DIR", f"{CACHE_DIR}/whisper/models")
  1623. WHISPER_MODEL_AUTO_UPDATE = (
  1624. not OFFLINE_MODE
  1625. and os.environ.get("WHISPER_MODEL_AUTO_UPDATE", "").lower() == "true"
  1626. )
  1627. AUDIO_STT_OPENAI_API_BASE_URL = PersistentConfig(
  1628. "AUDIO_STT_OPENAI_API_BASE_URL",
  1629. "audio.stt.openai.api_base_url",
  1630. os.getenv("AUDIO_STT_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  1631. )
  1632. AUDIO_STT_OPENAI_API_KEY = PersistentConfig(
  1633. "AUDIO_STT_OPENAI_API_KEY",
  1634. "audio.stt.openai.api_key",
  1635. os.getenv("AUDIO_STT_OPENAI_API_KEY", OPENAI_API_KEY),
  1636. )
  1637. AUDIO_STT_ENGINE = PersistentConfig(
  1638. "AUDIO_STT_ENGINE",
  1639. "audio.stt.engine",
  1640. os.getenv("AUDIO_STT_ENGINE", ""),
  1641. )
  1642. AUDIO_STT_MODEL = PersistentConfig(
  1643. "AUDIO_STT_MODEL",
  1644. "audio.stt.model",
  1645. os.getenv("AUDIO_STT_MODEL", ""),
  1646. )
  1647. AUDIO_TTS_OPENAI_API_BASE_URL = PersistentConfig(
  1648. "AUDIO_TTS_OPENAI_API_BASE_URL",
  1649. "audio.tts.openai.api_base_url",
  1650. os.getenv("AUDIO_TTS_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  1651. )
  1652. AUDIO_TTS_OPENAI_API_KEY = PersistentConfig(
  1653. "AUDIO_TTS_OPENAI_API_KEY",
  1654. "audio.tts.openai.api_key",
  1655. os.getenv("AUDIO_TTS_OPENAI_API_KEY", OPENAI_API_KEY),
  1656. )
  1657. AUDIO_TTS_API_KEY = PersistentConfig(
  1658. "AUDIO_TTS_API_KEY",
  1659. "audio.tts.api_key",
  1660. os.getenv("AUDIO_TTS_API_KEY", ""),
  1661. )
  1662. AUDIO_TTS_ENGINE = PersistentConfig(
  1663. "AUDIO_TTS_ENGINE",
  1664. "audio.tts.engine",
  1665. os.getenv("AUDIO_TTS_ENGINE", ""),
  1666. )
  1667. AUDIO_TTS_MODEL = PersistentConfig(
  1668. "AUDIO_TTS_MODEL",
  1669. "audio.tts.model",
  1670. os.getenv("AUDIO_TTS_MODEL", "tts-1"), # OpenAI default model
  1671. )
  1672. AUDIO_TTS_VOICE = PersistentConfig(
  1673. "AUDIO_TTS_VOICE",
  1674. "audio.tts.voice",
  1675. os.getenv("AUDIO_TTS_VOICE", "alloy"), # OpenAI default voice
  1676. )
  1677. AUDIO_TTS_SPLIT_ON = PersistentConfig(
  1678. "AUDIO_TTS_SPLIT_ON",
  1679. "audio.tts.split_on",
  1680. os.getenv("AUDIO_TTS_SPLIT_ON", "punctuation"),
  1681. )
  1682. AUDIO_TTS_AZURE_SPEECH_REGION = PersistentConfig(
  1683. "AUDIO_TTS_AZURE_SPEECH_REGION",
  1684. "audio.tts.azure.speech_region",
  1685. os.getenv("AUDIO_TTS_AZURE_SPEECH_REGION", "eastus"),
  1686. )
  1687. AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT = PersistentConfig(
  1688. "AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT",
  1689. "audio.tts.azure.speech_output_format",
  1690. os.getenv(
  1691. "AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT", "audio-24khz-160kbitrate-mono-mp3"
  1692. ),
  1693. )
  1694. ####################################
  1695. # LDAP
  1696. ####################################
  1697. ENABLE_LDAP = PersistentConfig(
  1698. "ENABLE_LDAP",
  1699. "ldap.enable",
  1700. os.environ.get("ENABLE_LDAP", "false").lower() == "true",
  1701. )
  1702. LDAP_SERVER_LABEL = PersistentConfig(
  1703. "LDAP_SERVER_LABEL",
  1704. "ldap.server.label",
  1705. os.environ.get("LDAP_SERVER_LABEL", "LDAP Server"),
  1706. )
  1707. LDAP_SERVER_HOST = PersistentConfig(
  1708. "LDAP_SERVER_HOST",
  1709. "ldap.server.host",
  1710. os.environ.get("LDAP_SERVER_HOST", "localhost"),
  1711. )
  1712. LDAP_SERVER_PORT = PersistentConfig(
  1713. "LDAP_SERVER_PORT",
  1714. "ldap.server.port",
  1715. int(os.environ.get("LDAP_SERVER_PORT", "389")),
  1716. )
  1717. LDAP_ATTRIBUTE_FOR_MAIL = PersistentConfig(
  1718. "LDAP_ATTRIBUTE_FOR_MAIL",
  1719. "ldap.server.attribute_for_mail",
  1720. os.environ.get("LDAP_ATTRIBUTE_FOR_MAIL", "mail"),
  1721. )
  1722. LDAP_ATTRIBUTE_FOR_USERNAME = PersistentConfig(
  1723. "LDAP_ATTRIBUTE_FOR_USERNAME",
  1724. "ldap.server.attribute_for_username",
  1725. os.environ.get("LDAP_ATTRIBUTE_FOR_USERNAME", "uid"),
  1726. )
  1727. LDAP_APP_DN = PersistentConfig(
  1728. "LDAP_APP_DN", "ldap.server.app_dn", os.environ.get("LDAP_APP_DN", "")
  1729. )
  1730. LDAP_APP_PASSWORD = PersistentConfig(
  1731. "LDAP_APP_PASSWORD",
  1732. "ldap.server.app_password",
  1733. os.environ.get("LDAP_APP_PASSWORD", ""),
  1734. )
  1735. LDAP_SEARCH_BASE = PersistentConfig(
  1736. "LDAP_SEARCH_BASE", "ldap.server.users_dn", os.environ.get("LDAP_SEARCH_BASE", "")
  1737. )
  1738. LDAP_SEARCH_FILTERS = PersistentConfig(
  1739. "LDAP_SEARCH_FILTER",
  1740. "ldap.server.search_filter",
  1741. os.environ.get("LDAP_SEARCH_FILTER", ""),
  1742. )
  1743. LDAP_USE_TLS = PersistentConfig(
  1744. "LDAP_USE_TLS",
  1745. "ldap.server.use_tls",
  1746. os.environ.get("LDAP_USE_TLS", "True").lower() == "true",
  1747. )
  1748. LDAP_CA_CERT_FILE = PersistentConfig(
  1749. "LDAP_CA_CERT_FILE",
  1750. "ldap.server.ca_cert_file",
  1751. os.environ.get("LDAP_CA_CERT_FILE", ""),
  1752. )
  1753. LDAP_CIPHERS = PersistentConfig(
  1754. "LDAP_CIPHERS", "ldap.server.ciphers", os.environ.get("LDAP_CIPHERS", "ALL")
  1755. )