Examples

Updates an example's properties within an audience.

patch/audience/{audienceId}/example/{exampleId}

Request

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

Path parameters

audienceIdstring required

The unique identifier of the audience.

exampleIdstring required

The unique identifier of the example to update.

Request body

instructionTextstring

The instruction shown to the user — the criteria for a compare example, the target for a locate, line or scrub example, or the title for a classify or transcription example. The example's answer options are left unchanged.

explanationstring nullable

The optional explanation that will be shown to the user when answering wrong.

contextstring nullable

An optional text context that will be shown to the user.

randomCorrectProbabilitynumber double nullable

The probability that if the user answers at random that they'll be correct.

isCommonSenseboolean nullable

Whether answers to this example count towards the annotator's global userscore; platform admins only.

flagIfIncorrectboolean nullable

Whether an incorrect answer is rejected and shown to the annotator as wrong.

sortIndexinteger

The sort index that controls the serving order of this example.

visibility'Private' | 'Public'

Response

No Content

Changes