Files

1121 lines
34 KiB
Python
Raw Permalink Normal View History

2024-12-13 15:29:43 +01:00
from typing import List, Optional
2024-10-01 22:45:04 -07:00
from pydantic import BaseModel
2025-09-02 21:32:07 +04:00
from fastapi import APIRouter, Depends, HTTPException, status, Request, Query
2026-01-08 12:49:45 +04:00
from fastapi.responses import StreamingResponse
2025-11-24 21:22:23 +01:00
from fastapi.concurrency import run_in_threadpool
2024-10-04 11:11:53 -07:00
import logging
2026-01-08 12:49:45 +04:00
import io
import zipfile
2024-10-01 22:45:04 -07:00
2025-12-29 00:21:18 +04:00
from sqlalchemy.orm import Session
from open_webui.internal.db import get_session
2025-12-10 23:19:19 -05:00
from open_webui.models.groups import Groups
2024-12-10 00:54:13 -08:00
from open_webui.models.knowledge import (
2025-12-10 00:53:41 -05:00
KnowledgeFileListResponse,
2024-10-01 22:45:04 -07:00
Knowledges,
KnowledgeForm,
KnowledgeResponse,
2024-11-18 05:51:01 -08:00
KnowledgeUserResponse,
2024-10-01 22:45:04 -07:00
)
2025-04-18 01:40:30 +02:00
from open_webui.models.files import Files, FileModel, FileMetadataResponse
from open_webui.retrieval.vector.factory import VECTOR_DB_CLIENT
2024-12-18 12:18:31 -05:00
from open_webui.routers.retrieval import (
process_file,
ProcessFileForm,
process_files_batch,
BatchProcessFilesForm,
)
from open_webui.storage.provider import Storage
2024-10-02 20:42:10 -07:00
2024-10-01 22:45:04 -07:00
from open_webui.constants import ERROR_MESSAGES
2026-01-08 12:49:45 +04:00
from open_webui.utils.auth import get_verified_user, get_admin_user
2026-02-23 16:01:03 -06:00
from open_webui.utils.access_control import has_permission, filter_allowed_access_grants
from open_webui.models.access_grants import AccessGrants
2024-11-16 18:00:57 -08:00
from open_webui.config import BYPASS_ADMIN_ACCESS_CONTROL
from open_webui.models.models import Models, ModelForm
2024-10-04 11:11:53 -07:00
log = logging.getLogger(__name__)
2024-10-03 06:46:20 -07:00
2024-10-01 22:45:04 -07:00
router = APIRouter()
############################
2024-11-16 16:51:55 -08:00
# getKnowledgeBases
2024-10-01 22:45:04 -07:00
############################
2025-12-10 23:19:19 -05:00
PAGE_ITEM_COUNT = 30
2026-01-09 22:21:00 +04:00
############################
# Knowledge Base Embedding
############################
KNOWLEDGE_BASES_COLLECTION = "knowledge-bases"
async def embed_knowledge_base_metadata(
request: Request,
knowledge_base_id: str,
name: str,
description: str,
) -> bool:
"""Generate and store embedding for knowledge base."""
try:
content = f"{name}\n\n{description}" if description else name
embedding = await request.app.state.EMBEDDING_FUNCTION(content)
VECTOR_DB_CLIENT.upsert(
collection_name=KNOWLEDGE_BASES_COLLECTION,
items=[
{
"id": knowledge_base_id,
"text": content,
"vector": embedding,
"metadata": {
"knowledge_base_id": knowledge_base_id,
},
}
],
)
return True
except Exception as e:
log.error(f"Failed to embed knowledge base {knowledge_base_id}: {e}")
return False
def remove_knowledge_base_metadata_embedding(knowledge_base_id: str) -> bool:
"""Remove knowledge base embedding."""
try:
VECTOR_DB_CLIENT.delete(
collection_name=KNOWLEDGE_BASES_COLLECTION,
ids=[knowledge_base_id],
)
return True
except Exception as e:
log.debug(f"Failed to remove embedding for {knowledge_base_id}: {e}")
return False
2024-10-01 22:45:04 -07:00
2025-12-10 16:58:53 -05:00
class KnowledgeAccessResponse(KnowledgeUserResponse):
write_access: Optional[bool] = False
2025-12-10 23:19:19 -05:00
class KnowledgeAccessListResponse(BaseModel):
items: list[KnowledgeAccessResponse]
total: int
2024-11-16 16:51:55 -08:00
2025-12-10 23:19:19 -05:00
@router.get("/", response_model=KnowledgeAccessListResponse)
2025-12-29 00:21:18 +04:00
async def get_knowledge_bases(
page: Optional[int] = 1,
user=Depends(get_verified_user),
db: Session = Depends(get_session),
):
2025-12-10 23:19:19 -05:00
page = max(page, 1)
limit = PAGE_ITEM_COUNT
skip = (page - 1) * limit
filter = {}
2026-02-13 13:56:29 -06:00
groups = Groups.get_groups_by_member_id(user.id, db=db)
user_group_ids = {group.id for group in groups}
2025-12-10 23:19:19 -05:00
if not user.role == "admin" or not BYPASS_ADMIN_ACCESS_CONTROL:
if groups:
filter["group_ids"] = [group.id for group in groups]
filter["user_id"] = user.id
result = Knowledges.search_knowledge_bases(
2025-12-29 00:21:18 +04:00
user.id, filter=filter, skip=skip, limit=limit, db=db
2025-12-10 23:19:19 -05:00
)
2026-02-13 13:56:29 -06:00
# Batch-fetch writable knowledge IDs in a single query instead of N has_access calls
knowledge_base_ids = [knowledge_base.id for knowledge_base in result.items]
writable_knowledge_base_ids = AccessGrants.get_accessible_resource_ids(
user_id=user.id,
resource_type="knowledge",
resource_ids=knowledge_base_ids,
permission="write",
user_group_ids=user_group_ids,
db=db,
)
2025-12-10 23:19:19 -05:00
return KnowledgeAccessListResponse(
items=[
KnowledgeAccessResponse(
**knowledge_base.model_dump(),
write_access=(
user.id == knowledge_base.user_id
or (user.role == "admin" and BYPASS_ADMIN_ACCESS_CONTROL)
2026-02-13 13:56:29 -06:00
or knowledge_base.id in writable_knowledge_base_ids
2025-12-10 23:19:19 -05:00
),
)
for knowledge_base in result.items
],
total=result.total,
)
@router.get("/search", response_model=KnowledgeAccessListResponse)
async def search_knowledge_bases(
query: Optional[str] = None,
view_option: Optional[str] = None,
page: Optional[int] = 1,
user=Depends(get_verified_user),
2025-12-29 00:21:18 +04:00
db: Session = Depends(get_session),
2025-12-10 23:19:19 -05:00
):
page = max(page, 1)
limit = PAGE_ITEM_COUNT
skip = (page - 1) * limit
filter = {}
if query:
filter["query"] = query
if view_option:
filter["view_option"] = view_option
2026-02-13 13:56:29 -06:00
groups = Groups.get_groups_by_member_id(user.id, db=db)
user_group_ids = {group.id for group in groups}
2025-12-10 23:19:19 -05:00
if not user.role == "admin" or not BYPASS_ADMIN_ACCESS_CONTROL:
if groups:
filter["group_ids"] = [group.id for group in groups]
filter["user_id"] = user.id
result = Knowledges.search_knowledge_bases(
2025-12-29 00:21:18 +04:00
user.id, filter=filter, skip=skip, limit=limit, db=db
2025-12-10 23:19:19 -05:00
)
2026-02-13 13:56:29 -06:00
# Batch-fetch writable knowledge IDs in a single query instead of N has_access calls
knowledge_base_ids = [knowledge_base.id for knowledge_base in result.items]
writable_knowledge_base_ids = AccessGrants.get_accessible_resource_ids(
user_id=user.id,
resource_type="knowledge",
resource_ids=knowledge_base_ids,
permission="write",
user_group_ids=user_group_ids,
db=db,
)
2025-12-10 23:19:19 -05:00
return KnowledgeAccessListResponse(
items=[
KnowledgeAccessResponse(
**knowledge_base.model_dump(),
write_access=(
user.id == knowledge_base.user_id
or (user.role == "admin" and BYPASS_ADMIN_ACCESS_CONTROL)
2026-02-13 13:56:29 -06:00
or knowledge_base.id in writable_knowledge_base_ids
2025-12-10 23:19:19 -05:00
),
)
for knowledge_base in result.items
],
total=result.total,
)
@router.get("/search/files", response_model=KnowledgeFileListResponse)
async def search_knowledge_files(
query: Optional[str] = None,
page: Optional[int] = 1,
user=Depends(get_verified_user),
2025-12-29 00:21:18 +04:00
db: Session = Depends(get_session),
2025-12-10 23:19:19 -05:00
):
page = max(page, 1)
limit = PAGE_ITEM_COUNT
skip = (page - 1) * limit
filter = {}
if query:
filter["query"] = query
2025-12-29 00:21:18 +04:00
groups = Groups.get_groups_by_member_id(user.id, db=db)
2025-12-10 23:19:19 -05:00
if groups:
filter["group_ids"] = [group.id for group in groups]
filter["user_id"] = user.id
2025-12-29 00:21:18 +04:00
return Knowledges.search_knowledge_files(
filter=filter, skip=skip, limit=limit, db=db
)
2024-10-01 22:45:04 -07:00
############################
# CreateNewKnowledge
############################
@router.post("/create", response_model=Optional[KnowledgeResponse])
2024-11-16 16:51:55 -08:00
async def create_new_knowledge(
2025-12-29 00:21:18 +04:00
request: Request,
form_data: KnowledgeForm,
user=Depends(get_verified_user),
2024-11-16 16:51:55 -08:00
):
# NOTE: We intentionally do NOT use Depends(get_session) here.
2026-02-23 16:01:03 -06:00
# Database operations (has_permission, filter_allowed_access_grants, insert_new_knowledge) manage their own sessions.
# This prevents holding a connection during embed_knowledge_base_metadata()
# which makes external embedding API calls (1-5+ seconds).
2024-11-17 03:04:31 -08:00
if user.role != "admin" and not has_permission(
user.id, "workspace.knowledge", request.app.state.config.USER_PERMISSIONS
2024-11-17 03:04:31 -08:00
):
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail=ERROR_MESSAGES.UNAUTHORIZED,
)
2026-02-23 16:01:03 -06:00
form_data.access_grants = filter_allowed_access_grants(
request.app.state.config.USER_PERMISSIONS,
user.id,
user.role,
form_data.access_grants,
"sharing.public_knowledge",
)
2026-02-23 15:49:05 -06:00
knowledge = Knowledges.insert_new_knowledge(user.id, form_data)
2024-10-01 22:45:04 -07:00
if knowledge:
2026-01-09 22:21:00 +04:00
# Embed knowledge base for semantic search
await embed_knowledge_base_metadata(
request,
knowledge.id,
knowledge.name,
knowledge.description,
)
2024-10-01 22:45:04 -07:00
return knowledge
else:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.FILE_EXISTS,
)
############################
# ReindexKnowledgeFiles
############################
@router.post("/reindex", response_model=bool)
2025-12-29 00:21:18 +04:00
async def reindex_knowledge_files(
request: Request,
user=Depends(get_verified_user),
db: Session = Depends(get_session),
):
if user.role != "admin":
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail=ERROR_MESSAGES.UNAUTHORIZED,
)
2025-04-12 16:35:11 -07:00
2025-12-29 00:21:18 +04:00
knowledge_bases = Knowledges.get_knowledge_bases(db=db)
2025-04-12 16:35:11 -07:00
log.info(f"Starting reindexing for {len(knowledge_bases)} knowledge bases")
2025-04-12 16:35:11 -07:00
for knowledge_base in knowledge_bases:
try:
2025-12-29 00:21:18 +04:00
files = Knowledges.get_files_by_id(knowledge_base.id, db=db)
try:
if VECTOR_DB_CLIENT.has_collection(collection_name=knowledge_base.id):
VECTOR_DB_CLIENT.delete_collection(
collection_name=knowledge_base.id
)
except Exception as e:
log.error(f"Error deleting collection {knowledge_base.id}: {str(e)}")
continue # Skip, don't raise
2025-04-12 16:35:11 -07:00
failed_files = []
for file in files:
try:
2025-11-24 21:22:23 +01:00
await run_in_threadpool(
process_file,
request,
2025-04-12 16:35:11 -07:00
ProcessFileForm(
file_id=file.id, collection_name=knowledge_base.id
),
user=user,
2025-12-29 00:21:18 +04:00
db=db,
)
except Exception as e:
2025-04-12 16:35:11 -07:00
log.error(
f"Error processing file {file.filename} (ID: {file.id}): {str(e)}"
)
failed_files.append({"file_id": file.id, "error": str(e)})
continue
2025-04-12 16:35:11 -07:00
except Exception as e:
log.error(f"Error processing knowledge base {knowledge_base.id}: {str(e)}")
# Don't raise, just continue
continue
2025-04-12 16:35:11 -07:00
if failed_files:
2025-04-12 16:35:11 -07:00
log.warning(
f"Failed to process {len(failed_files)} files in knowledge base {knowledge_base.id}"
)
for failed in failed_files:
log.warning(f"File ID: {failed['file_id']}, Error: {failed['error']}")
2025-04-12 16:35:11 -07:00
2025-12-02 10:53:32 -05:00
log.info(f"Reindexing completed.")
return True
2024-10-01 22:45:04 -07:00
2026-01-09 22:21:00 +04:00
############################
# ReindexKnowledgeBases
############################
@router.post("/metadata/reindex", response_model=dict)
async def reindex_knowledge_base_metadata_embeddings(
request: Request,
user=Depends(get_admin_user),
):
"""Batch embed all existing knowledge bases. Admin only.
2026-02-11 16:24:11 -06:00
NOTE: We intentionally do NOT use Depends(get_session) here.
This endpoint loops through ALL knowledge bases and calls embed_knowledge_base_metadata()
for each one, making N external embedding API calls. Holding a session during
this entire operation would exhaust the connection pool.
"""
knowledge_bases = Knowledges.get_knowledge_bases()
2026-01-09 22:21:00 +04:00
log.info(f"Reindexing embeddings for {len(knowledge_bases)} knowledge bases")
success_count = 0
for kb in knowledge_bases:
if await embed_knowledge_base_metadata(request, kb.id, kb.name, kb.description):
success_count += 1
log.info(f"Embedding reindex complete: {success_count}/{len(knowledge_bases)}")
return {"total": len(knowledge_bases), "success": success_count}
2024-10-01 22:45:04 -07:00
############################
# GetKnowledgeById
############################
2024-10-02 20:42:10 -07:00
class KnowledgeFilesResponse(KnowledgeResponse):
2025-12-10 23:19:19 -05:00
files: Optional[list[FileMetadataResponse]] = None
2025-12-10 16:58:53 -05:00
write_access: Optional[bool] = False
2024-10-02 20:42:10 -07:00
@router.get("/{id}", response_model=Optional[KnowledgeFilesResponse])
2025-12-29 00:21:18 +04:00
async def get_knowledge_by_id(
id: str, user=Depends(get_verified_user), db: Session = Depends(get_session)
):
knowledge = Knowledges.get_knowledge_by_id(id=id, db=db)
2024-10-01 22:45:04 -07:00
if knowledge:
2024-11-16 18:00:57 -08:00
if (
user.role == "admin"
or knowledge.user_id == user.id
2026-02-09 13:28:14 -06:00
or AccessGrants.has_access(
user_id=user.id,
resource_type="knowledge",
resource_id=knowledge.id,
permission="read",
db=db,
)
2024-11-16 18:00:57 -08:00
):
return KnowledgeFilesResponse(
**knowledge.model_dump(),
2025-12-10 17:00:28 -05:00
write_access=(
user.id == knowledge.user_id
or (user.role == "admin" and BYPASS_ADMIN_ACCESS_CONTROL)
2026-02-09 13:28:14 -06:00
or AccessGrants.has_access(
user_id=user.id,
resource_type="knowledge",
resource_id=knowledge.id,
permission="write",
db=db,
)
2025-12-10 17:00:28 -05:00
),
2024-11-16 18:00:57 -08:00
)
else:
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail=ERROR_MESSAGES.ACCESS_PROHIBITED,
)
2024-10-01 22:45:04 -07:00
else:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
2024-10-01 22:45:04 -07:00
detail=ERROR_MESSAGES.NOT_FOUND,
)
############################
# UpdateKnowledgeById
############################
2024-10-03 06:46:20 -07:00
@router.post("/{id}/update", response_model=Optional[KnowledgeFilesResponse])
2024-10-01 22:45:04 -07:00
async def update_knowledge_by_id(
request: Request,
2024-10-01 22:45:04 -07:00
id: str,
2024-11-16 20:47:45 -08:00
form_data: KnowledgeForm,
2024-11-16 16:51:55 -08:00
user=Depends(get_verified_user),
2024-10-01 22:45:04 -07:00
):
# NOTE: We intentionally do NOT use Depends(get_session) here.
# Database operations manage their own short-lived sessions internally.
# This prevents holding a connection during embed_knowledge_base_metadata()
# which makes external embedding API calls (1-5+ seconds).
knowledge = Knowledges.get_knowledge_by_id(id=id)
2024-11-16 18:00:57 -08:00
if not knowledge:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.NOT_FOUND,
)
# Is the user the original creator, in a group with write access, or an admin
2025-01-19 11:59:07 -08:00
if (
knowledge.user_id != user.id
2026-02-09 13:28:14 -06:00
and not AccessGrants.has_access(
user_id=user.id,
resource_type="knowledge",
resource_id=knowledge.id,
permission="write",
)
2025-01-19 11:59:07 -08:00
and user.role != "admin"
):
2024-11-16 18:00:57 -08:00
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.ACCESS_PROHIBITED,
)
2024-10-01 22:45:04 -07:00
2026-02-23 16:01:03 -06:00
form_data.access_grants = filter_allowed_access_grants(
request.app.state.config.USER_PERMISSIONS,
user.id,
user.role,
form_data.access_grants,
"sharing.public_knowledge",
)
2026-02-23 15:49:05 -06:00
knowledge = Knowledges.update_knowledge_by_id(id=id, form_data=form_data)
2024-10-01 22:45:04 -07:00
if knowledge:
2026-01-09 22:21:00 +04:00
# Re-embed knowledge base for semantic search
await embed_knowledge_base_metadata(
request,
knowledge.id,
knowledge.name,
knowledge.description,
)
2024-10-03 06:46:20 -07:00
return KnowledgeFilesResponse(
**knowledge.model_dump(),
files=Knowledges.get_file_metadatas_by_id(knowledge.id),
2024-10-03 06:46:20 -07:00
)
2024-10-01 22:45:04 -07:00
else:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.ID_TAKEN,
)
2026-02-10 15:47:21 -06:00
############################
# UpdateKnowledgeAccessById
############################
class KnowledgeAccessGrantsForm(BaseModel):
access_grants: list[dict]
@router.post("/{id}/access/update", response_model=Optional[KnowledgeFilesResponse])
async def update_knowledge_access_by_id(
request: Request,
2026-02-10 15:47:21 -06:00
id: str,
form_data: KnowledgeAccessGrantsForm,
user=Depends(get_verified_user),
db: Session = Depends(get_session),
):
knowledge = Knowledges.get_knowledge_by_id(id=id, db=db)
if not knowledge:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail=ERROR_MESSAGES.NOT_FOUND,
)
if (
knowledge.user_id != user.id
and not AccessGrants.has_access(
user_id=user.id,
resource_type="knowledge",
resource_id=knowledge.id,
permission="write",
db=db,
)
and user.role != "admin"
):
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.ACCESS_PROHIBITED,
)
2026-02-23 16:01:03 -06:00
form_data.access_grants = filter_allowed_access_grants(
request.app.state.config.USER_PERMISSIONS,
user.id,
user.role,
form_data.access_grants,
"sharing.public_knowledge"
)
2026-02-23 15:49:05 -06:00
2026-02-11 16:24:11 -06:00
AccessGrants.set_access_grants("knowledge", id, form_data.access_grants, db=db)
2026-02-10 15:47:21 -06:00
return KnowledgeFilesResponse(
**Knowledges.get_knowledge_by_id(id=id, db=db).model_dump(),
files=Knowledges.get_file_metadatas_by_id(id, db=db),
)
2025-12-10 00:53:41 -05:00
############################
# GetKnowledgeFilesById
############################
@router.get("/{id}/files", response_model=KnowledgeFileListResponse)
async def get_knowledge_files_by_id(
id: str,
query: Optional[str] = None,
view_option: Optional[str] = None,
order_by: Optional[str] = None,
direction: Optional[str] = None,
page: Optional[int] = 1,
user=Depends(get_verified_user),
2025-12-29 00:21:18 +04:00
db: Session = Depends(get_session),
2025-12-10 00:53:41 -05:00
):
2025-12-29 00:21:18 +04:00
knowledge = Knowledges.get_knowledge_by_id(id=id, db=db)
2025-12-10 00:53:41 -05:00
if not knowledge:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.NOT_FOUND,
)
if not (
user.role == "admin"
or knowledge.user_id == user.id
2026-02-09 13:28:14 -06:00
or AccessGrants.has_access(
user_id=user.id,
resource_type="knowledge",
resource_id=knowledge.id,
permission="read",
db=db,
)
2025-12-10 00:53:41 -05:00
):
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.ACCESS_PROHIBITED,
)
page = max(page, 1)
limit = 30
skip = (page - 1) * limit
filter = {}
if query:
filter["query"] = query
if view_option:
filter["view_option"] = view_option
if order_by:
filter["order_by"] = order_by
if direction:
filter["direction"] = direction
return Knowledges.search_files_by_id(
2025-12-29 00:21:18 +04:00
id, user.id, filter=filter, skip=skip, limit=limit, db=db
2025-12-10 00:53:41 -05:00
)
2024-10-03 06:46:20 -07:00
############################
# AddFileToKnowledge
############################
class KnowledgeFileIdForm(BaseModel):
file_id: str
@router.post("/{id}/file/add", response_model=Optional[KnowledgeFilesResponse])
2024-10-03 22:22:22 -07:00
def add_file_to_knowledge_by_id(
2024-12-12 22:32:28 -08:00
request: Request,
2024-10-03 06:46:20 -07:00
id: str,
form_data: KnowledgeFileIdForm,
2024-11-16 16:51:55 -08:00
user=Depends(get_verified_user),
2025-12-29 00:21:18 +04:00
db: Session = Depends(get_session),
2024-10-03 06:46:20 -07:00
):
2025-12-29 00:21:18 +04:00
knowledge = Knowledges.get_knowledge_by_id(id=id, db=db)
2024-11-16 18:00:57 -08:00
if not knowledge:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.NOT_FOUND,
)
if (
knowledge.user_id != user.id
2026-02-09 13:28:14 -06:00
and not AccessGrants.has_access(
user_id=user.id,
resource_type="knowledge",
resource_id=knowledge.id,
permission="write",
db=db,
)
and user.role != "admin"
):
2024-11-16 18:00:57 -08:00
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.ACCESS_PROHIBITED,
)
2025-12-29 00:21:18 +04:00
file = Files.get_file_by_id(form_data.file_id, db=db)
2024-10-03 06:46:20 -07:00
if not file:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.NOT_FOUND,
)
2024-10-03 22:22:22 -07:00
if not file.data:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.FILE_NOT_PROCESSED,
)
2024-10-03 06:46:20 -07:00
2024-10-03 22:35:43 -07:00
# Add content to the vector database
2024-10-03 23:06:47 -07:00
try:
2024-12-12 22:32:28 -08:00
process_file(
request,
ProcessFileForm(file_id=form_data.file_id, collection_name=id),
2025-02-05 00:07:45 -08:00
user=user,
2025-12-29 00:21:18 +04:00
db=db,
2024-12-12 22:32:28 -08:00
)
2025-12-10 15:48:27 -05:00
# Add file to knowledge base
Knowledges.add_file_to_knowledge_by_id(
2025-12-29 00:21:18 +04:00
knowledge_id=id, file_id=form_data.file_id, user_id=user.id, db=db
2025-12-10 15:48:27 -05:00
)
2024-10-03 23:06:47 -07:00
except Exception as e:
2024-10-04 16:16:16 -07:00
log.debug(e)
2024-10-04 18:22:55 -07:00
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=str(e),
)
2024-10-03 22:35:43 -07:00
2024-10-03 06:46:20 -07:00
if knowledge:
2025-12-02 10:53:32 -05:00
return KnowledgeFilesResponse(
**knowledge.model_dump(),
2025-12-29 00:21:18 +04:00
files=Knowledges.get_file_metadatas_by_id(knowledge.id, db=db),
2025-12-02 10:53:32 -05:00
)
2024-10-03 06:46:20 -07:00
else:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.NOT_FOUND,
)
2024-10-04 00:46:32 -07:00
@router.post("/{id}/file/update", response_model=Optional[KnowledgeFilesResponse])
def update_file_from_knowledge_by_id(
2024-12-12 22:32:28 -08:00
request: Request,
2024-10-04 00:46:32 -07:00
id: str,
form_data: KnowledgeFileIdForm,
2024-11-16 16:51:55 -08:00
user=Depends(get_verified_user),
2025-12-29 00:21:18 +04:00
db: Session = Depends(get_session),
2024-10-04 00:46:32 -07:00
):
2025-12-29 00:21:18 +04:00
knowledge = Knowledges.get_knowledge_by_id(id=id, db=db)
2024-11-16 18:00:57 -08:00
if not knowledge:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.NOT_FOUND,
)
if (
knowledge.user_id != user.id
2026-02-09 13:28:14 -06:00
and not AccessGrants.has_access(
user_id=user.id,
resource_type="knowledge",
resource_id=knowledge.id,
permission="write",
db=db,
)
and user.role != "admin"
):
2024-11-16 18:00:57 -08:00
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.ACCESS_PROHIBITED,
)
2025-12-29 00:21:18 +04:00
file = Files.get_file_by_id(form_data.file_id, db=db)
2024-10-04 00:46:32 -07:00
if not file:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.NOT_FOUND,
)
# Remove content from the vector database
VECTOR_DB_CLIENT.delete(
collection_name=knowledge.id, filter={"file_id": form_data.file_id}
)
# Add content to the vector database
try:
2024-12-12 22:32:28 -08:00
process_file(
request,
ProcessFileForm(file_id=form_data.file_id, collection_name=id),
2025-02-05 00:07:45 -08:00
user=user,
2025-12-29 00:21:18 +04:00
db=db,
2024-12-12 22:32:28 -08:00
)
2024-10-04 00:46:32 -07:00
except Exception as e:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=str(e),
)
if knowledge:
return KnowledgeFilesResponse(
**knowledge.model_dump(),
2025-12-29 00:21:18 +04:00
files=Knowledges.get_file_metadatas_by_id(knowledge.id, db=db),
2024-10-04 00:46:32 -07:00
)
else:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.NOT_FOUND,
)
2024-10-03 06:46:20 -07:00
############################
# RemoveFileFromKnowledge
############################
@router.post("/{id}/file/remove", response_model=Optional[KnowledgeFilesResponse])
2024-10-03 22:22:22 -07:00
def remove_file_from_knowledge_by_id(
2024-10-03 06:46:20 -07:00
id: str,
form_data: KnowledgeFileIdForm,
2025-09-02 21:32:07 +04:00
delete_file: bool = Query(True),
2024-11-16 16:51:55 -08:00
user=Depends(get_verified_user),
2025-12-29 00:21:18 +04:00
db: Session = Depends(get_session),
2024-10-03 06:46:20 -07:00
):
2025-12-29 00:21:18 +04:00
knowledge = Knowledges.get_knowledge_by_id(id=id, db=db)
2024-11-16 18:00:57 -08:00
if not knowledge:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.NOT_FOUND,
)
if (
knowledge.user_id != user.id
2026-02-09 13:28:14 -06:00
and not AccessGrants.has_access(
user_id=user.id,
resource_type="knowledge",
resource_id=knowledge.id,
permission="write",
db=db,
)
and user.role != "admin"
):
2024-11-16 18:00:57 -08:00
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.ACCESS_PROHIBITED,
)
2025-12-29 00:21:18 +04:00
file = Files.get_file_by_id(form_data.file_id, db=db)
2024-10-03 06:46:20 -07:00
if not file:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.NOT_FOUND,
)
2025-12-02 10:53:32 -05:00
Knowledges.remove_file_from_knowledge_by_id(
2025-12-29 00:21:18 +04:00
knowledge_id=id, file_id=form_data.file_id, db=db
2025-12-02 10:53:32 -05:00
)
2024-10-03 22:35:43 -07:00
# Remove content from the vector database
try:
VECTOR_DB_CLIENT.delete(
collection_name=knowledge.id, filter={"file_id": form_data.file_id}
2025-11-29 13:19:06 -05:00
) # Remove by file_id first
VECTOR_DB_CLIENT.delete(
collection_name=knowledge.id, filter={"hash": file.hash}
) # Remove by hash as well in case of duplicates
except Exception as e:
log.debug("This was most likely caused by bypassing embedding processing")
log.debug(e)
pass
2024-10-03 06:46:20 -07:00
2025-09-02 21:32:07 +04:00
if delete_file:
try:
# Remove the file's collection from vector database
file_collection = f"file-{form_data.file_id}"
if VECTOR_DB_CLIENT.has_collection(collection_name=file_collection):
VECTOR_DB_CLIENT.delete_collection(collection_name=file_collection)
except Exception as e:
log.debug("This was most likely caused by bypassing embedding processing")
log.debug(e)
pass
2025-09-02 21:32:07 +04:00
# Delete file from database
2025-12-29 00:21:18 +04:00
Files.delete_file_by_id(form_data.file_id, db=db)
2024-10-03 06:46:20 -07:00
if knowledge:
2025-12-02 10:53:32 -05:00
return KnowledgeFilesResponse(
**knowledge.model_dump(),
2025-12-29 00:21:18 +04:00
files=Knowledges.get_file_metadatas_by_id(knowledge.id, db=db),
2025-12-02 10:53:32 -05:00
)
2024-10-03 06:46:20 -07:00
else:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.NOT_FOUND,
)
2024-10-04 18:44:57 -07:00
############################
2024-11-16 18:00:57 -08:00
# DeleteKnowledgeById
2024-10-04 18:44:57 -07:00
############################
2024-11-16 18:00:57 -08:00
@router.delete("/{id}/delete", response_model=bool)
2025-12-29 00:21:18 +04:00
async def delete_knowledge_by_id(
id: str, user=Depends(get_verified_user), db: Session = Depends(get_session)
):
knowledge = Knowledges.get_knowledge_by_id(id=id, db=db)
2024-11-16 18:00:57 -08:00
if not knowledge:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.NOT_FOUND,
)
if (
knowledge.user_id != user.id
2026-02-09 13:28:14 -06:00
and not AccessGrants.has_access(
user_id=user.id,
resource_type="knowledge",
resource_id=knowledge.id,
permission="write",
db=db,
)
and user.role != "admin"
):
2024-11-16 18:00:57 -08:00
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.ACCESS_PROHIBITED,
)
log.info(f"Deleting knowledge base: {id} (name: {knowledge.name})")
# Get all models
2025-12-29 00:21:18 +04:00
models = Models.get_all_models(db=db)
log.info(f"Found {len(models)} models to check for knowledge base {id}")
# Update models that reference this knowledge base
for model in models:
if model.meta and hasattr(model.meta, "knowledge"):
knowledge_list = model.meta.knowledge or []
# Filter out the deleted knowledge base
updated_knowledge = [k for k in knowledge_list if k.get("id") != id]
2025-01-09 18:41:18 +01:00
# If the knowledge list changed, update the model
if len(updated_knowledge) != len(knowledge_list):
log.info(f"Updating model {model.id} to remove knowledge base {id}")
model.meta.knowledge = updated_knowledge
# Create a ModelForm for the update
model_form = ModelForm(
id=model.id,
name=model.name,
base_model_id=model.base_model_id,
meta=model.meta,
params=model.params,
2026-02-09 13:28:14 -06:00
access_grants=model.access_grants,
2025-01-09 18:41:18 +01:00
is_active=model.is_active,
)
2025-12-29 00:21:18 +04:00
Models.update_model_by_id(model.id, model_form, db=db)
# Clean up vector DB
2024-10-04 18:44:57 -07:00
try:
VECTOR_DB_CLIENT.delete_collection(collection_name=id)
except Exception as e:
log.debug(e)
pass
2026-01-09 22:21:00 +04:00
# Remove knowledge base embedding
remove_knowledge_base_metadata_embedding(id)
2025-12-29 00:21:18 +04:00
result = Knowledges.delete_knowledge_by_id(id=id, db=db)
2024-11-16 18:00:57 -08:00
return result
2024-10-04 18:44:57 -07:00
2024-10-01 22:45:04 -07:00
############################
2024-11-16 18:00:57 -08:00
# ResetKnowledgeById
2024-10-01 22:45:04 -07:00
############################
2024-11-16 18:00:57 -08:00
@router.post("/{id}/reset", response_model=Optional[KnowledgeResponse])
2025-12-29 00:21:18 +04:00
async def reset_knowledge_by_id(
id: str, user=Depends(get_verified_user), db: Session = Depends(get_session)
):
knowledge = Knowledges.get_knowledge_by_id(id=id, db=db)
2024-11-16 18:00:57 -08:00
if not knowledge:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.NOT_FOUND,
)
if (
knowledge.user_id != user.id
2026-02-09 13:28:14 -06:00
and not AccessGrants.has_access(
user_id=user.id,
resource_type="knowledge",
resource_id=knowledge.id,
permission="write",
db=db,
)
and user.role != "admin"
):
2024-11-16 18:00:57 -08:00
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.ACCESS_PROHIBITED,
)
2024-10-04 11:11:53 -07:00
try:
VECTOR_DB_CLIENT.delete_collection(collection_name=id)
except Exception as e:
log.debug(e)
pass
2024-11-16 18:00:57 -08:00
2025-12-29 00:21:18 +04:00
knowledge = Knowledges.reset_knowledge_by_id(id=id, db=db)
2024-11-16 18:00:57 -08:00
return knowledge
2024-12-13 15:29:43 +01:00
############################
# AddFilesToKnowledge
############################
2024-12-18 12:18:31 -05:00
2024-12-13 15:29:43 +01:00
@router.post("/{id}/files/batch/add", response_model=Optional[KnowledgeFilesResponse])
2025-11-27 04:35:12 -05:00
async def add_files_to_knowledge_batch(
2024-12-30 17:36:34 +01:00
request: Request,
2024-12-13 15:29:43 +01:00
id: str,
form_data: list[KnowledgeFileIdForm],
user=Depends(get_verified_user),
2025-12-29 00:21:18 +04:00
db: Session = Depends(get_session),
2024-12-13 15:29:43 +01:00
):
"""
Add multiple files to a knowledge base
"""
2025-12-29 00:21:18 +04:00
knowledge = Knowledges.get_knowledge_by_id(id=id, db=db)
2024-12-13 15:29:43 +01:00
if not knowledge:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.NOT_FOUND,
)
if (
knowledge.user_id != user.id
2026-02-09 13:28:14 -06:00
and not AccessGrants.has_access(
user_id=user.id,
resource_type="knowledge",
resource_id=knowledge.id,
permission="write",
db=db,
)
and user.role != "admin"
):
2024-12-13 15:29:43 +01:00
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.ACCESS_PROHIBITED,
)
# Batch-fetch all files to avoid N+1 queries
log.info(f"files/batch/add - {len(form_data)} files")
file_ids = [form.file_id for form in form_data]
files = Files.get_files_by_ids(file_ids, db=db)
# Verify all requested files were found
found_ids = {file.id for file in files}
missing_ids = [fid for fid in file_ids if fid not in found_ids]
if missing_ids:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=f"File {missing_ids[0]} not found",
)
2024-12-13 15:29:43 +01:00
# Process files
2024-12-14 10:45:27 +01:00
try:
2025-11-27 04:35:12 -05:00
result = await process_files_batch(
2024-12-30 17:36:34 +01:00
request=request,
form_data=BatchProcessFilesForm(files=files, collection_name=id),
2024-12-30 17:45:43 +01:00
user=user,
2025-12-29 00:21:18 +04:00
db=db,
2024-12-18 12:18:31 -05:00
)
2024-12-14 10:45:27 +01:00
except Exception as e:
2024-12-18 12:18:31 -05:00
log.error(
f"add_files_to_knowledge_batch: Exception occurred: {e}", exc_info=True
2024-12-14 10:45:27 +01:00
)
2024-12-18 12:18:31 -05:00
raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail=str(e))
2024-12-13 15:29:43 +01:00
# Only add files that were successfully processed
successful_file_ids = [r.file_id for r in result.results if r.status == "completed"]
for file_id in successful_file_ids:
2025-12-02 10:53:32 -05:00
Knowledges.add_file_to_knowledge_by_id(
2025-12-29 00:21:18 +04:00
knowledge_id=id, file_id=file_id, user_id=user.id, db=db
2025-12-02 10:53:32 -05:00
)
2024-12-13 15:29:43 +01:00
# If there were any errors, include them in the response
if result.errors:
error_details = [f"{err.file_id}: {err.error}" for err in result.errors]
return KnowledgeFilesResponse(
**knowledge.model_dump(),
2025-12-29 00:21:18 +04:00
files=Knowledges.get_file_metadatas_by_id(knowledge.id, db=db),
2024-12-13 15:29:43 +01:00
warnings={
"message": "Some files failed to process",
2024-12-18 12:18:31 -05:00
"errors": error_details,
},
2024-12-13 15:29:43 +01:00
)
return KnowledgeFilesResponse(
**knowledge.model_dump(),
2025-12-29 00:21:18 +04:00
files=Knowledges.get_file_metadatas_by_id(knowledge.id, db=db),
2024-12-13 15:29:43 +01:00
)
2026-01-08 12:49:45 +04:00
############################
# ExportKnowledgeById
############################
@router.get("/{id}/export")
async def export_knowledge_by_id(
id: str, user=Depends(get_admin_user), db: Session = Depends(get_session)
):
"""
Export a knowledge base as a zip file containing .txt files.
Admin only.
"""
knowledge = Knowledges.get_knowledge_by_id(id=id, db=db)
if not knowledge:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail=ERROR_MESSAGES.NOT_FOUND,
)
files = Knowledges.get_files_by_id(id, db=db)
# Create zip file in memory
zip_buffer = io.BytesIO()
with zipfile.ZipFile(zip_buffer, "w", zipfile.ZIP_DEFLATED) as zf:
for file in files:
content = file.data.get("content", "") if file.data else ""
if content:
# Use original filename with .txt extension
filename = file.filename
if not filename.endswith(".txt"):
filename = f"{filename}.txt"
zf.writestr(filename, content)
zip_buffer.seek(0)
# Sanitize knowledge name for filename
safe_name = "".join(c if c.isalnum() or c in " -_" else "_" for c in knowledge.name)
zip_filename = f"{safe_name}.zip"
return StreamingResponse(
zip_buffer,
media_type="application/zip",
headers={"Content-Disposition": f"attachment; filename={zip_filename}"},
)