main.py 61 KB

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