retrieval.py 73 KB

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