main.py 62 KB

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