intellif-aihub 0.1.5__py3-none-any.whl → 0.1.6__py3-none-any.whl

aihub/models/task_center.py

@@ -8,10 +8,7 @@ from pydantic import BaseModel, Field, field_serializer, field_validator
 
 
 class TaskCenterPriorityEnum(Enum):
-    """
-    任务优先级枚举
-    """
-
+    """任务优先级枚举"""
     low = "low"
     medium = "medium"
     high = "high"
@@ -22,7 +19,6 @@ class LabelProjectTypeEnum(Enum):
     任务类型枚举
      1 - 目标检测 2 - 语义分割 3 - 图片分类 4 - 实例分割 5 - 视频标注 6 - 人类偏好文本标注 7- 敏感预料文本标注 8 - 文本标注 9 - 关键点标注
     """
-
     OBJECT_DETECTION = 1
     SEGMENTATION = 2
     IMAGE_CLASSIFICATION = 3
@@ -35,36 +31,43 @@ class LabelProjectTypeEnum(Enum):
 
 
 class CreateTaskOtherInfo(BaseModel):
-    label_project_type: LabelProjectTypeEnum = LabelProjectTypeEnum.IMAGE_CLASSIFICATION
-    dataset_id: int = Field(alias="dataset_id")
-    dataset_version_id: int = Field(alias="dataset_version_id")
-    doc_id: int = Field(alias="doc_id")
-    doc_type: str = Field(alias="doc_type", default="doc_center")
+    """创建任务附加信息"""
+    label_project_type: LabelProjectTypeEnum = Field(LabelProjectTypeEnum.IMAGE_CLASSIFICATION, description="标注枚举")
+    dataset_id: int = Field(alias="dataset_id", description="数据集ID")
+    dataset_version_id: int = Field(alias="dataset_version_id", description="数据集版本ID")
+    doc_id: int = Field(alias="doc_id", description="文档中心文档ID")
+    doc_type: str = Field(alias="doc_type", default="doc_center", description="文档类型")
+
+    model_config = {"use_enum_values": True}
 
 
 class ProjectInfo(BaseModel):
-    label_project_id: int = Field(alias="label_project_id")
-    label_project_name: str = Field(alias="label_project_name")
+    """项目信息"""
+    label_project_id: int = Field(alias="label_project_id", description="项目ID")
+    label_project_name: str = Field(alias="label_project_name", description="项目名称")
 
 
 class TaskDetailOtherInfo(BaseModel):
-    label_project_type: LabelProjectTypeEnum = LabelProjectTypeEnum.IMAGE_CLASSIFICATION
-    dataset_id: int = Field(alias="dataset_id")
-    dataset_version_id: int = Field(alias="dataset_version_id")
-    doc_id: int = Field(alias="doc_id")
-    doc_type: str = Field(alias="doc_type", default="doc_center")
-    label_projects: Optional[List[ProjectInfo]] = Field(alias="label_projects")
+    """任务详情附加信息"""
+    label_project_type: LabelProjectTypeEnum = Field(LabelProjectTypeEnum.IMAGE_CLASSIFICATION, description="标注枚举")
+    dataset_id: int = Field(alias="dataset_id", description="数据集ID")
+    dataset_version_id: int = Field(alias="dataset_version_id", description="数据集版本ID")
+    doc_id: int = Field(alias="doc_id", description="文档中心文档ID")
+    doc_type: str = Field(alias="doc_type", default="doc_center", description="文档类型")
+    label_projects: Optional[List[ProjectInfo]] = Field(alias="label_projects", default=None,
+                                                        description="关联标注项目列表")
 
 
 class CreateTaskReq(BaseModel):
-    name: str
-    description: Optional[str] = None
-    task_priority: Optional[str] = None
-    type: Optional[str] = None
-    receiver_id: Optional[int] = None
-    project_id: Optional[int] = None
-    other_info: CreateTaskOtherInfo = Field(alias="other_info")
-    estimated_delivery_at: Optional[int] = None
+    """创建标注任务请求"""
+    name: str = Field(description="任务名称")
+    description: Optional[str] = Field(None, description="任务描述")
+    task_priority: Optional[str] = Field(None, alias="task_priority", description="优先级")
+    type: Optional[str] = Field(None, description="任务类型")
+    receiver_id: Optional[int] = Field(None, description="接收人ID")
+    project_id: Optional[int] = Field(None, description="项目ID")
+    other_info: CreateTaskOtherInfo = Field(alias="other_info", description="附加信息")
+    estimated_delivery_at: Optional[int] = Field(None, description="预计交付时间")
 
     @field_serializer("other_info")
     def serialize_other_info(self, value: CreateTaskOtherInfo) -> str:
@@ -73,20 +76,20 @@ class CreateTaskReq(BaseModel):
 
 
 class CreateTaskResp(BaseModel):
-    id: int = Field(alias="id")
+    """创建标注任务返回"""
+    id: int = Field(alias="id", description="任务ID")
 
 
 class LabelTaskDetail(BaseModel):
     """任务详情"""
-
-    name: str
-    description: Optional[str] = Field(alias="description")
-    task_priority: Optional[str] = Field(alias="task_priority")
-    type: Optional[str] = Field(alias="type")
-    receiver_id: Optional[int] = Field(alias="receiver_id")
-    project_id: Optional[int] = None
-    other_info: TaskDetailOtherInfo = Field(alias="other_info")
-    estimated_delivery_at: Optional[int] = None
+    name: str = Field(description="任务名称")
+    description: Optional[str] = Field(alias="description", description="任务描述")
+    task_priority: Optional[str] = Field(alias="task_priority", description="优先级")
+    type: Optional[str] = Field(alias="type", description="任务类型")
+    receiver_id: Optional[int] = Field(alias="receiver_id", description="接收人ID")
+    project_id: Optional[int] = Field(None, description="项目ID")
+    other_info: TaskDetailOtherInfo = Field(alias="other_info", description="附加信息")
+    estimated_delivery_at: Optional[int] = Field(None, description="预计交付时间")
 
     @field_serializer("other_info")
     def serialize_other_info(self, value: TaskDetailOtherInfo) -> str:

aihub/models/user_system.py

@@ -1,5 +1,3 @@
-# !/usr/bin/env python
-# -*-coding:utf-8 -*-
 from __future__ import annotations
 
 from typing import List, Optional
@@ -12,31 +10,35 @@ from pydantic import BaseModel, Field
 # ======================================================================
 
 class Role(BaseModel):
-    id: int
-    name: str
-    role_type: int = Field(alias="role_type")
-    menu_ids: Optional[List[int]] = Field(None, alias="menu_ids")
+    """角色"""
+    id: int = Field(description="角色ID")
+    name: str = Field(description="角色名称")
+    role_type: int = Field(alias="role_type", description="角色类型，1-管理员，2-普通")
+    menu_ids: Optional[List[int]] = Field(None, alias="menu_ids", description="菜单列表")
 
 
 class Menu(BaseModel):
-    id: int
-    name: str
-    parent: int
-    auth: str
+    """菜单"""
+    id: int = Field(description="菜单ID")
+    name: str = Field(description="菜单名称")
+    parent: int = Field(description="父级菜单ID")
+    auth: str = Field(description="权限")
 
 
 class TreeMenu(BaseModel):
-    id: int
-    name: str
-    parent: int
-    auth: str
-    children: Optional[List["TreeMenu"]] = None
-    roles: Optional[List[Role]] = None
+    """菜单（树形）"""
+    id: int = Field(description="菜单ID")
+    name: str = Field(description="菜单名称")
+    parent: int = Field(description="父级菜单ID")
+    auth: str = Field(description="权限")
+    children: Optional[List["TreeMenu"]] = Field(None, description="子菜单")
+    roles: Optional[List[Role]] = Field(None, description="绑定角色列表")
 
 
 class TagBrief(BaseModel):
-    id: int
-    name: str
+    """标签"""
+    id: int = Field(description="标签ID")
+    name: str = Field(description="标签名称")
 
 
 # ======================================================================
@@ -44,78 +46,91 @@ class TagBrief(BaseModel):
 # ======================================================================
 
 class LoginRequest(BaseModel):
-    username: str = Field(alias="username")
-    password: str = Field(alias="password")
+    """登录请求"""
+    username: str = Field(alias="username", description="用户名")
+    password: str = Field(alias="password", description="密码")
 
 
 class LoginResponse(BaseModel):
-    id: int = Field(alias="id")
-    token: str = Field(alias="token")
+    """登录返回"""
+    id: int = Field(alias="id", description="用户ID")
+    token: str = Field(alias="token", description="JWT Token")
 
 
 class SignupRequest(BaseModel):
-    username: str = Field(alias="username")
-    password: str = Field(alias="password")
-    nickname: str = Field(alias="nickname")
-    email: str = Field(alias="email")
-    role_ids: List[int] = Field(alias="role_ids")
+    """注册请求"""
+    username: str = Field(alias="username", description="用户名")
+    password: str = Field(alias="password", description="密码")
+    nickname: str = Field(alias="nickname", description="昵称")
+    email: str = Field(alias="email", description="邮箱")
+    role_ids: List[int] = Field(alias="role_ids", description="角色列表")
 
 
 class SignupResponse(BaseModel):
-    id: int = Field(alias="id")
+    """注册返回"""
+    id: int = Field(alias="id", description="用户ID")
 
 
 # ======================================================================
 # ------------------------------- MENU ---------------------------------
 # ======================================================================
 class ListMenusRequest(BaseModel):
-    need_roles: Optional[bool] = Field(None, alias="need_roles")
+    """查询菜单列表请求"""
+    need_roles: Optional[bool] = Field(None, alias="need_roles", description="是否同时返回菜单绑定的角色信息")
 
 
 class ListMenusResponse(BaseModel):
-    menus: List[TreeMenu] = Field(None, alias="menus")
+    """查询菜单列表返回"""
+    menus: List[TreeMenu] = Field(alias="menus", description="菜单树列表")
 
 
 class CreateMenuRequest(BaseModel):
-    name: str = Field(alias="name")
-    parent: int = Field(alias="parent")
-    auth: str = Field(alias="auth")
-    role_ids: Optional[List[int]] = Field(None, alias="role_ids")
+    """创建菜单请求"""
+    name: str = Field(alias="name", description="菜单名称")
+    parent: int = Field(alias="parent", description="父级菜单ID")
+    auth: str = Field(alias="auth", description="权限")
+    role_ids: Optional[List[int]] = Field(None, alias="role_ids", description="绑定的角色列表")
 
 
 class CreateMenuResponse(BaseModel):
-    id: int = Field(alias="id")
+    """创建菜单返回"""
+    id: int = Field(alias="id", description="菜单ID")
 
 
 class UpdateMenuRequest(BaseModel):
-    name: Optional[str] = Field(None, alias="name")
-    parent: Optional[int] = Field(None, alias="parent")
-    auth: str = Field(alias="auth")
-    role_ids: Optional[List[int]] = Field(None, alias="role_ids")
+    """更新菜单请求"""
+    name: Optional[str] = Field(None, alias="name", description="菜单名称")
+    parent: Optional[int] = Field(None, alias="parent", description="父级菜单ID")
+    auth: str = Field(alias="auth", description="权限")
+    role_ids: Optional[List[int]] = Field(None, alias="role_ids", description="绑定的角色列表")
 
 
 class GetMenuRolesResponse(BaseModel):
-    role_ids: List[int] = Field(alias="role_ids")
+    """获取菜单角色返回"""
+    role_ids: List[int] = Field(alias="role_ids", description="菜单绑定的角色ID")
 
 
 class SetMenuRolesRequest(BaseModel):
-    role_ids: List[int] = Field(alias="role_ids")
+    """设置菜单角色请求"""
+    role_ids: List[int] = Field(alias="role_ids", description="绑定的角色列表")
 
 
 class SearchMenusRequest(BaseModel):
-    page_size: int = Field(20, alias="page_size")
-    page_num: int = Field(1, alias="page_num")
-    name: Optional[str] = None
-    parent_ids: Optional[List[int]] = Field(None, alias="parent_ids")
-    auth: Optional[str] = None
-    menu_ids: Optional[List[int]] = Field(None, alias="menu_ids")
+    """搜索菜单请求"""
+    page_size: int = Field(20, alias="page_size", description="单页条数")
+    page_num: int = Field(1, alias="page_num", description="页码")
+    name: Optional[str] = Field(None, description="名称过滤")
+    parent_ids: Optional[List[int]] = Field(None, alias="parent_ids", description="父级ID过滤")
+    auth: Optional[str] = Field(None, description="权限过滤")
+    menu_ids: Optional[List[int]] = Field(None, alias="menu_ids", description="菜单过滤")
 
 
 class SearchMenusResponse(BaseModel):
-    total: int
-    page_size: int = Field(alias="page_size")
-    page_num: int = Field(alias="page_num")
-    data: List[Menu]
+    """搜索菜单返回"""
+    total: int = Field(description="总数")
+    page_size: int = Field(alias="page_size", description="单页条数")
+    page_num: int = Field(alias="page_num", description="当前页")
+    data: List[Menu] = Field(description="菜单列表")
 
 
 # ======================================================================
@@ -124,56 +139,65 @@ class SearchMenusResponse(BaseModel):
 
 
 class CreateRoleRequest(BaseModel):
-    id: Optional[int] = Field(None, alias="id")
-    name: str
-    role_type: int = Field(alias="role_type")
-    menu_ids: Optional[List[int]] = Field(None, alias="menu_ids")
+    """创建角色请求"""
+    id: Optional[int] = Field(None, description="自定义ID")
+    name: str = Field(description="角色名称")
+    role_type: int = Field(alias="role_type", description="角色类型")
+    menu_ids: Optional[List[int]] = Field(None, alias="menu_ids", description="绑定菜单")
 
 
 class CreateRoleResponse(BaseModel):
-    id: int
+    """创建角色返回"""
+    id: int = Field(description="角色ID")
 
 
 class UpdateRoleRequest(BaseModel):
-    name: Optional[str] = None
-    role_type: Optional[int] = Field(None, alias="role_type")
-    menu_ids: Optional[List[int]] = Field(None, alias="menu_ids")
+    """更新角色请求"""
+    name: Optional[str] = Field(None, description="角色名称")
+    role_type: Optional[int] = Field(None, alias="role_type", description="角色类型")
+    menu_ids: Optional[List[int]] = Field(None, alias="menu_ids", description="菜单列表")
 
 
 class GetRoleMenusResponse(BaseModel):
-    menu_ids: List[int] = Field(alias="menu_ids")
+    """获取角色菜单返回"""
+    menu_ids: List[int] = Field(alias="menu_ids", description="菜单ID")
 
 
 class SetRoleMenusRequest(BaseModel):
-    menu_ids: List[int] = Field(alias="menu_ids")
+    """设置角色菜单请求"""
+    menu_ids: List[int] = Field(alias="menu_ids", description="菜单ID")
 
 
 class ListRolesRequest(BaseModel):
-    page_size: int = Field(20, alias="page_size")
-    page_num: int = Field(1, alias="page_num")
-    role_type: Optional[int] = Field(None, alias="role_type")
+    """查询角色列表请求"""
+    page_size: int = Field(20, alias="page_size", description="单页条数")
+    page_num: int = Field(1, alias="page_num", description="页码")
+    role_type: Optional[int] = Field(None, alias="role_type", description="角色类型过滤")
 
 
 class ListRolesResponse(BaseModel):
-    total: int
-    page_size: int = Field(alias="page_size")
-    page_num: int = Field(alias="page_num")
-    data: List[Role]
+    """查询角色列表返回"""
+    total: int = Field(description="总数")
+    page_size: int = Field(alias="page_size", description="单页条数")
+    page_num: int = Field(alias="page_num", description="当前页")
+    data: List[Role] = Field(description="角色列表")
 
 
 class SearchRolesRequest(BaseModel):
-    page_size: int = Field(20, alias="page_size")
-    page_num: int = Field(1, alias="page_num")
-    name: Optional[str] = None
-    role_ids: Optional[List[int]] = Field(None, alias="role_ids")
-    menu_ids: Optional[List[int]] = Field(None, alias="menu_ids")
+    """搜索角色请求"""
+    page_size: int = Field(20, alias="page_size", description="单页条数")
+    page_num: int = Field(1, alias="page_num", description="页码")
+    name: Optional[str] = Field(None, description="名字过滤")
+    role_ids: Optional[List[int]] = Field(None, alias="role_ids", description="角色ID过滤")
+    menu_ids: Optional[List[int]] = Field(None, alias="menu_ids", description="菜单ID过滤")
 
 
 class SearchRolesResponse(BaseModel):
-    total: int
-    page_size: int = Field(alias="page_size")
-    page_num: int = Field(alias="page_num")
-    data: List[Role]
+    """搜索角色返回"""
+    total: int = Field(description="总数")
+    page_size: int = Field(alias="page_size", description="单页条数")
+    page_num: int = Field(alias="page_num", description="当前页")
+    data: List[Role] = Field(description="角色列表")
 
 
 # ======================================================================
@@ -181,81 +205,91 @@ class SearchRolesResponse(BaseModel):
 # ======================================================================
 
 class User(BaseModel):
-    id: int
-    username: str
-    nickname: str
-    email: str
-    roles: Optional[List[Role]] = Field(None, alias="roles")
-    status: int
-    tags: Optional[List[TagBrief]] = Field(None, alias="tags")
-    created_at: int = Field(alias="created_at")
+    """用户信息"""
+    id: int = Field(description="用户ID")
+    username: str = Field(description="用户名")
+    nickname: str = Field(description="昵称")
+    email: str = Field(description="邮箱")
+    roles: Optional[List[Role]] = Field(None, alias="roles", description="角色列表")
+    status: int = Field(description="状态，1-可用，2-禁用")
+    tags: Optional[List[TagBrief]] = Field(None, alias="tags", description="标签")
+    created_at: int = Field(alias="created_at", description="创建时间戳（ms）")
 
 
 class ListUsersRequest(BaseModel):
-    page_size: int = Field(20, alias="page_size")
-    page_num: int = Field(1, alias="page_num")
-    search_key: Optional[str] = Field(None, alias="search_key")
+    """查询用户列表请求"""
+    page_size: int = Field(20, alias="page_size", description="单页条数")
+    page_num: int = Field(1, alias="page_num", description="页码")
+    search_key: Optional[str] = Field(None, alias="search_key", description="搜索关键字")
 
 
 class ListUsersResponse(BaseModel):
-    total: int
-    page_size: int = Field(alias="page_size")
-    page_num: int = Field(alias="page_num")
-    data: List[User]
+    """查询用户列表返回"""
+    total: int = Field(description="总数")
+    page_size: int = Field(alias="page_size", description="单页条数")
+    page_num: int = Field(alias="page_num", description="当前页")
+    data: List[User] = Field(description="用户列表")
 
 
 class CreateUserRequest(BaseModel):
-    id: int
-    username: str
-    password: str
-    nickname: str
-    email: str
-    role_ids: Optional[List[int]] = Field(None, alias="role_ids")
-    created_at: Optional[int] = Field(None, alias="created_at")
-    updated_at: Optional[int] = Field(None, alias="updated_at")
-    status: Optional[int] = None
-    tag_ids: Optional[List[int]] = Field(None, alias="tag_ids")
+    """创建用户请求"""
+    id: int = Field(description="用户id")
+    username: str = Field(description="用户名")
+    password: str = Field(description="密码")
+    nickname: str = Field(description="昵称")
+    email: str = Field(description="邮箱")
+    role_ids: Optional[List[int]] = Field(None, alias="role_ids", description="角色列表")
+    created_at: Optional[int] = Field(None, alias="created_at", description="创建时间戳")
+    updated_at: Optional[int] = Field(None, alias="updated_at", description="更新时间戳")
+    status: Optional[int] = Field(None, description="状态，1-可用，2-禁用")
+    tag_ids: Optional[List[int]] = Field(None, alias="tag_ids", description="标签列表")
 
 
 class CreateUserResponse(BaseModel):
-    id: int
+    """创建用户返回"""
+    id: int = Field(description="用户ID")
 
 
 class UpdateUserRequest(BaseModel):
-    username: Optional[str] = None
-    nickname: Optional[str] = None
-    email: Optional[str] = None
-    password: Optional[str] = None
-    role_ids: Optional[List[int]] = Field(default_factory=list, alias="role_ids")
-    status: Optional[int] = None
-    tag_ids: Optional[List[int]] = Field(default_factory=list, alias="tag_ids")
+    """更新用户请求"""
+    username: Optional[str] = Field(None, description="用户名")
+    nickname: Optional[str] = Field(None, description="昵称")
+    email: Optional[str] = Field(None, description="邮箱")
+    password: Optional[str] = Field(None, description="密码")
+    role_ids: Optional[List[int]] = Field(default_factory=list, alias="role_ids", description="角色列表")
+    status: Optional[int] = Field(None, description="状态，1-可用，2-禁用")
+    tag_ids: Optional[List[int]] = Field(default_factory=list, alias="tag_ids", description="标签列表")
 
 
 class SetUserRolesRequest(BaseModel):
-    role_ids: List[int] = Field(alias="role_ids")
+    """设置用户角色请求"""
+    role_ids: List[int] = Field(alias="role_ids", description="角色列表")
 
 
 class GetUserMenusResponse(BaseModel):
-    menus: List[TreeMenu]
+    """获取用户菜单返回"""
+    menus: List[TreeMenu] = Field(description="菜单树")
 
 
 class SearchUsersRequest(BaseModel):
-    page_size: int = Field(20, alias="page_size")
-    page_num: int = Field(1, alias="page_num")
-    username: Optional[str] = None
-    nickname: Optional[str] = None
-    email: Optional[str] = None
-    user_ids: Optional[List[int]] = Field(None, alias="user_ids")
-    role_ids: Optional[List[int]] = Field(None, alias="role_ids")
-    role_names: Optional[List[str]] = Field(None, alias="role_names")
-    status: Optional[int] = None
+    """搜索用户请求"""
+    page_size: int = Field(20, alias="page_size", description="单页条数")
+    page_num: int = Field(1, alias="page_num", description="当前页")
+    username: Optional[str] = Field(None, description="用户名过滤")
+    nickname: Optional[str] = Field(None, description="昵称过滤")
+    email: Optional[str] = Field(None, description="邮箱过滤")
+    user_ids: Optional[List[int]] = Field(None, alias="user_ids", description="用户ID过滤")
+    role_ids: Optional[List[int]] = Field(None, alias="role_ids", description="角色ID过滤")
+    role_names: Optional[List[str]] = Field(None, alias="role_names", description="角色名过滤")
+    status: Optional[int] = Field(None, description="状态过滤")
 
 
 class SearchUsersResponse(BaseModel):
-    total: int
-    page_size: int = Field(alias="page_size")
-    page_num: int = Field(alias="page_num")
-    data: List[User]
+    """搜索用户返回"""
+    total: int = Field(description="总数")
+    page_size: int = Field(alias="page_size", description="单页条数")
+    page_num: int = Field(alias="page_num", description="当前页")
+    data: List[User] = Field(description="用户列表")
 
 
 # 此行放在文件末尾，否则序列化报错