1
0

main.py 49 KB

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