main.py 50 KB

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