Leaderboard

Updates a leaderboard using patch semantics.

Changed on

displayInstruction is presentation-only and never affects run creation, vote recording or ranking; setting or clearing it requires platform-admin. A supplied featureFlags list replaces the stored set and applies to future runs only; votes already recorded are untouched.

patch/leaderboard/{leaderboardId}

Request

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

Path parameters

leaderboardIdstring required

The id of the leaderboard to update.

Request body

namestring

The new name of the leaderboard.

displayInstructionstring nullable

Text to display instead of the leaderboard's instruction. Presentation-only; it never changes what annotators are asked or how results are scored. Pass null to clear the override so instruction is displayed again.

responseBudgetinteger

The response budget collected when onboarding a new participant.

minResponsesinteger

The minimum responses collected per matchup.

priorityinteger nullable

Priority override applied to every run's job. Pass null to clear the override and fall back to the default priority.

weightnumber double

Multiplier applied to this leaderboard's match results when they contribute to the parent benchmark's overall / combined scoreboards; unbounded.

scoreShiftnumber double

Additive offset applied to displayed scores on this leaderboard's scoreboard.

scoreScalenumber double

Multiplicative factor applied to displayed scores on this leaderboard's scoreboard, relative to the Bradley-Terry center; must be strictly positive.

isHiddenboolean

Whether the leaderboard is hidden from standard listings.

isExcludedFromOverallboolean

Whether this leaderboard is excluded from its benchmark's overall / combined scoreboard, making it a private experiment of the owning organization.

voteAggregation'AllVotes' | 'MajorityVote'
includedTagsstring[]

Prompt tag values to restrict matchups to; only prompts carrying at least one are used. Empty means no restriction.

excludedTagsstring[]

Prompt tag values the leaderboard never creates matchups for; takes precedence over includedTags, even when another tag is included.

Response

No Content

Changes

  • ebc7fbc31114Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

  • 9da534659e5fRevision changes
    • info

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