main.py 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305
  1. import asyncio
  2. import inspect
  3. import json
  4. import logging
  5. import mimetypes
  6. import os
  7. import shutil
  8. import sys
  9. import time
  10. import random
  11. from contextlib import asynccontextmanager
  12. from urllib.parse import urlencode, parse_qs, urlparse
  13. from pydantic import BaseModel
  14. from sqlalchemy import text
  15. from typing import Optional
  16. from aiocache import cached
  17. import aiohttp
  18. import requests
  19. from fastapi import (
  20. Depends,
  21. FastAPI,
  22. File,
  23. Form,
  24. HTTPException,
  25. Request,
  26. UploadFile,
  27. status,
  28. applications,
  29. BackgroundTasks,
  30. )
  31. from fastapi.openapi.docs import get_swagger_ui_html
  32. from fastapi.middleware.cors import CORSMiddleware
  33. from fastapi.responses import JSONResponse, RedirectResponse
  34. from fastapi.staticfiles import StaticFiles
  35. from starlette.exceptions import HTTPException as StarletteHTTPException
  36. from starlette.middleware.base import BaseHTTPMiddleware
  37. from starlette.middleware.sessions import SessionMiddleware
  38. from starlette.responses import Response, StreamingResponse
  39. from open_webui.socket.main import (
  40. app as socket_app,
  41. periodic_usage_pool_cleanup,
  42. )
  43. from open_webui.routers import (
  44. audio,
  45. images,
  46. ollama,
  47. openai,
  48. retrieval,
  49. pipelines,
  50. tasks,
  51. auths,
  52. channels,
  53. chats,
  54. folders,
  55. configs,
  56. groups,
  57. files,
  58. functions,
  59. memories,
  60. models,
  61. knowledge,
  62. prompts,
  63. evaluations,
  64. tools,
  65. users,
  66. utils,
  67. )
  68. from open_webui.routers.retrieval import (
  69. get_embedding_function,
  70. get_ef,
  71. get_rf,
  72. )
  73. from open_webui.internal.db import Session
  74. from open_webui.models.functions import Functions
  75. from open_webui.models.models import Models
  76. from open_webui.models.users import UserModel, Users
  77. from open_webui.config import (
  78. # Ollama
  79. ENABLE_OLLAMA_API,
  80. OLLAMA_BASE_URLS,
  81. OLLAMA_API_CONFIGS,
  82. # OpenAI
  83. ENABLE_OPENAI_API,
  84. OPENAI_API_BASE_URLS,
  85. OPENAI_API_KEYS,
  86. OPENAI_API_CONFIGS,
  87. # Direct Connections
  88. ENABLE_DIRECT_CONNECTIONS,
  89. # Code Interpreter
  90. ENABLE_CODE_INTERPRETER,
  91. CODE_INTERPRETER_ENGINE,
  92. CODE_INTERPRETER_PROMPT_TEMPLATE,
  93. CODE_INTERPRETER_JUPYTER_URL,
  94. CODE_INTERPRETER_JUPYTER_AUTH,
  95. CODE_INTERPRETER_JUPYTER_AUTH_TOKEN,
  96. CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD,
  97. # Image
  98. AUTOMATIC1111_API_AUTH,
  99. AUTOMATIC1111_BASE_URL,
  100. AUTOMATIC1111_CFG_SCALE,
  101. AUTOMATIC1111_SAMPLER,
  102. AUTOMATIC1111_SCHEDULER,
  103. COMFYUI_BASE_URL,
  104. COMFYUI_API_KEY,
  105. COMFYUI_WORKFLOW,
  106. COMFYUI_WORKFLOW_NODES,
  107. ENABLE_IMAGE_GENERATION,
  108. ENABLE_IMAGE_PROMPT_GENERATION,
  109. IMAGE_GENERATION_ENGINE,
  110. IMAGE_GENERATION_MODEL,
  111. IMAGE_SIZE,
  112. IMAGE_STEPS,
  113. IMAGES_OPENAI_API_BASE_URL,
  114. IMAGES_OPENAI_API_KEY,
  115. IMAGES_GEMINI_API_BASE_URL,
  116. IMAGES_GEMINI_API_KEY,
  117. # Audio
  118. AUDIO_STT_ENGINE,
  119. AUDIO_STT_MODEL,
  120. AUDIO_STT_OPENAI_API_BASE_URL,
  121. AUDIO_STT_OPENAI_API_KEY,
  122. AUDIO_TTS_API_KEY,
  123. AUDIO_TTS_ENGINE,
  124. AUDIO_TTS_MODEL,
  125. AUDIO_TTS_OPENAI_API_BASE_URL,
  126. AUDIO_TTS_OPENAI_API_KEY,
  127. AUDIO_TTS_SPLIT_ON,
  128. AUDIO_TTS_VOICE,
  129. AUDIO_TTS_AZURE_SPEECH_REGION,
  130. AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT,
  131. WHISPER_MODEL,
  132. DEEPGRAM_API_KEY,
  133. WHISPER_MODEL_AUTO_UPDATE,
  134. WHISPER_MODEL_DIR,
  135. # Retrieval
  136. RAG_TEMPLATE,
  137. DEFAULT_RAG_TEMPLATE,
  138. RAG_EMBEDDING_MODEL,
  139. RAG_EMBEDDING_MODEL_AUTO_UPDATE,
  140. RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE,
  141. RAG_RERANKING_MODEL,
  142. RAG_RERANKING_MODEL_AUTO_UPDATE,
  143. RAG_RERANKING_MODEL_TRUST_REMOTE_CODE,
  144. RAG_EMBEDDING_ENGINE,
  145. RAG_EMBEDDING_BATCH_SIZE,
  146. RAG_RELEVANCE_THRESHOLD,
  147. RAG_FILE_MAX_COUNT,
  148. RAG_FILE_MAX_SIZE,
  149. RAG_OPENAI_API_BASE_URL,
  150. RAG_OPENAI_API_KEY,
  151. RAG_OLLAMA_BASE_URL,
  152. RAG_OLLAMA_API_KEY,
  153. CHUNK_OVERLAP,
  154. CHUNK_SIZE,
  155. CONTENT_EXTRACTION_ENGINE,
  156. TIKA_SERVER_URL,
  157. RAG_TOP_K,
  158. RAG_TEXT_SPLITTER,
  159. TIKTOKEN_ENCODING_NAME,
  160. PDF_EXTRACT_IMAGES,
  161. YOUTUBE_LOADER_LANGUAGE,
  162. YOUTUBE_LOADER_PROXY_URL,
  163. # Retrieval (Web Search)
  164. RAG_WEB_SEARCH_ENGINE,
  165. RAG_WEB_SEARCH_RESULT_COUNT,
  166. RAG_WEB_SEARCH_CONCURRENT_REQUESTS,
  167. RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  168. JINA_API_KEY,
  169. SEARCHAPI_API_KEY,
  170. SEARCHAPI_ENGINE,
  171. SERPAPI_API_KEY,
  172. SERPAPI_ENGINE,
  173. SEARXNG_QUERY_URL,
  174. SERPER_API_KEY,
  175. SERPLY_API_KEY,
  176. SERPSTACK_API_KEY,
  177. SERPSTACK_HTTPS,
  178. TAVILY_API_KEY,
  179. BING_SEARCH_V7_ENDPOINT,
  180. BING_SEARCH_V7_SUBSCRIPTION_KEY,
  181. BRAVE_SEARCH_API_KEY,
  182. EXA_API_KEY,
  183. KAGI_SEARCH_API_KEY,
  184. MOJEEK_SEARCH_API_KEY,
  185. BOCHA_SEARCH_API_KEY,
  186. GOOGLE_PSE_API_KEY,
  187. GOOGLE_PSE_ENGINE_ID,
  188. GOOGLE_DRIVE_CLIENT_ID,
  189. GOOGLE_DRIVE_API_KEY,
  190. ENABLE_RAG_HYBRID_SEARCH,
  191. ENABLE_RAG_LOCAL_WEB_FETCH,
  192. ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION,
  193. ENABLE_RAG_WEB_SEARCH,
  194. ENABLE_GOOGLE_DRIVE_INTEGRATION,
  195. UPLOAD_DIR,
  196. # WebUI
  197. WEBUI_AUTH,
  198. WEBUI_NAME,
  199. WEBUI_BANNERS,
  200. WEBHOOK_URL,
  201. ADMIN_EMAIL,
  202. SHOW_ADMIN_DETAILS,
  203. JWT_EXPIRES_IN,
  204. ENABLE_SIGNUP,
  205. ENABLE_LOGIN_FORM,
  206. ENABLE_API_KEY,
  207. ENABLE_API_KEY_ENDPOINT_RESTRICTIONS,
  208. API_KEY_ALLOWED_ENDPOINTS,
  209. ENABLE_CHANNELS,
  210. ENABLE_COMMUNITY_SHARING,
  211. ENABLE_MESSAGE_RATING,
  212. ENABLE_EVALUATION_ARENA_MODELS,
  213. USER_PERMISSIONS,
  214. DEFAULT_USER_ROLE,
  215. DEFAULT_PROMPT_SUGGESTIONS,
  216. DEFAULT_MODELS,
  217. DEFAULT_ARENA_MODEL,
  218. MODEL_ORDER_LIST,
  219. EVALUATION_ARENA_MODELS,
  220. # WebUI (OAuth)
  221. ENABLE_OAUTH_ROLE_MANAGEMENT,
  222. OAUTH_ROLES_CLAIM,
  223. OAUTH_EMAIL_CLAIM,
  224. OAUTH_PICTURE_CLAIM,
  225. OAUTH_USERNAME_CLAIM,
  226. OAUTH_ALLOWED_ROLES,
  227. OAUTH_ADMIN_ROLES,
  228. # WebUI (LDAP)
  229. ENABLE_LDAP,
  230. LDAP_SERVER_LABEL,
  231. LDAP_SERVER_HOST,
  232. LDAP_SERVER_PORT,
  233. LDAP_ATTRIBUTE_FOR_MAIL,
  234. LDAP_ATTRIBUTE_FOR_USERNAME,
  235. LDAP_SEARCH_FILTERS,
  236. LDAP_SEARCH_BASE,
  237. LDAP_APP_DN,
  238. LDAP_APP_PASSWORD,
  239. LDAP_USE_TLS,
  240. LDAP_CA_CERT_FILE,
  241. LDAP_CIPHERS,
  242. # Misc
  243. ENV,
  244. CACHE_DIR,
  245. STATIC_DIR,
  246. FRONTEND_BUILD_DIR,
  247. CORS_ALLOW_ORIGIN,
  248. DEFAULT_LOCALE,
  249. OAUTH_PROVIDERS,
  250. WEBUI_URL,
  251. # Admin
  252. ENABLE_ADMIN_CHAT_ACCESS,
  253. ENABLE_ADMIN_EXPORT,
  254. # Tasks
  255. TASK_MODEL,
  256. TASK_MODEL_EXTERNAL,
  257. ENABLE_TAGS_GENERATION,
  258. ENABLE_TITLE_GENERATION,
  259. ENABLE_SEARCH_QUERY_GENERATION,
  260. ENABLE_RETRIEVAL_QUERY_GENERATION,
  261. ENABLE_AUTOCOMPLETE_GENERATION,
  262. TITLE_GENERATION_PROMPT_TEMPLATE,
  263. TAGS_GENERATION_PROMPT_TEMPLATE,
  264. IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE,
  265. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
  266. QUERY_GENERATION_PROMPT_TEMPLATE,
  267. AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE,
  268. AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH,
  269. AppConfig,
  270. reset_config,
  271. )
  272. from open_webui.env import (
  273. CHANGELOG,
  274. GLOBAL_LOG_LEVEL,
  275. SAFE_MODE,
  276. SRC_LOG_LEVELS,
  277. VERSION,
  278. WEBUI_BUILD_HASH,
  279. WEBUI_SECRET_KEY,
  280. WEBUI_SESSION_COOKIE_SAME_SITE,
  281. WEBUI_SESSION_COOKIE_SECURE,
  282. WEBUI_AUTH_TRUSTED_EMAIL_HEADER,
  283. WEBUI_AUTH_TRUSTED_NAME_HEADER,
  284. ENABLE_WEBSOCKET_SUPPORT,
  285. BYPASS_MODEL_ACCESS_CONTROL,
  286. RESET_CONFIG_ON_START,
  287. OFFLINE_MODE,
  288. )
  289. from open_webui.utils.models import (
  290. get_all_models,
  291. get_all_base_models,
  292. check_model_access,
  293. )
  294. from open_webui.utils.chat import (
  295. generate_chat_completion as chat_completion_handler,
  296. chat_completed as chat_completed_handler,
  297. chat_action as chat_action_handler,
  298. )
  299. from open_webui.utils.middleware import process_chat_payload, process_chat_response
  300. from open_webui.utils.access_control import has_access
  301. from open_webui.utils.auth import (
  302. decode_token,
  303. get_admin_user,
  304. get_verified_user,
  305. )
  306. from open_webui.utils.oauth import oauth_manager
  307. from open_webui.utils.security_headers import SecurityHeadersMiddleware
  308. from open_webui.tasks import stop_task, list_tasks # Import from tasks.py
  309. if SAFE_MODE:
  310. print("SAFE MODE ENABLED")
  311. Functions.deactivate_all_functions()
  312. logging.basicConfig(stream=sys.stdout, level=GLOBAL_LOG_LEVEL)
  313. log = logging.getLogger(__name__)
  314. log.setLevel(SRC_LOG_LEVELS["MAIN"])
  315. class SPAStaticFiles(StaticFiles):
  316. async def get_response(self, path: str, scope):
  317. try:
  318. return await super().get_response(path, scope)
  319. except (HTTPException, StarletteHTTPException) as ex:
  320. if ex.status_code == 404:
  321. if path.endswith(".js"):
  322. # Return 404 for javascript files
  323. raise ex
  324. else:
  325. return await super().get_response("index.html", scope)
  326. else:
  327. raise ex
  328. print(
  329. rf"""
  330. ___ __ __ _ _ _ ___
  331. / _ \ _ __ ___ _ __ \ \ / /__| |__ | | | |_ _|
  332. | | | | '_ \ / _ \ '_ \ \ \ /\ / / _ \ '_ \| | | || |
  333. | |_| | |_) | __/ | | | \ V V / __/ |_) | |_| || |
  334. \___/| .__/ \___|_| |_| \_/\_/ \___|_.__/ \___/|___|
  335. |_|
  336. v{VERSION} - building the best open-source AI user interface.
  337. {f"Commit: {WEBUI_BUILD_HASH}" if WEBUI_BUILD_HASH != "dev-build" else ""}
  338. https://github.com/open-webui/open-webui
  339. """
  340. )
  341. @asynccontextmanager
  342. async def lifespan(app: FastAPI):
  343. if RESET_CONFIG_ON_START:
  344. reset_config()
  345. asyncio.create_task(periodic_usage_pool_cleanup())
  346. yield
  347. app = FastAPI(
  348. docs_url="/docs" if ENV == "dev" else None,
  349. openapi_url="/openapi.json" if ENV == "dev" else None,
  350. redoc_url=None,
  351. lifespan=lifespan,
  352. )
  353. app.state.config = AppConfig()
  354. ########################################
  355. #
  356. # OLLAMA
  357. #
  358. ########################################
  359. app.state.config.ENABLE_OLLAMA_API = ENABLE_OLLAMA_API
  360. app.state.config.OLLAMA_BASE_URLS = OLLAMA_BASE_URLS
  361. app.state.config.OLLAMA_API_CONFIGS = OLLAMA_API_CONFIGS
  362. app.state.OLLAMA_MODELS = {}
  363. ########################################
  364. #
  365. # OPENAI
  366. #
  367. ########################################
  368. app.state.config.ENABLE_OPENAI_API = ENABLE_OPENAI_API
  369. app.state.config.OPENAI_API_BASE_URLS = OPENAI_API_BASE_URLS
  370. app.state.config.OPENAI_API_KEYS = OPENAI_API_KEYS
  371. app.state.config.OPENAI_API_CONFIGS = OPENAI_API_CONFIGS
  372. app.state.OPENAI_MODELS = {}
  373. ########################################
  374. #
  375. # DIRECT CONNECTIONS
  376. #
  377. ########################################
  378. app.state.config.ENABLE_DIRECT_CONNECTIONS = ENABLE_DIRECT_CONNECTIONS
  379. ########################################
  380. #
  381. # WEBUI
  382. #
  383. ########################################
  384. app.state.config.WEBUI_URL = WEBUI_URL
  385. app.state.config.ENABLE_SIGNUP = ENABLE_SIGNUP
  386. app.state.config.ENABLE_LOGIN_FORM = ENABLE_LOGIN_FORM
  387. app.state.config.ENABLE_API_KEY = ENABLE_API_KEY
  388. app.state.config.ENABLE_API_KEY_ENDPOINT_RESTRICTIONS = (
  389. ENABLE_API_KEY_ENDPOINT_RESTRICTIONS
  390. )
  391. app.state.config.API_KEY_ALLOWED_ENDPOINTS = API_KEY_ALLOWED_ENDPOINTS
  392. app.state.config.JWT_EXPIRES_IN = JWT_EXPIRES_IN
  393. app.state.config.SHOW_ADMIN_DETAILS = SHOW_ADMIN_DETAILS
  394. app.state.config.ADMIN_EMAIL = ADMIN_EMAIL
  395. app.state.config.DEFAULT_MODELS = DEFAULT_MODELS
  396. app.state.config.DEFAULT_PROMPT_SUGGESTIONS = DEFAULT_PROMPT_SUGGESTIONS
  397. app.state.config.DEFAULT_USER_ROLE = DEFAULT_USER_ROLE
  398. app.state.config.USER_PERMISSIONS = USER_PERMISSIONS
  399. app.state.config.WEBHOOK_URL = WEBHOOK_URL
  400. app.state.config.BANNERS = WEBUI_BANNERS
  401. app.state.config.MODEL_ORDER_LIST = MODEL_ORDER_LIST
  402. app.state.config.ENABLE_CHANNELS = ENABLE_CHANNELS
  403. app.state.config.ENABLE_COMMUNITY_SHARING = ENABLE_COMMUNITY_SHARING
  404. app.state.config.ENABLE_MESSAGE_RATING = ENABLE_MESSAGE_RATING
  405. app.state.config.ENABLE_EVALUATION_ARENA_MODELS = ENABLE_EVALUATION_ARENA_MODELS
  406. app.state.config.EVALUATION_ARENA_MODELS = EVALUATION_ARENA_MODELS
  407. app.state.config.OAUTH_USERNAME_CLAIM = OAUTH_USERNAME_CLAIM
  408. app.state.config.OAUTH_PICTURE_CLAIM = OAUTH_PICTURE_CLAIM
  409. app.state.config.OAUTH_EMAIL_CLAIM = OAUTH_EMAIL_CLAIM
  410. app.state.config.ENABLE_OAUTH_ROLE_MANAGEMENT = ENABLE_OAUTH_ROLE_MANAGEMENT
  411. app.state.config.OAUTH_ROLES_CLAIM = OAUTH_ROLES_CLAIM
  412. app.state.config.OAUTH_ALLOWED_ROLES = OAUTH_ALLOWED_ROLES
  413. app.state.config.OAUTH_ADMIN_ROLES = OAUTH_ADMIN_ROLES
  414. app.state.config.ENABLE_LDAP = ENABLE_LDAP
  415. app.state.config.LDAP_SERVER_LABEL = LDAP_SERVER_LABEL
  416. app.state.config.LDAP_SERVER_HOST = LDAP_SERVER_HOST
  417. app.state.config.LDAP_SERVER_PORT = LDAP_SERVER_PORT
  418. app.state.config.LDAP_ATTRIBUTE_FOR_MAIL = LDAP_ATTRIBUTE_FOR_MAIL
  419. app.state.config.LDAP_ATTRIBUTE_FOR_USERNAME = LDAP_ATTRIBUTE_FOR_USERNAME
  420. app.state.config.LDAP_APP_DN = LDAP_APP_DN
  421. app.state.config.LDAP_APP_PASSWORD = LDAP_APP_PASSWORD
  422. app.state.config.LDAP_SEARCH_BASE = LDAP_SEARCH_BASE
  423. app.state.config.LDAP_SEARCH_FILTERS = LDAP_SEARCH_FILTERS
  424. app.state.config.LDAP_USE_TLS = LDAP_USE_TLS
  425. app.state.config.LDAP_CA_CERT_FILE = LDAP_CA_CERT_FILE
  426. app.state.config.LDAP_CIPHERS = LDAP_CIPHERS
  427. app.state.AUTH_TRUSTED_EMAIL_HEADER = WEBUI_AUTH_TRUSTED_EMAIL_HEADER
  428. app.state.AUTH_TRUSTED_NAME_HEADER = WEBUI_AUTH_TRUSTED_NAME_HEADER
  429. app.state.TOOLS = {}
  430. app.state.FUNCTIONS = {}
  431. ########################################
  432. #
  433. # RETRIEVAL
  434. #
  435. ########################################
  436. app.state.config.TOP_K = RAG_TOP_K
  437. app.state.config.RELEVANCE_THRESHOLD = RAG_RELEVANCE_THRESHOLD
  438. app.state.config.FILE_MAX_SIZE = RAG_FILE_MAX_SIZE
  439. app.state.config.FILE_MAX_COUNT = RAG_FILE_MAX_COUNT
  440. app.state.config.ENABLE_RAG_HYBRID_SEARCH = ENABLE_RAG_HYBRID_SEARCH
  441. app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION = (
  442. ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION
  443. )
  444. app.state.config.CONTENT_EXTRACTION_ENGINE = CONTENT_EXTRACTION_ENGINE
  445. app.state.config.TIKA_SERVER_URL = TIKA_SERVER_URL
  446. app.state.config.TEXT_SPLITTER = RAG_TEXT_SPLITTER
  447. app.state.config.TIKTOKEN_ENCODING_NAME = TIKTOKEN_ENCODING_NAME
  448. app.state.config.CHUNK_SIZE = CHUNK_SIZE
  449. app.state.config.CHUNK_OVERLAP = CHUNK_OVERLAP
  450. app.state.config.RAG_EMBEDDING_ENGINE = RAG_EMBEDDING_ENGINE
  451. app.state.config.RAG_EMBEDDING_MODEL = RAG_EMBEDDING_MODEL
  452. app.state.config.RAG_EMBEDDING_BATCH_SIZE = RAG_EMBEDDING_BATCH_SIZE
  453. app.state.config.RAG_RERANKING_MODEL = RAG_RERANKING_MODEL
  454. app.state.config.RAG_TEMPLATE = RAG_TEMPLATE
  455. app.state.config.RAG_OPENAI_API_BASE_URL = RAG_OPENAI_API_BASE_URL
  456. app.state.config.RAG_OPENAI_API_KEY = RAG_OPENAI_API_KEY
  457. app.state.config.RAG_OLLAMA_BASE_URL = RAG_OLLAMA_BASE_URL
  458. app.state.config.RAG_OLLAMA_API_KEY = RAG_OLLAMA_API_KEY
  459. app.state.config.PDF_EXTRACT_IMAGES = PDF_EXTRACT_IMAGES
  460. app.state.config.YOUTUBE_LOADER_LANGUAGE = YOUTUBE_LOADER_LANGUAGE
  461. app.state.config.YOUTUBE_LOADER_PROXY_URL = YOUTUBE_LOADER_PROXY_URL
  462. app.state.config.ENABLE_RAG_WEB_SEARCH = ENABLE_RAG_WEB_SEARCH
  463. app.state.config.RAG_WEB_SEARCH_ENGINE = RAG_WEB_SEARCH_ENGINE
  464. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST = RAG_WEB_SEARCH_DOMAIN_FILTER_LIST
  465. app.state.config.ENABLE_GOOGLE_DRIVE_INTEGRATION = ENABLE_GOOGLE_DRIVE_INTEGRATION
  466. app.state.config.SEARXNG_QUERY_URL = SEARXNG_QUERY_URL
  467. app.state.config.GOOGLE_PSE_API_KEY = GOOGLE_PSE_API_KEY
  468. app.state.config.GOOGLE_PSE_ENGINE_ID = GOOGLE_PSE_ENGINE_ID
  469. app.state.config.BRAVE_SEARCH_API_KEY = BRAVE_SEARCH_API_KEY
  470. app.state.config.KAGI_SEARCH_API_KEY = KAGI_SEARCH_API_KEY
  471. app.state.config.MOJEEK_SEARCH_API_KEY = MOJEEK_SEARCH_API_KEY
  472. app.state.config.BOCHA_SEARCH_API_KEY = BOCHA_SEARCH_API_KEY
  473. app.state.config.SERPSTACK_API_KEY = SERPSTACK_API_KEY
  474. app.state.config.SERPSTACK_HTTPS = SERPSTACK_HTTPS
  475. app.state.config.SERPER_API_KEY = SERPER_API_KEY
  476. app.state.config.SERPLY_API_KEY = SERPLY_API_KEY
  477. app.state.config.TAVILY_API_KEY = TAVILY_API_KEY
  478. app.state.config.SEARCHAPI_API_KEY = SEARCHAPI_API_KEY
  479. app.state.config.SEARCHAPI_ENGINE = SEARCHAPI_ENGINE
  480. app.state.config.SERPAPI_API_KEY = SERPAPI_API_KEY
  481. app.state.config.SERPAPI_ENGINE = SERPAPI_ENGINE
  482. app.state.config.JINA_API_KEY = JINA_API_KEY
  483. app.state.config.BING_SEARCH_V7_ENDPOINT = BING_SEARCH_V7_ENDPOINT
  484. app.state.config.BING_SEARCH_V7_SUBSCRIPTION_KEY = BING_SEARCH_V7_SUBSCRIPTION_KEY
  485. app.state.config.EXA_API_KEY = EXA_API_KEY
  486. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT = RAG_WEB_SEARCH_RESULT_COUNT
  487. app.state.config.RAG_WEB_SEARCH_CONCURRENT_REQUESTS = RAG_WEB_SEARCH_CONCURRENT_REQUESTS
  488. app.state.EMBEDDING_FUNCTION = None
  489. app.state.ef = None
  490. app.state.rf = None
  491. app.state.YOUTUBE_LOADER_TRANSLATION = None
  492. try:
  493. app.state.ef = get_ef(
  494. app.state.config.RAG_EMBEDDING_ENGINE,
  495. app.state.config.RAG_EMBEDDING_MODEL,
  496. RAG_EMBEDDING_MODEL_AUTO_UPDATE,
  497. )
  498. app.state.rf = get_rf(
  499. app.state.config.RAG_RERANKING_MODEL,
  500. RAG_RERANKING_MODEL_AUTO_UPDATE,
  501. )
  502. except Exception as e:
  503. log.error(f"Error updating models: {e}")
  504. pass
  505. app.state.EMBEDDING_FUNCTION = get_embedding_function(
  506. app.state.config.RAG_EMBEDDING_ENGINE,
  507. app.state.config.RAG_EMBEDDING_MODEL,
  508. app.state.ef,
  509. (
  510. app.state.config.RAG_OPENAI_API_BASE_URL
  511. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  512. else app.state.config.RAG_OLLAMA_BASE_URL
  513. ),
  514. (
  515. app.state.config.RAG_OPENAI_API_KEY
  516. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  517. else app.state.config.RAG_OLLAMA_API_KEY
  518. ),
  519. app.state.config.RAG_EMBEDDING_BATCH_SIZE,
  520. )
  521. ########################################
  522. #
  523. # CODE INTERPRETER
  524. #
  525. ########################################
  526. app.state.config.ENABLE_CODE_INTERPRETER = ENABLE_CODE_INTERPRETER
  527. app.state.config.CODE_INTERPRETER_ENGINE = CODE_INTERPRETER_ENGINE
  528. app.state.config.CODE_INTERPRETER_PROMPT_TEMPLATE = CODE_INTERPRETER_PROMPT_TEMPLATE
  529. app.state.config.CODE_INTERPRETER_JUPYTER_URL = CODE_INTERPRETER_JUPYTER_URL
  530. app.state.config.CODE_INTERPRETER_JUPYTER_AUTH = CODE_INTERPRETER_JUPYTER_AUTH
  531. app.state.config.CODE_INTERPRETER_JUPYTER_AUTH_TOKEN = (
  532. CODE_INTERPRETER_JUPYTER_AUTH_TOKEN
  533. )
  534. app.state.config.CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD = (
  535. CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD
  536. )
  537. ########################################
  538. #
  539. # IMAGES
  540. #
  541. ########################################
  542. app.state.config.IMAGE_GENERATION_ENGINE = IMAGE_GENERATION_ENGINE
  543. app.state.config.ENABLE_IMAGE_GENERATION = ENABLE_IMAGE_GENERATION
  544. app.state.config.ENABLE_IMAGE_PROMPT_GENERATION = ENABLE_IMAGE_PROMPT_GENERATION
  545. app.state.config.IMAGES_OPENAI_API_BASE_URL = IMAGES_OPENAI_API_BASE_URL
  546. app.state.config.IMAGES_OPENAI_API_KEY = IMAGES_OPENAI_API_KEY
  547. app.state.config.IMAGES_GEMINI_API_BASE_URL = IMAGES_GEMINI_API_BASE_URL
  548. app.state.config.IMAGES_GEMINI_API_KEY = IMAGES_GEMINI_API_KEY
  549. app.state.config.IMAGE_GENERATION_MODEL = IMAGE_GENERATION_MODEL
  550. app.state.config.AUTOMATIC1111_BASE_URL = AUTOMATIC1111_BASE_URL
  551. app.state.config.AUTOMATIC1111_API_AUTH = AUTOMATIC1111_API_AUTH
  552. app.state.config.AUTOMATIC1111_CFG_SCALE = AUTOMATIC1111_CFG_SCALE
  553. app.state.config.AUTOMATIC1111_SAMPLER = AUTOMATIC1111_SAMPLER
  554. app.state.config.AUTOMATIC1111_SCHEDULER = AUTOMATIC1111_SCHEDULER
  555. app.state.config.COMFYUI_BASE_URL = COMFYUI_BASE_URL
  556. app.state.config.COMFYUI_API_KEY = COMFYUI_API_KEY
  557. app.state.config.COMFYUI_WORKFLOW = COMFYUI_WORKFLOW
  558. app.state.config.COMFYUI_WORKFLOW_NODES = COMFYUI_WORKFLOW_NODES
  559. app.state.config.IMAGE_SIZE = IMAGE_SIZE
  560. app.state.config.IMAGE_STEPS = IMAGE_STEPS
  561. ########################################
  562. #
  563. # AUDIO
  564. #
  565. ########################################
  566. app.state.config.STT_OPENAI_API_BASE_URL = AUDIO_STT_OPENAI_API_BASE_URL
  567. app.state.config.STT_OPENAI_API_KEY = AUDIO_STT_OPENAI_API_KEY
  568. app.state.config.STT_ENGINE = AUDIO_STT_ENGINE
  569. app.state.config.STT_MODEL = AUDIO_STT_MODEL
  570. app.state.config.WHISPER_MODEL = WHISPER_MODEL
  571. app.state.config.DEEPGRAM_API_KEY = DEEPGRAM_API_KEY
  572. app.state.config.TTS_OPENAI_API_BASE_URL = AUDIO_TTS_OPENAI_API_BASE_URL
  573. app.state.config.TTS_OPENAI_API_KEY = AUDIO_TTS_OPENAI_API_KEY
  574. app.state.config.TTS_ENGINE = AUDIO_TTS_ENGINE
  575. app.state.config.TTS_MODEL = AUDIO_TTS_MODEL
  576. app.state.config.TTS_VOICE = AUDIO_TTS_VOICE
  577. app.state.config.TTS_API_KEY = AUDIO_TTS_API_KEY
  578. app.state.config.TTS_SPLIT_ON = AUDIO_TTS_SPLIT_ON
  579. app.state.config.TTS_AZURE_SPEECH_REGION = AUDIO_TTS_AZURE_SPEECH_REGION
  580. app.state.config.TTS_AZURE_SPEECH_OUTPUT_FORMAT = AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT
  581. app.state.faster_whisper_model = None
  582. app.state.speech_synthesiser = None
  583. app.state.speech_speaker_embeddings_dataset = None
  584. ########################################
  585. #
  586. # TASKS
  587. #
  588. ########################################
  589. app.state.config.TASK_MODEL = TASK_MODEL
  590. app.state.config.TASK_MODEL_EXTERNAL = TASK_MODEL_EXTERNAL
  591. app.state.config.ENABLE_SEARCH_QUERY_GENERATION = ENABLE_SEARCH_QUERY_GENERATION
  592. app.state.config.ENABLE_RETRIEVAL_QUERY_GENERATION = ENABLE_RETRIEVAL_QUERY_GENERATION
  593. app.state.config.ENABLE_AUTOCOMPLETE_GENERATION = ENABLE_AUTOCOMPLETE_GENERATION
  594. app.state.config.ENABLE_TAGS_GENERATION = ENABLE_TAGS_GENERATION
  595. app.state.config.ENABLE_TITLE_GENERATION = ENABLE_TITLE_GENERATION
  596. app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE = TITLE_GENERATION_PROMPT_TEMPLATE
  597. app.state.config.TAGS_GENERATION_PROMPT_TEMPLATE = TAGS_GENERATION_PROMPT_TEMPLATE
  598. app.state.config.IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE = (
  599. IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE
  600. )
  601. app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = (
  602. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
  603. )
  604. app.state.config.QUERY_GENERATION_PROMPT_TEMPLATE = QUERY_GENERATION_PROMPT_TEMPLATE
  605. app.state.config.AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE = (
  606. AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE
  607. )
  608. app.state.config.AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH = (
  609. AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH
  610. )
  611. ########################################
  612. #
  613. # WEBUI
  614. #
  615. ########################################
  616. app.state.MODELS = {}
  617. class RedirectMiddleware(BaseHTTPMiddleware):
  618. async def dispatch(self, request: Request, call_next):
  619. # Check if the request is a GET request
  620. if request.method == "GET":
  621. path = request.url.path
  622. query_params = dict(parse_qs(urlparse(str(request.url)).query))
  623. # Check for the specific watch path and the presence of 'v' parameter
  624. if path.endswith("/watch") and "v" in query_params:
  625. video_id = query_params["v"][0] # Extract the first 'v' parameter
  626. encoded_video_id = urlencode({"youtube": video_id})
  627. redirect_url = f"/?{encoded_video_id}"
  628. return RedirectResponse(url=redirect_url)
  629. # Proceed with the normal flow of other requests
  630. response = await call_next(request)
  631. return response
  632. # Add the middleware to the app
  633. app.add_middleware(RedirectMiddleware)
  634. app.add_middleware(SecurityHeadersMiddleware)
  635. @app.middleware("http")
  636. async def commit_session_after_request(request: Request, call_next):
  637. response = await call_next(request)
  638. # log.debug("Commit session after request")
  639. Session.commit()
  640. return response
  641. @app.middleware("http")
  642. async def check_url(request: Request, call_next):
  643. start_time = int(time.time())
  644. request.state.enable_api_key = app.state.config.ENABLE_API_KEY
  645. response = await call_next(request)
  646. process_time = int(time.time()) - start_time
  647. response.headers["X-Process-Time"] = str(process_time)
  648. return response
  649. @app.middleware("http")
  650. async def inspect_websocket(request: Request, call_next):
  651. if (
  652. "/ws/socket.io" in request.url.path
  653. and request.query_params.get("transport") == "websocket"
  654. ):
  655. upgrade = (request.headers.get("Upgrade") or "").lower()
  656. connection = (request.headers.get("Connection") or "").lower().split(",")
  657. # Check that there's the correct headers for an upgrade, else reject the connection
  658. # This is to work around this upstream issue: https://github.com/miguelgrinberg/python-engineio/issues/367
  659. if upgrade != "websocket" or "upgrade" not in connection:
  660. return JSONResponse(
  661. status_code=status.HTTP_400_BAD_REQUEST,
  662. content={"detail": "Invalid WebSocket upgrade request"},
  663. )
  664. return await call_next(request)
  665. app.add_middleware(
  666. CORSMiddleware,
  667. allow_origins=CORS_ALLOW_ORIGIN,
  668. allow_credentials=True,
  669. allow_methods=["*"],
  670. allow_headers=["*"],
  671. )
  672. app.mount("/ws", socket_app)
  673. app.include_router(ollama.router, prefix="/ollama", tags=["ollama"])
  674. app.include_router(openai.router, prefix="/openai", tags=["openai"])
  675. app.include_router(pipelines.router, prefix="/api/v1/pipelines", tags=["pipelines"])
  676. app.include_router(tasks.router, prefix="/api/v1/tasks", tags=["tasks"])
  677. app.include_router(images.router, prefix="/api/v1/images", tags=["images"])
  678. app.include_router(audio.router, prefix="/api/v1/audio", tags=["audio"])
  679. app.include_router(retrieval.router, prefix="/api/v1/retrieval", tags=["retrieval"])
  680. app.include_router(configs.router, prefix="/api/v1/configs", tags=["configs"])
  681. app.include_router(auths.router, prefix="/api/v1/auths", tags=["auths"])
  682. app.include_router(users.router, prefix="/api/v1/users", tags=["users"])
  683. app.include_router(channels.router, prefix="/api/v1/channels", tags=["channels"])
  684. app.include_router(chats.router, prefix="/api/v1/chats", tags=["chats"])
  685. app.include_router(models.router, prefix="/api/v1/models", tags=["models"])
  686. app.include_router(knowledge.router, prefix="/api/v1/knowledge", tags=["knowledge"])
  687. app.include_router(prompts.router, prefix="/api/v1/prompts", tags=["prompts"])
  688. app.include_router(tools.router, prefix="/api/v1/tools", tags=["tools"])
  689. app.include_router(memories.router, prefix="/api/v1/memories", tags=["memories"])
  690. app.include_router(folders.router, prefix="/api/v1/folders", tags=["folders"])
  691. app.include_router(groups.router, prefix="/api/v1/groups", tags=["groups"])
  692. app.include_router(files.router, prefix="/api/v1/files", tags=["files"])
  693. app.include_router(functions.router, prefix="/api/v1/functions", tags=["functions"])
  694. app.include_router(
  695. evaluations.router, prefix="/api/v1/evaluations", tags=["evaluations"]
  696. )
  697. app.include_router(utils.router, prefix="/api/v1/utils", tags=["utils"])
  698. ##################################
  699. #
  700. # Chat Endpoints
  701. #
  702. ##################################
  703. @app.get("/api/models")
  704. async def get_models(request: Request, user=Depends(get_verified_user)):
  705. def get_filtered_models(models, user):
  706. filtered_models = []
  707. for model in models:
  708. if model.get("arena"):
  709. if has_access(
  710. user.id,
  711. type="read",
  712. access_control=model.get("info", {})
  713. .get("meta", {})
  714. .get("access_control", {}),
  715. ):
  716. filtered_models.append(model)
  717. continue
  718. model_info = Models.get_model_by_id(model["id"])
  719. if model_info:
  720. if user.id == model_info.user_id or has_access(
  721. user.id, type="read", access_control=model_info.access_control
  722. ):
  723. filtered_models.append(model)
  724. return filtered_models
  725. models = await get_all_models(request)
  726. # Filter out filter pipelines
  727. models = [
  728. model
  729. for model in models
  730. if "pipeline" not in model or model["pipeline"].get("type", None) != "filter"
  731. ]
  732. model_order_list = request.app.state.config.MODEL_ORDER_LIST
  733. if model_order_list:
  734. model_order_dict = {model_id: i for i, model_id in enumerate(model_order_list)}
  735. # Sort models by order list priority, with fallback for those not in the list
  736. models.sort(
  737. key=lambda x: (model_order_dict.get(x["id"], float("inf")), x["name"])
  738. )
  739. # Filter out models that the user does not have access to
  740. if user.role == "user" and not BYPASS_MODEL_ACCESS_CONTROL:
  741. models = get_filtered_models(models, user)
  742. log.debug(
  743. f"/api/models returned filtered models accessible to the user: {json.dumps([model['id'] for model in models])}"
  744. )
  745. return {"data": models}
  746. @app.get("/api/models/base")
  747. async def get_base_models(request: Request, user=Depends(get_admin_user)):
  748. models = await get_all_base_models(request)
  749. return {"data": models}
  750. @app.post("/api/chat/completions")
  751. async def chat_completion(
  752. request: Request,
  753. form_data: dict,
  754. user=Depends(get_verified_user),
  755. ):
  756. if not request.app.state.MODELS:
  757. await get_all_models(request)
  758. model_item = form_data.pop("model_item", {})
  759. tasks = form_data.pop("background_tasks", None)
  760. try:
  761. if not model_item.get("direct", False):
  762. model_id = form_data.get("model", None)
  763. if model_id not in request.app.state.MODELS:
  764. raise Exception("Model not found")
  765. model = request.app.state.MODELS[model_id]
  766. model_info = Models.get_model_by_id(model_id)
  767. # Check if user has access to the model
  768. if not BYPASS_MODEL_ACCESS_CONTROL and user.role == "user":
  769. try:
  770. check_model_access(user, model)
  771. except Exception as e:
  772. raise e
  773. else:
  774. model = model_item
  775. model_info = None
  776. request.state.direct = True
  777. request.state.model = model
  778. metadata = {
  779. "user_id": user.id,
  780. "chat_id": form_data.pop("chat_id", None),
  781. "message_id": form_data.pop("id", None),
  782. "session_id": form_data.pop("session_id", None),
  783. "tool_ids": form_data.get("tool_ids", None),
  784. "files": form_data.get("files", None),
  785. "features": form_data.get("features", None),
  786. "variables": form_data.get("variables", None),
  787. "model": model_info,
  788. "direct": model_item.get("direct", False),
  789. **(
  790. {"function_calling": "native"}
  791. if form_data.get("params", {}).get("function_calling") == "native"
  792. or (
  793. model_info
  794. and model_info.params.model_dump().get("function_calling")
  795. == "native"
  796. )
  797. else {}
  798. ),
  799. }
  800. request.state.metadata = metadata
  801. form_data["metadata"] = metadata
  802. form_data, metadata, events = await process_chat_payload(
  803. request, form_data, metadata, user, model
  804. )
  805. except Exception as e:
  806. log.debug(f"Error processing chat payload: {e}")
  807. raise HTTPException(
  808. status_code=status.HTTP_400_BAD_REQUEST,
  809. detail=str(e),
  810. )
  811. try:
  812. response = await chat_completion_handler(request, form_data, user)
  813. return await process_chat_response(
  814. request, response, form_data, user, events, metadata, tasks
  815. )
  816. except Exception as e:
  817. raise HTTPException(
  818. status_code=status.HTTP_400_BAD_REQUEST,
  819. detail=str(e),
  820. )
  821. # Alias for chat_completion (Legacy)
  822. generate_chat_completions = chat_completion
  823. generate_chat_completion = chat_completion
  824. @app.post("/api/chat/completed")
  825. async def chat_completed(
  826. request: Request, form_data: dict, user=Depends(get_verified_user)
  827. ):
  828. try:
  829. model_item = form_data.pop("model_item", {})
  830. if model_item.get("direct", False):
  831. request.state.direct = True
  832. request.state.model = model_item
  833. return await chat_completed_handler(request, form_data, user)
  834. except Exception as e:
  835. raise HTTPException(
  836. status_code=status.HTTP_400_BAD_REQUEST,
  837. detail=str(e),
  838. )
  839. @app.post("/api/chat/actions/{action_id}")
  840. async def chat_action(
  841. request: Request, action_id: str, form_data: dict, user=Depends(get_verified_user)
  842. ):
  843. try:
  844. model_item = form_data.pop("model_item", {})
  845. if model_item.get("direct", False):
  846. request.state.direct = True
  847. request.state.model = model_item
  848. return await chat_action_handler(request, action_id, form_data, user)
  849. except Exception as e:
  850. raise HTTPException(
  851. status_code=status.HTTP_400_BAD_REQUEST,
  852. detail=str(e),
  853. )
  854. @app.post("/api/tasks/stop/{task_id}")
  855. async def stop_task_endpoint(task_id: str, user=Depends(get_verified_user)):
  856. try:
  857. result = await stop_task(task_id) # Use the function from tasks.py
  858. return result
  859. except ValueError as e:
  860. raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail=str(e))
  861. @app.get("/api/tasks")
  862. async def list_tasks_endpoint(user=Depends(get_verified_user)):
  863. return {"tasks": list_tasks()} # Use the function from tasks.py
  864. ##################################
  865. #
  866. # Config Endpoints
  867. #
  868. ##################################
  869. @app.get("/api/config")
  870. async def get_app_config(request: Request):
  871. user = None
  872. if "token" in request.cookies:
  873. token = request.cookies.get("token")
  874. try:
  875. data = decode_token(token)
  876. except Exception as e:
  877. log.debug(e)
  878. raise HTTPException(
  879. status_code=status.HTTP_401_UNAUTHORIZED,
  880. detail="Invalid token",
  881. )
  882. if data is not None and "id" in data:
  883. user = Users.get_user_by_id(data["id"])
  884. onboarding = False
  885. if user is None:
  886. user_count = Users.get_num_users()
  887. onboarding = user_count == 0
  888. return {
  889. **({"onboarding": True} if onboarding else {}),
  890. "status": True,
  891. "name": WEBUI_NAME,
  892. "version": VERSION,
  893. "default_locale": str(DEFAULT_LOCALE),
  894. "oauth": {
  895. "providers": {
  896. name: config.get("name", name)
  897. for name, config in OAUTH_PROVIDERS.items()
  898. }
  899. },
  900. "features": {
  901. "auth": WEBUI_AUTH,
  902. "auth_trusted_header": bool(app.state.AUTH_TRUSTED_EMAIL_HEADER),
  903. "enable_ldap": app.state.config.ENABLE_LDAP,
  904. "enable_api_key": app.state.config.ENABLE_API_KEY,
  905. "enable_signup": app.state.config.ENABLE_SIGNUP,
  906. "enable_login_form": app.state.config.ENABLE_LOGIN_FORM,
  907. "enable_websocket": ENABLE_WEBSOCKET_SUPPORT,
  908. **(
  909. {
  910. "enable_direct_connections": app.state.config.ENABLE_DIRECT_CONNECTIONS,
  911. "enable_channels": app.state.config.ENABLE_CHANNELS,
  912. "enable_web_search": app.state.config.ENABLE_RAG_WEB_SEARCH,
  913. "enable_code_interpreter": app.state.config.ENABLE_CODE_INTERPRETER,
  914. "enable_image_generation": app.state.config.ENABLE_IMAGE_GENERATION,
  915. "enable_autocomplete_generation": app.state.config.ENABLE_AUTOCOMPLETE_GENERATION,
  916. "enable_community_sharing": app.state.config.ENABLE_COMMUNITY_SHARING,
  917. "enable_message_rating": app.state.config.ENABLE_MESSAGE_RATING,
  918. "enable_admin_export": ENABLE_ADMIN_EXPORT,
  919. "enable_admin_chat_access": ENABLE_ADMIN_CHAT_ACCESS,
  920. "enable_google_drive_integration": app.state.config.ENABLE_GOOGLE_DRIVE_INTEGRATION,
  921. }
  922. if user is not None
  923. else {}
  924. ),
  925. },
  926. **(
  927. {
  928. "default_models": app.state.config.DEFAULT_MODELS,
  929. "default_prompt_suggestions": app.state.config.DEFAULT_PROMPT_SUGGESTIONS,
  930. "audio": {
  931. "tts": {
  932. "engine": app.state.config.TTS_ENGINE,
  933. "voice": app.state.config.TTS_VOICE,
  934. "split_on": app.state.config.TTS_SPLIT_ON,
  935. },
  936. "stt": {
  937. "engine": app.state.config.STT_ENGINE,
  938. },
  939. },
  940. "file": {
  941. "max_size": app.state.config.FILE_MAX_SIZE,
  942. "max_count": app.state.config.FILE_MAX_COUNT,
  943. },
  944. "permissions": {**app.state.config.USER_PERMISSIONS},
  945. "google_drive": {
  946. "client_id": GOOGLE_DRIVE_CLIENT_ID.value,
  947. "api_key": GOOGLE_DRIVE_API_KEY.value,
  948. },
  949. }
  950. if user is not None
  951. else {}
  952. ),
  953. }
  954. class UrlForm(BaseModel):
  955. url: str
  956. @app.get("/api/webhook")
  957. async def get_webhook_url(user=Depends(get_admin_user)):
  958. return {
  959. "url": app.state.config.WEBHOOK_URL,
  960. }
  961. @app.post("/api/webhook")
  962. async def update_webhook_url(form_data: UrlForm, user=Depends(get_admin_user)):
  963. app.state.config.WEBHOOK_URL = form_data.url
  964. app.state.WEBHOOK_URL = app.state.config.WEBHOOK_URL
  965. return {"url": app.state.config.WEBHOOK_URL}
  966. @app.get("/api/version")
  967. async def get_app_version():
  968. return {
  969. "version": VERSION,
  970. }
  971. @app.get("/api/version/updates")
  972. async def get_app_latest_release_version(user=Depends(get_verified_user)):
  973. if OFFLINE_MODE:
  974. log.debug(
  975. f"Offline mode is enabled, returning current version as latest version"
  976. )
  977. return {"current": VERSION, "latest": VERSION}
  978. try:
  979. timeout = aiohttp.ClientTimeout(total=1)
  980. async with aiohttp.ClientSession(timeout=timeout, trust_env=True) as session:
  981. async with session.get(
  982. "https://api.github.com/repos/open-webui/open-webui/releases/latest"
  983. ) as response:
  984. response.raise_for_status()
  985. data = await response.json()
  986. latest_version = data["tag_name"]
  987. return {"current": VERSION, "latest": latest_version[1:]}
  988. except Exception as e:
  989. log.debug(e)
  990. return {"current": VERSION, "latest": VERSION}
  991. @app.get("/api/changelog")
  992. async def get_app_changelog():
  993. return {key: CHANGELOG[key] for idx, key in enumerate(CHANGELOG) if idx < 5}
  994. ############################
  995. # OAuth Login & Callback
  996. ############################
  997. # SessionMiddleware is used by authlib for oauth
  998. if len(OAUTH_PROVIDERS) > 0:
  999. app.add_middleware(
  1000. SessionMiddleware,
  1001. secret_key=WEBUI_SECRET_KEY,
  1002. session_cookie="oui-session",
  1003. same_site=WEBUI_SESSION_COOKIE_SAME_SITE,
  1004. https_only=WEBUI_SESSION_COOKIE_SECURE,
  1005. )
  1006. @app.get("/oauth/{provider}/login")
  1007. async def oauth_login(provider: str, request: Request):
  1008. return await oauth_manager.handle_login(provider, request)
  1009. # OAuth login logic is as follows:
  1010. # 1. Attempt to find a user with matching subject ID, tied to the provider
  1011. # 2. If OAUTH_MERGE_ACCOUNTS_BY_EMAIL is true, find a user with the email address provided via OAuth
  1012. # - This is considered insecure in general, as OAuth providers do not always verify email addresses
  1013. # 3. If there is no user, and ENABLE_OAUTH_SIGNUP is true, create a user
  1014. # - Email addresses are considered unique, so we fail registration if the email address is already taken
  1015. @app.get("/oauth/{provider}/callback")
  1016. async def oauth_callback(provider: str, request: Request, response: Response):
  1017. return await oauth_manager.handle_callback(provider, request, response)
  1018. @app.get("/manifest.json")
  1019. async def get_manifest_json():
  1020. return {
  1021. "name": WEBUI_NAME,
  1022. "short_name": WEBUI_NAME,
  1023. "description": "Open WebUI is an open, extensible, user-friendly interface for AI that adapts to your workflow.",
  1024. "start_url": "/",
  1025. "display": "standalone",
  1026. "background_color": "#343541",
  1027. "orientation": "natural",
  1028. "icons": [
  1029. {
  1030. "src": "/static/logo.png",
  1031. "type": "image/png",
  1032. "sizes": "500x500",
  1033. "purpose": "any",
  1034. },
  1035. {
  1036. "src": "/static/logo.png",
  1037. "type": "image/png",
  1038. "sizes": "500x500",
  1039. "purpose": "maskable",
  1040. },
  1041. ],
  1042. }
  1043. @app.get("/opensearch.xml")
  1044. async def get_opensearch_xml():
  1045. xml_content = rf"""
  1046. <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" xmlns:moz="http://www.mozilla.org/2006/browser/search/">
  1047. <ShortName>{WEBUI_NAME}</ShortName>
  1048. <Description>Search {WEBUI_NAME}</Description>
  1049. <InputEncoding>UTF-8</InputEncoding>
  1050. <Image width="16" height="16" type="image/x-icon">{app.state.config.WEBUI_URL}/static/favicon.png</Image>
  1051. <Url type="text/html" method="get" template="{app.state.config.WEBUI_URL}/?q={"{searchTerms}"}"/>
  1052. <moz:SearchForm>{app.state.config.WEBUI_URL}</moz:SearchForm>
  1053. </OpenSearchDescription>
  1054. """
  1055. return Response(content=xml_content, media_type="application/xml")
  1056. @app.get("/health")
  1057. async def healthcheck():
  1058. return {"status": True}
  1059. @app.get("/health/db")
  1060. async def healthcheck_with_db():
  1061. Session.execute(text("SELECT 1;")).all()
  1062. return {"status": True}
  1063. app.mount("/static", StaticFiles(directory=STATIC_DIR), name="static")
  1064. app.mount("/cache", StaticFiles(directory=CACHE_DIR), name="cache")
  1065. def swagger_ui_html(*args, **kwargs):
  1066. return get_swagger_ui_html(
  1067. *args,
  1068. **kwargs,
  1069. swagger_js_url="/static/swagger-ui/swagger-ui-bundle.js",
  1070. swagger_css_url="/static/swagger-ui/swagger-ui.css",
  1071. swagger_favicon_url="/static/swagger-ui/favicon.png",
  1072. )
  1073. applications.get_swagger_ui_html = swagger_ui_html
  1074. if os.path.exists(FRONTEND_BUILD_DIR):
  1075. mimetypes.add_type("text/javascript", ".js")
  1076. app.mount(
  1077. "/",
  1078. SPAStaticFiles(directory=FRONTEND_BUILD_DIR, html=True),
  1079. name="spa-static-files",
  1080. )
  1081. else:
  1082. log.warning(
  1083. f"Frontend build directory not found at '{FRONTEND_BUILD_DIR}'. Serving API only."
  1084. )