main.py 55 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656
  1. import asyncio
  2. import inspect
  3. import json
  4. import logging
  5. import mimetypes
  6. import os
  7. import shutil
  8. import sys
  9. import time
  10. import random
  11. from contextlib import asynccontextmanager
  12. from urllib.parse import urlencode, parse_qs, urlparse
  13. from pydantic import BaseModel
  14. from sqlalchemy import text
  15. from typing import Optional
  16. from aiocache import cached
  17. import aiohttp
  18. import anyio.to_thread
  19. import requests
  20. from fastapi import (
  21. Depends,
  22. FastAPI,
  23. File,
  24. Form,
  25. HTTPException,
  26. Request,
  27. UploadFile,
  28. status,
  29. applications,
  30. BackgroundTasks,
  31. )
  32. from fastapi.openapi.docs import get_swagger_ui_html
  33. from fastapi.middleware.cors import CORSMiddleware
  34. from fastapi.responses import JSONResponse, RedirectResponse
  35. from fastapi.staticfiles import StaticFiles
  36. from starlette_compress import CompressMiddleware
  37. from starlette.exceptions import HTTPException as StarletteHTTPException
  38. from starlette.middleware.base import BaseHTTPMiddleware
  39. from starlette.middleware.sessions import SessionMiddleware
  40. from starlette.responses import Response, StreamingResponse
  41. from open_webui.utils import logger
  42. from open_webui.utils.audit import AuditLevel, AuditLoggingMiddleware
  43. from open_webui.utils.logger import start_logger
  44. from open_webui.socket.main import (
  45. app as socket_app,
  46. periodic_usage_pool_cleanup,
  47. )
  48. from open_webui.routers import (
  49. audio,
  50. images,
  51. ollama,
  52. openai,
  53. retrieval,
  54. pipelines,
  55. tasks,
  56. auths,
  57. channels,
  58. chats,
  59. notes,
  60. folders,
  61. configs,
  62. groups,
  63. files,
  64. functions,
  65. memories,
  66. models,
  67. knowledge,
  68. prompts,
  69. evaluations,
  70. tools,
  71. users,
  72. utils,
  73. )
  74. from open_webui.routers.retrieval import (
  75. get_embedding_function,
  76. get_ef,
  77. get_rf,
  78. )
  79. from open_webui.internal.db import Session, engine
  80. from open_webui.models.functions import Functions
  81. from open_webui.models.models import Models
  82. from open_webui.models.users import UserModel, Users
  83. from open_webui.models.chats import Chats
  84. from open_webui.config import (
  85. LICENSE_KEY,
  86. # Ollama
  87. ENABLE_OLLAMA_API,
  88. OLLAMA_BASE_URLS,
  89. OLLAMA_API_CONFIGS,
  90. # OpenAI
  91. ENABLE_OPENAI_API,
  92. ONEDRIVE_CLIENT_ID,
  93. ONEDRIVE_SHAREPOINT_URL,
  94. ONEDRIVE_SHAREPOINT_TENANT_ID,
  95. OPENAI_API_BASE_URLS,
  96. OPENAI_API_KEYS,
  97. OPENAI_API_CONFIGS,
  98. # Direct Connections
  99. ENABLE_DIRECT_CONNECTIONS,
  100. # Thread pool size for FastAPI/AnyIO
  101. THREAD_POOL_SIZE,
  102. # Tool Server Configs
  103. TOOL_SERVER_CONNECTIONS,
  104. # Code Execution
  105. ENABLE_CODE_EXECUTION,
  106. CODE_EXECUTION_ENGINE,
  107. CODE_EXECUTION_JUPYTER_URL,
  108. CODE_EXECUTION_JUPYTER_AUTH,
  109. CODE_EXECUTION_JUPYTER_AUTH_TOKEN,
  110. CODE_EXECUTION_JUPYTER_AUTH_PASSWORD,
  111. CODE_EXECUTION_JUPYTER_TIMEOUT,
  112. ENABLE_CODE_INTERPRETER,
  113. CODE_INTERPRETER_ENGINE,
  114. CODE_INTERPRETER_PROMPT_TEMPLATE,
  115. CODE_INTERPRETER_JUPYTER_URL,
  116. CODE_INTERPRETER_JUPYTER_AUTH,
  117. CODE_INTERPRETER_JUPYTER_AUTH_TOKEN,
  118. CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD,
  119. CODE_INTERPRETER_JUPYTER_TIMEOUT,
  120. # Image
  121. AUTOMATIC1111_API_AUTH,
  122. AUTOMATIC1111_BASE_URL,
  123. AUTOMATIC1111_CFG_SCALE,
  124. AUTOMATIC1111_SAMPLER,
  125. AUTOMATIC1111_SCHEDULER,
  126. COMFYUI_BASE_URL,
  127. COMFYUI_API_KEY,
  128. COMFYUI_WORKFLOW,
  129. COMFYUI_WORKFLOW_NODES,
  130. ENABLE_IMAGE_GENERATION,
  131. ENABLE_IMAGE_PROMPT_GENERATION,
  132. IMAGE_GENERATION_ENGINE,
  133. IMAGE_GENERATION_MODEL,
  134. IMAGE_SIZE,
  135. IMAGE_STEPS,
  136. IMAGES_OPENAI_API_BASE_URL,
  137. IMAGES_OPENAI_API_KEY,
  138. IMAGES_GEMINI_API_BASE_URL,
  139. IMAGES_GEMINI_API_KEY,
  140. # Audio
  141. AUDIO_STT_ENGINE,
  142. AUDIO_STT_MODEL,
  143. AUDIO_STT_OPENAI_API_BASE_URL,
  144. AUDIO_STT_OPENAI_API_KEY,
  145. AUDIO_STT_AZURE_API_KEY,
  146. AUDIO_STT_AZURE_REGION,
  147. AUDIO_STT_AZURE_LOCALES,
  148. AUDIO_STT_AZURE_BASE_URL,
  149. AUDIO_STT_AZURE_MAX_SPEAKERS,
  150. AUDIO_TTS_API_KEY,
  151. AUDIO_TTS_ENGINE,
  152. AUDIO_TTS_MODEL,
  153. AUDIO_TTS_OPENAI_API_BASE_URL,
  154. AUDIO_TTS_OPENAI_API_KEY,
  155. AUDIO_TTS_SPLIT_ON,
  156. AUDIO_TTS_VOICE,
  157. AUDIO_TTS_AZURE_SPEECH_REGION,
  158. AUDIO_TTS_AZURE_SPEECH_BASE_URL,
  159. AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT,
  160. PLAYWRIGHT_WS_URL,
  161. PLAYWRIGHT_TIMEOUT,
  162. FIRECRAWL_API_BASE_URL,
  163. FIRECRAWL_API_KEY,
  164. WEB_LOADER_ENGINE,
  165. WHISPER_MODEL,
  166. WHISPER_VAD_FILTER,
  167. WHISPER_LANGUAGE,
  168. DEEPGRAM_API_KEY,
  169. WHISPER_MODEL_AUTO_UPDATE,
  170. WHISPER_MODEL_DIR,
  171. # Retrieval
  172. RAG_TEMPLATE,
  173. DEFAULT_RAG_TEMPLATE,
  174. RAG_FULL_CONTEXT,
  175. BYPASS_EMBEDDING_AND_RETRIEVAL,
  176. RAG_EMBEDDING_MODEL,
  177. RAG_EMBEDDING_MODEL_AUTO_UPDATE,
  178. RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE,
  179. RAG_RERANKING_ENGINE,
  180. RAG_RERANKING_MODEL,
  181. RAG_EXTERNAL_RERANKER_URL,
  182. RAG_EXTERNAL_RERANKER_API_KEY,
  183. RAG_RERANKING_MODEL_AUTO_UPDATE,
  184. RAG_RERANKING_MODEL_TRUST_REMOTE_CODE,
  185. RAG_EMBEDDING_ENGINE,
  186. RAG_EMBEDDING_BATCH_SIZE,
  187. RAG_TOP_K,
  188. RAG_TOP_K_RERANKER,
  189. RAG_RELEVANCE_THRESHOLD,
  190. RAG_HYBRID_BM25_WEIGHT,
  191. RAG_ALLOWED_FILE_EXTENSIONS,
  192. RAG_FILE_MAX_COUNT,
  193. RAG_FILE_MAX_SIZE,
  194. RAG_OPENAI_API_BASE_URL,
  195. RAG_OPENAI_API_KEY,
  196. RAG_AZURE_OPENAI_BASE_URL,
  197. RAG_AZURE_OPENAI_API_KEY,
  198. RAG_AZURE_OPENAI_API_VERSION,
  199. RAG_OLLAMA_BASE_URL,
  200. RAG_OLLAMA_API_KEY,
  201. CHUNK_OVERLAP,
  202. CHUNK_SIZE,
  203. CONTENT_EXTRACTION_ENGINE,
  204. DATALAB_MARKER_API_KEY,
  205. DATALAB_MARKER_LANGS,
  206. DATALAB_MARKER_SKIP_CACHE,
  207. DATALAB_MARKER_FORCE_OCR,
  208. DATALAB_MARKER_PAGINATE,
  209. DATALAB_MARKER_STRIP_EXISTING_OCR,
  210. DATALAB_MARKER_DISABLE_IMAGE_EXTRACTION,
  211. DATALAB_MARKER_OUTPUT_FORMAT,
  212. DATALAB_MARKER_USE_LLM,
  213. EXTERNAL_DOCUMENT_LOADER_URL,
  214. EXTERNAL_DOCUMENT_LOADER_API_KEY,
  215. TIKA_SERVER_URL,
  216. DOCLING_SERVER_URL,
  217. DOCLING_OCR_ENGINE,
  218. DOCLING_OCR_LANG,
  219. DOCLING_DO_PICTURE_DESCRIPTION,
  220. DOCUMENT_INTELLIGENCE_ENDPOINT,
  221. DOCUMENT_INTELLIGENCE_KEY,
  222. MISTRAL_OCR_API_KEY,
  223. RAG_TEXT_SPLITTER,
  224. TIKTOKEN_ENCODING_NAME,
  225. PDF_EXTRACT_IMAGES,
  226. YOUTUBE_LOADER_LANGUAGE,
  227. YOUTUBE_LOADER_PROXY_URL,
  228. # Retrieval (Web Search)
  229. ENABLE_WEB_SEARCH,
  230. WEB_SEARCH_ENGINE,
  231. BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL,
  232. BYPASS_WEB_SEARCH_WEB_LOADER,
  233. WEB_SEARCH_RESULT_COUNT,
  234. WEB_SEARCH_CONCURRENT_REQUESTS,
  235. WEB_SEARCH_TRUST_ENV,
  236. WEB_SEARCH_DOMAIN_FILTER_LIST,
  237. JINA_API_KEY,
  238. SEARCHAPI_API_KEY,
  239. SEARCHAPI_ENGINE,
  240. SERPAPI_API_KEY,
  241. SERPAPI_ENGINE,
  242. SEARXNG_QUERY_URL,
  243. YACY_QUERY_URL,
  244. YACY_USERNAME,
  245. YACY_PASSWORD,
  246. SERPER_API_KEY,
  247. SERPLY_API_KEY,
  248. SERPSTACK_API_KEY,
  249. SERPSTACK_HTTPS,
  250. TAVILY_API_KEY,
  251. TAVILY_EXTRACT_DEPTH,
  252. BING_SEARCH_V7_ENDPOINT,
  253. BING_SEARCH_V7_SUBSCRIPTION_KEY,
  254. BRAVE_SEARCH_API_KEY,
  255. EXA_API_KEY,
  256. PERPLEXITY_API_KEY,
  257. SOUGOU_API_SID,
  258. SOUGOU_API_SK,
  259. KAGI_SEARCH_API_KEY,
  260. MOJEEK_SEARCH_API_KEY,
  261. BOCHA_SEARCH_API_KEY,
  262. GOOGLE_PSE_API_KEY,
  263. GOOGLE_PSE_ENGINE_ID,
  264. GOOGLE_DRIVE_CLIENT_ID,
  265. GOOGLE_DRIVE_API_KEY,
  266. ONEDRIVE_CLIENT_ID,
  267. ONEDRIVE_SHAREPOINT_URL,
  268. ONEDRIVE_SHAREPOINT_TENANT_ID,
  269. ENABLE_RAG_HYBRID_SEARCH,
  270. ENABLE_RAG_LOCAL_WEB_FETCH,
  271. ENABLE_WEB_LOADER_SSL_VERIFICATION,
  272. ENABLE_GOOGLE_DRIVE_INTEGRATION,
  273. ENABLE_ONEDRIVE_INTEGRATION,
  274. UPLOAD_DIR,
  275. EXTERNAL_WEB_SEARCH_URL,
  276. EXTERNAL_WEB_SEARCH_API_KEY,
  277. EXTERNAL_WEB_LOADER_URL,
  278. EXTERNAL_WEB_LOADER_API_KEY,
  279. # WebUI
  280. WEBUI_AUTH,
  281. WEBUI_NAME,
  282. WEBUI_BANNERS,
  283. WEBHOOK_URL,
  284. ADMIN_EMAIL,
  285. SHOW_ADMIN_DETAILS,
  286. JWT_EXPIRES_IN,
  287. ENABLE_SIGNUP,
  288. ENABLE_LOGIN_FORM,
  289. ENABLE_API_KEY,
  290. ENABLE_API_KEY_ENDPOINT_RESTRICTIONS,
  291. API_KEY_ALLOWED_ENDPOINTS,
  292. ENABLE_CHANNELS,
  293. ENABLE_NOTES,
  294. ENABLE_COMMUNITY_SHARING,
  295. ENABLE_MESSAGE_RATING,
  296. ENABLE_USER_WEBHOOKS,
  297. ENABLE_EVALUATION_ARENA_MODELS,
  298. USER_PERMISSIONS,
  299. DEFAULT_USER_ROLE,
  300. PENDING_USER_OVERLAY_CONTENT,
  301. PENDING_USER_OVERLAY_TITLE,
  302. DEFAULT_PROMPT_SUGGESTIONS,
  303. DEFAULT_MODELS,
  304. DEFAULT_ARENA_MODEL,
  305. MODEL_ORDER_LIST,
  306. EVALUATION_ARENA_MODELS,
  307. # WebUI (OAuth)
  308. ENABLE_OAUTH_ROLE_MANAGEMENT,
  309. OAUTH_ROLES_CLAIM,
  310. OAUTH_EMAIL_CLAIM,
  311. OAUTH_PICTURE_CLAIM,
  312. OAUTH_USERNAME_CLAIM,
  313. OAUTH_ALLOWED_ROLES,
  314. OAUTH_ADMIN_ROLES,
  315. # WebUI (LDAP)
  316. ENABLE_LDAP,
  317. LDAP_SERVER_LABEL,
  318. LDAP_SERVER_HOST,
  319. LDAP_SERVER_PORT,
  320. LDAP_ATTRIBUTE_FOR_MAIL,
  321. LDAP_ATTRIBUTE_FOR_USERNAME,
  322. LDAP_SEARCH_FILTERS,
  323. LDAP_SEARCH_BASE,
  324. LDAP_APP_DN,
  325. LDAP_APP_PASSWORD,
  326. LDAP_USE_TLS,
  327. LDAP_CA_CERT_FILE,
  328. LDAP_VALIDATE_CERT,
  329. LDAP_CIPHERS,
  330. # Misc
  331. ENV,
  332. CACHE_DIR,
  333. STATIC_DIR,
  334. FRONTEND_BUILD_DIR,
  335. CORS_ALLOW_ORIGIN,
  336. DEFAULT_LOCALE,
  337. OAUTH_PROVIDERS,
  338. WEBUI_URL,
  339. RESPONSE_WATERMARK,
  340. # Admin
  341. ENABLE_ADMIN_CHAT_ACCESS,
  342. ENABLE_ADMIN_EXPORT,
  343. # Tasks
  344. TASK_MODEL,
  345. TASK_MODEL_EXTERNAL,
  346. ENABLE_TAGS_GENERATION,
  347. ENABLE_TITLE_GENERATION,
  348. ENABLE_SEARCH_QUERY_GENERATION,
  349. ENABLE_RETRIEVAL_QUERY_GENERATION,
  350. ENABLE_AUTOCOMPLETE_GENERATION,
  351. TITLE_GENERATION_PROMPT_TEMPLATE,
  352. TAGS_GENERATION_PROMPT_TEMPLATE,
  353. IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE,
  354. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
  355. QUERY_GENERATION_PROMPT_TEMPLATE,
  356. AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE,
  357. AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH,
  358. AppConfig,
  359. reset_config,
  360. )
  361. from open_webui.env import (
  362. AUDIT_EXCLUDED_PATHS,
  363. AUDIT_LOG_LEVEL,
  364. CHANGELOG,
  365. REDIS_URL,
  366. REDIS_SENTINEL_HOSTS,
  367. REDIS_SENTINEL_PORT,
  368. GLOBAL_LOG_LEVEL,
  369. MAX_BODY_LOG_SIZE,
  370. SAFE_MODE,
  371. SRC_LOG_LEVELS,
  372. VERSION,
  373. WEBUI_BUILD_HASH,
  374. WEBUI_SECRET_KEY,
  375. WEBUI_SESSION_COOKIE_SAME_SITE,
  376. WEBUI_SESSION_COOKIE_SECURE,
  377. WEBUI_AUTH_TRUSTED_EMAIL_HEADER,
  378. WEBUI_AUTH_TRUSTED_NAME_HEADER,
  379. WEBUI_AUTH_SIGNOUT_REDIRECT_URL,
  380. ENABLE_WEBSOCKET_SUPPORT,
  381. BYPASS_MODEL_ACCESS_CONTROL,
  382. RESET_CONFIG_ON_START,
  383. OFFLINE_MODE,
  384. ENABLE_OTEL,
  385. EXTERNAL_PWA_MANIFEST_URL,
  386. AIOHTTP_CLIENT_SESSION_SSL,
  387. )
  388. from open_webui.utils.models import (
  389. get_all_models,
  390. get_all_base_models,
  391. check_model_access,
  392. )
  393. from open_webui.utils.chat import (
  394. generate_chat_completion as chat_completion_handler,
  395. chat_completed as chat_completed_handler,
  396. chat_action as chat_action_handler,
  397. )
  398. from open_webui.utils.middleware import process_chat_payload, process_chat_response
  399. from open_webui.utils.access_control import has_access
  400. from open_webui.utils.auth import (
  401. get_license_data,
  402. get_http_authorization_cred,
  403. decode_token,
  404. get_admin_user,
  405. get_verified_user,
  406. )
  407. from open_webui.utils.plugin import install_tool_and_function_dependencies
  408. from open_webui.utils.oauth import OAuthManager
  409. from open_webui.utils.security_headers import SecurityHeadersMiddleware
  410. from open_webui.tasks import (
  411. list_task_ids_by_chat_id,
  412. stop_task,
  413. list_tasks,
  414. ) # Import from tasks.py
  415. from open_webui.utils.redis import get_sentinels_from_env
  416. if SAFE_MODE:
  417. print("SAFE MODE ENABLED")
  418. Functions.deactivate_all_functions()
  419. logging.basicConfig(stream=sys.stdout, level=GLOBAL_LOG_LEVEL)
  420. log = logging.getLogger(__name__)
  421. log.setLevel(SRC_LOG_LEVELS["MAIN"])
  422. class SPAStaticFiles(StaticFiles):
  423. async def get_response(self, path: str, scope):
  424. try:
  425. return await super().get_response(path, scope)
  426. except (HTTPException, StarletteHTTPException) as ex:
  427. if ex.status_code == 404:
  428. if path.endswith(".js"):
  429. # Return 404 for javascript files
  430. raise ex
  431. else:
  432. return await super().get_response("index.html", scope)
  433. else:
  434. raise ex
  435. print(
  436. rf"""
  437. ██████╗ ██████╗ ███████╗███╗ ██╗ ██╗ ██╗███████╗██████╗ ██╗ ██╗██╗
  438. ██╔═══██╗██╔══██╗██╔════╝████╗ ██║ ██║ ██║██╔════╝██╔══██╗██║ ██║██║
  439. ██║ ██║██████╔╝█████╗ ██╔██╗ ██║ ██║ █╗ ██║█████╗ ██████╔╝██║ ██║██║
  440. ██║ ██║██╔═══╝ ██╔══╝ ██║╚██╗██║ ██║███╗██║██╔══╝ ██╔══██╗██║ ██║██║
  441. ╚██████╔╝██║ ███████╗██║ ╚████║ ╚███╔███╔╝███████╗██████╔╝╚██████╔╝██║
  442. ╚═════╝ ╚═╝ ╚══════╝╚═╝ ╚═══╝ ╚══╝╚══╝ ╚══════╝╚═════╝ ╚═════╝ ╚═╝
  443. v{VERSION} - building the best AI user interface.
  444. {f"Commit: {WEBUI_BUILD_HASH}" if WEBUI_BUILD_HASH != "dev-build" else ""}
  445. https://github.com/open-webui/open-webui
  446. """
  447. )
  448. @asynccontextmanager
  449. async def lifespan(app: FastAPI):
  450. start_logger()
  451. if RESET_CONFIG_ON_START:
  452. reset_config()
  453. if LICENSE_KEY:
  454. get_license_data(app, LICENSE_KEY)
  455. # This should be blocking (sync) so functions are not deactivated on first /get_models calls
  456. # when the first user lands on the / route.
  457. log.info("Installing external dependencies of functions and tools...")
  458. install_tool_and_function_dependencies()
  459. if THREAD_POOL_SIZE and THREAD_POOL_SIZE > 0:
  460. limiter = anyio.to_thread.current_default_thread_limiter()
  461. limiter.total_tokens = THREAD_POOL_SIZE
  462. asyncio.create_task(periodic_usage_pool_cleanup())
  463. yield
  464. app = FastAPI(
  465. title="Open WebUI",
  466. docs_url="/docs" if ENV == "dev" else None,
  467. openapi_url="/openapi.json" if ENV == "dev" else None,
  468. redoc_url=None,
  469. lifespan=lifespan,
  470. )
  471. oauth_manager = OAuthManager(app)
  472. app.state.config = AppConfig(
  473. redis_url=REDIS_URL,
  474. redis_sentinels=get_sentinels_from_env(REDIS_SENTINEL_HOSTS, REDIS_SENTINEL_PORT),
  475. )
  476. app.state.WEBUI_NAME = WEBUI_NAME
  477. app.state.LICENSE_METADATA = None
  478. ########################################
  479. #
  480. # OPENTELEMETRY
  481. #
  482. ########################################
  483. if ENABLE_OTEL:
  484. from open_webui.utils.telemetry.setup import setup as setup_opentelemetry
  485. setup_opentelemetry(app=app, db_engine=engine)
  486. ########################################
  487. #
  488. # OLLAMA
  489. #
  490. ########################################
  491. app.state.config.ENABLE_OLLAMA_API = ENABLE_OLLAMA_API
  492. app.state.config.OLLAMA_BASE_URLS = OLLAMA_BASE_URLS
  493. app.state.config.OLLAMA_API_CONFIGS = OLLAMA_API_CONFIGS
  494. app.state.OLLAMA_MODELS = {}
  495. ########################################
  496. #
  497. # OPENAI
  498. #
  499. ########################################
  500. app.state.config.ENABLE_OPENAI_API = ENABLE_OPENAI_API
  501. app.state.config.OPENAI_API_BASE_URLS = OPENAI_API_BASE_URLS
  502. app.state.config.OPENAI_API_KEYS = OPENAI_API_KEYS
  503. app.state.config.OPENAI_API_CONFIGS = OPENAI_API_CONFIGS
  504. app.state.OPENAI_MODELS = {}
  505. ########################################
  506. #
  507. # TOOL SERVERS
  508. #
  509. ########################################
  510. app.state.config.TOOL_SERVER_CONNECTIONS = TOOL_SERVER_CONNECTIONS
  511. app.state.TOOL_SERVERS = []
  512. ########################################
  513. #
  514. # DIRECT CONNECTIONS
  515. #
  516. ########################################
  517. app.state.config.ENABLE_DIRECT_CONNECTIONS = ENABLE_DIRECT_CONNECTIONS
  518. ########################################
  519. #
  520. # WEBUI
  521. #
  522. ########################################
  523. app.state.config.WEBUI_URL = WEBUI_URL
  524. app.state.config.ENABLE_SIGNUP = ENABLE_SIGNUP
  525. app.state.config.ENABLE_LOGIN_FORM = ENABLE_LOGIN_FORM
  526. app.state.config.ENABLE_API_KEY = ENABLE_API_KEY
  527. app.state.config.ENABLE_API_KEY_ENDPOINT_RESTRICTIONS = (
  528. ENABLE_API_KEY_ENDPOINT_RESTRICTIONS
  529. )
  530. app.state.config.API_KEY_ALLOWED_ENDPOINTS = API_KEY_ALLOWED_ENDPOINTS
  531. app.state.config.JWT_EXPIRES_IN = JWT_EXPIRES_IN
  532. app.state.config.SHOW_ADMIN_DETAILS = SHOW_ADMIN_DETAILS
  533. app.state.config.ADMIN_EMAIL = ADMIN_EMAIL
  534. app.state.config.DEFAULT_MODELS = DEFAULT_MODELS
  535. app.state.config.DEFAULT_PROMPT_SUGGESTIONS = DEFAULT_PROMPT_SUGGESTIONS
  536. app.state.config.DEFAULT_USER_ROLE = DEFAULT_USER_ROLE
  537. app.state.config.PENDING_USER_OVERLAY_CONTENT = PENDING_USER_OVERLAY_CONTENT
  538. app.state.config.PENDING_USER_OVERLAY_TITLE = PENDING_USER_OVERLAY_TITLE
  539. app.state.config.RESPONSE_WATERMARK = RESPONSE_WATERMARK
  540. app.state.config.USER_PERMISSIONS = USER_PERMISSIONS
  541. app.state.config.WEBHOOK_URL = WEBHOOK_URL
  542. app.state.config.BANNERS = WEBUI_BANNERS
  543. app.state.config.MODEL_ORDER_LIST = MODEL_ORDER_LIST
  544. app.state.config.ENABLE_CHANNELS = ENABLE_CHANNELS
  545. app.state.config.ENABLE_NOTES = ENABLE_NOTES
  546. app.state.config.ENABLE_COMMUNITY_SHARING = ENABLE_COMMUNITY_SHARING
  547. app.state.config.ENABLE_MESSAGE_RATING = ENABLE_MESSAGE_RATING
  548. app.state.config.ENABLE_USER_WEBHOOKS = ENABLE_USER_WEBHOOKS
  549. app.state.config.ENABLE_EVALUATION_ARENA_MODELS = ENABLE_EVALUATION_ARENA_MODELS
  550. app.state.config.EVALUATION_ARENA_MODELS = EVALUATION_ARENA_MODELS
  551. app.state.config.OAUTH_USERNAME_CLAIM = OAUTH_USERNAME_CLAIM
  552. app.state.config.OAUTH_PICTURE_CLAIM = OAUTH_PICTURE_CLAIM
  553. app.state.config.OAUTH_EMAIL_CLAIM = OAUTH_EMAIL_CLAIM
  554. app.state.config.ENABLE_OAUTH_ROLE_MANAGEMENT = ENABLE_OAUTH_ROLE_MANAGEMENT
  555. app.state.config.OAUTH_ROLES_CLAIM = OAUTH_ROLES_CLAIM
  556. app.state.config.OAUTH_ALLOWED_ROLES = OAUTH_ALLOWED_ROLES
  557. app.state.config.OAUTH_ADMIN_ROLES = OAUTH_ADMIN_ROLES
  558. app.state.config.ENABLE_LDAP = ENABLE_LDAP
  559. app.state.config.LDAP_SERVER_LABEL = LDAP_SERVER_LABEL
  560. app.state.config.LDAP_SERVER_HOST = LDAP_SERVER_HOST
  561. app.state.config.LDAP_SERVER_PORT = LDAP_SERVER_PORT
  562. app.state.config.LDAP_ATTRIBUTE_FOR_MAIL = LDAP_ATTRIBUTE_FOR_MAIL
  563. app.state.config.LDAP_ATTRIBUTE_FOR_USERNAME = LDAP_ATTRIBUTE_FOR_USERNAME
  564. app.state.config.LDAP_APP_DN = LDAP_APP_DN
  565. app.state.config.LDAP_APP_PASSWORD = LDAP_APP_PASSWORD
  566. app.state.config.LDAP_SEARCH_BASE = LDAP_SEARCH_BASE
  567. app.state.config.LDAP_SEARCH_FILTERS = LDAP_SEARCH_FILTERS
  568. app.state.config.LDAP_USE_TLS = LDAP_USE_TLS
  569. app.state.config.LDAP_CA_CERT_FILE = LDAP_CA_CERT_FILE
  570. app.state.config.LDAP_VALIDATE_CERT = LDAP_VALIDATE_CERT
  571. app.state.config.LDAP_CIPHERS = LDAP_CIPHERS
  572. app.state.AUTH_TRUSTED_EMAIL_HEADER = WEBUI_AUTH_TRUSTED_EMAIL_HEADER
  573. app.state.AUTH_TRUSTED_NAME_HEADER = WEBUI_AUTH_TRUSTED_NAME_HEADER
  574. app.state.WEBUI_AUTH_SIGNOUT_REDIRECT_URL = WEBUI_AUTH_SIGNOUT_REDIRECT_URL
  575. app.state.EXTERNAL_PWA_MANIFEST_URL = EXTERNAL_PWA_MANIFEST_URL
  576. app.state.USER_COUNT = None
  577. app.state.TOOLS = {}
  578. app.state.TOOL_CONTENTS = {}
  579. app.state.FUNCTIONS = {}
  580. app.state.FUNCTION_CONTENTS = {}
  581. ########################################
  582. #
  583. # RETRIEVAL
  584. #
  585. ########################################
  586. app.state.config.TOP_K = RAG_TOP_K
  587. app.state.config.TOP_K_RERANKER = RAG_TOP_K_RERANKER
  588. app.state.config.RELEVANCE_THRESHOLD = RAG_RELEVANCE_THRESHOLD
  589. app.state.config.HYBRID_BM25_WEIGHT = RAG_HYBRID_BM25_WEIGHT
  590. app.state.config.ALLOWED_FILE_EXTENSIONS = RAG_ALLOWED_FILE_EXTENSIONS
  591. app.state.config.FILE_MAX_SIZE = RAG_FILE_MAX_SIZE
  592. app.state.config.FILE_MAX_COUNT = RAG_FILE_MAX_COUNT
  593. app.state.config.RAG_FULL_CONTEXT = RAG_FULL_CONTEXT
  594. app.state.config.BYPASS_EMBEDDING_AND_RETRIEVAL = BYPASS_EMBEDDING_AND_RETRIEVAL
  595. app.state.config.ENABLE_RAG_HYBRID_SEARCH = ENABLE_RAG_HYBRID_SEARCH
  596. app.state.config.ENABLE_WEB_LOADER_SSL_VERIFICATION = ENABLE_WEB_LOADER_SSL_VERIFICATION
  597. app.state.config.CONTENT_EXTRACTION_ENGINE = CONTENT_EXTRACTION_ENGINE
  598. app.state.config.DATALAB_MARKER_API_KEY = DATALAB_MARKER_API_KEY
  599. app.state.config.DATALAB_MARKER_LANGS = DATALAB_MARKER_LANGS
  600. app.state.config.DATALAB_MARKER_SKIP_CACHE = DATALAB_MARKER_SKIP_CACHE
  601. app.state.config.DATALAB_MARKER_FORCE_OCR = DATALAB_MARKER_FORCE_OCR
  602. app.state.config.DATALAB_MARKER_PAGINATE = DATALAB_MARKER_PAGINATE
  603. app.state.config.DATALAB_MARKER_STRIP_EXISTING_OCR = DATALAB_MARKER_STRIP_EXISTING_OCR
  604. app.state.config.DATALAB_MARKER_DISABLE_IMAGE_EXTRACTION = (
  605. DATALAB_MARKER_DISABLE_IMAGE_EXTRACTION
  606. )
  607. app.state.config.DATALAB_MARKER_USE_LLM = DATALAB_MARKER_USE_LLM
  608. app.state.config.DATALAB_MARKER_OUTPUT_FORMAT = DATALAB_MARKER_OUTPUT_FORMAT
  609. app.state.config.EXTERNAL_DOCUMENT_LOADER_URL = EXTERNAL_DOCUMENT_LOADER_URL
  610. app.state.config.EXTERNAL_DOCUMENT_LOADER_API_KEY = EXTERNAL_DOCUMENT_LOADER_API_KEY
  611. app.state.config.TIKA_SERVER_URL = TIKA_SERVER_URL
  612. app.state.config.DOCLING_SERVER_URL = DOCLING_SERVER_URL
  613. app.state.config.DOCLING_OCR_ENGINE = DOCLING_OCR_ENGINE
  614. app.state.config.DOCLING_OCR_LANG = DOCLING_OCR_LANG
  615. app.state.config.DOCLING_DO_PICTURE_DESCRIPTION = DOCLING_DO_PICTURE_DESCRIPTION
  616. app.state.config.DOCUMENT_INTELLIGENCE_ENDPOINT = DOCUMENT_INTELLIGENCE_ENDPOINT
  617. app.state.config.DOCUMENT_INTELLIGENCE_KEY = DOCUMENT_INTELLIGENCE_KEY
  618. app.state.config.MISTRAL_OCR_API_KEY = MISTRAL_OCR_API_KEY
  619. app.state.config.TEXT_SPLITTER = RAG_TEXT_SPLITTER
  620. app.state.config.TIKTOKEN_ENCODING_NAME = TIKTOKEN_ENCODING_NAME
  621. app.state.config.CHUNK_SIZE = CHUNK_SIZE
  622. app.state.config.CHUNK_OVERLAP = CHUNK_OVERLAP
  623. app.state.config.RAG_EMBEDDING_ENGINE = RAG_EMBEDDING_ENGINE
  624. app.state.config.RAG_EMBEDDING_MODEL = RAG_EMBEDDING_MODEL
  625. app.state.config.RAG_EMBEDDING_BATCH_SIZE = RAG_EMBEDDING_BATCH_SIZE
  626. app.state.config.RAG_RERANKING_ENGINE = RAG_RERANKING_ENGINE
  627. app.state.config.RAG_RERANKING_MODEL = RAG_RERANKING_MODEL
  628. app.state.config.RAG_EXTERNAL_RERANKER_URL = RAG_EXTERNAL_RERANKER_URL
  629. app.state.config.RAG_EXTERNAL_RERANKER_API_KEY = RAG_EXTERNAL_RERANKER_API_KEY
  630. app.state.config.RAG_TEMPLATE = RAG_TEMPLATE
  631. app.state.config.RAG_OPENAI_API_BASE_URL = RAG_OPENAI_API_BASE_URL
  632. app.state.config.RAG_OPENAI_API_KEY = RAG_OPENAI_API_KEY
  633. app.state.config.RAG_AZURE_OPENAI_BASE_URL = RAG_AZURE_OPENAI_BASE_URL
  634. app.state.config.RAG_AZURE_OPENAI_API_KEY = RAG_AZURE_OPENAI_API_KEY
  635. app.state.config.RAG_AZURE_OPENAI_API_VERSION = RAG_AZURE_OPENAI_API_VERSION
  636. app.state.config.RAG_OLLAMA_BASE_URL = RAG_OLLAMA_BASE_URL
  637. app.state.config.RAG_OLLAMA_API_KEY = RAG_OLLAMA_API_KEY
  638. app.state.config.PDF_EXTRACT_IMAGES = PDF_EXTRACT_IMAGES
  639. app.state.config.YOUTUBE_LOADER_LANGUAGE = YOUTUBE_LOADER_LANGUAGE
  640. app.state.config.YOUTUBE_LOADER_PROXY_URL = YOUTUBE_LOADER_PROXY_URL
  641. app.state.config.ENABLE_WEB_SEARCH = ENABLE_WEB_SEARCH
  642. app.state.config.WEB_SEARCH_ENGINE = WEB_SEARCH_ENGINE
  643. app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST = WEB_SEARCH_DOMAIN_FILTER_LIST
  644. app.state.config.WEB_SEARCH_RESULT_COUNT = WEB_SEARCH_RESULT_COUNT
  645. app.state.config.WEB_SEARCH_CONCURRENT_REQUESTS = WEB_SEARCH_CONCURRENT_REQUESTS
  646. app.state.config.WEB_LOADER_ENGINE = WEB_LOADER_ENGINE
  647. app.state.config.WEB_SEARCH_TRUST_ENV = WEB_SEARCH_TRUST_ENV
  648. app.state.config.BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL = (
  649. BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL
  650. )
  651. app.state.config.BYPASS_WEB_SEARCH_WEB_LOADER = BYPASS_WEB_SEARCH_WEB_LOADER
  652. app.state.config.ENABLE_GOOGLE_DRIVE_INTEGRATION = ENABLE_GOOGLE_DRIVE_INTEGRATION
  653. app.state.config.ENABLE_ONEDRIVE_INTEGRATION = ENABLE_ONEDRIVE_INTEGRATION
  654. app.state.config.SEARXNG_QUERY_URL = SEARXNG_QUERY_URL
  655. app.state.config.YACY_QUERY_URL = YACY_QUERY_URL
  656. app.state.config.YACY_USERNAME = YACY_USERNAME
  657. app.state.config.YACY_PASSWORD = YACY_PASSWORD
  658. app.state.config.GOOGLE_PSE_API_KEY = GOOGLE_PSE_API_KEY
  659. app.state.config.GOOGLE_PSE_ENGINE_ID = GOOGLE_PSE_ENGINE_ID
  660. app.state.config.BRAVE_SEARCH_API_KEY = BRAVE_SEARCH_API_KEY
  661. app.state.config.KAGI_SEARCH_API_KEY = KAGI_SEARCH_API_KEY
  662. app.state.config.MOJEEK_SEARCH_API_KEY = MOJEEK_SEARCH_API_KEY
  663. app.state.config.BOCHA_SEARCH_API_KEY = BOCHA_SEARCH_API_KEY
  664. app.state.config.SERPSTACK_API_KEY = SERPSTACK_API_KEY
  665. app.state.config.SERPSTACK_HTTPS = SERPSTACK_HTTPS
  666. app.state.config.SERPER_API_KEY = SERPER_API_KEY
  667. app.state.config.SERPLY_API_KEY = SERPLY_API_KEY
  668. app.state.config.TAVILY_API_KEY = TAVILY_API_KEY
  669. app.state.config.SEARCHAPI_API_KEY = SEARCHAPI_API_KEY
  670. app.state.config.SEARCHAPI_ENGINE = SEARCHAPI_ENGINE
  671. app.state.config.SERPAPI_API_KEY = SERPAPI_API_KEY
  672. app.state.config.SERPAPI_ENGINE = SERPAPI_ENGINE
  673. app.state.config.JINA_API_KEY = JINA_API_KEY
  674. app.state.config.BING_SEARCH_V7_ENDPOINT = BING_SEARCH_V7_ENDPOINT
  675. app.state.config.BING_SEARCH_V7_SUBSCRIPTION_KEY = BING_SEARCH_V7_SUBSCRIPTION_KEY
  676. app.state.config.EXA_API_KEY = EXA_API_KEY
  677. app.state.config.PERPLEXITY_API_KEY = PERPLEXITY_API_KEY
  678. app.state.config.SOUGOU_API_SID = SOUGOU_API_SID
  679. app.state.config.SOUGOU_API_SK = SOUGOU_API_SK
  680. app.state.config.EXTERNAL_WEB_SEARCH_URL = EXTERNAL_WEB_SEARCH_URL
  681. app.state.config.EXTERNAL_WEB_SEARCH_API_KEY = EXTERNAL_WEB_SEARCH_API_KEY
  682. app.state.config.EXTERNAL_WEB_LOADER_URL = EXTERNAL_WEB_LOADER_URL
  683. app.state.config.EXTERNAL_WEB_LOADER_API_KEY = EXTERNAL_WEB_LOADER_API_KEY
  684. app.state.config.PLAYWRIGHT_WS_URL = PLAYWRIGHT_WS_URL
  685. app.state.config.PLAYWRIGHT_TIMEOUT = PLAYWRIGHT_TIMEOUT
  686. app.state.config.FIRECRAWL_API_BASE_URL = FIRECRAWL_API_BASE_URL
  687. app.state.config.FIRECRAWL_API_KEY = FIRECRAWL_API_KEY
  688. app.state.config.TAVILY_EXTRACT_DEPTH = TAVILY_EXTRACT_DEPTH
  689. app.state.EMBEDDING_FUNCTION = None
  690. app.state.ef = None
  691. app.state.rf = None
  692. app.state.YOUTUBE_LOADER_TRANSLATION = None
  693. try:
  694. app.state.ef = get_ef(
  695. app.state.config.RAG_EMBEDDING_ENGINE,
  696. app.state.config.RAG_EMBEDDING_MODEL,
  697. RAG_EMBEDDING_MODEL_AUTO_UPDATE,
  698. )
  699. app.state.rf = get_rf(
  700. app.state.config.RAG_RERANKING_ENGINE,
  701. app.state.config.RAG_RERANKING_MODEL,
  702. app.state.config.RAG_EXTERNAL_RERANKER_URL,
  703. app.state.config.RAG_EXTERNAL_RERANKER_API_KEY,
  704. RAG_RERANKING_MODEL_AUTO_UPDATE,
  705. )
  706. except Exception as e:
  707. log.error(f"Error updating models: {e}")
  708. pass
  709. app.state.EMBEDDING_FUNCTION = get_embedding_function(
  710. app.state.config.RAG_EMBEDDING_ENGINE,
  711. app.state.config.RAG_EMBEDDING_MODEL,
  712. app.state.ef,
  713. (
  714. app.state.config.RAG_OPENAI_API_BASE_URL
  715. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  716. else (
  717. app.state.config.RAG_OLLAMA_BASE_URL
  718. if app.state.config.RAG_EMBEDDING_ENGINE == "ollama"
  719. else app.state.config.RAG_AZURE_OPENAI_BASE_URL
  720. )
  721. ),
  722. (
  723. app.state.config.RAG_OPENAI_API_KEY
  724. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  725. else (
  726. app.state.config.RAG_OLLAMA_API_KEY
  727. if app.state.config.RAG_EMBEDDING_ENGINE == "ollama"
  728. else app.state.config.RAG_AZURE_OPENAI_API_KEY
  729. )
  730. ),
  731. app.state.config.RAG_EMBEDDING_BATCH_SIZE,
  732. azure_api_version=(
  733. app.state.config.RAG_AZURE_OPENAI_API_VERSION
  734. if app.state.config.RAG_EMBEDDING_ENGINE == "azure_openai"
  735. else None
  736. ),
  737. )
  738. ########################################
  739. #
  740. # CODE EXECUTION
  741. #
  742. ########################################
  743. app.state.config.ENABLE_CODE_EXECUTION = ENABLE_CODE_EXECUTION
  744. app.state.config.CODE_EXECUTION_ENGINE = CODE_EXECUTION_ENGINE
  745. app.state.config.CODE_EXECUTION_JUPYTER_URL = CODE_EXECUTION_JUPYTER_URL
  746. app.state.config.CODE_EXECUTION_JUPYTER_AUTH = CODE_EXECUTION_JUPYTER_AUTH
  747. app.state.config.CODE_EXECUTION_JUPYTER_AUTH_TOKEN = CODE_EXECUTION_JUPYTER_AUTH_TOKEN
  748. app.state.config.CODE_EXECUTION_JUPYTER_AUTH_PASSWORD = (
  749. CODE_EXECUTION_JUPYTER_AUTH_PASSWORD
  750. )
  751. app.state.config.CODE_EXECUTION_JUPYTER_TIMEOUT = CODE_EXECUTION_JUPYTER_TIMEOUT
  752. app.state.config.ENABLE_CODE_INTERPRETER = ENABLE_CODE_INTERPRETER
  753. app.state.config.CODE_INTERPRETER_ENGINE = CODE_INTERPRETER_ENGINE
  754. app.state.config.CODE_INTERPRETER_PROMPT_TEMPLATE = CODE_INTERPRETER_PROMPT_TEMPLATE
  755. app.state.config.CODE_INTERPRETER_JUPYTER_URL = CODE_INTERPRETER_JUPYTER_URL
  756. app.state.config.CODE_INTERPRETER_JUPYTER_AUTH = CODE_INTERPRETER_JUPYTER_AUTH
  757. app.state.config.CODE_INTERPRETER_JUPYTER_AUTH_TOKEN = (
  758. CODE_INTERPRETER_JUPYTER_AUTH_TOKEN
  759. )
  760. app.state.config.CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD = (
  761. CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD
  762. )
  763. app.state.config.CODE_INTERPRETER_JUPYTER_TIMEOUT = CODE_INTERPRETER_JUPYTER_TIMEOUT
  764. ########################################
  765. #
  766. # IMAGES
  767. #
  768. ########################################
  769. app.state.config.IMAGE_GENERATION_ENGINE = IMAGE_GENERATION_ENGINE
  770. app.state.config.ENABLE_IMAGE_GENERATION = ENABLE_IMAGE_GENERATION
  771. app.state.config.ENABLE_IMAGE_PROMPT_GENERATION = ENABLE_IMAGE_PROMPT_GENERATION
  772. app.state.config.IMAGES_OPENAI_API_BASE_URL = IMAGES_OPENAI_API_BASE_URL
  773. app.state.config.IMAGES_OPENAI_API_KEY = IMAGES_OPENAI_API_KEY
  774. app.state.config.IMAGES_GEMINI_API_BASE_URL = IMAGES_GEMINI_API_BASE_URL
  775. app.state.config.IMAGES_GEMINI_API_KEY = IMAGES_GEMINI_API_KEY
  776. app.state.config.IMAGE_GENERATION_MODEL = IMAGE_GENERATION_MODEL
  777. app.state.config.AUTOMATIC1111_BASE_URL = AUTOMATIC1111_BASE_URL
  778. app.state.config.AUTOMATIC1111_API_AUTH = AUTOMATIC1111_API_AUTH
  779. app.state.config.AUTOMATIC1111_CFG_SCALE = AUTOMATIC1111_CFG_SCALE
  780. app.state.config.AUTOMATIC1111_SAMPLER = AUTOMATIC1111_SAMPLER
  781. app.state.config.AUTOMATIC1111_SCHEDULER = AUTOMATIC1111_SCHEDULER
  782. app.state.config.COMFYUI_BASE_URL = COMFYUI_BASE_URL
  783. app.state.config.COMFYUI_API_KEY = COMFYUI_API_KEY
  784. app.state.config.COMFYUI_WORKFLOW = COMFYUI_WORKFLOW
  785. app.state.config.COMFYUI_WORKFLOW_NODES = COMFYUI_WORKFLOW_NODES
  786. app.state.config.IMAGE_SIZE = IMAGE_SIZE
  787. app.state.config.IMAGE_STEPS = IMAGE_STEPS
  788. ########################################
  789. #
  790. # AUDIO
  791. #
  792. ########################################
  793. app.state.config.STT_OPENAI_API_BASE_URL = AUDIO_STT_OPENAI_API_BASE_URL
  794. app.state.config.STT_OPENAI_API_KEY = AUDIO_STT_OPENAI_API_KEY
  795. app.state.config.STT_ENGINE = AUDIO_STT_ENGINE
  796. app.state.config.STT_MODEL = AUDIO_STT_MODEL
  797. app.state.config.WHISPER_MODEL = WHISPER_MODEL
  798. app.state.config.WHISPER_VAD_FILTER = WHISPER_VAD_FILTER
  799. app.state.config.DEEPGRAM_API_KEY = DEEPGRAM_API_KEY
  800. app.state.config.AUDIO_STT_AZURE_API_KEY = AUDIO_STT_AZURE_API_KEY
  801. app.state.config.AUDIO_STT_AZURE_REGION = AUDIO_STT_AZURE_REGION
  802. app.state.config.AUDIO_STT_AZURE_LOCALES = AUDIO_STT_AZURE_LOCALES
  803. app.state.config.AUDIO_STT_AZURE_BASE_URL = AUDIO_STT_AZURE_BASE_URL
  804. app.state.config.AUDIO_STT_AZURE_MAX_SPEAKERS = AUDIO_STT_AZURE_MAX_SPEAKERS
  805. app.state.config.TTS_OPENAI_API_BASE_URL = AUDIO_TTS_OPENAI_API_BASE_URL
  806. app.state.config.TTS_OPENAI_API_KEY = AUDIO_TTS_OPENAI_API_KEY
  807. app.state.config.TTS_ENGINE = AUDIO_TTS_ENGINE
  808. app.state.config.TTS_MODEL = AUDIO_TTS_MODEL
  809. app.state.config.TTS_VOICE = AUDIO_TTS_VOICE
  810. app.state.config.TTS_API_KEY = AUDIO_TTS_API_KEY
  811. app.state.config.TTS_SPLIT_ON = AUDIO_TTS_SPLIT_ON
  812. app.state.config.TTS_AZURE_SPEECH_REGION = AUDIO_TTS_AZURE_SPEECH_REGION
  813. app.state.config.TTS_AZURE_SPEECH_BASE_URL = AUDIO_TTS_AZURE_SPEECH_BASE_URL
  814. app.state.config.TTS_AZURE_SPEECH_OUTPUT_FORMAT = AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT
  815. app.state.faster_whisper_model = None
  816. app.state.speech_synthesiser = None
  817. app.state.speech_speaker_embeddings_dataset = None
  818. ########################################
  819. #
  820. # TASKS
  821. #
  822. ########################################
  823. app.state.config.TASK_MODEL = TASK_MODEL
  824. app.state.config.TASK_MODEL_EXTERNAL = TASK_MODEL_EXTERNAL
  825. app.state.config.ENABLE_SEARCH_QUERY_GENERATION = ENABLE_SEARCH_QUERY_GENERATION
  826. app.state.config.ENABLE_RETRIEVAL_QUERY_GENERATION = ENABLE_RETRIEVAL_QUERY_GENERATION
  827. app.state.config.ENABLE_AUTOCOMPLETE_GENERATION = ENABLE_AUTOCOMPLETE_GENERATION
  828. app.state.config.ENABLE_TAGS_GENERATION = ENABLE_TAGS_GENERATION
  829. app.state.config.ENABLE_TITLE_GENERATION = ENABLE_TITLE_GENERATION
  830. app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE = TITLE_GENERATION_PROMPT_TEMPLATE
  831. app.state.config.TAGS_GENERATION_PROMPT_TEMPLATE = TAGS_GENERATION_PROMPT_TEMPLATE
  832. app.state.config.IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE = (
  833. IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE
  834. )
  835. app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = (
  836. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
  837. )
  838. app.state.config.QUERY_GENERATION_PROMPT_TEMPLATE = QUERY_GENERATION_PROMPT_TEMPLATE
  839. app.state.config.AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE = (
  840. AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE
  841. )
  842. app.state.config.AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH = (
  843. AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH
  844. )
  845. ########################################
  846. #
  847. # WEBUI
  848. #
  849. ########################################
  850. app.state.MODELS = {}
  851. class RedirectMiddleware(BaseHTTPMiddleware):
  852. async def dispatch(self, request: Request, call_next):
  853. # Check if the request is a GET request
  854. if request.method == "GET":
  855. path = request.url.path
  856. query_params = dict(parse_qs(urlparse(str(request.url)).query))
  857. # Check for the specific watch path and the presence of 'v' parameter
  858. if path.endswith("/watch") and "v" in query_params:
  859. # Extract the first 'v' parameter
  860. video_id = query_params["v"][0]
  861. encoded_video_id = urlencode({"youtube": video_id})
  862. redirect_url = f"/?{encoded_video_id}"
  863. return RedirectResponse(url=redirect_url)
  864. # Proceed with the normal flow of other requests
  865. response = await call_next(request)
  866. return response
  867. # Add the middleware to the app
  868. app.add_middleware(CompressMiddleware)
  869. app.add_middleware(RedirectMiddleware)
  870. app.add_middleware(SecurityHeadersMiddleware)
  871. @app.middleware("http")
  872. async def commit_session_after_request(request: Request, call_next):
  873. response = await call_next(request)
  874. # log.debug("Commit session after request")
  875. Session.commit()
  876. return response
  877. @app.middleware("http")
  878. async def check_url(request: Request, call_next):
  879. start_time = int(time.time())
  880. request.state.token = get_http_authorization_cred(
  881. request.headers.get("Authorization")
  882. )
  883. request.state.enable_api_key = app.state.config.ENABLE_API_KEY
  884. response = await call_next(request)
  885. process_time = int(time.time()) - start_time
  886. response.headers["X-Process-Time"] = str(process_time)
  887. return response
  888. @app.middleware("http")
  889. async def inspect_websocket(request: Request, call_next):
  890. if (
  891. "/ws/socket.io" in request.url.path
  892. and request.query_params.get("transport") == "websocket"
  893. ):
  894. upgrade = (request.headers.get("Upgrade") or "").lower()
  895. connection = (request.headers.get("Connection") or "").lower().split(",")
  896. # Check that there's the correct headers for an upgrade, else reject the connection
  897. # This is to work around this upstream issue: https://github.com/miguelgrinberg/python-engineio/issues/367
  898. if upgrade != "websocket" or "upgrade" not in connection:
  899. return JSONResponse(
  900. status_code=status.HTTP_400_BAD_REQUEST,
  901. content={"detail": "Invalid WebSocket upgrade request"},
  902. )
  903. return await call_next(request)
  904. app.add_middleware(
  905. CORSMiddleware,
  906. allow_origins=CORS_ALLOW_ORIGIN,
  907. allow_credentials=True,
  908. allow_methods=["*"],
  909. allow_headers=["*"],
  910. )
  911. app.mount("/ws", socket_app)
  912. app.include_router(ollama.router, prefix="/ollama", tags=["ollama"])
  913. app.include_router(openai.router, prefix="/openai", tags=["openai"])
  914. app.include_router(pipelines.router, prefix="/api/v1/pipelines", tags=["pipelines"])
  915. app.include_router(tasks.router, prefix="/api/v1/tasks", tags=["tasks"])
  916. app.include_router(images.router, prefix="/api/v1/images", tags=["images"])
  917. app.include_router(audio.router, prefix="/api/v1/audio", tags=["audio"])
  918. app.include_router(retrieval.router, prefix="/api/v1/retrieval", tags=["retrieval"])
  919. app.include_router(configs.router, prefix="/api/v1/configs", tags=["configs"])
  920. app.include_router(auths.router, prefix="/api/v1/auths", tags=["auths"])
  921. app.include_router(users.router, prefix="/api/v1/users", tags=["users"])
  922. app.include_router(channels.router, prefix="/api/v1/channels", tags=["channels"])
  923. app.include_router(chats.router, prefix="/api/v1/chats", tags=["chats"])
  924. app.include_router(notes.router, prefix="/api/v1/notes", tags=["notes"])
  925. app.include_router(models.router, prefix="/api/v1/models", tags=["models"])
  926. app.include_router(knowledge.router, prefix="/api/v1/knowledge", tags=["knowledge"])
  927. app.include_router(prompts.router, prefix="/api/v1/prompts", tags=["prompts"])
  928. app.include_router(tools.router, prefix="/api/v1/tools", tags=["tools"])
  929. app.include_router(memories.router, prefix="/api/v1/memories", tags=["memories"])
  930. app.include_router(folders.router, prefix="/api/v1/folders", tags=["folders"])
  931. app.include_router(groups.router, prefix="/api/v1/groups", tags=["groups"])
  932. app.include_router(files.router, prefix="/api/v1/files", tags=["files"])
  933. app.include_router(functions.router, prefix="/api/v1/functions", tags=["functions"])
  934. app.include_router(
  935. evaluations.router, prefix="/api/v1/evaluations", tags=["evaluations"]
  936. )
  937. app.include_router(utils.router, prefix="/api/v1/utils", tags=["utils"])
  938. try:
  939. audit_level = AuditLevel(AUDIT_LOG_LEVEL)
  940. except ValueError as e:
  941. logger.error(f"Invalid audit level: {AUDIT_LOG_LEVEL}. Error: {e}")
  942. audit_level = AuditLevel.NONE
  943. if audit_level != AuditLevel.NONE:
  944. app.add_middleware(
  945. AuditLoggingMiddleware,
  946. audit_level=audit_level,
  947. excluded_paths=AUDIT_EXCLUDED_PATHS,
  948. max_body_size=MAX_BODY_LOG_SIZE,
  949. )
  950. ##################################
  951. #
  952. # Chat Endpoints
  953. #
  954. ##################################
  955. @app.get("/api/models")
  956. async def get_models(request: Request, user=Depends(get_verified_user)):
  957. def get_filtered_models(models, user):
  958. filtered_models = []
  959. for model in models:
  960. if model.get("arena"):
  961. if has_access(
  962. user.id,
  963. type="read",
  964. access_control=model.get("info", {})
  965. .get("meta", {})
  966. .get("access_control", {}),
  967. ):
  968. filtered_models.append(model)
  969. continue
  970. model_info = Models.get_model_by_id(model["id"])
  971. if model_info:
  972. if user.id == model_info.user_id or has_access(
  973. user.id, type="read", access_control=model_info.access_control
  974. ):
  975. filtered_models.append(model)
  976. return filtered_models
  977. all_models = await get_all_models(request, user=user)
  978. models = []
  979. for model in all_models:
  980. # Filter out filter pipelines
  981. if "pipeline" in model and model["pipeline"].get("type", None) == "filter":
  982. continue
  983. try:
  984. model_tags = [
  985. tag.get("name")
  986. for tag in model.get("info", {}).get("meta", {}).get("tags", [])
  987. ]
  988. tags = [tag.get("name") for tag in model.get("tags", [])]
  989. tags = list(set(model_tags + tags))
  990. model["tags"] = [{"name": tag} for tag in tags]
  991. except Exception as e:
  992. log.debug(f"Error processing model tags: {e}")
  993. model["tags"] = []
  994. pass
  995. models.append(model)
  996. model_order_list = request.app.state.config.MODEL_ORDER_LIST
  997. if model_order_list:
  998. model_order_dict = {model_id: i for i, model_id in enumerate(model_order_list)}
  999. # Sort models by order list priority, with fallback for those not in the list
  1000. models.sort(
  1001. key=lambda x: (model_order_dict.get(x["id"], float("inf")), x["name"])
  1002. )
  1003. # Filter out models that the user does not have access to
  1004. if user.role == "user" and not BYPASS_MODEL_ACCESS_CONTROL:
  1005. models = get_filtered_models(models, user)
  1006. log.debug(
  1007. f"/api/models returned filtered models accessible to the user: {json.dumps([model['id'] for model in models])}"
  1008. )
  1009. return {"data": models}
  1010. @app.get("/api/models/base")
  1011. async def get_base_models(request: Request, user=Depends(get_admin_user)):
  1012. models = await get_all_base_models(request, user=user)
  1013. return {"data": models}
  1014. @app.post("/api/chat/completions")
  1015. async def chat_completion(
  1016. request: Request,
  1017. form_data: dict,
  1018. user=Depends(get_verified_user),
  1019. ):
  1020. if not request.app.state.MODELS:
  1021. await get_all_models(request, user=user)
  1022. model_item = form_data.pop("model_item", {})
  1023. tasks = form_data.pop("background_tasks", None)
  1024. metadata = {}
  1025. try:
  1026. if not model_item.get("direct", False):
  1027. model_id = form_data.get("model", None)
  1028. if model_id not in request.app.state.MODELS:
  1029. raise Exception("Model not found")
  1030. model = request.app.state.MODELS[model_id]
  1031. model_info = Models.get_model_by_id(model_id)
  1032. # Check if user has access to the model
  1033. if not BYPASS_MODEL_ACCESS_CONTROL and user.role == "user":
  1034. try:
  1035. check_model_access(user, model)
  1036. except Exception as e:
  1037. raise e
  1038. else:
  1039. model = model_item
  1040. model_info = None
  1041. request.state.direct = True
  1042. request.state.model = model
  1043. metadata = {
  1044. "user_id": user.id,
  1045. "chat_id": form_data.pop("chat_id", None),
  1046. "message_id": form_data.pop("id", None),
  1047. "session_id": form_data.pop("session_id", None),
  1048. "filter_ids": form_data.pop("filter_ids", []),
  1049. "tool_ids": form_data.get("tool_ids", None),
  1050. "tool_servers": form_data.pop("tool_servers", None),
  1051. "files": form_data.get("files", None),
  1052. "features": form_data.get("features", {}),
  1053. "variables": form_data.get("variables", {}),
  1054. "model": model,
  1055. "direct": model_item.get("direct", False),
  1056. **(
  1057. {"function_calling": "native"}
  1058. if form_data.get("params", {}).get("function_calling") == "native"
  1059. or (
  1060. model_info
  1061. and model_info.params.model_dump().get("function_calling")
  1062. == "native"
  1063. )
  1064. else {}
  1065. ),
  1066. }
  1067. request.state.metadata = metadata
  1068. form_data["metadata"] = metadata
  1069. form_data, metadata, events = await process_chat_payload(
  1070. request, form_data, user, metadata, model
  1071. )
  1072. except Exception as e:
  1073. log.debug(f"Error processing chat payload: {e}")
  1074. if metadata.get("chat_id") and metadata.get("message_id"):
  1075. # Update the chat message with the error
  1076. Chats.upsert_message_to_chat_by_id_and_message_id(
  1077. metadata["chat_id"],
  1078. metadata["message_id"],
  1079. {
  1080. "error": {"content": str(e)},
  1081. },
  1082. )
  1083. raise HTTPException(
  1084. status_code=status.HTTP_400_BAD_REQUEST,
  1085. detail=str(e),
  1086. )
  1087. try:
  1088. response = await chat_completion_handler(request, form_data, user)
  1089. return await process_chat_response(
  1090. request, response, form_data, user, metadata, model, events, tasks
  1091. )
  1092. except Exception as e:
  1093. raise HTTPException(
  1094. status_code=status.HTTP_400_BAD_REQUEST,
  1095. detail=str(e),
  1096. )
  1097. # Alias for chat_completion (Legacy)
  1098. generate_chat_completions = chat_completion
  1099. generate_chat_completion = chat_completion
  1100. @app.post("/api/chat/completed")
  1101. async def chat_completed(
  1102. request: Request, form_data: dict, user=Depends(get_verified_user)
  1103. ):
  1104. try:
  1105. model_item = form_data.pop("model_item", {})
  1106. if model_item.get("direct", False):
  1107. request.state.direct = True
  1108. request.state.model = model_item
  1109. return await chat_completed_handler(request, form_data, user)
  1110. except Exception as e:
  1111. raise HTTPException(
  1112. status_code=status.HTTP_400_BAD_REQUEST,
  1113. detail=str(e),
  1114. )
  1115. @app.post("/api/chat/actions/{action_id}")
  1116. async def chat_action(
  1117. request: Request, action_id: str, form_data: dict, user=Depends(get_verified_user)
  1118. ):
  1119. try:
  1120. model_item = form_data.pop("model_item", {})
  1121. if model_item.get("direct", False):
  1122. request.state.direct = True
  1123. request.state.model = model_item
  1124. return await chat_action_handler(request, action_id, form_data, user)
  1125. except Exception as e:
  1126. raise HTTPException(
  1127. status_code=status.HTTP_400_BAD_REQUEST,
  1128. detail=str(e),
  1129. )
  1130. @app.post("/api/tasks/stop/{task_id}")
  1131. async def stop_task_endpoint(task_id: str, user=Depends(get_verified_user)):
  1132. try:
  1133. result = await stop_task(task_id)
  1134. return result
  1135. except ValueError as e:
  1136. raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail=str(e))
  1137. @app.get("/api/tasks")
  1138. async def list_tasks_endpoint(user=Depends(get_verified_user)):
  1139. return {"tasks": list_tasks()}
  1140. @app.get("/api/tasks/chat/{chat_id}")
  1141. async def list_tasks_by_chat_id_endpoint(chat_id: str, user=Depends(get_verified_user)):
  1142. chat = Chats.get_chat_by_id(chat_id)
  1143. if chat is None or chat.user_id != user.id:
  1144. return {"task_ids": []}
  1145. task_ids = list_task_ids_by_chat_id(chat_id)
  1146. print(f"Task IDs for chat {chat_id}: {task_ids}")
  1147. return {"task_ids": task_ids}
  1148. ##################################
  1149. #
  1150. # Config Endpoints
  1151. #
  1152. ##################################
  1153. @app.get("/api/config")
  1154. async def get_app_config(request: Request):
  1155. user = None
  1156. if "token" in request.cookies:
  1157. token = request.cookies.get("token")
  1158. try:
  1159. data = decode_token(token)
  1160. except Exception as e:
  1161. log.debug(e)
  1162. raise HTTPException(
  1163. status_code=status.HTTP_401_UNAUTHORIZED,
  1164. detail="Invalid token",
  1165. )
  1166. if data is not None and "id" in data:
  1167. user = Users.get_user_by_id(data["id"])
  1168. user_count = Users.get_num_users()
  1169. onboarding = False
  1170. if user is None:
  1171. onboarding = user_count == 0
  1172. return {
  1173. **({"onboarding": True} if onboarding else {}),
  1174. "status": True,
  1175. "name": app.state.WEBUI_NAME,
  1176. "version": VERSION,
  1177. "default_locale": str(DEFAULT_LOCALE),
  1178. "oauth": {
  1179. "providers": {
  1180. name: config.get("name", name)
  1181. for name, config in OAUTH_PROVIDERS.items()
  1182. }
  1183. },
  1184. "features": {
  1185. "auth": WEBUI_AUTH,
  1186. "auth_trusted_header": bool(app.state.AUTH_TRUSTED_EMAIL_HEADER),
  1187. "enable_ldap": app.state.config.ENABLE_LDAP,
  1188. "enable_api_key": app.state.config.ENABLE_API_KEY,
  1189. "enable_signup": app.state.config.ENABLE_SIGNUP,
  1190. "enable_login_form": app.state.config.ENABLE_LOGIN_FORM,
  1191. "enable_websocket": ENABLE_WEBSOCKET_SUPPORT,
  1192. **(
  1193. {
  1194. "enable_direct_connections": app.state.config.ENABLE_DIRECT_CONNECTIONS,
  1195. "enable_channels": app.state.config.ENABLE_CHANNELS,
  1196. "enable_notes": app.state.config.ENABLE_NOTES,
  1197. "enable_web_search": app.state.config.ENABLE_WEB_SEARCH,
  1198. "enable_code_execution": app.state.config.ENABLE_CODE_EXECUTION,
  1199. "enable_code_interpreter": app.state.config.ENABLE_CODE_INTERPRETER,
  1200. "enable_image_generation": app.state.config.ENABLE_IMAGE_GENERATION,
  1201. "enable_autocomplete_generation": app.state.config.ENABLE_AUTOCOMPLETE_GENERATION,
  1202. "enable_community_sharing": app.state.config.ENABLE_COMMUNITY_SHARING,
  1203. "enable_message_rating": app.state.config.ENABLE_MESSAGE_RATING,
  1204. "enable_user_webhooks": app.state.config.ENABLE_USER_WEBHOOKS,
  1205. "enable_admin_export": ENABLE_ADMIN_EXPORT,
  1206. "enable_admin_chat_access": ENABLE_ADMIN_CHAT_ACCESS,
  1207. "enable_google_drive_integration": app.state.config.ENABLE_GOOGLE_DRIVE_INTEGRATION,
  1208. "enable_onedrive_integration": app.state.config.ENABLE_ONEDRIVE_INTEGRATION,
  1209. }
  1210. if user is not None
  1211. else {}
  1212. ),
  1213. },
  1214. **(
  1215. {
  1216. "default_models": app.state.config.DEFAULT_MODELS,
  1217. "default_prompt_suggestions": app.state.config.DEFAULT_PROMPT_SUGGESTIONS,
  1218. "user_count": user_count,
  1219. "code": {
  1220. "engine": app.state.config.CODE_EXECUTION_ENGINE,
  1221. },
  1222. "audio": {
  1223. "tts": {
  1224. "engine": app.state.config.TTS_ENGINE,
  1225. "voice": app.state.config.TTS_VOICE,
  1226. "split_on": app.state.config.TTS_SPLIT_ON,
  1227. },
  1228. "stt": {
  1229. "engine": app.state.config.STT_ENGINE,
  1230. },
  1231. },
  1232. "file": {
  1233. "max_size": app.state.config.FILE_MAX_SIZE,
  1234. "max_count": app.state.config.FILE_MAX_COUNT,
  1235. },
  1236. "permissions": {**app.state.config.USER_PERMISSIONS},
  1237. "google_drive": {
  1238. "client_id": GOOGLE_DRIVE_CLIENT_ID.value,
  1239. "api_key": GOOGLE_DRIVE_API_KEY.value,
  1240. },
  1241. "onedrive": {
  1242. "client_id": ONEDRIVE_CLIENT_ID.value,
  1243. "sharepoint_url": ONEDRIVE_SHAREPOINT_URL.value,
  1244. "sharepoint_tenant_id": ONEDRIVE_SHAREPOINT_TENANT_ID.value,
  1245. },
  1246. "ui": {
  1247. "pending_user_overlay_title": app.state.config.PENDING_USER_OVERLAY_TITLE,
  1248. "pending_user_overlay_content": app.state.config.PENDING_USER_OVERLAY_CONTENT,
  1249. "response_watermark": app.state.config.RESPONSE_WATERMARK,
  1250. },
  1251. "license_metadata": app.state.LICENSE_METADATA,
  1252. **(
  1253. {
  1254. "active_entries": app.state.USER_COUNT,
  1255. }
  1256. if user.role == "admin"
  1257. else {}
  1258. ),
  1259. }
  1260. if user is not None
  1261. else {}
  1262. ),
  1263. }
  1264. class UrlForm(BaseModel):
  1265. url: str
  1266. @app.get("/api/webhook")
  1267. async def get_webhook_url(user=Depends(get_admin_user)):
  1268. return {
  1269. "url": app.state.config.WEBHOOK_URL,
  1270. }
  1271. @app.post("/api/webhook")
  1272. async def update_webhook_url(form_data: UrlForm, user=Depends(get_admin_user)):
  1273. app.state.config.WEBHOOK_URL = form_data.url
  1274. app.state.WEBHOOK_URL = app.state.config.WEBHOOK_URL
  1275. return {"url": app.state.config.WEBHOOK_URL}
  1276. @app.get("/api/version")
  1277. async def get_app_version():
  1278. return {
  1279. "version": VERSION,
  1280. }
  1281. @app.get("/api/version/updates")
  1282. async def get_app_latest_release_version(user=Depends(get_verified_user)):
  1283. if OFFLINE_MODE:
  1284. log.debug(
  1285. f"Offline mode is enabled, returning current version as latest version"
  1286. )
  1287. return {"current": VERSION, "latest": VERSION}
  1288. try:
  1289. timeout = aiohttp.ClientTimeout(total=1)
  1290. async with aiohttp.ClientSession(timeout=timeout, trust_env=True) as session:
  1291. async with session.get(
  1292. "https://api.github.com/repos/open-webui/open-webui/releases/latest",
  1293. ssl=AIOHTTP_CLIENT_SESSION_SSL,
  1294. ) as response:
  1295. response.raise_for_status()
  1296. data = await response.json()
  1297. latest_version = data["tag_name"]
  1298. return {"current": VERSION, "latest": latest_version[1:]}
  1299. except Exception as e:
  1300. log.debug(e)
  1301. return {"current": VERSION, "latest": VERSION}
  1302. @app.get("/api/changelog")
  1303. async def get_app_changelog():
  1304. return {key: CHANGELOG[key] for idx, key in enumerate(CHANGELOG) if idx < 5}
  1305. ############################
  1306. # OAuth Login & Callback
  1307. ############################
  1308. # SessionMiddleware is used by authlib for oauth
  1309. if len(OAUTH_PROVIDERS) > 0:
  1310. app.add_middleware(
  1311. SessionMiddleware,
  1312. secret_key=WEBUI_SECRET_KEY,
  1313. session_cookie="oui-session",
  1314. same_site=WEBUI_SESSION_COOKIE_SAME_SITE,
  1315. https_only=WEBUI_SESSION_COOKIE_SECURE,
  1316. )
  1317. @app.get("/oauth/{provider}/login")
  1318. async def oauth_login(provider: str, request: Request):
  1319. return await oauth_manager.handle_login(request, provider)
  1320. # OAuth login logic is as follows:
  1321. # 1. Attempt to find a user with matching subject ID, tied to the provider
  1322. # 2. If OAUTH_MERGE_ACCOUNTS_BY_EMAIL is true, find a user with the email address provided via OAuth
  1323. # - This is considered insecure in general, as OAuth providers do not always verify email addresses
  1324. # 3. If there is no user, and ENABLE_OAUTH_SIGNUP is true, create a user
  1325. # - Email addresses are considered unique, so we fail registration if the email address is already taken
  1326. @app.get("/oauth/{provider}/callback")
  1327. async def oauth_callback(provider: str, request: Request, response: Response):
  1328. return await oauth_manager.handle_callback(request, provider, response)
  1329. @app.get("/manifest.json")
  1330. async def get_manifest_json():
  1331. if app.state.EXTERNAL_PWA_MANIFEST_URL:
  1332. return requests.get(app.state.EXTERNAL_PWA_MANIFEST_URL).json()
  1333. else:
  1334. return {
  1335. "name": app.state.WEBUI_NAME,
  1336. "short_name": app.state.WEBUI_NAME,
  1337. "description": "Open WebUI is an open, extensible, user-friendly interface for AI that adapts to your workflow.",
  1338. "start_url": "/",
  1339. "display": "standalone",
  1340. "background_color": "#343541",
  1341. "orientation": "any",
  1342. "icons": [
  1343. {
  1344. "src": "/static/logo.png",
  1345. "type": "image/png",
  1346. "sizes": "500x500",
  1347. "purpose": "any",
  1348. },
  1349. {
  1350. "src": "/static/logo.png",
  1351. "type": "image/png",
  1352. "sizes": "500x500",
  1353. "purpose": "maskable",
  1354. },
  1355. ],
  1356. }
  1357. @app.get("/opensearch.xml")
  1358. async def get_opensearch_xml():
  1359. xml_content = rf"""
  1360. <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" xmlns:moz="http://www.mozilla.org/2006/browser/search/">
  1361. <ShortName>{app.state.WEBUI_NAME}</ShortName>
  1362. <Description>Search {app.state.WEBUI_NAME}</Description>
  1363. <InputEncoding>UTF-8</InputEncoding>
  1364. <Image width="16" height="16" type="image/x-icon">{app.state.config.WEBUI_URL}/static/favicon.png</Image>
  1365. <Url type="text/html" method="get" template="{app.state.config.WEBUI_URL}/?q={"{searchTerms}"}"/>
  1366. <moz:SearchForm>{app.state.config.WEBUI_URL}</moz:SearchForm>
  1367. </OpenSearchDescription>
  1368. """
  1369. return Response(content=xml_content, media_type="application/xml")
  1370. @app.get("/health")
  1371. async def healthcheck():
  1372. return {"status": True}
  1373. @app.get("/health/db")
  1374. async def healthcheck_with_db():
  1375. Session.execute(text("SELECT 1;")).all()
  1376. return {"status": True}
  1377. app.mount("/static", StaticFiles(directory=STATIC_DIR), name="static")
  1378. app.mount("/cache", StaticFiles(directory=CACHE_DIR), name="cache")
  1379. def swagger_ui_html(*args, **kwargs):
  1380. return get_swagger_ui_html(
  1381. *args,
  1382. **kwargs,
  1383. swagger_js_url="/static/swagger-ui/swagger-ui-bundle.js",
  1384. swagger_css_url="/static/swagger-ui/swagger-ui.css",
  1385. swagger_favicon_url="/static/swagger-ui/favicon.png",
  1386. )
  1387. applications.get_swagger_ui_html = swagger_ui_html
  1388. if os.path.exists(FRONTEND_BUILD_DIR):
  1389. mimetypes.add_type("text/javascript", ".js")
  1390. app.mount(
  1391. "/",
  1392. SPAStaticFiles(directory=FRONTEND_BUILD_DIR, html=True),
  1393. name="spa-static-files",
  1394. )
  1395. else:
  1396. log.warning(
  1397. f"Frontend build directory not found at '{FRONTEND_BUILD_DIR}'. Serving API only."
  1398. )