ImagenModelFutures

@PublicPreviewAPI
public abstract class ImagenModelFutures


Wrapper class providing Java compatible methods for ImagenModel.

See also
ImagenModel

Summary

Nested types

public static class ImagenModelFutures.Companion

Public methods

abstract @NonNull ListenableFuture<@NonNull ImagenGenerationResponse<@NonNull ImagenInlineImage>>
editImage(
    @NonNull List<@NonNull ImagenReferenceImage> referenceImages,
    @NonNull String prompt
)

Generates an image from a single or set of base images, returning the result directly to the caller.

abstract @NonNull ListenableFuture<@NonNull ImagenGenerationResponse<@NonNull ImagenInlineImage>>
editImage(
    @NonNull List<@NonNull ImagenReferenceImage> referenceImages,
    @NonNull String prompt,
    ImagenEditingConfig config
)

Generates an image from a single or set of base images, returning the result directly to the caller.

static final @NonNull ImagenModelFutures
abstract @NonNull ListenableFuture<@NonNull ImagenGenerationResponse<@NonNull ImagenInlineImage>>

Generates an image, returning the result directly to the caller.

abstract @NonNull ImagenModel

Returns the ImagenModel object wrapped by this object.

abstract @NonNull ListenableFuture<@NonNull ImagenGenerationResponse<@NonNull ImagenInlineImage>>
inpaintImage(
    @NonNull ImagenInlineImage image,
    @NonNull String prompt,
    @NonNull ImagenMaskReference mask,
    @NonNull ImagenEditingConfig config
)

Generates an image by inpainting a masked off part of a base image.

abstract @NonNull ListenableFuture<@NonNull ImagenGenerationResponse<@NonNull ImagenInlineImage>>
outpaintImage(
    @NonNull ImagenInlineImage image,
    @NonNull Dimensions newDimensions,
    @NonNull ImagenImagePlacement newPosition,
    @NonNull String prompt,
    ImagenEditingConfig config
)

Generates an image by outpainting the image, extending its borders

Public methods

editImage

public abstract @NonNull ListenableFuture<@NonNull ImagenGenerationResponse<@NonNull ImagenInlineImage>> editImage(
    @NonNull List<@NonNull ImagenReferenceImage> referenceImages,
    @NonNull String prompt
)

Generates an image from a single or set of base images, returning the result directly to the caller.

Parameters
@NonNull List<@NonNull ImagenReferenceImage> referenceImages

the image inputs given to the model as a prompt

@NonNull String prompt

the text input given to the model as a prompt

editImage

public abstract @NonNull ListenableFuture<@NonNull ImagenGenerationResponse<@NonNull ImagenInlineImage>> editImage(
    @NonNull List<@NonNull ImagenReferenceImage> referenceImages,
    @NonNull String prompt,
    ImagenEditingConfig config
)

Generates an image from a single or set of base images, returning the result directly to the caller.

Parameters
@NonNull List<@NonNull ImagenReferenceImage> referenceImages

the image inputs given to the model as a prompt

@NonNull String prompt

the text input given to the model as a prompt

ImagenEditingConfig config

the editing configuration settings

from

public static final @NonNull ImagenModelFutures from(@NonNull ImagenModel model)
Returns
@NonNull ImagenModelFutures

a ImagenModelFutures created around the provided ImagenModel

generateImages

public abstract @NonNull ListenableFuture<@NonNull ImagenGenerationResponse<@NonNull ImagenInlineImage>> generateImages(@NonNull String prompt)

Generates an image, returning the result directly to the caller.

Parameters
@NonNull String prompt

The main text prompt from which the image is generated.

getImageModel

public abstract @NonNull ImagenModel getImageModel()

Returns the ImagenModel object wrapped by this object.

inpaintImage

public abstract @NonNull ListenableFuture<@NonNull ImagenGenerationResponse<@NonNull ImagenInlineImage>> inpaintImage(
    @NonNull ImagenInlineImage image,
    @NonNull String prompt,
    @NonNull ImagenMaskReference mask,
    @NonNull ImagenEditingConfig config
)

Generates an image by inpainting a masked off part of a base image.

Parameters
@NonNull ImagenInlineImage image

the base image

@NonNull String prompt

the text input given to the model as a prompt

@NonNull ImagenMaskReference mask

the mask which defines where in the image can be painted by imagen.

@NonNull ImagenEditingConfig config

the editing configuration settings, it should include an ImagenEditMode

outpaintImage

public abstract @NonNull ListenableFuture<@NonNull ImagenGenerationResponse<@NonNull ImagenInlineImage>> outpaintImage(
    @NonNull ImagenInlineImage image,
    @NonNull Dimensions newDimensions,
    @NonNull ImagenImagePlacement newPosition,
    @NonNull String prompt,
    ImagenEditingConfig config
)

Generates an image by outpainting the image, extending its borders

Parameters
@NonNull ImagenInlineImage image

the base image

@NonNull Dimensions newDimensions

the new dimensions for the image, must be larger than the original image.

@NonNull ImagenImagePlacement newPosition

the placement of the base image within the new image. This can either be coordinates (0,0 is the top left corner) or an alignment (ex: ImagenImagePlacement.BOTTOM_CENTER)

@NonNull String prompt

optional, but can be used to specify the background generated if context is insufficient

ImagenEditingConfig config

the editing configuration settings