Skip to content

Commit 998dbec

Browse files
authored
[Vertex AI] Remove generateImages(prompt:gcsURI:) from public API (#14452)
1 parent ba8869c commit 998dbec

File tree

4 files changed

+13
-5
lines changed

4 files changed

+13
-5
lines changed

FirebaseVertexAI/Sources/Types/Public/Imagen/ImagenGCSImage.swift renamed to FirebaseVertexAI/Sources/Types/Internal/Imagen/ImagenGCSImage.swift

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,10 @@
1515
import Foundation
1616

1717
/// An image generated by Imagen, stored in Cloud Storage (GCS) for Firebase.
18+
///
19+
/// TODO(#14451): Make this `public` and move to the `Public` directory when ready.
1820
@available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
19-
public struct ImagenGCSImage {
21+
struct ImagenGCSImage {
2022
/// The IANA standard MIME type of the image file; either `"image/png"` or `"image/jpeg"`.
2123
///
2224
/// > Note: To request a different format, set ``ImagenGenerationConfig/imageFormat`` in

FirebaseVertexAI/Sources/Types/Public/Imagen/ImagenGenerationResponse.swift

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,15 @@ import Foundation
1616

1717
/// A response from a request to generate images with Imagen.
1818
///
19-
/// The type placeholder `T` is an image type of either ``ImagenInlineImage`` or ``ImagenGCSImage``.
19+
/// The type placeholder `T` is an image type; this is currently always an ``ImagenInlineImage``.
2020
///
2121
/// This type is returned from:
2222
/// - ``ImagenModel/generateImages(prompt:)`` where `T` is ``ImagenInlineImage``
23-
/// - ``ImagenModel/generateImages(prompt:gcsURI:)`` where `T` is ``ImagenGCSImage``
2423
@available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
24+
// TODO(#14451): Re-add "- ``ImagenModel/generateImages(prompt:gcsURI:)`` where `T` is
25+
// ``ImagenGCSImage``" in the DocC above.
2526
public struct ImagenGenerationResponse<T> {
26-
/// The images generated by Imagen; see ``ImagenInlineImage`` and ``ImagenGCSImage``.
27+
/// The images generated by Imagen; see ``ImagenInlineImage``.
2728
///
2829
/// > Important: The number of images generated may be fewer than the number requested if one or
2930
/// more were filtered out; see ``filteredReason``.

FirebaseVertexAI/Sources/Types/Public/Imagen/ImagenModel.swift

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,9 @@ public final class ImagenModel {
110110
/// - prompt: A text prompt describing the image(s) to generate.
111111
/// - gcsURI: The Cloud Storage (GCS) for Firebase URI where the generated images are stored.
112112
/// This is a `"gs://"`-prefixed URI , for example, `"gs://bucket-name/path/"`.
113-
public func generateImages(prompt: String, gcsURI: String) async throws
113+
///
114+
/// TODO(#14451): Make this `public` when backend support is ready.
115+
func generateImages(prompt: String, gcsURI: String) async throws
114116
-> ImagenGenerationResponse<ImagenGCSImage> {
115117
return try await generateImages(
116118
prompt: prompt,

FirebaseVertexAI/Tests/TestApp/Tests/Integration/ImagenIntegrationTests.swift

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ import VertexAITestApp
2323
import UIKit
2424
#endif // canImport(UIKit)
2525

26+
// TODO(#14452): Remove `@testable import` when `generateImages(prompt:gcsURI:)` is public.
27+
@testable import class FirebaseVertexAI.ImagenModel
28+
2629
@Suite(
2730
.enabled(
2831
if: ProcessInfo.processInfo.environment["VTXIntegrationImagen"] != nil,

0 commit comments

Comments
 (0)