main.py 50 KB

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