An event represents a specific occurrence during a session.

Example Usage

import { Event } from "syllable-sdk/models/components";

let value: Event = {
  timestamp: new Date("2024-01-16T13:37:49.640Z"),
  source: "tool-call",
  category: "automation",
  type: "phone-transfer",
  userId: "+18042221111",
  description: "Transfer to phone number +18042221111",
};

Fields

FieldTypeRequiredDescriptionExample
timestampDateTRUETimestamp at which the event occurred
sessionIdstringFALSEID of the session in which the event occurred
conversationIdstringFALSEID of the conversation associated with the session in which the event occurred
sourcestringFALSESource of the event (either a tool call or an LLM prompt)tool-call
sourceIdstringFALSEID of the source of the event (either a tool ID or a prompt ID)
categorystringFALSEBroad categorization of the eventautomation
typestringFALSEMore specific class of the eventphone-transfer
userIdstringFALSEID of the user interacting with the system when the event occurred (e.g., their phone number)+18042221111
descriptionstringFALSEHuman-readable description of the eventTransfer to phone number +18042221111
attributescomponents.AttributesFALSEArbitrary additional metadata for the event