main.py 51 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486
  1. # TODO: Merge this with the webui_app and make it a single app
  2. import json
  3. import logging
  4. import mimetypes
  5. import os
  6. import shutil
  7. import uuid
  8. from datetime import datetime
  9. from pathlib import Path
  10. from typing import Iterator, Optional, Sequence, Union
  11. from fastapi import Depends, FastAPI, File, Form, HTTPException, UploadFile, status
  12. from fastapi.middleware.cors import CORSMiddleware
  13. from pydantic import BaseModel
  14. import tiktoken
  15. from open_webui.storage.provider import Storage
  16. from open_webui.apps.webui.models.knowledge import Knowledges
  17. from open_webui.apps.retrieval.vector.connector import VECTOR_DB_CLIENT
  18. # Document loaders
  19. from open_webui.apps.retrieval.loaders.main import Loader
  20. from open_webui.apps.retrieval.loaders.youtube import YoutubeLoader
  21. # Web search engines
  22. from open_webui.apps.retrieval.web.main import SearchResult
  23. from open_webui.apps.retrieval.web.utils import get_web_loader
  24. from open_webui.apps.retrieval.web.brave import search_brave
  25. from open_webui.apps.retrieval.web.mojeek import search_mojeek
  26. from open_webui.apps.retrieval.web.duckduckgo import search_duckduckgo
  27. from open_webui.apps.retrieval.web.google_pse import search_google_pse
  28. from open_webui.apps.retrieval.web.jina_search import search_jina
  29. from open_webui.apps.retrieval.web.searchapi import search_searchapi
  30. from open_webui.apps.retrieval.web.searxng import search_searxng
  31. from open_webui.apps.retrieval.web.serper import search_serper
  32. from open_webui.apps.retrieval.web.serply import search_serply
  33. from open_webui.apps.retrieval.web.serpstack import search_serpstack
  34. from open_webui.apps.retrieval.web.tavily import search_tavily
  35. from open_webui.apps.retrieval.web.bing import search_bing
  36. from open_webui.apps.retrieval.utils import (
  37. get_embedding_function,
  38. get_model_path,
  39. query_collection,
  40. query_collection_with_hybrid_search,
  41. query_doc,
  42. query_doc_with_hybrid_search,
  43. )
  44. from open_webui.apps.webui.models.files import Files
  45. from open_webui.config import (
  46. BRAVE_SEARCH_API_KEY,
  47. MOJEEK_SEARCH_API_KEY,
  48. TIKTOKEN_ENCODING_NAME,
  49. RAG_TEXT_SPLITTER,
  50. CHUNK_OVERLAP,
  51. CHUNK_SIZE,
  52. CONTENT_EXTRACTION_ENGINE,
  53. CORS_ALLOW_ORIGIN,
  54. ENABLE_RAG_HYBRID_SEARCH,
  55. ENABLE_RAG_LOCAL_WEB_FETCH,
  56. ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION,
  57. ENABLE_RAG_WEB_SEARCH,
  58. ENV,
  59. GOOGLE_PSE_API_KEY,
  60. GOOGLE_PSE_ENGINE_ID,
  61. PDF_EXTRACT_IMAGES,
  62. RAG_EMBEDDING_ENGINE,
  63. RAG_EMBEDDING_MODEL,
  64. RAG_EMBEDDING_MODEL_AUTO_UPDATE,
  65. RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE,
  66. RAG_EMBEDDING_BATCH_SIZE,
  67. RAG_FILE_MAX_COUNT,
  68. RAG_FILE_MAX_SIZE,
  69. RAG_OPENAI_API_BASE_URL,
  70. RAG_OPENAI_API_KEY,
  71. RAG_OLLAMA_BASE_URL,
  72. RAG_OLLAMA_API_KEY,
  73. RAG_RELEVANCE_THRESHOLD,
  74. RAG_RERANKING_MODEL,
  75. RAG_RERANKING_MODEL_AUTO_UPDATE,
  76. RAG_RERANKING_MODEL_TRUST_REMOTE_CODE,
  77. DEFAULT_RAG_TEMPLATE,
  78. RAG_TEMPLATE,
  79. RAG_TOP_K,
  80. RAG_WEB_SEARCH_CONCURRENT_REQUESTS,
  81. RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  82. RAG_WEB_SEARCH_ENGINE,
  83. RAG_WEB_SEARCH_RESULT_COUNT,
  84. JINA_API_KEY,
  85. SEARCHAPI_API_KEY,
  86. SEARCHAPI_ENGINE,
  87. SEARXNG_QUERY_URL,
  88. SERPER_API_KEY,
  89. SERPLY_API_KEY,
  90. SERPSTACK_API_KEY,
  91. SERPSTACK_HTTPS,
  92. TAVILY_API_KEY,
  93. BING_SEARCH_V7_ENDPOINT,
  94. BING_SEARCH_V7_SUBSCRIPTION_KEY,
  95. TIKA_SERVER_URL,
  96. UPLOAD_DIR,
  97. YOUTUBE_LOADER_LANGUAGE,
  98. DEFAULT_LOCALE,
  99. AppConfig,
  100. )
  101. from open_webui.constants import ERROR_MESSAGES
  102. from open_webui.env import (
  103. SRC_LOG_LEVELS,
  104. DEVICE_TYPE,
  105. DOCKER,
  106. )
  107. from open_webui.utils.misc import (
  108. calculate_sha256,
  109. calculate_sha256_string,
  110. extract_folders_after_data_docs,
  111. sanitize_filename,
  112. )
  113. from open_webui.utils.utils import get_admin_user, get_verified_user
  114. from langchain.text_splitter import RecursiveCharacterTextSplitter, TokenTextSplitter
  115. from langchain_core.documents import Document
  116. log = logging.getLogger(__name__)
  117. log.setLevel(SRC_LOG_LEVELS["RAG"])
  118. app = FastAPI(
  119. docs_url="/docs" if ENV == "dev" else None,
  120. openapi_url="/openapi.json" if ENV == "dev" else None,
  121. redoc_url=None,
  122. )
  123. app.state.config = AppConfig()
  124. app.state.config.TOP_K = RAG_TOP_K
  125. app.state.config.RELEVANCE_THRESHOLD = RAG_RELEVANCE_THRESHOLD
  126. app.state.config.FILE_MAX_SIZE = RAG_FILE_MAX_SIZE
  127. app.state.config.FILE_MAX_COUNT = RAG_FILE_MAX_COUNT
  128. app.state.config.ENABLE_RAG_HYBRID_SEARCH = ENABLE_RAG_HYBRID_SEARCH
  129. app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION = (
  130. ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION
  131. )
  132. app.state.config.CONTENT_EXTRACTION_ENGINE = CONTENT_EXTRACTION_ENGINE
  133. app.state.config.TIKA_SERVER_URL = TIKA_SERVER_URL
  134. app.state.config.TEXT_SPLITTER = RAG_TEXT_SPLITTER
  135. app.state.config.TIKTOKEN_ENCODING_NAME = TIKTOKEN_ENCODING_NAME
  136. app.state.config.CHUNK_SIZE = CHUNK_SIZE
  137. app.state.config.CHUNK_OVERLAP = CHUNK_OVERLAP
  138. app.state.config.RAG_EMBEDDING_ENGINE = RAG_EMBEDDING_ENGINE
  139. app.state.config.RAG_EMBEDDING_MODEL = RAG_EMBEDDING_MODEL
  140. app.state.config.RAG_EMBEDDING_BATCH_SIZE = RAG_EMBEDDING_BATCH_SIZE
  141. app.state.config.RAG_RERANKING_MODEL = RAG_RERANKING_MODEL
  142. app.state.config.RAG_TEMPLATE = RAG_TEMPLATE
  143. app.state.config.OPENAI_API_BASE_URL = RAG_OPENAI_API_BASE_URL
  144. app.state.config.OPENAI_API_KEY = RAG_OPENAI_API_KEY
  145. app.state.config.OLLAMA_BASE_URL = RAG_OLLAMA_BASE_URL
  146. app.state.config.OLLAMA_API_KEY = RAG_OLLAMA_API_KEY
  147. app.state.config.PDF_EXTRACT_IMAGES = PDF_EXTRACT_IMAGES
  148. app.state.config.YOUTUBE_LOADER_LANGUAGE = YOUTUBE_LOADER_LANGUAGE
  149. app.state.YOUTUBE_LOADER_TRANSLATION = None
  150. app.state.config.ENABLE_RAG_WEB_SEARCH = ENABLE_RAG_WEB_SEARCH
  151. app.state.config.RAG_WEB_SEARCH_ENGINE = RAG_WEB_SEARCH_ENGINE
  152. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST = RAG_WEB_SEARCH_DOMAIN_FILTER_LIST
  153. app.state.config.SEARXNG_QUERY_URL = SEARXNG_QUERY_URL
  154. app.state.config.GOOGLE_PSE_API_KEY = GOOGLE_PSE_API_KEY
  155. app.state.config.GOOGLE_PSE_ENGINE_ID = GOOGLE_PSE_ENGINE_ID
  156. app.state.config.BRAVE_SEARCH_API_KEY = BRAVE_SEARCH_API_KEY
  157. app.state.config.MOJEEK_SEARCH_API_KEY = MOJEEK_SEARCH_API_KEY
  158. app.state.config.SERPSTACK_API_KEY = SERPSTACK_API_KEY
  159. app.state.config.SERPSTACK_HTTPS = SERPSTACK_HTTPS
  160. app.state.config.SERPER_API_KEY = SERPER_API_KEY
  161. app.state.config.SERPLY_API_KEY = SERPLY_API_KEY
  162. app.state.config.TAVILY_API_KEY = TAVILY_API_KEY
  163. app.state.config.SEARCHAPI_API_KEY = SEARCHAPI_API_KEY
  164. app.state.config.SEARCHAPI_ENGINE = SEARCHAPI_ENGINE
  165. app.state.config.JINA_API_KEY = JINA_API_KEY
  166. app.state.config.BING_SEARCH_V7_ENDPOINT = BING_SEARCH_V7_ENDPOINT
  167. app.state.config.BING_SEARCH_V7_SUBSCRIPTION_KEY = BING_SEARCH_V7_SUBSCRIPTION_KEY
  168. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT = RAG_WEB_SEARCH_RESULT_COUNT
  169. app.state.config.RAG_WEB_SEARCH_CONCURRENT_REQUESTS = RAG_WEB_SEARCH_CONCURRENT_REQUESTS
  170. def update_embedding_model(
  171. embedding_model: str,
  172. auto_update: bool = False,
  173. ):
  174. if embedding_model and app.state.config.RAG_EMBEDDING_ENGINE == "":
  175. from sentence_transformers import SentenceTransformer
  176. try:
  177. app.state.sentence_transformer_ef = SentenceTransformer(
  178. get_model_path(embedding_model, auto_update),
  179. device=DEVICE_TYPE,
  180. trust_remote_code=RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE,
  181. )
  182. except Exception as e:
  183. log.debug(f"Error loading SentenceTransformer: {e}")
  184. app.state.sentence_transformer_ef = None
  185. else:
  186. app.state.sentence_transformer_ef = None
  187. def update_reranking_model(
  188. reranking_model: str,
  189. auto_update: bool = False,
  190. ):
  191. if reranking_model:
  192. if any(model in reranking_model for model in ["jinaai/jina-colbert-v2"]):
  193. try:
  194. from open_webui.apps.retrieval.models.colbert import ColBERT
  195. app.state.sentence_transformer_rf = ColBERT(
  196. get_model_path(reranking_model, auto_update),
  197. env="docker" if DOCKER else None,
  198. )
  199. except Exception as e:
  200. log.error(f"ColBERT: {e}")
  201. app.state.sentence_transformer_rf = None
  202. app.state.config.ENABLE_RAG_HYBRID_SEARCH = False
  203. else:
  204. import sentence_transformers
  205. try:
  206. app.state.sentence_transformer_rf = sentence_transformers.CrossEncoder(
  207. get_model_path(reranking_model, auto_update),
  208. device=DEVICE_TYPE,
  209. trust_remote_code=RAG_RERANKING_MODEL_TRUST_REMOTE_CODE,
  210. )
  211. except:
  212. log.error("CrossEncoder error")
  213. app.state.sentence_transformer_rf = None
  214. app.state.config.ENABLE_RAG_HYBRID_SEARCH = False
  215. else:
  216. app.state.sentence_transformer_rf = None
  217. update_embedding_model(
  218. app.state.config.RAG_EMBEDDING_MODEL,
  219. RAG_EMBEDDING_MODEL_AUTO_UPDATE,
  220. )
  221. update_reranking_model(
  222. app.state.config.RAG_RERANKING_MODEL,
  223. RAG_RERANKING_MODEL_AUTO_UPDATE,
  224. )
  225. app.state.EMBEDDING_FUNCTION = get_embedding_function(
  226. app.state.config.RAG_EMBEDDING_ENGINE,
  227. app.state.config.RAG_EMBEDDING_MODEL,
  228. app.state.sentence_transformer_ef,
  229. (
  230. app.state.config.OPENAI_API_BASE_URL
  231. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  232. else app.state.config.OLLAMA_BASE_URL
  233. ),
  234. (
  235. app.state.config.OPENAI_API_KEY
  236. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  237. else app.state.config.OLLAMA_API_KEY
  238. ),
  239. app.state.config.RAG_EMBEDDING_BATCH_SIZE,
  240. )
  241. app.add_middleware(
  242. CORSMiddleware,
  243. allow_origins=CORS_ALLOW_ORIGIN,
  244. allow_credentials=True,
  245. allow_methods=["*"],
  246. allow_headers=["*"],
  247. )
  248. class CollectionNameForm(BaseModel):
  249. collection_name: Optional[str] = None
  250. class ProcessUrlForm(CollectionNameForm):
  251. url: str
  252. class SearchForm(CollectionNameForm):
  253. query: str
  254. @app.get("/")
  255. async def get_status():
  256. return {
  257. "status": True,
  258. "chunk_size": app.state.config.CHUNK_SIZE,
  259. "chunk_overlap": app.state.config.CHUNK_OVERLAP,
  260. "template": app.state.config.RAG_TEMPLATE,
  261. "embedding_engine": app.state.config.RAG_EMBEDDING_ENGINE,
  262. "embedding_model": app.state.config.RAG_EMBEDDING_MODEL,
  263. "reranking_model": app.state.config.RAG_RERANKING_MODEL,
  264. "embedding_batch_size": app.state.config.RAG_EMBEDDING_BATCH_SIZE,
  265. }
  266. @app.get("/embedding")
  267. async def get_embedding_config(user=Depends(get_admin_user)):
  268. return {
  269. "status": True,
  270. "embedding_engine": app.state.config.RAG_EMBEDDING_ENGINE,
  271. "embedding_model": app.state.config.RAG_EMBEDDING_MODEL,
  272. "embedding_batch_size": app.state.config.RAG_EMBEDDING_BATCH_SIZE,
  273. "openai_config": {
  274. "url": app.state.config.OPENAI_API_BASE_URL,
  275. "key": app.state.config.OPENAI_API_KEY,
  276. },
  277. "ollama_config": {
  278. "url": app.state.config.OLLAMA_BASE_URL,
  279. "key": app.state.config.OLLAMA_API_KEY,
  280. },
  281. }
  282. @app.get("/reranking")
  283. async def get_reraanking_config(user=Depends(get_admin_user)):
  284. return {
  285. "status": True,
  286. "reranking_model": app.state.config.RAG_RERANKING_MODEL,
  287. }
  288. class OpenAIConfigForm(BaseModel):
  289. url: str
  290. key: str
  291. class OllamaConfigForm(BaseModel):
  292. url: str
  293. key: str
  294. class EmbeddingModelUpdateForm(BaseModel):
  295. openai_config: Optional[OpenAIConfigForm] = None
  296. ollama_config: Optional[OllamaConfigForm] = None
  297. embedding_engine: str
  298. embedding_model: str
  299. embedding_batch_size: Optional[int] = 1
  300. @app.post("/embedding/update")
  301. async def update_embedding_config(
  302. form_data: EmbeddingModelUpdateForm, user=Depends(get_admin_user)
  303. ):
  304. log.info(
  305. f"Updating embedding model: {app.state.config.RAG_EMBEDDING_MODEL} to {form_data.embedding_model}"
  306. )
  307. try:
  308. app.state.config.RAG_EMBEDDING_ENGINE = form_data.embedding_engine
  309. app.state.config.RAG_EMBEDDING_MODEL = form_data.embedding_model
  310. if app.state.config.RAG_EMBEDDING_ENGINE in ["ollama", "openai"]:
  311. if form_data.openai_config is not None:
  312. app.state.config.OPENAI_API_BASE_URL = form_data.openai_config.url
  313. app.state.config.OPENAI_API_KEY = form_data.openai_config.key
  314. if form_data.ollama_config is not None:
  315. app.state.config.OLLAMA_BASE_URL = form_data.ollama_config.url
  316. app.state.config.OLLAMA_API_KEY = form_data.ollama_config.key
  317. app.state.config.RAG_EMBEDDING_BATCH_SIZE = form_data.embedding_batch_size
  318. update_embedding_model(app.state.config.RAG_EMBEDDING_MODEL)
  319. app.state.EMBEDDING_FUNCTION = get_embedding_function(
  320. app.state.config.RAG_EMBEDDING_ENGINE,
  321. app.state.config.RAG_EMBEDDING_MODEL,
  322. app.state.sentence_transformer_ef,
  323. (
  324. app.state.config.OPENAI_API_BASE_URL
  325. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  326. else app.state.config.OLLAMA_BASE_URL
  327. ),
  328. (
  329. app.state.config.OPENAI_API_KEY
  330. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  331. else app.state.config.OLLAMA_API_KEY
  332. ),
  333. app.state.config.RAG_EMBEDDING_BATCH_SIZE,
  334. )
  335. return {
  336. "status": True,
  337. "embedding_engine": app.state.config.RAG_EMBEDDING_ENGINE,
  338. "embedding_model": app.state.config.RAG_EMBEDDING_MODEL,
  339. "embedding_batch_size": app.state.config.RAG_EMBEDDING_BATCH_SIZE,
  340. "openai_config": {
  341. "url": app.state.config.OPENAI_API_BASE_URL,
  342. "key": app.state.config.OPENAI_API_KEY,
  343. },
  344. "ollama_config": {
  345. "url": app.state.config.OLLAMA_BASE_URL,
  346. "key": app.state.config.OLLAMA_API_KEY,
  347. },
  348. }
  349. except Exception as e:
  350. log.exception(f"Problem updating embedding model: {e}")
  351. raise HTTPException(
  352. status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
  353. detail=ERROR_MESSAGES.DEFAULT(e),
  354. )
  355. class RerankingModelUpdateForm(BaseModel):
  356. reranking_model: str
  357. @app.post("/reranking/update")
  358. async def update_reranking_config(
  359. form_data: RerankingModelUpdateForm, user=Depends(get_admin_user)
  360. ):
  361. log.info(
  362. f"Updating reranking model: {app.state.config.RAG_RERANKING_MODEL} to {form_data.reranking_model}"
  363. )
  364. try:
  365. app.state.config.RAG_RERANKING_MODEL = form_data.reranking_model
  366. update_reranking_model(app.state.config.RAG_RERANKING_MODEL, True)
  367. return {
  368. "status": True,
  369. "reranking_model": app.state.config.RAG_RERANKING_MODEL,
  370. }
  371. except Exception as e:
  372. log.exception(f"Problem updating reranking model: {e}")
  373. raise HTTPException(
  374. status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
  375. detail=ERROR_MESSAGES.DEFAULT(e),
  376. )
  377. @app.get("/config")
  378. async def get_rag_config(user=Depends(get_admin_user)):
  379. return {
  380. "status": True,
  381. "pdf_extract_images": app.state.config.PDF_EXTRACT_IMAGES,
  382. "content_extraction": {
  383. "engine": app.state.config.CONTENT_EXTRACTION_ENGINE,
  384. "tika_server_url": app.state.config.TIKA_SERVER_URL,
  385. },
  386. "chunk": {
  387. "text_splitter": app.state.config.TEXT_SPLITTER,
  388. "chunk_size": app.state.config.CHUNK_SIZE,
  389. "chunk_overlap": app.state.config.CHUNK_OVERLAP,
  390. },
  391. "file": {
  392. "max_size": app.state.config.FILE_MAX_SIZE,
  393. "max_count": app.state.config.FILE_MAX_COUNT,
  394. },
  395. "youtube": {
  396. "language": app.state.config.YOUTUBE_LOADER_LANGUAGE,
  397. "translation": app.state.YOUTUBE_LOADER_TRANSLATION,
  398. },
  399. "web": {
  400. "web_loader_ssl_verification": app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION,
  401. "search": {
  402. "enabled": app.state.config.ENABLE_RAG_WEB_SEARCH,
  403. "engine": app.state.config.RAG_WEB_SEARCH_ENGINE,
  404. "searxng_query_url": app.state.config.SEARXNG_QUERY_URL,
  405. "google_pse_api_key": app.state.config.GOOGLE_PSE_API_KEY,
  406. "google_pse_engine_id": app.state.config.GOOGLE_PSE_ENGINE_ID,
  407. "brave_search_api_key": app.state.config.BRAVE_SEARCH_API_KEY,
  408. "mojeek_search_api_key": app.state.config.MOJEEK_SEARCH_API_KEY,
  409. "serpstack_api_key": app.state.config.SERPSTACK_API_KEY,
  410. "serpstack_https": app.state.config.SERPSTACK_HTTPS,
  411. "serper_api_key": app.state.config.SERPER_API_KEY,
  412. "serply_api_key": app.state.config.SERPLY_API_KEY,
  413. "tavily_api_key": app.state.config.TAVILY_API_KEY,
  414. "searchapi_api_key": app.state.config.SEARCHAPI_API_KEY,
  415. "seaarchapi_engine": app.state.config.SEARCHAPI_ENGINE,
  416. "jina_api_key": app.state.config.JINA_API_KEY,
  417. "bing_search_v7_endpoint": app.state.config.BING_SEARCH_V7_ENDPOINT,
  418. "bing_search_v7_subscription_key": app.state.config.BING_SEARCH_V7_SUBSCRIPTION_KEY,
  419. "result_count": app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  420. "concurrent_requests": app.state.config.RAG_WEB_SEARCH_CONCURRENT_REQUESTS,
  421. },
  422. },
  423. }
  424. class FileConfig(BaseModel):
  425. max_size: Optional[int] = None
  426. max_count: Optional[int] = None
  427. class ContentExtractionConfig(BaseModel):
  428. engine: str = ""
  429. tika_server_url: Optional[str] = None
  430. class ChunkParamUpdateForm(BaseModel):
  431. text_splitter: Optional[str] = None
  432. chunk_size: int
  433. chunk_overlap: int
  434. class YoutubeLoaderConfig(BaseModel):
  435. language: list[str]
  436. translation: Optional[str] = None
  437. class WebSearchConfig(BaseModel):
  438. enabled: bool
  439. engine: Optional[str] = None
  440. searxng_query_url: Optional[str] = None
  441. google_pse_api_key: Optional[str] = None
  442. google_pse_engine_id: Optional[str] = None
  443. brave_search_api_key: Optional[str] = None
  444. mojeek_search_api_key: Optional[str] = None
  445. serpstack_api_key: Optional[str] = None
  446. serpstack_https: Optional[bool] = None
  447. serper_api_key: Optional[str] = None
  448. serply_api_key: Optional[str] = None
  449. tavily_api_key: Optional[str] = None
  450. searchapi_api_key: Optional[str] = None
  451. searchapi_engine: Optional[str] = None
  452. jina_api_key: Optional[str] = None
  453. bing_search_v7_endpoint: Optional[str] = None
  454. bing_search_v7_subscription_key: Optional[str] = None
  455. result_count: Optional[int] = None
  456. concurrent_requests: Optional[int] = None
  457. class WebConfig(BaseModel):
  458. search: WebSearchConfig
  459. web_loader_ssl_verification: Optional[bool] = None
  460. class ConfigUpdateForm(BaseModel):
  461. pdf_extract_images: Optional[bool] = None
  462. file: Optional[FileConfig] = None
  463. content_extraction: Optional[ContentExtractionConfig] = None
  464. chunk: Optional[ChunkParamUpdateForm] = None
  465. youtube: Optional[YoutubeLoaderConfig] = None
  466. web: Optional[WebConfig] = None
  467. @app.post("/config/update")
  468. async def update_rag_config(form_data: ConfigUpdateForm, user=Depends(get_admin_user)):
  469. app.state.config.PDF_EXTRACT_IMAGES = (
  470. form_data.pdf_extract_images
  471. if form_data.pdf_extract_images is not None
  472. else app.state.config.PDF_EXTRACT_IMAGES
  473. )
  474. if form_data.file is not None:
  475. app.state.config.FILE_MAX_SIZE = form_data.file.max_size
  476. app.state.config.FILE_MAX_COUNT = form_data.file.max_count
  477. if form_data.content_extraction is not None:
  478. log.info(f"Updating text settings: {form_data.content_extraction}")
  479. app.state.config.CONTENT_EXTRACTION_ENGINE = form_data.content_extraction.engine
  480. app.state.config.TIKA_SERVER_URL = form_data.content_extraction.tika_server_url
  481. if form_data.chunk is not None:
  482. app.state.config.TEXT_SPLITTER = form_data.chunk.text_splitter
  483. app.state.config.CHUNK_SIZE = form_data.chunk.chunk_size
  484. app.state.config.CHUNK_OVERLAP = form_data.chunk.chunk_overlap
  485. if form_data.youtube is not None:
  486. app.state.config.YOUTUBE_LOADER_LANGUAGE = form_data.youtube.language
  487. app.state.YOUTUBE_LOADER_TRANSLATION = form_data.youtube.translation
  488. if form_data.web is not None:
  489. app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION = (
  490. # Note: When UI "Bypass SSL verification for Websites"=True then ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION=False
  491. form_data.web.web_loader_ssl_verification
  492. )
  493. app.state.config.ENABLE_RAG_WEB_SEARCH = form_data.web.search.enabled
  494. app.state.config.RAG_WEB_SEARCH_ENGINE = form_data.web.search.engine
  495. app.state.config.SEARXNG_QUERY_URL = form_data.web.search.searxng_query_url
  496. app.state.config.GOOGLE_PSE_API_KEY = form_data.web.search.google_pse_api_key
  497. app.state.config.GOOGLE_PSE_ENGINE_ID = (
  498. form_data.web.search.google_pse_engine_id
  499. )
  500. app.state.config.BRAVE_SEARCH_API_KEY = (
  501. form_data.web.search.brave_search_api_key
  502. )
  503. app.state.config.MOJEEK_SEARCH_API_KEY = (
  504. form_data.web.search.mojeek_search_api_key
  505. )
  506. app.state.config.SERPSTACK_API_KEY = form_data.web.search.serpstack_api_key
  507. app.state.config.SERPSTACK_HTTPS = form_data.web.search.serpstack_https
  508. app.state.config.SERPER_API_KEY = form_data.web.search.serper_api_key
  509. app.state.config.SERPLY_API_KEY = form_data.web.search.serply_api_key
  510. app.state.config.TAVILY_API_KEY = form_data.web.search.tavily_api_key
  511. app.state.config.SEARCHAPI_API_KEY = form_data.web.search.searchapi_api_key
  512. app.state.config.SEARCHAPI_ENGINE = form_data.web.search.searchapi_engine
  513. app.state.config.JINA_API_KEY = form_data.web.search.jina_api_key
  514. app.state.config.BING_SEARCH_V7_ENDPOINT = (
  515. form_data.web.search.bing_search_v7_endpoint
  516. )
  517. app.state.config.BING_SEARCH_V7_SUBSCRIPTION_KEY = (
  518. form_data.web.search.bing_search_v7_subscription_key
  519. )
  520. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT = form_data.web.search.result_count
  521. app.state.config.RAG_WEB_SEARCH_CONCURRENT_REQUESTS = (
  522. form_data.web.search.concurrent_requests
  523. )
  524. return {
  525. "status": True,
  526. "pdf_extract_images": app.state.config.PDF_EXTRACT_IMAGES,
  527. "file": {
  528. "max_size": app.state.config.FILE_MAX_SIZE,
  529. "max_count": app.state.config.FILE_MAX_COUNT,
  530. },
  531. "content_extraction": {
  532. "engine": app.state.config.CONTENT_EXTRACTION_ENGINE,
  533. "tika_server_url": app.state.config.TIKA_SERVER_URL,
  534. },
  535. "chunk": {
  536. "text_splitter": app.state.config.TEXT_SPLITTER,
  537. "chunk_size": app.state.config.CHUNK_SIZE,
  538. "chunk_overlap": app.state.config.CHUNK_OVERLAP,
  539. },
  540. "youtube": {
  541. "language": app.state.config.YOUTUBE_LOADER_LANGUAGE,
  542. "translation": app.state.YOUTUBE_LOADER_TRANSLATION,
  543. },
  544. "web": {
  545. "web_loader_ssl_verification": app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION,
  546. "search": {
  547. "enabled": app.state.config.ENABLE_RAG_WEB_SEARCH,
  548. "engine": app.state.config.RAG_WEB_SEARCH_ENGINE,
  549. "searxng_query_url": app.state.config.SEARXNG_QUERY_URL,
  550. "google_pse_api_key": app.state.config.GOOGLE_PSE_API_KEY,
  551. "google_pse_engine_id": app.state.config.GOOGLE_PSE_ENGINE_ID,
  552. "brave_search_api_key": app.state.config.BRAVE_SEARCH_API_KEY,
  553. "mojeek_search_api_key": app.state.config.MOJEEK_SEARCH_API_KEY,
  554. "serpstack_api_key": app.state.config.SERPSTACK_API_KEY,
  555. "serpstack_https": app.state.config.SERPSTACK_HTTPS,
  556. "serper_api_key": app.state.config.SERPER_API_KEY,
  557. "serply_api_key": app.state.config.SERPLY_API_KEY,
  558. "serachapi_api_key": app.state.config.SEARCHAPI_API_KEY,
  559. "searchapi_engine": app.state.config.SEARCHAPI_ENGINE,
  560. "tavily_api_key": app.state.config.TAVILY_API_KEY,
  561. "jina_api_key": app.state.config.JINA_API_KEY,
  562. "bing_search_v7_endpoint": app.state.config.BING_SEARCH_V7_ENDPOINT,
  563. "bing_search_v7_subscription_key": app.state.config.BING_SEARCH_V7_SUBSCRIPTION_KEY,
  564. "result_count": app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  565. "concurrent_requests": app.state.config.RAG_WEB_SEARCH_CONCURRENT_REQUESTS,
  566. },
  567. },
  568. }
  569. @app.get("/template")
  570. async def get_rag_template(user=Depends(get_verified_user)):
  571. return {
  572. "status": True,
  573. "template": app.state.config.RAG_TEMPLATE,
  574. }
  575. @app.get("/query/settings")
  576. async def get_query_settings(user=Depends(get_admin_user)):
  577. return {
  578. "status": True,
  579. "template": app.state.config.RAG_TEMPLATE,
  580. "k": app.state.config.TOP_K,
  581. "r": app.state.config.RELEVANCE_THRESHOLD,
  582. "hybrid": app.state.config.ENABLE_RAG_HYBRID_SEARCH,
  583. }
  584. class QuerySettingsForm(BaseModel):
  585. k: Optional[int] = None
  586. r: Optional[float] = None
  587. template: Optional[str] = None
  588. hybrid: Optional[bool] = None
  589. @app.post("/query/settings/update")
  590. async def update_query_settings(
  591. form_data: QuerySettingsForm, user=Depends(get_admin_user)
  592. ):
  593. app.state.config.RAG_TEMPLATE = form_data.template
  594. app.state.config.TOP_K = form_data.k if form_data.k else 4
  595. app.state.config.RELEVANCE_THRESHOLD = form_data.r if form_data.r else 0.0
  596. app.state.config.ENABLE_RAG_HYBRID_SEARCH = (
  597. form_data.hybrid if form_data.hybrid else False
  598. )
  599. return {
  600. "status": True,
  601. "template": app.state.config.RAG_TEMPLATE,
  602. "k": app.state.config.TOP_K,
  603. "r": app.state.config.RELEVANCE_THRESHOLD,
  604. "hybrid": app.state.config.ENABLE_RAG_HYBRID_SEARCH,
  605. }
  606. ####################################
  607. #
  608. # Document process and retrieval
  609. #
  610. ####################################
  611. def _get_docs_info(docs: list[Document]) -> str:
  612. docs_info = set()
  613. # Trying to select relevant metadata identifying the document.
  614. for doc in docs:
  615. metadata = getattr(doc, "metadata", {})
  616. doc_name = metadata.get("name", "")
  617. if not doc_name:
  618. doc_name = metadata.get("title", "")
  619. if not doc_name:
  620. doc_name = metadata.get("source", "")
  621. if doc_name:
  622. docs_info.add(doc_name)
  623. return ", ".join(docs_info)
  624. def save_docs_to_vector_db(
  625. docs,
  626. collection_name,
  627. metadata: Optional[dict] = None,
  628. overwrite: bool = False,
  629. split: bool = True,
  630. add: bool = False,
  631. ) -> bool:
  632. log.info(
  633. f"save_docs_to_vector_db: document {_get_docs_info(docs)} {collection_name}"
  634. )
  635. # Check if entries with the same hash (metadata.hash) already exist
  636. if metadata and "hash" in metadata:
  637. result = VECTOR_DB_CLIENT.query(
  638. collection_name=collection_name,
  639. filter={"hash": metadata["hash"]},
  640. )
  641. if result is not None:
  642. existing_doc_ids = result.ids[0]
  643. if existing_doc_ids:
  644. log.info(f"Document with hash {metadata['hash']} already exists")
  645. raise ValueError(ERROR_MESSAGES.DUPLICATE_CONTENT)
  646. if split:
  647. if app.state.config.TEXT_SPLITTER in ["", "character"]:
  648. text_splitter = RecursiveCharacterTextSplitter(
  649. chunk_size=app.state.config.CHUNK_SIZE,
  650. chunk_overlap=app.state.config.CHUNK_OVERLAP,
  651. add_start_index=True,
  652. )
  653. elif app.state.config.TEXT_SPLITTER == "token":
  654. log.info(
  655. f"Using token text splitter: {app.state.config.TIKTOKEN_ENCODING_NAME}"
  656. )
  657. tiktoken.get_encoding(str(app.state.config.TIKTOKEN_ENCODING_NAME))
  658. text_splitter = TokenTextSplitter(
  659. encoding_name=str(app.state.config.TIKTOKEN_ENCODING_NAME),
  660. chunk_size=app.state.config.CHUNK_SIZE,
  661. chunk_overlap=app.state.config.CHUNK_OVERLAP,
  662. add_start_index=True,
  663. )
  664. else:
  665. raise ValueError(ERROR_MESSAGES.DEFAULT("Invalid text splitter"))
  666. docs = text_splitter.split_documents(docs)
  667. if len(docs) == 0:
  668. raise ValueError(ERROR_MESSAGES.EMPTY_CONTENT)
  669. texts = [doc.page_content for doc in docs]
  670. metadatas = [
  671. {
  672. **doc.metadata,
  673. **(metadata if metadata else {}),
  674. "embedding_config": json.dumps(
  675. {
  676. "engine": app.state.config.RAG_EMBEDDING_ENGINE,
  677. "model": app.state.config.RAG_EMBEDDING_MODEL,
  678. }
  679. ),
  680. }
  681. for doc in docs
  682. ]
  683. # ChromaDB does not like datetime formats
  684. # for meta-data so convert them to string.
  685. for metadata in metadatas:
  686. for key, value in metadata.items():
  687. if isinstance(value, datetime):
  688. metadata[key] = str(value)
  689. try:
  690. if VECTOR_DB_CLIENT.has_collection(collection_name=collection_name):
  691. log.info(f"collection {collection_name} already exists")
  692. if overwrite:
  693. VECTOR_DB_CLIENT.delete_collection(collection_name=collection_name)
  694. log.info(f"deleting existing collection {collection_name}")
  695. elif add is False:
  696. log.info(
  697. f"collection {collection_name} already exists, overwrite is False and add is False"
  698. )
  699. return True
  700. log.info(f"adding to collection {collection_name}")
  701. embedding_function = get_embedding_function(
  702. app.state.config.RAG_EMBEDDING_ENGINE,
  703. app.state.config.RAG_EMBEDDING_MODEL,
  704. app.state.sentence_transformer_ef,
  705. (
  706. app.state.config.OPENAI_API_BASE_URL
  707. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  708. else app.state.config.OLLAMA_BASE_URL
  709. ),
  710. (
  711. app.state.config.OPENAI_API_KEY
  712. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  713. else app.state.config.OLLAMA_API_KEY
  714. ),
  715. app.state.config.RAG_EMBEDDING_BATCH_SIZE,
  716. )
  717. embeddings = embedding_function(
  718. list(map(lambda x: x.replace("\n", " "), texts))
  719. )
  720. items = [
  721. {
  722. "id": str(uuid.uuid4()),
  723. "text": text,
  724. "vector": embeddings[idx],
  725. "metadata": metadatas[idx],
  726. }
  727. for idx, text in enumerate(texts)
  728. ]
  729. VECTOR_DB_CLIENT.insert(
  730. collection_name=collection_name,
  731. items=items,
  732. )
  733. return True
  734. except Exception as e:
  735. log.exception(e)
  736. return False
  737. class ProcessFileForm(BaseModel):
  738. file_id: str
  739. content: Optional[str] = None
  740. collection_name: Optional[str] = None
  741. @app.post("/process/file")
  742. def process_file(
  743. form_data: ProcessFileForm,
  744. user=Depends(get_verified_user),
  745. ):
  746. try:
  747. file = Files.get_file_by_id(form_data.file_id)
  748. collection_name = form_data.collection_name
  749. if collection_name is None:
  750. collection_name = f"file-{file.id}"
  751. if form_data.content:
  752. # Update the content in the file
  753. # Usage: /files/{file_id}/data/content/update
  754. VECTOR_DB_CLIENT.delete(collection_name=f"file-{file.id}")
  755. docs = [
  756. Document(
  757. page_content=form_data.content,
  758. metadata={
  759. **file.meta,
  760. "name": file.filename,
  761. "created_by": file.user_id,
  762. "file_id": file.id,
  763. "source": file.filename,
  764. },
  765. )
  766. ]
  767. text_content = form_data.content
  768. elif form_data.collection_name:
  769. # Check if the file has already been processed and save the content
  770. # Usage: /knowledge/{id}/file/add, /knowledge/{id}/file/update
  771. result = VECTOR_DB_CLIENT.query(
  772. collection_name=f"file-{file.id}", filter={"file_id": file.id}
  773. )
  774. if result is not None and len(result.ids[0]) > 0:
  775. docs = [
  776. Document(
  777. page_content=result.documents[0][idx],
  778. metadata=result.metadatas[0][idx],
  779. )
  780. for idx, id in enumerate(result.ids[0])
  781. ]
  782. else:
  783. docs = [
  784. Document(
  785. page_content=file.data.get("content", ""),
  786. metadata={
  787. **file.meta,
  788. "name": file.filename,
  789. "created_by": file.user_id,
  790. "file_id": file.id,
  791. "source": file.filename,
  792. },
  793. )
  794. ]
  795. text_content = file.data.get("content", "")
  796. else:
  797. # Process the file and save the content
  798. # Usage: /files/
  799. file_path = file.path
  800. if file_path:
  801. file_path = Storage.get_file(file_path)
  802. loader = Loader(
  803. engine=app.state.config.CONTENT_EXTRACTION_ENGINE,
  804. TIKA_SERVER_URL=app.state.config.TIKA_SERVER_URL,
  805. PDF_EXTRACT_IMAGES=app.state.config.PDF_EXTRACT_IMAGES,
  806. )
  807. docs = loader.load(
  808. file.filename, file.meta.get("content_type"), file_path
  809. )
  810. docs = [
  811. Document(
  812. page_content=doc.page_content,
  813. metadata={
  814. **doc.metadata,
  815. "name": file.filename,
  816. "created_by": file.user_id,
  817. "file_id": file.id,
  818. "source": file.filename,
  819. },
  820. )
  821. for doc in docs
  822. ]
  823. else:
  824. docs = [
  825. Document(
  826. page_content=file.data.get("content", ""),
  827. metadata={
  828. **file.meta,
  829. "name": file.filename,
  830. "created_by": file.user_id,
  831. "file_id": file.id,
  832. "source": file.filename,
  833. },
  834. )
  835. ]
  836. text_content = " ".join([doc.page_content for doc in docs])
  837. log.debug(f"text_content: {text_content}")
  838. Files.update_file_data_by_id(
  839. file.id,
  840. {"content": text_content},
  841. )
  842. hash = calculate_sha256_string(text_content)
  843. Files.update_file_hash_by_id(file.id, hash)
  844. try:
  845. result = save_docs_to_vector_db(
  846. docs=docs,
  847. collection_name=collection_name,
  848. metadata={
  849. "file_id": file.id,
  850. "name": file.filename,
  851. "hash": hash,
  852. },
  853. add=(True if form_data.collection_name else False),
  854. )
  855. if result:
  856. Files.update_file_metadata_by_id(
  857. file.id,
  858. {
  859. "collection_name": collection_name,
  860. },
  861. )
  862. return {
  863. "status": True,
  864. "collection_name": collection_name,
  865. "filename": file.meta.get("name", file.filename),
  866. "content": text_content,
  867. }
  868. except Exception as e:
  869. raise e
  870. except Exception as e:
  871. log.exception(e)
  872. if "No pandoc was found" in str(e):
  873. raise HTTPException(
  874. status_code=status.HTTP_400_BAD_REQUEST,
  875. detail=ERROR_MESSAGES.PANDOC_NOT_INSTALLED,
  876. )
  877. else:
  878. raise HTTPException(
  879. status_code=status.HTTP_400_BAD_REQUEST,
  880. detail=str(e),
  881. )
  882. class ProcessTextForm(BaseModel):
  883. name: str
  884. content: str
  885. collection_name: Optional[str] = None
  886. @app.post("/process/text")
  887. def process_text(
  888. form_data: ProcessTextForm,
  889. user=Depends(get_verified_user),
  890. ):
  891. collection_name = form_data.collection_name
  892. if collection_name is None:
  893. collection_name = calculate_sha256_string(form_data.content)
  894. docs = [
  895. Document(
  896. page_content=form_data.content,
  897. metadata={"name": form_data.name, "created_by": user.id},
  898. )
  899. ]
  900. text_content = form_data.content
  901. log.debug(f"text_content: {text_content}")
  902. result = save_docs_to_vector_db(docs, collection_name)
  903. if result:
  904. return {
  905. "status": True,
  906. "collection_name": collection_name,
  907. "content": text_content,
  908. }
  909. else:
  910. raise HTTPException(
  911. status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
  912. detail=ERROR_MESSAGES.DEFAULT(),
  913. )
  914. @app.post("/process/youtube")
  915. def process_youtube_video(form_data: ProcessUrlForm, user=Depends(get_verified_user)):
  916. try:
  917. collection_name = form_data.collection_name
  918. if not collection_name:
  919. collection_name = calculate_sha256_string(form_data.url)[:63]
  920. loader = YoutubeLoader(
  921. form_data.url, language=app.state.config.YOUTUBE_LOADER_LANGUAGE
  922. )
  923. docs = loader.load()
  924. content = " ".join([doc.page_content for doc in docs])
  925. log.debug(f"text_content: {content}")
  926. save_docs_to_vector_db(docs, collection_name, overwrite=True)
  927. return {
  928. "status": True,
  929. "collection_name": collection_name,
  930. "filename": form_data.url,
  931. "file": {
  932. "data": {
  933. "content": content,
  934. },
  935. "meta": {
  936. "name": form_data.url,
  937. },
  938. },
  939. }
  940. except Exception as e:
  941. log.exception(e)
  942. raise HTTPException(
  943. status_code=status.HTTP_400_BAD_REQUEST,
  944. detail=ERROR_MESSAGES.DEFAULT(e),
  945. )
  946. @app.post("/process/web")
  947. def process_web(form_data: ProcessUrlForm, user=Depends(get_verified_user)):
  948. try:
  949. collection_name = form_data.collection_name
  950. if not collection_name:
  951. collection_name = calculate_sha256_string(form_data.url)[:63]
  952. loader = get_web_loader(
  953. form_data.url,
  954. verify_ssl=app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION,
  955. requests_per_second=app.state.config.RAG_WEB_SEARCH_CONCURRENT_REQUESTS,
  956. )
  957. docs = loader.load()
  958. content = " ".join([doc.page_content for doc in docs])
  959. log.debug(f"text_content: {content}")
  960. save_docs_to_vector_db(docs, collection_name, overwrite=True)
  961. return {
  962. "status": True,
  963. "collection_name": collection_name,
  964. "filename": form_data.url,
  965. "file": {
  966. "data": {
  967. "content": content,
  968. },
  969. "meta": {
  970. "name": form_data.url,
  971. },
  972. },
  973. }
  974. except Exception as e:
  975. log.exception(e)
  976. raise HTTPException(
  977. status_code=status.HTTP_400_BAD_REQUEST,
  978. detail=ERROR_MESSAGES.DEFAULT(e),
  979. )
  980. def search_web(engine: str, query: str) -> list[SearchResult]:
  981. """Search the web using a search engine and return the results as a list of SearchResult objects.
  982. Will look for a search engine API key in environment variables in the following order:
  983. - SEARXNG_QUERY_URL
  984. - GOOGLE_PSE_API_KEY + GOOGLE_PSE_ENGINE_ID
  985. - BRAVE_SEARCH_API_KEY
  986. - MOJEEK_SEARCH_API_KEY
  987. - SERPSTACK_API_KEY
  988. - SERPER_API_KEY
  989. - SERPLY_API_KEY
  990. - TAVILY_API_KEY
  991. - SEARCHAPI_API_KEY + SEARCHAPI_ENGINE (by default `google`)
  992. Args:
  993. query (str): The query to search for
  994. """
  995. # TODO: add playwright to search the web
  996. if engine == "searxng":
  997. if app.state.config.SEARXNG_QUERY_URL:
  998. return search_searxng(
  999. app.state.config.SEARXNG_QUERY_URL,
  1000. query,
  1001. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1002. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  1003. )
  1004. else:
  1005. raise Exception("No SEARXNG_QUERY_URL found in environment variables")
  1006. elif engine == "google_pse":
  1007. if (
  1008. app.state.config.GOOGLE_PSE_API_KEY
  1009. and app.state.config.GOOGLE_PSE_ENGINE_ID
  1010. ):
  1011. return search_google_pse(
  1012. app.state.config.GOOGLE_PSE_API_KEY,
  1013. app.state.config.GOOGLE_PSE_ENGINE_ID,
  1014. query,
  1015. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1016. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  1017. )
  1018. else:
  1019. raise Exception(
  1020. "No GOOGLE_PSE_API_KEY or GOOGLE_PSE_ENGINE_ID found in environment variables"
  1021. )
  1022. elif engine == "brave":
  1023. if app.state.config.BRAVE_SEARCH_API_KEY:
  1024. return search_brave(
  1025. app.state.config.BRAVE_SEARCH_API_KEY,
  1026. query,
  1027. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1028. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  1029. )
  1030. else:
  1031. raise Exception("No BRAVE_SEARCH_API_KEY found in environment variables")
  1032. elif engine == "mojeek":
  1033. if app.state.config.MOJEEK_SEARCH_API_KEY:
  1034. return search_mojeek(
  1035. app.state.config.MOJEEK_SEARCH_API_KEY,
  1036. query,
  1037. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1038. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  1039. )
  1040. else:
  1041. raise Exception("No MOJEEK_SEARCH_API_KEY found in environment variables")
  1042. elif engine == "serpstack":
  1043. if app.state.config.SERPSTACK_API_KEY:
  1044. return search_serpstack(
  1045. app.state.config.SERPSTACK_API_KEY,
  1046. query,
  1047. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1048. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  1049. https_enabled=app.state.config.SERPSTACK_HTTPS,
  1050. )
  1051. else:
  1052. raise Exception("No SERPSTACK_API_KEY found in environment variables")
  1053. elif engine == "serper":
  1054. if app.state.config.SERPER_API_KEY:
  1055. return search_serper(
  1056. app.state.config.SERPER_API_KEY,
  1057. query,
  1058. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1059. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  1060. )
  1061. else:
  1062. raise Exception("No SERPER_API_KEY found in environment variables")
  1063. elif engine == "serply":
  1064. if app.state.config.SERPLY_API_KEY:
  1065. return search_serply(
  1066. app.state.config.SERPLY_API_KEY,
  1067. query,
  1068. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1069. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  1070. )
  1071. else:
  1072. raise Exception("No SERPLY_API_KEY found in environment variables")
  1073. elif engine == "duckduckgo":
  1074. return search_duckduckgo(
  1075. query,
  1076. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1077. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  1078. )
  1079. elif engine == "tavily":
  1080. if app.state.config.TAVILY_API_KEY:
  1081. return search_tavily(
  1082. app.state.config.TAVILY_API_KEY,
  1083. query,
  1084. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1085. )
  1086. else:
  1087. raise Exception("No TAVILY_API_KEY found in environment variables")
  1088. elif engine == "searchapi":
  1089. if app.state.config.SEARCHAPI_API_KEY:
  1090. return search_searchapi(
  1091. app.state.config.SEARCHAPI_API_KEY,
  1092. app.state.config.SEARCHAPI_ENGINE,
  1093. query,
  1094. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1095. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  1096. )
  1097. else:
  1098. raise Exception("No SEARCHAPI_API_KEY found in environment variables")
  1099. elif engine == "jina":
  1100. return search_jina(
  1101. app.state.config.JINA_API_KEY,
  1102. query,
  1103. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1104. )
  1105. elif engine == "bing":
  1106. return search_bing(
  1107. app.state.config.BING_SEARCH_V7_SUBSCRIPTION_KEY,
  1108. app.state.config.BING_SEARCH_V7_ENDPOINT,
  1109. str(DEFAULT_LOCALE),
  1110. query,
  1111. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1112. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  1113. )
  1114. else:
  1115. raise Exception("No search engine API key found in environment variables")
  1116. @app.post("/process/web/search")
  1117. def process_web_search(form_data: SearchForm, user=Depends(get_verified_user)):
  1118. try:
  1119. logging.info(
  1120. f"trying to web search with {app.state.config.RAG_WEB_SEARCH_ENGINE, form_data.query}"
  1121. )
  1122. web_results = search_web(
  1123. app.state.config.RAG_WEB_SEARCH_ENGINE, form_data.query
  1124. )
  1125. except Exception as e:
  1126. log.exception(e)
  1127. print(e)
  1128. raise HTTPException(
  1129. status_code=status.HTTP_400_BAD_REQUEST,
  1130. detail=ERROR_MESSAGES.WEB_SEARCH_ERROR(e),
  1131. )
  1132. try:
  1133. collection_name = form_data.collection_name
  1134. if collection_name == "":
  1135. collection_name = calculate_sha256_string(form_data.query)[:63]
  1136. urls = [result.link for result in web_results]
  1137. loader = get_web_loader(
  1138. urls,
  1139. verify_ssl=app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION,
  1140. requests_per_second=app.state.config.RAG_WEB_SEARCH_CONCURRENT_REQUESTS,
  1141. )
  1142. docs = loader.aload()
  1143. save_docs_to_vector_db(docs, collection_name, overwrite=True)
  1144. return {
  1145. "status": True,
  1146. "collection_name": collection_name,
  1147. "filenames": urls,
  1148. }
  1149. except Exception as e:
  1150. log.exception(e)
  1151. raise HTTPException(
  1152. status_code=status.HTTP_400_BAD_REQUEST,
  1153. detail=ERROR_MESSAGES.DEFAULT(e),
  1154. )
  1155. class QueryDocForm(BaseModel):
  1156. collection_name: str
  1157. query: str
  1158. k: Optional[int] = None
  1159. r: Optional[float] = None
  1160. hybrid: Optional[bool] = None
  1161. @app.post("/query/doc")
  1162. def query_doc_handler(
  1163. form_data: QueryDocForm,
  1164. user=Depends(get_verified_user),
  1165. ):
  1166. try:
  1167. if app.state.config.ENABLE_RAG_HYBRID_SEARCH:
  1168. return query_doc_with_hybrid_search(
  1169. collection_name=form_data.collection_name,
  1170. query=form_data.query,
  1171. embedding_function=app.state.EMBEDDING_FUNCTION,
  1172. k=form_data.k if form_data.k else app.state.config.TOP_K,
  1173. reranking_function=app.state.sentence_transformer_rf,
  1174. r=(
  1175. form_data.r if form_data.r else app.state.config.RELEVANCE_THRESHOLD
  1176. ),
  1177. )
  1178. else:
  1179. return query_doc(
  1180. collection_name=form_data.collection_name,
  1181. query=form_data.query,
  1182. embedding_function=app.state.EMBEDDING_FUNCTION,
  1183. k=form_data.k if form_data.k else app.state.config.TOP_K,
  1184. )
  1185. except Exception as e:
  1186. log.exception(e)
  1187. raise HTTPException(
  1188. status_code=status.HTTP_400_BAD_REQUEST,
  1189. detail=ERROR_MESSAGES.DEFAULT(e),
  1190. )
  1191. class QueryCollectionsForm(BaseModel):
  1192. collection_names: list[str]
  1193. query: str
  1194. k: Optional[int] = None
  1195. r: Optional[float] = None
  1196. hybrid: Optional[bool] = None
  1197. @app.post("/query/collection")
  1198. def query_collection_handler(
  1199. form_data: QueryCollectionsForm,
  1200. user=Depends(get_verified_user),
  1201. ):
  1202. try:
  1203. if app.state.config.ENABLE_RAG_HYBRID_SEARCH:
  1204. return query_collection_with_hybrid_search(
  1205. collection_names=form_data.collection_names,
  1206. query=form_data.query,
  1207. embedding_function=app.state.EMBEDDING_FUNCTION,
  1208. k=form_data.k if form_data.k else app.state.config.TOP_K,
  1209. reranking_function=app.state.sentence_transformer_rf,
  1210. r=(
  1211. form_data.r if form_data.r else app.state.config.RELEVANCE_THRESHOLD
  1212. ),
  1213. )
  1214. else:
  1215. return query_collection(
  1216. collection_names=form_data.collection_names,
  1217. query=form_data.query,
  1218. embedding_function=app.state.EMBEDDING_FUNCTION,
  1219. k=form_data.k if form_data.k else app.state.config.TOP_K,
  1220. )
  1221. except Exception as e:
  1222. log.exception(e)
  1223. raise HTTPException(
  1224. status_code=status.HTTP_400_BAD_REQUEST,
  1225. detail=ERROR_MESSAGES.DEFAULT(e),
  1226. )
  1227. ####################################
  1228. #
  1229. # Vector DB operations
  1230. #
  1231. ####################################
  1232. class DeleteForm(BaseModel):
  1233. collection_name: str
  1234. file_id: str
  1235. @app.post("/delete")
  1236. def delete_entries_from_collection(form_data: DeleteForm, user=Depends(get_admin_user)):
  1237. try:
  1238. if VECTOR_DB_CLIENT.has_collection(collection_name=form_data.collection_name):
  1239. file = Files.get_file_by_id(form_data.file_id)
  1240. hash = file.hash
  1241. VECTOR_DB_CLIENT.delete(
  1242. collection_name=form_data.collection_name,
  1243. metadata={"hash": hash},
  1244. )
  1245. return {"status": True}
  1246. else:
  1247. return {"status": False}
  1248. except Exception as e:
  1249. log.exception(e)
  1250. return {"status": False}
  1251. @app.post("/reset/db")
  1252. def reset_vector_db(user=Depends(get_admin_user)):
  1253. VECTOR_DB_CLIENT.reset()
  1254. Knowledges.delete_all_knowledge()
  1255. @app.post("/reset/uploads")
  1256. def reset_upload_dir(user=Depends(get_admin_user)) -> bool:
  1257. folder = f"{UPLOAD_DIR}"
  1258. try:
  1259. # Check if the directory exists
  1260. if os.path.exists(folder):
  1261. # Iterate over all the files and directories in the specified directory
  1262. for filename in os.listdir(folder):
  1263. file_path = os.path.join(folder, filename)
  1264. try:
  1265. if os.path.isfile(file_path) or os.path.islink(file_path):
  1266. os.unlink(file_path) # Remove the file or link
  1267. elif os.path.isdir(file_path):
  1268. shutil.rmtree(file_path) # Remove the directory
  1269. except Exception as e:
  1270. print(f"Failed to delete {file_path}. Reason: {e}")
  1271. else:
  1272. print(f"The directory {folder} does not exist")
  1273. except Exception as e:
  1274. print(f"Failed to process the directory {folder}. Reason: {e}")
  1275. return True
  1276. if ENV == "dev":
  1277. @app.get("/ef")
  1278. async def get_embeddings():
  1279. return {"result": app.state.EMBEDDING_FUNCTION("hello world")}
  1280. @app.get("/ef/{text}")
  1281. async def get_embeddings_text(text: str):
  1282. return {"result": app.state.EMBEDDING_FUNCTION(text)}