retrieval.py 77 KB

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