main.py 67 KB

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