Benchmark

Updates a benchmark using patch semantics.

Changed on
patch/benchmark/{benchmarkId}

Request

  • Base URL
    https://api.rapidata.ai
  • URL
    https://api.rapidata.ai/benchmark/{benchmarkId}
  • 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 update.

Request body

namestring

The new name of the benchmark.

descriptionstring

Optional plain-text credit for the people or sources behind the benchmark. Limited to 2000 characters; send null to clear it, omit to leave it unchanged.

isPublicboolean

True makes public now; false makes private. Do not combine with publicationDate.

isPublishedboolean

Whether the benchmark should be surfaced in the public benchmark repository.

publicationDatestring date-time nullable

Public access starts at this instant; null makes private, omission leaves it unchanged. Do not combine with isPublic.

initialBoostLevelinteger nullable

Initial boost level applied to the campaign of every run created from this benchmark. Pass null to clear the override and fall back to the benchmark default.

minAssetsPerPromptinteger nullable

Optional submission quality gate. Set to at least 2 to warn on submit for prompts with 1..N-1 samples; pass null to clear the gate; omit to leave it unchanged.

scoreShiftnumber double

Additive offset applied to displayed scores on the benchmark's overall scoreboard.

scoreScalenumber double

Multiplicative factor applied to displayed scores (relative to the Bradley-Terry center) on the overall scoreboard of this benchmark. Must be strictly positive.

Response

No Content

Changes

  • 57d1ef1d7143Revision changes
    • info

      added the new optional request property

  • 9da534659e5fRevision changes
    • info

      the security scope api was added to the endpoint's security scheme OpenIdConnect

    • info

      added the new optional request property