main.py 45 KB
Newer Older
Timothy J. Baek's avatar
Timothy J. Baek committed
1
2
3
4
5
6
7
8
9
from fastapi import (
    FastAPI,
    Depends,
    HTTPException,
    status,
    UploadFile,
    File,
    Form,
)
Timothy J. Baek's avatar
Timothy J. Baek committed
10
from fastapi.middleware.cors import CORSMiddleware
Que Nguyen's avatar
Que Nguyen committed
11
import requests
12
import os, shutil, logging, re
mindspawn's avatar
mindspawn committed
13
from datetime import datetime
14
15

from pathlib import Path
16
from typing import List, Union, Sequence, Iterator, Any
Timothy J. Baek's avatar
Timothy J. Baek committed
17

18
from chromadb.utils.batch_utils import create_batches
19
from langchain_core.documents import Document
Timothy J. Baek's avatar
Timothy J. Baek committed
20

Timothy J. Baek's avatar
Timothy J. Baek committed
21
22
23
24
25
from langchain_community.document_loaders import (
    WebBaseLoader,
    TextLoader,
    PyPDFLoader,
    CSVLoader,
26
    BSHTMLLoader,
Timothy J. Baek's avatar
Timothy J. Baek committed
27
    Docx2txtLoader,
Dave Bauman's avatar
Dave Bauman committed
28
    UnstructuredEPubLoader,
Timothy J. Baek's avatar
Timothy J. Baek committed
29
30
    UnstructuredWordDocumentLoader,
    UnstructuredMarkdownLoader,
31
    UnstructuredXMLLoader,
Marclass's avatar
Marclass committed
32
    UnstructuredRSTLoader,
Marclass's avatar
Marclass committed
33
    UnstructuredExcelLoader,
Timothy J. Baek's avatar
Timothy J. Baek committed
34
    UnstructuredPowerPointLoader,
Timothy J. Baek's avatar
Timothy J. Baek committed
35
    YoutubeLoader,
mindspawn's avatar
mindspawn committed
36
    OutlookMessageLoader,
Timothy J. Baek's avatar
Timothy J. Baek committed
37
)
38
39
from langchain.text_splitter import RecursiveCharacterTextSplitter

40
41
42
43
44
import validators
import urllib.parse
import socket


45
46
from pydantic import BaseModel
from typing import Optional
47
import mimetypes
48
import uuid
49
50
import json

Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
51
from apps.webui.models.documents import (
52
53
54
55
    Documents,
    DocumentForm,
    DocumentResponse,
)
Timothy J. Baek's avatar
Timothy J. Baek committed
56
57
58
from apps.webui.models.files import (
    Files,
)
Jannik Streidl's avatar
Jannik Streidl committed
59

60
from apps.rag.utils import (
61
    get_model_path,
Timothy J. Baek's avatar
Timothy J. Baek committed
62
63
64
65
66
    get_embedding_function,
    query_doc,
    query_doc_with_hybrid_search,
    query_collection,
    query_collection_with_hybrid_search,
67
)
Timothy J. Baek's avatar
Timothy J. Baek committed
68

Timothy J. Baek's avatar
Timothy J. Baek committed
69
70
71
72
73
74
from apps.rag.search.brave import search_brave
from apps.rag.search.google_pse import search_google_pse
from apps.rag.search.main import SearchResult
from apps.rag.search.searxng import search_searxng
from apps.rag.search.serper import search_serper
from apps.rag.search.serpstack import search_serpstack
75
from apps.rag.search.serply import search_serply
76
from apps.rag.search.duckduckgo import search_duckduckgo
77
from apps.rag.search.tavily import search_tavily
78
from apps.rag.search.jina_search import search_jina
Timothy J. Baek's avatar
Timothy J. Baek committed
79

80
81
82
83
84
85
from utils.misc import (
    calculate_sha256,
    calculate_sha256_string,
    sanitize_filename,
    extract_folders_after_data_docs,
)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
86
from utils.utils import get_verified_user, get_admin_user
87

88
from config import (
89
    AppConfig,
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
90
    ENV,
91
    SRC_LOG_LEVELS,
92
93
    UPLOAD_DIR,
    DOCS_DIR,
94
95
    RAG_TOP_K,
    RAG_RELEVANCE_THRESHOLD,
96
    RAG_EMBEDDING_ENGINE,
97
    RAG_EMBEDDING_MODEL,
98
    RAG_EMBEDDING_MODEL_AUTO_UPDATE,
99
    RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE,
Timothy J. Baek's avatar
Timothy J. Baek committed
100
    ENABLE_RAG_HYBRID_SEARCH,
101
    ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION,
Steven Kreitzer's avatar
Steven Kreitzer committed
102
    RAG_RERANKING_MODEL,
103
    PDF_EXTRACT_IMAGES,
104
    RAG_RERANKING_MODEL_AUTO_UPDATE,
Steven Kreitzer's avatar
Steven Kreitzer committed
105
    RAG_RERANKING_MODEL_TRUST_REMOTE_CODE,
Timothy J. Baek's avatar
Timothy J. Baek committed
106
107
    RAG_OPENAI_API_BASE_URL,
    RAG_OPENAI_API_KEY,
108
    DEVICE_TYPE,
109
110
111
    CHROMA_CLIENT,
    CHUNK_SIZE,
    CHUNK_OVERLAP,
Timothy J. Baek's avatar
Timothy J. Baek committed
112
    RAG_TEMPLATE,
113
    ENABLE_RAG_LOCAL_WEB_FETCH,
114
    YOUTUBE_LOADER_LANGUAGE,
Timothy J. Baek's avatar
Timothy J. Baek committed
115
    ENABLE_RAG_WEB_SEARCH,
Timothy J. Baek's avatar
Timothy J. Baek committed
116
    RAG_WEB_SEARCH_ENGINE,
Que Nguyen's avatar
Que Nguyen committed
117
    RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
Timothy J. Baek's avatar
Timothy J. Baek committed
118
119
120
    SEARXNG_QUERY_URL,
    GOOGLE_PSE_API_KEY,
    GOOGLE_PSE_ENGINE_ID,
Timothy J. Baek's avatar
Timothy J. Baek committed
121
    BRAVE_SEARCH_API_KEY,
Timothy J. Baek's avatar
Timothy J. Baek committed
122
123
124
    SERPSTACK_API_KEY,
    SERPSTACK_HTTPS,
    SERPER_API_KEY,
125
    SERPLY_API_KEY,
126
    TAVILY_API_KEY,
Timothy J. Baek's avatar
Timothy J. Baek committed
127
    RAG_WEB_SEARCH_RESULT_COUNT,
128
    RAG_WEB_SEARCH_CONCURRENT_REQUESTS,
129
    RAG_EMBEDDING_OPENAI_BATCH_SIZE,
130
)
131

132
133
from constants import ERROR_MESSAGES

134
135
136
log = logging.getLogger(__name__)
log.setLevel(SRC_LOG_LEVELS["RAG"])

Timothy J. Baek's avatar
Timothy J. Baek committed
137
138
app = FastAPI()

139
app.state.config = AppConfig()
Timothy J. Baek's avatar
Timothy J. Baek committed
140

141
142
143
144
145
app.state.config.TOP_K = RAG_TOP_K
app.state.config.RELEVANCE_THRESHOLD = RAG_RELEVANCE_THRESHOLD

app.state.config.ENABLE_RAG_HYBRID_SEARCH = ENABLE_RAG_HYBRID_SEARCH
app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION = (
146
147
    ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION
)
Steven Kreitzer's avatar
Steven Kreitzer committed
148

149
150
app.state.config.CHUNK_SIZE = CHUNK_SIZE
app.state.config.CHUNK_OVERLAP = CHUNK_OVERLAP
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
151

152
153
app.state.config.RAG_EMBEDDING_ENGINE = RAG_EMBEDDING_ENGINE
app.state.config.RAG_EMBEDDING_MODEL = RAG_EMBEDDING_MODEL
154
app.state.config.RAG_EMBEDDING_OPENAI_BATCH_SIZE = RAG_EMBEDDING_OPENAI_BATCH_SIZE
155
156
app.state.config.RAG_RERANKING_MODEL = RAG_RERANKING_MODEL
app.state.config.RAG_TEMPLATE = RAG_TEMPLATE
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
157

