main.py 47.5 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

51
import sentence_transformers
52

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

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

Timothy J. Baek's avatar
Timothy J. Baek committed
71
72
73
74
75
76
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
77
from apps.rag.search.serply import search_serply
78
from apps.rag.search.duckduckgo import search_duckduckgo
79
from apps.rag.search.tavily import search_tavily
80
from apps.rag.search.jina_search import search_jina
Timothy J. Baek's avatar
Timothy J. Baek committed
81

82
83
84
85
86
87
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
88
from utils.utils import get_verified_user, get_admin_user
89

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

136
137
from constants import ERROR_MESSAGES

138
139
140
log = logging.getLogger(__name__)
log.setLevel(SRC_LOG_LEVELS["RAG"])

Timothy J. Baek's avatar
Timothy J. Baek committed
141
142
app = FastAPI()

143
app.state.config = AppConfig()
Timothy J. Baek's avatar
Timothy J. Baek committed
144

145
146
147
148
149
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 = (
150
151
    ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION
)
Steven Kreitzer's avatar
Steven Kreitzer committed
152

153
154
155
app.state.config.TEXT_EXTRACTION_ENGINE = TEXT_EXTRACTION_ENGINE
app.state.config.TIKA_SERVER_URL = TIKA_SERVER_URL

156
157
app.state.config.CHUNK_SIZE = CHUNK_SIZE
app.state.config.CHUNK_OVERLAP = CHUNK_OVERLAP
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
158

159
160
app.state.config.RAG_EMBEDDING_ENGINE = RAG_EMBEDDING_ENGINE
app.state.config.RAG_EMBEDDING_MODEL = RAG_EMBEDDING_MODEL
161
app.state.config.RAG_EMBEDDING_OPENAI_BATCH_SIZE = RAG_EMBEDDING_OPENAI_BATCH_SIZE
162
163
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
164

165

166
167
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
168

169
app.state.config.PDF_EXTRACT_IMAGES = PDF_EXTRACT_IMAGES
170

Steven Kreitzer's avatar
Steven Kreitzer committed
171

172
app.state.config.YOUTUBE_LOADER_LANGUAGE = YOUTUBE_LOADER_LANGUAGE
173
174
175
app.state.YOUTUBE_LOADER_TRANSLATION = None


Timothy J. Baek's avatar
Timothy J. Baek committed
176
app.state.config.ENABLE_RAG_WEB_SEARCH = ENABLE_RAG_WEB_SEARCH
Timothy J. Baek's avatar
Timothy J. Baek committed
177
app.state.config.RAG_WEB_SEARCH_ENGINE = RAG_WEB_SEARCH_ENGINE
Que Nguyen's avatar
Que Nguyen committed
178
app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST = RAG_WEB_SEARCH_DOMAIN_FILTER_LIST
Timothy J. Baek's avatar
Timothy J. Baek committed
179

Timothy J. Baek's avatar
Timothy J. Baek committed
180
181
182
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
183
app.state.config.BRAVE_SEARCH_API_KEY = BRAVE_SEARCH_API_KEY
Timothy J. Baek's avatar
Timothy J. Baek committed
184
185
186
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
187
app.state.config.SERPLY_API_KEY = SERPLY_API_KEY
188
app.state.config.TAVILY_API_KEY = TAVILY_API_KEY
Timothy J. Baek's avatar
Timothy J. Baek committed
189
190
191
192
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


193
194
195
196
def update_embedding_model(
    embedding_model: str,
    update_model: bool = False,
):
197
    if embedding_model and app.state.config.RAG_EMBEDDING_ENGINE == "":
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
        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:
        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(
222
    app.state.config.RAG_EMBEDDING_MODEL,
223
224
225
226
    RAG_EMBEDDING_MODEL_AUTO_UPDATE,
)

update_reranking_model(
227
    app.state.config.RAG_RERANKING_MODEL,
228
229
    RAG_RERANKING_MODEL_AUTO_UPDATE,
)
Timothy J. Baek's avatar
Timothy J. Baek committed
230

Timothy J. Baek's avatar
Timothy J. Baek committed
231
232

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

Timothy J. Baek's avatar
Timothy J. Baek committed
241
242
origins = ["*"]

243

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


Timothy J. Baek's avatar
Timothy J. Baek committed
253
class CollectionNameForm(BaseModel):
254
255
256
    collection_name: Optional[str] = "test"


Timothy J. Baek's avatar
Timothy J. Baek committed
257
class UrlForm(CollectionNameForm):
Timothy J. Baek's avatar
Timothy J. Baek committed
258
259
    url: str

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

