main.py 44 KB

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