main.py 43 KB

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