main.py 59 KB

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