main.py 60 KB

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