158

159
160
app.state.config.OPENAI_API_BASE_URL = RAG_OPENAI_API_BASE_URL
app.state.config.OPENAI_API_KEY = RAG_OPENAI_API_KEY
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
161

162
app.state.config.PDF_EXTRACT_IMAGES = PDF_EXTRACT_IMAGES
163

Steven Kreitzer's avatar
Steven Kreitzer committed
164

165
app.state.config.YOUTUBE_LOADER_LANGUAGE = YOUTUBE_LOADER_LANGUAGE
166
167
168
app.state.YOUTUBE_LOADER_TRANSLATION = None


Timothy J. Baek's avatar
Timothy J. Baek committed
169
app.state.config.ENABLE_RAG_WEB_SEARCH = ENABLE_RAG_WEB_SEARCH
Timothy J. Baek's avatar
Timothy J. Baek committed
170
app.state.config.RAG_WEB_SEARCH_ENGINE = RAG_WEB_SEARCH_ENGINE
Que Nguyen's avatar
Que Nguyen committed
171
app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST = RAG_WEB_SEARCH_DOMAIN_FILTER_LIST
Timothy J. Baek's avatar
Timothy J. Baek committed
172

Timothy J. Baek's avatar
Timothy J. Baek committed
173
174
175
app.state.config.SEARXNG_QUERY_URL = SEARXNG_QUERY_URL
app.state.config.GOOGLE_PSE_API_KEY = GOOGLE_PSE_API_KEY
app.state.config.GOOGLE_PSE_ENGINE_ID = GOOGLE_PSE_ENGINE_ID
Timothy J. Baek's avatar
Timothy J. Baek committed
176
app.state.config.BRAVE_SEARCH_API_KEY = BRAVE_SEARCH_API_KEY
Timothy J. Baek's avatar
Timothy J. Baek committed
177
178
179
app.state.config.SERPSTACK_API_KEY = SERPSTACK_API_KEY
app.state.config.SERPSTACK_HTTPS = SERPSTACK_HTTPS
app.state.config.SERPER_API_KEY = SERPER_API_KEY
180
app.state.config.SERPLY_API_KEY = SERPLY_API_KEY
181
app.state.config.TAVILY_API_KEY = TAVILY_API_KEY
Timothy J. Baek's avatar
Timothy J. Baek committed
182
183
184
185
app.state.config.RAG_WEB_SEARCH_RESULT_COUNT = RAG_WEB_SEARCH_RESULT_COUNT
app.state.config.RAG_WEB_SEARCH_CONCURRENT_REQUESTS = RAG_WEB_SEARCH_CONCURRENT_REQUESTS


186
187
188
189
def update_embedding_model(
    embedding_model: str,
    update_model: bool = False,
):
190
    if embedding_model and app.state.config.RAG_EMBEDDING_ENGINE == "":
191
192
        import sentence_transformers

193
194
195
196
197
198
199
200
201
202
203
204
205
206
        app.state.sentence_transformer_ef = sentence_transformers.SentenceTransformer(
            get_model_path(embedding_model, update_model),
            device=DEVICE_TYPE,
            trust_remote_code=RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE,
        )
    else:
        app.state.sentence_transformer_ef = None


def update_reranking_model(
    reranking_model: str,
    update_model: bool = False,
):
    if reranking_model:
207
208
        import sentence_transformers

209
210
211
212
213
214
215
216
217
218
        app.state.sentence_transformer_rf = sentence_transformers.CrossEncoder(
            get_model_path(reranking_model, update_model),
            device=DEVICE_TYPE,
            trust_remote_code=RAG_RERANKING_MODEL_TRUST_REMOTE_CODE,
        )
    else:
        app.state.sentence_transformer_rf = None


update_embedding_model(
219
    app.state.config.RAG_EMBEDDING_MODEL,
220
221
222
223
    RAG_EMBEDDING_MODEL_AUTO_UPDATE,
)

update_reranking_model(
224
    app.state.config.RAG_RERANKING_MODEL,
225
226
    RAG_RERANKING_MODEL_AUTO_UPDATE,
)
Timothy J. Baek's avatar
Timothy J. Baek committed
227

Timothy J. Baek's avatar
Timothy J. Baek committed
228
229

app.state.EMBEDDING_FUNCTION = get_embedding_function(
230
231
    app.state.config.RAG_EMBEDDING_ENGINE,
    app.state.config.RAG_EMBEDDING_MODEL,
Timothy J. Baek's avatar
Timothy J. Baek committed
232
    app.state.sentence_transformer_ef,
233
234
    app.state.config.OPENAI_API_KEY,
    app.state.config.OPENAI_API_BASE_URL,
235
    app.state.config.RAG_EMBEDDING_OPENAI_BATCH_SIZE,
Timothy J. Baek's avatar
Timothy J. Baek committed
236
237
)

Timothy J. Baek's avatar
Timothy J. Baek committed
238
239
origins = ["*"]

240

Timothy J. Baek's avatar
Timothy J. Baek committed
241
242
243
244
245
246
247
248
249
app.add_middleware(
    CORSMiddleware,
    allow_origins=origins,
    allow_credentials=True,
    allow_methods=["*"],
    allow_headers=["*"],
)


Timothy J. Baek's avatar
Timothy J. Baek committed
250
class CollectionNameForm(BaseModel):
251
252
253
    collection_name: Optional[str] = "test"


Timothy J. Baek's avatar
Timothy J. Baek committed
254
class UrlForm(CollectionNameForm):
Timothy J. Baek's avatar
Timothy J. Baek committed
255
256
    url: str

Timothy J. Baek's avatar
Timothy J. Baek committed
257

258
259
260
261
class SearchForm(CollectionNameForm):
    query: str


Timothy J. Baek's avatar
Timothy J. Baek committed
262
263
@app.get("/")
async def get_status():
Timothy J. Baek's avatar
Timothy J. Baek committed
264
265
    return {
        "status": True,
266
267
268
269
270
271
        "chunk_size": app.state.config.CHUNK_SIZE,
        "chunk_overlap": app.state.config.CHUNK_OVERLAP,
        "template": app.state.config.RAG_TEMPLATE,
        "embedding_engine": app.state.config.RAG_EMBEDDING_ENGINE,
        "embedding_model": app.state.config.RAG_EMBEDDING_MODEL,
        "reranking_model": app.state.config.RAG_RERANKING_MODEL,
272
        "openai_batch_size": app.state.config.RAG_EMBEDDING_OPENAI_BATCH_SIZE,
273
274
275
    }


Timothy J. Baek's avatar
Timothy J. Baek committed
276
277
@app.get("/embedding")
async def get_embedding_config(user=Depends(get_admin_user)):
278
279
    return {
        "status": True,
280
281
        "embedding_engine": app.state.config.RAG_EMBEDDING_ENGINE,
        "embedding_model": app.state.config.RAG_EMBEDDING_MODEL,
282
        "openai_config": {
283
284
            "url": app.state.config.OPENAI_API_BASE_URL,
            "key": app.state.config.OPENAI_API_KEY,
285
            "batch_size": app.state.config.RAG_EMBEDDING_OPENAI_BATCH_SIZE,
286
        },
287
288
289
    }


Steven Kreitzer's avatar
Steven Kreitzer committed
290
291
@app.get("/reranking")
async def get_reraanking_config(user=Depends(get_admin_user)):
292
293
    return {
        "status": True,
294
        "reranking_model": app.state.config.RAG_RERANKING_MODEL,
295
    }
Steven Kreitzer's avatar
Steven Kreitzer committed
296
297


298
299
300
class OpenAIConfigForm(BaseModel):
    url: str
    key: str
301
    batch_size: Optional[int] = None
302
303


304
class EmbeddingModelUpdateForm(BaseModel):
305
    openai_config: Optional[OpenAIConfigForm] = None
Timothy J. Baek's avatar
Timothy J. Baek committed
306
    embedding_engine: str
307
308
309
    embedding_model: str


Timothy J. Baek's avatar
Timothy J. Baek committed
310
311
@app.post("/embedding/update")
async def update_embedding_config(
312
313
    form_data: EmbeddingModelUpdateForm, user=Depends(get_admin_user)
):
Self Denial's avatar
Self Denial committed
314
    log.info(
315
        f"Updating embedding model: {app.state.config.RAG_EMBEDDING_MODEL} to {form_data.embedding_model}"
316
    )
