main.py 62 KB

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