V2 Parsing Job

Job

class Job(raw_response)

Job information for a V2 polling attempt.

Parameters:

raw_response (dict[str, Any])

alias: str

Optional alias for the file.

completed_at: datetime | None = None

Date and time of the Job completion. Filled once processing is finished.

created_at: datetime

Date and time of the Job creation.

error: ErrorResponse | None

Error response if any.

filename: str

Name for the file.

id: str

Job ID.

model_id: str

ID of the model.

polling_url: str

URL to poll for the job status.

result_url: str | None

URL to poll for the job result, redirects to the result if available.

status: str

Status of the job.

webhooks: list[JobWebhook]

ID of webhooks associated with the job.

Job Response

class JobResponse(raw_response)

Represent an inference response from Mindee V2 API.

Parameters:

raw_response (dict[str, Any])

job: Job

Job for the polling.

property raw_http: str

Displays the result of the raw response as json string.

Job Webook

class JobWebhook(server_response)

JobWebhook information.

Parameters:

server_response (dict[str, Any])

static parse_date(date_string)

Parse the date, if present.

Return type:

datetime | None

Parameters:

date_string (str | None)

created_at: datetime | None

Created at date.

error: ErrorResponse | None

Error response, if any.

id: str

JobWebhook ID.

status: str

Status of the webhook.