main.py 71 KB

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