HookRunner

Constructors

Constructor

new HookRunner(hooks?, errorHandler?): HookRunner;

Parameters

Parameter	Type
`hooks`	`HarnessHooks`
`errorHandler?`	`HookErrorHandler`

Returns

HookRunner

Methods

getHooks()

getHooks(): HarnessHooks;

Returns

HarnessHooks

has()

has(hookName): boolean;

Check if a specific hook is configured.

Parameters

Parameter	Type
`hookName`	`string`

Returns

boolean

merge()

merge(additionalHooks): void;

Parameters

Parameter	Type
`additionalHooks`	`HarnessHooks`

Returns

void

onAgentEnd()

onAgentEnd(context, agentId): Promise<void>;

Parameters

Parameter	Type
`context`	`RunContext`
`agentId`	`string`

Returns

Promise<void>

onAgentStart()

onAgentStart(context, agentId): Promise<void>;

Parameters

Parameter	Type
`context`	`RunContext`
`agentId`	`string`

Returns

Promise<void>

onConversationEnd()

onConversationEnd(session, outcome): Promise<void>;

Parameters

Parameter	Type
`session`	`Session`
`outcome`	`ConversationOutcomeRecord`

Returns

Promise<void>

onEnd()

onEnd(context, result): Promise<void>;

Parameters

Parameter	Type
`context`	`RunContext`
`result`	{ `error?`: `Error`; `success`: `boolean`; }
`result.error?`	`Error`
`result.success`	`boolean`

Returns

Promise<void>

onError()

onError(context, error): Promise<void>;

Parameters

Parameter	Type
`context`	`RunContext`
`error`	`Error`

Returns

Promise<void>

onHandoff()

onHandoff(
   context,
   from,
   to,
reason): Promise<void>;

Parameters

Parameter	Type
`context`	`RunContext`
`from`	`string`
`to`	`string`
`reason`	`string`

Returns

Promise<void>

onMessage()

onMessage(context, message): Promise<void>;

Parameters

Parameter	Type
`context`	`RunContext`
`message`	`ModelMessage`

Returns

Promise<void>

onSessionEnd()

onSessionEnd(session, metadata): Promise<void>;

Parameters

Parameter	Type
`session`	`Session`
`metadata`	`SessionEndMetadata`

Returns

Promise<void>

onStart()

onStart(context): Promise<void>;

Parameters

Parameter	Type
`context`	`RunContext`

Returns

Promise<void>

onStepEnd()

onStepEnd(
   context,
   step,
result): Promise<void>;

Parameters

Parameter	Type
`context`	`RunContext`
`step`	`number`
`result`	`StepResult`

Returns

Promise<void>

onStepStart()

onStepStart(context, step): Promise<void>;

Parameters

Parameter	Type
`context`	`RunContext`
`step`	`number`

Returns

Promise<void>

onStreamPart()

onStreamPart(context, part): Promise<void>;

Parameters

Parameter	Type
`context`	`RunContext`
`part`	`HarnessStreamPart`

Returns

Promise<void>

onTokensUpdate()

onTokensUpdate(context, turn): Promise<void>;

Parameters

Parameter	Type
`context`	`RunContext`
`turn`	`TurnUsage`

Returns

Promise<void>

onToolCall()

onToolCall(context, call): Promise<void>;

Parameters

Parameter	Type
`context`	`RunContext`
`call`	`ToolCallRecord`

Returns

Promise<void>

onToolError()

onToolError(
   context,
   call,
error): Promise<void>;

Parameters

Parameter	Type
`context`	`RunContext`
`call`	`ToolCallRecord`
`error`	`Error`

Returns

Promise<void>

onToolResult()

onToolResult(context, call): Promise<void>;

Parameters

Parameter	Type
`context`	`RunContext`
`call`	`ToolCallRecord`

Returns

Promise<void>

onTurnEnd()

onTurnEnd(context, summary): Promise<void | TurnEndHookResult>;

Parameters

Parameter	Type
`context`	`RunContext`
`summary`	`TurnSummary`

Returns

Promise<void | TurnEndHookResult>

run()

run<K>(hookName, ...args): Promise<void>;

Type Parameters

Type Parameter
`K` extends keyof `HarnessHooks`

Parameters

Parameter	Type
`hookName`	`K`
…`args`	`NonNullable`<`HarnessHooks`[`K`]> extends (…`args`) => `unknown` ? `P` : `never`

Returns

Promise<void>

setHooks()

setHooks(hooks): void;

Parameters

Parameter	Type
`hooks`	`HarnessHooks`

Returns

void