317
    try:
318
319
        app.state.config.RAG_EMBEDDING_ENGINE = form_data.embedding_engine
        app.state.config.RAG_EMBEDDING_MODEL = form_data.embedding_model
Timothy J. Baek's avatar
Timothy J. Baek committed
320

321
        if app.state.config.RAG_EMBEDDING_ENGINE in ["ollama", "openai"]:
322
            if form_data.openai_config is not None:
323
324
                app.state.config.OPENAI_API_BASE_URL = form_data.openai_config.url
                app.state.config.OPENAI_API_KEY = form_data.openai_config.key
325
326
327
328
329
                app.state.config.RAG_EMBEDDING_OPENAI_BATCH_SIZE = (
                    form_data.openai_config.batch_size
                    if form_data.openai_config.batch_size
                    else 1
                )
330

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
331
        update_embedding_model(app.state.config.RAG_EMBEDDING_MODEL)
332

Timothy J. Baek's avatar
Timothy J. Baek committed
333
        app.state.EMBEDDING_FUNCTION = get_embedding_function(
334
335
            app.state.config.RAG_EMBEDDING_ENGINE,
            app.state.config.RAG_EMBEDDING_MODEL,
Timothy J. Baek's avatar
Timothy J. Baek committed
336
            app.state.sentence_transformer_ef,
337
338
            app.state.config.OPENAI_API_KEY,
            app.state.config.OPENAI_API_BASE_URL,
339
            app.state.config.RAG_EMBEDDING_OPENAI_BATCH_SIZE,
Timothy J. Baek's avatar
Timothy J. Baek committed
340
341
        )

342
343
        return {
            "status": True,
344
345
            "embedding_engine": app.state.config.RAG_EMBEDDING_ENGINE,
            "embedding_model": app.state.config.RAG_EMBEDDING_MODEL,
346
            "openai_config": {
347
348
                "url": app.state.config.OPENAI_API_BASE_URL,
                "key": app.state.config.OPENAI_API_KEY,
349
                "batch_size": app.state.config.RAG_EMBEDDING_OPENAI_BATCH_SIZE,
350
            },
351
352
353
354
355
356
357
        }
    except Exception as e:
        log.exception(f"Problem updating embedding model: {e}")
        raise HTTPException(
            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
            detail=ERROR_MESSAGES.DEFAULT(e),
        )
Timothy J. Baek's avatar
Timothy J. Baek committed
358
359


Steven Kreitzer's avatar
Steven Kreitzer committed
360
361
class RerankingModelUpdateForm(BaseModel):
    reranking_model: str
362

Steven Kreitzer's avatar
Steven Kreitzer committed
363
364
365
366
367
368

@app.post("/reranking/update")
async def update_reranking_config(
    form_data: RerankingModelUpdateForm, user=Depends(get_admin_user)
):
    log.info(
369
        f"Updating reranking model: {app.state.config.RAG_RERANKING_MODEL} to {form_data.reranking_model}"
Steven Kreitzer's avatar
Steven Kreitzer committed
370
371
    )
    try:
372
        app.state.config.RAG_RERANKING_MODEL = form_data.reranking_model
373

374
        update_reranking_model(app.state.config.RAG_RERANKING_MODEL), True
Steven Kreitzer's avatar
Steven Kreitzer committed
375
376
377

        return {
            "status": True,
378
            "reranking_model": app.state.config.RAG_RERANKING_MODEL,
Steven Kreitzer's avatar
Steven Kreitzer committed
379
380
381
382
383
384
385
386
387
        }
    except Exception as e:
        log.exception(f"Problem updating reranking model: {e}")
        raise HTTPException(
            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
            detail=ERROR_MESSAGES.DEFAULT(e),
        )


Timothy J. Baek's avatar
Timothy J. Baek committed
388
389
@app.get("/config")
async def get_rag_config(user=Depends(get_admin_user)):
Timothy J. Baek's avatar
Timothy J. Baek committed
390
391
    return {
        "status": True,
392
        "pdf_extract_images": app.state.config.PDF_EXTRACT_IMAGES,
Timothy J. Baek's avatar
Timothy J. Baek committed
393
        "chunk": {
394
395
            "chunk_size": app.state.config.CHUNK_SIZE,
            "chunk_overlap": app.state.config.CHUNK_OVERLAP,
Timothy J. Baek's avatar
Timothy J. Baek committed
396
        },
397
        "youtube": {
398
            "language": app.state.config.YOUTUBE_LOADER_LANGUAGE,
399
400
            "translation": app.state.YOUTUBE_LOADER_TRANSLATION,
        },
Timothy J. Baek's avatar
Timothy J. Baek committed
401
        "web": {
Timothy J. Baek's avatar
Timothy J. Baek committed
402
            "ssl_verification": app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION,
Timothy J. Baek's avatar
Timothy J. Baek committed
403
            "search": {
Timothy J. Baek's avatar
Timothy J. Baek committed
404
                "enabled": app.state.config.ENABLE_RAG_WEB_SEARCH,
Timothy J. Baek's avatar
Timothy J. Baek committed
405
                "engine": app.state.config.RAG_WEB_SEARCH_ENGINE,
Timothy J. Baek's avatar
Timothy J. Baek committed
406
407
408
                "searxng_query_url": app.state.config.SEARXNG_QUERY_URL,
                "google_pse_api_key": app.state.config.GOOGLE_PSE_API_KEY,
                "google_pse_engine_id": app.state.config.GOOGLE_PSE_ENGINE_ID,
Timothy J. Baek's avatar
Timothy J. Baek committed
409
                "brave_search_api_key": app.state.config.BRAVE_SEARCH_API_KEY,
Timothy J. Baek's avatar
Timothy J. Baek committed
410
411
412
                "serpstack_api_key": app.state.config.SERPSTACK_API_KEY,
                "serpstack_https": app.state.config.SERPSTACK_HTTPS,
                "serper_api_key": app.state.config.SERPER_API_KEY,
413
                "serply_api_key": app.state.config.SERPLY_API_KEY,
414
                "tavily_api_key": app.state.config.TAVILY_API_KEY,
Timothy J. Baek's avatar
Timothy J. Baek committed
415
416
                "result_count": app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
                "concurrent_requests": app.state.config.RAG_WEB_SEARCH_CONCURRENT_REQUESTS,
Timothy J. Baek's avatar
Timothy J. Baek committed
417
            },
Timothy J. Baek's avatar
Timothy J. Baek committed
418
        },
Timothy J. Baek's avatar
Timothy J. Baek committed
419
420
421
422
423
424
425
426
    }


class ChunkParamUpdateForm(BaseModel):
    chunk_size: int
    chunk_overlap: int


427
428
429
430
431
class YoutubeLoaderConfig(BaseModel):
    language: List[str]
    translation: Optional[str] = None


Timothy J. Baek's avatar
Timothy J. Baek committed
432
class WebSearchConfig(BaseModel):
Timothy J. Baek's avatar
Timothy J. Baek committed
433
    enabled: bool
Timothy J. Baek's avatar
Timothy J. Baek committed
434
    engine: Optional[str] = None
Timothy J. Baek's avatar
Timothy J. Baek committed
435
436
437
    searxng_query_url: Optional[str] = None
    google_pse_api_key: Optional[str] = None
    google_pse_engine_id: Optional[str] = None
Timothy J. Baek's avatar
Timothy J. Baek committed
438
    brave_search_api_key: Optional[str] = None
Timothy J. Baek's avatar
Timothy J. Baek committed
439
440
441
    serpstack_api_key: Optional[str] = None
    serpstack_https: Optional[bool] = None
    serper_api_key: Optional[str] = None
442
    serply_api_key: Optional[str] = None
443
    tavily_api_key: Optional[str] = None
Timothy J. Baek's avatar
Timothy J. Baek committed
444
445
446
447
    result_count: Optional[int] = None
    concurrent_requests: Optional[int] = None


Timothy J. Baek's avatar
Timothy J. Baek committed
448
449
450
451
452
class WebConfig(BaseModel):
    search: WebSearchConfig
    web_loader_ssl_verification: Optional[bool] = None


