OpenWebUI/open-webui
1
0
Fork 0
mirror of https://github.com/open-webui/open-webui synced 2025-06-26 18:26:48 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

refac: rename projects -> knowledge

Browse Source
This commit is contained in:
Timothy J. Baek
2024-10-01 22:45:04 -07:00
parent 3e012f0219
commit 08969ecf89
24 changed files with 335 additions and 258 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
backend/open_webui/apps/webui/main.py
View File

@@ -10,11 +10,11 @@ from open_webui.apps.webui.routers import (
auths,
chats,
configs,
projects,
files,
functions,
memories,
models,
knowledge,
prompts,
tools,
users,
@@ -111,15 +111,15 @@ app.include_router(auths.router, prefix="/auths", tags=["auths"])
app.include_router(users.router, prefix="/users", tags=["users"])
app.include_router(chats.router, prefix="/chats", tags=["chats"])
app.include_router(projects.router, prefix="/projects", tags=["projects"])
app.include_router(models.router, prefix="/models", tags=["models"])
app.include_router(knowledge.router, prefix="/knowledge", tags=["knowledge"])
app.include_router(prompts.router, prefix="/prompts", tags=["prompts"])
app.include_router(memories.router, prefix="/memories", tags=["memories"])
app.include_router(files.router, prefix="/files", tags=["files"])
app.include_router(tools.router, prefix="/tools", tags=["tools"])
app.include_router(functions.router, prefix="/functions", tags=["functions"])
app.include_router(memories.router, prefix="/memories", tags=["memories"])
app.include_router(utils.router, prefix="/utils", tags=["utils"])

56
backend/open_webui/apps/webui/models/projects.py → backend/open_webui/apps/webui/models/knowledge.py
View File

@@ -14,12 +14,12 @@ log = logging.getLogger(__name__)
log.setLevel(SRC_LOG_LEVELS["MODELS"])
####################
# Projects DB Schema
# Knowledge DB Schema
####################
class Project(Base):
__tablename__ = "project"
class Knowledge(Base):
__tablename__ = "knowledge"
id = Column(Text, unique=True, primary_key=True)
user_id = Column(Text)
@@ -34,7 +34,7 @@ class Project(Base):
updated_at = Column(BigInteger)
class ProjectModel(BaseModel):
class KnowledgeModel(BaseModel):
model_config = ConfigDict(from_attributes=True)
id: str
@@ -55,7 +55,7 @@ class ProjectModel(BaseModel):
####################
class ProjectResponse(BaseModel):
class KnowledgeResponse(BaseModel):
id: str
name: str
description: str
@@ -65,18 +65,18 @@ class ProjectResponse(BaseModel):
updated_at: int # timestamp in epoch
class ProjectForm(BaseModel):
class KnowledgeForm(BaseModel):
name: str
description: str
data: Optional[dict] = None
class ProjectTable:
def insert_new_project(
self, user_id: str, form_data: ProjectForm
) -> Optional[ProjectModel]:
class KnowledgeTable:
def insert_new_knowledge(
self, user_id: str, form_data: KnowledgeForm
) -> Optional[KnowledgeModel]:
with get_db() as db:
project = ProjectModel(
knowledge = KnowledgeModel(
**{
**form_data.model_dump(),
"id": str(uuid.uuid4()),
@@ -87,59 +87,59 @@ class ProjectTable:
)
try:
result = Project(**project.model_dump())
result = Knowledge(**knowledge.model_dump())
db.add(result)
db.commit()
db.refresh(result)
if result:
return ProjectModel.model_validate(result)
return KnowledgeModel.model_validate(result)
else:
return None
except Exception:
return None
def get_projects(self) -> list[ProjectModel]:
def get_knowledge_items(self) -> list[KnowledgeModel]:
with get_db() as db:
return [
ProjectModel.model_validate(project)
for project in db.query(Project)
.order_by(Project.updated_at.desc())
KnowledgeModel.model_validate(knowledge)
for knowledge in db.query(Knowledge)
.order_by(Knowledge.updated_at.desc())
.all()
]
def get_project_by_id(self, id: str) -> Optional[ProjectModel]:
def get_knowledge_by_id(self, id: str) -> Optional[KnowledgeModel]:
try:
with get_db() as db:
project = db.query(Project).filter_by(id=id).first()
return ProjectModel.model_validate(project) if project else None
knowledge = db.query(Knowledge).filter_by(id=id).first()
return KnowledgeModel.model_validate(knowledge) if knowledge else None
except Exception:
return None
def update_project_by_id(
self, id: str, form_data: ProjectForm
) -> Optional[ProjectModel]:
def update_knowledge_by_id(
self, id: str, form_data: KnowledgeForm
) -> Optional[KnowledgeModel]:
try:
with get_db() as db:
db.query(Project).filter_by(id=id).update(
db.query(Knowledge).filter_by(id=id).update(
{
"name": form_data.name,
"updated_id": int(time.time()),
}
)
db.commit()
return self.get_project_by_id(id=form_data.id)
return self.get_knowledge_by_id(id=form_data.id)
except Exception as e:
log.exception(e)
return None
def delete_project_by_id(self, id: str) -> bool:
def delete_knowledge_by_id(self, id: str) -> bool:
try:
with get_db() as db:
db.query(Project).filter_by(id=id).delete()
db.query(Knowledge).filter_by(id=id).delete()
db.commit()
return True
except Exception:
return False
Projects = ProjectTable()
Knowledges = KnowledgeTable()

112
backend/open_webui/apps/webui/routers/knowledge.py Normal file
View File

@@ -0,0 +1,112 @@
import json
from typing import Optional, Union
from pydantic import BaseModel
from fastapi import APIRouter, Depends, HTTPException, status
from open_webui.apps.webui.models.knowledge import (
Knowledges,
KnowledgeModel,
KnowledgeForm,
KnowledgeResponse,
)
from open_webui.constants import ERROR_MESSAGES
from open_webui.utils.utils import get_admin_user, get_verified_user
router = APIRouter()
############################
# GetKnowledgeItems
############################
@router.get(
"/", response_model=Optional[Union[list[KnowledgeResponse], KnowledgeResponse]]
)
async def get_knowledge_items(
id: Optional[str] = None, user=Depends(get_verified_user)
):
if id:
knowledge = Knowledges.get_knowledge_by_id(id=id)
if knowledge:
return knowledge
else:
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail=ERROR_MESSAGES.NOT_FOUND,
)
else:
return [
KnowledgeResponse(**knowledge.model_dump())
for knowledge in Knowledges.get_knowledge_items()
]
############################
# CreateNewKnowledge
############################
@router.post("/create", response_model=Optional[KnowledgeResponse])
async def create_new_knowledge(form_data: KnowledgeForm, user=Depends(get_admin_user)):
knowledge = Knowledges.insert_new_knowledge(user.id, form_data)
if knowledge:
return knowledge
else:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.FILE_EXISTS,
)
############################
# GetKnowledgeById
############################
@router.get("/{id}", response_model=Optional[KnowledgeResponse])
async def get_knowledge_by_id(id: str, user=Depends(get_verified_user)):
knowledge = Knowledges.get_knowledge_by_id(id=id)
if knowledge:
return knowledge
else:
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail=ERROR_MESSAGES.NOT_FOUND,
)
############################
# UpdateKnowledgeById
############################
@router.post("/{id}/update", response_model=Optional[KnowledgeResponse])
async def update_knowledge_by_id(
id: str,
form_data: KnowledgeForm,
user=Depends(get_admin_user),
):
knowledge = Knowledges.update_knowledge_by_id(id=id, form_data=form_data)
if knowledge:
return knowledge
else:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.ID_TAKEN,
)
############################
# DeleteKnowledgeById
############################
@router.delete("/{id}/delete", response_model=bool)
async def delete_knowledge_by_id(id: str, user=Depends(get_admin_user)):
result = Knowledges.delete_knowledge_by_id(id=id)
return result

