From e3756e141ccd3781551412c58b1c042469fc1ce2 Mon Sep 17 00:00:00 2001 From: Daniel La Rocque Date: Fri, 21 Feb 2025 09:23:55 -0500 Subject: [PATCH 1/3] Add missing properties to CountTokensRequest --- common/api-review/vertexai.api.md | 3 ++ docs-devsite/vertexai.counttokensrequest.md | 33 +++++++++++++++++++++ packages/vertexai/src/types/requests.ts | 12 ++++++++ 3 files changed, 48 insertions(+) diff --git a/common/api-review/vertexai.api.md b/common/api-review/vertexai.api.md index 14c58e803e5..0ebc4f0769a 100644 --- a/common/api-review/vertexai.api.md +++ b/common/api-review/vertexai.api.md @@ -90,6 +90,9 @@ export interface Content { export interface CountTokensRequest { // (undocumented) contents: Content[]; + generationConfig?: GenerationConfig; + systemInstruction?: string | Part | Content; + tools?: Tool[]; } // @public diff --git a/docs-devsite/vertexai.counttokensrequest.md b/docs-devsite/vertexai.counttokensrequest.md index db519b7eb11..d81073c3133 100644 --- a/docs-devsite/vertexai.counttokensrequest.md +++ b/docs-devsite/vertexai.counttokensrequest.md @@ -23,6 +23,9 @@ export interface CountTokensRequest | Property | Type | Description | | --- | --- | --- | | [contents](./vertexai.counttokensrequest.md#counttokensrequestcontents) | [Content](./vertexai.content.md#content_interface)\[\] | | +| [generationConfig](./vertexai.counttokensrequest.md#counttokensrequestgenerationconfig) | [GenerationConfig](./vertexai.generationconfig.md#generationconfig_interface) | Configuration options used for content-related requests. | +| [systemInstruction](./vertexai.counttokensrequest.md#counttokensrequestsysteminstruction) | string \| [Part](./vertexai.md#part) \| [Content](./vertexai.content.md#content_interface) | Instructions that direct the model to behave a certain way. | +| [tools](./vertexai.counttokensrequest.md#counttokensrequesttools) | [Tool](./vertexai.md#tool)\[\] | [Tool](./vertexai.md#tool) configuration. | ## CountTokensRequest.contents @@ -31,3 +34,33 @@ export interface CountTokensRequest ```typescript contents: Content[]; ``` + +## CountTokensRequest.generationConfig + +Configuration options used for content-related requests. + +Signature: + +```typescript +generationConfig?: GenerationConfig; +``` + +## CountTokensRequest.systemInstruction + +Instructions that direct the model to behave a certain way. + +Signature: + +```typescript +systemInstruction?: string | Part | Content; +``` + +## CountTokensRequest.tools + +[Tool](./vertexai.md#tool) configuration. + +Signature: + +```typescript +tools?: Tool[]; +``` diff --git a/packages/vertexai/src/types/requests.ts b/packages/vertexai/src/types/requests.ts index dc7576f232d..44edc636c26 100644 --- a/packages/vertexai/src/types/requests.ts +++ b/packages/vertexai/src/types/requests.ts @@ -114,6 +114,18 @@ export interface StartChatParams extends BaseParams { */ export interface CountTokensRequest { contents: Content[]; + /** + * Instructions that direct the model to behave a certain way. + */ + systemInstruction?: string | Part | Content; + /** + * {@link Tool} configuration. + */ + tools?: Tool[]; + /** + * Configuration options used for content-related requests. + */ + generationConfig?: GenerationConfig; } /** From 162f89793c982712f4bba10e9c026b5138951fe3 Mon Sep 17 00:00:00 2001 From: Daniel La Rocque Date: Tue, 4 Mar 2025 13:47:35 -0500 Subject: [PATCH 2/3] Add changeset --- .changeset/chilly-parrots-remember.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/chilly-parrots-remember.md diff --git a/.changeset/chilly-parrots-remember.md b/.changeset/chilly-parrots-remember.md new file mode 100644 index 00000000000..aaf0d766b44 --- /dev/null +++ b/.changeset/chilly-parrots-remember.md @@ -0,0 +1,5 @@ +--- +'@firebase/vertexai': minor +--- + +Add `systemInstruction`, `tools`, and `generationConfig` to `CountTokensRequest`. From 3ce689ff7efa843f3a55a710247c4af1baa442a6 Mon Sep 17 00:00:00 2001 From: Daniel La Rocque Date: Wed, 5 Mar 2025 09:28:08 -0500 Subject: [PATCH 3/3] Review fixes --- docs-devsite/vertexai.counttokensrequest.md | 4 ++-- packages/vertexai/src/types/requests.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs-devsite/vertexai.counttokensrequest.md b/docs-devsite/vertexai.counttokensrequest.md index d81073c3133..f5875564588 100644 --- a/docs-devsite/vertexai.counttokensrequest.md +++ b/docs-devsite/vertexai.counttokensrequest.md @@ -23,7 +23,7 @@ export interface CountTokensRequest | Property | Type | Description | | --- | --- | --- | | [contents](./vertexai.counttokensrequest.md#counttokensrequestcontents) | [Content](./vertexai.content.md#content_interface)\[\] | | -| [generationConfig](./vertexai.counttokensrequest.md#counttokensrequestgenerationconfig) | [GenerationConfig](./vertexai.generationconfig.md#generationconfig_interface) | Configuration options used for content-related requests. | +| [generationConfig](./vertexai.counttokensrequest.md#counttokensrequestgenerationconfig) | [GenerationConfig](./vertexai.generationconfig.md#generationconfig_interface) | Configuration options that control how the model generates a response. | | [systemInstruction](./vertexai.counttokensrequest.md#counttokensrequestsysteminstruction) | string \| [Part](./vertexai.md#part) \| [Content](./vertexai.content.md#content_interface) | Instructions that direct the model to behave a certain way. | | [tools](./vertexai.counttokensrequest.md#counttokensrequesttools) | [Tool](./vertexai.md#tool)\[\] | [Tool](./vertexai.md#tool) configuration. | @@ -37,7 +37,7 @@ contents: Content[]; ## CountTokensRequest.generationConfig -Configuration options used for content-related requests. +Configuration options that control how the model generates a response. Signature: diff --git a/packages/vertexai/src/types/requests.ts b/packages/vertexai/src/types/requests.ts index 44edc636c26..5058b457365 100644 --- a/packages/vertexai/src/types/requests.ts +++ b/packages/vertexai/src/types/requests.ts @@ -123,7 +123,7 @@ export interface CountTokensRequest { */ tools?: Tool[]; /** - * Configuration options used for content-related requests. + * Configuration options that control how the model generates a response. */ generationConfig?: GenerationConfig; }