Merge branch 'main' into feat/hitl

api/fields/annotation_fields.py

@@ -1,36 +1,69 @@
-from flask_restx import Namespace, fields
+from __future__ import annotations
 
-from libs.helper import TimestampField
+from datetime import datetime
 
-annotation_fields = {
-    "id": fields.String,
-    "question": fields.String,
-    "answer": fields.Raw(attribute="content"),
-    "hit_count": fields.Integer,
-    "created_at": TimestampField,
-    # 'account': fields.Nested(simple_account_fields, allow_null=True)
-}
+from pydantic import BaseModel, ConfigDict, Field, field_validator
 
 
-def build_annotation_model(api_or_ns: Namespace):
-    """Build the annotation model for the API or Namespace."""
-    return api_or_ns.model("Annotation", annotation_fields)
+def _to_timestamp(value: datetime | int | None) -> int | None:
+    if isinstance(value, datetime):
+        return int(value.timestamp())
+    return value
 
 
-annotation_list_fields = {
-    "data": fields.List(fields.Nested(annotation_fields)),
-}
+class ResponseModel(BaseModel):
+    model_config = ConfigDict(
+        from_attributes=True,
+        extra="ignore",
+        populate_by_name=True,
+        serialize_by_alias=True,
+        protected_namespaces=(),
+    )
 
-annotation_hit_history_fields = {
-    "id": fields.String,
-    "source": fields.String,
-    "score": fields.Float,
-    "question": fields.String,
-    "created_at": TimestampField,
-    "match": fields.String(attribute="annotation_question"),
-    "response": fields.String(attribute="annotation_content"),
-}
 
-annotation_hit_history_list_fields = {
-    "data": fields.List(fields.Nested(annotation_hit_history_fields)),
-}
+class Annotation(ResponseModel):
+    id: str
+    question: str | None = None
+    answer: str | None = Field(default=None, validation_alias="content")
+    hit_count: int | None = None
+    created_at: int | None = None
+
+    @field_validator("created_at", mode="before")
+    @classmethod
+    def _normalize_created_at(cls, value: datetime | int | None) -> int | None:
+        return _to_timestamp(value)
+
+
+class AnnotationList(ResponseModel):
+    data: list[Annotation]
+    has_more: bool
+    limit: int
+    total: int
+    page: int
+
+
+class AnnotationExportList(ResponseModel):
+    data: list[Annotation]
+
+
+class AnnotationHitHistory(ResponseModel):
+    id: str
+    source: str | None = None
+    score: float | None = None
+    question: str | None = None
+    created_at: int | None = None
+    match: str | None = Field(default=None, validation_alias="annotation_question")
+    response: str | None = Field(default=None, validation_alias="annotation_content")
+
+    @field_validator("created_at", mode="before")
+    @classmethod
+    def _normalize_created_at(cls, value: datetime | int | None) -> int | None:
+        return _to_timestamp(value)
+
+
+class AnnotationHitHistoryList(ResponseModel):
+    data: list[AnnotationHitHistory]
+    has_more: bool
+    limit: int
+    total: int
+    page: int

api/fields/end_user_fields.py

