main.py 47 KB

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