File size: 8,874 Bytes
f56a29b | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 | /**
* Shared Type Definitions for Multi-Agent Orchestration
*
* Defines the session-based multi-agent conversation system with
* support for QA, Discussion, and Lecture session types.
*/
import type { UIMessage } from 'ai';
import type { ThinkingConfig } from './provider';
// Session Types
export type SessionType = 'qa' | 'discussion' | 'lecture';
export type SessionStatus = 'idle' | 'active' | 'interrupted' | 'completed';
/**
* Metadata attached to chat messages
*/
export interface ChatMessageMetadata {
senderName?: string;
senderAvatar?: string;
originalRole?: 'teacher' | 'agent' | 'user';
actions?: MessageAction[];
agentId?: string;
agentColor?: string;
createdAt?: number;
interrupted?: boolean;
}
/**
* Action buttons that can be attached to messages
*/
export interface MessageAction {
id: string;
label: string;
icon?: string;
variant?: 'spotlight' | 'highlight' | 'reset' | 'insert' | 'draw';
}
/**
* Chat session representing a conversation with one or more agents
*/
export interface ChatSession {
id: string;
type: SessionType;
title: string;
status: SessionStatus;
messages: UIMessage<ChatMessageMetadata>[];
config: SessionConfig;
toolCalls: ToolCallRecord[];
pendingToolCalls: ToolCallRequest[];
createdAt: number;
updatedAt: number;
sceneId?: string;
lastActionIndex?: number;
}
/**
* Session configuration
*/
export interface SessionConfig {
agentIds: string[];
maxTurns: number;
currentTurn: number;
triggerAgentId?: string; // For discussion: first agent to speak
defaultAgentId?: string; // For QA: the responding agent
}
/**
* Pending tool call request sent to client for execution
*/
export interface ToolCallRequest {
toolCallId: string;
toolName: string;
args: Record<string, unknown>;
agentId: string;
status: 'pending' | 'executing';
requestedAt: number;
}
/**
* Completed tool call record with result
*/
export interface ToolCallRecord {
toolCallId: string;
toolName: string;
args: Record<string, unknown>;
agentId: string;
result?: unknown;
error?: string;
status: 'pending' | 'executing' | 'completed' | 'failed';
requestedAt: number;
completedAt?: number;
}
/**
* Server-Sent Event types for streaming session updates
*/
export type SessionEvent =
| { type: 'message'; data: UIMessage<ChatMessageMetadata> }
| {
type: 'tool_request';
data: { sessionId: string; toolCalls: ToolCallRequest[] };
}
| { type: 'tool_complete'; data: ToolCallRecord }
| {
type: 'agent_switch';
data: { fromAgentId: string | null; toAgentId: string };
}
| { type: 'session_status'; data: { status: SessionStatus; reason?: string } }
| { type: 'error'; data: { message: string } }
| { type: 'done'; data: SessionSummary }
| {
type: 'text_start';
data: { messageId: string; agentId: string; agentName: string };
}
| { type: 'text_delta'; data: { messageId: string; delta: string } }
| { type: 'text_end'; data: { messageId: string; content: string } };
/**
* Summary data sent when session completes
*/
export interface SessionSummary {
sessionId: string;
totalTurns: number;
totalMessages: number;
totalToolCalls: number;
endReason: string;
}
/**
* Request body for creating a new session
*/
export interface CreateSessionRequest {
type: SessionType;
title?: string;
trigger: {
message?: string;
agentIds: string[];
triggerAgentId?: string;
maxTurns?: number;
};
}
/**
* Request body for sending a message to a session
*/
export interface SendMessageRequest {
content: string;
apiKey?: string;
baseUrl?: string;
model?: string;
storeState: {
stage: unknown;
scenes: unknown[];
currentSceneId: string | null;
mode: 'autonomous' | 'playback';
whiteboardOpen: boolean;
};
}
/**
* Request body for submitting tool results
*/
export interface ToolResultsRequest {
results: ToolCallRecord[];
}
/**
* Session list item (without full messages for efficiency)
*/
export interface SessionListItem {
id: string;
type: SessionType;
title: string;
status: SessionStatus;
messageCount: number;
toolCallCount: number;
createdAt: number;
updatedAt: number;
}
/**
* Convert a full ChatSession to a list item (without messages)
*/
export function toSessionListItem(session: ChatSession): SessionListItem {
return {
id: session.id,
type: session.type,
title: session.title,
status: session.status,
messageCount: session.messages.length,
toolCallCount: session.toolCalls.length,
createdAt: session.createdAt,
updatedAt: session.updatedAt,
};
}
/**
* A single item in a lecture note — either speech text or an action badge.
* Ordered to match the original action sequence in the scene.
*/
export type LectureNoteItem =
| { kind: 'speech'; text: string }
| { kind: 'action'; type: string; label?: string };
/**
* A completed lecture note entry for one scene.
* Built from Scene.actions, displayed in the Notes tab.
*/
export interface LectureNoteEntry {
sceneId: string;
sceneTitle: string;
sceneOrder: number;
items: LectureNoteItem[];
completedAt: number;
}
// ==================== Stateless Multi-Agent API Types ====================
import type { Stage, Scene, StageMode } from '@/lib/types/stage';
import type { AgentTurnSummary, WhiteboardActionRecord } from '@/lib/orchestration/types';
/**
* Accumulated director state passed between per-agent requests.
* Client-maintained — backend is stateless.
*/
export interface DirectorState {
turnCount: number;
agentResponses: AgentTurnSummary[];
whiteboardLedger: WhiteboardActionRecord[];
}
/**
* Request body for the stateless chat API
* All state is sent from the client on each request
*/
export interface StatelessChatRequest {
/** Conversation history (client-maintained) */
messages: UIMessage<ChatMessageMetadata>[];
/** Current application state */
storeState: {
stage: Stage | null;
scenes: Scene[];
currentSceneId: string | null;
mode: StageMode;
whiteboardOpen: boolean;
};
/** Agent configuration */
config: {
agentIds: string[];
sessionType?: 'qa' | 'discussion';
/** Discussion topic (for agent-initiated discussions) */
discussionTopic?: string;
/** Discussion prompt (for agent-initiated discussions) */
discussionPrompt?: string;
/** Which agent should speak first in a discussion */
triggerAgentId?: string;
/** Full agent configs for generated (non-default) agents that aren't in the server-side registry */
agentConfigs?: Array<{
id: string;
name: string;
role: string;
persona: string;
avatar: string;
color: string;
allowedActions: string[];
priority: number;
isGenerated?: boolean;
boundStageId?: string;
}>;
};
/** Accumulated director state from previous per-agent requests */
directorState?: DirectorState;
/** User profile for personalization */
userProfile?: {
nickname?: string;
bio?: string;
};
/** OpenAI-compatible API credentials */
apiKey: string;
baseUrl?: string;
model?: string;
providerType?: string;
/**
* Opt-in: enable provider-side thinking for this request. Default is
* `{ enabled: false }` (low-latency chat). Eval harness sets this to
* `{ enabled: true }` when `EVAL_ENABLE_THINKING=1`.
*/
thinking?: ThinkingConfig;
/** UI-selected per-model thinking config. Takes precedence over `thinking`. */
thinkingConfig?: ThinkingConfig;
}
/**
* Parsed action from structured output
*/
export interface ParsedAction {
actionId: string;
actionName: string;
params: Record<string, unknown>;
}
/** @deprecated Use ParsedAction instead */
export type ParsedToolCall = ParsedAction;
/**
* Server-Sent Events for stateless chat API
*/
export type StatelessEvent =
| {
type: 'agent_start';
data: {
messageId: string;
agentId: string;
agentName: string;
agentAvatar?: string;
agentColor?: string;
};
}
| { type: 'agent_end'; data: { messageId: string; agentId: string } }
| { type: 'text_delta'; data: { content: string; messageId?: string } }
| {
type: 'action';
data: {
actionId: string;
actionName: string;
params: Record<string, unknown>;
agentId: string;
messageId?: string;
};
}
| {
type: 'thinking';
data: { stage: 'director' | 'agent_loading'; agentId?: string };
}
| { type: 'cue_user'; data: { fromAgentId?: string; prompt?: string } }
| {
type: 'done';
data: {
totalActions: number;
totalAgents: number;
agentHadContent?: boolean;
directorState?: DirectorState;
};
}
| { type: 'error'; data: { message: string } };
|