Member Junction
    Preparing search index...

    Class ImageVariationParams

    Parameters for creating image variations

    Index

    Constructors

    constructor

    Properties

    CancellationToken? image model? n? outputFormat? prompt? providerOptions? size? strength?

    Constructors

    Properties

    CancellationToken?: AbortSignal

    Optional signal for cancelling the request. The driver is responsible for honoring it: it should refuse the call when the signal is already aborted and hand it to the provider's HTTP client, so an abort tears the request down. A call the signal ends resolves with success: false and an errorInfo that classifies a caller cancellation as Cancelled, which is never failed over (see BaseImageGenerator.CancelledResult).

    image: string | Buffer<ArrayBufferLike>

    The original image to create variations of. Can be a Buffer, base64 string, or URL.

    model?: string

    Model name/ID to use for variations

    n?: number = 1

    Number of variations to generate

    outputFormat?: ImageResponseFormat = 'b64_json'

    How the result should be returned

    prompt?: string

    Optional prompt to guide the variation

    providerOptions?: Record<string, unknown>

    Provider-specific additional parameters

    size?: string

    Size of the output image(s)

    strength?: number

    Strength of variation (0-1). Higher values create more different images.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties