main.py 63 KB

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