retrieval.py 91 KB

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