main.py 64 KB

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