Merge pull request #5 from PatilShreyas/v0.2.1-kmp

Sync with google/generative-ai-android v0.2.1
PatilShreyas · Feb 29, 2024 · bd50eb5 · bd50eb5
2 parents 29e8f6b + bc6e06d
commit bd50eb5
Show file tree

Hide file tree

Showing 9 changed files with 56 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -59,7 +59,7 @@ The versioning scheme is of the form `X-Y` where:
 
 X is the _Generative AI  Android SDK_ version that is being tracked.
 Y is the _Multiplatform SDK_ version.
-For example, if _Generative AI  Android SDK_ is on `0.2.0` and _Multiplatform SDK_ is on `1.0.0`, the artifact for a release will be `dev.shreyaspatil.generativeai:generativeai-google:0.2.0-1.0.0`.
+For example, if _Generative AI  Android SDK_ is on `0.2.1` and _Multiplatform SDK_ is on `1.0.0`, the artifact for a release will be `dev.shreyaspatil.generativeai:generativeai-google:0.2.1-1.0.0`.
 
 ## Try sample app
 

diff --git a/generativeai/gradle.properties b/generativeai/gradle.properties
@@ -2,7 +2,7 @@
 SONATYPE_HOST=DEFAULT
 RELEASE_SIGNING_ENABLED=true
 GROUP=dev.shreyaspatil.generativeai
-VERSION_NAME=0.2.0-1.0.0
+VERSION_NAME=0.2.1-1.0.0
 
 POM_ARTIFACT_ID=generativeai-google
 POM_NAME=Google Generative AI

