main.py 62 KB

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