Sign in
gateway.openapi_Gateway

Create Evaluation Job

post/v1/accounts/{account_id}/evaluationJobs

Path parameters

account_idstring required

The Account Id

Request body

evaluationJobIdstring
leaderboardIdsstring[]

Optional leaderboards to attach this job to upon creation.

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'

JobState represents the state an asynchronous job can be in.

  • JOB_STATE_PAUSED: Job is paused, typically due to account suspension or manual intervention.
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

Changed in 6 of the 27 revisions of this API.510

  • 920bcfb416a72See the full diff
    • ●

      removed the request property /

      request-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 80bec85988ad2See the full diff
    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • e9e5bbd5fb9d2See the full diff
    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 4506ec9d12ff11See the full diff
    • ●

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

      response-property-enum-value-added

    • ○

      added the new JOB_STATE_PAUSED enum value to the request property /

      request-property-enum-value-added

  • 824e683281d411See the full diff
    • ●

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

      response-property-enum-value-added

    • ○

      added the new JOB_STATE_EARLY_STOPPED enum value to the request property /

      request-property-enum-value-added

  • 311efdb2fa5714See the full diff
    • ●

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

      response-property-enum-value-added

    • ○

      the endpoint scheme security BearerAuth was added to the API

      api-security-added

    • ○

      api tag gateway.openapi_Gateway added

      api-tag-added

    • ○

      api tag Gateway removed

      api-tag-removed

    • ○

      added the new JOB_STATE_CANCELLING enum value to the request property /

      request-property-enum-value-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog