Interface ImageGenerationStreamCapability<TInput, TOutput>

Provider-agnostic streaming image generation capability interface.

Allows receiving partial image data streams.

interface ImageGenerationStreamCapability<
    TInput = any,
    TOutput = NormalizedImage[],
> {
    generateImageStream(
        request: AIRequest<TInput>,
        ctx: MultiModalExecutionContext,
        signal?: AbortSignal,
    ): AsyncGenerator<AIResponseChunk<TOutput>>;
}

Type Parameters

TInput = any
Input type for the image generation request.
TOutput = NormalizedImage[]
Output type for streamed image data.

Hierarchy (View Summary)

ProviderCapability
- ImageGenerationStreamCapability

Implemented by

Index

Methods

generateImageStream

Methods

generateImageStream

generateImageStream(
    request: AIRequest<TInput>,
    ctx: MultiModalExecutionContext,
    signal?: AbortSignal,
): AsyncGenerator<AIResponseChunk<TOutput>>
Stream image generation results as they are produced.
Parameters
- request: AIRequest<TInput>
  AIRequest containing image generation input.
- ctx: MultiModalExecutionContext
  Execution context.
- Optionalsignal: AbortSignal
  Optional abort signal.
Returns AsyncGenerator<AIResponseChunk<TOutput>>
Async generator yielding response chunks.
- Defined in src/core/provider/capabilities/ImageCapability.ts:56