Type Definitions

Type definitions and data structures used throughout the SDK.

API Response Types

class moderatelyai_sdk.types.APIResponse[source]

Bases: TypedDict

Standard API response structure.

success: bool

data: Optional[Dict[str, Any]]

error: Optional[str]

message: Optional[str]

Pipeline Types

class moderatelyai_sdk.types.Pipeline[source]

Bases: TypedDict

Pipeline resource type - basic pipeline metadata.

pipelineId: str

teamId: str

name: str

description: Optional[str]

createdAt: Optional[str]

updatedAt: Optional[str]

lastRunAt: Optional[str]

totalRuns: float

successfulRuns: float

successRate: float

class moderatelyai_sdk.types.PipelineConfigurationVersion[source]

Bases: TypedDict

Pipeline configuration version resource type - contains the actual pipeline logic.

pipelineConfigurationVersionId: str

pipelineId: str

configuration: Dict[str, Any]

createdAt: Optional[str]

updatedAt: Optional[str]

status: Optional[str]

version: Optional[str]

class moderatelyai_sdk.types.PipelineExecution[source]

Bases: TypedDict

Pipeline execution resource type - runtime execution instances.

pipelineExecutionId: str

pipelineConfigurationVersionId: str

pipelineInput: Dict[str, Any]

pipelineInputSummary: str

pipelineOutput: Optional[Dict[str, Any]]

pipelineOutputSummary: Optional[str]

status: str

progressData: Dict[str, Any]

pipelineOutputFileUri: Optional[str]

currentStep: Optional[int]

totalSteps: Optional[int]

createdAt: Optional[str]

updatedAt: Optional[str]

startedAt: Optional[str]

completedAt: Optional[str]

failedAt: Optional[str]

cancelledAt: Optional[str]

pausedAt: Optional[str]

HTTP Types

moderatelyai_sdk.types.HTTPMethod: alias of Literal[‘GET’, ‘POST’, ‘PATCH’, ‘PUT’, ‘DELETE’]