main.py 48 KB

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