1
0

retrieval.py 96 KB

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