modelscope-api 0.0.1__py3-none-any.whl

modelscope_api/__init__.py

@@ -0,0 +1 @@
+from .models import ModelScopeClient

modelscope_api/config.py

@@ -0,0 +1,23 @@
+"""
+配置
+"""
+
+import os
+from typing import Optional
+
+from dotenv import load_dotenv
+from yarl import URL
+
+
+# 加载 .env 文件
+load_dotenv()
+
+# 用于 ModelScope 用户进行身份验证的令牌
+MODELSCOPE_API_TOKEN: Optional[str] = os.getenv("MODELSCOPE_API_TOKEN")
+
+# OpenAPI 基础地址
+MODELSCOPE_OPENAPI_VERSION: str = "v1"
+MODELSCOPE_OPENAPI_BASE_URL: URL = URL(os.getenv(
+    "MODELSCOPE_OPENAPI_BASE_URL",
+    "https://modelscope.cn/openapi"
+))

modelscope_api/data_models/__init__.py

@@ -0,0 +1,3 @@
+"""
+数据模型。
+"""

modelscope_api/data_models/base.py

@@ -0,0 +1,22 @@
+"""
+数据类基类。
+"""
+
+from __future__ import annotations
+
+from typing import List
+
+from ..utils.typing import JsonObject
+
+
+class BaseDataClass:
+    """
+    数据模型基类，提供从 JSON 构造的通用方法。
+    """
+
+    @classmethod
+    def from_json(cls, data: JsonObject | List[JsonObject]) -> BaseDataClass:
+        """
+        从 JSON 数据对象构造。
+        """
+        return cls(**data)

modelscope_api/data_models/collection/__init__.py

@@ -0,0 +1,6 @@
+"""
+与合集（Collection）有关的数据模型。
+"""
+
+from .collection import CollectionInfo, CollectionTheme, CollectionVisibility
+from .collection_item import CollectionItemInfo, CollectionItemType, CollectionItemVisibility

modelscope_api/data_models/collection/collection.py

@@ -0,0 +1,110 @@
+"""
+合集（Collection）数据模型。
+"""
+
+from __future__ import annotations
+
+from enum import StrEnum
+from typing import List, Optional
+
+from pydantic import Field
+from pydantic.dataclasses import dataclass
+
+from ...utils.regex import COLLECTION_SLUG_PATTERN
+from ..base import BaseDataClass
+from .collection_item import CollectionItemInfo
+
+
+
+class CollectionVisibility(StrEnum):
+    """
+    合集可见性。
+    """
+    PUBLIC  = "public"  # 公开
+    PRIVATE = "private" # 私有
+
+
+class CollectionTheme(StrEnum):
+    """
+    合集的主题色。
+    """
+    BLUE = "Blue"
+    PINK = "Pink"
+    PURPLE = "Purple"
+    CYAN = "Cyan"
+
+
+@dataclass(frozen=True)
+class CollectionInfo(BaseDataClass):
+    """
+    合集（collection）信息。
+    """
+
+    slug: str = Field(
+        description=(
+            "Collection 唯一标识，格式 {owner}/{slug}。"
+            "新建为 {owner}/{title_slug}；历史为 {owner}/{title_slug}-{short_id}"
+        ),
+        pattern=COLLECTION_SLUG_PATTERN.pattern
+    )
+
+    title: Optional[str] = Field(
+        description="合集标题。",
+        default=None
+    )
+
+    description: Optional[str] = Field(
+        description="合集简介描述（Markdown）。",
+        default=None
+    )
+
+    owner: str = Field(
+        description="合集的所有者（用户名或组织名）。"
+    )
+
+    visibility: CollectionVisibility = Field(
+        description="可见性：public（公开）/ private（私有）。"
+    )
+
+    theme: CollectionTheme = Field(
+        description="合集页面主题样式标识。"
+    )
+
+    item_count: int = Field(
+        description="喜欢数。",
+        ge=0
+    )
+
+    likes: int = Field(
+        description="合集点赞数",
+        ge=0
+    )
+
+    view_count: int = Field(
+        description="浏览量。",
+        ge=0
+    )
+
+    items: list[CollectionItemInfo] = Field(
+        description="合集内部条目列表，数组元素为合集子项对象，为空时返回空列表",
+        default_factory=list
+    )
+
+    created_at: Optional[str] = Field(
+        description="合集创建时间，ISO‑8601格式UTC时间字符串。",
+        default=None
+    )
+
+    updated_at: Optional[str] = Field(
+        description="合集最后更新时间，ISO‑8601格式UTC时间字符串。",
+        default=None
+    )
+
+    url: str = Field(
+        description="合集网页访问完整URL地址。"
+    )
+
+    install_command: List[str] = Field(
+        description="当 items 包含 skill 时，返回下载命令数组。",
+        default_factory=list
+    )

modelscope_api/data_models/collection/collection_item.py

