main.py 68 KB

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