config.py 23 KB

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