Examples

Adds a new example to an audience.

Changed on
post/audience/{audienceId}/example

Request

  • Base URL
    https://api.rapidata.ai
  • URL
    https://api.rapidata.ai/audience/{audienceId}/example
  • 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.

Request body

randomCorrectProbabilitynumber double required

The probability for an answer to be correct when randomly guessing.

explanationstring nullable

An explanation for the users if they answer the example incorrectly.

contextstring nullable

An optional textual context that provides additional information to the user.

sortIndexinteger nullable

The sort index that controls the serving order of this example within the audience. When null, the next sort index is automatically calculated.

isCommonSenseboolean nullable

Whether answers to this example count towards the annotator's global userscore; platform admins only. When null, AI auto-detection decides and may set this and flagIfIncorrect to true.

flagIfIncorrectboolean nullable

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

visibility'Private' | 'Public'

Response

OK

recalculationIdstring nullable

The id of the audience state recalculation dispatched as a result of adding this example. Null when the example addition cannot transition any user's state (e.g. the audience already has more examples than MaxDistillingResponses + 1).

Changes