261
262
263
264
class SearchForm(CollectionNameForm):
    query: str


Timothy J. Baek's avatar
Timothy J. Baek committed
265
266
@app.get("/")
async def get_status():
Timothy J. Baek's avatar
Timothy J. Baek committed
267
268
    return {
        "status": True,
269
270
271
272
273
274
        "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,
275
        "openai_batch_size": app.state.config.RAG_EMBEDDING_OPENAI_BATCH_SIZE,
276
277
278
    }


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


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


301
302
303
class OpenAIConfigForm(BaseModel):
    url: str
    key: str
304
    batch_size: Optional[int] = None
305
306


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


Timothy J. Baek's avatar
Timothy J. Baek committed
313
314
@app.post("/embedding/update")
async def update_embedding_config(
315
316
    form_data: EmbeddingModelUpdateForm, user=Depends(get_admin_user)
):
Self Denial's avatar
Self Denial committed
317
    log.info(
318
        f"Updating embedding model: {app.state.config.RAG_EMBEDDING_MODEL} to {form_data.embedding_model}"
319
    )
320
    try:
321
322
        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
323

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

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

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

345
346
        return {
            "status": True,
347
348
            "embedding_engine": app.state.config.RAG_EMBEDDING_ENGINE,
            "embedding_model": app.state.config.RAG_EMBEDDING_MODEL,
349
            "openai_config": {
350
351
                "url": app.state.config.OPENAI_API_BASE_URL,
                "key": app.state.config.OPENAI_API_KEY,
352
                "batch_size": app.state.config.RAG_EMBEDDING_OPENAI_BATCH_SIZE,
353
            },
354
355
356
357
358
359
360
        }
    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
361
362


Steven Kreitzer's avatar
Steven Kreitzer committed
363
364
class RerankingModelUpdateForm(BaseModel):
    reranking_model: str
365

Steven Kreitzer's avatar
Steven Kreitzer committed
366
367
368
369
370
371

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

377
        update_reranking_model(app.state.config.RAG_RERANKING_MODEL), True
Steven Kreitzer's avatar
Steven Kreitzer committed
378
379
380

        return {
            "status": True,
381
            "reranking_model": app.state.config.RAG_RERANKING_MODEL,
Steven Kreitzer's avatar
Steven Kreitzer committed
382
383
384
385
386
387
388
389
390
        }
    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
391
392
@app.get("/config")
async def get_rag_config(user=Depends(get_admin_user)):
Timothy J. Baek's avatar
Timothy J. Baek committed
393
394
    return {
        "status": True,
395
        "pdf_extract_images": app.state.config.PDF_EXTRACT_IMAGES,
396
397
398
399
        "text_extraction": {
            "engine": app.state.config.TEXT_EXTRACTION_ENGINE,
            "tika_server_url": app.state.config.TIKA_SERVER_URL,
        },
Timothy J. Baek's avatar
Timothy J. Baek committed
400
        "chunk": {
401
402
            "chunk_size": app.state.config.CHUNK_SIZE,
            "chunk_overlap": app.state.config.CHUNK_OVERLAP,
Timothy J. Baek's avatar
Timothy J. Baek committed
403
        },
404
        "youtube": {
405
            "language": app.state.config.YOUTUBE_LOADER_LANGUAGE,
406
407
            "translation": app.state.YOUTUBE_LOADER_TRANSLATION,
        },
Timothy J. Baek's avatar
Timothy J. Baek committed
408
        "web": {
Timothy J. Baek's avatar
Timothy J. Baek committed
409
            "ssl_verification": app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION,
Timothy J. Baek's avatar
Timothy J. Baek committed
410
            "search": {
Timothy J. Baek's avatar
Timothy J. Baek committed
411
                "enabled": app.state.config.ENABLE_RAG_WEB_SEARCH,
Timothy J. Baek's avatar
Timothy J. Baek committed
412
                "engine": app.state.config.RAG_WEB_SEARCH_ENGINE,
Timothy J. Baek's avatar
Timothy J. Baek committed
413
414
415
                "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
416
                "brave_search_api_key": app.state.config.BRAVE_SEARCH_API_KEY,
Timothy J. Baek's avatar
Timothy J. Baek committed
417
418
419
                "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,
420
                "serply_api_key": app.state.config.SERPLY_API_KEY,
421
                "tavily_api_key": app.state.config.TAVILY_API_KEY,
Timothy J. Baek's avatar
Timothy J. Baek committed
422
423
                "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
424
            },
Timothy J. Baek's avatar
Timothy J. Baek committed
425
        },
Timothy J. Baek's avatar
Timothy J. Baek committed
426
427
428
    }


