config.py 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862
  1. import os
  2. import sys
  3. import logging
  4. import importlib.metadata
  5. import pkgutil
  6. import chromadb
  7. from chromadb import Settings
  8. from base64 import b64encode
  9. from bs4 import BeautifulSoup
  10. from typing import TypeVar, Generic, Union
  11. from pydantic import BaseModel
  12. from typing import Optional
  13. from pathlib import Path
  14. import json
  15. import yaml
  16. import markdown
  17. import requests
  18. import shutil
  19. from secrets import token_bytes
  20. from constants import ERROR_MESSAGES
  21. ####################################
  22. # Load .env file
  23. ####################################
  24. BACKEND_DIR = Path(__file__).parent # the path containing this file
  25. BASE_DIR = BACKEND_DIR.parent # the path containing the backend/
  26. print(BASE_DIR)
  27. try:
  28. from dotenv import load_dotenv, find_dotenv
  29. load_dotenv(find_dotenv(str(BASE_DIR / ".env")))
  30. except ImportError:
  31. print("dotenv not installed, skipping...")
  32. ####################################
  33. # LOGGING
  34. ####################################
  35. log_levels = ["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"]
  36. GLOBAL_LOG_LEVEL = os.environ.get("GLOBAL_LOG_LEVEL", "").upper()
  37. if GLOBAL_LOG_LEVEL in log_levels:
  38. logging.basicConfig(stream=sys.stdout, level=GLOBAL_LOG_LEVEL, force=True)
  39. else:
  40. GLOBAL_LOG_LEVEL = "INFO"
  41. log = logging.getLogger(__name__)
  42. log.info(f"GLOBAL_LOG_LEVEL: {GLOBAL_LOG_LEVEL}")
  43. log_sources = [
  44. "AUDIO",
  45. "COMFYUI",
  46. "CONFIG",
  47. "DB",
  48. "IMAGES",
  49. "MAIN",
  50. "MODELS",
  51. "OLLAMA",
  52. "OPENAI",
  53. "RAG",
  54. "WEBHOOK",
  55. ]
  56. SRC_LOG_LEVELS = {}
  57. for source in log_sources:
  58. log_env_var = source + "_LOG_LEVEL"
  59. SRC_LOG_LEVELS[source] = os.environ.get(log_env_var, "").upper()
  60. if SRC_LOG_LEVELS[source] not in log_levels:
  61. SRC_LOG_LEVELS[source] = GLOBAL_LOG_LEVEL
  62. log.info(f"{log_env_var}: {SRC_LOG_LEVELS[source]}")
  63. log.setLevel(SRC_LOG_LEVELS["CONFIG"])
  64. WEBUI_NAME = os.environ.get("WEBUI_NAME", "Open WebUI")
  65. if WEBUI_NAME != "Open WebUI":
  66. WEBUI_NAME += " (Open WebUI)"
  67. WEBUI_URL = os.environ.get("WEBUI_URL", "http://localhost:3000")
  68. WEBUI_FAVICON_URL = "https://openwebui.com/favicon.png"
  69. ####################################
  70. # ENV (dev,test,prod)
  71. ####################################
  72. ENV = os.environ.get("ENV", "dev")
  73. try:
  74. PACKAGE_DATA = json.loads((BASE_DIR / "package.json").read_text())
  75. except:
  76. try:
  77. PACKAGE_DATA = {"version": importlib.metadata.version("open-webui")}
  78. except importlib.metadata.PackageNotFoundError:
  79. PACKAGE_DATA = {"version": "0.0.0"}
  80. VERSION = PACKAGE_DATA["version"]
  81. # Function to parse each section
  82. def parse_section(section):
  83. items = []
  84. for li in section.find_all("li"):
  85. # Extract raw HTML string
  86. raw_html = str(li)
  87. # Extract text without HTML tags
  88. text = li.get_text(separator=" ", strip=True)
  89. # Split into title and content
  90. parts = text.split(": ", 1)
  91. title = parts[0].strip() if len(parts) > 1 else ""
  92. content = parts[1].strip() if len(parts) > 1 else text
  93. items.append({"title": title, "content": content, "raw": raw_html})
  94. return items
  95. try:
  96. changelog_path = BASE_DIR / "CHANGELOG.md"
  97. with open(str(changelog_path.absolute()), "r", encoding="utf8") as file:
  98. changelog_content = file.read()
  99. except:
  100. changelog_content = (pkgutil.get_data("open_webui", "CHANGELOG.md") or b"").decode()
  101. # Convert markdown content to HTML
  102. html_content = markdown.markdown(changelog_content)
  103. # Parse the HTML content
  104. soup = BeautifulSoup(html_content, "html.parser")
  105. # Initialize JSON structure
  106. changelog_json = {}
  107. # Iterate over each version
  108. for version in soup.find_all("h2"):
  109. version_number = version.get_text().strip().split(" - ")[0][1:-1] # Remove brackets
  110. date = version.get_text().strip().split(" - ")[1]
  111. version_data = {"date": date}
  112. # Find the next sibling that is a h3 tag (section title)
  113. current = version.find_next_sibling()
  114. while current and current.name != "h2":
  115. if current.name == "h3":
  116. section_title = current.get_text().lower() # e.g., "added", "fixed"
  117. section_items = parse_section(current.find_next_sibling("ul"))
  118. version_data[section_title] = section_items
  119. # Move to the next element
  120. current = current.find_next_sibling()
  121. changelog_json[version_number] = version_data
  122. CHANGELOG = changelog_json
  123. ####################################
  124. # WEBUI_BUILD_HASH
  125. ####################################
  126. WEBUI_BUILD_HASH = os.environ.get("WEBUI_BUILD_HASH", "dev-build")
  127. ####################################
  128. # DATA/FRONTEND BUILD DIR
  129. ####################################
  130. DATA_DIR = Path(os.getenv("DATA_DIR", BACKEND_DIR / "data")).resolve()
  131. FRONTEND_BUILD_DIR = Path(os.getenv("FRONTEND_BUILD_DIR", BASE_DIR / "build")).resolve()
  132. try:
  133. CONFIG_DATA = json.loads((DATA_DIR / "config.json").read_text())
  134. except:
  135. CONFIG_DATA = {}
  136. ####################################
  137. # Config helpers
  138. ####################################
  139. def save_config():
  140. try:
  141. with open(f"{DATA_DIR}/config.json", "w") as f:
  142. json.dump(CONFIG_DATA, f, indent="\t")
  143. except Exception as e:
  144. log.exception(e)
  145. def get_config_value(config_path: str):
  146. path_parts = config_path.split(".")
  147. cur_config = CONFIG_DATA
  148. for key in path_parts:
  149. if key in cur_config:
  150. cur_config = cur_config[key]
  151. else:
  152. return None
  153. return cur_config
  154. T = TypeVar("T")
  155. class PersistentConfig(Generic[T]):
  156. def __init__(self, env_name: str, config_path: str, env_value: T):
  157. self.env_name = env_name
  158. self.config_path = config_path
  159. self.env_value = env_value
  160. self.config_value = get_config_value(config_path)
  161. if self.config_value is not None:
  162. log.info(f"'{env_name}' loaded from config.json")
  163. self.value = self.config_value
  164. else:
  165. self.value = env_value
  166. def __str__(self):
  167. return str(self.value)
  168. @property
  169. def __dict__(self):
  170. raise TypeError(
  171. "PersistentConfig object cannot be converted to dict, use config_get or .value instead."
  172. )
  173. def __getattribute__(self, item):
  174. if item == "__dict__":
  175. raise TypeError(
  176. "PersistentConfig object cannot be converted to dict, use config_get or .value instead."
  177. )
  178. return super().__getattribute__(item)
  179. def save(self):
  180. # Don't save if the value is the same as the env value and the config value
  181. if self.env_value == self.value:
  182. if self.config_value == self.value:
  183. return
  184. log.info(f"Saving '{self.env_name}' to config.json")
  185. path_parts = self.config_path.split(".")
  186. config = CONFIG_DATA
  187. for key in path_parts[:-1]:
  188. if key not in config:
  189. config[key] = {}
  190. config = config[key]
  191. config[path_parts[-1]] = self.value
  192. save_config()
  193. self.config_value = self.value
  194. class AppConfig:
  195. _state: dict[str, PersistentConfig]
  196. def __init__(self):
  197. super().__setattr__("_state", {})
  198. def __setattr__(self, key, value):
  199. if isinstance(value, PersistentConfig):
  200. self._state[key] = value
  201. else:
  202. self._state[key].value = value
  203. self._state[key].save()
  204. def __getattr__(self, key):
  205. return self._state[key].value
  206. ####################################
  207. # WEBUI_AUTH (Required for security)
  208. ####################################
  209. WEBUI_AUTH = os.environ.get("WEBUI_AUTH", "True").lower() == "true"
  210. WEBUI_AUTH_TRUSTED_EMAIL_HEADER = os.environ.get(
  211. "WEBUI_AUTH_TRUSTED_EMAIL_HEADER", None
  212. )
  213. JWT_EXPIRES_IN = PersistentConfig(
  214. "JWT_EXPIRES_IN", "auth.jwt_expiry", os.environ.get("JWT_EXPIRES_IN", "-1")
  215. )
  216. ####################################
  217. # Static DIR
  218. ####################################
  219. STATIC_DIR = Path(os.getenv("STATIC_DIR", BACKEND_DIR / "static")).resolve()
  220. frontend_favicon = FRONTEND_BUILD_DIR / "favicon.png"
  221. if frontend_favicon.exists():
  222. shutil.copyfile(frontend_favicon, STATIC_DIR / "favicon.png")
  223. else:
  224. logging.warning(f"Frontend favicon not found at {frontend_favicon}")
  225. ####################################
  226. # CUSTOM_NAME
  227. ####################################
  228. CUSTOM_NAME = os.environ.get("CUSTOM_NAME", "")
  229. if CUSTOM_NAME:
  230. try:
  231. r = requests.get(f"https://api.openwebui.com/api/v1/custom/{CUSTOM_NAME}")
  232. data = r.json()
  233. if r.ok:
  234. if "logo" in data:
  235. WEBUI_FAVICON_URL = url = (
  236. f"https://api.openwebui.com{data['logo']}"
  237. if data["logo"][0] == "/"
  238. else data["logo"]
  239. )
  240. r = requests.get(url, stream=True)
  241. if r.status_code == 200:
  242. with open(f"{STATIC_DIR}/favicon.png", "wb") as f:
  243. r.raw.decode_content = True
  244. shutil.copyfileobj(r.raw, f)
  245. WEBUI_NAME = data["name"]
  246. except Exception as e:
  247. log.exception(e)
  248. pass
  249. ####################################
  250. # File Upload DIR
  251. ####################################
  252. UPLOAD_DIR = f"{DATA_DIR}/uploads"
  253. Path(UPLOAD_DIR).mkdir(parents=True, exist_ok=True)
  254. ####################################
  255. # Cache DIR
  256. ####################################
  257. CACHE_DIR = f"{DATA_DIR}/cache"
  258. Path(CACHE_DIR).mkdir(parents=True, exist_ok=True)
  259. ####################################
  260. # Docs DIR
  261. ####################################
  262. DOCS_DIR = os.getenv("DOCS_DIR", f"{DATA_DIR}/docs")
  263. Path(DOCS_DIR).mkdir(parents=True, exist_ok=True)
  264. ####################################
  265. # LITELLM_CONFIG
  266. ####################################
  267. def create_config_file(file_path):
  268. directory = os.path.dirname(file_path)
  269. # Check if directory exists, if not, create it
  270. if not os.path.exists(directory):
  271. os.makedirs(directory)
  272. # Data to write into the YAML file
  273. config_data = {
  274. "general_settings": {},
  275. "litellm_settings": {},
  276. "model_list": [],
  277. "router_settings": {},
  278. }
  279. # Write data to YAML file
  280. with open(file_path, "w") as file:
  281. yaml.dump(config_data, file)
  282. LITELLM_CONFIG_PATH = f"{DATA_DIR}/litellm/config.yaml"
  283. # if not os.path.exists(LITELLM_CONFIG_PATH):
  284. # log.info("Config file doesn't exist. Creating...")
  285. # create_config_file(LITELLM_CONFIG_PATH)
  286. # log.info("Config file created successfully.")
  287. ####################################
  288. # OLLAMA_BASE_URL
  289. ####################################
  290. ENABLE_OLLAMA_API = PersistentConfig(
  291. "ENABLE_OLLAMA_API",
  292. "ollama.enable",
  293. os.environ.get("ENABLE_OLLAMA_API", "True").lower() == "true",
  294. )
  295. OLLAMA_API_BASE_URL = os.environ.get(
  296. "OLLAMA_API_BASE_URL", "http://localhost:11434/api"
  297. )
  298. OLLAMA_BASE_URL = os.environ.get("OLLAMA_BASE_URL", "")
  299. K8S_FLAG = os.environ.get("K8S_FLAG", "")
  300. USE_OLLAMA_DOCKER = os.environ.get("USE_OLLAMA_DOCKER", "false")
  301. if OLLAMA_BASE_URL == "" and OLLAMA_API_BASE_URL != "":
  302. OLLAMA_BASE_URL = (
  303. OLLAMA_API_BASE_URL[:-4]
  304. if OLLAMA_API_BASE_URL.endswith("/api")
  305. else OLLAMA_API_BASE_URL
  306. )
  307. if ENV == "prod":
  308. if OLLAMA_BASE_URL == "/ollama" and not K8S_FLAG:
  309. if USE_OLLAMA_DOCKER.lower() == "true":
  310. # if you use all-in-one docker container (Open WebUI + Ollama)
  311. # with the docker build arg USE_OLLAMA=true (--build-arg="USE_OLLAMA=true") this only works with http://localhost:11434
  312. OLLAMA_BASE_URL = "http://localhost:11434"
  313. else:
  314. OLLAMA_BASE_URL = "http://host.docker.internal:11434"
  315. elif K8S_FLAG:
  316. OLLAMA_BASE_URL = "http://ollama-service.open-webui.svc.cluster.local:11434"
  317. OLLAMA_BASE_URLS = os.environ.get("OLLAMA_BASE_URLS", "")
  318. OLLAMA_BASE_URLS = OLLAMA_BASE_URLS if OLLAMA_BASE_URLS != "" else OLLAMA_BASE_URL
  319. OLLAMA_BASE_URLS = [url.strip() for url in OLLAMA_BASE_URLS.split(";")]
  320. OLLAMA_BASE_URLS = PersistentConfig(
  321. "OLLAMA_BASE_URLS", "ollama.base_urls", OLLAMA_BASE_URLS
  322. )
  323. ####################################
  324. # OPENAI_API
  325. ####################################
  326. ENABLE_OPENAI_API = PersistentConfig(
  327. "ENABLE_OPENAI_API",
  328. "openai.enable",
  329. os.environ.get("ENABLE_OPENAI_API", "True").lower() == "true",
  330. )
  331. OPENAI_API_KEY = os.environ.get("OPENAI_API_KEY", "")
  332. OPENAI_API_BASE_URL = os.environ.get("OPENAI_API_BASE_URL", "")
  333. if OPENAI_API_BASE_URL == "":
  334. OPENAI_API_BASE_URL = "https://api.openai.com/v1"
  335. OPENAI_API_KEYS = os.environ.get("OPENAI_API_KEYS", "")
  336. OPENAI_API_KEYS = OPENAI_API_KEYS if OPENAI_API_KEYS != "" else OPENAI_API_KEY
  337. OPENAI_API_KEYS = [url.strip() for url in OPENAI_API_KEYS.split(";")]
  338. OPENAI_API_KEYS = PersistentConfig(
  339. "OPENAI_API_KEYS", "openai.api_keys", OPENAI_API_KEYS
  340. )
  341. OPENAI_API_BASE_URLS = os.environ.get("OPENAI_API_BASE_URLS", "")
  342. OPENAI_API_BASE_URLS = (
  343. OPENAI_API_BASE_URLS if OPENAI_API_BASE_URLS != "" else OPENAI_API_BASE_URL
  344. )
  345. OPENAI_API_BASE_URLS = [
  346. url.strip() if url != "" else "https://api.openai.com/v1"
  347. for url in OPENAI_API_BASE_URLS.split(";")
  348. ]
  349. OPENAI_API_BASE_URLS = PersistentConfig(
  350. "OPENAI_API_BASE_URLS", "openai.api_base_urls", OPENAI_API_BASE_URLS
  351. )
  352. OPENAI_API_KEY = ""
  353. try:
  354. OPENAI_API_KEY = OPENAI_API_KEYS.value[
  355. OPENAI_API_BASE_URLS.value.index("https://api.openai.com/v1")
  356. ]
  357. except:
  358. pass
  359. OPENAI_API_BASE_URL = "https://api.openai.com/v1"
  360. ####################################
  361. # WEBUI
  362. ####################################
  363. ENABLE_SIGNUP = PersistentConfig(
  364. "ENABLE_SIGNUP",
  365. "ui.enable_signup",
  366. (
  367. False
  368. if not WEBUI_AUTH
  369. else os.environ.get("ENABLE_SIGNUP", "True").lower() == "true"
  370. ),
  371. )
  372. DEFAULT_MODELS = PersistentConfig(
  373. "DEFAULT_MODELS", "ui.default_models", os.environ.get("DEFAULT_MODELS", None)
  374. )
  375. DEFAULT_PROMPT_SUGGESTIONS = PersistentConfig(
  376. "DEFAULT_PROMPT_SUGGESTIONS",
  377. "ui.prompt_suggestions",
  378. [
  379. {
  380. "title": ["Help me study", "vocabulary for a college entrance exam"],
  381. "content": "Help me study vocabulary: write a sentence for me to fill in the blank, and I'll try to pick the correct option.",
  382. },
  383. {
  384. "title": ["Give me ideas", "for what to do with my kids' art"],
  385. "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.",
  386. },
  387. {
  388. "title": ["Tell me a fun fact", "about the Roman Empire"],
  389. "content": "Tell me a random fun fact about the Roman Empire",
  390. },
  391. {
  392. "title": ["Show me a code snippet", "of a website's sticky header"],
  393. "content": "Show me a code snippet of a website's sticky header in CSS and JavaScript.",
  394. },
  395. {
  396. "title": [
  397. "Explain options trading",
  398. "if I'm familiar with buying and selling stocks",
  399. ],
  400. "content": "Explain options trading in simple terms if I'm familiar with buying and selling stocks.",
  401. },
  402. {
  403. "title": ["Overcome procrastination", "give me tips"],
  404. "content": "Could you start by asking me about instances when I procrastinate the most and then give me some suggestions to overcome it?",
  405. },
  406. ],
  407. )
  408. DEFAULT_USER_ROLE = PersistentConfig(
  409. "DEFAULT_USER_ROLE",
  410. "ui.default_user_role",
  411. os.getenv("DEFAULT_USER_ROLE", "pending"),
  412. )
  413. USER_PERMISSIONS_CHAT_DELETION = (
  414. os.environ.get("USER_PERMISSIONS_CHAT_DELETION", "True").lower() == "true"
  415. )
  416. USER_PERMISSIONS = PersistentConfig(
  417. "USER_PERMISSIONS",
  418. "ui.user_permissions",
  419. {"chat": {"deletion": USER_PERMISSIONS_CHAT_DELETION}},
  420. )
  421. ENABLE_MODEL_FILTER = PersistentConfig(
  422. "ENABLE_MODEL_FILTER",
  423. "model_filter.enable",
  424. os.environ.get("ENABLE_MODEL_FILTER", "False").lower() == "true",
  425. )
  426. MODEL_FILTER_LIST = os.environ.get("MODEL_FILTER_LIST", "")
  427. MODEL_FILTER_LIST = PersistentConfig(
  428. "MODEL_FILTER_LIST",
  429. "model_filter.list",
  430. [model.strip() for model in MODEL_FILTER_LIST.split(";")],
  431. )
  432. WEBHOOK_URL = PersistentConfig(
  433. "WEBHOOK_URL", "webhook_url", os.environ.get("WEBHOOK_URL", "")
  434. )
  435. ENABLE_ADMIN_EXPORT = os.environ.get("ENABLE_ADMIN_EXPORT", "True").lower() == "true"
  436. ENABLE_COMMUNITY_SHARING = PersistentConfig(
  437. "ENABLE_COMMUNITY_SHARING",
  438. "ui.enable_community_sharing",
  439. os.environ.get("ENABLE_COMMUNITY_SHARING", "True").lower() == "true",
  440. )
  441. class BannerModel(BaseModel):
  442. id: str
  443. type: str
  444. title: Optional[str] = None
  445. content: str
  446. dismissible: bool
  447. timestamp: int
  448. WEBUI_BANNERS = PersistentConfig(
  449. "WEBUI_BANNERS",
  450. "ui.banners",
  451. [BannerModel(**banner) for banner in json.loads("[]")],
  452. )
  453. ####################################
  454. # WEBUI_SECRET_KEY
  455. ####################################
  456. WEBUI_SECRET_KEY = os.environ.get(
  457. "WEBUI_SECRET_KEY",
  458. os.environ.get(
  459. "WEBUI_JWT_SECRET_KEY", "t0p-s3cr3t"
  460. ), # DEPRECATED: remove at next major version
  461. )
  462. if WEBUI_AUTH and WEBUI_SECRET_KEY == "":
  463. raise ValueError(ERROR_MESSAGES.ENV_VAR_NOT_FOUND)
  464. ####################################
  465. # RAG
  466. ####################################
  467. CHROMA_DATA_PATH = f"{DATA_DIR}/vector_db"
  468. CHROMA_TENANT = os.environ.get("CHROMA_TENANT", chromadb.DEFAULT_TENANT)
  469. CHROMA_DATABASE = os.environ.get("CHROMA_DATABASE", chromadb.DEFAULT_DATABASE)
  470. CHROMA_HTTP_HOST = os.environ.get("CHROMA_HTTP_HOST", "")
  471. CHROMA_HTTP_PORT = int(os.environ.get("CHROMA_HTTP_PORT", "8000"))
  472. # Comma-separated list of header=value pairs
  473. CHROMA_HTTP_HEADERS = os.environ.get("CHROMA_HTTP_HEADERS", "")
  474. if CHROMA_HTTP_HEADERS:
  475. CHROMA_HTTP_HEADERS = dict(
  476. [pair.split("=") for pair in CHROMA_HTTP_HEADERS.split(",")]
  477. )
  478. else:
  479. CHROMA_HTTP_HEADERS = None
  480. CHROMA_HTTP_SSL = os.environ.get("CHROMA_HTTP_SSL", "false").lower() == "true"
  481. # 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)
  482. RAG_TOP_K = PersistentConfig(
  483. "RAG_TOP_K", "rag.top_k", int(os.environ.get("RAG_TOP_K", "5"))
  484. )
  485. RAG_RELEVANCE_THRESHOLD = PersistentConfig(
  486. "RAG_RELEVANCE_THRESHOLD",
  487. "rag.relevance_threshold",
  488. float(os.environ.get("RAG_RELEVANCE_THRESHOLD", "0.0")),
  489. )
  490. ENABLE_RAG_HYBRID_SEARCH = PersistentConfig(
  491. "ENABLE_RAG_HYBRID_SEARCH",
  492. "rag.enable_hybrid_search",
  493. os.environ.get("ENABLE_RAG_HYBRID_SEARCH", "").lower() == "true",
  494. )
  495. ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION = PersistentConfig(
  496. "ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION",
  497. "rag.enable_web_loader_ssl_verification",
  498. os.environ.get("ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION", "True").lower() == "true",
  499. )
  500. RAG_EMBEDDING_ENGINE = PersistentConfig(
  501. "RAG_EMBEDDING_ENGINE",
  502. "rag.embedding_engine",
  503. os.environ.get("RAG_EMBEDDING_ENGINE", ""),
  504. )
  505. PDF_EXTRACT_IMAGES = PersistentConfig(
  506. "PDF_EXTRACT_IMAGES",
  507. "rag.pdf_extract_images",
  508. os.environ.get("PDF_EXTRACT_IMAGES", "False").lower() == "true",
  509. )
  510. RAG_EMBEDDING_MODEL = PersistentConfig(
  511. "RAG_EMBEDDING_MODEL",
  512. "rag.embedding_model",
  513. os.environ.get("RAG_EMBEDDING_MODEL", "sentence-transformers/all-MiniLM-L6-v2"),
  514. )
  515. log.info(f"Embedding model set: {RAG_EMBEDDING_MODEL.value}"),
  516. RAG_EMBEDDING_MODEL_AUTO_UPDATE = (
  517. os.environ.get("RAG_EMBEDDING_MODEL_AUTO_UPDATE", "").lower() == "true"
  518. )
  519. RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE = (
  520. os.environ.get("RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE", "").lower() == "true"
  521. )
  522. RAG_RERANKING_MODEL = PersistentConfig(
  523. "RAG_RERANKING_MODEL",
  524. "rag.reranking_model",
  525. os.environ.get("RAG_RERANKING_MODEL", ""),
  526. )
  527. if RAG_RERANKING_MODEL.value != "":
  528. log.info(f"Reranking model set: {RAG_RERANKING_MODEL.value}"),
  529. RAG_RERANKING_MODEL_AUTO_UPDATE = (
  530. os.environ.get("RAG_RERANKING_MODEL_AUTO_UPDATE", "").lower() == "true"
  531. )
  532. RAG_RERANKING_MODEL_TRUST_REMOTE_CODE = (
  533. os.environ.get("RAG_RERANKING_MODEL_TRUST_REMOTE_CODE", "").lower() == "true"
  534. )
  535. if CHROMA_HTTP_HOST != "":
  536. CHROMA_CLIENT = chromadb.HttpClient(
  537. host=CHROMA_HTTP_HOST,
  538. port=CHROMA_HTTP_PORT,
  539. headers=CHROMA_HTTP_HEADERS,
  540. ssl=CHROMA_HTTP_SSL,
  541. tenant=CHROMA_TENANT,
  542. database=CHROMA_DATABASE,
  543. settings=Settings(allow_reset=True, anonymized_telemetry=False),
  544. )
  545. else:
  546. CHROMA_CLIENT = chromadb.PersistentClient(
  547. path=CHROMA_DATA_PATH,
  548. settings=Settings(allow_reset=True, anonymized_telemetry=False),
  549. tenant=CHROMA_TENANT,
  550. database=CHROMA_DATABASE,
  551. )
  552. # device type embedding models - "cpu" (default), "cuda" (nvidia gpu required) or "mps" (apple silicon) - choosing this right can lead to better performance
  553. USE_CUDA = os.environ.get("USE_CUDA_DOCKER", "false")
  554. if USE_CUDA.lower() == "true":
  555. DEVICE_TYPE = "cuda"
  556. else:
  557. DEVICE_TYPE = "cpu"
  558. CHUNK_SIZE = PersistentConfig(
  559. "CHUNK_SIZE", "rag.chunk_size", int(os.environ.get("CHUNK_SIZE", "1500"))
  560. )
  561. CHUNK_OVERLAP = PersistentConfig(
  562. "CHUNK_OVERLAP",
  563. "rag.chunk_overlap",
  564. int(os.environ.get("CHUNK_OVERLAP", "100")),
  565. )
  566. DEFAULT_RAG_TEMPLATE = """Use the following context as your learned knowledge, inside <context></context> XML tags.
  567. <context>
  568. [context]
  569. </context>
  570. When answer to user:
  571. - If you don't know, just say that you don't know.
  572. - If you don't know when you are not sure, ask for clarification.
  573. Avoid mentioning that you obtained the information from the context.
  574. And answer according to the language of the user's question.
  575. Given the context information, answer the query.
  576. Query: [query]"""
  577. RAG_TEMPLATE = PersistentConfig(
  578. "RAG_TEMPLATE",
  579. "rag.template",
  580. os.environ.get("RAG_TEMPLATE", DEFAULT_RAG_TEMPLATE),
  581. )
  582. RAG_OPENAI_API_BASE_URL = PersistentConfig(
  583. "RAG_OPENAI_API_BASE_URL",
  584. "rag.openai_api_base_url",
  585. os.getenv("RAG_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  586. )
  587. RAG_OPENAI_API_KEY = PersistentConfig(
  588. "RAG_OPENAI_API_KEY",
  589. "rag.openai_api_key",
  590. os.getenv("RAG_OPENAI_API_KEY", OPENAI_API_KEY),
  591. )
  592. ENABLE_RAG_LOCAL_WEB_FETCH = (
  593. os.getenv("ENABLE_RAG_LOCAL_WEB_FETCH", "False").lower() == "true"
  594. )
  595. YOUTUBE_LOADER_LANGUAGE = PersistentConfig(
  596. "YOUTUBE_LOADER_LANGUAGE",
  597. "rag.youtube_loader_language",
  598. os.getenv("YOUTUBE_LOADER_LANGUAGE", "en").split(","),
  599. )
  600. ####################################
  601. # Transcribe
  602. ####################################
  603. WHISPER_MODEL = os.getenv("WHISPER_MODEL", "base")
  604. WHISPER_MODEL_DIR = os.getenv("WHISPER_MODEL_DIR", f"{CACHE_DIR}/whisper/models")
  605. WHISPER_MODEL_AUTO_UPDATE = (
  606. os.environ.get("WHISPER_MODEL_AUTO_UPDATE", "").lower() == "true"
  607. )
  608. ####################################
  609. # Images
  610. ####################################
  611. IMAGE_GENERATION_ENGINE = PersistentConfig(
  612. "IMAGE_GENERATION_ENGINE",
  613. "image_generation.engine",
  614. os.getenv("IMAGE_GENERATION_ENGINE", ""),
  615. )
  616. ENABLE_IMAGE_GENERATION = PersistentConfig(
  617. "ENABLE_IMAGE_GENERATION",
  618. "image_generation.enable",
  619. os.environ.get("ENABLE_IMAGE_GENERATION", "").lower() == "true",
  620. )
  621. AUTOMATIC1111_BASE_URL = PersistentConfig(
  622. "AUTOMATIC1111_BASE_URL",
  623. "image_generation.automatic1111.base_url",
  624. os.getenv("AUTOMATIC1111_BASE_URL", ""),
  625. )
  626. COMFYUI_BASE_URL = PersistentConfig(
  627. "COMFYUI_BASE_URL",
  628. "image_generation.comfyui.base_url",
  629. os.getenv("COMFYUI_BASE_URL", ""),
  630. )
  631. IMAGES_OPENAI_API_BASE_URL = PersistentConfig(
  632. "IMAGES_OPENAI_API_BASE_URL",
  633. "image_generation.openai.api_base_url",
  634. os.getenv("IMAGES_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  635. )
  636. IMAGES_OPENAI_API_KEY = PersistentConfig(
  637. "IMAGES_OPENAI_API_KEY",
  638. "image_generation.openai.api_key",
  639. os.getenv("IMAGES_OPENAI_API_KEY", OPENAI_API_KEY),
  640. )
  641. IMAGE_SIZE = PersistentConfig(
  642. "IMAGE_SIZE", "image_generation.size", os.getenv("IMAGE_SIZE", "512x512")
  643. )
  644. IMAGE_STEPS = PersistentConfig(
  645. "IMAGE_STEPS", "image_generation.steps", int(os.getenv("IMAGE_STEPS", 50))
  646. )
  647. IMAGE_GENERATION_MODEL = PersistentConfig(
  648. "IMAGE_GENERATION_MODEL",
  649. "image_generation.model",
  650. os.getenv("IMAGE_GENERATION_MODEL", ""),
  651. )
  652. ####################################
  653. # Audio
  654. ####################################
  655. AUDIO_OPENAI_API_BASE_URL = PersistentConfig(
  656. "AUDIO_OPENAI_API_BASE_URL",
  657. "audio.openai.api_base_url",
  658. os.getenv("AUDIO_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  659. )
  660. AUDIO_OPENAI_API_KEY = PersistentConfig(
  661. "AUDIO_OPENAI_API_KEY",
  662. "audio.openai.api_key",
  663. os.getenv("AUDIO_OPENAI_API_KEY", OPENAI_API_KEY),
  664. )
  665. AUDIO_OPENAI_API_MODEL = PersistentConfig(
  666. "AUDIO_OPENAI_API_MODEL",
  667. "audio.openai.api_model",
  668. os.getenv("AUDIO_OPENAI_API_MODEL", "tts-1"),
  669. )
  670. AUDIO_OPENAI_API_VOICE = PersistentConfig(
  671. "AUDIO_OPENAI_API_VOICE",
  672. "audio.openai.api_voice",
  673. os.getenv("AUDIO_OPENAI_API_VOICE", "alloy"),
  674. )
  675. ####################################
  676. # Database
  677. ####################################
  678. DATABASE_URL = os.environ.get("DATABASE_URL", f"sqlite:///{DATA_DIR}/webui.db")