main.py 67 KB

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