Interface StreamingExecutor<C, TInput, TOutput>

Executor contract for streaming capabilities.

interface StreamingExecutor<C extends CapabilityKeyType, TInput, TOutput> {
    streaming: true;
    invoke(
        capability: CapabilityFor<C>,
        input: AIRequest<TInput>,
        ctx: MultiModalExecutionContext,
        signal?: AbortSignal,
    ): AsyncGenerator<AIResponseChunk<TOutput>>;
}

Type Parameters

C extends CapabilityKeyType
Capability key type
TInput
Request input type
TOutput
Final output type

Index

Properties

Methods

Properties

streaming

streaming: true

Discriminator indicating this executor yields chunks.

Methods

invoke

invoke(
    capability: CapabilityFor<C>,
    input: AIRequest<TInput>,
    ctx: MultiModalExecutionContext,
    signal?: AbortSignal,
): AsyncGenerator<AIResponseChunk<TOutput>>
Invokes the streaming capability.
Parameters
- capability: CapabilityFor<C>
  The provider capability implementation.
- input: AIRequest<TInput>
  The AIRequest input.
- ctx: MultiModalExecutionContext
  The multimodal execution context.
- Optionalsignal: AbortSignal
  Optional abort signal.
Returns AsyncGenerator<AIResponseChunk<TOutput>>
Async generator yielding response chunks.
- Defined in src/core/provider/CapabilityExecutorRegistry.ts:47