Alfred v1.66.3.0
Alfred
Alfred
  • Introduction
  • Authentication
  • Event API
    • File Events
      • File Add To Job
      • File Category Create
      • File Category Delete
      • File Change Tag
      • File Done
      • File Extracted Data Create
      • File Extracted Data Delete
      • File Failed
      • File Move
      • File Move To Pending
      • File Move To Recycle Bin
      • File Property Create
      • File Property Delete
      • File Remove Tag
      • File Status Update
      • File Update
    • Job Events
      • JobCreateEvent
      • JobExceededRetriesEvent
      • JobFailedEvent
      • JobFinishedEvent
      • JobInvalidEvent
      • JobRetryEvent
      • JobStageUpdateEvent
      • JobStartEvent
    • Event Structures
  • endpoints
    • Alfred
    • File
      • Remote Sources
      • File Status
    • Deferred Session
    • Job
      • Job Stages
    • Tag
    • Metadata
    • Metadata Values
    • Report
    • Account
    • Company
Powered by GitBook
On this page

Was this helpful?

  1. endpoints
  2. File

File Status

The FileStatus entity in Alfred represents the current state of a file within the document processing workflow, indicating its progress from initiation to completion

In Alfred, each file progresses through a series of distinct statuses, reflecting key points in its lifecycle. These statuses are integral to understanding and effectively managing the flow of document processing tasks. They provide users with clear markers of a file's journey from upload to completion, highlighting critical moments such as processing, waiting for input, encountering issues, and successful resolution.

This documentation page offers a detailed overview of the File statuses in Alfred. By comprehending these statuses, users gain valuable insights into the current state and progress of each file. This understanding is crucial for efiicient monitoring, managing, and interacting with files in Alfred, ensuring a smooth and effective document processing experience.

Code
Status
Description

0

uploaded

Indicates the file has been successfully uploaded to the system.

1

metadata

The file is currently in the process of Metada acquisition.

2

pre_processing

The file is currently undergoing its corresponding preprocessing pipeline

3

pre_processed

The file has succesfully completed the preprocessing pipeline.

4

decomposing

The file is being decomposed into separate elements.

5

decomposed

The decomposition of the file into manageable elements is complete.

6

ocr

The file is currently undergoing the extraction of information throught the Optical Character Recognition (OCR) processing.

7

transformed

The file has been transformed as needed for further processing.

8

classifying

The file is in the process of being classified into a Tag.

9

classified

The file has been succesfully completed the classification pipeline.

10

indexing

The file's components are currently being indexed.

11

indexed

The indexing process for the file has been succesfully completed.

12

extracting

The corresponding Data Points for the file are currently being extracted.

13

extracted

The Data Point extraction for the file has been completed.

14

confirmation_required

The file requires user confirmation for further processing.

15

confirmation_submitted

User confirmation for the file has been submitted.

16

confirmed

The file has been confirmed by the user.

17

finished

The file has completed its assigned pipeline.

18

re_tagged

The file has been retagged.

19

tag_removed

Tags associated with the file have been removed.

20

failed_classification

The file has failed the classification process.

21

deleted

The file has been deleted from the system.

22

duplicate

The file is marked as a duplicate of another file.

23

waiting_to_be_sent_to_third_party

The file is waiting to be sent to a third party.

24

sent_to_third_party

The file has been sent to a third party.

25

re_queued

The file has been re-queued for processing.

26

failed_extraction

The file has failed the data extraction process.

27

failed_to_send_to_third_party

Sending the file to a third party has failed.

28

failed_file_operation

A file operation has failed.

29

failed_transformation

The file transformation process has failed.

30

failed_job

The job associated with the file has failed.

31

canceled_job

The job associated with the file has been canceled.

Last updated 3 months ago

Was this helpful?