main.py 33 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070
  1. from fastapi import (
  2. FastAPI,
  3. Depends,
  4. HTTPException,
  5. status,
  6. UploadFile,
  7. File,
  8. Form,
  9. )
  10. from fastapi.middleware.cors import CORSMiddleware
  11. import os, shutil, logging, re
  12. from pathlib import Path
  13. from typing import List, Union, Sequence
  14. from chromadb.utils.batch_utils import create_batches
  15. from langchain_community.document_loaders import (
  16. WebBaseLoader,
  17. TextLoader,
  18. PyPDFLoader,
  19. CSVLoader,
  20. BSHTMLLoader,
  21. Docx2txtLoader,
  22. UnstructuredEPubLoader,
  23. UnstructuredWordDocumentLoader,
  24. UnstructuredMarkdownLoader,
  25. UnstructuredXMLLoader,
  26. UnstructuredRSTLoader,
  27. UnstructuredExcelLoader,
  28. UnstructuredPowerPointLoader,
  29. YoutubeLoader,
  30. )
  31. from langchain.text_splitter import RecursiveCharacterTextSplitter
  32. import validators
  33. import urllib.parse
  34. import socket
  35. from pydantic import BaseModel
  36. from typing import Optional
  37. import mimetypes
  38. import uuid
  39. import json
  40. import sentence_transformers
  41. from apps.webui.models.documents import (
  42. Documents,
  43. DocumentForm,
  44. DocumentResponse,
  45. )
  46. from apps.rag.utils import (
  47. get_model_path,
  48. get_embedding_function,
  49. query_doc,
  50. query_doc_with_hybrid_search,
  51. query_collection,
  52. query_collection_with_hybrid_search,
  53. search_web,
  54. )
  55. from utils.misc import (
  56. calculate_sha256,
  57. calculate_sha256_string,
  58. sanitize_filename,
  59. extract_folders_after_data_docs,
  60. )
  61. from utils.utils import get_current_user, get_admin_user
  62. from config import (
  63. ENV,
  64. SRC_LOG_LEVELS,
  65. UPLOAD_DIR,
  66. DOCS_DIR,
  67. RAG_TOP_K,
  68. RAG_RELEVANCE_THRESHOLD,
  69. RAG_EMBEDDING_ENGINE,
  70. RAG_EMBEDDING_MODEL,
  71. RAG_EMBEDDING_MODEL_AUTO_UPDATE,
  72. RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE,
  73. ENABLE_RAG_HYBRID_SEARCH,
  74. ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION,
  75. RAG_RERANKING_MODEL,
  76. PDF_EXTRACT_IMAGES,
  77. RAG_RERANKING_MODEL_AUTO_UPDATE,
  78. RAG_RERANKING_MODEL_TRUST_REMOTE_CODE,
  79. RAG_OPENAI_API_BASE_URL,
  80. RAG_OPENAI_API_KEY,
  81. DEVICE_TYPE,
  82. CHROMA_CLIENT,
  83. CHUNK_SIZE,
  84. CHUNK_OVERLAP,
  85. RAG_TEMPLATE,
  86. ENABLE_RAG_LOCAL_WEB_FETCH,
  87. YOUTUBE_LOADER_LANGUAGE,
  88. ENABLE_RAG_WEB_SEARCH,
  89. SEARXNG_QUERY_URL,
  90. GOOGLE_PSE_API_KEY,
  91. GOOGLE_PSE_ENGINE_ID,
  92. SERPSTACK_API_KEY,
  93. SERPSTACK_HTTPS,
  94. SERPER_API_KEY,
  95. RAG_WEB_SEARCH_RESULT_COUNT,
  96. RAG_WEB_SEARCH_CONCURRENT_REQUESTS,
  97. AppConfig,
  98. )
  99. from constants import ERROR_MESSAGES
  100. log = logging.getLogger(__name__)
  101. log.setLevel(SRC_LOG_LEVELS["RAG"])
  102. app = FastAPI()
  103. app.state.config = AppConfig()
  104. app.state.config.TOP_K = RAG_TOP_K
  105. app.state.config.RELEVANCE_THRESHOLD = RAG_RELEVANCE_THRESHOLD
  106. app.state.config.ENABLE_RAG_HYBRID_SEARCH = ENABLE_RAG_HYBRID_SEARCH
  107. app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION = (
  108. ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION
  109. )
  110. app.state.config.CHUNK_SIZE = CHUNK_SIZE
  111. app.state.config.CHUNK_OVERLAP = CHUNK_OVERLAP
  112. app.state.config.RAG_EMBEDDING_ENGINE = RAG_EMBEDDING_ENGINE
  113. app.state.config.RAG_EMBEDDING_MODEL = RAG_EMBEDDING_MODEL
  114. app.state.config.RAG_RERANKING_MODEL = RAG_RERANKING_MODEL
  115. app.state.config.RAG_TEMPLATE = RAG_TEMPLATE
  116. app.state.config.OPENAI_API_BASE_URL = RAG_OPENAI_API_BASE_URL
  117. app.state.config.OPENAI_API_KEY = RAG_OPENAI_API_KEY
  118. app.state.config.PDF_EXTRACT_IMAGES = PDF_EXTRACT_IMAGES
  119. app.state.config.YOUTUBE_LOADER_LANGUAGE = YOUTUBE_LOADER_LANGUAGE
  120. app.state.YOUTUBE_LOADER_TRANSLATION = None
  121. app.state.config.ENABLE_RAG_WEB_SEARCH = ENABLE_RAG_WEB_SEARCH
  122. app.state.config.SEARXNG_QUERY_URL = SEARXNG_QUERY_URL
  123. app.state.config.GOOGLE_PSE_API_KEY = GOOGLE_PSE_API_KEY
  124. app.state.config.GOOGLE_PSE_ENGINE_ID = GOOGLE_PSE_ENGINE_ID
  125. app.state.config.SERPSTACK_API_KEY = SERPSTACK_API_KEY
  126. app.state.config.SERPSTACK_HTTPS = SERPSTACK_HTTPS
  127. app.state.config.SERPER_API_KEY = SERPER_API_KEY
  128. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT = RAG_WEB_SEARCH_RESULT_COUNT
  129. app.state.config.RAG_WEB_SEARCH_CONCURRENT_REQUESTS = RAG_WEB_SEARCH_CONCURRENT_REQUESTS
  130. def update_embedding_model(
  131. embedding_model: str,
  132. update_model: bool = False,
  133. ):
  134. if embedding_model and app.state.config.RAG_EMBEDDING_ENGINE == "":
  135. app.state.sentence_transformer_ef = sentence_transformers.SentenceTransformer(
  136. get_model_path(embedding_model, update_model),
  137. device=DEVICE_TYPE,
  138. trust_remote_code=RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE,
  139. )
  140. else:
  141. app.state.sentence_transformer_ef = None
  142. def update_reranking_model(
  143. reranking_model: str,
  144. update_model: bool = False,
  145. ):
  146. if reranking_model:
  147. app.state.sentence_transformer_rf = sentence_transformers.CrossEncoder(
  148. get_model_path(reranking_model, update_model),
  149. device=DEVICE_TYPE,
  150. trust_remote_code=RAG_RERANKING_MODEL_TRUST_REMOTE_CODE,
  151. )
  152. else:
  153. app.state.sentence_transformer_rf = None
  154. update_embedding_model(
  155. app.state.config.RAG_EMBEDDING_MODEL,
  156. RAG_EMBEDDING_MODEL_AUTO_UPDATE,
  157. )
  158. update_reranking_model(
  159. app.state.config.RAG_RERANKING_MODEL,
  160. RAG_RERANKING_MODEL_AUTO_UPDATE,
  161. )
  162. app.state.EMBEDDING_FUNCTION = get_embedding_function(
  163. app.state.config.RAG_EMBEDDING_ENGINE,
  164. app.state.config.RAG_EMBEDDING_MODEL,
  165. app.state.sentence_transformer_ef,
  166. app.state.config.OPENAI_API_KEY,
  167. app.state.config.OPENAI_API_BASE_URL,
  168. )
  169. origins = ["*"]
  170. app.add_middleware(
  171. CORSMiddleware,
  172. allow_origins=origins,
  173. allow_credentials=True,
  174. allow_methods=["*"],
  175. allow_headers=["*"],
  176. )
  177. class CollectionNameForm(BaseModel):
  178. collection_name: Optional[str] = "test"
  179. class UrlForm(CollectionNameForm):
  180. url: str
  181. class SearchForm(CollectionNameForm):
  182. query: str
  183. @app.get("/")
  184. async def get_status():
  185. return {
  186. "status": True,
  187. "chunk_size": app.state.config.CHUNK_SIZE,
  188. "chunk_overlap": app.state.config.CHUNK_OVERLAP,
  189. "template": app.state.config.RAG_TEMPLATE,
  190. "embedding_engine": app.state.config.RAG_EMBEDDING_ENGINE,
  191. "embedding_model": app.state.config.RAG_EMBEDDING_MODEL,
  192. "reranking_model": app.state.config.RAG_RERANKING_MODEL,
  193. }
  194. @app.get("/embedding")
  195. async def get_embedding_config(user=Depends(get_admin_user)):
  196. return {
  197. "status": True,
  198. "embedding_engine": app.state.config.RAG_EMBEDDING_ENGINE,
  199. "embedding_model": app.state.config.RAG_EMBEDDING_MODEL,
  200. "openai_config": {
  201. "url": app.state.config.OPENAI_API_BASE_URL,
  202. "key": app.state.config.OPENAI_API_KEY,
  203. },
  204. }
  205. @app.get("/reranking")
  206. async def get_reraanking_config(user=Depends(get_admin_user)):
  207. return {
  208. "status": True,
  209. "reranking_model": app.state.config.RAG_RERANKING_MODEL,
  210. }
  211. class OpenAIConfigForm(BaseModel):
  212. url: str
  213. key: str
  214. class EmbeddingModelUpdateForm(BaseModel):
  215. openai_config: Optional[OpenAIConfigForm] = None
  216. embedding_engine: str
  217. embedding_model: str
  218. @app.post("/embedding/update")
  219. async def update_embedding_config(
  220. form_data: EmbeddingModelUpdateForm, user=Depends(get_admin_user)
  221. ):
  222. log.info(
  223. f"Updating embedding model: {app.state.config.RAG_EMBEDDING_MODEL} to {form_data.embedding_model}"
  224. )
  225. try:
  226. app.state.config.RAG_EMBEDDING_ENGINE = form_data.embedding_engine
  227. app.state.config.RAG_EMBEDDING_MODEL = form_data.embedding_model
  228. if app.state.config.RAG_EMBEDDING_ENGINE in ["ollama", "openai"]:
  229. if form_data.openai_config != None:
  230. app.state.config.OPENAI_API_BASE_URL = form_data.openai_config.url
  231. app.state.config.OPENAI_API_KEY = form_data.openai_config.key
  232. update_embedding_model(app.state.config.RAG_EMBEDDING_MODEL)
  233. app.state.EMBEDDING_FUNCTION = get_embedding_function(
  234. app.state.config.RAG_EMBEDDING_ENGINE,
  235. app.state.config.RAG_EMBEDDING_MODEL,
  236. app.state.sentence_transformer_ef,
  237. app.state.config.OPENAI_API_KEY,
  238. app.state.config.OPENAI_API_BASE_URL,
  239. )
  240. return {
  241. "status": True,
  242. "embedding_engine": app.state.config.RAG_EMBEDDING_ENGINE,
  243. "embedding_model": app.state.config.RAG_EMBEDDING_MODEL,
  244. "openai_config": {
  245. "url": app.state.config.OPENAI_API_BASE_URL,
  246. "key": app.state.config.OPENAI_API_KEY,
  247. },
  248. }
  249. except Exception as e:
  250. log.exception(f"Problem updating embedding model: {e}")
  251. raise HTTPException(
  252. status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
  253. detail=ERROR_MESSAGES.DEFAULT(e),
  254. )
  255. class RerankingModelUpdateForm(BaseModel):
  256. reranking_model: str
  257. @app.post("/reranking/update")
  258. async def update_reranking_config(
  259. form_data: RerankingModelUpdateForm, user=Depends(get_admin_user)
  260. ):
  261. log.info(
  262. f"Updating reranking model: {app.state.config.RAG_RERANKING_MODEL} to {form_data.reranking_model}"
  263. )
  264. try:
  265. app.state.config.RAG_RERANKING_MODEL = form_data.reranking_model
  266. update_reranking_model(app.state.config.RAG_RERANKING_MODEL), True
  267. return {
  268. "status": True,
  269. "reranking_model": app.state.config.RAG_RERANKING_MODEL,
  270. }
  271. except Exception as e:
  272. log.exception(f"Problem updating reranking model: {e}")
  273. raise HTTPException(
  274. status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
  275. detail=ERROR_MESSAGES.DEFAULT(e),
  276. )
  277. @app.get("/config")
  278. async def get_rag_config(user=Depends(get_admin_user)):
  279. return {
  280. "status": True,
  281. "pdf_extract_images": app.state.config.PDF_EXTRACT_IMAGES,
  282. "chunk": {
  283. "chunk_size": app.state.config.CHUNK_SIZE,
  284. "chunk_overlap": app.state.config.CHUNK_OVERLAP,
  285. },
  286. "web_loader_ssl_verification": app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION,
  287. "youtube": {
  288. "language": app.state.config.YOUTUBE_LOADER_LANGUAGE,
  289. "translation": app.state.YOUTUBE_LOADER_TRANSLATION,
  290. },
  291. "web": {
  292. "search": {
  293. "enable": app.state.config.ENABLE_RAG_WEB_SEARCH,
  294. "searxng_query_url": app.state.config.SEARXNG_QUERY_URL,
  295. "google_pse_api_key": app.state.config.GOOGLE_PSE_API_KEY,
  296. "google_pse_engine_id": app.state.config.GOOGLE_PSE_ENGINE_ID,
  297. "serpstack_api_key": app.state.config.SERPSTACK_API_KEY,
  298. "serpstack_https": app.state.config.SERPSTACK_HTTPS,
  299. "serper_api_key": app.state.config.SERPER_API_KEY,
  300. "result_count": app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
  301. "concurrent_requests": app.state.config.RAG_WEB_SEARCH_CONCURRENT_REQUESTS,
  302. }
  303. },
  304. }
  305. class ChunkParamUpdateForm(BaseModel):
  306. chunk_size: int
  307. chunk_overlap: int
  308. class YoutubeLoaderConfig(BaseModel):
  309. language: List[str]
  310. translation: Optional[str] = None
  311. class WebSearchConfig(BaseModel):
  312. enable: bool
  313. searxng_query_url: Optional[str] = None
  314. google_pse_api_key: Optional[str] = None
  315. google_pse_engine_id: Optional[str] = None
  316. serpstack_api_key: Optional[str] = None
  317. serpstack_https: Optional[bool] = None
  318. serper_api_key: Optional[str] = None
  319. result_count: Optional[int] = None
  320. concurrent_requests: Optional[int] = None
  321. class ConfigUpdateForm(BaseModel):
  322. pdf_extract_images: Optional[bool] = None
  323. chunk: Optional[ChunkParamUpdateForm] = None
  324. web_loader_ssl_verification: Optional[bool] = None
  325. youtube: Optional[YoutubeLoaderConfig] = None
  326. @app.post("/config/update")
  327. async def update_rag_config(form_data: ConfigUpdateForm, user=Depends(get_admin_user)):
  328. app.state.config.PDF_EXTRACT_IMAGES = (
  329. form_data.pdf_extract_images
  330. if form_data.pdf_extract_images is not None
  331. else app.state.config.PDF_EXTRACT_IMAGES
  332. )
  333. app.state.config.CHUNK_SIZE = (
  334. form_data.chunk.chunk_size
  335. if form_data.chunk is not None
  336. else app.state.config.CHUNK_SIZE
  337. )
  338. app.state.config.CHUNK_OVERLAP = (
  339. form_data.chunk.chunk_overlap
  340. if form_data.chunk is not None
  341. else app.state.config.CHUNK_OVERLAP
  342. )
  343. app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION = (
  344. form_data.web_loader_ssl_verification
  345. if form_data.web_loader_ssl_verification != None
  346. else app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION
  347. )
  348. app.state.config.YOUTUBE_LOADER_LANGUAGE = (
  349. form_data.youtube.language
  350. if form_data.youtube is not None
  351. else app.state.config.YOUTUBE_LOADER_LANGUAGE
  352. )
  353. app.state.YOUTUBE_LOADER_TRANSLATION = (
  354. form_data.youtube.translation
  355. if form_data.youtube is not None
  356. else app.state.YOUTUBE_LOADER_TRANSLATION
  357. )
  358. return {
  359. "status": True,
  360. "pdf_extract_images": app.state.config.PDF_EXTRACT_IMAGES,
  361. "chunk": {
  362. "chunk_size": app.state.config.CHUNK_SIZE,
  363. "chunk_overlap": app.state.config.CHUNK_OVERLAP,
  364. },
  365. "web_loader_ssl_verification": app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION,
  366. "youtube": {
  367. "language": app.state.config.YOUTUBE_LOADER_LANGUAGE,
  368. "translation": app.state.YOUTUBE_LOADER_TRANSLATION,
  369. },
  370. }
  371. @app.get("/template")
  372. async def get_rag_template(user=Depends(get_current_user)):
  373. return {
  374. "status": True,
  375. "template": app.state.config.RAG_TEMPLATE,
  376. }
  377. @app.get("/query/settings")
  378. async def get_query_settings(user=Depends(get_admin_user)):
  379. return {
  380. "status": True,
  381. "template": app.state.config.RAG_TEMPLATE,
  382. "k": app.state.config.TOP_K,
  383. "r": app.state.config.RELEVANCE_THRESHOLD,
  384. "hybrid": app.state.config.ENABLE_RAG_HYBRID_SEARCH,
  385. }
  386. class QuerySettingsForm(BaseModel):
  387. k: Optional[int] = None
  388. r: Optional[float] = None
  389. template: Optional[str] = None
  390. hybrid: Optional[bool] = None
  391. @app.post("/query/settings/update")
  392. async def update_query_settings(
  393. form_data: QuerySettingsForm, user=Depends(get_admin_user)
  394. ):
  395. app.state.config.RAG_TEMPLATE = (
  396. form_data.template if form_data.template else RAG_TEMPLATE
  397. )
  398. app.state.config.TOP_K = form_data.k if form_data.k else 4
  399. app.state.config.RELEVANCE_THRESHOLD = form_data.r if form_data.r else 0.0
  400. app.state.config.ENABLE_RAG_HYBRID_SEARCH = (
  401. form_data.hybrid if form_data.hybrid else False
  402. )
  403. return {
  404. "status": True,
  405. "template": app.state.config.RAG_TEMPLATE,
  406. "k": app.state.config.TOP_K,
  407. "r": app.state.config.RELEVANCE_THRESHOLD,
  408. "hybrid": app.state.config.ENABLE_RAG_HYBRID_SEARCH,
  409. }
  410. class QueryDocForm(BaseModel):
  411. collection_name: str
  412. query: str
  413. k: Optional[int] = None
  414. r: Optional[float] = None
  415. hybrid: Optional[bool] = None
  416. @app.post("/query/doc")
  417. def query_doc_handler(
  418. form_data: QueryDocForm,
  419. user=Depends(get_current_user),
  420. ):
  421. try:
  422. if app.state.config.ENABLE_RAG_HYBRID_SEARCH:
  423. return query_doc_with_hybrid_search(
  424. collection_name=form_data.collection_name,
  425. query=form_data.query,
  426. embedding_function=app.state.EMBEDDING_FUNCTION,
  427. k=form_data.k if form_data.k else app.state.config.TOP_K,
  428. reranking_function=app.state.sentence_transformer_rf,
  429. r=(
  430. form_data.r if form_data.r else app.state.config.RELEVANCE_THRESHOLD
  431. ),
  432. )
  433. else:
  434. return query_doc(
  435. collection_name=form_data.collection_name,
  436. query=form_data.query,
  437. embedding_function=app.state.EMBEDDING_FUNCTION,
  438. k=form_data.k if form_data.k else app.state.config.TOP_K,
  439. )
  440. except Exception as e:
  441. log.exception(e)
  442. raise HTTPException(
  443. status_code=status.HTTP_400_BAD_REQUEST,
  444. detail=ERROR_MESSAGES.DEFAULT(e),
  445. )
  446. class QueryCollectionsForm(BaseModel):
  447. collection_names: List[str]
  448. query: str
  449. k: Optional[int] = None
  450. r: Optional[float] = None
  451. hybrid: Optional[bool] = None
  452. @app.post("/query/collection")
  453. def query_collection_handler(
  454. form_data: QueryCollectionsForm,
  455. user=Depends(get_current_user),
  456. ):
  457. try:
  458. if app.state.config.ENABLE_RAG_HYBRID_SEARCH:
  459. return query_collection_with_hybrid_search(
  460. collection_names=form_data.collection_names,
  461. query=form_data.query,
  462. embedding_function=app.state.EMBEDDING_FUNCTION,
  463. k=form_data.k if form_data.k else app.state.config.TOP_K,
  464. reranking_function=app.state.sentence_transformer_rf,
  465. r=(
  466. form_data.r if form_data.r else app.state.config.RELEVANCE_THRESHOLD
  467. ),
  468. )
  469. else:
  470. return query_collection(
  471. collection_names=form_data.collection_names,
  472. query=form_data.query,
  473. embedding_function=app.state.EMBEDDING_FUNCTION,
  474. k=form_data.k if form_data.k else app.state.config.TOP_K,
  475. )
  476. except Exception as e:
  477. log.exception(e)
  478. raise HTTPException(
  479. status_code=status.HTTP_400_BAD_REQUEST,
  480. detail=ERROR_MESSAGES.DEFAULT(e),
  481. )
  482. @app.post("/youtube")
  483. def store_youtube_video(form_data: UrlForm, user=Depends(get_current_user)):
  484. try:
  485. loader = YoutubeLoader.from_youtube_url(
  486. form_data.url,
  487. add_video_info=True,
  488. language=app.state.config.YOUTUBE_LOADER_LANGUAGE,
  489. translation=app.state.YOUTUBE_LOADER_TRANSLATION,
  490. )
  491. data = loader.load()
  492. collection_name = form_data.collection_name
  493. if collection_name == "":
  494. collection_name = calculate_sha256_string(form_data.url)[:63]
  495. store_data_in_vector_db(data, collection_name, overwrite=True)
  496. return {
  497. "status": True,
  498. "collection_name": collection_name,
  499. "filename": form_data.url,
  500. }
  501. except Exception as e:
  502. log.exception(e)
  503. raise HTTPException(
  504. status_code=status.HTTP_400_BAD_REQUEST,
  505. detail=ERROR_MESSAGES.DEFAULT(e),
  506. )
  507. @app.post("/web")
  508. def store_web(form_data: UrlForm, user=Depends(get_current_user)):
  509. # "https://www.gutenberg.org/files/1727/1727-h/1727-h.htm"
  510. try:
  511. loader = get_web_loader(
  512. form_data.url,
  513. verify_ssl=app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION,
  514. )
  515. data = loader.load()
  516. collection_name = form_data.collection_name
  517. if collection_name == "":
  518. collection_name = calculate_sha256_string(form_data.url)[:63]
  519. store_data_in_vector_db(data, collection_name, overwrite=True)
  520. return {
  521. "status": True,
  522. "collection_name": collection_name,
  523. "filename": form_data.url,
  524. }
  525. except Exception as e:
  526. log.exception(e)
  527. raise HTTPException(
  528. status_code=status.HTTP_400_BAD_REQUEST,
  529. detail=ERROR_MESSAGES.DEFAULT(e),
  530. )
  531. def get_web_loader(url: Union[str, Sequence[str]], verify_ssl: bool = True):
  532. # Check if the URL is valid
  533. if not validate_url(url):
  534. raise ValueError(ERROR_MESSAGES.INVALID_URL)
  535. return WebBaseLoader(
  536. url,
  537. verify_ssl=verify_ssl,
  538. requests_per_second=RAG_WEB_SEARCH_CONCURRENT_REQUESTS,
  539. continue_on_failure=True,
  540. )
  541. def validate_url(url: Union[str, Sequence[str]]):
  542. if isinstance(url, str):
  543. if isinstance(validators.url(url), validators.ValidationError):
  544. raise ValueError(ERROR_MESSAGES.INVALID_URL)
  545. if not ENABLE_RAG_LOCAL_WEB_FETCH:
  546. # Local web fetch is disabled, filter out any URLs that resolve to private IP addresses
  547. parsed_url = urllib.parse.urlparse(url)
  548. # Get IPv4 and IPv6 addresses
  549. ipv4_addresses, ipv6_addresses = resolve_hostname(parsed_url.hostname)
  550. # Check if any of the resolved addresses are private
  551. # This is technically still vulnerable to DNS rebinding attacks, as we don't control WebBaseLoader
  552. for ip in ipv4_addresses:
  553. if validators.ipv4(ip, private=True):
  554. raise ValueError(ERROR_MESSAGES.INVALID_URL)
  555. for ip in ipv6_addresses:
  556. if validators.ipv6(ip, private=True):
  557. raise ValueError(ERROR_MESSAGES.INVALID_URL)
  558. return True
  559. elif isinstance(url, Sequence):
  560. return all(validate_url(u) for u in url)
  561. else:
  562. return False
  563. def resolve_hostname(hostname):
  564. # Get address information
  565. addr_info = socket.getaddrinfo(hostname, None)
  566. # Extract IP addresses from address information
  567. ipv4_addresses = [info[4][0] for info in addr_info if info[0] == socket.AF_INET]
  568. ipv6_addresses = [info[4][0] for info in addr_info if info[0] == socket.AF_INET6]
  569. return ipv4_addresses, ipv6_addresses
  570. @app.post("/web/search")
  571. def store_web_search(form_data: SearchForm, user=Depends(get_current_user)):
  572. try:
  573. try:
  574. web_results = search_web(form_data.query)
  575. except Exception as e:
  576. log.exception(e)
  577. raise HTTPException(
  578. status_code=status.HTTP_400_BAD_REQUEST,
  579. detail=ERROR_MESSAGES.WEB_SEARCH_ERROR,
  580. )
  581. urls = [result.link for result in web_results]
  582. loader = get_web_loader(urls)
  583. data = loader.load()
  584. collection_name = form_data.collection_name
  585. if collection_name == "":
  586. collection_name = calculate_sha256_string(form_data.query)[:63]
  587. store_data_in_vector_db(data, collection_name, overwrite=True)
  588. return {
  589. "status": True,
  590. "collection_name": collection_name,
  591. "filenames": urls,
  592. }
  593. except Exception as e:
  594. log.exception(e)
  595. raise HTTPException(
  596. status_code=status.HTTP_400_BAD_REQUEST,
  597. detail=ERROR_MESSAGES.DEFAULT(e),
  598. )
  599. def store_data_in_vector_db(data, collection_name, overwrite: bool = False) -> bool:
  600. text_splitter = RecursiveCharacterTextSplitter(
  601. chunk_size=app.state.config.CHUNK_SIZE,
  602. chunk_overlap=app.state.config.CHUNK_OVERLAP,
  603. add_start_index=True,
  604. )
  605. docs = text_splitter.split_documents(data)
  606. if len(docs) > 0:
  607. log.info(f"store_data_in_vector_db {docs}")
  608. return store_docs_in_vector_db(docs, collection_name, overwrite), None
  609. else:
  610. raise ValueError(ERROR_MESSAGES.EMPTY_CONTENT)
  611. def store_text_in_vector_db(
  612. text, metadata, collection_name, overwrite: bool = False
  613. ) -> bool:
  614. text_splitter = RecursiveCharacterTextSplitter(
  615. chunk_size=app.state.config.CHUNK_SIZE,
  616. chunk_overlap=app.state.config.CHUNK_OVERLAP,
  617. add_start_index=True,
  618. )
  619. docs = text_splitter.create_documents([text], metadatas=[metadata])
  620. return store_docs_in_vector_db(docs, collection_name, overwrite)
  621. def store_docs_in_vector_db(docs, collection_name, overwrite: bool = False) -> bool:
  622. log.info(f"store_docs_in_vector_db {docs} {collection_name}")
  623. texts = [doc.page_content for doc in docs]
  624. metadatas = [doc.metadata for doc in docs]
  625. try:
  626. if overwrite:
  627. for collection in CHROMA_CLIENT.list_collections():
  628. if collection_name == collection.name:
  629. log.info(f"deleting existing collection {collection_name}")
  630. CHROMA_CLIENT.delete_collection(name=collection_name)
  631. collection = CHROMA_CLIENT.create_collection(name=collection_name)
  632. embedding_func = get_embedding_function(
  633. app.state.config.RAG_EMBEDDING_ENGINE,
  634. app.state.config.RAG_EMBEDDING_MODEL,
  635. app.state.sentence_transformer_ef,
  636. app.state.config.OPENAI_API_KEY,
  637. app.state.config.OPENAI_API_BASE_URL,
  638. )
  639. embedding_texts = list(map(lambda x: x.replace("\n", " "), texts))
  640. embeddings = embedding_func(embedding_texts)
  641. for batch in create_batches(
  642. api=CHROMA_CLIENT,
  643. ids=[str(uuid.uuid4()) for _ in texts],
  644. metadatas=metadatas,
  645. embeddings=embeddings,
  646. documents=texts,
  647. ):
  648. collection.add(*batch)
  649. return True
  650. except Exception as e:
  651. log.exception(e)
  652. if e.__class__.__name__ == "UniqueConstraintError":
  653. return True
  654. return False
  655. def get_loader(filename: str, file_content_type: str, file_path: str):
  656. file_ext = filename.split(".")[-1].lower()
  657. known_type = True
  658. known_source_ext = [
  659. "go",
  660. "py",
  661. "java",
  662. "sh",
  663. "bat",
  664. "ps1",
  665. "cmd",
  666. "js",
  667. "ts",
  668. "css",
  669. "cpp",
  670. "hpp",
  671. "h",
  672. "c",
  673. "cs",
  674. "sql",
  675. "log",
  676. "ini",
  677. "pl",
  678. "pm",
  679. "r",
  680. "dart",
  681. "dockerfile",
  682. "env",
  683. "php",
  684. "hs",
  685. "hsc",
  686. "lua",
  687. "nginxconf",
  688. "conf",
  689. "m",
  690. "mm",
  691. "plsql",
  692. "perl",
  693. "rb",
  694. "rs",
  695. "db2",
  696. "scala",
  697. "bash",
  698. "swift",
  699. "vue",
  700. "svelte",
  701. ]
  702. if file_ext == "pdf":
  703. loader = PyPDFLoader(
  704. file_path, extract_images=app.state.config.PDF_EXTRACT_IMAGES
  705. )
  706. elif file_ext == "csv":
  707. loader = CSVLoader(file_path)
  708. elif file_ext == "rst":
  709. loader = UnstructuredRSTLoader(file_path, mode="elements")
  710. elif file_ext == "xml":
  711. loader = UnstructuredXMLLoader(file_path)
  712. elif file_ext in ["htm", "html"]:
  713. loader = BSHTMLLoader(file_path, open_encoding="unicode_escape")
  714. elif file_ext == "md":
  715. loader = UnstructuredMarkdownLoader(file_path)
  716. elif file_content_type == "application/epub+zip":
  717. loader = UnstructuredEPubLoader(file_path)
  718. elif (
  719. file_content_type
  720. == "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
  721. or file_ext in ["doc", "docx"]
  722. ):
  723. loader = Docx2txtLoader(file_path)
  724. elif file_content_type in [
  725. "application/vnd.ms-excel",
  726. "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
  727. ] or file_ext in ["xls", "xlsx"]:
  728. loader = UnstructuredExcelLoader(file_path)
  729. elif file_content_type in [
  730. "application/vnd.ms-powerpoint",
  731. "application/vnd.openxmlformats-officedocument.presentationml.presentation",
  732. ] or file_ext in ["ppt", "pptx"]:
  733. loader = UnstructuredPowerPointLoader(file_path)
  734. elif file_ext in known_source_ext or (
  735. file_content_type and file_content_type.find("text/") >= 0
  736. ):
  737. loader = TextLoader(file_path, autodetect_encoding=True)
  738. else:
  739. loader = TextLoader(file_path, autodetect_encoding=True)
  740. known_type = False
  741. return loader, known_type
  742. @app.post("/doc")
  743. def store_doc(
  744. collection_name: Optional[str] = Form(None),
  745. file: UploadFile = File(...),
  746. user=Depends(get_current_user),
  747. ):
  748. # "https://www.gutenberg.org/files/1727/1727-h/1727-h.htm"
  749. log.info(f"file.content_type: {file.content_type}")
  750. try:
  751. unsanitized_filename = file.filename
  752. filename = os.path.basename(unsanitized_filename)
  753. file_path = f"{UPLOAD_DIR}/{filename}"
  754. contents = file.file.read()
  755. with open(file_path, "wb") as f:
  756. f.write(contents)
  757. f.close()
  758. f = open(file_path, "rb")
  759. if collection_name == None:
  760. collection_name = calculate_sha256(f)[:63]
  761. f.close()
  762. loader, known_type = get_loader(filename, file.content_type, file_path)
  763. data = loader.load()
  764. try:
  765. result = store_data_in_vector_db(data, collection_name)
  766. if result:
  767. return {
  768. "status": True,
  769. "collection_name": collection_name,
  770. "filename": filename,
  771. "known_type": known_type,
  772. }
  773. except Exception as e:
  774. raise HTTPException(
  775. status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
  776. detail=e,
  777. )
  778. except Exception as e:
  779. log.exception(e)
  780. if "No pandoc was found" in str(e):
  781. raise HTTPException(
  782. status_code=status.HTTP_400_BAD_REQUEST,
  783. detail=ERROR_MESSAGES.PANDOC_NOT_INSTALLED,
  784. )
  785. else:
  786. raise HTTPException(
  787. status_code=status.HTTP_400_BAD_REQUEST,
  788. detail=ERROR_MESSAGES.DEFAULT(e),
  789. )
  790. class TextRAGForm(BaseModel):
  791. name: str
  792. content: str
  793. collection_name: Optional[str] = None
  794. @app.post("/text")
  795. def store_text(
  796. form_data: TextRAGForm,
  797. user=Depends(get_current_user),
  798. ):
  799. collection_name = form_data.collection_name
  800. if collection_name == None:
  801. collection_name = calculate_sha256_string(form_data.content)
  802. result = store_text_in_vector_db(
  803. form_data.content,
  804. metadata={"name": form_data.name, "created_by": user.id},
  805. collection_name=collection_name,
  806. )
  807. if result:
  808. return {"status": True, "collection_name": collection_name}
  809. else:
  810. raise HTTPException(
  811. status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
  812. detail=ERROR_MESSAGES.DEFAULT(),
  813. )
  814. @app.get("/scan")
  815. def scan_docs_dir(user=Depends(get_admin_user)):
  816. for path in Path(DOCS_DIR).rglob("./**/*"):
  817. try:
  818. if path.is_file() and not path.name.startswith("."):
  819. tags = extract_folders_after_data_docs(path)
  820. filename = path.name
  821. file_content_type = mimetypes.guess_type(path)
  822. f = open(path, "rb")
  823. collection_name = calculate_sha256(f)[:63]
  824. f.close()
  825. loader, known_type = get_loader(
  826. filename, file_content_type[0], str(path)
  827. )
  828. data = loader.load()
  829. try:
  830. result = store_data_in_vector_db(data, collection_name)
  831. if result:
  832. sanitized_filename = sanitize_filename(filename)
  833. doc = Documents.get_doc_by_name(sanitized_filename)
  834. if doc == None:
  835. doc = Documents.insert_new_doc(
  836. user.id,
  837. DocumentForm(
  838. **{
  839. "name": sanitized_filename,
  840. "title": filename,
  841. "collection_name": collection_name,
  842. "filename": filename,
  843. "content": (
  844. json.dumps(
  845. {
  846. "tags": list(
  847. map(
  848. lambda name: {"name": name},
  849. tags,
  850. )
  851. )
  852. }
  853. )
  854. if len(tags)
  855. else "{}"
  856. ),
  857. }
  858. ),
  859. )
  860. except Exception as e:
  861. log.exception(e)
  862. pass
  863. except Exception as e:
  864. log.exception(e)
  865. return True
  866. @app.get("/reset/db")
  867. def reset_vector_db(user=Depends(get_admin_user)):
  868. CHROMA_CLIENT.reset()
  869. @app.get("/reset")
  870. def reset(user=Depends(get_admin_user)) -> bool:
  871. folder = f"{UPLOAD_DIR}"
  872. for filename in os.listdir(folder):
  873. file_path = os.path.join(folder, filename)
  874. try:
  875. if os.path.isfile(file_path) or os.path.islink(file_path):
  876. os.unlink(file_path)
  877. elif os.path.isdir(file_path):
  878. shutil.rmtree(file_path)
  879. except Exception as e:
  880. log.error("Failed to delete %s. Reason: %s" % (file_path, e))
  881. try:
  882. CHROMA_CLIENT.reset()
  883. except Exception as e:
  884. log.exception(e)
  885. return True
  886. if ENV == "dev":
  887. @app.get("/ef")
  888. async def get_embeddings():
  889. return {"result": app.state.EMBEDDING_FUNCTION("hello world")}
  890. @app.get("/ef/{text}")
  891. async def get_embeddings_text(text: str):
  892. return {"result": app.state.EMBEDDING_FUNCTION(text)}