main.py 71 KB

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