main.py 49 KB

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