main.py 58 KB

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