main.py 49 KB

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