retrieval.py 55 KB

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