main.py 61 KB

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