main.py 41 KB

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