429
430
431
432
433
class TextExtractionConfig(BaseModel):
    engine: str = ""
    tika_server_url: Optional[str] = None


Timothy J. Baek's avatar
Timothy J. Baek committed
434
435
436
437
438
class ChunkParamUpdateForm(BaseModel):
    chunk_size: int
    chunk_overlap: int


439
440
441
442
443
class YoutubeLoaderConfig(BaseModel):
    language: List[str]
    translation: Optional[str] = None


Timothy J. Baek's avatar
Timothy J. Baek committed
444
class WebSearchConfig(BaseModel):
Timothy J. Baek's avatar
Timothy J. Baek committed
445
    enabled: bool
Timothy J. Baek's avatar
Timothy J. Baek committed
446
    engine: Optional[str] = None
Timothy J. Baek's avatar
Timothy J. Baek committed
447
448
449
    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
450
    brave_search_api_key: Optional[str] = None
Timothy J. Baek's avatar
Timothy J. Baek committed
451
452
453
    serpstack_api_key: Optional[str] = None
    serpstack_https: Optional[bool] = None
    serper_api_key: Optional[str] = None
454
    serply_api_key: Optional[str] = None
455
    tavily_api_key: Optional[str] = None
Timothy J. Baek's avatar
Timothy J. Baek committed
456
457
458
459
    result_count: Optional[int] = None
    concurrent_requests: Optional[int] = None


Timothy J. Baek's avatar
Timothy J. Baek committed
460
461
462
463
464
class WebConfig(BaseModel):
    search: WebSearchConfig
    web_loader_ssl_verification: Optional[bool] = None


Timothy J. Baek's avatar
Timothy J. Baek committed
465
class ConfigUpdateForm(BaseModel):
466
    pdf_extract_images: Optional[bool] = None
467
    text_extraction: Optional[TextExtractionConfig] = None
468
    chunk: Optional[ChunkParamUpdateForm] = None
469
    youtube: Optional[YoutubeLoaderConfig] = None
Timothy J. Baek's avatar
Timothy J. Baek committed
470
    web: Optional[WebConfig] = None
Timothy J. Baek's avatar
Timothy J. Baek committed
471
472
473
474


@app.post("/config/update")
async def update_rag_config(form_data: ConfigUpdateForm, user=Depends(get_admin_user)):
475
    app.state.config.PDF_EXTRACT_IMAGES = (
476
        form_data.pdf_extract_images
477
478
        if form_data.pdf_extract_images is not None
        else app.state.config.PDF_EXTRACT_IMAGES
479
480
    )

481
482
483
484
485
    if form_data.text_extraction is not None:
        log.info(f"Updating text settings: {form_data.text_extraction}")
        app.state.config.TEXT_EXTRACTION_ENGINE = form_data.text_extraction.engine
        app.state.config.TIKA_SERVER_URL = form_data.text_extraction.tika_server_url

Timothy J. Baek's avatar
Timothy J. Baek committed
486
487
488
    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
489

Timothy J. Baek's avatar
Timothy J. Baek committed
490
491
492
    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
493

Timothy J. Baek's avatar
Timothy J. Baek committed
494
495
496
497
    if form_data.web is not None:
        app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION = (
            form_data.web.web_loader_ssl_verification
        )
498

Timothy J. Baek's avatar
Timothy J. Baek committed
499
        app.state.config.ENABLE_RAG_WEB_SEARCH = form_data.web.search.enabled
Timothy J. Baek's avatar
Timothy J. Baek committed
500
501
502
503
504
505
506
507
508
509
510
511
        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
512
        app.state.config.SERPLY_API_KEY = form_data.web.search.serply_api_key
513
        app.state.config.TAVILY_API_KEY = form_data.web.search.tavily_api_key
Timothy J. Baek's avatar
Timothy J. Baek committed
514
515
516
517
        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
        )
518

