main.py 45 KB

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