Correct "GoogleAIFileManager" mentions to point to the right method i…

…nstead
google-gemini · Aug 7, 2024 · 737320b · 737320b
1 parent 9aca8e8
commit 737320b
Show file tree

Hide file tree

Showing 11 changed files with 28 additions and 28 deletions.
diff --git a/docs/reference/main/generative-ai.chatsession.md b/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 <code>GoogleAIFileManager</code> 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 <code>GoogleAIFileManager</code> 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> |
 
diff --git a/docs/reference/main/generative-ai.chatsession.sendmessage.md b/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 `GoogleAIFileManager` 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:**
 

diff --git a/docs/reference/main/generative-ai.chatsession.sendmessagestream.md b/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 `GoogleAIFileManager` 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:**
 

diff --git a/docs/reference/main/generative-ai.generativemodel.batchembedcontents.md b/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 `GoogleAIFileManager` 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:**
 

diff --git a/docs/reference/main/generative-ai.generativemodel.counttokens.md b/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 `GoogleAIFileManager` 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:**
 

diff --git a/docs/reference/main/generative-ai.generativemodel.embedcontent.md b/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 `GoogleAIFileManager` 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:**
 

diff --git a/docs/reference/main/generative-ai.generativemodel.generatecontent.md b/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 `GoogleAIFileManager` 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:**
 

diff --git a/docs/reference/main/generative-ai.generativemodel.generatecontentstream.md b/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 `GoogleAIFileManager` 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:**
 

diff --git a/docs/reference/main/generative-ai.generativemodel.md b/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 <code>GoogleAIFileManager</code> 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 <code>GoogleAIFileManager</code> 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 <code>GoogleAIFileManager</code> 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 <code>GoogleAIFileManager</code> 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 <code>GoogleAIFileManager</code> 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. |
 
diff --git a/packages/main/src/methods/chat-session.ts b/packages/main/src/methods/chat-session.ts
@@ -74,8 +74,8 @@ export class ChatSession {
    * {@link GenerateContentResult}.
    *
    * Fields set in the optional {@link SingleRequestOptions} parameter will
-   * take precedence over the {@link RequestOptions} values provided at the
-   * time of the `GoogleAIFileManager` initialization.
+   * take precedence over the {@link RequestOptions} values provided to
+   * {@link GoogleGenerativeAI.getGenerativeModel }.
    */
   async sendMessage(
     request: string | Array<string | Part>,
@@ -140,8 +140,8 @@ export class ChatSession {
    * and a response promise.
    *
    * Fields set in the optional {@link SingleRequestOptions} parameter will
-   * take precedence over the {@link RequestOptions} values provided at the
-   * time of the `GoogleAIFileManager` initialization.
+   * take precedence over the {@link RequestOptions} values provided to
+   * {@link GoogleGenerativeAI.getGenerativeModel }.
    */
   async sendMessageStream(
     request: string | Array<string | Part>,

diff --git a/packages/main/src/models/generative-model.ts b/packages/main/src/models/generative-model.ts
@@ -92,8 +92,8 @@ export class GenerativeModel {
    * and returns an object containing a single {@link GenerateContentResponse}.
    *
    * Fields set in the optional {@link SingleRequestOptions} parameter will
-   * take precedence over the {@link RequestOptions} values provided at the
-   * time of the `GoogleAIFileManager` initialization.
+   * take precedence over the {@link RequestOptions} values provided to
+   * {@link GoogleGenerativeAI.getGenerativeModel }.
    */
   async generateContent(
     request: GenerateContentRequest | string | Array<string | Part>,
@@ -127,8 +127,8 @@ export class GenerativeModel {
    * aggregated response.
    *
    * Fields set in the optional {@link SingleRequestOptions} parameter will
-   * take precedence over the {@link RequestOptions} values provided at the
-   * time of the `GoogleAIFileManager` initialization.
+   * take precedence over the {@link RequestOptions} values provided to
+   * {@link GoogleGenerativeAI.getGenerativeModel }.
    */
   async generateContentStream(
     request: GenerateContentRequest | string | Array<string | Part>,
@@ -180,8 +180,8 @@ export class GenerativeModel {
    * Counts the tokens in the provided request.
    *
    * Fields set in the optional {@link SingleRequestOptions} parameter will
-   * take precedence over the {@link RequestOptions} values provided at the
-   * time of the `GoogleAIFileManager` initialization.
+   * take precedence over the {@link RequestOptions} values provided to
+   * {@link GoogleGenerativeAI.getGenerativeModel }.
    */
   async countTokens(
     request: CountTokensRequest | string | Array<string | Part>,
@@ -212,8 +212,8 @@ export class GenerativeModel {
    * Embeds the provided content.
    *
    * Fields set in the optional {@link SingleRequestOptions} parameter will
-   * take precedence over the {@link RequestOptions} values provided at the
-   * time of the `GoogleAIFileManager` initialization.
+   * take precedence over the {@link RequestOptions} values provided to
+   * {@link GoogleGenerativeAI.getGenerativeModel }.
    */
   async embedContent(
     request: EmbedContentRequest | string | Array<string | Part>,
@@ -236,8 +236,8 @@ export class GenerativeModel {
    * Embeds an array of {@link EmbedContentRequest}s.
    *
    * Fields set in the optional {@link SingleRequestOptions} parameter will
-   * take precedence over the {@link RequestOptions} values provided at the
-   * time of the `GoogleAIFileManager` initialization.
+   * take precedence over the {@link RequestOptions} values provided to
+   * {@link GoogleGenerativeAI.getGenerativeModel }.
    */
   async batchEmbedContents(
     batchEmbedContentRequest: BatchEmbedContentsRequest,