main.py 44 KB

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