main.py 37 KB

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