WarmDispatchResult

Parameters and properties

• resumeRequired
  <U = undefined>(options: DispatchOptions<U>) => Promise<WarmDispatchResult<U>>
  Continue this conversation on the same open sandbox with new dispatch options.
• forkRequired
  <U = undefined>(options: DispatchOptions<U>) => Promise<WarmDispatchResult<U>>
  Continue a copy of this conversation on the same open sandbox, leaving the original unchanged.
• completionOptional
  string | undefined
  Completion marker found in the last turn’s text.
• textRequired
  string
  Text of every turn of the execution, joined with newlines, including response repair turns.
• conversationOptional
  string | undefined
  Native conversation id of the last turn, when the agent reported one.
• usageRequired
  Usage
  Token counters summed over every turn; not a cost.
• fallbackOptional
  FallbackRecord | undefined
  Present only when the dispatch used a fallback agent: the candidate that produced this result and the candidates that stopped before it.
• completedRequired
  boolean
  True when the last turn’s text contains a completion marker, or when a typed response was validated.
• branchRequired
  string
  Work branch of this dispatch.
• observerErrorsOptional
  readonly unknown[] | undefined
  Sink and journal failures collected during the dispatch; they do not affect success. With a shared hub, also includes its earlier failures.
• directoryRequired
  string
  Host worktree directory of this dispatch.
• commitsRequired
  readonly Commit[]
  Commits created during the dispatch, as oid and subject; with several passes, the commits of every pass.
• transcriptOptional
  string | undefined
  Host path of the captured native transcript, when the agent’s conversation was captured.
• transcriptReferenceOptional
  TransportReference | undefined
  Pinned remote index for the final captured conversation, when using transported conversation storage.
• logReferenceOptional
  TransportReference | undefined
  Versioned journal index for readJournal, for both local and remote persistence. Absent when logging is disabled or directed to stdout.
• retainedDirectoryOptional
  string | undefined
  Worktree kept after closing because it was detached or held uncommitted changes.
• turnsRequired
  readonly Turn[]
  Every turn in order, including response repairs and turns resumed by steering.
• valueRequired
  T
  Parsed and validated response; undefined without a response option.

Signature

export interface WarmDispatchResult<T> extends Omit<
  DispatchResult<T>,
  "resume" | "fork"
> {
  resume<U = undefined>(
    options: DispatchOptions<U>,
  ): Promise<WarmDispatchResult<U>>;
  fork<U = undefined>(
    options: DispatchOptions<U>,
  ): Promise<WarmDispatchResult<U>>;
}

Related contracts

• DispatchOptions
• DispatchResult