Class SubjectReferenceImage (1.73.0)

SubjectReferenceImage(
    reference_id,
    image: typing.Optional[
        typing.Union[bytes, vertexai.vision_models.Image, str]
    ] = None,
    subject_description: typing.Optional[str] = None,
    subject_type: typing.Optional[
        typing.Literal["default", "person", "animal", "product"]
    ] = None,
)

Subject reference image.

This encapsulates the subject reference image type.

Methods

SubjectReferenceImage

SubjectReferenceImage(
    reference_id,
    image: typing.Optional[
        typing.Union[bytes, vertexai.vision_models.Image, str]
    ] = None,
    subject_description: typing.Optional[str] = None,
    subject_type: typing.Optional[
        typing.Literal["default", "person", "animal", "product"]
    ] = None,
)

Creates a SubjectReferenceImage 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.
subject_description	typing.Optional[str] Subject description for the image.
subject_type	typing.Optional[typing.Literal['default', 'person', 'animal', 'product']] Subject type for the image. Can take the following values: * default: Default subject type * person: Person subject type * animal: Animal subject type * product: Product subject type