retrieval.py 95 KB

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