main.py 58 KB

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