Skip to main content

0.3.0

New: Python SDK​

Python SDK is now available on PyPI:

pip install modelhealth
from modelhealth import ModelHealthService

service = ModelHealthService(api_key="...")
sessions = service.list_sessions()

See the Python documentation for the full API reference.

New: Session Import​

Sessions can now be imported from a JSON activity export. The import workflow handles session creation, subject association, video transfer and processing for each activity and reports progress via a status callback.

Progress is delivered as ImportStatus values: CreatingSession, CreatedSession, UploadingVideo (with trial name and upload count) and Processing.

New: Activity type for automatic analysis​

startRecording now accepts an optional ActivityConfig containing an activity type. When provided, the corresponding analysis starts automatically once the recording is processed — no need to call startAnalysis separately.

Swift

let activity = try await service.startRecording(
    activityNamed: "cmj",
    in: session,
    config: ActivityConfig(activityType: .counterMovementJump)
)

TypeScript

const activity = await client.startRecording("cmj", session, {
    activityType: ActivityType.CounterMovementJump,
})

Python

activity = service.start_recording(
    "cmj", session, ActivityConfig(ActivityType.counter_movement_jump)
)

New: Archive Download​

Sessions can now be exported as a ZIP archive containing all activity data and, optionally, raw video files.

Swift

let archive = try await service.prepareArchive(for: session, withVideos: false)
// poll until ready
let data = try await service.archiveData(for: archive)

TypeScript

const archive = await service.prepareArchive(session, false)
// poll until ready
const data = await service.archiveData(archive)

Python

archive = service.prepare_archive(session, with_videos=False)
# poll until ready
data = service.archive_data(archive)

Use archive_status / archiveStatus to poll: the archive moves from Processing to Ready when the ZIP is available.

New: Session configuration​

Sessions can now be configured with capture settings before recording begins.

Swift

// All defaults
try await service.configure(session: session)

// Custom frame rate and data-sharing only
try await service.configure(session: session, config: SessionConfig(
    framerate: .fps60,
    dataSharing: .shareNoData
))

TypeScript

// All defaults
await service.configureSession(session, {})

// Custom frame rate and data-sharing only
await service.configureSession(session, {
    framerate: 60,
    dataSharing: "Share no data",
})

Python

# All defaults
service.configure_session(session)

# Custom frame rate and data-sharing only
service.configure_session(
    session,
    framerate=SessionFramerate.fps_60,
    data_sharing=SessionDataSharing.share_no_data,
)

create_session / createSession now automatically applies a default configuration — call configure_session afterwards to override any settings.

Breaking: activitiesForSubject now takes an integer ID instead of a string​

Getting activities for a subject previously accepted a raw string ID and now requires an integer.

SDKBeforeAfter
Swiftactivities(forSubject: "\(subject.id)")activities(forSubject: subject.id)
TypeScriptactivitiesForSubject("{subject.id}"")activitiesForSubject(subject.id)

Swift: SwiftUI preview support for Archive​

Archive conforms to the protocols needed to use it in SwiftUI previews.