retrieval.py 72 KB

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