From c030e1408c3eb2c52b0474d3d018a571e5af13e2 Mon Sep 17 00:00:00 2001 From: DellaBitta Date: Wed, 8 May 2024 14:27:11 -0400 Subject: [PATCH 1/3] Add a responseMimeType to generationConfig --- docs/reference/main/generative-ai.generationconfig.md | 1 + ...generative-ai.generationconfig.responsemimetype.md | 11 +++++++++++ packages/main/types/requests.ts | 1 + 3 files changed, 13 insertions(+) create mode 100644 docs/reference/main/generative-ai.generationconfig.responsemimetype.md diff --git a/docs/reference/main/generative-ai.generationconfig.md b/docs/reference/main/generative-ai.generationconfig.md index 2cb26cd62..9c6be543d 100644 --- a/docs/reference/main/generative-ai.generationconfig.md +++ b/docs/reference/main/generative-ai.generationconfig.md @@ -18,6 +18,7 @@ export interface GenerationConfig | --- | --- | --- | --- | | [candidateCount?](./generative-ai.generationconfig.candidatecount.md) | | number | _(Optional)_ | | [maxOutputTokens?](./generative-ai.generationconfig.maxoutputtokens.md) | | number | _(Optional)_ | +| [responseMimeType?](./generative-ai.generationconfig.responsemimetype.md) | | string | _(Optional)_ | | [stopSequences?](./generative-ai.generationconfig.stopsequences.md) | | string\[\] | _(Optional)_ | | [temperature?](./generative-ai.generationconfig.temperature.md) | | number | _(Optional)_ | | [topK?](./generative-ai.generationconfig.topk.md) | | number | _(Optional)_ | diff --git a/docs/reference/main/generative-ai.generationconfig.responsemimetype.md b/docs/reference/main/generative-ai.generationconfig.responsemimetype.md new file mode 100644 index 000000000..f674be829 --- /dev/null +++ b/docs/reference/main/generative-ai.generationconfig.responsemimetype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerationConfig](./generative-ai.generationconfig.md) > [responseMimeType](./generative-ai.generationconfig.responsemimetype.md) + +## GenerationConfig.responseMimeType property + +**Signature:** + +```typescript +responseMimeType?: string; +``` diff --git a/packages/main/types/requests.ts b/packages/main/types/requests.ts index eefa38259..eff0c4543 100644 --- a/packages/main/types/requests.ts +++ b/packages/main/types/requests.ts @@ -74,6 +74,7 @@ export interface GenerationConfig { temperature?: number; topP?: number; topK?: number; + responseMimeType?: string; } /** From 1cc010482acc50bb60b04f7b1b382def2fbdc341 Mon Sep 17 00:00:00 2001 From: DellaBitta Date: Wed, 8 May 2024 14:50:42 -0400 Subject: [PATCH 2/3] Updated docs. --- docs/reference/main/generative-ai.generationconfig.md | 2 +- .../main/generative-ai.generationconfig.responsemimetype.md | 2 ++ packages/main/types/requests.ts | 6 ++++++ 3 files changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/reference/main/generative-ai.generationconfig.md b/docs/reference/main/generative-ai.generationconfig.md index 9c6be543d..633c5fc2f 100644 --- a/docs/reference/main/generative-ai.generationconfig.md +++ b/docs/reference/main/generative-ai.generationconfig.md @@ -18,7 +18,7 @@ export interface GenerationConfig | --- | --- | --- | --- | | [candidateCount?](./generative-ai.generationconfig.candidatecount.md) | | number | _(Optional)_ | | [maxOutputTokens?](./generative-ai.generationconfig.maxoutputtokens.md) | | number | _(Optional)_ | -| [responseMimeType?](./generative-ai.generationconfig.responsemimetype.md) | | string | _(Optional)_ | +| [responseMimeType?](./generative-ai.generationconfig.responsemimetype.md) | | string | _(Optional)_ Output response mimetype of the generated candidate text. Supported mimetype: text/plain: (default) Text output. application/json: JSON response in the candidates. | | [stopSequences?](./generative-ai.generationconfig.stopsequences.md) | | string\[\] | _(Optional)_ | | [temperature?](./generative-ai.generationconfig.temperature.md) | | number | _(Optional)_ | | [topK?](./generative-ai.generationconfig.topk.md) | | number | _(Optional)_ | diff --git a/docs/reference/main/generative-ai.generationconfig.responsemimetype.md b/docs/reference/main/generative-ai.generationconfig.responsemimetype.md index f674be829..3620d925e 100644 --- a/docs/reference/main/generative-ai.generationconfig.responsemimetype.md +++ b/docs/reference/main/generative-ai.generationconfig.responsemimetype.md @@ -4,6 +4,8 @@ ## GenerationConfig.responseMimeType property +Output response mimetype of the generated candidate text. Supported mimetype: `text/plain`: (default) Text output. `application/json`: JSON response in the candidates. + **Signature:** ```typescript diff --git a/packages/main/types/requests.ts b/packages/main/types/requests.ts index eff0c4543..6787ea8b2 100644 --- a/packages/main/types/requests.ts +++ b/packages/main/types/requests.ts @@ -74,6 +74,12 @@ export interface GenerationConfig { temperature?: number; topP?: number; topK?: number; + /** + * Output response mimetype of the generated candidate text. + * Supported mimetype: + * `text/plain`: (default) Text output. + * `application/json`: JSON response in the candidates. + */ responseMimeType?: string; } From d91ef80a60b416df0a194f161fdb1a11fa9b2f10 Mon Sep 17 00:00:00 2001 From: DellaBitta Date: Wed, 8 May 2024 14:52:40 -0400 Subject: [PATCH 3/3] changeset --- .changeset/dirty-snails-unite.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/dirty-snails-unite.md diff --git a/.changeset/dirty-snails-unite.md b/.changeset/dirty-snails-unite.md new file mode 100644 index 000000000..1d487fbc0 --- /dev/null +++ b/.changeset/dirty-snails-unite.md @@ -0,0 +1,5 @@ +--- +"@google/generative-ai": minor +--- + +Added responseMimeType to GenerationConfig to allow for JSON formatted responses.