main.py 43 KB

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