FirebaseVertexAI Framework Reference

ImagenModel

@available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *)
public final class ImagenModel

Represents a remote Imagen model with the ability to generate images using text prompts.

See the generate images documentation for more details about the image generation capabilities offered by the Imagen model in the Vertex AI in Firebase SDK.

Warning

For Vertex AI in Firebase, image generation using Imagen 3 models is in Public Preview, which means that the feature is not subject to any SLA or deprecation policy and could change in backwards-incompatible ways.

  • [Public Preview] Generates images using the Imagen model and returns them as inline data.

    The individual data is provided for each of the generated images.

    Note

    By default, 1 image sample is generated; see numberOfImages to configure the number of images that are generated.

    Warning: For Vertex AI in Firebase, image generation using Imagen 3 models is in Public Preview, which means that the feature is not subject to any SLA or deprecation policy and could change in backwards-incompatible ways.

    Declaration

    Swift

    public func generateImages(prompt: String) async throws
      -> ImagenGenerationResponse<ImagenInlineImage>

    Parameters

    prompt

    A text prompt describing the image(s) to generate.