Interface RecontextImageConfig

Configuration for recontextualizing an image.

interface RecontextImageConfig {
    abortSignal?: AbortSignal;
    addWatermark?: boolean;
    baseSteps?: number;
    enhancePrompt?: boolean;
    httpOptions?: HttpOptions;
    labels?: Record<string, string>;
    numberOfImages?: number;
    outputCompressionQuality?: number;
    outputGcsUri?: string;
    outputMimeType?: string;
    personGeneration?: PersonGeneration;
    safetyFilterLevel?: SafetyFilterLevel;
    seed?: number;
}

Properties

abortSignal? addWatermark? baseSteps? enhancePrompt? httpOptions? labels? numberOfImages? outputCompressionQuality? outputGcsUri? outputMimeType? personGeneration? safetyFilterLevel? seed?

Properties

OptionalabortSignal

abortSignal?: AbortSignal

Abort signal which can be used to cancel the request.

NOTE: AbortSignal is a client-only operation. Using it to cancel an operation will not cancel the request in the service. You will still be charged usage for any applicable operations.

OptionaladdWatermark

addWatermark?: boolean

Whether to add a SynthID watermark to the generated images.

OptionalbaseSteps

baseSteps?: number

The number of sampling steps. A higher value has better image quality, while a lower value has better latency.

OptionalenhancePrompt

enhancePrompt?: boolean

Whether to use the prompt rewriting logic.

OptionalhttpOptions

httpOptions?: HttpOptions

Used to override HTTP request options.

Optionallabels

labels?: Record<string, string>

User specified labels to track billing usage.

OptionalnumberOfImages

numberOfImages?: number

Number of images to generate.

OptionaloutputCompressionQuality

outputCompressionQuality?: number

Compression quality of the generated image (for image/jpeg only).

OptionaloutputGcsUri

outputGcsUri?: string

Cloud Storage URI used to store the generated images.

OptionaloutputMimeType

outputMimeType?: string

MIME type of the generated image.

OptionalpersonGeneration

personGeneration?: PersonGeneration

Whether allow to generate person images, and restrict to specific ages.

OptionalsafetyFilterLevel

safetyFilterLevel?: SafetyFilterLevel

Filter level for safety filtering.

Optionalseed

seed?: number

Random seed for image generation.

Settings

On This Page

Properties