Fix Schema type to reference itself in its child properties (#222)

Author: hsubox76

.changeset/breezy-scissors-attend.md

@@ -0,0 +1,5 @@
+---
+"@google/generative-ai": minor
+---
+
+Fix `Schema` type to reference itself and not a derived type in its `items` array and `properties` map.

common/api-review/generative-ai-server.api.md

@@ -282,23 +282,13 @@ export interface FunctionDeclarationSchema {
         [k: string]: FunctionDeclarationSchemaProperty;
     };
     required?: string[];
-    type: FunctionDeclarationSchemaType;
+    type: SchemaType;
 }
 
 // @public
 export interface FunctionDeclarationSchemaProperty extends Schema {
 }
 
-// @public
-export enum FunctionDeclarationSchemaType {
-    ARRAY = "ARRAY",
-    BOOLEAN = "BOOLEAN",
-    INTEGER = "INTEGER",
-    NUMBER = "NUMBER",
-    OBJECT = "OBJECT",
-    STRING = "STRING"
-}
-
 // @public
 export interface FunctionDeclarationsTool {
     functionDeclarations?: FunctionDeclaration[];
@@ -356,7 +346,6 @@ export class GoogleAIFileManager {
     apiKey: string;
     deleteFile(fileId: string): Promise<void>;
     getFile(fileId: string, requestOptions?: SingleRequestOptions): Promise<FileMetadataResponse>;
-    // Warning: (ae-forgotten-export) The symbol "SingleRequestOptions" needs to be exported by the entry point index.d.ts
     listFiles(listParams?: ListParams, requestOptions?: SingleRequestOptions): Promise<ListFilesResponse>;
     uploadFile(filePath: string, fileMetadata: FileMetadata): Promise<UploadFileResponse>;
 }
@@ -440,13 +429,28 @@ export interface Schema {
     enum?: string[];
     example?: unknown;
     format?: string;
-    items?: FunctionDeclarationSchema;
+    items?: Schema;
     nullable?: boolean;
     properties?: {
-        [k: string]: FunctionDeclarationSchema;
+        [k: string]: Schema;
     };
     required?: string[];
-    type?: FunctionDeclarationSchemaType;
+    type?: SchemaType;
+}
+
+// @public
+export enum SchemaType {
+    ARRAY = "ARRAY",
+    BOOLEAN = "BOOLEAN",
+    INTEGER = "INTEGER",
+    NUMBER = "NUMBER",
+    OBJECT = "OBJECT",
+    STRING = "STRING"
+}
+
+// @public
+export interface SingleRequestOptions extends RequestOptions {
+    signal?: AbortSignal;
 }
 
 // @public

common/api-review/generative-ai.api.md

@@ -329,23 +329,13 @@ export interface FunctionDeclarationSchema {
         [k: string]: FunctionDeclarationSchemaProperty;
     };
     required?: string[];
-    type: FunctionDeclarationSchemaType;
+    type: SchemaType;
 }
 
 // @public
 export interface FunctionDeclarationSchemaProperty extends Schema {
 }
 
