Runtime

Constructors

Constructor

new Runtime(config): Runtime;

Parameters

Parameter	Type
config	HarnessConfig

Returns

Runtime

Methods

abortSession()

abortSession(sessionId, reason?): void;

Parameters

Parameter	Type
sessionId	string
reason?	string

Returns

void

---

addDynamicFlows()

addDynamicFlows(defs, opts): Promise<void>;

Atomically register a bundle of stored flow definitions on a live agent.

Persistence is not transactional across rows. On failure the in-memory catalog rolls back this bundle’s registrations; members that already persisted are best-effort archived so a later loadDynamicFlows does not resurrect them.

Reusing an existing dynamic name is rejected unless replace: true.

Parameters

Parameter	Type
defs	readonly AuthoringFlowDefinition[]
opts	{ agentId: string; compiler?: | LanguageModel | NlPredicateProvider; replace?: boolean; store?: FlowDefinitionsStore; }
opts.agentId	string
opts.compiler?	| LanguageModel | NlPredicateProvider
opts.replace?	boolean
opts.store?	FlowDefinitionsStore

Returns

Promise<void>

---

deleteSession()

deleteSession(sessionId): Promise<void>;

Parameters

Parameter	Type
sessionId	string

Returns

Promise<void>

---

getConversationLength()

getConversationLength(sessionId): Promise<number>;

Parameters

Parameter	Type
sessionId	string

Returns

Promise<number>

---

getDefaultAgentId()

getDefaultAgentId(): string;

The agent used when neither the caller nor persisted state names one.

Returns

string

---

getRun()

getRun(runId, sessionId?): Promise<RunHandle | null>;

Parameters

Parameter	Type
runId	string
sessionId?	string

Returns

Promise<RunHandle | null>

---

getRunStore()

getRunStore(): RunStore;

Returns

RunStore

---

getSession()

getSession(sessionId): Promise<Session | null>;

Parameters

Parameter	Type
sessionId	string

Returns

Promise<Session | null>

---

getSessionStore()

getSessionStore(): SessionStore;

Returns

SessionStore

---

getTrace()

getTrace(traceId): Promise<AgentTrace | null>;

Parameters

Parameter	Type
traceId	string

Returns

Promise<AgentTrace | null>

---

getTraceStore()

getTraceStore(): TraceStore | undefined;

Returns

TraceStore | undefined

---

listTraces()

listTraces(sessionId): Promise<AgentTrace[]>;

Parameters

Parameter	Type
sessionId	string

Returns

Promise<AgentTrace[]>

---

loadDynamicFlows()

loadDynamicFlows(opts): Promise<void>;

Load status: 'active' versions onto the agent’s live catalog. Per-row failures are logged and skipped so one corrupt definition cannot sink boot.

Parameters

Parameter	Type
opts	{ agentId: string; store?: FlowDefinitionsStore; }
opts.agentId	string
opts.store?	FlowDefinitionsStore

Returns

Promise<void>

---

markOutcome()

markOutcome(
   sessionId,
   outcome,
opts?): Promise<void>;

Parameters

Parameter	Type
sessionId	string
outcome	ConversationOutcome
opts?	{ markedBy?: ConversationOutcomeMarkedBy; reason?: string; }
opts.markedBy?	ConversationOutcomeMarkedBy
opts.reason?	string

Returns

Promise<void>

---

removeDynamicFlow()

removeDynamicFlow(name, opts): Promise<boolean>;

Drop a dynamic flow from this runtime’s live catalog.

The store row stays active; a later loadDynamicFlows (including boot) will reload it unless the caller archives the name first.

Parameters

Parameter	Type
name	string
opts	{ agentId: string; }
opts.agentId	string

Returns

Promise<boolean>

---

replayAuditLog()

replayAuditLog(sessionId, opts?): Promise<ConversationAuditEntry[]>;

Parameters

Parameter	Type
sessionId	string
opts?	AuditListOptions

Returns

Promise<ConversationAuditEntry[]>

---

resumeFromEscalation()

resumeFromEscalation(sessionId, opts?): Promise<void>;

Hand the conversation back to the bot after a human resolved an escalation: appends a resolution note the model will see, clears any parked flow/escalation state, and marks the run runnable again. The next run() continues the conversation with full context.

Parameters

Parameter	Type
sessionId	string
opts?	{ resolutionSummary?: string; }
opts.resolutionSummary?	string

Returns

Promise<void>

---

run()

run(opts): TurnHandle;

Parameters

Parameter	Type
opts	RunOptions

Returns

TurnHandle

---

runOnce()

runOnce(opts): Promise<AgentTrace>;

Parameters

Parameter	Type
opts	RunOptions

Returns

Promise<AgentTrace>

---

settled()

settled(): Promise<void>;

Resolves once every in-flight background extraction has settled.

Returns

Promise<void>

---

stream()

stream(opts): TurnHandle;

Parameters

Parameter	Type
opts	RunOptions

Returns

TurnHandle