Tool Reference

Jobs & Reporting

Monitor, recover, and analyze your processing pipelines. Generate detailed dataset reports with class distributions and annotation statistics, poll async job progress in real-time, and retry operations that encountered failures. Most compute tools return a job_id that you can poll with these tools.

How async jobs work

Submit

Call a processing tool (merge, export, ingest, augment). It returns immediately with a job_id.

Poll

Use get_processing_status with the job_id to check progress. The assistant does this automatically.

Complete

When status is "completed", your artifact (dataset, export file, report) is ready to use.

report_dataset

Instant / Async

Generate a comprehensive report for a dataset. By default reads from cached analysis (instant). Set recompute to true to trigger a fresh analysis job on serverless GPU infrastructure.

Parameters

dataset_namestring

Name of the dataset to report on.

Required

branch_namestring

Branch to analyze. Defaults to "main".

Optional

recomputeboolean

Set true to trigger a fresh analysis instead of reading cache.

Optional

Returns

Dataset report with class distribution, split breakdown, image dimensions, annotation statistics, and storage usage. When recompute is true, returns a job ID instead.

Example prompt

“Show me a report for my "retail-detection" dataset”

get_processing_status

Instant

Get the current status of any processing job. Returns state, progress percentage, and result data when complete. Use this to poll jobs returned by merge, export, ingest, augment, and other async tools.

Parameters

job_idstring

The job ID returned by any async tool.

Required

Returns

Job status object with fields: state ("pending", "running", "completed", "failed"), progress (0–100), and result data when state is "completed".

Example prompt

“Is the merge job finished yet?”

retry_job

Async Job

Retry a failed job or resume a paused job. Paused jobs resume from their last checkpoint; failed jobs restart fresh with the same parameters.

Parameters

job_idstring

The job ID to retry or resume.

Required

Returns

New job ID for tracking. The retry inherits all original parameters.

Example prompt

“That export job failed — please retry it”

Job states

pendingJob is queued and waiting for a worker.

runningJob is actively processing. Progress percentage is available.

completedJob finished successfully. Result data is attached.

failedJob encountered an error. Use retry_job to resubmit.