main.py 42 KB

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