Benchmark
HuggingFaceSync

Starts a HuggingFace sync of the benchmark and returns its current sync status.

Changed on

The export configuration (sampleMediaMode, segmentExports) is persisted on the benchmark; a field left null keeps the stored value, and an empty segmentExports list resets to the legacy shape. Every sync rebuilds the whole dataset; an existing README is kept. An asset segment carried into the dataset holds exactly one file per prompt: matchups whose prompt carries no value, or a multi-asset, under a configured asset segment are left out of the export (several files belong in several segments). Responds 400 when a segment export names a key the benchmark's prompt structure does not define, when a column does not match ^[a-z][a-z0-9_]{0,63}$, is used twice or collides with a reserved dataset column (model1, model2, image1, image2, video1, video2, file1, file2, or any name starting with weighted_results_ or detailed_results_), when a key is exported twice, or when a mode contradicts the segment's kind (Text only for text segments, Embed / Url only for asset segments). Responds 409 Conflict when a sync is already in progress for the benchmark, or when a repo name is supplied that differs from the one an earlier successful sync established. The repo name is only honored while the benchmark has never completed a sync.

post/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 to sync.

Request body

repoNamestring nullable

Optional target repo name. Only honored while the benchmark has never completed a sync; defaults to a name derived from the benchmark name.

sampleMediaMode'Auto' | 'Embed' | 'Url' nullable

How the two compared sample columns are represented. Null keeps the stored value; defaults to Auto on the first sync.

Response

OK

status'NeverSynced' | 'Exporting' | 'Uploading' | 'Completed' | 'Failed' required
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.

appliedSampleMediaMode'Auto' | 'Embed' | 'Url' required

Changes

    • info

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

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property