-// @public
-export enum FunctionDeclarationSchemaType {
-    ARRAY = "ARRAY",
-    BOOLEAN = "BOOLEAN",
-    INTEGER = "INTEGER",
-    NUMBER = "NUMBER",
-    OBJECT = "OBJECT",
-    STRING = "STRING"
-}
-
 // @public
 export interface FunctionDeclarationsTool {
     functionDeclarations?: FunctionDeclaration[];
@@ -656,13 +646,23 @@ export interface Schema {
     enum?: string[];
     example?: unknown;
     format?: string;
-    items?: FunctionDeclarationSchema;
+    items?: Schema;
     nullable?: boolean;
     properties?: {
-        [k: string]: FunctionDeclarationSchema;
+        [k: string]: Schema;
     };
     required?: string[];
-    type?: FunctionDeclarationSchemaType;
+    type?: SchemaType;
+}
+
+// @public
+export enum SchemaType {
+    ARRAY = "ARRAY",
+    BOOLEAN = "BOOLEAN",
+    INTEGER = "INTEGER",
+    NUMBER = "NUMBER",
+    OBJECT = "OBJECT",
+    STRING = "STRING"
 }
 
 // @public

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

@@ -30,6 +30,6 @@ export declare class ChatSession
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
 |  [getHistory()](./generative-ai.chatsession.gethistory.md) |  | Gets the chat history so far. Blocked prompts are not added to history. Blocked candidates are not added to history, nor are the prompts that generated them. |
-|  [sendMessage(request, requestOptions)](./generative-ai.chatsession.sendmessage.md) |  | <p>Sends a chat message and receives a non-streaming [GenerateContentResult](./generative-ai.generatecontentresult.md)<!-- -->.</p><p>Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided at the time of the  initialization.</p> |
-|  [sendMessageStream(request, requestOptions)](./generative-ai.chatsession.sendmessagestream.md) |  | <p>Sends a chat message and receives the response as a [GenerateContentStreamResult](./generative-ai.generatecontentstreamresult.md) containing an iterable stream and a response promise.</p><p>Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided at the time of the  initialization.</p> |
+|  [sendMessage(request, requestOptions)](./generative-ai.chatsession.sendmessage.md) |  | <p>Sends a chat message and receives a non-streaming [GenerateContentResult](./generative-ai.generatecontentresult.md)<!-- -->.</p><p>Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided to [GoogleGenerativeAI.getGenerativeModel()](./generative-ai.googlegenerativeai.getgenerativemodel.md)<!-- -->.</p> |
+|  [sendMessageStream(request, requestOptions)](./generative-ai.chatsession.sendmessagestream.md) |  | <p>Sends a chat message and receives the response as a [GenerateContentStreamResult](./generative-ai.generatecontentstreamresult.md) containing an iterable stream and a response promise.</p><p>Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided to [GoogleGenerativeAI.getGenerativeModel()](./generative-ai.googlegenerativeai.getgenerativemodel.md)<!-- -->.</p> |
 

docs/reference/main/generative-ai.chatsession.sendmessage.md

@@ -6,7 +6,7 @@
 
 Sends a chat message and receives a non-streaming [GenerateContentResult](./generative-ai.generatecontentresult.md)<!-- -->.
 
-Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided at the time of the  initialization.
+Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided to [GoogleGenerativeAI.getGenerativeModel()](./generative-ai.googlegenerativeai.getgenerativemodel.md)<!-- -->.
 
 **Signature:**
 

docs/reference/main/generative-ai.chatsession.sendmessagestream.md

@@ -6,7 +6,7 @@
 
 Sends a chat message and receives the response as a [GenerateContentStreamResult](./generative-ai.generatecontentstreamresult.md) containing an iterable stream and a response promise.
 
-Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided at the time of the  initialization.
+Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided to [GoogleGenerativeAI.getGenerativeModel()](./generative-ai.googlegenerativeai.getgenerativemodel.md)<!-- -->.
 
 **Signature:**
 

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

@@ -19,5 +19,5 @@ export interface FunctionDeclarationSchema
 |  [description?](./generative-ai.functiondeclarationschema.description.md) |  | string | _(Optional)_ Optional. Description of the parameter. |
 |  [properties](./generative-ai.functiondeclarationschema.properties.md) |  | { \[k: string\]: [FunctionDeclarationSchemaProperty](./generative-ai.functiondeclarationschemaproperty.md)<!-- -->; } | The format of the parameter. |
 |  [required?](./generative-ai.functiondeclarationschema.required.md) |  | string\[\] | _(Optional)_ Optional. Array of required parameters. |
-|  [type](./generative-ai.functiondeclarationschema.type.md) |  | [FunctionDeclarationSchemaType](./generative-ai.functiondeclarationschematype.md) | The type of the parameter. |
+|  [type](./generative-ai.functiondeclarationschema.type.md) |  | [SchemaType](./generative-ai.schematype.md) | The type of the parameter. |
 

docs/reference/main/generative-ai.functiondeclarationschema.type.md

@@ -9,5 +9,5 @@ The type of the parameter.
 **Signature:**
 
 ```typescript
-type: FunctionDeclarationSchemaType;
+type: SchemaType;
 ```

docs/reference/main/generative-ai.generativemodel.batchembedcontents.md

@@ -6,7 +6,7 @@
 
 Embeds an array of [EmbedContentRequest](./generative-ai.embedcontentrequest.md)<!-- -->s.
 
-Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided at the time of the  initialization.
+Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided to [GoogleGenerativeAI.getGenerativeModel()](./generative-ai.googlegenerativeai.getgenerativemodel.md)<!-- -->.
 
 **Signature:**
 

docs/reference/main/generative-ai.generativemodel.counttokens.md

@@ -6,7 +6,7 @@
 
 Counts the tokens in the provided request.
 
-Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided at the time of the  initialization.
+Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided to [GoogleGenerativeAI.getGenerativeModel()](./generative-ai.googlegenerativeai.getgenerativemodel.md)<!-- -->.
 
 **Signature:**
 

docs/reference/main/generative-ai.generativemodel.embedcontent.md

@@ -6,7 +6,7 @@
 
 Embeds the provided content.
 
-Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided at the time of the  initialization.
+Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided to [GoogleGenerativeAI.getGenerativeModel()](./generative-ai.googlegenerativeai.getgenerativemodel.md)<!-- -->.
 
 **Signature:**
 

docs/reference/main/generative-ai.generativemodel.generatecontent.md

@@ -6,7 +6,7 @@
 
 Makes a single non-streaming call to the model and returns an object containing a single [GenerateContentResponse](./generative-ai.generatecontentresponse.md)<!-- -->.
 
-Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided at the time of the  initialization.
+Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided to [GoogleGenerativeAI.getGenerativeModel()](./generative-ai.googlegenerativeai.getgenerativemodel.md)<!-- -->.
 
 **Signature:**
 

docs/reference/main/generative-ai.generativemodel.generatecontentstream.md

@@ -6,7 +6,7 @@
 
 Makes a single streaming call to the model and returns an object containing an iterable stream that iterates over all chunks in the streaming response as well as a promise that returns the final aggregated response.
 
-Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided at the time of the  initialization.
+Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided to [GoogleGenerativeAI.getGenerativeModel()](./generative-ai.googlegenerativeai.getgenerativemodel.md)<!-- -->.
 
 **Signature:**
 

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

@@ -36,10 +36,10 @@ export declare class GenerativeModel
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [batchEmbedContents(batchEmbedContentRequest, requestOptions)](./generative-ai.generativemodel.batchembedcontents.md) |  | <p>Embeds an array of [EmbedContentRequest](./generative-ai.embedcontentrequest.md)<!-- -->s.</p><p>Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided at the time of the  initialization.</p> |
-|  [countTokens(request, requestOptions)](./generative-ai.generativemodel.counttokens.md) |  | <p>Counts the tokens in the provided request.</p><p>Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided at the time of the  initialization.</p> |
-|  [embedContent(request, requestOptions)](./generative-ai.generativemodel.embedcontent.md) |  | <p>Embeds the provided content.</p><p>Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided at the time of the  initialization.</p> |
-|  [generateContent(request, requestOptions)](./generative-ai.generativemodel.generatecontent.md) |  | <p>Makes a single non-streaming call to the model and returns an object containing a single [GenerateContentResponse](./generative-ai.generatecontentresponse.md)<!-- -->.</p><p>Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided at the time of the  initialization.</p> |
-|  [generateContentStream(request, requestOptions)](./generative-ai.generativemodel.generatecontentstream.md) |  | <p>Makes a single streaming call to the model and returns an object containing an iterable stream that iterates over all chunks in the streaming response as well as a promise that returns the final aggregated response.</p><p>Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided at the time of the  initialization.</p> |
+|  [batchEmbedContents(batchEmbedContentRequest, requestOptions)](./generative-ai.generativemodel.batchembedcontents.md) |  | <p>Embeds an array of [EmbedContentRequest](./generative-ai.embedcontentrequest.md)<!-- -->s.</p><p>Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided to [GoogleGenerativeAI.getGenerativeModel()](./generative-ai.googlegenerativeai.getgenerativemodel.md)<!-- -->.</p> |
+|  [countTokens(request, requestOptions)](./generative-ai.generativemodel.counttokens.md) |  | <p>Counts the tokens in the provided request.</p><p>Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided to [GoogleGenerativeAI.getGenerativeModel()](./generative-ai.googlegenerativeai.getgenerativemodel.md)<!-- -->.</p> |
+|  [embedContent(request, requestOptions)](./generative-ai.generativemodel.embedcontent.md) |  | <p>Embeds the provided content.</p><p>Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided to [GoogleGenerativeAI.getGenerativeModel()](./generative-ai.googlegenerativeai.getgenerativemodel.md)<!-- -->.</p> |
+|  [generateContent(request, requestOptions)](./generative-ai.generativemodel.generatecontent.md) |  | <p>Makes a single non-streaming call to the model and returns an object containing a single [GenerateContentResponse](./generative-ai.generatecontentresponse.md)<!-- -->.</p><p>Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided to [GoogleGenerativeAI.getGenerativeModel()](./generative-ai.googlegenerativeai.getgenerativemodel.md)<!-- -->.</p> |
+|  [generateContentStream(request, requestOptions)](./generative-ai.generativemodel.generatecontentstream.md) |  | <p>Makes a single streaming call to the model and returns an object containing an iterable stream that iterates over all chunks in the streaming response as well as a promise that returns the final aggregated response.</p><p>Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided to [GoogleGenerativeAI.getGenerativeModel()](./generative-ai.googlegenerativeai.getgenerativemodel.md)<!-- -->.</p> |
 |  [startChat(startChatParams)](./generative-ai.generativemodel.startchat.md) |  | Gets a new [ChatSession](./generative-ai.chatsession.md) instance which can be used for multi-turn chats. |
 

docs/reference/main/generative-ai.md

@@ -24,11 +24,11 @@
 |  [ExecutableCodeLanguage](./generative-ai.executablecodelanguage.md) |  |
 |  [FinishReason](./generative-ai.finishreason.md) | Reason that a candidate finished. |
 |  [FunctionCallingMode](./generative-ai.functioncallingmode.md) |  |
-|  [FunctionDeclarationSchemaType](./generative-ai.functiondeclarationschematype.md) | Contains the list of OpenAPI data types as defined by https://swagger.io/docs/specification/data-models/data-types/ |
 |  [HarmBlockThreshold](./generative-ai.harmblockthreshold.md) | Threshold above which a prompt or candidate will be blocked. |
 |  [HarmCategory](./generative-ai.harmcategory.md) | Harm categories that would cause prompts or candidates to be blocked. |
 |  [HarmProbability](./generative-ai.harmprobability.md) | Probability that a prompt or candidate matches a harm category. |
 |  [Outcome](./generative-ai.outcome.md) | Possible outcomes of code execution. |
+|  [SchemaType](./generative-ai.schematype.md) | Contains the list of OpenAPI data types as defined by https://swagger.io/docs/specification/data-models/data-types/ |
 |  [TaskType](./generative-ai.tasktype.md) | Task type for embedding content. |
 
 ## Interfaces

docs/reference/main/generative-ai.schema.items.md

@@ -4,10 +4,10 @@
 
 ## Schema.items property
 
-Optional. The items of the property. [FunctionDeclarationSchema](./generative-ai.functiondeclarationschema.md)
+Optional. The items of the property.
 
 **Signature:**
 
 ```typescript
-items?: FunctionDeclarationSchema;
+items?: Schema;
 ```