main.py 67 KB

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