superb-ai-onprem 0.2.0__tar.gz → 0.3.1__tar.gz

{superb_ai_onprem-0.2.0/superb_ai_onprem.egg-info → superb_ai_onprem-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: superb-ai-onprem
-Version: 0.2.0
+Version: 0.3.1
 Summary: Python SDK for Superb AI On-premise
 Home-page: https://github.com/Superb-AI-Suite/superb-ai-onprem-python
 Author: Superb AI

{superb_ai_onprem-0.2.0 → superb_ai_onprem-0.3.1}/spb_onprem/__init__.py

@@ -8,6 +8,7 @@ from .datasets.service import DatasetService
 from .data.service import DataService
 from .slices.service import SliceService
 from .activities.service import ActivityService
+from .exports.service import ExportService
 
 # Core Entities and Enums
 from .entities import (
@@ -22,6 +23,7 @@ from .entities import (
     Slice,
     Activity,
     ActivityHistory,
+    Export,
 
     # Enums
     DataType,
@@ -44,6 +46,8 @@ from .searches import (
     SlicesFilterOptions,
     ActivitiesFilter,
     ActivitiesFilterOptions,
+    ExportFilter,
+    ExportFilterOptions,
 )
 
 __all__ = (
@@ -52,6 +56,7 @@ __all__ = (
     "DataService",
     "SliceService",
     "ActivityService",
+    "ExportService",
 
     # Core Entities
     "Data",
@@ -64,7 +69,7 @@ __all__ = (
     "Slice",
     "Activity",
     "ActivityHistory",
-    
+    "Export",
     # Enums
     "DataType",
     "SceneType",
@@ -84,4 +89,6 @@ __all__ = (
     "SlicesFilterOptions",
     "ActivitiesFilter",
     "ActivitiesFilterOptions",
+    "ExportFilter",
+    "ExportFilterOptions",
 )

{superb_ai_onprem-0.2.0 → superb_ai_onprem-0.3.1}/spb_onprem/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.2.0'
-__version_tuple__ = version_tuple = (0, 2, 0)
+__version__ = version = '0.3.1'
+__version_tuple__ = version_tuple = (0, 3, 1)

{superb_ai_onprem-0.2.0 → superb_ai_onprem-0.3.1}/spb_onprem/data/enums/data_type.py

@@ -6,4 +6,5 @@ class DataType(str, Enum):
     The type of the data.
     This is used to determine the type of the data.
     """
-    SUPERB_IMAGE = "SUPERB_IMAGE"
+    SUPERB_IMAGE = "SUPERB_IMAGE"
+    MCAP = "MCAP"

{superb_ai_onprem-0.2.0 → superb_ai_onprem-0.3.1}/spb_onprem/entities.py

@@ -21,6 +21,7 @@ from .activities.entities import (
     ActivitySchema,
     SchemaType,
 )
+from .exports.entities import Export
 
 __all__ = [
     # Core Entities
@@ -34,7 +35,8 @@ __all__ = [
     "Slice",
     "Activity",
     "ActivityHistory",
-    
+    "Export",
+
     # Enums
     "DataType",
     "SceneType",

superb_ai_onprem-0.3.1/spb_onprem/exports/__init__.py

@@ -0,0 +1,9 @@
+from .service import ExportService
+from .entities import Export
+from .params import ExportFilterOptions
+
+__all__ = (
+    "ExportService",
+    "Export",
+    "ExportFilterOptions",
+) 

superb_ai_onprem-0.3.1/spb_onprem/exports/entities/__init__.py

@@ -0,0 +1,7 @@
+from .export import Export
+
+__all__ = (
+    "Export",
+    "ExportStatus",
+    "ExportType",
+) 

superb_ai_onprem-0.3.1/spb_onprem/exports/entities/export.py

@@ -0,0 +1,27 @@
+from typing import Optional, Any
+from spb_onprem.base_model import CustomBaseModel, Field
+from spb_onprem.data.params import DataListFilter
+
+
+class Export(CustomBaseModel):
+    """
+    The export entity.
+    """
+    id: str = Field(..., alias="id")
+    dataset_id: str = Field(..., alias="datasetId")
+    
+    name: Optional[str] = Field(None, alias="name")
+    data_filter: Optional[DataListFilter] = Field(None, alias="dataFilter")
+    location: Optional[str] = Field(None, alias="location")
+    
+    data_count: Optional[int] = Field(None, alias="dataCount")
+    annotation_count: Optional[int] = Field(None, alias="annotationCount")
+    frame_count: Optional[int] = Field(None, alias="frameCount")
+    
+    meta: Optional[dict] = Field(None, alias="meta")
+    
+    created_at: Optional[str] = Field(None, alias="createdAt")
+    created_by: Optional[str] = Field(None, alias="createdBy")
+    updated_at: Optional[str] = Field(None, alias="updatedAt")
+    updated_by: Optional[str] = Field(None, alias="updatedBy")
+    completed_at: Optional[str] = Field(None, alias="completedAt") 

superb_ai_onprem-0.3.1/spb_onprem/exports/params/__init__.py

@@ -0,0 +1,19 @@
+from .exports import (
+    ExportFilter,
+    ExportFilterOptions,
+    get_exports_params,
+)
+from .export import get_export_params
+from .create_export import create_export_params
+from .delete_export import delete_export_params
+from .update_export import update_export_params
+
+__all__ = (
+    "ExportFilter",
+    "ExportFilterOptions",
+    "get_exports_params",
+    "get_export_params",
+    "create_export_params",
+    "delete_export_params",
+    "update_export_params",
+) 

superb_ai_onprem-0.3.1/spb_onprem/exports/params/create_export.py

@@ -0,0 +1,85 @@
+from typing import Union
+
+from spb_onprem.base_types import Undefined, UndefinedType
+from spb_onprem.exceptions import BadParameterError
+from spb_onprem.data.params import DataListFilter
+
+
+def create_export_params(
+    dataset_id: str,
+    location: Union[
+        UndefinedType,
+        str
+    ] = Undefined,
+    name: Union[
+        UndefinedType,
+        str
+    ] = Undefined,
+    data_filter: Union[
+        UndefinedType,
+        DataListFilter,
+        dict
+    ] = Undefined,
+    data_count: Union[
+        UndefinedType,
+        int
+    ] = Undefined,
+    frame_count: Union[
+        UndefinedType,
+        int
+    ] = Undefined,
+    annotation_count: Union[
+        UndefinedType,
+        int
+    ] = Undefined,
+    meta: Union[
+        UndefinedType,
+        dict
+    ] = Undefined,
+):
+    """Create parameters for export creation.
+    
+    Args:
+        dataset_id (str): The ID of the dataset to create the export for.
+        location (Optional[str]): The location where the export will be stored.
+        name (Optional[str]): The name of the export.
+        data_filter (Optional[DataListFilter | dict]): The search filter of the data.
+        data_count (Optional[int]): The number of data items to export.
+        frame_count (Optional[int]): The number of frames to export.
+        annotation_count (Optional[int]): The number of annotations to export.
+        meta (Optional[dict]): The meta information for the export.
+        
+    Returns:
+        dict: Parameters for export creation
+        
+    Raises:
+        BadParameterError: If required parameters are missing
+    """
+    if dataset_id is None:
+        raise BadParameterError("Dataset ID is required")
+
+    params = {
+        "dataset_id": dataset_id,
+    }
+
+    if location is not Undefined:
+        params["location"] = location
+    if name is not Undefined:
+        params["name"] = name
+    if data_filter is not Undefined and data_filter is not None:
+        # Handle both DataListFilter objects and plain dicts
+        if isinstance(data_filter, DataListFilter):
+            params["data_filter"] = data_filter.model_dump(by_alias=True, exclude_unset=True)
+        else:
+            # Assume it's a dict and use it directly
+            params["data_filter"] = data_filter
+    if data_count is not Undefined:
+        params["data_count"] = data_count
+    if frame_count is not Undefined:
+        params["frame_count"] = frame_count
+    if annotation_count is not Undefined:
+        params["annotation_count"] = annotation_count
+    if meta is not Undefined:
+        params["meta"] = meta
+
+    return params 

superb_ai_onprem-0.3.1/spb_onprem/exports/params/delete_export.py

@@ -0,0 +1,30 @@
+from spb_onprem.exceptions import BadParameterError
+
+
+def delete_export_params(
+    dataset_id: str,
+    export_id: str,
+):
+    """Create parameters for export deletion.
+    
+    Args:
+        export_id (str): The ID of the export to delete.
+        
+    Returns:
+        dict: Parameters for export deletion
+        
+    Raises:
+        BadParameterError: If export_id is missing
+    """
+    if dataset_id is None:
+        raise BadParameterError("Dataset ID is required")
+
+    if export_id is None:
+        raise BadParameterError("Export ID is required")
+
+    params = {
+        "dataset_id": dataset_id,
+        "export_id": export_id,
+    }
+
+    return params

superb_ai_onprem-0.3.1/spb_onprem/exports/params/export.py

@@ -0,0 +1,30 @@
+from spb_onprem.exceptions import BadParameterError
+
+
+def get_export_params(
+    dataset_id: str,
+    export_id: str,
+):
+    """Create parameters for getting an export.
+    
+    Args:
+        export_id (str): The ID of the export to get.
+        dataset_id (Optional[str]): The ID of the dataset to get the export for.
+        slice_id (Optional[str]): The ID of the slice to get the export for.
+        
+    Returns:
+        dict: Parameters for getting an export
+        
+    Raises:
+        BadParameterError: If export_id is missing
+    """
+    if dataset_id is None:
+        raise BadParameterError("Dataset ID is required")
+
+    if export_id is None:
+        raise BadParameterError("Export ID is required")
+
+    return {
+        "dataset_id": dataset_id,
+        "export_id": export_id
+    } 

superb_ai_onprem-0.3.1/spb_onprem/exports/params/exports.py

@@ -0,0 +1,74 @@
+from typing import Optional, List, Union
+from spb_onprem.base_model import CustomBaseModel, Field
+from spb_onprem.base_types import Undefined, UndefinedType
+from spb_onprem.exceptions import BadParameterError
+
+
+class ExportFilterOptions(CustomBaseModel):
+    """Options for filtering exports.
+    
+    Attributes:
+        id_in: Filter exports by list of IDs
+        name_contains: Filter exports by name containing this string
+        name: Filter exports by exact name match
+        location_contains: Filter exports by location containing this string
+        location: Filter exports by exact location match
+    """
+    id_in: Optional[List[str]] = Field(None, alias="idIn")
+    name_contains: Optional[str] = Field(None, alias="nameContains")
+    name: Optional[str] = Field(None, alias="name")
+    location_contains: Optional[str] = Field(None, alias="locationContains")
+    location: Optional[str] = Field(None, alias="location")
+
+
+class ExportFilter(CustomBaseModel):
+    """Filter criteria for export queries.
+    
+    Attributes:
+        must_filter: Conditions that must be met
+        not_filter: Conditions that must not be met
+    """
+    must_filter: Optional[ExportFilterOptions] = Field(None, alias="must")
+    not_filter: Optional[ExportFilterOptions] = Field(None, alias="not")
+
+
+def get_exports_params(
+    dataset_id: str,
+    export_filter: Union[
+        UndefinedType,
+        ExportFilter
+    ] = Undefined,
+    cursor: Union[
+        UndefinedType,
+        str
+    ] = Undefined,
+    length: int = 10,
+):
+    """Create parameters for getting exports.
+    
+    Args:
+        dataset_id (str): The ID of the dataset to get exports for.
+        export_filter (Optional[ExportFilter]): The filter to apply to the exports.
+        cursor (Optional[str]): The cursor to use for pagination.
+        length (int): The number of exports to get.
+        
+    Returns:
+        dict: Parameters for getting exports
+        
+    Raises:
+        BadParameterError: If dataset_id is missing
+    """
+    if dataset_id is None:
+        raise BadParameterError("Dataset ID is required")
+
+    params = {
+        "dataset_id": dataset_id,
+        "length": length
+    }
+
+    if export_filter is not Undefined and export_filter is not None:
+        params["filter"] = export_filter.model_dump(by_alias=True, exclude_unset=True)
+    if cursor is not Undefined:
+        params["cursor"] = cursor
+
+    return params 

superb_ai_onprem-0.3.1/spb_onprem/exports/params/update_export.py

@@ -0,0 +1,98 @@
+from typing import Union
+from datetime import datetime
+
+from spb_onprem.base_types import Undefined, UndefinedType
+from spb_onprem.exceptions import BadParameterError
+from spb_onprem.data.params import DataListFilter
+
+
+def update_export_params(
+    dataset_id: str,
+    export_id: str,
+    location: Union[
+        UndefinedType,
+        str
+    ] = Undefined,
+    name: Union[
+        UndefinedType,
+        str
+    ] = Undefined,
+    data_filter: Union[
+        UndefinedType,
+        DataListFilter,
+        dict
+    ] = Undefined,
+    data_count: Union[
+        UndefinedType,
+        int
+    ] = Undefined,
+    frame_count: Union[
+        UndefinedType,
+        int
+    ] = Undefined,
+    annotation_count: Union[
+        UndefinedType,
+        int
+    ] = Undefined,
+    meta: Union[
+        UndefinedType,
+        dict
+    ] = Undefined,
+    completed_at: Union[
+        UndefinedType,
+        datetime
+    ] = Undefined,
+):
+    """Create parameters for export update.
+    
+    Args:
+        dataset_id (str): The ID of the dataset to update the export for.
+        export_id (str): The ID of the export to update.
+        location (Optional[str]): The location where the export will be stored.
+        name (Optional[str]): The name of the export.
+        data_filter (Optional[DataListFilter | dict]): The search filter of the data.
+        data_count (Optional[int]): The number of data items to export.
+        frame_count (Optional[int]): The number of frames to export.
+        annotation_count (Optional[int]): The number of annotations to export.
+        meta (Optional[dict]): The meta information for the export.
+        completed_at (Optional[datetime]): The completed time of the export.
+        
+    Returns:
+        dict: Parameters for export update
+        
+    Raises:
+        BadParameterError: If required parameters are missing
+    """
+    if dataset_id is None:
+        raise BadParameterError("Dataset ID is required")
+    if export_id is None:
+        raise BadParameterError("Export ID is required")
+
+    params = {
+        "dataset_id": dataset_id,
+        "export_id": export_id,
+    }
+
+    if location is not Undefined:
+        params["location"] = location
+    if name is not Undefined:
+        params["name"] = name
+    if data_filter is not Undefined and data_filter is not None:
+        # Handle both DataListFilter objects and plain dicts
+        if isinstance(data_filter, DataListFilter):
+            params["data_filter"] = data_filter.model_dump(by_alias=True, exclude_unset=True)
+        else:
+            # Assume it's a dict and use it directly
+            params["data_filter"] = data_filter
+    if data_count is not Undefined:
+        params["data_count"] = data_count
+    if frame_count is not Undefined:
+        params["frame_count"] = frame_count
+    if annotation_count is not Undefined:
+        params["annotation_count"] = annotation_count
+    if meta is not Undefined:
+        params["meta"] = meta
+    if completed_at is not Undefined:
+        params["completed_at"] = completed_at
+
+    return params 

superb_ai_onprem-0.3.1/spb_onprem/exports/queries/get_exports.py

@@ -0,0 +1,97 @@
+from typing import Union, Optional
+
+from spb_onprem.base_types import Undefined, UndefinedType
+from spb_onprem.graphql import build_query
+
+
+def get_exports_params(
+    dataset_id: str,
+    filter_params: Union[
+        UndefinedType,
+        dict
+    ] = Undefined,
+    order_by: Union[
+        UndefinedType,
+        dict
+    ] = Undefined,
+    cursor: Union[
+        UndefinedType,
+        str
+    ] = Undefined,
+    length: Union[
+        UndefinedType,
+        int
+    ] = Undefined,
+):
+    """Create parameters for getting exports.
+    
+    Args:
+        dataset_id (str): The ID of the dataset to get exports for.
+        filter_params (Optional[dict]): The filter to apply to the exports.
+        order_by (Optional[dict]): The order to return the exports in.
+        cursor (Optional[str]): The cursor to use for pagination.
+        length (Optional[int]): The number of exports to return.
+        
+    Returns:
+        dict: Parameters for getting exports
+    """
+    params = {
+        "datasetId": dataset_id,
+    }
+
+    if filter_params is not Undefined:
+        params["filter"] = filter_params
+    if order_by is not Undefined:
+        params["orderBy"] = order_by
+    if cursor is not Undefined:
+        params["cursor"] = cursor
+    if length is not Undefined:
+        params["length"] = length
+
+    return params
+
+
+def get_exports_query(params: dict) -> str:
+    """Build GraphQL query for getting exports.
+    
+    Args:
+        params (dict): Parameters for the query
+        
+    Returns:
+        str: GraphQL query
+    """
+    query = """
+        query GetExports(
+            $datasetId: String!
+            $filter: ExportFilter
+            $orderBy: ExportOrderBy
+            $cursor: String
+            $length: Int
+        ) {
+            exports(
+                datasetId: $datasetId
+                filter: $filter
+                orderBy: $orderBy
+                cursor: $cursor
+                length: $length
+            ) {
+                exports {
+                    id
+                    name
+                    location
+                    status
+                    dataFilter
+                    dataCount
+                    frameCount
+                    annotationCount
+                    meta
+                    createdAt
+                    completedAt
+                }
+                next
+                totalCount
+            }
+        }
+    """
+    
+    return build_query(query, params)