File Failed

Usage

This file event notifies your application when a file has failed to complete any of the stages of its assigned pipeline. The resulting message details the reason and stage in which the processing failed.

JSON Payload

{
  "event_id": "(UUID format) - Unique identifier for the event.",
  "event_type": "Describes the type of event that occurred.",
  "event_time": "(floating-point numeric timestamp) - Unix timestamp representing the time when the event occurred, including tenths of a second.",
  "event": {
    "event_name": "Name of the specific event.",
    "event_type": "Type of the event, often matching or related to the outer event_type.",
    "company_id": "(UUID format) - Unique identifier for the company involved in the event.",
    "company_name": "Name of the company involved in the event.",
    "blob_name": "Filename of the document or data blob involved in the event.",
    "blob_url": "URL - Fully qualified URL where the blob or document is stored, accessible via HTTP or HTTPS.",
    "file_id": "(UUID format) - Unique identifier for the file associated with the event.",
    "tag_id": "(UUID format) - Unique identifier for the tag associated with the file.",
    "tag_name": "Name of the tag assigned to the file.",
    "classification_score": "(floating-point numeric value) - Score representing the confidence or relevance of the classification, typically between 0.0 and 1.0.",
    "classification_status": "Status of the classification process such as 'pending_review'.",
    "file_status": "Status of the file, typically a textual description like 'failed', 'processing', etc.",
    "error_messages": "Array of Strings - List of error messages associated with the event indicating reasons for failure.",
    "creation_date": "(ISO 8601 date format) - Date and time when the event or file was initially created.",
    "update_date": "(ISO 8601 date format) - Date and time when the event or file status was last updated."
  }
}

{
  "event_id": "uvwx6789-xy01-2345-z678-abcd90123456",
  "event_type": "file_event_type",
  "event_time": "1651527890.30",
  "event": {
    "event_name": "file_failed_event",
    "event_type": "file_event_type",
    "company_id": "890q1234-r56s-78t9-u012-679014186000",
    "company_name": "CloudTech Innovations",
    "blob_name": "report_final_draft.docx",
    "blob_url": "https://storage.cloudtech.com/documents/report_final_draft.docx",
    "file_id": "678q2345-r67s-89t0-v123-780114187000",
    "tag_id": "789r3456-s78t-01u2-w234-891214188000",
    "tag_name": "Review Needed",
    "classification_score": "0.82",
    "classification_status": "pending_review",
    "file_status": "failed",
    "error_messages": [
      "Document corrupt and cannot be opened",
      "Failed to connect to document parser service"
    ],
    "creation_date": "2023-05-07T16:40:00Z",
    "update_date": "2023-05-08T17:50:00Z"
  }
}