main.py 71 KB

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