@@ -1,4 +1,7 @@
-from flask_restx import Namespace, fields
+from __future__ import annotations
+
+from flask_restx import fields
+from pydantic import BaseModel, ConfigDict
 
 simple_end_user_fields = {
     "id": fields.String,
@@ -8,5 +11,18 @@ simple_end_user_fields = {
 }
 
 
-def build_simple_end_user_model(api_or_ns: Namespace):
-    return api_or_ns.model("SimpleEndUser", simple_end_user_fields)
+class ResponseModel(BaseModel):
+    model_config = ConfigDict(
+        from_attributes=True,
+        extra="ignore",
+        populate_by_name=True,
+        serialize_by_alias=True,
+        protected_namespaces=(),
+    )
+
+
+class SimpleEndUser(ResponseModel):
+    id: str
+    type: str
+    is_anonymous: bool
+    session_id: str | None = None

api/fields/member_fields.py

@@ -1,6 +1,11 @@
-from flask_restx import Namespace, fields
+from __future__ import annotations
 
-from libs.helper import AvatarUrlField, TimestampField
+from datetime import datetime
+
+from flask_restx import fields
+from pydantic import BaseModel, ConfigDict, computed_field, field_validator
+
+from core.file import helpers as file_helpers
 
 simple_account_fields = {
     "id": fields.String,
@@ -9,36 +14,78 @@ simple_account_fields = {
 }
 
 
-def build_simple_account_model(api_or_ns: Namespace):
-    return api_or_ns.model("SimpleAccount", simple_account_fields)
+def _to_timestamp(value: datetime | int | None) -> int | None:
+    if isinstance(value, datetime):
+        return int(value.timestamp())
+    return value
 
 
-account_fields = {
-    "id": fields.String,
-    "name": fields.String,
-    "avatar": fields.String,
-    "avatar_url": AvatarUrlField,
-    "email": fields.String,
-    "is_password_set": fields.Boolean,
-    "interface_language": fields.String,
-    "interface_theme": fields.String,
-    "timezone": fields.String,
-    "last_login_at": TimestampField,
-    "last_login_ip": fields.String,
-    "created_at": TimestampField,
-}
+def _build_avatar_url(avatar: str | None) -> str | None:
+    if avatar is None:
+        return None
+    if avatar.startswith(("http://", "https://")):
+        return avatar
+    return file_helpers.get_signed_file_url(avatar)
 
-account_with_role_fields = {
-    "id": fields.String,
-    "name": fields.String,
-    "avatar": fields.String,
-    "avatar_url": AvatarUrlField,
-    "email": fields.String,
-    "last_login_at": TimestampField,
-    "last_active_at": TimestampField,
-    "created_at": TimestampField,
-    "role": fields.String,
-    "status": fields.String,
-}
 
-account_with_role_list_fields = {"accounts": fields.List(fields.Nested(account_with_role_fields))}
+class ResponseModel(BaseModel):
+    model_config = ConfigDict(
+        from_attributes=True,
+        extra="ignore",
+        populate_by_name=True,
+        serialize_by_alias=True,
+        protected_namespaces=(),
+    )
+
+
+class SimpleAccount(ResponseModel):
+    id: str
+    name: str
+    email: str
+
+
+class _AccountAvatar(ResponseModel):
+    avatar: str | None = None
+
+    @computed_field(return_type=str | None)  # type: ignore[prop-decorator]
+    @property
+    def avatar_url(self) -> str | None:
+        return _build_avatar_url(self.avatar)
+
+
+class Account(_AccountAvatar):
+    id: str
+    name: str
+    email: str
+    is_password_set: bool
+    interface_language: str | None = None
+    interface_theme: str | None = None
+    timezone: str | None = None
+    last_login_at: int | None = None
+    last_login_ip: str | None = None
+    created_at: int | None = None
+
+    @field_validator("last_login_at", "created_at", mode="before")
+    @classmethod
+    def _normalize_timestamp(cls, value: datetime | int | None) -> int | None:
+        return _to_timestamp(value)
+
+
+class AccountWithRole(_AccountAvatar):
+    id: str
+    name: str
+    email: str
+    last_login_at: int | None = None
+    last_active_at: int | None = None
+    created_at: int | None = None
+    role: str
+    status: str
+
+    @field_validator("last_login_at", "last_active_at", "created_at", mode="before")
+    @classmethod
+    def _normalize_timestamp(cls, value: datetime | int | None) -> int | None:
+        return _to_timestamp(value)
+
+
+class AccountWithRoleList(ResponseModel):
+    accounts: list[AccountWithRole]

api/fields/tag_fields.py

@@ -1,12 +1,20 @@
-from flask_restx import Namespace, fields
+from __future__ import annotations
 
-dataset_tag_fields = {
-    "id": fields.String,
-    "name": fields.String,
-    "type": fields.String,
-    "binding_count": fields.String,
-}
+from pydantic import BaseModel, ConfigDict
 
 
-def build_dataset_tag_fields(api_or_ns: Namespace):
-    return api_or_ns.model("DataSetTag", dataset_tag_fields)
+class ResponseModel(BaseModel):
+    model_config = ConfigDict(
+        from_attributes=True,
+        extra="ignore",
+        populate_by_name=True,
+        serialize_by_alias=True,
+        protected_namespaces=(),
+    )
+
+
+class DataSetTag(ResponseModel):
+    id: str
+    name: str
+    type: str
+    binding_count: str | None = None

api/fields/workflow_app_log_fields.py

@@ -1,7 +1,7 @@
 from flask_restx import Namespace, fields
 
-from fields.end_user_fields import build_simple_end_user_model, simple_end_user_fields
-from fields.member_fields import build_simple_account_model, simple_account_fields
+from fields.end_user_fields import simple_end_user_fields
+from fields.member_fields import simple_account_fields
 from fields.workflow_run_fields import (
     build_workflow_run_for_archived_log_model,
     build_workflow_run_for_log_model,
@@ -25,17 +25,9 @@ workflow_app_log_partial_fields = {
 def build_workflow_app_log_partial_model(api_or_ns: Namespace):
     """Build the workflow app log partial model for the API or Namespace."""
     workflow_run_model = build_workflow_run_for_log_model(api_or_ns)
-    simple_account_model = build_simple_account_model(api_or_ns)
-    simple_end_user_model = build_simple_end_user_model(api_or_ns)
 
     copied_fields = workflow_app_log_partial_fields.copy()
     copied_fields["workflow_run"] = fields.Nested(workflow_run_model, attribute="workflow_run", allow_null=True)
-    copied_fields["created_by_account"] = fields.Nested(
-        simple_account_model, attribute="created_by_account", allow_null=True
-    )
-    copied_fields["created_by_end_user"] = fields.Nested(
-        simple_end_user_model, attribute="created_by_end_user", allow_null=True
-    )
     return api_or_ns.model("WorkflowAppLogPartial", copied_fields)
 
 
@@ -52,17 +44,9 @@ workflow_archived_log_partial_fields = {
 def build_workflow_archived_log_partial_model(api_or_ns: Namespace):
     """Build the workflow archived log partial model for the API or Namespace."""
     workflow_run_model = build_workflow_run_for_archived_log_model(api_or_ns)
-    simple_account_model = build_simple_account_model(api_or_ns)
-    simple_end_user_model = build_simple_end_user_model(api_or_ns)
 
     copied_fields = workflow_archived_log_partial_fields.copy()
     copied_fields["workflow_run"] = fields.Nested(workflow_run_model, allow_null=True)
-    copied_fields["created_by_account"] = fields.Nested(
-        simple_account_model, attribute="created_by_account", allow_null=True
-    )
-    copied_fields["created_by_end_user"] = fields.Nested(
-        simple_end_user_model, attribute="created_by_end_user", allow_null=True
-    )
     return api_or_ns.model("WorkflowArchivedLogPartial", copied_fields)