UHuhh-lt
job

Start Ml job

Changed on
post/job/ml

Request

  • The document declares no server URL.
  • Auth
    OAuth 2
    Password
    Token URL: /authentication/login

Request body

project_idinteger required

The ID of the Project to analyse

ml_job_type'QUOTATION_ATTRIBUTION' | 'TAG_RECOMMENDATION' | 'COREFERENCE_RESOLUTION' | 'DOCUMENT_EMBEDDING' | 'SENTENCE_EMBEDDING' required

Response

Successful Response

job_idstring required

RQ job ID

job_type'ml' required

Type of the job

project_idinteger required

Project ID associated with the job

status'queued' | 'finished' | 'failed' | 'started' | 'deferred' | 'scheduled' | 'stopped' | 'canceled' required
status_messagestring nullable

Status message

current_stepinteger required

Current step in the job process

stepsstring[] required

Total number of steps in the job process

outputunknown
createdstring date-time required

Created timestamp of the job

finishedstring date-time nullable

Finished timestamp of the job

Changes

  • 3bdfd02830b1Revision changes
    • warning

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

    • info

      the response property const value ml was added for the status

  • bd1187f3520eRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status