Class ControlReferenceImage

A control reference image.

The image of the control reference image is either a control image provided by the user, or a regular image which the backend will use to generate a control image of. In the case of the latter, the enable_control_image_computation field in the config should be set to True.

A control image is an image that represents a sketch image of areas for the model to fill in based on the prompt.

Constructors

constructor

Properties

config? referenceId? referenceImage? referenceType?

Methods

toReferenceImageAPI

Constructors

constructor

Properties

Optionalconfig

config?: ControlReferenceConfig

Configuration for the control reference image.

OptionalreferenceId

referenceId?: number

The id of the reference image.

OptionalreferenceImage

referenceImage?: Image

The reference image for the editing operation.

OptionalreferenceType

referenceType?: string

The type of the reference image. Only set by the SDK.

Methods

toReferenceImageAPI

  • toReferenceImageAPI(): ReferenceImageAPIInternal

    Internal method to convert to ReferenceImageAPIInternal.

    Returns ReferenceImageAPIInternal

Settings

On This Page

Constructors
Properties
Methods