@@ -0,0 +1,92 @@
+"""
+合集（Collection）数据模型。
+"""
+
+from __future__ import annotations
+
+from enum import StrEnum
+from typing import Optional
+
+from pydantic import Field
+from pydantic.dataclasses import dataclass
+
+from ..base import BaseDataClass
+
+
+
+class CollectionItemType(StrEnum):
+    """
+    合集中的条目的资源类型。
+    """
+    MODEL = "model"
+    DATASET = "dataset"
+    STUDIO = "studio"
+    PAPER = "paper"
+    SKILL = "skill"
+    MCP = "mcp"
+
+
+class CollectionItemVisibility(StrEnum):
+    """
+    合集中的条目的可见性。
+    """
+    PUBLIC    = "public"    # 公开
+    PROTECTED = "protected" # 仅公开体验
+    PRIVATE   = "private"   # 私有
+
+
+@dataclass(frozen=True)
+class CollectionItemInfo(BaseDataClass):
+    """
+    合集中的条目信息。
+    """
+    item_type: CollectionItemType = Field(
+        description="资源类型：model / dataset / studio / paper / skill / mcp，用于定位"
+    )
+
+    item_object_id: str = Field(
+        description="资源标识，用于定位，如 damo/nlp_bert_base 或论文 ID"
+    )
+
+    note: Optional[str] = Field(
+        description="用户对该条目的备注说明（Markdown）。",
+        default=None
+    )
+
+    position: Optional[int] = Field(
+        description="排序位置（从 1 开始）。",
+        default=None,
+        ge=1
+    )
+
+    created_at: Optional[str] = Field(
+        description="添加时间，ISO 8601 UTC。",
+        default=None
+    )
+
+    visibility: Optional[CollectionItemVisibility] = Field(
+        description="可见性：public / protected / private。",
+        default=None
+    )
+
+    gated: Optional[bool] = Field(
+        description="visibility 为 public 时，是否需先申请并经同意后才可访问。",
+        default=None
+    )
+
+    protected_mode: Optional[int] = Field(
+        description=(
+            "protected（仅公开体验）模式标识；"
+            "用于表达条目/资源的仅公开体验语义，具体取值含义以产品后端实现为准（如 0=无、2=仅公开体验）。"
+        ),
+        default=None
+    )
+
+    reason: Optional[str] = Field(
+        description=(
+            "失败原因错误码，如 ResourceNotFound, ItemAlreadyInCollection, "
+            "ItemNotInCollection, PermissionDenied。"
+            "仅当添加或更新条目失败时有效。"
+        ),
+        default=None
+    )

modelscope_api/data_models/magicube/__init__.py

@@ -0,0 +1,5 @@
+"""
+与魔粒（Magicube）有关的数据模型。
+"""
+
+from .magicube_blance import MagicubeBalanceInfo

modelscope_api/data_models/magicube/magicube_blance.py

@@ -0,0 +1,31 @@
+"""
+魔粒余额数据模型。
+"""
+
+from pydantic import Field
+from pydantic.dataclasses import dataclass
+
+from ...utils.typing import Real
+from ..base import BaseDataClass
+
+
+
+@dataclass(frozen=True)
+class MagicubeBalanceInfo(BaseDataClass):
+    """
+    魔粒余额信息。
+    """
+    total_balance: Real = Field(
+        description="总额度（可用额度 + 预扣额度）",
+        ge=0
+    )
+
+    available_balance: Real = Field(
+        description="可用额度",
+        ge=0
+    )
+
+    frozen_amount: Real = Field(
+        description="预扣额度（进行中任务未返回结果时预扣减）",
+        ge=0
+    )

modelscope_api/data_models/studio/__init__.py

@@ -0,0 +1,13 @@
+"""
+与创空间（Studio）有关的数据模型。
+"""
+
+from .base_image import BaseImageInfo
+from .environment_variable import EnvironmentVariableInfo, EnvironmentVariableType
+from .hardware import HardwareInfo
+from .logs import LogsInfo, LogsType
+from .sdk import SDKType, SDKVersionInfo
+from .studio import (
+	StudioActiveConfig, StudioRuntimeStatus, StudioRuntimeInfo,
+	StudioVisibility, StudioInfo
+)

modelscope_api/data_models/studio/base_image.py

@@ -0,0 +1,26 @@
+"""
+基础镜像数据模型。
+"""
+
+from typing import Optional
+
+from pydantic import Field
+from pydantic.dataclasses import dataclass
+
+from ..base import BaseDataClass
+
+
+
+@dataclass(frozen=True)
+class BaseImageInfo(BaseDataClass):
+    """
+    基础镜像信息。
+    """
+    name: str = Field(
+        description="镜像名称，例如 ubuntu22.04-py311-torch2.9.1-modelscope1.35.0。"
+    )
+
+    tag: Optional[str] = Field(
+        description="标签，例如 latest",
+        default=None
+    )

modelscope_api/data_models/studio/environment_variable.py

