retrieval.py 58 KB

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