Interface IOutlineResult<Data, Param>

Interface representing the result of an outline operation. Encapsulates the outcome, including validity, execution details, and history.

interface IOutlineResult<
    Data extends IOutlineData = IOutlineData,
    Param extends IOutlineParam = IOutlineParam,
> {
    attempt: number;
    data: Data;
    error?: string;
    history: IOutlineMessage[];
    isValid: boolean;
    param: Param;
    resultId: string;
}

Type Parameters

  • Data extends IOutlineData = IOutlineData

    The type of the data param, defaults to IOutlineData.

  • Param extends IOutlineParam = IOutlineParam

    The type of the input param, defaults to IOutlineParam. IOutlineResult

Properties

attempt data error? history isValid param resultId

Properties

attempt

attempt: number

The attempt number for this outline operation. Tracks the retry or iteration count for the operation.

data

data: Data

The data param generated by the outline operation. Null if the operation fails or no data is produced.

Optionalerror

error?: string

Optional error message if the outline operation or validation fails. Null if no error occurs.

history

history: IOutlineMessage[]

The history of messages associated with the outline operation. Contains the sequence of user, assistant, or system messages.

isValid

isValid: boolean

Indicates whether the outline data is valid based on validation checks. True if all validations pass, false otherwise.

param

param: Param

The input param used for the outline operation. Reflects the original param provided in the arguments.

resultId

resultId: string

The unique identifier for the execution instance of the outline operation. Used for tracking or debugging specific runs.

Settings

Member Visibility

On This Page

Properties