main.py 70 KB

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