main.py 44 KB

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