main.py 49 KB

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