retrieval.py 71 KB

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