main.py 50 KB

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