main.py 42 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306
  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 contextlib import asynccontextmanager
  12. from urllib.parse import urlencode, parse_qs, urlparse
  13. from pydantic import BaseModel
  14. from sqlalchemy import text
  15. from typing import Optional
  16. from aiocache import cached
  17. import aiohttp
  18. import requests
  19. from fastapi import (
  20. Depends,
  21. FastAPI,
  22. File,
  23. Form,
  24. HTTPException,
  25. Request,
  26. UploadFile,
  27. status,
  28. applications,
  29. BackgroundTasks,
  30. )
  31. from fastapi.openapi.docs import get_swagger_ui_html
  32. from fastapi.middleware.cors import CORSMiddleware
  33. from fastapi.responses import JSONResponse, RedirectResponse
  34. from fastapi.staticfiles import StaticFiles
  35. from starlette.exceptions import HTTPException as StarletteHTTPException
  36. from starlette.middleware.base import BaseHTTPMiddleware
  37. from starlette.middleware.sessions import SessionMiddleware
  38. from starlette.responses import Response, StreamingResponse
  39. from open_webui.socket.main import (
  40. app as socket_app,
  41. periodic_usage_pool_cleanup,
  42. )
  43. from open_webui.routers import (
  44. audio,
  45. images,
  46. ollama,
  47. openai,
  48. retrieval,
  49. pipelines,
  50. tasks,
  51. auths,
  52. channels,
  53. chats,
  54. folders,
  55. configs,
  56. groups,
  57. files,
  58. functions,
  59. memories,
  60. models,
  61. knowledge,
  62. prompts,
  63. evaluations,
  64. tools,
  65. users,
  66. utils,
  67. )
  68. from open_webui.routers.retrieval import (
  69. get_embedding_function,
  70. get_ef,
  71. get_rf,
  72. )
  73. from open_webui.internal.db import Session
  74. from open_webui.models.functions import Functions
  75. from open_webui.models.models import Models
  76. from open_webui.models.users import UserModel, Users
  77. from open_webui.config import (
  78. # Ollama
  79. ENABLE_OLLAMA_API,
  80. OLLAMA_BASE_URLS,
  81. OLLAMA_API_CONFIGS,
  82. # OpenAI
  83. ENABLE_OPENAI_API,
  84. OPENAI_API_BASE_URLS,
  85. OPENAI_API_KEYS,
  86. OPENAI_API_CONFIGS,
  87. # Direct Connections
  88. ENABLE_DIRECT_CONNECTIONS,
  89. # Code Interpreter
  90. ENABLE_CODE_INTERPRETER,
  91. CODE_INTERPRETER_ENGINE,
  92. CODE_INTERPRETER_PROMPT_TEMPLATE,
  93. CODE_INTERPRETER_JUPYTER_URL,
  94. CODE_INTERPRETER_JUPYTER_AUTH,
  95. CODE_INTERPRETER_JUPYTER_AUTH_TOKEN,
  96. CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD,
  97. # Image
  98. AUTOMATIC1111_API_AUTH,
  99. AUTOMATIC1111_BASE_URL,
  100. AUTOMATIC1111_CFG_SCALE,
  101. AUTOMATIC1111_SAMPLER,
  102. AUTOMATIC1111_SCHEDULER,
  103. COMFYUI_BASE_URL,
  104. COMFYUI_API_KEY,
  105. COMFYUI_WORKFLOW,
  106. COMFYUI_WORKFLOW_NODES,
  107. ENABLE_IMAGE_GENERATION,
  108. ENABLE_IMAGE_PROMPT_GENERATION,
  109. IMAGE_GENERATION_ENGINE,
  110. IMAGE_GENERATION_MODEL,
  111. IMAGE_SIZE,
  112. IMAGE_STEPS,
  113. IMAGES_OPENAI_API_BASE_URL,
  114. IMAGES_OPENAI_API_KEY,
  115. # Audio
  116. AUDIO_STT_ENGINE,
  117. AUDIO_STT_MODEL,
  118. AUDIO_STT_OPENAI_API_BASE_URL,
  119. AUDIO_STT_OPENAI_API_KEY,
  120. AUDIO_TTS_API_KEY,
  121. AUDIO_TTS_ENGINE,
  122. AUDIO_TTS_MODEL,
  123. AUDIO_TTS_OPENAI_API_BASE_URL,
  124. AUDIO_TTS_OPENAI_API_KEY,
  125. AUDIO_TTS_SPLIT_ON,
  126. AUDIO_TTS_VOICE,
  127. AUDIO_TTS_AZURE_SPEECH_REGION,
  128. AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT,
  129. PLAYWRIGHT_WS_URI,
  130. RAG_WEB_LOADER_ENGINE,
  131. WHISPER_MODEL,
  132. DEEPGRAM_API_KEY,
  133. WHISPER_MODEL_AUTO_UPDATE,
  134. WHISPER_MODEL_DIR,
  135. # Retrieval
  136. RAG_TEMPLATE,
  137. DEFAULT_RAG_TEMPLATE,
  138. RAG_EMBEDDING_MODEL,
  139. RAG_EMBEDDING_MODEL_AUTO_UPDATE,
  140. RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE,
  141. RAG_RERANKING_MODEL,
  142. RAG_RERANKING_MODEL_AUTO_UPDATE,
  143. RAG_RERANKING_MODEL_TRUST_REMOTE_CODE,
  144. RAG_EMBEDDING_ENGINE,
  145. RAG_EMBEDDING_BATCH_SIZE,
  146. RAG_RELEVANCE_THRESHOLD,
  147. RAG_FILE_MAX_COUNT,
  148. RAG_FILE_MAX_SIZE,
  149. RAG_OPENAI_API_BASE_URL,
  150. RAG_OPENAI_API_KEY,
  151. RAG_OLLAMA_BASE_URL,
  152. RAG_OLLAMA_API_KEY,
  153. CHUNK_OVERLAP,
  154. CHUNK_SIZE,
  155. CONTENT_EXTRACTION_ENGINE,
  156. TIKA_SERVER_URL,
  157. RAG_TOP_K,
  158. RAG_TEXT_SPLITTER,
  159. TIKTOKEN_ENCODING_NAME,
  160. PDF_EXTRACT_IMAGES,
  161. YOUTUBE_LOADER_LANGUAGE,
  162. YOUTUBE_LOADER_PROXY_URL,
  163. # Retrieval (Web Search)
  164. RAG_WEB_SEARCH_ENGINE,
  165. RAG_WEB_SEARCH_RESULT_COUNT,
  166. RAG_WEB_SEARCH_CONCURRENT_REQUESTS,
  167. RAG_WEB_SEARCH_TRUST_ENV,
  168. RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  169. JINA_API_KEY,
  170. SEARCHAPI_API_KEY,
  171. SEARCHAPI_ENGINE,
  172. SERPAPI_API_KEY,
  173. SERPAPI_ENGINE,
  174. SEARXNG_QUERY_URL,
  175. SERPER_API_KEY,
  176. SERPLY_API_KEY,
  177. SERPSTACK_API_KEY,
  178. SERPSTACK_HTTPS,
  179. TAVILY_API_KEY,
  180. BING_SEARCH_V7_ENDPOINT,
  181. BING_SEARCH_V7_SUBSCRIPTION_KEY,
  182. BRAVE_SEARCH_API_KEY,
  183. EXA_API_KEY,
  184. KAGI_SEARCH_API_KEY,
  185. MOJEEK_SEARCH_API_KEY,
  186. BOCHA_SEARCH_API_KEY,
  187. GOOGLE_PSE_API_KEY,
  188. GOOGLE_PSE_ENGINE_ID,
  189. GOOGLE_DRIVE_CLIENT_ID,
  190. GOOGLE_DRIVE_API_KEY,
  191. ENABLE_RAG_HYBRID_SEARCH,
  192. ENABLE_RAG_LOCAL_WEB_FETCH,
  193. ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION,
  194. ENABLE_RAG_WEB_SEARCH,
  195. ENABLE_GOOGLE_DRIVE_INTEGRATION,
  196. UPLOAD_DIR,
  197. # WebUI
  198. WEBUI_AUTH,
  199. WEBUI_NAME,
  200. WEBUI_BANNERS,
  201. WEBHOOK_URL,
  202. ADMIN_EMAIL,
  203. SHOW_ADMIN_DETAILS,
  204. JWT_EXPIRES_IN,
  205. ENABLE_SIGNUP,
  206. ENABLE_LOGIN_FORM,
  207. ENABLE_API_KEY,
  208. ENABLE_API_KEY_ENDPOINT_RESTRICTIONS,
  209. API_KEY_ALLOWED_ENDPOINTS,
  210. ENABLE_CHANNELS,
  211. ENABLE_COMMUNITY_SHARING,
  212. ENABLE_MESSAGE_RATING,
  213. ENABLE_EVALUATION_ARENA_MODELS,
  214. USER_PERMISSIONS,
  215. DEFAULT_USER_ROLE,
  216. DEFAULT_PROMPT_SUGGESTIONS,
  217. DEFAULT_MODELS,
  218. DEFAULT_ARENA_MODEL,
  219. MODEL_ORDER_LIST,
  220. EVALUATION_ARENA_MODELS,
  221. # WebUI (OAuth)
  222. ENABLE_OAUTH_ROLE_MANAGEMENT,
  223. OAUTH_ROLES_CLAIM,
  224. OAUTH_EMAIL_CLAIM,
  225. OAUTH_PICTURE_CLAIM,
  226. OAUTH_USERNAME_CLAIM,
  227. OAUTH_ALLOWED_ROLES,
  228. OAUTH_ADMIN_ROLES,
  229. # WebUI (LDAP)
  230. ENABLE_LDAP,
  231. LDAP_SERVER_LABEL,
  232. LDAP_SERVER_HOST,
  233. LDAP_SERVER_PORT,
  234. LDAP_ATTRIBUTE_FOR_MAIL,
  235. LDAP_ATTRIBUTE_FOR_USERNAME,
  236. LDAP_SEARCH_FILTERS,
  237. LDAP_SEARCH_BASE,
  238. LDAP_APP_DN,
  239. LDAP_APP_PASSWORD,
  240. LDAP_USE_TLS,
  241. LDAP_CA_CERT_FILE,
  242. LDAP_CIPHERS,
  243. # Misc
  244. ENV,
  245. CACHE_DIR,
  246. STATIC_DIR,
  247. FRONTEND_BUILD_DIR,
  248. CORS_ALLOW_ORIGIN,
  249. DEFAULT_LOCALE,
  250. OAUTH_PROVIDERS,
  251. WEBUI_URL,
  252. # Admin
  253. ENABLE_ADMIN_CHAT_ACCESS,
  254. ENABLE_ADMIN_EXPORT,
  255. # Tasks
  256. TASK_MODEL,
  257. TASK_MODEL_EXTERNAL,
  258. ENABLE_TAGS_GENERATION,
  259. ENABLE_TITLE_GENERATION,
  260. ENABLE_SEARCH_QUERY_GENERATION,
  261. ENABLE_RETRIEVAL_QUERY_GENERATION,
  262. ENABLE_AUTOCOMPLETE_GENERATION,
  263. TITLE_GENERATION_PROMPT_TEMPLATE,
  264. TAGS_GENERATION_PROMPT_TEMPLATE,
  265. IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE,
  266. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
  267. QUERY_GENERATION_PROMPT_TEMPLATE,
  268. AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE,
  269. AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH,
  270. AppConfig,
  271. reset_config,
  272. )
  273. from open_webui.env import (
  274. CHANGELOG,
  275. GLOBAL_LOG_LEVEL,
  276. SAFE_MODE,
  277. SRC_LOG_LEVELS,
  278. VERSION,
  279. WEBUI_BUILD_HASH,
  280. WEBUI_SECRET_KEY,
  281. WEBUI_SESSION_COOKIE_SAME_SITE,
  282. WEBUI_SESSION_COOKIE_SECURE,
  283. WEBUI_AUTH_TRUSTED_EMAIL_HEADER,
  284. WEBUI_AUTH_TRUSTED_NAME_HEADER,
  285. ENABLE_WEBSOCKET_SUPPORT,
  286. BYPASS_MODEL_ACCESS_CONTROL,
  287. RESET_CONFIG_ON_START,
  288. OFFLINE_MODE,
  289. )
  290. from open_webui.utils.models import (
  291. get_all_models,
  292. get_all_base_models,
  293. check_model_access,
  294. )
  295. from open_webui.utils.chat import (
  296. generate_chat_completion as chat_completion_handler,
  297. chat_completed as chat_completed_handler,
  298. chat_action as chat_action_handler,
  299. )
  300. from open_webui.utils.middleware import process_chat_payload, process_chat_response
  301. from open_webui.utils.access_control import has_access
  302. from open_webui.utils.auth import (
  303. decode_token,
  304. get_admin_user,
  305. get_verified_user,
  306. )
  307. from open_webui.utils.oauth import oauth_manager
  308. from open_webui.utils.security_headers import SecurityHeadersMiddleware
  309. from open_webui.tasks import stop_task, list_tasks # Import from tasks.py
  310. if SAFE_MODE:
  311. print("SAFE MODE ENABLED")
  312. Functions.deactivate_all_functions()
  313. logging.basicConfig(stream=sys.stdout, level=GLOBAL_LOG_LEVEL)
  314. log = logging.getLogger(__name__)
  315. log.setLevel(SRC_LOG_LEVELS["MAIN"])
  316. class SPAStaticFiles(StaticFiles):
  317. async def get_response(self, path: str, scope):
  318. try:
  319. return await super().get_response(path, scope)
  320. except (HTTPException, StarletteHTTPException) as ex:
  321. if ex.status_code == 404:
  322. if path.endswith(".js"):
  323. # Return 404 for javascript files
  324. raise ex
  325. else:
  326. return await super().get_response("index.html", scope)
  327. else:
  328. raise ex
  329. print(
  330. rf"""
  331. ██████╗ ██████╗ ███████╗███╗ ██╗ ██╗ ██╗███████╗██████╗ ██╗ ██╗██╗
  332. ██╔═══██╗██╔══██╗██╔════╝████╗ ██║ ██║ ██║██╔════╝██╔══██╗██║ ██║██║
  333. ██║ ██║██████╔╝█████╗ ██╔██╗ ██║ ██║ █╗ ██║█████╗ ██████╔╝██║ ██║██║
  334. ██║ ██║██╔═══╝ ██╔══╝ ██║╚██╗██║ ██║███╗██║██╔══╝ ██╔══██╗██║ ██║██║
  335. ╚██████╔╝██║ ███████╗██║ ╚████║ ╚███╔███╔╝███████╗██████╔╝╚██████╔╝██║
  336. ╚═════╝ ╚═╝ ╚══════╝╚═╝ ╚═══╝ ╚══╝╚══╝ ╚══════╝╚═════╝ ╚═════╝ ╚═╝
  337. v{VERSION} - building the best open-source AI user interface.
  338. {f"Commit: {WEBUI_BUILD_HASH}" if WEBUI_BUILD_HASH != "dev-build" else ""}
  339. https://github.com/open-webui/open-webui
  340. """
  341. )
  342. @asynccontextmanager
  343. async def lifespan(app: FastAPI):
  344. if RESET_CONFIG_ON_START:
  345. reset_config()
  346. asyncio.create_task(periodic_usage_pool_cleanup())
  347. yield
  348. app = FastAPI(
  349. docs_url="/docs" if ENV == "dev" else None,
  350. openapi_url="/openapi.json" if ENV == "dev" else None,
  351. redoc_url=None,
  352. lifespan=lifespan,
  353. )
  354. app.state.config = AppConfig()
  355. ########################################
  356. #
  357. # OLLAMA
  358. #
  359. ########################################
  360. app.state.config.ENABLE_OLLAMA_API = ENABLE_OLLAMA_API
  361. app.state.config.OLLAMA_BASE_URLS = OLLAMA_BASE_URLS
  362. app.state.config.OLLAMA_API_CONFIGS = OLLAMA_API_CONFIGS
  363. app.state.OLLAMA_MODELS = {}
  364. ########################################
  365. #
  366. # OPENAI
  367. #
  368. ########################################
  369. app.state.config.ENABLE_OPENAI_API = ENABLE_OPENAI_API
  370. app.state.config.OPENAI_API_BASE_URLS = OPENAI_API_BASE_URLS
  371. app.state.config.OPENAI_API_KEYS = OPENAI_API_KEYS
  372. app.state.config.OPENAI_API_CONFIGS = OPENAI_API_CONFIGS
  373. app.state.OPENAI_MODELS = {}
  374. ########################################
  375. #
  376. # DIRECT CONNECTIONS
  377. #
  378. ########################################
  379. app.state.config.ENABLE_DIRECT_CONNECTIONS = ENABLE_DIRECT_CONNECTIONS
  380. ########################################
  381. #
  382. # WEBUI
  383. #
  384. ########################################
  385. app.state.config.WEBUI_URL = WEBUI_URL
  386. app.state.config.ENABLE_SIGNUP = ENABLE_SIGNUP
  387. app.state.config.ENABLE_LOGIN_FORM = ENABLE_LOGIN_FORM
  388. app.state.config.ENABLE_API_KEY = ENABLE_API_KEY
  389. app.state.config.ENABLE_API_KEY_ENDPOINT_RESTRICTIONS = (
  390. ENABLE_API_KEY_ENDPOINT_RESTRICTIONS
  391. )
  392. app.state.config.API_KEY_ALLOWED_ENDPOINTS = API_KEY_ALLOWED_ENDPOINTS
  393. app.state.config.JWT_EXPIRES_IN = JWT_EXPIRES_IN
  394. app.state.config.SHOW_ADMIN_DETAILS = SHOW_ADMIN_DETAILS
  395. app.state.config.ADMIN_EMAIL = ADMIN_EMAIL
  396. app.state.config.DEFAULT_MODELS = DEFAULT_MODELS
  397. app.state.config.DEFAULT_PROMPT_SUGGESTIONS = DEFAULT_PROMPT_SUGGESTIONS
  398. app.state.config.DEFAULT_USER_ROLE = DEFAULT_USER_ROLE
  399. app.state.config.USER_PERMISSIONS = USER_PERMISSIONS
  400. app.state.config.WEBHOOK_URL = WEBHOOK_URL
  401. app.state.config.BANNERS = WEBUI_BANNERS
  402. app.state.config.MODEL_ORDER_LIST = MODEL_ORDER_LIST
  403. app.state.config.ENABLE_CHANNELS = ENABLE_CHANNELS
  404. app.state.config.ENABLE_COMMUNITY_SHARING = ENABLE_COMMUNITY_SHARING
  405. app.state.config.ENABLE_MESSAGE_RATING = ENABLE_MESSAGE_RATING
  406. app.state.config.ENABLE_EVALUATION_ARENA_MODELS = ENABLE_EVALUATION_ARENA_MODELS
  407. app.state.config.EVALUATION_ARENA_MODELS = EVALUATION_ARENA_MODELS
  408. app.state.config.OAUTH_USERNAME_CLAIM = OAUTH_USERNAME_CLAIM
  409. app.state.config.OAUTH_PICTURE_CLAIM = OAUTH_PICTURE_CLAIM
  410. app.state.config.OAUTH_EMAIL_CLAIM = OAUTH_EMAIL_CLAIM
  411. app.state.config.ENABLE_OAUTH_ROLE_MANAGEMENT = ENABLE_OAUTH_ROLE_MANAGEMENT
  412. app.state.config.OAUTH_ROLES_CLAIM = OAUTH_ROLES_CLAIM
  413. app.state.config.OAUTH_ALLOWED_ROLES = OAUTH_ALLOWED_ROLES
  414. app.state.config.OAUTH_ADMIN_ROLES = OAUTH_ADMIN_ROLES
  415. app.state.config.ENABLE_LDAP = ENABLE_LDAP
  416. app.state.config.LDAP_SERVER_LABEL = LDAP_SERVER_LABEL
  417. app.state.config.LDAP_SERVER_HOST = LDAP_SERVER_HOST
  418. app.state.config.LDAP_SERVER_PORT = LDAP_SERVER_PORT
  419. app.state.config.LDAP_ATTRIBUTE_FOR_MAIL = LDAP_ATTRIBUTE_FOR_MAIL
  420. app.state.config.LDAP_ATTRIBUTE_FOR_USERNAME = LDAP_ATTRIBUTE_FOR_USERNAME
  421. app.state.config.LDAP_APP_DN = LDAP_APP_DN
  422. app.state.config.LDAP_APP_PASSWORD = LDAP_APP_PASSWORD
  423. app.state.config.LDAP_SEARCH_BASE = LDAP_SEARCH_BASE
  424. app.state.config.LDAP_SEARCH_FILTERS = LDAP_SEARCH_FILTERS
  425. app.state.config.LDAP_USE_TLS = LDAP_USE_TLS
  426. app.state.config.LDAP_CA_CERT_FILE = LDAP_CA_CERT_FILE
  427. app.state.config.LDAP_CIPHERS = LDAP_CIPHERS
  428. app.state.AUTH_TRUSTED_EMAIL_HEADER = WEBUI_AUTH_TRUSTED_EMAIL_HEADER
  429. app.state.AUTH_TRUSTED_NAME_HEADER = WEBUI_AUTH_TRUSTED_NAME_HEADER
  430. app.state.TOOLS = {}
  431. app.state.FUNCTIONS = {}
  432. ########################################
  433. #
  434. # RETRIEVAL
  435. #
  436. ########################################
  437. app.state.config.TOP_K = RAG_TOP_K
  438. app.state.config.RELEVANCE_THRESHOLD = RAG_RELEVANCE_THRESHOLD
  439. app.state.config.FILE_MAX_SIZE = RAG_FILE_MAX_SIZE
  440. app.state.config.FILE_MAX_COUNT = RAG_FILE_MAX_COUNT
  441. app.state.config.ENABLE_RAG_HYBRID_SEARCH = ENABLE_RAG_HYBRID_SEARCH
  442. app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION = (
  443. ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION
  444. )
  445. app.state.config.CONTENT_EXTRACTION_ENGINE = CONTENT_EXTRACTION_ENGINE
  446. app.state.config.TIKA_SERVER_URL = TIKA_SERVER_URL
  447. app.state.config.TEXT_SPLITTER = RAG_TEXT_SPLITTER
  448. app.state.config.TIKTOKEN_ENCODING_NAME = TIKTOKEN_ENCODING_NAME
  449. app.state.config.CHUNK_SIZE = CHUNK_SIZE
  450. app.state.config.CHUNK_OVERLAP = CHUNK_OVERLAP
  451. app.state.config.RAG_EMBEDDING_ENGINE = RAG_EMBEDDING_ENGINE
  452. app.state.config.RAG_EMBEDDING_MODEL = RAG_EMBEDDING_MODEL
  453. app.state.config.RAG_EMBEDDING_BATCH_SIZE = RAG_EMBEDDING_BATCH_SIZE
  454. app.state.config.RAG_RERANKING_MODEL = RAG_RERANKING_MODEL
  455. app.state.config.RAG_TEMPLATE = RAG_TEMPLATE
  456. app.state.config.RAG_OPENAI_API_BASE_URL = RAG_OPENAI_API_BASE_URL
  457. app.state.config.RAG_OPENAI_API_KEY = RAG_OPENAI_API_KEY
  458. app.state.config.RAG_OLLAMA_BASE_URL = RAG_OLLAMA_BASE_URL
  459. app.state.config.RAG_OLLAMA_API_KEY = RAG_OLLAMA_API_KEY
  460. app.state.config.PDF_EXTRACT_IMAGES = PDF_EXTRACT_IMAGES
  461. app.state.config.YOUTUBE_LOADER_LANGUAGE = YOUTUBE_LOADER_LANGUAGE
  462. app.state.config.YOUTUBE_LOADER_PROXY_URL = YOUTUBE_LOADER_PROXY_URL
  463. app.state.config.ENABLE_RAG_WEB_SEARCH = ENABLE_RAG_WEB_SEARCH
  464. app.state.config.RAG_WEB_SEARCH_ENGINE = RAG_WEB_SEARCH_ENGINE
  465. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST = RAG_WEB_SEARCH_DOMAIN_FILTER_LIST
  466. app.state.config.ENABLE_GOOGLE_DRIVE_INTEGRATION = ENABLE_GOOGLE_DRIVE_INTEGRATION
  467. app.state.config.SEARXNG_QUERY_URL = SEARXNG_QUERY_URL
  468. app.state.config.GOOGLE_PSE_API_KEY = GOOGLE_PSE_API_KEY
  469. app.state.config.GOOGLE_PSE_ENGINE_ID = GOOGLE_PSE_ENGINE_ID
  470. app.state.config.BRAVE_SEARCH_API_KEY = BRAVE_SEARCH_API_KEY
  471. app.state.config.KAGI_SEARCH_API_KEY = KAGI_SEARCH_API_KEY
  472. app.state.config.MOJEEK_SEARCH_API_KEY = MOJEEK_SEARCH_API_KEY
  473. app.state.config.BOCHA_SEARCH_API_KEY = BOCHA_SEARCH_API_KEY
  474. app.state.config.SERPSTACK_API_KEY = SERPSTACK_API_KEY
  475. app.state.config.SERPSTACK_HTTPS = SERPSTACK_HTTPS
  476. app.state.config.SERPER_API_KEY = SERPER_API_KEY
  477. app.state.config.SERPLY_API_KEY = SERPLY_API_KEY
  478. app.state.config.TAVILY_API_KEY = TAVILY_API_KEY
  479. app.state.config.SEARCHAPI_API_KEY = SEARCHAPI_API_KEY
  480. app.state.config.SEARCHAPI_ENGINE = SEARCHAPI_ENGINE
  481. app.state.config.SERPAPI_API_KEY = SERPAPI_API_KEY
  482. app.state.config.SERPAPI_ENGINE = SERPAPI_ENGINE
  483. app.state.config.JINA_API_KEY = JINA_API_KEY
  484. app.state.config.BING_SEARCH_V7_ENDPOINT = BING_SEARCH_V7_ENDPOINT
  485. app.state.config.BING_SEARCH_V7_SUBSCRIPTION_KEY = BING_SEARCH_V7_SUBSCRIPTION_KEY
  486. app.state.config.EXA_API_KEY = EXA_API_KEY
  487. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT = RAG_WEB_SEARCH_RESULT_COUNT
  488. app.state.config.RAG_WEB_SEARCH_CONCURRENT_REQUESTS = RAG_WEB_SEARCH_CONCURRENT_REQUESTS
  489. app.state.config.RAG_WEB_LOADER_ENGINE = RAG_WEB_LOADER_ENGINE
  490. app.state.config.RAG_WEB_SEARCH_TRUST_ENV = RAG_WEB_SEARCH_TRUST_ENV
  491. app.state.config.PLAYWRIGHT_WS_URI = PLAYWRIGHT_WS_URI
  492. app.state.EMBEDDING_FUNCTION = None
  493. app.state.ef = None
  494. app.state.rf = None
  495. app.state.YOUTUBE_LOADER_TRANSLATION = None
  496. try:
  497. app.state.ef = get_ef(
  498. app.state.config.RAG_EMBEDDING_ENGINE,
  499. app.state.config.RAG_EMBEDDING_MODEL,
  500. RAG_EMBEDDING_MODEL_AUTO_UPDATE,
  501. )
  502. app.state.rf = get_rf(
  503. app.state.config.RAG_RERANKING_MODEL,
  504. RAG_RERANKING_MODEL_AUTO_UPDATE,
  505. )
  506. except Exception as e:
  507. log.error(f"Error updating models: {e}")
  508. pass
  509. app.state.EMBEDDING_FUNCTION = get_embedding_function(
  510. app.state.config.RAG_EMBEDDING_ENGINE,
  511. app.state.config.RAG_EMBEDDING_MODEL,
  512. app.state.ef,
  513. (
  514. app.state.config.RAG_OPENAI_API_BASE_URL
  515. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  516. else app.state.config.RAG_OLLAMA_BASE_URL
  517. ),
  518. (
  519. app.state.config.RAG_OPENAI_API_KEY
  520. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  521. else app.state.config.RAG_OLLAMA_API_KEY
  522. ),
  523. app.state.config.RAG_EMBEDDING_BATCH_SIZE,
  524. )
  525. ########################################
  526. #
  527. # CODE INTERPRETER
  528. #
  529. ########################################
  530. app.state.config.ENABLE_CODE_INTERPRETER = ENABLE_CODE_INTERPRETER
  531. app.state.config.CODE_INTERPRETER_ENGINE = CODE_INTERPRETER_ENGINE
  532. app.state.config.CODE_INTERPRETER_PROMPT_TEMPLATE = CODE_INTERPRETER_PROMPT_TEMPLATE
  533. app.state.config.CODE_INTERPRETER_JUPYTER_URL = CODE_INTERPRETER_JUPYTER_URL
  534. app.state.config.CODE_INTERPRETER_JUPYTER_AUTH = CODE_INTERPRETER_JUPYTER_AUTH
  535. app.state.config.CODE_INTERPRETER_JUPYTER_AUTH_TOKEN = (
  536. CODE_INTERPRETER_JUPYTER_AUTH_TOKEN
  537. )
  538. app.state.config.CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD = (
  539. CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD
  540. )
  541. ########################################
  542. #
  543. # IMAGES
  544. #
  545. ########################################
  546. app.state.config.IMAGE_GENERATION_ENGINE = IMAGE_GENERATION_ENGINE
  547. app.state.config.ENABLE_IMAGE_GENERATION = ENABLE_IMAGE_GENERATION
  548. app.state.config.ENABLE_IMAGE_PROMPT_GENERATION = ENABLE_IMAGE_PROMPT_GENERATION
  549. app.state.config.IMAGES_OPENAI_API_BASE_URL = IMAGES_OPENAI_API_BASE_URL
  550. app.state.config.IMAGES_OPENAI_API_KEY = IMAGES_OPENAI_API_KEY
  551. app.state.config.IMAGE_GENERATION_MODEL = IMAGE_GENERATION_MODEL
  552. app.state.config.AUTOMATIC1111_BASE_URL = AUTOMATIC1111_BASE_URL
  553. app.state.config.AUTOMATIC1111_API_AUTH = AUTOMATIC1111_API_AUTH
  554. app.state.config.AUTOMATIC1111_CFG_SCALE = AUTOMATIC1111_CFG_SCALE
  555. app.state.config.AUTOMATIC1111_SAMPLER = AUTOMATIC1111_SAMPLER
  556. app.state.config.AUTOMATIC1111_SCHEDULER = AUTOMATIC1111_SCHEDULER
  557. app.state.config.COMFYUI_BASE_URL = COMFYUI_BASE_URL
  558. app.state.config.COMFYUI_API_KEY = COMFYUI_API_KEY
  559. app.state.config.COMFYUI_WORKFLOW = COMFYUI_WORKFLOW
  560. app.state.config.COMFYUI_WORKFLOW_NODES = COMFYUI_WORKFLOW_NODES
  561. app.state.config.IMAGE_SIZE = IMAGE_SIZE
  562. app.state.config.IMAGE_STEPS = IMAGE_STEPS
  563. ########################################
  564. #
  565. # AUDIO
  566. #
  567. ########################################
  568. app.state.config.STT_OPENAI_API_BASE_URL = AUDIO_STT_OPENAI_API_BASE_URL
  569. app.state.config.STT_OPENAI_API_KEY = AUDIO_STT_OPENAI_API_KEY
  570. app.state.config.STT_ENGINE = AUDIO_STT_ENGINE
  571. app.state.config.STT_MODEL = AUDIO_STT_MODEL
  572. app.state.config.WHISPER_MODEL = WHISPER_MODEL
  573. app.state.config.DEEPGRAM_API_KEY = DEEPGRAM_API_KEY
  574. app.state.config.TTS_OPENAI_API_BASE_URL = AUDIO_TTS_OPENAI_API_BASE_URL
  575. app.state.config.TTS_OPENAI_API_KEY = AUDIO_TTS_OPENAI_API_KEY
  576. app.state.config.TTS_ENGINE = AUDIO_TTS_ENGINE
  577. app.state.config.TTS_MODEL = AUDIO_TTS_MODEL
  578. app.state.config.TTS_VOICE = AUDIO_TTS_VOICE
  579. app.state.config.TTS_API_KEY = AUDIO_TTS_API_KEY
  580. app.state.config.TTS_SPLIT_ON = AUDIO_TTS_SPLIT_ON
  581. app.state.config.TTS_AZURE_SPEECH_REGION = AUDIO_TTS_AZURE_SPEECH_REGION
  582. app.state.config.TTS_AZURE_SPEECH_OUTPUT_FORMAT = AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT
  583. app.state.faster_whisper_model = None
  584. app.state.speech_synthesiser = None
  585. app.state.speech_speaker_embeddings_dataset = None
  586. ########################################
  587. #
  588. # TASKS
  589. #
  590. ########################################
  591. app.state.config.TASK_MODEL = TASK_MODEL
  592. app.state.config.TASK_MODEL_EXTERNAL = TASK_MODEL_EXTERNAL
  593. app.state.config.ENABLE_SEARCH_QUERY_GENERATION = ENABLE_SEARCH_QUERY_GENERATION
  594. app.state.config.ENABLE_RETRIEVAL_QUERY_GENERATION = ENABLE_RETRIEVAL_QUERY_GENERATION
  595. app.state.config.ENABLE_AUTOCOMPLETE_GENERATION = ENABLE_AUTOCOMPLETE_GENERATION
  596. app.state.config.ENABLE_TAGS_GENERATION = ENABLE_TAGS_GENERATION
  597. app.state.config.ENABLE_TITLE_GENERATION = ENABLE_TITLE_GENERATION
  598. app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE = TITLE_GENERATION_PROMPT_TEMPLATE
  599. app.state.config.TAGS_GENERATION_PROMPT_TEMPLATE = TAGS_GENERATION_PROMPT_TEMPLATE
  600. app.state.config.IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE = (
  601. IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE
  602. )
  603. app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = (
  604. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
  605. )
  606. app.state.config.QUERY_GENERATION_PROMPT_TEMPLATE = QUERY_GENERATION_PROMPT_TEMPLATE
  607. app.state.config.AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE = (
  608. AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE
  609. )
  610. app.state.config.AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH = (
  611. AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH
  612. )
  613. ########################################
  614. #
  615. # WEBUI
  616. #
  617. ########################################
  618. app.state.MODELS = {}
  619. class RedirectMiddleware(BaseHTTPMiddleware):
  620. async def dispatch(self, request: Request, call_next):
  621. # Check if the request is a GET request
  622. if request.method == "GET":
  623. path = request.url.path
  624. query_params = dict(parse_qs(urlparse(str(request.url)).query))
  625. # Check for the specific watch path and the presence of 'v' parameter
  626. if path.endswith("/watch") and "v" in query_params:
  627. video_id = query_params["v"][0] # Extract the first 'v' parameter
  628. encoded_video_id = urlencode({"youtube": video_id})
  629. redirect_url = f"/?{encoded_video_id}"
  630. return RedirectResponse(url=redirect_url)
  631. # Proceed with the normal flow of other requests
  632. response = await call_next(request)
  633. return response
  634. # Add the middleware to the app
  635. app.add_middleware(RedirectMiddleware)
  636. app.add_middleware(SecurityHeadersMiddleware)
  637. @app.middleware("http")
  638. async def commit_session_after_request(request: Request, call_next):
  639. response = await call_next(request)
  640. # log.debug("Commit session after request")
  641. Session.commit()
  642. return response
  643. @app.middleware("http")
  644. async def check_url(request: Request, call_next):
  645. start_time = int(time.time())
  646. request.state.enable_api_key = app.state.config.ENABLE_API_KEY
  647. response = await call_next(request)
  648. process_time = int(time.time()) - start_time
  649. response.headers["X-Process-Time"] = str(process_time)
  650. return response
  651. @app.middleware("http")
  652. async def inspect_websocket(request: Request, call_next):
  653. if (
  654. "/ws/socket.io" in request.url.path
  655. and request.query_params.get("transport") == "websocket"
  656. ):
  657. upgrade = (request.headers.get("Upgrade") or "").lower()
  658. connection = (request.headers.get("Connection") or "").lower().split(",")
  659. # Check that there's the correct headers for an upgrade, else reject the connection
  660. # This is to work around this upstream issue: https://github.com/miguelgrinberg/python-engineio/issues/367
  661. if upgrade != "websocket" or "upgrade" not in connection:
  662. return JSONResponse(
  663. status_code=status.HTTP_400_BAD_REQUEST,
  664. content={"detail": "Invalid WebSocket upgrade request"},
  665. )
  666. return await call_next(request)
  667. app.add_middleware(
  668. CORSMiddleware,
  669. allow_origins=CORS_ALLOW_ORIGIN,
  670. allow_credentials=True,
  671. allow_methods=["*"],
  672. allow_headers=["*"],
  673. )
  674. app.mount("/ws", socket_app)
  675. app.include_router(ollama.router, prefix="/ollama", tags=["ollama"])
  676. app.include_router(openai.router, prefix="/openai", tags=["openai"])
  677. app.include_router(pipelines.router, prefix="/api/v1/pipelines", tags=["pipelines"])
  678. app.include_router(tasks.router, prefix="/api/v1/tasks", tags=["tasks"])
  679. app.include_router(images.router, prefix="/api/v1/images", tags=["images"])
  680. app.include_router(audio.router, prefix="/api/v1/audio", tags=["audio"])
  681. app.include_router(retrieval.router, prefix="/api/v1/retrieval", tags=["retrieval"])
  682. app.include_router(configs.router, prefix="/api/v1/configs", tags=["configs"])
  683. app.include_router(auths.router, prefix="/api/v1/auths", tags=["auths"])
  684. app.include_router(users.router, prefix="/api/v1/users", tags=["users"])
  685. app.include_router(channels.router, prefix="/api/v1/channels", tags=["channels"])
  686. app.include_router(chats.router, prefix="/api/v1/chats", tags=["chats"])
  687. app.include_router(models.router, prefix="/api/v1/models", tags=["models"])
  688. app.include_router(knowledge.router, prefix="/api/v1/knowledge", tags=["knowledge"])
  689. app.include_router(prompts.router, prefix="/api/v1/prompts", tags=["prompts"])
  690. app.include_router(tools.router, prefix="/api/v1/tools", tags=["tools"])
  691. app.include_router(memories.router, prefix="/api/v1/memories", tags=["memories"])
  692. app.include_router(folders.router, prefix="/api/v1/folders", tags=["folders"])
  693. app.include_router(groups.router, prefix="/api/v1/groups", tags=["groups"])
  694. app.include_router(files.router, prefix="/api/v1/files", tags=["files"])
  695. app.include_router(functions.router, prefix="/api/v1/functions", tags=["functions"])
  696. app.include_router(
  697. evaluations.router, prefix="/api/v1/evaluations", tags=["evaluations"]
  698. )
  699. app.include_router(utils.router, prefix="/api/v1/utils", tags=["utils"])
  700. ##################################
  701. #
  702. # Chat Endpoints
  703. #
  704. ##################################
  705. @app.get("/api/models")
  706. async def get_models(request: Request, user=Depends(get_verified_user)):
  707. def get_filtered_models(models, user):
  708. filtered_models = []
  709. for model in models:
  710. if model.get("arena"):
  711. if has_access(
  712. user.id,
  713. type="read",
  714. access_control=model.get("info", {})
  715. .get("meta", {})
  716. .get("access_control", {}),
  717. ):
  718. filtered_models.append(model)
  719. continue
  720. model_info = Models.get_model_by_id(model["id"])
  721. if model_info:
  722. if user.id == model_info.user_id or has_access(
  723. user.id, type="read", access_control=model_info.access_control
  724. ):
  725. filtered_models.append(model)
  726. return filtered_models
  727. models = await get_all_models(request)
  728. # Filter out filter pipelines
  729. models = [
  730. model
  731. for model in models
  732. if "pipeline" not in model or model["pipeline"].get("type", None) != "filter"
  733. ]
  734. model_order_list = request.app.state.config.MODEL_ORDER_LIST
  735. if model_order_list:
  736. model_order_dict = {model_id: i for i, model_id in enumerate(model_order_list)}
  737. # Sort models by order list priority, with fallback for those not in the list
  738. models.sort(
  739. key=lambda x: (model_order_dict.get(x["id"], float("inf")), x["name"])
  740. )
  741. # Filter out models that the user does not have access to
  742. if user.role == "user" and not BYPASS_MODEL_ACCESS_CONTROL:
  743. models = get_filtered_models(models, user)
  744. log.debug(
  745. f"/api/models returned filtered models accessible to the user: {json.dumps([model['id'] for model in models])}"
  746. )
  747. return {"data": models}
  748. @app.get("/api/models/base")
  749. async def get_base_models(request: Request, user=Depends(get_admin_user)):
  750. models = await get_all_base_models(request)
  751. return {"data": models}
  752. @app.post("/api/chat/completions")
  753. async def chat_completion(
  754. request: Request,
  755. form_data: dict,
  756. user=Depends(get_verified_user),
  757. ):
  758. if not request.app.state.MODELS:
  759. await get_all_models(request)
  760. model_item = form_data.pop("model_item", {})
  761. tasks = form_data.pop("background_tasks", None)
  762. try:
  763. if not model_item.get("direct", False):
  764. model_id = form_data.get("model", None)
  765. if model_id not in request.app.state.MODELS:
  766. raise Exception("Model not found")
  767. model = request.app.state.MODELS[model_id]
  768. model_info = Models.get_model_by_id(model_id)
  769. # Check if user has access to the model
  770. if not BYPASS_MODEL_ACCESS_CONTROL and user.role == "user":
  771. try:
  772. check_model_access(user, model)
  773. except Exception as e:
  774. raise e
  775. else:
  776. model = model_item
  777. model_info = None
  778. request.state.direct = True
  779. request.state.model = model
  780. metadata = {
  781. "user_id": user.id,
  782. "chat_id": form_data.pop("chat_id", None),
  783. "message_id": form_data.pop("id", None),
  784. "session_id": form_data.pop("session_id", None),
  785. "tool_ids": form_data.get("tool_ids", None),
  786. "files": form_data.get("files", None),
  787. "features": form_data.get("features", None),
  788. "variables": form_data.get("variables", None),
  789. "model": model_info,
  790. "direct": model_item.get("direct", False),
  791. **(
  792. {"function_calling": "native"}
  793. if form_data.get("params", {}).get("function_calling") == "native"
  794. or (
  795. model_info
  796. and model_info.params.model_dump().get("function_calling")
  797. == "native"
  798. )
  799. else {}
  800. ),
  801. }
  802. request.state.metadata = metadata
  803. form_data["metadata"] = metadata
  804. form_data, metadata, events = await process_chat_payload(
  805. request, form_data, metadata, user, model
  806. )
  807. except Exception as e:
  808. log.debug(f"Error processing chat payload: {e}")
  809. raise HTTPException(
  810. status_code=status.HTTP_400_BAD_REQUEST,
  811. detail=str(e),
  812. )
  813. try:
  814. response = await chat_completion_handler(request, form_data, user)
  815. return await process_chat_response(
  816. request, response, form_data, user, events, metadata, tasks
  817. )
  818. except Exception as e:
  819. raise HTTPException(
  820. status_code=status.HTTP_400_BAD_REQUEST,
  821. detail=str(e),
  822. )
  823. # Alias for chat_completion (Legacy)
  824. generate_chat_completions = chat_completion
  825. generate_chat_completion = chat_completion
  826. @app.post("/api/chat/completed")
  827. async def chat_completed(
  828. request: Request, form_data: dict, user=Depends(get_verified_user)
  829. ):
  830. try:
  831. model_item = form_data.pop("model_item", {})
  832. if model_item.get("direct", False):
  833. request.state.direct = True
  834. request.state.model = model_item
  835. return await chat_completed_handler(request, form_data, user)
  836. except Exception as e:
  837. raise HTTPException(
  838. status_code=status.HTTP_400_BAD_REQUEST,
  839. detail=str(e),
  840. )
  841. @app.post("/api/chat/actions/{action_id}")
  842. async def chat_action(
  843. request: Request, action_id: str, form_data: dict, user=Depends(get_verified_user)
  844. ):
  845. try:
  846. model_item = form_data.pop("model_item", {})
  847. if model_item.get("direct", False):
  848. request.state.direct = True
  849. request.state.model = model_item
  850. return await chat_action_handler(request, action_id, form_data, user)
  851. except Exception as e:
  852. raise HTTPException(
  853. status_code=status.HTTP_400_BAD_REQUEST,
  854. detail=str(e),
  855. )
  856. @app.post("/api/tasks/stop/{task_id}")
  857. async def stop_task_endpoint(task_id: str, user=Depends(get_verified_user)):
  858. try:
  859. result = await stop_task(task_id) # Use the function from tasks.py
  860. return result
  861. except ValueError as e:
  862. raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail=str(e))
  863. @app.get("/api/tasks")
  864. async def list_tasks_endpoint(user=Depends(get_verified_user)):
  865. return {"tasks": list_tasks()} # Use the function from tasks.py
  866. ##################################
  867. #
  868. # Config Endpoints
  869. #
  870. ##################################
  871. @app.get("/api/config")
  872. async def get_app_config(request: Request):
  873. user = None
  874. if "token" in request.cookies:
  875. token = request.cookies.get("token")
  876. try:
  877. data = decode_token(token)
  878. except Exception as e:
  879. log.debug(e)
  880. raise HTTPException(
  881. status_code=status.HTTP_401_UNAUTHORIZED,
  882. detail="Invalid token",
  883. )
  884. if data is not None and "id" in data:
  885. user = Users.get_user_by_id(data["id"])
  886. onboarding = False
  887. if user is None:
  888. user_count = Users.get_num_users()
  889. onboarding = user_count == 0
  890. return {
  891. **({"onboarding": True} if onboarding else {}),
  892. "status": True,
  893. "name": WEBUI_NAME,
  894. "version": VERSION,
  895. "default_locale": str(DEFAULT_LOCALE),
  896. "oauth": {
  897. "providers": {
  898. name: config.get("name", name)
  899. for name, config in OAUTH_PROVIDERS.items()
  900. }
  901. },
  902. "features": {
  903. "auth": WEBUI_AUTH,
  904. "auth_trusted_header": bool(app.state.AUTH_TRUSTED_EMAIL_HEADER),
  905. "enable_ldap": app.state.config.ENABLE_LDAP,
  906. "enable_api_key": app.state.config.ENABLE_API_KEY,
  907. "enable_signup": app.state.config.ENABLE_SIGNUP,
  908. "enable_login_form": app.state.config.ENABLE_LOGIN_FORM,
  909. "enable_websocket": ENABLE_WEBSOCKET_SUPPORT,
  910. **(
  911. {
  912. "enable_direct_connections": app.state.config.ENABLE_DIRECT_CONNECTIONS,
  913. "enable_channels": app.state.config.ENABLE_CHANNELS,
  914. "enable_web_search": app.state.config.ENABLE_RAG_WEB_SEARCH,
  915. "enable_code_interpreter": app.state.config.ENABLE_CODE_INTERPRETER,
  916. "enable_image_generation": app.state.config.ENABLE_IMAGE_GENERATION,
  917. "enable_autocomplete_generation": app.state.config.ENABLE_AUTOCOMPLETE_GENERATION,
  918. "enable_community_sharing": app.state.config.ENABLE_COMMUNITY_SHARING,
  919. "enable_message_rating": app.state.config.ENABLE_MESSAGE_RATING,
  920. "enable_admin_export": ENABLE_ADMIN_EXPORT,
  921. "enable_admin_chat_access": ENABLE_ADMIN_CHAT_ACCESS,
  922. "enable_google_drive_integration": app.state.config.ENABLE_GOOGLE_DRIVE_INTEGRATION,
  923. }
  924. if user is not None
  925. else {}
  926. ),
  927. },
  928. **(
  929. {
  930. "default_models": app.state.config.DEFAULT_MODELS,
  931. "default_prompt_suggestions": app.state.config.DEFAULT_PROMPT_SUGGESTIONS,
  932. "audio": {
  933. "tts": {
  934. "engine": app.state.config.TTS_ENGINE,
  935. "voice": app.state.config.TTS_VOICE,
  936. "split_on": app.state.config.TTS_SPLIT_ON,
  937. },
  938. "stt": {
  939. "engine": app.state.config.STT_ENGINE,
  940. },
  941. },
  942. "file": {
  943. "max_size": app.state.config.FILE_MAX_SIZE,
  944. "max_count": app.state.config.FILE_MAX_COUNT,
  945. },
  946. "permissions": {**app.state.config.USER_PERMISSIONS},
  947. "google_drive": {
  948. "client_id": GOOGLE_DRIVE_CLIENT_ID.value,
  949. "api_key": GOOGLE_DRIVE_API_KEY.value,
  950. },
  951. }
  952. if user is not None
  953. else {}
  954. ),
  955. }
  956. class UrlForm(BaseModel):
  957. url: str
  958. @app.get("/api/webhook")
  959. async def get_webhook_url(user=Depends(get_admin_user)):
  960. return {
  961. "url": app.state.config.WEBHOOK_URL,
  962. }
  963. @app.post("/api/webhook")
  964. async def update_webhook_url(form_data: UrlForm, user=Depends(get_admin_user)):
  965. app.state.config.WEBHOOK_URL = form_data.url
  966. app.state.WEBHOOK_URL = app.state.config.WEBHOOK_URL
  967. return {"url": app.state.config.WEBHOOK_URL}
  968. @app.get("/api/version")
  969. async def get_app_version():
  970. return {
  971. "version": VERSION,
  972. }
  973. @app.get("/api/version/updates")
  974. async def get_app_latest_release_version(user=Depends(get_verified_user)):
  975. if OFFLINE_MODE:
  976. log.debug(
  977. f"Offline mode is enabled, returning current version as latest version"
  978. )
  979. return {"current": VERSION, "latest": VERSION}
  980. try:
  981. timeout = aiohttp.ClientTimeout(total=1)
  982. async with aiohttp.ClientSession(timeout=timeout, trust_env=True) as session:
  983. async with session.get(
  984. "https://api.github.com/repos/open-webui/open-webui/releases/latest"
  985. ) as response:
  986. response.raise_for_status()
  987. data = await response.json()
  988. latest_version = data["tag_name"]
  989. return {"current": VERSION, "latest": latest_version[1:]}
  990. except Exception as e:
  991. log.debug(e)
  992. return {"current": VERSION, "latest": VERSION}
  993. @app.get("/api/changelog")
  994. async def get_app_changelog():
  995. return {key: CHANGELOG[key] for idx, key in enumerate(CHANGELOG) if idx < 5}
  996. ############################
  997. # OAuth Login & Callback
  998. ############################
  999. # SessionMiddleware is used by authlib for oauth
  1000. if len(OAUTH_PROVIDERS) > 0:
  1001. app.add_middleware(
  1002. SessionMiddleware,
  1003. secret_key=WEBUI_SECRET_KEY,
  1004. session_cookie="oui-session",
  1005. same_site=WEBUI_SESSION_COOKIE_SAME_SITE,
  1006. https_only=WEBUI_SESSION_COOKIE_SECURE,
  1007. )
  1008. @app.get("/oauth/{provider}/login")
  1009. async def oauth_login(provider: str, request: Request):
  1010. return await oauth_manager.handle_login(provider, request)
  1011. # OAuth login logic is as follows:
  1012. # 1. Attempt to find a user with matching subject ID, tied to the provider
  1013. # 2. If OAUTH_MERGE_ACCOUNTS_BY_EMAIL is true, find a user with the email address provided via OAuth
  1014. # - This is considered insecure in general, as OAuth providers do not always verify email addresses
  1015. # 3. If there is no user, and ENABLE_OAUTH_SIGNUP is true, create a user
  1016. # - Email addresses are considered unique, so we fail registration if the email address is already taken
  1017. @app.get("/oauth/{provider}/callback")
  1018. async def oauth_callback(provider: str, request: Request, response: Response):
  1019. return await oauth_manager.handle_callback(provider, request, response)
  1020. @app.get("/manifest.json")
  1021. async def get_manifest_json():
  1022. return {
  1023. "name": WEBUI_NAME,
  1024. "short_name": WEBUI_NAME,
  1025. "description": "Open WebUI is an open, extensible, user-friendly interface for AI that adapts to your workflow.",
  1026. "start_url": "/",
  1027. "display": "standalone",
  1028. "background_color": "#343541",
  1029. "orientation": "natural",
  1030. "icons": [
  1031. {
  1032. "src": "/static/logo.png",
  1033. "type": "image/png",
  1034. "sizes": "500x500",
  1035. "purpose": "any",
  1036. },
  1037. {
  1038. "src": "/static/logo.png",
  1039. "type": "image/png",
  1040. "sizes": "500x500",
  1041. "purpose": "maskable",
  1042. },
  1043. ],
  1044. }
  1045. @app.get("/opensearch.xml")
  1046. async def get_opensearch_xml():
  1047. xml_content = rf"""
  1048. <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" xmlns:moz="http://www.mozilla.org/2006/browser/search/">
  1049. <ShortName>{WEBUI_NAME}</ShortName>
  1050. <Description>Search {WEBUI_NAME}</Description>
  1051. <InputEncoding>UTF-8</InputEncoding>
  1052. <Image width="16" height="16" type="image/x-icon">{app.state.config.WEBUI_URL}/static/favicon.png</Image>
  1053. <Url type="text/html" method="get" template="{app.state.config.WEBUI_URL}/?q={"{searchTerms}"}"/>
  1054. <moz:SearchForm>{app.state.config.WEBUI_URL}</moz:SearchForm>
  1055. </OpenSearchDescription>
  1056. """
  1057. return Response(content=xml_content, media_type="application/xml")
  1058. @app.get("/health")
  1059. async def healthcheck():
  1060. return {"status": True}
  1061. @app.get("/health/db")
  1062. async def healthcheck_with_db():
  1063. Session.execute(text("SELECT 1;")).all()
  1064. return {"status": True}
  1065. app.mount("/static", StaticFiles(directory=STATIC_DIR), name="static")
  1066. app.mount("/cache", StaticFiles(directory=CACHE_DIR), name="cache")
  1067. def swagger_ui_html(*args, **kwargs):
  1068. return get_swagger_ui_html(
  1069. *args,
  1070. **kwargs,
  1071. swagger_js_url="/static/swagger-ui/swagger-ui-bundle.js",
  1072. swagger_css_url="/static/swagger-ui/swagger-ui.css",
  1073. swagger_favicon_url="/static/swagger-ui/favicon.png",
  1074. )
  1075. applications.get_swagger_ui_html = swagger_ui_html
  1076. if os.path.exists(FRONTEND_BUILD_DIR):
  1077. mimetypes.add_type("text/javascript", ".js")
  1078. app.mount(
  1079. "/",
  1080. SPAStaticFiles(directory=FRONTEND_BUILD_DIR, html=True),
  1081. name="spa-static-files",
  1082. )
  1083. else:
  1084. log.warning(
  1085. f"Frontend build directory not found at '{FRONTEND_BUILD_DIR}'. Serving API only."
  1086. )