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

Was this helpful?

  1. Event API
  2. File Events

File Remove Tag

Usage

This file event trigger when the assigned tag of a file has been removed.

If this occurs, the file will be ignored for historical purposes and model training purposes. It will no longer appear in search results and will be available for auditing purposes.

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, rounded to whole seconds.",
  "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.",
    "file_id": "(UUID format) - Unique identifier for the file associated with the event.",
    "tag_being_removed_id": "(UUID format) - Unique identifier for the tag that is being removed from the file.",
    "tag_being_removed_name": "Name of the tag that is being removed, indicating the previous classification or status.",
    "classification_score": "(floating-point numeric value) - Score representing the confidence or relevance of the tag removal, typically between 0.0 and 1.0."
  }
}
 {
  "event_id": "qrst2345-uvwx-4567-yzab-2345cdef6789",
  "event_type": "file_event_type",
  "event_time": "1652134500.00",
  "event": {
    "event_name": "file_change_tag_event",
    "event_type": "file_event_type",
    "company_id": "67890123-6789-6789-6789-6789012345gh",
    "company_name": "Dynamic Enterprises",
    "file_id": "32109876-9876-9876-9876-765432109876",
    "tag_being_removed_id": "43210987-0987-0987-0987-987654321098",
    "tag_being_removed_name": "Outdated",
    "classification_score": "0.86"
  }
}

Last updated 1 year ago

Was this helpful?