Add the Content caching feature

config/api-extractor.json

@@ -110,7 +110,7 @@
  /**
  * (REQUIRED) Whether to generate an API report.
  */
- "enabled": false,
+ "enabled": true,
 
  /**
  * The filename for the API report files. It will be combined with "reportFolder" or "reportTempFolder" to produce

docs/reference/main/generative-ai.cachedcontent.createtime.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [CachedContent](./generative-ai.cachedcontent.md) &gt; [createTime](./generative-ai.cachedcontent.createtime.md)
+
+## CachedContent.createTime property
+
+`CachedContent` creation time in ISO string format.
+
+**Signature:**
+
+```typescript
+createTime?: string;
+```

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

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [CachedContent](./generative-ai.cachedcontent.md)
+
+## CachedContent interface
+
+Describes `CachedContent` interface for sending to the server (if creating) or received from the server (using getters or list methods).
+
+**Signature:**
+
+```typescript
+export interface CachedContent extends CachedContentBase 
+```
+**Extends:** [CachedContentBase](./generative-ai.cachedcontentbase.md)
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [createTime?](./generative-ai.cachedcontent.createtime.md) | | string | _(Optional)_ <code>CachedContent</code> creation time in ISO string format. |
+| [name?](./generative-ai.cachedcontent.name.md) | | string | _(Optional)_ |
+| [ttl?](./generative-ai.cachedcontent.ttl.md) | | string | _(Optional)_ protobuf.Duration format (ex. "3.0001s"). |
+| [updateTime?](./generative-ai.cachedcontent.updatetime.md) | | string | _(Optional)_ <code>CachedContent</code> update time in ISO string format. |
+

docs/reference/main/generative-ai.cachedcontent.name.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [CachedContent](./generative-ai.cachedcontent.md) &gt; [name](./generative-ai.cachedcontent.name.md)
+
+## CachedContent.name property
+
+**Signature:**
+
+```typescript
+name?: string;
+```

docs/reference/main/generative-ai.cachedcontent.ttl.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [CachedContent](./generative-ai.cachedcontent.md) &gt; [ttl](./generative-ai.cachedcontent.ttl.md)
+
+## CachedContent.ttl property
+
+protobuf.Duration format (ex. "3.0001s").
+
+**Signature:**
+
+```typescript
+ttl?: string;
+```

docs/reference/main/generative-ai.cachedcontent.updatetime.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [CachedContent](./generative-ai.cachedcontent.md) &gt; [updateTime](./generative-ai.cachedcontent.updatetime.md)
+
+## CachedContent.updateTime property
+
+`CachedContent` update time in ISO string format.
+
+**Signature:**
+
+```typescript
+updateTime?: string;
+```

docs/reference/main/generative-ai.cachedcontentbase.contents.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [CachedContentBase](./generative-ai.cachedcontentbase.md) &gt; [contents](./generative-ai.cachedcontentbase.contents.md)
+
+## CachedContentBase.contents property
+
+**Signature:**
+
+```typescript
+contents: Content[];
+```

docs/reference/main/generative-ai.cachedcontentbase.displayname.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [CachedContentBase](./generative-ai.cachedcontentbase.md) &gt; [displayName](./generative-ai.cachedcontentbase.displayname.md)
+
+## CachedContentBase.displayName property
+
+**Signature:**
+
+```typescript
+displayName?: string;
+```

docs/reference/main/generative-ai.cachedcontentbase.expiretime.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [CachedContentBase](./generative-ai.cachedcontentbase.md) &gt; [expireTime](./generative-ai.cachedcontentbase.expiretime.md)
+
+## CachedContentBase.expireTime property
+
+Expiration time in ISO string format. Specify either this or `ttlSeconds` when creating a `CachedContent`<!-- -->.
+
+**Signature:**
+
+```typescript
+expireTime?: string;
+```

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

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [CachedContentBase](./generative-ai.cachedcontentbase.md)
+
+## CachedContentBase interface
+
+
+**Signature:**
+
+```typescript
+export interface CachedContentBase 
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [contents](./generative-ai.cachedcontentbase.contents.md) | | [Content](./generative-ai.content.md)<!-- -->\[\] | |
+| [displayName?](./generative-ai.cachedcontentbase.displayname.md) | | string | _(Optional)_ |
+| [expireTime?](./generative-ai.cachedcontentbase.expiretime.md) | | string | _(Optional)_ Expiration time in ISO string format. Specify either this or <code>ttlSeconds</code> when creating a <code>CachedContent</code>. |
+| [model?](./generative-ai.cachedcontentbase.model.md) | | string | _(Optional)_ |
+| [systemInstruction?](./generative-ai.cachedcontentbase.systeminstruction.md) | | string \| [Part](./generative-ai.part.md) \| [Content](./generative-ai.content.md) | _(Optional)_ |
+| [toolConfig?](./generative-ai.cachedcontentbase.toolconfig.md) | | [ToolConfig](./generative-ai.toolconfig.md) | _(Optional)_ |
+| [tools?](./generative-ai.cachedcontentbase.tools.md) | | [Tool](./generative-ai.tool.md)<!-- -->\[\] | _(Optional)_ |
+

docs/reference/main/generative-ai.cachedcontentbase.model.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [CachedContentBase](./generative-ai.cachedcontentbase.md) &gt; [model](./generative-ai.cachedcontentbase.model.md)
+
+## CachedContentBase.model property
+
+**Signature:**
+
+```typescript
+model?: string;
+```

docs/reference/main/generative-ai.cachedcontentbase.systeminstruction.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [CachedContentBase](./generative-ai.cachedcontentbase.md) &gt; [systemInstruction](./generative-ai.cachedcontentbase.systeminstruction.md)
+
+## CachedContentBase.systemInstruction property
+
+**Signature:**
+
+```typescript
+systemInstruction?: string | Part | Content;
+```

docs/reference/main/generative-ai.cachedcontentbase.toolconfig.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [CachedContentBase](./generative-ai.cachedcontentbase.md) &gt; [toolConfig](./generative-ai.cachedcontentbase.toolconfig.md)
+
+## CachedContentBase.toolConfig property
+
+**Signature:**
+
+```typescript
+toolConfig?: ToolConfig;
+```

docs/reference/main/generative-ai.cachedcontentbase.tools.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [CachedContentBase](./generative-ai.cachedcontentbase.md) &gt; [tools](./generative-ai.cachedcontentbase.tools.md)
+
+## CachedContentBase.tools property
+
+**Signature:**
+
+```typescript
+tools?: Tool[];
+```

docs/reference/main/generative-ai.generatecontentrequest.cachedcontent.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [GenerateContentRequest](./generative-ai.generatecontentrequest.md) &gt; [cachedContent](./generative-ai.generatecontentrequest.cachedcontent.md)
+
+## GenerateContentRequest.cachedContent property
+
+This is the name of a `CachedContent` and not the cache object itself.
+
+**Signature:**
+
+```typescript
+cachedContent?: string;
+```

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

@@ -17,6 +17,7 @@ export interface GenerateContentRequest extends BaseParams
 
 | Property | Modifiers | Type | Description |
 | --- | --- | --- | --- |
+| [cachedContent?](./generative-ai.generatecontentrequest.cachedcontent.md) | | string | _(Optional)_ This is the name of a <code>CachedContent</code> and not the cache object itself. |
 | [contents](./generative-ai.generatecontentrequest.contents.md) | | [Content](./generative-ai.content.md)<!-- -->\[\] | |
 | [systemInstruction?](./generative-ai.generatecontentrequest.systeminstruction.md) | | string \| [Part](./generative-ai.part.md) \| [Content](./generative-ai.content.md) | _(Optional)_ |
 | [toolConfig?](./generative-ai.generatecontentrequest.toolconfig.md) | | [ToolConfig](./generative-ai.toolconfig.md) | _(Optional)_ |

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

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [GenerativeModel](./generative-ai.generativemodel.md) &gt; [cachedContent](./generative-ai.generativemodel.cachedcontent.md)
+
+## GenerativeModel.cachedContent property
+
+**Signature:**
+
+```typescript
+cachedContent: CachedContent;
+```

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

@@ -23,6 +23,7 @@ export declare class GenerativeModel
 | Property | Modifiers | Type | Description |
 | --- | --- | --- | --- |
 | [apiKey](./generative-ai.generativemodel.apikey.md) | | string | |
+| [cachedContent](./generative-ai.generativemodel.cachedcontent.md) | | [CachedContent](./generative-ai.cachedcontent.md) | |
 | [generationConfig](./generative-ai.generativemodel.generationconfig.md) | | [GenerationConfig](./generative-ai.generationconfig.md) | |
 | [model](./generative-ai.generativemodel.model.md) | | string | |
 | [requestOptions](./generative-ai.generativemodel.requestoptions.md) | | [RequestOptions](./generative-ai.requestoptions.md) | |

docs/reference/main/generative-ai.googlegenerativeai.getgenerativemodelfromcachedcontent.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [GoogleGenerativeAI](./generative-ai.googlegenerativeai.md) &gt; [getGenerativeModelFromCachedContent](./generative-ai.googlegenerativeai.getgenerativemodelfromcachedcontent.md)
+
+## GoogleGenerativeAI.getGenerativeModelFromCachedContent() method
+
+Creates a [GenerativeModel](./generative-ai.generativemodel.md) instance from provided content cache.
+
+**Signature:**
+
+```typescript
+getGenerativeModelFromCachedContent(cachedContent: CachedContent, requestOptions?: RequestOptions): GenerativeModel;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| cachedContent | [CachedContent](./generative-ai.cachedcontent.md) | |
+| requestOptions | [RequestOptions](./generative-ai.requestoptions.md) | _(Optional)_ |
+
+**Returns:**
+
+[GenerativeModel](./generative-ai.generativemodel.md)
+

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

@@ -29,4 +29,5 @@ export declare class GoogleGenerativeAI
 | Method | Modifiers | Description |
 | --- | --- | --- |
 | [getGenerativeModel(modelParams, requestOptions)](./generative-ai.googlegenerativeai.getgenerativemodel.md) | | Gets a [GenerativeModel](./generative-ai.generativemodel.md) instance for the provided model name. |
+| [getGenerativeModelFromCachedContent(cachedContent, requestOptions)](./generative-ai.googlegenerativeai.getgenerativemodelfromcachedcontent.md) | | Creates a [GenerativeModel](./generative-ai.generativemodel.md) instance from provided content cache. |
 

docs/reference/main/generative-ai.md

@@ -36,6 +36,8 @@
 | [BaseParams](./generative-ai.baseparams.md) | Base parameters for a number of methods. |
 | [BatchEmbedContentsRequest](./generative-ai.batchembedcontentsrequest.md) | Params for calling [GenerativeModel.batchEmbedContents()](./generative-ai.generativemodel.batchembedcontents.md) |
 | [BatchEmbedContentsResponse](./generative-ai.batchembedcontentsresponse.md) | Response from calling [GenerativeModel.batchEmbedContents()](./generative-ai.generativemodel.batchembedcontents.md)<!-- -->. |
+| [CachedContent](./generative-ai.cachedcontent.md) | Describes <code>CachedContent</code> interface for sending to the server (if creating) or received from the server (using getters or list methods). |
+| [CachedContentBase](./generative-ai.cachedcontentbase.md) | |
 | [CitationMetadata](./generative-ai.citationmetadata.md) | Citation metadata that may be found on a [GenerateContentCandidate](./generative-ai.generatecontentcandidate.md)<!-- -->. |
 | [CitationSource](./generative-ai.citationsource.md) | A single citation source. |
 | [Content](./generative-ai.content.md) | Content type for both prompts and response candidates. |
@@ -68,7 +70,7 @@
 | [ModelParams](./generative-ai.modelparams.md) | Params passed to [GoogleGenerativeAI.getGenerativeModel()](./generative-ai.googlegenerativeai.getgenerativemodel.md)<!-- -->. |
 | [PromptFeedback](./generative-ai.promptfeedback.md) | If the prompt was blocked, this will be populated with <code>blockReason</code> and the relevant <code>safetyRatings</code>. |
 | [RequestOptions](./generative-ai.requestoptions.md) | Params passed to getGenerativeModel() or GoogleAIFileManager(). |
-| [ResponseSchema](./generative-ai.responseschema.md) | Schema passed to [GenerationConfig.responseSchema](./generative-ai.generationconfig.responseschema.md) |
+| [ResponseSchema](./generative-ai.responseschema.md) | Schema passed to <code>GenerationConfig.responseSchema</code> |
 | [SafetyRating](./generative-ai.safetyrating.md) | A safety rating associated with a [GenerateContentCandidate](./generative-ai.generatecontentcandidate.md) |
 | [SafetySetting](./generative-ai.safetysetting.md) | Safety setting that can be sent as part of request parameters. |
 | [Schema](./generative-ai.schema.md) | Schema is used to define the format of input/output data. Represents a select subset of an OpenAPI 3.0 schema object. More fields may be added in the future as needed. |

docs/reference/main/generative-ai.modelparams.cachedcontent.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ModelParams](./generative-ai.modelparams.md) &gt; [cachedContent](./generative-ai.modelparams.cachedcontent.md)
+
+## ModelParams.cachedContent property
+
+**Signature:**
+
+```typescript
+cachedContent?: CachedContent;
+```

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

@@ -17,6 +17,7 @@ export interface ModelParams extends BaseParams
 
 | Property | Modifiers | Type | Description |
 | --- | --- | --- | --- |
+| [cachedContent?](./generative-ai.modelparams.cachedcontent.md) | | [CachedContent](./generative-ai.cachedcontent.md) | _(Optional)_ |
 | [model](./generative-ai.modelparams.model.md) | | string | |
 | [systemInstruction?](./generative-ai.modelparams.systeminstruction.md) | | string \| [Part](./generative-ai.part.md) \| [Content](./generative-ai.content.md) | _(Optional)_ |
 | [toolConfig?](./generative-ai.modelparams.toolconfig.md) | | [ToolConfig](./generative-ai.toolconfig.md) | _(Optional)_ |

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

@@ -4,7 +4,7 @@
 
 ## ResponseSchema interface
 
-Schema passed to [GenerationConfig.responseSchema](./generative-ai.generationconfig.responseschema.md)
+Schema passed to `GenerationConfig.responseSchema`
 
 **Signature:**
 

docs/reference/main/generative-ai.startchatparams.cachedcontent.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [StartChatParams](./generative-ai.startchatparams.md) &gt; [cachedContent](./generative-ai.startchatparams.cachedcontent.md)
+
+## StartChatParams.cachedContent property
+
+This is the name of a `CachedContent` and not the cache object itself.
+
+**Signature:**
+
+```typescript
+cachedContent?: string;
+```

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

@@ -17,6 +17,7 @@ export interface StartChatParams extends BaseParams
 
 | Property | Modifiers | Type | Description |
 | --- | --- | --- | --- |
+| [cachedContent?](./generative-ai.startchatparams.cachedcontent.md) | | string | _(Optional)_ This is the name of a <code>CachedContent</code> and not the cache object itself. |
 | [history?](./generative-ai.startchatparams.history.md) | | [Content](./generative-ai.content.md)<!-- -->\[\] | _(Optional)_ |
 | [systemInstruction?](./generative-ai.startchatparams.systeminstruction.md) | | string \| [Part](./generative-ai.part.md) \| [Content](./generative-ai.content.md) | _(Optional)_ |
 | [toolConfig?](./generative-ai.startchatparams.toolconfig.md) | | [ToolConfig](./generative-ai.toolconfig.md) | _(Optional)_ |

docs/reference/server/generative-ai.cachedcontent.createtime.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [CachedContent](./generative-ai.cachedcontent.md) &gt; [createTime](./generative-ai.cachedcontent.createtime.md)
+
+## CachedContent.createTime property
+
+`CachedContent` creation time in ISO string format.
+
+**Signature:**
+
+```typescript
+createTime?: string;
+```

docs/reference/server/generative-ai.cachedcontent.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [CachedContent](./generative-ai.cachedcontent.md)
+
+## CachedContent interface
+
+Describes `CachedContent` interface for sending to the server (if creating) or received from the server (using getters or list methods).
+
+**Signature:**
+
+```typescript
+export interface CachedContent extends CachedContentBase 
+```
+**Extends:** [CachedContentBase](./generative-ai.cachedcontentbase.md)
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [createTime?](./generative-ai.cachedcontent.createtime.md) | | string | _(Optional)_ <code>CachedContent</code> creation time in ISO string format. |
+| [name?](./generative-ai.cachedcontent.name.md) | | string | _(Optional)_ |
+| [ttl?](./generative-ai.cachedcontent.ttl.md) | | string | _(Optional)_ protobuf.Duration format (ex. "3.0001s"). |
+| [updateTime?](./generative-ai.cachedcontent.updatetime.md) | | string | _(Optional)_ <code>CachedContent</code> update time in ISO string format. |
+

docs/reference/server/generative-ai.cachedcontent.name.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [CachedContent](./generative-ai.cachedcontent.md) &gt; [name](./generative-ai.cachedcontent.name.md)
+
+## CachedContent.name property
+
+**Signature:**
+
+```typescript
+name?: string;
+```