107
backend/open_webui/apps/webui/routers/projects.py
View File

@@ -1,107 +0,0 @@
import json
from typing import Optional, Union
from pydantic import BaseModel
from fastapi import APIRouter, Depends, HTTPException, status
from open_webui.apps.webui.models.projects import (
Projects,
ProjectModel,
ProjectForm,
ProjectResponse,
)
from open_webui.constants import ERROR_MESSAGES
from open_webui.utils.utils import get_admin_user, get_verified_user
router = APIRouter()
############################
# GetProjects
############################
@router.get("/", response_model=Optional[Union[list[ProjectResponse], ProjectResponse]])
async def get_projects(id: Optional[str] = None, user=Depends(get_verified_user)):
if id:
project = Projects.get_project_by_id(id=id)
if project:
return project
else:
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail=ERROR_MESSAGES.NOT_FOUND,
)
else:
return [
ProjectResponse(**project.model_dump())
for project in Projects.get_projects()
]
############################
# CreateNewProject
############################
@router.post("/create", response_model=Optional[ProjectResponse])
async def create_new_project(form_data: ProjectForm, user=Depends(get_admin_user)):
project = Projects.insert_new_project(user.id, form_data)
if project:
return project
else:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.FILE_EXISTS,
)
############################
# GetProjectById
############################
@router.get("/{id}", response_model=Optional[ProjectResponse])
async def get_projects(id: str, user=Depends(get_verified_user)):
project = Projects.get_project_by_id(id=id)
if project:
return project
else:
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail=ERROR_MESSAGES.NOT_FOUND,
)
############################
# UpdateProjectById
############################
@router.post("/{id}/update", response_model=Optional[ProjectResponse])
async def update_project_by_id(
id: str,
form_data: ProjectForm,
user=Depends(get_admin_user),
):
project = Projects.update_project_by_id(form_data)
if project:
return project
else:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ERROR_MESSAGES.ID_TAKEN,
)
############################
# DeleteProjectById
############################
@router.delete("/{id}/delete", response_model=bool)
async def delete_project_by_id(id: str, user=Depends(get_admin_user)):
result = Projects.delete_project_by_id(id=id)
return result

