feat: backend for user feedback (#1019)

* feat: backend for user feedback

Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com>

* feat: backend for user feedback

Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com>

* fix: alembic script & using post for creation

Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com>

---------

Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com>

Author: tomkis

apps/beeai-server/src/beeai_server/api/dependencies.py

@@ -13,6 +13,7 @@
 from beeai_server.service_layer.services.env import EnvService
 from beeai_server.service_layer.services.files import FileService
 from beeai_server.service_layer.services.provider import ProviderService
+from beeai_server.service_layer.services.user_feedback import UserFeedbackService
 from beeai_server.service_layer.services.users import UserService
 from beeai_server.service_layer.services.vector_stores import VectorStoreService
 
@@ -23,6 +24,7 @@
 FileServiceDependency = Annotated[FileService, Depends(lambda: di[FileService])]
 UserServiceDependency = Annotated[UserService, Depends(lambda: di[UserService])]
 VectorStoreServiceDependency = Annotated[VectorStoreService, Depends(lambda: di[VectorStoreService])]
+UserFeedbackServiceDependency = Annotated[UserFeedbackService, Depends(lambda: di[UserFeedbackService])]
 
 # Auth
 

apps/beeai-server/src/beeai_server/api/routes/user_feedback.py

@@ -0,0 +1,27 @@
+# Copyright 2025 © BeeAI a Series of LF Projects, LLC
+# SPDX-License-Identifier: Apache-2.0
+
+import fastapi
+
+from beeai_server.api.dependencies import AuthenticatedUserDependency, UserFeedbackServiceDependency
+from beeai_server.api.schema.user_feedback import InsertUserFeedbackRequest
+
+router = fastapi.APIRouter()
+
+
+@router.post("", status_code=fastapi.status.HTTP_201_CREATED)
+async def user_feedback(
+    request: InsertUserFeedbackRequest,
+    user_feedback_service: UserFeedbackServiceDependency,
+    user: AuthenticatedUserDependency,
+) -> None:
+    await user_feedback_service.create_user_feedback(
+        provider_id=request.provider_id,
+        task_id=request.task_id,
+        context_id=request.context_id,
+        rating=request.rating,
+        comment=request.comment,
+        comment_tags=request.comment_tags,
+        message=request.message,
+        user=user,
+    )

apps/beeai-server/src/beeai_server/api/schema/user_feedback.py

@@ -0,0 +1,25 @@
+# Copyright 2025 © BeeAI a Series of LF Projects, LLC
+# SPDX-License-Identifier: Apache-2.0
+
+from uuid import UUID
+
+from pydantic import BaseModel, Field, field_validator
+
+
+class InsertUserFeedbackRequest(BaseModel):
+    """Request to create a user feedback."""
+
+    provider_id: UUID
+    task_id: UUID
+    context_id: UUID
+    rating: int = Field(..., description="Rating thats either 1 or -1")
+    message: str
+    comment_tags: list[str] | None = None
+    comment: str | None = None
+
+    @field_validator("rating")
+    @classmethod
+    def validate_rating(cls, v):
+        if v not in [1, -1]:
+            raise ValueError("Rating must be either 1 or -1")
+        return v

apps/beeai-server/src/beeai_server/application.py

@@ -21,6 +21,7 @@
 from beeai_server.api.routes.llm import router as llm_router
 from beeai_server.api.routes.provider import router as provider_router
 from beeai_server.api.routes.ui import router as ui_router
+from beeai_server.api.routes.user_feedback import router as user_feedback_router
 from beeai_server.api.routes.vector_stores import router as vector_stores_router
 from beeai_server.bootstrap import bootstrap_dependencies_sync
 from beeai_server.configuration import Configuration
@@ -81,6 +82,7 @@ def mount_routes(app: FastAPI):
     server_router.include_router(ui_router, prefix="/ui", tags=["ui"])
     server_router.include_router(embeddings_router, prefix="/llm", tags=["embeddings"])
     server_router.include_router(vector_stores_router, prefix="/vector_stores", tags=["vector_stores"])
+    server_router.include_router(user_feedback_router, prefix="/user_feedback", tags=["user_feedback"])
 
     app.include_router(server_router, prefix="/api/v1", tags=["provider"])
 

apps/beeai-server/src/beeai_server/domain/models/user_feedback.py

@@ -0,0 +1,28 @@
+# Copyright 2025 © BeeAI a Series of LF Projects, LLC
+# SPDX-License-Identifier: Apache-2.0
+
+from uuid import UUID, uuid4
+
+from pydantic import AwareDatetime, BaseModel, Field, field_validator
+
+from beeai_server.utils.utils import utc_now
+
+
+class UserFeedback(BaseModel):
+    id: UUID = Field(default_factory=uuid4)
+    provider_id: UUID
+    task_id: UUID
+    context_id: UUID
+    rating: int = Field(..., description="Rating thats either 1 or -1")
+    message: str
+    comment_tags: list[str] | None = None
+    comment: str | None = None
+    created_at: AwareDatetime = Field(default_factory=utc_now)
+    created_by: UUID
+
+    @field_validator("rating")
+    @classmethod
+    def validate_rating(cls, v: int) -> int:
+        if v not in [1, -1]:
+            raise ValueError("Rating must be either 1 or -1")
+        return v

apps/beeai-server/src/beeai_server/domain/repositories/user_feedback.py

@@ -0,0 +1,11 @@
+# Copyright 2025 © BeeAI a Series of LF Projects, LLC
+# SPDX-License-Identifier: Apache-2.0
+
+from typing import Protocol, runtime_checkable
+
+from beeai_server.domain.models.user_feedback import UserFeedback
+
+
+@runtime_checkable
+class IUserFeedbackRepository(Protocol):
+    async def create(self, *, user_feedback: UserFeedback) -> None: ...

apps/beeai-server/src/beeai_server/infrastructure/persistence/migrations/alembic/versions/b2d91792f9b5_.py

@@ -0,0 +1,46 @@
+# Copyright 2025 © BeeAI a Series of LF Projects, LLC
+# SPDX-License-Identifier: Apache-2.0
+
+"""empty message
+
+Revision ID: b2d91792f9b5
+Revises: 644ccacc48f3
+Create Date: 2025-08-06 16:12:21.149930
+
+"""
+
+from collections.abc import Sequence
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "b2d91792f9b5"
+down_revision: str | None = "644ccacc48f3"
+branch_labels: str | Sequence[str] | None = None
+depends_on: str | Sequence[str] | None = None
+
+
+def upgrade() -> None:
+    """Upgrade schema."""
+    op.create_table(
+        "user_feedback",
+        sa.Column("id", sa.UUID(), nullable=False),
+        sa.Column("provider_id", sa.UUID(), nullable=False),
+        sa.Column("task_id", sa.UUID(), nullable=False),
+        sa.Column("context_id", sa.UUID(), nullable=False),
+        sa.Column("message", sa.Text(), nullable=False),
+        sa.Column("comment", sa.Text(), nullable=True),
+        sa.Column("comment_tags", sa.ARRAY(sa.Text()), nullable=True),
+        sa.Column("rating", sa.Integer(), nullable=False),
+        sa.Column("created_at", sa.DateTime(timezone=True), nullable=False),
+        sa.Column("created_by", sa.UUID(), nullable=False),
+        sa.ForeignKeyConstraint(["provider_id"], ["providers.id"], ondelete="CASCADE"),
+        sa.ForeignKeyConstraint(["created_by"], ["users.id"], ondelete="CASCADE"),
+        sa.PrimaryKeyConstraint("id"),
+    )
+    op.create_check_constraint("user_feedback_rating_check", "user_feedback", "rating IN (1, -1)")
+
+
+def downgrade() -> None:
+    op.execute("DROP TABLE IF EXISTS user_feedback CASCADE")

apps/beeai-server/src/beeai_server/infrastructure/persistence/repositories/user_feedback.py

@@ -0,0 +1,48 @@
+# Copyright 2025 © BeeAI a Series of LF Projects, LLC
+# SPDX-License-Identifier: Apache-2.0
+
+from kink import inject
+from sqlalchemy import ARRAY, CheckConstraint, Column, DateTime, Integer, Table, Text
+from sqlalchemy import UUID as SQL_UUID
+from sqlalchemy.ext.asyncio import AsyncConnection
+
+from beeai_server.domain.models.user_feedback import UserFeedback
+from beeai_server.domain.repositories.user_feedback import IUserFeedbackRepository
+from beeai_server.infrastructure.persistence.repositories.db_metadata import metadata
+
+user_feedback_table = Table(
+    "user_feedback",
+    metadata,
+    Column("id", SQL_UUID, primary_key=True),
+    Column("provider_id", SQL_UUID, nullable=False),
+    Column("task_id", SQL_UUID, nullable=False),
+    Column("context_id", SQL_UUID, nullable=False),
+    Column("rating", Integer, nullable=False),
+    Column("message", Text, nullable=False),
+    Column("comment", Text, nullable=True),
+    Column("comment_tags", ARRAY(Text), nullable=True),
+    Column("created_at", DateTime(timezone=True), nullable=False),
+    Column("created_by", SQL_UUID, nullable=False),
+    CheckConstraint("rating IN (1, -1)", name="rating_check"),
+)
+
+
+@inject
+class SqlAlchemyUserFeedbackRepository(IUserFeedbackRepository):
+    def __init__(self, connection: AsyncConnection):
+        self.connection = connection
+
+    async def create(self, *, user_feedback: UserFeedback) -> None:
+        query = user_feedback_table.insert().values(
+            id=user_feedback.id,
+            provider_id=user_feedback.provider_id,
+            task_id=user_feedback.task_id,
+            context_id=user_feedback.context_id,
+            rating=user_feedback.rating,
+            comment=user_feedback.comment,
+            comment_tags=user_feedback.comment_tags,
+            message=user_feedback.message,
+            created_at=user_feedback.created_at,
+            created_by=user_feedback.created_by,
+        )
+        await self.connection.execute(query)

apps/beeai-server/src/beeai_server/infrastructure/persistence/unit_of_work.py

@@ -11,11 +11,13 @@
 from beeai_server.domain.repositories.file import IFileRepository
 from beeai_server.domain.repositories.provider import IProviderRepository
 from beeai_server.domain.repositories.user import IUserRepository
+from beeai_server.domain.repositories.user_feedback import IUserFeedbackRepository
 from beeai_server.domain.repositories.vector_store import IVectorDatabaseRepository, IVectorStoreRepository
 from beeai_server.infrastructure.persistence.repositories.env import SqlAlchemyEnvVariableRepository
 from beeai_server.infrastructure.persistence.repositories.file import SqlAlchemyFileRepository
 from beeai_server.infrastructure.persistence.repositories.provider import SqlAlchemyProviderRepository
 from beeai_server.infrastructure.persistence.repositories.user import SqlAlchemyUserRepository
+from beeai_server.infrastructure.persistence.repositories.user_feedback import SqlAlchemyUserFeedbackRepository
 from beeai_server.infrastructure.persistence.repositories.vector_store import SqlAlchemyVectorStoreRepository
 from beeai_server.infrastructure.vector_database.vector_db import VectorDatabaseRepository
 from beeai_server.service_layer.unit_of_work import IUnitOfWork, IUnitOfWorkFactory
@@ -33,6 +35,7 @@ class SQLAlchemyUnitOfWork(IUnitOfWork):
     users: IUserRepository
     vector_stores: IVectorStoreRepository
     vector_database: IVectorDatabaseRepository
+    user_feedback: IUserFeedbackRepository
 
     def __init__(self, engine: AsyncEngine, config: Configuration) -> None:
         self._engine: AsyncEngine = engine
@@ -55,6 +58,7 @@ async def __aenter__(self) -> Self:
             self.vector_database = VectorDatabaseRepository(
                 self._connection, schema_name=self._config.persistence.vector_db_schema
             )
+            self.user_feedback = SqlAlchemyUserFeedbackRepository(self._connection)
 
         except Exception as e:
             if self._connection:

apps/beeai-server/src/beeai_server/service_layer/services/user_feedback.py

@@ -0,0 +1,46 @@
+# Copyright 2025 © BeeAI a Series of LF Projects, LLC
+# SPDX-License-Identifier: Apache-2.0
+
+import logging
+from uuid import UUID
+
+from kink import inject
+
+from beeai_server.domain.models.user import User
+from beeai_server.domain.models.user_feedback import UserFeedback
+from beeai_server.service_layer.unit_of_work import IUnitOfWorkFactory
+
+logger = logging.getLogger(__name__)
+
+
+@inject
+class UserFeedbackService:
+    def __init__(self, uow: IUnitOfWorkFactory):
+        self._uow = uow
+
+    async def create_user_feedback(
+        self,
+        *,
+        provider_id: UUID,
+        rating: int,
+        comment: str | None = None,
+        comment_tags: list[str] | None = None,
+        message: str,
+        task_id: UUID,
+        context_id: UUID,
+        user: User,
+    ):
+        async with self._uow() as uow:
+            user_feedback = UserFeedback(
+                provider_id=provider_id,
+                rating=rating,
+                comment=comment,
+                comment_tags=comment_tags,
+                message=message,
+                task_id=task_id,
+                context_id=context_id,
+                created_by=user.id,
+            )
+            await uow.user_feedback.create(user_feedback=user_feedback)
+            await uow.commit()
+            return user_feedback