main.py 62 KB

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