Timothy J. Baek's avatar
Timothy J. Baek committed
519
520
    return {
        "status": True,
521
        "pdf_extract_images": app.state.config.PDF_EXTRACT_IMAGES,
522
523
524
525
        "text_extraction": {
            "engine": app.state.config.TEXT_EXTRACTION_ENGINE,
            "tika_server_url": app.state.config.TIKA_SERVER_URL,
        },
Timothy J. Baek's avatar
Timothy J. Baek committed
526
        "chunk": {
527
528
            "chunk_size": app.state.config.CHUNK_SIZE,
            "chunk_overlap": app.state.config.CHUNK_OVERLAP,
Timothy J. Baek's avatar
Timothy J. Baek committed
529
        },
530
        "youtube": {
531
            "language": app.state.config.YOUTUBE_LOADER_LANGUAGE,
532
533
            "translation": app.state.YOUTUBE_LOADER_TRANSLATION,
        },
Timothy J. Baek's avatar
Timothy J. Baek committed
534
535
536
        "web": {
            "ssl_verification": app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION,
            "search": {
Timothy J. Baek's avatar
Timothy J. Baek committed
537
                "enabled": app.state.config.ENABLE_RAG_WEB_SEARCH,
Timothy J. Baek's avatar
Timothy J. Baek committed
538
539
540
541
542
543
544
545
                "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,
546
                "serply_api_key": app.state.config.SERPLY_API_KEY,
547
                "tavily_api_key": app.state.config.TAVILY_API_KEY,
Timothy J. Baek's avatar
Timothy J. Baek committed
548
549
550
551
                "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
552
    }
553
554


Timothy J. Baek's avatar
Timothy J. Baek committed
555
@app.get("/template")
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
556
async def get_rag_template(user=Depends(get_verified_user)):
Timothy J. Baek's avatar
Timothy J. Baek committed
557
558
    return {
        "status": True,
559
        "template": app.state.config.RAG_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
560
561
562
    }


563
564
565
566
@app.get("/query/settings")
async def get_query_settings(user=Depends(get_admin_user)):
    return {
        "status": True,
567
568
569
570
        "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,
571
    }
Timothy J. Baek's avatar
Timothy J. Baek committed
572
573


574
575
class QuerySettingsForm(BaseModel):
    k: Optional[int] = None
576
    r: Optional[float] = None
577
    template: Optional[str] = None
Steven Kreitzer's avatar
Steven Kreitzer committed
578
    hybrid: Optional[bool] = None
579
580
581
582
583
584


@app.post("/query/settings/update")
async def update_query_settings(
    form_data: QuerySettingsForm, user=Depends(get_admin_user)
):
585
    app.state.config.RAG_TEMPLATE = (
Timothy J. Baek's avatar
Timothy J. Baek committed
586
        form_data.template if form_data.template else RAG_TEMPLATE
587
    )
588
589
590
    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
591
        form_data.hybrid if form_data.hybrid else False
592
    )
Steven Kreitzer's avatar
Steven Kreitzer committed
593
594
    return {
        "status": True,
595
596
597
598
        "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
599
    }
600
601


602
class QueryDocForm(BaseModel):
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
603
604
    collection_name: str
    query: str
605
    k: Optional[int] = None
606
    r: Optional[float] = None
Steven Kreitzer's avatar
Steven Kreitzer committed
607
    hybrid: Optional[bool] = None
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
608
609


610
@app.post("/query/doc")
Timothy J. Baek's avatar
Timothy J. Baek committed
611
def query_doc_handler(
612
    form_data: QueryDocForm,
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
613
    user=Depends(get_verified_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
614
):
615
    try:
616
        if app.state.config.ENABLE_RAG_HYBRID_SEARCH:
Timothy J. Baek's avatar
Timothy J. Baek committed
617
618
619
            return query_doc_with_hybrid_search(
                collection_name=form_data.collection_name,
                query=form_data.query,
Steven Kreitzer's avatar
Steven Kreitzer committed
620
                embedding_function=app.state.EMBEDDING_FUNCTION,
621
                k=form_data.k if form_data.k else app.state.config.TOP_K,
Steven Kreitzer's avatar
Steven Kreitzer committed
622
                reranking_function=app.state.sentence_transformer_rf,
623
                r=(
624
                    form_data.r if form_data.r else app.state.config.RELEVANCE_THRESHOLD
625
                ),
Timothy J. Baek's avatar
Timothy J. Baek committed
626
627
628
629
630
            )
        else:
            return query_doc(
                collection_name=form_data.collection_name,
                query=form_data.query,
Steven Kreitzer's avatar
Steven Kreitzer committed
631
                embedding_function=app.state.EMBEDDING_FUNCTION,
632
                k=form_data.k if form_data.k else app.state.config.TOP_K,
Timothy J. Baek's avatar
Timothy J. Baek committed
633
            )
634
    except Exception as e:
635
        log.exception(e)
636
637
638
639
        raise HTTPException(
            status_code=status.HTTP_400_BAD_REQUEST,
            detail=ERROR_MESSAGES.DEFAULT(e),
        )
640
641


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
642
643
644
class QueryCollectionsForm(BaseModel):
    collection_names: List[str]
    query: str
645
    k: Optional[int] = None
646
    r: Optional[float] = None
Steven Kreitzer's avatar
Steven Kreitzer committed
647
    hybrid: Optional[bool] = None
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
648
649


650
@app.post("/query/collection")
Timothy J. Baek's avatar
Timothy J. Baek committed
651
def query_collection_handler(
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
652
    form_data: QueryCollectionsForm,
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
653
    user=Depends(get_verified_user),
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
654
):
655
    try:
656
        if app.state.config.ENABLE_RAG_HYBRID_SEARCH:
Timothy J. Baek's avatar
Timothy J. Baek committed
657
658
659
            return query_collection_with_hybrid_search(
                collection_names=form_data.collection_names,
                query=form_data.query,
Steven Kreitzer's avatar
Steven Kreitzer committed
660
                embedding_function=app.state.EMBEDDING_FUNCTION,
661
                k=form_data.k if form_data.k else app.state.config.TOP_K,
Steven Kreitzer's avatar
Steven Kreitzer committed
662
                reranking_function=app.state.sentence_transformer_rf,
663
                r=(
664
                    form_data.r if form_data.r else app.state.config.RELEVANCE_THRESHOLD
665
                ),
Timothy J. Baek's avatar
Timothy J. Baek committed
666
667
668
669
670
            )
        else:
            return query_collection(
                collection_names=form_data.collection_names,
                query=form_data.query,
Steven Kreitzer's avatar
Steven Kreitzer committed
671
                embedding_function=app.state.EMBEDDING_FUNCTION,
672
                k=form_data.k if form_data.k else app.state.config.TOP_K,
Timothy J. Baek's avatar
Timothy J. Baek committed
673
            )
674

675
676
677
678
679
680
    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
681
682


Timothy J. Baek's avatar
Timothy J. Baek committed
683
@app.post("/youtube")
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
684
def store_youtube_video(form_data: UrlForm, user=Depends(get_verified_user)):
Timothy J. Baek's avatar
Timothy J. Baek committed
685
    try:
686
687
688
        loader = YoutubeLoader.from_youtube_url(
            form_data.url,
            add_video_info=True,
689
            language=app.state.config.YOUTUBE_LOADER_LANGUAGE,
690
691
            translation=app.state.YOUTUBE_LOADER_TRANSLATION,
        )
Timothy J. Baek's avatar
Timothy J. Baek committed
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
        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),
        )


