Member Junction
    Preparing search index...

    Class ImageEditParams

    Parameters for image editing/inpainting

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    CancellationToken? image mask? model? n? negativePrompt? outputFormat? prompt providerOptions? size?

    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 edit. Can be a Buffer, base64 string, or URL.

    mask?: string | Buffer<ArrayBufferLike>

    Mask image indicating which areas to edit. Transparent/white areas will be regenerated. Can be a Buffer, base64 string, or URL.

    model?: string

    Model name/ID to use for editing

    n?: number = 1

    Number of edited images to generate

    negativePrompt?: string

    Negative prompt - things to avoid

    outputFormat?: ImageResponseFormat = 'b64_json'

    How the result should be returned

    prompt: string

    Text prompt describing the edit to make

    providerOptions?: Record<string, unknown>

    Provider-specific additional parameters

    size?: string

    Size of the output image(s)

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties