Capture and share the backend's message for an invalid API key

google-gemini · Mar 15, 2024 · 771bb77 · 771bb77
1 parent dfea475
commit 771bb77
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/Sources/GoogleAI/GenerateContentError.swift b/Sources/GoogleAI/GenerateContentError.swift
@@ -30,7 +30,7 @@ public enum GenerateContentError: Error {
   case responseStoppedEarly(reason: FinishReason, response: GenerateContentResponse)
 
   /// The provided API key is invalid.
-  case invalidAPIKey
+  case invalidAPIKey(message: String)
 
   /// The user's location (region) is not supported by the API.
   ///

diff --git a/Sources/GoogleAI/GenerativeModel.swift b/Sources/GoogleAI/GenerativeModel.swift
@@ -286,7 +286,7 @@ public final class GenerativeModel {
     if let error = error as? GenerateContentError {
       return error
     } else if let error = error as? RPCError, error.isInvalidAPIKeyError() {
-      return GenerateContentError.invalidAPIKey
+      return GenerateContentError.invalidAPIKey(message: error.message)
     } else if let error = error as? RPCError, error.isUnsupportedUserLocationError() {
       return GenerateContentError.unsupportedUserLocation
     }

diff --git a/Tests/GoogleAITests/GenerativeModelTests.swift b/Tests/GoogleAITests/GenerativeModelTests.swift
@@ -181,8 +181,8 @@ final class GenerativeModelTests: XCTestCase {
     do {
       _ = try await model.generateContent(testPrompt)
       XCTFail("Should throw GenerateContentError.internalError; no error thrown.")
-    } catch GenerateContentError.invalidAPIKey {
-      // Do nothing, catching a GenerateContentError.invalidAPIKey error is expected.
+    } catch GenerateContentError.invalidAPIKey(let message) {
+      XCTAssertEqual(message, "API key not valid. Please pass a valid API key.")
     } catch {
       XCTFail("Should throw GenerateContentError.invalidAPIKey; error thrown: \(error)")
     }