Add internal unspecified enums to prevent unknown enum value logs

Author: andrewheard

FirebaseAI/Sources/GenerateContentResponse.swift

@@ -171,6 +171,7 @@ public struct Citation: Sendable {
 @available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
 public struct FinishReason: DecodableProtoEnum, Hashable, Sendable {
   enum Kind: String {
+    case unspecified = "FINISH_REASON_UNSPECIFIED"
     case stop = "STOP"
     case maxTokens = "MAX_TOKENS"
     case safety = "SAFETY"
@@ -366,16 +367,17 @@ extension Candidate: Decodable {
       }
     }
 
-    if let safetyRatings = try container.decodeIfPresent(
-      [SafetyRating].self,
-      forKey: .safetyRatings
-    ) {
-      self.safetyRatings = safetyRatings
-    } else {
-      safetyRatings = []
+    let safetyRatings = try container
+      .decodeIfPresent([SafetyRating].self, forKey: .safetyRatings) ?? []
+    // Filter out safety ratings where the category and probability are both unspecified by the
+    // backend.
+    self.safetyRatings = safetyRatings.filter {
+      $0.category.rawValue != HarmCategory.Kind.unspecified.rawValue
+        && $0.probability.rawValue != SafetyRating.HarmProbability.Kind.unspecified.rawValue
     }
 
     finishReason = try container.decodeIfPresent(FinishReason.self, forKey: .finishReason)
+      .flatMap { $0.rawValue == FinishReason.Kind.unspecified.rawValue ? nil : $0 }
 
     citationMetadata = try container.decodeIfPresent(
       CitationMetadata.self,

FirebaseAI/Sources/GenerativeModel.swift

@@ -167,7 +167,8 @@ public final class GenerativeModel: Sendable {
     }
 
     // Check to see if an error should be thrown for stop reason.
-    if let reason = response.candidates.first?.finishReason, reason != .stop {
+    if let reason = response.candidates.first?.finishReason, reason != .stop,
+       reason.rawValue != FinishReason.Kind.unspecified.rawValue {
       throw GenerateContentError.responseStoppedEarly(reason: reason, response: response)
     }
 

FirebaseAI/Sources/Safety.swift

@@ -78,6 +78,7 @@ public struct SafetyRating: Equatable, Hashable, Sendable {
   @available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
   public struct HarmProbability: DecodableProtoEnum, Hashable, Sendable {
     enum Kind: String {
+      case unspecified = "HARM_CATEGORY_UNSPECIFIED"
       case negligible = "NEGLIGIBLE"
       case low = "LOW"
       case medium = "MEDIUM"
@@ -114,6 +115,7 @@ public struct SafetyRating: Equatable, Hashable, Sendable {
   @available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
   public struct HarmSeverity: DecodableProtoEnum, Hashable, Sendable {
     enum Kind: String {
+      case unspecified = "HARM_SEVERITY_UNSPECIFIED"
       case negligible = "HARM_SEVERITY_NEGLIGIBLE"
       case low = "HARM_SEVERITY_LOW"
       case medium = "HARM_SEVERITY_MEDIUM"
@@ -234,6 +236,7 @@ public struct SafetySetting: Sendable {
 @available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
 public struct HarmCategory: CodableProtoEnum, Hashable, Sendable {
   enum Kind: String {
+    case unspecified = "HARM_CATEGORY_UNSPECIFIED"
     case harassment = "HARM_CATEGORY_HARASSMENT"
     case hateSpeech = "HARM_CATEGORY_HATE_SPEECH"
     case sexuallyExplicit = "HARM_CATEGORY_SEXUALLY_EXPLICIT"