diff --git a/generativeai/src/commonMain/kotlin/dev/shreyaspatil/ai/client/generativeai/Chat.kt b/generativeai/src/commonMain/kotlin/dev/shreyaspatil/ai/client/generativeai/Chat.kt
@@ -72,7 +72,7 @@ class Chat(private val model: GenerativeModel, val history: MutableList<Content>
      * @throws InvalidStateException if the [Chat] instance has an active request.
      */
     suspend fun sendMessage(prompt: String): GenerateContentResponse {
-        val content = content("user") { text(prompt) }
+        val content = content { text(prompt) }
         return sendMessage(content)
     }
 
@@ -83,7 +83,7 @@ class Chat(private val model: GenerativeModel, val history: MutableList<Content>
      * @throws InvalidStateException if the [Chat] instance has an active request.
      */
     suspend fun sendMessage(prompt: PlatformImage): GenerateContentResponse {
-        val content = content("user") { image(prompt) }
+        val content = content { image(prompt) }
         return sendMessage(content)
     }
 
@@ -149,7 +149,7 @@ class Chat(private val model: GenerativeModel, val history: MutableList<Content>
      * @throws InvalidStateException if the [Chat] instance has an active request.
      */
     fun sendMessageStream(prompt: String): Flow<GenerateContentResponse> {
-        val content = content("user") { text(prompt) }
+        val content = content { text(prompt) }
         return sendMessageStream(content)
     }
 
@@ -161,7 +161,7 @@ class Chat(private val model: GenerativeModel, val history: MutableList<Content>
      * @throws InvalidStateException if the [Chat] instance has an active request.
      */
     fun sendMessageStream(prompt: PlatformImage): Flow<GenerateContentResponse> {
-        val content = content("user") { image(prompt) }
+        val content = content { image(prompt) }
         return sendMessageStream(content)
     }
 

diff --git a/...c/commonMain/kotlin/dev/shreyaspatil/ai/client/generativeai/internal/api/APIController.kt b/...c/commonMain/kotlin/dev/shreyaspatil/ai/client/generativeai/internal/api/APIController.kt
@@ -16,7 +16,9 @@
 package dev.shreyaspatil.ai.client.generativeai.internal.api
 
 import dev.shreyaspatil.ai.client.generativeai.internal.util.decodeToFlow
+import dev.shreyaspatil.ai.client.generativeai.type.InvalidAPIKeyException
 import dev.shreyaspatil.ai.client.generativeai.type.ServerException
+import dev.shreyaspatil.ai.client.generativeai.type.UnsupportedUserLocationException
 import io.ktor.client.HttpClient
 import io.ktor.client.HttpClientConfig
 import io.ktor.client.call.body
@@ -179,7 +181,13 @@ private suspend fun validateResponse(response: HttpResponse) {
             } catch (e: Throwable) {
                 "Unexpected Response:\n$text"
             }
-
+        if (message.contains("API key not valid")) {
+            throw InvalidAPIKeyException(message)
+        }
+        // TODO (b/325117891): Use a better method than string matching.
+        if (message == "User location is not supported for the API use.") {
+            throw UnsupportedUserLocationException()
+        }
         throw ServerException(message)
     }
 }
diff --git a/...rc/commonMain/kotlin/dev/shreyaspatil/ai/client/generativeai/internal/api/shared/Types.kt b/...rc/commonMain/kotlin/dev/shreyaspatil/ai/client/generativeai/internal/api/shared/Types.kt
@@ -40,7 +40,7 @@ internal enum class HarmCategory(override val serialName: String) : Serializable
 
 typealias Base64 = String
 
-@Serializable internal data class Content(val role: String? = null, val parts: List<Part>)
+@Serializable internal data class Content(val role: String? = "user", val parts: List<Part>)
 
 @Serializable(PartSerializer::class)
 internal sealed interface Part

diff --git a/...rativeai/src/commonMain/kotlin/dev/shreyaspatil/ai/client/generativeai/type/Exceptions.kt b/...rativeai/src/commonMain/kotlin/dev/shreyaspatil/ai/client/generativeai/type/Exceptions.kt
@@ -57,6 +57,10 @@ class SerializationException(message: String, cause: Throwable? = null) :
 class ServerException(message: String, cause: Throwable? = null) :
     GoogleGenerativeAIException(message, cause)
 
+/** The server responded that the API Key is no valid. */
+class InvalidAPIKeyException(message: String, cause: Throwable? = null) :
+    GoogleGenerativeAIException(message, cause)
+
 /**
  * A request was blocked for some reason.
  *
@@ -70,6 +74,16 @@ class PromptBlockedException(val response: GenerateContentResponse, cause: Throw
         cause,
     )
 
+/**
+ * The user's location (region) is not supported by the API.
+ *
+ * See the Google documentation for a
+ * [list of regions](https://ai.google.dev/available_regions#available_regions) (countries and
+ * territories) where the API is available.
+ */
+class UnsupportedUserLocationException(cause: Throwable? = null) :
+    GoogleGenerativeAIException("User location is not supported for the API use.", cause)
+
 /**
  * Some form of state occurred that shouldn't have.
  *

diff --git a/generativeai/src/test/java/dev/shreyaspatil/ai/client/generativeai/StreamingSnapshotTests.kt b/generativeai/src/test/java/dev/shreyaspatil/ai/client/generativeai/StreamingSnapshotTests.kt
@@ -18,6 +18,7 @@ package dev.shreyaspatil.ai.client.generativeai
 import dev.shreyaspatil.ai.client.generativeai.type.BlockReason
 import dev.shreyaspatil.ai.client.generativeai.type.FinishReason
 import dev.shreyaspatil.ai.client.generativeai.type.HarmCategory
+import dev.shreyaspatil.ai.client.generativeai.type.InvalidAPIKeyException
 import dev.shreyaspatil.ai.client.generativeai.type.PromptBlockedException
 import dev.shreyaspatil.ai.client.generativeai.type.ResponseStoppedException
 import dev.shreyaspatil.ai.client.generativeai.type.SerializationException
@@ -172,6 +173,6 @@ internal class StreamingSnapshotTests {
         goldenStreamingFile("failure-api-key.txt", HttpStatusCode.BadRequest) {
             val responses = model.generateContentStream()
 
-            withTimeout(testTimeout) { shouldThrow<ServerException> { responses.collect() } }
+            withTimeout(testTimeout) { shouldThrow<InvalidAPIKeyException> { responses.collect() } }
         }
 }
diff --git a/generativeai/src/test/java/dev/shreyaspatil/ai/client/generativeai/UnarySnapshotTests.kt b/generativeai/src/test/java/dev/shreyaspatil/ai/client/generativeai/UnarySnapshotTests.kt
@@ -18,10 +18,12 @@ package dev.shreyaspatil.ai.client.generativeai
 import dev.shreyaspatil.ai.client.generativeai.type.BlockReason
 import dev.shreyaspatil.ai.client.generativeai.type.FinishReason
 import dev.shreyaspatil.ai.client.generativeai.type.HarmCategory
+import dev.shreyaspatil.ai.client.generativeai.type.InvalidAPIKeyException
 import dev.shreyaspatil.ai.client.generativeai.type.PromptBlockedException
 import dev.shreyaspatil.ai.client.generativeai.type.ResponseStoppedException
 import dev.shreyaspatil.ai.client.generativeai.type.SerializationException
 import dev.shreyaspatil.ai.client.generativeai.type.ServerException
+import dev.shreyaspatil.ai.client.generativeai.type.UnsupportedUserLocationException
 import dev.shreyaspatil.ai.client.generativeai.util.goldenUnaryFile
 import io.kotest.assertions.throwables.shouldThrow
 import io.kotest.matchers.should
@@ -93,6 +95,14 @@ internal class UnarySnapshotTests {
             withTimeout(testTimeout) { shouldThrow<ServerException> { model.generateContent() } }
         }
 
+    @Test
+    fun `user location error`() =
+        goldenUnaryFile("failure-unsupported-user-location.json", HttpStatusCode.PreconditionFailed) {
+            withTimeout(testTimeout) {
+                shouldThrow<UnsupportedUserLocationException> { model.generateContent() }
+            }
+        }
+
     @Test
     fun `stopped for safety`() =
         goldenUnaryFile("failure-finish-reason-safety.json") {
@@ -128,7 +138,7 @@ internal class UnarySnapshotTests {
     @Test
     fun `invalid api key`() =
         goldenUnaryFile("failure-api-key.json", HttpStatusCode.BadRequest) {
-            withTimeout(testTimeout) { shouldThrow<ServerException> { model.generateContent() } }
+            withTimeout(testTimeout) { shouldThrow<InvalidAPIKeyException> { model.generateContent() } }
         }
 
     @Test

diff --git a/generativeai/src/test/resources/golden-files/unary/failure-unsupported-user-location.json b/generativeai/src/test/resources/golden-files/unary/failure-unsupported-user-location.json
@@ -0,0 +1,13 @@
+{
+  "error": {
+    "code": 400,
+    "message": "User location is not supported for the API use.",
+    "status": "FAILED_PRECONDITION",
+    "details": [
+      {
+        "@type": "type.googleapis.com/google.rpc.DebugInfo",
+        "detail": "[ORIGINAL ERROR] generic::failed_precondition: User location is not supported for the API use. [google.rpc.error_details_ext] { message: \"User location is not supported for the API use.\" }"
+      }
+    ]
+  }
+}