Sample

Gets a benchmark sample by its id.

Changed on
get/benchmark-sample/{sampleId}

Request

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

Path parameters

sampleIdstring required

The id of the sample to be retrieved.

Response

OK

idstring required

The unique identifier of the sample.

identifierstring required

The identifier used to correlate samples of different participants.

participantIdstring required

The id of the participant that owns the sample.

participantNamestring required

The name of the participant that owns the sample.

englishPromptstring nullable

An optional prompt text translated to English.

originalPromptstring nullable

An optional prompt text as originally provided.

tagsstring[] required

The tags associated with the sample.

createdAtstring date-time

The timestamp when the sample was created.

votesExcludedboolean

Whether the sample's matchups are excluded from the benchmark's scores.

ownerIdstring uuid nullable

The sample's owner; null unless the caller is platform staff or in the owning organization.

ownerMailstring nullable

The owner's mail; null unless the caller is platform staff or in the owning organization.

organizationIdstring nullable

The owner's organization; null unless the caller is platform staff or in the owning organization.

Changes

  • bf98b6cb9b5aRevision changes
    • info

      added the optional property to the response with the status

  • 21c16ab2e7abRevision changes
    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status