config.py 24 KB

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