main.py 51 KB

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