main.py 71 KB

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