retrieval.py 105 KB

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