main.py 58 KB

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