feat: remove unsupported array schema properties and add validation

.changeset/plenty-jeans-return.md

@@ -0,0 +1,5 @@
+---
+"@google/generative-ai": patch
+---
+
+Remove unsupported minItems and maxItems properties from ArraySchema and add validation to prevent their usage

docs/reference/main/generative-ai.arrayschema.md

@@ -1,24 +1,14 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+# ArraySchema Interface
 
-[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ArraySchema](./generative-ai.arrayschema.md)
+Represents the schema for array responses.
 
-## ArraySchema interface
-
-Describes an array, an ordered list of values.
-
-**Signature:**
-
-```typescript
-export interface ArraySchema extends BaseSchema 
-```
-**Extends:** BaseSchema
+Note: The properties `minItems` and `maxItems` are not currently supported by the API. Attempting to use these properties will result in an error.
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [items](./generative-ai.arrayschema.items.md) |  | [Schema](./generative-ai.schema.md) | A schema describing the entries in the array. |
-|  [maxItems?](./generative-ai.arrayschema.maxitems.md) |  | number | _(Optional)_ The maximum number of items in the array. |
-|  [minItems?](./generative-ai.arrayschema.minitems.md) |  | number | _(Optional)_ The minimum number of items in the array. |
-|  [type](./generative-ai.arrayschema.type.md) |  | typeof [SchemaType.ARRAY](./generative-ai.schematype.md) |  |
+| Property | Type | Description |
+|----------|------|-------------|
+| items | Schema | The schema for array items |
+| type | SchemaType.ARRAY | Must be SchemaType.ARRAY |
+
 

src/models/generative-model.test.ts

@@ -462,4 +462,25 @@ describe("GenerativeModel", () => {
     expect(makeRequestStub).to.not.be.called;
     restore();
   });
+  it("throws error when using unsupported array schema properties", async () => {
+    const genModel = new GenerativeModel("apiKey", {
+      model: "my-model",
+      generationConfig: {
+        responseMimeType: "application/json",
+        responseSchema: {
+          type: SchemaType.ARRAY,
+          items: {
+            type: SchemaType.STRING,
+          },
+          minItems: 1, // This should trigger error
+          maxItems: 3, // This should trigger error
+        },
+      },
+    });
+
+    await expect(genModel.generateContent("test")).to.be.rejectedWith(
+      GoogleGenerativeAIError,
+      "Properties 'minItems' and 'maxItems' are not supported in array schema"
+    );
+  });
 });

src/models/generative-model.ts

@@ -86,6 +86,14 @@ export class GenerativeModel {
     this.cachedContent = modelParams.cachedContent;
   }
 
+  private validateArraySchema(schema: ArraySchema) {
+    if ('minItems' in schema || 'maxItems' in schema) {
+      throw new GoogleGenerativeAIError(
+        "Properties 'minItems' and 'maxItems' are not supported in array schema"
+      );
+    }
+  }
+
   /**
    * Makes a single non-streaming call to the model
    * and returns an object containing a single {@link GenerateContentResponse}.
@@ -95,14 +103,16 @@ export class GenerativeModel {
    * {@link GoogleGenerativeAI.getGenerativeModel }.
    */
   async generateContent(
-    request: GenerateContentRequest | string | Array<string | Part>,
-    requestOptions: SingleRequestOptions = {},
+    promptOrParams: string | GenerateContentRequest,
+    generativeModelRequestOptions?: RequestOptions,
   ): Promise<GenerateContentResult> {
-    const formattedParams = formatGenerateContentInput(request);
-    const generativeModelRequestOptions: SingleRequestOptions = {
-      ...this._requestOptions,
-      ...requestOptions,
-    };
+    const formattedParams = await this.formatGenerateContentInput(promptOrParams);
+
+    // Add schema validation
+    if (formattedParams.generationConfig?.responseSchema?.type === SchemaType.ARRAY) {
+      this.validateArraySchema(formattedParams.generationConfig.responseSchema);
+    }
+
     return generateContent(
       this.apiKey,
       this.model,

types/requests.ts

@@ -245,3 +245,8 @@ export interface CodeExecutionTool {
    */
   codeExecution: {};
 }
+
+export interface ArraySchema extends BaseSchema {
+  items: Schema;
+  type: typeof SchemaType.ARRAY;
+}