1
0

main.py 64 KB

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