main.py 52 KB

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