Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions FirebaseAI/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Unreleased
- [changed] The Developer API and the Imagen generation APIs are now Generally Available (GA).

# 12.3.0
- [feature] Added support for the Code Execution tool, which enables the model
to generate and run code to perform complex tasks like solving mathematical
Expand Down
6 changes: 1 addition & 5 deletions FirebaseAI/Sources/FirebaseAI.swift
Original file line number Diff line number Diff line change
Expand Up @@ -105,11 +105,7 @@ public final class FirebaseAI: Sendable {
)
}

/// **[Public Preview]** Initializes an ``ImagenModel`` with the given parameters.
///
/// > Warning: For Firebase AI SDK, 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.
/// Initializes an ``ImagenModel`` with the given parameters.
///
/// > Important: Only Imagen 3 models (named `imagen-3.0-*`) are supported.
///
Expand Down
17 changes: 2 additions & 15 deletions FirebaseAI/Sources/Types/Public/Imagen/ImagenModel.swift
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,6 @@ import Foundation
/// documentation](https://firebase.google.com/docs/vertex-ai/generate-images-imagen?platform=ios)
/// for more details about the image generation capabilities offered by the Imagen model in the
/// Firebase AI SDK SDK.
///
/// > Warning: For Firebase AI SDK, 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.
@available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
public final class ImagenModel {
/// Model name prefix to identify Imagen models.
Expand Down Expand Up @@ -65,18 +61,14 @@ public final class ImagenModel {
self.requestOptions = requestOptions
}

/// **[Public Preview]** Generates images using the Imagen model and returns them as inline data.
/// Generates images using the Imagen model and returns them as inline data.
///
/// The individual ``ImagenInlineImage/data`` is provided for each of the generated
/// ``ImagenGenerationResponse/images``.
///
/// > Note: By default, 1 image sample is generated; see ``ImagenGenerationConfig/numberOfImages``
/// to configure the number of images that are generated.
///
/// > Warning: For Firebase AI SDK, 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.
///
/// - Parameters:
/// - prompt: A text prompt describing the image(s) to generate.
public func generateImages(prompt: String) async throws
Expand All @@ -91,8 +83,7 @@ public final class ImagenModel {
)
}

/// **[Public Preview]** Generates images using the Imagen model and stores them in Cloud Storage
/// (GCS) for Firebase.
/// Generates images using the Imagen model and stores them in Cloud Storage (GCS) for Firebase.
///
/// The generated images are stored in a subdirectory of the requested `gcsURI`, named as a random
/// numeric hash. For example, for the `gcsURI` `"gs://bucket-name/path/"`, the generated images
Expand All @@ -105,10 +96,6 @@ public final class ImagenModel {
/// > Note: By default, 1 image sample is generated; see ``ImagenGenerationConfig/numberOfImages``
/// to configure the number of images that are generated.
///
/// > Warning: For Firebase AI SDK, 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.
///
/// - Parameters:
/// - prompt: A text prompt describing the image(s) to generate.
/// - gcsURI: The Cloud Storage (GCS) for Firebase URI where the generated images are stored.
Expand Down
Loading