Interface StepResult

The result of executing a single step.

const stepResult: StepResult = {
  name: 'analyze',
  iterations: 3,
  success: true,
  usage: { tokens: 500, cost: 0.001, duration: 1200 }
};

interface StepResult {
    name: string;
    iterations: number;
    success: boolean;
    error?: string;
    usage?: Usage;
}

Properties

name: string

The name of the step that was executed.

iterations: number

Number of iterations run before the predicate was satisfied or maxIter was reached.

success: boolean

Whether the step completed successfully. False if the predicate was not satisfied within maxIter, or if an error occurred.

error?: string

Error message if the step failed. Only present if success is false.

usage?: Usage

Usage statistics for this step only. Accumulated across all iterations.