retrieval.py 93 KB

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