18
backend/open_webui/migrations/versions/6a39f3d8e55c_add_project_table.py → backend/open_webui/migrations/versions/6a39f3d8e55c_add_knowledge_table.py
View File

@@ -1,4 +1,4 @@
"""Add project table
"""Add knowledge table
Revision ID: 6a39f3d8e55c
Revises: c0fbf31ca0db
@@ -19,10 +19,10 @@ depends_on = None
def upgrade():
# Creating the 'project' table
print("Creating project table")
project_table = op.create_table(
"project",
# Creating the 'knowledge' table
print("Creating knowledge table")
knowledge_table = op.create_table(
"knowledge",
sa.Column("id", sa.Text(), primary_key=True),
sa.Column("user_id", sa.Text(), nullable=False),
sa.Column("name", sa.Text(), nullable=False),
@@ -33,7 +33,7 @@ def upgrade():
sa.Column("updated_at", sa.BigInteger(), nullable=True),
)
print("Migrating data from document table to project table")
print("Migrating data from document table to knowledge table")
# Representation of the existing 'document' table
document_table = table(
"document",
@@ -57,10 +57,10 @@ def upgrade():
)
)
# Insert data into project table from document table
# Insert data into knowledge table from document table
for doc in documents:
op.get_bind().execute(
project_table.insert().values(
knowledge_table.insert().values(
id=doc.collection_name,
user_id=doc.user_id,
description=doc.name,
@@ -76,4 +76,4 @@ def upgrade():
def downgrade():
op.drop_table("project")
op.drop_table("knowledge")