main.py 65 KB

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