Class ControlReferenceImage (1.75.0)

ControlReferenceImage(
    reference_id,
    image: typing.Optional[
        typing.Union[bytes, vertexai.vision_models.Image, str]
    ] = None,
    control_type: typing.Optional[
        typing.Literal["default", "scribble", "face_mesh", "canny"]
    ] = None,
    enable_control_image_computation: typing.Optional[bool] = False,
)

Control reference image.

This encapsulates the control reference image type.

Methods

ControlReferenceImage

ControlReferenceImage(
    reference_id,
    image: typing.Optional[
        typing.Union[bytes, vertexai.vision_models.Image, str]
    ] = None,
    control_type: typing.Optional[
        typing.Literal["default", "scribble", "face_mesh", "canny"]
    ] = None,
    enable_control_image_computation: typing.Optional[bool] = False,
)

Creates a ControlReferenceImage object.

Parameters
Name	Description
image	typing.Union[bytes, vertexai.vision_models.Image, str, NoneType] Either Image object or Image file bytes. Image can be in PNG or JPEG format.
control_type	typing.Optional[typing.Literal['default', 'scribble', 'face_mesh', 'canny']] Control type for the image. Can take the following values: * default: Default control type * scribble: Scribble control type * face_mesh: Face mesh control type * canny: Canny control type
enable_control_image_computation	typing.Optional[bool] When set to True, the control image will be computed by the model based on the control type. When set to False, the control image will be provided by the user.