HarnessSession
Generated by TypeDoc. Do not edit this page directly.
Interface: HarnessSession
Section titled “Interface: HarnessSession”Defined in: packages/core/src/session/types.ts:152
Properties
Section titled “Properties”| Property | Modifier | Type | Defined in |
|---|---|---|---|
id | readonly | string | packages/core/src/session/types.ts:153 |
snapshots | public | HarnessSnapshotSession | packages/core/src/session/types.ts:170 |
transcript | public | HarnessTranscriptSession | packages/core/src/session/types.ts:169 |
Methods
Section titled “Methods”approveTool()
Section titled “approveTool()”approveTool(approvalId): Promise<void>;Defined in: packages/core/src/session/types.ts:176
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
approvalId | string |
Returns
Section titled “Returns”Promise<void>
clearModelOverride()
Section titled “clearModelOverride()”clearModelOverride(): void;Defined in: packages/core/src/session/types.ts:161
Returns
Section titled “Returns”void
close()
Section titled “close()”close(): Promise<void>;Defined in: packages/core/src/session/types.ts:188
Returns
Section titled “Returns”Promise<void>
denyTool()
Section titled “denyTool()”denyTool(approvalId, reason?): Promise<void>;Defined in: packages/core/src/session/types.ts:177
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
approvalId | string |
reason? | string |
Returns
Section titled “Returns”Promise<void>
getAgentManifest()
Section titled “getAgentManifest()”getAgentManifest(): HarnessAgentManifest;Defined in: packages/core/src/session/types.ts:173
Returns
Section titled “Returns”getContextSnapshot()
Section titled “getContextSnapshot()”getContextSnapshot(): ContextSnapshot | undefined;Defined in: packages/core/src/session/types.ts:172
Returns
Section titled “Returns”ContextSnapshot | undefined
getEvents()
Section titled “getEvents()”getEvents(filter?): HarnessEventRecord<unknown>[];Defined in: packages/core/src/session/types.ts:171
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
filter? | HarnessEventQuery<unknown> |
Returns
Section titled “Returns”HarnessEventRecord<unknown>[]
getMode()
Section titled “getMode()”getMode(): string;Defined in: packages/core/src/session/types.ts:162
Returns
Section titled “Returns”string
getModel()
Section titled “getModel()”getModel(): string;Defined in: packages/core/src/session/types.ts:159
Returns
Section titled “Returns”string
getPendingApprovals()
Section titled “getPendingApprovals()”getPendingApprovals(): ToolApprovalHandle[];Defined in: packages/core/src/session/types.ts:175
Returns
Section titled “Returns”getState()
Section titled “getState()”getState(): AgentSharedState;Defined in: packages/core/src/session/types.ts:165
Returns
Section titled “Returns”getStatus()
Section titled “getStatus()”getStatus(): HarnessSessionStatus;Defined in: packages/core/src/session/types.ts:158
Returns
Section titled “Returns”on(listener): () => void;Defined in: packages/core/src/session/types.ts:179
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
listener | HarnessSessionListener |
Returns
Section titled “Returns”() => void
onEvent()
Section titled “onEvent()”onEvent<TPayload, TEvent>(eventClass, listener): () => void;Defined in: packages/core/src/session/types.ts:180
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
TPayload |
TEvent extends HarnessEvent<TPayload> |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
eventClass | HarnessEventClass<TPayload, TEvent> |
listener | HarnessSessionEventListener<TEvent> |
Returns
Section titled “Returns”() => void
replaceState()
Section titled “replaceState()”replaceState(next): void;Defined in: packages/core/src/session/types.ts:167
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
next | AgentSharedState |
Returns
Section titled “Returns”void
send()
Section titled “send()”send(input, options?): Promise<SendResult>;Defined in: packages/core/src/session/types.ts:155
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | string | HarnessUserInput |
options? | SendOptions |
Returns
Section titled “Returns”Promise<SendResult>
setModel()
Section titled “setModel()”setModel(model): void;Defined in: packages/core/src/session/types.ts:160
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
model | string |
Returns
Section titled “Returns”void
stream()
Section titled “stream()”stream(input, options?): HarnessRunStream;Defined in: packages/core/src/session/types.ts:156
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | string | HarnessUserInput |
options? | StreamOptions |
Returns
Section titled “Returns”switchMode()
Section titled “switchMode()”switchMode(mode, input?): Promise<void>;Defined in: packages/core/src/session/types.ts:163
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
mode | | string | HarnessModeSelector |
input? | unknown |
Returns
Section titled “Returns”Promise<void>
updateState()
Section titled “updateState()”updateState(patch): void;Defined in: packages/core/src/session/types.ts:166
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
patch | unknown |
Returns
Section titled “Returns”void
waitForEvent()
Section titled “waitForEvent()”waitForEvent<TPayload, TEvent>(eventClass, options?): Promise<TEvent>;Defined in: packages/core/src/session/types.ts:184
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
TPayload |
TEvent extends HarnessEvent<TPayload> |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
eventClass | HarnessEventClass<TPayload, TEvent> |
options? | WaitForEventOptions |
Returns
Section titled “Returns”Promise<TEvent>