main.py 48 KB

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