Skip to content
v9.1.1
Français

Turn

import type { Turn } from "@elie-laloum/outpost";

Parameters and properties

Section titled “Parameters and properties”
  • textRequired
    string
    Text of this turn.
  • statusRequired
    number
    Exit status of the agent process. Always 0 in a returned turn: a nonzero status fails the dispatch.
  • interruptedOptional
    "steering" | undefined
    steering when Outpost stopped this turn to resume its conversation with a steering instruction; the next turn continues it. Absent for turns that ended on their own.
  • conversationOptional
    string | undefined
    Native conversation id after this turn, when the agent reported one.
  • transcriptOptional
    string | undefined
    Host path of the transcript captured after this turn.
  • transcriptReferenceOptional
    TransportReference | undefined
    Pinned remote index of the conversation captured after this turn; its local transcript remains available separately.
  • usageRequired
    Usage
    Token counters reported for this turn; not a cost.
  • durationMsRequired
    number
    Duration of this turn in milliseconds.

Signature

Section titled “Signature”
export interface Turn {
  readonly text: string;
  readonly status: number;
  /** Set when steering stopped this turn to resume the conversation with new instructions. */
  readonly interrupted?: "steering";
  readonly conversation?: string;
  readonly transcript?: string;
  readonly transcriptReference?: TransportReference;
  readonly usage: Usage;
  readonly durationMs: number;
}
Section titled “Related contracts”