AgentLifecycleOptions
Agent Runtimes / hooks/useCheckpoints / AgentLifecycleOptions
Interface: AgentLifecycleOptions
Defined in: hooks/useCheckpoints.ts:391
Options for useAgentLifecycle.
Properties
agentSpec?
optionalagentSpec?:Record<string,any>
Defined in: hooks/useCheckpoints.ts:395
Full agent spec object (persisted with checkpoints)
agentSpecId?
optionalagentSpecId?:string
Defined in: hooks/useCheckpoints.ts:393
Agent spec ID (identifies the agent for lifecycle management)
connectToRuntime
connectToRuntime: (
opts) =>void
Defined in: hooks/useCheckpoints.ts:399
Callback to connect to a new runtime pod
Parameters
opts
environmentName
string
jupyterBaseUrl?
string
podName
string
Returns
void
disconnect
disconnect: () =>
void
Defined in: hooks/useCheckpoints.ts:405
Callback to disconnect from the runtime
Returns
void
launchRuntime
launchRuntime: () =>
Promise<AgentConnection>
Defined in: hooks/useCheckpoints.ts:407
Callback to launch a new runtime
Returns
Promise<AgentConnection>
onResetAgentCreation?
optionalonResetAgentCreation?: () =>void
Defined in: hooks/useCheckpoints.ts:412
Callback fired when the hook needs to signal that the agent should be re-created on a (possibly new) pod.
Returns
void
runtime
runtime:
AgentConnection|null
Defined in: hooks/useCheckpoints.ts:397
Current runtime connection from the agent store