config.py 24 KB

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