main.py 58 KB

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