main.py 43 KB

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