retrieval.py 57 KB

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