main.py 41 KB

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