Benchmark

Creates a benchmark.

Changed on
post/benchmark

Request

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

Request body

namestring required

The name of the benchmark.

descriptionstring nullable

Optional plain-text credit for the people or sources behind the benchmark. Limited to 2000 characters; leave unset for none.

initialBoostLevelinteger nullable

Initial boost level applied to the campaign of every run created from this benchmark. Leave unset to fall back to DefaultInitialBoostLevel.

minAssetsPerPromptinteger nullable

Optional submission quality gate. When set (at least 2), submitting a participant warns for any prompt it generated between 1 and N-1 samples for. Leave unset to disable.

scoreShiftnumber double nullable

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

scoreScalenumber double nullable

Multiplicative factor applied to displayed scores on the benchmark's overall scoreboard, relative to the Bradley-Terry center. Defaults to 1.0; must be strictly positive.

Response

OK

idstring required

The id of the created benchmark.

Changes

  • ebc7fbc31114Revision 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