main.py 49 KB

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