feat(ai): add missing enum types (#18198)

Author: Lyokone

packages/firebase_ai/firebase_ai/lib/src/api.dart

@@ -626,7 +626,19 @@ enum HarmCategory {
   sexuallyExplicit('HARM_CATEGORY_SEXUALLY_EXPLICIT'),
 
   /// Promotes or enables access to harmful goods, services, and activities.
-  dangerousContent('HARM_CATEGORY_DANGEROUS_CONTENT');
+  dangerousContent('HARM_CATEGORY_DANGEROUS_CONTENT'),
+
+  /// Image content containing hate speech.
+  imageHate('HARM_CATEGORY_IMAGE_HATE'),
+
+  /// Image content that is dangerous.
+  imageDangerousContent('HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT'),
+
+  /// Image content containing harassment.
+  imageHarassment('HARM_CATEGORY_IMAGE_HARASSMENT'),
+
+  /// Image content that is sexually explicit.
+  imageSexuallyExplicit('HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT');
 
   const HarmCategory(this._jsonString);
 
@@ -638,7 +650,13 @@ enum HarmCategory {
       'HARM_CATEGORY_HATE_SPEECH' => HarmCategory.hateSpeech,
       'HARM_CATEGORY_SEXUALLY_EXPLICIT' => HarmCategory.sexuallyExplicit,
       'HARM_CATEGORY_DANGEROUS_CONTENT' => HarmCategory.dangerousContent,
-      _ => throw FormatException('Unhandled HarmCategory format', jsonObject),
+      'HARM_CATEGORY_IMAGE_HATE' => HarmCategory.imageHate,
+      'HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT' =>
+        HarmCategory.imageDangerousContent,
+      'HARM_CATEGORY_IMAGE_HARASSMENT' => HarmCategory.imageHarassment,
+      'HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT' =>
+        HarmCategory.imageSexuallyExplicit,
+      _ => HarmCategory.unknown,
     };
   }
 

packages/firebase_ai/firebase_ai/lib/src/developer/api.dart

@@ -49,7 +49,13 @@ String _harmCategoryToJson(HarmCategory harmCategory) => switch (harmCategory) {
       HarmCategory.harassment => 'HARM_CATEGORY_HARASSMENT',
       HarmCategory.hateSpeech => 'HARM_CATEGORY_HATE_SPEECH',
       HarmCategory.sexuallyExplicit => 'HARM_CATEGORY_SEXUALLY_EXPLICIT',
-      HarmCategory.dangerousContent => 'HARM_CATEGORY_DANGEROUS_CONTENT'
+      HarmCategory.dangerousContent => 'HARM_CATEGORY_DANGEROUS_CONTENT',
+      HarmCategory.imageHate => 'HARM_CATEGORY_IMAGE_HATE',
+      HarmCategory.imageDangerousContent =>
+        'HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT',
+      HarmCategory.imageHarassment => 'HARM_CATEGORY_IMAGE_HARASSMENT',
+      HarmCategory.imageSexuallyExplicit =>
+        'HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT',
     };
 
 Object _safetySettingToJson(SafetySetting safetySetting) {
@@ -241,5 +247,11 @@ HarmCategory _parseHarmCategory(Object jsonObject) => switch (jsonObject) {
       'HARM_CATEGORY_HATE_SPEECH' => HarmCategory.hateSpeech,
       'HARM_CATEGORY_SEXUALLY_EXPLICIT' => HarmCategory.sexuallyExplicit,
       'HARM_CATEGORY_DANGEROUS_CONTENT' => HarmCategory.dangerousContent,
-      _ => throw unhandledFormat('HarmCategory', jsonObject),
+      'HARM_CATEGORY_IMAGE_HATE' => HarmCategory.imageHate,
+      'HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT' =>
+        HarmCategory.imageDangerousContent,
+      'HARM_CATEGORY_IMAGE_HARASSMENT' => HarmCategory.imageHarassment,
+      'HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT' =>
+        HarmCategory.imageSexuallyExplicit,
+      _ => HarmCategory.unknown,
     };

packages/firebase_ai/firebase_ai/test/api_test.dart

@@ -289,6 +289,13 @@ void main() {
           'HARM_CATEGORY_SEXUALLY_EXPLICIT');
       expect(HarmCategory.dangerousContent.toJson(),
           'HARM_CATEGORY_DANGEROUS_CONTENT');
+      expect(HarmCategory.imageHate.toJson(), 'HARM_CATEGORY_IMAGE_HATE');
+      expect(HarmCategory.imageDangerousContent.toJson(),
+          'HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT');
+      expect(HarmCategory.imageHarassment.toJson(),
+          'HARM_CATEGORY_IMAGE_HARASSMENT');
+      expect(HarmCategory.imageSexuallyExplicit.toJson(),
+          'HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT');
     });
 
     test('HarmProbability toJson and toString', () {
@@ -736,6 +743,75 @@ void main() {
         expect(response.usageMetadata!.candidatesTokensDetails, hasLength(1));
       });
 
+      test('parses image harm categories in safetyRatings', () {
+        final json = {
+          'candidates': [
+            {
+              'content': {
+                'role': 'model',
+                'parts': [
+                  {'text': ''}
+                ]
+              },
+              'finishReason': 'STOP',
+              'safetyRatings': [
+                {
+                  'category': 'HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT',
+                  'probability': 'NEGLIGIBLE'
+                },
+                {
+                  'category': 'HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT',
+                  'probability': 'NEGLIGIBLE'
+                },
+                {
+                  'category': 'HARM_CATEGORY_IMAGE_HATE',
+                  'probability': 'NEGLIGIBLE'
+                },
+                {
+                  'category': 'HARM_CATEGORY_IMAGE_HARASSMENT',
+                  'probability': 'NEGLIGIBLE'
+                },
+              ]
+            }
+          ]
+        };
+        final response =
+            VertexSerialization().parseGenerateContentResponse(json);
+        final ratings = response.candidates.first.safetyRatings!;
+        expect(ratings.map((r) => r.category), [
+          HarmCategory.imageDangerousContent,
+          HarmCategory.imageSexuallyExplicit,
+          HarmCategory.imageHate,
+          HarmCategory.imageHarassment,
+        ]);
+      });
+
+      test('falls back to HarmCategory.unknown for unrecognized values', () {
+        final json = {
+          'candidates': [
+            {
+              'content': {
+                'role': 'model',
+                'parts': [
+                  {'text': ''}
+                ]
+              },
+              'finishReason': 'STOP',
+              'safetyRatings': [
+                {
+                  'category': 'HARM_CATEGORY_SOMETHING_NEW',
+                  'probability': 'NEGLIGIBLE'
+                }
+              ]
+            }
+          ]
+        };
+        final response =
+            VertexSerialization().parseGenerateContentResponse(json);
+        expect(response.candidates.first.safetyRatings!.first.category,
+            HarmCategory.unknown);
+      });
+
       group('usageMetadata parsing', () {
         test('parses usageMetadata when thoughtsTokenCount is set', () {
           final json = {