Skip to main content

Interface: Dialect

Properties​

browserToolsHint?​

readonly optional browserToolsHint?: string

capabilities?​

readonly optional capabilities?: Partial<BackendCapabilities>

defaultCmd​

readonly defaultCmd: string

finishMissionOnExit​

readonly finishMissionOnExit: boolean

hostedConnectors​

readonly hostedConnectors: boolean

id​

readonly id: string

localEnv?​

readonly optional localEnv?: LocalEnvPolicy

maxPromptBytes?​

readonly optional maxPromptBytes?: number

permissionModel​

readonly permissionModel: "none" | "mcp-bridge" | "sandbox" | "protocol"

permissionsHint?​

readonly optional permissionsHint?: string

persistentProcess​

readonly persistentProcess: boolean

rateLimitReporting​

readonly rateLimitReporting: "none" | "structured" | "textual"

sessionResumable​

readonly sessionResumable: boolean

sessionStore​

readonly sessionStore: "global" | "per-mission"

thinkingControls?​

readonly optional thinkingControls?: readonly ("levels" | "budget" | "toggle")[]

Methods​

accountUsage()?​

optional accountUsage(profile): Promise<AccountUsage | null>

Parameters​

profile​

ProfileRuntime

Returns​

Promise<AccountUsage | null>

buildSpawn()​

buildSpawn(opts, profile): Promise<SpawnResult>

Parameters​

opts​

BuildSpawnOpts

profile​

ProfileRuntime

Returns​

Promise<SpawnResult>

discoverModels()?​

optional discoverModels(profile): Promise<(string | DiscoveredModel)[]>

Parameters​

profile​

ProfileRuntime

Returns​

Promise<(string | DiscoveredModel)[]>

dispose()?​

optional dispose(missionId): void

Parameters​

missionId​

string

Returns​

void

enrichEvent()?​

optional enrichEvent(ev, missionId): NormalizedEvent

Parameters​

ev​

NormalizedEvent

missionId​

string

Returns​

NormalizedEvent

extractSessionId()​

extractSessionId(ev): string | null

Parameters​

ev​

NormalizedEvent

Returns​

string | null

isSessionNotFoundError()?​

optional isSessionNotFoundError(stderr): boolean

Parameters​

stderr​

string

Returns​

boolean

openSession()?​

optional openSession(args): SessionDriver

Parameters​

args​

SessionOpenArgs

Returns​

SessionDriver

parseLine()​

parseLine(line): NormalizedEvent[]

Parameters​

line​

string

Returns​

NormalizedEvent[]

permissionsByAgent()?​

optional permissionsByAgent(profileId): boolean

Parameters​

profileId​

string

Returns​

boolean

setModel()?​

optional setModel(proc, model): Promise<boolean>

Parameters​

proc​

ChildProcessWithoutNullStreams

model​

string

Returns​

Promise<boolean>

spans()?​

optional spans(ev, state, eventId): SpanOp[]

Parameters​

ev​

NormalizedEvent

state​

SpanState

eventId​

number

Returns​

SpanOp[]

writeUserInput()​

writeUserInput(proc, text, images?): void

Parameters​

proc​

ChildProcessWithoutNullStreams

text​

string

images?​

ImageAttachment[]

Returns​

void