retrieval.py 56 KB

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