@lobehub/chat/packages/agent-runtime/src/types/event.ts

Lobe Chat - an open-source, high-performance chatbot framework that supports speech synthesis, multimodal, and extensible Function Call plugin system. Supports one-click free deployment of your private ChatGPT/LLM web application.

/* eslint-disable sort-keys-fix/sort-keys-fix, typescript-sort-keys/interface */
import type { AgentState, ToolsCalling } from './state';

export interface AgentEventInit {
  type: 'init';
}

export interface AgentEventLlmStart {
  type: 'llm_start';
  payload: unknown;
}

export interface AgentEventLlmStream {
  type: 'llm_stream';
  chunk: unknown;
}

export interface AgentEventLlmResult {
  type: 'llm_result';
  result: unknown;
}

export interface AgentEventToolPending {
  type: 'tool_pending';
  toolCalls: ToolsCalling[];
}

export interface AgentEventToolResult {
  type: 'tool_result';
  id: string;
  result: any;
}

export interface AgentEventHumanApproveRequired {
  type: 'human_approve_required';
  pendingToolsCalling: ToolsCalling[];
  sessionId: string;
}

export interface AgentEventHumanPromptRequired {
  type: 'human_prompt_required';
  metadata?: Record<string, unknown>;
  prompt: string;
  sessionId: string;
}

export interface AgentEventHumanSelectRequired {
  type: 'human_select_required';
  metadata?: Record<string, unknown>;
  multi?: boolean;
  options: { label: string; value: string }[];
  prompt?: string;
  sessionId: string;
}

/**
 * Standardized finish reasons
 */
export type FinishReason =
  | 'completed' // Normal completion
  | 'user_requested' // User requested to end
  | 'max_steps_exceeded' // Reached maximum steps limit
  | 'cost_limit_exceeded' // Reached cost limit
  | 'timeout' // Execution timeout
  | 'agent_decision' // Agent decided to finish
  | 'error_recovery' // Finished due to unrecoverable error
  | 'system_shutdown'; // System is shutting down

export interface AgentEventDone {
  type: 'done';
  finalState: AgentState;
  reason: FinishReason;
  reasonDetail?: string;
}

export interface AgentEventError {
  type: 'error';
  error: any;
}

export interface AgentEventInterrupted {
  type: 'interrupted';
  reason: string;
  interruptedAt: string;
  interruptedInstruction?: any;
  canResume: boolean;
  metadata?: Record<string, unknown>;
}

export interface AgentEventResumed {
  type: 'resumed';
  reason: string;
  resumedAt: string;
  resumedFromStep: number;
  metadata?: Record<string, unknown>;
}

/**
 * Events emitted by the AgentRuntime during execution
 */
export type AgentEvent =
  // Initialization
  | AgentEventInit
  // LLM streaming output
  | AgentEventLlmStart
  | AgentEventLlmStream
  | AgentEventLlmResult
  // Tool invocation
  | AgentEventToolPending
  | AgentEventToolResult
  // Normal completion
  | AgentEventDone
  // Error thrown
  | AgentEventError
  // Human-in-the-loop (HIL)
  | AgentEventHumanApproveRequired
  | AgentEventHumanPromptRequired
  | AgentEventHumanSelectRequired
  // Interruption and resumption
  | AgentEventInterrupted
  | AgentEventResumed;