main.py 66 KB

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