main.py 31 KB

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