main.py 44 KB

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