main.py 50 KB

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