main.py 43 KB

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