retrieval.py 76 KB

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