main.py 43 KB

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