712
@app.post("/web")
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
713
def store_web(form_data: UrlForm, user=Depends(get_verified_user)):
714
715
    # "https://www.gutenberg.org/files/1727/1727-h/1727-h.htm"
    try:
716
        loader = get_web_loader(
717
            form_data.url,
718
            verify_ssl=app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION,
719
        )
720
        data = loader.load()
Timothy J. Baek's avatar
Timothy J. Baek committed
721
722
723
724
725

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

726
        store_data_in_vector_db(data, collection_name, overwrite=True)
Timothy J. Baek's avatar
Timothy J. Baek committed
727
728
        return {
            "status": True,
Timothy J. Baek's avatar
Timothy J. Baek committed
729
            "collection_name": collection_name,
Timothy J. Baek's avatar
Timothy J. Baek committed
730
731
            "filename": form_data.url,
        }
732
    except Exception as e:
733
        log.exception(e)
734
735
736
737
738
        raise HTTPException(
            status_code=status.HTTP_400_BAD_REQUEST,
            detail=ERROR_MESSAGES.DEFAULT(e),
        )

739

740
def get_web_loader(url: Union[str, Sequence[str]], verify_ssl: bool = True):
741
    # Check if the URL is valid
742
    if not validate_url(url):
743
        raise ValueError(ERROR_MESSAGES.INVALID_URL)
744
    return SafeWebBaseLoader(
745
746
747
        url,
        verify_ssl=verify_ssl,
        requests_per_second=RAG_WEB_SEARCH_CONCURRENT_REQUESTS,
748
        continue_on_failure=True,
749
    )
750
751


752
753
754
755
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)
756
        if not ENABLE_RAG_LOCAL_WEB_FETCH:
Timothy J. Baek's avatar
revert  
Timothy J. Baek committed
757
758
759
760
761
762
763
764
765
766
767
            # 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):
768
769
770
771
772
773
774
                    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
775

Timothy J. Baek's avatar
revert  
Timothy J. Baek committed
776
777
778
779
780
781
782
783
784
785
786
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
787
788
789
790
791
792
793
794
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
795
    - SERPLY_API_KEY
796
    - TAVILY_API_KEY
