SampleGeneration

Returns the current status and progress of a sample generation request.

Changed on
get/benchmark/sample-generation/{sampleGenerationId}

Request

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

Path parameters

sampleGenerationIdstring required

The id of the sample generation request.

Response

OK

idstring required

The id of the sample generation request.

benchmarkIdstring required

The benchmark this generation belongs to.

status'Pending' | 'Processing' | 'Completed' | 'CompletedWithFailures' | 'Failed' | 'Cancelled' required
mode'Additive' | 'Target' required
samplesPerPromptinteger required

The per-prompt sample count the run was created with — samples to add in additive mode, the count each prompt was brought up to in target mode.

totalCountinteger required

The total number of items queued.

completedCountinteger required

The number of items that have succeeded so far.

failedCountinteger required

The number of items that have failed.

promptIdentifierFilterstring[] nullable

Optional prompt identifier filter that was applied.

tagsFilterstring[] nullable

Optional tag filter that was applied.

ownerIdstring uuid required

The id of the customer that started this generation.

ownerMailstring required

The mail of the customer that started this generation.

organizationIdstring required

The id of the organization that owns the entity.

createdAtstring date-time required

When the generation was created.

Changes

  • ebc7fbc31114Revision changes
    • warning

      added the new InvalidOutput enum value to the /// response property for the response 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