Benchmark
HuggingFaceSync

Returns the HuggingFace sync status of the benchmark.

Changed on

The repo and outcome fields are null when the benchmark has never been synced; isUpToDate and pendingRunCount are always set. The stored export configuration (sampleMediaMode, segmentExports) is returned alongside the benchmark's availableSegments, so a configuration can be composed from what the prompt structure offers.

get/benchmark/{benchmarkId}/huggingface-sync

Request

  • Base URL
    https://api.rapidata.ai
  • URL
    https://api.rapidata.ai/benchmark/{benchmarkId}/huggingface-sync
  • Auth
    OpenID Connect (https://auth.rapidata.ai/.well-known/openid-configuration, scopes: openid, profile, email, offline_access, api)

Path parameters

benchmarkIdstring required

The id of the benchmark whose sync status to return.

Response

OK

status'NeverSynced' | 'Exporting' | 'Uploading' | 'Completed' | 'Failed' required
isUpToDateboolean required

Whether the dataset covers every completed run of the benchmark — a successful sync exists and no completed run is pending export. Always false when never synced.

pendingRunCountinteger required

Number of completed runs not yet exported to the HuggingFace dataset. Runs carried by an in-progress sync stay pending until that sync succeeds.

outcome'CreatedPrivate' | 'UpdatedPrivate' | 'OpenedPullRequest' | 'Failed' nullable

Result of the last completed HuggingFace sync attempt.

repoIdstring nullable

The target HuggingFace repo id (e.g. Rapidata/svg-benchmark), or null.

repoUrlstring nullable

URL of the HuggingFace repo, or null when not yet known.

prUrlstring nullable

URL of the review pull request opened by the last attempt, or null.

lastSyncedAtstring date-time nullable

When the benchmark was last successfully synced, or null.

lastErrorstring nullable

The error from the last failed attempt, or null.

sampleMediaMode'Auto' | 'Embed' | 'Url' required

Changes

  • c72c9f1c8ef5Revision changes
    • info

      removed the undefined enum value from the //// response property for the response status

  • ebc7fbc31114Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status