parseur.schemas.document¶

Classes¶

`DocumentStatus`	Enum for Parseur document processing statuses.
`DocumentSchema`
`DocumentLogSchema`
`AttachmentSchema`
`DocumentUploadSchema`
`NotificationSetSchema`	User notifications returned by asynchronous document actions.

Module Contents¶

class parseur.schemas.document.DocumentStatus[source]¶

Bases: str, enum.Enum

Enum for Parseur document processing statuses.

INCOMING = 'INCOMING'[source]¶

ANALYZING = 'ANALYZING'[source]¶

DELETED = 'DELETED'[source]¶

PROGRESS = 'PROGRESS'[source]¶

PARSEDOK = 'PARSEDOK'[source]¶

PARSEDKO = 'PARSEDKO'[source]¶

QUOTAEXC = 'QUOTAEXC'[source]¶

SKIPPED = 'SKIPPED'[source]¶

SPLIT = 'SPLIT'[source]¶

EXPORTKO = 'EXPORTKO'[source]¶

TRANSKO = 'TRANSKO'[source]¶

INVALID = 'INVALID'[source]¶

class parseur.schemas.document.DocumentSchema[source]¶

Bases: parseur.schemas.BaseSchema

id[source]¶

name[source]¶

status[source]¶

status_source[source]¶

received[source]¶

processed[source]¶

ai_credits_used[source]¶

credits_used[source]¶

is_ai_ready[source]¶

is_ocr_ready[source]¶

is_processable[source]¶

is_split[source]¶

is_splittable[source]¶

parser[source]¶

template[source]¶

attached_to[source]¶

prev_id[source]¶

next_id[source]¶

content[source]¶

result[source]¶

csv_download_url[source]¶

json_download_url[source]¶

xls_download_url[source]¶

original_document_url[source]¶

ocr_ready_url[source]¶

parse_result_json(data, **kwargs)[source]¶

class parseur.schemas.document.DocumentLogSchema[source]¶

Bases: parseur.schemas.BaseSchema

id[source]¶

code[source]¶

created[source]¶

document[source]¶

document_name[source]¶

message[source]¶

parser[source]¶

parser_name[source]¶

payload[source]¶

source[source]¶

status[source]¶

template[source]¶

template_name[source]¶

initiator[source]¶

initiator_name[source]¶

parse_payload_json(data, **kwargs)[source]¶

class parseur.schemas.document.AttachmentSchema[source]¶

Bases: parseur.schemas.BaseSchema

DocumentID[source]¶

name[source]¶

class parseur.schemas.document.DocumentUploadSchema[source]¶

Bases: parseur.schemas.BaseSchema

DocumentID[source]¶

attachments[source]¶

message[source]¶

class parseur.schemas.document.NotificationSetSchema[source]¶

Bases: parseur.schemas.BaseSchema

User notifications returned by asynchronous document actions.

Endpoints that kick off background work (reprocess, copy, split, reverse_split, …) do not return the document; they reply with {"notification_set": {<level>: [messages]}} where <level> is one of info / success / warning / error. Only the levels present in the response are populated.

info[source]¶

success[source]¶

warning[source]¶

error[source]¶