dataops-sdk 0.4.2__tar.gz → 0.4.4__tar.gz

{dataops_sdk-0.4.2 → dataops_sdk-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dataops-sdk
-Version: 0.4.2
+Version: 0.4.4
 Summary: Python SDK for the DataOps platform.
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown

{dataops_sdk-0.4.2 → dataops_sdk-0.4.4}/src/dataops_sdk/__init__.py

@@ -95,6 +95,8 @@ from .services import (  # noqa: F401
     service_ref_forward,
     service_set_application,
     service_skill_call_by_code,
+    service_skill_download,
+    service_skill_update,
     service_skill_upload,
     service_skill_upload_sub_file,
     service_start_workflow,
@@ -107,4 +109,4 @@ from .services import (  # noqa: F401
 )
 from .session import dataops_base_url_context, request_context
 
-__version__ = "0.4.2"
+__version__ = "0.4.4"

{dataops_sdk-0.4.2 → dataops_sdk-0.4.4}/src/dataops_sdk/schemas/__init__.py

@@ -43,6 +43,7 @@ from .meta import (
 from .query import PageParam, SqlCondition, SqlFilter, SqlQueryParam, SqlSort
 from .report import ReportMeta, ReportMetaData
 from .skill import DataSkill, DataSkillSubFile, MetaSkill, SkillCallResult
+from .tag import TagBrief, TagEntityType, TagTreeNode
 from .table import (
     ColumnItem,
     DataBaseColumnDictExternal,
@@ -53,4 +54,12 @@ from .table import (
 )
 from .user import Application, UserInfo
 from .widget import WidgetMeta, WidgetMetaData
+from .wiki import (
+    KbType,
+    KnowledgeBase,
+    KnowledgeDocument,
+    KnowledgeSearchResult,
+    WikiPage,
+    WikiPageResult,
+)
 from .workflow import DataWorkflow, MetaWorkflow

dataops_sdk-0.4.4/src/dataops_sdk/schemas/tag.py

@@ -0,0 +1,144 @@
+"""元标签 (meta tag) Schema 定义.
+
+对应后端 ``MetaTagController``（``/data/meta/tag``）的树节点与实体关联摘要。
+``type`` 表示被标注的实体类型（如 skill / agent），不是 ``MetaType``。
+"""
+
+from __future__ import annotations
+
+from datetime import datetime
+from enum import StrEnum
+from typing import Annotated
+
+from pydantic import AliasChoices, BaseModel, ConfigDict, Field
+
+
+class TagEntityType(StrEnum):
+    """常见标签作用域（实体类型）提示枚举；后端仍接受任意字符串."""
+
+    SKILL = "skill"
+    AGENT = "agent"
+    REPORT = "report"
+    WIDGET = "widget"
+
+
+class TagBrief(BaseModel):
+    """实体已绑定标签的简要信息（``rel/list`` 返回）."""
+
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    cuid: Annotated[
+        str,
+        Field(description="标签 cuid", validation_alias=AliasChoices("cuid", "CUID")),
+    ]
+    title: Annotated[
+        str | None,
+        Field(description="标题", validation_alias=AliasChoices("title", "TITLE")),
+    ] = None
+    color: Annotated[
+        str | None,
+        Field(description="颜色", validation_alias=AliasChoices("color", "COLOR")),
+    ] = None
+    parentId: Annotated[
+        str | None,
+        Field(
+            description="父标签 cuid",
+            validation_alias=AliasChoices("parentId", "parent_id", "PARENT_ID"),
+        ),
+    ] = None
+    icon: Annotated[
+        str | None,
+        Field(description="图标", validation_alias=AliasChoices("icon", "ICON")),
+    ] = None
+
+
+class TagTreeNode(BaseModel):
+    """标签树节点（``/tree`` 返回）."""
+
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    cuid: Annotated[
+        str,
+        Field(description="标签 cuid", validation_alias=AliasChoices("cuid", "CUID")),
+    ]
+    tenantId: Annotated[
+        str | None,
+        Field(
+            description="租户 ID",
+            validation_alias=AliasChoices("tenantId", "tenant_id", "TENANT_ID"),
+        ),
+    ] = None
+    prodCode: Annotated[
+        str | None,
+        Field(
+            description="应用编码",
+            validation_alias=AliasChoices("prodCode", "prod_code", "PROD_CODE"),
+        ),
+    ] = None
+    parentId: Annotated[
+        str | None,
+        Field(
+            description="父标签 cuid",
+            validation_alias=AliasChoices("parentId", "parent_id", "PARENT_ID"),
+        ),
+    ] = None
+    type: Annotated[
+        str | None,
+        Field(description="实体类型作用域", validation_alias=AliasChoices("type", "TYPE")),
+    ] = None
+    code: Annotated[
+        str | None,
+        Field(description="标签编码", validation_alias=AliasChoices("code", "CODE")),
+    ] = None
+    title: Annotated[
+        str | None,
+        Field(description="标题", validation_alias=AliasChoices("title", "TITLE")),
+    ] = None
+    icon: Annotated[
+        str | None,
+        Field(description="图标", validation_alias=AliasChoices("icon", "ICON")),
+    ] = None
+    color: Annotated[
+        str | None,
+        Field(description="颜色", validation_alias=AliasChoices("color", "COLOR")),
+    ] = None
+    sort: Annotated[
+        float | None,
+        Field(description="排序", validation_alias=AliasChoices("sort", "SORT")),
+    ] = None
+    remark: Annotated[
+        str | None,
+        Field(description="备注", validation_alias=AliasChoices("remark", "REMARK")),
+    ] = None
+    createUser: Annotated[
+        str | None,
+        Field(
+            description="创建人",
+            validation_alias=AliasChoices("createUser", "create_user", "CREATE_USER"),
+        ),
+    ] = None
+    createTime: Annotated[
+        datetime | str | None,
+        Field(
+            description="创建时间",
+            validation_alias=AliasChoices("createTime", "create_time", "CREATE_TIME"),
+        ),
+    ] = None
+    lastModifyUser: Annotated[
+        str | None,
+        Field(
+            description="修改人",
+            validation_alias=AliasChoices("lastModifyUser", "last_modify_user", "LAST_MODIFY_USER"),
+        ),
+    ] = None
+    lastModifyTime: Annotated[
+        datetime | str | None,
+        Field(
+            description="修改时间",
+            validation_alias=AliasChoices("lastModifyTime", "last_modify_time", "LAST_MODIFY_TIME"),
+        ),
+    ] = None
+    children: Annotated[
+        list[TagTreeNode],
+        Field(default_factory=list, description="子标签"),
+    ]

dataops_sdk-0.4.4/src/dataops_sdk/schemas/wiki.py

@@ -0,0 +1,120 @@
+"""Wiki / 知识库 Schema 定义.
+
+对应后端 ``data-ops-wiki`` 的 ``WikiApiController``（``/data/wiki/*``）返回结构。
+字段通过 ``validation_alias`` / ``AliasChoices`` 兼容 snake_case 与 weKnora 原始键名。
+"""
+
+from __future__ import annotations
+
+from enum import StrEnum
+from typing import Annotated, Generic, TypeVar
+
+from pydantic import AliasChoices, BaseModel, ConfigDict, Field
+
+T = TypeVar("T")
+
+
+class KbType(StrEnum):
+    """知识库类型."""
+
+    DOCUMENT = "document"
+    FAQ = "faq"
+    WIKI = "wiki"
+
+
+class KnowledgeBase(BaseModel):
+    """知识库."""
+
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    id: Annotated[str, Field(description="知识库 ID")]
+    name: Annotated[str, Field(description="知识库名称")]
+    description: Annotated[str | None, Field(description="描述")] = None
+    type: Annotated[str | None, Field(description="类型：document/faq/wiki")] = None
+    knowledge_count: Annotated[int | None, Field(description="文档数量", alias="knowledgeCount")] = None
+    chunk_count: Annotated[int | None, Field(description="切片数量", alias="chunkCount")] = None
+    created_at: Annotated[str | None, Field(description="创建时间")] = None
+    updated_at: Annotated[str | None, Field(description="更新时间")] = None
+
+
+class KnowledgeDocument(BaseModel):
+    """知识库文档."""
+
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    id: Annotated[str, Field(description="文档 ID")]
+    title: Annotated[str | None, Field(description="标题")] = None
+    file_name: Annotated[str | None, Field(description="文件名", alias="fileName")] = None
+    file_type: Annotated[str | None, Field(description="文件类型", alias="fileType")] = None
+    parse_status: Annotated[str | None, Field(description="解析状态", alias="parseStatus")] = None
+    source: Annotated[str | None, Field(description="来源")] = None
+    type: Annotated[str | None, Field(description="类型")] = None
+    knowledge_base_id: Annotated[
+        str | None, Field(description="所属知识库", alias="knowledgeBaseId")
+    ] = None
+    created_at: Annotated[str | None, Field(description="创建时间")] = None
+
+
+class KnowledgeSearchResult(BaseModel):
+    """关键词检索结果."""
+
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    id: Annotated[str | None, Field(description="结果 ID")] = None
+    chunk_id: Annotated[str | None, Field(description="切片 ID", alias="chunkId")] = None
+    title: Annotated[str | None, Field(description="标题")] = None
+    content: Annotated[str | None, Field(description="内容片段")] = None
+    score: Annotated[float | None, Field(description="相关度分数")] = None
+    kb_id: Annotated[str | None, Field(description="知识库 ID")] = None
+    knowledge_base_id: Annotated[
+        str | None, Field(description="知识库 ID", alias="knowledgeBaseId")
+    ] = None
+    kb_name: Annotated[str | None, Field(description="知识库名称", alias="kbName")] = None
+    knowledge_id: Annotated[str | None, Field(description="文档 ID", alias="knowledgeId")] = None
+    knowledge_title: Annotated[
+        str | None, Field(description="文档标题", alias="knowledgeTitle")
+    ] = None
+    file_type: Annotated[str | None, Field(description="文件类型", alias="fileType")] = None
+
+
+class WikiPage(BaseModel):
+    """Wiki 页面."""
+
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    id: Annotated[str | None, Field(description="页面 ID")] = None
+    slug: Annotated[str, Field(description="页面 slug")]
+    title: Annotated[str | None, Field(description="标题")] = None
+    page_type: Annotated[str | None, Field(description="页面类型", alias="pageType")] = None
+    status: Annotated[str | None, Field(description="状态")] = None
+    summary: Annotated[str | None, Field(description="摘要")] = None
+    content: Annotated[str | None, Field(description="正文")] = None
+    wiki_path: Annotated[str | None, Field(description="Wiki 路径")] = None
+    knowledge_base_id: Annotated[
+        str | None, Field(description="所属知识库", alias="knowledgeBaseId")
+    ] = None
+
+
+class WikiPageResult(BaseModel, Generic[T]):
+    """分页结果."""
+
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    items: Annotated[
+        list[T],
+        Field(
+            description="列表",
+            validation_alias=AliasChoices("list", "items"),
+            serialization_alias="list",
+        ),
+    ] = []
+    total: Annotated[int, Field(description="总数")] = 0
+    page: Annotated[int, Field(description="页码")] = 1
+    page_size: Annotated[
+        int,
+        Field(description="每页条数", validation_alias=AliasChoices("page_size", "pageSize")),
+    ] = 20
+    has_more: Annotated[
+        bool | None,
+        Field(description="是否还有更多", validation_alias=AliasChoices("has_more", "hasMore")),
+    ] = None

{dataops_sdk-0.4.2 → dataops_sdk-0.4.4}/src/dataops_sdk/services/__init__.py

@@ -106,8 +106,10 @@ from .skill import (
     service_skill_call_by_code,
     service_skill_call_by_name,
     service_skill_delete_sub_file,
+    service_skill_download,
     service_skill_get_subfile_by_code,
     service_skill_get_subfile_by_name,
+    service_skill_update,
     service_skill_upload,
     service_skill_upload_sub_file,
 )
@@ -129,6 +131,17 @@ from .table import (
     service_update_table_record_by_id,
     service_update_table_record_by_id_list,
 )
+from .tag import (
+    flatten_tag_tree,
+    service_add_entity_tags,
+    service_get_tag_detail,
+    service_list_entity_tags,
+    service_list_entity_tags_by_codes,
+    service_list_tags,
+    service_remove_entity_tags,
+    service_save_entity_tags,
+    service_set_entity_tags,
+)
 from .widget import (
     service_count_widget_by_code,
     service_get_widget_data_by_code,
@@ -137,6 +150,14 @@ from .widget import (
     service_update_widget,
     servive_tree_widget,
 )
+from .wiki import (
+    service_get_knowledge_base,
+    service_list_knowledge_bases,
+    service_list_knowledge_documents,
+    service_search_knowledge,
+    service_search_wiki_pages,
+    service_upload_knowledge_file,
+)
 from .workflow import (
     service_get_workflow_by_code,
     service_get_workflow_by_name,

{dataops_sdk-0.4.2 → dataops_sdk-0.4.4}/src/dataops_sdk/services/skill.py

@@ -3,8 +3,8 @@
 封装技能实体的元数据查询、ZIP 包导入、子文件上传 / 删除以及同步调用:
 
 - 列表与详情: ``service_list_skills`` / ``service_get_skill_by_code`` / ``service_get_skill_by_name`` / ``service_list_skill_files``.
-- 导入 / 删除: ``service_skill_upload`` / ``service_delete_skill`` / ``service_skill_upload_sub_file`` / ``service_skill_delete_sub_file``.
-- 打包 ZIP: ``service_pack_skill_zip``（按允许列表校验源文件夹结构后本地打包为 ZIP）.
+- 导入 / 更新 / 删除: ``service_skill_upload`` / ``service_skill_update`` / ``service_delete_skill`` / ``service_skill_upload_sub_file`` / ``service_skill_delete_sub_file``.
+- 打包 / 下载 ZIP: ``service_pack_skill_zip`` / ``service_skill_download``.
 - 同步调用: ``service_skill_call_by_code``.
 
 所有函数均为纯 Python 接口，不依赖 typer/Rich.
@@ -44,7 +44,9 @@ __all__ = [
     "service_skill_delete_sub_file",
     "service_get_skill_by_code",
     "service_get_skill_by_name",
+    "service_skill_download",
     "service_skill_upload",
+    "service_skill_update",
     "service_list_skill_files",
     "service_list_skills",
     "service_skill_upload_sub_file",
@@ -314,6 +316,115 @@ def service_skill_upload(
         return body.get("data") or {}
 
 
+def service_skill_update(
+    name: str,
+    file_path: str | Path,
+    *,
+    sub_type: MetaSkillSubType | None = None,
+    title: str | None = None,
+) -> dict:
+    """全量覆盖更新已有技能（multipart 上传）.
+
+    按技能业务名解析 ``code`` 后覆盖更新：清空子文件后按 ZIP/文件夹重建。
+    对应后端 ``POST /data/skill/{code}/import``。
+
+    Args:
+        name: 技能业务名.
+        file_path: 本地 ZIP 或 .md 文件路径.
+        sub_type: 可选技能子类型，``llm`` / ``api`` / ``report``.
+        title: 可选覆盖 SKILL.md 中的 ``title`` 字段.
+
+    Returns:
+        后端返回的 ``data`` 字典.
+
+    Raises:
+        NotFoundError: 找不到对应技能时
+        DataOpsError: API 返回错误时
+        AuthenticationError: 未认证或认证失败时
+        FileNotFoundError: 本地文件不存在时
+    """
+    path = Path(file_path)
+    if not path.exists():
+        raise FileNotFoundError(f"文件不存在: {path}")
+
+    meta = service_get_skill_by_name(name)
+    form_data: dict[str, str] = {}
+    if sub_type is not None:
+        form_data["subType"] = sub_type
+    if title:
+        form_data["title"] = title
+
+    with (
+        open(path, "rb") as f,
+        post_multipart(
+            f"/data/skill/{meta.code}/import",
+            files={"file": (path.name, f)},
+            data=form_data or None,
+        ) as resp,
+    ):
+        body = resp.json()
+        return body.get("data") or {}
+
+
+def service_skill_download(
+    name: str,
+    output_path: str | Path | None = None,
+) -> Path:
+    """从平台导出技能 ZIP 并保存到本地.
+
+    按业务名解析 ``code`` 后调用 ``POST /data/skill/export/{code}``，
+    将返回的 ``application/zip`` 二进制写入本地文件。
+
+    Args:
+        name: 技能业务名.
+        output_path: 可选输出路径。省略时写到当前目录 ``{name}.zip``；
+            路径以 ``/`` 或 ``\\`` 结尾时视为目录，在其下生成 ``{name}.zip``；
+            否则视为精确文件路径。
+
+    Returns:
+        实际写入的 ZIP 文件 :class:`Path` 对象。
+
+    Raises:
+        NotFoundError: 找不到对应技能时
+        DataOpsError: API 返回错误时
+        AuthenticationError: 未认证或认证失败时
+        OSError: 写入本地文件失败时
+    """
+    meta = service_get_skill_by_name(name)
+    try:
+        with get_session() as session:
+            resp = session.post(f"/data/skill/export/{meta.code}")
+            if resp.status_code == 401:
+                raise AuthenticationError("认证失败，请先登录")
+            if resp.status_code != 200:
+                msg = f"HTTP {resp.status_code}"
+                try:
+                    body = resp.json()
+                    msg = body.get("msg", msg) if isinstance(body, dict) else msg
+                except Exception:
+                    pass
+                raise DataOpsError(msg, resp.status_code)
+            content = resp.content
+    except SystemExit as e:
+        raise AuthenticationError("认证失败，请先登录") from e
+
+    # 默认/目录场景统一用业务名，便于与 upload 对称识别
+    zip_filename = f"{name}.zip"
+
+    if output_path is None:
+        out = Path(zip_filename)
+    else:
+        raw = os.fspath(output_path)
+        treat_as_dir = isinstance(raw, str) and raw.endswith(("/", "\\"))
+        out = Path(raw)
+        if treat_as_dir or out.is_dir():
+            out = out / zip_filename
+
+    out.parent.mkdir(parents=True, exist_ok=True)
+    out.write_bytes(content)
+    return out
+
+
 def service_delete_skill(name: str) -> dict:
     """按业务名删除技能（级联删除所有 skill_file）.