ima-python-sdk 0.1.0__py3-none-any.whl

ima_sdk/types.py

@@ -0,0 +1,424 @@
+"""IMA OpenAPI 数据类型定义。"""
+
+from __future__ import annotations
+
+import enum
+from dataclasses import dataclass, field
+from typing import Dict, List, Optional
+
+
+# ── 枚举 ──────────────────────────────────────────────────────────────────────
+
+
+class MediaType(enum.IntEnum):
+    """知识库媒体类型。"""
+
+    PDF = 1
+    WEB = 2
+    WORD = 3
+    PPT = 4
+    EXCEL = 5
+    WECHAT_ARTICLE = 6
+    MARKDOWN = 7
+    IMAGE = 9
+    NOTE = 11
+    AI_SESSION = 12
+    TXT = 13
+    XMIND = 14
+    AUDIO = 15
+    VIDEO = 16  # 不支持通过 API 添加
+
+
+class ContentFormat(enum.IntEnum):
+    """笔记内容格式。"""
+
+    PLAINTEXT = 0
+    MARKDOWN = 1
+    JSON = 2
+
+
+class SearchType(enum.IntEnum):
+    """笔记搜索方式。"""
+
+    TITLE = 0
+    CONTENT = 1
+
+
+class SortType(enum.IntEnum):
+    """笔记排序方式。"""
+
+    MODIFY_TIME = 0
+    CREATE_TIME = 1
+    TITLE = 2
+    SIZE = 3
+
+
+class FolderType(enum.IntEnum):
+    """笔记本类型。"""
+
+    USER_CREATED = 0
+    ALL_NOTES = 1
+    UNCATEGORIZED = 2
+
+
+# ── 知识库数据结构 ────────────────────────────────────────────────────────────
+
+
+@dataclass
+class KnowledgeBaseInfo:
+    """知识库信息。"""
+
+    id: str = ""
+    name: str = ""
+    cover_url: str = ""
+    description: str = ""
+    recommended_questions: List[str] = field(default_factory=list)
+
+    @classmethod
+    def from_dict(cls, d: dict) -> KnowledgeBaseInfo:
+        return cls(
+            id=d.get("id", ""),
+            name=d.get("name", ""),
+            cover_url=d.get("cover_url", ""),
+            description=d.get("description", ""),
+            recommended_questions=d.get("recommended_questions", []),
+        )
+
+
+@dataclass
+class KnowledgeInfo:
+    """知识条目。"""
+
+    media_id: str = ""
+    title: str = ""
+    parent_folder_id: str = ""
+
+    @classmethod
+    def from_dict(cls, d: dict) -> KnowledgeInfo:
+        return cls(
+            media_id=d.get("media_id", ""),
+            title=d.get("title", ""),
+            parent_folder_id=d.get("parent_folder_id", ""),
+        )
+
+
+@dataclass
+class KBFolderInfo:
+    """知识库文件夹条目。"""
+
+    folder_id: str = ""
+    name: str = ""
+    file_number: int = 0
+    folder_number: int = 0
+    parent_folder_id: str = ""
+    is_top: bool = False
+
+    @classmethod
+    def from_dict(cls, d: dict) -> KBFolderInfo:
+        return cls(
+            folder_id=d.get("folder_id", ""),
+            name=d.get("name", ""),
+            file_number=d.get("file_number", 0),
+            folder_number=d.get("folder_number", 0),
+            parent_folder_id=d.get("parent_folder_id", ""),
+            is_top=d.get("is_top", False),
+        )
+
+
+@dataclass
+class AddableKnowledgeBaseInfo:
+    """可添加的知识库信息。"""
+
+    id: str = ""
+    name: str = ""
+
+    @classmethod
+    def from_dict(cls, d: dict) -> AddableKnowledgeBaseInfo:
+        return cls(id=d.get("id", ""), name=d.get("name", ""))
+
+
+@dataclass
+class SearchedKnowledgeBaseInfo:
+    """搜索到的知识库信息。"""
+
+    id: str = ""
+    name: str = ""
+    cover_url: str = ""
+
+    @classmethod
+    def from_dict(cls, d: dict) -> SearchedKnowledgeBaseInfo:
+        return cls(
+            id=d.get("id", "") or d.get("kb_id", ""),
+            name=d.get("name", "") or d.get("kb_name", ""),
+            cover_url=d.get("cover_url", ""),
+        )
+
+
+@dataclass
+class SearchedKnowledgeInfo:
+    """搜索到的知识条目。"""
+
+    media_id: str = ""
+    title: str = ""
+    parent_folder_id: str = ""
+    highlight_content: str = ""
+
+    @classmethod
+    def from_dict(cls, d: dict) -> SearchedKnowledgeInfo:
+        return cls(
+            media_id=d.get("media_id", ""),
+            title=d.get("title", ""),
+            parent_folder_id=d.get("parent_folder_id", ""),
+            highlight_content=d.get("highlight_content", ""),
+        )
+
+
+@dataclass
+class ImportURLResult:
+    """URL 导入结果。"""
+
+    url: str = ""
+    ret_code: int = 0
+    media_id: str = ""
+
+    @classmethod
+    def from_dict(cls, d: dict) -> ImportURLResult:
+        return cls(
+            url=d.get("url", ""),
+            ret_code=d.get("ret_code", 0),
+            media_id=d.get("media_id", ""),
+        )
+
+
+@dataclass
+class CosCredential:
+    """COS 上传凭证。"""
+
+    token: str = ""
+    secret_id: str = ""
+    secret_key: str = ""
+    start_time: int = 0
+    expired_time: int = 0
+    appid: str = ""
+    bucket_name: str = ""
+    region: str = ""
+    custom_domain: str = ""
+    cos_key: str = ""
+
+    @classmethod
+    def from_dict(cls, d: dict) -> CosCredential:
+        return cls(
+            token=d.get("token", ""),
+            secret_id=d.get("secret_id", ""),
+            secret_key=d.get("secret_key", ""),
+            start_time=int(d.get("start_time", 0)),
+            expired_time=int(d.get("expired_time", 0)),
+            appid=d.get("appid", ""),
+            bucket_name=d.get("bucket_name", ""),
+            region=d.get("region", ""),
+            custom_domain=d.get("custom_domain", ""),
+            cos_key=d.get("cos_key", ""),
+        )
+
+
+@dataclass
+class FileInfo:
+    """文件信息（add_knowledge 使用）。"""
+
+    cos_key: str = ""
+    file_size: int = 0
+    last_modify_time: int = 0
+    password: str = ""
+    file_name: str = ""
+
+    def to_dict(self) -> dict:
+        d: dict = {
+            "cos_key": self.cos_key,
+            "file_size": self.file_size,
+            "file_name": self.file_name,
+        }
+        if self.last_modify_time:
+            d["last_modify_time"] = self.last_modify_time
+        if self.password:
+            d["password"] = self.password
+        return d
+
+
+@dataclass
+class CheckRepeatedNameResult:
+    """文件名重复检查结果。"""
+
+    name: str = ""
+    is_repeated: bool = False
+
+    @classmethod
+    def from_dict(cls, d: dict) -> CheckRepeatedNameResult:
+        return cls(name=d.get("name", ""), is_repeated=d.get("is_repeated", False))
+
+
+@dataclass
+class CreateMediaResult:
+    """创建媒体返回结果。"""
+
+    media_id: str = ""
+    cos_credential: Optional[CosCredential] = None
+
+    @classmethod
+    def from_dict(cls, d: dict) -> CreateMediaResult:
+        cred = d.get("cos_credential")
+        return cls(
+            media_id=d.get("media_id", ""),
+            cos_credential=CosCredential.from_dict(cred) if cred else None,
+        )
+
+
+# ── 知识库列表返回结构 ────────────────────────────────────────────────────────
+
+
+@dataclass
+class KnowledgeListResult:
+    """浏览知识库内容返回结果。"""
+
+    knowledge_list: List[KnowledgeInfo] = field(default_factory=list)
+    folder_list: List[KBFolderInfo] = field(default_factory=list)
+    is_end: bool = True
+    next_cursor: str = ""
+    current_path: List[KBFolderInfo] = field(default_factory=list)
+
+    @classmethod
+    def from_dict(cls, d: dict) -> KnowledgeListResult:
+        return cls(
+            knowledge_list=[
+                KnowledgeInfo.from_dict(i) for i in d.get("knowledge_list", [])
+            ],
+            folder_list=[
+                KBFolderInfo.from_dict(i) for i in d.get("folder_list", [])
+            ],
+            is_end=d.get("is_end", True),
+            next_cursor=d.get("next_cursor", ""),
+            current_path=[
+                KBFolderInfo.from_dict(i) for i in d.get("current_path", [])
+            ],
+        )
+
+
+# ── 笔记数据结构 ─────────────────────────────────────────────────────────────
+
+
+@dataclass
+class DocBasic:
+    """笔记基本信息。"""
+
+    doc_id: str = ""
+    title: str = ""
+    summary: str = ""
+    create_time: int = 0
+    modify_time: int = 0
+    status: int = 0  # 0=正常, 1=已删除
+    folder_id: str = ""
+    folder_name: str = ""
+
+    @classmethod
+    def from_dict(cls, d: dict) -> DocBasic:
+        return cls(
+            doc_id=d.get("docid", ""),
+            title=d.get("title", ""),
+            summary=d.get("summary", ""),
+            create_time=d.get("create_time", 0),
+            modify_time=d.get("modify_time", 0),
+            status=d.get("status", 0),
+            folder_id=d.get("folder_id", ""),
+            folder_name=d.get("folder_name", ""),
+        )
+
+
+@dataclass
+class NoteFolderItem:
+    """笔记本条目。"""
+
+    folder_id: str = ""
+    name: str = ""
+    note_number: int = 0
+    create_time: int = 0
+    modify_time: int = 0
+    parent_folder_id: str = ""
+    folder_type: int = 0  # 0=用户自建, 1=全部笔记, 2=未分类
+    status: int = 0
+
+    @classmethod
+    def from_dict(cls, d: dict) -> NoteFolderItem:
+        # API 返回嵌套结构: folder.basic_info.{fields}
+        basic = d
+        if "folder" in d:
+            folder = d["folder"]
+            if "basic_info" in folder:
+                basic = folder["basic_info"]
+        return cls(
+            folder_id=basic.get("folder_id", ""),
+            name=basic.get("name", ""),
+            note_number=basic.get("note_number", 0),
+            create_time=basic.get("create_time", 0),
+            modify_time=basic.get("modify_time", 0),
+            parent_folder_id=basic.get("parent_folder_id", ""),
+            folder_type=basic.get("folder_type", 0),
+            status=basic.get("status", 0),
+        )
+
+
+@dataclass
+class NoteBookInfo:
+    """笔记信息（笔记列表返回）。"""
+
+    doc: DocBasic = field(default_factory=DocBasic)
+
+    @classmethod
+    def from_dict(cls, d: dict) -> NoteBookInfo:
+        # API 返回嵌套结构: basic_info.basic_info.{fields}
+        basic = d
+        if "basic_info" in d:
+            inner = d["basic_info"]
+            if "basic_info" in inner:
+                basic = inner["basic_info"]
+            else:
+                basic = inner
+        return cls(doc=DocBasic.from_dict(basic))
+
+
+@dataclass
+class SearchedDoc:
+    """搜索到的笔记。"""
+
+    doc: DocBasic = field(default_factory=DocBasic)
+    highlight_info: Dict[str, str] = field(default_factory=dict)
+
+    @classmethod
+    def from_dict(cls, d: dict) -> SearchedDoc:
+        doc_data = d.get("doc", {})
+        basic = doc_data
+        if "basic_info" in doc_data:
+            inner = doc_data["basic_info"]
+            if "basic_info" in inner:
+                basic = inner["basic_info"]
+            else:
+                basic = inner
+        return cls(
+            doc=DocBasic.from_dict(basic),
+            highlight_info=d.get("highlight_info", {}),
+        )
+
+
+# ── 文件预检结果 ─────────────────────────────────────────────────────────────
+
+
+@dataclass
+class FileCheckResult:
+    """文件预检结果。"""
+
+    passed: bool = False
+    file_path: str = ""
+    file_name: str = ""
+    file_ext: str = ""
+    file_size: int = 0
+    media_type: Optional[int] = None
+    content_type: Optional[str] = None
+    reason: str = ""