retrieval.py 59 KB

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