Class GeneratedImage (1.48.0)

Version latest

• 1.48.0 (latest)
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.39.0
• 1.38.1
• 1.37.0
• 1.36.4
• 1.35.0
• 1.34.0
• 1.33.1
• 1.32.0
• 1.31.1
• 1.30.1
• 1.29.0
• 1.28.1
• 1.27.1
• 1.26.1
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.1
• 1.21.0
• 1.20.0
• 1.19.1
• 1.18.3
• 1.17.1
• 1.16.1
• 1.15.1
• 1.14.0
• 1.13.1
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.1
• 1.7.1
• 1.6.2
• 1.5.0
• 1.4.3
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.1
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.1
• 0.4.0
• 0.3.1

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.