Timothy J. Baek's avatar
Timothy J. Baek committed
797
798
799
800
801
802
803
    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
804
805
806
807
            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
808
                app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
Timothy J. Baek's avatar
Timothy J. Baek committed
809
            )
Timothy J. Baek's avatar
Timothy J. Baek committed
810
811
812
813
814
815
816
817
818
819
820
        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
821
                app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
Timothy J. Baek's avatar
Timothy J. Baek 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
829
            )
        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
830
831
832
833
            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
834
                app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
Timothy J. Baek's avatar
Timothy J. Baek committed
835
            )
Timothy J. Baek's avatar
Timothy J. Baek committed
836
837
838
839
840
841
842
        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
843
                app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
Que Nguyen's avatar
Que Nguyen committed
844
                app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
Timothy J. Baek's avatar
Timothy J. Baek committed
845
846
847
848
849
850
                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
851
852
853
854
            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
855
                app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
Timothy J. Baek's avatar
Timothy J. Baek committed
856
            )
Timothy J. Baek's avatar
Timothy J. Baek committed
857
858
        else:
            raise Exception("No SERPER_API_KEY found in environment variables")
859
860
861
862
863
864
    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
865
                app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
866
867
868
            )
        else:
            raise Exception("No SERPLY_API_KEY found in environment variables")
869
    elif engine == "duckduckgo":
Timothy J. Baek's avatar
Timothy J. Baek committed
870
871
872
873
874
        return search_duckduckgo(
            query,
            app.state.config.RAG_WEB_SEARCH_RESULT_COUNT,
            app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
        )
875
876
877
878
879
880
881
882
883
    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")
884
885
    elif engine == "jina":
        return search_jina(query, app.state.config.RAG_WEB_SEARCH_RESULT_COUNT)
Timothy J. Baek's avatar
Timothy J. Baek committed
886
887
888
889
    else:
        raise Exception("No search engine API key found in environment variables")


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
890
@app.post("/web/search")
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
891
def store_web_search(form_data: SearchForm, user=Depends(get_verified_user)):
892
    try:
Timothy J. Baek's avatar
Timothy J. Baek committed
893
894
895
        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
896
897
898
899
900
901
902
903
904
905
906
907
908
        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:
909
910
        urls = [result.link for result in web_results]
        loader = get_web_loader(urls)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
911
        data = loader.load()
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930

        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),
        )


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

933
    text_splitter = RecursiveCharacterTextSplitter(
934
935
        chunk_size=app.state.config.CHUNK_SIZE,
        chunk_overlap=app.state.config.CHUNK_OVERLAP,
936
937
        add_start_index=True,
    )
938

939
    docs = text_splitter.split_documents(data)
Timothy J. Baek's avatar
Timothy J. Baek committed
940
941

    if len(docs) > 0:
942
        log.info(f"store_data_in_vector_db {docs}")
Timothy J. Baek's avatar
Timothy J. Baek committed
943
944
945
        return store_docs_in_vector_db(docs, collection_name, overwrite), None
    else:
        raise ValueError(ERROR_MESSAGES.EMPTY_CONTENT)
946
947
948


def store_text_in_vector_db(
Timothy J. Baek's avatar
Timothy J. Baek committed
949
    text, metadata, collection_name, overwrite: bool = False
950
951
) -> bool:
    text_splitter = RecursiveCharacterTextSplitter(
952
953
        chunk_size=app.state.config.CHUNK_SIZE,
        chunk_overlap=app.state.config.CHUNK_OVERLAP,
954
955
        add_start_index=True,
    )
Timothy J. Baek's avatar
Timothy J. Baek committed
956
    docs = text_splitter.create_documents([text], metadatas=[metadata])
957
958
959
    return store_docs_in_vector_db(docs, collection_name, overwrite)


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

963
964
965
    texts = [doc.page_content for doc in docs]
    metadatas = [doc.metadata for doc in docs]

mindspawn's avatar
mindspawn committed
966
967
968
969
970
971
972
    # 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)

973
974
975
976
    try:
        if overwrite:
            for collection in CHROMA_CLIENT.list_collections():
                if collection_name == collection.name:
977
                    log.info(f"deleting existing collection {collection_name}")
978
979
                    CHROMA_CLIENT.delete_collection(name=collection_name)

980
        collection = CHROMA_CLIENT.create_collection(name=collection_name)
981

