ControlSurface
Auto-generated API reference for ControlSurface.
Interface: ControlSurface
Defined in: observability/src/prod-control.ts:74
#Properties
#awaitResume
awaitResume: (
runId) =>Promise<void>
Defined in: observability/src/prod-control.ts:93
Hook the runtime calls between iterations. Resolves immediately
when the run is not paused; otherwise waits for resume /
step.
#Parameters
runId
string
#Returns
Promise<void>
#consumeOverride
consumeOverride: (
runId,tool) =>ToolOverride|undefined
Defined in: observability/src/prod-control.ts:99
Hook the runtime calls before invoking a tool. Returns the forced result if an override is queued; otherwise undefined and the tool runs normally.
#Parameters
runId
string
tool
string
#Returns
ToolOverride | undefined
#httpHandler
httpHandler: () => (
req) =>Promise<{body:unknown;status:number; }>
Defined in: observability/src/prod-control.ts:104
HTTP request handler — drop into any Node http / Express /
Hono route. Bearer-token gated.
#Returns
(req) => Promise<{ body: unknown; status: number; }>
#inject
inject: (
runId,override,actor?) =>void
Defined in: observability/src/prod-control.ts:83
Inject a tool override consumed by the next matching tool call.
#Parameters
runId
string
override
actor?
string
#Returns
void
#observer
observer:
Observer
Defined in: observability/src/prod-control.ts:76
Plug into createRuntime(\{ observers: [control.observer] \}).
#pause
pause: (
runId,actor?) =>void
Defined in: observability/src/prod-control.ts:78
Pause the loop for runId. The runtime hook awaits a resume / step.
#Parameters
runId
string
actor?
string
#Returns
void
#replay
replay: (
snapshot,actor?) =>void
Defined in: observability/src/prod-control.ts:87
Restore a snapshot's pending overrides + paused state. Replay events are NOT reused — replay against your own runtime.
#Parameters
snapshot
actor?
string
#Returns
void
#resume
resume: (
runId,actor?) =>void
Defined in: observability/src/prod-control.ts:79
#Parameters
runId
string
actor?
string
#Returns
void
#snapshot
snapshot: (
runId,metadata?) =>RunSnapshot
Defined in: observability/src/prod-control.ts:85
Capture a snapshot for a support ticket.
#Parameters
runId
string
metadata?
Record<string, unknown>
#Returns
#step
step: (
runId,actor?) =>void
Defined in: observability/src/prod-control.ts:81
Allow exactly one more iteration on a paused run.
#Parameters
runId
string
actor?
string
#Returns
void