Interface ImageAnalysisStreamCapability<TInput, TOutput>

Streaming image analysis capability.

Providers implementing this interface support analyzing one or more images and emitting structured, provider-agnostic analysis results incrementally as they become available.

Typical use cases:

Vision analysis with object detection
OCR extraction
Safety / moderation signals
Tagging and semantic classification

Template: TImageAnalysisInput

Provider-agnostic image analysis request type

interface ImageAnalysisStreamCapability<
    TInput = unknown,
    TOutput = NormalizedImageAnalysis[],
> {
    analyzeImageStream(
        request: AIRequest<TInput>,
        ctx: MultiModalExecutionContext,
        signal?: AbortSignal,
    ): AsyncGenerator<AIResponseChunk<TOutput>>;
}

Type Parameters

TInput = unknown
TOutput = NormalizedImageAnalysis[]

Hierarchy (View Summary)

ProviderCapability
- ImageAnalysisStreamCapability

Implemented by

Index

Methods

analyzeImageStream

Methods

analyzeImageStream

analyzeImageStream(
    request: AIRequest<TInput>,
    ctx: MultiModalExecutionContext,
    signal?: AbortSignal,
): AsyncGenerator<AIResponseChunk<TOutput>>
Analyze images with streaming output.

The returned async iterable yields objects as soon as partial or completed analysis results are available.
Parameters
- request: AIRequest<TInput>
- ctx: MultiModalExecutionContext
- Optionalsignal: AbortSignal
Returns AsyncGenerator<AIResponseChunk<TOutput>>
- Defined in src/core/provider/capabilities/ImageCapability.ts:121

Interface ImageAnalysisStreamCapability<TInput, TOutput>

Template: TImageAnalysisInput

Type Parameters

Hierarchy (View Summary)

Implemented by

Index

Methods

Methods

analyzeImageStream

Parameters

Returns AsyncGenerator<AIResponseChunk<TOutput>>

Settings

On This Page