main.py 59 KB

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