Leaderboard

Gets a leaderboard by its id.

Changed on

displayInstruction is presentation-only: render it instead of instruction when set, falling back to instruction when null. instruction stays the wording annotators were asked and results are scored on.

get/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 retrieve.

Response

OK

idstring required

The unique identifier of the leaderboard.

namestring required

The name of the leaderboard.

instructionstring required

The instruction used when collecting responses.

displayInstructionstring nullable

Text to display instead of instruction; null means display instruction itself.

showPromptboolean required

Whether the prompt is shown on the rapids.

showPromptAssetboolean required

Whether the prompt asset is shown on the rapids.

isInversedboolean required

Whether the leaderboard results are inversed.

responseBudgetinteger required

The response budget per run.

minResponsesinteger required

The minimum responses collected per comparison.

audienceIdstring required

The id of the audience that evaluates the leaderboard.

jobDefinitionIdstring nullable

The id of the associated job definition, if any.

priorityinteger nullable

Priority override applied to every run's job; null falls back to the default priority.

weightnumber double required

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

scoreShiftnumber double required

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

scoreScalenumber double required

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

isHiddenboolean required

Whether the leaderboard is hidden from standard listings.

isExcludedFromOverallboolean required

Whether the leaderboard is excluded from its benchmark's overall / combined scoreboard, making it an owner-only private experiment.

voteAggregation'AllVotes' | 'MajorityVote' required
includedTagsstring[] required

Prompt tag values the leaderboard restricts its matchups to. Empty means no restriction.

excludedTagsstring[] required

Prompt tag values the leaderboard never creates matchups for. Takes precedence over includedTags.

lastUpdatedAtstring date-time nullable required

When votes were last recorded for the leaderboard; null when none ever were.

Changes

  • ebc7fbc31114Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

  • 9da534659e5fRevision changes
    • info

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