gateway.openapi_Gateway
post/v1/accounts/{account_id}/dpoJobs
Path parameters
account_idstring required
The Account Id
Query parameters
dpoJobIdstring
ID of the DPO job, a random ID will be generated if not specified.
Request body
namestring
displayNamestring
createTimestring date-time
completedTimestring date-time
datasetstring required
The name of the dataset used for training.
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.
createdBystring
The email address of the user who initiated this dpo job.
trainerLogsSignedUrlstring
The signed URL for the trainer logs file (stdout/stderr). Only populated if the account has trainer log reading enabled.
Response
A successful response.
namestring
displayNamestring
createTimestring date-time
completedTimestring date-time
datasetstring required
The name of the dataset used for training.
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.
createdBystring
The email address of the user who initiated this dpo job.
trainerLogsSignedUrlstring
The signed URL for the trainer logs file (stdout/stderr). Only populated if the account has trainer log reading enabled.