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
  • Usage
  • Example JSON Payload

Was this helpful?

  1. Event API
  2. File Events

File Category Delete

Usage

This file event triggers when a file has not been assigned a tag in Alfred since it would not be representative of the image content.

If this event is triggered the affecte file will not be classified or indexed and the data points configured from its tags will not be extracted.

Example 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 milliseconds.",
  "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 associated with the event.",
    "company_name": "Name of the company associated with the event.",
    "file_log_id": "(UUID format) - Unique identifier for the log entry related to the file event.",
    "description": "Brief textual description of the event or action taken.",
    "confidence": "(floating-point numeric value) - Confidence level of the action taken or the classification, typically between 0.0 and 1.0.",
    "creation_date": "(ISO 8601 date format) - Date and time when the file category was initially created.",
    "update_date": "(ISO 8601 date format) - Date and time when the file category was last updated."
  }
}
{
  "event_id": "89cd2345-ef67-8901-ij23-klmn45678901",
  "event_type": "file_event_type",
  "event_time": "1651021234.85",
  "event": {
    "event_name": "file_category_delete_event",
    "event_type": "file_event_type",
    "company_id": "123e4567-e89b-12d3-a456-426614174000",
    "company_name": "Example Company",
    "file_log_id": "123e4567-e89b-12d3-a456-426614174003",
    "description": "Removal of outdated classification",
    "confidence": "0.92",
    "creation_date": "2023-04-25T14:30:00Z",
    "update_date": "2023-04-26T15:45:00Z"
  }
}

Last updated 1 year ago

Was this helpful?