Skip to content

@egain/ai-agent-sdk API Reference - v0.3.2 / AgentEvent

Interface: AgentEvent<T> ​

Wrapped agent event structure

Type parameters ​

NameType
Textends AgentEventType = AgentEventType

Table of contents ​

Properties ​

Properties ​

type ​

• type: T

Event type identifier

Defined in ​

core/AiAgent.ts:291


timestamp ​

• timestamp: number

Timestamp when the event occurred (milliseconds since epoch)

Defined in ​

core/AiAgent.ts:296


sessionId ​

• Optional sessionId: string | number

Session ID associated with the event

Defined in ​

core/AiAgent.ts:301


agentId ​

• Optional agentId: string | number

Agent ID associated with the event

Defined in ​

core/AiAgent.ts:306


payload ​

• payload: AgentEventPayloadMap[T]

Event-specific payload data Type varies based on the event type

Defined in ​

core/AiAgent.ts:312

Released under the MIT License.