Timothy J. Baek's avatar
Timothy J. Baek committed
453
class ConfigUpdateForm(BaseModel):
454
455
    pdf_extract_images: Optional[bool] = None
    chunk: Optional[ChunkParamUpdateForm] = None
456
    youtube: Optional[YoutubeLoaderConfig] = None
Timothy J. Baek's avatar
Timothy J. Baek committed
457
    web: Optional[WebConfig] = None
Timothy J. Baek's avatar
Timothy J. Baek committed
458
459
460
461


@app.post("/config/update")
async def update_rag_config(form_data: ConfigUpdateForm, user=Depends(get_admin_user)):
462
    app.state.config.PDF_EXTRACT_IMAGES = (
463
        form_data.pdf_extract_images
464
465
        if form_data.pdf_extract_images is not None
        else app.state.config.PDF_EXTRACT_IMAGES
466
467
    )

Timothy J. Baek's avatar
Timothy J. Baek committed
468
469
470
    if form_data.chunk is not None:
        app.state.config.CHUNK_SIZE = form_data.chunk.chunk_size
        app.state.config.CHUNK_OVERLAP = form_data.chunk.chunk_overlap
471

Timothy J. Baek's avatar
Timothy J. Baek committed
472
473
474
    if form_data.youtube is not None:
        app.state.config.YOUTUBE_LOADER_LANGUAGE = form_data.youtube.language
        app.state.YOUTUBE_LOADER_TRANSLATION = form_data.youtube.translation
475

Timothy J. Baek's avatar
Timothy J. Baek committed
476
477
478
479
    if form_data.web is not None:
        app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION = (
            form_data.web.web_loader_ssl_verification
        )
480

Timothy J. Baek's avatar
Timothy J. Baek committed
481
        app.state.config.ENABLE_RAG_WEB_SEARCH = form_data.web.search.enabled
Timothy J. Baek's avatar
Timothy J. Baek committed
482
483
484
485
486
487
488
489
490
491
492
493
        app.state.config.RAG_WEB_SEARCH_ENGINE = form_data.web.search.engine
        app.state.config.SEARXNG_QUERY_URL = form_data.web.search.searxng_query_url
        app.state.config.GOOGLE_PSE_API_KEY = form_data.web.search.google_pse_api_key
        app.state.config.GOOGLE_PSE_ENGINE_ID = (
            form_data.web.search.google_pse_engine_id
        )
        app.state.config.BRAVE_SEARCH_API_KEY = (
            form_data.web.search.brave_search_api_key
        )
        app.state.config.SERPSTACK_API_KEY = form_data.web.search.serpstack_api_key
        app.state.config.SERPSTACK_HTTPS = form_data.web.search.serpstack_https
        app.state.config.SERPER_API_KEY = form_data.web.search.serper_api_key
494
        app.state.config.SERPLY_API_KEY = form_data.web.search.serply_api_key
495
        app.state.config.TAVILY_API_KEY = form_data.web.search.tavily_api_key
Timothy J. Baek's avatar
Timothy J. Baek committed
496
497
498
499
        app.state.config.RAG_WEB_SEARCH_RESULT_COUNT = form_data.web.search.result_count
        app.state.config.RAG_WEB_SEARCH_CONCURRENT_REQUESTS = (
            form_data.web.search.concurrent_requests
        )
500

Timothy J. Baek's avatar
Timothy J. Baek committed
501
502
    return {
        "status": True,
503
        "pdf_extract_images": app.state.config.PDF_EXTRACT_IMAGES,
Timothy J. Baek's avatar
Timothy J. Baek committed
504
        "chunk": {
505
506
            "chunk_size": app.state.config.CHUNK_SIZE,
            "chunk_overlap": app.state.config.CHUNK_OVERLAP,
Timothy J. Baek's avatar
Timothy J. Baek committed
507
        },
508
        "youtube": {
509
            "language": app.state.config.YOUTUBE_LOADER_LANGUAGE,
510
511
            "translation": app.state.YOUTUBE_LOADER_TRANSLATION,
        },
Timothy J. Baek's avatar
Timothy J. Baek committed
512
513
514
        "web": {
            "ssl_verification": app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION,
            "search": {
Timothy J. Baek's avatar
Timothy J. Baek committed
515
                "enabled": app.state.config.ENABLE_RAG_WEB_SEARCH,
Timothy J. Baek's avatar
Timothy J. Baek committed
516
517
518
519
520
521
522
523
                "engine": app.state.config.RAG_WEB_SEARCH_ENGINE,
                "searxng_query_url": app.state.config.SEARXNG_QUERY_URL,
                "google_pse_api_key": app.state.config.GOOGLE_PSE_API_KEY,
                "google_pse_engine_id": app.state.config.GOOGLE_PSE_ENGINE_ID,
                "brave_search_api_key": app.state.config.BRAVE_SEARCH_API_KEY,
                "serpstack_api_key": app.state.config.SERPSTACK_API_KEY,
                "serpstack_https": app.state.config.SERPSTACK_HTTPS,
                "serper_api_key": app.state.config.SERPER_API_KEY,
524
                "serply_api_key": app.state.config.SERPLY_API_KEY,
525
                "tavily_api_key": app.state.config.TAVILY_API_KEY,
Timothy J. Baek's avatar
Timothy J. Baek committed
526
527
528
529
                "result_count": app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
                "concurrent_requests": app.state.config.RAG_WEB_SEARCH_CONCURRENT_REQUESTS,
            },
        },
Timothy J. Baek's avatar
Timothy J. Baek committed
530
    }
531
532


Timothy J. Baek's avatar
Timothy J. Baek committed
533
@app.get("/template")
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
534
async def get_rag_template(user=Depends(get_verified_user)):
Timothy J. Baek's avatar
Timothy J. Baek committed
535
536
    return {
        "status": True,
537
        "template": app.state.config.RAG_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
538
539
540
    }


541
542
543
544
@app.get("/query/settings")
async def get_query_settings(user=Depends(get_admin_user)):
    return {
        "status": True,
545
546
547
548
        "template": app.state.config.RAG_TEMPLATE,
        "k": app.state.config.TOP_K,
        "r": app.state.config.RELEVANCE_THRESHOLD,
        "hybrid": app.state.config.ENABLE_RAG_HYBRID_SEARCH,
549
    }
Timothy J. Baek's avatar
Timothy J. Baek committed
550
551


552
553
class QuerySettingsForm(BaseModel):
    k: Optional[int] = None
554
    r: Optional[float] = None
555
    template: Optional[str] = None
Steven Kreitzer's avatar
Steven Kreitzer committed
556
    hybrid: Optional[bool] = None
557
558
559
560
561
562


@app.post("/query/settings/update")
async def update_query_settings(
    form_data: QuerySettingsForm, user=Depends(get_admin_user)
):
563
    app.state.config.RAG_TEMPLATE = (
Timothy J. Baek's avatar
Timothy J. Baek committed
564
        form_data.template if form_data.template else RAG_TEMPLATE
565
    )
566
567
568
    app.state.config.TOP_K = form_data.k if form_data.k else 4
    app.state.config.RELEVANCE_THRESHOLD = form_data.r if form_data.r else 0.0
    app.state.config.ENABLE_RAG_HYBRID_SEARCH = (
Timothy J. Baek's avatar
Timothy J. Baek committed
569
        form_data.hybrid if form_data.hybrid else False
570
    )
Steven Kreitzer's avatar
Steven Kreitzer committed
571
572
    return {
        "status": True,
573
574
575
576
        "template": app.state.config.RAG_TEMPLATE,
        "k": app.state.config.TOP_K,
        "r": app.state.config.RELEVANCE_THRESHOLD,
        "hybrid": app.state.config.ENABLE_RAG_HYBRID_SEARCH,
Steven Kreitzer's avatar
Steven Kreitzer committed
577
    }
578
579


580
class QueryDocForm(BaseModel):
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
581
582
    collection_name: str
    query: str
583
    k: Optional[int] = None
584
    r: Optional[float] = None
Steven Kreitzer's avatar
Steven Kreitzer committed
585
    hybrid: Optional[bool] = None
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
586
587


