Merge branch 'main' into dconeybe/dataconnect/GradlePluginMacOSAndWindows

Author: dconeybe

.github/workflows/ci_tests.yml

@@ -167,7 +167,7 @@ jobs:
 
     steps:
       - name: Download Artifacts
-        uses: actions/[email protected].5
+        uses: actions/[email protected].7
         with:
           path: artifacts
 

firebase-vertexai/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Unreleased
-* [changed] Breaking Change: refactored enum classes to be normal classes (#6340). 
+* [feature] Added support for `title` and `publicationDate` in citations. (#6309)
+* [feature] Added support for `frequencyPenalty`, `presencePenalty`, and `HarmBlockMethod`. (#6309)
+* [changed] **Breaking Change**: Introduced `Citations` class. Now `CitationMetadata` wraps that type. (#6276)
+* [changed] **Breaking Change**: Introduced `FunctionCall` and `FunctionResponse` types. Now `FunctionCallPart` and `FunctionResponsePart` wrap those types, respectively. (#6311)
+* [changed] **Breaking Change**: Reworked `Schema` declaration mechanism. (#6258)
+* [changed] **Breaking Change**: Reworked function calling mechanism to use the new `Schema` format. Function calls no longer use native types, nor include references to the actual executable code. (#6258)
+* [changed] **Breaking Change**: Made `totalBillableCharacters` field in `CountTokens` nullable and optional. (#6294)
+* [changed] **Breaking Change**: Removed `UNKNOWN` option for the `HarmBlockThreshold` enum. (#6294)
+* [changed] **Breaking Change**: Removed `UNSPECIFIED` option for the `HarmBlockThreshold`, `HarmProbability`, `HarmSeverity`, and `BlockReason` enums. (#6294)
+* [changed] **Breaking Change**: Renamed `BlockThreshold` as `HarmBlockThreshold`. (#6262)
+* [changed] **Breaking Change**: Renamed all types and methods starting with `blob` to start with `inlineData`. (#6309)
+* [changed] **Breaking Change**: Changed the order of arguments in `InlineDataPart` to match `ImagePart`. (#6340)
+* [changed] **Breaking Change**: Changed `RequestOption` to accept only `long` timeout values. (#6289)
+* [changed] **Breaking Change**: Moved `requestOptions` to the last positional argument in the `generativeModel` argument list. (#6292)
+* [changed] **Breaking Change**: Replaced sealed classes with abstract classes for `StringFormat`. (#6334)
+* [changed] **Breaking Change**: Refactored enum classes to be normal classes. (#6340)
+* [changed] **Breaking Change**: Marked `GenerativeModel` properties as private. (#6309)
 
 
 # 16.0.0-beta05
@@ -17,4 +33,3 @@
 * [feature] Added support for `responseMimeType` in `GenerationConfig`.
 * [changed] Renamed `GoogleGenerativeAIException` to `FirebaseVertexAIException`.
 * [changed] Updated the KDocs for various classes and functions.
-

firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/GenerativeModel.kt

@@ -231,7 +231,7 @@ internal constructor(
       generationConfig?.toInternal(),
       tools?.map { it.toInternal() },
       toolConfig?.toInternal(),
-      systemInstruction?.toInternal()
+      systemInstruction?.copy(role = "system")?.toInternal()
     )
 
   private fun constructCountTokensRequest(vararg prompt: Content) =

firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/Content.kt

@@ -30,6 +30,10 @@ public class Content
 @JvmOverloads
 constructor(public val role: String? = "user", public val parts: List<Part>) {
 
+  public fun copy(role: String? = this.role, parts: List<Part> = this.parts): Content {
+    return Content(role, parts)
+  }
+
   /** Builder class to facilitate constructing complex [Content] objects. */
   public class Builder {
 

firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/Schema.kt

@@ -36,6 +36,7 @@ internal constructor(
   public companion object {
     /** Returns a schema for a boolean */
     @JvmStatic
+    @JvmOverloads
     public fun boolean(description: String? = null, nullable: Boolean = false): Schema =
       Schema(
         description = description,
@@ -51,6 +52,7 @@ internal constructor(
      */
     @JvmStatic
     @JvmName("numInt")
+    @JvmOverloads
     public fun integer(description: String? = null, nullable: Boolean = false): Schema =
       Schema(
         description = description,
@@ -67,6 +69,7 @@ internal constructor(
      */
     @JvmStatic
     @JvmName("numLong")
+    @JvmOverloads
     public fun long(description: String? = null, nullable: Boolean = false): Schema =
       Schema(
         description = description,
@@ -82,6 +85,7 @@ internal constructor(
      */
     @JvmStatic
     @JvmName("numDouble")
+    @JvmOverloads
     public fun double(description: String? = null, nullable: Boolean = false): Schema =
       Schema(description = description, nullable = nullable, type = "NUMBER", format = "double")
 
@@ -93,6 +97,7 @@ internal constructor(
      */
     @JvmStatic
     @JvmName("numFloat")
+    @JvmOverloads
     public fun float(description: String? = null, nullable: Boolean = false): Schema =
       Schema(description = description, nullable = nullable, type = "NUMBER", format = "float")
 
@@ -105,6 +110,7 @@ internal constructor(
      */
     @JvmStatic
     @JvmName("str")
+    @JvmOverloads
     public fun string(
       description: String? = null,
       nullable: Boolean = false,
@@ -125,6 +131,7 @@ internal constructor(
      * @param nullable: Whether null is a valid value for this schema
      */
     @JvmStatic
+    @JvmOverloads
     public fun obj(
       properties: Map<String, Schema>,
       optionalProperties: List<String> = emptyList(),
@@ -153,6 +160,7 @@ internal constructor(
      * @param nullable: Whether null is a valid value for this schema
      */
     @JvmStatic
+    @JvmOverloads
     public fun array(
       items: Schema,
       description: String? = null,
@@ -173,6 +181,7 @@ internal constructor(
      * @param nullable: Whether null is a valid value for this schema
      */
     @JvmStatic
+    @JvmOverloads
     public fun enumeration(
       values: List<String>,
       description: String? = null,

firebase-vertexai/src/test/java/com/google/firebase/vertexai/GenerativeModelTesting.kt

@@ -0,0 +1,92 @@
+/*
+ * 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.vertexai
+
+import com.google.firebase.vertexai.common.APIController
+import com.google.firebase.vertexai.common.GenerateContentResponse
+import com.google.firebase.vertexai.common.JSON
+import com.google.firebase.vertexai.common.server.Candidate
+import com.google.firebase.vertexai.common.shared.Content
+import com.google.firebase.vertexai.common.shared.TextPart
+import com.google.firebase.vertexai.common.util.doBlocking
+import com.google.firebase.vertexai.type.RequestOptions
+import com.google.firebase.vertexai.type.content
+import io.kotest.assertions.json.shouldContainJsonKey
+import io.kotest.assertions.json.shouldContainJsonKeyValue
+import io.kotest.matchers.collections.shouldNotBeEmpty
+import io.kotest.matchers.types.shouldBeInstanceOf
+import io.ktor.client.engine.mock.MockEngine
+import io.ktor.client.engine.mock.respond
+import io.ktor.http.HttpHeaders
+import io.ktor.http.HttpStatusCode
+import io.ktor.http.content.TextContent
+import io.ktor.http.headersOf
+import kotlin.time.Duration.Companion.seconds
+import kotlinx.coroutines.withTimeout
+import kotlinx.serialization.encodeToString
+import org.junit.Test
+
+internal class GenerativeModelTesting {
+  private val TEST_CLIENT_ID = "test"
+
+  @Test
+  fun addition() = doBlocking {
+    val mockEngine = MockEngine {
+      respond(
+        generateContentResponseAsJsonString("text response"),
+        HttpStatusCode.OK,
+        headersOf(HttpHeaders.ContentType, "application/json")
+      )
+    }
+
+    val apiController =
+      APIController(
+        "super_cool_test_key",
+        "gemini-1.5-flash",
+        RequestOptions(timeout = 5.seconds, endpoint = "https://my.custom.endpoint"),
+        mockEngine,
+        TEST_CLIENT_ID,
+        null,
+      )
+
+    val generativeModel =
+      GenerativeModel(
+        "gemini-1.5-flash",
+        systemInstruction = content { text("system instruction") },
+        controller = apiController
+      )
+
+    withTimeout(5.seconds) { generativeModel.generateContent("my test prompt") }
+
+    mockEngine.requestHistory.shouldNotBeEmpty()
+
+    val request = mockEngine.requestHistory.first().body
+    request.shouldBeInstanceOf<TextContent>()
+
+    request.text.let {
+      it shouldContainJsonKey "system_instruction"
+      it.shouldContainJsonKeyValue("$.system_instruction.role", "system")
+      it.shouldContainJsonKeyValue("$.system_instruction.parts[0].text", "system instruction")
+    }
+  }
+
+  private fun generateContentResponseAsJsonString(text: String): String {
+    return JSON.encodeToString(
+      GenerateContentResponse(listOf(Candidate(Content(parts = listOf(TextPart(text))))))
+    )
+  }
+}