Type Alias TConversation

The conversation object. Methods:

turn(stage, input, opts?) — run one turn
close() — seal the conversation (finalize calls this)

.turn after .close() throws ConversationClosedError.

type TConversation = {
    closed: boolean;
    lastResponseId: TResponseId | null;
    tokenUsage: TLlmTokenUsage;
    close(): void;
    turn<TOut>(
        stage: TStage<TOut>,
        input: TTurnInput,
        opts?: { branchFrom?: TResponseId; onComplete?: () => void },
    ): Promise<TTurnResult<TOut>>;
}

Index

Properties

closed lastResponseId tokenUsage

Methods

Properties

`Readonly`closed

closed: boolean

Whether the conversation has been closed.

`Readonly`lastResponseId

lastResponseId: TResponseId | null

The latest provider response id in the chain.

`Readonly`tokenUsage

tokenUsage: TLlmTokenUsage

Cumulative token usage across all turns.

Methods

close

close(): void
Seal the conversation. Subsequent .turn calls throw.

Returns void
- Defined in src/lib/conversation/conversation.ts:43

turn

turn<TOut>(
    stage: TStage<TOut>,
    input: TTurnInput,
    opts?: { branchFrom?: TResponseId; onComplete?: () => void },
): Promise<TTurnResult<TOut>>
Run one turn: execute the stage, thread previousResponseId (from branchFrom or the last response id), and return the result including the new response id.
Type Parameters
- TOut
Parameters
- stage: TStage<TOut>
- input: TTurnInput
- Optionalopts: { branchFrom?: TResponseId; onComplete?: () => void }
Returns Promise<TTurnResult<TOut>>
- Defined in src/lib/conversation/conversation.ts:31