feat(ai): add support for imageConfig and NO_IMAGE FinishReason

Author: google-labs-jules[bot]

firebase-ai/src/main/kotlin/com/google/firebase/ai/type/AspectRatio.kt

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.firebase.ai.type
+
+/** Represents the aspect ratio that the generated image should conform to. */
+public class AspectRatio private constructor(internal val internalVal: String) {
+  public companion object {
+    @JvmField public val SQUARE_1x1: AspectRatio = AspectRatio("1:1")
+    @JvmField public val PORTRAIT_2x3: AspectRatio = AspectRatio("2:3")
+    @JvmField public val LANDSCAPE_3x2: AspectRatio = AspectRatio("3:2")
+    @JvmField public val PORTRAIT_3x4: AspectRatio = AspectRatio("3:4")
+    @JvmField public val LANDSCAPE_4x3: AspectRatio = AspectRatio("4:3")
+    @JvmField public val PORTRAIT_4x5: AspectRatio = AspectRatio("4:5")
+    @JvmField public val LANDSCAPE_5x4: AspectRatio = AspectRatio("5:4")
+    @JvmField public val PORTRAIT_9x16: AspectRatio = AspectRatio("9:16")
+    @JvmField public val LANDSCAPE_16x9: AspectRatio = AspectRatio("16:9")
+    @JvmField public val LANDSCAPE_21x9: AspectRatio = AspectRatio("21:9")
+  }
+}

firebase-ai/src/main/kotlin/com/google/firebase/ai/type/Candidate.kt

@@ -237,7 +237,8 @@ public class FinishReason private constructor(public val name: String, public va
     BLOCKLIST,
     PROHIBITED_CONTENT,
     SPII,
-    MALFORMED_FUNCTION_CALL;
+    MALFORMED_FUNCTION_CALL,
+    @SerialName("NO_IMAGE") NO_IMAGE;
 
     internal object Serializer : KSerializer<Internal> by FirstOrdinalSerializer(Internal::class)
 
@@ -252,6 +253,7 @@ public class FinishReason private constructor(public val name: String, public va
         PROHIBITED_CONTENT -> FinishReason.PROHIBITED_CONTENT
         SPII -> FinishReason.SPII
         MALFORMED_FUNCTION_CALL -> FinishReason.MALFORMED_FUNCTION_CALL
+        NO_IMAGE -> FinishReason.NO_IMAGE
         else -> FinishReason.UNKNOWN
       }
   }
@@ -291,6 +293,9 @@ public class FinishReason private constructor(public val name: String, public va
     /** The function call generated by the model is invalid. */
     @JvmField
     public val MALFORMED_FUNCTION_CALL: FinishReason = FinishReason("MALFORMED_FUNCTION_CALL", 9)
+
+    /** No image was generated. */
+    @JvmField public val NO_IMAGE: FinishReason = FinishReason("NO_IMAGE", 10)
   }
 }
 

firebase-ai/src/main/kotlin/com/google/firebase/ai/type/GenerationConfig.kt

@@ -92,6 +92,7 @@ private constructor(
   internal val responseSchema: Schema?,
   internal val responseModalities: List<ResponseModality>?,
   internal val thinkingConfig: ThinkingConfig?,
+  internal val imageConfig: ImageConfig?,
 ) {
 
   /**
@@ -137,6 +138,7 @@ private constructor(
     @JvmField public var responseSchema: Schema? = null
     @JvmField public var responseModalities: List<ResponseModality>? = null
     @JvmField public var thinkingConfig: ThinkingConfig? = null
+    @JvmField public var imageConfig: ImageConfig? = null
 
     public fun setTemperature(temperature: Float?): Builder = apply {
       this.temperature = temperature
@@ -170,6 +172,9 @@ private constructor(
     public fun setThinkingConfig(thinkingConfig: ThinkingConfig?): Builder = apply {
       this.thinkingConfig = thinkingConfig
     }
+    public fun setImageConfig(imageConfig: ImageConfig?): Builder = apply {
+      this.imageConfig = imageConfig
+    }
 
     /** Create a new [GenerationConfig] with the attached arguments. */
     public fun build(): GenerationConfig =
@@ -185,7 +190,8 @@ private constructor(
         responseMimeType = responseMimeType,
         responseSchema = responseSchema,
         responseModalities = responseModalities,
-        thinkingConfig = thinkingConfig
+        thinkingConfig = thinkingConfig,
+        imageConfig = imageConfig
       )
   }
 
@@ -202,7 +208,8 @@ private constructor(
       responseMimeType = responseMimeType,
       responseSchema = responseSchema?.toInternal(),
       responseModalities = responseModalities?.map { it.toInternal() },
-      thinkingConfig = thinkingConfig?.toInternal()
+      thinkingConfig = thinkingConfig?.toInternal(),
+      imageConfig = imageConfig?.toInternal()
     )
 
   @Serializable
@@ -218,7 +225,8 @@ private constructor(
     @SerialName("frequency_penalty") val frequencyPenalty: Float? = null,
     @SerialName("response_schema") val responseSchema: Schema.Internal? = null,
     @SerialName("response_modalities") val responseModalities: List<String>? = null,
-    @SerialName("thinking_config") val thinkingConfig: ThinkingConfig.Internal? = null
+    @SerialName("thinking_config") val thinkingConfig: ThinkingConfig.Internal? = null,
+    @SerialName("image_config") val imageConfig: ImageConfig.Internal? = null
   )
 
   public companion object {

firebase-ai/src/main/kotlin/com/google/firebase/ai/type/ImageConfig.kt

@@ -0,0 +1,74 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.firebase.ai.type
+
+/**
+ * Configuration parameters to use for image generation.
+ *
+ * @property aspectRatio The aspect ratio of the generated image.
+ */
+public class ImageConfig internal constructor(internal val aspectRatio: AspectRatio?) {
+
+  /**
+   * Builder for creating an [ImageConfig].
+   *
+   * Mainly intended for Java interop. Kotlin consumers should use [imageConfig] for a more
+   * idiomatic experience.
+   *
+   * @property aspectRatio See [ImageConfig.aspectRatio].
+   * @see [imageConfig]
+   */
+  public class Builder {
+    @JvmField public var aspectRatio: AspectRatio? = null
+
+    public fun setAspectRatio(aspectRatio: AspectRatio?): Builder = apply { this.aspectRatio = aspectRatio }
+
+    /** Create a new [ImageConfig] with the attached arguments. */
+    public fun build(): ImageConfig = ImageConfig(aspectRatio = aspectRatio)
+  }
+
+  internal fun toInternal() = Internal(aspectRatio = aspectRatio?.internalVal)
+
+  internal data class Internal(val aspectRatio: String?)
+
+  public companion object {
+
+    /**
+     * Alternative casing for [ImageConfig.Builder]:
+     * ```
+     * val config = ImageConfig.builder()
+     * ```
+     */
+    public fun builder(): Builder = Builder()
+  }
+}
+
+/**
+ * Helper method to construct an [ImageConfig] in a DSL-like manner.
+ *
+ * Example Usage:
+ * ```
+ * imageConfig {
+ *   aspectRatio = AspectRatio.LANDSCAPE_16x9
+ * }
+ * ```
+ */
+public fun imageConfig(init: ImageConfig.Builder.() -> Unit): ImageConfig {
+  val builder = ImageConfig.builder()
+  builder.init()
+  return builder.build()
+}