Class GeneratedImage (1.59.0)

GeneratedImage(
    image_bytes: typing.Optional[bytes],
    generation_parameters: typing.Dict[str, typing.Any],
    gcs_uri: typing.Optional[str] = None,
)

Generated image.

Properties

generation_parameters

Image generation parameters as a dictionary.

Methods

GeneratedImage

GeneratedImage(
    image_bytes: typing.Optional[bytes],
    generation_parameters: typing.Dict[str, typing.Any],
    gcs_uri: typing.Optional[str] = None,
)

Creates a GeneratedImage object.

Parameters
Name	Description
`image_bytes`	`typing.Optional[bytes]` Image file bytes. Image can be in PNG or JPEG format.
`generation_parameters`	`typing.Dict[str, typing.Any]` Image generation parameter values.
`gcs_uri`	`typing.Optional[str]` Image file Google Cloud Storage uri.

load_from_file

load_from_file(location: str) -> vertexai.preview.vision_models.GeneratedImage

Loads image from file.

Parameter
Name	Description
`location`	`str` Local path from where to load the image.

save

save(location: str, include_generation_parameters: bool = True)

Saves image to a file.

Parameters
Name	Description
`location`	`str` Local path where to save the image.
`include_generation_parameters`	`bool` Whether to include the image generation parameters in the image's EXIF metadata.

show

show()

Shows the image.

This method only works when in a notebook environment.