main.py 67 KB

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