588
@app.post("/query/doc")
Timothy J. Baek's avatar
Timothy J. Baek committed
589
def query_doc_handler(
590
    form_data: QueryDocForm,
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
591
    user=Depends(get_verified_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
592
):
593
    try:
594
        if app.state.config.ENABLE_RAG_HYBRID_SEARCH:
Timothy J. Baek's avatar
Timothy J. Baek committed
595
596
597
            return query_doc_with_hybrid_search(
                collection_name=form_data.collection_name,
                query=form_data.query,
Steven Kreitzer's avatar
Steven Kreitzer committed
598
                embedding_function=app.state.EMBEDDING_FUNCTION,
599
                k=form_data.k if form_data.k else app.state.config.TOP_K,
Steven Kreitzer's avatar
Steven Kreitzer committed
600
                reranking_function=app.state.sentence_transformer_rf,
601
                r=(
602
                    form_data.r if form_data.r else app.state.config.RELEVANCE_THRESHOLD
603
                ),
Timothy J. Baek's avatar
Timothy J. Baek committed
604
605
606
607
608
            )
        else:
            return query_doc(
                collection_name=form_data.collection_name,
                query=form_data.query,
Steven Kreitzer's avatar
Steven Kreitzer committed
609
                embedding_function=app.state.EMBEDDING_FUNCTION,
610
                k=form_data.k if form_data.k else app.state.config.TOP_K,
Timothy J. Baek's avatar
Timothy J. Baek committed
611
            )
612
    except Exception as e:
613
        log.exception(e)
614
615
616
617
        raise HTTPException(
            status_code=status.HTTP_400_BAD_REQUEST,
            detail=ERROR_MESSAGES.DEFAULT(e),
        )
618
619


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
620
621
622
class QueryCollectionsForm(BaseModel):
    collection_names: List[str]
    query: str
623
    k: Optional[int] = None
624
    r: Optional[float] = None
Steven Kreitzer's avatar
Steven Kreitzer committed
625
    hybrid: Optional[bool] = None
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
626
627


628
@app.post("/query/collection")
Timothy J. Baek's avatar
Timothy J. Baek committed
629
def query_collection_handler(
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
630
    form_data: QueryCollectionsForm,
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
631
    user=Depends(get_verified_user),
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
632
):
633
    try:
634
        if app.state.config.ENABLE_RAG_HYBRID_SEARCH:
Timothy J. Baek's avatar
Timothy J. Baek committed
635
636
637
            return query_collection_with_hybrid_search(
                collection_names=form_data.collection_names,
                query=form_data.query,
Steven Kreitzer's avatar
Steven Kreitzer committed
638
                embedding_function=app.state.EMBEDDING_FUNCTION,
639
                k=form_data.k if form_data.k else app.state.config.TOP_K,
Steven Kreitzer's avatar
Steven Kreitzer committed
640
                reranking_function=app.state.sentence_transformer_rf,
641
                r=(
642
                    form_data.r if form_data.r else app.state.config.RELEVANCE_THRESHOLD
643
                ),
Timothy J. Baek's avatar
Timothy J. Baek committed
644
645
646
647
648
            )
        else:
            return query_collection(
                collection_names=form_data.collection_names,
                query=form_data.query,
Steven Kreitzer's avatar
Steven Kreitzer committed
649
                embedding_function=app.state.EMBEDDING_FUNCTION,
650
                k=form_data.k if form_data.k else app.state.config.TOP_K,
Timothy J. Baek's avatar
Timothy J. Baek committed
651
            )
652

653
654
655
656
657
658
    except Exception as e:
        log.exception(e)
        raise HTTPException(
            status_code=status.HTTP_400_BAD_REQUEST,
            detail=ERROR_MESSAGES.DEFAULT(e),
        )
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
659
660


Timothy J. Baek's avatar
Timothy J. Baek committed
661
@app.post("/youtube")
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
662
def store_youtube_video(form_data: UrlForm, user=Depends(get_verified_user)):
Timothy J. Baek's avatar
Timothy J. Baek committed
663
    try:
664
665
666
        loader = YoutubeLoader.from_youtube_url(
            form_data.url,
            add_video_info=True,
667
            language=app.state.config.YOUTUBE_LOADER_LANGUAGE,
668
669
            translation=app.state.YOUTUBE_LOADER_TRANSLATION,
        )
Timothy J. Baek's avatar
Timothy J. Baek committed
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
        data = loader.load()

        collection_name = form_data.collection_name
        if collection_name == "":
            collection_name = calculate_sha256_string(form_data.url)[:63]

        store_data_in_vector_db(data, collection_name, overwrite=True)
        return {
            "status": True,
            "collection_name": collection_name,
            "filename": form_data.url,
        }
    except Exception as e:
        log.exception(e)
        raise HTTPException(
            status_code=status.HTTP_400_BAD_REQUEST,
            detail=ERROR_MESSAGES.DEFAULT(e),
        )


690
@app.post("/web")
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
691
def store_web(form_data: UrlForm, user=Depends(get_verified_user)):
692
693
    # "https://www.gutenberg.org/files/1727/1727-h/1727-h.htm"
    try:
694
        loader = get_web_loader(
695
            form_data.url,
696
            verify_ssl=app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION,
697
        )
698
        data = loader.load()
Timothy J. Baek's avatar
Timothy J. Baek committed
699
700
701
702
703

        collection_name = form_data.collection_name
        if collection_name == "":
            collection_name = calculate_sha256_string(form_data.url)[:63]

704
        store_data_in_vector_db(data, collection_name, overwrite=True)
Timothy J. Baek's avatar
Timothy J. Baek committed
705
706
        return {
            "status": True,
Timothy J. Baek's avatar
Timothy J. Baek committed
707
            "collection_name": collection_name,
Timothy J. Baek's avatar
Timothy J. Baek committed
708
709
            "filename": form_data.url,
        }
710
    except Exception as e:
711
        log.exception(e)
712
713
714
715
716
        raise HTTPException(
            status_code=status.HTTP_400_BAD_REQUEST,
            detail=ERROR_MESSAGES.DEFAULT(e),
        )

717

718
def get_web_loader(url: Union[str, Sequence[str]], verify_ssl: bool = True):
719
    # Check if the URL is valid
720
    if not validate_url(url):
721
        raise ValueError(ERROR_MESSAGES.INVALID_URL)
722
    return SafeWebBaseLoader(
723
724
725
        url,
        verify_ssl=verify_ssl,
        requests_per_second=RAG_WEB_SEARCH_CONCURRENT_REQUESTS,
726
        continue_on_failure=True,
727
    )
728
729


730
731
732
733
def validate_url(url: Union[str, Sequence[str]]):
    if isinstance(url, str):
        if isinstance(validators.url(url), validators.ValidationError):
            raise ValueError(ERROR_MESSAGES.INVALID_URL)
734
        if not ENABLE_RAG_LOCAL_WEB_FETCH:
Timothy J. Baek's avatar
revert  
Timothy J. Baek committed
735
736
737
738
739
740
741
742
743
744
745
            # Local web fetch is disabled, filter out any URLs that resolve to private IP addresses
            parsed_url = urllib.parse.urlparse(url)
            # Get IPv4 and IPv6 addresses
            ipv4_addresses, ipv6_addresses = resolve_hostname(parsed_url.hostname)
            # Check if any of the resolved addresses are private
            # This is technically still vulnerable to DNS rebinding attacks, as we don't control WebBaseLoader
            for ip in ipv4_addresses:
                if validators.ipv4(ip, private=True):
                    raise ValueError(ERROR_MESSAGES.INVALID_URL)
            for ip in ipv6_addresses:
                if validators.ipv6(ip, private=True):
746
747
748
749
750
751
752
                    raise ValueError(ERROR_MESSAGES.INVALID_URL)
        return True
    elif isinstance(url, Sequence):
        return all(validate_url(u) for u in url)
    else:
        return False

Timothy J. Baek's avatar
Timothy J. Baek committed
753

Timothy J. Baek's avatar
revert  
Timothy J. Baek committed
754
755
756
757
758
759
760
761
762
763
764
def resolve_hostname(hostname):
    # Get address information
    addr_info = socket.getaddrinfo(hostname, None)

    # Extract IP addresses from address information
    ipv4_addresses = [info[4][0] for info in addr_info if info[0] == socket.AF_INET]
    ipv6_addresses = [info[4][0] for info in addr_info if info[0] == socket.AF_INET6]

    return ipv4_addresses, ipv6_addresses


Timothy J. Baek's avatar
Timothy J. Baek committed
765
766
767
768
769
770
771
772
def search_web(engine: str, query: str) -> list[SearchResult]:
    """Search the web using a search engine and return the results as a list of SearchResult objects.
    Will look for a search engine API key in environment variables in the following order:
    - SEARXNG_QUERY_URL
    - GOOGLE_PSE_API_KEY + GOOGLE_PSE_ENGINE_ID
    - BRAVE_SEARCH_API_KEY
    - SERPSTACK_API_KEY
    - SERPER_API_KEY
773
    - SERPLY_API_KEY
774
    - TAVILY_API_KEY
Timothy J. Baek's avatar
Timothy J. Baek committed
775
776
777
778
779
780
781
    Args:
        query (str): The query to search for
    """

    # TODO: add playwright to search the web
    if engine == "searxng":
        if app.state.config.SEARXNG_QUERY_URL:
Timothy J. Baek's avatar
Timothy J. Baek committed
782
783
784
785
            return search_searxng(
                app.state.config.SEARXNG_QUERY_URL,
                query,
                app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
Timothy J. Baek's avatar
Timothy J. Baek committed
786
                app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
Timothy J. Baek's avatar
Timothy J. Baek committed
787
            )
Timothy J. Baek's avatar
Timothy J. Baek committed
788
789
790
791
792
793
794
795
796
797
798
        else:
            raise Exception("No SEARXNG_QUERY_URL found in environment variables")
    elif engine == "google_pse":
        if (
            app.state.config.GOOGLE_PSE_API_KEY
            and app.state.config.GOOGLE_PSE_ENGINE_ID
        ):
            return search_google_pse(
                app.state.config.GOOGLE_PSE_API_KEY,
                app.state.config.GOOGLE_PSE_ENGINE_ID,
                query,
Timothy J. Baek's avatar
Timothy J. Baek committed
799
                app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
Timothy J. Baek's avatar
Timothy J. Baek committed
800
                app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
Timothy J. Baek's avatar
Timothy J. Baek committed
801
802
803
804
805
806
807
            )
        else:
            raise Exception(
                "No GOOGLE_PSE_API_KEY or GOOGLE_PSE_ENGINE_ID found in environment variables"
            )
    elif engine == "brave":
        if app.state.config.BRAVE_SEARCH_API_KEY:
Timothy J. Baek's avatar
Timothy J. Baek committed
808
809
810
811
            return search_brave(
                app.state.config.BRAVE_SEARCH_API_KEY,
                query,
                app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
Timothy J. Baek's avatar
Timothy J. Baek committed
812
                app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
Timothy J. Baek's avatar
Timothy J. Baek committed
813
            )
Timothy J. Baek's avatar
Timothy J. Baek committed
814
815
816
817
818
819
820
        else:
            raise Exception("No BRAVE_SEARCH_API_KEY found in environment variables")
    elif engine == "serpstack":
        if app.state.config.SERPSTACK_API_KEY:
            return search_serpstack(
                app.state.config.SERPSTACK_API_KEY,
                query,
Timothy J. Baek's avatar
Timothy J. Baek committed
821
                app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
Que Nguyen's avatar
Que Nguyen committed
822
                app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
Timothy J. Baek's avatar
Timothy J. Baek committed
823
824
825
826
827
828
                https_enabled=app.state.config.SERPSTACK_HTTPS,
            )
        else:
            raise Exception("No SERPSTACK_API_KEY found in environment variables")
    elif engine == "serper":
        if app.state.config.SERPER_API_KEY:
Timothy J. Baek's avatar
Timothy J. Baek committed
829
830
831
832
            return search_serper(
                app.state.config.SERPER_API_KEY,
                query,
                app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
Timothy J. Baek's avatar
Timothy J. Baek committed
833
                app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
Timothy J. Baek's avatar
Timothy J. Baek committed
834
            )
Timothy J. Baek's avatar
Timothy J. Baek committed
835
836
        else:
            raise Exception("No SERPER_API_KEY found in environment variables")
837
838
839
840
841
842
    elif engine == "serply":
        if app.state.config.SERPLY_API_KEY:
            return search_serply(
                app.state.config.SERPLY_API_KEY,
                query,
                app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
Timothy J. Baek's avatar
Timothy J. Baek committed
843
                app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
844
845
846
            )
        else:
            raise Exception("No SERPLY_API_KEY found in environment variables")
847
    elif engine == "duckduckgo":
Timothy J. Baek's avatar
Timothy J. Baek committed
848
849
850
851
852
        return search_duckduckgo(
            query,
            app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
            app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
        )
853
854
855
856
857
858
859
860
861
    elif engine == "tavily":
        if app.state.config.TAVILY_API_KEY:
            return search_tavily(
                app.state.config.TAVILY_API_KEY,
                query,
                app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
            )
        else:
            raise Exception("No TAVILY_API_KEY found in environment variables")
862
863
    elif engine == "jina":
        return search_jina(query, app.state.config.RAG_WEB_SEARCH_RESULT_COUNT)
Timothy J. Baek's avatar
Timothy J. Baek committed
864
865
866
867
    else:
        raise Exception("No search engine API key found in environment variables")


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
868
@app.post("/web/search")
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
869
def store_web_search(form_data: SearchForm, user=Depends(get_verified_user)):
870
    try:
Timothy J. Baek's avatar
Timothy J. Baek committed
871
872
873
        logging.info(
            f"trying to web search with {app.state.config.RAG_WEB_SEARCH_ENGINE, form_data.query}"
        )
Timothy J. Baek's avatar
Timothy J. Baek committed
874
875
876
877
878
879
880
881
882
883
884
885
886
        web_results = search_web(
            app.state.config.RAG_WEB_SEARCH_ENGINE, form_data.query
        )
    except Exception as e:
        log.exception(e)

        print(e)
        raise HTTPException(
            status_code=status.HTTP_400_BAD_REQUEST,
            detail=ERROR_MESSAGES.WEB_SEARCH_ERROR(e),
        )

    try:
887
888
        urls = [result.link for result in web_results]
        loader = get_web_loader(urls)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
889
        data = loader.load()
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908

        collection_name = form_data.collection_name
        if collection_name == "":
            collection_name = calculate_sha256_string(form_data.query)[:63]

        store_data_in_vector_db(data, collection_name, overwrite=True)
        return {
            "status": True,
            "collection_name": collection_name,
            "filenames": urls,
        }
    except Exception as e:
        log.exception(e)
        raise HTTPException(
            status_code=status.HTTP_400_BAD_REQUEST,
            detail=ERROR_MESSAGES.DEFAULT(e),
        )


909
def store_data_in_vector_db(data, collection_name, overwrite: bool = False) -> bool:
Timothy J. Baek's avatar
Timothy J. Baek committed
910

911
    text_splitter = RecursiveCharacterTextSplitter(
912
913
        chunk_size=app.state.config.CHUNK_SIZE,
        chunk_overlap=app.state.config.CHUNK_OVERLAP,
914
915
        add_start_index=True,
    )
916

917
    docs = text_splitter.split_documents(data)
Timothy J. Baek's avatar
Timothy J. Baek committed
918
919

    if len(docs) > 0:
920
        log.info(f"store_data_in_vector_db {docs}")
Timothy J. Baek's avatar
Timothy J. Baek committed
921
922
923
        return store_docs_in_vector_db(docs, collection_name, overwrite), None
    else:
        raise ValueError(ERROR_MESSAGES.EMPTY_CONTENT)
924
925
926


def store_text_in_vector_db(
Timothy J. Baek's avatar
Timothy J. Baek committed
927
    text, metadata, collection_name, overwrite: bool = False
928
929
) -> bool:
    text_splitter = RecursiveCharacterTextSplitter(
930
931
        chunk_size=app.state.config.CHUNK_SIZE,
        chunk_overlap=app.state.config.CHUNK_OVERLAP,
932
933
        add_start_index=True,
    )
Timothy J. Baek's avatar
Timothy J. Baek committed
934
    docs = text_splitter.create_documents([text], metadatas=[metadata])
935
936
937
    return store_docs_in_vector_db(docs, collection_name, overwrite)


Timothy J. Baek's avatar
Timothy J. Baek committed
938
def store_docs_in_vector_db(docs, collection_name, overwrite: bool = False) -> bool:
939
    log.info(f"store_docs_in_vector_db {docs} {collection_name}")
Timothy J. Baek's avatar
Timothy J. Baek committed
940

941
942
943
    texts = [doc.page_content for doc in docs]
    metadatas = [doc.metadata for doc in docs]

mindspawn's avatar
mindspawn committed
944
945
946
947
948
949
950
    # ChromaDB does not like datetime formats
    # for meta-data so convert them to string.
    for metadata in metadatas:
        for key, value in metadata.items():
            if isinstance(value, datetime):
                metadata[key] = str(value)

951
952
953
954
    try:
        if overwrite:
            for collection in CHROMA_CLIENT.list_collections():
                if collection_name == collection.name:
955
                    log.info(f"deleting existing collection {collection_name}")
956
957
                    CHROMA_CLIENT.delete_collection(name=collection_name)

958
        collection = CHROMA_CLIENT.create_collection(name=collection_name)
959

Timothy J. Baek's avatar
Timothy J. Baek committed
960
        embedding_func = get_embedding_function(
961
962
            app.state.config.RAG_EMBEDDING_ENGINE,
            app.state.config.RAG_EMBEDDING_MODEL,
Steven Kreitzer's avatar
Steven Kreitzer committed
963
            app.state.sentence_transformer_ef,
964
965
            app.state.config.OPENAI_API_KEY,
            app.state.config.OPENAI_API_BASE_URL,
966
            app.state.config.RAG_EMBEDDING_OPENAI_BATCH_SIZE,
Steven Kreitzer's avatar
Steven Kreitzer committed
967
968
969
        )

        embedding_texts = list(map(lambda x: x.replace("\n", " "), texts))
970
        embeddings = embedding_func(embedding_texts)
971
972
973

        for batch in create_batches(
            api=CHROMA_CLIENT,
974
            ids=[str(uuid.uuid4()) for _ in texts],
975
976
977
978
979
            metadatas=metadatas,
            embeddings=embeddings,
            documents=texts,
        ):
            collection.add(*batch)
980

981
        return True
982
    except Exception as e:
983
        log.exception(e)
984
985
986
987
988
989
        if e.__class__.__name__ == "UniqueConstraintError":
            return True

        return False


990
991
def get_loader(filename: str, file_content_type: str, file_path: str):
    file_ext = filename.split(".")[-1].lower()
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
    known_type = True

    known_source_ext = [
        "go",
        "py",
        "java",
        "sh",
        "bat",
        "ps1",
        "cmd",
        "js",
        "ts",
        "css",
        "cpp",
        "hpp",
        "h",
        "c",
        "cs",
        "sql",
        "log",
        "ini",
        "pl",
        "pm",
        "r",
        "dart",
        "dockerfile",
        "env",
        "php",
        "hs",
        "hsc",
        "lua",
        "nginxconf",
        "conf",
        "m",
        "mm",
        "plsql",
        "perl",
        "rb",
        "rs",
        "db2",
        "scala",
        "bash",
        "swift",
        "vue",
        "svelte",
mindspawn's avatar
mindspawn committed
1037
        "msg",
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1038
1039
1040
    ]

    if file_ext == "pdf":
1041
        loader = PyPDFLoader(
1042
            file_path, extract_images=app.state.config.PDF_EXTRACT_IMAGES
1043
        )
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1044
1045
1046
1047
1048
1049
    elif file_ext == "csv":
        loader = CSVLoader(file_path)
    elif file_ext == "rst":
        loader = UnstructuredRSTLoader(file_path, mode="elements")
    elif file_ext == "xml":
        loader = UnstructuredXMLLoader(file_path)
1050
    elif file_ext in ["htm", "html"]:
Timothy J. Baek's avatar
Timothy J. Baek committed
1051
        loader = BSHTMLLoader(file_path, open_encoding="unicode_escape")
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1052
1053
    elif file_ext == "md":
        loader = UnstructuredMarkdownLoader(file_path)
1054
    elif file_content_type == "application/epub+zip":
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1055
1056
        loader = UnstructuredEPubLoader(file_path)
    elif (
1057
        file_content_type
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1058
1059
1060
1061
        == "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
        or file_ext in ["doc", "docx"]
    ):
        loader = Docx2txtLoader(file_path)
1062
    elif file_content_type in [
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1063
1064
1065
1066
        "application/vnd.ms-excel",
        "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
    ] or file_ext in ["xls", "xlsx"]:
        loader = UnstructuredExcelLoader(file_path)
Timothy J. Baek's avatar
Timothy J. Baek committed
1067
1068
1069
1070
1071
    elif file_content_type in [
        "application/vnd.ms-powerpoint",
        "application/vnd.openxmlformats-officedocument.presentationml.presentation",
    ] or file_ext in ["ppt", "pptx"]:
        loader = UnstructuredPowerPointLoader(file_path)
mindspawn's avatar
mindspawn committed
1072
1073
    elif file_ext == "msg":
        loader = OutlookMessageLoader(file_path)
1074
1075
1076
    elif file_ext in known_source_ext or (
        file_content_type and file_content_type.find("text/") >= 0
    ):
1077
        loader = TextLoader(file_path, autodetect_encoding=True)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1078
    else:
1079
        loader = TextLoader(file_path, autodetect_encoding=True)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1080
1081
1082
1083
1084
        known_type = False

    return loader, known_type


1085
@app.post("/doc")
Timothy J. Baek's avatar
Timothy J. Baek committed
1086
def store_doc(
Timothy J. Baek's avatar
Timothy J. Baek committed
1087
    collection_name: Optional[str] = Form(None),
Timothy J. Baek's avatar
Timothy J. Baek committed
1088
    file: UploadFile = File(...),
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1089
    user=Depends(get_verified_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
1090
):
1091
    # "https://www.gutenberg.org/files/1727/1727-h/1727-h.htm"
Timothy J. Baek's avatar
Timothy J. Baek committed
1092

1093
    log.info(f"file.content_type: {file.content_type}")
1094
    try:
1095
        unsanitized_filename = file.filename
Timothy J. Baek's avatar
Timothy J. Baek committed
1096
        filename = os.path.basename(unsanitized_filename)
1097

Timothy J. Baek's avatar
Timothy J. Baek committed
1098
        file_path = f"{UPLOAD_DIR}/{filename}"
1099

1100
        contents = file.file.read()
Timothy J. Baek's avatar
Timothy J. Baek committed
1101
        with open(file_path, "wb") as f:
1102
1103
1104
            f.write(contents)
            f.close()

Timothy J. Baek's avatar
Timothy J. Baek committed
1105
1106
1107
1108
1109
        f = open(file_path, "rb")
        if collection_name == None:
            collection_name = calculate_sha256(f)[:63]
        f.close()

Timothy J. Baek's avatar
Timothy J. Baek committed
1110
        loader, known_type = get_loader(filename, file.content_type, file_path)
Timothy J. Baek's avatar
Timothy J. Baek committed
1111
        data = loader.load()
Timothy J. Baek's avatar
Timothy J. Baek committed
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123

        try:
            result = store_data_in_vector_db(data, collection_name)

            if result:
                return {
                    "status": True,
                    "collection_name": collection_name,
                    "filename": filename,
                    "known_type": known_type,
                }
        except Exception as e:
Timothy J. Baek's avatar
Timothy J. Baek committed
1124
1125
            raise HTTPException(
                status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
Timothy J. Baek's avatar
Timothy J. Baek committed
1126
                detail=e,
Timothy J. Baek's avatar
Timothy J. Baek committed
1127
            )
1128
    except Exception as e:
1129
        log.exception(e)
Dave Bauman's avatar
Dave Bauman committed
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
        if "No pandoc was found" in str(e):
            raise HTTPException(
                status_code=status.HTTP_400_BAD_REQUEST,
                detail=ERROR_MESSAGES.PANDOC_NOT_INSTALLED,
            )
        else:
            raise HTTPException(
                status_code=status.HTTP_400_BAD_REQUEST,
                detail=ERROR_MESSAGES.DEFAULT(e),
            )
1140
1141


Timothy J. Baek's avatar
Timothy J. Baek committed
1142
1143
class ProcessDocForm(BaseModel):
    file_id: str
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1144
    collection_name: Optional[str] = None
Timothy J. Baek's avatar
Timothy J. Baek committed
1145
1146
1147
1148
1149


@app.post("/process/doc")
def process_doc(
    form_data: ProcessDocForm,
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1150
    user=Depends(get_verified_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
1151
1152
1153
1154
1155
1156
):
    try:
        file = Files.get_file_by_id(form_data.file_id)
        file_path = file.meta.get("path", f"{UPLOAD_DIR}/{file.filename}")

        f = open(file_path, "rb")
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1157
1158

        collection_name = form_data.collection_name
Timothy J. Baek's avatar
Timothy J. Baek committed
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
        if collection_name == None:
            collection_name = calculate_sha256(f)[:63]
        f.close()

        loader, known_type = get_loader(
            file.filename, file.meta.get("content_type"), file_path
        )
        data = loader.load()

        try:
            result = store_data_in_vector_db(data, collection_name)

            if result:
                return {
                    "status": True,
                    "collection_name": collection_name,
                    "known_type": known_type,
                }
        except Exception as e:
            raise HTTPException(
                status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
                detail=e,
            )
    except Exception as e:
        log.exception(e)
        if "No pandoc was found" in str(e):
            raise HTTPException(
                status_code=status.HTTP_400_BAD_REQUEST,
                detail=ERROR_MESSAGES.PANDOC_NOT_INSTALLED,
            )
        else:
            raise HTTPException(
                status_code=status.HTTP_400_BAD_REQUEST,
                detail=ERROR_MESSAGES.DEFAULT(e),
            )


1196
1197
1198
1199
1200
1201
1202
1203
1204
class TextRAGForm(BaseModel):
    name: str
    content: str
    collection_name: Optional[str] = None


@app.post("/text")
def store_text(
    form_data: TextRAGForm,
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1205
    user=Depends(get_verified_user),
1206
1207
1208
1209
1210
1211
):

    collection_name = form_data.collection_name
    if collection_name == None:
        collection_name = calculate_sha256_string(form_data.content)

Timothy J. Baek's avatar
Timothy J. Baek committed
1212
1213
1214
1215
1216
    result = store_text_in_vector_db(
        form_data.content,
        metadata={"name": form_data.name, "created_by": user.id},
        collection_name=collection_name,
    )
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226

    if result:
        return {"status": True, "collection_name": collection_name}
    else:
        raise HTTPException(
            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
            detail=ERROR_MESSAGES.DEFAULT(),
        )


1227
1228
@app.get("/scan")
def scan_docs_dir(user=Depends(get_admin_user)):
1229
1230
    for path in Path(DOCS_DIR).rglob("./**/*"):
        try:
1231
1232
1233
1234
1235
1236
1237
1238
1239
            if path.is_file() and not path.name.startswith("."):
                tags = extract_folders_after_data_docs(path)
                filename = path.name
                file_content_type = mimetypes.guess_type(path)

                f = open(path, "rb")
                collection_name = calculate_sha256(f)[:63]
                f.close()

Timothy J. Baek's avatar
Timothy J. Baek committed
1240
1241
1242
                loader, known_type = get_loader(
                    filename, file_content_type[0], str(path)
                )
1243
1244
                data = loader.load()

Timothy J. Baek's avatar
Timothy J. Baek committed
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
                try:
                    result = store_data_in_vector_db(data, collection_name)

                    if result:
                        sanitized_filename = sanitize_filename(filename)
                        doc = Documents.get_doc_by_name(sanitized_filename)

                        if doc == None:
                            doc = Documents.insert_new_doc(
                                user.id,
                                DocumentForm(
                                    **{
                                        "name": sanitized_filename,
                                        "title": filename,
                                        "collection_name": collection_name,
                                        "filename": filename,
                                        "content": (
                                            json.dumps(
                                                {
                                                    "tags": list(
                                                        map(
                                                            lambda name: {"name": name},
                                                            tags,
                                                        )
1269
                                                    )
Timothy J. Baek's avatar
Timothy J. Baek committed
1270
1271
1272
1273
1274
1275
1276
1277
1278
                                                }
                                            )
                                            if len(tags)
                                            else "{}"
                                        ),
                                    }
                                ),
                            )
                except Exception as e:
1279
                    log.exception(e)
Timothy J. Baek's avatar
Timothy J. Baek committed
1280
                    pass
1281

1282
        except Exception as e:
1283
            log.exception(e)
1284
1285
1286
1287

    return True


Timothy J. Baek's avatar
Timothy J. Baek committed
1288
@app.get("/reset/db")
1289
1290
def reset_vector_db(user=Depends(get_admin_user)):
    CHROMA_CLIENT.reset()
Timothy J. Baek's avatar
Timothy J. Baek committed
1291
1292


Timothy J. Baek's avatar
Timothy J. Baek committed
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
@app.get("/reset/uploads")
def reset_upload_dir(user=Depends(get_admin_user)) -> bool:
    folder = f"{UPLOAD_DIR}"
    try:
        # Check if the directory exists
        if os.path.exists(folder):
            # Iterate over all the files and directories in the specified directory
            for filename in os.listdir(folder):
                file_path = os.path.join(folder, filename)
                try:
                    if os.path.isfile(file_path) or os.path.islink(file_path):
                        os.unlink(file_path)  # Remove the file or link
                    elif os.path.isdir(file_path):
                        shutil.rmtree(file_path)  # Remove the directory
                except Exception as e:
                    print(f"Failed to delete {file_path}. Reason: {e}")
        else:
            print(f"The directory {folder} does not exist")
    except Exception as e:
        print(f"Failed to process the directory {folder}. Reason: {e}")

    return True


Timothy J. Baek's avatar
Timothy J. Baek committed
1317
@app.get("/reset")
1318
1319
1320
1321
def reset(user=Depends(get_admin_user)) -> bool:
    folder = f"{UPLOAD_DIR}"
    for filename in os.listdir(folder):
        file_path = os.path.join(folder, filename)
Timothy J. Baek's avatar
Timothy J. Baek committed
1322
        try:
1323
1324
1325
1326
            if os.path.isfile(file_path) or os.path.islink(file_path):
                os.unlink(file_path)
            elif os.path.isdir(file_path):
                shutil.rmtree(file_path)
Timothy J. Baek's avatar
Timothy J. Baek committed
1327
        except Exception as e:
1328
            log.error("Failed to delete %s. Reason: %s" % (file_path, e))
Timothy J. Baek's avatar
Timothy J. Baek committed
1329

1330
1331
1332
    try:
        CHROMA_CLIENT.reset()
    except Exception as e:
1333
        log.exception(e)
1334
1335

    return True
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1336

Timothy J. Baek's avatar
Timothy J. Baek committed
1337

1338
1339
class SafeWebBaseLoader(WebBaseLoader):
    """WebBaseLoader with enhanced error handling for URLs."""
Timothy J. Baek's avatar
Timothy J. Baek committed
1340

1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
    def lazy_load(self) -> Iterator[Document]:
        """Lazy load text from the url(s) in web_path with error handling."""
        for path in self.web_paths:
            try:
                soup = self._scrape(path, bs_kwargs=self.bs_kwargs)
                text = soup.get_text(**self.bs_get_text_kwargs)

                # Build metadata
                metadata = {"source": path}
                if title := soup.find("title"):
                    metadata["title"] = title.get_text()
                if description := soup.find("meta", attrs={"name": "description"}):
Timothy J. Baek's avatar
Timothy J. Baek committed
1353
1354
1355
                    metadata["description"] = description.get(
                        "content", "No description found."
                    )
1356
1357
                if html := soup.find("html"):
                    metadata["language"] = html.get("lang", "No language found.")
Timothy J. Baek's avatar
Timothy J. Baek committed
1358

1359
1360
1361
1362
                yield Document(page_content=text, metadata=metadata)
            except Exception as e:
                # Log the error and continue with the next URL
                log.error(f"Error loading {path}: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
1363
1364


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1365
1366
1367
1368
1369
1370
1371
1372
1373
if ENV == "dev":

    @app.get("/ef")
    async def get_embeddings():
        return {"result": app.state.EMBEDDING_FUNCTION("hello world")}

    @app.get("/ef/{text}")
    async def get_embeddings_text(text: str):
        return {"result": app.state.EMBEDDING_FUNCTION(text)}