@@ -0,0 +1,38 @@
+"""
+环境变量数据模型。
+"""
+
+from enum import StrEnum
+from typing import Optional
+
+from pydantic import Field
+from pydantic.dataclasses import dataclass
+
+from ..base import BaseDataClass
+
+
+
+class EnvironmentVariableType(StrEnum):
+    """
+    环境变量类型。
+    """
+    # 明文变量
+    VARIABLE = "variable"
+
+    # 密文变量
+    SECRET = "secret"
+
+
+@dataclass(frozen=True)
+class EnvironmentVariableInfo(BaseDataClass):
+    """
+    环境变量信息。
+    """
+    key: str = Field(
+        description="变量名称。"
+    )
+
+    value: Optional[str] = Field(
+        description="变量值。密文变量为 None。",
+        default=None
+    )

modelscope_api/data_models/studio/hardware.py

@@ -0,0 +1,87 @@
+"""
+硬件数据模型。
+"""
+
+from typing import List, Literal, Optional
+
+from pydantic import Field
+from pydantic.dataclasses import dataclass
+
+from ..base import BaseDataClass
+
+
+
+@dataclass(frozen=True)
+class HardwareInfo(BaseDataClass):
+    """
+    硬件资源配置详细信息，用于描述运行环境的具体规格、库存及成本。
+    """
+    name: str = Field(
+        description="OpenAPI hardware 参数值。付费资源格式为 paid/<InstanceType>。"
+    )
+
+    resource_type: Literal["free", "paid"] = Field(
+        description="资源类型，free 表示平台免费资源，paid 表示使用用户自己的云账号付费部署。"
+    )
+
+    instance_type: Optional[str] = Field(
+        description="ECS 规格名，仅付费资源返回，例如 ecs.gn7i-c8g1.2xlarge。",
+        default=None
+    )
+
+    cpu: Optional[int] = Field(
+        description="CPU 核数，仅付费资源返回",
+        default=None,
+        ge=0
+    )
+
+    gpu: Optional[int] = Field(
+        description="GPU 数量，仅付费资源返回",
+        default=None,
+        ge=0
+    )
+
+    memory: Optional[int] = Field(
+        description="内存大小（GB），仅付费资源返回",
+        default=None,
+        ge=0
+    )
+
+    gpu_type: Optional[str] = Field(
+        description="GPU 类型，仅付费资源返回，如 NVIDIA A100、V100 等",
+        default=None
+    )
+
+    gpu_memory: Optional[int] = Field(
+        description="显存（GB），仅付费资源返回",
+        default=None,
+        ge=0
+    )
+
+    supported_sdk_types: List[str] = Field(
+        description="该硬件所支持的 SDK 类型列表，例如 ['gradio', 'streamlit']",
+        default_factory=list
+    )
+
+    has_stock: Optional[bool] = Field(
+        description="是否有库存，仅付费资源返回",
+        default=None
+    )
+
+    stock: Optional[int] = Field(
+        description="库存数量",
+        default=None,
+        ge=0
+    )
+
+    cost_after_discount: Optional[float] = Field(
+        description="折后价格，仅付费资源返回",
+        default=None,
+        ge=0.0
+    )
+
+    original_cost: Optional[float] = Field(
+        description="原价，仅付费资源返回",
+        default=None,
+        ge=0.0
+    )

modelscope_api/data_models/studio/logs.py

@@ -0,0 +1,54 @@
+"""
+日志数据模型。
+"""
+
+from enum import StrEnum
+from typing import List
+
+from pydantic import Field
+from pydantic.dataclasses import dataclass
+
+from ..base import BaseDataClass
+
+
+
+class LogsType(StrEnum):
+    """
+    日志类型。
+    """
+    BUILD = "build"
+    RUN = "run"
+
+
+@dataclass(frozen=True)
+class LogsInfo(BaseDataClass):
+    """
+    日志信息。
+    """
+    logs: List[str] = Field(
+        description="日志内容，每行为一条日志。",
+        default_factory=list
+    )
+
+    page_num: int = Field(
+        description="页码。",
+        default=1,
+        ge=1
+    )
+
+    page_size: int = Field(
+        description="每页的日志条数。",
+        default=100,
+        ge=1,
+        le=500
+    )
+
+    total_count: int = Field(
+        description="日志总数。",
+        ge=0
+    )
+
+    total_page_num: int = Field(
+        description="页面总数。",
+        ge=0
+    )

modelscope_api/data_models/studio/sdk.py

@@ -0,0 +1,41 @@
+"""
+SDK 版本数据模型。
+"""
+
+from enum import StrEnum
+from typing import Optional
+
+from pydantic import Field
+from pydantic.dataclasses import dataclass
+
+from ..base import BaseDataClass
+
+
+
+class SDKType(StrEnum):
+    """
+    创空间 SDK 类型。
+    """
+    GRADIO = "gradio"
+    STREAMLIT = "streamlit"
+    DOCKER = "docker"
+    STATIC = "static"
+
+
+@dataclass(frozen=True)
+class SDKVersionInfo(BaseDataClass):
+    """
+    SDK 版本信息。
+    """
+    sdk_type: SDKType = Field(
+        description="SDK 类型"
+    )
+
+    tag: Optional[str] = Field(
+        description="版本标签",
+        default=None
+    )
+
+    version: str = Field(
+        description="SDK 版本"
+    )