Timothy J. Baek's avatar
Timothy J. Baek committed
982
        embedding_func = get_embedding_function(
983
984
            app.state.config.RAG_EMBEDDING_ENGINE,
            app.state.config.RAG_EMBEDDING_MODEL,
Steven Kreitzer's avatar
Steven Kreitzer committed
985
            app.state.sentence_transformer_ef,
986
987
            app.state.config.OPENAI_API_KEY,
            app.state.config.OPENAI_API_BASE_URL,
988
            app.state.config.RAG_EMBEDDING_OPENAI_BATCH_SIZE,
Steven Kreitzer's avatar
Steven Kreitzer committed
989
990
991
        )

        embedding_texts = list(map(lambda x: x.replace("\n", " "), texts))
992
        embeddings = embedding_func(embedding_texts)
993
994
995

        for batch in create_batches(
            api=CHROMA_CLIENT,
996
            ids=[str(uuid.uuid4()) for _ in texts],
997
998
999
1000
1001
            metadatas=metadatas,
            embeddings=embeddings,
            documents=texts,
        ):
            collection.add(*batch)
1002

1003
        return True
1004
    except Exception as e:
1005
        log.exception(e)
1006
1007
1008
1009
1010
1011
        if e.__class__.__name__ == "UniqueConstraintError":
            return True

        return False


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
class TikaLoader:
    def __init__(self, file_path, mime_type=None):
        self.file_path = file_path
        self.mime_type = mime_type

    def load(self) -> List[Document]:
        with (open(self.file_path, "rb") as f):
            data = f.read()

        if self.mime_type is not None:
            headers = {"Content-Type": self.mime_type}
        else:
            headers = {}

1026
        endpoint = app.state.config.TIKA_SERVER_URL
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
        if not endpoint.endswith("/"):
            endpoint += "/"
        endpoint += "tika/text"

        r = requests.put(endpoint, data=data, headers=headers)

        if r.ok:
            raw_metadata = r.json()
            text = raw_metadata.get("X-TIKA:content", "<No text content found>")

            if "Content-Type" in raw_metadata:
                headers["Content-Type"] = raw_metadata["Content-Type"]

            log.info("Tika extracted text: %s", text)

            return [Document(page_content=text, metadata=headers)]
        else:
            raise Exception(f"Error calling Tika: {r.reason}")


1047
1048
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
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
    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
1094
        "msg",
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1095
1096
    ]

1097
    if app.state.config.TEXT_EXTRACTION_ENGINE == "tika" and app.state.config.TIKA_SERVER_URL:
1098
1099
1100
1101
1102
1103
        if file_ext in known_source_ext or (
                file_content_type and file_content_type.find("text/") >= 0
        ):
            loader = TextLoader(file_path, autodetect_encoding=True)
        else:
            loader = TikaLoader(file_path, file_content_type)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1104
    else:
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
        if file_ext == "pdf":
            loader = PyPDFLoader(
                file_path, extract_images=app.state.config.PDF_EXTRACT_IMAGES
            )
        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)
        elif file_ext in ["htm", "html"]:
            loader = BSHTMLLoader(file_path, open_encoding="unicode_escape")
        elif file_ext == "md":
            loader = UnstructuredMarkdownLoader(file_path)
        elif file_content_type == "application/epub+zip":
            loader = UnstructuredEPubLoader(file_path)
        elif (
            file_content_type
            == "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
            or file_ext in ["doc", "docx"]
        ):
            loader = Docx2txtLoader(file_path)
        elif file_content_type in [
            "application/vnd.ms-excel",
            "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
        ] or file_ext in ["xls", "xlsx"]:
            loader = UnstructuredExcelLoader(file_path)
        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)
        elif file_ext == "msg":
            loader = OutlookMessageLoader(file_path)
        elif file_ext in known_source_ext or (
            file_content_type and file_content_type.find("text/") >= 0
        ):
            loader = TextLoader(file_path, autodetect_encoding=True)
        else:
            loader = TextLoader(file_path, autodetect_encoding=True)
            known_type = False
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1146
1147
1148
1149

    return loader, known_type


