retrieval.py 85 KB

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