main.py 63 KB

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