From 70cc35336d128d16db24d2c513133050071a182e Mon Sep 17 00:00:00 2001 From: wong2 Date: Thu, 22 Aug 2024 23:48:29 +0800 Subject: [PATCH] Fix requestOptions in startChat (#228) --- .changeset/real-windows-itch.md | 5 +++++ common/api-review/generative-ai.api.md | 2 -- docs/reference/main/generative-ai.generativemodel.md | 1 - .../generative-ai.generativemodel.requestoptions.md | 11 ----------- packages/main/src/models/generative-model.ts | 3 +-- 5 files changed, 6 insertions(+), 16 deletions(-) create mode 100644 .changeset/real-windows-itch.md delete mode 100644 docs/reference/main/generative-ai.generativemodel.requestoptions.md diff --git a/.changeset/real-windows-itch.md b/.changeset/real-windows-itch.md new file mode 100644 index 000000000..78ce904ea --- /dev/null +++ b/.changeset/real-windows-itch.md @@ -0,0 +1,5 @@ +--- +"@google/generative-ai": patch +--- + +Fix reference to `requestOptions` in `startChat`. diff --git a/common/api-review/generative-ai.api.md b/common/api-review/generative-ai.api.md index 2275a977e..fdf5d6470 100644 --- a/common/api-review/generative-ai.api.md +++ b/common/api-review/generative-ai.api.md @@ -475,8 +475,6 @@ export class GenerativeModel { // (undocumented) model: string; // (undocumented) - requestOptions: RequestOptions; - // (undocumented) safetySettings: SafetySetting[]; startChat(startChatParams?: StartChatParams): ChatSession; // (undocumented) diff --git a/docs/reference/main/generative-ai.generativemodel.md b/docs/reference/main/generative-ai.generativemodel.md index c822694ce..eba3e32ed 100644 --- a/docs/reference/main/generative-ai.generativemodel.md +++ b/docs/reference/main/generative-ai.generativemodel.md @@ -26,7 +26,6 @@ export declare class GenerativeModel | [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) | | | [safetySettings](./generative-ai.generativemodel.safetysettings.md) | | [SafetySetting](./generative-ai.safetysetting.md)\[\] | | | [systemInstruction?](./generative-ai.generativemodel.systeminstruction.md) | | [Content](./generative-ai.content.md) | _(Optional)_ | | [toolConfig?](./generative-ai.generativemodel.toolconfig.md) | | [ToolConfig](./generative-ai.toolconfig.md) | _(Optional)_ | diff --git a/docs/reference/main/generative-ai.generativemodel.requestoptions.md b/docs/reference/main/generative-ai.generativemodel.requestoptions.md deleted file mode 100644 index 89e74b089..000000000 --- a/docs/reference/main/generative-ai.generativemodel.requestoptions.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerativeModel](./generative-ai.generativemodel.md) > [requestOptions](./generative-ai.generativemodel.requestoptions.md) - -## GenerativeModel.requestOptions property - -**Signature:** - -```typescript -requestOptions: RequestOptions; -``` diff --git a/packages/main/src/models/generative-model.ts b/packages/main/src/models/generative-model.ts index 375d9ddff..cb415a3b1 100644 --- a/packages/main/src/models/generative-model.ts +++ b/packages/main/src/models/generative-model.ts @@ -59,7 +59,6 @@ export class GenerativeModel { model: string; generationConfig: GenerationConfig; safetySettings: SafetySetting[]; - requestOptions: RequestOptions; tools?: Tool[]; toolConfig?: ToolConfig; systemInstruction?: Content; @@ -172,7 +171,7 @@ export class GenerativeModel { cachedContent: this.cachedContent?.name, ...startChatParams, }, - this.requestOptions, + this._requestOptions, ); }