retrieval.py 74 KB

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