AgentSessionRunner

Generated by TypeDoc. Do not edit this page directly.

Class: AgentSessionRunner

Defined in: packages/core/src/runtime/runner.ts:308

Constructors

Constructor

new AgentSessionRunner(options): AgentSessionRunner;

Defined in: packages/core/src/runtime/runner.ts:343

Parameters

Parameter	Type
`options`	`AgentSessionRunnerOptions`

Returns

AgentSessionRunner

Properties

Property	Modifier	Type	Defined in
`agent`	`readonly`	`NormalizedAgentDefinition`	packages/core/src/runtime/runner.ts:309
`outputDir`	`readonly`	`string`	packages/core/src/runtime/runner.ts:311
`workDir`	`readonly`	`string`	packages/core/src/runtime/runner.ts:310

Accessors

mode

Get Signature

get mode(): string;

Defined in: packages/core/src/runtime/runner.ts:607

Returns

string

runId

Get Signature

get runId(): string;

Defined in: packages/core/src/runtime/runner.ts:611

Returns

string

Methods

clearModelOverride()

clearModelOverride(): void;

Defined in: packages/core/src/runtime/runner.ts:841

Returns

void

close()

close(): Promise<void>;

Defined in: packages/core/src/runtime/runner.ts:805

Returns

Promise<void>

createSnapshot()

createSnapshot(input?, eventOptions?): Promise<HarnessSnapshot>;

Defined in: packages/core/src/runtime/runner.ts:911

Parameters

Parameter	Type
`input?`	`HarnessSnapshotInput`
`eventOptions?`	`HarnessEventEmitOptions`

Returns

Promise<HarnessSnapshot>

deleteSnapshot()

deleteSnapshot(id, eventOptions?): Promise<boolean>;

Defined in: packages/core/src/runtime/runner.ts:930

Parameters

Parameter	Type
`id`	`string`
`eventOptions?`	`HarnessEventEmitOptions`

Returns

Promise<boolean>

getAgentManifest()

getAgentManifest(): HarnessAgentManifest;

Defined in: packages/core/src/runtime/runner.ts:864

Returns

HarnessAgentManifest

getAvailableModels()

getAvailableModels(): object[];

Defined in: packages/core/src/runtime/runner.ts:853

Returns

object[]

getContextEntries()

getContextEntries(filter?): ContextEntry[];

Defined in: packages/core/src/runtime/runner.ts:938

Parameters

Parameter	Type
`filter?`	`ContextEntryFilter`

Returns

ContextEntry[]

getContextSnapshot()

getContextSnapshot(): ContextSnapshot | undefined;

Defined in: packages/core/src/runtime/runner.ts:934

Returns

ContextSnapshot | undefined

getEvents()

getEvents(filter?): HarnessEventRecord<unknown>[];

Defined in: packages/core/src/runtime/runner.ts:879

Parameters

Parameter	Type
`filter?`	`HarnessEventQuery`<`unknown`>

Returns

HarnessEventRecord<unknown>[]

getMetrics()

getMetrics(): RunMetrics;

Defined in: packages/core/src/runtime/runner.ts:814

Returns

RunMetrics

getModel()

getModel(): string;

Defined in: packages/core/src/runtime/runner.ts:833

Returns

string

getModelProviderInfo()

getModelProviderInfo(): ModelProviderInfo;

Defined in: packages/core/src/runtime/runner.ts:845

Returns

ModelProviderInfo

getRunInfo()

getRunInfo(): object;

Defined in: packages/core/src/runtime/runner.ts:822

Returns

object

agentKey

agentKey: string;

outputDir

outputDir: string | undefined;

runId

runId: string;

started

started: boolean;

startedAt

startedAt: string;

workDir

workDir: string;

getSnapshot()

getSnapshot(id): HarnessSnapshot | undefined;

Defined in: packages/core/src/runtime/runner.ts:922

Parameters

Parameter	Type
`id`	`string`

Returns

HarnessSnapshot | undefined

getState()

getState(): AgentSharedState;

Defined in: packages/core/src/runtime/runner.ts:895

Returns

AgentSharedState

getTranscript()

getTranscript(options?): AgentMessage[];

Defined in: packages/core/src/runtime/runner.ts:810

Parameters

Parameter	Type
`options?`	`TranscriptQuery`

Returns

AgentMessage[]

getTranscriptCursor()

getTranscriptCursor(): TranscriptCursor;

Defined in: packages/core/src/runtime/runner.ts:883

Returns

TranscriptCursor

hydrate()

hydrate(): Promise<void>;

Defined in: packages/core/src/runtime/runner.ts:800

Returns

Promise<void>

latestTranscript()

latestTranscript(): Promise<TranscriptCursor>;

Defined in: packages/core/src/runtime/runner.ts:891

Returns

Promise<TranscriptCursor>

listSnapshots()

listSnapshots(): HarnessSnapshotSummary[];

Defined in: packages/core/src/runtime/runner.ts:918

Returns

HarnessSnapshotSummary[]

prompt()

prompt(message, options?): Promise<AgentRunResult>;

Defined in: packages/core/src/runtime/runner.ts:781

Parameters

Parameter	Type
`message`	`string`
`options`	`AgentRunnerRunOptions`

Returns

Promise<AgentRunResult>

replaceState()

replaceState(next): void;

Defined in: packages/core/src/runtime/runner.ts:907

Parameters

Parameter	Type
`next`	`AgentSharedState`

Returns

void

requestTurnHandoff()

requestTurnHandoff(): void;

Defined in: packages/core/src/runtime/runner.ts:619

Returns

void

restoreSnapshot()

restoreSnapshot(id, eventOptions?): Promise<HarnessSnapshot>;

Defined in: packages/core/src/runtime/runner.ts:926

Parameters

Parameter	Type
`id`	`string`
`eventOptions?`	`HarnessEventEmitOptions`

Returns

Promise<HarnessSnapshot>

run()

run(message, options?): Promise<AgentRunResult>;

Defined in: packages/core/src/runtime/runner.ts:690

Parameters

Parameter	Type
`message`	`string`
`options`	`AgentRunnerRunOptions`

Returns

Promise<AgentRunResult>

seekTranscript()

seekTranscript(target): Promise<TranscriptCursor>;

Defined in: packages/core/src/runtime/runner.ts:887

Parameters

Parameter	Type
`target`	`TranscriptSeekTarget`

Returns

Promise<TranscriptCursor>

setModel()

setModel(model): void;

Defined in: packages/core/src/runtime/runner.ts:837

Parameters

Parameter	Type
`model`	`string`

Returns

void

subscribe(listener): () => void;

Defined in: packages/core/src/runtime/runner.ts:615

Parameters

Parameter	Type
`listener`	`RunnerEventListener`

Returns

() => void

switchMode()

switchMode(mode, input?): Promise<void>;

Defined in: packages/core/src/runtime/runner.ts:942

Parameters

Parameter	Type
`mode`	`HarnessModeSelector`
`input?`	`unknown`

Returns

Promise<void>

updateState()

updateState(patch): void;

Defined in: packages/core/src/runtime/runner.ts:899

Parameters

Parameter	Type
`patch`	`unknown`

Returns

void