FWfw-ai-external
gateway.openapi_Gateway

Create Evaluation Job

Changed on
post/v1/accounts/{account_id}/evaluationJobs

Request

Path parameters

account_idstring required

The Account Id

Request body

evaluationJobIdstring

Response

A successful response.

namestring
displayNamestring
createTimestring date-time
createdBystring
state'JOB_STATE_UNSPECIFIED' | 'JOB_STATE_CREATING' | 'JOB_STATE_RUNNING' | 'JOB_STATE_COMPLETED' | 'JOB_STATE_FAILED' | 'JOB_STATE_CANCELLED' | 'JOB_STATE_DELETING' | 'JOB_STATE_WRITING_RESULTS' | 'JOB_STATE_VALIDATING' | 'JOB_STATE_DELETING_CLEANING_UP' | 'JOB_STATE_PENDING' | 'JOB_STATE_EXPIRED' | 'JOB_STATE_RE_QUEUEING' | 'JOB_STATE_CREATING_INPUT_DATASET' | 'JOB_STATE_IDLE' | 'JOB_STATE_CANCELLING' | 'JOB_STATE_EARLY_STOPPED' | 'JOB_STATE_PAUSED' | 'JOB_STATE_DELETED' | 'JOB_STATE_ARCHIVED'

JobState represents the state an asynchronous job can be in.

  • JOB_STATE_PAUSED: Job is paused, typically due to account suspension or manual intervention.
  • JOB_STATE_DELETED: Job has been deleted.
  • JOB_STATE_ARCHIVED: User-facing state for jobs whose row is retained post-delete (e.g. RLOR trainers within the checkpoint retention window). The internal row is still in JOB_STATE_DELETED; the gateway translates it to ARCHIVED on public responses.
evaluatorstring required

The fully-qualified resource name of the Evaluation used by this job.

Format: accounts/{account_id}/evaluators/{evaluator_id}

inputDatasetstring required

The fully-qualified resource name of the input Dataset used by this job.

Format: accounts/{account_id}/datasets/{dataset_id}

outputDatasetstring required

The fully-qualified resource name of the output Dataset created by this job.

Format: accounts/{account_id}/datasets/{output_dataset_id}

metricsobject
outputStatsstring

The output dataset's aggregated stats for the evaluation job.

updateTimestring date-time

The update time for the evaluation job.

Changes

  • 3bf245180173Revision changes
    • warning

      removed the request property

    • warning

      added the new JOB_STATE_ARCHIVED enum value to the response property for the response status

    • warning

      added the new JOB_STATE_DELETED enum value to the response property for the response status

    • info

      added the new JOB_STATE_ARCHIVED enum value to the request property /

    • info

      added the new JOB_STATE_DELETED enum value to the request property /

  • 920bcfb416a7Revision changes
    • warning

      removed the request property /

    • warning

      removed the optional property from the response with the status