HarnessHooks

Properties

onAgentEnd?

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

Parameters

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

Returns

Promise<void>

onAgentStart?

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

Parameters

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

Returns

Promise<void>

onBeforeModelCall?

optional onBeforeModelCall?: (context, data) => Promise<
  | void
| BeforeModelCallResult>;

Parameters

Parameter	Type
`context`	`RunContext`
`data`	`BeforeModelCallData`

Returns

Promise< | void | BeforeModelCallResult>

onConversationEnd?

optional onConversationEnd?: (session, outcome) => Promise<
  | void
  | {
  csatChannel?: "email" | "sms" | "in-app";
  csatInvited: boolean;
}>;

Parameters

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

Returns

Promise< | void | { csatChannel?: "email" | "sms" | "in-app"; csatInvited: boolean; }>

onEnd?

optional 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?

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

Parameters

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

Returns

Promise<void>

onHandoff?

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

Parameters

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

Returns

Promise<void>

onMemoryIngest?

optional onMemoryIngest?: (context, session) => Promise<boolean | void>;

Parameters

Parameter	Type
`context`	`RunContext`
`session`	`Session`

Returns

Promise<boolean | void>

onMemoryIngested?

optional onMemoryIngested?: (context, session) => Promise<void>;

Parameters

Parameter	Type
`context`	`RunContext`
`session`	`Session`

Returns

Promise<void>

onMessage?

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

Parameters

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

Returns

Promise<void>

onPersistenceError?

optional onPersistenceError?: (session, error) => Promise<void>;

Parameters

Parameter	Type
`session`	`Session`
`error`	`Error`

Returns

Promise<void>

onSessionEnd?

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

Parameters

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

Returns

Promise<void>

onStart?

optional onStart?: (context) => Promise<void>;

Parameters

Parameter	Type
`context`	`RunContext`

Returns

Promise<void>

onStepEnd?

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

Parameters

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

Returns

Promise<void>

onStepStart?

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

Parameters

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

Returns

Promise<void>

onStreamPart?

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

Parameters

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

Returns

Promise<void>

onTokensUpdate?

optional onTokensUpdate?: (context, turn) => void | Promise<void>;

Parameters

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

Returns

void | Promise<void>

onToolCall?

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

Parameters

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

Returns

Promise<void>

onToolError?

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

Parameters

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

Returns

Promise<void>

onToolResult?

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

Parameters

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

Returns

Promise<void>

onTurnEnd?

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

Parameters

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

Returns

Promise<void | TurnEndHookResult>