Interface ImageGenerationCapability<TInput, TOutput>

Provider-agnostic image generation capability interface.

Providers that implement this interface can generate images from prompts.

interface ImageGenerationCapability<
    TInput = ClientImageGenerationRequest,
    TOutput = NormalizedImage[],
> {
    generateImage(
        req: AIRequest<TInput>,
        ctx: MultiModalExecutionContext,
        signal?: AbortSignal,
    ): Promise<AIResponse<TOutput>>;
}

Type Parameters

TInput = ClientImageGenerationRequest
Input type for the image generation request.
TOutput = NormalizedImage[]
Output type for normalized generated images.

Hierarchy (View Summary)

ProviderCapability
- ImageGenerationCapability

Implemented by

Index

Methods

Methods

generateImage

generateImage(
    req: AIRequest<TInput>,
    ctx: MultiModalExecutionContext,
    signal?: AbortSignal,
): Promise<AIResponse<TOutput>>
Generate images for the given request.
Parameters
- req: AIRequest<TInput>
  AIRequest containing image generation input.
- ctx: MultiModalExecutionContext
  Execution context.
- Optionalsignal: AbortSignal
  Optional abort signal.
Returns Promise<AIResponse<TOutput>>
AIResponse wrapping generated images.
- Defined in src/core/provider/capabilities/ImageCapability.ts:36