feat(vertexai): add name constructor for function calling schema (#12898)

cynthiajoan · web-flow · commit 466884b6474b · 2024-06-07T10:20:51.000-07:00
* add name constructor for function calling schema

* fix for analyzer
diff --git a/packages/firebase_vertexai/firebase_vertexai/lib/src/vertex_content.dart b/packages/firebase_vertexai/firebase_vertexai/lib/src/vertex_content.dart
@@ -50,6 +50,9 @@ final class Content {
   static Content functionResponse(
           String name, Map<String, Object?>? response) =>
       Content('function', [FunctionResponse(name, response)]);
+  /// Return a [Content] with multiple [FunctionResponse].
+  static Content functionResponses(Iterable<FunctionResponse> responses) =>
+      Content('function', responses.toList());
 
   /// Return a [Content] with [TextPart] of system instruction.
   static Content system(String instructions) =>
diff --git a/packages/firebase_vertexai/firebase_vertexai/lib/src/vertex_function_calling.dart b/packages/firebase_vertexai/firebase_vertexai/lib/src/vertex_function_calling.dart
@@ -184,7 +184,6 @@ enum FunctionCallingMode {
 /// Represents a select subset of an
 /// [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema).
 final class Schema {
-  // TODO: Add named constructors for the types?
   /// Constructor
   Schema(
     this.type, {
@@ -197,6 +196,93 @@ final class Schema {
     this.requiredProperties,
   });
 
+  /// Construct a schema for an object with one or more properties.
+  Schema.object({
+    required Map<String, Schema> properties,
+    List<String>? requiredProperties,
+    String? description,
+    bool? nullable,
+  }) : this(
+          SchemaType.object,
+          properties: properties,
+          requiredProperties: requiredProperties,
+          description: description,
+          nullable: nullable,
+        );
+
+  /// Construct a schema for an array of values with a specified type.
+  Schema.array({
+    required Schema items,
+    String? description,
+    bool? nullable,
+  }) : this(
+          SchemaType.array,
+          description: description,
+          nullable: nullable,
+          items: items,
+        );
+
+  /// Construct a schema for bool value.
+  Schema.boolean({
+    String? description,
+    bool? nullable,
+  }) : this(
+          SchemaType.boolean,
+          description: description,
+          nullable: nullable,
+        );
+
+  /// Construct a schema for an integer number.
+  ///
+  /// The [format] may be "int32" or "int64".
+  Schema.integer({
+    String? description,
+    bool? nullable,
+    String? format,
+  }) : this(
+          SchemaType.integer,
+          description: description,
+          nullable: nullable,
+          format: format,
+        );
+
+  /// Construct a schema for a non-integer number.
+  ///
+  /// The [format] may be "float" or "double".
+  Schema.number({
+    String? description,
+    bool? nullable,
+    String? format,
+  }) : this(
+          SchemaType.number,
+          description: description,
+          nullable: nullable,
+          format: format,
+        );
+
+  /// Construct a schema for String value with enumerated possible values.
+  Schema.enumString({
+    required List<String> enumValues,
+    String? description,
+    bool? nullable,
+  }) : this(
+          SchemaType.string,
+          enumValues: enumValues,
+          description: description,
+          nullable: nullable,
+          format: 'enum',
+        );
+
+  /// Construct a schema for a String value.
+  Schema.string({
+    String? description,
+    bool? nullable,
+  }) : this(
+          SchemaType.string,
+          description: description,
+          nullable: nullable,
+        );
+
   /// The type of this value.
   SchemaType type;
 
diff --git a/packages/firebase_vertexai/firebase_vertexai/lib/src/vertex_model.dart b/packages/firebase_vertexai/firebase_vertexai/lib/src/vertex_model.dart
@@ -69,9 +69,7 @@ final class GenerativeModel {
               : [],
           generationConfig: generationConfig?.toGoogleAI(),
           systemInstruction: systemInstruction?.toGoogleAI(),
-          tools: tools != null
-              ? tools.map((tool) => tool.toGoogleAI()).toList()
-              : [],
+          tools: tools?.map((tool) => tool.toGoogleAI()).toList(),
           toolConfig: toolConfig?.toGoogleAI(),
         );
   final google_ai.GenerativeModel _googleAIModel;
@@ -136,9 +134,7 @@ final class GenerativeModel {
     final response = await _googleAIModel.generateContent(googlePrompt,
         safetySettings: googleSafetySettings,
         generationConfig: generationConfig?.toGoogleAI(),
-        tools: tools != null
-            ? tools.map((tool) => tool.toGoogleAI()).toList()
-            : [],
+        tools: tools?.map((tool) => tool.toGoogleAI()).toList(),
         toolConfig: toolConfig?.toGoogleAI());
     return response.toVertex();
   }
@@ -167,9 +163,7 @@ final class GenerativeModel {
                 ? safetySettings.map((setting) => setting.toGoogleAI()).toList()
                 : [],
             generationConfig: generationConfig?.toGoogleAI(),
-            tools: tools != null
-                ? tools.map((tool) => tool.toGoogleAI()).toList()
-                : [],
+            tools: tools?.map((tool) => tool.toGoogleAI()).toList(),
             toolConfig: toolConfig?.toGoogleAI())
         .map((r) => r.toVertex());
   }
