main.py 65 KB

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