superb-ai-onprem 0.1.6__py3-none-any.whl → 0.2.0__py3-none-any.whl

spb_onprem/__init__.py

@@ -7,6 +7,7 @@ except ImportError:
 from .datasets.service import DatasetService
 from .data.service import DataService
 from .slices.service import SliceService
+from .activities.service import ActivityService
 
 # Core Entities and Enums
 from .entities import (
@@ -19,12 +20,17 @@ from .entities import (
     DataMeta,
     Dataset,
     Slice,
-    
+    Activity,
+    ActivityHistory,
+
     # Enums
     DataType,
     SceneType,
     DataMetaTypes,
     DataMetaValue,
+    ActivityStatus,
+    ActivitySchema,
+    SchemaType,
 )
 
 # Filters
@@ -36,6 +42,8 @@ from .searches import (
     DatasetsFilterOptions,
     SlicesFilter,
     SlicesFilterOptions,
+    ActivitiesFilter,
+    ActivitiesFilterOptions,
 )
 
 __all__ = (
@@ -43,7 +51,8 @@ __all__ = (
     "DatasetService",
     "DataService",
     "SliceService",
-    
+    "ActivityService",
+
     # Core Entities
     "Data",
     "Scene",
@@ -53,12 +62,17 @@ __all__ = (
     "DataMeta",
     "Dataset",
     "Slice",
+    "Activity",
+    "ActivityHistory",
     
     # Enums
     "DataType",
     "SceneType",
     "DataMetaTypes",
     "DataMetaValue",
+    "ActivityStatus",
+    "ActivitySchema",
+    "SchemaType",
     
     # Filters
     "AnnotationFilter",
@@ -68,4 +82,6 @@ __all__ = (
     "DatasetsFilterOptions",
     "SlicesFilter",
     "SlicesFilterOptions",
+    "ActivitiesFilter",
+    "ActivitiesFilterOptions",
 )

spb_onprem/_version.py

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

spb_onprem/activities/entities/__init__.py

@@ -0,0 +1,10 @@
+from .activity import Activity, ActivitySchema, SchemaType
+from .activity_history import ActivityHistory, ActivityStatus
+
+__all__ = (
+    "Activity",
+    "ActivityHistory",
+    "ActivityStatus",
+    "SchemaType",
+    "ActivitySchema",
+)

spb_onprem/activities/entities/activity.py

@@ -0,0 +1,39 @@
+from typing import Optional, List, Any
+from enum import Enum
+from spb_onprem.base_model import CustomBaseModel, Field
+
+
+class SchemaType(str, Enum):
+    STRING = "String"
+    NUMBER = "Number"
+    BOOLEAN = "Boolean"
+    JSON_OBJECT = "JSONObject"
+    DATETIME = "DateTime"
+
+
+class ActivitySchema(CustomBaseModel):
+    key: Optional[str] = None
+    schema_type: Optional[SchemaType] = None
+    required: Optional[bool] = None
+    default: Optional[Any] = None
+
+
+class Activity(CustomBaseModel):
+    id: Optional[str] = Field(None, alias="id")
+    dataset_id: Optional[str] = Field(None, alias="datasetId")
+    
+    name: Optional[str] = Field(None, alias="name")
+    description: Optional[str] = Field(None, alias="description")
+    activity_type: Optional[str] = Field(None, alias="type")
+    
+    progress_schema: Optional[List[ActivitySchema]] = Field(None, alias="progressSchema")
+    parameter_schema: Optional[List[ActivitySchema]] = Field(None, alias="parameterSchema")
+    
+    settings: Optional[dict] = Field(None, alias="settings")
+    
+    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")

spb_onprem/activities/entities/activity_history.py

@@ -0,0 +1,31 @@
+from typing import Optional, Any
+from enum import Enum
+from spb_onprem.base_model import CustomBaseModel, Field
+
+
+class ActivityStatus(str, Enum):
+    PENDING = "PENDING"
+    RUNNING = "RUNNING"
+    SUCCESS = "SUCCESS"
+    FAILED = "FAILED"
+    CANCELLED = "CANCELLED"
+
+
+class ActivityHistory(CustomBaseModel):
+    """
+    The activity history.
+    """
+    id: Optional[str] = Field(None, alias="id")
+    dataset_id: Optional[str] = Field(None, alias="datasetId")
+    activity_id: Optional[str] = Field(None, alias="jobId")
+    status: Optional[ActivityStatus] = Field(None, alias="status")
+    
+    parameters: Optional[Any] = Field(None, alias="parameters")
+    progress: Optional[Any] = Field(None, alias="progress")
+    
+    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")

spb_onprem/activities/params/__init__.py

@@ -0,0 +1,23 @@
+from .activities import (
+    ActivitiesFilter,
+    ActivitiesFilterOptions,
+    get_activities_params,
+)
+from .activity import get_activity_params
+from .create_activity import create_activity_params
+from .update_activity import update_activity_params
+from .delete_activity import delete_activity_params
+from .start_activity import start_activity_params
+from .update_activity_history import update_activity_history_params
+
+__all__ = (
+    "ActivitiesFilter",
+    "ActivitiesFilterOptions",
+    "get_activities_params",
+    "get_activity_params",
+    "create_activity_params",
+    "update_activity_params",
+    "delete_activity_params",
+    "start_activity_params",
+    "update_activity_history_params",
+)

spb_onprem/activities/params/activities.py

@@ -0,0 +1,53 @@
+from typing import (
+    Union,
+    Optional,
+    List,
+)
+
+from spb_onprem.base_model import CustomBaseModel, Field
+from spb_onprem.base_types import Undefined, UndefinedType
+
+
+class ActivitiesFilterOptions(CustomBaseModel):
+    """Options for filtering activities.
+    
+    """
+    id_in: Optional[List[str]] = Field(None, alias="idIn")
+    name_contains: Optional[str] = Field(None, alias="nameContains")
+    dataset_id_in: Optional[List[str]] = Field(None, alias="datasetIdIn")
+    type_in: Optional[List[str]] = Field(None, alias="typeIn")
+
+
+class ActivitiesFilter(CustomBaseModel):
+    """Filter criteria for activity queries.
+    
+    Attributes:
+        must_filter: Conditions that must be met
+        not_filter: Conditions that must not be met
+    """
+    must_filter: Optional[ActivitiesFilterOptions] = Field(None, alias="must")
+    not_filter: Optional[ActivitiesFilterOptions] = Field(None, alias="not")
+
+
+def get_activities_params(
+    dataset_id: str,
+    activity_filter: Union[
+        UndefinedType,
+        ActivitiesFilter,
+    ] = Undefined,
+    cursor: Optional[str] = None,
+    length: Optional[int] = 10
+):
+    """Get the params for the activities query.
+    
+    """
+    params = {
+        "datasetId": dataset_id,
+        "cursor": cursor,
+        "length": length,
+    }
+    if activity_filter is not Undefined and activity_filter is not None:
+        params["filter"] = activity_filter.model_dump(
+            by_alias=True, exclude_unset=True
+        )
+    return params

spb_onprem/activities/params/activity.py

@@ -0,0 +1,42 @@
+from typing import Union, Optional
+
+from spb_onprem.base_types import Undefined, UndefinedType
+from spb_onprem.exceptions import BadParameterError
+
+
+def get_activity_params(
+    activity_id: Optional[str] = None,
+    activity_name: Optional[str] = None,
+    dataset_id: Union[
+        UndefinedType,
+        str
+    ] = Undefined,
+):
+    """Create parameters for getting an activity.
+    
+    Args:
+        activity_id (str): The ID of the activity to get.
+        dataset_id (Optional[str]): The ID of the dataset to get the activity for.
+        
+    Returns:
+        dict: Parameters for getting an activity
+        
+    Raises:
+        BadParameterError: If activity_id is missing
+    """
+    if activity_id is None and activity_name is None:
+        raise BadParameterError("Activity ID or name is required")
+
+    params = {
+    }
+
+    if activity_id is not None:
+        params["id"] = activity_id
+
+    if activity_name is not None:
+        params["name"] = activity_name
+
+    if dataset_id is not Undefined:
+        params["datasetId"] = dataset_id
+
+    return params

spb_onprem/activities/params/create_activity.py

@@ -0,0 +1,80 @@
+from typing import Union, List
+
+from spb_onprem.base_types import Undefined, UndefinedType
+from spb_onprem.activities.entities import ActivitySchema
+from spb_onprem.exceptions import BadParameterError
+
+def create_activity_params(
+    activity_type: str,
+    name: str,
+    dataset_id: Union[
+        UndefinedType,
+        str
+    ] = Undefined,
+    description: Union[
+        UndefinedType,
+        str
+    ] = Undefined,
+    progress_schema: Union[
+        UndefinedType,
+        List[ActivitySchema]
+    ] = Undefined,
+    parameter_schema: Union[
+        UndefinedType,
+        List[ActivitySchema]
+    ] = Undefined,
+    settings: Union[
+        UndefinedType,
+        dict
+    ] = Undefined,
+    meta: Union[
+        UndefinedType,
+        dict
+    ] = Undefined,
+):
+    """Create parameters for activity creation.
+    
+    Args:
+        activity_type (str): The type of the activity to create.
+        name (str): The name of the activity to create.
+        dataset_id (Optional[str]): The ID of the dataset to create the activity for.
+        description (Optional[str]): The description of the activity to create.
+        progress_schema (Optional[List[ActivitySchema]]): The progress schema of the activity to create.
+        parameter_schema (Optional[List[ActivitySchema]]): The parameter schema of the activity to create.
+        settings (Optional[dict]): The settings of the activity to create.
+        meta (Optional[dict]): The meta of the activity to create.
+        
+    Returns:
+        dict: Parameters for activity creation
+        
+    Raises:
+        BadParameterError: If activity_type is not provided
+    """
+    if activity_type is None:
+        raise BadParameterError("Activity type is required")
+    if name is None:
+        raise BadParameterError("Activity name is required")
+
+    params = {
+        "datasetId": None,
+        "name": name,
+        "description": None,
+        "progressSchema": None,
+        "parameterSchema": None,
+        "type": activity_type,
+        "settings": None,
+        "meta": None,
+    }
+    if dataset_id is not Undefined:
+        params["datasetId"] = dataset_id
+    if description is not Undefined:
+        params["description"] = description
+    if progress_schema is not Undefined:
+        params["progressSchema"] = progress_schema
+    if parameter_schema is not Undefined:
+        params["parameterSchema"] = parameter_schema
+    if settings is not Undefined:
+        params["settings"] = settings
+    if meta is not Undefined:
+        params["meta"] = meta
+    return params

spb_onprem/activities/params/delete_activity.py

@@ -0,0 +1,23 @@
+from spb_onprem.exceptions import BadParameterError
+
+def delete_activity_params(
+    activity_id: str,
+):
+    """Create parameters for activity deletion.
+    
+    Args:
+        activity_id (str): The ID of the activity to delete.
+        
+    Returns:
+        dict: Parameters for activity deletion
+        
+    Raises:
+        BadParameterError: If activity_id is None
+    """
+    if activity_id is None:
+        raise BadParameterError("Activity ID is required")
+
+    params = {
+        "id": activity_id,
+    }
+    return params

spb_onprem/activities/params/start_activity.py

@@ -0,0 +1,59 @@
+from typing import Optional, Union
+
+from spb_onprem.base_types import Undefined, UndefinedType
+from spb_onprem.exceptions import BadParameterError
+
+
+def start_activity_params(
+    dataset_id: str,
+    activity_id: Optional[str] = None,
+    activity_type: Optional[str] = None,
+    parameters: Union[
+        UndefinedType,
+        dict
+    ] = Undefined,
+    progress: Union[
+        UndefinedType,
+        dict
+    ] = Undefined,
+    meta: Union[
+        UndefinedType,
+        dict
+    ] = Undefined,
+) -> dict:
+    """Create parameters for starting an activity.
+    
+    Args:
+        dataset_id (str): The ID of the dataset to start the activity for.
+        activity_id (Optional[str]): The ID of the activity to start.
+        activity_type (Optional[str]): The type of the activity to start.
+        parameters (Optional[dict]): The parameters to start the activity with.
+        progress (Optional[dict]): The progress to start the activity with.
+        meta (Optional[dict]): The meta information to start the activity with.
+        
+    Returns:
+        dict: Parameters for starting an activity
+        
+    Raises:
+        BadParameterError: If neither activity_id nor activity_type is provided
+    """
+    if activity_id is None and activity_type is None:
+        raise BadParameterError("Either activity_id or activity_type must be provided")
+
+    params = {
+        "datasetId": dataset_id,
+    }
+
+    if activity_id is not None:
+        params["id"] = activity_id
+    else:
+        params["jobType"] = activity_type
+
+    if parameters is not Undefined:
+        params["parameters"] = parameters
+    if progress is not Undefined:
+        params["progress"] = progress
+    if meta is not Undefined:
+        params["meta"] = meta
+
+    return params

spb_onprem/activities/params/update_activity.py

@@ -0,0 +1,79 @@
+from typing import Union, List
+
+from spb_onprem.base_types import Undefined, UndefinedType
+from spb_onprem.exceptions import BadParameterError
+from spb_onprem.activities.entities import ActivitySchema
+
+def update_activity_params(
+    activity_id: str,
+    activity_type: Union[
+        str,
+        UndefinedType
+    ] = Undefined,
+    name: Union[
+        str,
+        UndefinedType
+    ] = Undefined,
+    description: Union[
+        UndefinedType,
+        str
+    ] = Undefined,
+    progress_schema: Union[
+        UndefinedType,
+        List[ActivitySchema]
+    ] = Undefined,
+    parameter_schema: Union[
+        UndefinedType,
+        List[ActivitySchema]
+    ] = Undefined,
+    settings: Union[
+        UndefinedType,
+        dict
+    ] = Undefined,
+    meta: Union[
+        UndefinedType,
+        dict
+    ] = Undefined,
+):
+    """Create parameters for activity update.
+    
+    Args:
+        activity_id (str): The ID of the activity to update.
+        activity_type (Optional[str]): The type of the activity to update.
+        name (Optional[str]): The name of the activity to update.
+        dataset_id (Optional[str]): The ID of the dataset to update the activity for.
+        description (Optional[str]): The description of the activity to update.
+        progress_schema (Optional[List[ActivitySchema]]): The progress schema of the activity to update.
+        parameter_schema (Optional[List[ActivitySchema]]): The parameter schema of the activity to update.
+        settings (Optional[dict]): The settings of the activity to update.
+        meta (Optional[dict]): The meta of the activity to update.
+        
+    Returns:
+        dict: Parameters for activity update
+        
+    Raises:
+        BadParameterError: If activity_id is not provided
+    """
+    if activity_id is None:
+        raise BadParameterError("Activity ID is required")
+
+    params = {
+        "id": activity_id
+    }
+
+    if activity_type is not Undefined:
+        params["type"] = activity_type
+    if name is not Undefined:
+        params["name"] = name
+    if description is not Undefined:
+        params["description"] = description
+    if progress_schema is not Undefined:
+        params["progressSchema"] = progress_schema
+    if parameter_schema is not Undefined:
+        params["parameterSchema"] = parameter_schema
+    if settings is not Undefined:
+        params["settings"] = settings
+    if meta is not Undefined:
+        params["meta"] = meta
+
+    return params

spb_onprem/activities/params/update_activity_history.py

@@ -0,0 +1,54 @@
+from typing import Union
+
+from spb_onprem.base_types import Undefined, UndefinedType
+from spb_onprem.exceptions import BadParameterError
+from spb_onprem.activities.entities import ActivityStatus
+
+
+def update_activity_history_params(
+    activity_history_id: str,
+    status: Union[
+        UndefinedType,
+        ActivityStatus
+    ] = Undefined,
+    progress: Union[
+        UndefinedType,
+        dict
+    ] = Undefined,
+    meta: Union[
+        UndefinedType,
+        dict
+    ] = Undefined,
+) -> dict:
+    """Create parameters for updating an activity history.
+    
+    Args:
+        activity_history_id (str): The ID of the activity history to update.
+        status (Optional[ActivityStatus]): The status to update the activity to.
+        progress (Optional[dict]): The progress to update the activity with.
+        meta (Optional[dict]): The meta information to update with.
+        
+    Returns:
+        dict: Parameters for updating activity history
+        
+    Raises:
+        BadParameterError: If activity_history_id is not provided or if neither status nor progress is provided
+    """
+    if activity_history_id is None:
+        raise BadParameterError("Activity history ID is required")
+    
+    if status is Undefined and progress is Undefined:
+        raise BadParameterError("Either status or progress must be provided")
+
+    params = {
+        "id": activity_history_id,
+    }
+    
+    if status is not Undefined:
+        params["status"] = status
+    if progress is not Undefined:
+        params["progress"] = progress
+    if meta is not Undefined:
+        params["meta"] = meta
+
+    return params