main.py 45 KB

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