main.py 42 KB

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