main.py 55 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598
  1. # TODO: Merge this with the webui_app and make it a single app
  2. import json
  3. import logging
  4. import os
  5. import shutil
  6. import uuid
  7. from datetime import datetime
  8. from typing import List, Optional
  9. from fastapi import Depends, FastAPI, HTTPException, status
  10. from fastapi.middleware.cors import CORSMiddleware
  11. from pydantic import BaseModel
  12. import tiktoken
  13. from open_webui.storage.provider import Storage
  14. from open_webui.apps.webui.models.knowledge import Knowledges
  15. from open_webui.apps.retrieval.vector.connector import VECTOR_DB_CLIENT
  16. # Document loaders
  17. from open_webui.apps.retrieval.loaders.main import Loader
  18. from open_webui.apps.retrieval.loaders.youtube import YoutubeLoader
  19. # Web search engines
  20. from open_webui.apps.retrieval.web.main import SearchResult
  21. from open_webui.apps.retrieval.web.utils import get_web_loader
  22. from open_webui.apps.retrieval.web.brave import search_brave
  23. from open_webui.apps.retrieval.web.kagi import search_kagi
  24. from open_webui.apps.retrieval.web.mojeek import search_mojeek
  25. from open_webui.apps.retrieval.web.duckduckgo import search_duckduckgo
  26. from open_webui.apps.retrieval.web.google_pse import search_google_pse
  27. from open_webui.apps.retrieval.web.jina_search import search_jina
  28. from open_webui.apps.retrieval.web.searchapi import search_searchapi
  29. from open_webui.apps.retrieval.web.searxng import search_searxng
  30. from open_webui.apps.retrieval.web.serper import search_serper
  31. from open_webui.apps.retrieval.web.serply import search_serply
  32. from open_webui.apps.retrieval.web.serpstack import search_serpstack
  33. from open_webui.apps.retrieval.web.tavily import search_tavily
  34. from open_webui.apps.retrieval.web.bing import search_bing
  35. from open_webui.apps.retrieval.utils import (
  36. get_embedding_function,
  37. get_model_path,
  38. query_collection,
  39. query_collection_with_hybrid_search,
  40. query_doc,
  41. query_doc_with_hybrid_search,
  42. )
  43. from open_webui.apps.webui.models.files import FileModel, Files
  44. from open_webui.config import (
  45. BRAVE_SEARCH_API_KEY,
  46. KAGI_SEARCH_API_KEY,
  47. MOJEEK_SEARCH_API_KEY,
  48. TIKTOKEN_ENCODING_NAME,
  49. RAG_TEXT_SPLITTER,
  50. CHUNK_OVERLAP,
  51. CHUNK_SIZE,
  52. CONTENT_EXTRACTION_ENGINE,
  53. CORS_ALLOW_ORIGIN,
  54. ENABLE_RAG_HYBRID_SEARCH,
  55. ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION,
  56. ENABLE_RAG_WEB_SEARCH,
  57. ENV,
  58. GOOGLE_PSE_API_KEY,
  59. GOOGLE_PSE_ENGINE_ID,
  60. PDF_EXTRACT_IMAGES,
  61. RAG_EMBEDDING_ENGINE,
  62. RAG_EMBEDDING_MODEL,
  63. RAG_EMBEDDING_MODEL_AUTO_UPDATE,
  64. RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE,
  65. RAG_EMBEDDING_BATCH_SIZE,
  66. RAG_FILE_MAX_COUNT,
  67. RAG_FILE_MAX_SIZE,
  68. RAG_OPENAI_API_BASE_URL,
  69. RAG_OPENAI_API_KEY,
  70. RAG_OLLAMA_BASE_URL,
  71. RAG_OLLAMA_API_KEY,
  72. RAG_RELEVANCE_THRESHOLD,
  73. RAG_RERANKING_MODEL,
  74. RAG_RERANKING_MODEL_AUTO_UPDATE,
  75. RAG_RERANKING_MODEL_TRUST_REMOTE_CODE,
  76. RAG_TEMPLATE,
  77. RAG_TOP_K,
  78. RAG_WEB_SEARCH_CONCURRENT_REQUESTS,
  79. RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  80. RAG_WEB_SEARCH_ENGINE,
  81. RAG_WEB_SEARCH_RESULT_COUNT,
  82. JINA_API_KEY,
  83. SEARCHAPI_API_KEY,
  84. SEARCHAPI_ENGINE,
  85. SEARXNG_QUERY_URL,
  86. SERPER_API_KEY,
  87. SERPLY_API_KEY,
  88. SERPSTACK_API_KEY,
  89. SERPSTACK_HTTPS,
  90. TAVILY_API_KEY,
  91. BING_SEARCH_V7_ENDPOINT,
  92. BING_SEARCH_V7_SUBSCRIPTION_KEY,
  93. TIKA_SERVER_URL,
  94. UPLOAD_DIR,
  95. YOUTUBE_LOADER_LANGUAGE,
  96. YOUTUBE_LOADER_PROXY_URL,
  97. DEFAULT_LOCALE,
  98. AppConfig,
  99. )
  100. from open_webui.constants import ERROR_MESSAGES
  101. from open_webui.env import (
  102. SRC_LOG_LEVELS,
  103. DEVICE_TYPE,
  104. DOCKER,
  105. )
  106. from open_webui.utils.misc import (
  107. calculate_sha256_string,
  108. )
  109. from open_webui.utils.auth import get_admin_user, get_verified_user
  110. from langchain.text_splitter import RecursiveCharacterTextSplitter, TokenTextSplitter
  111. from langchain_core.documents import Document
  112. log = logging.getLogger(__name__)
  113. log.setLevel(SRC_LOG_LEVELS["RAG"])
  114. app = FastAPI(
  115. docs_url="/docs" if ENV == "dev" else None,
  116. openapi_url="/openapi.json" if ENV == "dev" else None,
  117. redoc_url=None,
  118. )
  119. app.state.config = AppConfig()
  120. app.state.config.TOP_K = RAG_TOP_K
  121. app.state.config.RELEVANCE_THRESHOLD = RAG_RELEVANCE_THRESHOLD
  122. app.state.config.FILE_MAX_SIZE = RAG_FILE_MAX_SIZE
  123. app.state.config.FILE_MAX_COUNT = RAG_FILE_MAX_COUNT
  124. app.state.config.ENABLE_RAG_HYBRID_SEARCH = ENABLE_RAG_HYBRID_SEARCH
  125. app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION = (
  126. ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION
  127. )
  128. app.state.config.CONTENT_EXTRACTION_ENGINE = CONTENT_EXTRACTION_ENGINE
  129. app.state.config.TIKA_SERVER_URL = TIKA_SERVER_URL
  130. app.state.config.TEXT_SPLITTER = RAG_TEXT_SPLITTER
  131. app.state.config.TIKTOKEN_ENCODING_NAME = TIKTOKEN_ENCODING_NAME
  132. app.state.config.CHUNK_SIZE = CHUNK_SIZE
  133. app.state.config.CHUNK_OVERLAP = CHUNK_OVERLAP
  134. app.state.config.RAG_EMBEDDING_ENGINE = RAG_EMBEDDING_ENGINE
  135. app.state.config.RAG_EMBEDDING_MODEL = RAG_EMBEDDING_MODEL
  136. app.state.config.RAG_EMBEDDING_BATCH_SIZE = RAG_EMBEDDING_BATCH_SIZE
  137. app.state.config.RAG_RERANKING_MODEL = RAG_RERANKING_MODEL
  138. app.state.config.RAG_TEMPLATE = RAG_TEMPLATE
  139. app.state.config.OPENAI_API_BASE_URL = RAG_OPENAI_API_BASE_URL
  140. app.state.config.OPENAI_API_KEY = RAG_OPENAI_API_KEY
  141. app.state.config.OLLAMA_BASE_URL = RAG_OLLAMA_BASE_URL
  142. app.state.config.OLLAMA_API_KEY = RAG_OLLAMA_API_KEY
  143. app.state.config.PDF_EXTRACT_IMAGES = PDF_EXTRACT_IMAGES
  144. app.state.config.YOUTUBE_LOADER_LANGUAGE = YOUTUBE_LOADER_LANGUAGE
  145. app.state.config.YOUTUBE_LOADER_PROXY_URL = YOUTUBE_LOADER_PROXY_URL
  146. app.state.YOUTUBE_LOADER_TRANSLATION = None
  147. app.state.config.ENABLE_RAG_WEB_SEARCH = ENABLE_RAG_WEB_SEARCH
  148. app.state.config.RAG_WEB_SEARCH_ENGINE = RAG_WEB_SEARCH_ENGINE
  149. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST = RAG_WEB_SEARCH_DOMAIN_FILTER_LIST
  150. app.state.config.SEARXNG_QUERY_URL = SEARXNG_QUERY_URL
  151. app.state.config.GOOGLE_PSE_API_KEY = GOOGLE_PSE_API_KEY
  152. app.state.config.GOOGLE_PSE_ENGINE_ID = GOOGLE_PSE_ENGINE_ID
  153. app.state.config.BRAVE_SEARCH_API_KEY = BRAVE_SEARCH_API_KEY
  154. app.state.config.KAGI_SEARCH_API_KEY = KAGI_SEARCH_API_KEY
  155. app.state.config.MOJEEK_SEARCH_API_KEY = MOJEEK_SEARCH_API_KEY
  156. app.state.config.SERPSTACK_API_KEY = SERPSTACK_API_KEY
  157. app.state.config.SERPSTACK_HTTPS = SERPSTACK_HTTPS
  158. app.state.config.SERPER_API_KEY = SERPER_API_KEY
  159. app.state.config.SERPLY_API_KEY = SERPLY_API_KEY
  160. app.state.config.TAVILY_API_KEY = TAVILY_API_KEY
  161. app.state.config.SEARCHAPI_API_KEY = SEARCHAPI_API_KEY
  162. app.state.config.SEARCHAPI_ENGINE = SEARCHAPI_ENGINE
  163. app.state.config.JINA_API_KEY = JINA_API_KEY
  164. app.state.config.BING_SEARCH_V7_ENDPOINT = BING_SEARCH_V7_ENDPOINT
  165. app.state.config.BING_SEARCH_V7_SUBSCRIPTION_KEY = BING_SEARCH_V7_SUBSCRIPTION_KEY
  166. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT = RAG_WEB_SEARCH_RESULT_COUNT
  167. app.state.config.RAG_WEB_SEARCH_CONCURRENT_REQUESTS = RAG_WEB_SEARCH_CONCURRENT_REQUESTS
  168. def update_embedding_model(
  169. embedding_model: str,
  170. auto_update: bool = False,
  171. ):
  172. if embedding_model and app.state.config.RAG_EMBEDDING_ENGINE == "":
  173. from sentence_transformers import SentenceTransformer
  174. try:
  175. app.state.sentence_transformer_ef = SentenceTransformer(
  176. get_model_path(embedding_model, auto_update),
  177. device=DEVICE_TYPE,
  178. trust_remote_code=RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE,
  179. )
  180. except Exception as e:
  181. log.debug(f"Error loading SentenceTransformer: {e}")
  182. app.state.sentence_transformer_ef = None
  183. else:
  184. app.state.sentence_transformer_ef = None
  185. def update_reranking_model(
  186. reranking_model: str,
  187. auto_update: bool = False,
  188. ):
  189. if reranking_model:
  190. if any(model in reranking_model for model in ["jinaai/jina-colbert-v2"]):
  191. try:
  192. from open_webui.apps.retrieval.models.colbert import ColBERT
  193. app.state.sentence_transformer_rf = ColBERT(
  194. get_model_path(reranking_model, auto_update),
  195. env="docker" if DOCKER else None,
  196. )
  197. except Exception as e:
  198. log.error(f"ColBERT: {e}")
  199. app.state.sentence_transformer_rf = None
  200. app.state.config.ENABLE_RAG_HYBRID_SEARCH = False
  201. else:
  202. import sentence_transformers
  203. try:
  204. app.state.sentence_transformer_rf = sentence_transformers.CrossEncoder(
  205. get_model_path(reranking_model, auto_update),
  206. device=DEVICE_TYPE,
  207. trust_remote_code=RAG_RERANKING_MODEL_TRUST_REMOTE_CODE,
  208. )
  209. except:
  210. log.error("CrossEncoder error")
  211. app.state.sentence_transformer_rf = None
  212. app.state.config.ENABLE_RAG_HYBRID_SEARCH = False
  213. else:
  214. app.state.sentence_transformer_rf = None
  215. update_embedding_model(
  216. app.state.config.RAG_EMBEDDING_MODEL,
  217. RAG_EMBEDDING_MODEL_AUTO_UPDATE,
  218. )
  219. update_reranking_model(
  220. app.state.config.RAG_RERANKING_MODEL,
  221. RAG_RERANKING_MODEL_AUTO_UPDATE,
  222. )
  223. app.state.EMBEDDING_FUNCTION = get_embedding_function(
  224. app.state.config.RAG_EMBEDDING_ENGINE,
  225. app.state.config.RAG_EMBEDDING_MODEL,
  226. app.state.sentence_transformer_ef,
  227. (
  228. app.state.config.OPENAI_API_BASE_URL
  229. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  230. else app.state.config.OLLAMA_BASE_URL
  231. ),
  232. (
  233. app.state.config.OPENAI_API_KEY
  234. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  235. else app.state.config.OLLAMA_API_KEY
  236. ),
  237. app.state.config.RAG_EMBEDDING_BATCH_SIZE,
  238. )
  239. app.add_middleware(
  240. CORSMiddleware,
  241. allow_origins=CORS_ALLOW_ORIGIN,
  242. allow_credentials=True,
  243. allow_methods=["*"],
  244. allow_headers=["*"],
  245. )
  246. class CollectionNameForm(BaseModel):
  247. collection_name: Optional[str] = None
  248. class ProcessUrlForm(CollectionNameForm):
  249. url: str
  250. class SearchForm(CollectionNameForm):
  251. query: str
  252. @app.get("/")
  253. async def get_status():
  254. return {
  255. "status": True,
  256. "chunk_size": app.state.config.CHUNK_SIZE,
  257. "chunk_overlap": app.state.config.CHUNK_OVERLAP,
  258. "template": app.state.config.RAG_TEMPLATE,
  259. "embedding_engine": app.state.config.RAG_EMBEDDING_ENGINE,
  260. "embedding_model": app.state.config.RAG_EMBEDDING_MODEL,
  261. "reranking_model": app.state.config.RAG_RERANKING_MODEL,
  262. "embedding_batch_size": app.state.config.RAG_EMBEDDING_BATCH_SIZE,
  263. }
  264. @app.get("/embedding")
  265. async def get_embedding_config(user=Depends(get_admin_user)):
  266. return {
  267. "status": True,
  268. "embedding_engine": app.state.config.RAG_EMBEDDING_ENGINE,
  269. "embedding_model": app.state.config.RAG_EMBEDDING_MODEL,
  270. "embedding_batch_size": app.state.config.RAG_EMBEDDING_BATCH_SIZE,
  271. "openai_config": {
  272. "url": app.state.config.OPENAI_API_BASE_URL,
  273. "key": app.state.config.OPENAI_API_KEY,
  274. },
  275. "ollama_config": {
  276. "url": app.state.config.OLLAMA_BASE_URL,
  277. "key": app.state.config.OLLAMA_API_KEY,
  278. },
  279. }
  280. @app.get("/reranking")
  281. async def get_reraanking_config(user=Depends(get_admin_user)):
  282. return {
  283. "status": True,
  284. "reranking_model": app.state.config.RAG_RERANKING_MODEL,
  285. }
  286. class OpenAIConfigForm(BaseModel):
  287. url: str
  288. key: str
  289. class OllamaConfigForm(BaseModel):
  290. url: str
  291. key: str
  292. class EmbeddingModelUpdateForm(BaseModel):
  293. openai_config: Optional[OpenAIConfigForm] = None
  294. ollama_config: Optional[OllamaConfigForm] = None
  295. embedding_engine: str
  296. embedding_model: str
  297. embedding_batch_size: Optional[int] = 1
  298. @app.post("/embedding/update")
  299. async def update_embedding_config(
  300. form_data: EmbeddingModelUpdateForm, user=Depends(get_admin_user)
  301. ):
  302. log.info(
  303. f"Updating embedding model: {app.state.config.RAG_EMBEDDING_MODEL} to {form_data.embedding_model}"
  304. )
  305. try:
  306. app.state.config.RAG_EMBEDDING_ENGINE = form_data.embedding_engine
  307. app.state.config.RAG_EMBEDDING_MODEL = form_data.embedding_model
  308. if app.state.config.RAG_EMBEDDING_ENGINE in ["ollama", "openai"]:
  309. if form_data.openai_config is not None:
  310. app.state.config.OPENAI_API_BASE_URL = form_data.openai_config.url
  311. app.state.config.OPENAI_API_KEY = form_data.openai_config.key
  312. if form_data.ollama_config is not None:
  313. app.state.config.OLLAMA_BASE_URL = form_data.ollama_config.url
  314. app.state.config.OLLAMA_API_KEY = form_data.ollama_config.key
  315. app.state.config.RAG_EMBEDDING_BATCH_SIZE = form_data.embedding_batch_size
  316. update_embedding_model(app.state.config.RAG_EMBEDDING_MODEL)
  317. app.state.EMBEDDING_FUNCTION = get_embedding_function(
  318. app.state.config.RAG_EMBEDDING_ENGINE,
  319. app.state.config.RAG_EMBEDDING_MODEL,
  320. app.state.sentence_transformer_ef,
  321. (
  322. app.state.config.OPENAI_API_BASE_URL
  323. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  324. else app.state.config.OLLAMA_BASE_URL
  325. ),
  326. (
  327. app.state.config.OPENAI_API_KEY
  328. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  329. else app.state.config.OLLAMA_API_KEY
  330. ),
  331. app.state.config.RAG_EMBEDDING_BATCH_SIZE,
  332. )
  333. return {
  334. "status": True,
  335. "embedding_engine": app.state.config.RAG_EMBEDDING_ENGINE,
  336. "embedding_model": app.state.config.RAG_EMBEDDING_MODEL,
  337. "embedding_batch_size": app.state.config.RAG_EMBEDDING_BATCH_SIZE,
  338. "openai_config": {
  339. "url": app.state.config.OPENAI_API_BASE_URL,
  340. "key": app.state.config.OPENAI_API_KEY,
  341. },
  342. "ollama_config": {
  343. "url": app.state.config.OLLAMA_BASE_URL,
  344. "key": app.state.config.OLLAMA_API_KEY,
  345. },
  346. }
  347. except Exception as e:
  348. log.exception(f"Problem updating embedding model: {e}")
  349. raise HTTPException(
  350. status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
  351. detail=ERROR_MESSAGES.DEFAULT(e),
  352. )
  353. class RerankingModelUpdateForm(BaseModel):
  354. reranking_model: str
  355. @app.post("/reranking/update")
  356. async def update_reranking_config(
  357. form_data: RerankingModelUpdateForm, user=Depends(get_admin_user)
  358. ):
  359. log.info(
  360. f"Updating reranking model: {app.state.config.RAG_RERANKING_MODEL} to {form_data.reranking_model}"
  361. )
  362. try:
  363. app.state.config.RAG_RERANKING_MODEL = form_data.reranking_model
  364. update_reranking_model(app.state.config.RAG_RERANKING_MODEL, True)
  365. return {
  366. "status": True,
  367. "reranking_model": app.state.config.RAG_RERANKING_MODEL,
  368. }
  369. except Exception as e:
  370. log.exception(f"Problem updating reranking model: {e}")
  371. raise HTTPException(
  372. status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
  373. detail=ERROR_MESSAGES.DEFAULT(e),
  374. )
  375. @app.get("/config")
  376. async def get_rag_config(user=Depends(get_admin_user)):
  377. return {
  378. "status": True,
  379. "pdf_extract_images": app.state.config.PDF_EXTRACT_IMAGES,
  380. "content_extraction": {
  381. "engine": app.state.config.CONTENT_EXTRACTION_ENGINE,
  382. "tika_server_url": app.state.config.TIKA_SERVER_URL,
  383. },
  384. "chunk": {
  385. "text_splitter": app.state.config.TEXT_SPLITTER,
  386. "chunk_size": app.state.config.CHUNK_SIZE,
  387. "chunk_overlap": app.state.config.CHUNK_OVERLAP,
  388. },
  389. "file": {
  390. "max_size": app.state.config.FILE_MAX_SIZE,
  391. "max_count": app.state.config.FILE_MAX_COUNT,
  392. },
  393. "youtube": {
  394. "language": app.state.config.YOUTUBE_LOADER_LANGUAGE,
  395. "translation": app.state.YOUTUBE_LOADER_TRANSLATION,
  396. "proxy_url": app.state.config.YOUTUBE_LOADER_PROXY_URL,
  397. },
  398. "web": {
  399. "web_loader_ssl_verification": app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION,
  400. "search": {
  401. "enabled": app.state.config.ENABLE_RAG_WEB_SEARCH,
  402. "engine": app.state.config.RAG_WEB_SEARCH_ENGINE,
  403. "searxng_query_url": app.state.config.SEARXNG_QUERY_URL,
  404. "google_pse_api_key": app.state.config.GOOGLE_PSE_API_KEY,
  405. "google_pse_engine_id": app.state.config.GOOGLE_PSE_ENGINE_ID,
  406. "brave_search_api_key": app.state.config.BRAVE_SEARCH_API_KEY,
  407. "kagi_search_api_key": app.state.config.KAGI_SEARCH_API_KEY,
  408. "mojeek_search_api_key": app.state.config.MOJEEK_SEARCH_API_KEY,
  409. "serpstack_api_key": app.state.config.SERPSTACK_API_KEY,
  410. "serpstack_https": app.state.config.SERPSTACK_HTTPS,
  411. "serper_api_key": app.state.config.SERPER_API_KEY,
  412. "serply_api_key": app.state.config.SERPLY_API_KEY,
  413. "tavily_api_key": app.state.config.TAVILY_API_KEY,
  414. "searchapi_api_key": app.state.config.SEARCHAPI_API_KEY,
  415. "seaarchapi_engine": app.state.config.SEARCHAPI_ENGINE,
  416. "jina_api_key": app.state.config.JINA_API_KEY,
  417. "bing_search_v7_endpoint": app.state.config.BING_SEARCH_V7_ENDPOINT,
  418. "bing_search_v7_subscription_key": app.state.config.BING_SEARCH_V7_SUBSCRIPTION_KEY,
  419. "result_count": app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  420. "concurrent_requests": app.state.config.RAG_WEB_SEARCH_CONCURRENT_REQUESTS,
  421. },
  422. },
  423. }
  424. class FileConfig(BaseModel):
  425. max_size: Optional[int] = None
  426. max_count: Optional[int] = None
  427. class ContentExtractionConfig(BaseModel):
  428. engine: str = ""
  429. tika_server_url: Optional[str] = None
  430. class ChunkParamUpdateForm(BaseModel):
  431. text_splitter: Optional[str] = None
  432. chunk_size: int
  433. chunk_overlap: int
  434. class YoutubeLoaderConfig(BaseModel):
  435. language: list[str]
  436. translation: Optional[str] = None
  437. proxy_url: str = ""
  438. class WebSearchConfig(BaseModel):
  439. enabled: bool
  440. engine: Optional[str] = None
  441. searxng_query_url: Optional[str] = None
  442. google_pse_api_key: Optional[str] = None
  443. google_pse_engine_id: Optional[str] = None
  444. brave_search_api_key: Optional[str] = None
  445. kagi_search_api_key: Optional[str] = None
  446. mojeek_search_api_key: Optional[str] = None
  447. serpstack_api_key: Optional[str] = None
  448. serpstack_https: Optional[bool] = None
  449. serper_api_key: Optional[str] = None
  450. serply_api_key: Optional[str] = None
  451. tavily_api_key: Optional[str] = None
  452. searchapi_api_key: Optional[str] = None
  453. searchapi_engine: Optional[str] = None
  454. jina_api_key: Optional[str] = None
  455. bing_search_v7_endpoint: Optional[str] = None
  456. bing_search_v7_subscription_key: Optional[str] = None
  457. result_count: Optional[int] = None
  458. concurrent_requests: Optional[int] = None
  459. class WebConfig(BaseModel):
  460. search: WebSearchConfig
  461. web_loader_ssl_verification: Optional[bool] = None
  462. class ConfigUpdateForm(BaseModel):
  463. pdf_extract_images: Optional[bool] = None
  464. file: Optional[FileConfig] = None
  465. content_extraction: Optional[ContentExtractionConfig] = None
  466. chunk: Optional[ChunkParamUpdateForm] = None
  467. youtube: Optional[YoutubeLoaderConfig] = None
  468. web: Optional[WebConfig] = None
  469. @app.post("/config/update")
  470. async def update_rag_config(form_data: ConfigUpdateForm, user=Depends(get_admin_user)):
  471. app.state.config.PDF_EXTRACT_IMAGES = (
  472. form_data.pdf_extract_images
  473. if form_data.pdf_extract_images is not None
  474. else app.state.config.PDF_EXTRACT_IMAGES
  475. )
  476. if form_data.file is not None:
  477. app.state.config.FILE_MAX_SIZE = form_data.file.max_size
  478. app.state.config.FILE_MAX_COUNT = form_data.file.max_count
  479. if form_data.content_extraction is not None:
  480. log.info(f"Updating text settings: {form_data.content_extraction}")
  481. app.state.config.CONTENT_EXTRACTION_ENGINE = form_data.content_extraction.engine
  482. app.state.config.TIKA_SERVER_URL = form_data.content_extraction.tika_server_url
  483. if form_data.chunk is not None:
  484. app.state.config.TEXT_SPLITTER = form_data.chunk.text_splitter
  485. app.state.config.CHUNK_SIZE = form_data.chunk.chunk_size
  486. app.state.config.CHUNK_OVERLAP = form_data.chunk.chunk_overlap
  487. if form_data.youtube is not None:
  488. app.state.config.YOUTUBE_LOADER_LANGUAGE = form_data.youtube.language
  489. app.state.config.YOUTUBE_LOADER_PROXY_URL = form_data.youtube.proxy_url
  490. app.state.YOUTUBE_LOADER_TRANSLATION = form_data.youtube.translation
  491. if form_data.web is not None:
  492. app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION = (
  493. # Note: When UI "Bypass SSL verification for Websites"=True then ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION=False
  494. form_data.web.web_loader_ssl_verification
  495. )
  496. app.state.config.ENABLE_RAG_WEB_SEARCH = form_data.web.search.enabled
  497. app.state.config.RAG_WEB_SEARCH_ENGINE = form_data.web.search.engine
  498. app.state.config.SEARXNG_QUERY_URL = form_data.web.search.searxng_query_url
  499. app.state.config.GOOGLE_PSE_API_KEY = form_data.web.search.google_pse_api_key
  500. app.state.config.GOOGLE_PSE_ENGINE_ID = (
  501. form_data.web.search.google_pse_engine_id
  502. )
  503. app.state.config.BRAVE_SEARCH_API_KEY = (
  504. form_data.web.search.brave_search_api_key
  505. )
  506. app.state.config.KAGI_SEARCH_API_KEY = form_data.web.search.kagi_search_api_key
  507. app.state.config.MOJEEK_SEARCH_API_KEY = (
  508. form_data.web.search.mojeek_search_api_key
  509. )
  510. app.state.config.SERPSTACK_API_KEY = form_data.web.search.serpstack_api_key
  511. app.state.config.SERPSTACK_HTTPS = form_data.web.search.serpstack_https
  512. app.state.config.SERPER_API_KEY = form_data.web.search.serper_api_key
  513. app.state.config.SERPLY_API_KEY = form_data.web.search.serply_api_key
  514. app.state.config.TAVILY_API_KEY = form_data.web.search.tavily_api_key
  515. app.state.config.SEARCHAPI_API_KEY = form_data.web.search.searchapi_api_key
  516. app.state.config.SEARCHAPI_ENGINE = form_data.web.search.searchapi_engine
  517. app.state.config.JINA_API_KEY = form_data.web.search.jina_api_key
  518. app.state.config.BING_SEARCH_V7_ENDPOINT = (
  519. form_data.web.search.bing_search_v7_endpoint
  520. )
  521. app.state.config.BING_SEARCH_V7_SUBSCRIPTION_KEY = (
  522. form_data.web.search.bing_search_v7_subscription_key
  523. )
  524. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT = form_data.web.search.result_count
  525. app.state.config.RAG_WEB_SEARCH_CONCURRENT_REQUESTS = (
  526. form_data.web.search.concurrent_requests
  527. )
  528. return {
  529. "status": True,
  530. "pdf_extract_images": app.state.config.PDF_EXTRACT_IMAGES,
  531. "file": {
  532. "max_size": app.state.config.FILE_MAX_SIZE,
  533. "max_count": app.state.config.FILE_MAX_COUNT,
  534. },
  535. "content_extraction": {
  536. "engine": app.state.config.CONTENT_EXTRACTION_ENGINE,
  537. "tika_server_url": app.state.config.TIKA_SERVER_URL,
  538. },
  539. "chunk": {
  540. "text_splitter": app.state.config.TEXT_SPLITTER,
  541. "chunk_size": app.state.config.CHUNK_SIZE,
  542. "chunk_overlap": app.state.config.CHUNK_OVERLAP,
  543. },
  544. "youtube": {
  545. "language": app.state.config.YOUTUBE_LOADER_LANGUAGE,
  546. "proxy_url": app.state.config.YOUTUBE_LOADER_PROXY_URL,
  547. "translation": app.state.YOUTUBE_LOADER_TRANSLATION,
  548. },
  549. "web": {
  550. "web_loader_ssl_verification": app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION,
  551. "search": {
  552. "enabled": app.state.config.ENABLE_RAG_WEB_SEARCH,
  553. "engine": app.state.config.RAG_WEB_SEARCH_ENGINE,
  554. "searxng_query_url": app.state.config.SEARXNG_QUERY_URL,
  555. "google_pse_api_key": app.state.config.GOOGLE_PSE_API_KEY,
  556. "google_pse_engine_id": app.state.config.GOOGLE_PSE_ENGINE_ID,
  557. "brave_search_api_key": app.state.config.BRAVE_SEARCH_API_KEY,
  558. "kagi_search_api_key": app.state.config.KAGI_SEARCH_API_KEY,
  559. "mojeek_search_api_key": app.state.config.MOJEEK_SEARCH_API_KEY,
  560. "serpstack_api_key": app.state.config.SERPSTACK_API_KEY,
  561. "serpstack_https": app.state.config.SERPSTACK_HTTPS,
  562. "serper_api_key": app.state.config.SERPER_API_KEY,
  563. "serply_api_key": app.state.config.SERPLY_API_KEY,
  564. "serachapi_api_key": app.state.config.SEARCHAPI_API_KEY,
  565. "searchapi_engine": app.state.config.SEARCHAPI_ENGINE,
  566. "tavily_api_key": app.state.config.TAVILY_API_KEY,
  567. "jina_api_key": app.state.config.JINA_API_KEY,
  568. "bing_search_v7_endpoint": app.state.config.BING_SEARCH_V7_ENDPOINT,
  569. "bing_search_v7_subscription_key": app.state.config.BING_SEARCH_V7_SUBSCRIPTION_KEY,
  570. "result_count": app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  571. "concurrent_requests": app.state.config.RAG_WEB_SEARCH_CONCURRENT_REQUESTS,
  572. },
  573. },
  574. }
  575. @app.get("/template")
  576. async def get_rag_template(user=Depends(get_verified_user)):
  577. return {
  578. "status": True,
  579. "template": app.state.config.RAG_TEMPLATE,
  580. }
  581. @app.get("/query/settings")
  582. async def get_query_settings(user=Depends(get_admin_user)):
  583. return {
  584. "status": True,
  585. "template": app.state.config.RAG_TEMPLATE,
  586. "k": app.state.config.TOP_K,
  587. "r": app.state.config.RELEVANCE_THRESHOLD,
  588. "hybrid": app.state.config.ENABLE_RAG_HYBRID_SEARCH,
  589. }
  590. class QuerySettingsForm(BaseModel):
  591. k: Optional[int] = None
  592. r: Optional[float] = None
  593. template: Optional[str] = None
  594. hybrid: Optional[bool] = None
  595. @app.post("/query/settings/update")
  596. async def update_query_settings(
  597. form_data: QuerySettingsForm, user=Depends(get_admin_user)
  598. ):
  599. app.state.config.RAG_TEMPLATE = form_data.template
  600. app.state.config.TOP_K = form_data.k if form_data.k else 4
  601. app.state.config.RELEVANCE_THRESHOLD = form_data.r if form_data.r else 0.0
  602. app.state.config.ENABLE_RAG_HYBRID_SEARCH = (
  603. form_data.hybrid if form_data.hybrid else False
  604. )
  605. return {
  606. "status": True,
  607. "template": app.state.config.RAG_TEMPLATE,
  608. "k": app.state.config.TOP_K,
  609. "r": app.state.config.RELEVANCE_THRESHOLD,
  610. "hybrid": app.state.config.ENABLE_RAG_HYBRID_SEARCH,
  611. }
  612. ####################################
  613. #
  614. # Document process and retrieval
  615. #
  616. ####################################
  617. def _get_docs_info(docs: list[Document]) -> str:
  618. docs_info = set()
  619. # Trying to select relevant metadata identifying the document.
  620. for doc in docs:
  621. metadata = getattr(doc, "metadata", {})
  622. doc_name = metadata.get("name", "")
  623. if not doc_name:
  624. doc_name = metadata.get("title", "")
  625. if not doc_name:
  626. doc_name = metadata.get("source", "")
  627. if doc_name:
  628. docs_info.add(doc_name)
  629. return ", ".join(docs_info)
  630. def save_docs_to_vector_db(
  631. docs,
  632. collection_name,
  633. metadata: Optional[dict] = None,
  634. overwrite: bool = False,
  635. split: bool = True,
  636. add: bool = False,
  637. ) -> bool:
  638. log.info(
  639. f"save_docs_to_vector_db: document {_get_docs_info(docs)} {collection_name}"
  640. )
  641. # Check if entries with the same hash (metadata.hash) already exist
  642. if metadata and "hash" in metadata:
  643. result = VECTOR_DB_CLIENT.query(
  644. collection_name=collection_name,
  645. filter={"hash": metadata["hash"]},
  646. )
  647. if result is not None:
  648. existing_doc_ids = result.ids[0]
  649. if existing_doc_ids:
  650. log.info(f"Document with hash {metadata['hash']} already exists")
  651. raise ValueError(ERROR_MESSAGES.DUPLICATE_CONTENT)
  652. if split:
  653. if app.state.config.TEXT_SPLITTER in ["", "character"]:
  654. text_splitter = RecursiveCharacterTextSplitter(
  655. chunk_size=app.state.config.CHUNK_SIZE,
  656. chunk_overlap=app.state.config.CHUNK_OVERLAP,
  657. add_start_index=True,
  658. )
  659. elif app.state.config.TEXT_SPLITTER == "token":
  660. log.info(
  661. f"Using token text splitter: {app.state.config.TIKTOKEN_ENCODING_NAME}"
  662. )
  663. tiktoken.get_encoding(str(app.state.config.TIKTOKEN_ENCODING_NAME))
  664. text_splitter = TokenTextSplitter(
  665. encoding_name=str(app.state.config.TIKTOKEN_ENCODING_NAME),
  666. chunk_size=app.state.config.CHUNK_SIZE,
  667. chunk_overlap=app.state.config.CHUNK_OVERLAP,
  668. add_start_index=True,
  669. )
  670. else:
  671. raise ValueError(ERROR_MESSAGES.DEFAULT("Invalid text splitter"))
  672. docs = text_splitter.split_documents(docs)
  673. if len(docs) == 0:
  674. raise ValueError(ERROR_MESSAGES.EMPTY_CONTENT)
  675. texts = [doc.page_content for doc in docs]
  676. metadatas = [
  677. {
  678. **doc.metadata,
  679. **(metadata if metadata else {}),
  680. "embedding_config": json.dumps(
  681. {
  682. "engine": app.state.config.RAG_EMBEDDING_ENGINE,
  683. "model": app.state.config.RAG_EMBEDDING_MODEL,
  684. }
  685. ),
  686. }
  687. for doc in docs
  688. ]
  689. # ChromaDB does not like datetime formats
  690. # for meta-data so convert them to string.
  691. for metadata in metadatas:
  692. for key, value in metadata.items():
  693. if isinstance(value, datetime):
  694. metadata[key] = str(value)
  695. try:
  696. if VECTOR_DB_CLIENT.has_collection(collection_name=collection_name):
  697. log.info(f"collection {collection_name} already exists")
  698. if overwrite:
  699. VECTOR_DB_CLIENT.delete_collection(collection_name=collection_name)
  700. log.info(f"deleting existing collection {collection_name}")
  701. elif add is False:
  702. log.info(
  703. f"collection {collection_name} already exists, overwrite is False and add is False"
  704. )
  705. return True
  706. log.info(f"adding to collection {collection_name}")
  707. embedding_function = get_embedding_function(
  708. app.state.config.RAG_EMBEDDING_ENGINE,
  709. app.state.config.RAG_EMBEDDING_MODEL,
  710. app.state.sentence_transformer_ef,
  711. (
  712. app.state.config.OPENAI_API_BASE_URL
  713. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  714. else app.state.config.OLLAMA_BASE_URL
  715. ),
  716. (
  717. app.state.config.OPENAI_API_KEY
  718. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  719. else app.state.config.OLLAMA_API_KEY
  720. ),
  721. app.state.config.RAG_EMBEDDING_BATCH_SIZE,
  722. )
  723. embeddings = embedding_function(
  724. list(map(lambda x: x.replace("\n", " "), texts))
  725. )
  726. items = [
  727. {
  728. "id": str(uuid.uuid4()),
  729. "text": text,
  730. "vector": embeddings[idx],
  731. "metadata": metadatas[idx],
  732. }
  733. for idx, text in enumerate(texts)
  734. ]
  735. VECTOR_DB_CLIENT.insert(
  736. collection_name=collection_name,
  737. items=items,
  738. )
  739. return True
  740. except Exception as e:
  741. log.exception(e)
  742. raise e
  743. class ProcessFileForm(BaseModel):
  744. file_id: str
  745. content: Optional[str] = None
  746. collection_name: Optional[str] = None
  747. @app.post("/process/file")
  748. def process_file(
  749. form_data: ProcessFileForm,
  750. user=Depends(get_verified_user),
  751. ):
  752. try:
  753. file = Files.get_file_by_id(form_data.file_id)
  754. collection_name = form_data.collection_name
  755. if collection_name is None:
  756. collection_name = f"file-{file.id}"
  757. if form_data.content:
  758. # Update the content in the file
  759. # Usage: /files/{file_id}/data/content/update
  760. VECTOR_DB_CLIENT.delete_collection(collection_name=f"file-{file.id}")
  761. docs = [
  762. Document(
  763. page_content=form_data.content.replace("<br/>", "\n"),
  764. metadata={
  765. **file.meta,
  766. "name": file.filename,
  767. "created_by": file.user_id,
  768. "file_id": file.id,
  769. "source": file.filename,
  770. },
  771. )
  772. ]
  773. text_content = form_data.content
  774. elif form_data.collection_name:
  775. # Check if the file has already been processed and save the content
  776. # Usage: /knowledge/{id}/file/add, /knowledge/{id}/file/update
  777. result = VECTOR_DB_CLIENT.query(
  778. collection_name=f"file-{file.id}", filter={"file_id": file.id}
  779. )
  780. if result is not None and len(result.ids[0]) > 0:
  781. docs = [
  782. Document(
  783. page_content=result.documents[0][idx],
  784. metadata=result.metadatas[0][idx],
  785. )
  786. for idx, id in enumerate(result.ids[0])
  787. ]
  788. else:
  789. docs = [
  790. Document(
  791. page_content=file.data.get("content", ""),
  792. metadata={
  793. **file.meta,
  794. "name": file.filename,
  795. "created_by": file.user_id,
  796. "file_id": file.id,
  797. "source": file.filename,
  798. },
  799. )
  800. ]
  801. text_content = file.data.get("content", "")
  802. else:
  803. # Process the file and save the content
  804. # Usage: /files/
  805. file_path = file.path
  806. if file_path:
  807. file_path = Storage.get_file(file_path)
  808. loader = Loader(
  809. engine=app.state.config.CONTENT_EXTRACTION_ENGINE,
  810. TIKA_SERVER_URL=app.state.config.TIKA_SERVER_URL,
  811. PDF_EXTRACT_IMAGES=app.state.config.PDF_EXTRACT_IMAGES,
  812. )
  813. docs = loader.load(
  814. file.filename, file.meta.get("content_type"), file_path
  815. )
  816. docs = [
  817. Document(
  818. page_content=doc.page_content,
  819. metadata={
  820. **doc.metadata,
  821. "name": file.filename,
  822. "created_by": file.user_id,
  823. "file_id": file.id,
  824. "source": file.filename,
  825. },
  826. )
  827. for doc in docs
  828. ]
  829. else:
  830. docs = [
  831. Document(
  832. page_content=file.data.get("content", ""),
  833. metadata={
  834. **file.meta,
  835. "name": file.filename,
  836. "created_by": file.user_id,
  837. "file_id": file.id,
  838. "source": file.filename,
  839. },
  840. )
  841. ]
  842. text_content = " ".join([doc.page_content for doc in docs])
  843. log.debug(f"text_content: {text_content}")
  844. Files.update_file_data_by_id(
  845. file.id,
  846. {"content": text_content},
  847. )
  848. hash = calculate_sha256_string(text_content)
  849. Files.update_file_hash_by_id(file.id, hash)
  850. try:
  851. result = save_docs_to_vector_db(
  852. docs=docs,
  853. collection_name=collection_name,
  854. metadata={
  855. "file_id": file.id,
  856. "name": file.filename,
  857. "hash": hash,
  858. },
  859. add=(True if form_data.collection_name else False),
  860. )
  861. if result:
  862. Files.update_file_metadata_by_id(
  863. file.id,
  864. {
  865. "collection_name": collection_name,
  866. },
  867. )
  868. return {
  869. "status": True,
  870. "collection_name": collection_name,
  871. "filename": file.filename,
  872. "content": text_content,
  873. }
  874. except Exception as e:
  875. raise e
  876. except Exception as e:
  877. log.exception(e)
  878. if "No pandoc was found" in str(e):
  879. raise HTTPException(
  880. status_code=status.HTTP_400_BAD_REQUEST,
  881. detail=ERROR_MESSAGES.PANDOC_NOT_INSTALLED,
  882. )
  883. else:
  884. raise HTTPException(
  885. status_code=status.HTTP_400_BAD_REQUEST,
  886. detail=str(e),
  887. )
  888. class BatchProcessFilesForm(BaseModel):
  889. files: List[FileModel]
  890. collection_name: str
  891. class BatchProcessFilesResult(BaseModel):
  892. file_id: str
  893. status: str
  894. error: Optional[str] = None
  895. class BatchProcessFilesResponse(BaseModel):
  896. results: List[BatchProcessFilesResult]
  897. errors: List[BatchProcessFilesResult]
  898. @app.post("/process/files/batch")
  899. def process_files_batch(
  900. form_data: BatchProcessFilesForm,
  901. user=Depends(get_verified_user),
  902. ) -> BatchProcessFilesResponse:
  903. """
  904. Process a batch of files and save them to the vector database.
  905. """
  906. results: List[BatchProcessFilesResult] = []
  907. errors: List[BatchProcessFilesResult] = []
  908. collection_name = form_data.collection_name
  909. # Prepare all documents first
  910. all_docs: List[Document] = []
  911. for file in form_data.files:
  912. try:
  913. text_content = file.data.get("content", "")
  914. docs: List[Document] = [
  915. Document(
  916. page_content=text_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. hash = calculate_sha256_string(text_content)
  927. Files.update_file_hash_by_id(file.id, hash)
  928. Files.update_file_data_by_id(file.id, {"content": text_content})
  929. all_docs.extend(docs)
  930. results.append(BatchProcessFilesResult(
  931. file_id=file.id,
  932. status="prepared"
  933. ))
  934. except Exception as e:
  935. log.error(f"process_files_batch: Error processing file {file.id}: {str(e)}")
  936. errors.append(BatchProcessFilesResult(
  937. file_id=file.id,
  938. status="failed",
  939. error=str(e)
  940. ))
  941. # Save all documents in one batch
  942. if all_docs:
  943. try:
  944. save_docs_to_vector_db(
  945. docs=all_docs,
  946. collection_name=collection_name,
  947. add=True
  948. )
  949. # Update all files with collection name
  950. for result in results:
  951. Files.update_file_metadata_by_id(
  952. result.file_id,
  953. {"collection_name": collection_name}
  954. )
  955. result.status = "completed"
  956. except Exception as e:
  957. log.error(f"process_files_batch: Error saving documents to vector DB: {str(e)}")
  958. for result in results:
  959. result.status = "failed"
  960. errors.append(BatchProcessFilesResult(
  961. file_id=result.file_id,
  962. error=str(e)
  963. ))
  964. return BatchProcessFilesResponse(
  965. results=results,
  966. errors=errors
  967. )
  968. class ProcessTextForm(BaseModel):
  969. name: str
  970. content: str
  971. collection_name: Optional[str] = None
  972. @app.post("/process/text")
  973. def process_text(
  974. form_data: ProcessTextForm,
  975. user=Depends(get_verified_user),
  976. ):
  977. collection_name = form_data.collection_name
  978. if collection_name is None:
  979. collection_name = calculate_sha256_string(form_data.content)
  980. docs = [
  981. Document(
  982. page_content=form_data.content,
  983. metadata={"name": form_data.name, "created_by": user.id},
  984. )
  985. ]
  986. text_content = form_data.content
  987. log.debug(f"text_content: {text_content}")
  988. result = save_docs_to_vector_db(docs, collection_name)
  989. if result:
  990. return {
  991. "status": True,
  992. "collection_name": collection_name,
  993. "content": text_content,
  994. }
  995. else:
  996. raise HTTPException(
  997. status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
  998. detail=ERROR_MESSAGES.DEFAULT(),
  999. )
  1000. @app.post("/process/youtube")
  1001. def process_youtube_video(form_data: ProcessUrlForm, user=Depends(get_verified_user)):
  1002. try:
  1003. collection_name = form_data.collection_name
  1004. if not collection_name:
  1005. collection_name = calculate_sha256_string(form_data.url)[:63]
  1006. loader = YoutubeLoader(
  1007. form_data.url,
  1008. language=app.state.config.YOUTUBE_LOADER_LANGUAGE,
  1009. proxy_url=app.state.config.YOUTUBE_LOADER_PROXY_URL,
  1010. )
  1011. docs = loader.load()
  1012. content = " ".join([doc.page_content for doc in docs])
  1013. log.debug(f"text_content: {content}")
  1014. save_docs_to_vector_db(docs, collection_name, overwrite=True)
  1015. return {
  1016. "status": True,
  1017. "collection_name": collection_name,
  1018. "filename": form_data.url,
  1019. "file": {
  1020. "data": {
  1021. "content": content,
  1022. },
  1023. "meta": {
  1024. "name": form_data.url,
  1025. },
  1026. },
  1027. }
  1028. except Exception as e:
  1029. log.exception(e)
  1030. raise HTTPException(
  1031. status_code=status.HTTP_400_BAD_REQUEST,
  1032. detail=ERROR_MESSAGES.DEFAULT(e),
  1033. )
  1034. @app.post("/process/web")
  1035. def process_web(form_data: ProcessUrlForm, user=Depends(get_verified_user)):
  1036. try:
  1037. collection_name = form_data.collection_name
  1038. if not collection_name:
  1039. collection_name = calculate_sha256_string(form_data.url)[:63]
  1040. loader = get_web_loader(
  1041. form_data.url,
  1042. verify_ssl=app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION,
  1043. requests_per_second=app.state.config.RAG_WEB_SEARCH_CONCURRENT_REQUESTS,
  1044. )
  1045. docs = loader.load()
  1046. content = " ".join([doc.page_content for doc in docs])
  1047. log.debug(f"text_content: {content}")
  1048. save_docs_to_vector_db(docs, collection_name, overwrite=True)
  1049. return {
  1050. "status": True,
  1051. "collection_name": collection_name,
  1052. "filename": form_data.url,
  1053. "file": {
  1054. "data": {
  1055. "content": content,
  1056. },
  1057. "meta": {
  1058. "name": form_data.url,
  1059. },
  1060. },
  1061. }
  1062. except Exception as e:
  1063. log.exception(e)
  1064. raise HTTPException(
  1065. status_code=status.HTTP_400_BAD_REQUEST,
  1066. detail=ERROR_MESSAGES.DEFAULT(e),
  1067. )
  1068. def search_web(engine: str, query: str) -> list[SearchResult]:
  1069. """Search the web using a search engine and return the results as a list of SearchResult objects.
  1070. Will look for a search engine API key in environment variables in the following order:
  1071. - SEARXNG_QUERY_URL
  1072. - GOOGLE_PSE_API_KEY + GOOGLE_PSE_ENGINE_ID
  1073. - BRAVE_SEARCH_API_KEY
  1074. - KAGI_SEARCH_API_KEY
  1075. - MOJEEK_SEARCH_API_KEY
  1076. - SERPSTACK_API_KEY
  1077. - SERPER_API_KEY
  1078. - SERPLY_API_KEY
  1079. - TAVILY_API_KEY
  1080. - SEARCHAPI_API_KEY + SEARCHAPI_ENGINE (by default `google`)
  1081. Args:
  1082. query (str): The query to search for
  1083. """
  1084. # TODO: add playwright to search the web
  1085. if engine == "searxng":
  1086. if app.state.config.SEARXNG_QUERY_URL:
  1087. return search_searxng(
  1088. app.state.config.SEARXNG_QUERY_URL,
  1089. query,
  1090. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1091. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  1092. )
  1093. else:
  1094. raise Exception("No SEARXNG_QUERY_URL found in environment variables")
  1095. elif engine == "google_pse":
  1096. if (
  1097. app.state.config.GOOGLE_PSE_API_KEY
  1098. and app.state.config.GOOGLE_PSE_ENGINE_ID
  1099. ):
  1100. return search_google_pse(
  1101. app.state.config.GOOGLE_PSE_API_KEY,
  1102. app.state.config.GOOGLE_PSE_ENGINE_ID,
  1103. query,
  1104. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1105. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  1106. )
  1107. else:
  1108. raise Exception(
  1109. "No GOOGLE_PSE_API_KEY or GOOGLE_PSE_ENGINE_ID found in environment variables"
  1110. )
  1111. elif engine == "brave":
  1112. if app.state.config.BRAVE_SEARCH_API_KEY:
  1113. return search_brave(
  1114. app.state.config.BRAVE_SEARCH_API_KEY,
  1115. query,
  1116. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1117. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  1118. )
  1119. else:
  1120. raise Exception("No BRAVE_SEARCH_API_KEY found in environment variables")
  1121. elif engine == "kagi":
  1122. if app.state.config.KAGI_SEARCH_API_KEY:
  1123. return search_kagi(
  1124. app.state.config.KAGI_SEARCH_API_KEY,
  1125. query,
  1126. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1127. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  1128. )
  1129. else:
  1130. raise Exception("No KAGI_SEARCH_API_KEY found in environment variables")
  1131. elif engine == "mojeek":
  1132. if app.state.config.MOJEEK_SEARCH_API_KEY:
  1133. return search_mojeek(
  1134. app.state.config.MOJEEK_SEARCH_API_KEY,
  1135. query,
  1136. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1137. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  1138. )
  1139. else:
  1140. raise Exception("No MOJEEK_SEARCH_API_KEY found in environment variables")
  1141. elif engine == "serpstack":
  1142. if app.state.config.SERPSTACK_API_KEY:
  1143. return search_serpstack(
  1144. app.state.config.SERPSTACK_API_KEY,
  1145. query,
  1146. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1147. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  1148. https_enabled=app.state.config.SERPSTACK_HTTPS,
  1149. )
  1150. else:
  1151. raise Exception("No SERPSTACK_API_KEY found in environment variables")
  1152. elif engine == "serper":
  1153. if app.state.config.SERPER_API_KEY:
  1154. return search_serper(
  1155. app.state.config.SERPER_API_KEY,
  1156. query,
  1157. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1158. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  1159. )
  1160. else:
  1161. raise Exception("No SERPER_API_KEY found in environment variables")
  1162. elif engine == "serply":
  1163. if app.state.config.SERPLY_API_KEY:
  1164. return search_serply(
  1165. app.state.config.SERPLY_API_KEY,
  1166. query,
  1167. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1168. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  1169. )
  1170. else:
  1171. raise Exception("No SERPLY_API_KEY found in environment variables")
  1172. elif engine == "duckduckgo":
  1173. return search_duckduckgo(
  1174. query,
  1175. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1176. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  1177. )
  1178. elif engine == "tavily":
  1179. if app.state.config.TAVILY_API_KEY:
  1180. return search_tavily(
  1181. app.state.config.TAVILY_API_KEY,
  1182. query,
  1183. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1184. )
  1185. else:
  1186. raise Exception("No TAVILY_API_KEY found in environment variables")
  1187. elif engine == "searchapi":
  1188. if app.state.config.SEARCHAPI_API_KEY:
  1189. return search_searchapi(
  1190. app.state.config.SEARCHAPI_API_KEY,
  1191. app.state.config.SEARCHAPI_ENGINE,
  1192. query,
  1193. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1194. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  1195. )
  1196. else:
  1197. raise Exception("No SEARCHAPI_API_KEY found in environment variables")
  1198. elif engine == "jina":
  1199. return search_jina(
  1200. app.state.config.JINA_API_KEY,
  1201. query,
  1202. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1203. )
  1204. elif engine == "bing":
  1205. return search_bing(
  1206. app.state.config.BING_SEARCH_V7_SUBSCRIPTION_KEY,
  1207. app.state.config.BING_SEARCH_V7_ENDPOINT,
  1208. str(DEFAULT_LOCALE),
  1209. query,
  1210. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  1211. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  1212. )
  1213. else:
  1214. raise Exception("No search engine API key found in environment variables")
  1215. @app.post("/process/web/search")
  1216. def process_web_search(form_data: SearchForm, user=Depends(get_verified_user)):
  1217. try:
  1218. logging.info(
  1219. f"trying to web search with {app.state.config.RAG_WEB_SEARCH_ENGINE, form_data.query}"
  1220. )
  1221. web_results = search_web(
  1222. app.state.config.RAG_WEB_SEARCH_ENGINE, form_data.query
  1223. )
  1224. except Exception as e:
  1225. log.exception(e)
  1226. print(e)
  1227. raise HTTPException(
  1228. status_code=status.HTTP_400_BAD_REQUEST,
  1229. detail=ERROR_MESSAGES.WEB_SEARCH_ERROR(e),
  1230. )
  1231. try:
  1232. collection_name = form_data.collection_name
  1233. if collection_name == "":
  1234. collection_name = calculate_sha256_string(form_data.query)[:63]
  1235. urls = [result.link for result in web_results]
  1236. loader = get_web_loader(
  1237. urls,
  1238. verify_ssl=app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION,
  1239. requests_per_second=app.state.config.RAG_WEB_SEARCH_CONCURRENT_REQUESTS,
  1240. )
  1241. docs = loader.aload()
  1242. save_docs_to_vector_db(docs, collection_name, overwrite=True)
  1243. return {
  1244. "status": True,
  1245. "collection_name": collection_name,
  1246. "filenames": urls,
  1247. }
  1248. except Exception as e:
  1249. log.exception(e)
  1250. raise HTTPException(
  1251. status_code=status.HTTP_400_BAD_REQUEST,
  1252. detail=ERROR_MESSAGES.DEFAULT(e),
  1253. )
  1254. class QueryDocForm(BaseModel):
  1255. collection_name: str
  1256. query: str
  1257. k: Optional[int] = None
  1258. r: Optional[float] = None
  1259. hybrid: Optional[bool] = None
  1260. @app.post("/query/doc")
  1261. def query_doc_handler(
  1262. form_data: QueryDocForm,
  1263. user=Depends(get_verified_user),
  1264. ):
  1265. try:
  1266. if app.state.config.ENABLE_RAG_HYBRID_SEARCH:
  1267. return query_doc_with_hybrid_search(
  1268. collection_name=form_data.collection_name,
  1269. query=form_data.query,
  1270. embedding_function=app.state.EMBEDDING_FUNCTION,
  1271. k=form_data.k if form_data.k else app.state.config.TOP_K,
  1272. reranking_function=app.state.sentence_transformer_rf,
  1273. r=(
  1274. form_data.r if form_data.r else app.state.config.RELEVANCE_THRESHOLD
  1275. ),
  1276. )
  1277. else:
  1278. return query_doc(
  1279. collection_name=form_data.collection_name,
  1280. query_embedding=app.state.EMBEDDING_FUNCTION(form_data.query),
  1281. k=form_data.k if form_data.k else app.state.config.TOP_K,
  1282. )
  1283. except Exception as e:
  1284. log.exception(e)
  1285. raise HTTPException(
  1286. status_code=status.HTTP_400_BAD_REQUEST,
  1287. detail=ERROR_MESSAGES.DEFAULT(e),
  1288. )
  1289. class QueryCollectionsForm(BaseModel):
  1290. collection_names: list[str]
  1291. query: str
  1292. k: Optional[int] = None
  1293. r: Optional[float] = None
  1294. hybrid: Optional[bool] = None
  1295. @app.post("/query/collection")
  1296. def query_collection_handler(
  1297. form_data: QueryCollectionsForm,
  1298. user=Depends(get_verified_user),
  1299. ):
  1300. try:
  1301. if app.state.config.ENABLE_RAG_HYBRID_SEARCH:
  1302. return query_collection_with_hybrid_search(
  1303. collection_names=form_data.collection_names,
  1304. queries=[form_data.query],
  1305. embedding_function=app.state.EMBEDDING_FUNCTION,
  1306. k=form_data.k if form_data.k else app.state.config.TOP_K,
  1307. reranking_function=app.state.sentence_transformer_rf,
  1308. r=(
  1309. form_data.r if form_data.r else app.state.config.RELEVANCE_THRESHOLD
  1310. ),
  1311. )
  1312. else:
  1313. return query_collection(
  1314. collection_names=form_data.collection_names,
  1315. queries=[form_data.query],
  1316. embedding_function=app.state.EMBEDDING_FUNCTION,
  1317. k=form_data.k if form_data.k else app.state.config.TOP_K,
  1318. )
  1319. except Exception as e:
  1320. log.exception(e)
  1321. raise HTTPException(
  1322. status_code=status.HTTP_400_BAD_REQUEST,
  1323. detail=ERROR_MESSAGES.DEFAULT(e),
  1324. )
  1325. ####################################
  1326. #
  1327. # Vector DB operations
  1328. #
  1329. ####################################
  1330. class DeleteForm(BaseModel):
  1331. collection_name: str
  1332. file_id: str
  1333. @app.post("/delete")
  1334. def delete_entries_from_collection(form_data: DeleteForm, user=Depends(get_admin_user)):
  1335. try:
  1336. if VECTOR_DB_CLIENT.has_collection(collection_name=form_data.collection_name):
  1337. file = Files.get_file_by_id(form_data.file_id)
  1338. hash = file.hash
  1339. VECTOR_DB_CLIENT.delete(
  1340. collection_name=form_data.collection_name,
  1341. metadata={"hash": hash},
  1342. )
  1343. return {"status": True}
  1344. else:
  1345. return {"status": False}
  1346. except Exception as e:
  1347. log.exception(e)
  1348. return {"status": False}
  1349. @app.post("/reset/db")
  1350. def reset_vector_db(user=Depends(get_admin_user)):
  1351. VECTOR_DB_CLIENT.reset()
  1352. Knowledges.delete_all_knowledge()
  1353. @app.post("/reset/uploads")
  1354. def reset_upload_dir(user=Depends(get_admin_user)) -> bool:
  1355. folder = f"{UPLOAD_DIR}"
  1356. try:
  1357. # Check if the directory exists
  1358. if os.path.exists(folder):
  1359. # Iterate over all the files and directories in the specified directory
  1360. for filename in os.listdir(folder):
  1361. file_path = os.path.join(folder, filename)
  1362. try:
  1363. if os.path.isfile(file_path) or os.path.islink(file_path):
  1364. os.unlink(file_path) # Remove the file or link
  1365. elif os.path.isdir(file_path):
  1366. shutil.rmtree(file_path) # Remove the directory
  1367. except Exception as e:
  1368. print(f"Failed to delete {file_path}. Reason: {e}")
  1369. else:
  1370. print(f"The directory {folder} does not exist")
  1371. except Exception as e:
  1372. print(f"Failed to process the directory {folder}. Reason: {e}")
  1373. return True
  1374. if ENV == "dev":
  1375. @app.get("/ef")
  1376. async def get_embeddings():
  1377. return {"result": app.state.EMBEDDING_FUNCTION("hello world")}
  1378. @app.get("/ef/{text}")
  1379. async def get_embeddings_text(text: str):
  1380. return {"result": app.state.EMBEDDING_FUNCTION(text)}