main.py 44 KB

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