NUnugen
Alignment Projects

Get Alignment Status

The polled status of one alignment project.

Returns the state and its qualifiers only. Configuration, documents, metrics, and failure qualifiers (degraded, stage_failures, error) never change while a run executes or live on the detail route instead, so they are not re-sent on every poll.

get/api/v3/alignment-projects/{alignment_id}/status

Request

  • Base URL
    https://api.nugen.in
  • Auth
    HTTP bearer

Path parameters

alignment_idstring required

ID of the alignment project, returned when it was created

Response

Returns the current status of an alignment project: state, timestamps, queue position and stop qualifier. Poll this; fetch the full record, including failure qualifiers, once from GET /alignment-projects/{alignment_id}.

alignment_idstring required

Unique identifier of the alignment project.

status'QUEUED' | 'PROCESSING' | 'READY' | 'FAILED' | 'STOPPED' required

Lifecycle status of a resource that runs asynchronously. Stored as is and returned as is, with no translation in between.

  • QUEUED: accepted and waiting for its workflow to start
  • PROCESSING: running
  • READY: finished successfully
  • FAILED: failed at any stage
  • STOPPED: stopped by the user before completion
created_atstring nullable

Timestamp when the project was created.

completed_atstring nullable

Timestamp when the project completed; null while still running.

updated_atstring nullable

Last update timestamp.

progressnumber nullable

Completion progress, 0.0 to 100.0. Not wired up yet, always null.

eta_secondsinteger nullable

Estimated time remaining in seconds. Not wired up yet, always null.

queue_positioninteger nullable

Place in the queue while status is QUEUED, 1 meaning next to start.

stop_requested_atstring nullable

Set once a stop was requested; the run ends STOPPED.

early_deployableboolean

True once train-time alignment has written a checkpoint, so POST /models/{model_id}/deployment?early=true will succeed. Only meaningful while status is still PROCESSING; false once train-time alignment has finished, since a normal deploy applies then.

evaluation_idstring nullable

The evaluation created from benchmark_id once train-time alignment finished.

evaluation_status'QUEUED' | 'PROCESSING' | 'READY' | 'FAILED' | 'STOPPED'

Lifecycle status of a resource that runs asynchronously. Stored as is and returned as is, with no translation in between.

  • QUEUED: accepted and waiting for its workflow to start
  • PROCESSING: running
  • READY: finished successfully
  • FAILED: failed at any stage
  • STOPPED: stopped by the user before completion
evaluation_messagestring nullable

Why the evaluation could not be created or why it failed.

Changes

No recorded changes to this operation across all 1 revision of this API.