DataRobot APIのリソース > APIリファレンスドキュメント > DataRobot REST API > Jobs (GenAI)

Jobs (GenAI)¶

This page outlines the operations, endpoints, parameters, and example requests and responses for the Jobs (GenAI).

GET /api/v2/genai/status/{statusId}/¶

Retrieve the execution status of a GenAI worker job.

Code samples¶

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/genai/status/{statusId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
statusId	path	string(uuid)	true	The ID of the job to retrieve the status for.

Example responses¶

200 Response

{
  "code": 0,
  "created": "2019-08-24T14:15:22Z",
  "description": "",
  "message": "",
  "status": "INITIALIZED",
  "statusId": "e900225c-0629-4e96-be6e-86a17a309645",
  "statusType": ""
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationErrorResponse

Response Schema¶

Status Code 200

Response Get Status Status Statusid Get

Name	Type	Required	Restrictions	Description
Response Get Status Status Statusid Get	any	false		none

anyOf

Name	Type	Required	Description
» anonymous	StatusResponse	false	API response object for job execution status.
»» code	JobErrorCode	true	The error code associated with the job.
»» created	string(date-time)	true	The creation date of the job (ISO 8601 formatted).
»» description	string	false	The description associated with the job.
»» message	string	false	The error message associated with the job.
»» status	JobExecutionState	true	The execution status of the job.
»» statusId	string(uuid)	true	The ID of the job.
»» statusType	string	false	The type of the status object.

or

Name	Type	Required	Restrictions	Description
» anonymous	string	false		none

Enumerated Values¶

Property	Value
code	[`0`, `1`]
status	[`INITIALIZED`, `RUNNING`, `COMPLETED`, `ERROR`, `ABORTED`, `EXPIRED`]

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

Schemas¶

HTTPValidationErrorResponse

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

HTTPValidationErrorResponse

Properties¶

Name	Type	Required	Restrictions	Description
detail	[ValidationError]	false		none

JobErrorCode

Properties¶

Name	Type	Required	Restrictions	Description
JobErrorCode	integer	false		Possible job error codes. This enum exists for consistency with the DataRobot Status API.

Enumerated Values¶

Property	Value
JobErrorCode	[`0`, `1`]

JobExecutionState

"INITIALIZED"

JobExecutionState

Properties¶

Name	Type	Required	Restrictions	Description
JobExecutionState	string	false		Possible job states. Values match the DataRobot Status API.

Enumerated Values¶

Property	Value
JobExecutionState	[`INITIALIZED`, `RUNNING`, `COMPLETED`, `ERROR`, `ABORTED`, `EXPIRED`]

StatusResponse

{
  "code": 0,
  "created": "2019-08-24T14:15:22Z",
  "description": "",
  "message": "",
  "status": "INITIALIZED",
  "statusId": "e900225c-0629-4e96-be6e-86a17a309645",
  "statusType": ""
}

StatusResponse

Properties¶

Name	Type	Required	Description
code	JobErrorCode	true	The error code associated with the job.
created	string(date-time)	true	The creation date of the job (ISO 8601 formatted).
description	string	false	The description associated with the job.
message	string	false	The error message associated with the job.
status	JobExecutionState	true	The execution status of the job.
statusId	string(uuid)	true	The ID of the job.
statusType	string	false	The type of the status object.

ValidationError

{
  "loc": [
    "string"
  ],
  "msg": "string",
  "type": "string"
}

ValidationError

Properties¶

Name	Type	Required	Restrictions	Description
loc	[anyOf]	true		none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false		none

or

Name	Type	Required	Restrictions	Description
» anonymous	integer	false		none

continued

Name	Type	Required	Restrictions	Description
msg	string	true		none
type	string	true		none

更新しました May 14, 2024

このページは役に立ちましたか？

ありがとうございます。どのような点が役に立ちましたか？

より良いコンテンツを提供するには、どうすればよいでしょうか？

アンケートにご協力いただき、ありがとうございました。