Interface CompiledStrategyStreamResult

Internal stream result shape returned by compiled agency strategies.

Strategy compilers may return only the live iterables plus aggregate promises. The outer agency() wrapper can enrich this into the public AgencyStreamResult.

This type exists for strategy authors. Most external callers should consume AgencyStreamResult from agency().stream(...) instead.

interface CompiledStrategyStreamResult {
    textStream?: AsyncIterable<string, any, any>;
    fullStream?: AsyncIterable<AgencyStreamPart, any, any>;
    text?: Promise<string>;
    usage?: Promise<{
        promptTokens: number;
        completionTokens: number;
        totalTokens: number;
        costUSD?: number;
        cacheReadTokens?: number;
        cacheCreationTokens?: number;
    }>;
    agentCalls?: Promise<AgentCallRecord[]>;
    result?: Promise<Record<string, unknown>>;
}

Properties

textStream? fullStream? text? usage? agentCalls? result?

Properties

Optional textStream

textStream?: AsyncIterable<string, any, any>

Raw live text chunks from the strategy.

Optional fullStream

fullStream?: AsyncIterable<AgencyStreamPart, any, any>

Structured live stream parts from the strategy.

Optional text

text?: Promise<string>

Final raw text assembled by the strategy, when available.

Optional usage

usage?: Promise<{
    promptTokens: number;
    completionTokens: number;
    totalTokens: number;
    costUSD?: number;
    cacheReadTokens?: number;
    cacheCreationTokens?: number;
}>

Aggregate usage for the strategy run, when available.

Type declaration

  • promptTokens: number
  • completionTokens: number
  • totalTokens: number
  • Optional costUSD?: number
  • Optional cacheReadTokens?: number
  • Optional cacheCreationTokens?: number

Optional agentCalls

agentCalls?: Promise<AgentCallRecord[]>

Final per-agent ledger for the strategy run, when available.

Optional result

result?: Promise<Record<string, unknown>>

The strategy's whole result, when it has more than text, usage and agent calls (a panel's ledger). The agency wrapper merges it into the finalized result.

Settings

Member Visibility

Theme

On This Page

textStreamfullStreamtextusageagentCallsresult