1150
@app.post("/doc")
Timothy J. Baek's avatar
Timothy J. Baek committed
1151
def store_doc(
Timothy J. Baek's avatar
Timothy J. Baek committed
1152
    collection_name: Optional[str] = Form(None),
Timothy J. Baek's avatar
Timothy J. Baek committed
1153
    file: UploadFile = File(...),
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1154
    user=Depends(get_verified_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
1155
):
1156
    # "https://www.gutenberg.org/files/1727/1727-h/1727-h.htm"
Timothy J. Baek's avatar
Timothy J. Baek committed
1157

1158
    log.info(f"file.content_type: {file.content_type}")
1159
    try:
1160
        unsanitized_filename = file.filename
Timothy J. Baek's avatar
Timothy J. Baek committed
1161
        filename = os.path.basename(unsanitized_filename)
1162

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

1165
        contents = file.file.read()
Timothy J. Baek's avatar
Timothy J. Baek committed
1166
        with open(file_path, "wb") as f:
1167
1168
1169
            f.write(contents)
            f.close()

Timothy J. Baek's avatar
Timothy J. Baek committed
1170
1171
1172
1173
1174
        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
1175
        loader, known_type = get_loader(filename, file.content_type, file_path)
Timothy J. Baek's avatar
Timothy J. Baek committed
1176
        data = loader.load()
Timothy J. Baek's avatar
Timothy J. Baek committed
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188

        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
1189
1190
            raise HTTPException(
                status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
Timothy J. Baek's avatar
Timothy J. Baek committed
1191
                detail=e,
Timothy J. Baek's avatar
Timothy J. Baek committed
1192
            )
1193
    except Exception as e:
1194
        log.exception(e)
Dave Bauman's avatar
Dave Bauman committed
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
        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),
            )
1205
1206


Timothy J. Baek's avatar
Timothy J. Baek committed
1207
1208
class ProcessDocForm(BaseModel):
    file_id: str
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1209
    collection_name: Optional[str] = None
Timothy J. Baek's avatar
Timothy J. Baek committed
1210
1211
1212
1213
1214


@app.post("/process/doc")
def process_doc(
    form_data: ProcessDocForm,
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1215
    user=Depends(get_verified_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
1216
1217
1218
1219
1220
1221
):
    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
1222
1223

        collection_name = form_data.collection_name
Timothy J. Baek's avatar
Timothy J. Baek committed
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
        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),
            )


1261
1262
1263
1264
1265
1266
1267
1268
1269
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
1270
    user=Depends(get_verified_user),
1271
1272
1273
1274
1275
1276
):

    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
1277
1278
1279
1280
1281
    result = store_text_in_vector_db(
        form_data.content,
        metadata={"name": form_data.name, "created_by": user.id},
        collection_name=collection_name,
    )
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291

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


1292
1293
@app.get("/scan")
def scan_docs_dir(user=Depends(get_admin_user)):
1294
1295
    for path in Path(DOCS_DIR).rglob("./**/*"):
        try:
1296
1297
1298
1299
1300
1301
1302
1303
1304
            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
1305
1306
1307
                loader, known_type = get_loader(
                    filename, file_content_type[0], str(path)
                )
1308
1309
                data = loader.load()

Timothy J. Baek's avatar
Timothy J. Baek committed
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
                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,
                                                        )
1334
                                                    )
Timothy J. Baek's avatar
Timothy J. Baek committed
1335
1336
1337
1338
1339
1340
1341
1342
1343
                                                }
                                            )
                                            if len(tags)
                                            else "{}"
                                        ),
                                    }
                                ),
                            )
                except Exception as e:
1344
                    log.exception(e)
Timothy J. Baek's avatar
Timothy J. Baek committed
1345
                    pass
1346

1347
        except Exception as e:
1348
            log.exception(e)
1349
1350
1351
1352

    return True


Timothy J. Baek's avatar
Timothy J. Baek committed
1353
@app.get("/reset/db")
1354
1355
def reset_vector_db(user=Depends(get_admin_user)):
    CHROMA_CLIENT.reset()
Timothy J. Baek's avatar
Timothy J. Baek committed
1356
1357


Timothy J. Baek's avatar
Timothy J. Baek committed
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
@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
1382
@app.get("/reset")
1383
1384
1385
1386
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
1387
        try:
1388
1389
1390
1391
            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
1392
        except Exception as e:
1393
            log.error("Failed to delete %s. Reason: %s" % (file_path, e))
Timothy J. Baek's avatar
Timothy J. Baek committed
1394

1395
1396
1397
    try:
        CHROMA_CLIENT.reset()
    except Exception as e:
1398
        log.exception(e)
1399
1400

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

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

1403
1404
class SafeWebBaseLoader(WebBaseLoader):
    """WebBaseLoader with enhanced error handling for URLs."""
Timothy J. Baek's avatar
Timothy J. Baek committed
1405

1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
    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
1418
1419
1420
                    metadata["description"] = description.get(
                        "content", "No description found."
                    )
1421
1422
                if html := soup.find("html"):
                    metadata["language"] = html.get("lang", "No language found.")
Timothy J. Baek's avatar
Timothy J. Baek committed
1423

1424
1425
1426
1427
                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
1428
1429


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1430
1431
1432
1433
1434
1435
1436
1437
1438
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)}